3 * Archiving of GiNaC expressions. */
6 * GiNaC Copyright (C) 1999-2015 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(archive &ar) : a(ar), has_expression(false) {}
87 archive_node(archive &ar, const ex &expr);
89 const archive_node &operator=(const archive_node &other);
91 /** Add property of type "bool" to node. */
92 void add_bool(const std::string &name, bool value);
94 /** Add property of type "unsigned int" to node. */
95 void add_unsigned(const std::string &name, unsigned value);
97 /** Add property of type "string" to node. */
98 void add_string(const std::string &name, const std::string &value);
100 /** Add property of type "ex" to node. */
101 void add_ex(const std::string &name, const ex &value);
103 /** Retrieve property of type "bool" from node.
104 * @return "true" if property was found, "false" otherwise */
105 bool find_bool(const std::string &name, bool &ret, unsigned index = 0) const;
107 /** Retrieve property of type "unsigned" from node.
108 * @return "true" if property was found, "false" otherwise */
109 bool find_unsigned(const std::string &name, unsigned &ret, unsigned index = 0) const;
111 /** Retrieve property of type "string" from node.
112 * @return "true" if property was found, "false" otherwise */
113 bool find_string(const std::string &name, std::string &ret, unsigned index = 0) const;
115 /** Find the location in the vector of properties of the first/last
116 * property with a given name. */
117 archive_node_cit find_first(const std::string &name) const;
118 archive_node_cit find_last(const std::string &name) const;
120 /** Retrieve property of type "ex" from node.
121 * @return "true" if property was found, "false" otherwise */
122 bool find_ex(const std::string &name, ex &ret, lst &sym_lst, unsigned index = 0) const;
124 /** Retrieve property of type "ex" from the node if it is known
125 * that this node in fact contains such a property at the given
126 * location. This is much more efficient than the preceding function. */
127 void find_ex_by_loc(archive_node_cit loc, ex &ret, lst &sym_lst) const;
129 /** Retrieve property of type "ex" from node, returning the node of
130 * the sub-expression. */
131 const archive_node &find_ex_node(const std::string &name, unsigned index = 0) const;
133 /** Return vector of properties stored in node. */
134 void get_properties(propinfovector &v) const;
136 ex unarchive(lst &sym_lst) const;
137 bool has_same_ex_as(const archive_node &other) const;
138 bool has_ex() const {return has_expression;}
139 ex get_ex() const {return e;}
142 void printraw(std::ostream &os) const;
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). */
158 typedef basic* (*synthesize_func)();
159 typedef std::map<std::string, synthesize_func> unarchive_map_t;
161 class unarchive_table_t
164 static unarchive_map_t* unarch_map;
167 ~unarchive_table_t();
168 synthesize_func find(const std::string& classname) const;
169 void insert(const std::string& classname, synthesize_func f);
171 static unarchive_table_t unarch_table_instance;
173 /** Helper macros to register a class with (un)archiving (a.k.a.
174 * (de)serialization).
178 * GINAC_DECLARE_UNARCHIVER(myclass);
180 * into the header file (in the global or namespace scope), and
182 * GINAC_BIND_UNARCHIVER(myclass);
184 * into the source file.
186 * Effect: the `myclass' (being a class derived directly or indirectly
187 * from GiNaC::basic) can be archived and unarchived.
189 * Note: you need to use GINAC_{DECLARE,BIND}_UNARCHIVER incantations
190 * in order to make your class (un)archivable _even if your class does
191 * not overload `read_archive' method_. Sorry for inconvenience.
195 * The `basic' class has a `read_archive' virtual method which reads an
196 * expression from archive. Derived classes can overload that method.
197 * There's a small problem, though. On unarchiving all we have is a set
198 * of named byte streams. In C++ the class name (as written in the source
199 * code) has nothing to do with its actual type. Thus, we need establish
200 * a correspondence ourselves. To do so we maintain a `class_name' =>
201 * `function_pointer' table (see the unarchive_table_t class above).
202 * Every function in this table is supposed to create a new object of
203 * the `class_name' type. The `archive_node' class uses that table to
204 * construct an object of correct type. Next it invokes read_archive
205 * virtual method of newly created object, which does the actual job.
207 * Note: this approach is very simple-minded (it does not handle classes
208 * with same names from different namespaces, multiple inheritance, etc),
209 * but it happens to work surprisingly well.
211 #define GINAC_DECLARE_UNARCHIVER(classname) \
212 class classname ## _unarchiver \
214 static int usecount; \
216 static GiNaC::basic* create(); \
217 classname ## _unarchiver(); \
218 ~ classname ## _unarchiver(); \
220 static classname ## _unarchiver classname ## _unarchiver_instance
222 #define GINAC_BIND_UNARCHIVER(classname) \
223 classname ## _unarchiver::classname ## _unarchiver() \
225 static GiNaC::unarchive_table_t table; \
226 if (usecount++ == 0) { \
227 table.insert(std::string(#classname), \
228 &(classname ## _unarchiver::create)); \
231 GiNaC::basic* classname ## _unarchiver::create() \
233 return new classname(); \
235 classname ## _unarchiver::~ classname ## _unarchiver() { } \
236 int classname ## _unarchiver::usecount = 0
239 /** This class holds archived versions of GiNaC expressions (class ex).
240 * An archive can be constructed from an expression and then written to
241 * a stream; or it can be read from a stream and then unarchived, yielding
242 * back the expression. Archives can hold multiple expressions which can
243 * be referred to by name or index number. The main component of the
244 * archive class is a vector of archive_nodes which each store one object
245 * of class basic (or a derived class). */
248 friend std::ostream &operator<<(std::ostream &os, const archive &ar);
249 friend std::istream &operator>>(std::istream &is, archive &ar);
255 /** Construct archive from expression using the default name "ex". */
256 archive(const ex &e) {archive_ex(e, "ex");}
258 /** Construct archive from expression using the specified name. */
259 archive(const ex &e, const char *n) {archive_ex(e, n);}
261 /** Archive an expression.
262 * @param e the expression to be archived
263 * @param name name under which the expression is stored */
264 void archive_ex(const ex &e, const char *name);
266 /** Retrieve expression from archive by name.
267 * @param sym_lst list of pre-defined symbols
268 * @param name name of expression */
269 ex unarchive_ex(const lst &sym_lst, const char *name) const;
271 /** Retrieve expression from archive by index.
272 * @param sym_lst list of pre-defined symbols
273 * @param index index of expression
274 * @see count_expressions */
275 ex unarchive_ex(const lst &sym_lst, unsigned index = 0) const;
277 /** Retrieve expression and its name from archive by index.
278 * @param sym_lst list of pre-defined symbols
279 * @param name receives the name of the expression
280 * @param index index of expression
281 * @see count_expressions */
282 ex unarchive_ex(const lst &sym_lst, std::string &name, unsigned index = 0) const;
284 /** Return number of archived expressions. */
285 unsigned num_expressions() const;
287 /** Return reference to top node of an expression specified by index. */
288 const archive_node &get_top_node(unsigned index = 0) const;
290 /** Clear all archived expressions. */
293 archive_node_id add_node(const archive_node &n);
294 archive_node &get_node(archive_node_id id);
297 void printraw(std::ostream &os) const;
300 /** Vector of archived nodes. */
301 std::vector<archive_node> nodes;
303 /** Archived expression descriptor. */
306 archived_ex(archive_atom n, archive_node_id node) : name(n), root(node) {}
308 archive_atom name; /**< Name of expression. */
309 archive_node_id root; /**< ID of root node. */
312 /** Vector of archived expression descriptors. */
313 std::vector<archived_ex> exprs;
316 archive_atom atomize(const std::string &s) const;
317 const std::string &unatomize(archive_atom id) const;
320 /** Vector of atomized strings (using a vector allows faster unarchiving). */
321 mutable std::vector<std::string> atoms;
322 /** The map of from strings to indices of the atoms vectors allows for
325 typedef std::map<std::string, archive_atom>::const_iterator inv_at_cit;
326 mutable std::map<std::string, archive_atom> inverse_atoms;
328 /** Map of stored expressions to nodes for faster archiving */
329 typedef std::map<ex, archive_node_id, ex_is_less>::iterator mapit;
330 mutable std::map<ex, archive_node_id, ex_is_less> exprtable;
334 std::ostream &operator<<(std::ostream &os, const archive &ar);
335 std::istream &operator>>(std::istream &is, archive &ar);
339 #endif // ndef GINAC_ARCHIVE_H