rnr::cmd::CmdFormDef Class Reference

Compiled command form defintion class. More...

#include <CmdFormDef.h>

Public Member Functions
	CmdFormDef ()
	Default constructor.
	CmdFormDef (const std::string &strSyntax)
	Initialization constructor.
	CmdFormDef (const CmdFormDef &src)
	Copy constructor. More...
virtual	~CmdFormDef ()
	Destructor.
CmdFormDef &	operator= (const CmdFormDef &rhs)
	Assignment operator. More...
bool	isDefined () const
int	getParentCmdUid () const
	Get parent command's unique id. More...
int	getIndex () const
	Get forms's index. More...
std::string	getSyntax () const
	Get form's extended usage syntax.
const CmdArgDef &	at (const int nIndex) const
	Get form's argument at index. More...
const CmdArgDef &	operator[] (const int nIndex) const
	Index operator. More...
int	numOfArgs () const
	Get the total number of arguments. More...
int	numOfRequiredArgs () const
	Get the total number of required arguments. More...
int	numOfOptionalArgs () const
	Get the total number of optional arguments. More...

Protected Member Functions
void	reset ()
	Reset form definition to pre-compiled state.
void	setParent (const int nCmdUid)
	Set parent's command id. More...
void	setIndex (const int nIndex)
	Set forms's index. More...
void	setSyntax (const std::string &strSyntax)
	Set command's extended usage syntax. More...
void	pushArg (CmdArgDef &argdef)
	Push argument to end of argument list. More...
CmdArgDef &	argAt (const int nIndex)
	Get form's modifiable argument at index. More...
CmdArgDef &	lastArg ()
	Get the last pushed argument. More...

Protected Attributes
int	m_nCmdUid
	parent command's unique id
int	m_nIndex
	forms index
std::string	m_strSyntax
	command extened usage syntax
ArgDefVec	m_argDefs
	command argument definitions
int	m_nArgcReq
	number of required arguments
int	m_nArgcOpt
	number of optional arguments

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

Detailed Description

Compiled command form defintion class.

Definition at line 91 of file CmdFormDef.h.

Constructor & Destructor Documentation

CmdFormDef::CmdFormDef

(

const CmdFormDef &

src

)

Copy constructor.

Parameters

src	Source object.

Definition at line 113 of file CmdFormDef.cxx.

References m_argDefs, m_nArgcOpt, m_nArgcReq, m_nCmdUid, m_nIndex, and m_strSyntax.

{
  m_nCmdUid   = src.m_nCmdUid;
  m_nIndex    = src.m_nIndex;
  m_strSyntax = src.m_strSyntax;
  m_argDefs   = src.m_argDefs;
  m_nArgcReq  = src.m_nArgcReq;
  m_nArgcOpt  = src.m_nArgcOpt;
}

Member Function Documentation

CmdArgDef & CmdFormDef::argAt ( const int  nIndex )

protected

Get form's modifiable argument at index.

Protected version of at().

Parameters

nIndex

Argument index.

Returns

Command argument definition reference.

Definition at line 188 of file CmdFormDef.cxx.

References rnr::cmd::noargdef.

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

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

const CmdArgDef & CmdFormDef::at

(

const int

nIndex

)

const

Get form's argument at index.

Parameters

nIndex

Argument index.

Returns

Command argument definition reference.

Definition at line 176 of file CmdFormDef.cxx.

References rnr::cmd::noargdef.

Referenced by getSyntax(), rnr::cmd::CommandLine::matchCommand(), rnr::cmd::CommandLine::matchCommandForm(), and operator[]().

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

int rnr::cmd::CmdFormDef::getIndex ( ) const

inline

Get forms's index.

Returns

Zero based index.

Definition at line 152 of file CmdFormDef.h.

References m_nIndex.

Referenced by rnr::cmd::CommandLine::compile(), rnr::cmd::CommandLine::matchCommandForm(), rnr::cmd::CommandLine::parseArgv0(), and rnr::cmd::CommandLine::parseSyntax().

      {
        return m_nIndex;
      }

int rnr::cmd::CmdFormDef::getParentCmdUid ( ) const

inline

Get parent command's unique id.

Returns

Unique id.

Definition at line 142 of file CmdFormDef.h.

References m_nCmdUid.

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

      {
        return m_nCmdUid;
      }

CmdArgDef & CmdFormDef::lastArg ( )

protected

Get the last pushed argument.

Returns

Argument definition reference.

Definition at line 200 of file CmdFormDef.cxx.

References rnr::io::deltaindent(), rnr::io::indent(), m_argDefs, m_nCmdUid, m_nIndex, m_strSyntax, rnr::cmd::noargdef, numOfArgs(), numOfOptionalArgs(), numOfRequiredArgs(), and operator<<().

Referenced by rnr::cmd::CommandLine::parseArgv0(), rnr::cmd::CommandLine::parseLiteralArg(), rnr::cmd::CommandLine::parseOptionalArgList(), rnr::cmd::CommandLine::parseVariableArg(), and rnr::cmd::CommandLine::parseXorListArg().

{
  return m_argDefs.empty()? noargdef: m_argDefs.back();
}

int rnr::cmd::CmdFormDef::numOfArgs ( ) const

inline

Get the total number of arguments.

The first argument (argv0) is the command.

Returns

Number of arguments.

Definition at line 195 of file CmdFormDef.h.

References m_argDefs.

Referenced by lastArg(), rnr::cmd::CommandLine::matchCommandForm(), rnr::cmd::CommandLine::numOfArgs(), rnr::cmd::CommandLine::parseLiteralArg(), rnr::cmd::CommandLine::parseSyntax(), rnr::cmd::CommandLine::parseXorListArg(), and rnr::cmd::CommandLine::rlArgDefs().

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

int rnr::cmd::CmdFormDef::numOfOptionalArgs ( ) const

inline

Get the total number of optional arguments.

Optional arguments start at argument index numOfRequiredArgs().

Returns

Number of arguments.

Definition at line 221 of file CmdFormDef.h.

References m_nArgcOpt, and operator<<.

Referenced by lastArg(), and rnr::cmd::CommandLine::numOfOptionalArgs().

      {
        return m_nArgcOpt;
      }

int rnr::cmd::CmdFormDef::numOfRequiredArgs ( ) const

inline

Get the total number of required arguments.

The required number includes the command argv0.

Required arguments start at argument index 0.

Returns

Number of arguments.

Definition at line 209 of file CmdFormDef.h.

References m_nArgcReq.

Referenced by lastArg(), rnr::cmd::CommandLine::matchCommandForm(), and rnr::cmd::CommandLine::numOfRequiredArgs().

      {
        return m_nArgcReq;
      }

CmdFormDef & CmdFormDef::operator=

(

const CmdFormDef &

rhs

)

Assignment operator.

Parameters

rhs	Right-hand side object.

Returns

*this

Definition at line 127 of file CmdFormDef.cxx.

References m_argDefs, m_nArgcOpt, m_nArgcReq, m_nCmdUid, m_nIndex, and m_strSyntax.

{
  m_nCmdUid   = rhs.m_nCmdUid;
  m_nIndex    = rhs.m_nIndex;
  m_strSyntax = rhs.m_strSyntax;
  m_argDefs   = rhs.m_argDefs;
  m_nArgcReq  = rhs.m_nArgcReq;
  m_nArgcOpt  = rhs.m_nArgcOpt;
}

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

inline

Index operator.

Get form's argument at index.

Parameters

nIndex

Argument index.

Returns

Command argument definition reference.

Definition at line 183 of file CmdFormDef.h.

References at().

      {
        return at(nIndex);
      }

void CmdFormDef::pushArg ( CmdArgDef &  argdef )

protected

Push argument to end of argument list.

Parameters

argdef

Command argument definition.

Definition at line 167 of file CmdFormDef.cxx.

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

Referenced by rnr::cmd::CommandLine::parseLiteralArg(), rnr::cmd::CommandLine::parseVariableArg(), and rnr::cmd::CommandLine::parseXorListArg().

{
  int nIndex = numOfArgs();

  argdef.setParent(m_nCmdUid, m_nIndex);
  argdef.setIndex(nIndex);
  m_argDefs.push_back(argdef);
}

void CmdFormDef::setIndex ( const int  nIndex )

protected

Set forms's index.

Parameters

nIndex

Zero based index.

Definition at line 157 of file CmdFormDef.cxx.

Referenced by rnr::cmd::CmdDef::pushForm().

{
  m_nIndex = nIndex;
}

void CmdFormDef::setParent ( const int  nCmdUid )

protected

Set parent's command id.

Parameters

nCmdUid

Command unique id.

Definition at line 152 of file CmdFormDef.cxx.

Referenced by rnr::cmd::CmdDef::pushForm().

{
  m_nCmdUid = nCmdUid;
}

void CmdFormDef::setSyntax ( const std::string &  strSyntax )

protected

Set command's extended usage syntax.

Parameters

strSyntax

Syntax string.

Definition at line 162 of file CmdFormDef.cxx.

{
  m_strSyntax = strSyntax;
}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const CmdFormDef &  formdef  )

friend

Insert object into output stream.

Parameters

os	Output stream.
formdef	Object to insert.

Returns

Reference to output stream.

Referenced by numOfOptionalArgs().

---

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

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