CommandSyntax Class Reference

#include <Command.h>

Collaboration diagram for CommandSyntax:

Public Member Functions
	CommandSyntax (const char *help, void(*syntaxCall)(ParsedCommand *, int), const int mode)
void	addArg (CommandArg *arg)
CommandArg *	getArg (int index) const
int	getRequiredArgSize (unsigned int currentArgs)
int	getArgCount () const
void	call (ParsedCommand *parsedCommand)
CommandSyntax *	getAltSyntax ()
void	setAltSyntax (CommandSyntax *altSyntax)
void	help (const char *keyword, FILE *out) const

Protected Attributes
FlexArray< CommandArg * >	args_
int	argCount_
const char *	help_
void(*	syntaxCall_ )(ParsedCommand *, int)
int	mode_
CommandSyntax *	altSyntax_

Private Member Functions
	CommandSyntax (const CommandSyntax &old)

Constructor & Destructor Documentation

CommandSyntax::CommandSyntax ( const char *  help, void(*)(ParsedCommand *, int)  syntaxCall, const int  mode  )

inline

CommandSyntax::CommandSyntax ( const CommandSyntax &  old )

private

Member Function Documentation

void CommandSyntax::addArg ( CommandArg *  arg )

inline

References argCount_, args_, and FlexArray< T >::push().

Referenced by Command::addArg().

void CommandSyntax::call ( ParsedCommand *  parsedCommand )

inline

References mode_, and syntaxCall_.

Referenced by ParsedCommand::execute().

CommandSyntax* CommandSyntax::getAltSyntax ( )

inline

References altSyntax_.

Referenced by ParsedCommand::findArg().

CommandArg* CommandSyntax::getArg ( int  index ) const

inline

References args_, and FlexArray< T >::get().

Referenced by CommandLine::commandShowDependencies(), ParsedCommand::findArg(), CommandLine_Test::testParse(), and ParsedCommand::toString().

int CommandSyntax::getArgCount ( ) const

inline

References argCount_.

Referenced by ParsedCommand::findArg(), ParsedCommand::parseBufferEnd(), and CommandLine_Test::testParse().

int CommandSyntax::getRequiredArgSize ( unsigned int  currentArgs )

inline

References args_, FlexArray< T >::get(), CommandArg::getRequired(), REQUIRED, REQUIRED_AFTER_PREVIOUS, and FlexArrayBase::size().

Referenced by ParsedCommand::implySyntax(), and ParsedCommand::syntaxOk().

void CommandSyntax::help ( const char *  keyword, FILE *  out  ) const

inline

References argCount_, args_, FlexArray< T >::get(), CommandArg::getRequired(), CommandArg::help(), help_, NOT_REQUIRED, and REQUIRED_AFTER_PREVIOUS.

Referenced by Command::help().

void CommandSyntax::setAltSyntax ( CommandSyntax *  altSyntax )

inline

References altSyntax_.

Referenced by ParsedCommand::findArg(), and ParsedCommand::implySyntax().

Member Data Documentation

CommandSyntax* CommandSyntax::altSyntax_

protected

Referenced by getAltSyntax(), and setAltSyntax().

int CommandSyntax::argCount_

protected

Referenced by addArg(), getArgCount(), and help().

FlexArray<CommandArg*> CommandSyntax::args_

protected

Referenced by addArg(), getArg(), getRequiredArgSize(), and help().

const char* CommandSyntax::help_

protected

Referenced by help().

int CommandSyntax::mode_

protected

Referenced by call().

void( * CommandSyntax::syntaxCall_) (ParsedCommand *, int)

protected

Referenced by call().

---

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

• /Volumes/ubuntu_share/lrauv-application/Source/supervisor/Command.h