DEADSOFTWARE

Document fold.h and textmodel.h, and add a destructor
[odcread.git] / textmodel.h
index abfe13d24f6c6ad38b2dae6a333c05d88aa076c8..8eb26eb47d419c2a2d2b7d5e30765161e4898d91 100644 (file)
@@ -16,11 +16,23 @@ namespace odc {
                virtual const std::string &getTypeName() const;
 
                TextModel(INTEGER id);
+               /**
+                * Just calls super and reads the version and checks that its in the allowed range.
+                */
                virtual void internalize(Reader &reader);
        };
 
+       /**
+        * A TextPiece is just a component of an StdTextModel.
+        * It has a certain length in bytes, which is known construction time (due
+        * to meta-data in the StdTextModel header) and contents which are read
+        * later.
+        */
        class TextPiece {
                public:
+               /**
+                * The number of bytes that will be read.
+                */
                const size_t d_len;
                TextPiece(size_t len);
                virtual void read(Reader &reader) = 0;
@@ -28,6 +40,10 @@ namespace odc {
                virtual void accept(Visitor &visitor) const = 0;
        };
 
+       /**
+        * TextPiece consisting of 16-bit characters.
+        * Not sure of the encoding.
+        */
        class LongPiece : public TextPiece {
                private:
                CHAR *d_buf;
@@ -36,10 +52,17 @@ namespace odc {
                ~LongPiece();
                virtual void read(Reader &reader);
                virtual std::string toString() const;
+               /**
+                * Return the text contained in this piece.
+                * Currently just casting the buffer to wchar_t* and hoping for the best.
+                */
                virtual std::wstring getText() const;
                virtual void accept(Visitor &visitor) const;
        };
 
+       /**
+        * TextPiece consisting of 8-bit characters.
+        */
        class ShortPiece : public TextPiece {
                private:
                SHORTCHAR *d_buf;
@@ -52,15 +75,23 @@ namespace odc {
                virtual void accept(Visitor &visitor) const;
        };
 
+       /**
+        * TextPiece that embeds a View.
+        */
        class ViewPiece : public TextPiece {
                Store *d_view;
                public:
                ViewPiece(Store *view);
+               ~ViewPiece();
                virtual void read(Reader &reader);
                virtual std::string toString() const;
                virtual void accept(Visitor &visitor) const;
        };
 
+       /**
+        * Default implementation of a TextModel.
+        * Essentially it is a series of TextPieces.
+        */
        class StdTextModel : public TextModel {
                private:
                static const TypeProxy<StdTextModel, TextModel> PROXY;
@@ -71,6 +102,11 @@ namespace odc {
                virtual const std::string &getTypeName() const;
 
                StdTextModel(INTEGER id);
+               /**
+                * Calls super and reads the version and checks that its in the allowed range.
+                * Then the text model meta-data is read, including information on all the pieces.
+                * After reading the meta-data, the pieces themselves are read.
+                */
                virtual void internalize(Reader &reader);
 
                virtual std::string toString();