GINAC_DECLARE_REGISTERED_CLASS declares duplicate() and compare_same_type(),
[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-2001 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 #ifndef __GINAC_REGISTRAR_H__
24 #define __GINAC_REGISTRAR_H__
25
26 #include <string>
27
28 #ifndef NO_NAMESPACE_GINAC
29 namespace GiNaC {
30 #endif // ndef NO_NAMESPACE_GINAC
31
32 class registered_class_info;
33 class ex;
34 class archive_node;
35 class lst;
36
37
38 /** Unarchiving function (static member function of every GiNaC class). */
39 typedef ex (*unarch_func)(const archive_node &n, const lst &sym_lst);
40
41
42 /** Head of list of all registered_class_info structures. */
43 extern registered_class_info *first_registered_class;
44
45
46 /** This structure stores information about a registered GiNaC class. */
47 struct registered_class_info {
48         registered_class_info(const char *n, const char *s, unsigned int k, unarch_func f)
49                 : name(n), super(s), tinfo_key(k), unarchive(f)
50         {
51                 // Add structure to list
52                 next = first_registered_class;
53                 first_registered_class = this;
54         }
55
56         registered_class_info *next;  /**< Pointer to next registered_class_info in list. */
57         const char *name;             /**< Class name. */
58         const char *super;            /**< Name of superclass. */
59         unsigned int tinfo_key;       /**< TINFO_* key. */
60         unarch_func unarchive;        /**< Pointer to unarchiving function. */
61 };
62
63
64 #define GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(classname, supername) \
65 public: \
66         typedef supername inherited; \
67         static registered_class_info reg_info; \
68         virtual const char *class_name(void) const; \
69         classname(const archive_node &n, const lst &sym_lst); \
70         virtual void archive(archive_node &n) const; \
71         static ex unarchive(const archive_node &n, const lst &sym_lst);
72
73 /** Macro for inclusion in the declaration of each registered class.
74  *  It declares some functions that are common to all classes derived
75  *  from 'basic' as well as all required stuff for the GiNaC class
76  *  registry (mainly needed for archiving). */
77 #define GINAC_DECLARE_REGISTERED_CLASS(classname, supername) \
78         GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(classname, supername) \
79 public: \
80         classname(); \
81         ~classname(); \
82         classname(const classname & other); \
83         const classname & operator=(const classname & other); \
84         basic * duplicate() const; \
85 protected: \
86         void copy(const classname & other); \
87         void destroy(bool call_parent); \
88         int compare_same_type(const basic & other) const; \
89 private:
90
91 #define GINAC_IMPLEMENT_REGISTERED_CLASS_NO_CTORS(classname, supername) \
92         registered_class_info classname::reg_info(#classname, #supername, TINFO_##classname, &classname::unarchive); \
93         const char *classname::class_name(void) const {return reg_info.name;}
94
95 /** Macro for inclusion in the implementation of each registered class.
96  *  It implements some functions that are the same in all classes derived
97  *  from 'basic' (such as the destructor, the copy constructor and the
98  *  assignment operator). */
99 #define GINAC_IMPLEMENT_REGISTERED_CLASS(classname, supername) \
100         GINAC_IMPLEMENT_REGISTERED_CLASS_NO_CTORS(classname, supername) \
101 classname::~classname() \
102 { \
103         debugmsg(#classname " destructor", LOGLEVEL_DESTRUCT); \
104         destroy(false); \
105 } \
106 classname::classname(const classname & other) \
107 { \
108         debugmsg(#classname " copy constructor", LOGLEVEL_CONSTRUCT); \
109         copy(other); \
110 } \
111 const classname & classname::operator=(const classname & other) \
112 { \
113         debugmsg(#classname " operator=", LOGLEVEL_ASSIGNMENT); \
114         if (this != &other) { \
115                 destroy(true); \
116                 copy(other); \
117         } \
118         return *this; \
119 } \
120 basic * classname::duplicate() const \
121 { \
122         debugmsg(#classname " duplicate", LOGLEVEL_DUPLICATE); \
123         return new classname(*this); \
124 }
125
126
127 /** Find TINFO_* key by class name. */
128 extern unsigned int find_tinfo_key(const std::string &class_name);
129
130 /** Find unarchiving function by class name. */
131 extern unarch_func find_unarch_func(const std::string &class_name);
132
133
134 #ifndef NO_NAMESPACE_GINAC
135 } // namespace GiNaC
136 #endif // ndef NO_NAMESPACE_GINAC
137
138 #endif // ndef __GINAC_REGISTRAR_H__