3 * Archiving of GiNaC expressions. */
6 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #include "registrar.h"
32 #ifndef NO_NAMESPACE_GINAC
34 #endif // ndef NO_NAMESPACE_GINAC
37 /** Archive an expression.
38 * @param ex the expression to be archived
39 * @param name name under which the expression is stored */
40 void archive::archive_ex(const ex &e, const char *name)
42 // Create root node (which recursively archives the whole expression tree)
43 // and add it to the archive
44 archive_node_id id = add_node(archive_node(*this, e));
46 // Add root node ID to list of archived expressions
47 archived_ex ae = archived_ex(atomize(name), id);
52 /** Add archive_node to archive if the corresponding expression is
53 * not already archived.
54 * @return ID of archived node */
55 archive_node_id archive::add_node(const archive_node &n)
57 // Search for node in nodes vector
58 std::vector<archive_node>::const_iterator i = nodes.begin(), iend = nodes.end();
59 archive_node_id id = 0;
61 if (i->has_same_ex_as(n))
66 // Not found, add archive_node to nodes vector
72 /** Retrieve archive_node by ID. */
73 archive_node &archive::get_node(archive_node_id id)
75 if (id >= nodes.size())
76 throw (std::range_error("archive::get_node(): archive node ID out of range"));
82 /** Retrieve expression from archive by name.
83 * @param sym_lst list of pre-defined symbols */
84 ex archive::unarchive_ex(const lst &sym_lst, const char *name) const
87 std::string name_string = name;
88 archive_atom id = atomize(name_string);
89 std::vector<archived_ex>::const_iterator i = exprs.begin(), iend = exprs.end();
95 throw (std::logic_error("expression with name '" + name_string + "' not found in archive"));
98 // Recursively unarchive all nodes, starting at the root node
99 return nodes[i->root].unarchive(sym_lst);
102 /** Retrieve expression from archive by index.
103 * @param sym_lst list of pre-defined symbols */
104 ex archive::unarchive_ex(const lst &sym_lst, unsigned int index) const
106 if (index >= exprs.size())
107 throw (std::range_error("index of archived expression out of range"));
109 // Recursively unarchive all nodes, starting at the root node
110 return nodes[exprs[index].root].unarchive(sym_lst);
113 /** Retrieve expression and its name from archive by index.
114 * @param sym_lst list of pre-defined symbols */
115 ex archive::unarchive_ex(const lst &sym_lst, std::string &name, unsigned int index) const
117 if (index >= exprs.size())
118 throw (std::range_error("index of archived expression out of range"));
120 // Return expression name
121 name = unatomize(exprs[index].name);
123 // Recursively unarchive all nodes, starting at the root node
124 return nodes[exprs[index].root].unarchive(sym_lst);
128 /** Return number of archived expressions. */
129 unsigned int archive::num_expressions(void) const
136 * Archive file format
138 * - 4 bytes signature 'GARC'
139 * - unsigned version number
140 * - unsigned number of atoms
141 * - atom strings (each zero-terminated)
142 * - unsigned number of expressions
143 * - unsigned name atom
144 * - unsigned root node ID
145 * - unsigned number of nodes
146 * - unsigned number of properties
147 * - unsigned containing type (PTYPE_*) in its lower 3 bits and
148 * name atom in the upper bits
149 * - unsigned property value
151 * Unsigned quantities are stored in a compressed format:
152 * - numbers in the range 0x00..0x7f are stored verbatim (1 byte)
153 * - numbers larger than 0x7f are stored in 7-bit packets (1 byte per
154 * packet), starting with the LSBs; all bytes except the last one have
155 * their upper bit set
170 * 0x80 0x80 0x01 = 0x4000
174 /** Write unsigned integer quantity to stream. */
175 static void write_unsigned(std::ostream &os, unsigned int val)
178 os.put((val & 0x7f) | 0x80);
184 /** Read unsigned integer quantity from stream. */
185 static unsigned int read_unsigned(std::istream &is)
188 unsigned int ret = 0;
189 unsigned int shift = 0;
194 ret |= (b & 0x7f) << shift;
200 /** Write archive_node to binary data stream. */
201 std::ostream &operator<<(std::ostream &os, const archive_node &n)
204 unsigned int num_props = n.props.size();
205 write_unsigned(os, num_props);
206 for (unsigned int i=0; i<num_props; i++) {
207 write_unsigned(os, n.props[i].type | (n.props[i].name << 3));
208 write_unsigned(os, n.props[i].value);
213 /** Write archive to binary data stream. */
214 std::ostream &operator<<(std::ostream &os, const archive &ar)
217 os.put('G'); // Signature
221 write_unsigned(os, ARCHIVE_VERSION);
224 unsigned int num_atoms = ar.atoms.size();
225 write_unsigned(os, num_atoms);
226 for (unsigned int i=0; i<num_atoms; i++)
227 os << ar.atoms[i] << std::ends;
230 unsigned int num_exprs = ar.exprs.size();
231 write_unsigned(os, num_exprs);
232 for (unsigned int i=0; i<num_exprs; i++) {
233 write_unsigned(os, ar.exprs[i].name);
234 write_unsigned(os, ar.exprs[i].root);
238 unsigned int num_nodes = ar.nodes.size();
239 write_unsigned(os, num_nodes);
240 for (unsigned int i=0; i<num_nodes; i++)
245 /** Read archive_node from binary data stream. */
246 std::istream &operator>>(std::istream &is, archive_node &n)
249 unsigned int num_props = read_unsigned(is);
250 n.props.resize(num_props);
251 for (unsigned int i=0; i<num_props; i++) {
252 unsigned int name_type = read_unsigned(is);
253 n.props[i].type = (archive_node::property_type)(name_type & 7);
254 n.props[i].name = name_type >> 3;
255 n.props[i].value = read_unsigned(is);
260 /** Read archive from binary data stream. */
261 std::istream &operator>>(std::istream &is, archive &ar)
265 is.get(c1); is.get(c2); is.get(c3); is.get(c4);
266 if (c1 != 'G' || c2 != 'A' || c3 != 'R' || c4 != 'C')
267 throw (std::runtime_error("not a GiNaC archive (signature not found)"));
268 unsigned int version = read_unsigned(is);
269 if (version > ARCHIVE_VERSION || version < ARCHIVE_VERSION - ARCHIVE_AGE)
270 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)));
273 unsigned int num_atoms = read_unsigned(is);
274 ar.atoms.resize(num_atoms);
275 for (unsigned int i=0; i<num_atoms; i++)
276 getline(is, ar.atoms[i], '\0');
279 unsigned int num_exprs = read_unsigned(is);
280 ar.exprs.resize(num_exprs);
281 for (unsigned int i=0; i<num_exprs; i++) {
282 archive_atom name = read_unsigned(is);
283 archive_node_id root = read_unsigned(is);
284 ar.exprs[i] = archive::archived_ex(name, root);
288 unsigned int num_nodes = read_unsigned(is);
289 ar.nodes.resize(num_nodes, ar);
290 for (unsigned int i=0; i<num_nodes; i++)
296 /** Atomize a string (i.e. convert it into an ID number that uniquely
297 * represents the string). */
298 archive_atom archive::atomize(const std::string &s) const
300 // Search for string in atoms vector
301 std::vector<std::string>::const_iterator i = atoms.begin(), iend = atoms.end();
309 // Not found, add to atoms vector
314 /** Unatomize a string (i.e. convert the ID number back to the string). */
315 const std::string &archive::unatomize(archive_atom id) const
317 if (id >= atoms.size())
318 throw (std::range_error("archive::unatomizee(): atom ID out of range"));
324 /** Copy constructor of archive_node. */
325 archive_node::archive_node(const archive_node &other)
326 : a(other.a), props(other.props), has_expression(other.has_expression), e(other.e)
331 /** Assignment operator of archive_node. */
332 const archive_node &archive_node::operator=(const archive_node &other)
334 if (this != &other) {
337 has_expression = other.has_expression;
344 /** Recursively construct archive node from expression. */
345 archive_node::archive_node(archive &ar, const ex &expr)
346 : a(ar), has_expression(true), e(expr)
348 expr.bp->archive(*this);
352 /** Check if the archive_node stores the same expression as another
354 * @return "true" if expressions are the same */
355 bool archive_node::has_same_ex_as(const archive_node &other) const
357 if (!has_expression || !other.has_expression)
359 return e.bp == other.e.bp;
363 /** Add property of type "bool" to node. */
364 void archive_node::add_bool(const std::string &name, bool value)
366 props.push_back(property(a.atomize(name), PTYPE_BOOL, value));
369 /** Add property of type "unsigned int" to node. */
370 void archive_node::add_unsigned(const std::string &name, unsigned int value)
372 props.push_back(property(a.atomize(name), PTYPE_UNSIGNED, value));
375 /** Add property of type "string" to node. */
376 void archive_node::add_string(const std::string &name, const std::string &value)
378 props.push_back(property(a.atomize(name), PTYPE_STRING, a.atomize(value)));
381 /** Add property of type "ex" to node. */
382 void archive_node::add_ex(const std::string &name, const ex &value)
384 // Recursively create an archive_node and add its ID to the properties of this node
385 archive_node_id id = a.add_node(archive_node(a, value));
386 props.push_back(property(a.atomize(name), PTYPE_NODE, id));
390 /** Retrieve property of type "bool" from node.
391 * @return "true" if property was found, "false" otherwise */
392 bool archive_node::find_bool(const std::string &name, bool &ret) const
394 archive_atom name_atom = a.atomize(name);
395 std::vector<property>::const_iterator i = props.begin(), iend = props.end();
397 if (i->type == PTYPE_BOOL && i->name == name_atom) {
406 /** Retrieve property of type "unsigned" from node.
407 * @return "true" if property was found, "false" otherwise */
408 bool archive_node::find_unsigned(const std::string &name, unsigned int &ret) const
410 archive_atom name_atom = a.atomize(name);
411 std::vector<property>::const_iterator i = props.begin(), iend = props.end();
413 if (i->type == PTYPE_UNSIGNED && i->name == name_atom) {
422 /** Retrieve property of type "string" from node.
423 * @return "true" if property was found, "false" otherwise */
424 bool archive_node::find_string(const std::string &name, std::string &ret) const
426 archive_atom name_atom = a.atomize(name);
427 std::vector<property>::const_iterator i = props.begin(), iend = props.end();
429 if (i->type == PTYPE_STRING && i->name == name_atom) {
430 ret = a.unatomize(i->value);
438 /** Retrieve property of type "ex" from node.
439 * @return "true" if property was found, "false" otherwise */
440 bool archive_node::find_ex(const std::string &name, ex &ret, const lst &sym_lst, unsigned int index) const
442 archive_atom name_atom = a.atomize(name);
443 std::vector<property>::const_iterator i = props.begin(), iend = props.end();
444 unsigned int found_index = 0;
446 if (i->type == PTYPE_NODE && i->name == name_atom) {
447 if (found_index == index)
456 ret = a.get_node(i->value).unarchive(sym_lst);
461 /** Convert archive node to GiNaC expression. */
462 ex archive_node::unarchive(const lst &sym_lst) const
464 // Already unarchived? Then return cached unarchived expression.
468 // Find instantiation function for class specified in node
469 std::string class_name;
470 if (!find_string("class", class_name))
471 throw (std::runtime_error("archive node contains no class name"));
472 unarch_func f = find_unarch_func(class_name);
474 // Call instantiation function
475 e = f(*this, sym_lst);
476 has_expression = true;
481 /** Assignment operator of property. */
482 const archive_node::property &archive_node::property::operator=(const property &other)
484 if (this != &other) {
493 /** Clear all archived expressions. */
494 void archive::clear(void)
502 /** Delete cached unarchived expressions in all archive_nodes (mainly for debugging). */
503 void archive::forget(void)
505 std::vector<archive_node>::iterator i = nodes.begin(), iend = nodes.end();
512 /** Delete cached unarchived expressions from node (for debugging). */
513 void archive_node::forget(void)
515 has_expression = false;
520 /** Print archive to stream in ugly raw format (for debugging). */
521 void archive::printraw(std::ostream &os) const
526 std::vector<std::string>::const_iterator i = atoms.begin(), iend = atoms.end();
529 os << " " << id << " " << *i << std::endl;
536 os << "Expressions:\n";
538 std::vector<archived_ex>::const_iterator i = exprs.begin(), iend = exprs.end();
539 unsigned int index = 0;
541 os << " " << index << " \"" << unatomize(i->name) << "\" root node " << i->root << std::endl;
550 std::vector<archive_node>::const_iterator i = nodes.begin(), iend = nodes.end();
551 archive_node_id id = 0;
553 os << " " << id << " ";
560 /** Output archive_node to stream in ugly raw format (for debugging). */
561 void archive_node::printraw(std::ostream &os) const
563 // Dump cached unarchived expression
565 os << "(basic * " << e.bp << " = " << e << ")\n";
570 std::vector<property>::const_iterator i = props.begin(), iend = props.end();
574 case PTYPE_BOOL: os << "bool"; break;
575 case PTYPE_UNSIGNED: os << "unsigned"; break;
576 case PTYPE_STRING: os << "string"; break;
577 case PTYPE_NODE: os << "node"; break;
578 default: os << "<unknown>"; break;
580 os << " \"" << a.unatomize(i->name) << "\" " << i->value << std::endl;
585 /** Create a dummy archive. The intention is to fill archive_node's default
586 * ctor, which is currently a Cint-requirement. */
587 archive* archive_node::dummy_ar_creator(void)
589 static archive* some_ar = new archive;
594 #ifndef NO_NAMESPACE_GINAC
596 #endif // ndef NO_NAMESPACE_GINAC