3 * Archiving of GiNaC expressions. */
6 * GiNaC Copyright (C) 1999-2002 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 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) {}
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 typedef std::vector<property_info> propinfovector;
79 archive_node() : a(*dummy_ar_creator()), has_expression(false) {} // hack for cint which always requires a default constructor
80 archive_node(archive &ar) : a(ar), has_expression(false) {}
81 archive_node(archive &ar, const ex &expr);
84 archive_node(const archive_node &other);
85 const archive_node &operator=(const archive_node &other);
87 /** Add property of type "bool" to node. */
88 void add_bool(const std::string &name, bool value);
90 /** Add property of type "unsigned int" to node. */
91 void add_unsigned(const std::string &name, unsigned value);
93 /** Add property of type "string" to node. */
94 void add_string(const std::string &name, const std::string &value);
96 /** Add property of type "ex" to node. */
97 void add_ex(const std::string &name, const ex &value);
99 /** Retrieve property of type "bool" from node.
100 * @return "true" if property was found, "false" otherwise */
101 bool find_bool(const std::string &name, bool &ret, unsigned index = 0) const;
103 /** Retrieve property of type "unsigned" from node.
104 * @return "true" if property was found, "false" otherwise */
105 bool find_unsigned(const std::string &name, unsigned &ret, unsigned index = 0) const;
107 /** Retrieve property of type "string" from node.
108 * @return "true" if property was found, "false" otherwise */
109 bool find_string(const std::string &name, std::string &ret, unsigned index = 0) const;
111 /** Retrieve property of type "ex" from node.
112 * @return "true" if property was found, "false" otherwise */
113 bool find_ex(const std::string &name, ex &ret, const lst &sym_lst, unsigned index = 0) const;
115 /** Retrieve property of type "ex" from node, returning the node of
116 * the sub-expression. */
117 const archive_node &find_ex_node(const std::string &name, unsigned index = 0) const;
119 /** Return vector of properties stored in node. */
120 void get_properties(propinfovector &v) const;
122 ex unarchive(const lst &sym_lst) const;
123 bool has_same_ex_as(const archive_node &other) const;
126 void printraw(std::ostream &os) const;
129 static archive* dummy_ar_creator(void);
131 /** Archived property (data type, name and associated data) */
134 property(archive_atom n, property_type t, unsigned v) : type(t), name(n), value(v) {}
137 property(const property &other) : type(other.type), name(other.name), value(other.value) {}
138 const property &operator=(const property &other);
140 property_type type; /**< Data type of property. */
141 archive_atom name; /**< Name of property. */
142 unsigned value; /**< Stored value. */
145 /** Reference to the archive to which this node belongs. */
148 /** Vector of stored properties. */
149 std::vector<property> props;
151 /** Flag indicating whether a cached unarchived representation of this node exists. */
152 mutable bool has_expression;
154 /** The cached unarchived representation of this node (if any). */
159 /** This class holds archived versions of GiNaC expressions (class ex).
160 * An archive can be constructed from an expression and then written to
161 * a stream; or it can be read from a stream and then unarchived, yielding
162 * back the expression. Archives can hold multiple expressions which can
163 * be referred to by name or index number. The main component of the
164 * archive class is a vector of archive_nodes which each store one object
165 * of class basic (or a derived class). */
168 friend std::ostream &operator<<(std::ostream &os, const archive &ar);
169 friend std::istream &operator>>(std::istream &is, archive &ar);
175 /** Construct archive from expression using the default name "ex". */
176 archive(const ex &e) {archive_ex(e, "ex");}
178 /** Construct archive from expression using the specified name. */
179 archive(const ex &e, const char *n) {archive_ex(e, n);}
181 /** Archive an expression.
182 * @param e the expression to be archived
183 * @param name name under which the expression is stored */
184 void archive_ex(const ex &e, const char *name);
186 /** Retrieve expression from archive by name.
187 * @param sym_lst list of pre-defined symbols */
188 ex unarchive_ex(const lst &sym_lst, const char *name) const;
190 /** Retrieve expression from archive by index.
191 * @param sym_lst list of pre-defined symbols
192 * @see count_expressions */
193 ex unarchive_ex(const lst &sym_lst, unsigned index = 0) const;
195 /** Retrieve expression and its name from archive by index.
196 * @param sym_lst list of pre-defined symbols
197 * @param name receives the name of the expression
198 * @see count_expressions */
199 ex unarchive_ex(const lst &sym_lst, std::string &name, unsigned index = 0) const;
201 /** Return number of archived expressions. */
202 unsigned num_expressions(void) const;
204 /** Return reference to top node of an expression specified by index. */
205 const archive_node &get_top_node(unsigned index = 0) const;
207 /** Clear all archived expressions. */
210 archive_node_id add_node(const archive_node &n);
211 archive_node &get_node(archive_node_id id);
214 void printraw(std::ostream &os) const;
217 /** Vector of archived nodes. */
218 std::vector<archive_node> nodes;
220 /** Archived expression descriptor. */
223 archived_ex(archive_atom n, archive_node_id node) : name(n), root(node) {}
225 archive_atom name; /**< Name of expression. */
226 archive_node_id root; /**< ID of root node. */
229 /** Vector of archived expression descriptors. */
230 std::vector<archived_ex> exprs;
233 archive_atom atomize(const std::string &s) const;
234 const std::string &unatomize(archive_atom id) const;
237 /** Vector of atomized strings (using a vector allows faster unarchiving). */
238 mutable std::vector<std::string> atoms;
242 std::ostream &operator<<(std::ostream &os, const archive &ar);
243 std::istream &operator>>(std::istream &is, archive &ar);
248 #endif // ndef __GINAC_ARCHIVE_H__