ginac/archive.h

   1 /** @file archive.h
   2  *
   3  *  Archiving of GiNaC expressions. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
   7  *
   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.
  12  *
  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.
  17  *
  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
  21  */
  22
  23 #ifndef __GINAC_ARCHIVE_H__
  24 #define __GINAC_ARCHIVE_H__
  25
  26 #include "ex.h"
  27
  28 #include <string>
  29 #include <vector>
  30 #include <iostream>
  31
  32 namespace GiNaC {
  33
  34 class lst;
  35 class archive;
  36
  37
  38 /** Numerical ID value to refer to an archive_node. */
  39 typedef unsigned archive_node_id;
  40
  41 /** Numerical ID value to refer to a string. */
  42 typedef unsigned archive_atom;
  43
  44
  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. */
  48 class archive_node
  49 {
  50         friend std::ostream &operator<<(std::ostream &os, const archive_node &ar);
  51         friend std::istream &operator>>(std::istream &is, archive_node &ar);
  52
  53 public:
  54         /** Property data types */
  55         enum property_type {
  56                 PTYPE_BOOL,
  57                 PTYPE_UNSIGNED,
  58                 PTYPE_STRING,
  59                 PTYPE_NODE
  60         };
  61
  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 {
  66                 property_info() {}
  67                 property_info(property_type t, const std::string &n, unsigned c = 1) : type(t), name(n), count(c) {}
  68                 ~property_info() {}
  69
  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);
  72
  73                 property_type type;     /**< Data type of property. */
  74                 std::string name;   /**< Name of property. */
  75                 unsigned count;     /**< Number of occurrences. */
  76         };
  77         typedef std::vector<property_info> propinfovector;
  78
  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);
  82         ~archive_node() {}
  83
  84         archive_node(const archive_node &other);
  85         const archive_node &operator=(const archive_node &other);
  86
  87         /** Add property of type "bool" to node. */
  88         void add_bool(const std::string &name, bool value);
  89
  90         /** Add property of type "unsigned int" to node. */
  91         void add_unsigned(const std::string &name, unsigned value);
  92
  93         /** Add property of type "string" to node. */
  94         void add_string(const std::string &name, const std::string &value);
  95
  96         /** Add property of type "ex" to node. */
  97         void add_ex(const std::string &name, const ex &value);
  98
  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;
 102
 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;
 106
 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;
 110
 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;
 114
 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;
 118
 119         /** Return vector of properties stored in node. */
 120         void get_properties(propinfovector &v) const;
 121
 122         ex unarchive(const lst &sym_lst) const;
 123         bool has_same_ex_as(const archive_node &other) const;
 124
 125         void forget(void);
 126         void printraw(std::ostream &os) const;
 127
 128 private:
 129         static archive* dummy_ar_creator(void);
 130
 131         /** Archived property (data type, name and associated data) */
 132         struct property {
 133                 property() {}
 134                 property(archive_atom n, property_type t, unsigned v) : type(t), name(n), value(v) {}
 135                 ~property() {}
 136
 137                 property(const property &other) : type(other.type), name(other.name), value(other.value) {}
 138                 const property &operator=(const property &other);
 139
 140                 property_type type; /**< Data type of property. */
 141                 archive_atom name;  /**< Name of property. */
 142                 unsigned value; /**< Stored value. */
 143         };
 144
 145         /** Reference to the archive to which this node belongs. */
 146         archive &a;
 147
 148         /** Vector of stored properties. */
 149         std::vector<property> props;
 150
 151         /** Flag indicating whether a cached unarchived representation of this node exists. */
 152         mutable bool has_expression;
 153
 154         /** The cached unarchived representation of this node (if any). */
 155         mutable ex e;
 156 };
 157
 158
 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). */
 166 class archive
 167 {
 168         friend std::ostream &operator<<(std::ostream &os, const archive &ar);
 169         friend std::istream &operator>>(std::istream &is, archive &ar);
 170
 171 public:
 172         archive() {}
 173         ~archive() {}
 174
 175         /** Construct archive from expression using the default name "ex". */
 176         archive(const ex &e) {archive_ex(e, "ex");}
 177
 178         /** Construct archive from expression using the specified name. */
 179         archive(const ex &e, const char *n) {archive_ex(e, n);}
 180
 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);
 185
 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;
 189
 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;
 194
 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;
 200
 201         /** Return number of archived expressions. */
 202         unsigned num_expressions(void) const;
 203
 204         /** Return reference to top node of an expression specified by index. */
 205         const archive_node &get_top_node(unsigned index = 0) const;
 206
 207         /** Clear all archived expressions. */
 208         void clear(void);
 209
 210         archive_node_id add_node(const archive_node &n);
 211         archive_node &get_node(archive_node_id id);
 212
 213         void forget(void);
 214         void printraw(std::ostream &os) const;
 215
 216 private:
 217         /** Vector of archived nodes. */
 218         std::vector<archive_node> nodes;
 219
 220         /** Archived expression descriptor. */
 221         struct archived_ex {
 222                 archived_ex() {}
 223                 archived_ex(archive_atom n, archive_node_id node) : name(n), root(node) {}
 224
 225                 archive_atom name;              /**< Name of expression. */
 226                 archive_node_id root;   /**< ID of root node. */
 227         };
 228
 229         /** Vector of archived expression descriptors. */
 230         std::vector<archived_ex> exprs;
 231
 232 public:
 233         archive_atom atomize(const std::string &s) const;
 234         const std::string &unatomize(archive_atom id) const;
 235
 236 private:
 237         /** Vector of atomized strings (using a vector allows faster unarchiving). */
 238         mutable std::vector<std::string> atoms;
 239 };
 240
 241
 242 std::ostream &operator<<(std::ostream &os, const archive &ar);
 243 std::istream &operator>>(std::istream &is, archive &ar);
 244
 245
 246 } // namespace GiNaC
 247
 248 #endif // ndef __GINAC_ARCHIVE_H__