]> www.ginac.de Git - ginac.git/blobdiff - ginac/registrar.h
Make sure add::eval() collects all numeric terms.
[ginac.git] / ginac / registrar.h
index 6969f0c23bb66cd5b27ccc7167125000edb0bdc3..8fd22270a15d14a745b1d8dd208b0d0992863dfd 100644 (file)
@@ -3,7 +3,7 @@
  *  GiNaC's class registrar (for class basic and all classes derived from it). */
 
 /*
- *  GiNaC Copyright (C) 1999-2003 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2010 Johannes Gutenberg University Mainz, Germany
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *
  *  You should have received a copy of the GNU General Public License
  *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#ifndef __GINAC_REGISTRAR_H__
-#define __GINAC_REGISTRAR_H__
+#ifndef GINAC_REGISTRAR_H
+#define GINAC_REGISTRAR_H
+
+#include "class_info.h"
+#include "print.h"
 
-#include <string>
 #include <list>
+#include <string>
+#include <typeinfo>
+#include <vector>
 
 namespace GiNaC {
 
-class registered_class_info;
 class ex;
 class archive_node;
 
-template <template <class> class> class container;
+template <template <class T, class = std::allocator<T> > class> class container;
 typedef container<std::list> lst;
 
+/** To distinguish between different kinds of non-commutative objects */
+struct return_type_t
+{
+       /// to distinguish between non-commutative objects of different type.
+       std::type_info const* tinfo; 
+       /// to distinguish between non-commutative objects of the same type.
+       /// Think of gamma matrices with different represenation labels.
+       unsigned rl;
+
+       /// Strict weak ordering (so one can put return_type_t's into
+       /// a STL container).
+       inline bool operator<(const return_type_t& other) const
+       {
+               if (tinfo->before(*other.tinfo))
+                       return true;
+               return rl < other.rl;
+       }
+       inline bool operator==(const return_type_t& other) const
+       {
+               if (*tinfo != *(other.tinfo))
+                       return false;
+               return rl == other.rl;
+       }
+       inline bool operator!=(const return_type_t& other) const
+       {
+               return ! (operator==(other));
+       }
+};
 
-/** Unarchiving function (static member function of every GiNaC class). */
-typedef ex (*unarch_func)(const archive_node &n, lst &sym_lst);
-
+template<typename T> inline return_type_t make_return_type_t(const unsigned rl = 0)
+{
+       return_type_t ret;
+       ret.rl = rl;
+       ret.tinfo = &typeid(T);
+       return ret;
+}
+
+/** This class stores information about a registered GiNaC class. */
+class registered_class_options {
+public:
+       registered_class_options(const char *n, const char *p, 
+                                const std::type_info& ti)
+        : name(n), parent_name(p), tinfo_key(&ti) { }
+
+       const char *get_name() const { return name; }
+       const char *get_parent_name() const { return parent_name; }
+       std::type_info const* get_id() const { return tinfo_key; }
+       const std::vector<print_functor> &get_print_dispatch_table() const { return print_dispatch_table; }
+
+       template <class Ctx, class T, class C>
+       registered_class_options & print_func(void f(const T &, const C & c, unsigned))
+       {
+               set_print_func(Ctx::get_class_info_static().options.get_id(), f);
+               return *this;
+       }
 
-/** Head of list of all registered_class_info structures. */
-extern registered_class_info *first_registered_class;
+       template <class Ctx, class T, class C>
+       registered_class_options & print_func(void (T::*f)(const C &, unsigned))
+       {
+               set_print_func(Ctx::get_class_info_static().options.get_id(), f);
+               return *this;
+       }
 
+       template <class Ctx>
+       registered_class_options & print_func(const print_functor & f)
+       {
+               set_print_func(Ctx::get_class_info_static().options.get_id(), f);
+               return *this;
+       }
 
-/** This structure stores information about a registered GiNaC class. */
-struct registered_class_info {
-       registered_class_info(const char *n, const char *s, unsigned int k, unarch_func f)
-               : name(n), super(s), tinfo_key(k), unarchive(f)
+       void set_print_func(unsigned id, const print_functor & f)
        {
-               // Add structure to list
-               next = first_registered_class;
-               first_registered_class = this;
+               if (id >= print_dispatch_table.size())
+                       print_dispatch_table.resize(id + 1);
+               print_dispatch_table[id] = f;
        }
 
-       registered_class_info *next;  /**< Pointer to next registered_class_info in list. */
-       const char *name;             /**< Class name. */
-       const char *super;            /**< Name of superclass. */
-       unsigned int tinfo_key;       /**< TINFO_* key. */
-       unarch_func unarchive;        /**< Pointer to unarchiving function. */
+private:
+       const char *name;         /**< Class name. */
+       const char *parent_name;  /**< Name of superclass. */
+       std::type_info const* tinfo_key;        /**< Type information key. */
+       std::vector<print_functor> print_dispatch_table; /**< Method table for print() dispatch */
 };
 
+typedef class_info<registered_class_options> registered_class_info;
+
 
 /** Primary macro for inclusion in the declaration of each registered class. */
 #define GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(classname, supername) \
 public: \
        typedef supername inherited; \
-       \
+private: \
        static GiNaC::registered_class_info reg_info; \
-       virtual const char *class_name() const; \
-       \
-       classname(const GiNaC::archive_node &n, GiNaC::lst &sym_lst); \
-       virtual void archive(GiNaC::archive_node &n) const; \
-       static GiNaC::ex unarchive(const GiNaC::archive_node &n, GiNaC::lst &sym_lst); \
-       \
+public: \
+       static GiNaC::registered_class_info &get_class_info_static() { return reg_info; } \
+       virtual const GiNaC::registered_class_info &get_class_info() const { return classname::get_class_info_static(); } \
+       virtual GiNaC::registered_class_info &get_class_info() { return classname::get_class_info_static(); } \
+       virtual const char *class_name() const { return classname::get_class_info_static().options.get_name(); } \
        class visitor { \
        public: \
                virtual void visit(const classname &) = 0; \
+               virtual ~visitor() {}; \
        };
 
 /** Macro for inclusion in the declaration of each registered class.
@@ -87,9 +151,9 @@ public: \
        GINAC_DECLARE_REGISTERED_CLASS_NO_CTORS(classname, supername) \
 public: \
        classname(); \
-       classname * duplicate() const { return new classname(*this); } \
+       virtual classname * duplicate() const { return new classname(*this); } \
        \
-       void accept(GiNaC::visitor & v) const \
+       virtual void accept(GiNaC::visitor & v) const \
        { \
                if (visitor *p = dynamic_cast<visitor *>(&v)) \
                        p->visit(*this); \
@@ -97,24 +161,40 @@ public: \
                        inherited::accept(v); \
        } \
 protected: \
-       int compare_same_type(const GiNaC::basic & other) const; \
+       virtual int compare_same_type(const GiNaC::basic & other) const; \
 private:
 
-/** Macro for inclusion in the implementation of each registered class.
- *  It defines some members that are the same in all classes derived from
- *  'basic'. */
+
+/** Macro for inclusion in the implementation of each registered class. */
 #define GINAC_IMPLEMENT_REGISTERED_CLASS(classname, supername) \
-       GiNaC::registered_class_info classname::reg_info(#classname, #supername, TINFO_##classname, &classname::unarchive); \
-       const char *classname::class_name() const {return reg_info.name;}
+       GiNaC::registered_class_info classname::reg_info = GiNaC::registered_class_info(GiNaC::registered_class_options(#classname, #supername, typeid(classname))); 
+
+/** Macro for inclusion in the implementation of each registered class.
+ *  Additional options can be specified. */
+#define GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(classname, supername, options) \
+       GiNaC::registered_class_info classname::reg_info = GiNaC::registered_class_info(GiNaC::registered_class_options(#classname, #supername, typeid(classname)).options);
+
+/** Macro for inclusion in the implementation of each registered class.
+ *  Additional options can be specified. */
+#define GINAC_IMPLEMENT_REGISTERED_CLASS_OPT_T(classname, supername, options) \
+       GiNaC::registered_class_info classname::reg_info = GiNaC::registered_class_info(GiNaC::registered_class_options(#classname, #supername, typeid(classname)).options);
 
 
-/** Find TINFO_* key by class name. */
-extern unsigned int find_tinfo_key(const std::string &class_name);
+/** Add or replace a print method. */
+template <class Alg, class Ctx, class T, class C>
+extern void set_print_func(void f(const T &, const C & c, unsigned))
+{
+       Alg::get_class_info_static().options.set_print_func(Ctx::get_class_info_static().options.get_id(), f);
+}
 
-/** Find unarchiving function by class name. */
-extern unarch_func find_unarch_func(const std::string &class_name);
+/** Add or replace a print method. */
+template <class Alg, class Ctx, class T, class C>
+extern void set_print_func(void (T::*f)(const C &, unsigned))
+{
+       Alg::get_class_info_static().options.set_print_func(Ctx::get_class_info_static().options.get_id(), f);
+}
 
 
 } // namespace GiNaC
 
-#endif // ndef __GINAC_REGISTRAR_H__
+#endif // ndef GINAC_REGISTRAR_H