JEEP::JComment Struct Reference

Auxiliary class for comment. More...

#include <JComment.hh>

Inheritance diagram for JEEP::JComment:

Public Member Functions
	JComment ()
	Default constructor. More...
JComment &	add (const std::string &comment)
	Add comment. More...
JComment &	add (const JComment &comment)
	Add comment. More...

Static Public Attributes
static const char	START_COMMENT = '#'
	start of comment More...
static const char	CLOSE_COMMENT = '\n'
	close of comment More...
static const char	QUOTE = '"'
	quote More...

Friends
std::istream &	operator>> (std::istream &in, JComment &comment)
	Read comment from input. More...
std::ostream &	operator<< (std::ostream &out, const JComment &comment)
	Write comment to output. More...

Detailed Description

Auxiliary class for comment.

A comment starts with a JComment::START_COMMENT and ends with a JComment::CLOSE_COMMENT.
The text between the quotes JComment::QUOTE is considered as one block which may cross newlines, etc.
The comments are appended.

Definition at line 29 of file JComment.hh.

Constructor & Destructor Documentation

JEEP::JComment::JComment ( )

inline

Default constructor.

Definition at line 41 of file JComment.hh.

    {}

Member Function Documentation

JComment& JEEP::JComment::add ( const std::string &  comment )

inline

Add comment.

Parameters

comment

comment

Returns

this comment

Definition at line 51 of file JComment.hh.

    {
      this->push_back(comment);

      return *this;
    }

JComment& JEEP::JComment::add ( const JComment &  comment )

inline

Add comment.

Parameters

comment

comment

Returns

this comment

Definition at line 65 of file JComment.hh.

    {
      for (const_iterator i = comment.begin(); i != comment.end(); ++i) {
        this->push_back(*i);
      }

      return *this;
    }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JComment &  comment  )

friend

Read comment from input.

Parameters

in	input stream
comment	comment

Returns

input stream

Definition at line 82 of file JComment.hh.

    {
      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;
    }

std::ostream& operator<< ( std::ostream &  out, const JComment &  comment  )

friend

Write comment to output.

Parameters

out	output stream
comment	comment

Returns

output stream

Definition at line 125 of file JComment.hh.

    {
      using namespace std;

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

      return out << flush;
    }

Member Data Documentation

const char JEEP::JComment::START_COMMENT = '#'

static

start of comment

Definition at line 33 of file JComment.hh.

const char JEEP::JComment::CLOSE_COMMENT = '\n'

static

close of comment

Definition at line 34 of file JComment.hh.

const char JEEP::JComment::QUOTE = '"'

static

quote

Definition at line 35 of file JComment.hh.

---

The documentation for this struct was generated from the following file:

• JComment.hh