3 * Archiving of GiNaC expressions. */
6 * GiNaC Copyright (C) 1999-2007 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #ifndef __GINAC_ARCHIVE_H__
24 #define __GINAC_ARCHIVE_H__
38 /** Numerical ID value to refer to an archive_node. */
39 typedef unsigned archive_node_id;
41 /** Numerical ID value to refer to a string. */
42 typedef unsigned 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) {}
69 property_type type; /**< Data type of property. */
70 std::string name; /**< Name of property. */
71 unsigned count; /**< Number of occurrences. */
73 typedef std::vector<property_info> propinfovector;
75 /** Archived property (data type, name and associated data) */
78 property(archive_atom n, property_type t, unsigned v) : type(t), name(n), value(v) {}
80 property_type type; /**< Data type of property. */
81 archive_atom name; /**< Name of property. */
82 unsigned value; /**< Stored value. */
84 typedef std::vector<property>::const_iterator archive_node_cit;
86 archive_node() : a(*dummy_ar_creator()), has_expression(false) {} // hack for cint which always requires a default constructor
87 archive_node(archive &ar) : a(ar), has_expression(false) {}
88 archive_node(archive &ar, const ex &expr);
90 const archive_node &operator=(const archive_node &other);
92 /** Add property of type "bool" to node. */
93 void add_bool(const std::string &name, bool value);
95 /** Add property of type "unsigned int" to node. */
96 void add_unsigned(const std::string &name, unsigned value);
98 /** Add property of type "string" to node. */
99 void add_string(const std::string &name, const std::string &value);
101 /** Add property of type "ex" to node. */
102 void add_ex(const std::string &name, const ex &value);
104 /** Retrieve property of type "bool" from node.
105 * @return "true" if property was found, "false" otherwise */
106 bool find_bool(const std::string &name, bool &ret, unsigned index = 0) const;
108 /** Retrieve property of type "unsigned" from node.
109 * @return "true" if property was found, "false" otherwise */
110 bool find_unsigned(const std::string &name, unsigned &ret, unsigned index = 0) const;
112 /** Retrieve property of type "string" from node.
113 * @return "true" if property was found, "false" otherwise */
114 bool find_string(const std::string &name, std::string &ret, unsigned index = 0) const;
116 /** Find the location in the vector of properties of the first/last
117 * property with a given name. */
118 archive_node_cit find_first(const std::string &name) const;
119 archive_node_cit find_last(const std::string &name) const;
121 /** Retrieve property of type "ex" from node.
122 * @return "true" if property was found, "false" otherwise */
123 bool find_ex(const std::string &name, ex &ret, lst &sym_lst, unsigned index = 0) const;
125 /** Retrieve property of type "ex" from the node if it is known
126 * that this node in fact contains such a property at the given
127 * location. This is much more efficient than the preceding function. */
128 void find_ex_by_loc(archive_node_cit loc, ex &ret, lst &sym_lst) const;
130 /** Retrieve property of type "ex" from node, returning the node of
131 * the sub-expression. */
132 const archive_node &find_ex_node(const std::string &name, unsigned index = 0) const;
134 /** Return vector of properties stored in node. */
135 void get_properties(propinfovector &v) const;
137 ex unarchive(lst &sym_lst) const;
138 bool has_same_ex_as(const archive_node &other) const;
139 bool has_ex() const {return has_expression;}
140 ex get_ex() const {return e;}
143 void printraw(std::ostream &os) const;
146 static archive* dummy_ar_creator();
148 /** Reference to the archive to which this node belongs. */
151 /** Vector of stored properties. */
152 std::vector<property> props;
154 /** Flag indicating whether a cached unarchived representation of this node exists. */
155 mutable bool has_expression;
157 /** The cached unarchived representation of this node (if any). */
162 /** This class holds archived versions of GiNaC expressions (class ex).
163 * An archive can be constructed from an expression and then written to
164 * a stream; or it can be read from a stream and then unarchived, yielding
165 * back the expression. Archives can hold multiple expressions which can
166 * be referred to by name or index number. The main component of the
167 * archive class is a vector of archive_nodes which each store one object
168 * of class basic (or a derived class). */
171 friend std::ostream &operator<<(std::ostream &os, const archive &ar);
172 friend std::istream &operator>>(std::istream &is, archive &ar);
178 /** Construct archive from expression using the default name "ex". */
179 archive(const ex &e) {archive_ex(e, "ex");}
181 /** Construct archive from expression using the specified name. */
182 archive(const ex &e, const char *n) {archive_ex(e, n);}
184 /** Archive an expression.
185 * @param e the expression to be archived
186 * @param name name under which the expression is stored */
187 void archive_ex(const ex &e, const char *name);
189 /** Retrieve expression from archive by name.
190 * @param sym_lst list of pre-defined symbols
191 * @param name name of expression */
192 ex unarchive_ex(const lst &sym_lst, const char *name) const;
194 /** Retrieve expression from archive by index.
195 * @param sym_lst list of pre-defined symbols
196 * @param index index of expression
197 * @see count_expressions */
198 ex unarchive_ex(const lst &sym_lst, unsigned index = 0) const;
200 /** Retrieve expression and its name from archive by index.
201 * @param sym_lst list of pre-defined symbols
202 * @param name receives the name of the expression
203 * @param index index of expression
204 * @see count_expressions */
205 ex unarchive_ex(const lst &sym_lst, std::string &name, unsigned index = 0) const;
207 /** Return number of archived expressions. */
208 unsigned num_expressions() const;
210 /** Return reference to top node of an expression specified by index. */
211 const archive_node &get_top_node(unsigned 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;
245 /** The map of from strings to indices of the atoms vectors allows for
248 typedef std::map<std::string, archive_atom>::const_iterator inv_at_cit;
249 mutable std::map<std::string, archive_atom> inverse_atoms;
251 /** Map of stored expressions to nodes for faster archiving */
252 typedef std::map<ex, archive_node_id, ex_is_less>::iterator mapit;
253 mutable std::map<ex, archive_node_id, ex_is_less> exprtable;
257 std::ostream &operator<<(std::ostream &os, const archive &ar);
258 std::istream &operator>>(std::istream &is, archive &ar);
263 #endif // ndef __GINAC_ARCHIVE_H__