1 #ifndef MSP_DATAFILE_LOADER_H_
2 #define MSP_DATAFILE_LOADER_H_
5 #include <msp/io/file.h>
6 #include "loaderaction.h"
14 Base class for data loaders. This class only provides core functionality.
15 You'll almost certainly want to use one of the BasicLoader classes instead.
17 Under normal circumstances, a class capable of being loaded should have a
18 nested typed called Loader which resolves to a descendant of this class. If
19 another structure is used, the loader object must be constructed manually.
21 A loader class should execute one or more calls to the various add() functions
22 to register actions with expected keywords. Currently possible actions are
23 calling a function of the loader, storing values in member variables of an
24 object and ignoring the statement. If a unexpected keyword is encountered, an
25 exception is thrown and the loading is aborted.
27 A sub-object can be loaded with one of the load_sub functions.
29 When loading has finished successfully, the virtual function finish() is
30 called. Any post-processing of the data should be placed here and not in the
33 See also classes ObjectLoader and CollectionObjectLoader in objectloader.h.
38 typedef std::map<StatementKey, LoaderAction *> ActionMap;
43 const Statement *cur_st;
46 std::list<Loader *> aux_loaders;
54 /** Loads statements from a parser. */
58 /** Loads data from a statement. */
59 void load(const Statement &st);
61 /** Loads statemsnts from a parser, feeding them directly to actions. */
62 void load_direct(Parser &, unsigned);
64 /** Processes a single statement */
65 void load_statement(const Statement &st);
68 /** Loads a sub-object from the statement being processed. The Loader class
69 of the sub-object is automatically used. */
73 typename S::Loader ldr(s);
77 /** Loads a sub-object from the statement being processed with an extra
78 parameter for the Loader. The Loader class of the sub-object is
79 automatically used. */
80 template<typename S, typename T>
81 void load_sub(S &s, T &p)
83 typename S::Loader ldr(s, p);
87 /** Processes the current statement's substatements with another Loader. */
88 void load_sub_with(Loader &);
90 /** Adds a keyword that is loaded by calling a function. */
92 void add(const std::string &k, void (L::*func)())
93 { add(k, new LoaderFunc0<L>(func)); }
95 template<typename L, typename A0>
96 void add(const std::string &k, void (L::*func)(A0))
97 { add(k, new LoaderFunc1<L, A0>(func)); }
99 template<typename L, typename A0, typename A1>
100 void add(const std::string &k, void (L::*func)(A0, A1))
101 { add(k, new LoaderFunc2<L, A0, A1>(func)); }
103 template<typename L, typename A0, typename A1, typename A2>
104 void add(const std::string &k, void (L::*func)(A0, A1, A2))
105 { add(k, new LoaderFunc3<L, A0, A1, A2>(func)); }
107 template<typename L, typename A0, typename A1, typename A2, typename A3>
108 void add(const std::string &k, void (L::*func)(A0, A1, A2, A3))
109 { add(k, new LoaderFunc4<L, A0, A1, A2, A3>(func)); }
111 template<typename L, typename A0, typename A1, typename A2, typename A3, typename A4>
112 void add(const std::string &k, void (L::*func)(A0, A1, A2, A3, A4))
113 { add(k, new LoaderFunc5<L, A0, A1, A2, A3, A4>(func)); }
115 /** Adds a keyword that is loaded into a member of the loaded object. */
116 template<typename L, typename T0>
117 void add(const std::string &k, T0 L::*p0)
118 { add(k, new LoadValue1<L, T0>(p0)); }
120 template<typename L, typename T0, typename T1>
121 void add(const std::string &k, T0 L::*p0, T1 L::*p1)
122 { add(k, new LoadValue2<L, T0, T1>(p0, p1)); }
124 /** Adds a keyword that is recognized but ignored. */
125 void add(const std::string &k)
129 void add(const std::string &, LoaderAction *);
132 void add_auxiliary_loader(Loader &);
135 bool has_action(const StatementKey &) const;
136 LoaderAction *find_action(const StatementKey &) const;
139 /** Returns the source of the statement being processed. This can be used
140 to implement relative paths in include-like statements. Note that the
141 source may not necessarily be a file. */
142 const std::string &get_source() const;
144 /** Returns the keyword of the statement being processed. Can be used to
145 implement dynamic keywords. */
146 const std::string &get_keyword() const;
148 virtual void finish() { }
153 Loads an object from a file. The object must have a public Loader class.
156 void load(T &obj, const std::string &fn)
158 IO::BufferedFile in(fn);
160 Parser parser(in, fn);
161 typename T::Loader loader(obj);
165 template<typename T, typename U>
166 void load(T &obj, const std::string &fn, U &arg)
168 IO::BufferedFile in(fn);
170 Parser parser(in, fn);
171 typename T::Loader loader(obj, arg);
175 } // namespace DataFile