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