X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Farchive.cpp;h=d25c804a49045e2f8fd737c4d2065f4df59d83f0;hp=0fdb30ad4ae97296a96513d8b04ce4e814324f20;hb=cca88b51436e4b654d16a4d60cd0d1c66fcf5dd6;hpb=a331d1fd814315cd934c4f0ebf0cf485dc52fe96 diff --git a/ginac/archive.cpp b/ginac/archive.cpp index 0fdb30ad..d25c804a 100644 --- a/ginac/archive.cpp +++ b/ginac/archive.cpp @@ -3,7 +3,7 @@ * Archiving of GiNaC expressions. */ /* - * GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany + * GiNaC Copyright (C) 1999-2014 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,26 +17,25 @@ * * 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 -#include - #include "archive.h" #include "registrar.h" #include "ex.h" +#include "lst.h" +#ifdef HAVE_CONFIG_H #include "config.h" -#include "utils.h" +#endif +#include "tostring.h" +#include "version.h" + +#include +#include -#ifndef NO_GINAC_NAMESPACE namespace GiNaC { -#endif // ndef NO_GINAC_NAMESPACE -/** Archive an expression. - * @param ex the expression to be archived - * @param name name under which the expression is stored */ void archive::archive_ex(const ex &e, const char *name) { // Create root node (which recursively archives the whole expression tree) @@ -54,18 +53,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 - vector::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()) { + mapit 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,40 +79,36 @@ archive_node &archive::get_node(archive_node_id id) } -/** Retrieve expression from archive by name. - * @param sym_lst list of pre-defined symbols */ ex archive::unarchive_ex(const lst &sym_lst, const char *name) const { // Find root node - string name_string = name; + std::string name_string = name; archive_atom id = atomize(name_string); - vector::const_iterator i = exprs.begin(), iend = exprs.end(); + std::vector::const_iterator i = exprs.begin(), iend = exprs.end(); while (i != iend) { if (i->name == id) goto found; i++; } - throw (std::logic_error("expression with name '" + name_string + "' not found in archive")); + throw (std::runtime_error("expression with name '" + name_string + "' not found in archive")); 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); } -/** Retrieve expression from archive by index. - * @param sym_lst list of pre-defined symbols */ -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); } -/** Retrieve expression and its name from archive by index. - * @param sym_lst list of pre-defined symbols */ -ex archive::unarchive_ex(const lst &sym_lst, 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")); @@ -121,16 +117,23 @@ ex archive::unarchive_ex(const lst &sym_lst, string &name, unsigned int index) c 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); } - -/** Return number of archived expressions. */ -unsigned int archive::num_expressions(void) const +unsigned archive::num_expressions() const { return exprs.size(); } +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")); + + return nodes[exprs[index].root]; +} + /* * Archive file format @@ -144,8 +147,8 @@ unsigned int archive::num_expressions(void) const * - unsigned root node ID * - unsigned number of nodes * - unsigned number of properties - * - unsigned type (PTYPE_*) - * - unsigned name atom + * - unsigned containing type (PTYPE_*) in its lower 3 bits and + * name atom in the upper bits * - unsigned property value * * Unsigned quantities are stored in a compressed format: @@ -172,9 +175,9 @@ unsigned int archive::num_expressions(void) const */ /** Write unsigned integer quantity to stream. */ -static void write_unsigned(ostream &os, unsigned int val) +static void write_unsigned(std::ostream &os, unsigned val) { - while (val > 0x80) { + while (val >= 0x80) { os.put((val & 0x7f) | 0x80); val >>= 7; } @@ -182,13 +185,15 @@ static void write_unsigned(ostream &os, unsigned int val) } /** Read unsigned integer quantity from stream. */ -static unsigned int read_unsigned(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 { - is.get(b); + char b2; + is.get(b2); + b = b2; ret |= (b & 0x7f) << shift; shift += 7; } while (b & 0x80); @@ -196,117 +201,123 @@ static unsigned int read_unsigned(istream &is) } /** Write archive_node to binary data stream. */ -ostream &operator<<(ostream &os, const archive_node &n) +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>(istream &is, archive_node &n) +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> 3; n.props[i].value = read_unsigned(is); } + return is; } /** Read archive from binary data stream. */ -istream &operator>>(istream &is, archive &ar) +std::istream &operator>>(std::istream &is, archive &ar) { // Read header char c1, c2, c3, c4; 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))); + static const unsigned max_version = GINACLIB_ARCHIVE_VERSION; + static const 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 " + ToString(version) + " cannot be read by this GiNaC library (which supports versions " + ToString(min_version) + " thru " + ToString(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> ar.nodes[i]; + return is; } /** Atomize a string (i.e. convert it into an ID number that uniquely * represents the string). */ -archive_atom archive::atomize(const string &s) const +archive_atom archive::atomize(const std::string &s) const { - // Search for string in atoms vector - vector::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; } /** Unatomize a string (i.e. convert the ID number back to the string). */ -const string &archive::unatomize(archive_atom id) 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")); @@ -315,18 +326,11 @@ const string &archive::unatomize(archive_atom id) const } -/** 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; @@ -337,7 +341,7 @@ const archive_node &archive_node::operator=(const archive_node &other) /** Recursively construct archive node from expression. */ archive_node::archive_node(archive &ar, const ex &expr) - : a(ar), has_expression(true), e(expr) + : a(ar), has_expression(true), e(expr) { expr.bp->archive(*this); } @@ -353,27 +357,44 @@ 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 (archive_node_cit 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 (archive_node_cit i=props.end(); i!=props.begin();) { + --i; + if (i->name == name_atom) + return i; + } + return props.end(); +} -/** Add property of type "bool" to node. */ -void archive_node::add_bool(const string &name, bool value) +void archive_node::add_bool(const std::string &name, bool value) { props.push_back(property(a.atomize(name), PTYPE_BOOL, value)); } -/** Add property of type "unsigned int" to node. */ -void archive_node::add_unsigned(const 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)); } -/** Add property of type "string" to node. */ -void archive_node::add_string(const string &name, const string &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))); } -/** Add property of type "ex" to node. */ -void archive_node::add_ex(const string &name, const ex &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)); @@ -381,130 +402,206 @@ void archive_node::add_ex(const string &name, const ex &value) } -/** Retrieve property of type "bool" from node. - * @return "true" if property was found, "false" otherwise */ -bool archive_node::find_bool(const 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); - vector::const_iterator i = props.begin(), iend = props.end(); + archive_node_cit 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; } -/** Retrieve property of type "unsigned" from node. - * @return "true" if property was found, "false" otherwise */ -bool archive_node::find_unsigned(const 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); - vector::const_iterator i = props.begin(), iend = props.end(); + archive_node_cit 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; } -/** Retrieve property of type "string" from node. - * @return "true" if property was found, "false" otherwise */ -bool archive_node::find_string(const string &name, 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); - vector::const_iterator i = props.begin(), iend = props.end(); + archive_node_cit 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; } -/** Retrieve property of type "ex" from node. - * @return "true" if property was found, "false" otherwise */ -bool archive_node::find_ex(const 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); - vector::const_iterator i = props.begin(), iend = props.end(); - unsigned int found_index = 0; + archive_node_cit 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 index) const +{ + archive_atom name_atom = a.atomize(name); + archive_node_cit 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) + return a.get_node(i->value); + found_index++; + } + i++; + } + throw (std::runtime_error("property with name '" + name + "' not found in archive node")); } +void archive_node::get_properties(propinfovector &v) const +{ + v.clear(); + archive_node_cit i = props.begin(), iend = props.end(); + while (i != iend) { + property_type type = i->type; + std::string name = a.unatomize(i->name); + + propinfovector::iterator a = v.begin(), aend = v.end(); + bool found = false; + while (a != aend) { + if (a->type == type && a->name == name) { + a->count++; + found = true; + break; + } + ++a; + } + if (!found) + v.push_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) return e; // Find instantiation function for class specified in node - string class_name; + 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 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 = 0; -/** Assignment operator of property. */ -const archive_node::property &archive_node::property::operator=(const property &other) +unarchive_table_t::unarchive_table_t() { - if (this != &other) { - type = other.type; - name = other.name; - value = other.value; - } - return *this; + if (usecount == 0) + unarch_map = new unarchive_map_t(); + ++usecount; +} + +synthesize_func unarchive_table_t::find(const std::string& classname) const +{ + 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; } -/** Clear all archived expressions. */ -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() { - vector::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; @@ -512,36 +609,36 @@ void archive_node::forget(void) /** Print archive to stream in ugly raw format (for debugging). */ -void archive::printraw(ostream &os) const +void archive::printraw(std::ostream &os) const { // Dump atoms os << "Atoms:\n"; { - vector::const_iterator i = atoms.begin(), iend = atoms.end(); + std::vector::const_iterator i = atoms.begin(), iend = atoms.end(); archive_atom id = 0; while (i != iend) { - os << " " << id << " " << *i << endl; + os << " " << id << " " << *i << std::endl; i++; id++; } } - os << endl; + os << std::endl; // Dump expressions os << "Expressions:\n"; { - vector::const_iterator i = exprs.begin(), iend = exprs.end(); - unsigned int index = 0; + std::vector::const_iterator i = exprs.begin(), iend = exprs.end(); + unsigned index = 0; while (i != iend) { - os << " " << index << " \"" << unatomize(i->name) << "\" root node " << i->root << endl; + os << " " << index << " \"" << unatomize(i->name) << "\" root node " << i->root << std::endl; i++; index++; } } - os << endl; + os << std::endl; // Dump nodes os << "Nodes:\n"; { - vector::const_iterator i = nodes.begin(), iend = nodes.end(); + std::vector::const_iterator i = nodes.begin(), iend = nodes.end(); archive_node_id id = 0; while (i != iend) { os << " " << id << " "; @@ -552,16 +649,16 @@ void archive::printraw(ostream &os) const } /** Output archive_node to stream in ugly raw format (for debugging). */ -void archive_node::printraw(ostream &os) const +void archive_node::printraw(std::ostream &os) const { // Dump cached unarchived expression if (has_expression) os << "(basic * " << e.bp << " = " << e << ")\n"; else - os << "(no expression)\n"; + os << "\n"; // Dump properties - vector::const_iterator i = props.begin(), iend = props.end(); + archive_node_cit i = props.begin(), iend = props.end(); while (i != iend) { os << " "; switch (i->type) { @@ -571,12 +668,18 @@ void archive_node::printraw(ostream &os) const case PTYPE_NODE: os << "node"; break; default: os << ""; break; } - os << " \"" << a.unatomize(i->name) << "\" " << i->value << endl; + os << " \"" << a.unatomize(i->name) << "\" " << i->value << std::endl; i++; } } +/** 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() +{ + static archive* some_ar = new archive; + return some_ar; +} + -#ifndef NO_GINAC_NAMESPACE } // namespace GiNaC -#endif // ndef NO_GINAC_NAMESPACE