166af391e9574b7d6e5e7f7867bab05ab43c2e7f
[xonotic/xonotic-data.pk3dir.git] / qcsrc / common / util.qh
1 #define WANT_CONST
2 // commonly used, but better make them macros
3 #define TRUE 1
4 #define FALSE 0
5
6 // a dummy macro that prevents the "hanging ;" warning
7 #define ENDS_WITH_CURLY_BRACE
8
9 #ifdef GMQCC
10 # define ACCUMULATE_FUNCTION(func,otherfunc) \
11         [[accumulate]] void func() { otherfunc(); }
12 # define CALL_ACCUMULATED_FUNCTION(func) \
13         func()
14 #else
15 #ifdef HAVE_YO_DAWG_CPP
16 // TODO make ascii art pic of xzibit
17 // YO DAWG!
18 // I HERD YO LIEK MACROS
19 // SO I PUT A MACRO DEFINITION IN YO MACRO DEFINITION
20 // SO YO CAN EXPAND MACROS WHILE YO EXPAND MACROS
21 # define ACCUMULATE_FUNCTION(func,otherfunc) \
22         #ifdef func \
23         void __merge__##otherfunc() { func(); otherfunc(); } \
24         #undef func \
25         #define func __merge__##otherfunc \
26         #else \
27         #define func otherfunc \
28         #endif
29 # define CALL_ACCUMULATED_FUNCTION(func) \
30         func()
31 #else
32 # define ACCUMULATE_FUNCTION(func,otherfunc) \
33         .float _ACCUMULATE_##func##__##otherfunc
34 void ACCUMULATE_call(string func)
35 {
36         float i;
37         float n = numentityfields();
38         string funcprefix = strcat("_ACCUMULATE_", func, "__");
39         float funcprefixlen = strlen(funcprefix);
40         for(i = 0; i < n; ++i)
41         {
42                 string name = entityfieldname(i);
43                 if(substring(name, 0, funcprefixlen) == funcprefix)
44                         callfunction(substring(name, funcprefixlen, -1));
45         }
46 }
47 # define CALL_ACCUMULATED_FUNCTION(func) \
48         ACCUMULATE_call(#func)
49 #endif
50 #endif
51
52 // used for simplifying ACCUMULATE_FUNCTIONs
53 #define SET_FIRST_OR_LAST(input,first,count) if(!input) { input = (first + count); }
54 #define SET_FIELD_COUNT(field,first,count) if(!field) { field = (first + count); ++count; }
55 #define CHECK_MAX_COUNT(name,max,count,type) if(count == max) { error(strcat("Maximum ", type, " hit: ", #name, ": ", ftos(count), ".\n")); }
56
57 // this returns a tempstring containing a copy of s with additional \n newlines added, it also replaces \n in the text with a real newline
58 // NOTE: s IS allowed to be a tempstring
59 string wordwrap(string s, float l);
60 #ifndef MENUQC
61 #ifndef CSQC
62 void wordwrap_sprint(string s, float l);
63 #endif
64 #endif
65 void wordwrap_cb(string s, float l, void(string) callback);
66
67 #ifndef SVQC
68 string draw_currentSkin;
69 string draw_UseSkinFor(string pic);
70 #endif
71
72 // iterative depth-first search, with fields that go "up", "down left" and "right" in a tree
73 // for each element, funcPre is called first, then funcPre and funcPost for all its children, and funcPost last
74 void depthfirst(entity start, .entity up, .entity downleft, .entity right, void(entity, entity) funcPre, void(entity, entity) funcPost, entity pass);
75
76 float median(float a, float b, float c);
77
78 // converts a number to a string with the indicated number of decimals
79 // works for up to 10 decimals!
80 string ftos_decimals(float number, float decimals);
81
82 float fexists(string f);
83
84 vector colormapPaletteColor(float c, float isPants);
85
86 // unzone the string, and return it as tempstring. Safe to be called on string_null
87 string fstrunzone(string s);
88
89 // database (NOTE: keys are case sensitive)
90 void db_save(float db, string filename);
91 void db_dump(float db, string pFilename);
92 float db_create();
93 float db_load(string filename);
94 void db_close(float db);
95 string db_get(float db, string key);
96 void db_put(float db, string key, string value);
97
98 // stringbuffer loading/saving
99 float buf_load(string filename);
100 void buf_save(float buf, string filename);
101
102 // modulo function
103 #ifndef MENUQC
104 float mod(float a, float b) { return a - (floor(a / b) * b); }   
105 #endif
106
107 #define TIME_TO_NTHS(t,n) floor((t) * (n) + 0.4)
108 string mmsss(float t);
109 string mmssss(float t);
110
111 #define TIME_DECIMALS 2
112 #define TIME_FACTOR 100
113 #define TIME_ENCODED_TOSTRING(n) mmssss(n)
114 #define RACE_RECORD "/race100record/"
115 #define CTS_RECORD "/cts100record/"
116 #define TIME_ENCODE(t) TIME_TO_NTHS(t, TIME_FACTOR)
117 #define TIME_DECODE(n) ((n) / TIME_FACTOR)
118
119 string ScoreString(float vflags, float value);
120
121 float dotproduct(vector a, vector b);
122 vector cross(vector a, vector b);
123
124 void compressShortVector_init();
125 vector decompressShortVector(float data);
126 float compressShortVector(vector vec);
127
128 #ifndef MENUQC
129 float CheckWireframeBox(entity forent, vector v0, vector dvx, vector dvy, vector dvz);
130 #endif
131
132 string fixPriorityList(string pl, float from, float to, float subtract, float complete);
133 string mapPriorityList(string order, string(string) mapfunc);
134 string swapInPriorityList(string order, float i, float j);
135
136 float cvar_value_issafe(string s);
137
138 float cvar_settemp(string pKey, string pValue);
139 float cvar_settemp_restore();
140
141 #ifndef MENUQC
142 // modes: 0 = trust q3map2 (_mini images)
143 //        1 = trust tracebox (_radar images)
144 // in both modes, mapinfo's "size" overrides
145
146 string mi_shortname;
147 vector mi_min;
148 vector mi_max;
149 void get_mi_min_max(float mode);
150
151 vector mi_picmin; // adjusted mins that map to the picture (square)
152 vector mi_picmax; // adjusted maxs that map to the picture (square)
153 vector mi_pictexcoord0; // texcoords of the image corners (after transforming, these are 2D coords too)
154 vector mi_pictexcoord1; // texcoords of the image corners (after transforming, these are 2D coords too)
155 vector mi_pictexcoord2; // texcoords of the image corners (after transforming, these are 2D coords too)
156 vector mi_pictexcoord3; // texcoords of the image corners (after transforming, these are 2D coords too)
157 void get_mi_min_max_texcoords(float mode);
158 #endif
159
160 float almost_equals(float a, float b);
161 float almost_in_bounds(float a, float b, float c);
162
163 float power2of(float e);
164 float log2of(float x);
165
166 const string HEXDIGITS = "0123456789ABCDEF0123456789abcdef";
167 #define HEXDIGIT_TO_DEC_RAW(d) (strstrofs(HEXDIGITS, (d), 0))
168 #define HEXDIGIT_TO_DEC(d) ((HEXDIGIT_TO_DEC_RAW(d) | 0x10) - 0x10)
169 #define DEC_TO_HEXDIGIT(d) (substring(HEXDIGITS, (d), 1))
170
171 vector rgb_to_hsl(vector rgb);
172 vector hsl_to_rgb(vector hsl);
173 vector rgb_to_hsv(vector rgb);
174 vector hsv_to_rgb(vector hsv);
175 string rgb_to_hexcolor(vector rgb);
176
177 float boxesoverlap(vector m1, vector m2, vector m3, vector m4);
178 float boxinsidebox(vector smins, vector smaxs, vector bmins, vector bmaxs);
179
180 typedef float(string s, vector size) textLengthUpToWidth_widthFunction_t;
181 typedef float(string s) textLengthUpToLength_lenFunction_t;
182 float textLengthUpToWidth(string theText, float maxWidth, vector size, textLengthUpToWidth_widthFunction_t tw);
183 string textShortenToWidth(string theText, float maxWidth, vector size, textLengthUpToWidth_widthFunction_t tw);
184 float textLengthUpToLength(string theText, float maxWidth, textLengthUpToLength_lenFunction_t tw);
185 string textShortenToLength(string theText, float maxWidth, textLengthUpToLength_lenFunction_t tw);
186
187 string getWrappedLine_remaining;
188 string getWrappedLine(float w, vector size, textLengthUpToWidth_widthFunction_t tw);
189 string getWrappedLineLen(float w, textLengthUpToLength_lenFunction_t tw);
190
191 float isGametypeInFilter(float gt, float tp, float ts, string pattern);
192
193 typedef void(float i1, float i2, entity pass) swapfunc_t; // is only ever called for i1 < i2
194 typedef float(float i1, float i2, entity pass) comparefunc_t; // <0 for <, ==0 for ==, >0 for > (like strcmp)
195 void shuffle(float n, swapfunc_t swap, entity pass);
196 void heapsort(float n, swapfunc_t swap, comparefunc_t cmp, entity pass);
197
198 string swapwords(string str, float i, float j);
199 string shufflewords(string str);
200
201 string substring_range(string s, float b, float e);
202
203 vector solve_quadratic(float a, float b, float c);
204 // solution 1 -> x
205 // solution 2 -> y
206 // z = 1 if a real solution exists, 0 if not
207 // if no real solution exists, x contains the real part and y the imaginary part of the complex solutions x+iy and x-iy
208
209 vector solve_shotdirection(vector myorg, vector myvel, vector eorg, vector evel, float spd, float newton_style);
210 vector get_shotvelocity(vector myvel, vector mydir, float spd, float newton_style, float mi, float ma);
211
212 void check_unacceptable_compiler_bugs();
213
214 float compressShotOrigin(vector v);
215 vector decompressShotOrigin(float f);
216
217 #ifdef SVQC
218 string rankings_reply, ladder_reply, lsmaps_reply, maplist_reply; // cached replies
219 string records_reply[10];
220 #endif
221
222 float RandomSelection_totalweight;
223 float RandomSelection_best_priority;
224 entity RandomSelection_chosen_ent;
225 float RandomSelection_chosen_float;
226 string RandomSelection_chosen_string;
227 void RandomSelection_Init();
228 void RandomSelection_Add(entity e, float f, string s, float weight, float priority);
229
230 #ifndef MENUQC
231 vector healtharmor_maxdamage(float h, float a, float armorblock, float deathtype); // returns vector: maxdamage, armorideal, 1 if fully armored
232 vector healtharmor_applydamage(float a, float armorblock, float deathtype, float damage); // returns vector: take, save, 0
233 #endif
234
235 string getcurrentmod();
236
237 #ifndef MENUQC
238 #ifdef CSQC
239 float ReadInt24_t();
240 vector ReadInt48_t();
241 vector ReadInt72_t();
242 #else
243 void WriteInt24_t(float dest, float val);
244 void WriteInt48_t(float dest, vector val);
245 void WriteInt72_t(float dest, vector val);
246 #endif
247 #endif
248
249 // the NULL function
250 #ifdef GMQCC
251 #define func_null nil
252 #define string_null nil
253 #else
254 var void func_null(void);
255 var string string_null;
256 #endif
257 float float2range11(float f);
258 float float2range01(float f);
259
260 float gsl_ran_gaussian(float sigma);
261
262 string car(string s); // returns first word
263 string cdr(string s); // returns all but first word
264 float matchacl(string acl, string str); // matches str against ACL acl (with entries +foo*, +foo, +*foo, +*foo*, and same with - for forbidding)
265 float startsWith(string haystack, string needle);
266 float startsWithNocase(string haystack, string needle);
267
268 string get_model_datafilename(string mod, float skn, string fil); // skin -1 will return wildcard, mod string_null will also put wildcard there
269 string get_model_parameters_modelname;
270 float get_model_parameters_modelskin;
271 string get_model_parameters_name;
272 float get_model_parameters_species;
273 string get_model_parameters_sex;
274 float get_model_parameters_weight;
275 float get_model_parameters_age;
276 string get_model_parameters_bone_upperbody;
277 string get_model_parameters_bone_weapon;
278 #define MAX_AIM_BONES 4
279 string get_model_parameters_bone_aim[MAX_AIM_BONES];
280 float get_model_parameters_bone_aimweight[MAX_AIM_BONES];
281 float get_model_parameters_fixbone;
282 string get_model_parameters_desc;
283 float get_model_parameters(string mod, float skn); // call with string_null to clear; skin -1 means mod is the filename of the txt file and is to be split
284
285 vector vec2(vector v);
286
287 #ifndef MENUQC
288 vector NearestPointOnBox(entity box, vector org);
289 #endif
290
291 float vercmp(string v1, string v2);
292
293 float u8_strsize(string s);
294
295 // translation helpers
296 string prvm_language;
297 string language_filename(string s);
298 string CTX(string s);
299 #define ZCTX(s) strzone(CTX(s))
300
301 // x-encoding (encoding as zero length invisible string)
302 // encodes approx. 14 bits into 5 bytes of color code string
303 const float XENCODE_MAX = 21295; // 2*22*22*22-1
304 const float XENCODE_LEN = 5;
305 string xencode(float f);
306 float xdecode(string s);
307
308 #ifndef COMPAT_XON010_CHANNELS
309 #define sound(e,c,s,v,a) sound7(e,c,s,v,a,0,0)
310 #endif
311
312 float lowestbit(float f);
313
314 #ifdef CSQC
315 entity ReadCSQCEntity();
316 #endif
317
318 #ifndef MENUQC
319 string strtolower(string s);
320 #endif
321
322 string MakeConsoleSafe(string input);
323
324 #ifndef MENUQC
325 float InterpretBoolean(string input);
326 #endif
327
328 // generic shutdown handler
329 void Shutdown();
330
331 #ifndef MENUQC
332 .float skeleton_bones;
333 void Skeleton_SetBones(entity e);
334 // loops through the tags of model v using counter tagnum
335 #define FOR_EACH_TAG(v) float tagnum; Skeleton_SetBones(v); for(tagnum = 0; tagnum < v.skeleton_bones; tagnum++, gettaginfo(v, tagnum))
336 #endif
337 #ifdef SVQC
338 void WriteApproxPastTime(float dst, float t);
339 #endif
340 #ifdef CSQC
341 float ReadApproxPastTime();
342 #endif
343
344 // execute-stuff-next-frame subsystem
345 void execute_next_frame();
346 void queue_to_execute_next_frame(string s);
347
348 // for marking written-to values as unused where it's a good idea to do this
349 noref float unused_float;
350
351 // a function f with:
352 // f(0) = 0
353 // f(1) = 1
354 // f'(0) = startspeedfactor
355 // f'(1) = endspeedfactor
356 float cubic_speedfunc(float startspeedfactor, float endspeedfactor, float x);
357
358 // checks whether f'(x) = 0 anywhere from 0 to 1
359 // because if this is the case, the function is not usable for platforms
360 // as it may exceed 0..1 bounds, or go in reverse
361 float cubic_speedfunc_is_sane(float startspeedfactor, float endspeedfactor);
362
363 typedef entity(entity cur, entity near, entity pass) findNextEntityNearFunction_t;
364 typedef float(entity a, entity b, entity pass) isConnectedFunction_t;
365 void FindConnectedComponent(entity e, .entity fld, findNextEntityNearFunction_t nxt, isConnectedFunction_t iscon, entity pass);
366
367 // expand multiple arguments into one argument by stripping parenthesis
368 #define XPD(...) __VA_ARGS__
369
370 #ifndef MENUQC
371 void backtrace(string msg);
372 #endif
373
374 // color code replace, place inside of sprintf and parse the string... defaults described as constants
375 // foreground/normal colors
376 var string autocvar_hud_colorset_foreground_1 = "2"; // F1 - Green  // primary priority (important names, etc)
377 var string autocvar_hud_colorset_foreground_2 = "3"; // F2 - Yellow // secondary priority (items, locations, numbers, etc)
378 var string autocvar_hud_colorset_foreground_3 = "4"; // F3 - Blue   // tertiary priority or relatively inconsequential text
379 var string autocvar_hud_colorset_foreground_4 = "1"; // F4 - Red    // notice/attention grabbing texting
380 // "kill" colors
381 var string autocvar_hud_colorset_kill_1 = "1"; // K1 - Red    // "bad" or "dangerous" text (death messages against you, kill notifications, etc)
382 var string autocvar_hud_colorset_kill_2 = "3"; // K2 - Yellow // similar to above, but less important... OR, a highlight out of above message type
383 var string autocvar_hud_colorset_kill_3 = "4"; // K3 - Blue   // "good" or "beneficial" text (you fragging someone, etc)
384 // background color
385 var string autocvar_hud_colorset_background = "7"; // BG - White // neutral/unimportant text
386
387 string CCR(string input);
388
389 #ifndef MENUQC
390 #ifdef CSQC
391 #define GENTLE (autocvar_cl_gentle || autocvar_cl_gentle_messages)
392 #else
393 #define GENTLE autocvar_sv_gentle
394 #endif
395 #define normal_or_gentle(normal,gentle) (GENTLE ? ((gentle != "") ? gentle : normal) : normal)
396 #endif
397
398 // allow writing to also pass through to spectators (like so spectators see the same centerprints as players for example)
399 #define WRITESPECTATABLE_MSG_ONE_VARNAME(varname,statement) entity varname; varname = msg_entity; FOR_EACH_REALCLIENT(msg_entity) if(msg_entity == varname || (msg_entity.classname == STR_SPECTATOR && msg_entity.enemy == varname)) statement msg_entity = varname
400 #define WRITESPECTATABLE_MSG_ONE(statement) WRITESPECTATABLE_MSG_ONE_VARNAME(oldmsg_entity, statement)
401 #define WRITESPECTATABLE(msg,statement) if(msg == MSG_ONE) { WRITESPECTATABLE_MSG_ONE(statement); } else statement float WRITESPECTATABLE_workaround = 0
402
403 vector vec3(float x, float y, float z);
404
405 #ifndef MENUQC
406 vector animfixfps(entity e, vector a, vector b);
407 #endif
408
409 #ifdef SVQC
410 void dedicated_print(string input);
411 #endif
412
413 // todo: better way to do this?
414 #ifdef MENUQC
415 #define PROGNAME "MENUQC"
416 #else
417 #ifdef SVQC
418 #define PROGNAME "SVQC"
419 #else
420 #define PROGNAME "CSQC"
421 #endif
422 #endif
423
424 #ifndef MENUQC
425 #define CNT_NORMAL 1
426 #define CNT_GAMESTART 2
427 #define CNT_IDLE 3
428 #define CNT_KILL 4
429 #define CNT_RESPAWN 5
430 #define CNT_ROUNDSTART 6
431 float Announcer_PickNumber(float type, float num);
432 #endif