ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/network.h
Revision: 1.24
Committed: Mon Oct 12 14:00:58 2009 UTC (14 years, 8 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-2_82, rel-2_81
Changes since 1.23: +7 -6 lines
Log Message:
clarify license

File Contents

# User Rev Content
1 root 1.1 /*
2 root 1.20 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 pippijn 1.8 *
4 root 1.21 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 root 1.12 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6     * Copyright (©) 1992,2007 Frank Tore Johansen
7 pippijn 1.8 *
8 root 1.24 * Deliantra is free software: you can redistribute it and/or modify it under
9     * the terms of the Affero GNU General Public License as published by the
10     * Free Software Foundation, either version 3 of the License, or (at your
11     * option) any later version.
12 pippijn 1.8 *
13 root 1.14 * This program is distributed in the hope that it will be useful,
14     * but WITHOUT ANY WARRANTY; without even the implied warranty of
15     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16     * GNU General Public License for more details.
17 pippijn 1.8 *
18 root 1.24 * You should have received a copy of the Affero GNU General Public License
19     * and the GNU General Public License along with this program. If not, see
20     * <http://www.gnu.org/licenses/>.
21 root 1.12 *
22 root 1.20 * The authors can be reached via e-mail to <support@deliantra.net>
23 pippijn 1.8 */
24 root 1.1
25     /* This file defines various flags that both the new client and
26     * newserver uses. These should never be changed, only expanded.
27     * Changing them will likely cause all old clients to not work properly.
28     * While called newclient, it is really used by both the client and
29     * server to keep some values the same.
30     *
31     * Name format is CS_(command)_(flag)
32     * CS = Client/Server.
33     * (command) is protocol command, ie ITEM
34     * (flag) is the flag name
35     */
36    
37     /* It is trivial to keep a link of copy of this file in the client
38     * or server area. But keeping one common file should make things
39     * more reliable, as both the client and server will definately be
40     * talking about the same values.
41     */
42    
43    
44 root 1.4 #ifndef NETWORK_H
45     #define NETWORK_H
46    
47     #include <cstdarg>
48 root 1.1
49 root 1.6 /* Maximum size of any packet we expect.
50 root 1.1 *
51 root 1.17 * The size must be the same in the server and the client (stupid).
52 root 1.19 * TODO: make the actual network configurable per client and use 2**16.
53 root 1.1 */
54 root 1.17 #define MAXSOCKBUF 10239
55 root 1.1
56     #define CS_QUERY_YESNO 0x1 /* Yes/no question */
57     #define CS_QUERY_SINGLECHAR 0x2 /* Single character response expected */
58     #define CS_QUERY_HIDEINPUT 0x4 /* Hide input being entered */
59    
60     /* These are multiplication values that should be used when changing
61     * floats to ints, and vice version. MULTI is integer representatin
62     * (float to int), MULTF is float, for going from int to float.
63     */
64     #define FLOAT_MULTI 100000
65     #define FLOAT_MULTF 100000.0
66    
67     /* ID's for the various stats that get sent across. */
68    
69     #define CS_STAT_HP 1
70     #define CS_STAT_MAXHP 2
71     #define CS_STAT_SP 3
72     #define CS_STAT_MAXSP 4
73     #define CS_STAT_STR 5
74     #define CS_STAT_INT 6
75     #define CS_STAT_WIS 7
76     #define CS_STAT_DEX 8
77     #define CS_STAT_CON 9
78     #define CS_STAT_CHA 10
79     #define CS_STAT_EXP 11
80     #define CS_STAT_LEVEL 12
81     #define CS_STAT_WC 13
82     #define CS_STAT_AC 14
83     #define CS_STAT_DAM 15
84     #define CS_STAT_ARMOUR 16
85     #define CS_STAT_SPEED 17
86     #define CS_STAT_FOOD 18
87     #define CS_STAT_WEAP_SP 19
88     #define CS_STAT_RANGE 20
89     #define CS_STAT_TITLE 21
90     #define CS_STAT_POW 22
91     #define CS_STAT_GRACE 23
92     #define CS_STAT_MAXGRACE 24
93     #define CS_STAT_FLAGS 25
94     #define CS_STAT_WEIGHT_LIM 26
95     #define CS_STAT_EXP64 28
96     #define CS_STAT_SPELL_ATTUNE 29
97     #define CS_STAT_SPELL_REPEL 30
98     #define CS_STAT_SPELL_DENY 31
99    
100     /* Start & end of resistances, inclusive. */
101     #define CS_STAT_RESIST_START 100
102     #define CS_STAT_RESIST_END 117
103     #define CS_STAT_RES_PHYS 100
104     #define CS_STAT_RES_MAG 101
105     #define CS_STAT_RES_FIRE 102
106     #define CS_STAT_RES_ELEC 103
107     #define CS_STAT_RES_COLD 104
108     #define CS_STAT_RES_CONF 105
109     #define CS_STAT_RES_ACID 106
110     #define CS_STAT_RES_DRAIN 107
111     #define CS_STAT_RES_GHOSTHIT 108
112     #define CS_STAT_RES_POISON 109
113     #define CS_STAT_RES_SLOW 110
114     #define CS_STAT_RES_PARA 111
115     #define CS_STAT_TURN_UNDEAD 112
116     #define CS_STAT_RES_FEAR 113
117     #define CS_STAT_RES_DEPLETE 114
118     #define CS_STAT_RES_DEATH 115
119     #define CS_STAT_RES_HOLYWORD 116
120     #define CS_STAT_RES_BLIND 117
121    
122     /* Start & end of skill experience + skill level, inclusive. */
123     #define CS_STAT_SKILLEXP_START 118
124     #define CS_STAT_SKILLEXP_END 129
125     #define CS_STAT_SKILLEXP_AGILITY 118
126     #define CS_STAT_SKILLEXP_AGLEVEL 119
127     #define CS_STAT_SKILLEXP_PERSONAL 120
128     #define CS_STAT_SKILLEXP_PELEVEL 121
129     #define CS_STAT_SKILLEXP_MENTAL 122
130     #define CS_STAT_SKILLEXP_MELEVEL 123
131     #define CS_STAT_SKILLEXP_PHYSIQUE 124
132     #define CS_STAT_SKILLEXP_PHLEVEL 125
133     #define CS_STAT_SKILLEXP_MAGIC 126
134     #define CS_STAT_SKILLEXP_MALEVEL 127
135     #define CS_STAT_SKILLEXP_WISDOM 128
136     #define CS_STAT_SKILLEXP_WILEVEL 129
137    
138     /* CS_STAT_SKILLINFO is used as the starting index point. Skill number->name
139     * map is generated dynamically for the client, so a bunch of entries will
140     * be used here. CS_NUM_SKILLS does not match how many skills there really
141     * are - instead, it is used as a range of values so that the client
142     * can have some idea how many skill categories there may be.
143     */
144     #define CS_STAT_SKILLINFO 140
145     #define CS_NUM_SKILLS 50
146    
147     /* These are used with CS_STAT_FLAGS above to communicate S->C what the
148     * server thinks the fireon & runon states are.
149     */
150     #define SF_FIREON 0x01
151     #define SF_RUNON 0x02
152    
153     /* Flags for the item command */
154     enum {a_none, a_readied, a_wielded, a_worn, a_active, a_applied};
155     #define F_APPLIED 0x000F
156     #define F_LOCATION 0x00F0
157     #define F_UNPAID 0x0200
158     #define F_MAGIC 0x0400
159     #define F_CURSED 0x0800
160     #define F_DAMNED 0x1000
161     #define F_OPEN 0x2000
162     #define F_NOPICK 0x4000
163     #define F_LOCKED 0x8000
164    
165     #define CF_FACE_NONE 0
166     #define CF_FACE_BITMAP 1
167     #define CF_FACE_XPM 2
168     #define CF_FACE_PNG 3
169     #define CF_FACE_CACHE 0x10
170    
171     /* Used in the new_face structure on the magicmap field. Low bits
172     * are color informatin. For now, only high bit information we need
173     * is floor information.
174     */
175     #define FACE_FLOOR 0x80
176     #define FACE_WALL 0x40 /* Or'd into the color value by the server
177     * right before sending.
178     */
179     #define FACE_COLOR_MASK 0xf
180    
181     #define UPD_LOCATION 0x01
182     #define UPD_FLAGS 0x02
183     #define UPD_WEIGHT 0x04
184     #define UPD_FACE 0x08
185     #define UPD_NAME 0x10
186     #define UPD_ANIM 0x20
187     #define UPD_ANIMSPEED 0x40
188     #define UPD_NROF 0x80
189    
190     /* The flag values sent by the updspell command */
191     #define UPD_SP_MANA 0x01
192     #define UPD_SP_GRACE 0x02
193     #define UPD_SP_DAMAGE 0x04
194    
195     #define SOUND_NORMAL 0
196     #define SOUND_SPELL 1
197    
198     struct data
199     {
200     unsigned int len;
201     const void *ptr;
202    
203     data (const void *ptr, int len) : len (len), ptr (ptr) { }
204     data (const char *str) : len (strlen (str ? str : 0)), ptr ((void *)str) { }
205 root 1.23 data (shstr_tmp sh) : len (sh.length ()), ptr ((void *)&sh) { }
206 root 1.22 data (dynbuf &buf) : len (buf.size ()), ptr (buf.linearise ()) { }
207 root 1.1 };
208    
209     struct data8
210     {
211     unsigned int len;
212     const void *ptr;
213    
214     data8 (const void *ptr, int len) : len (len), ptr (ptr) { }
215     data8 (const char *str) : len (strlen (str ? str : 0)), ptr ((void *)str) { }
216 root 1.23 data8 (shstr_tmp sh) : len (sh.length ()), ptr ((void *)&sh) { }
217 root 1.22 data8 (dynbuf &buf) : len (buf.size ()), ptr (buf.linearise ()) { }
218 root 1.1 };
219    
220     struct data16
221     {
222     unsigned int len;
223     const void *ptr;
224    
225     data16 (const void *ptr, int len) : len (len), ptr (ptr) { }
226     data16 (const char *str) : len (strlen (str ? str : 0)), ptr ((void *)str) { }
227 root 1.23 data16 (shstr_tmp sh) : len (sh.length ()), ptr ((void *)&sh) { }
228 root 1.22 data16 (dynbuf &buf) : len (buf.size ()), ptr (buf.linearise ()) { }
229 root 1.1 };
230    
231 root 1.9 struct ber32
232     {
233 root 1.10 enum { size = 5 }; // maximum length of an encoded ber32
234 root 1.9 uint32 val;
235    
236     ber32 (uint32 val) : val (val) { }
237 root 1.16
238     static int encoded_size (uint32 val)
239     {
240     if (val >= (1 << 7*4)) return 5;
241     if (val >= (1 << 7*3)) return 4;
242     if (val >= (1 << 7*2)) return 3;
243     if (val >= (1 << 7*1)) return 2;
244     return 1;
245     }
246 root 1.9 };
247    
248 root 1.1 /* Contains the base information we use to make up a packet we want to send. */
249     struct packet
250     {
251     enum { bufsize = MAXSOCKBUF };
252     enum { hdrlen = 2 }; // keep this many bytes free at the front
253    
254     // strategy: only check on variable-length adds
255     // and allow 256 bytes for any headers.
256     uint8 *cur;
257     uint8 buf_ [hdrlen + bufsize + 256];
258    
259 root 1.5 packet ()
260     {
261     reset ();
262     }
263    
264     packet (const char *name);
265 root 1.1
266     uint8 operator [](unsigned int i) const { return buf_ [i + hdrlen]; }
267     uint8 &operator [](unsigned int i) { return buf_ [i + hdrlen]; }
268    
269     uint8 *buf () { return buf_ + hdrlen; }
270     const uint8 *buf () const { return buf_ + hdrlen; }
271    
272     void reset (int offset = 0) { cur = buf () + offset; }
273     int length () const { return cur - buf (); }
274     int room () { return bufsize - (cur - buf ()); }
275    
276     // unchecked
277     packet &operator <<(uint8 v) { *cur++ = v; return *this; }
278    
279     packet &operator <<(uint16 v) { return *this << uint8 (v >> 8) << uint8 (v); }
280     packet &operator <<(uint32 v) { return *this << uint16 (v >> 16) << uint16 (v); }
281     packet &operator <<(uint64 v) { return *this << uint32 (v >> 32) << uint32 (v); }
282    
283     packet &operator <<(sint8 v) { return *this << (uint8 )v; }
284     packet &operator <<(sint16 v) { return *this << (uint16)v; }
285     packet &operator <<(sint32 v) { return *this << (uint32)v; }
286     packet &operator <<(sint64 v) { return *this << (uint64)v; }
287    
288     // checked
289 root 1.9 packet &operator <<(const ber32 v);
290    
291 root 1.1 packet &operator <<(const data &v);
292     packet &operator <<(const data8 &v);
293     packet &operator <<(const data16 &v);
294    
295     packet &operator <<(const char *v);
296 root 1.23 packet &operator <<(shstr_tmp sh) { return *this << data (sh); }
297 root 1.11 packet &operator <<(const std::string &s) { return *this << data (s.data (), s.size ()); }
298 root 1.1
299 root 1.4 void vprintf (const char *format, va_list ap);
300    
301     void printf (const char *format, ...)
302     {
303     va_list ap;
304     va_start (ap, format);
305     vprintf (format, ap);
306     va_end (ap);
307     }
308 root 1.1 };
309    
310     inline uint16 net_uint16 (uint8 *data) { return (data [0] << 8) | data [1]; }
311     inline uint32 net_uint32 (uint8 *data) { return (net_uint16 (data) << 16) | net_uint16 (data + 2); }
312     inline sint16 net_sint16 (uint8 *data) { return sint16 (net_uint16 (data)); }
313     inline sint16 net_sint32 (uint8 *data) { return sint32 (net_uint32 (data)); }
314    
315     #endif
316