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
23 #ifndef __GINAC_ARCHIVE_H__
24 #define __GINAC_ARCHIVE_H__
32 #ifndef NO_NAMESPACE_GINAC
34 #endif // ndef NO_NAMESPACE_GINAC
40 /** Numerical ID value to refer to an archive_node. */
41 typedef unsigned int archive_node_id;
43 /** Numerical ID value to refer to a string. */
44 typedef unsigned int archive_atom;
47 /** This class stores all properties needed to record/retrieve the state
48 * of one object of class basic (or a derived class). Each property is
49 * addressed by its name and data type. */
52 friend std::ostream &operator<<(std::ostream &os, const archive_node &ar);
53 friend std::istream &operator>>(std::istream &is, archive_node &ar);
56 archive_node() : a(*dummy_ar_creator()), has_expression(false) {} // hack for cint which always requires a default constructor
57 archive_node(archive &ar) : a(ar), has_expression(false) {}
58 archive_node(archive &ar, const ex &expr);
61 archive_node(const archive_node &other);
62 const archive_node &operator=(const archive_node &other);
64 bool has_same_ex_as(const archive_node &other) const;
66 void add_bool(const std::string &name, bool value);
67 void add_unsigned(const std::string &name, unsigned int value);
68 void add_string(const std::string &name, const std::string &value);
69 void add_ex(const std::string &name, const ex &value);
71 bool find_bool(const std::string &name, bool &ret) const;
72 bool find_unsigned(const std::string &name, unsigned int &ret) const;
73 bool find_string(const std::string &name, std::string &ret) const;
74 bool find_ex(const std::string &name, ex &ret, const lst &sym_lst, unsigned int index = 0) const;
76 ex unarchive(const lst &sym_lst) const;
79 void printraw(std::ostream &os) const;
82 static archive* dummy_ar_creator(void);
84 /** Property data types */
92 /** Archived property (data type, name and associated data) */
95 property(archive_atom n, property_type t, unsigned int v) : type(t), name(n), value(v) {}
98 property(const property &other) : type(other.type), name(other.name), value(other.value) {}
99 const property &operator=(const property &other);
101 property_type type; /**< Data type of property. */
102 archive_atom name; /**< Name of property. */
103 unsigned int value; /**< Stored value. */
106 /** Reference to the archive to which this node belongs. */
109 /** Vector of stored properties. */
110 std::vector<property> props;
112 /** Flag indicating whether a cached unarchived representation of this node exists. */
113 mutable bool has_expression;
115 /** The cached unarchived representation of this node (if any). */
120 /** This class holds archived versions of GiNaC expressions (class ex).
121 * An archive can be constructed from an expression and then written to
122 * a stream; or it can be read from a stream and then unarchived, yielding
123 * back the expression. Archives can hold multiple expressions which can
124 * be referred to by name or index number. The main component of the
125 * archive class is a vector of archive_nodes which each store one object
126 * of class basic (or a derived class). */
129 friend std::ostream &operator<<(std::ostream &os, const archive &ar);
130 friend std::istream &operator>>(std::istream &is, archive &ar);
136 /** Construct archive from expression using the default name "ex". */
137 archive(const ex &e) {archive_ex(e, "ex");}
139 /** Construct archive from expression using the specified name. */
140 archive(const ex &e, const char *n) {archive_ex(e, n);}
142 archive_node_id add_node(const archive_node &n);
143 archive_node &get_node(archive_node_id id);
145 void archive_ex(const ex &e, const char *name);
146 ex unarchive_ex(const lst &sym_lst, const char *name) const;
147 ex unarchive_ex(const lst &sym_lst, unsigned int index = 0) const;
148 ex unarchive_ex(const lst &sym_lst, std::string &name, unsigned int index = 0) const;
149 unsigned int num_expressions(void) const;
154 void printraw(std::ostream &os) const;
157 /** Vector of archived nodes. */
158 std::vector<archive_node> nodes;
160 /** Archived expression descriptor. */
163 archived_ex(archive_atom n, archive_node_id node) : name(n), root(node) {}
165 archive_atom name; /**< Name of expression. */
166 archive_node_id root; /**< ID of root node. */
169 /** Vector of archived expression descriptors. */
170 std::vector<archived_ex> exprs;
173 archive_atom atomize(const std::string &s) const;
174 const std::string &unatomize(archive_atom id) const;
177 /** Vector of atomized strings (using a vector allows faster unarchiving). */
178 mutable std::vector<std::string> atoms;
182 std::ostream &operator<<(std::ostream &os, const archive &ar);
183 std::istream &operator>>(std::istream &is, archive &ar);
186 #ifndef NO_NAMESPACE_GINAC
188 #endif // ndef NO_NAMESPACE_GINAC
190 #endif // ndef __GINAC_ARCHIVE_H__