JEEP::JComment Struct Reference

Auxiliary class for comment. More...

#include <JComment.hh>

Inheritance diagram for JEEP::JComment:

Public Types
enum	{ UUID_t = 0 }

Public Member Functions
	JComment ()
	Default constructor. More...
JComment &	update (const JUUID &uuid)
	Update this comment with given UUID. More...
JComment &	update ()
	Update this comment with random UUID. More...
JComment &	add (const std::string &comment)
	Add comment. More...
JComment &	add (const JComment_t &comment)
	Add comment block. More...
bool	hasUUID () const
	Check if this comment has UUID. More...
JUUID	getUUID () const
	Get UUID. More...

Static Public Member Functions
static bool	is_special (const std::string &buffer)
	Check if given string is special. More...

Static Public Attributes
static const char	START_COMMENT = '#'
	start comment More...
static const char	CLOSE_COMMENT = '\n'
	close comment More...
static const char	START_SPECIAL = '$'
	start special comment More...
static const char	CLOSE_SPECIAL = '$'
	close special 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 41 of file JComment.hh.

Member Enumeration Documentation

anonymous enum

Enumerator
UUID_t	index of UUID

Definition at line 44 of file JComment.hh.

         {
      UUID_t = 0                                 //!< index of UUID
    };

Constructor & Destructor Documentation

JEEP::JComment::JComment ( )

inline

Default constructor.

Definition at line 58 of file JComment.hh.

    {}

Member Function Documentation

JComment& JEEP::JComment::update ( const JUUID &  uuid )

inline

Update this comment with given UUID.

Parameters

uuid

UUID

Returns

this comment

Definition at line 68 of file JComment.hh.

    {
      if (!this->hasUUID()) {
        if ((int) this->size() <= UUID_t)
          this->resize(UUID_t + 1);
        else
          this->insert(this->begin() + UUID_t, value_type());
      }

      (*this)[UUID_t] = MAKE_STRING(START_SPECIAL << uuid << CLOSE_SPECIAL);

      return *this; 
    }

JComment& JEEP::JComment::update ( )

inline

Update this comment with random UUID.

Returns

this comment

Definition at line 88 of file JComment.hh.

    {
      return this->update(JUUID::rndm());
    }

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

inline

Add comment.

Parameters

comment

comment

Returns

this comment

Definition at line 100 of file JComment.hh.

    {
      this->push_back(comment);

      return this->update();
    }

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

inline

Add comment block.

Parameters

comment

comment block

Returns

this comment

Definition at line 114 of file JComment.hh.

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

      return this->update();
    }

bool JEEP::JComment::hasUUID ( ) const

inline

Check if this comment has UUID.

Returns

true if UUID present; else false

Definition at line 129 of file JComment.hh.

    {
      return (UUID_t < (int) this->size() && is_special((*this)[UUID_t]));
    }

JUUID JEEP::JComment::getUUID ( ) const

inline

Get UUID.

Returns

UUID

Definition at line 140 of file JComment.hh.

    {
      if (this->hasUUID()) {

        const std::string& buffer = (*this)[UUID_t];

        return JUUID::valueOf(buffer.substr(1, buffer.size() - 2));

      } else {

        THROW(JNoValue, "No UUID in comment.");
      }
    }

static bool JEEP::JComment::is_special ( const std::string &  buffer )

inlinestatic

Check if given string is special.

Parameters

buffer

input string

Returns

true if special; else false

Definition at line 223 of file JComment.hh.

    {
      const int N = buffer.size();

      return (N            >   2               &&
              buffer[0]    ==  START_SPECIAL   &&
              buffer[N-1]  ==  CLOSE_SPECIAL);        
    }

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 162 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 205 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 comment

Definition at line 48 of file JComment.hh.

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

static

close comment

Definition at line 49 of file JComment.hh.

const char JEEP::JComment::START_SPECIAL = '$'

static

start special comment

Definition at line 50 of file JComment.hh.

const char JEEP::JComment::CLOSE_SPECIAL = '$'

static

close special comment

Definition at line 51 of file JComment.hh.

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

static

quote

Definition at line 52 of file JComment.hh.

---

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

• JComment.hh