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 int archive_node_id;
  40
  41 /** Numerical ID value to refer to a string. */
  42 typedef unsigned int 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
  78         archive_node() : a(*dummy_ar_creator()), has_expression(false) {} // hack for cint which always requires a default constructor
  79         archive_node(archive &ar) : a(ar), has_expression(false) {}
  80         archive_node(archive &ar, const ex &expr);
  81         ~archive_node() {}
  82
  83         archive_node(const archive_node &other);
  84         const archive_node &operator=(const archive_node &other);
  85
  86         /** Add property of type "bool" to node. */
  87         void add_bool(const std::string &name, bool value);
  88
  89         /** Add property of type "unsigned int" to node. */
  90         void add_unsigned(const std::string &name, unsigned int value);
  91
  92         /** Add property of type "string" to node. */
  93         void add_string(const std::string &name, const std::string &value);
  94
  95         /** Add property of type "ex" to node. */
  96         void add_ex(const std::string &name, const ex &value);
  97
  98         /** Retrieve property of type "bool" from node.
  99          *  @return "true" if property was found, "false" otherwise */
 100         bool find_bool(const std::string &name, bool &ret) const;
 101
 102         /** Retrieve property of type "unsigned" from node.
 103          *  @return "true" if property was found, "false" otherwise */
 104         bool find_unsigned(const std::string &name, unsigned int &ret) const;
 105
 106         /** Retrieve property of type "string" from node.
 107          *  @return "true" if property was found, "false" otherwise */
 108         bool find_string(const std::string &name, std::string &ret) const;
 109
 110         /** Retrieve property of type "ex" from node.
 111          *  @return "true" if property was found, "false" otherwise */
 112         bool find_ex(const std::string &name, ex &ret, const lst &sym_lst, unsigned int index = 0) const;
 113
 114         /** Retrieve property of type "ex" from node, returning the node of
 115          *  the sub-expression. */
 116         const archive_node &find_ex_node(const std::string &name, unsigned int index = 0) const;
 117
 118         /** Return vector of properties stored in node. */
 119         void get_properties(std::vector<property_info> &v) const;
 120
 121         ex unarchive(const lst &sym_lst) const;
 122         bool has_same_ex_as(const archive_node &other) const;
 123
 124         void forget(void);
 125         void printraw(std::ostream &os) const;
 126
 127 private:
 128         static archive* dummy_ar_creator(void);
 129
 130         /** Archived property (data type, name and associated data) */
 131         struct property {
 132                 property() {}
 133                 property(archive_atom n, property_type t, unsigned int v) : type(t), name(n), value(v) {}
 134                 ~property() {}
 135
 136                 property(const property &other) : type(other.type), name(other.name), value(other.value) {}
 137                 const property &operator=(const property &other);
 138
 139                 property_type type; /**< Data type of property. */
 140                 archive_atom name;  /**< Name of property. */
 141                 unsigned int value; /**< Stored value. */
 142         };
 143
 144         /** Reference to the archive to which this node belongs. */
 145         archive &a;
 146
 147         /** Vector of stored properties. */
 148         std::vector<property> props;
 149
 150         /** Flag indicating whether a cached unarchived representation of this node exists. */
 151         mutable bool has_expression;
 152
 153         /** The cached unarchived representation of this node (if any). */
 154         mutable ex e;
 155 };
 156
 157
 158 /** This class holds archived versions of GiNaC expressions (class ex).
 159  *  An archive can be constructed from an expression and then written to
 160  *  a stream; or it can be read from a stream and then unarchived, yielding
 161  *  back the expression. Archives can hold multiple expressions which can
 162  *  be referred to by name or index number. The main component of the
 163  *  archive class is a vector of archive_nodes which each store one object
 164  *  of class basic (or a derived class). */
 165 class archive
 166 {
 167         friend std::ostream &operator<<(std::ostream &os, const archive &ar);
 168         friend std::istream &operator>>(std::istream &is, archive &ar);
 169
 170 public:
 171         archive() {}
 172         ~archive() {}
 173
 174         /** Construct archive from expression using the default name "ex". */
 175         archive(const ex &e) {archive_ex(e, "ex");}
 176
 177         /** Construct archive from expression using the specified name. */
 178         archive(const ex &e, const char *n) {archive_ex(e, n);}
 179
 180         /** Archive an expression.
 181          *  @param e the expression to be archived
 182          *  @param name name under which the expression is stored */
 183         void archive_ex(const ex &e, const char *name);
 184
 185         /** Retrieve expression from archive by name.
 186          *  @param sym_lst list of pre-defined symbols */
 187         ex unarchive_ex(const lst &sym_lst, const char *name) const;
 188
 189         /** Retrieve expression from archive by index.
 190          *  @param sym_lst list of pre-defined symbols
 191      *  @see count_expressions */
 192         ex unarchive_ex(const lst &sym_lst, unsigned int index = 0) const;
 193
 194         /** Retrieve expression and its name from archive by index.
 195          *  @param sym_lst list of pre-defined symbols
 196          *  @param name receives the name of the expression
 197      *  @see count_expressions */
 198         ex unarchive_ex(const lst &sym_lst, std::string &name, unsigned int index = 0) const;
 199
 200         /** Return number of archived expressions. */
 201         unsigned int num_expressions(void) const;
 202
 203         /** Return reference to top node of an expression specified by index. */
 204         const archive_node &get_top_node(unsigned int index = 0) const;
 205
 206         /** Clear all archived expressions. */
 207         void clear(void);
 208
 209         archive_node_id add_node(const archive_node &n);
 210         archive_node &get_node(archive_node_id id);
 211
 212         void forget(void);
 213         void printraw(std::ostream &os) const;
 214
 215 private:
 216         /** Vector of archived nodes. */
 217         std::vector<archive_node> nodes;
 218
 219         /** Archived expression descriptor. */
 220         struct archived_ex {
 221                 archived_ex() {}
 222                 archived_ex(archive_atom n, archive_node_id node) : name(n), root(node) {}
 223
 224                 archive_atom name;              /**< Name of expression. */
 225                 archive_node_id root;   /**< ID of root node. */
 226         };
 227
 228         /** Vector of archived expression descriptors. */
 229         std::vector<archived_ex> exprs;
 230
 231 public:
 232         archive_atom atomize(const std::string &s) const;
 233         const std::string &unatomize(archive_atom id) const;
 234
 235 private:
 236         /** Vector of atomized strings (using a vector allows faster unarchiving). */
 237         mutable std::vector<std::string> atoms;
 238 };
 239
 240
 241 std::ostream &operator<<(std::ostream &os, const archive &ar);
 242 std::istream &operator>>(std::istream &is, archive &ar);
 243
 244
 245 } // namespace GiNaC
 246
 247 #endif // ndef __GINAC_ARCHIVE_H__