lemon-0.x: comparison src/work/deba/graph

equal deleted inserted replaced

-:1bc79fcb3372
+:f503f5ab3c9e
 private:
 int line_num;
 };
-// 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))
 	  throw DataFormatException("Default Reader format exception");
 }
 };
+/// 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;
 value.clear();
 is >> ws;
 if (!is.get(c) || c != '\"')
 case 'v':
 	return '\v';
 case 'x':
 	{
 	  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);
 	  return code;
 	}
 default:
 	{
 	  int code;
-	  if (!isOct(c)) throw DataFormatException("Escape format exception");
+	  if (!isOct(c))
-	  else if (code = valueOct(c), !is.get(c) || !isOct(c)) is.putback(c);
+	    throw DataFormatException("Escape format exception");
-	  else if (code = code * 8 + valueOct(c), !is.get(c) || !isOct(c)) is.putback(c);
+	  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;
 	}
 }
 }
 static int valueOct(char c) {
 return c - '0';
 }
 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');
 }
 static int valueHex(char c) {
 if ('0' <= c && c <= '9') return c - '0';
 if ('a' <= c && c <= 'z') return c - 'a' + 10;
 }
 bool escaped;
 };
+/// \brief The graph reader class.
+///
+/// The reader class for the graph input.
+/// \see graph-io-page
-// Graph reader
 template <typename _Graph, typename _ReaderTraits = DefaultReaderTraits>
 class GraphReader {
 public:
 typedef _Graph Graph;
 typedef typename Graph::Edge Edge;
 typedef _ReaderTraits ReaderTraits;
 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() {
 for (typename NodeMapReaders::iterator it = node_map_readers.begin();
 	   it != node_map_readers.end(); ++it) {
 	delete it->second;
 	delete it->second;
 }
 }
-// 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) {
 return addNodeMap<typename ReaderTraits::template
 	Reader<typename Map::Value>, Map>(name, map);
 }
+/// \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,
 			     const Reader& reader = Reader()) {
 if (node_map_readers.find(name) != node_map_readers.end()) {
 	throw Exception() << "Multiple read rule for node map: " << name;
 node_map_readers.insert(
 make_pair(name, new MapReader<Node, Map, Reader>(map, reader)));
 return *this;
 }
+/// \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,
 			     const Reader& reader = Reader()) {
 if (node_map_readers.find(name) != node_map_readers.end()) {
 	throw Exception() << "Multiple read rule for node map: " << name;
 node_map_readers.insert(
 make_pair(name, new SkipReader<Node, Reader>(reader)));
 return *this;
 }
-// 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) {
 return addEdgeMap<typename ReaderTraits::template
 	Reader<typename Map::Value>, Map>(name, map);
 }
+/// \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,
 			     const Reader& reader = Reader()) {
 if (edge_map_readers.find(name) != edge_map_readers.end()) {
 	throw Exception() << "Multiple read rule for edge map: " << name;
 edge_map_readers.insert(
 make_pair(name, new MapReader<Edge, Map, Reader>(map, reader)));
 return *this;
 }
+/// \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,
 			     const Reader& reader = Reader()) {
 if (edge_map_readers.find(name) != edge_map_readers.end()) {
 	throw Exception() << "Multiple read rule for edge map: " << name;
 edge_map_readers.insert(
 make_pair(name, new SkipReader<Edge, Reader>(reader)));
 return *this;
 }
-// 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()) {
 	throw Exception() << "Multiple read rule for node";
 }
 node_readers.insert(make_pair(name, &node));
 return *this;
 }
-// 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()) {
 	throw Exception() << "Multiple read rule for edge";
 }
 edge_readers.insert(make_pair(name, &edge));
 return *this;
 }
-void read() {
+/// \brief Executes the reader commands.
+///
+/// Executes the reader commands.
+void run() {
 int line_num = 0;
 std::auto_ptr<InverterBase<Node> > nodeInverter;
 std::auto_ptr<InverterBase<Edge> > edgeInverter;
 try {
 	std::string line = readNotEmptyLine(is, line_num);

changeset 1139	f59038affc7e
parent 1115	444f69240539