rnr::cmd::CmdDef Class Reference

Compiled command definition class. More...

#include <CmdDef.h>

Public Member Functions
	CmdDef ()
	Default constructor.
	CmdDef (const CmdDef &src)
	Copy constructor. More...
virtual	~CmdDef ()
	Destructor.
CmdDef &	operator= (const CmdDef &rhs)
	Assignment operator. More...
bool	isDefined () const
int	getUid () const
	Get command's unique id. More...
const std::string &	getName () const
	Return command's name. More...
const std::string &	getSyntax () const
	Return command's syntax usage. More...
const std::string &	getSynopsis () const
	Return command's synopsis. More...
const std::string &	getLongDesc () const
	Return command's long description. More...
int	numOfForms () const
	Get the total number command forms. More...
const CmdFormDef &	at (const int nIndex) const
	Get command form at index. More...
const CmdFormDef &	operator[] (const int nIndex) const
	Index operator. More...

Protected Member Functions
void	reset ()
	Reset command definition to pre-compiled state.
void	setUid (const int uid)
	Set command's unique id. More...
void	setName (const std::string &strName)
	Set command's name. More...
void	pushForm (CmdFormDef &formdef)
	Push new command form to end of form list. More...
CmdFormDef &	formAt (const int nIndex)
	Get command modifiable form at index. More...
void	addHelp (const char *sSynopsis, const char *sLongDesc)
	Add help to command. More...
void	addHelp (const std::string &strSynopsis, const std::string &strLongDesc)

Protected Attributes
int	m_nUid
	command unique id
std::string	m_strName
	command name
std::string	m_strSyntax
	parsable command extended usage syntax
std::string	m_strSynopsis
	short command synopsis
std::string	m_strLongDesc
	long command description
CmdFormDefVec	m_formDefs
	vector of command forms

Friends
class	CommandLine
std::ostream &	operator<< (std::ostream &os, const CmdDef &cmddef)
	Insert object into output stream. More...

Detailed Description

Compiled command definition class.

Definition at line 88 of file CmdDef.h.

Constructor & Destructor Documentation

CmdDef::CmdDef

(

const CmdDef &

src

)

Copy constructor.

Parameters

src	Source object.

Definition at line 102 of file CmdDef.cxx.

References m_formDefs, m_nUid, m_strLongDesc, m_strName, m_strSynopsis, and m_strSyntax.

{
  m_nUid        = src.m_nUid;
  m_strName     = src.m_strName;
  m_strSyntax   = src.m_strSyntax;
  m_strSynopsis = src.m_strSynopsis;
  m_strLongDesc = src.m_strLongDesc;
  m_formDefs    = src.m_formDefs;
}

Member Function Documentation

void CmdDef::addHelp ( const char *  sSynopsis, const char *  sLongDesc  )

protected

Add help to command.

Parameters

sSynopsis	Short command synopsis.
sLongDesc	Long command description.
strSynopsis	Short command synopsis.
strLongDesc	Long command description.

Definition at line 152 of file CmdDef.cxx.

{
  string strSynopsis(sSynopsis != NULL? sSynopsis: "");
  string strLongDesc(sLongDesc != NULL? sLongDesc: "");

  addHelp(strSynopsis, strLongDesc);
}

const CmdFormDef & CmdDef::at

(

const int

nIndex

)

const

Get command form at index.

Parameters

nIndex

Form's index.

Returns

Command form definition reference.

Definition at line 175 of file CmdDef.cxx.

References rnr::cmd::noformdef.

Referenced by rnr::cmd::CommandLine::matchCommand(), rnr::cmd::CommandLine::numOfArgs(), numOfForms(), rnr::cmd::CommandLine::numOfOptionalArgs(), rnr::cmd::CommandLine::numOfRequiredArgs(), and operator[]().

{
  if( (nIndex >= 0) && (nIndex < m_formDefs.size()) )
  {
    return m_formDefs[nIndex];
  }
  else
  {
    return noformdef;
  }
}

CmdFormDef & CmdDef::formAt ( const int  nIndex )

protected

Get command modifiable form at index.

Protected version of at().

Parameters

nIndex

Form's index.

Returns

Command form definition reference.

Definition at line 187 of file CmdDef.cxx.

References rnr::io::deltaindent(), rnr::io::indent(), m_formDefs, m_nUid, m_strLongDesc, m_strName, m_strSynopsis, m_strSyntax, rnr::cmd::noformdef, numOfForms(), and operator<<().

Referenced by rnr::cmd::CommandLine::compile(), and rnr::cmd::CommandLine::match().

{
  if( (nIndex >= 0) && (nIndex < m_formDefs.size()) )
  {
    return m_formDefs[nIndex];
  }
  else
  {
    return noformdef;
  }
}

const std::string& rnr::cmd::CmdDef::getLongDesc ( ) const

inline

Return command's long description.

Returns

Long description string.

Definition at line 174 of file CmdDef.h.

References m_strLongDesc.

Referenced by rnr::cmd::addons::execHelp().

      {
        return m_strLongDesc;
      }

const std::string& rnr::cmd::CmdDef::getName ( ) const

inline

Return command's name.

Returns

Name string.

Definition at line 144 of file CmdDef.h.

References m_strName.

Referenced by rnr::cmd::CommandLine::compile(), rnr::cmd::addons::execHelp(), rnr::cmd::CommandLine::finalize(), rnr::cmd::CommandLine::matchCommand(), rnr::cmd::CommandLine::parseArgv0(), and rnr::cmd::CommandLine::parseSyntax().

      {
        return m_strName;
      }

const std::string& rnr::cmd::CmdDef::getSynopsis ( ) const

inline

Return command's synopsis.

Returns

Synopsis string.

Definition at line 164 of file CmdDef.h.

References m_strSynopsis.

Referenced by rnr::cmd::addons::execHelp().

      {
        return m_strSynopsis;
      }

const std::string& rnr::cmd::CmdDef::getSyntax ( ) const

inline

Return command's syntax usage.

Returns

Syntax string.

Definition at line 154 of file CmdDef.h.

References m_strSyntax.

Referenced by rnr::cmd::addons::execHelp().

      {
        return m_strSyntax;
      }

int rnr::cmd::CmdDef::getUid ( ) const

inline

Get command's unique id.

Returns

Unique id.

Definition at line 134 of file CmdDef.h.

References m_nUid.

Referenced by rnr::cmd::CommandLine::addCommand(), rnr::cmd::CommandLine::compile(), rnr::cmd::addons::execHelp(), rnr::cmd::CommandLine::execute(), rnr::cmd::CommandLine::finalize(), rnr::cmd::CommandLine::parseSyntax(), and rnr::cmd::CommandLine::removeCommand().

      {
        return m_nUid;
      }

int rnr::cmd::CmdDef::numOfForms ( ) const

inline

Get the total number command forms.

Returns

Number of forms.

Definition at line 184 of file CmdDef.h.

References at(), and m_formDefs.

Referenced by rnr::cmd::CommandLine::compile(), formAt(), and rnr::cmd::CommandLine::matchCommand().

      {
        return (int)m_formDefs.size();
      }

CmdDef & CmdDef::operator=

(

const CmdDef &

rhs

)

Assignment operator.

Parameters

rhs	Right-hand side object.

Returns

*this

Definition at line 116 of file CmdDef.cxx.

References m_formDefs, m_nUid, m_strLongDesc, m_strName, m_strSynopsis, and m_strSyntax.

{
  m_nUid        = rhs.m_nUid;
  m_strName     = rhs.m_strName;
  m_strSyntax   = rhs.m_strSyntax;
  m_strSynopsis = rhs.m_strSynopsis;
  m_strLongDesc = rhs.m_strLongDesc;
  m_formDefs    = rhs.m_formDefs;
}

const CmdFormDef& rnr::cmd::CmdDef::operator[] ( const int  nIndex ) const

inline

Index operator.

Get command form at index.

Parameters

nIndex

Argument index.

Returns

Command form definition reference.

Definition at line 207 of file CmdDef.h.

References at(), and operator<<.

      {
        return at(nIndex);
      }

void CmdDef::pushForm ( CmdFormDef &  formdef )

protected

Push new command form to end of form list.

Parameters

formdef

Command form definition.

Definition at line 166 of file CmdDef.cxx.

References rnr::cmd::CmdFormDef::setIndex(), and rnr::cmd::CmdFormDef::setParent().

Referenced by rnr::cmd::CommandLine::addCommand().

{
  int nIndex = numOfForms();

  formdef.setParent(m_nUid);
  formdef.setIndex(nIndex);
  m_formDefs.push_back(formdef);
}

void CmdDef::setName ( const std::string &  strName )

protected

Set command's name.

Parameters

strName

Name string.

Definition at line 147 of file CmdDef.cxx.

Referenced by rnr::cmd::CommandLine::parseArgv0().

{
  m_strName = strName;
}

void CmdDef::setUid ( const int  uid )

protected

Set command's unique id.

Parameters

uid	Unique id.

Definition at line 142 of file CmdDef.cxx.

Referenced by rnr::cmd::CommandLine::addCommand().

{
  m_nUid = uid;
}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const CmdDef &  cmddef  )

friend

Insert object into output stream.

Parameters

os	Output stream.
cmddef	Object to insert.

Returns

Reference to output stream.

Referenced by operator[]().

---

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

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