8 #define NULL (0, null_entity)
10 #define NULL (0, world)
15 /** @deprecated, use new_pure or NEW(class) */
16 #define make_pure(e) \
19 (e).pure_data = true; \
21 #define make_impure(e) \
24 (e).pure_data = false; \
26 #define is_pure(e) ((e).pure_data)
29 /** Location entity was spawned from in source */
37 // pure entities: need no .origin
39 entity spawn_pure() = #600;
41 #define spawn_pure() _spawn()
44 entity __spawn(string _classname, string _sourceLoc, bool pure)
46 entity this = pure ? spawn_pure() : _spawn();
47 this.classname = _classname;
48 this.sourceLoc = _sourceLoc;
52 setorigin(this, '0 0 10000');
55 setorigin(this, '0 0 -10000');
62 #define entityclass(...) EVAL_entityclass(OVERLOAD_(entityclass, __VA_ARGS__))
63 #define EVAL_entityclass(...) __VA_ARGS__
64 #define entityclass_1(name) entityclass_2(name, Object)
65 #ifndef QCC_SUPPORT_ENTITYCLASS
66 #define entityclass_2(name, base) typedef entity name
68 #define _new(class, pure) __spawn( #class, __FILE__ ":" STR(__LINE__), pure)
70 #define entityclass_2(name, base) entityclass name : base {}
71 #define class(name) [[class(name)]]
72 #define _new(class, pure) ((class) __spawn( #class, __FILE__ ":" STR(__LINE__), pure))
74 /** entities you care about seeing (.origin works) */
75 #define new(class) _new(class, false)
76 /** purely logical entities (.origin doesn't work) */
77 #define new_pure(class) _new(class, true)
78 #define spawn() __spawn("entity", __FILE__ ":" STR(__LINE__), false)
80 #define delete(this) MACRO_BEGIN { \
81 entity _this = (this); \
82 void(entity) _dtor = _this.dtor; \
83 if (_dtor) _dtor(_this); else remove(_this); \
87 entity _clearentity_ent;
88 STATIC_INIT(clearentity)
90 _clearentity_ent = new_pure(clearentity);
92 void clearentity(entity e)
97 bool was_pure = is_pure(e);
98 copyentity(_clearentity_ent, e);
99 if (!was_pure) make_impure(e);
105 // Classes have a `spawn##cname(entity)` constructor
106 // The parameter is used across [[accumulate]] functions
108 // Macros to hide this implementation detail:
110 #define NEW(cname, ...) \
111 OVERLOAD_(spawn##cname, new_pure(cname) P99_IF_EMPTY(__VA_ARGS__)()(, __VA_ARGS__))
112 #define CONSTRUCT(cname, ...) \
113 OVERLOAD_(spawn##cname, this P99_IF_EMPTY(__VA_ARGS__)()(, __VA_ARGS__))
115 #define NEW(cname, ...) \
116 OVERLOAD(spawn##cname, new_pure(cname),##__VA_ARGS__)
118 #define CONSTRUCT(cname, ...) \
119 OVERLOAD(spawn##cname, this,##__VA_ARGS__)
122 #define CONSTRUCTOR(cname, ...) \
123 cname OVERLOAD(spawn##cname, cname this, __VA_ARGS__) \
127 [[accumulate]] cname OVERLOAD(spawn##cname, cname this, __VA_ARGS__)
132 void RegisterClasses() {}
133 STATIC_INIT(RegisterClasses)
138 #define VTBL(cname, base) \
139 INIT_STATIC(cname); \
140 entity cname##_vtbl; \
141 void cname##_vtbl_init() \
143 cname e = new_pure(vtbl); \
144 spawn##cname##_static(e); \
145 e.vtblname = #cname; \
146 /* Top level objects refer to themselves */ \
147 e.vtblbase = base##_vtbl ? base##_vtbl : e; \
150 ACCUMULATE_FUNCTION(RegisterClasses, cname##_vtbl_init)
152 #define INIT_STATIC(cname) [[accumulate]] void spawn##cname##_static(cname this)
153 #define INIT(cname) [[accumulate]] cname spawn##cname##_1(cname this)
155 #define CLASS(cname, base) \
156 entityclass(cname, base); \
157 class(cname).bool instanceOf##cname; \
163 copyentity(cname##_vtbl, this); \
166 spawn##base##_static(this); \
167 this.instanceOf##cname = true; \
171 /* Only statically initialize the current class, it contains everything it inherits */ \
172 if (cname##_vtbl.vtblname == this.classname) \
174 spawn##cname##_static(this); \
175 this.classname = #cname; \
176 this.vtblname = string_null; \
177 this.vtblbase = cname##_vtbl; \
179 spawn##base##_1(this); \
182 #define METHOD_REFERENCE(cname, name) \
185 #define STATIC_METHOD(cname, name, prototype) \
186 prototype METHOD_REFERENCE(cname, name)
188 #define METHOD(cname, name, prototype) \
189 STATIC_METHOD(cname, name, prototype); \
190 class(cname) .prototype name; \
193 this.name = METHOD_REFERENCE(cname, name); \
195 STATIC_METHOD(cname, name, prototype)
197 #define DESTRUCTOR(cname) \
198 STATIC_METHOD(cname, dtorimpl, void(cname this)); \
199 METHOD(cname, dtor, void(cname this)) \
201 METHOD_REFERENCE(cname, dtorimpl)(this); \
202 entity super = SUPER(cname); \
203 if (super != cname##_vtbl) super.dtor(this); \
205 STATIC_METHOD(cname, dtorimpl, void(cname this))
207 #define ATTRIB(cname, name, type, val) \
208 class(cname).type name; \
211 noref bool strzone; /* Error on strzone() calls. */ \
215 #define ATTRIB_STRZONE(cname, name, type, val) \
216 class(cname).type name; \
220 strunzone(this.name); \
221 this.name = strzone(val); \
224 #define ATTRIBARRAY(cname, name, type, cnt) \
225 class(cname).type name[cnt];
227 #define ENDCLASS(cname) \
233 #define SUPER(cname) (cname##_vtbl.vtblbase)
235 #define spawn_static(this)
236 #define spawn_1(this)
239 DESTRUCTOR(Object) { remove(this); }
240 #define remove(this) delete(this)
241 METHOD(Object, describe, string(Object this))
243 string s = _("No description");
244 if (cvar("developer"))
246 for (int i = 0, n = numentityfields(); i < n; ++i)
248 string value = getentityfieldstring(i, this);
249 if (value != "") s = sprintf("%s\n%s = %s", s, entityfieldname(i), value);
254 METHOD(Object, display, void(Object this, void(string name, string icon) returns))
256 returns(sprintf("entity %i", this), "nopreview_map");