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.
JComment &	update (const JUUID &uuid)
	Update this comment with given UUID.
JComment &	update ()
	Update this comment with random UUID.
JComment &	add (const std::string &comment)
	Add comment.
JComment &	add (const JComment_t &comment)
	Add comment block.
bool	hasUUID () const
	Check if this comment has UUID.
JUUID	getUUID () const
	Get UUID.

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

Static Public Attributes
static constexpr char	START_COMMENT = '#'
	start comment
static constexpr char	CLOSE_COMMENT = '\n'
	close comment
static constexpr char	START_SPECIAL = '$'
	start special comment
static constexpr char	CLOSE_SPECIAL = '$'
	close special comment
static constexpr char	QUOTE = '"'
	quote

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

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

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

JComment()

JEEP::JComment::JComment ( )

inline

Default constructor.

Definition at line 58 of file JComment.hh.

    {}

Member Function Documentation

update() [1/2]

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

update() [2/2]

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());
    }

add() [1/2]

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();
    }

add() [2/2]

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();
    }

hasUUID()

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]));
    }

getUUID()

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.");
      }
    }

is_special()

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 Symbol Documentation

operator>>

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

operator<<

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

START_COMMENT

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

staticconstexpr

start comment

Definition at line 48 of file JComment.hh.

CLOSE_COMMENT

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

staticconstexpr

close comment

Definition at line 49 of file JComment.hh.

START_SPECIAL

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

staticconstexpr

start special comment

Definition at line 50 of file JComment.hh.

CLOSE_SPECIAL

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

staticconstexpr

close special comment

Definition at line 51 of file JComment.hh.

QUOTE

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

staticconstexpr

quote

Definition at line 52 of file JComment.hh.

---

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

• JComment.hh