qcsrc/lib/deglobalization.qh

   1 #include "lib/float.qh"
   2 #include "lib/misc.qh"
   3 #include "lib/static.qh"
   4 #include "lib/vector.qh"
   5
   6 // These macros wrap functions which use globals so mutation only occurs inside them and is not visible from outside.
   7 // Functions for which all usages are replaced with these macros can be hidden by #defines inside our `*defs.qh` files
   8 // to prevent anyone from using them accidentally in the future
   9
  10 // TODO stuff in the engine that uses the v_forward/v_right/v_up globals and is not wrapped yet:
  11 //  - RF_USEAXIS, addentities, predraw,
  12 //    - CL_GetEntityMatrix (in engine but is called from other functions so transitively any of them can use the globals - e.g. V_CalcRefdef, maybe others)
  13 //    - however RF_USEAXIS is only used if MF_ROTATE is used which is only set in one place
  14 //  - e.camera_transform / CL_VM_TransformView (in engine
  15 //    - this is the only used function that both sets and gets the globals (aim does too but isn't used in our code)
  16
  17 #define NEW_VECS(...) EVAL(OVERLOAD(NEW_VECS, __VA_ARGS__))
  18 #define NEW_VECS_3(forward, right, up) vector forward = '0 0 0'; vector right = '0 0 0'; vector up = '0 0 0';
  19 #define NEW_VECS_4(forward, right, up, origin) NEW_VECS_3(forward, right, up); vector origin = '0 0 0';
  20
  21 // convenience for deglobalized code - don't use these just to hide that globals are still used
  22 #define CLEAR_V_GLOBALS() v_forward = VEC_NAN; v_right = VEC_NAN; v_up = VEC_NAN;
  23 #define GET_V_GLOBALS(forward, right, up) forward = v_forward; right = v_right; up = v_up;
  24 #define SET_V_GLOBALS(forward, right, up) v_forward = forward; v_right = right; v_up = up;
  25
  26 #ifdef GAMEQC
  27 STATIC_INIT(globals) {
  28         // set to NaN to more easily detect uninitialized use
  29         // TODO when all functions are wrapped and the raw functions are not used anymore,
  30         // uncomment the defines in *progs.qh files that hide the raw functions
  31         // and assert that the global vectors are NaN before calling the raw functions here
  32         // to make sure nobody (even builtins) is accidentally using them - NaN is the most likely value to expose remaining usages
  33
  34         CLEAR_V_GLOBALS();
  35 }
  36 #endif
  37
  38 /// Same as the `makevectors` builtin but uses the provided locals instead of the `v_*` globals.
  39 /// Always use this instead of raw `makevectors` to make the data flow clear.
  40 #define MAKE_VECTORS(angles, forward, right, up) MACRO_BEGIN { \
  41         _makevectors_hidden(angles); \
  42         GET_V_GLOBALS(forward, right, up); \
  43         CLEAR_V_GLOBALS(); \
  44 } MACRO_END
  45
  46 /// Same as `MAKE_VECTORS` but also creates the locals for convenience.
  47 #define MAKE_VECTORS_NEW(angles, forward, right, up) \
  48         NEW_VECS(forward, right, up); \
  49         MAKE_VECTORS(angles, forward, right, up);
  50
  51 /// Returns all 4 vectors by assigning to them (instead of returning a value) for consistency (and sanity)
  52 #define SKEL_GET_BONE_ABS(skel, bonenum, forward, right, up, origin) MACRO_BEGIN { \
  53         origin = _skel_get_boneabs_hidden(skel, bonenum) \
  54         GET_V_GLOBALS(forward, right, up); \
  55         CLEAR_V_GLOBALS(); \
  56 } MACRO_END
  57
  58 #define SKEL_GET_BONE_ABS_NEW(skel, bonenum, forward, right, up, origin) \
  59         NEW_VECS(forward, right, up, origin); \
  60         SKEL_GET_BONE_ABS(skel, bonenum, forward, right, up, origin)
  61
  62 #define SKEL_SET_BONE(skel, bonenum, org, forward, right, up) MACRO_BEGIN { \
  63         SET_V_GLOBALS(forward, right, up); \
  64         _skel_set_bone_hidden(skel, bonenum, org); \
  65         CLEAR_V_GLOBALS(); \
  66 } MACRO_END
  67
  68 #define ADD_DYNAMIC_LIGHT(org, radius, lightcolours, forward, right, up) MACRO_BEGIN { \
  69         SET_V_GLOBALS(forward, right, up); \
  70         _adddynamiclight_hidden(org, radius, lightcolours); \
  71         CLEAR_V_GLOBALS(); \
  72 } MACRO_END
  73
  74 #define VECTOR_VECTORS(forward_in, forward, right, up) MACRO_BEGIN { \
  75         _vectorvectors_hidden(forward_in); \
  76         GET_V_GLOBALS(forward, right, up); \
  77         CLEAR_V_GLOBALS(); \
  78 } MACRO_END
  79
  80 #define VECTOR_VECTORS_NEW(forward_in, forward, right, up) \
  81         NEW_VECS(forward, right, up); \
  82         VECTOR_VECTORS(forward_in, forward, right, up);
  83
  84 /// Note that this only avoids the v_* globals, not the gettaginfo_* ones
  85 #define GET_TAG_INFO(ent, tagindex, forward, right, up, origin) MACRO_BEGIN {  \
  86         origin = _gettaginfo_hidden(ent, tagindex); \
  87         GET_V_GLOBALS(forward, right, up); \
  88         CLEAR_V_GLOBALS(); \
  89 } MACRO_END
  90
  91 #define GET_TAG_INFO_NEW(ent, tagindex, forward, right, up, origin) \
  92         NEW_VECS(forward, right, up, origin); \
  93         GET_TAG_INFO(ent, tagindex, forward, right, up, origin);