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 "JIO/JSerialisable.hh"
//#include "JIO/JSTDIO.hh"
#include "Jeep/JPrint.hh"
 
 
/**
 * \author mdejong
 */
 
namespace JEEP {}
namespace JPP { using namespace JEEP; }
 
namespace JEEP {
 
  //using JIO::JReader;
  //using JIO::JWriter;
 
 
  /**
   * Auxiliary class for comment.
   *
   * A comment starts with a <pre>JComment::START_COMMENT</pre> and ends with a <pre>JComment::CLOSE_COMMENT</pre>.
   * 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
 
 
    /**
     * 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;
 
      for (string buffer; in.peek() == (int) START_COMMENT; ) {
 
        in.get();
 
        if (in.peek() == (int) ' ') {
          in.get();
        }
 
        getline(in, buffer, CLOSE_COMMENT);
 
        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;
    }
  
 
    /**
     * Read comment from input.
     *
     * \param  in         reader
     * \param  comment    comment
     * \return            reader
     */
    /*
    friend inline JReader& operator>>(JReader& in, JComment& comment)
    {
      return in;
    }
    */
 
    /**
     * Write comment to output.
     *
     * \param  out        writer
     * \param  comment    comment
     * \return            writer
     */
    /*
    friend inline JWriter& operator<<(JWriter& out, const JComment& comment)
    {
      return out;
    }
    */
  };
}
 
#endif