rnr::cmd::CmdArgDef Class Reference

Command argument compiled definition class. More...

#include <CmdArgDef.h>

Classes
struct	range
	Number minimum and maximum (sub)range. More...

Public Types
enum	ArgType {   ArgTypeUndef = 0,   ArgTypeLiteral,   ArgTypeWord,   ArgTypeMultiWord,   ArgTypeIdentifier,   ArgTypeBoolean,   ArgTypeInteger,   ArgTypeFpn,   ArgTypeFile,   ArgTypeRegEx }
	Argument type enumeration. More...
enum	ArgFlags {   FlagCommand = 0x0001,   FlagOptional = 0x0002,   FlagXorList = 0x0004,   FlagRepeat = 0x0008 }
	Argument flag modifiers. More...
typedef std::vector< range >	RangeVec
	vector of subranges

Public Member Functions
	CmdArgDef ()
	Default constructor.
	CmdArgDef (const CmdArgDef &src)
	Copy constructor. More...
virtual	~CmdArgDef ()
	Destructor.
CmdArgDef &	operator= (const CmdArgDef &rhs)
	Assignment operator. More...
bool	isDefined () const
	Test if argument definition is sufficiently defined. More...
int	getParentCmdUid () const
	Get parent command's unique id. More...
int	getParentFormIndex () const
	Get parent command form's index. More...
int	getIndex () const
	Get argument's command line index. More...
const std::string &	getName () const
	Get argument's name. More...
ArgType	getType () const
	Get argument's type. More...
int	numOfLiterals () const
	Get the number of mutually exclusive literals. More...
const std::string &	literalAt (const int nIndex) const
	Get literal value at index. More...
const RangeVec &	getRanges () const
	Get numeric range values. More...
const std::string &	getRegEx () const
	Get regular expression value. More...
unsigned	getFlags () const
	Get argument's modifier flags. More...
bool	isCommand () const
	Test if argument is the command argument (argv0). More...
bool	isOptional () const
	Test if argument is an optional argument. More...
std::string	constructLiteralList (const std::string sep=" ") const
	Construct literal list string. More...
std::string	constructRangeList (const std::string sep=",") const
	Construct ranges string. More...
std::string	constructSyntax () const
	Construct syntax equivalent string from argument data. More...
double	match (const std::string &strArg, const bool bIgnoreCase=false) const
	Match argument string against argument definition pattern. More...
int	matchLiteral (const std::string &strArg, const bool bIgnoreCase=false) const
	Match argument agains literal enumeration list. More...
CmdExtArg	convert (const std::string &strArg, const bool bIgnoreCase=false) const
	Convert argument string to type. More...
bool	inRange (const long value) const
	Check if value is in the specified range. More...
bool	inRange (const double value) const

Static Public Member Functions
static CmdArgDef::ArgType	lookupArgType (const std::string strSymbol)
	Look up argument type, given argument type symbol. More...
static const std::string	lookupArgSymbol (const CmdArgDef::ArgType eType)
	Look up argument symbol, given argument type. More...
static const std::string	lookupFlagNames (const unsigned uFlags)
	Look up argument flags, given flags value. More...

Protected Member Functions
void	setParent (const int nCmdUid, const int nFormIndex)
	Set parent's command and form id's. More...
void	setIndex (const int nIndex)
	Set arguments's command line index. More...
void	setName (const std::string &strName)
	Set argument's name. More...
void	setType (const ArgType eType)
	Set argument's type. More...
void	addLiteralValue (const std::string &strValue)
	Add literal value to list of argument values. More...
void	setRanges (const RangeVec &ranges)
	Set numeric range values. More...
void	setRegEx (const RegEx &re)
	Set regular expression value. More...
void	orFlags (const unsigned uFlags)
	Or flags into argment modifier flags. More...

Protected Attributes
int	m_nCmdUid
	parent command's unique id
int	m_nFormIndex
	parent command's form index
int	m_nIndex
	argument index
std::string	m_strName
	argument name
ArgType	m_eType
	argument type
str::StringVec	m_literals
	literal argument valid values
RangeVec	m_ranges
	numeric argument valid ranges
RegEx	m_re
	reg expression argument valid pattern
unsigned	m_uFlags
	argument modifiers

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

Detailed Description

Command argument compiled definition class.

Definition at line 89 of file CmdArgDef.h.

Member Enumeration Documentation

enum rnr::cmd::CmdArgDef::ArgFlags

Argument flag modifiers.

Enumerator
FlagCommand	argument is the command
FlagOptional	argument is optional
FlagXorList	argument has a mutually exclusive list
FlagRepeat	argument supports repetition

Definition at line 112 of file CmdArgDef.h.

      {
        FlagCommand   = 0x0001, ///< argument is the command
        FlagOptional  = 0x0002, ///< argument is optional
        FlagXorList   = 0x0004, ///< argument has a mutually exclusive list
        FlagRepeat    = 0x0008  ///< argument supports repetition
      };

enum rnr::cmd::CmdArgDef::ArgType

Argument type enumeration.

Enumerator
ArgTypeUndef	undefined argument type
ArgTypeLiteral	literal constant
ArgTypeWord	any non-whitespace contiguous char sequence
ArgTypeMultiWord	any (quoted) character sequence
ArgTypeIdentifier	identifier (C conforming)
ArgTypeBoolean	boolean (bool)
ArgTypeInteger	integer (long)
ArgTypeFpn	floating point number (double)
ArgTypeFile	file path
ArgTypeRegEx	regular expression

Definition at line 95 of file CmdArgDef.h.

      {
        ArgTypeUndef   = 0, ///< undefined argument type
        ArgTypeLiteral,     ///< literal constant
        ArgTypeWord,        ///< any non-whitespace contiguous char sequence
        ArgTypeMultiWord,   ///< any (quoted) character sequence
        ArgTypeIdentifier,  ///< identifier (C conforming)
        ArgTypeBoolean,     ///< boolean (bool)
        ArgTypeInteger,     ///< integer (long)
        ArgTypeFpn,         ///< floating point number (double)
        ArgTypeFile,        ///< file path
        ArgTypeRegEx        ///< regular expression
      };

Constructor & Destructor Documentation

CmdArgDef::CmdArgDef

(

const CmdArgDef &

src

)

Copy constructor.

Parameters

src	Source object.

Definition at line 142 of file CmdArgDef.cxx.

References m_eType, m_literals, m_nCmdUid, m_nFormIndex, m_nIndex, m_ranges, m_re, m_strName, and m_uFlags.

{
  m_nCmdUid     = src.m_nCmdUid;
  m_nFormIndex  = src.m_nFormIndex;
  m_nIndex      = src.m_nIndex;
  m_strName     = src.m_strName;
  m_eType       = src.m_eType;
  m_literals    = src.m_literals;
  m_ranges      = src.m_ranges;
  m_re          = src.m_re;
  m_uFlags      = src.m_uFlags;
}

Member Function Documentation

void CmdArgDef::addLiteralValue ( const std::string &  strValue )

protected

Add literal value to list of argument values.

Parameters

strValue

Value to add.

Definition at line 200 of file CmdArgDef.cxx.

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

{
  m_literals.push_back(strValue);
}

string CmdArgDef::constructLiteralList

(

const std::string

sep = " "

)

const

Construct literal list string.

Parameters

sep	Seperator string between literals.

Returns

Literal list string.

Definition at line 256 of file CmdArgDef.cxx.

Referenced by isOptional(), lookupFlagNames(), and rnr::cmd::CommandLine::matchCommandForm().

{
  stringstream  ss;
  string        pre;

  for(size_t i = 0; i < numOfLiterals(); ++i)
  {
    ss << pre << literalAt(i);
    pre = sep;
  }

  return ss.str();
}

string CmdArgDef::constructRangeList

(

const std::string

sep = ","

)

const

Construct ranges string.

Parameters

sep	Seperator string between ranges.

Returns

Literal list string.

Definition at line 270 of file CmdArgDef.cxx.

Referenced by isOptional(), lookupFlagNames(), and rnr::cmd::CommandLine::matchCommandForm().

{
  stringstream  ss;
  string        pre;

  for(size_t i = 0; i < m_ranges.size(); ++i)
  {
    ss << pre << m_ranges[i].min << ":" << m_ranges[i].max;
    pre = sep;
  }

  return ss.str();
}

string CmdArgDef::constructSyntax

(

)

const

Construct syntax equivalent string from argument data.

Returns

Syntax string.

Definition at line 284 of file CmdArgDef.cxx.

Referenced by isOptional().

{
  stringstream  ss;
  string        sep;

  switch( m_eType )
  {
    case ArgTypeLiteral:
      ss << "{" << constructLiteralList(" | ") << "}";
      break;
    case ArgTypeWord:
    case ArgTypeMultiWord:
    case ArgTypeIdentifier:
    case ArgTypeBoolean:
    case ArgTypeFile:
      ss << "<" << m_strName << ":" << lookupArgSymbol(m_eType) << ">";
      break;
    case ArgTypeInteger:
    case ArgTypeFpn:
      ss << "<" << m_strName << ":" << lookupArgSymbol(m_eType);
      if( m_ranges.size() > 0 )
      {
        ss << "(" << constructRangeList() << ")";
      }
      ss << ">";
      break;
    case ArgTypeRegEx:
      ss << "<" << m_strName << ":" << lookupArgSymbol(m_eType);
      if( m_re.isValid() )
      {
        ss << "(" << m_re.getRegEx() << ")";
      }
      ss << ">";
      break;
    default:
      ss << "<" << m_strName << ">";
      break;
  }

  return ss.str();
}

CmdExtArg CmdArgDef::convert	(	const std::string &	strArg,
		const bool	bIgnoreCase = false
	)		const

Convert argument string to type.

Parameters

strArg	Argument source string.
bIgnoreCase	Do [not] ignore case when applying pattern matching.

Returns

Converted argument object.

Definition at line 482 of file CmdArgDef.cxx.

References rnr::cmd::CmdExtArg::b(), rnr::cmd::CmdExtArg::e(), rnr::cmd::CmdExtArg::f(), rnr::cmd::CmdExtArg::i(), rnr::str::lowercase(), rnr::cmd::CmdExtArg::s(), rnr::str::tobool(), rnr::str::todouble(), and rnr::str::tolong().

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

{
  CmdExtArg cvt(m_nCmdUid, m_nFormIndex, m_nIndex, 0, strArg);

  switch( m_eType )
  {
    // 
    // Converted literal value is the literal enum list index.
    //
    case ArgTypeLiteral:
      {
        long  val;

        if( (val = matchLiteral(strArg, bIgnoreCase)) >= 0 )
        {
          cvt.e(val);
        }
      }
      break;

    //
    // The converted value is the argument for these argument types.
    //
    case ArgTypeWord:
    case ArgTypeMultiWord:
    case ArgTypeIdentifier:
    case ArgTypeFile:
    case ArgTypeRegEx:
      cvt.s(strArg);
      break;

    //
    // Converted to boolean.
    //
    case ArgTypeBoolean:
      {
        bool    val;
        int     rc;

        if( bIgnoreCase )
        {
          rc = tobool(lowercase(strArg), val);
        }
        else
        {
          rc = tobool(strArg, val);
        }
        if( rc == OK )
        {
          cvt.b(val);
        }
      }
      break;

    //
    // Convert to integer.
    //
    case ArgTypeInteger:
      {
        long val;

        if( tolong(strArg, val) == OK )
        {
          cvt.i(val);
        }
      }
      break;

    //
    // Convert to floating-point number.
    //
    case ArgTypeFpn:
      {
        double val;

        if( todouble(strArg, val) == OK )
        {
          cvt.f(val);
        }
      }
      break;

    //
    // Unknown or uninitialized.
    //
    case ArgTypeUndef:
    default:
      break;
  }

  return cvt;
}

unsigned rnr::cmd::CmdArgDef::getFlags ( ) const

inline

Get argument's modifier flags.

Returns

Bit-or'ed flags.

Definition at line 279 of file CmdArgDef.h.

References m_uFlags.

      {
        return m_uFlags;
      }

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

inline

Get argument's command line index.

Returns

Zero based index..

Definition at line 194 of file CmdArgDef.h.

References m_nIndex.

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

      {
        return m_nIndex;
      }

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

inline

Get argument's name.

Returns

Name string.

Definition at line 204 of file CmdArgDef.h.

References m_strName.

Referenced by rnr::cmd::CommandLine::getArgName(), and rnr::cmd::CommandLine::parseArgv0().

      {
        return m_strName;
      }

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

inline

Get parent command's unique id.

Returns

Unique id.

Definition at line 174 of file CmdArgDef.h.

References m_nCmdUid.

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

      {
        return m_nCmdUid;
      }

int rnr::cmd::CmdArgDef::getParentFormIndex ( ) const

inline

Get parent command form's index.

Returns

Zero based index.

Definition at line 184 of file CmdArgDef.h.

References m_nFormIndex.

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

      {
        return m_nFormIndex;
      }

const RangeVec& rnr::cmd::CmdArgDef::getRanges ( ) const

inline

Get numeric range values.

Returns

Vector of ranges.

Definition at line 243 of file CmdArgDef.h.

References m_ranges.

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

      {
        return m_ranges;
      }

const std::string& rnr::cmd::CmdArgDef::getRegEx ( ) const

inline

Get regular expression value.

Returns

String value.

Definition at line 253 of file CmdArgDef.h.

References rnr::RegEx::getRegEx(), inRange(), and m_re.

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

      {
        return m_re.getRegEx();
      }

ArgType rnr::cmd::CmdArgDef::getType ( ) const

inline

Get argument's type.

Returns

Type enum.

Definition at line 214 of file CmdArgDef.h.

References m_eType.

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

      {
        return m_eType;
      }

bool CmdArgDef::inRange

(

const long

value

)

const

Check if value is in the specified range.

Parameters

value

Value to check.

Returns

Returns true or false.

Definition at line 222 of file CmdArgDef.cxx.

Referenced by getRegEx().

{
  return inRange((double)value);
}

bool rnr::cmd::CmdArgDef::isCommand ( ) const

inline

Test if argument is the command argument (argv0).

Returns

Returns true or false.

Definition at line 289 of file CmdArgDef.h.

References FlagCommand, and m_uFlags.

      {
        return (m_uFlags & FlagCommand) != 0;
      }

bool CmdArgDef::isDefined

(

)

const

Test if argument definition is sufficiently defined.

Returns

Returns true or false.

Definition at line 174 of file CmdArgDef.cxx.

{
  return (m_nIndex >= 0) && !m_strName.empty() && (m_eType != ArgTypeUndef);
}

bool rnr::cmd::CmdArgDef::isOptional ( ) const

inline

Test if argument is an optional argument.

Returns

Returns true or false.

Definition at line 299 of file CmdArgDef.h.

References constructLiteralList(), constructRangeList(), constructSyntax(), convert(), FlagOptional, lookupArgSymbol(), lookupArgType(), lookupFlagNames(), m_uFlags, match(), matchLiteral(), and operator<<.

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

      {
        return (m_uFlags & FlagOptional) != 0;
      }

const string & CmdArgDef::literalAt

(

const int

nIndex

)

const

Get literal value at index.

Parameters

nIndex

Index of literal in list.

Returns

String value.

Definition at line 205 of file CmdArgDef.cxx.

References rnr::cmd::noliteral.

Referenced by numOfLiterals(), and rnr::cmd::CommandLine::parseArgv0().

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

const string CmdArgDef::lookupArgSymbol ( const CmdArgDef::ArgType  eType )

static

Look up argument symbol, given argument type.

Parameters

eType

Type enum.

Returns

Type symbol string.

Definition at line 587 of file CmdArgDef.cxx.

References rnr::cmd::ArgTypeLookupTbl, rnr::cmd::NameValuePair::m_sName, and rnr::cmd::undefstring.

Referenced by isOptional(), lookupFlagNames(), rnr::cmd::CommandLine::matchCommandForm(), and rnr::cmd::CommandLine::parseVarMod().

{
  for(int i = 0; ArgTypeLookupTbl[i].m_sName != NULL; ++i)
  {
    if( eType == ArgTypeLookupTbl[i].m_nValue ) 
    {
      return ArgTypeLookupTbl[i].m_sName;
    }
  }
  return undefstring;
}

CmdArgDef::ArgType CmdArgDef::lookupArgType ( const std::string  strSymbol )

static

Look up argument type, given argument type symbol.

Parameters

strSymbol

Type Symbol.

Returns

Type enum.

Definition at line 575 of file CmdArgDef.cxx.

References rnr::cmd::ArgTypeLookupTbl, rnr::cmd::NameValuePair::m_nValue, and rnr::cmd::NameValuePair::m_sName.

Referenced by isOptional(), and rnr::cmd::CommandLine::parseVarType().

{
  for(int i = 0; ArgTypeLookupTbl[i].m_sName != NULL; ++i)
  {
    if( strSymbol == ArgTypeLookupTbl[i].m_sName )
    {
      return (CmdArgDef::ArgType)ArgTypeLookupTbl[i].m_nValue; 
    }
  }
  return CmdArgDef::ArgTypeUndef;
}

const string CmdArgDef::lookupFlagNames ( const unsigned  uFlags )

static

Look up argument flags, given flags value.

Parameters

uFlags

Bit or'ed list of flags.

Returns

String.

Definition at line 599 of file CmdArgDef.cxx.

References rnr::cmd::ArgFlagLookupTbl, constructLiteralList(), constructRangeList(), rnr::io::deltaindent(), rnr::io::indent(), lookupArgSymbol(), lookupFlagNames(), m_eType, m_literals, m_nCmdUid, m_nFormIndex, m_nIndex, m_ranges, m_re, rnr::cmd::NameValuePair::m_sName, m_strName, m_uFlags, and operator<<().

Referenced by isOptional(), and lookupFlagNames().

{
  stringstream  ss;
  string        sep;

  for(int i = 0; ArgFlagLookupTbl[i].m_sName != NULL; ++i)
  {
    if( uFlags & ArgFlagLookupTbl[i].m_nValue )
    {
      ss << sep << ArgFlagLookupTbl[i].m_sName;
      sep = "|";
    }
  }
  return ss.str();
}

double CmdArgDef::match	(	const std::string &	strArg,
		const bool	bIgnoreCase = false
	)		const

Match argument string against argument definition pattern.

The match weight returned is a heuristic measure of match strength. A value of 0.0 is no match, while anything > 0.0 is a match, with 1.0 being the best possible fit. With a matched weight assigned to each command argument, the best matched command applied to the input can be heuristically determined.

For Example:

Given two arguments whose syntax are specified as:

* girl
* <teen:word>
* 

Then the weights returned from the following match calls are:

* arg girl: match("girl") --> 1.00
* arg teen: match("girl") --> 0.91
* arg girl: match("boy")  --> 0.00
* arg teen: match("boy")  --> 0.91
* 

Parameters

strArg	Argument value.
bIgnoreCase	Do [not] ignore case when applying pattern matching.

Returns

Returns match weight [0.0 - 1.0].

Definition at line 326 of file CmdArgDef.cxx.

References rnr::cmd::isIdentifier(), rnr::str::lowercase(), rnr::str::tobool(), rnr::str::todouble(), and rnr::str::tolong().

Referenced by isOptional(), rnr::cmd::CommandLine::matchCommand(), rnr::cmd::CommandLine::matchCommandForm(), and rnr::cmd::CommandLine::rlArgDefs().

{
  double  fWeight = 0.0;

  switch( m_eType )
  {
    //
    // Literal constant.
    //
    case ArgTypeLiteral:
      if( matchLiteral(strArg, bIgnoreCase) >= 0 )
      {
        fWeight = 1.0;
      }
      break;

    //
    // Contiguous block of non-whitespace characters.
    //
    case ArgTypeWord:
      if( strArg.find_first_of(" \t\r\n\v\f") == string::npos )
      {
        fWeight = 0.91;
      }
      break;
      
    //
    // Any string.
    //
    case ArgTypeMultiWord:
      fWeight = 0.90;
      break;

    //
    // C conforming identifier.
    //
    case ArgTypeIdentifier:
      if( isIdentifier(strArg) )
      {
        fWeight = 0.94;
      }
      break;

    //
    // Boolean.
    //
    case ArgTypeBoolean:
      {
        bool  val;
        int   rc;
        if( bIgnoreCase )
        {
          rc = tobool(lowercase(strArg), val);
        }
        else
        {
          rc = tobool(strArg, val);
        }

        if( rc == OK )
        {
          fWeight = 0.95;
        }
      }
      break;

    //
    // (Signed) integer in base 8, 10, or 16.
    //
    case ArgTypeInteger:
      {
        long  val;
        if( (tolong(strArg, val) == OK) && inRange(val) )
        {
          fWeight = 0.95;
        }
      }
      break;

    //
    // Floating-point number.
    // 
    case ArgTypeFpn:
      {
        double val;
        if( (todouble(strArg, val) == OK) && inRange(val) )
        {
          fWeight = 0.95;
        }
      }
      break;

    //
    // Regular expression.
    //
    case ArgTypeRegEx:
      if( m_re.isValid() && m_re.match(strArg) )
      {
        fWeight = 0.93;
      }
      break;

    //
    // Filename.
    //
    case ArgTypeFile:
      fWeight = 0.91;
      break;

    //
    // Bug.
    //
    case ArgTypeUndef:
    default:
      stringstream ss;
      ss
        << "Bug: "
        << "cmduid " << m_nCmdUid << ", "
        << "form " << m_nFormIndex << ", "
        << "arg " << m_nIndex << ": "
        << m_eType << ": Unknown type.";
      LOGERROR("%s", ss.str().c_str());
      break;
  } 

  return fWeight;
}

int CmdArgDef::matchLiteral	(	const std::string &	strArg,
		const bool	bIgnoreCase = false
	)		const

Match argument agains literal enumeration list.

Parameters

strArg	Argument value.
bIgnoreCase	Do [not] ignore case when applying pattern matching.

Returns

On success, returns literal list index >= 0. Otherwise -1 is returned.

Definition at line 454 of file CmdArgDef.cxx.

References rnr::str::lowercase().

Referenced by isOptional().

{
  if( bIgnoreCase )
  {
    string strICaseArg = lowercase(strArg);

    for(size_t i = 0; i < numOfLiterals(); ++i)
    {
      if( strICaseArg == lowercase(literalAt(i)) )
      {
        return (int)i;
      }
    }
  }
  else
  {
    for(size_t i = 0; i < numOfLiterals(); ++i)
    {
      if( strArg == literalAt(i) )
      {
        return (int)i;
      }
    }
  }

  return -1;
}

int rnr::cmd::CmdArgDef::numOfLiterals ( ) const

inline

Get the number of mutually exclusive literals.

Returns

Number.

Definition at line 224 of file CmdArgDef.h.

References literalAt(), and m_literals.

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

CmdArgDef & CmdArgDef::operator=

(

const CmdArgDef &

rhs

)

Assignment operator.

Parameters

rhs	Right-hand side object.

Returns

*this

Definition at line 159 of file CmdArgDef.cxx.

References m_eType, m_literals, m_nCmdUid, m_nFormIndex, m_nIndex, m_ranges, m_re, m_strName, and m_uFlags.

{
  m_nCmdUid     = rhs.m_nCmdUid;
  m_nFormIndex  = rhs.m_nFormIndex;
  m_nIndex      = rhs.m_nIndex;
  m_strName     = rhs.m_strName;
  m_eType       = rhs.m_eType;
  m_literals    = rhs.m_literals;
  m_ranges      = rhs.m_ranges;
  m_re          = rhs.m_re;
  m_uFlags      = rhs.m_uFlags;

  return *this;
}

void CmdArgDef::orFlags ( const unsigned  uFlags )

protected

Or flags into argment modifier flags.

Parameters

uFlags

Bit list of flags.

Definition at line 251 of file CmdArgDef.cxx.

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

{
  m_uFlags |= uFlags;
}

void CmdArgDef::setIndex ( const int  nIndex )

protected

Set arguments's command line index.

Parameters

nIndex

Zero based index.

Definition at line 185 of file CmdArgDef.cxx.

Referenced by rnr::cmd::CmdFormDef::pushArg().

{
  m_nIndex = nIndex;
}

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

protected

Set argument's name.

Parameters

strName

Name string.

Definition at line 190 of file CmdArgDef.cxx.

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

{
  m_strName = strName;
}

void CmdArgDef::setParent ( const int  nCmdUid, const int  nFormIndex  )

protected

Set parent's command and form id's.

Parameters

nCmdUid	Command unique id.
nFormIndex	Zero based form index within command.

Definition at line 179 of file CmdArgDef.cxx.

Referenced by rnr::cmd::CmdFormDef::pushArg().

{
  m_nCmdUid     = nCmdUid;
  m_nFormIndex  = nFormIndex;
}

void CmdArgDef::setRanges ( const RangeVec &  ranges )

protected

Set numeric range values.

Parameters

ranges

Vector of ranges.

Definition at line 217 of file CmdArgDef.cxx.

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

{
  m_ranges = ranges;
}

void CmdArgDef::setRegEx ( const RegEx &  re )

protected

Set regular expression value.

Parameters

re	Regular expression.

Definition at line 246 of file CmdArgDef.cxx.

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

{
  m_re = re;
}

void CmdArgDef::setType ( const ArgType  eType )

protected

Set argument's type.

Parameters

eType

Type enum.

Definition at line 195 of file CmdArgDef.cxx.

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

{
  m_eType = eType;
}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const CmdArgDef &  argdef  )

friend

Insert object into output stream.

Parameters

os	Output stream.
argdef	Object to insert.

Returns

Reference to output stream.

Referenced by isOptional().

---

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

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