source: cpp/frams/param/param.cpp @ 535

Last change on this file since 535 was 535, checked in by Maciej Komosinski, 7 years ago
  • More strict type description checking when adding a property in mutableparam
  • Error message when the param property could not be added for some reason
  • Property svn:eol-style set to native
File size: 27.2 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#include <stdio.h>
6#include <ctype.h>
7
8#include "param.h"
9#include <frams/util/extvalue.h>
10#include "common/log.h"
11#include <frams/util/sstringutils.h>
12
13//#define SAVE_ALL_NAMES
14#define SAVE_SELECTED_NAMES
15#define WARN_MISSING_NAME
16
17char MakeCodeGuardHappy;
18
19ParamEntry empty_paramtab[] =
20{ { "Empty", 1, 0, "Empty", }, { 0, 0, 0, }, };
21
22static void czytdotyldy(VirtFILE *f, SString &s)
23{
24        SString temp;
25        int z;
26        char last_char = 0;
27        while ((z = f->Vgetc()) != EOF)
28        {
29                if (z == '~')
30                        if (last_char != '\\') break;
31                last_char = (char)z;
32                temp += last_char;
33        }
34        s = temp;
35}
36
37static const char *strchrlimit(const char *t, int ch, const char *limit)
38{
39        if (limit < t) return NULL;
40        return (const char*)memchr((const void*)t, ch, limit - t);
41}
42
43void ParamInterface::copyFrom(ParamInterface *src)
44{
45        int n = getPropCount();
46        ExtValue v;
47        int j;
48        for (int i = 0; i < n; i++)
49                if ((!(flags(i)&PARAM_READONLY))
50                        && (*type(i) != 'p'))
51                {
52                j = src->findId(id(i));
53                if (j < 0) continue;
54                src->get(j, v);
55                set(i, v);
56                }
57}
58
59void ParamInterface::quickCopyFrom(ParamInterface *src)
60{
61        int n = getPropCount();
62        ExtValue v;
63        for (int i = 0; i < n; i++)
64                if ((!(flags(i)&PARAM_READONLY))
65                        && (*type(i) != 'p'))
66                {
67                src->get(i, v);
68                set(i, v);
69                }
70}
71
72int ParamInterface::getMinMax(int prop, paInt& minumum, paInt& maximum, paInt &def)
73{
74        const char* t = type(prop) + 1;
75        while (*t) if (*t == ' ') break; else t++;
76        return sscanf(t, PA_INT_SCANF " " PA_INT_SCANF " " PA_INT_SCANF, &minumum, &maximum, &def);
77}
78
79int ParamInterface::getMinMax(int prop, double& minumum, double& maximum, double& def)
80{
81        const char* t = type(prop) + 1;
82        while (*t) if (*t == ' ') break; else t++;
83        return sscanf(t, "%lg %lg %lg", &minumum, &maximum, &def);
84}
85
86int ParamInterface::getMinMax(int prop, int& minumum, int& maximum, SString& def)
87{
88        const char* t = type(prop) + 1;
89        while (*t) if (*t == ' ') break; else t++;
90        int ret = sscanf(t, "%d %d", &minumum, &maximum);
91        def = SString::empty();
92        if (ret == 2)
93        {
94                while (*t == ' ') t++;
95                for (int skip_fields = 2; skip_fields > 0; skip_fields--)
96                {
97                        while (*t) if (*t == ' ') break; else t++;
98                        while (*t == ' ') t++;
99                }
100                if (*t)
101                {
102                        const char* end = strchr(t, '~');
103                        if (!end)
104                                end = t + strlen(t);
105                        while ((end > t) && (end[-1] == ' ')) end--;
106                        def = SString(t, end - t);
107                }
108                return 3;
109        }
110        else
111                return ret;
112}
113
114void ParamInterface::setDefault()
115{
116        for (int i = 0; i < getPropCount(); i++)
117                setDefault(i);
118}
119
120void ParamInterface::setMin()
121{
122        for (int i = 0; i < getPropCount(); i++)
123                setMin(i);
124}
125
126void ParamInterface::setMax()
127{
128        for (int i = 0; i < getPropCount(); i++)
129                setMax(i);
130}
131
132void ParamInterface::setDefault(int i)
133{
134        const char *t = type(i);
135        switch (*t)
136        {
137        case 'f':
138        {
139                double mn = 0, mx = 0, def = 0;
140                if (getMinMax(i, mn, mx, def) < 3) def = mn;
141                setDouble(i, def);
142        }
143                break;
144        case 'd':
145        {
146                paInt mn = 0, mx = 0, def = 0;
147                if (getMinMax(i, mn, mx, def) < 3) def = mn;
148                setInt(i, def);
149        }
150                break;
151        case 's': case 'x':
152        {
153                int mn, mx; SString def;
154                getMinMax(i, mn, mx, def);
155                if (*t == 's')
156                        setString(i, def);
157                else
158                {
159                        if (def.len() > 0) setExtValue(i, ExtValue(def)); else setExtValue(i, ExtValue::empty());
160                }
161        }
162                break;
163        case 'o':
164                setObject(i, ExtObject::empty());
165                break;
166        }
167}
168
169void ParamInterface::setMin(int i)
170{
171        const char *t = type(i);
172        switch (*t)
173        {
174        case 'f':
175        {
176                double mn = 0, mx = 0, def = 0;
177                getMinMax(i, mn, mx, def);
178                setDouble(i, mn);
179        }
180                break;
181        case 'd':
182        {
183                paInt mn = 0, mx = 0, def = 0;
184                getMinMax(i, mn, mx, def);
185                setInt(i, mn);
186        }
187                break;
188        default: set(i, "");
189        }
190}
191
192void ParamInterface::setMax(int i)
193{
194        const char *t = type(i);
195        switch (*t)
196        {
197        case 'f':
198        {
199                double mn = 0, mx = 0, def = 0;
200                getMinMax(i, mn, mx, def);
201                setDouble(i, mx);
202        }
203                break;
204        case 'd':
205        {
206                paInt mn = 0, mx = 0, def = 0;
207                getMinMax(i, mn, mx, def);
208                setInt(i, mx);
209        }
210                break;
211        default: set(i, "");
212        }
213}
214
215SString ParamInterface::getStringById(const char*prop)
216{
217        int i = findId(prop); if (i >= 0) return getString(i); else return SString();
218}
219paInt ParamInterface::getIntById(const char*prop)
220{
221        int i = findId(prop); if (i >= 0) return getInt(i); else return 0;
222}
223double ParamInterface::getDoubleById(const char*prop)
224{
225        int i = findId(prop); if (i >= 0) return getDouble(i); else return 0;
226}
227ExtObject ParamInterface::getObjectById(const char*prop)
228{
229        int i = findId(prop); if (i >= 0) return getObject(i); else return ExtObject();
230}
231ExtValue ParamInterface::getExtValueById(const char*prop)
232{
233        int i = findId(prop); if (i >= 0) return getExtValue(i); else return ExtValue();
234}
235
236int ParamInterface::setIntById(const char* prop, paInt v)
237{
238        int i = findId(prop); if (i >= 0) return setInt(i, v); else return PSET_NOPROPERTY;
239}
240int ParamInterface::setDoubleById(const char* prop, double v)
241{
242        int i = findId(prop); if (i >= 0) return setDouble(i, v); else return PSET_NOPROPERTY;
243}
244int ParamInterface::setStringById(const char* prop, const SString &v)
245{
246        int i = findId(prop); if (i >= 0) return setString(i, v); else return PSET_NOPROPERTY;
247}
248int ParamInterface::setObjectById(const char* prop, const ExtObject &v)
249{
250        int i = findId(prop); if (i >= 0) return setObject(i, v); else return PSET_NOPROPERTY;
251}
252int ParamInterface::setExtValueById(const char* prop, const ExtValue &v)
253{
254        int i = findId(prop); if (i >= 0) return setExtValue(i, v); else return PSET_NOPROPERTY;
255}
256int ParamInterface::setById(const char* prop, const ExtValue &v)
257{
258        int i = findId(prop); if (i >= 0) return set(i, v); else return PSET_NOPROPERTY;
259}
260
261int ParamInterface::save(VirtFILE* f, const char* altname, bool force)
262{
263        const char *p;
264        SString ws;
265        int err = 0, i;
266        bool withname = false;
267        if ((altname == NULL) || (altname[0] != 0))
268        {
269                err |= (f->Vputs(altname ? altname : getName()) == EOF);
270                err |= (f->Vputs(":\n") == EOF);
271                withname = true;
272        }
273        for (i = 0; p = id(i); i++)
274                err |= saveprop(f, i, p, force);
275        if (withname)
276                err |= (f->Vputs("\n") == EOF);
277        return err;
278}
279
280const char* ParamInterface::SERIALIZATION_PREFIX = "@Serialized:";
281
282int ParamInterface::saveprop(VirtFILE* f, int i, const char* p, bool force)
283{
284        if ((flags(i)&PARAM_DONTSAVE) && (!force)) return 0;
285        const char *typ = type(i);
286        if (*typ == 'p') return 0;
287
288        const char *t, *w;
289        SString ws;
290        int err = 0, cr;
291
292        err |= (f->Vputs(p) == EOF); f->Vputc(':');
293        cr = 0;
294        if ((*typ == 'x') || (*typ == 'o'))
295        {
296                ExtValue ex;
297                get(i, ex);
298                ws = SString(SERIALIZATION_PREFIX) + ex.serialize(NativeSerialization);
299        }
300        else
301                ws = get(i);
302        quoteTilde(ws);
303        w = ws.c_str();
304        if (ws.len() > 50) cr = 1;
305        else for (t = w; *t; t++) if ((*t == 10) || (*t == 13)) { cr = 1; break; }
306        if (cr) f->Vputs("~\n");
307        err |= (f->Vputs(w) == EOF);
308        err |= (f->Vputs(cr ? "~\n" : "\n") == EOF);
309        return err;
310}
311
312
313int SimpleAbstractParam::isequal(int i, void* defdata)
314{ // defdata->member == object->member ?
315        void *backup = object;
316        switch (type(i)[0])
317        {
318        case 'd':
319        {
320                select(defdata);
321                paInt x = getInt(i);
322                select(backup);
323                return x == getInt(i);
324        }
325        case 'f':
326        {
327                select(defdata);
328                double x = getDouble(i);
329                select(backup);
330                return x == getDouble(i);
331        }
332        case 's':
333        {
334                select(defdata);
335                SString x = getString(i);
336                select(backup);
337                return x == getString(i);
338        }
339        }
340        return 1;
341}
342
343void SimpleAbstractParam::save2(SString& f, void *defdata, bool addcr, bool all_names)
344{ // defdata!=NULL -> does not save default values
345        const char *p;
346        int i;
347        int needlabel = 0;
348        int first = 1;
349        SString val;
350        SString t;
351        int fl;
352        // t+=SString(getName()); t+=':';
353        for (i = 0; p = id(i); i++)
354                if (!((fl = flags(i))&PARAM_DONTSAVE))
355                {
356                if (defdata && isequal(i, defdata))
357                        needlabel = 1;
358                else
359                {
360                        if (!first) t += ", ";
361#ifndef SAVE_ALL_NAMES
362#ifdef SAVE_SELECTED_NAMES
363                        if (needlabel || all_names || !(fl & PARAM_CANOMITNAME))
364#else
365                        if (needlabel)
366#endif
367#endif
368                        {
369                                t += p; t += "="; needlabel = 0;
370                        }
371                        if (type(i)[0] == 's')
372                        { // string - special case
373                                SString str = getString(i);
374                                if (strContainsOneOf(str.c_str(), ", \\\n\r\t\""))
375                                {
376                                        t += "\"";
377                                        sstringQuote(str);
378                                        t += str;
379                                        t += "\"";
380                                }
381                                else
382                                        t += str;
383                        }
384                        else
385                                t += get(i);
386                        first = 0;
387                }
388                }
389        if (addcr)
390                t += "\n";
391        f += t;
392}
393
394int ParamInterface::load(VirtFILE* f, bool warn_unknown_fields, bool *abortable, int *linenum)
395{
396        SString buf;
397        int i;
398        const char *p, *p0;
399        int p_len;
400        bool loaded;
401        int fields_loaded = 0;
402        int unexpected_line = 0;
403        vector<bool> seen;
404        seen.resize(getPropCount());
405        if ((i=findId("beforeLoad"))>=0)
406                call(i,NULL,NULL);
407        while (((!abortable) || (!*abortable)) && loadSStringLine(f, buf))
408        {
409                if (linenum) (*linenum)++;
410                const char* t = buf.c_str();
411                p0 = t; while (isblank(*p0)) p0++;
412                if (!*p0) break;
413                if (p0[0] == '#') { unexpected_line = 0; continue; }
414                p = strchr(p0, ':');
415                if (!p)
416                        {
417                        switch(unexpected_line)
418                                {
419                                case 0:
420                                        logPrintf("ParamInterface", "load", LOG_WARN, "Ignored unexpected line %s while reading object '%s'",
421                                          linenum ?
422                                          SString::sprintf("%d",*linenum).c_str()
423                                        : SString::sprintf("'%s'", p0).c_str(),
424                                          getName());
425                                        break;
426                                case 1:
427                                        logPrintf("ParamInterface", "load", LOG_WARN, "The following line(s) were also unexpected and were ignored");
428                                        break;
429                                }
430                        unexpected_line++;
431                        continue;
432                        }
433                unexpected_line = 0;
434                p_len = (int)(p - p0);
435                loaded = false;
436                if (p_len && ((i = findIdn(p0, p_len)) >= 0))
437                {
438                        if (seen[i])
439                                {
440                                SString fileinfo;
441                                const char* fname=f->VgetPath();
442                                if (fname!=NULL)
443                                        {
444                                        fileinfo=SString::sprintf(" while reading from '%s'",fname);
445                                        if (linenum)
446                                                fileinfo+=SString::sprintf(" (line %d)",*linenum);
447                                        }
448                                logPrintf("ParamInterface", "load", LOG_WARN, "Multiple '%s.%s' fields found%s",getName(),id(i),fileinfo.c_str());
449                                }
450                        else
451                                seen[i]=true;
452                        if (!(flags(i)&PARAM_DONTLOAD))
453                        {
454                                if (p0[p_len + 1] == '~')
455                                {
456                                        SString s;
457                                        czytdotyldy(f, s);
458                                        int lfcount = 1;
459                                        const char* tmp = s.c_str();
460                                        while (tmp)
461                                                if ((tmp = strchr(tmp, '\n')))
462                                                {
463                                                lfcount++; tmp++;
464                                                }
465                                        removeCR(s);
466                                        int ch; while ((ch = f->Vgetc()) != EOF) if (ch == '\n') break;
467                                        unquoteTilde(s);
468                                        if (linenum && (flags(i)&PARAM_LINECOMMENT))
469                                                s = SString::sprintf("@file %s\n@line %d\n", f->VgetPath(), *linenum + 1) + s;
470                                        set(i, s.c_str());
471                                        if (linenum)
472                                                (*linenum) += lfcount;
473                                }
474                                else
475                                {
476                                        set(i, p0 + p_len + 1);
477                                }
478                                fields_loaded++;
479                                loaded = true;
480                        }
481                }
482                else if (warn_unknown_fields)
483                {
484                        SString name(p0, p_len);
485                        logPrintf("ParamInterface", "load", LOG_WARN, "Ignored unknown property '%s' while reading object '%s'", name.c_str(), getName());
486                }
487
488                if ((!loaded) && (p0[p_len + 1] == '~'))
489                { // eat unrecognized multiline field
490                        SString s;
491                        czytdotyldy(f, s);
492                        if (linenum)
493                        {
494                                const char* tmp = s.c_str();
495                                int lfcount = 1;
496                                while (tmp)
497                                        if ((tmp = strchr(tmp, '\n')))
498                                        {
499                                        lfcount++; tmp++;
500                                        }
501                                (*linenum) += lfcount;
502                        }
503                        int ch; while ((ch = f->Vgetc()) != EOF) if (ch == '\n') break;
504                }
505        }
506        if ((i=findId("afterLoad"))>=0)
507                call(i,NULL,NULL);
508        return fields_loaded;
509}
510
511
512/*
513SString SimpleAbstractParam::getString(int i)
514{
515char *t;
516switch (*(t=type(i)))
517{
518case 'd':
519{
520for (i=atol(get(i));i>=0;i--) if (t) t=strchr(t+1,'~');
521if (t)
522{
523t++;
524char *t2=strchr(t,'~');
525if (!t2) t2=t+strlen(t);
526SString str;
527strncpy(str.directWrite(t2-t),t,t2-t);
528str.endWrite(t2-t);
529return str;
530}
531}
532}
533return get(i);
534}
535*/
536
537int ParamInterface::findId(const char* n)
538{
539        int i; const char *p;
540        for (i = 0; p = id(i); i++) if (!strcmp(n, p)) return i;
541        return -1;
542}
543
544int ParamInterface::findIdn(const char* naz, int n)
545{
546        int i; const char *p;
547        for (i = 0; p = id(i); i++) if ((!strncmp(naz, p, n)) && (!p[n])) return i;
548        return -1;
549}
550
551void ParamInterface::get(int i, ExtValue &ret)
552{
553        switch (type(i)[0])
554        {
555        case 'd':       ret.setInt(getInt(i)); break;
556        case 'f':       ret.setDouble(getDouble(i)); break;
557        case 's':       ret.setString(getString(i)); break;
558        case 'o':       ret.setObject(getObject(i)); break;
559        case 'x':       ret = getExtValue(i); break;
560        default: logPrintf("ParamInterface", "get", LOG_ERROR, "'%s.%s' is not a field", getName(), id(i));
561        }
562}
563
564int ParamInterface::setInt(int i, const char* str)
565{
566        paInt value;
567        if (!ExtValue::parseInt(str, value, false, true))
568        {
569                paInt mn, mx, def;
570                if (getMinMax(i, mn, mx, def) >= 3)
571                        return setInt(i, def) | PSET_PARSEFAILED;
572                else
573                        return setInt(i, (paInt)0) | PSET_PARSEFAILED;
574        }
575        else
576                return setInt(i, value);
577}
578
579int ParamInterface::setDouble(int i, const char* str)
580{
581        double value;
582        if (!ExtValue::parseDouble(str, value, true))
583        {
584                double mn, mx, def;
585                if (getMinMax(i, mn, mx, def) >= 3)
586                        return setDouble(i, def) | PSET_PARSEFAILED;
587                else
588                        return setDouble(i, (double)0) | PSET_PARSEFAILED;
589        }
590        else
591                return setDouble(i, value);
592}
593
594int ParamInterface::set(int i, const ExtValue &v)
595{
596        switch (type(i)[0])
597        {
598        case 'd':
599                if ((v.type == TInt) || (v.type == TDouble)) return setInt(i, v.getInt());
600                else
601                {
602                        if (v.type == TObj)
603                        {
604                                logPrintf("ParamInterface", "set", LOG_ERROR, "Setting int '%s.%s' from object reference (%s)", getName(), id(i), v.getString().c_str());
605                                return 0;
606                        }
607                        else
608                                return setInt(i, v.getString().c_str());
609                }
610        case 'f':
611                if ((v.type == TInt) || (v.type == TDouble)) return setDouble(i, v.getDouble());
612                else
613                {
614                        if (v.type == TObj)
615                        {
616                                logPrintf("ParamInterface", "set", LOG_ERROR, "Setting float '%s.%s' from object reference (%s)", getName(), id(i), v.getString().c_str());
617                                return 0;
618                        }
619                        else
620                                return setDouble(i, v.getString().c_str());
621                }
622        case 's': { SString t = v.getString(); return setString(i, t); }
623        case 'o':
624                if ((v.type!=TUnknown)&&(v.type!=TObj))
625                        logPrintf("ParamInterface", "set", LOG_ERROR, "Setting object '%s.%s' from %s", getName(), id(i), v.typeAndValue().c_str());
626                else
627                        return setObject(i, v.getObject());
628                break;
629        case 'x': return setExtValue(i, v);
630        default: logPrintf("ParamInterface", "set", LOG_ERROR, "'%s.%s' is not a field", getName(), id(i));
631        }
632        return 0;
633}
634
635int ParamInterface::set(int i, const char *v)
636{
637        char typ = type(i)[0];
638        switch (typ)
639        {
640        case 'd': return setInt(i, v);
641        case 'f': return setDouble(i, v);
642        case 's': { SString t(v); return setString(i, t); }
643        case 'x': case 'o':
644        {
645                ExtValue e;
646                const char* after;
647                if (!strncmp(v, SERIALIZATION_PREFIX, strlen(SERIALIZATION_PREFIX)))
648                {
649                        after = e.deserialize(v + strlen(SERIALIZATION_PREFIX));
650                        if ((after == NULL) || (*after))
651                        {
652                                logPrintf("ParamInterface", "set", LOG_ERROR, "serialization format mismatch in %s.%s", (getName() ? getName() : "<Unknown>"), id(i));
653                                e.setEmpty();
654                        }
655                }
656                else if ((after = e.parseNumber(v)) && (*after == 0)) //consumed the whole string
657                {
658                        //OK!
659                }
660                else
661                {
662                        e.setString(SString(v));
663                }
664                if (typ == 'x')
665                        return setExtValue(i, e);
666                else
667                        return setObject(i, e.getObject());
668        }
669        }
670        return 0;
671}
672
673SString ParamInterface::getText(int i)
674{
675        const char *t;
676        if ((*(t = type(i))) == 'd')
677        {
678                paInt mn, mx, def;
679                int value = getInt(i);
680                if (getMinMax(i, mn, mx, def) >= 2)
681                {
682                        if (value > mx)
683                                return get(i);
684                        value -= mn;
685                }
686                if (value < 0) return get(i);
687                for (; value >= 0; value--) if (t) t = strchr(t + 1, '~');
688                if (t)
689                {
690                        t++;
691                        const char *t2 = strchr(t, '~');
692                        if (!t2) t2 = t + strlen(t);
693                        return SString(t, (int)(t2 - t));
694                }
695        }
696        return get(i);
697}
698
699SString ParamInterface::get(int i)
700{
701        switch (type(i)[0])
702        {
703        case 'd': return SString::valueOf(getInt(i));
704        case 'f': return SString::valueOf(getDouble(i));
705        case 's': return getString(i);
706        }
707        ExtValue v;
708        get(i, v);
709        return v.getString();
710}
711
712bool ParamInterface::isValidTypeDescription(const char* t)
713{
714if (t==NULL) return false;
715if (*t==0) return false;
716if (strchr("dfsoxp", *t)==NULL) return false;
717return true;
718}
719
720//////////////////////////////// PARAM ////////////////////////////////////
721
722#ifdef _DEBUG
723void SimpleAbstractParam::sanityCheck(int i)
724{
725        ParamEntry *pe=entry(i);
726
727        const char* t=pe->type;
728        const char* err=NULL;
729
730        if (!isValidTypeDescription(t))
731                err="invalid type description";
732        if (*t=='p')
733        {
734                if (pe->fun1==NULL)
735                        err="no procedure defined";
736        }
737        else
738        {
739                if (!(pe->flags & PARAM_READONLY))
740                { //write access
741                        if ((pe->fun2==NULL)&&(pe->offset==PARAM_ILLEGAL_OFFSET))
742                                err="no field defined (GETONLY without PARAM_READONLY?)";
743                }
744        }
745        if (err!=NULL)
746                logPrintf("SimpleAbstractParam","sanityCheck", LOG_ERROR,
747                "Invalid ParamEntry for %s.%s (%s)", getName(), pe->id, err);
748}       
749#endif
750
751void *SimpleAbstractParam::getTarget(int i)
752{
753        return (void*)(((char*)object) + entry(i)->offset);
754        //return &(object->*(entry(i)->fldptr));
755}
756
757///////// get
758
759#ifdef _DEBUG
760#define SANITY_CHECK(i) sanityCheck(i)
761#else
762#define SANITY_CHECK(i)
763#endif
764
765paInt SimpleAbstractParam::getInt(int i)
766{
767        SANITY_CHECK(i);
768        ExtValue v;
769        ParamEntry *pe = entry(i);
770        if (pe->fun1)
771        {
772                (*(void(*)(void*, ExtValue*))pe->fun1)(object, &v);
773                return v.getInt();
774        }
775        else
776        {
777                void *target = getTarget(i);
778                return *((paInt*)target);
779        }
780}
781
782double SimpleAbstractParam::getDouble(int i)
783{
784        SANITY_CHECK(i);
785        ExtValue v;
786        ParamEntry *pe = entry(i);
787        if (pe->fun1)
788        {
789                (*(void(*)(void*, ExtValue*))pe->fun1)(object, &v);
790                return v.getDouble();
791        }
792        else
793        {
794                void *target = getTarget(i);
795                return *((double*)target);
796        }
797}
798
799SString SimpleAbstractParam::getString(int i)
800{
801        SANITY_CHECK(i);
802        ExtValue v;
803        ParamEntry *pe = entry(i);
804        if (pe->fun1)
805        {
806                (*(void(*)(void*, ExtValue*))pe->fun1)(object, &v);
807                return v.getString();
808        }
809        else
810        {
811                void *target = getTarget(i);
812                return *((SString*)target);
813        }
814}
815
816ExtObject SimpleAbstractParam::getObject(int i)
817{
818        SANITY_CHECK(i);
819        ExtValue v;
820        ParamEntry *pe = entry(i);
821        if (pe->fun1)
822        {
823                (*(void(*)(void*, ExtValue*))pe->fun1)(object, &v);
824                return v.getObject();
825        }
826        else
827        {
828                void *target = getTarget(i);
829                return *((ExtObject*)target);
830        }
831}
832
833ExtValue SimpleAbstractParam::getExtValue(int i)
834{
835        SANITY_CHECK(i);
836        ExtValue v;
837        ParamEntry *pe = entry(i);
838        if (pe->fun1)
839        {
840                (*(void(*)(void*, ExtValue*))pe->fun1)(object, &v);
841                return v;
842        }
843        else
844        {
845                void *target = getTarget(i);
846                return *((ExtValue*)target);
847        }
848}
849
850
851//////// set
852
853int SimpleAbstractParam::setInt(int i, paInt x)
854{
855        SANITY_CHECK(i);
856        ExtValue v;
857        ParamEntry *pe = entry(i);
858        if (pe->flags&PARAM_READONLY) return PSET_RONLY;
859        paInt xcopy = x; //only needed for messageOnExceedRange(): retain original, requested value of x because it may be changed below
860        paInt mn = 0, mx = 0;
861        int result = 0;
862        const char* t = pe->type + 1;
863        while (*t) if (*t == ' ') break; else t++;
864        if (sscanf(t, PA_INT_SCANF " " PA_INT_SCANF, &mn, &mx) == 2)
865                if (mn <= mx) // else if mn>mx then the min/max constraint makes no sense and there is no checking
866                {
867                if (x < mn) { x = mn; result = PSET_HITMIN; }
868                else if (x > mx) { x = mx; result = PSET_HITMAX; }
869                }
870
871        if (pe->fun2)
872        {
873                v.setInt(x);
874                result |= (*(int(*)(void*, const ExtValue*))pe->fun2)(object, &v);
875        }
876        else
877        {
878                void *target = getTarget(i);
879                if (dontcheckchanges || (*((paInt*)target) != x))
880                {
881                        result |= PSET_CHANGED;
882                        *((paInt*)target) = x;
883                }
884        }
885        messageOnExceedRange(i, result, xcopy);
886        return result;
887}
888
889int SimpleAbstractParam::setDouble(int i, double x)
890{
891        SANITY_CHECK(i);
892        ExtValue v;
893        ParamEntry *pe = entry(i);
894        if (pe->flags&PARAM_READONLY) return PSET_RONLY;
895        double xcopy = x; //only needed for messageOnExceedRange(): retain original, requested value of x because it may be changed below
896        double mn = 0, mx = 0;
897        int result = 0;
898        const char* t = pe->type + 1;
899        while (*t) if (*t == ' ') break; else t++;
900        if (sscanf(t, "%lg %lg", &mn, &mx) == 2)
901                if (mn <= mx) // else if mn>mx then the min/max constraint makes no sense and there is no checking
902                {
903                if (x < mn) { x = mn; result = PSET_HITMIN; }
904                else if (x > mx) { x = mx; result = PSET_HITMAX; }
905                }
906
907        if (pe->fun2)
908        {
909                v.setDouble(x);
910                result |= (*(int(*)(void*, const ExtValue*))pe->fun2)(object, &v);
911        }
912        else
913        {
914                void *target = getTarget(i);
915                if (dontcheckchanges || (*((double*)target) != x))
916                {
917                        result |= PSET_CHANGED;
918                        *((double*)target) = x;
919                }
920        }
921        messageOnExceedRange(i, result, xcopy);
922        return result;
923}
924
925int SimpleAbstractParam::setString(int i, const SString& x)
926{
927        SANITY_CHECK(i);
928        ExtValue v;
929        SString vs;
930        const SString *xx = &x;
931        ParamEntry *pe = entry(i);
932        if (pe->flags&PARAM_READONLY) return PSET_RONLY;
933        SString xcopy = x; //only needed for messageOnExceedRange(): retain original, requested value of x because it may be changed below
934        const char* t = pe->type + 1;
935        while (*t) if (*t == ' ') break; else t++;
936        int mn = 0, mx = 0;
937        int result = 0;
938        if (sscanf(t, "%d %d", &mn, &mx) == 2) //using getMinMax would also get default value, which is not needed here
939        {
940                if ((x.len() > mx) && (mx > 0))
941                {
942                        vs = x.substr(0, mx);
943                        xx = &vs;
944                        result |= PSET_HITMAX;
945                }
946        }
947
948        if (pe->fun2)
949        {
950                v.setString(*xx);
951                result |= (*(int(*)(void*, const ExtValue*))pe->fun2)(object, &v);
952        }
953        else
954        {
955                void *target = getTarget(i);
956                if (dontcheckchanges || (!(*((SString*)target) == *xx)))
957                {
958                        result |= PSET_CHANGED;
959                        *((SString*)target) = *xx;
960                }
961        }
962        messageOnExceedRange(i, result, xcopy);
963        return result;
964}
965
966int SimpleAbstractParam::setObject(int i, const ExtObject& x)
967{
968        SANITY_CHECK(i);
969        ExtValue v;
970        ParamEntry *pe = entry(i);
971        if (pe->flags&PARAM_READONLY) return PSET_RONLY;
972        if (pe->flags&PARAM_OBJECTSET)
973                {
974                ExtObject o=getObject(i);
975                Param tmp;
976                ParamInterface* oif=o.getParamInterface(tmp);
977                int ass;
978                if (oif && ((ass=oif->findId("assign"))>=0))
979                        {
980                        ExtValue arg=x;
981                        oif->call(ass,&arg,&v);
982                        }
983                else
984                        logPrintf("SimpleAbstractParam", "setObject", LOG_ERROR,
985                                  "'%s.%s' is PARAM_OBJECTSET but no 'assign()' in %s", getName(), pe->id, o.interfaceName());
986                return PSET_CHANGED;
987                }
988        ExtObject xcopy = x; //only needed for messageOnExceedRange(): retain original, requested value of x because it may be changed below
989        if (pe->fun2)
990        {
991                v.setObject(x);
992                int result = (*(int(*)(void*, const ExtValue*))pe->fun2)(object, &v);
993                messageOnExceedRange(i, result, xcopy);
994                return result;
995        }
996        else
997        {
998                void *target = getTarget(i);
999                *((ExtObject*)target) = x;
1000                return PSET_CHANGED;
1001        }
1002}
1003
1004int SimpleAbstractParam::setExtValue(int i, const ExtValue& x)
1005{
1006        SANITY_CHECK(i);
1007        ParamEntry *pe = entry(i);
1008        if (pe->flags&PARAM_READONLY) return PSET_RONLY;
1009        ExtValue xcopy = x; //only needed for messageOnExceedRange(): retain original, requested value of x because it may be changed below
1010        if (pe->fun2)
1011        {
1012                int result = (*(int(*)(void*, const ExtValue*))pe->fun2)(object, &x);
1013                messageOnExceedRange(i, result, xcopy);
1014                return result;
1015        }
1016        else
1017        {
1018                void *target = getTarget(i);
1019                *((ExtValue*)target) = x;
1020                return PSET_CHANGED;
1021        }
1022}
1023
1024void SimpleAbstractParam::call(int i, ExtValue *args, ExtValue *ret)
1025{
1026        SANITY_CHECK(i);
1027        ParamEntry *pe = entry(i);
1028        if (!pe) return;
1029        if (pe->fun1 && (pe->type[0] == 'p'))
1030                (*(void(*)(void*, ExtValue*, ExtValue*))pe->fun1)(object, args, ret);
1031        else
1032        {
1033                logPrintf("SimpleAbstractParam", "call", LOG_ERROR,
1034                        (*pe->type != 'p') ? "'%s.%s' is not a function" : "Internal error - undefined function pointer for '%s.%s'", getName(), pe->id);
1035                ret->setInvalid();
1036        }
1037}
1038
1039void SimpleAbstractParam::setDefault()
1040{
1041        bool save = dontcheckchanges;
1042        dontcheckchanges = 1;
1043        ParamInterface::setDefault();
1044        dontcheckchanges = save;
1045}
1046
1047void SimpleAbstractParam::setDefault(int i)
1048{
1049        bool save = dontcheckchanges;
1050        dontcheckchanges = 1;
1051        ParamInterface::setDefault(i);
1052        dontcheckchanges = save;
1053}
1054
1055// Returns the address of the beginning of the line.
1056// len = line length (without \n).
1057// 0 may mean the line with length=0 or the end of the SString.
1058// poz is advanced to the beginning of the next line.
1059// A typical loop: for(poz=0;poz<s.d;) {line=getline(s,poz,len);...
1060static const char *getline(const SString &s, int &poz, int &len)
1061{
1062        const char *beg = s.c_str() + poz;
1063        if (poz >= s.len()) { poz = s.len(); len = 0; return s.c_str() + s.len(); }
1064        const char *lf = strchr(beg, '\n');
1065        if (!lf) { lf = s.c_str() + s.len() - 1; poz = s.len(); }
1066        else { poz = (int)(lf - s.c_str()) + 1; if (poz > s.len()) poz = s.len(); }
1067        while (lf >= beg) if ((*lf == '\n') || (*lf == '\r')) lf--; else break;
1068        len = (int)(lf - beg) + 1;
1069        return beg;
1070}
1071
1072int ParamInterface::load2(const SString &s, int &poz)
1073{
1074        int i; // the index number of the parameter
1075        int tmpi;
1076        int len;
1077        int ret;
1078        int fields_loaded = 0;
1079        const char *t, *lin, *end;
1080        const char *equals_sign, *field_end, *next_field;
1081        char remember;
1082        const char *quote, *quote2;
1083        const char *value, *valstop;
1084        SString tmpvalue;
1085        bool parse_failed=false;
1086        if (poz >= s.len()) return fields_loaded;
1087        t = s.c_str() + poz;
1088
1089        lin = getline(s, poz, len); // all fields must be encoded in a single line
1090        if (!len) return fields_loaded; // empty line = end
1091        i = 0;
1092        end = lin + len;
1093        while (t < end)
1094        {
1095                // processing a single field
1096                // "p:name=field_value,  field_name=field_value  , name=value..."
1097                //                     ^ ^-t (after)           ^ ^_next_field
1098                //                     \_t (before)            \_field_end
1099                while (isspace(*t)) if (t < end) t++; else return fields_loaded;
1100
1101                field_end = strchrlimit(t, ',', end); if (!field_end) field_end = end;
1102                next_field = field_end;
1103                while ((field_end>t) && isblank(field_end[-1])) field_end--;
1104                quote = strchrlimit(t, '\"', field_end);
1105                if (quote)
1106                {
1107                        quote2 = skipQuoteString(quote + 1, end);
1108                        if (quote2 > field_end)
1109                        {
1110                                field_end = strchrlimit(quote2 + 1, ',', end);
1111                                if (!field_end) field_end = end;
1112                                next_field = field_end;
1113                        }
1114                        equals_sign = strchrlimit(t, '=', quote);
1115                }
1116                else
1117                {
1118                        equals_sign = strchrlimit(t, '=', field_end);
1119                        quote2 = 0;
1120                }
1121                if (equals_sign == t) { t++; equals_sign = 0; }
1122                if (field_end == t)     // skip empty value
1123                {
1124                        t++; i++;
1125                        continue;
1126                }
1127                if (equals_sign) // have parameter name
1128                {
1129                        tmpi = findIdn(t, (int)(equals_sign - t));
1130                        i = tmpi;
1131                        if (tmpi < 0)
1132                        {
1133                                SString name(t, (int)(equals_sign - t));
1134                                logPrintf("Param", "load2", LOG_WARN, "Unknown property '%s' while reading object '%s' (ignored)", name.c_str(), getName());
1135                        }
1136                        t = equals_sign + 1; // t=value
1137                }
1138#ifdef WARN_MISSING_NAME
1139                else
1140#ifdef SAVE_SELECTED_NAMES
1141                        if ((i>=getPropCount()) || !(flags(i)&PARAM_CANOMITNAME))
1142#endif
1143                        {
1144                        if (id(i))
1145                                logPrintf("Param", "load2", LOG_WARN, "Missing property name in '%s' (assuming '%s')", getName(), id(i));
1146                        else
1147                                logPrintf("Param", "load2", LOG_WARN, "Value after the last property of '%s'", getName());
1148                        }
1149#endif
1150                if ((i >= 0) && id(i))
1151                {
1152                        value = t;
1153                        if (quote)
1154                        {
1155                                tmpvalue.copyFrom(quote + 1, (int)(quote2 - quote) - 1);
1156                                sstringUnquote(tmpvalue);
1157                                value = tmpvalue.c_str();
1158                                valstop = quote2;
1159                        }
1160                        else
1161                                if (field_end < end) valstop = field_end; else valstop = end;
1162
1163                        remember = *valstop;
1164                        *(char*)valstop = 0;
1165                        ret = set(i, value);
1166                        fields_loaded++;
1167                        if (ret&(PSET_HITMAX | PSET_HITMIN))
1168                                logPrintf("Param", "load2", LOG_WARN, "Adjusted '%s' in '%s' (was too %s)",
1169                                id(i), getName(), (ret&PSET_HITMAX) ? "big" : "small");
1170                        if (ret&PSET_PARSEFAILED)
1171                                parse_failed=true;
1172                        *(char*)valstop = remember;
1173                }
1174
1175                if (i >= 0) i++;
1176#ifdef __CODEGUARD__
1177                if (next_field<end-1) t=next_field+1; else return fields_loaded;
1178#else
1179                t = next_field + 1;
1180#endif
1181        }
1182        return fields_loaded | (parse_failed ? LOAD2_PARSE_FAILED : 0);
1183}
1184
1185int Param::grmember(int g, int a)
1186{
1187        if ((getGroupCount() < 2) && (!g))
1188                return (a < getPropCount()) ? a : -9999;
1189
1190        ParamEntry *e = entry(0);
1191        int x = 0, i = 0;
1192        for (; e->id; i++, e++)
1193        {
1194                if (e->group == g)
1195                        if (a == x) return i; else x++;
1196        }
1197        return -9999;
1198}
Note: See TracBrowser for help on using the repository browser.