source: cpp/frams/param/multiparamload.h @ 268

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

ParamInterface::load warns on unknown fields and skips comments

  • Property svn:eol-style set to native
File size: 6.6 KB
1// This file is a part of the Framsticks GDK.
2// Copyright (C) 1999-2014  Maciej Komosinski and Szymon Ulatowski.  See LICENSE.txt for details.
3// Refer to for further information.
8#include <stdio.h>
9#include "param.h"
10#include <frams/virtfile/virtfile.h>
11#include <frams/util/extvalue.h>
13/** This is the general "framsticks-format" file parser for loading multiple objects.
15        The loader can be configured to recognize multiple object types from object headers
16    and automatically call ParamInterface::load for the matching class.
18    Your code should repeatedly call MultiParamLoader::go() method and check the status after each call, until the end of file.
19    The loader pauses before and/or after each object giving you a chance to perform your application-specific actions (see MultiParamLoader::breakOn()).
20    If your application does not require any special actions, then the simple MultiParamLoader:run() can be used.
21    The word "record" (and "record type") used in this description refer to the textual form of a serialized object - this is to avoid confusion with 'live' objects passed to the loader methods. "Record type" can be the same as the class name, but it does not have to be the same. For example, the most common record type for storing the Genotype object is called "org" (think: organism) instead of "Genotype".
23    Typical usage scenarios:
24    1. Loading a file that contains at most one object of any given class:
25    - declare the object class(es) - MultiParamLoader::addClass()
26    - call MultiParamLoader::run()
27    - and that's all, the records from the file will be loaded into the corresponding objects
29    2. Loading multiple objects and adding them to a list (see loadtest.cpp for a sample code that demonstrates this scenario)
30    - declare the object class giving the empty "template" object - MultiParamLoader::addClass()
31    - set breakOn(AfterObject)
32    - call MultiParamLoader::go() in a loop
33    - the returned status will be equal to AfterObject each time an object is loaded. One can detect this condition and create the real object from our template object
34    (alternatively, one could breakOn(BeforeObject) and use MultiParamLoader::loadObjectNow(ParamInterface*) to load the incoming object into a newly created object).   
35 */
36class MultiParamLoader
38VirtFILE *file;
39SListTempl<VirtFILE*> filestack;
40char ownfile;
41PtrListTempl<ExtObject*> objects;
42int status;
43SString lasterror, lastcomment, lastunknown;
44ExtObject lastobject;
45int breakcond;
46Param emptyparam;
48void init();
50int maybeBreak(int cond)
51{ status=cond; return breakcond & cond; }
53VirtFILE* popstack();
54void clearstack();
56  public:
57MultiParamLoader() {init();}
58MultiParamLoader(VirtFILE *f) {init(); load(f);}
59MultiParamLoader(const char* filename) {init(); load(filename);}
61~MultiParamLoader() {abort();clearObjects();}
63void reset();
65void load(); //< use previously opened file
66void load(VirtFILE *f);
67void load(const char* filename);
69/** Register the object class. Class names will be matched with object headers ("xxx:" in the input file).
70    Used with breakOn(BeforeObject) and/or breakOn(AfterObject).
71    Note that registered classes will only work when the record name matches the class name, otherwise breakOn(BeforeUnknown) must be used and then getClassName() to check for the expected record.
72 */
73void addObject(ParamInterface *pi) {objects+=new ExtObject(pi);}
74void removeObject(ParamInterface *pi) {removeObject(ExtObject(pi));}
75void addObject(const ExtObject &o) {objects+=new ExtObject(o);}
76void removeObject(const ExtObject &o);
77int findObject(const ExtObject &o);
78void clearObjects();
80/** To be used in the main loop: while(event=loader.go()) { ... }
81    loader.go() will return on specified events (@see breakOn(), noBreakOn()),
82    then you can handle the event and resume loading.
83 */
84virtual int go();
85/** same value as 'go()' */
86int getStatus() {return status;}
87int finished() {return (status==Finished);}
89VirtFILE *getFile() {return file;}
91/** Abort immediately and close the file if needed */
92void abort();
93/** @param conditions can be combined bitwise, eg. MultiParamLoader::BeforeObject |  MultiParamLoader::OnComment
94    @see BreakConfitions
96void breakOn(int conditions) {breakcond|=conditions;}
97void noBreakOn(int conditions) {breakcond&=~conditions;}
99   These constants are used as arguments in breakOn(), and as status values from go() and getStatus().
100   The user code can define some classes for automatic recognition (using addClass()); such records can be read without performing any additional actions.
102   - BeforeObject: found an object with recognized classname (addClass()). Application code can choose to skip the incoming record (skipObject()), redirect the incoming data into a different object (loadObjectNow(ParamInterface*)), or do nothing for default behavior (loading into previously registered object).
104   - AfterObject: the object was loaded into the registered class interface (addClass()). This is to allow for additional actions after loading the object (e.g. data validation).
106   - BeforeUnknown: unknown (not registered) object header detected. Like in BeforeObject, the application can skipObject() or loadObjectNow().
108@see getClass(), GetClassName()
109 */
110enum BreakConditions { Finished=0, BeforeObject=1, AfterObject=2,
111                       BeforeUnknown=4, OnComment=8, OnError=16, Loading=32 };
113/** Can be used BeforeObject and AfterObject */
114ExtObject &getObject() {return lastobject;}
115/** Can be used BeforeUnknown, BeforeObject, AfterObject */
116const SString& getObjectName() {return lastunknown;}
117void setObjectName(SString n) {lastunknown=n;}
118/** Unknown object will be loaded if you set its class BeforeUnknown */
119void setObject(ParamInterface *pi) {lastobject=ExtObject(pi);}
120void setObject(const ExtObject& o) {lastobject=o;}
121/** Can be used OnComment */
122const SString& getComment() {return lastcomment;}
123/** Can be used OnError */
124const SString& getError() {return lasterror;}
125/** Can be used BeforeObject and BeforeUnknown */
126int loadObjectNow(ParamInterface *pi,bool warn_unknown_fields=true) {return loadObjectNow(ExtObject(pi),warn_unknown_fields);}
127int loadObjectNow(const ExtObject &o,bool warn_unknown_fields=true);
128/** Can be used BeforeObject */
129int loadObjectNow() {return loadObjectNow(getObject());}
130/** Can be used BeforeObject and BeforeUnknown.
131    Object data will not be loaded. */
132int skipObject() {return loadObjectNow(&emptyparam,false);}
133/** @return 1 if no errors */
134int run();
136void includeFile(SString& filename);
137bool returnFromIncluded();
138bool alreadyIncluded(const char* filename);
Note: See TracBrowser for help on using the repository browser.