]> de.git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blobdiff - qcsrc/lib/oo.qh
Put pure entities in the corners of the map instead of out of bounds, fixes heavy...
[xonotic/xonotic-data.pk3dir.git] / qcsrc / lib / oo.qh
index e7d9a13b101b068f370d7eaf71c93550b7a6da83..cf3a51f3aeaa10dc503b14a63dcad4c4220ec0a2 100644 (file)
-#ifndef OO_H
-#define OO_H
+#pragma once
 
 #include "misc.qh"
 #include "nil.qh"
 #include "static.qh"
 
 #ifdef MENUQC
-       #define NULL (null_entity)
+       #define NULL (0, null_entity)
+       #define world NULL
 #else
-       #define NULL (world)
+       #define NULL (0, world)
 #endif
 
 .vector origin;
 .bool pure_data;
+/** @deprecated use new_pure or NEW(class) */
 #define make_pure(e) \
-       do \
+       MACRO_BEGIN \
        { \
                (e).pure_data = true; \
-       } \
-       while (0)
+       } MACRO_END
+#define make_impure(e) \
+       MACRO_BEGIN \
+       { \
+               (e).pure_data = false; \
+       } MACRO_END
 #define is_pure(e) ((e).pure_data)
 
 .string classname;
 /** Location entity was spawned from in source */
-.string sourceLocFile;
-.int sourceLocLine;
+.string sourceLoc;
 entity _spawn();
-entity __spawn(string _classname, string _sourceFile, int _sourceLine, bool pure)
+
+#ifndef SPAWN_PURE
+#define SPAWN_PURE 0
+#endif
+
+// pure entities: need no .origin
+#if SPAWN_PURE
+entity spawn_pure() = #600;
+#else
+#define spawn_pure() _spawn()
+#endif
+
+entity __spawn(string _classname, string _sourceLoc, bool pure)
 {
-       entity this = _spawn();
+       entity this = pure ? spawn_pure() : _spawn();
        this.classname = _classname;
-       this.sourceLocFile = _sourceFile;
-       this.sourceLocLine = _sourceLine;
-       if (pure) make_pure(this);
+       this.sourceLoc = _sourceLoc;
+       if (pure) {
+               make_pure(this);
+               #ifdef CSQC
+               setorigin(this, world.mins + '0 0 20');
+               #endif
+               #ifdef SVQC
+        setorigin(this, world.maxs - '0 0 20');
+        #endif
+       }
        return this;
 }
 
 
-#define entityclass(...) EVAL(OVERLOAD(entityclass, __VA_ARGS__))
+#define entityclass(...) EVAL_entityclass(OVERLOAD_(entityclass, __VA_ARGS__))
+#define EVAL_entityclass(...) __VA_ARGS__
 #define entityclass_1(name) entityclass_2(name, Object)
 #ifndef QCC_SUPPORT_ENTITYCLASS
-       #define entityclass_2(name, base) typedef entity name
+       #define entityclass_2(name, base) USING(name, entity)
        #define class(name)
-       #define new(class) __spawn( #class, __FILE__, __LINE__, false)
+       #define _new(class, pure) __spawn( #class, __FILE__ ":" STR(__LINE__), pure)
 #else
        #define entityclass_2(name, base) entityclass name : base {}
        #define class(name) [[class(name)]]
-       #define new(class) ((class) __spawn( #class, __FILE__, __LINE__, false))
+       #define _new(class, pure) ((class) __spawn( #class, __FILE__ ":" STR(__LINE__), pure))
 #endif
-#define spawn() __spawn("entity", __FILE__, __LINE__, false)
+/** entities you care about seeing (.origin works) */
+#define new(class) _new(class, false)
+/** purely logical entities (.origin doesn't work) */
+#define new_pure(class) _new(class, true)
+#define spawn() __spawn("entity", __FILE__ ":" STR(__LINE__), false)
+
+#define delete(this) MACRO_BEGIN { \
+    entity _this = (this); \
+    void(entity) _dtor = _this.dtor; \
+    if (_dtor) _dtor(_this); else remove(_this); \
+    /* this = NULL; */  \
+} MACRO_END
 
 entity _clearentity_ent;
 STATIC_INIT(clearentity)
 {
-       _clearentity_ent = new(clearentity);
+       _clearentity_ent = new_pure(clearentity);
 }
 void clearentity(entity e)
 {
 #ifdef CSQC
                int n = e.entnum;
 #endif
+       bool was_pure = is_pure(e);
        copyentity(_clearentity_ent, e);
+       if (!was_pure) make_impure(e);
 #ifdef CSQC
                e.entnum = n;
 #endif
@@ -69,25 +106,38 @@ void clearentity(entity e)
 // Classes have a `spawn##cname(entity)` constructor
 // The parameter is used across [[accumulate]] functions
 
+.bool transmute;
+
 // Macros to hide this implementation detail:
-#ifdef GMQCC
+#ifdef __STDC__
        #define NEW(cname, ...) \
-               OVERLOAD(spawn##cname, new(cname),##__VA_ARGS__)
+               OVERLOAD_(spawn##cname, new_pure(cname) P99_IF_EMPTY(__VA_ARGS__)()(, __VA_ARGS__))
+
+    #define _TRANSMUTE(cname, this, ...) \
+        OVERLOAD_(spawn##cname, this P99_IF_EMPTY(__VA_ARGS__)()(, __VA_ARGS__))
 
        #define CONSTRUCT(cname, ...) \
-               OVERLOAD(spawn##cname, this,##__VA_ARGS__)
+               OVERLOAD_(spawn##cname, this P99_IF_EMPTY(__VA_ARGS__)()(, __VA_ARGS__))
 #else
-       #define NEW_(cname, ...) \
-               OVERLOAD_(spawn##cname, __VA_ARGS__)
        #define NEW(cname, ...) \
-               NEW_(cname, new(cname),##__VA_ARGS__)(new(cname),##__VA_ARGS__)
+               OVERLOAD(spawn##cname, new_pure(cname),##__VA_ARGS__)
+
+    #define _TRANSMUTE(cname, this, ...) \
+        OVERLOAD(spawn##cname, this,##__VA_ARGS__)
 
-       #define CONSTRUCT_(cname, ...) \
-               OVERLOAD_(spawn##cname, __VA_ARGS__)
        #define CONSTRUCT(cname, ...) \
-               CONSTRUCT_(cname, this,##__VA_ARGS__)(this,##__VA_ARGS__)
+               OVERLOAD(spawn##cname, this,##__VA_ARGS__)
 #endif
 
+#define TRANSMUTE(cname, this, ...) MACRO_BEGIN \
+    entity _e = (this); \
+    if (_e.vtblbase != cname##_vtbl) { \
+        _e.transmute = true; \
+        _e.classname = #cname; \
+        _TRANSMUTE(cname, _e, __VA_ARGS__); \
+    } \
+    MACRO_END
+
 #define CONSTRUCTOR(cname, ...) \
        cname OVERLOAD(spawn##cname, cname this, __VA_ARGS__) \
        { \
@@ -105,12 +155,11 @@ STATIC_INIT(RegisterClasses)
 }
 
 #define VTBL(cname, base) \
-       INIT_STATIC(cname); \
+       _INIT_STATIC(cname); \
        entity cname##_vtbl; \
        void cname##_vtbl_init() \
        { \
-               cname e = new(vtbl); \
-               make_pure(e); \
+               cname e = new_pure(vtbl); \
                spawn##cname##_static(e); \
                e.vtblname = #cname; \
                /* Top level objects refer to themselves */ \
@@ -119,29 +168,32 @@ STATIC_INIT(RegisterClasses)
        } \
        ACCUMULATE_FUNCTION(RegisterClasses, cname##_vtbl_init)
 
-#define INIT_STATIC(cname) [[accumulate]] void spawn##cname##_static(cname this)
+#define _INIT_STATIC(cname) [[accumulate]] void spawn##cname##_static(cname this)
 #define INIT(cname) [[accumulate]] cname spawn##cname##_1(cname this)
 
 #define CLASS(cname, base)                  \
        entityclass(cname, base);               \
-       class(cname).bool instanceOf##cname;   \
+       class(cname).bool instanceOf##cname;    \
+    bool is_##cname(entity e) { return e.instanceOf##cname; } \
+    void isnt_##cname(entity e) { eprint(e); } \
        VTBL(cname, base)                       \
-       INIT_STATIC(cname) \
-       {                    \
-               if (cname##_vtbl\
-               {                 \
+       _INIT_STATIC(cname)                     \
+       {                                       \
+               if (cname##_vtbl && !this.transmute)\
+               {                                   \
                        copyentity(cname##_vtbl, this); \
                        return;                         \
                }                                   \
                spawn##base##_static(this);         \
                this.instanceOf##cname = true;      \
        }                                       \
-       INIT(cname) \
-       {                           \
+       INIT(cname)                             \
+       {                                       \
                /* Only statically initialize the current class, it contains everything it inherits */ \
                if (cname##_vtbl.vtblname == this.classname) \
-               { \
+               {                                   \
                        spawn##cname##_static(this);    \
+                       this.transmute = false;         \
                        this.classname = #cname;        \
                        this.vtblname = string_null;    \
                        this.vtblbase = cname##_vtbl;   \
@@ -149,14 +201,31 @@ STATIC_INIT(RegisterClasses)
                spawn##base##_1(this);              \
        }
 
-#define METHOD(cname, name, prototype)      \
-       class(cname).prototype name;           \
-       prototype cname##_##name;               \
-       INIT_STATIC(cname) \
+#define METHOD_REFERENCE(cname, name) \
+       cname##_##name
+
+#define STATIC_METHOD(cname, name, prototype) \
+       prototype METHOD_REFERENCE(cname, name)
+
+#define METHOD(cname, name, prototype) \
+       STATIC_METHOD(cname, name, prototype); \
+       class(cname) .prototype name; \
+       _INIT_STATIC(cname) \
        { \
-               this.name = cname##_##name; \
+               this.name = METHOD_REFERENCE(cname, name); \
        } \
-       prototype cname##_##name
+       STATIC_METHOD(cname, name, prototype)
+
+#define DESTRUCTOR(cname) \
+       STATIC_METHOD(cname, dtorimpl, void(cname this)); \
+    METHOD(cname, dtor, void(cname this)) \
+    { \
+        METHOD_REFERENCE(cname, dtorimpl)(this); \
+        this.instanceOf##cname = false; \
+        entity super = SUPER(cname); \
+        if (super != cname##_vtbl) super.dtor(this); \
+    } \
+       STATIC_METHOD(cname, dtorimpl, void(cname this))
 
 #define ATTRIB(cname, name, type, val)      \
        class(cname).type name;                \
@@ -166,6 +235,16 @@ STATIC_INIT(RegisterClasses)
                this.name = val; \
        }
 
+#define STATIC_ATTRIB(cname, name, type, val) \
+       type cname##_##name; \
+       _INIT_STATIC(cname) \
+       { \
+               noref bool strzone; /* Error on strzone() calls. */ \
+               cname##_##name = val; \
+       }
+
+// cleanup potentially zoned strings from base classes
+
 #define ATTRIB_STRZONE(cname, name, type, val)      \
        class(cname).type name;                \
        INIT(cname) \
@@ -175,6 +254,15 @@ STATIC_INIT(RegisterClasses)
                this.name = strzone(val); \
        }
 
+#define STATIC_ATTRIB_STRZONE(cname, name, type, val) \
+       type cname##_##name; \
+       _INIT_STATIC(cname) \
+       { \
+        if (cname##_##name) \
+            strunzone(cname##_##name); \
+               cname##_##name = val; \
+       }
+
 #define ATTRIBARRAY(cname, name, type, cnt) \
        class(cname).type name[cnt];
 
@@ -190,8 +278,11 @@ STATIC_INIT(RegisterClasses)
 #define spawn_1(this)
 #define _vtbl NULL
 CLASS(Object, );
-       METHOD(Object, describe, string(entity this))
+    DESTRUCTOR(Object) { remove(this); }
+    #define remove(this) delete(this)
+       METHOD(Object, describe, string(Object this))
        {
+           TC(Object, this);
                string s = _("No description");
                if (cvar("developer"))
                {
@@ -203,13 +294,12 @@ CLASS(Object, );
                }
                return s;
        }
-       METHOD(Object, display, void(entity this, void(string name, string icon) returns))
+       METHOD(Object, display, void(Object this, void(string name, string icon) returns))
        {
+           TC(Object, this);
                returns(sprintf("entity %i", this), "nopreview_map");
        }
 ENDCLASS(Object)
 #undef spawn_static
 #undef spawn_1
 #undef _vtbl
-
-#endif