fixed a bug where quo() would call vector::reserve() with a negative argument
[ginac.git] / ginac / archive.cpp
index d249f2971a427c9d6399220099ad5113ebe3efe1..c5c261310ec6849e2731afcccfce079f6ca7d1dc 100644 (file)
@@ -3,7 +3,7 @@
  *  Archiving of GiNaC expressions. */
 
 /*
- *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2001 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
 #include "registrar.h"
 #include "ex.h"
 #include "config.h"
-#include "utils.h"
+#include "tostring.h"
 
-#ifndef NO_NAMESPACE_GINAC
 namespace GiNaC {
-#endif // ndef NO_NAMESPACE_GINAC
 
 
-/** 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)
@@ -79,8 +74,6 @@ 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
@@ -92,16 +85,14 @@ ex archive::unarchive_ex(const lst &sym_lst, const char *name) const
                        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);
 }
 
-/** 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"));
@@ -110,9 +101,7 @@ ex archive::unarchive_ex(const lst &sym_lst, unsigned int index) const
        return nodes[exprs[index].root].unarchive(sym_lst);
 }
 
-/** 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, 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"));
@@ -124,13 +113,19 @@ ex archive::unarchive_ex(const lst &sym_lst, std::string &name, unsigned int ind
        return nodes[exprs[index].root].unarchive(sym_lst);
 }
 
-
-/** Return number of archived expressions. */
-unsigned int archive::num_expressions(void) const
+unsigned archive::num_expressions(void) 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
@@ -172,9 +167,9 @@ unsigned int archive::num_expressions(void) 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) {
+       while (val >= 0x80) {
                os.put((val & 0x7f) | 0x80);
                val >>= 7;
        }
@@ -182,13 +177,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 {
-               is.get(b);
+        char b2;
+               is.get(b2);
+        b = b2;
                ret |= (b & 0x7f) << shift;
                shift += 7;
        } while (b & 0x80);
@@ -199,13 +196,13 @@ 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);
        }
-    return os;
+       return os;
 }
 
 /** Write archive to binary data stream. */
@@ -219,40 +216,40 @@ std::ostream &operator<<(std::ostream &os, const archive &ar)
        write_unsigned(os, 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++)
-               os << ar.atoms[i] << ends;
+       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;
+       return os;
 }
 
 /** Read archive_node from binary data stream. */
 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);
        }
-    return is;
+       return is;
 }
 
 /** Read archive from binary data stream. */
@@ -263,31 +260,31 @@ 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);
+       unsigned 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)));
 
        // 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');
 
        // 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;
+       return is;
 }
 
 
@@ -321,7 +318,7 @@ const std::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)
+  : a(other.a), props(other.props), has_expression(other.has_expression), e(other.e)
 {
 }
 
@@ -341,7 +338,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);
 }
@@ -358,25 +355,21 @@ bool archive_node::has_same_ex_as(const archive_node &other) const
 }
 
 
-/** Add property of type "bool" to node. */
 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 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));
 }
 
-/** Add property of type "string" to node. */
 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 std::string &name, const ex &value)
 {
        // Recursively create an archive_node and add its ID to the properties of this node
@@ -385,74 +378,117 @@ void archive_node::add_ex(const std::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 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();
+       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 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();
+       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 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();
+       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 std::string &name, ex &ret, const lst &sym_lst, unsigned int index) const
+bool archive_node::find_ex(const std::string &name, ex &ret, const 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;
+       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);
+       std::vector<property>::const_iterator 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();
+       std::vector<property>::const_iterator 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++;
+       }       
 }
 
 
@@ -476,6 +512,17 @@ ex archive_node::unarchive(const lst &sym_lst) const
 }
 
 
+/** Assignment operator of property_info. */
+const archive_node::property_info &archive_node::property_info::operator=(const property_info &other)
+{
+       if (this != &other) {
+               type = other.type;
+               name = other.name;
+               count = other.count;
+       }
+       return *this;
+}
+
 /** Assignment operator of property. */
 const archive_node::property &archive_node::property::operator=(const property &other)
 {
@@ -488,7 +535,6 @@ const archive_node::property &archive_node::property::operator=(const property &
 }
 
 
-/** Clear all archived expressions. */
 void archive::clear(void)
 {
        atoms.clear();
@@ -500,11 +546,7 @@ void archive::clear(void)
 /** Delete cached unarchived expressions in all archive_nodes (mainly for debugging). */
 void archive::forget(void)
 {
-       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). */
@@ -524,23 +566,23 @@ void archive::printraw(std::ostream &os) const
                std::vector<std::string>::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";
        {
                std::vector<archived_ex>::const_iterator i = exprs.begin(), iend = exprs.end();
-               unsigned int index = 0;
+               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";
@@ -575,7 +617,7 @@ void archive_node::printraw(std::ostream &os) const
                        case PTYPE_NODE: os << "node"; break;
                        default: os << "<unknown>"; break;
                }
-               os << " \"" << a.unatomize(i->name) << "\" " << i->value << endl;
+               os << " \"" << a.unatomize(i->name) << "\" " << i->value << std::endl;
                i++;
        }
 }
@@ -584,11 +626,9 @@ void archive_node::printraw(std::ostream &os) const
  *  ctor, which is currently a Cint-requirement. */
 archive* archive_node::dummy_ar_creator(void)
 {
-    static archive* some_ar = new archive;
-    return some_ar;
+       static archive* some_ar = new archive;
+       return some_ar;
 }
 
 
-#ifndef NO_NAMESPACE_GINAC
 } // namespace GiNaC
-#endif // ndef NO_NAMESPACE_GINAC