Changeset 1133:9fd485470fee in lemon-0.x for src/work/deba/graph_reader.h

Timestamp:

02/07/05 11:48:14 (19 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1532

Message:

Documentation

File:

• src/work/deba/graph_reader.h (modified) (16 diffs)

src/work/deba/graph_reader.h

@@ -74 +74 @@
 
 
-  // Readers and ReaderTraits
   /// \brief Standard ReaderTraits for the GraphReader class.
   ///
-  /// 
- 
+  /// Standard ReaderTraits for the GraphReader class.
+  /// It defines standard reading method for all type of value. 
   struct DefaultReaderTraits {
 
+    /// \brief Template class for reading an value.
+    ///
+    /// Template class for reading an value.
     template <typename _Value>
     struct Reader {
+      /// The value type.
       typedef _Value Value;
+      /// \brief Reads a value from the given stream.
+      ///
+      /// Reads a value from the given stream.
       void read(std::istream& is, Value& value) {
         if (!(is >> value)) 
@@ -90 +96 @@
     };
 
+    /// The reader class for the not needed maps.
     typedef Reader<std::string> DefaultReader;
 
   };
 
+  /// \brief Reader class for quoted strings.
+  ///
+  /// Reader class for quoted strings. It can process the escape
+  /// sequences in the string.
   class QuotedStringReader {
   public:
     typedef std::string Value;
-
+    
+    /// \brief Constructor for the reader.
+    ///
+    /// Constructor for the reader. If the given parameter is true
+    /// the reader processes the escape sequences.
     QuotedStringReader(bool _escaped = true) : escaped(_escaped) {}
-
+    
+    /// \brief Reads a quoted string from the given stream.
+    ///
+    /// Reads a quoted string from the given stream.
     void read(std::istream& is, std::string& value) {
       char c;
@@ -146 +164 @@
         {
           int code;
-          if (!is.get(c) || !isHex(c)) throw DataFormatException("Escape format exception");
+          if (!is.get(c) || !isHex(c)) 
+            throw DataFormatException("Escape format exception");
           else if (code = valueHex(c), !is.get(c) || !isHex(c)) is.putback(c);
           else code = code * 16 + valueHex(c);
@@ -154 +173 @@
         {
           int code;
-          if (!isOct(c)) throw DataFormatException("Escape format exception");
-          else if (code = valueOct(c), !is.get(c) || !isOct(c)) is.putback(c);
-          else if (code = code * 8 + valueOct(c), !is.get(c) || !isOct(c)) is.putback(c);
+          if (!isOct(c)) 
+            throw DataFormatException("Escape format exception");
+          else if (code = valueOct(c), !is.get(c) || !isOct(c)) 
+            is.putback(c);
+          else if (code = code * 8 + valueOct(c), !is.get(c) || !isOct(c)) 
+            is.putback(c);
           else code = code * 8 + valueOct(c);
           return code;
@@ -172 +194 @@
 
    static bool isHex(char c) {
-      return ('0' <= c && c <= '9') || ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z'); 
+      return ('0' <= c && c <= '9') || 
+        ('a' <= c && c <= 'z') || 
+        ('A' <= c && c <= 'Z'); 
     }
     
@@ -184 +208 @@
   };
 
-
-
-
-
-  // Graph reader
-  
+  /// \brief The graph reader class.
+  ///
+  /// The reader class for the graph input.
+  /// \see graph-io-page
   template <typename _Graph, typename _ReaderTraits = DefaultReaderTraits> 
   class GraphReader {
@@ -201 +223 @@
     typedef typename ReaderTraits::DefaultReader DefaultReader;
 
+    /// \brief Construct a new GraphReader.
+    ///
+    /// Construct a new GraphReader. It reads from the given map,
+    /// it constructs the given map and it use the given reader as the
+    /// default skipper.
     GraphReader(std::istream& _is, Graph& _graph, 
                 const DefaultReader& _reader = DefaultReader()) 
       : is(_is), graph(_graph), nodeSkipper(_reader), edgeSkipper(_reader) {}
 
-
+    /// \brief Destruct the graph reader.
+    ///
+    /// Destruct the graph reader.
     ~GraphReader() {
 
@@ -220 +249 @@
     }
 
-    // Node map rules
-
+    /// \brief Add a new node map reader command for the reader.
+    ///
+    /// Add a new node map reader command for the reader.
     template <typename Map>
     GraphReader& addNodeMap(std::string name, Map& map) {
@@ -228 +258 @@
     }
 
+    /// \brief Add a new node map reader command for the reader.
+    ///
+    /// Add a new node map reader command for the reader.
     template <typename Reader, typename Map>
     GraphReader& addNodeMap(std::string name, Map& map, 
@@ -239 +272 @@
     }
 
+    /// \brief Add a new node map skipper command for the reader.
+    ///
+    /// Add a new node map skipper command for the reader.
     template <typename Reader>
     GraphReader& skipNodeMap(std::string name, 
@@ -250 +286 @@
     }
 
-    // Edge map rules
-
+    /// \brief Add a new edge map reader command for the reader.
+    ///
+    /// Add a new edge map reader command for the reader.
     template <typename Map>
     GraphReader& addEdgeMap(std::string name, Map& map) { 
@@ -259 +296 @@
 
 
+    /// \brief Add a new edge map reader command for the reader.
+    ///
+    /// Add a new edge map reader command for the reader.
     template <typename Reader, typename Map>
     GraphReader& addEdgeMap(std::string name, Map& map,
@@ -270 +310 @@
     }
 
+    /// \brief Add a new edge map skipper command for the reader.
+    ///
+    /// Add a new edge map skipper command for the reader.
     template <typename Reader>
     GraphReader& skipEdgeMap(std::string name,
@@ -281 +324 @@
     }
 
-    // Node rules
+    /// \brief Add a new labeled node reader for the reader.
+    ///
+    /// Add a new labeled node reader for the reader.
     GraphReader& addNode(std::string name, Node& node) {
       if (node_readers.find(name) != node_readers.end()) {
@@ -290 +335 @@
     }
 
-    // Edge rules
-
+    /// \brief Add a new labeled edge reader for the reader.
+    ///
+    /// Add a new labeled edge reader for the reader.
     GraphReader& addEdge(std::string name, Edge& edge) {
       if (edge_readers.find(name) != edge_readers.end()) {
@@ -300 +346 @@
     }
 
-    void read() {
+    /// \brief Executes the reader commands.
+    ///
+    /// Executes the reader commands.
+    void run() {
       int line_num = 0;
       std::auto_ptr<InverterBase<Node> > nodeInverter;