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::vector<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 #if __cplusplus>=201103L
 101         template<typename L, typename... Args>
 102         void add(const std::string &k, void (L::*func)(Args...))
 103         { add(k, new LoaderFuncN<L, Args...>(func)); }
 104
 105 #else
 106         template<typename L, typename A0, typename A1>
 107         void add(const std::string &k, void (L::*func)(A0, A1))
 108         { add(k, new LoaderFunc2<L, A0, A1>(func)); }
 109
 110         template<typename L, typename A0, typename A1, typename A2>
 111         void add(const std::string &k, void (L::*func)(A0, A1, A2))
 112         { add(k, new LoaderFunc3<L, A0, A1, A2>(func)); }
 113
 114         template<typename L, typename A0, typename A1, typename A2, typename A3>
 115         void add(const std::string &k, void (L::*func)(A0, A1, A2, A3))
 116         { add(k, new LoaderFunc4<L, A0, A1, A2, A3>(func)); }
 117
 118         template<typename L, typename A0, typename A1, typename A2, typename A3, typename A4>
 119         void add(const std::string &k, void (L::*func)(A0, A1, A2, A3, A4))
 120         { add(k, new LoaderFunc5<L, A0, A1, A2, A3, A4>(func)); }
 121 #endif
 122
 123         /** Adds a keyword that is loaded into a member of the loaded object. */
 124         template<typename L, typename T0>
 125         void add(const std::string &k, T0 L::*p0)
 126         { add(k, new LoadValue1<L, T0>(p0)); }
 127
 128         template<typename L, typename T0, typename T1>
 129         void add(const std::string &k, T0 L::*p0, T1 L::*p1)
 130         { add(k, new LoadValue2<L, T0, T1>(p0, p1)); }
 131
 132         /** Adds a keyword that is recognized but ignored. */
 133         void add(const std::string &k)
 134         { add(k, 0); }
 135
 136 private:
 137         void add(const std::string &, LoaderAction *);
 138
 139 protected:
 140         void add_auxiliary_loader(Loader &);
 141
 142 private:
 143         bool has_action(const StatementKey &) const;
 144         LoaderAction *find_action(const StatementKey &) const;
 145
 146 protected:
 147         /** Returns the source of the statement being processed.  This can be used
 148         to implement relative paths in include-like statements.  Note that the
 149         source may not necessarily be a file. */
 150         const std::string &get_source() const;
 151
 152         /** Returns the keyword of the statement being processed.  Can be used to
 153         implement dynamic keywords. */
 154         const std::string &get_keyword() const;
 155
 156         virtual void finish() { }
 157 };
 158
 159
 160 #if __cplusplus>=201103L
 161 /**
 162 Loads an object from a file.  The object must have a public Loader class.  Any
 163 extra arguments are passed to the Loader constructor.
 164 */
 165 template<typename T, typename... Args>
 166 void load(T &obj, const std::string &fn, Args &... args)
 167 {
 168         IO::BufferedFile in(fn);
 169
 170         Parser parser(in, fn);
 171         typename T::Loader loader(obj, args...);
 172         loader.load(parser);
 173 }
 174
 175 /**
 176 Loads an object from a file stored in a collection.  The object must havea
 177 public Loader class.  The collection is passed to the Loader constructor,
 178 followed by any extra arguments.
 179 */
 180 template<typename T, typename... Args>
 181 void load(T &obj, typename T::Loader::Collection &coll, const std::string &fn, Args &... args)
 182 {
 183         RefPtr<IO::Seekable> in = coll.open_raw(fn);
 184         if(!in)
 185                 throw IO::file_not_found(fn);
 186
 187         Parser parser(*in, fn);
 188         typename T::Loader loader(obj, coll, args...);
 189         loader.load(parser);
 190 }
 191
 192 /**
 193 Loads an object from a file stored in a collection.  The object must havea
 194 public Loader class.  Any extra arguments are passed to the Loader constructor.
 195 */
 196 template<typename T, typename C, typename... Args>
 197 typename EnableIf<NeedsCollection<typename T::Loader>::value, void>::No load(T &obj, C &coll, const std::string &fn, Args &... args)
 198 {
 199         RefPtr<IO::Seekable> in = coll.open_raw(fn);
 200         if(!in)
 201                 throw IO::file_not_found(fn);
 202
 203         Parser parser(*in, fn);
 204         typename T::Loader loader(obj, args...);
 205         loader.load(parser);
 206 }
 207
 208 #else
 209
 210 /**
 211 Loads an object from a file.  The object must have a public Loader class.
 212 */
 213 template<typename T>
 214 void load(T &obj, const std::string &fn)
 215 {
 216         IO::BufferedFile in(fn);
 217
 218         Parser parser(in, fn);
 219         typename T::Loader loader(obj);
 220         loader.load(parser);
 221 }
 222
 223 /**
 224 Loads an object from a file, passing one extra argument to the Loader
 225 constructor.  The object must have a public Loader class.
 226 */
 227 template<typename T, typename U>
 228 void load(T &obj, const std::string &fn, U &arg)
 229 {
 230         IO::BufferedFile in(fn);
 231
 232         Parser parser(in, fn);
 233         typename T::Loader loader(obj, arg);
 234         loader.load(parser);
 235 }
 236 #endif
 237
 238 } // namespace DataFile
 239 } // namespace Msp
 240
 241 #endif