RhodeCode

 *

 * Permission to use, modify and distribute this software is granted

 * provided that this copyright notice appears in all copies. For

 * precise terms see the accompanying LICENSE file.

 *

 * This software is provided "AS IS" with no warranty of any kind,

 * express or implied, and with no claim as to its suitability for any

 * purpose.

 *

 */

///\ingroup lemon_io

///\file

///\brief \ref lgf-format "LEMON Graph Format" reader.

#ifndef LEMON_LGF_READER_H

#define LEMON_LGF_READER_H

#include <iostream>

#include <fstream>

#include <sstream>

#include <set>

#include <map>

#include <lemon/core.h>

#include <lemon/lgf_writer.h>

#include <lemon/concept_check.h>

#include <lemon/concepts/maps.h>

namespace lemon {

  namespace _reader_bits {

    template <typename Value>

    struct DefaultConverter {

      Value operator()(const std::string& str) {

        std::istringstream is(str);

        Value value;

        if (!(is >> value)) {

          throw FormatError("Cannot read token");

        }

        char c;

        if (is >> std::ws >> c) {

          throw FormatError("Remaining characters in token");

        }

        return value;

      }

    };

    template <>

    struct DefaultConverter<std::string> {

      std::string operator()(const std::string& str) {

        return str;

      }

    };

    template <typename _Item>

    class MapStorageBase {

    public:

      typedef _Item Item;

    public:

      MapStorageBase() {}

      virtual ~MapStorageBase() {}

      virtual void set(const Item& item, const std::string& value) = 0;

    };

    template <typename _Item, typename _Map,

              typename _Converter = DefaultConverter<typename _Map::Value> >

    class MapStorage : public MapStorageBase<_Item> {

    public:

      typedef _Map Map;

      typedef _Converter Converter;

      typedef _Item Item;

    private:

      Map& _map;

      Converter _converter;

    public:

      MapStorage(Map& map, const Converter& converter = Converter())

        : _map(map), _converter(converter) {}

      virtual ~MapStorage() {}

      virtual void set(const Item& item ,const std::string& value) {

        _map.set(item, _converter(value));

      }

    };

              typename _Converter = DefaultConverter<typename _Map::Value> >

    public:

      typedef _Map Map;

      typedef _Converter Converter;

      static const bool dir = _dir;

    private:

      Map& _map;

      Converter _converter;

    public:

                         const Converter& converter = Converter())

        : _graph(graph), _map(map), _converter(converter) {}

      virtual ~GraphArcMapStorage() {}

      virtual void set(const Item& item ,const std::string& value) {

        _map.set(_graph.direct(item, dir), _converter(value));

      }

    };

    class ValueStorageBase {

    public:

      ValueStorageBase() {}

      virtual ~ValueStorageBase() {}

      virtual void set(const std::string&) = 0;

    };

    template <typename _Value, typename _Converter = DefaultConverter<_Value> >

    class ValueStorage : public ValueStorageBase {

    public:

      typedef _Value Value;

      typedef _Converter Converter;

    private:

      Value& _value;

      Converter _converter;

    public:

      ValueStorage(Value& value, const Converter& converter = Converter())

        : _value(value), _converter(converter) {}

      virtual void set(const std::string& value) {

        _value = _converter(value);

      }

    };

    template <typename Value>

    struct MapLookUpConverter {

      const std::map<std::string, Value>& _map;

      MapLookUpConverter(const std::map<std::string, Value>& map)

        : _map(map) {}

      Value operator()(const std::string& str) {

        typename std::map<std::string, Value>::const_iterator it =

          _map.find(str);

        if (it == _map.end()) {

          std::ostringstream msg;

          msg << "Item not found: " << str;

          throw FormatError(msg.str());

        }

        return it->second;

      }

    };

    struct GraphArcLookUpConverter {

                              const std::map<std::string,

        : _graph(graph), _map(map) {}

        if (str.empty() || (str[0] != '+' && str[0] != '-')) {

          throw FormatError("Item must start with '+' or '-'");

        }

          ::const_iterator it = _map.find(str.substr(1));

        if (it == _map.end()) {

          throw FormatError("Item not found");

        }

        return _graph.direct(it->second, str[0] == '+');

      }

    };

    inline bool isWhiteSpace(char c) {

      return c == ' ' || c == '\t' || c == '\v' ||

        c == '\n' || c == '\r' || c == '\f';

    }

    inline bool isOct(char c) {

      return '0' <= c && c <='7';

    }

    inline int valueOct(char c) {

      LEMON_ASSERT(isOct(c), "The character is not octal.");

      return c - '0';

    }

    inline bool isHex(char c) {

      return ('0' <= c && c <= '9') ||

        ('a' <= c && c <= 'z') ||

        ('A' <= c && c <= 'Z');

    }

    inline int valueHex(char c) {

      LEMON_ASSERT(isHex(c), "The character is not hexadecimal.");

      if ('0' <= c && c <= '9') return c - '0';

      if ('a' <= c && c <= 'z') return c - 'a' + 10;

      return c - 'A' + 10;

    }

    inline bool isIdentifierFirstChar(char c) {

      return ('a' <= c && c <= 'z') ||

        ('A' <= c && c <= 'Z') || c == '_';

    }

    inline bool isIdentifierChar(char c) {

      return isIdentifierFirstChar(c) ||

        ('0' <= c && c <= '9');

    }

    inline char readEscape(std::istream& is) {

      char c;

      if (!is.get(c))

        throw FormatError("Escape format error");

      switch (c) {

      case '\\':

        return '\\';

      case '\"':

        return '\"';

      case '\'':

        return '\'';

      case '\?':

        return '\?';

      case 'a':

        return '\a';

      case 'b':

        return '\b';

      case 'f':

        return '\f';

      case 'n':

        return '\n';

      case 'r':

        return '\r';

      case 't':

        return '\t';

      case 'v':

        return '\v';

      case 'x':

        {

          int code;

          if (!is.get(c) || !isHex(c))

            throw FormatError("Escape format error");

          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 FormatError("Escape format error");

          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;

        }

      }

    }

      if (!is.get(c))

        return is;

      if (c == '\"') {

        while (is.get(c) && c != '\"') {

          if (c == '\\')

            c = readEscape(is);

          os << c;

        }

        if (!is)

          throw FormatError("Quoted format error");

      } else {

        is.putback(c);

        while (is.get(c) && !isWhiteSpace(c)) {

          if (c == '\\')

            c = readEscape(is);

          os << c;

        }

        if (!is) {

          is.clear();

        } else {

          is.putback(c);

        }

      }

      str = os.str();

      return is;

    }

    class Section {

    public:

      virtual ~Section() {}

      virtual void process(std::istream& is, int& line_num) = 0;

    };

    template <typename Functor>

    class LineSection : public Section {

    private:

      Functor _functor;

    public:

      LineSection(const Functor& functor) : _functor(functor) {}

      virtual ~LineSection() {}

      virtual void process(std::istream& is, int& line_num) {

        char c;

        std::string line;

        while (is.get(c) && c != '@') {

          if (c == '\n') {

            ++line_num;

          } else if (c == '#') {

            getline(is, line);

            ++line_num;

          } else if (!isWhiteSpace(c)) {

            is.putback(c);

            getline(is, line);

            _functor(line);

            ++line_num;

          }

        }

        if (is) is.putback(c);

        else if (is.eof()) is.clear();

      }

    };

    template <typename Functor>

    class StreamSection : public Section {

    private:

      Functor _functor;

    public:

      StreamSection(const Functor& functor) : _functor(functor) {}

      virtual ~StreamSection() {}

      virtual void process(std::istream& is, int& line_num) {

        _functor(is, line_num);

        char c;

        std::string line;

        while (is.get(c) && c != '@') {

          if (c == '\n') {

            ++line_num;

          } else if (!isWhiteSpace(c)) {

            getline(is, line);

            ++line_num;

          }

        }

        if (is) is.putback(c);

        else if (is.eof()) is.clear();

      }

    };

  }

  class DigraphReader;

  /// \ingroup lemon_io

  ///

  /// \brief \ref lgf-format "LGF" reader for directed graphs

  ///

  /// This utility reads an \ref lgf-format "LGF" file.

  ///

  /// The reading method does a batch processing. The user creates a

  /// reader object, then various reading rules can be added to the

  /// reader, and eventually the reading is executed with the \c run()

  /// member function. A map reading rule can be added to the reader

  /// with the \c nodeMap() or \c arcMap() members. An optional

  /// converter parameter can also be added as a standard functor

  /// converting from \c std::string to the value type of the map. If it

  /// is set, it will determine how the tokens in the file should be

  /// converted to the value type of the map. If the functor is not set,

  /// then a default conversion will be used. One map can be read into

  /// multiple map objects at the same time. The \c attribute(), \c

  /// node() and \c arc() functions are used to add attribute reading

  /// rules.

  ///

  ///\code

  ///   nodeMap("coordinates", coord_map).

  ///   arcMap("capacity", cap_map).

  ///   node("source", src).

  ///   node("target", trg).

  ///   attribute("caption", caption).

  ///   run();

  ///\endcode

  ///

  /// By default the reader uses the first section in the file of the

  /// proper type. If a section has an optional name, then it can be

  /// selected for reading by giving an optional name parameter to the

  /// \c nodes(), \c arcs() or \c attributes() functions.

  ///

  /// The \c useNodes() and \c useArcs() functions are used to tell the reader

  /// that the nodes or arcs should not be constructed (added to the

  /// graph) during the reading, but instead the label map of the items

  /// are given as a parameter of these functions. An

  /// application of these functions is multipass reading, which is

  /// important if two \c \@arcs sections must be read from the

  /// file. In this case the first phase would read the node set and one

  /// of the arc sets, while the second phase would read the second arc

  /// set into an \e ArcSet class (\c SmartArcSet or \c ListArcSet).

  /// The previously read label node map should be passed to the \c

  /// useNodes() functions. Another application of multipass reading when

  /// paths are given as a node map or an arc map.

  /// It is impossible to read this in

  /// a single pass, because the arcs are not constructed when the node

  /// maps are read.

  class DigraphReader {

  public:

  private:

    std::istream* _is;

    bool local_is;

    std::string _filename;

    std::string _nodes_caption;

    std::string _arcs_caption;

    std::string _attributes_caption;

    typedef std::map<std::string, Node> NodeIndex;

    NodeIndex _node_index;

    typedef std::map<std::string, Arc> ArcIndex;

    ArcIndex _arc_index;

    typedef std::vector<std::pair<std::string,

      _reader_bits::MapStorageBase<Node>*> > NodeMaps;

    NodeMaps _node_maps;

    typedef std::vector<std::pair<std::string,

      _reader_bits::MapStorageBase<Arc>*> >ArcMaps;

    ArcMaps _arc_maps;

    typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>

      Attributes;

    Attributes _attributes;

    bool _use_nodes;

    bool _use_arcs;

    bool _skip_nodes;

    bool _skip_arcs;

    int line_num;

    std::istringstream line;

  public:

    /// \brief Constructor

    ///

    /// Construct a directed graph reader, which reads from the given

    /// input stream.

      : _is(&is), local_is(false), _digraph(digraph),

        _use_nodes(false), _use_arcs(false),

        _skip_nodes(false), _skip_arcs(false) {}

    /// \brief Constructor

    ///

    /// Construct a directed graph reader, which reads from the given

    /// file.

      : _is(new std::ifstream(fn.c_str())), local_is(true),

        _filename(fn), _digraph(digraph),

        _use_nodes(false), _use_arcs(false),

        _skip_nodes(false), _skip_arcs(false) {

      if (!(*_is)) {

        delete _is;

        throw IoError("Cannot open file", fn);

      }

    }

    /// \brief Constructor

    ///

    /// Construct a directed graph reader, which reads from the given

    /// file.

      : _is(new std::ifstream(fn)), local_is(true),

        _filename(fn), _digraph(digraph),

        _use_nodes(false), _use_arcs(false),

        _skip_nodes(false), _skip_arcs(false) {

      if (!(*_is)) {

        delete _is;

        throw IoError("Cannot open file", fn);

      }

    }

    /// \brief Destructor

    ~DigraphReader() {

      for (typename NodeMaps::iterator it = _node_maps.begin();

           it != _node_maps.end(); ++it) {

        delete it->second;

      }

      for (typename ArcMaps::iterator it = _arc_maps.begin();

           it != _arc_maps.end(); ++it) {

        delete it->second;

      }

      for (typename Attributes::iterator it = _attributes.begin();

           it != _attributes.end(); ++it) {

        delete it->second;

      }

      if (local_is) {

        delete _is;

      }

    }

  private:

    DigraphReader(DigraphReader& other)

      : _is(other._is), local_is(other.local_is), _digraph(other._digraph),

        _use_nodes(other._use_nodes), _use_arcs(other._use_arcs),

        _skip_nodes(other._skip_nodes), _skip_arcs(other._skip_arcs) {

      other._is = 0;

      other.local_is = false;

      _node_index.swap(other._node_index);

      _arc_index.swap(other._arc_index);

      _node_maps.swap(other._node_maps);

      _arc_maps.swap(other._arc_maps);

      _attributes.swap(other._attributes);

      _nodes_caption = other._nodes_caption;

      _arcs_caption = other._arcs_caption;

      _attributes_caption = other._attributes_caption;

    }

    DigraphReader& operator=(const DigraphReader&);

  public:

    /// \name Reading rules

    /// @{

    /// \brief Node map reading rule

    ///

    /// Add a node map reading rule to the reader.

    template <typename Map>

    DigraphReader& nodeMap(const std::string& caption, Map& map) {

      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();

      _reader_bits::MapStorageBase<Node>* storage =

        new _reader_bits::MapStorage<Node, Map>(map);

      _node_maps.push_back(std::make_pair(caption, storage));

      return *this;

    }

    /// \brief Node map reading rule

    ///

    /// Add a node map reading rule with specialized converter to the

    /// reader.

    template <typename Map, typename Converter>

    DigraphReader& nodeMap(const std::string& caption, Map& map,

                           const Converter& converter = Converter()) {

      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();

      _reader_bits::MapStorageBase<Node>* storage =

        new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);

      _node_maps.push_back(std::make_pair(caption, storage));

      return *this;

    }

    /// \brief Arc map reading rule

    ///

    /// Add an arc map reading rule to the reader.

    template <typename Map>

    DigraphReader& arcMap(const std::string& caption, Map& map) {

      checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();

      _reader_bits::MapStorageBase<Arc>* storage =

        new _reader_bits::MapStorage<Arc, Map>(map);

      _arc_maps.push_back(std::make_pair(caption, storage));

      return *this;

    }

    /// \brief Arc map reading rule

    ///

    /// Add an arc map reading rule with specialized converter to the

    /// reader.

    template <typename Map, typename Converter>

    DigraphReader& arcMap(const std::string& caption, Map& map,

                          const Converter& converter = Converter()) {

      checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();

      _reader_bits::MapStorageBase<Arc>* storage =

        new _reader_bits::MapStorage<Arc, Map, Converter>(map, converter);

      _arc_maps.push_back(std::make_pair(caption, storage));

      return *this;

    }

    /// \brief Attribute reading rule

    ///

    /// Add an attribute reading rule to the reader.

    template <typename Value>

    DigraphReader& attribute(const std::string& caption, Value& value) {

      _reader_bits::ValueStorageBase* storage =

        new _reader_bits::ValueStorage<Value>(value);

      _attributes.insert(std::make_pair(caption, storage));

      return *this;

    }

    /// \brief Attribute reading rule

    ///

    /// Add an attribute reading rule with specialized converter to the

    /// reader.

        {

          typename Attributes::iterator it = _attributes.lower_bound(attr);

          while (it != _attributes.end() && it->first == attr) {

            it->second->set(token);

            ++it;

          }

        }

      }

      if (readSuccess()) {

        line.putback(c);

      }

      for (typename Attributes::iterator it = _attributes.begin();

           it != _attributes.end(); ++it) {

        if (read_attr.find(it->first) == read_attr.end()) {

          std::ostringstream msg;

          msg << "Attribute not found: " << it->first;

          throw FormatError(msg.str());

        }

      }

    }

  public:

    /// \name Execution of the reader

    /// @{

    /// \brief Start the batch processing

    ///

    /// This function starts the batch processing

    void run() {

      LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");

      bool nodes_done = _skip_nodes;

      bool arcs_done = _skip_arcs;

      bool attributes_done = false;

      line_num = 0;

      readLine();

      skipSection();

      while (readSuccess()) {

        try {

          char c;

          std::string section, caption;

          line >> c;

          _reader_bits::readToken(line, section);

          _reader_bits::readToken(line, caption);

          if (line >> c)

            throw FormatError("Extra character at the end of line");

          if (section == "nodes" && !nodes_done) {

            if (_nodes_caption.empty() || _nodes_caption == caption) {

              readNodes();

              nodes_done = true;

            }

          } else if ((section == "arcs" || section == "edges") &&

                     !arcs_done) {

            if (_arcs_caption.empty() || _arcs_caption == caption) {

              readArcs();

              arcs_done = true;

            }

          } else if (section == "attributes" && !attributes_done) {

            if (_attributes_caption.empty() || _attributes_caption == caption) {

              readAttributes();

              attributes_done = true;

            }

          } else {

            readLine();

            skipSection();

          }

        } catch (FormatError& error) {

          error.line(line_num);

          error.file(_filename);

          throw;

        }

      }

      if (!nodes_done) {

        throw FormatError("Section @nodes not found");

      }

      if (!arcs_done) {

        throw FormatError("Section @arcs not found");

      }

      if (!attributes_done && !_attributes.empty()) {

        throw FormatError("Section @attributes not found");

      }

    }

    /// @}

  };

  /// \brief Return a \ref DigraphReader class

  ///

  /// This function just returns a \ref DigraphReader class.

  /// \relates DigraphReader

    return tmp;

  }

  /// \brief Return a \ref DigraphReader class

  ///

  /// This function just returns a \ref DigraphReader class.

  /// \relates DigraphReader

    return tmp;

  }

  class GraphReader;

  /// \ingroup lemon_io

  ///

  /// \brief \ref lgf-format "LGF" reader for undirected graphs

  ///

  /// This utility reads an \ref lgf-format "LGF" file.

  ///

  /// It can be used almost the same way as \c DigraphReader.

  /// The only difference is that this class can handle edges and

  /// edge maps as well as arcs and arc maps.

  ///

  /// The columns in the \c \@edges (or \c \@arcs) section are the

  /// edge maps. However, if there are two maps with the same name

  /// prefixed with \c '+' and \c '-', then these can be read into an

  /// arc map.  Similarly, an attribute can be read into an arc, if

  /// it's value is an edge label prefixed with \c '+' or \c '-'.

  template <typename GR>

  class GraphReader {

  public:

    typedef GR Graph;

  private:

    std::istream* _is;

    bool local_is;

    std::string _filename;

    std::string _nodes_caption;

    std::string _edges_caption;

    std::string _attributes_caption;

    typedef std::map<std::string, Node> NodeIndex;

    NodeIndex _node_index;

    typedef std::map<std::string, Edge> EdgeIndex;

    EdgeIndex _edge_index;

    typedef std::vector<std::pair<std::string,

      _reader_bits::MapStorageBase<Node>*> > NodeMaps;

    NodeMaps _node_maps;

    typedef std::vector<std::pair<std::string,

      _reader_bits::MapStorageBase<Edge>*> > EdgeMaps;

    EdgeMaps _edge_maps;

    typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>

      Attributes;

    Attributes _attributes;

    bool _use_nodes;

    bool _use_edges;

    bool _skip_nodes;

    bool _skip_edges;

    int line_num;

    std::istringstream line;

  public:

    /// \brief Constructor

    ///

    /// Construct an undirected graph reader, which reads from the given

    /// input stream.

      : _is(&is), local_is(false), _graph(graph),

        _use_nodes(false), _use_edges(false),

        _skip_nodes(false), _skip_edges(false) {}

    /// \brief Constructor

    ///

    /// Construct an undirected graph reader, which reads from the given

    /// file.

      : _is(new std::ifstream(fn.c_str())), local_is(true),

        _filename(fn), _graph(graph),

        _use_nodes(false), _use_edges(false),

        _skip_nodes(false), _skip_edges(false) {

      if (!(*_is)) {

        delete _is;

        throw IoError("Cannot open file", fn);

      }

    }

    /// \brief Constructor

    ///

    /// Construct an undirected graph reader, which reads from the given

    /// file.

      : _is(new std::ifstream(fn)), local_is(true),

        _filename(fn), _graph(graph),

        _use_nodes(false), _use_edges(false),

        _skip_nodes(false), _skip_edges(false) {

      if (!(*_is)) {

        delete _is;

        throw IoError("Cannot open file", fn);

      }

    }

    /// \brief Destructor

    ~GraphReader() {

      for (typename NodeMaps::iterator it = _node_maps.begin();

           it != _node_maps.end(); ++it) {

        delete it->second;

      }

      for (typename EdgeMaps::iterator it = _edge_maps.begin();

           it != _edge_maps.end(); ++it) {

        delete it->second;

      }

      for (typename Attributes::iterator it = _attributes.begin();

           it != _attributes.end(); ++it) {

        delete it->second;

      }

      if (local_is) {

        delete _is;

      }

    }

  private:

    GraphReader(GraphReader& other)

      : _is(other._is), local_is(other.local_is), _graph(other._graph),

        _use_nodes(other._use_nodes), _use_edges(other._use_edges),

        _skip_nodes(other._skip_nodes), _skip_edges(other._skip_edges) {

      other._is = 0;

      other.local_is = false;

      _node_index.swap(other._node_index);

      _edge_index.swap(other._edge_index);

      _node_maps.swap(other._node_maps);

      _edge_maps.swap(other._edge_maps);

      _attributes.swap(other._attributes);

      _nodes_caption = other._nodes_caption;

      _edges_caption = other._edges_caption;

      _attributes_caption = other._attributes_caption;

    }

    GraphReader& operator=(const GraphReader&);

  public:

    /// \name Reading rules

    /// @{

    /// \brief Node map reading rule

    ///

    /// Add a node map reading rule to the reader.

    template <typename Map>

    GraphReader& nodeMap(const std::string& caption, Map& map) {

      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();

      _reader_bits::MapStorageBase<Node>* storage =

        new _reader_bits::MapStorage<Node, Map>(map);

      _node_maps.push_back(std::make_pair(caption, storage));

      return *this;

    }

    /// \brief Node map reading rule

    ///

    /// Add a node map reading rule with specialized converter to the

    /// reader.

    template <typename Map, typename Converter>

    GraphReader& nodeMap(const std::string& caption, Map& map,

                           const Converter& converter = Converter()) {

      checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();

      _reader_bits::MapStorageBase<Node>* storage =

        new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);

      _node_maps.push_back(std::make_pair(caption, storage));

      return *this;

    }

    /// \brief Edge map reading rule

    ///

    /// Add an edge map reading rule to the reader.

    template <typename Map>

    GraphReader& edgeMap(const std::string& caption, Map& map) {

      checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();

      _reader_bits::MapStorageBase<Edge>* storage =

        new _reader_bits::MapStorage<Edge, Map>(map);

      _edge_maps.push_back(std::make_pair(caption, storage));

      return *this;

    }

    /// \brief Edge map reading rule

    ///

    /// Add an edge map reading rule with specialized converter to the

    /// reader.

    template <typename Map, typename Converter>

    GraphReader& edgeMap(const std::string& caption, Map& map,

                          const Converter& converter = Converter()) {

      checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();

      _reader_bits::MapStorageBase<Edge>* storage =

        new _reader_bits::MapStorage<Edge, Map, Converter>(map, converter);

      _edge_maps.push_back(std::make_pair(caption, storage));

      return *this;

    }

    /// \brief Arc map reading rule

    ///

    /// Add an arc map reading rule to the reader.