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