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__
38 /** Numerical ID value to refer to an archive_node. */
39 typedef unsigned int archive_node_id;
41 /** Numerical ID value to refer to a string. */
42 typedef unsigned int archive_atom;
45 /** This class stores all properties needed to record/retrieve the state
46 * of one object of class basic (or a derived class). Each property is
47 * addressed by its name and data type. */
50 friend std::ostream &operator<<(std::ostream &os, const archive_node &ar);
51 friend std::istream &operator>>(std::istream &is, archive_node &ar);
54 /** Property data types */
62 /** Information about a stored property. A vector of these structures
63 * is returned by get_properties().
64 * @see get_properties */
65 struct property_info {
67 property_info(property_type t, const std::string &n, unsigned c = 1) : type(t), name(n), count(c) {}
70 property_info(const property_info &other) : type(other.type), name(other.name), count(other.count) {}
71 const property_info &operator=(const property_info &other);
73 property_type type; /**< Data type of property. */
74 std::string name; /**< Name of property. */
75 unsigned count; /**< Number of occurrences. */
77 // Cint doesn't like vector<..,default_alloc> but malloc_alloc is
78 // unstandardized and not supported by newer GCCs.
79 #if defined(__GNUC__) && ((__GNUC__ == 2) && (__GNUC_MINOR__ < 97))
80 typedef std::vector<property_info,malloc_alloc> propinfovector;
82 typedef std::vector<ex> propinfovector;
85 archive_node() : a(*dummy_ar_creator()), has_expression(false) {} // hack for cint which always requires a default constructor
86 archive_node(archive &ar) : a(ar), has_expression(false) {}
87 archive_node(archive &ar, const ex &expr);
90 archive_node(const archive_node &other);
91 const archive_node &operator=(const archive_node &other);
93 /** Add property of type "bool" to node. */
94 void add_bool(const std::string &name, bool value);
96 /** Add property of type "unsigned int" to node. */
97 void add_unsigned(const std::string &name, unsigned int value);
99 /** Add property of type "string" to node. */
100 void add_string(const std::string &name, const std::string &value);
102 /** Add property of type "ex" to node. */
103 void add_ex(const std::string &name, const ex &value);
105 /** Retrieve property of type "bool" from node.
106 * @return "true" if property was found, "false" otherwise */
107 bool find_bool(const std::string &name, bool &ret) const;
109 /** Retrieve property of type "unsigned" from node.
110 * @return "true" if property was found, "false" otherwise */
111 bool find_unsigned(const std::string &name, unsigned int &ret) const;
113 /** Retrieve property of type "string" from node.
114 * @return "true" if property was found, "false" otherwise */
115 bool find_string(const std::string &name, std::string &ret) const;
117 /** Retrieve property of type "ex" from node.
118 * @return "true" if property was found, "false" otherwise */
119 bool find_ex(const std::string &name, ex &ret, const lst &sym_lst, unsigned int index = 0) const;
121 /** Retrieve property of type "ex" from node, returning the node of
122 * the sub-expression. */
123 const archive_node &find_ex_node(const std::string &name, unsigned int index = 0) const;
125 /** Return vector of properties stored in node. */
126 void get_properties(propinfovector &v) const;
128 ex unarchive(const lst &sym_lst) const;
129 bool has_same_ex_as(const archive_node &other) const;
132 void printraw(std::ostream &os) const;
135 static archive* dummy_ar_creator(void);
137 /** Archived property (data type, name and associated data) */
140 property(archive_atom n, property_type t, unsigned int v) : type(t), name(n), value(v) {}
143 property(const property &other) : type(other.type), name(other.name), value(other.value) {}
144 const property &operator=(const property &other);
146 property_type type; /**< Data type of property. */
147 archive_atom name; /**< Name of property. */
148 unsigned int value; /**< Stored value. */
151 /** Reference to the archive to which this node belongs. */
154 /** Vector of stored properties. */
155 std::vector<property> props;
157 /** Flag indicating whether a cached unarchived representation of this node exists. */
158 mutable bool has_expression;
160 /** The cached unarchived representation of this node (if any). */
165 /** This class holds archived versions of GiNaC expressions (class ex).
166 * An archive can be constructed from an expression and then written to
167 * a stream; or it can be read from a stream and then unarchived, yielding
168 * back the expression. Archives can hold multiple expressions which can
169 * be referred to by name or index number. The main component of the
170 * archive class is a vector of archive_nodes which each store one object
171 * of class basic (or a derived class). */
174 friend std::ostream &operator<<(std::ostream &os, const archive &ar);
175 friend std::istream &operator>>(std::istream &is, archive &ar);
181 /** Construct archive from expression using the default name "ex". */
182 archive(const ex &e) {archive_ex(e, "ex");}
184 /** Construct archive from expression using the specified name. */
185 archive(const ex &e, const char *n) {archive_ex(e, n);}
187 /** Archive an expression.
188 * @param e the expression to be archived
189 * @param name name under which the expression is stored */
190 void archive_ex(const ex &e, const char *name);
192 /** Retrieve expression from archive by name.
193 * @param sym_lst list of pre-defined symbols */
194 ex unarchive_ex(const lst &sym_lst, const char *name) const;
196 /** Retrieve expression from archive by index.
197 * @param sym_lst list of pre-defined symbols
198 * @see count_expressions */
199 ex unarchive_ex(const lst &sym_lst, unsigned int index = 0) const;
201 /** Retrieve expression and its name from archive by index.
202 * @param sym_lst list of pre-defined symbols
203 * @param name receives the name of the expression
204 * @see count_expressions */
205 ex unarchive_ex(const lst &sym_lst, std::string &name, unsigned int index = 0) const;
207 /** Return number of archived expressions. */
208 unsigned int num_expressions(void) const;
210 /** Return reference to top node of an expression specified by index. */
211 const archive_node &get_top_node(unsigned int index = 0) const;
213 /** Clear all archived expressions. */
216 archive_node_id add_node(const archive_node &n);
217 archive_node &get_node(archive_node_id id);
220 void printraw(std::ostream &os) const;
223 /** Vector of archived nodes. */
224 std::vector<archive_node> nodes;
226 /** Archived expression descriptor. */
229 archived_ex(archive_atom n, archive_node_id node) : name(n), root(node) {}
231 archive_atom name; /**< Name of expression. */
232 archive_node_id root; /**< ID of root node. */
235 /** Vector of archived expression descriptors. */
236 std::vector<archived_ex> exprs;
239 archive_atom atomize(const std::string &s) const;
240 const std::string &unatomize(archive_atom id) const;
243 /** Vector of atomized strings (using a vector allows faster unarchiving). */
244 mutable std::vector<std::string> atoms;
248 std::ostream &operator<<(std::ostream &os, const archive &ar);
249 std::istream &operator>>(std::istream &is, archive &ar);
254 #endif // ndef __GINAC_ARCHIVE_H__