JComment.hh

Go to the documentation of this file.

#ifndef __JEEP__JCOMMENT__
#define __JEEP__JCOMMENT__

#include <istream>
#include <ostream>
#include <sstream>
#include <string>
#include <vector>

#include "Jeep/JPrint.hh"


/**
 * \author mdejong
 */

namespace JEEP {}
namespace JPP { using namespace JEEP; }

namespace JEEP {

  /**
   * Auxiliary class for comment.
   *
   * A comment starts with a JComment::START_COMMENT and ends with a JComment::CLOSE_COMMENT.\n
   * The text between the quotes JComment::QUOTE is considered as one block which may cross newlines, etc.\n
   * The comments are appended.
   */
  struct JComment :
    public std::vector<std::string>
  {

    static const char START_COMMENT  =  '#';     //!< start of comment
    static const char CLOSE_COMMENT  = '\n';     //!< close of comment
    static const char QUOTE          =  '"';     //!< quote


    /**
     * Default constructor.
     */
    JComment()
    {}


    /**
     * Add comment.
     *
     * \param  comment    comment
     * \return            this comment
     */
    JComment& add(const std::string& comment)
    {
      this->push_back(comment);

      return *this;
    }


    /**
     * Add comment.
     *
     * \param  comment    comment
     * \return            this comment
     */
    JComment& add(const JComment& comment)
    {
      for (const_iterator i = comment.begin(); i != comment.end(); ++i) {
        this->push_back(*i);
      }

      return *this;
    }


    /**
     * Read comment from input.
     *
     * \param  in         input stream
     * \param  comment    comment
     * \return            input stream
     */
    friend inline std::istream& operator>>(std::istream& in, JComment& comment)
    {
      using namespace std;

      while (in.peek() == (int) START_COMMENT) {

        in.get();

        if (in.peek() == (int) ' ') {
          in.get();
        }

        int    c;
        string buffer;

        while ((c = in.get()) != EOF && c != (int) CLOSE_COMMENT) {

          buffer.push_back((char) c);

          if (c == (int) QUOTE) {

            while ((c = in.get()) != EOF && c != (int) QUOTE) {
              buffer.push_back((char) c);
            }

            buffer.push_back(QUOTE);
          }
        }

        comment.push_back(buffer);
      }

      return in;
    }


    /**
     * Write comment to output.
     *
     * \param  out        output stream
     * \param  comment    comment
     * \return            output stream
     */
    friend inline std::ostream& operator<<(std::ostream& out, const JComment& comment)
    {
      using namespace std;

      for (JComment::const_iterator i = comment.begin(); i != comment.end(); ++i) {
        out << START_COMMENT << ' ' << *i << CLOSE_COMMENT;
      }

      return out << flush;
    }
  };
}

#endif