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

Last change on this file since 319 was 319, checked in by Maciej Komosinski, 9 years ago

Fixed compilation warnings

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