3ce173bf638e95d705a70042fc6bfae62f4838aa
[xonotic/xonotic-data.pk3dir.git] / qcsrc / common / util.qh
1 // a dummy macro that prevents the "hanging ;" warning
2 #define ENDS_WITH_CURLY_BRACE
3
4 // TODO make ascii art pic of xzibit
5 // YO DAWG!
6 // I HERD YO LIEK MACROS
7 // SO I PUT A MACRO DEFINITION IN YO MACRO DEFINITION
8 // SO YO CAN EXPAND MACROS WHILE YO EXPAND MACROS
9 #define ACCUMULATE_FUNCTION(func,otherfunc) \
10         #ifdef func \
11         void __merge__##otherfunc() { func(); otherfunc(); } \
12         #undef func \
13         #define func __merge__##otherfunc \
14         #else \
15         #define func otherfunc \
16         #endif
17
18 // 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
19 // NOTE: s IS allowed to be a tempstring
20 string wordwrap(string s, float l);
21 #ifndef MENUQC
22 #ifndef CSQC
23 void wordwrap_sprint(string s, float l);
24 #endif
25 #endif
26 void wordwrap_cb(string s, float l, void(string) callback)
27
28 #ifndef SVQC
29 string draw_currentSkin;
30 string draw_UseSkinFor(string pic);
31 #endif
32
33 // iterative depth-first search, with fields that go "up", "down left" and "right" in a tree
34 // for each element, funcPre is called first, then funcPre and funcPost for all its children, and funcPost last
35 void depthfirst(entity start, .entity up, .entity downleft, .entity right, void(entity, entity) funcPre, void(entity, entity) funcPost, entity pass);
36
37 float median(float a, float b, float c);
38
39 // converts a number to a string with the indicated number of decimals
40 // works for up to 10 decimals!
41 string ftos_decimals(float number, float decimals);
42
43 float fexists(string f);
44
45 vector colormapPaletteColor(float c, float isPants);
46
47 // unzone the string, and return it as tempstring. Safe to be called on string_null
48 string fstrunzone(string s);
49
50 // database (NOTE: keys are case sensitive)
51 void db_save(float db, string filename);
52 void db_dump(float db, string pFilename);
53 float db_create();
54 float db_load(string filename);
55 void db_close(float db);
56 string db_get(float db, string key);
57 void db_put(float db, string key, string value);
58
59 // stringbuffer loading/saving
60 float buf_load(string filename);
61 void buf_save(float buf, string filename);
62
63 // modulo function
64 #ifndef MENUQC
65 float mod(float a, float b) { return a - (floor(a / b) * b); }   
66 #endif
67
68 #define TIME_TO_NTHS(t,n) floor((t) * (n) + 0.4)
69 string mmsss(float t);
70 string mmssss(float t);
71
72 #define TIME_DECIMALS 2
73 #define TIME_FACTOR 100
74 #define TIME_ENCODED_TOSTRING(n) mmssss(n)
75 #define RACE_RECORD "/race100record/"
76 #define CTS_RECORD "/cts100record/"
77 #define TIME_ENCODE(t) TIME_TO_NTHS(t, TIME_FACTOR)
78 #define TIME_DECODE(n) ((n) / TIME_FACTOR)
79
80 string ScoreString(float vflags, float value);
81
82 vector cross(vector a, vector b);
83
84 void compressShortVector_init();
85 vector decompressShortVector(float data);
86 float compressShortVector(vector vec);
87
88 #ifndef MENUQC
89 float CheckWireframeBox(entity forent, vector v0, vector dvx, vector dvy, vector dvz);
90 #endif
91
92 string fixPriorityList(string pl, float from, float to, float subtract, float complete);
93 string mapPriorityList(string order, string(string) mapfunc);
94 string swapInPriorityList(string order, float i, float j);
95
96 float cvar_value_issafe(string s);
97
98 float cvar_settemp(string pKey, string pValue);
99 float cvar_settemp_restore();
100
101 #ifndef MENUQC
102 // modes: 0 = trust q3map2 (_mini images)
103 //        1 = trust tracebox (_radar images)
104 // in both modes, mapinfo's "size" overrides
105
106 string mi_shortname;
107 vector mi_min;
108 vector mi_max;
109 void get_mi_min_max(float mode);
110
111 vector mi_picmin; // adjusted mins that map to the picture (square)
112 vector mi_picmax; // adjusted maxs that map to the picture (square)
113 vector mi_pictexcoord0; // texcoords of the image corners (after transforming, these are 2D coords too)
114 vector mi_pictexcoord1; // texcoords of the image corners (after transforming, these are 2D coords too)
115 vector mi_pictexcoord2; // texcoords of the image corners (after transforming, these are 2D coords too)
116 vector mi_pictexcoord3; // texcoords of the image corners (after transforming, these are 2D coords too)
117 void get_mi_min_max_texcoords(float mode);
118 #endif
119
120 #define FTEQCC_YOU_SUCK_THIS_IS_NOT_UNREFERENCED(x) void reference_##x() { x = x; }
121
122 float almost_equals(float a, float b);
123 float almost_in_bounds(float a, float b, float c);
124
125 float power2of(float e);
126 float log2of(float x);
127
128 string HEXDIGITS = "0123456789ABCDEF0123456789abcdef";
129 #define HEXDIGIT_TO_DEC_RAW(d) (strstrofs(HEXDIGITS, (d), 0))
130 #define HEXDIGIT_TO_DEC(d) ((HEXDIGIT_TO_DEC_RAW(d) | 0x10) - 0x10)
131 #define DEC_TO_HEXDIGIT(d) (substring(HEXDIGITS, (d), 1))
132
133 vector rgb_to_hsl(vector rgb);
134 vector hsl_to_rgb(vector hsl);
135 vector rgb_to_hsv(vector rgb);
136 vector hsv_to_rgb(vector hsv);
137 string rgb_to_hexcolor(vector rgb);
138
139 float boxesoverlap(vector m1, vector m2, vector m3, vector m4);
140 float boxinsidebox(vector smins, vector smaxs, vector bmins, vector bmaxs);
141
142 typedef float(string s, vector size) textLengthUpToWidth_widthFunction_t;
143 typedef float(string s) textLengthUpToLength_lenFunction_t;
144 float textLengthUpToWidth(string theText, float maxWidth, vector size, textLengthUpToWidth_widthFunction_t tw);
145 string textShortenToWidth(string theText, float maxWidth, vector size, textLengthUpToWidth_widthFunction_t tw);
146 float textLengthUpToLength(string theText, float maxWidth, textLengthUpToLength_lenFunction_t tw);
147 string textShortenToLength(string theText, float maxWidth, textLengthUpToLength_lenFunction_t tw);
148
149 string getWrappedLine_remaining;
150 string getWrappedLine(float w, vector size, textLengthUpToWidth_widthFunction_t tw);
151 string getWrappedLineLen(float w, textLengthUpToLength_lenFunction_t tw);
152
153 float isGametypeInFilter(float gt, float tp, float ts, string pattern);
154
155 typedef void(float i1, float i2, entity pass) swapfunc_t; // is only ever called for i1 < i2
156 typedef float(float i1, float i2, entity pass) comparefunc_t; // <0 for <, ==0 for ==, >0 for > (like strcmp)
157 void shuffle(float n, swapfunc_t swap, entity pass);
158 void heapsort(float n, swapfunc_t swap, comparefunc_t cmp, entity pass);
159
160 string swapwords(string str, float i, float j);
161 string shufflewords(string str);
162
163 string substring_range(string s, float b, float e);
164
165 vector solve_quadratic(float a, float b, float c);
166 // solution 1 -> x
167 // solution 2 -> y
168 // z = 1 if a real solution exists, 0 if not
169 // if no real solution exists, x contains the real part and y the imaginary part of the complex solutions x+iy and x-iy
170
171 vector solve_shotdirection(vector myorg, vector myvel, vector eorg, vector evel, float spd, float newton_style);
172 vector get_shotvelocity(vector myvel, vector mydir, float spd, float newton_style, float mi, float ma);
173
174 void check_unacceptable_compiler_bugs();
175
176 float compressShotOrigin(vector v);
177 vector decompressShotOrigin(float f);
178
179 #ifdef SVQC
180 string rankings_reply, ladder_reply, lsmaps_reply, lsnewmaps_reply, maplist_reply; // cached replies
181 string records_reply[10];
182 #endif
183
184 float RandomSelection_totalweight;
185 float RandomSelection_best_priority;
186 entity RandomSelection_chosen_ent;
187 float RandomSelection_chosen_float;
188 string RandomSelection_chosen_string;
189 void RandomSelection_Init();
190 void RandomSelection_Add(entity e, float f, string s, float weight, float priority);
191
192 vector healtharmor_maxdamage(float h, float a, float armorblock); // returns vector: maxdamage, armorideal, 1 if fully armored
193 vector healtharmor_applydamage(float a, float armorblock, float damage); // returns vector: take, save, 0
194
195 string getcurrentmod();
196
197 #ifndef MENUQC
198 #ifdef CSQC
199 float ReadInt24_t();
200 #else
201 void WriteInt24_t(float dest, float val);
202 #endif
203 #endif
204
205 // the NULL function
206 const var void func_null(void); FTEQCC_YOU_SUCK_THIS_IS_NOT_UNREFERENCED(func_null)
207 const var string string_null;
208 float float2range11(float f);
209 float float2range01(float f);
210
211 float gsl_ran_gaussian(float sigma);
212
213 string car(string s); // returns first word
214 string cdr(string s); // returns all but first word
215 float matchacl(string acl, string str); // matches str against ACL acl (with entries +foo*, +foo, +*foo, +*foo*, and same with - for forbidding)
216 float startsWith(string haystack, string needle);
217 float startsWithNocase(string haystack, string needle);
218
219 string get_model_datafilename(string mod, float skn, string fil); // skin -1 will return wildcard, mod string_null will also put wildcard there
220 string get_model_parameters_modelname;
221 float get_model_parameters_modelskin;
222 string get_model_parameters_name;
223 float get_model_parameters_species;
224 string get_model_parameters_sex;
225 float get_model_parameters_weight;
226 float get_model_parameters_age;
227 string get_model_parameters_desc;
228 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
229
230 // stupid stupid stupid FTEQCC has a max limit on macro sizes, let's work around by splitting the macro into two macros! :(
231 #define HUD_Panel_GetName_Part2(id) \
232 switch(id) {\
233         case HUD_PANEL_ENGINEINFO: panel_name = HUD_PANELNAME_ENGINEINFO; break; \
234         case HUD_PANEL_INFOMESSAGES: panel_name = HUD_PANELNAME_INFOMESSAGES; break; \
235         case HUD_PANEL_PHYSICS: panel_name = HUD_PANELNAME_PHYSICS; break; \
236         case HUD_PANEL_CENTERPRINT: panel_name = HUD_PANELNAME_CENTERPRINT; break; \
237 } ENDS_WITH_CURLY_BRACE
238
239 // Get name of specified panel id
240 #define HUD_Panel_GetName(id) \
241 switch(id) { \
242         case HUD_PANEL_WEAPONS: panel_name = HUD_PANELNAME_WEAPONS; break; \
243         case HUD_PANEL_AMMO: panel_name = HUD_PANELNAME_AMMO; break; \
244         case HUD_PANEL_POWERUPS: panel_name = HUD_PANELNAME_POWERUPS; break; \
245         case HUD_PANEL_HEALTHARMOR: panel_name = HUD_PANELNAME_HEALTHARMOR; break; \
246         case HUD_PANEL_NOTIFY: panel_name = HUD_PANELNAME_NOTIFY; break; \
247         case HUD_PANEL_TIMER: panel_name = HUD_PANELNAME_TIMER; break; \
248         case HUD_PANEL_RADAR: panel_name = HUD_PANELNAME_RADAR; break; \
249         case HUD_PANEL_SCORE: panel_name = HUD_PANELNAME_SCORE; break; \
250         case HUD_PANEL_RACETIMER: panel_name = HUD_PANELNAME_RACETIMER; break; \
251         case HUD_PANEL_VOTE: panel_name = HUD_PANELNAME_VOTE; break; \
252         case HUD_PANEL_MODICONS: panel_name = HUD_PANELNAME_MODICONS; break; \
253         case HUD_PANEL_PRESSEDKEYS: panel_name = HUD_PANELNAME_PRESSEDKEYS; break; \
254         case HUD_PANEL_CHAT: panel_name = HUD_PANELNAME_CHAT; break; \
255     default: HUD_Panel_GetName_Part2(id)\
256 }
257
258 vector vec2(vector v);
259
260 #ifndef MENUQC
261 vector NearestPointOnBox(entity box, vector org);
262 #endif
263
264 float vercmp(string v1, string v2);
265
266 float u8_strsize(string s);
267
268 // translation helpers
269 string prvm_language;
270 string language_filename(string s);
271 string CTX(string s);
272 #define ZCTX(s) strzone(CTX(s))
273
274 // x-encoding (encoding as zero length invisible string)
275 // encodes approx. 14 bits into 5 bytes of color code string
276 const float XENCODE_MAX = 21295; // 2*22*22*22-1
277 const float XENCODE_LEN = 5;
278 string xencode(float f);
279 float xdecode(string s);
280
281 #ifndef COMPAT_XON010_CHANNELS
282 #define sound(e,c,s,v,a) sound7(e,c,s,v,a,0,0)
283 #endif
284
285 float lowestbit(float f);
286
287 #ifdef CSQC
288 entity ReadCSQCEntity()
289 #endif
290
291 #ifndef MENUQC
292 string strtolower(string s);
293 #endif
294
295 string MakeConsoleSafe(string input);
296
297 #ifndef MENUQC
298 float InterpretBoolean(string input);
299 #endif
300
301 // generic shutdown handler
302 void Shutdown();
303
304 #ifndef MENUQC
305 .float skeleton_bones;
306 void Skeleton_SetBones(entity e);
307 // loops through the tags of model v using counter tagnum
308 #define FOR_EACH_TAG(v) float tagnum; Skeleton_SetBones(v); for(tagnum = 0; tagnum < v.skeleton_bones; tagnum++, gettaginfo(v, tagnum))
309 #endif
310 #ifdef SVQC
311 void WriteApproxPastTime(float dst, float t);
312 #endif
313 #ifdef CSQC
314 float ReadApproxPastTime();
315 #endif
316
317 // execute-stuff-next-frame subsystem
318 void execute_next_frame();
319 void queue_to_execute_next_frame(string s);
320
321 // for marking written-to values as unused where it's a good idea to do this
322 noref float unused_float;
323
324
325
326 // a function f with:
327 // f(0) = 0
328 // f(1) = 1
329 // f'(0) = startspeedfactor
330 // f'(1) = endspeedfactor
331 float cubic_speedfunc(float startspeedfactor, float endspeedfactor, float x);
332
333 // checks whether f'(x) = 0 anywhere from 0 to 1
334 // because if this is the case, the function is not usable for platforms
335 // as it may exceed 0..1 bounds, or go in reverse
336 float cubic_speedfunc_is_sane(float startspeedfactor, float endspeedfactor);