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

Last change on this file since 574 was 574, checked in by Maciej Komosinski, 5 years ago

More strict validation of numeric type definitions: min without max is now invalid. More code is now reused.

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