X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Farchive.h;h=603bd81c8775d8e4b7f1fef627423c7f95347e93;hp=0c2a1af64204ad09b1d0234cea0248b310d1151c;hb=5f7f81ad35a80e12c6a9a2272e3882387732be4f;hpb=7d870583a6bf21a2ffb7b6f051b702064623892e diff --git a/ginac/archive.h b/ginac/archive.h index 0c2a1af6..603bd81c 100644 --- a/ginac/archive.h +++ b/ginac/archive.h @@ -3,7 +3,7 @@ * Archiving of GiNaC expressions. */ /* - * GiNaC Copyright (C) 1999-2008 Johannes Gutenberg University Mainz, Germany + * GiNaC Copyright (C) 1999-2020 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 @@ -20,15 +20,15 @@ * 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 -#include namespace GiNaC { @@ -82,8 +82,10 @@ public: unsigned value; /**< Stored value. */ }; typedef std::vector::const_iterator archive_node_cit; + struct archive_node_cit_range { + archive_node_cit begin, end; + }; - 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); @@ -114,17 +116,22 @@ public: bool find_string(const std::string &name, std::string &ret, unsigned index = 0) const; /** Find the location in the vector of properties of the first/last - * property with a given name. */ + * 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; + /** Find a range of locations in the vector of properties. The result + * begins at the first property with name1 and ends one past the last + * property with name2. */ + archive_node_cit_range find_property_range(const std::string &name1, const std::string &name2) const; + /** 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; /** 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. */ + * 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 @@ -143,8 +150,6 @@ public: void printraw(std::ostream &os) const; private: - static archive* dummy_ar_creator(); - /** Reference to the archive to which this node belongs. */ archive &a; @@ -158,6 +163,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 @@ -194,14 +279,14 @@ public: /** Retrieve expression from archive by index. * @param sym_lst list of pre-defined symbols * @param index index of expression - * @see count_expressions */ + * @see count_expressions */ ex unarchive_ex(const lst &sym_lst, unsigned index = 0) 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 */ + * @see count_expressions */ ex unarchive_ex(const lst &sym_lst, std::string &name, unsigned index = 0) const; /** Return number of archived expressions. */ @@ -249,7 +334,6 @@ private: mutable std::map inverse_atoms; /** Map of stored expressions to nodes for faster archiving */ - typedef std::map::iterator mapit; mutable std::map exprtable; }; @@ -257,7 +341,6 @@ private: std::ostream &operator<<(std::ostream &os, const archive &ar); std::istream &operator>>(std::istream &is, archive &ar); - } // namespace GiNaC -#endif // ndef __GINAC_ARCHIVE_H__ +#endif // ndef GINAC_ARCHIVE_H