store.h

   1 #ifndef _STORE_H_
   2 #define _STORE_H_
   3
   4 #include <oberon.h>
   5 #include <domain.h>
   6 #include <typeregister.h>
   7
   8 #include <string>
   9 #include <vector>
  10
  11 namespace odc {
  12         class Reader; // forward decl
  13
  14         class TypePath : public std::vector<std::string> {
  15                 public:
  16                 std::string toString() const;
  17         };
  18
  19         /**
  20          * TYPE Store
  21          * ABSTRACT
  22          * Storable extensible data types like Views.View or TextModels.Text are derived from Store.
  23          * Stores are typically allocated by suitable directories, e.g., Views.Directory or TextModels.Directory.
  24          * Stores are used as base types for all objects that must be both extensible and persistent.
  25          */
  26         class Store {
  27         private:
  28                 static const std::string TYPENAME;
  29                 static const TypeProxy<Store> PROXY;
  30
  31                 INTEGER d_id;
  32
  33         public:
  34                 static const SHORTCHAR NEWBASE = 0xF0; // (* new base type (level = 0), i.e. not yet in dict *)
  35                 static const SHORTCHAR NEWEXT = 0xF1;  // (* new extension type (level = 1), i.e. not yet in dict *)
  36                 static const SHORTCHAR OLDTYPE = 0xF2; // (* old type, i.e. already in dict *)
  37                 static const SHORTCHAR NIL = 0x80;     // (* nil store *)
  38                 static const SHORTCHAR LINK = 0x81;    // (* link to another elem in same file *)
  39                 static const SHORTCHAR STORE = 0x82;   // (* general store *)
  40                 static const SHORTCHAR ELEM = 0x83;    // (* elem store *)
  41                 static const SHORTCHAR NEWLINK = 0x84; // (* link to another non-elem store in same file *)
  42
  43                 Store(INTEGER id);
  44
  45                 INTEGER getId();
  46
  47                 /**
  48                  * Get the TypeName of this object.
  49                  * @see TypeRegister
  50                  */
  51                 static const std::string &getType();
  52                 /**
  53                  * Get the TypeName of the supertype of this object. Return 0 pointer if no supertype.
  54                  * @see TypeRegister
  55                  */
  56                 static const std::string *getSuper();
  57                 /**
  58                  * Get the TypeName for this object.
  59                  */
  60                 virtual const std::string &getTypeName() const;
  61                 /**
  62                  * Get the TypePath to this object's type.
  63                  * @see TypePath
  64                  */
  65                 void getTypePath(TypePath *path) const;
  66
  67                 /**
  68                  * PROCEDURE (s: Store) Domain (): Domain
  69                  * NEW
  70                  * A store may be associated with a domain. This is done by the procedure InitDomain, which assigns a domain to the store.
  71                  * Domain may be called by arbitrary clients.
  72                  */
  73                 //Domain* getDomain();
  74
  75                 /**
  76                  * PROCEDURE (s: Store) CopyFrom- (source: Store)
  77                  * NEW, EMPTY
  78                  * Copy the contents of source to s. Copying is a deep copy.
  79                  *
  80                  * Pre
  81                  * source # NIL guaranteed
  82                  * TYP(source) = TYP(s) guaranteed
  83                  * s.Domain() = NIL     guaranteed
  84                  * s is not yet initialized     guaranteed
  85                  */
  86                 // FIXME
  87                 /**
  88                  * PROCEDURE (s: Store) Internalize- (VAR rd: Reader)
  89                  * NEW, EMPTY
  90                  * (For backward compatibility, this method is actually still EXTENSIBLE. This may change in the future.)
  91                  * Reads the contents of s from reader rd. Internalize must read the same (amount of) data as is written by the corresponding Externalize procedure.
  92                  * Internalize is called locally.
  93                  * Internalize is extended by various persistent object types, e.g., models, views, and controllers.
  94                  *
  95                  * Pre
  96                  * source.Domain() = NIL        guaranteed
  97                  * source is not yet initialized        guaranteed
  98                  */
  99                  virtual void internalize(Reader &reader);
 100 //      PROCEDURE (s: Store) Internalize- (VAR rd: Reader), NEW, EXTENSIBLE;
 101 //              VAR thisVersion: INTEGER;
 102 //      BEGIN
 103 //              rd.ReadVersion(minVersion, maxStoreVersion, thisVersion);
 104 //              IF ~rd.cancelled & s.isElem THEN
 105 //                      rd.ReadVersion(minVersion, maxStoreVersion, thisVersion)
 106 //                      (* works since maxStoreVersion = maxElemVersion = 0 in pre-1.3 *)
 107 //              END
 108 //      END Internalize;
 109 //              }
 110
 111                 /**
 112                  * PROCEDURE (s: Store) Externalize- (VAR wr: Writer)
 113                  * NEW, EMPTY
 114                  * (For backward compatibility, this method is actually still EXTENSIBLE. This may change in the future.)
 115                  * Write the contents of s to writer wr. Externalize must write the same (amount of) data as is read by the corresponding Internalize procedure.
 116                  * Externalize ist called locally.
 117                  * Externalize is extended by various persistent object types, e.g., models, views, and controllers.
 118                  */
 119                 // FIXME
 120
 121                 /**
 122                  * PROCEDURE (s: Store) ExternalizeAs- (VAR s1: Store)
 123                  * NEW, EMPTY
 124                  * Before a store's Externalize procedure is called, its ExternalizeAs procedure is called, which gives the store the opportunity to denote another store that should be externalized in its place (a "proxy"). It is also possible to set s1 to NIL, which means that the store should not be externalized at all. This is used e.g. for compiler error markers, which are never stored.
 125                  * ExternalizeAs ist called locally.
 126                  *
 127                  * Pre
 128                  * s1 = s       guaranteed
 129                  */
 130                 // FIXME
 131
 132                 virtual std::string toString();
 133                 virtual std::string toPlainText();
 134
 135                 private:
 136                 void calcTypePath(TypePath * out, const std::string &name) const;
 137         };
 138
 139         class Elem : public Store {
 140                 private:
 141                 static const std::string TYPENAME;
 142                 static const TypeProxy<Elem> PROXY;
 143
 144                 public:
 145                 Elem(INTEGER id);
 146
 147                 /**
 148                  * Get the TypeName of this object.
 149                  * @see TypeRegister
 150                  */
 151                 static const std::string &getType();
 152                 /**
 153                  * Get the TypeName of the supertype of this object. Return 0 pointer if no supertype.
 154                  * @see TypeRegister
 155                  */
 156                 static const std::string *getSuper();
 157                 /**
 158                  * Get the TypeName for this object.
 159                  */
 160                 virtual const std::string &getTypeName() const;
 161
 162                 virtual void internalize(Reader &reader);
 163         };
 164
 165         class Model : public Elem {
 166                 private:
 167                 static const std::string TYPENAME;
 168                 static const TypeProxy<Model> PROXY;
 169
 170                 public:
 171                 Model(INTEGER id);
 172
 173                 /**
 174                  * Get the TypeName of this object.
 175                  * @see TypeRegister
 176                  */
 177                 static const std::string &getType();
 178                 /**
 179                  * Get the TypeName of the supertype of this object. Return 0 pointer if no supertype.
 180                  * @see TypeRegister
 181                  */
 182                 static const std::string *getSuper();
 183                 /**
 184                  * Get the TypeName for this object.
 185                  */
 186                 virtual const std::string &getTypeName() const;
 187
 188                 virtual void internalize(Reader &reader);
 189         };
 190
 191         class ContainerModel : public Model {
 192                 private:
 193                 static const std::string TYPENAME;
 194                 static const TypeProxy<ContainerModel> PROXY;
 195
 196                 public:
 197                 ContainerModel(INTEGER id);
 198                 static const std::string &getType();
 199                 static const std::string *getSuper();
 200                 virtual const std::string &getTypeName() const;
 201                 virtual void internalize(Reader &reader);
 202         };
 203 }
 204
 205 #endif // _STORE_H_