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

Last change on this file since 730 was 720, checked in by Maciej Komosinski, 7 years ago

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