]> de.git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blob - qcsrc/lib/registry.qh
Commands: use registry
[xonotic/xonotic-data.pk3dir.git] / qcsrc / lib / registry.qh
1 #ifndef REGISTRY_H
2 #define REGISTRY_H
3
4 #include "oo.qh"
5
6 #define REGISTER_INIT(ns, id) [[accumulate]] void Register_##ns##_##id##_init(entity this)
7 #define REGISTER_INIT_POST(ns, id) [[accumulate]] void Register_##ns##_##id##_init_post(entity this)
8
9 #define REGISTRY(id, max) \
10     void Register##id() {} \
11     const int id##_MAX = max; \
12     noref entity id[id##_MAX], id##_first, id##_last; \
13     int id##_COUNT;
14
15 /**
16  * Register a new entity with a global constructor.
17  * Must be followed by a semicolon or a function body with a `this` parameter.
18  * Wrapper macros may perform actions after user initialization like so:
19  *     #define REGISTER_FOO(id) \
20  *         REGISTER(RegisterFoos, FOO, FOOS, id, m_id, NEW(Foo)); \
21  *         REGISTER_INIT_POST(FOO, id) { \
22  *             print("Registering foo #", this.m_id + 1, "\n"); \
23  *         } \
24  *         REGISTER_INIT(FOO, id)
25  *
26  * Don't forget to forward declare `initfunc` and call `REGISTER_REGISTRY`:
27  *     void RegisterFoos();
28  *     REGISTER_REGISTRY(RegisterFoos)
29  *
30  * @param initfunc  The global constructor to accumulate into
31  * @param ns        Short for namespace, prefix for each global (ns##_##id)
32  * @param array     The array to add each entity to. Also requires `array##_first` and `array##_last` to be defined
33  * @param id        The identifier of the current entity being registered
34  * @param fld       The field to store the current count into
35  * @param inst      An expression to create a new instance, invoked for every registration
36  */
37 #define REGISTER(initfunc, ns, array, id, fld, inst)                \
38     entity ns##_##id;                                               \
39     REGISTER_INIT(ns, id) { }                                       \
40     REGISTER_INIT_POST(ns, id) { }                                  \
41     void Register_##ns##_##id() {                                   \
42         if (array##_COUNT >= array##_MAX) LOG_FATALF("Registry capacity exceeded (%s)", ftos(array##_MAX)); \
43         entity this = inst;                                         \
44         ns##_##id = this;                                           \
45         this.fld = array##_COUNT;                                   \
46         array[array##_COUNT++] = this;                              \
47         if (!array##_first)    array##_first = this;                \
48         if ( array##_last)     array##_last.REGISTRY_NEXT = this;   \
49         array##_last = this;                                        \
50         Register_##ns##_##id##_init(this);                          \
51         Register_##ns##_##id##_init_post(this);                     \
52     }                                                               \
53     ACCUMULATE_FUNCTION(initfunc, Register_##ns##_##id)             \
54     REGISTER_INIT(ns, id)
55
56 /** internal next pointer */
57 #define REGISTRY_NEXT enemy
58 .entity REGISTRY_NEXT;
59
60 #define REGISTRY_SORT(id, field, skip)                              \
61     void _REGISTRY_SWAP_##id(int i, int j, entity pass) {           \
62         i += skip; j += skip;                                       \
63                                                                     \
64         entity a = id[i], b = id[j];                                \
65         id[i] = b;                                                  \
66         id[j] = a;                                                  \
67                                                                     \
68         entity a_next = a.REGISTRY_NEXT, b_next = b.REGISTRY_NEXT;  \
69         a.REGISTRY_NEXT = b_next;                                   \
70         b.REGISTRY_NEXT = a_next;                                   \
71                                                                     \
72         if (i == 0) id##_first = b;                                 \
73         else id[i - 1].REGISTRY_NEXT = b;                           \
74                                                                     \
75         if (j == 0) id##_first = a;                                 \
76         else id[j - 1].REGISTRY_NEXT = a;                           \
77     }                                                               \
78     float _REGISTRY_CMP_##id(int i, int j, entity pass) {           \
79         i += skip; j += skip;                                       \
80         string a = id[i].field;                                     \
81         string b = id[j].field;                                     \
82         return strcasecmp(a, b);                                    \
83     }                                                               \
84     STATIC_INIT(Registry_sort_##id) {                               \
85         heapsort(id##_COUNT - (skip), _REGISTRY_SWAP_##id, _REGISTRY_CMP_##id, NULL); \
86     }
87
88 #endif