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 "parser.h"
   8 #include "statement.h"
   9
  10 namespace Msp {
  11 namespace DataFile {
  12
  13 /**
  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.
  16
  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.
  20
  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.
  26
  27 A sub-object can be loaded with one of the load_sub functions.
  28
  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
  31 destructor.
  32
  33 See also classes ObjectLoader and CollectionObjectLoader in objectloader.h.
  34 */
  35 class Loader
  36 {
  37 private:
  38         typedef std::map<StatementKey, LoaderAction *> ActionMap;
  39
  40         ActionMap actions;
  41         Parser *cur_parser;
  42         unsigned cur_level;
  43         const Statement *cur_st;
  44         bool sub_loaded;
  45         bool direct;
  46         std::list<Loader *> aux_loaders;
  47 protected:
  48         bool check_sub_loads;
  49
  50         Loader();
  51 public:
  52         virtual ~Loader();
  53
  54         /** Loads statements from a parser. */
  55         void load(Parser &p);
  56
  57 private:
  58         /** Loads data from a statement. */
  59         void load(const Statement &st);
  60
  61         /** Loads statemsnts from a parser, feeding them directly to actions. */
  62         void load_direct(Parser &, unsigned);
  63
  64         /** Processes a single statement */
  65         void load_statement(const Statement &st);
  66
  67 protected:
  68         /** Loads a sub-object from the statement being processed.  The Loader class
  69         of the sub-object is automatically used. */
  70         template<typename S>
  71         void load_sub(S &s)
  72         {
  73                 typename S::Loader ldr(s);
  74                 load_sub_with(ldr);
  75         }
  76
  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)
  82         {
  83                 typename S::Loader ldr(s, p);
  84                 load_sub_with(ldr);
  85         }
  86
  87         /** Processes the current statement's substatements with another Loader. */
  88         void load_sub_with(Loader &);
  89
  90         /** Adds a keyword that is loaded by calling a function. */
  91         template<typename L>
  92         void add(const std::string &k, void (L::*func)())
  93         { add(k, new LoaderFunc0<L>(func)); }
  94
  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)); }
  98
  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)); }
 102
 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)); }
 106
 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)); }
 110
 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)); }
 114
 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)); }
 119
 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)); }
 123
 124         /** Adds a keyword that is recognized but ignored. */
 125         void add(const std::string &k)
 126         { add(k, 0); }
 127
 128 private:
 129         void add(const std::string &, LoaderAction *);
 130
 131 protected:
 132         void add_auxiliary_loader(Loader &);
 133
 134 private:
 135         bool has_action(const StatementKey &) const;
 136         LoaderAction *find_action(const StatementKey &) const;
 137
 138 protected:
 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;
 143
 144         /** Returns the keyword of the statement being processed.  Can be used to
 145         implement dynamic keywords. */
 146         const std::string &get_keyword() const;
 147
 148         virtual void finish() { }
 149 };
 150
 151
 152 /**
 153 Loads an object from a file.  The object must have a public Loader class.
 154 */
 155 template<typename T>
 156 void load(T &obj, const std::string &fn)
 157 {
 158         IO::BufferedFile in(fn);
 159
 160         Parser parser(in, fn);
 161         typename T::Loader loader(obj);
 162         loader.load(parser);
 163 }
 164
 165 template<typename T, typename U>
 166 void load(T &obj, const std::string &fn, U &arg)
 167 {
 168         IO::BufferedFile in(fn);
 169
 170         Parser parser(in, fn);
 171         typename T::Loader loader(obj, arg);
 172         loader.load(parser);
 173 }
 174
 175 } // namespace DataFile
 176 } // namespace Msp
 177
 178 #endif