source: cpp/frams/param/param.h @ 884

Last change on this file since 884 was 805, checked in by Maciej Komosinski, 2 years ago

Fixed clang's compiler forward declaration problem - not using ExtValue? in param.h (template moved to param.cpp)

  • Property svn:eol-style set to native
File size: 13.9 KB
Line 
1// This file is a part of Framsticks SDK.  http://www.framsticks.com/
2// Copyright (C) 1999-2017  Maciej Komosinski and Szymon Ulatowski.
3// See LICENSE.txt for details.
4
5#ifndef _PARAM_H_
6#define _PARAM_H_
7
8#include <stdio.h>
9#include <stdint.h>
10#include <frams/util/sstring.h>
11#include <frams/util/sstringutils.h>
12#include <frams/util/list.h>
13#include <frams/util/statrick.h>
14#include <common/virtfile/virtfile.h>
15#include <common/log.h>
16
17class ExtValue;
18class ExtObject;
19
20// ParamInterface flags:
21#define PARAM_READONLY       1  //< Param is not able to change this member
22#define PARAM_DONTSAVE       2  //< Param will not save this member
23#define PARAM_SETLEVEL(x) (((x)&3)<<2)  //< internal use
24#define PARAM_LEVEL(x)    (((x)>>2)&3)  //< internal use
25#define PARAM_USERREADONLY  16  //< GUI should not change this member (even if Param can)
26#define PARAM_USERHIDDEN    32  //< GUI should not display this member
27#define MUTPARAM_ALLOCENTRY 64  //< for mutableparam (private!)
28#define MUTPARAM_ALLOCDATA 128  //< for mutableparam (private!)
29#define PARAM_NOSTATIC  256     //< (FramScript) don't access this member in a static object (ClassName.field)
30#define PARAM_CONST     512     //< (FramScript) constant value
31#define PARAM_CANOMITNAME 1024  //< affects Param::saveSingleLine()/loadSingleLine() - for example one-liners in f0 genetic encoding
32#define PARAM_DONTLOAD    2048  //< Param::load() skips this field
33#define PARAM_NOISOLATION 4096  //< don't use proxy object in master/slave interactions
34#define PARAM_DEPRECATED  8192  //< this member is deprecated
35#define PARAM_LINECOMMENT 16384 //< Param::load() adds "@line ..." comment when loading multiline (internal use)
36#define PARAM_OBJECTSET 32768   //< setting this field is handled by the object's assign(...) function and cannot change the object reference
37
38typedef int32_t paInt;
39#define PA_INT_SCANF "%d"
40#define PA_INT_SCANF_X "%x"
41
42// the result of param::set() is a combination of bits:
43
44// read-only: cannot modify
45#define PSET_RONLY      1
46
47// value has been modified
48#define PSET_CHANGED    2
49
50//value has been adjusted because it tried to exceed min or max
51#define PSET_HITMIN     4
52#define PSET_HITMAX     8
53
54#define PSET_NOPROPERTY 16
55
56#define PSET_PARSEFAILED        32
57
58// useful combination: need to get and display the value so that a user knows that the value they tried to set has been rejected or changed
59#define PSET_WARN (PSET_RONLY | PSET_HITMIN | PSET_HITMAX | PSET_PARSEFAILED)
60
61
62struct ParamEntry;
63
64/** Property get/set interface - runtime access to named properties */
65class ParamInterface
66{
67public:
68        virtual ~ParamInterface() {}
69
70        virtual int getGroupCount() = 0; ///< @return the number of property groups
71        virtual int getPropCount() = 0; ///< @return the number of properties
72
73        virtual const char* getName() = 0;
74        virtual const char* getDescription() { return 0; }
75        virtual ParamEntry *getParamTab() const { return NULL; }
76
77        int findId(const char *n);      ///< find id number for internal name
78        int findIdn(const char *naz, int n);
79
80        virtual const char *id(int i) = 0;      ///< get internal name
81        virtual const char *name(int i) = 0;    ///< get the human-readable name
82
83        /** get type description.
84                first character defines basic datatype:
85                - d = integer
86                - f = floating point
87                - s = string
88                - o = ExtObject
89                - x = ExtValue (universal datatype)
90                */
91        virtual const char *type(int i) = 0;
92
93        virtual const char *help(int i) = 0;    ///< get long description (tooltip)
94
95        virtual int flags(int i) = 0;           ///< get flags
96
97        virtual int group(int i) = 0;           ///< get group id for a property
98        virtual const char *grname(int gi) = 0; ///< get group name
99        virtual int grmember(int gi, int n) = 0;        ///< get property id for n'th member of group "gi"
100
101        virtual void call(int i, ExtValue* args, ExtValue *ret) = 0;
102
103        void get(int, ExtValue &retval);        ///< most universal get, can be used for every datatype
104
105        virtual SString getString(int) = 0;     ///< get string value, you can only use this for "s" type property
106        virtual paInt getInt(int) = 0;  ///< get long value, you can only use this for "d" type property
107        virtual double getDouble(int) = 0;      ///< get double value, you can only use this for "f" type property
108        virtual ExtObject getObject(int) = 0;   ///< get object reference, you can only use this for "o" type property
109        virtual ExtValue getExtValue(int) = 0;  ///< get extvalue object, you can only use this for "x" type property
110
111        SString get(int);               ///< old style get, can convert long or double to string
112        SString getText(int);           ///< like getString, returns enumeration label for subtype "d 0 n ~enum1~enum2...
113
114        SString getStringById(const char*prop);  ///< get string value, you can only use this for "s" type property
115        paInt getIntById(const char* prop);    ///< get long value, you can only use this for "d" type property
116        double getDoubleById(const char* prop);///< get double value, you can only use this for "f" type property
117        ExtObject getObjectById(const char* prop);///< get object reference, you can only use this for "o" type property
118        ExtValue getExtValueById(const char* prop);///< get extvalue object, you can only use this for "x" type property
119        ExtValue getById(const char* prop);
120
121        int setIntFromString(int i, const char* str, bool strict = false);
122        int setDoubleFromString(int i, const char* str);
123        virtual int setInt(int, paInt) = 0;             ///< set long value, you can only use this for "d" type prop
124        virtual int setDouble(int, double) = 0; ///< set double value, you can only use this for "f" type prop
125        virtual int setString(int, const SString &) = 0;        ///< set string value, you can only use this for "s" type prop
126        virtual int setObject(int, const ExtObject &) = 0;      ///< set object reference, you can only use this for "o" type prop
127        virtual int setExtValue(int, const ExtValue &) = 0;     ///< 4 in 1
128
129        int set(int, const ExtValue &);///< most universal set, can be used for every datatype
130
131        int setFromString(int, const char*, bool strict = false);               ///< oldstyle set, can convert string to long or double
132
133        int setIntById(const char* prop, paInt);///< set long value, you can only use this for "d" type prop
134        int setDoubleById(const char* prop, double);///< set double value, you can only use this for "f" type prop
135        int setStringById(const char* prop, const SString &);///< set string value, you can only use this for "s" type prop
136        int setObjectById(const char* prop, const ExtObject &);///< set object reference, you can only use this for "o" type prop
137        int setExtValueById(const char* prop, const ExtValue &); ///< for ExtValue types only
138        int setById(const char* prop, const ExtValue &);///< can be used for all property types
139
140        /** get valid minimum, maximum and default value for property 'prop'
141                @return 0 if min/max/def information is not available */
142        int getMinMaxInt(int prop, paInt& minumum, paInt& maximum, paInt& def);
143        /** get valid minimum, maximum and default value for property 'prop'
144                @return 0 if min/max/def information is not available */
145        int getMinMaxDouble(int prop, double& minumum, double& maximum, double& def);
146        int getMinMaxString(int prop, int& minumum, int& maximum, SString& def);
147        static int getMinMaxIntFromTypeDef(const char* type, paInt& minumum, paInt& maximum, paInt& def);
148        static int getMinMaxDoubleFromTypeDef(const char* type, double& minumum, double& maximum, double& def);
149        static int getMinMaxStringFromTypeDef(const char* type, int& minumum, int& maximum, SString& def);
150
151        virtual void setDefault();
152        virtual void setDefault(int i);
153        void setMin();
154        void setMax();
155        void setMin(int i);
156        void setMax(int i);
157
158        /** return the human readable description of the given type */
159        static SString friendlyTypeDescrFromTypeDef(const char* type);
160        SString friendlyTypeDescr(int i) { return friendlyTypeDescrFromTypeDef(type(i)); }
161
162        /** copy all property values from other ParamInterface object */
163        void copyFrom(ParamInterface *src);
164
165        /** Copy all property values from compatible ParamInterface object.
166                This method is more efficient than copyFrom,
167                but can be used only if the other object has the same properties sequence, e.g.:
168                - any two Param objects having common paramtab
169                - any ParamInterface object and the Param with paramtab constructed by ParamObject::makeParamTab
170                */
171        void quickCopyFrom(ParamInterface *src);
172
173        enum FileFormat { FormatMultiLine, FormatSingleLine }; // FormatJSON in the future?
174        struct LoadOptions {
175                bool warn_unknown_fields; bool *abortable; int *linenum; int offset; bool parse_failed;
176                LoadOptions() : warn_unknown_fields(false), abortable(NULL), linenum(NULL), offset(0), parse_failed(false) {}
177        };
178
179        int saveMultiLine(VirtFILE*, const char* altname = NULL, bool force = 0);
180        int saveprop(VirtFILE*, int i, const char* p, bool force = 0);
181
182        int load(FileFormat format, VirtFILE*, LoadOptions *load_options = NULL);///< @return the number of fields loaded
183        int load(FileFormat format, const SString &, LoadOptions *load_options = NULL);///< @return the number of fields loaded
184protected:
185        int loadMultiLine(VirtFILE*, LoadOptions &options);///< @return the number of fields loaded
186        int loadSingleLine(const SString &, LoadOptions &options);///< @return the number of fields loaded
187public:
188
189        static const char* SERIALIZATION_PREFIX;
190
191        static bool isValidTypeDescription(const char* t);
192#ifdef _DEBUG
193        virtual void sanityCheck(int i) {}
194#endif
195};
196
197// implementations:
198
199extern char MakeCodeGuardHappy;
200
201#define PROCOFFSET(_proc_) ( (void (*)(void*,ExtValue*,ExtValue*)) &(FIELDSTRUCT :: _proc_ ## _statrick))
202#define STATICPROCOFFSET(_proc_) ( (void (*)(void*,ExtValue*,ExtValue*)) &(FIELDSTRUCT :: _proc_))
203#define GETOFFSET(_proc_) ( (void (*)(void*,ExtValue*)) &(FIELDSTRUCT :: _proc_ ## _statrick))
204#define SETOFFSET(_proc_) ( (int (*)(void*,const ExtValue*)) &(FIELDSTRUCT :: _proc_ ## _statrick))
205
206#define FIELDOFFSET(_fld_) ((intptr_t)((char*)(&((FIELDSTRUCT*)&MakeCodeGuardHappy)->_fld_)-((char*)((FIELDSTRUCT*)&MakeCodeGuardHappy))))
207
208#ifdef _DEBUG
209#define PARAM_ILLEGAL_OFFSET ((intptr_t)0xdeadbeef)
210#else
211#define PARAM_ILLEGAL_OFFSET 0
212#endif
213
214#define FIELD(_fld_) FIELDOFFSET(_fld_),0,0
215#define LONGOFFSET(_o_) (_o_),0,0
216#define PROCEDURE(_proc_) PARAM_ILLEGAL_OFFSET,(void*)PROCOFFSET(_proc_),0
217#define STATICPROCEDURE(_proc_) PARAM_ILLEGAL_OFFSET,(void*)STATICPROCOFFSET(_proc_),0
218#define GETSET(_proc_) PARAM_ILLEGAL_OFFSET,(void*)GETOFFSET(get_ ## _proc_),(void*)SETOFFSET(set_ ## _proc_)
219#define GETFIELD(_proc_) FIELDOFFSET(_proc_),(void*)GETOFFSET(get_ ## _proc_),0
220#define SETFIELD(_proc_) FIELDOFFSET(_proc_),0,(void*)SETOFFSET(set_ ## _proc_)
221#define GETONLY(_proc_) PARAM_ILLEGAL_OFFSET,(void*)GETOFFSET(get_ ## _proc_),0
222#define SETONLY(_proc_) PARAM_ILLEGAL_OFFSET,0,(void*)SETOFFSET(set_ ## _proc_)
223
224#define PARAMPROCARGS ExtValue* args,ExtValue* ret
225#define PARAMSETARGS const ExtValue* arg
226#define PARAMGETARGS ExtValue* ret
227
228#define PARAMPROCDEF(name) STATRICKDEF2(name,ExtValue*,ExtValue*)
229#define PARAMGETDEF(name) STATRICKDEF1(get_ ## name,ExtValue*)
230#define PARAMSETDEF(name) STATRICKRDEF1(int,set_ ## name,const ExtValue*)
231
232///////////////////////////////
233
234struct ParamEntry
235{
236        const char *id;
237        paInt group, flags;
238        const char *name, *type;
239        intptr_t offset;
240        void *fun1; ///< procedure or get
241        void *fun2; ///< set
242        const char *help;
243};
244
245struct ParamEntryConstructor : public ParamEntry
246{
247public:
248        ParamEntryConstructor(const char *_id, paInt _group = 0, paInt _flags = 0, const char *_name = 0, const char *_type = 0, intptr_t _offset = 0, void *_fun1 = 0, void *_fun2 = 0, const char *_help = 0)
249        {
250                id = _id; group = _group; flags = _flags; name = _name; type = _type; offset = _offset; fun1 = _fun1; fun2 = _fun2; help = _help;
251        }
252};
253
254class SimpleAbstractParam : public virtual ParamInterface
255{
256protected:
257        virtual void *getTarget(int i);
258        const char* myname;
259        bool dontcheckchanges;
260
261public:
262        void *object;
263
264        const char* getName() { return myname; }
265        void setName(const char* n) { myname = n; }
266
267        /**
268                @param t ParamEntry table
269                @param o controlled object
270                @param n Param's name
271                */
272        SimpleAbstractParam(void* o = 0, const char*n = 0) :myname(n), dontcheckchanges(0), object(o) {}
273        void setDontCheckChanges(bool x) { dontcheckchanges = x; }
274
275        void select(void *o) { object = o; }
276        void* getSelected() { return object; }
277
278        virtual ParamEntry *entry(int i) = 0;
279        const char *id(int i) { return (i >= getPropCount()) ? 0 : entry(i)->id; }
280        const char *name(int i) { return entry(i)->name; }
281        const char *type(int i) { return entry(i)->type; }
282        const char *help(int i) { return entry(i)->help; }
283        int flags(int i) { return entry(i)->flags; }
284        int group(int i) { return entry(i)->group; }
285        void call(int i, ExtValue* args, ExtValue *ret);
286
287        SString getString(int);
288        paInt getInt(int);
289        double getDouble(int);
290        ExtObject getObject(int);
291        ExtValue getExtValue(int);
292
293        void messageOnExceedRange(int i, int setflags, ExtValue& valuetoset);
294        int setInt(int, paInt);
295        int setDouble(int, double);
296        int setString(int, const SString &);
297        int setObject(int, const ExtObject &);
298        int setExtValue(int, const ExtValue &);
299
300        int isequal(int i, void* defdata);
301        void saveSingleLine(SString&, void *defdata, bool addcr = true, bool all_names = true);
302
303        virtual void setDefault();
304        virtual void setDefault(int i);
305
306#ifdef _DEBUG
307        void sanityCheck(int i);
308#endif
309};
310
311class Param : public SimpleAbstractParam
312{
313protected:
314        ParamEntry *entry(int i) { return tab + tab[0].group + i; }
315public:
316        ParamEntry *tab;
317        /**
318                @param t ParamEntry table
319                @param o controlled object
320                @param n Param's name
321                */
322
323        Param(ParamEntry *t = 0, void* o = 0, const char*n = 0) :SimpleAbstractParam(o, n), tab(t)
324        {
325                if (!n&&tab) myname = tab[0].name;
326        }
327
328        Param(const Param& p) :SimpleAbstractParam(p.object, p.myname), tab(p.tab) {}
329        void operator=(const Param&p) { object = p.object; myname = p.myname; tab = p.tab; }
330
331        const char* getDescription() { return tab[0].type; }
332
333        int getGroupCount() { return tab[0].group; }
334        int getPropCount() { return tab[0].flags; }
335        const char *grname(int i) { return (i < getGroupCount()) ? tab[i].id : 0; }
336        int grmember(int, int);
337        void setParamTab(ParamEntry *t, int dontupdatename = 0) { tab = t; if ((!dontupdatename) && tab) myname = tab[0].name; }
338        ParamEntry *getParamTab() const { return tab; }
339};
340
341extern ParamEntry empty_paramtab[];
342
343#endif
Note: See TracBrowser for help on using the repository browser.