c3ae491660e116edcebc1adcee2d99340361ead8
[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 #define ACCUMULATE_FUNCTION(func,otherfunc) \
5         #ifdef func \
6         void __merge__##otherfunc() { func(); otherfunc(); } \
7         #undef func \
8         #define func __merge__##otherfunc \
9         #else \
10         #define func otherfunc \
11         #endif
12
13 // 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
14 // NOTE: s IS allowed to be a tempstring
15 string wordwrap(string s, float l);
16 #ifndef MENUQC
17 #ifndef CSQC
18 void wordwrap_sprint(string s, float l);
19 #endif
20 #endif
21 void wordwrap_cb(string s, float l, void(string) callback)
22
23 float GameCommand_Generic(string cmd);
24 // returns TRUE if handled, FALSE otherwise
25 // uses tokenize on its argument!
26
27 // iterative depth-first search, with fields that go "up", "down left" and "right" in a tree
28 // for each element, funcPre is called first, then funcPre and funcPost for all its children, and funcPost last
29 void depthfirst(entity start, .entity up, .entity downleft, .entity right, void(entity, entity) funcPre, void(entity, entity) funcPost, entity pass);
30
31 float median(float a, float b, float c);
32
33 // converts a number to a string with the indicated number of decimals
34 // works for up to 10 decimals!
35 string ftos_decimals(float number, float decimals);
36
37 float fexists(string f);
38
39 vector colormapPaletteColor(float c, float isPants);
40
41 // unzone the string, and return it as tempstring. Safe to be called on string_null
42 string fstrunzone(string s);
43
44 // database (NOTE: keys are case sensitive)
45 void db_save(float db, string filename);
46 void db_dump(float db, string pFilename);
47 float db_create();
48 float db_load(string filename);
49 void db_close(float db);
50 string db_get(float db, string key);
51 void db_put(float db, string key, string value);
52
53 // stringbuffer loading/saving
54 float buf_load(string filename);
55 void buf_save(float buf, string filename);
56
57 // modulo function
58 #ifndef MENUQC
59 float mod(float a, float b) { return a - (floor(a / b) * b); }   
60 #endif
61
62 string GametypeNameFromType(float g);
63 #define TIME_TO_NTHS(t,n) floor((t) * (n) + 0.4)
64 string mmsss(float t);
65 string mmssss(float t);
66
67 #define TIME_DECIMALS 2
68 #define TIME_FACTOR 100
69 #define TIME_ENCODED_TOSTRING(n) mmssss(n)
70 #define RACE_RECORD "/race100record/"
71 #define CTS_RECORD "/cts100record/"
72 #define TIME_ENCODE(t) TIME_TO_NTHS(t, TIME_FACTOR)
73 #define TIME_DECODE(n) ((n) / TIME_FACTOR)
74
75 string ScoreString(float vflags, float value);
76
77 vector cross(vector a, vector b);
78
79 void compressShortVector_init();
80 vector decompressShortVector(float data);
81 float compressShortVector(vector vec);
82
83 #ifndef MENUQC
84 float CheckWireframeBox(entity forent, vector v0, vector dvx, vector dvy, vector dvz);
85 #endif
86
87 string fixPriorityList(string pl, float from, float to, float subtract, float complete);
88 string swapInPriorityList(string order, float i, float j);
89
90 float cvar_value_issafe(string s);
91
92 void cvar_settemp(string pKey, string pValue);
93 void cvar_settemp_restore();
94
95 #ifndef MENUQC
96 // modes: 0 = trust q3map2 (_mini images)
97 //        1 = trust tracebox (_radar images)
98 // in both modes, mapinfo's "size" overrides
99
100 string mi_shortname;
101 vector mi_min;
102 vector mi_max;
103 void get_mi_min_max(float mode);
104
105 vector mi_picmin; // adjusted mins that map to the picture (square)
106 vector mi_picmax; // adjusted maxs that map to the picture (square)
107 vector mi_pictexcoord0; // texcoords of the image corners (after transforming, these are 2D coords too)
108 vector mi_pictexcoord1; // texcoords of the image corners (after transforming, these are 2D coords too)
109 vector mi_pictexcoord2; // texcoords of the image corners (after transforming, these are 2D coords too)
110 vector mi_pictexcoord3; // texcoords of the image corners (after transforming, these are 2D coords too)
111 void get_mi_min_max_texcoords(float mode);
112 #endif
113
114 #define FTEQCC_YOU_SUCK_THIS_IS_NOT_UNREFERENCED(x) void reference_##x() { x = x; }
115
116 float almost_equals(float a, float b);
117 float almost_in_bounds(float a, float b, float c);
118
119 float power2of(float e);
120 float log2of(float x);
121
122 string HEXDIGITS = "0123456789ABCDEF0123456789abcdef";
123 #define HEXDIGIT_TO_DEC_RAW(d) (strstrofs(HEXDIGITS, (d), 0))
124 #define HEXDIGIT_TO_DEC(d) ((HEXDIGIT_TO_DEC_RAW(d) | 0x10) - 0x10)
125 #define DEC_TO_HEXDIGIT(d) (substring(HEXDIGITS, (d), 1))
126
127 vector rgb_to_hsl(vector rgb);
128 vector hsl_to_rgb(vector hsl);
129 vector rgb_to_hsv(vector rgb);
130 vector hsv_to_rgb(vector hsv);
131 string rgb_to_hexcolor(vector rgb);
132
133 float boxesoverlap(vector m1, vector m2, vector m3, vector m4);
134 float boxinsidebox(vector smins, vector smaxs, vector bmins, vector bmaxs);
135
136 typedef float(string s, vector size) textLengthUpToWidth_widthFunction_t;
137 typedef float(string s) textLengthUpToLength_lenFunction_t;
138 float textLengthUpToWidth(string theText, float maxWidth, vector size, textLengthUpToWidth_widthFunction_t tw);
139 string textShortenToWidth(string theText, float maxWidth, vector size, textLengthUpToWidth_widthFunction_t tw);
140 float textLengthUpToLength(string theText, float maxWidth, textLengthUpToLength_lenFunction_t tw);
141 string textShortenToLength(string theText, float maxWidth, textLengthUpToLength_lenFunction_t tw);
142
143 string getWrappedLine_remaining;
144 string getWrappedLine(float w, vector size, textLengthUpToWidth_widthFunction_t tw);
145 string getWrappedLineLen(float w, textLengthUpToLength_lenFunction_t tw);
146
147 float isGametypeInFilter(float gt, float tp, float ts, string pattern);
148
149 typedef void(float i1, float i2, entity pass) swapfunc_t; // is only ever called for i1 < i2
150 typedef float(float i1, float i2, entity pass) comparefunc_t; // <0 for <, ==0 for ==, >0 for > (like strcmp)
151 void shuffle(float n, swapfunc_t swap, entity pass);
152 void heapsort(float n, swapfunc_t swap, comparefunc_t cmp, entity pass);
153
154 string swapwords(string str, float i, float j);
155 string shufflewords(string str);
156
157 string substring_range(string s, float b, float e);
158
159 vector solve_quadratic(float a, float b, float c);
160 // solution 1 -> x
161 // solution 2 -> y
162 // z = 1 if a real solution exists, 0 if not
163 // if no real solution exists, x contains the real part and y the imaginary part of the complex solutions x+iy and x-iy
164
165 void check_unacceptable_compiler_bugs();
166
167 float compressShotOrigin(vector v);
168 vector decompressShotOrigin(float f);
169
170 string rankings_reply, ladder_reply, lsmaps_reply, lsnewmaps_reply, maplist_reply; // cached replies
171 string records_reply[10];
172
173 float RandomSelection_totalweight;
174 float RandomSelection_best_priority;
175 entity RandomSelection_chosen_ent;
176 float RandomSelection_chosen_float;
177 string RandomSelection_chosen_string;
178 void RandomSelection_Init();
179 void RandomSelection_Add(entity e, float f, string s, float weight, float priority);
180
181 vector healtharmor_maxdamage(float h, float a, float armorblock); // returns vector: maxdamage, armorideal, 1 if fully armored
182 vector healtharmor_applydamage(float a, float armorblock, float damage); // returns vector: take, save, 0
183
184 string getcurrentmod();
185
186 #ifndef MENUQC
187 #ifdef CSQC
188 float ReadInt24_t();
189 #else
190 void WriteInt24_t(float dest, float val);
191 #endif
192 #endif
193
194 // the NULL function
195 const var void func_null(void); FTEQCC_YOU_SUCK_THIS_IS_NOT_UNREFERENCED(func_null)
196 const var string string_null;
197 float float2range11(float f);
198 float float2range01(float f);
199
200 float gsl_ran_gaussian(float sigma);
201
202 string car(string s); // returns first word
203 string cdr(string s); // returns all but first word
204 float matchacl(string acl, string str); // matches str against ACL acl (with entries +foo*, +foo, +*foo, +*foo*, and same with - for forbidding)
205 float startsWith(string haystack, string needle);
206 float startsWithNocase(string haystack, string needle);
207
208 string get_model_datafilename(string mod, float skn, string fil); // skin -1 will return wildcard, mod string_null will also put wildcard there
209 string get_model_parameters_modelname;
210 float get_model_parameters_modelskin;
211 string get_model_parameters_name;
212 float get_model_parameters_species;
213 string get_model_parameters_sex;
214 float get_model_parameters_weight;
215 float get_model_parameters_age;
216 string get_model_parameters_desc;
217 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
218
219 // stupid stupid stupid FTEQCC has a max limit on macro sizes, let's work around by splitting the macro into two macros! :(
220 #define HUD_Panel_GetName_Part2(id) \
221 switch(id) {\
222         case HUD_PANEL_ENGINEINFO: panel_name = HUD_PANELNAME_ENGINEINFO; break; \
223         case HUD_PANEL_INFOMESSAGES: panel_name = HUD_PANELNAME_INFOMESSAGES; break; \
224 } ENDS_WITH_CURLY_BRACE
225
226 // Get name of specified panel id
227 #define HUD_Panel_GetName(id) \
228 switch(id) { \
229         case HUD_PANEL_WEAPONS: panel_name = HUD_PANELNAME_WEAPONS; break; \
230         case HUD_PANEL_AMMO: panel_name = HUD_PANELNAME_AMMO; break; \
231         case HUD_PANEL_POWERUPS: panel_name = HUD_PANELNAME_POWERUPS; break; \
232         case HUD_PANEL_HEALTHARMOR: panel_name = HUD_PANELNAME_HEALTHARMOR; break; \
233         case HUD_PANEL_NOTIFY: panel_name = HUD_PANELNAME_NOTIFY; break; \
234         case HUD_PANEL_TIMER: panel_name = HUD_PANELNAME_TIMER; break; \
235         case HUD_PANEL_RADAR: panel_name = HUD_PANELNAME_RADAR; break; \
236         case HUD_PANEL_SCORE: panel_name = HUD_PANELNAME_SCORE; break; \
237         case HUD_PANEL_RACETIMER: panel_name = HUD_PANELNAME_RACETIMER; break; \
238         case HUD_PANEL_VOTE: panel_name = HUD_PANELNAME_VOTE; break; \
239         case HUD_PANEL_MODICONS: panel_name = HUD_PANELNAME_MODICONS; break; \
240         case HUD_PANEL_PRESSEDKEYS: panel_name = HUD_PANELNAME_PRESSEDKEYS; break; \
241         case HUD_PANEL_CHAT: panel_name = HUD_PANELNAME_CHAT; break; \
242 }\
243 HUD_Panel_GetName_Part2(id)
244
245 vector vec2(vector v);
246
247 #ifndef MENUQC
248 vector NearestPointOnBox(entity box, vector org);
249 #endif
250
251 float vercmp(string v1, string v2);
252
253 float u8_strsize(string s);
254
255 // translation helpers
256 string prvm_language;
257 string language_filename(string s);
258 string CTX(string s);
259 #define ZCTX(s) strzone(CTX(s))