]> www.ginac.de Git - ginac.git/blobdiff - ginac/archive.cpp
numeric.cpp, archive.cpp: don't include config.h
[ginac.git] / ginac / archive.cpp
index 3ce4ec6590a4fef154a209390b2e86c0c7057656..6fc690071c8b16ad2e5761cc3672ebdccf6b7eed 100644 (file)
@@ -3,7 +3,7 @@
  *  Archiving of GiNaC expressions. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 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
  *
  *  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
  */
 
-#include <iostream>
-#include <stdexcept>
-
 #include "archive.h"
 #include "registrar.h"
 #include "ex.h"
-#include "config.h"
-#include "utils.h"
+#include "lst.h"
+#include "version.h"
+
+#include <iostream>
+#include <stdexcept>
 
 namespace GiNaC {
 
@@ -40,7 +40,7 @@ void archive::archive_ex(const ex &e, const char *name)
 
        // Add root node ID to list of archived expressions
        archived_ex ae = archived_ex(atomize(name), id);
-       exprs.push_back(ae);
+       exprs.emplace_back(ae);
 }
 
 
@@ -49,18 +49,19 @@ void archive::archive_ex(const ex &e, const char *name)
  *  @return ID of archived node */
 archive_node_id archive::add_node(const archive_node &n)
 {
-       // Search for node in nodes vector
-       std::vector<archive_node>::const_iterator i = nodes.begin(), iend = nodes.end();
-       archive_node_id id = 0;
-       while (i != iend) {
-               if (i->has_same_ex_as(n))
-                       return id;
-               i++; id++;
+       // Look if expression is known to be in some node already.
+       if (n.has_ex()) {
+               auto i = exprtable.find(n.get_ex());
+               if (i != exprtable.end())
+                       return i->second;
+               nodes.push_back(n);
+               exprtable[n.get_ex()] = nodes.size() - 1;
+               return nodes.size() - 1;
        }
 
        // Not found, add archive_node to nodes vector
        nodes.push_back(n);
-       return id;
+       return nodes.size()-1;
 }
 
 
@@ -79,7 +80,7 @@ ex archive::unarchive_ex(const lst &sym_lst, const char *name) const
        // Find root node
        std::string name_string = name;
        archive_atom id = atomize(name_string);
-       std::vector<archived_ex>::const_iterator i = exprs.begin(), iend = exprs.end();
+       auto i = exprs.begin(), iend = exprs.end();
        while (i != iend) {
                if (i->name == id)
                        goto found;
@@ -89,19 +90,21 @@ ex archive::unarchive_ex(const lst &sym_lst, const char *name) const
 
 found:
        // Recursively unarchive all nodes, starting at the root node
-       return nodes[i->root].unarchive(sym_lst);
+       lst sym_lst_copy = sym_lst;
+       return nodes[i->root].unarchive(sym_lst_copy);
 }
 
-ex archive::unarchive_ex(const lst &sym_lst, unsigned int index) const
+ex archive::unarchive_ex(const lst &sym_lst, unsigned index) const
 {
        if (index >= exprs.size())
                throw (std::range_error("index of archived expression out of range"));
 
        // Recursively unarchive all nodes, starting at the root node
-       return nodes[exprs[index].root].unarchive(sym_lst);
+       lst sym_lst_copy = sym_lst;
+       return nodes[exprs[index].root].unarchive(sym_lst_copy);
 }
 
-ex archive::unarchive_ex(const lst &sym_lst, std::string &name, unsigned int index) const
+ex archive::unarchive_ex(const lst &sym_lst, std::string &name, unsigned index) const
 {
        if (index >= exprs.size())
                throw (std::range_error("index of archived expression out of range"));
@@ -110,15 +113,16 @@ ex archive::unarchive_ex(const lst &sym_lst, std::string &name, unsigned int ind
        name = unatomize(exprs[index].name);
 
        // Recursively unarchive all nodes, starting at the root node
-       return nodes[exprs[index].root].unarchive(sym_lst);
+       lst sym_lst_copy = sym_lst;
+       return nodes[exprs[index].root].unarchive(sym_lst_copy);
 }
 
-unsigned int archive::num_expressions(void) const
+unsigned archive::num_expressions() const
 {
        return exprs.size();
 }
 
-const archive_node &archive::get_top_node(unsigned int index) const
+const archive_node &archive::get_top_node(unsigned index) const
 {
        if (index >= exprs.size())
                throw (std::range_error("index of archived expression out of range"));
@@ -167,7 +171,7 @@ const archive_node &archive::get_top_node(unsigned int index) const
  */
 
 /** Write unsigned integer quantity to stream. */
-static void write_unsigned(std::ostream &os, unsigned int val)
+static void write_unsigned(std::ostream &os, unsigned val)
 {
        while (val >= 0x80) {
                os.put((val & 0x7f) | 0x80);
@@ -177,15 +181,15 @@ static void write_unsigned(std::ostream &os, unsigned int val)
 }
 
 /** Read unsigned integer quantity from stream. */
-static unsigned int read_unsigned(std::istream &is)
+static unsigned read_unsigned(std::istream &is)
 {
        unsigned char b;
-       unsigned int ret = 0;
-       unsigned int shift = 0;
+       unsigned ret = 0;
+       unsigned shift = 0;
        do {
-        char b2;
+               char b2;
                is.get(b2);
-        b = b2;
+               b = b2;
                ret |= (b & 0x7f) << shift;
                shift += 7;
        } while (b & 0x80);
@@ -196,9 +200,9 @@ static unsigned int read_unsigned(std::istream &is)
 std::ostream &operator<<(std::ostream &os, const archive_node &n)
 {
        // Write properties
-       unsigned int num_props = n.props.size();
+       unsigned num_props = n.props.size();
        write_unsigned(os, num_props);
-       for (unsigned int i=0; i<num_props; i++) {
+       for (unsigned i=0; i<num_props; i++) {
                write_unsigned(os, n.props[i].type | (n.props[i].name << 3));
                write_unsigned(os, n.props[i].value);
        }
@@ -213,26 +217,26 @@ std::ostream &operator<<(std::ostream &os, const archive &ar)
        os.put('A');
        os.put('R');
        os.put('C');
-       write_unsigned(os, ARCHIVE_VERSION);
+       write_unsigned(os, GINACLIB_ARCHIVE_VERSION);
 
        // Write atoms
-       unsigned int num_atoms = ar.atoms.size();
+       unsigned num_atoms = ar.atoms.size();
        write_unsigned(os, num_atoms);
-       for (unsigned int i=0; i<num_atoms; i++)
+       for (unsigned i=0; i<num_atoms; i++)
                os << ar.atoms[i] << std::ends;
 
        // Write expressions
-       unsigned int num_exprs = ar.exprs.size();
+       unsigned num_exprs = ar.exprs.size();
        write_unsigned(os, num_exprs);
-       for (unsigned int i=0; i<num_exprs; i++) {
+       for (unsigned i=0; i<num_exprs; i++) {
                write_unsigned(os, ar.exprs[i].name);
                write_unsigned(os, ar.exprs[i].root);
        }
 
        // Write nodes
-       unsigned int num_nodes = ar.nodes.size();
+       unsigned num_nodes = ar.nodes.size();
        write_unsigned(os, num_nodes);
-       for (unsigned int i=0; i<num_nodes; i++)
+       for (unsigned i=0; i<num_nodes; i++)
                os << ar.nodes[i];
        return os;
 }
@@ -241,10 +245,10 @@ std::ostream &operator<<(std::ostream &os, const archive &ar)
 std::istream &operator>>(std::istream &is, archive_node &n)
 {
        // Read properties
-       unsigned int num_props = read_unsigned(is);
+       unsigned num_props = read_unsigned(is);
        n.props.resize(num_props);
-       for (unsigned int i=0; i<num_props; i++) {
-               unsigned int name_type = read_unsigned(is);
+       for (unsigned i=0; i<num_props; i++) {
+               unsigned name_type = read_unsigned(is);
                n.props[i].type = (archive_node::property_type)(name_type & 7);
                n.props[i].name = name_type >> 3;
                n.props[i].value = read_unsigned(is);
@@ -260,29 +264,33 @@ std::istream &operator>>(std::istream &is, archive &ar)
        is.get(c1); is.get(c2); is.get(c3); is.get(c4);
        if (c1 != 'G' || c2 != 'A' || c3 != 'R' || c4 != 'C')
                throw (std::runtime_error("not a GiNaC archive (signature not found)"));
-       unsigned int version = read_unsigned(is);
-       if (version > ARCHIVE_VERSION || version < ARCHIVE_VERSION - ARCHIVE_AGE)
-               throw (std::runtime_error("archive version " + ToString(version) + " cannot be read by this GiNaC library (which supports versions " + ToString(ARCHIVE_VERSION-ARCHIVE_AGE) + " thru " + ToString(ARCHIVE_VERSION)));
+       constexpr unsigned max_version = GINACLIB_ARCHIVE_VERSION;
+       constexpr unsigned min_version = GINACLIB_ARCHIVE_VERSION - GINACLIB_ARCHIVE_AGE;
+       unsigned version = read_unsigned(is);
+       if ((version > max_version) || (version < min_version))
+               throw (std::runtime_error("archive version " + std::to_string(version) + " cannot be read by this GiNaC library (which supports versions " + std::to_string(min_version) + " thru " + std::to_string(max_version)));
 
        // Read atoms
-       unsigned int num_atoms = read_unsigned(is);
+       unsigned num_atoms = read_unsigned(is);
        ar.atoms.resize(num_atoms);
-       for (unsigned int i=0; i<num_atoms; i++)
+       for (unsigned i=0; i<num_atoms; i++) {
                getline(is, ar.atoms[i], '\0');
+               ar.inverse_atoms[ar.atoms[i]] = i;
+       }
 
        // Read expressions
-       unsigned int num_exprs = read_unsigned(is);
+       unsigned num_exprs = read_unsigned(is);
        ar.exprs.resize(num_exprs);
-       for (unsigned int i=0; i<num_exprs; i++) {
+       for (unsigned i=0; i<num_exprs; i++) {
                archive_atom name = read_unsigned(is);
                archive_node_id root = read_unsigned(is);
                ar.exprs[i] = archive::archived_ex(name, root);
        }
 
        // Read nodes
-       unsigned int num_nodes = read_unsigned(is);
+       unsigned num_nodes = read_unsigned(is);
        ar.nodes.resize(num_nodes, ar);
-       for (unsigned int i=0; i<num_nodes; i++)
+       for (unsigned i=0; i<num_nodes; i++)
                is >> ar.nodes[i];
        return is;
 }
@@ -292,17 +300,15 @@ std::istream &operator>>(std::istream &is, archive &ar)
  *  represents the string). */
 archive_atom archive::atomize(const std::string &s) const
 {
-       // Search for string in atoms vector
-       std::vector<std::string>::const_iterator i = atoms.begin(), iend = atoms.end();
-       archive_atom id = 0;
-       while (i != iend) {
-               if (*i == s)
-                       return id;
-               i++; id++;
-       }
+       // Search for string in inverse_atoms map.
+       inv_at_cit i = inverse_atoms.find(s);
+       if (i!=inverse_atoms.end())
+               return i->second;
 
        // Not found, add to atoms vector
+       archive_atom id = atoms.size();
        atoms.push_back(s);
+       inverse_atoms[s] = id;
        return id;
 }
 
@@ -310,24 +316,17 @@ archive_atom archive::atomize(const std::string &s) const
 const std::string &archive::unatomize(archive_atom id) const
 {
        if (id >= atoms.size())
-               throw (std::range_error("archive::unatomizee(): atom ID out of range"));
+               throw (std::range_error("archive::unatomize(): atom ID out of range"));
 
        return atoms[id];
 }
 
 
-/** Copy constructor of archive_node. */
-archive_node::archive_node(const archive_node &other)
-  : a(other.a), props(other.props), has_expression(other.has_expression), e(other.e)
-{
-}
-
-
 /** Assignment operator of archive_node. */
 const archive_node &archive_node::operator=(const archive_node &other)
 {
        if (this != &other) {
-               a = other.a;
+               // archive &a member doesn't get copied
                props = other.props;
                has_expression = other.has_expression;
                e = other.e;
@@ -354,97 +353,150 @@ bool archive_node::has_same_ex_as(const archive_node &other) const
        return e.bp == other.e.bp;
 }
 
+archive_node::archive_node_cit
+archive_node::find_first(const std::string &name) const
+{
+       archive_atom name_atom = a.atomize(name);
+       for (auto i=props.begin(); i!=props.end(); ++i)
+               if (i->name == name_atom)
+                       return i;
+       return props.end();
+}
+
+archive_node::archive_node_cit
+archive_node::find_last(const std::string &name) const
+{
+       archive_atom name_atom = a.atomize(name);
+       for (auto i=props.end(); i!=props.begin();) {
+               --i;
+               if (i->name == name_atom)
+                       return i;
+       }
+       return props.end();
+}
+
+archive_node::archive_node_cit_range
+archive_node::find_property_range(const std::string &name1, const std::string &name2) const
+{
+       archive_atom name1_atom = a.atomize(name1),
+                    name2_atom = a.atomize(name2);
+       archive_node_cit_range range = {props.end(), props.end()};
+       for (auto i=props.begin(); i!=props.end(); ++i) {
+               if (i->name == name1_atom && range.begin == props.end()) {
+                       range.begin = i;
+               }
+               if (i->name == name2_atom && range.begin != props.end()) {
+                       range.end = i + 1;
+               }
+       }
+       return range;
+}
 
 void archive_node::add_bool(const std::string &name, bool value)
 {
-       props.push_back(property(a.atomize(name), PTYPE_BOOL, value));
+       props.emplace_back(property(a.atomize(name), PTYPE_BOOL, value));
 }
 
-void archive_node::add_unsigned(const std::string &name, unsigned int value)
+void archive_node::add_unsigned(const std::string &name, unsigned value)
 {
-       props.push_back(property(a.atomize(name), PTYPE_UNSIGNED, value));
+       props.emplace_back(property(a.atomize(name), PTYPE_UNSIGNED, value));
 }
 
 void archive_node::add_string(const std::string &name, const std::string &value)
 {
-       props.push_back(property(a.atomize(name), PTYPE_STRING, a.atomize(value)));
+       props.emplace_back(property(a.atomize(name), PTYPE_STRING, a.atomize(value)));
 }
 
 void archive_node::add_ex(const std::string &name, const ex &value)
 {
        // Recursively create an archive_node and add its ID to the properties of this node
        archive_node_id id = a.add_node(archive_node(a, value));
-       props.push_back(property(a.atomize(name), PTYPE_NODE, id));
+       props.emplace_back(property(a.atomize(name), PTYPE_NODE, id));
 }
 
 
-bool archive_node::find_bool(const std::string &name, bool &ret) const
+bool archive_node::find_bool(const std::string &name, bool &ret, unsigned index) const
 {
        archive_atom name_atom = a.atomize(name);
-       std::vector<property>::const_iterator i = props.begin(), iend = props.end();
+       auto i = props.begin(), iend = props.end();
+       unsigned found_index = 0;
        while (i != iend) {
                if (i->type == PTYPE_BOOL && i->name == name_atom) {
-                       ret = i->value;
-                       return true;
+                       if (found_index == index) {
+                               ret = i->value;
+                               return true;
+                       }
+                       found_index++;
                }
                i++;
        }
        return false;
 }
 
-bool archive_node::find_unsigned(const std::string &name, unsigned int &ret) const
+bool archive_node::find_unsigned(const std::string &name, unsigned &ret, unsigned index) const
 {
        archive_atom name_atom = a.atomize(name);
-       std::vector<property>::const_iterator i = props.begin(), iend = props.end();
+       auto i = props.begin(), iend = props.end();
+       unsigned found_index = 0;
        while (i != iend) {
                if (i->type == PTYPE_UNSIGNED && i->name == name_atom) {
-                       ret = i->value;
-                       return true;
+                       if (found_index == index) {
+                               ret = i->value;
+                               return true;
+                       }
+                       found_index++;
                }
                i++;
        }
        return false;
 }
 
-bool archive_node::find_string(const std::string &name, std::string &ret) const
+bool archive_node::find_string(const std::string &name, std::string &ret, unsigned index) const
 {
        archive_atom name_atom = a.atomize(name);
-       std::vector<property>::const_iterator i = props.begin(), iend = props.end();
+       auto i = props.begin(), iend = props.end();
+       unsigned found_index = 0;
        while (i != iend) {
                if (i->type == PTYPE_STRING && i->name == name_atom) {
-                       ret = a.unatomize(i->value);
-                       return true;
+                       if (found_index == index) {
+                               ret = a.unatomize(i->value);
+                               return true;
+                       }
+                       found_index++;
                }
                i++;
        }
        return false;
 }
 
-bool archive_node::find_ex(const std::string &name, ex &ret, const lst &sym_lst, unsigned int index) const
+void archive_node::find_ex_by_loc(archive_node_cit loc, ex &ret, lst &sym_lst) const
+{
+       ret = a.get_node(loc->value).unarchive(sym_lst);
+}
+
+bool archive_node::find_ex(const std::string &name, ex &ret, lst &sym_lst, unsigned index) const
 {
        archive_atom name_atom = a.atomize(name);
-       std::vector<property>::const_iterator i = props.begin(), iend = props.end();
-       unsigned int found_index = 0;
+       auto i = props.begin(), iend = props.end();
+       unsigned found_index = 0;
        while (i != iend) {
                if (i->type == PTYPE_NODE && i->name == name_atom) {
-                       if (found_index == index)
-                               goto found;
+                       if (found_index == index) {
+                               ret = a.get_node(i->value).unarchive(sym_lst);
+                               return true;
+                       }
                        found_index++;
                }
                i++;
        }
        return false;
-
-found:
-       ret = a.get_node(i->value).unarchive(sym_lst);
-       return true;
 }
 
-const archive_node &archive_node::find_ex_node(const std::string &name, unsigned int index) const
+const archive_node &archive_node::find_ex_node(const std::string &name, unsigned index) const
 {
        archive_atom name_atom = a.atomize(name);
-       std::vector<property>::const_iterator i = props.begin(), iend = props.end();
-       unsigned int found_index = 0;
+       auto i = props.begin(), iend = props.end();
+       unsigned found_index = 0;
        while (i != iend) {
                if (i->type == PTYPE_NODE && i->name == name_atom) {
                        if (found_index == index)
@@ -460,12 +512,12 @@ const archive_node &archive_node::find_ex_node(const std::string &name, unsigned
 void archive_node::get_properties(propinfovector &v) const
 {
        v.clear();
-       std::vector<property>::const_iterator i = props.begin(), iend = props.end();
+       auto i = props.begin(), iend = props.end();
        while (i != iend) {
                property_type type = i->type;
-               string name = a.unatomize(i->name);
+               std::string name = a.unatomize(i->name);
 
-               propinfovector::iterator a = v.begin(), aend = v.end();
+               auto a = v.begin(), aend = v.end();
                bool found = false;
                while (a != aend) {
                        if (a->type == type && a->name == name) {
@@ -473,17 +525,23 @@ void archive_node::get_properties(propinfovector &v) const
                                found = true;
                                break;
                        }
-                       a++;
+                       ++a;
                }
                if (!found)
-                       v.push_back(property_info(type, name));
+                       v.emplace_back(property_info(type, name));
                i++;
-       }       
+       }
 }
 
+static synthesize_func find_factory_fcn(const std::string& name)
+{
+       static unarchive_table_t the_table;
+       synthesize_func ret = the_table.find(name);
+       return ret;
+}
 
 /** Convert archive node to GiNaC expression. */
-ex archive_node::unarchive(const lst &sym_lst) const
+ex archive_node::unarchive(lst &sym_lst) const
 {
        // Already unarchived? Then return cached unarchived expression.
        if (has_expression)
@@ -493,58 +551,69 @@ ex archive_node::unarchive(const lst &sym_lst) const
        std::string class_name;
        if (!find_string("class", class_name))
                throw (std::runtime_error("archive node contains no class name"));
-       unarch_func f = find_unarch_func(class_name);
 
        // Call instantiation function
-       e = f(*this, sym_lst);
+       synthesize_func factory_fcn = find_factory_fcn(class_name);
+       ptr<basic> obj(factory_fcn());
+       obj->setflag(status_flags::dynallocated);
+       obj->read_archive(*this, sym_lst);
+       e = ex(*obj);
        has_expression = true;
        return e;
 }
 
+int unarchive_table_t::usecount = 0;
+unarchive_map_t* unarchive_table_t::unarch_map = nullptr;
 
-/** Assignment operator of property_info. */
-const archive_node::property_info &archive_node::property_info::operator=(const property_info &other)
+unarchive_table_t::unarchive_table_t()
 {
-       if (this != &other) {
-               type = other.type;
-               name = other.name;
-               count = other.count;
-       }
-       return *this;
+       if (usecount == 0)
+               unarch_map = new unarchive_map_t();
+       ++usecount;
 }
 
-/** Assignment operator of property. */
-const archive_node::property &archive_node::property::operator=(const property &other)
+synthesize_func unarchive_table_t::find(const std::string& classname) const
 {
-       if (this != &other) {
-               type = other.type;
-               name = other.name;
-               value = other.value;
-       }
-       return *this;
+       unarchive_map_t::const_iterator i = unarch_map->find(classname);
+       if (i != unarch_map->end())
+               return i->second;
+       throw std::runtime_error(std::string("no unarchiving function for \"")
+                       + classname + "\" class");
+}
+
+void unarchive_table_t::insert(const std::string& classname, synthesize_func f)
+{
+       if (unarch_map->find(classname) != unarch_map->end())
+               throw std::runtime_error(std::string("Class \"" + classname
+                                       + "\" is already registered"));
+       unarch_map->operator[](classname) = f;
+}
+
+unarchive_table_t::~unarchive_table_t()
+{
+       if (--usecount == 0)
+               delete unarch_map;
 }
 
 
-void archive::clear(void)
+void archive::clear()
 {
        atoms.clear();
+       inverse_atoms.clear();
        exprs.clear();
        nodes.clear();
+       exprtable.clear();
 }
 
 
 /** Delete cached unarchived expressions in all archive_nodes (mainly for debugging). */
-void archive::forget(void)
+void archive::forget()
 {
-       std::vector<archive_node>::iterator i = nodes.begin(), iend = nodes.end();
-       while (i != iend) {
-               i->forget();
-               i++;
-       }
+       for_each(nodes.begin(), nodes.end(), std::mem_fun_ref(&archive_node::forget));
 }
 
 /** Delete cached unarchived expressions from node (for debugging). */
-void archive_node::forget(void)
+void archive_node::forget()
 {
        has_expression = false;
        e = 0;
@@ -569,8 +638,8 @@ void archive::printraw(std::ostream &os) const
        // Dump expressions
        os << "Expressions:\n";
        {
-               std::vector<archived_ex>::const_iterator i = exprs.begin(), iend = exprs.end();
-               unsigned int index = 0;
+               auto i = exprs.begin(), iend = exprs.end();
+               unsigned index = 0;
                while (i != iend) {
                        os << " " << index << " \"" << unatomize(i->name) << "\" root node " << i->root << std::endl;
                        i++; index++;
@@ -581,7 +650,7 @@ void archive::printraw(std::ostream &os) const
        // Dump nodes
        os << "Nodes:\n";
        {
-               std::vector<archive_node>::const_iterator i = nodes.begin(), iend = nodes.end();
+               auto i = nodes.begin(), iend = nodes.end();
                archive_node_id id = 0;
                while (i != iend) {
                        os << " " << id << " ";
@@ -601,7 +670,7 @@ void archive_node::printraw(std::ostream &os) const
                os << "\n";
 
        // Dump properties
-       std::vector<property>::const_iterator i = props.begin(), iend = props.end();
+       auto i = props.begin(), iend = props.end();
        while (i != iend) {
                os << "  ";
                switch (i->type) {
@@ -616,13 +685,5 @@ void archive_node::printraw(std::ostream &os) const
        }
 }
 
-/** Create a dummy archive.  The intention is to fill archive_node's default
- *  ctor, which is currently a Cint-requirement. */
-archive* archive_node::dummy_ar_creator(void)
-{
-       static archive* some_ar = new archive;
-       return some_ar;
-}
-
 
 } // namespace GiNaC