]> git.tdb.fi Git - libs/datafile.git/commitdiff
Move LoaderActions to loaderaction.h
authorMikko Rasa <tdb@tdb.fi>
Thu, 11 Sep 2008 19:04:35 +0000 (19:04 +0000)
committerMikko Rasa <tdb@tdb.fi>
Thu, 11 Sep 2008 19:04:35 +0000 (19:04 +0000)
Add basic loader classes to derive from
Update Loader documentation

source/loader.h
source/loaderaction.h [new file with mode: 0644]

index 2a2d1416ece760be799037c022662c57244b9cc9..9314ab3a8108e110e0dc3be39daf03511a4d8982 100644 (file)
@@ -12,226 +12,34 @@ Distributed under the LGPL
 #include <msp/io/buffered.h>
 #include <msp/io/file.h>
 #include "except.h"
+#include "loaderaction.h"
 #include "parser.h"
 #include "statement.h"
-#include "value.h"
 
 namespace Msp {
 namespace DataFile {
 
-class Loader;
-class Statement;
-
-/**
-Base class for loader actions.
-*/
-class LoaderAction
-{
-public:
-       /**
-       Called when a statement is to be loaded.
-       */
-       virtual void execute(Loader &, const Statement &) const=0;
-       virtual ~LoaderAction() { }
-protected:
-       LoaderAction() { }
-};
-
-
-/**
-Loads a statement by calling a function that takes no arguments.
-*/
-template<typename L>
-class LoaderFunc0: public LoaderAction
-{
-public:
-       typedef void (L::*FuncType)();
-
-       LoaderFunc0(FuncType f): func(f) { }
-       void execute(Loader &l, const Statement &st) const
-       {
-               if(st.args.size()!=0) throw TypeError("Wrong number of arguments");
-               (dynamic_cast<L &>(l).*func)();
-       };
-private:
-       FuncType func;
-};
-
-
-/**
-Loads a statement by calling a function that takes one argument.
-*/
-template<typename L, typename A0>
-class LoaderFunc1: public LoaderAction
-{
-public:
-       typedef void (L::*FuncType)(A0);
-
-       LoaderFunc1(FuncType f): func(f) { }
-       void execute(Loader &l, const Statement &st) const
-       {
-               if(st.args.size()!=1) throw TypeError("Wrong number of arguments");
-               (dynamic_cast<L &>(l).*func)(st.args[0].get<A0>());
-       }
-private:
-       FuncType func;
-};
-
-
 /**
-Loads a statement by calling a function that takes an array of values.
-*/
-template<typename L, typename A0>
-class LoaderFunc1<L, const std::vector<A0> &>: public LoaderAction
-{
-public:
-       typedef void (L::*FuncType)(const std::vector<A0> &);
-
-       LoaderFunc1(FuncType f): func(f) { }
-       void execute(Loader &l, const Statement &st) const
-       {
-               std::vector<A0> values;
-               values.reserve(st.args.size());
-               for(ValueArray::const_iterator i=st.args.begin(); i!=st.args.end(); ++i)
-                       values.push_back(i->get<A0>());
-               (dynamic_cast<L &>(l).*func)(values);
-       }
-private:
-       FuncType func;
-};
-
-
-template<typename L, typename A0, typename A1>
-class LoaderFunc2: public LoaderAction
-{
-public:
-       typedef void (L::*FuncType)(A0, A1);
-
-       LoaderFunc2(FuncType f): func(f) { }
-       void execute(Loader &l, const Statement &st) const
-       {
-               if(st.args.size()!=2) throw TypeError("Wrong number of arguments");
-               (dynamic_cast<L &>(l).*func)(st.args[0].get<A0>(), st.args[1].get<A1>());
-       }
-private:
-       FuncType func;
-};
-
-
-template<typename L, typename A0, typename A1, typename A2>
-class LoaderFunc3: public LoaderAction
-{
-public:
-       typedef void (L::*FuncType)(A0, A1, A2);
-
-       LoaderFunc3(FuncType f): func(f) { }
-       void execute(Loader &l, const Statement &st) const
-       {
-               if(st.args.size()!=3) throw TypeError("Wrong number of arguments");
-               (dynamic_cast<L &>(l).*func)(st.args[0].get<A0>(), st.args[1].get<A1>(), st.args[2].get<A2>());
-       }
-private:
-       FuncType func;
-};
-
-
-template<typename L, typename A0, typename A1, typename A2, typename A3>
-class LoaderFunc4: public LoaderAction
-{
-public:
-       typedef void (L::*FuncType)(A0, A1, A2, A3);
+Base class for data loaders.  This class only provides core functionality.
+You'll almost certainly want to use one of the BasicLoader classes instead.
 
-       LoaderFunc4(FuncType f): func(f) { }
-       void execute(Loader &l, const Statement &st) const
-       {
-               if(st.args.size()!=4) throw TypeError("Wrong number of arguments");
-               (dynamic_cast<L &>(l).*func)(st.args[0].get<A0>(), st.args[1].get<A1>(), st.args[2].get<A2>(), st.args[3].get<A3>());
-       }
-private:
-       FuncType func;
-};
-
-
-template<typename L, typename A0, typename A1, typename A2, typename A3, typename A4>
-class LoaderFunc5: public LoaderAction
-{
-public:
-       typedef void (L::*FuncType)(A0, A1, A2, A3, A4);
-
-       LoaderFunc5(FuncType f): func(f) { }
-       void execute(Loader &l, const Statement &st) const
-       {
-               if(st.args.size()!=5) throw TypeError("Wrong number of arguments");
-               (dynamic_cast<L &>(l).*func)(st.args[0].get<A0>(), st.args[1].get<A1>(), st.args[2].get<A2>(), st.args[3].get<A3>(), st.args[4].get<A4>());
-       }
-private:
-       FuncType func;
-};
-
-
-template<typename L, typename T0>
-class LoadValue1: public LoaderAction
-{
-public:
-       typedef T0 L::*Pointer0Type;
-
-       LoadValue1(Pointer0Type p0): ptr0(p0) { }
-       void execute(Loader &l, const Statement &st) const
-       {
-               if(st.args.size()!=1) throw TypeError("Wrong number of arguments");
-               dynamic_cast<typename L::Loader &>(l).get_object().*ptr0=st.args[0].get<T0>();
-       }
-private:
-       Pointer0Type ptr0;
-};
-
-
-template<typename L, typename T0>
-class LoadValue1<L, T0 *>: public LoaderAction
-{
-public:
-       typedef T0 *L::*Pointer0Type;
-
-       LoadValue1(Pointer0Type p0): ptr0(p0) { }
-       void execute(Loader &l, const Statement &st) const
-       {
-               if(st.args.size()!=1) throw TypeError("Wrong number of arguments");
-               typename L::Loader &ldr=dynamic_cast<typename L::Loader &>(l);
-               ldr.get_object().*ptr0=ldr.get_collection().template get<T0>(st.args[0].get<std::string>());
-       }
-private:
-       Pointer0Type ptr0;
-};
+Under normal circumstances, a class capable of being loaded should have a
+nested typed called Loader which resolves to a descendant of this class.  If
+another structure is used, the loader object must be constructed manually.
 
+A loader class should execute one or more calls to the various add() functions
+to register actions with expected keywords.  Currently possible actions are
+calling a function of the loader, storing values in member variables of an
+object and ignoring the statement.  If a unexpected keyword is encountered, an
+exception is thrown and the loading is aborted.
 
-template<typename L, typename T0, typename T1>
-class LoadValue2: public LoaderAction
-{
-public:
-       typedef T0 L::*Pointer0Type;
-       typedef T1 L::*Pointer1Type;
-
-       LoadValue2(Pointer0Type p0, Pointer1Type p1): ptr0(p0), ptr1(p1) { }
-       void execute(Loader &l, const Statement &st) const
-       {
-               if(st.args.size()!=2) throw TypeError("Wrong number of arguments");
-               dynamic_cast<typename L::Loader &>(l).get_object().*ptr0=st.args[0].get<T0>();
-               dynamic_cast<typename L::Loader &>(l).get_object().*ptr1=st.args[1].get<T1>();
-       }
-private:
-       Pointer0Type ptr0;
-       Pointer1Type ptr1;
-};
+A sub-object can be loaded with one of the load_sub functions.
 
+When loading has finished successfully, the virtual function finish() is
+called.  Any post-processing of the data should be placed here and not in the
+destructor.
 
-/**
-Base class for data loaders.  To give loading capabilities to a class, create a
-public Loader class in it, derived from this class.  Typically a loader object
-contains a reference to the loaded object.  To make use of loading directly
-into data members, the Loader class must have a get_object() member function,
-returning that reference.  If direct loading of pointers is desired, the Loader
-class must also have a get_collection() member function, returning a collection
-to get pointers from.
+See also classes BasicLoader and BasicLoader2.
 */
 class Loader
 {
@@ -346,6 +154,45 @@ private:
        void load_statement(const Statement &st);
 };
 
+
+/**
+Provides the basic functionality of an object loader.  Deriving from this
+allows loading values directly into member variables of the objects.
+*/
+template<typename O>
+class BasicLoader: public Loader
+{
+public:
+       typedef O Object;
+
+protected:
+       O &obj;
+
+public:
+       BasicLoader(O &o): obj(o) { }
+       O &get_object() const { return obj; }
+};
+
+
+/**
+Provides functionality for loading objects with a Collection.  Deriving from
+this allows loading pointers to objects in the collection automatically.
+*/
+template<typename O, typename C>
+class BasicLoader2: public BasicLoader<O>
+{
+public:
+       typedef C Collection;
+
+protected:
+       C &coll;
+
+public:
+       BasicLoader2(O &o, C &c): BasicLoader<O>(o), coll(c) { }
+       C &get_collection() const { return coll; }
+};
+
+
 /**
 Loads an object from a file.  The object must have a public Loader class.
 */
diff --git a/source/loaderaction.h b/source/loaderaction.h
new file mode 100644 (file)
index 0000000..2a2a8fc
--- /dev/null
@@ -0,0 +1,223 @@
+/* $Id$
+
+This file is part of libmspdatafile
+Copyright © 2006-2008  Mikko Rasa, Mikkosoft Productions
+Distributed under the LGPL
+*/
+
+#ifndef MSP_DATAFILE_LOADERACTION_H_
+#define MSP_DATAFILE_LOADERACTION_H_
+
+#include "except.h"
+#include "statement.h"
+
+namespace Msp {
+namespace DataFile {
+
+class Loader;
+
+/**
+Base class for loader actions.
+*/
+class LoaderAction
+{
+public:
+       /**
+       Called when a statement is to be loaded.
+       */
+       virtual void execute(Loader &, const Statement &) const=0;
+       virtual ~LoaderAction() { }
+protected:
+       LoaderAction() { }
+};
+
+
+/**
+Loads a statement by calling a function that takes no arguments.
+*/
+template<typename L>
+class LoaderFunc0: public LoaderAction
+{
+public:
+       typedef void (L::*FuncType)();
+
+       LoaderFunc0(FuncType f): func(f) { }
+       void execute(Loader &l, const Statement &st) const
+       {
+               if(st.args.size()!=0) throw TypeError("Wrong number of arguments");
+               (dynamic_cast<L &>(l).*func)();
+       };
+private:
+       FuncType func;
+};
+
+
+/**
+Loads a statement by calling a function that takes one argument.
+*/
+template<typename L, typename A0>
+class LoaderFunc1: public LoaderAction
+{
+public:
+       typedef void (L::*FuncType)(A0);
+
+       LoaderFunc1(FuncType f): func(f) { }
+       void execute(Loader &l, const Statement &st) const
+       {
+               if(st.args.size()!=1) throw TypeError("Wrong number of arguments");
+               (dynamic_cast<L &>(l).*func)(st.args[0].get<A0>());
+       }
+private:
+       FuncType func;
+};
+
+
+/**
+Loads a statement by calling a function that takes an array of values.
+*/
+template<typename L, typename A0>
+class LoaderFunc1<L, const std::vector<A0> &>: public LoaderAction
+{
+public:
+       typedef void (L::*FuncType)(const std::vector<A0> &);
+
+       LoaderFunc1(FuncType f): func(f) { }
+       void execute(Loader &l, const Statement &st) const
+       {
+               std::vector<A0> values;
+               values.reserve(st.args.size());
+               for(ValueArray::const_iterator i=st.args.begin(); i!=st.args.end(); ++i)
+                       values.push_back(i->get<A0>());
+               (dynamic_cast<L &>(l).*func)(values);
+       }
+private:
+       FuncType func;
+};
+
+
+template<typename L, typename A0, typename A1>
+class LoaderFunc2: public LoaderAction
+{
+public:
+       typedef void (L::*FuncType)(A0, A1);
+
+       LoaderFunc2(FuncType f): func(f) { }
+       void execute(Loader &l, const Statement &st) const
+       {
+               if(st.args.size()!=2) throw TypeError("Wrong number of arguments");
+               (dynamic_cast<L &>(l).*func)(st.args[0].get<A0>(), st.args[1].get<A1>());
+       }
+private:
+       FuncType func;
+};
+
+
+template<typename L, typename A0, typename A1, typename A2>
+class LoaderFunc3: public LoaderAction
+{
+public:
+       typedef void (L::*FuncType)(A0, A1, A2);
+
+       LoaderFunc3(FuncType f): func(f) { }
+       void execute(Loader &l, const Statement &st) const
+       {
+               if(st.args.size()!=3) throw TypeError("Wrong number of arguments");
+               (dynamic_cast<L &>(l).*func)(st.args[0].get<A0>(), st.args[1].get<A1>(), st.args[2].get<A2>());
+       }
+private:
+       FuncType func;
+};
+
+
+template<typename L, typename A0, typename A1, typename A2, typename A3>
+class LoaderFunc4: public LoaderAction
+{
+public:
+       typedef void (L::*FuncType)(A0, A1, A2, A3);
+
+       LoaderFunc4(FuncType f): func(f) { }
+       void execute(Loader &l, const Statement &st) const
+       {
+               if(st.args.size()!=4) throw TypeError("Wrong number of arguments");
+               (dynamic_cast<L &>(l).*func)(st.args[0].get<A0>(), st.args[1].get<A1>(), st.args[2].get<A2>(), st.args[3].get<A3>());
+       }
+private:
+       FuncType func;
+};
+
+
+template<typename L, typename A0, typename A1, typename A2, typename A3, typename A4>
+class LoaderFunc5: public LoaderAction
+{
+public:
+       typedef void (L::*FuncType)(A0, A1, A2, A3, A4);
+
+       LoaderFunc5(FuncType f): func(f) { }
+       void execute(Loader &l, const Statement &st) const
+       {
+               if(st.args.size()!=5) throw TypeError("Wrong number of arguments");
+               (dynamic_cast<L &>(l).*func)(st.args[0].get<A0>(), st.args[1].get<A1>(), st.args[2].get<A2>(), st.args[3].get<A3>(), st.args[4].get<A4>());
+       }
+private:
+       FuncType func;
+};
+
+
+template<typename L, typename T0>
+class LoadValue1: public LoaderAction
+{
+public:
+       typedef T0 L::*Pointer0Type;
+
+       LoadValue1(Pointer0Type p0): ptr0(p0) { }
+       void execute(Loader &l, const Statement &st) const
+       {
+               if(st.args.size()!=1) throw TypeError("Wrong number of arguments");
+               dynamic_cast<typename L::Loader &>(l).get_object().*ptr0=st.args[0].get<T0>();
+       }
+private:
+       Pointer0Type ptr0;
+};
+
+
+template<typename L, typename T0>
+class LoadValue1<L, T0 *>: public LoaderAction
+{
+public:
+       typedef T0 *L::*Pointer0Type;
+
+       LoadValue1(Pointer0Type p0): ptr0(p0) { }
+       void execute(Loader &l, const Statement &st) const
+       {
+               if(st.args.size()!=1) throw TypeError("Wrong number of arguments");
+               typename L::Loader &ldr=dynamic_cast<typename L::Loader &>(l);
+               ldr.get_object().*ptr0=ldr.get_collection().template get<T0>(st.args[0].get<std::string>());
+       }
+private:
+       Pointer0Type ptr0;
+};
+
+
+template<typename L, typename T0, typename T1>
+class LoadValue2: public LoaderAction
+{
+public:
+       typedef T0 L::*Pointer0Type;
+       typedef T1 L::*Pointer1Type;
+
+       LoadValue2(Pointer0Type p0, Pointer1Type p1): ptr0(p0), ptr1(p1) { }
+       void execute(Loader &l, const Statement &st) const
+       {
+               if(st.args.size()!=2) throw TypeError("Wrong number of arguments");
+               dynamic_cast<typename L::Loader &>(l).get_object().*ptr0=st.args[0].get<T0>();
+               dynamic_cast<typename L::Loader &>(l).get_object().*ptr1=st.args[1].get<T1>();
+       }
+private:
+       Pointer0Type ptr0;
+       Pointer1Type ptr1;
+};
+
+} // namespace DataFile
+} // namespace Msp
+
+#endif