qdefs: Define separate FLOAT_ and DOUBLE_ versions of lossless format and true for...
[xonotic/darkplaces.git] / qdefs.h
1 #ifndef QDEFS_H
2 #define QDEFS_H
3
4 #if defined (__GNUC__) || defined (__clang__) || defined (__TINYC__)
5 #define DP_GCC_COMPATIBLE
6 #endif
7
8 #if (__GNUC__ > 2) || defined (__clang__) || (__TINYC__)
9 #define DP_FUNC_PRINTF(n) __attribute__ ((format (printf, n, n+1)))
10 #define DP_FUNC_PURE      __attribute__ ((pure))
11 #define DP_FUNC_NORETURN  __attribute__ ((noreturn))
12 #define DP_FUNC_ALWAYSINLINE inline __attribute__((always_inline))
13 #else
14 #define DP_FUNC_PRINTF(n)
15 #define DP_FUNC_PURE
16 #define DP_FUNC_NORETURN
17 # if defined (MSVC)
18 # define DP_FUNC_ALWAYSINLINE __forceinline
19 # else
20 # define DP_FUNC_ALWAYS_INLINE inline
21 # endif
22 #endif
23
24 #ifdef DP_GCC_COMPATIBLE
25 #define Q_typeof(var) typeof(var)
26 #elif defined (MSVC)
27 #define Q_typeof(var) decltype(var)
28 #endif
29
30 #define MAX_NUM_ARGVS   50
31
32 #ifdef DP_SMALLMEMORY
33 #define MAX_INPUTLINE                   1024
34 #define CON_TEXTSIZE                    16384
35 #define CON_MAXLINES                    256
36 #define HIST_TEXTSIZE                   2048
37 #define HIST_MAXLINES                   16
38 #define MAX_ALIAS_NAME                  32
39 #define CMDBUFSIZE                              131072
40 #define MAX_ARGS                                80
41
42 #define NET_MAXMESSAGE                  65536
43 #define MAX_PACKETFRAGMENT              1024
44 #define MAX_EDICTS                              4096
45 #define MAX_MODELS                              1024
46 #define MAX_SOUNDS                              1024
47 #define MAX_LIGHTSTYLES                 64
48 #define MAX_STYLESTRING                 16
49 #define MAX_SCOREBOARD                  32
50 #define MAX_SCOREBOARDNAME              128
51 #define MAX_USERINFO_STRING             196
52 #define MAX_SERVERINFO_STRING   512
53 #define MAX_LOCALINFO_STRING    1 // not actually used by DP servers
54 #define CL_MAX_USERCMDS                 32
55 #define CVAR_HASHSIZE                   1024
56 #define M_MAX_EDICTS                    4096
57 #define MAX_DEMOS                               8
58 #define MAX_DEMONAME                    16
59 #define MAX_SAVEGAMES                   12
60 #define SAVEGAME_COMMENT_LENGTH 39
61 #define MAX_CLIENTNETWORKEYES   2
62 #define MAX_LEVELNETWORKEYES    0 // no portal support
63 #define MAX_OCCLUSION_QUERIES   256
64
65 #define CRYPTO_HOSTKEY_HASHSIZE 256
66 #define MAX_NETWM_ICON 1026 // one 32x32
67
68 #define MAX_WATERPLANES                 2
69 #define MAX_CUBEMAPS                    1024
70 #define MAX_EXPLOSIONS                  8
71 #define MAX_DLIGHTS                             16
72 #define MAX_CACHED_PICS                 2048 // this is 144 bytes each (or 152 on 64bit)
73 #define CACHEPICHASHSIZE                256
74 #define MAX_PARTICLEEFFECTNAME  256
75 #define MAX_PARTICLEEFFECTINFO  1024
76 #define MAX_PARTICLETEXTURES    256
77 #define MAXCLVIDEOS                             1
78 #define MAX_DYNAMIC_TEXTURE_COUNT       2
79 #define MAX_MAP_LEAFS                   8192
80
81 #define MAXTRACKS                               256
82 #define MAX_DYNAMIC_CHANNELS    64
83 #define MAX_CHANNELS                    260
84 #define MODLIST_TOTALSIZE               32
85 #define MAX_FAVORITESERVERS             32
86 #define MAX_DECALSYSTEM_QUEUE   64
87 #define PAINTBUFFER_SIZE                512
88 #define MAX_BINDMAPS                    8
89 #define MAX_PARTICLES_INITIAL   8192
90 #define MAX_PARTICLES                   8192
91 #define MAX_ENTITIES_INITIAL    256
92 #define MAX_STATICENTITIES              256
93 #define MAX_EFFECTS                             16
94 #define MAX_BEAMS                               16
95 #define MAX_TEMPENTITIES                256
96 #define SERVERLIST_TOTALSIZE            1024
97 #define SERVERLIST_ANDMASKCOUNT         5
98 #define SERVERLIST_ORMASKCOUNT          5
99 #else
100 #define MAX_INPUTLINE                   16384 ///< maximum length of console commandline, QuakeC strings, and many other text processing buffers
101 #define CON_TEXTSIZE                    1048576 ///< max scrollback buffer characters in console
102 #define CON_MAXLINES                    16384 ///< max scrollback buffer lines in console
103 #define HIST_TEXTSIZE                   262144 ///< max command history buffer characters in console
104 #define HIST_MAXLINES                   4096 ///< max command history buffer lines in console
105 #define MAX_ALIAS_NAME                  32
106 #define CMDBUFSIZE                              655360 ///< maximum script size that can be loaded by the exec command (8192 in Quake)
107 #define MAX_ARGS                                80 ///< maximum number of parameters to a console command or alias
108
109 #define NET_MAXMESSAGE                  65536 ///< max reliable packet size (sent as multiple fragments of MAX_PACKETFRAGMENT)
110 #define MAX_PACKETFRAGMENT              1024 ///< max length of packet fragment
111 #define MAX_EDICTS                              32768 ///< max number of objects in game world at once (32768 protocol limit)
112 #define MAX_MODELS                              8192 ///< max number of models loaded at once (including during level transitions)
113 #define MAX_SOUNDS                              4096 ///< max number of sounds loaded at once
114 #define MAX_LIGHTSTYLES                 256 ///< max flickering light styles in level (note: affects savegame format)
115 #define MAX_STYLESTRING                 64 ///< max length of flicker pattern for light style
116 #define MAX_SCOREBOARD                  255 ///< max number of players in game at once (255 protocol limit)
117 #define MAX_SCOREBOARDNAME              128 ///< max length of player name in game
118 #define MAX_USERINFO_STRING             1280 ///< max length of infostring for PROTOCOL_QUAKEWORLD (196 in QuakeWorld)
119 #define MAX_SERVERINFO_STRING   1280 ///< max length of server infostring for PROTOCOL_QUAKEWORLD (512 in QuakeWorld)
120 #define MAX_LOCALINFO_STRING    32768 ///< max length of server-local infostring for PROTOCOL_QUAKEWORLD (32768 in QuakeWorld)
121 #define CL_MAX_USERCMDS                 128 ///< max number of predicted input packets in queue
122 #define CVAR_HASHSIZE                   65536 ///< number of hash buckets for accelerating cvar name lookups
123 #define M_MAX_EDICTS                    32768 ///< max objects in menu vm
124 #define MAX_DEMOS                               8 ///< max demos provided to demos command
125 #define MAX_DEMONAME                    16 ///< max demo name length for demos command
126 #define MAX_SAVEGAMES                   12 ///< max savegames listed in savegame menu
127 #define SAVEGAME_COMMENT_LENGTH 39 ///< max comment length of savegame in menu
128 #define MAX_CLIENTNETWORKEYES   16 ///< max number of locations that can be added to pvs when culling network entities (must be at least 2 for prediction)
129 #define MAX_LEVELNETWORKEYES    512 ///< max number of locations that can be added to pvs when culling network entities (must be at least 2 for prediction)
130 #define MAX_OCCLUSION_QUERIES   4096 ///< max number of query objects that can be used in one frame
131
132 #define CRYPTO_HOSTKEY_HASHSIZE 8192 ///< number of hash buckets for accelerating host key lookups
133 #define MAX_NETWM_ICON 352822 // 16x16, 22x22, 24x24, 32x32, 48x48, 64x64, 128x128, 256x256, 512x512
134
135 #define MAX_WATERPLANES                 16 ///< max number of water planes visible (each one causes additional view renders)
136 #define MAX_CUBEMAPS                    1024 ///< max number of cubemap textures loaded for light filters
137 #define MAX_EXPLOSIONS                  64 ///< max number of explosion shell effects active at once (not particle related)
138 #define MAX_DLIGHTS                             256 ///< max number of dynamic lights (rocket flashes, etc) in scene at once
139 #define MAX_CACHED_PICS                 2048 ///< max number of 2D pics loaded at once
140 #define CACHEPICHASHSIZE                256 ///< number of hash buckets for accelerating 2D pic name lookups
141 #define MAX_PARTICLEEFFECTNAME  4096 ///< maximum number of unique names of particle effects (for particleeffectnum)
142 #define MAX_PARTICLEEFFECTINFO  8192 ///< maximum number of unique particle effects (each name may associate with several of these)
143 #define MAX_PARTICLETEXTURES    256 ///< maximum number of unique particle textures in the particle font
144 #define MAXCLVIDEOS                             65 ///< maximum number of video streams being played back at once (1 is reserved for the playvideo command)
145 #define MAX_DYNAMIC_TEXTURE_COUNT       64 ///< maximum number of dynamic textures (web browsers, playvideo, etc)
146 #define MAX_MAP_LEAFS                   65536 ///< maximum number of BSP leafs in world (8192 in Quake)
147
148 #define MAXTRACKS                               256 ///< max CD track index
149 // 0 to NUM_AMBIENTS - 1 = water, etc
150 // NUM_AMBIENTS to NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS - 1 = normal entity sounds
151 // NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS to total_channels = static sounds
152 #define MAX_DYNAMIC_CHANNELS    512
153 #define MAX_CHANNELS                    (8192 + 4)
154 #define MODLIST_TOTALSIZE               256
155 #define MAX_FAVORITESERVERS             256
156 #define MAX_DECALSYSTEM_QUEUE   1024
157 #define PAINTBUFFER_SIZE                2048
158 #define MAX_BINDMAPS                    8
159 #define MAX_PARTICLES_INITIAL   8192 ///< initial allocation for cl.particles
160 #define MAX_PARTICLES                   1048576 ///< upper limit on cl.particles size
161 #define MAX_ENTITIES_INITIAL            256 ///< initial size of cl.entities
162 #define MAX_STATICENTITIES              4096 ///< limit on size of cl.static_entities
163 #define MAX_EFFECTS                             256 ///< limit on size of cl.effects
164 #define MAX_BEAMS                               256 ///< limit on size of cl.beams
165 #define MAX_TEMPENTITIES                4096 ///< max number of temporary models visible per frame (certain sprite effects, certain types of CSQC entities also use this)
166 #define SERVERLIST_TOTALSIZE            2048 ///< max servers in the server list
167 #define SERVERLIST_ANDMASKCOUNT         16 ///< max items in server list AND mask
168 #define SERVERLIST_ORMASKCOUNT          16 ///< max items in server list OR mask
169 #endif
170
171
172 #define CMD_TOKENIZELENGTH (MAX_INPUTLINE + MAX_ARGS) ///< maximum tokenizable commandline length (counting trailing 0)
173
174
175 #define MAX_QPATH               128                     ///< max length of a quake game pathname
176 #ifdef PATH_MAX
177 #define MAX_OSPATH              PATH_MAX
178 #elif MAX_PATH
179 #define MAX_OSPATH              MAX_PATH
180 #else
181 #define MAX_OSPATH              1024            ///< max length of a filesystem pathname
182 #endif
183
184 #define ON_EPSILON              0.1                     ///< point on plane side epsilon
185
186 #define NET_MINRATE             1000 ///< limits "rate" and "sv_maxrate" cvars
187
188 // In Quake, any char in 0..32 counts as whitespace
189 //#define ISWHITESPACE(ch) ((unsigned char) ch <= (unsigned char) ' ')
190 #define ISWHITESPACE(ch) (!(ch) || (ch) == ' ' || (ch) == '\t' || (ch) == '\r' || (ch) == '\n')
191 #define ISCOMMENT(ch, pos) ch[pos] == '/' && ch[pos + 1] == '/' && (pos == 0 || ISWHITESPACE(ch[pos - 1]))
192 // This also includes extended characters, and ALL control chars
193 #define ISWHITESPACEORCONTROL(ch) ((signed char) (ch) <= (signed char) ' ')
194
195 #define DOUBLE_IS_TRUE_FOR_INT(x) ((x) & 0x7FFFFFFFFFFFFFFF) // also match "negative zero" doubles of value 0x8000000000000000
196 #define DOUBLE_LOSSLESS_FORMAT "%.17g"
197 #define DOUBLE_VECTOR_LOSSLESS_FORMAT "%.17g %.17g %.17g"
198
199 #define FLOAT_IS_TRUE_FOR_INT(x) ((x) & 0x7FFFFFFF) // also match "negative zero" floats of value 0x80000000
200 #define FLOAT_LOSSLESS_FORMAT "%.9g"
201 #define FLOAT_VECTOR_LOSSLESS_FORMAT "%.9g %.9g %.9g"
202
203 // originally this was _MSC_VER
204 // but here we want to test the system libc, which on win32 is borked, and NOT the compiler
205 #ifdef WIN32
206 #define INT_LOSSLESS_FORMAT_SIZE "I64"
207 #define INT_LOSSLESS_FORMAT_CONVERT_S(x) ((__int64)(x))
208 #define INT_LOSSLESS_FORMAT_CONVERT_U(x) ((unsigned __int64)(x))
209 #else
210 #define INT_LOSSLESS_FORMAT_SIZE "j"
211 #define INT_LOSSLESS_FORMAT_CONVERT_S(x) ((intmax_t)(x))
212 #define INT_LOSSLESS_FORMAT_CONVERT_U(x) ((uintmax_t)(x))
213 #endif
214
215 // simple safe library to handle integer overflows when doing buffer size calculations
216 // Usage:
217 //   - calculate data size using INTOVERFLOW_??? macros
218 //   - compare: calculated-size <= INTOVERFLOW_NORMALIZE(buffersize)
219 // Functionality:
220 //   - all overflows (values > INTOVERFLOW_MAX) and errors are mapped to INTOVERFLOW_MAX
221 //   - if any input of an operation is INTOVERFLOW_MAX, INTOVERFLOW_MAX will be returned
222 //   - otherwise, regular arithmetics apply
223
224 #define INTOVERFLOW_MAX 2147483647
225
226 #define INTOVERFLOW_ADD(a,b) (((a) < INTOVERFLOW_MAX && (b) < INTOVERFLOW_MAX && (a) < INTOVERFLOW_MAX - (b)) ? ((a) + (b)) : INTOVERFLOW_MAX)
227 #define INTOVERFLOW_SUB(a,b) (((a) < INTOVERFLOW_MAX && (b) < INTOVERFLOW_MAX && (b) <= (a))                  ? ((a) - (b)) : INTOVERFLOW_MAX)
228 #define INTOVERFLOW_MUL(a,b) (((a) < INTOVERFLOW_MAX && (b) < INTOVERFLOW_MAX && (a) < INTOVERFLOW_MAX / (b)) ? ((a) * (b)) : INTOVERFLOW_MAX)
229 #define INTOVERFLOW_DIV(a,b) (((a) < INTOVERFLOW_MAX && (b) < INTOVERFLOW_MAX && (b) > 0)                     ? ((a) / (b)) : INTOVERFLOW_MAX)
230
231 #define INTOVERFLOW_NORMALIZE(a) (((a) < INTOVERFLOW_MAX) ? (a) : (INTOVERFLOW_MAX - 1))
232
233 #endif