source/loader.h

   1 #ifndef MSP_DATAFILE_LOADER_H_
   2 #define MSP_DATAFILE_LOADER_H_
   3
   4 #include <map>
   5 #include <msp/io/file.h>
   6 #include "loaderaction.h"
   7 #include "meta.h"
   8 #include "parser.h"
   9 #include "statement.h"
  10
  11 namespace Msp {
  12 namespace DataFile {
  13
  14 /**
  15 Base class for data loaders.  This class only provides core functionality.
  16 You'll almost certainly want to use one of the BasicLoader classes instead.
  17
  18 Under normal circumstances, a class capable of being loaded should have a
  19 nested typed called Loader which resolves to a descendant of this class.  If
  20 another structure is used, the loader object must be constructed manually.
  21
  22 A loader class should execute one or more calls to the various add() functions
  23 to register actions with expected keywords.  Currently possible actions are
  24 calling a function of the loader, storing values in member variables of an
  25 object and ignoring the statement.  If a unexpected keyword is encountered, an
  26 exception is thrown and the loading is aborted.
  27
  28 A sub-object can be loaded with one of the load_sub functions.
  29
  30 When loading has finished successfully, the virtual function finish() is
  31 called.  Any post-processing of the data should be placed here and not in the
  32 destructor.
  33
  34 See also classes ObjectLoader and CollectionObjectLoader in objectloader.h.
  35 */
  36 class Loader
  37 {
  38 private:
  39         typedef std::map<StatementKey, LoaderAction *> ActionMap;
  40
  41         ActionMap actions;
  42         Parser *cur_parser;
  43         unsigned cur_level;
  44         const Statement *cur_st;
  45         bool sub_loaded;
  46         bool direct;
  47         std::list<Loader *> aux_loaders;
  48 protected:
  49         bool check_sub_loads;
  50
  51         Loader();
  52 public:
  53         virtual ~Loader();
  54
  55         /** Loads statements from a parser. */
  56         void load(Parser &p);
  57
  58 private:
  59         /** Loads data from a statement. */
  60         void load(const Statement &st);
  61
  62         /** Loads statemsnts from a parser, feeding them directly to actions. */
  63         void load_direct(Parser &, unsigned);
  64
  65         /** Processes a single statement */
  66         void load_statement(const Statement &st);
  67
  68 protected:
  69         /** Loads a sub-object from the statement being processed.  The Loader class
  70         of the sub-object is automatically used. */
  71         template<typename S>
  72         void load_sub(S &s)
  73         {
  74                 typename S::Loader ldr(s);
  75                 load_sub_with(ldr);
  76         }
  77
  78         /** Loads a sub-object from the statement being processed with an extra
  79         parameter for the Loader.  The Loader class of the sub-object is
  80         automatically used. */
  81         template<typename S, typename T>
  82         void load_sub(S &s, T &p)
  83         {
  84                 typename S::Loader ldr(s, p);
  85                 load_sub_with(ldr);
  86         }
  87
  88         /** Processes the current statement's substatements with another Loader. */
  89         void load_sub_with(Loader &);
  90
  91         /** Adds a keyword that is loaded by calling a function. */
  92         template<typename L>
  93         void add(const std::string &k, void (L::*func)())
  94         { add(k, new LoaderFunc0<L>(func)); }
  95
  96         template<typename L, typename A0>
  97         void add(const std::string &k, void (L::*func)(A0))
  98         { add(k, new LoaderFunc1<L, A0>(func)); }
  99
 100         template<typename L, typename A0, typename A1>
 101         void add(const std::string &k, void (L::*func)(A0, A1))
 102         { add(k, new LoaderFunc2<L, A0, A1>(func)); }
 103
 104         template<typename L, typename A0, typename A1, typename A2>
 105         void add(const std::string &k, void (L::*func)(A0, A1, A2))
 106         { add(k, new LoaderFunc3<L, A0, A1, A2>(func)); }
 107
 108         template<typename L, typename A0, typename A1, typename A2, typename A3>
 109         void add(const std::string &k, void (L::*func)(A0, A1, A2, A3))
 110         { add(k, new LoaderFunc4<L, A0, A1, A2, A3>(func)); }
 111
 112         template<typename L, typename A0, typename A1, typename A2, typename A3, typename A4>
 113         void add(const std::string &k, void (L::*func)(A0, A1, A2, A3, A4))
 114         { add(k, new LoaderFunc5<L, A0, A1, A2, A3, A4>(func)); }
 115
 116         /** Adds a keyword that is loaded into a member of the loaded object. */
 117         template<typename L, typename T0>
 118         void add(const std::string &k, T0 L::*p0)
 119         { add(k, new LoadValue1<L, T0>(p0)); }
 120
 121         template<typename L, typename T0, typename T1>
 122         void add(const std::string &k, T0 L::*p0, T1 L::*p1)
 123         { add(k, new LoadValue2<L, T0, T1>(p0, p1)); }
 124
 125         /** Adds a keyword that is recognized but ignored. */
 126         void add(const std::string &k)
 127         { add(k, 0); }
 128
 129 private:
 130         void add(const std::string &, LoaderAction *);
 131
 132 protected:
 133         void add_auxiliary_loader(Loader &);
 134
 135 private:
 136         bool has_action(const StatementKey &) const;
 137         LoaderAction *find_action(const StatementKey &) const;
 138
 139 protected:
 140         /** Returns the source of the statement being processed.  This can be used
 141         to implement relative paths in include-like statements.  Note that the
 142         source may not necessarily be a file. */
 143         const std::string &get_source() const;
 144
 145         /** Returns the keyword of the statement being processed.  Can be used to
 146         implement dynamic keywords. */
 147         const std::string &get_keyword() const;
 148
 149         virtual void finish() { }
 150 };
 151
 152
 153 #if __cplusplus>=201103L
 154 /**
 155 Loads an object from a file.  The object must have a public Loader class.  Any
 156 extra arguments are passed to the Loader constructor.
 157 */
 158 template<typename T, typename... Args>
 159 void load(T &obj, const std::string &fn, Args &... args)
 160 {
 161         IO::BufferedFile in(fn);
 162
 163         Parser parser(in, fn);
 164         typename T::Loader loader(obj, args...);
 165         loader.load(parser);
 166 }
 167
 168 /**
 169 Loads an object from a file stored in a collection.  The object must havea
 170 public Loader class.  The collection is passed to the Loader constructor,
 171 followed by any extra arguments.
 172 */
 173 template<typename T, typename... Args>
 174 void load(T &obj, typename T::Loader::Collection &coll, const std::string &fn, Args &... args)
 175 {
 176         RefPtr<IO::Seekable> in = coll.open_raw(fn);
 177
 178         Parser parser(*in, fn);
 179         typename T::Loader loader(obj, coll, args...);
 180         loader.load(parser);
 181 }
 182
 183 /**
 184 Loads an object from a file stored in a collection.  The object must havea
 185 public Loader class.  Any extra arguments are passed to the Loader constructor.
 186 */
 187 template<typename T, typename C, typename... Args>
 188 typename EnableIf<NeedsCollection<typename T::Loader>::value, void>::No load(T &obj, C &coll, const std::string &fn, Args &... args)
 189 {
 190         RefPtr<IO::Seekable> in = coll.open_raw(fn);
 191
 192         Parser parser(*in, fn);
 193         typename T::Loader loader(obj, args...);
 194         loader.load(parser);
 195 }
 196
 197 #else
 198
 199 /**
 200 Loads an object from a file.  The object must have a public Loader class.
 201 */
 202 template<typename T>
 203 void load(T &obj, const std::string &fn)
 204 {
 205         IO::BufferedFile in(fn);
 206
 207         Parser parser(in, fn);
 208         typename T::Loader loader(obj);
 209         loader.load(parser);
 210 }
 211
 212 /**
 213 Loads an object from a file, passing one extra argument to the Loader
 214 constructor.  The object must have a public Loader class.
 215 */
 216 template<typename T, typename U>
 217 void load(T &obj, const std::string &fn, U &arg)
 218 {
 219         IO::BufferedFile in(fn);
 220
 221         Parser parser(in, fn);
 222         typename T::Loader loader(obj, arg);
 223         loader.load(parser);
 224 }
 225 #endif
 226
 227 } // namespace DataFile
 228 } // namespace Msp
 229
 230 #endif