source: cpp/frams/util/extvalue.h @ 359

Last change on this file since 359 was 337, checked in by Maciej Komosinski, 10 years ago

New math operator semantics: extend mixed int/float to float, forbid number+notnumber

  • Property svn:eol-style set to native
File size: 9.0 KB
Line 
1// This file is a part of Framsticks SDK.  http://www.framsticks.com/
2// Copyright (C) 1999-2015  Maciej Komosinski and Szymon Ulatowski.
3// See LICENSE.txt for details.
4
5#ifndef _EXTVALUE_H_
6#define _EXTVALUE_H_
7
8#include "sstring.h"
9#include <frams/param/param.h>
10#include <common/nonstd_stl.h>
11#include <common/threads.h>
12
13#define EXTVALUEUNION
14template <int A, int B> struct CompileTimeMax { enum { val = A > B ? A : B }; };
15#define EXTVALUEUNIONSIZE CompileTimeMax<sizeof(ExtObject),sizeof(SString)>::val
16
17enum ExtPType
18{
19        TUnknown = 0, TInt, TDouble, TString, TObj, TInvalid
20};
21
22/**
23   destructable object
24   */
25class DestrBase
26{
27public:
28        int refcount;
29        DestrBase() :refcount(0) {}
30        void incref() { refcount++; }
31        void decref() { refcount--; if (refcount == 0) delete this; }
32        virtual ~DestrBase() {}
33};
34
35/**
36   object reference.
37   */
38class ExtObject
39{
40        int subtype;                    //< 0/1=Generic/DPC Object,  0/2=Standalone/Shared Param
41        void incref() const;
42        void decref() const;
43public:
44        union {
45                void* object;           //< generic object, will use param
46                DestrBase *dbobject;    //< object with refcounting, will be deleted if refcount goes to 0
47        };
48        union {
49                Param* param;           //< if object!=0
50                ParamInterface *paraminterface; //< if object==0
51        };
52
53        void copyFrom(const ExtObject& src)  { subtype = src.subtype; object = src.object; param = src.param; }
54
55        void* operator new(size_t s, void* mem){ return mem; }
56#ifdef _MSC_VER
57                void operator delete(void* mem, void* t) {}
58#endif
59        void* operator new(size_t s){ return malloc(sizeof(ExtObject)); }
60        void operator delete(void* mem) { free(mem); }
61        ///@param tmp_param can be used for temporary storage, the result ParamInterface* is only valid for as long as tmp_param is valid
62        ParamInterface *getParamInterface(Param &tmp_param) const  { if (subtype & 2){ tmp_param.setParamTab(param->getParamTab()); tmp_param.select(object); return &tmp_param; } return paraminterface; }
63        const char* interfaceName() const { if (isEmpty()) return "Empty"; return (subtype & 2) ? param->getName() : paraminterface->getName(); }
64        bool matchesInterfaceName(ParamInterface* pi) const { return !strcmp(interfaceName(), pi->getName()); }
65        void* getTarget() const { return (subtype & 1) ? dbobject : object; }
66        void* getTarget(const char* classname, bool through_barrier = true, bool warn = true) const;
67        void setEmpty() { decref(); subtype = 0; param = NULL; object = NULL; }
68        int isEmpty() const { return !param; }
69        static const ExtObject& empty() { static const ExtObject& e((ParamInterface*)NULL); return e; }
70        ExtObject(const ExtObject& src)      { src.incref(); copyFrom(src); }
71        void operator=(const ExtObject& src) { src.incref(); decref(); copyFrom(src); }
72        bool makeUnique();//< @return false if nothing has changed
73
74        bool operator==(const ExtObject& src) const;
75
76        SString toString() const;
77        SString serialize_inner() const;
78        SString serialize() const;
79
80        ExtObject(Param *p, void *o) :subtype(2), object(o), param(p){}
81        ExtObject(ParamInterface *p = 0) :subtype(0), object(0), paraminterface(p){}
82        ExtObject(Param *p, DestrBase *o) :subtype(1 + 2), dbobject(o), param(p){ incref(); }
83        ExtObject(ParamInterface *p, DestrBase *o) :subtype(1), dbobject(o), paraminterface(p){ incref(); }
84
85        ~ExtObject(){ decref(); }
86
87        class Serialization
88        {
89                std::vector<ExtObject> refs;
90                int level;
91        public:
92                Serialization() :level(0) {}
93                void begin();
94                void end();
95                int add(const ExtObject& o);
96                void replace(const ExtObject& o, const ExtObject& other);
97                void remove(const ExtObject& o);
98                const ExtObject* get(int ref);
99        };
100
101        static THREAD_LOCAL_DECL(Serialization, serialization);
102};
103
104class ExtValue
105{
106public:
107        ExtPType type;
108#ifdef EXTVALUEUNION
109        long data[(EXTVALUEUNIONSIZE + sizeof(long) - 1) / sizeof(long)];
110        paInt& idata() const { return (paInt&)data[0]; };
111        double& ddata() const { return *(double*)data; };
112        ExtObject& odata() const { return *(ExtObject*)data; };
113        SString& sdata() const { return *(SString*)data; };
114#else
115        union {
116                paInt i;
117                double d;
118                SString *s;
119                ExtObject *o;
120        };
121        paInt& idata() const {return (paInt&)i;};
122        double& ddata() const {return (double&)d;};
123        ExtObject& odata() const {return *o;};
124        SString& sdata() const {return *s;};
125#endif
126
127        void* operator new(size_t s, void* mem){ return mem; }
128        void* operator new(size_t s){ return ::operator new(s); }
129
130                ExtValue() :type(TUnknown){}
131        ~ExtValue() { setEmpty(); }
132        ExtValue(paInt v) { seti(v); }
133        ExtValue(double v) { setd(v); }
134        ExtValue(const SString &v) { sets(v); }
135        ExtValue(const ExtObject &srco) { seto(srco); }
136        static ExtValue invalid() { ExtValue v; v.setInvalid(); return v; }
137        static const ExtValue& empty() { static const ExtValue v; return v; }
138        static const ExtValue& zero() { static const ExtValue v(0); return v; }
139
140        enum CompareResult
141        {
142                ResultLower = -1, ResultEqual = 0, ResultHigher = 1,
143                ResultEqualUnordered,
144                ResultUnequal_RelaxedEqual,
145                ResultUnequal_RelaxedUnequal,
146                ResultMismatch_RelaxedUnequal,
147                ResultMismatch
148        };
149        // performs all script value comparisons.
150        // relaxed comparison (internal use only, not available in scripts) works like regular == with additional null~=0, notnull!~0
151        // and is used for pseudo-boolean conversion allowing for expressions like "if (null) ..."
152        CompareResult compare(const ExtValue& src) const;
153
154        enum CmpOperator { CmpFIRST, CmpEQ = CmpFIRST, CmpNE, CmpGE, CmpLE, CmpGT, CmpLT,/*relaxed (not)equal*/CmpREQ, CmpRNE };
155        static const char* cmp_op_names[];
156        struct CmpContext { const ExtValue *v1, *v2; };
157        // interpret compare() result, optional context controls error messages
158        // @return 0=false, 1=true, -1=undefined (null in script)
159        static int interpretCompare(CmpOperator op, CompareResult result, CmpContext *context = NULL);
160
161        void divInt(paInt a);
162        void divDouble(double a);
163
164        int operator==(const ExtValue& src) const;
165        void operator+=(const ExtValue& src);
166        void operator-=(const ExtValue& src);
167        void operator*=(const ExtValue& src);
168        void operator/=(const ExtValue& src);
169        void operator%=(const ExtValue& src);
170        void operator=(const ExtValue& src)
171        {
172                setr(src);
173        }
174        ExtValue(const ExtValue& src)
175                :type(TUnknown) {
176                set(src);
177        }
178        void setEmpty();
179        void setInvalid() { setEmpty(); type = TInvalid; }
180        bool makeUnique() { return (type == TObj) && odata().makeUnique(); } //< @return false if nothing has changed
181        ExtPType getType() const { return type; }
182        void *getObjectTarget(const char* classname, bool warn = true) const;
183        void setInt(paInt v) { if (type != TInt) setri(v); else idata() = v; }
184        void setDouble(double v) { if (type != TDouble) setrd(v); else ddata() = v; }
185        void setString(const SString &v) { if (type != TString) setrs(v); else sdata() = v; }
186        void setObject(const ExtObject &src) { if (type != TObj) setro(src); else odata() = src; }
187        static bool parseInt(const char* s, paInt &result, bool strict, bool error);
188        static bool parseDouble(const char* s, double &result, bool error);
189        static paInt getInt(const char* s, bool strict = false);//< @param strict=true will fail on floating point
190        static double getDouble(const char* s);
191        paInt getInt() const;
192        double getDouble() const;
193        SString getString() const;
194        const SString* getStringPtr() const;//< @return pointer to the internal sstring object or NULL if the current type is not string
195        SString serialize() const;
196        ExtObject getObject() const;
197        bool isNull() const { return (type == TUnknown) || ((type == TObj) && odata().isEmpty()); }
198        SString typeDescription() const;//< @return human readable type name (used in error messages)
199        SString typeAndValue() const;//< @return type and value (used in error messages)
200        const char* parseNumber(const char* in, ExtPType strict_type = TUnknown);
201        const char* deserialize(const char* in);//< @return first character after the succesfully parsed string or NULL if failed
202        const char* deserialize_inner(const char* in);
203        static ParamInterface *findDeserializableClass(const char* name);
204        static PtrListTempl<ParamInterface*> &getDeserializableClasses();
205        template<typename T> class AddDeserializable
206        {
207        public:
208                AddDeserializable() { ExtValue::getDeserializableClasses() += &T::getStaticParam(); }
209        };
210
211        static SString format(SString& fmt, const ExtValue **values, int count);
212
213        ExtValue getExtType();
214
215private: // setrx - release and set, setx - assume released
216        void setr(const ExtValue& src){ setEmpty(); set(src); }
217        void set(const ExtValue& src);
218        void setri(paInt v) { setEmpty(); seti(v); }
219        void setrd(double v) { setEmpty(); setd(v); }
220        void seti(paInt v) { type = TInt; idata() = v; }
221        void setd(double v) { type = TDouble; ddata() = v; }
222#ifdef EXTVALUEUNION
223        void setrs(const SString &v) { setEmpty(); sets(v); }
224        void setro(const ExtObject &src) { setEmpty(); seto(src); }
225        void sets(const SString &v) { type = TString; new(data)SString(v); }
226        void seto(const ExtObject &src) { type = TObj; new(data)ExtObject(src); }
227#else
228        void setrs(const SString &v) {setEmpty();sets(v);}
229        void setro(const ExtObject &src) {setEmpty();seto(src);}
230        void sets(const SString &v) {type=TString;s=new SString(v);}
231        void seto(const ExtObject &src) {type=TObj;o=new ExtObject(src);}
232#endif
233
234};
235
236#define REGISTER_DESERIALIZABLE(name) ExtValue::AddDeserializable<name> deserializable_autoinit_ ## name;
237
238#endif
Note: See TracBrowser for help on using the repository browser.