qcsrc/common/util.qh

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