// This file is a part of the Framsticks GDK. // Copyright (C) 2002-2014 Maciej Komosinski and Szymon Ulatowski. See LICENSE.txt for details. // Refer to http://www.framsticks.com/ for further information. #ifndef _PARAM_H_ #define _PARAM_H_ #include #include #include #include #include #include class ExtValue; class ExtObject; // ParamInterface flags: #define PARAM_READONLY 1 #define PARAM_DONTSAVE 2 #define PARAM_SETLEVEL(x) (((x)&3)<<2) #define PARAM_LEVEL(x) (((x)>>2)&3) #define PARAM_USERREADONLY 16 #define PARAM_USERHIDDEN 32 // for mutableparam (private!) #define MUTPARAM_ALLOCENTRY 64 #define MUTPARAM_ALLOCDATA 128 #define PARAM_NOSTATIC 256 #define PARAM_CONST 512 #define PARAM_CANOMITNAME 1024 #define PARAM_DONTLOAD 2048 #define PARAM_NOISOLATION 4096 #define PARAM_DEPRECATED 8192 // wynik z param::set() to kombinacja bitow: #define PSET_RONLY 1 // oznacza,ze nie mozna zmienic #define PSET_CHANGED 2 // zaawansowane: wartosc zostala zmieniona #define PSET_HITMIN 4 #define PSET_HITMAX 8 // wartosc zostala dopasowana do min lub max #define PSET_WARN (PSET_RONLY | PSET_HITMIN | PSET_HITMAX) // pozyteczna kombinacja - oznacza, ze nalezy pobrac i wyswietlic // wartosc, zeby uzytkownik wiedzial, ze jego propozycja jest odrzucona #define PSET_NOPROPERTY 16 struct ParamEntry; /** Property get/set interface - runtime access to named properties */ class ParamInterface { public: virtual int getGroupCount()=0; ///< @return number of property groups virtual int getPropCount()=0; ///< @return number of properties virtual const char* getName()=0; virtual const char* getDescription() {return 0;} virtual ParamEntry *getParamTab() const {return NULL;} int findId(const char *n); ///< find id number for internal name int findIdn(const char *naz,int n); virtual const char *id(int i)=0; ///< get internal name virtual const char *name(int i)=0; ///< get human readable name /** get type description. first character defines basic datatype: - d = integer - f = floating point - s = string - o = ExtObject - x = ExtValue (universal datatype) */ virtual const char *type(int i)=0; virtual const char *help(int i)=0; ///< get long description (tooltip) virtual int flags(int i)=0; ///< get flags virtual int group(int i)=0; ///< get group id for a property virtual const char *grname(int gi)=0; ///< get group name virtual int grmember(int gi,int n)=0; ///< get property id for n'th member of group "gi" virtual void call(int i,ExtValue* args,ExtValue *ret)=0; void get(int,ExtValue &retval); ///< most universal get, can be used for every datatype virtual SString getString(int)=0; ///< get string value, you can only use this for "s" type property virtual long getInt(int)=0; ///< get long value, you can only use this for "d" type property virtual double getDouble(int)=0; ///< get double value, you can only use this for "f" type property virtual ExtObject getObject(int)=0; ///< get object reference, you can only use this for "o" type property virtual ExtValue getExtValue(int)=0; ///< get extvalue object, you can only use this for "x" type property SString get(int); ///< old style get, can convert long or double to string SString getText(int); ///< like getString, returns enumeration label for subtype "d 0 n ~enum1~enum2... SString getStringById(const char*prop); ///< get string value, you can only use this for "s" type property long getIntById(const char* prop); ///< get long value, you can only use this for "d" type property double getDoubleById(const char* prop);///< get double value, you can only use this for "f" type property ExtObject getObjectById(const char* prop);///< get object reference, you can only use this for "o" type property ExtValue getExtValueById(const char* prop);///< get extvalue object, you can only use this for "x" type property ExtValue getById(const char* prop); int setInt(int i,const char* str); int setDouble(int i,const char* str); virtual int setInt(int,long)=0; ///< set long value, you can only use this for "d" type prop virtual int setDouble(int,double)=0; ///< set double value, you can only use this for "f" type prop virtual int setString(int,const SString &)=0; ///< set string value, you can only use this for "s" type prop virtual int setObject(int,const ExtObject &)=0; ///< set object reference, you can only use this for "o" type prop virtual int setExtValue(int,const ExtValue &)=0; ///< 4 in 1 int set(int,const ExtValue &);///< most universal set, can be used for every datatype int set(int,const char*); ///< oldstyle set, can convert string to long or double int setIntById(const char* prop,long);///< set long value, you can only use this for "d" type prop int setDoubleById(const char* prop,double);///< set double value, you can only use this for "f" type prop int setStringById(const char* prop,const SString &);///< set string value, you can only use this for "s" type prop int setObjectById(const char* prop,const ExtObject &);///< set object reference, you can only use this for "o" type prop int setExtValueById(const char* prop,const ExtValue &); ///< for ExtValue types only int setById(const char* prop,const ExtValue &);///< can be used for all property types /** get valid minimum, maximum and default value for property 'prop' @return 0 if min/max/def information is not available */ int getMinMax(int prop,long& minumum,long& maximum,long& def); /** get valid minimum, maximum and default value for property 'prop' @return 0 if min/max/def information is not available */ int getMinMax(int prop,double& minumum,double& maximum,double& def); virtual void setDefault(bool numericonly=false); virtual void setDefault(int i,bool numericonly=false); void setMin(); void setMax(); void setMin(int i); void setMax(int i); /** copy all property values from other ParamInterface object */ void copyFrom(ParamInterface *src); /** copy all property values from compatible ParamInterface object. this method is more efficient than copyFrom, but can be used only if the other object has the same properties sequence, eg: - any two Param objects having common paramtab - any ParamInterface object and the Param with paramtab constructed by ParamObject::makeParamTab */ void quickCopyFrom(ParamInterface *src); int save(VirtFILE*,const SString* altname=0,bool force=0); int saveprop(VirtFILE*,int i,const char* p,bool force=0); void load(VirtFILE*); void load2(const SString &,int &); static const char* SERIALIZATION_PREFIX; }; // implementations: extern char MakeCodeGuardHappy; #define PROCOFFSET(_proc_) ( (void (*)(void*,ExtValue*,ExtValue*)) &(FIELDSTRUCT :: _proc_ ## _statrick)) #define STATICPROCOFFSET(_proc_) ( (void (*)(void*,ExtValue*,ExtValue*)) &(FIELDSTRUCT :: _proc_)) #define GETOFFSET(_proc_) ( (void (*)(void*,ExtValue*)) &(FIELDSTRUCT :: _proc_ ## _statrick)) #define SETOFFSET(_proc_) ( (int (*)(void*,const ExtValue*)) &(FIELDSTRUCT :: _proc_ ## _statrick)) #define FIELDOFFSET(_fld_) ((long)((char*)(&((FIELDSTRUCT*)&MakeCodeGuardHappy)->_fld_)-((char*)((FIELDSTRUCT*)&MakeCodeGuardHappy)))) #define FIELD(_fld_) FIELDOFFSET(_fld_),0,0 #define LONGOFFSET(_o_) (_o_),0,0 #define PROCEDURE(_proc_) 0,(void*)PROCOFFSET(_proc_),0 #define STATICPROCEDURE(_proc_) 0,(void*)STATICPROCOFFSET(_proc_),0 #define GETSET(_proc_) 0,(void*)GETOFFSET(get_ ## _proc_),(void*)SETOFFSET(set_ ## _proc_) #define GETFIELD(_proc_) FIELDOFFSET(_proc_),(void*)GETOFFSET(get_ ## _proc_),0 #define SETFIELD(_proc_) FIELDOFFSET(_proc_),0,(void*)SETOFFSET(set_ ## _proc_) #define GETONLY(_proc_) 0,(void*)GETOFFSET(get_ ## _proc_),0 #define SETONLY(_proc_) 0,0,(void*)SETOFFSET(set_ ## _proc_) #define PARAMPROCARGS ExtValue* args,ExtValue* ret #define PARAMSETARGS const ExtValue* arg #define PARAMGETARGS ExtValue* ret #define PARAMPROCDEF(name) STATRICKDEF2(name,ExtValue*,ExtValue*) #define PARAMGETDEF(name) STATRICKDEF1(get_ ## name,ExtValue*) #define PARAMSETDEF(name) STATRICKRDEF1(int,set_ ## name,const ExtValue*) /////////////////////////////// struct ParamEntry { const char *id; short group,flags; const char *name,*type; long offset; void *fun1; ///< procedure or get void *fun2; ///< set const char *help; }; struct ParamEntryConstructor: public ParamEntry { public: ParamEntryConstructor(const char *_id,short _group=0,short _flags=0,const char *_name=0,const char *_type=0,long _offset=0,void *_fun1=0, void *_fun2=0, const char *_help=0) {id=_id;group=_group;flags=_flags;name=_name;type=_type;offset=_offset;fun1=_fun1;fun2=_fun2;help=_help;} }; class SimpleAbstractParam: public virtual ParamInterface { protected: virtual void *getTarget(int i); virtual ParamEntry *entry(int i)=0; const char* myname; bool dontcheckchanges; public: void *object; const char* getName() {return myname;} void setName(const char* n) {myname=n;} /** @param t ParamEntry table @param o controlled object @param n Param's name */ SimpleAbstractParam(void* o=0,const char*n=0):myname(n),dontcheckchanges(0),object(o) {} void setDontCheckChanges(bool x) {dontcheckchanges=x;} void select(void *o) {object=o;} void* getSelected() {return object;} const char *id(int i) {return (i>=getPropCount())?0:entry(i)->id;} const char *name(int i) {return entry(i)->name;} const char *type(int i) {return entry(i)->type;} const char *help(int i) {return entry(i)->help;} int flags(int i) {return entry(i)->flags;} int group(int i) {return entry(i)->group;} void call(int i,ExtValue* args,ExtValue *ret); SString getString(int); long getInt(int); double getDouble(int); ExtObject getObject(int); ExtValue getExtValue(int); template void messageOnExceedRange(int i,int setflags, T valuetoset) ///< prints a warning when setflags indicates that allowed param range has been exceeded during set { if (setflags & (PSET_HITMIN | PSET_HITMAX)) { SString svaluetoset=SString::valueOf(valuetoset); //converts any type to SString SString actual=get(i); FMprintf("Param","set",FMLV_WARN,"Setting '%s.%s = %s' exceeded allowed range (too %s). Adjusted to %s.", getName(),id(i),(const char*)svaluetoset,(setflags&PSET_HITMAX)?"big":"small",(const char*)actual); } } int setInt(int,long); int setDouble(int,double); int setString(int,const SString &); int setObject(int,const ExtObject &); int setExtValue(int,const ExtValue &); int isequal(int i,void* defdata); void save2(SString&,void *defdata,bool addcr=true,bool all_names=true); virtual void setDefault(bool numericonly=false); virtual void setDefault(int i,bool numericonly=false); }; class Param: public SimpleAbstractParam { protected: ParamEntry *entry(int i) {return tab+tab[0].group+i;} public: ParamEntry *tab; /** @param t ParamEntry table @param o controlled object @param n Param's name */ Param(ParamEntry *t=0,void* o=0,const char*n=0):SimpleAbstractParam(o,n),tab(t) {if (!n&&tab) myname=tab[0].name;} Param(const Param& p):SimpleAbstractParam(p.object,p.myname),tab(p.tab) {} void operator=(const Param&p) {object=p.object; myname=p.myname; tab=p.tab;} const char* getDescription() {return tab[0].type;} int getGroupCount() {return tab[0].group;} int getPropCount() {return tab[0].flags;} const char *grname(int i) {return (i