Update copyright statements.
[ginac.git] / 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-2014 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 "class_info.h"
27 #include "print.h"
28
29 #include <list>
30 #include <string>
31 #include <typeinfo>
32 #include <vector>
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 /** This class stores information about a registered GiNaC class. */
80 class registered_class_options {
81 public:
82         registered_class_options(const char *n, const char *p, 
83                                  const std::type_info& ti)
84          : name(n), parent_name(p), tinfo_key(&ti) { }
85
86         const char *get_name() const { return name; }
87         const char *get_parent_name() const { return parent_name; }
88         std::type_info const* get_id() const { return tinfo_key; }
89         const std::vector<print_functor> &get_print_dispatch_table() const { return print_dispatch_table; }
90
91         template <class Ctx, class T, class C>
92         registered_class_options & print_func(void f(const T &, const C & c, unsigned))
93         {
94                 set_print_func(Ctx::get_class_info_static().options.get_id(), f);
95                 return *this;
96         }
97
98         template <class Ctx, class T, class C>
99         registered_class_options & print_func(void (T::*f)(const C &, unsigned))
100         {
101                 set_print_func(Ctx::get_class_info_static().options.get_id(), f);
102                 return *this;
103         }
104
105         template <class Ctx>
106         registered_class_options & print_func(const print_functor & f)
107         {
108                 set_print_func(Ctx::get_class_info_static().options.get_id(), f);
109                 return *this;
110         }
111
112         void set_print_func(unsigned id, const print_functor & f)
113         {
114                 if (id >= print_dispatch_table.size())
115                         print_dispatch_table.resize(id + 1);
116                 print_dispatch_table[id] = f;
117         }
118
119 private:
120         const char *name;         /**< Class name. */
121         const char *parent_name;  /**< Name of superclass. */
122         std::type_info const* tinfo_key;        /**< Type information key. */
123         std::vector<print_functor> print_dispatch_table; /**< Method table for print() dispatch */
124 };
125
126 typedef class_info<registered_class_options> registered_class_info;
127
128
129 /** Primary macro for inclusion in the declaration of each registered class. */
130 #define GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(classname, supername) \
131 public: \
132         typedef supername inherited; \
133 private: \
134         static GiNaC::registered_class_info reg_info; \
135 public: \
136         static GiNaC::registered_class_info &get_class_info_static() { return reg_info; } \
137         virtual const GiNaC::registered_class_info &get_class_info() const { return classname::get_class_info_static(); } \
138         virtual GiNaC::registered_class_info &get_class_info() { return classname::get_class_info_static(); } \
139         virtual const char *class_name() const { return classname::get_class_info_static().options.get_name(); } \
140         class visitor { \
141         public: \
142                 virtual void visit(const classname &) = 0; \
143                 virtual ~visitor() {}; \
144         };
145
146 /** Macro for inclusion in the declaration of each registered class.
147  *  It declares some functions that are common to all classes derived
148  *  from 'basic' as well as all required stuff for the GiNaC class
149  *  registry (mainly needed for archiving). */
150 #define GINAC_DECLARE_REGISTERED_CLASS(classname, supername) \
151         GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(classname, supername) \
152 public: \
153         classname(); \
154         virtual classname * duplicate() const { return new classname(*this); } \
155         \
156         virtual void accept(GiNaC::visitor & v) const \
157         { \
158                 if (visitor *p = dynamic_cast<visitor *>(&v)) \
159                         p->visit(*this); \
160                 else \
161                         inherited::accept(v); \
162         } \
163 protected: \
164         virtual int compare_same_type(const GiNaC::basic & other) const; \
165 private:
166
167
168 /** Macro for inclusion in the implementation of each registered class. */
169 #define GINAC_IMPLEMENT_REGISTERED_CLASS(classname, supername) \
170         GiNaC::registered_class_info classname::reg_info = GiNaC::registered_class_info(GiNaC::registered_class_options(#classname, #supername, typeid(classname))); 
171
172 /** Macro for inclusion in the implementation of each registered class.
173  *  Additional options can be specified. */
174 #define GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(classname, supername, options) \
175         GiNaC::registered_class_info classname::reg_info = GiNaC::registered_class_info(GiNaC::registered_class_options(#classname, #supername, typeid(classname)).options);
176
177 /** Macro for inclusion in the implementation of each registered class.
178  *  Additional options can be specified. */
179 #define GINAC_IMPLEMENT_REGISTERED_CLASS_OPT_T(classname, supername, options) \
180         GiNaC::registered_class_info classname::reg_info = GiNaC::registered_class_info(GiNaC::registered_class_options(#classname, #supername, typeid(classname)).options);
181
182
183 /** Add or replace a print method. */
184 template <class Alg, class Ctx, class T, class C>
185 extern void set_print_func(void f(const T &, const C & c, unsigned))
186 {
187         Alg::get_class_info_static().options.set_print_func(Ctx::get_class_info_static().options.get_id(), f);
188 }
189
190 /** Add or replace a print method. */
191 template <class Alg, class Ctx, class T, class C>
192 extern void set_print_func(void (T::*f)(const C &, unsigned))
193 {
194         Alg::get_class_info_static().options.set_print_func(Ctx::get_class_info_static().options.get_id(), f);
195 }
196
197
198 } // namespace GiNaC
199
200 #endif // ndef GINAC_REGISTRAR_H