rnr::cmd::Token Class Reference

Parsed token container class. More...

#include <Token.h>

Public Member Functions
	Token ()
	Default constructor.
	Token (const std::string &strValue)
	Initialization constructor. More...
	Token (const std::string &strValue, const size_t lineNum, const size_t posStart, const size_t posEnd)
	Initialization constructor. More...
	Token (const Token &src)
	Copy constructor. More...
virtual	~Token ()
	Destructor.
Token &	operator= (const Token &rhs)
	Assignment operator. More...
const std::string &	value () const
	Return token string. More...
const size_t	linenum () const
	Return input line number where token was located. More...
void	position (size_t &posStart, size_t &posEnd) const
	Return input line position where token was located. More...
std::ostream &	printAnnotated (std::ostream &os, const std::string &strLine, const bool bLoc=false)
	Output annotated token embedded location in the input line. More...

Public Attributes
std::string	m_strValue
	token string value
size_t	m_lineNum
	line number
size_t	m_posStart
	line start position of token
size_t	m_posEnd
	line end position of token

Friends
std::ostream &	operator<< (std::ostream &os, const Token &tok)
	Insert object into output stream. More...
LogBook &	operator<< (LogBook &log, const Token &tok)
	Insert object into LogBook pending entry. More...

Detailed Description

Parsed token container class.

Definition at line 84 of file Token.h.

Constructor & Destructor Documentation

rnr::cmd::Token::Token

(

const std::string &

strValue

)

Initialization constructor.

Parameters

strValue

Token value.

rnr::cmd::Token::Token	(	const std::string &	strValue,
		const size_t	lineNum,
		const size_t	posStart,
		const size_t	posEnd
	)

Initialization constructor.

Parameters

strValue	Token value.
lineNum	Line number. Set to 0 if unknown or not associated with I/O input.
posStart	Token start position in line.
posEnd	Token end position in line.

Token::Token

(

const Token &

src

)

Copy constructor.

Parameters

src	Source object.

Definition at line 104 of file Token.cxx.

References m_lineNum, m_posEnd, m_posStart, and m_strValue.

{
  m_strValue  = src.m_strValue;
  m_lineNum   = src.m_lineNum;
  m_posStart  = src.m_posStart;
  m_posEnd    = src.m_posEnd;
}

Member Function Documentation

const size_t rnr::cmd::Token::linenum ( ) const

inline

Return input line number where token was located.

Returns

Line number.

Definition at line 159 of file Token.h.

References m_lineNum.

      {
        return m_lineNum;
      }

Token & Token::operator=

(

const Token &

rhs

)

Assignment operator.

Parameters

rhs	Right-hand side object.

Returns

*this

Definition at line 116 of file Token.cxx.

References m_lineNum, m_posEnd, m_posStart, and m_strValue.

{
  m_strValue  = rhs.m_strValue;
  m_lineNum   = rhs.m_lineNum;
  m_posStart  = rhs.m_posStart;
  m_posEnd    = rhs.m_posEnd;

  return *this;
}

void rnr::cmd::Token::position ( size_t &  posStart, size_t &  posEnd  ) const

inline

Return input line position where token was located.

Parameters

[out]	posStart	Starting character position of token.
[out]	posEnd	Ending character position of token.

Definition at line 170 of file Token.h.

References m_posEnd, m_posStart, operator<<, and printAnnotated().

      {
        posStart = m_posStart;
        posEnd   = m_posEnd;
      }

ostream & Token::printAnnotated	(	std::ostream &	os,
		const std::string &	strLine,
		const bool	bLoc = false
	)

Output annotated token embedded location in the input line.

Output:

[linenum] line of text where token was generated

Parameters

os	Output stream.
strLine	Line whence token was generated.
bLoc	If true, then include line number and token characater positions.

Returns

Reference to output stream.

Definition at line 126 of file Token.cxx.

References operator<<(), rnr::str::prettify(), and value().

Referenced by position().

{
  string color(ANSI_FG_BRIGHT_RED);
  string reset(ANSI_COLOR_RESET);

  size_t  lw = strLine.length();    // line width
  size_t  pos;                      // working substring starting position
  size_t  len;                      // working substring length

  //
  // Print line number
  //
  if( bLoc )
  {
    os << "[";
    if( m_lineNum > 0 )
    {
      os << m_lineNum << ":";
    }
    os << m_posStart << "," << m_posEnd;
    os << "] ";
  }

  //
  // Print token embedded in line.
  //
  if( m_posStart < lw )
  {
    //
    // Print substring before token in plaintext
    //
    if( m_posStart > 0 )
    {
      os << strLine.substr(0, m_posStart);
    }

    //
    // Print token substring in color.
    //
    len = m_posEnd - m_posStart + 1;
    if( len > lw )
    {
      len = lw - m_posStart;
    }
    os << color << strLine.substr(m_posStart, len) << reset;

    //
    // Print substring after token in plaintext
    //
    pos = m_posEnd + 1;
    if( pos < lw )
    {
      os << strLine.substr(pos);
    }
  }

  //
  // Print line.
  //
  else
  {
    os << strLine << endl;
  }

  return os;
}

const std::string& rnr::cmd::Token::value ( ) const

inline

Return token string.

Returns

String.

Definition at line 149 of file Token.h.

References m_strValue.

Referenced by rnr::cmd::CommandLine::peekEq(), and printAnnotated().

      {
        return m_strValue;
      }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const Token &  tok  )

friend

Insert object into output stream.

Parameters

os	Output stream.
tok	Object to insert.

Returns

Reference to output stream.

Referenced by position().

LogBook& operator<< ( LogBook &  log, const Token &  tok  )

friend

Insert object into LogBook pending entry.

Parameters

log	LogBook stream.
tok	Object to insert.

Returns

Reference to LogBook.

---

The documentation for this class was generated from the following files:

• include/rnr/appkit/Token.h
• sw/librnr_appkit/Token.cxx