ginac/registrar.h

   1 /** @file registrar.h
   2  *
   3  *  GiNaC's class registrar (for class basic and all classes derived from it). */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2008 Johannes Gutenberg University Mainz, Germany
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  */
  22
  23 #ifndef __GINAC_REGISTRAR_H__
  24 #define __GINAC_REGISTRAR_H__
  25
  26 #include <string>
  27 #include <list>
  28 #include <vector>
  29 #include <typeinfo>
  30
  31 #include "class_info.h"
  32 #include "print.h"
  33
  34 namespace GiNaC {
  35
  36 class ex;
  37 class archive_node;
  38
  39 template <template <class T, class = std::allocator<T> > class> class container;
  40 typedef container<std::list> lst;
  41
  42 /** To distinguish between different kinds of non-commutative objects */
  43 struct return_type_t
  44 {
  45         /// to distinguish between non-commutative objects of different type.
  46         std::type_info const* tinfo;
  47         /// to distinguish between non-commutative objects of the same type.
  48         /// Think of gamma matrices with different represenation labels.
  49         unsigned rl;
  50
  51         /// Strict weak ordering (so one can put return_type_t's into
  52         /// a STL container).
  53         inline bool operator<(const return_type_t& other) const
  54         {
  55                 if (tinfo->before(*other.tinfo))
  56                         return true;
  57                 return rl < other.rl;
  58         }
  59         inline bool operator==(const return_type_t& other) const
  60         {
  61                 if (*tinfo != *(other.tinfo))
  62                         return false;
  63                 return rl == other.rl;
  64         }
  65         inline bool operator!=(const return_type_t& other) const
  66         {
  67                 return ! (operator==(other));
  68         }
  69 };
  70
  71 template<typename T> inline return_type_t make_return_type_t(const unsigned rl = 0)
  72 {
  73         return_type_t ret;
  74         ret.rl = rl;
  75         ret.tinfo = &typeid(T);
  76         return ret;
  77 }
  78
  79 /** Unarchiving function (static member function of every GiNaC class). */
  80 typedef ex (*unarch_func)(const archive_node &n, lst &sym_lst);
  81
  82
  83 /** This class stores information about a registered GiNaC class. */
  84 class registered_class_options {
  85 public:
  86         registered_class_options(const char *n, const char *p,
  87                                  const std::type_info& ti,
  88                                  unarch_func f)
  89          : name(n), parent_name(p), tinfo_key(&ti), unarchive(f) {}
  90
  91         const char *get_name() const { return name; }
  92         const char *get_parent_name() const { return parent_name; }
  93         std::type_info const* get_id() const { return tinfo_key; }
  94         unarch_func get_unarch_func() const { return unarchive; }
  95         const std::vector<print_functor> &get_print_dispatch_table() const { return print_dispatch_table; }
  96
  97         template <class Ctx, class T, class C>
  98         registered_class_options & print_func(void f(const T &, const C & c, unsigned))
  99         {
 100                 set_print_func(Ctx::get_class_info_static().options.get_id(), f);
 101                 return *this;
 102         }
 103
 104         template <class Ctx, class T, class C>
 105         registered_class_options & print_func(void (T::*f)(const C &, unsigned))
 106         {
 107                 set_print_func(Ctx::get_class_info_static().options.get_id(), f);
 108                 return *this;
 109         }
 110
 111         template <class Ctx>
 112         registered_class_options & print_func(const print_functor & f)
 113         {
 114                 set_print_func(Ctx::get_class_info_static().options.get_id(), f);
 115                 return *this;
 116         }
 117
 118         void set_print_func(unsigned id, const print_functor & f)
 119         {
 120                 if (id >= print_dispatch_table.size())
 121                         print_dispatch_table.resize(id + 1);
 122                 print_dispatch_table[id] = f;
 123         }
 124
 125 private:
 126         const char *name;         /**< Class name. */
 127         const char *parent_name;  /**< Name of superclass. */
 128         std::type_info const* tinfo_key;        /**< Type information key. */
 129         unarch_func unarchive;    /**< Pointer to unarchiving function. */
 130         std::vector<print_functor> print_dispatch_table; /**< Method table for print() dispatch */
 131 };
 132
 133 typedef class_info<registered_class_options> registered_class_info;
 134
 135
 136 /** Primary macro for inclusion in the declaration of each registered class. */
 137 #define GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(classname, supername) \
 138 public: \
 139         typedef supername inherited; \
 140 private: \
 141         static GiNaC::registered_class_info reg_info; \
 142 public: \
 143         static GiNaC::registered_class_info &get_class_info_static() { return reg_info; } \
 144         virtual const GiNaC::registered_class_info &get_class_info() const { return classname::get_class_info_static(); } \
 145         virtual GiNaC::registered_class_info &get_class_info() { return classname::get_class_info_static(); } \
 146         virtual const char *class_name() const { return classname::get_class_info_static().options.get_name(); } \
 147         \
 148         classname(const GiNaC::archive_node &n, GiNaC::lst &sym_lst); \
 149         virtual void archive(GiNaC::archive_node &n) const; \
 150         static GiNaC::ex unarchive(const GiNaC::archive_node &n, GiNaC::lst &sym_lst); \
 151         \
 152         class visitor { \
 153         public: \
 154                 virtual void visit(const classname &) = 0; \
 155                 virtual ~visitor() {}; \
 156         };
 157
 158 /** Macro for inclusion in the declaration of each registered class.
 159  *  It declares some functions that are common to all classes derived
 160  *  from 'basic' as well as all required stuff for the GiNaC class
 161  *  registry (mainly needed for archiving). */
 162 #define GINAC_DECLARE_REGISTERED_CLASS(classname, supername) \
 163         GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(classname, supername) \
 164 public: \
 165         classname(); \
 166         virtual classname * duplicate() const { return new classname(*this); } \
 167         \
 168         virtual void accept(GiNaC::visitor & v) const \
 169         { \
 170                 if (visitor *p = dynamic_cast<visitor *>(&v)) \
 171                         p->visit(*this); \
 172                 else \
 173                         inherited::accept(v); \
 174         } \
 175 protected: \
 176         virtual int compare_same_type(const GiNaC::basic & other) const; \
 177 private:
 178
 179
 180 /** Macro for inclusion in the implementation of each registered class. */
 181 #define GINAC_IMPLEMENT_REGISTERED_CLASS(classname, supername) \
 182         GiNaC::registered_class_info classname::reg_info = GiNaC::registered_class_info(GiNaC::registered_class_options(#classname, #supername, typeid(classname), &classname::unarchive));
 183
 184 /** Macro for inclusion in the implementation of each registered class.
 185  *  Additional options can be specified. */
 186 #define GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(classname, supername, options) \
 187         GiNaC::registered_class_info classname::reg_info = GiNaC::registered_class_info(GiNaC::registered_class_options(#classname, #supername, typeid(classname), &classname::unarchive).options);
 188
 189 /** Macro for inclusion in the implementation of each registered class.
 190  *  Additional options can be specified. */
 191 #define GINAC_IMPLEMENT_REGISTERED_CLASS_OPT_T(classname, supername, options) \
 192         GiNaC::registered_class_info classname::reg_info = GiNaC::registered_class_info(GiNaC::registered_class_options(#classname, #supername, typeid(classname), &classname::unarchive).options);
 193
 194
 195 /** Find type information key by class name. */
 196 extern std::type_info const* find_tinfo_key(const std::string &class_name);
 197
 198 /** Find unarchiving function by class name. */
 199 extern unarch_func find_unarch_func(const std::string &class_name);
 200
 201
 202 /** Add or replace a print method. */
 203 template <class Alg, class Ctx, class T, class C>
 204 extern void set_print_func(void f(const T &, const C & c, unsigned))
 205 {
 206         Alg::get_class_info_static().options.set_print_func(Ctx::get_class_info_static().options.get_id(), f);
 207 }
 208
 209 /** Add or replace a print method. */
 210 template <class Alg, class Ctx, class T, class C>
 211 extern void set_print_func(void (T::*f)(const C &, unsigned))
 212 {
 213         Alg::get_class_info_static().options.set_print_func(Ctx::get_class_info_static().options.get_id(), f);
 214 }
 215
 216
 217 } // namespace GiNaC
 218
 219 #endif // ndef __GINAC_REGISTRAR_H__