X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Farchive.h;h=f78e593a97d5c4667d9551117e8fd25bdb8319e6;hp=396820b392a7fc58f4ee4b77432b059c14cab0ad;hb=866b3eb23253a272788d8791b1ed023e63674d50;hpb=5378fa494d21758a9c750efa2a90b49f34692e4b diff --git a/ginac/archive.h b/ginac/archive.h index 396820b3..f78e593a 100644 --- a/ginac/archive.h +++ b/ginac/archive.h @@ -3,7 +3,7 @@ * Archiving of GiNaC expressions. */ /* - * GiNaC Copyright (C) 1999-2000 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 @@ -17,33 +17,29 @@ * * 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_ARCHIVE_H__ -#define __GINAC_ARCHIVE_H__ +#ifndef GINAC_ARCHIVE_H +#define GINAC_ARCHIVE_H #include "ex.h" +#include +#include #include #include -class ostream; -class istream; - -#ifndef NO_NAMESPACE_GINAC namespace GiNaC { -#endif // ndef NO_NAMESPACE_GINAC -class lst; class archive; /** Numerical ID value to refer to an archive_node. */ -typedef unsigned int archive_node_id; +typedef unsigned archive_node_id; /** Numerical ID value to refer to a string. */ -typedef unsigned int archive_atom; +typedef unsigned archive_atom; /** This class stores all properties needed to record/retrieve the state @@ -51,65 +47,109 @@ typedef unsigned int archive_atom; * addressed by its name and data type. */ class archive_node { - friend ostream &operator<<(ostream &os, const archive_node &ar); - friend istream &operator>>(istream &is, archive_node &ar); + friend std::ostream &operator<<(std::ostream &os, const archive_node &ar); + friend std::istream &operator>>(std::istream &is, archive_node &ar); public: + /** Property data types */ + enum property_type { + PTYPE_BOOL, + PTYPE_UNSIGNED, + PTYPE_STRING, + PTYPE_NODE + }; + + /** Information about a stored property. A vector of these structures + * is returned by get_properties(). + * @see get_properties */ + struct property_info { + property_info() {} + property_info(property_type t, const std::string &n, unsigned c = 1) : type(t), name(n), count(c) {} + + property_type type; /**< Data type of property. */ + std::string name; /**< Name of property. */ + unsigned count; /**< Number of occurrences. */ + }; + typedef std::vector propinfovector; + + /** Archived property (data type, name and associated data) */ + struct property { + property() {} + property(archive_atom n, property_type t, unsigned v) : type(t), name(n), value(v) {} + + property_type type; /**< Data type of property. */ + archive_atom name; /**< Name of property. */ + unsigned value; /**< Stored value. */ + }; + typedef std::vector::const_iterator archive_node_cit; + archive_node() : a(*dummy_ar_creator()), has_expression(false) {} // hack for cint which always requires a default constructor archive_node(archive &ar) : a(ar), has_expression(false) {} archive_node(archive &ar, const ex &expr); - ~archive_node() {} - archive_node(const archive_node &other); const archive_node &operator=(const archive_node &other); - bool has_same_ex_as(const archive_node &other) const; + /** Add property of type "bool" to node. */ + void add_bool(const std::string &name, bool value); - void add_bool(const string &name, bool value); - void add_unsigned(const string &name, unsigned int value); - void add_string(const string &name, const string &value); - void add_ex(const string &name, const ex &value); + /** Add property of type "unsigned int" to node. */ + void add_unsigned(const std::string &name, unsigned value); - bool find_bool(const string &name, bool &ret) const; - bool find_unsigned(const string &name, unsigned int &ret) const; - bool find_string(const string &name, string &ret) const; - bool find_ex(const string &name, ex &ret, const lst &sym_lst, unsigned int index = 0) const; + /** Add property of type "string" to node. */ + void add_string(const std::string &name, const std::string &value); - ex unarchive(const lst &sym_lst) const; + /** Add property of type "ex" to node. */ + void add_ex(const std::string &name, const ex &value); - void forget(void); - void printraw(ostream &os) const; + /** Retrieve property of type "bool" from node. + * @return "true" if property was found, "false" otherwise */ + bool find_bool(const std::string &name, bool &ret, unsigned index = 0) const; -private: - static archive* dummy_ar_creator(void); + /** Retrieve property of type "unsigned" from node. + * @return "true" if property was found, "false" otherwise */ + bool find_unsigned(const std::string &name, unsigned &ret, unsigned index = 0) const; - /** Property data types */ - enum property_type { - PTYPE_BOOL, - PTYPE_UNSIGNED, - PTYPE_STRING, - PTYPE_NODE - }; + /** Retrieve property of type "string" from node. + * @return "true" if property was found, "false" otherwise */ + bool find_string(const std::string &name, std::string &ret, unsigned index = 0) const; - /** Archived property (data type, name and associated data) */ - struct property { - property() {} - property(archive_atom n, property_type t, unsigned int v) : type(t), name(n), value(v) {} - ~property() {} + /** Find the location in the vector of properties of the first/last + * property with a given name. */ + archive_node_cit find_first(const std::string &name) const; + archive_node_cit find_last(const std::string &name) const; - property(const property &other) : type(other.type), name(other.name), value(other.value) {} - const property &operator=(const property &other); + /** Retrieve property of type "ex" from node. + * @return "true" if property was found, "false" otherwise */ + bool find_ex(const std::string &name, ex &ret, lst &sym_lst, unsigned index = 0) const; - property_type type; /**< Data type of property. */ - archive_atom name; /**< Name of property. */ - unsigned int value; /**< Stored value. */ - }; + /** Retrieve property of type "ex" from the node if it is known + * that this node in fact contains such a property at the given + * location. This is much more efficient than the preceding function. */ + void find_ex_by_loc(archive_node_cit loc, ex &ret, lst &sym_lst) const; + + /** Retrieve property of type "ex" from node, returning the node of + * the sub-expression. */ + const archive_node &find_ex_node(const std::string &name, unsigned index = 0) const; + + /** Return vector of properties stored in node. */ + void get_properties(propinfovector &v) const; + + ex unarchive(lst &sym_lst) const; + bool has_same_ex_as(const archive_node &other) const; + bool has_ex() const {return has_expression;} + ex get_ex() const {return e;} + + void forget(); + void printraw(std::ostream &os) const; + +private: + static archive* dummy_ar_creator(); /** Reference to the archive to which this node belongs. */ archive &a; /** Vector of stored properties. */ - vector props; + std::vector props; /** Flag indicating whether a cached unarchived representation of this node exists. */ mutable bool has_expression; @@ -118,6 +158,86 @@ private: mutable ex e; }; +typedef basic* (*synthesize_func)(); +typedef std::map unarchive_map_t; + +class unarchive_table_t +{ + static int usecount; + static unarchive_map_t* unarch_map; +public: + unarchive_table_t(); + ~unarchive_table_t(); + synthesize_func find(const std::string& classname) const; + void insert(const std::string& classname, synthesize_func f); +}; +static unarchive_table_t unarch_table_instance; + +/** Helper macros to register a class with (un)archiving (a.k.a. + * (de)serialization). + * + * Usage: put + * + * GINAC_DECLARE_UNARCHIVER(myclass); + * + * into the header file (in the global or namespace scope), and + * + * GINAC_BIND_UNARCHIVER(myclass); + * + * into the source file. + * + * Effect: the `myclass' (being a class derived directly or indirectly + * from GiNaC::basic) can be archived and unarchived. + * + * Note: you need to use GINAC_{DECLARE,BIND}_UNARCHIVER incantations + * in order to make your class (un)archivable _even if your class does + * not overload `read_archive' method_. Sorry for inconvenience. + * + * How it works: + * + * The `basic' class has a `read_archive' virtual method which reads an + * expression from archive. Derived classes can overload that method. + * There's a small problem, though. On unarchiving all we have is a set + * of named byte streams. In C++ the class name (as written in the source + * code) has nothing to do with its actual type. Thus, we need establish + * a correspondence ourselves. To do so we maintain a `class_name' => + * `function_pointer' table (see the unarchive_table_t class above). + * Every function in this table is supposed to create a new object of + * the `class_name' type. The `archive_node' class uses that table to + * construct an object of correct type. Next it invokes read_archive + * virtual method of newly created object, which does the actual job. + * + * Note: this approach is very simple-minded (it does not handle classes + * with same names from different namespaces, multiple inheritance, etc), + * but it happens to work surprisingly well. + */ +#define GINAC_DECLARE_UNARCHIVER(classname) \ +class classname ## _unarchiver \ +{ \ + static int usecount; \ +public: \ + static GiNaC::basic* create(); \ + classname ## _unarchiver(); \ + ~ classname ## _unarchiver(); \ +}; \ +static classname ## _unarchiver classname ## _unarchiver_instance + +#define GINAC_BIND_UNARCHIVER(classname) \ +classname ## _unarchiver::classname ## _unarchiver() \ +{ \ + static GiNaC::unarchive_table_t table; \ + if (usecount++ == 0) { \ + table.insert(std::string(#classname), \ + &(classname ## _unarchiver::create)); \ + } \ +} \ +GiNaC::basic* classname ## _unarchiver::create() \ +{ \ + return new classname(); \ +} \ +classname ## _unarchiver::~ classname ## _unarchiver() { } \ +int classname ## _unarchiver::usecount = 0 + /** This class holds archived versions of GiNaC expressions (class ex). * An archive can be constructed from an expression and then written to @@ -128,8 +248,8 @@ private: * of class basic (or a derived class). */ class archive { - friend ostream &operator<<(ostream &os, const archive &ar); - friend istream &operator>>(istream &is, archive &ar); + friend std::ostream &operator<<(std::ostream &os, const archive &ar); + friend std::istream &operator>>(std::istream &is, archive &ar); public: archive() {} @@ -141,52 +261,82 @@ public: /** Construct archive from expression using the specified name. */ archive(const ex &e, const char *n) {archive_ex(e, n);} - archive_node_id add_node(const archive_node &n); - archive_node &get_node(archive_node_id id); - + /** Archive an expression. + * @param e the expression to be archived + * @param name name under which the expression is stored */ void archive_ex(const ex &e, const char *name); + + /** Retrieve expression from archive by name. + * @param sym_lst list of pre-defined symbols + * @param name name of expression */ ex unarchive_ex(const lst &sym_lst, const char *name) const; - ex unarchive_ex(const lst &sym_lst, unsigned int index = 0) const; - ex unarchive_ex(const lst &sym_lst, string &name, unsigned int index = 0) const; - unsigned int num_expressions(void) const; - void clear(void); + /** Retrieve expression from archive by index. + * @param sym_lst list of pre-defined symbols + * @param index index of expression + * @see count_expressions */ + ex unarchive_ex(const lst &sym_lst, unsigned index = 0) const; - void forget(void); - void printraw(ostream &os) const; + /** Retrieve expression and its name from archive by index. + * @param sym_lst list of pre-defined symbols + * @param name receives the name of the expression + * @param index index of expression + * @see count_expressions */ + ex unarchive_ex(const lst &sym_lst, std::string &name, unsigned index = 0) const; + + /** Return number of archived expressions. */ + unsigned num_expressions() const; + + /** Return reference to top node of an expression specified by index. */ + const archive_node &get_top_node(unsigned index = 0) const; + + /** Clear all archived expressions. */ + void clear(); + + archive_node_id add_node(const archive_node &n); + archive_node &get_node(archive_node_id id); + + void forget(); + void printraw(std::ostream &os) const; private: /** Vector of archived nodes. */ - vector nodes; + std::vector nodes; /** Archived expression descriptor. */ struct archived_ex { archived_ex() {} archived_ex(archive_atom n, archive_node_id node) : name(n), root(node) {} - archive_atom name; /**< Name of expression. */ - archive_node_id root; /**< ID of root node. */ + archive_atom name; /**< Name of expression. */ + archive_node_id root; /**< ID of root node. */ }; /** Vector of archived expression descriptors. */ - vector exprs; + std::vector exprs; public: - archive_atom atomize(const string &s) const; - const string &unatomize(archive_atom id) const; + archive_atom atomize(const std::string &s) const; + const std::string &unatomize(archive_atom id) const; private: /** Vector of atomized strings (using a vector allows faster unarchiving). */ - mutable vector atoms; + mutable std::vector atoms; + /** The map of from strings to indices of the atoms vectors allows for + * faster archiving. + */ + typedef std::map::const_iterator inv_at_cit; + mutable std::map inverse_atoms; + + /** Map of stored expressions to nodes for faster archiving */ + typedef std::map::iterator mapit; + mutable std::map exprtable; }; -ostream &operator<<(ostream &os, const archive &ar); -istream &operator>>(istream &is, archive &ar); - +std::ostream &operator<<(std::ostream &os, const archive &ar); +std::istream &operator>>(std::istream &is, archive &ar); -#ifndef NO_NAMESPACE_GINAC } // namespace GiNaC -#endif // ndef NO_NAMESPACE_GINAC -#endif // ndef __GINAC_ARCHIVE_H__ +#endif // ndef GINAC_ARCHIVE_H