DynaShellCmdHelp Class Reference

Help command. More...

Inheritance diagram for DynaShellCmdHelp:

Public Member Functions
void	Exec (DynaShell &shell, int argc, char *argv[])
	Print help. More...
virtual char *	TabCompletion (DynaShell &shell, const char *sText, size_t uTextLen, int nState, const char *sContext)
	Command tab completion generator. More...
Public Member Functions inherited from DynaShellCmd
	DynaShellCmd (int nArgCntMin=0, int nArgCntMax=0)
	Default constructor.
virtual	~DynaShellCmd ()
	Default destructor.
const char *	GetCmdName ()
	Get dynamixel shell command name. More...
const char *	GetCmdHelpBrief ()
	Get shell command name brief description. More...
virtual void	PrintHelp (int indent=0, int width=80)
	Print command help with the description aligned at the given indentation. More...
int	GetPublishedLevel () const
const char *	GetPublishedName () const
int	SetPublishedInfo (int nLevel, const char *sParent=NULL)
virtual bool	ChkArgCnt (DynaShell &shell, int argc)
	Check that the argument count is within the class (min,max). More...
bool	ChkArgCnt0 (DynaShell &shell, int argc)
	Check that the argument count is zero. More...
bool	ChkArgCntEQ (DynaShell &shell, int argc, int eq)
	Check that the argument count is equal to the required. More...
bool	ChkArgCntGE (DynaShell &shell, int argc, int min)
	Check argument count against minimum required. More...
bool	ChkArgCntLE (DynaShell &shell, int argc, int max)
	Check argument count against maximum allowed. More...
bool	ChkComm (DynaShell &shell)
	Check that Dynamixel communication exists and is open. More...
bool	ChkChain (DynaShell &shell)
	Check that the servo chain exists. More...
bool	ChkChainNotEmpty (DynaShell &shell)
	Check that the servo chain exists and is not empty. More...
bool	ChkChainHasServo (DynaShell &shell, int nServoId)
	Check that the given servo is present in the chain. More...
bool	ChkChainIsMasterServo (DynaShell &shell, int nServoId)
	Check that the given servo is a master. More...
bool	ToInt (DynaShell &shell, const char *sArg, int *pVal)
	Convert command argument to integer. More...
bool	ToUInt (DynaShell &shell, const char *sArg, uint_t *pVal)
	Convert command argument to unsigned integer. More...
bool	ToDouble (DynaShell &shell, const char *sArg, double *pVal)
	Convert command argument to double. More...
bool	ToBool (DynaShell &shell, const char *sArg, bool *pVal)
	Convert command argument to boolean. More...

Protected Member Functions
void	PrintHelpWordList (DynaShell &shell, ShCmdMap &cmdMap)
	Print help list of words. More...
void	PrintHelpSummaryList (DynaShell &shell, ShCmdMap &cmdMap)
	Print help summary list. More...
ShCmdNode &	MatchHelp (DynaShell &shell, int argc, char *argv[], ShCmdMap &cmdMap)
	Match command. More...
Protected Member Functions inherited from DynaShellCmd
virtual void	PrintSynopses (int indent, int width)
	Print synsopses. More...
virtual void	PrintBlock (int col, int indent, int width, const char *sText)
	Print a block of indented text of width. More...
virtual void	PrintDelim (int width, const char cDelim)
char *	eow (const char *s)
	Find end of word. More...

Additional Inherited Members
Protected Attributes inherited from DynaShellCmd
const char *	m_sCmdName
	command name
const char *	m_sCmdHelpBrief
	command help brief
const char *	m_sCmdHelpArgs
	command help arguments
const char *	m_sCmdHelpDesc
	command help description
const int	m_nArgCntMin
	minimum argument count
const int	m_nArgCntMax
	maximum argument count (0 if not max)
int	m_nPubLevel
	command's published level (depth)
char *	m_sPubName
	command's published name

Detailed Description

Help command.

Definition at line 117 of file dynashell_cmd_core.cxx.

Member Function Documentation

void DynaShellCmdHelp::Exec ( DynaShell &  shell, int  argc, char *  argv[]  )

inlinevirtual

Print help.

Parameters

shell	Dynamixel shell.
argc	Command argument count.
argv	Array of arguments.

Implements DynaShellCmd.

Definition at line 150 of file dynashell_cmd_core.cxx.

References DynaShell::Error(), ShCmdNode::GetCmd(), ShCmdNode::GetMap(), DynaShell::GetRootCmds(), ShCmdNode::IsCmd(), ShCmdNode::IsMap(), DynaShellCmd::PrintHelp(), and TRY.

  {
    ShCmdNode   cmdNode;

    TRY( ChkArgCnt(shell, argc) );

    // print root command list
    if( argc == 0 )
    {
      //PrintHelpWordList(shell, shell.GetRootCmds());
      PrintHelpSummaryList(shell, shell.GetRootCmds());
      printf("\n");
      return;
    }

    cmdNode = MatchHelp(shell, argc, argv, shell.GetRootCmds());

    // print command object list
    if( cmdNode.IsMap() )
    {
      // PrintHelpWordList(shell, *cmdNode.GetMap());
      PrintHelpSummaryList(shell, *cmdNode.GetMap());
      printf("\n");
    }

    // print long help.
    else if( cmdNode.IsCmd() )
    {
      cmdNode.GetCmd()->PrintHelp();
      printf("\n");
    }

    // print error 1
    else if( argc == 1 )
    {
      shell.Error("help: Unknown command \"%s\".", argv[0]);
    }

    // or print error 2
    else
    {
      shell.Error("help: Unknown command \"%s %s\".", argv[0], argv[1]);
    }
  }

ShCmdNode& DynaShellCmdHelp::MatchHelp ( DynaShell &  shell, int  argc, char *  argv[], ShCmdMap &  cmdMap  )

inlineprotected

Match command.

Parameters

shell	Dynamixel shell.
argc	Command argument count.
argv	Array of arguments.
cmdMap	Command map to search.

Returns

Shell command node.

Definition at line 286 of file dynashell_cmd_core.cxx.

References DynaShell::Error().

  {
    static ShCmdNode    cmdNull;

    ShCmdMap::iterator  iter1, iter2;
    char               *sPattern;
    const char         *sCmdName1, *sCmdName2;
    size_t              n;
  
    if( argc == 0 )
    {
      return cmdNull;
    }

    sPattern = argv[0];

    n = strlen(sPattern);

    // find command
    for(iter1=cmdMap.begin(); iter1!=cmdMap.end(); iter1++)
    {
      sCmdName1 = iter1->first;
      if( !strncmp(sPattern, sCmdName1, n) )
      {
        break;
      }
    }

    // no matching command found
    if( iter1 == cmdMap.end() )
    {
      return cmdNull;
    }

    // verify uniqueness
    for(iter2=cmdMap.begin(); iter2!=cmdMap.end(); iter2++)
    {
      if( iter2 == iter1 )
      {
        continue;
      }

      sCmdName2 = iter2->first;

      // another match 
      if( !strncmp(sPattern, sCmdName2, n) )
      {
        shell.Error("help: %s: (Sub)Command not unique: Matches %s %s ...",
            sPattern, sCmdName1, sCmdName2);
        return cmdNull;
      }
    }

    if( argc == 1 )
    {
      return iter1->second;
    }
    else if( (argc == 2) && iter1->second.IsMap() )
    {
      return MatchHelp(shell, argc-1, argv+1, *iter1->second.GetMap());
    }
    else
    {
      return cmdNull;
    }
  }

void DynaShellCmdHelp::PrintHelpSummaryList ( DynaShell &  shell, ShCmdMap &  cmdMap  )

inlineprotected

Print help summary list.

Parameters

shell	Dynamixel shell.
cmdMap	Command map to print.

Definition at line 266 of file dynashell_cmd_core.cxx.

  {
    ShCmdMap::iterator  iter;

    for(iter=cmdMap.begin(); iter!=cmdMap.end(); iter++)
    {
      printf("%15s - %s\n", iter->first, iter->second.GetMapBrief().c_str());
    }
  }

void DynaShellCmdHelp::PrintHelpWordList ( DynaShell &  shell, ShCmdMap &  cmdMap  )

inlineprotected

Print help list of words.

Parameters

shell	Dynamixel shell.
cmdMap	Command map to print.

Definition at line 248 of file dynashell_cmd_core.cxx.

  {
    ShCmdMap::iterator  iter;

    for(iter=cmdMap.begin(); iter!=cmdMap.end(); iter++)
    {
      printf("%s ", iter->first);
    }

    printf("\n");
  }

virtual char* DynaShellCmdHelp::TabCompletion ( DynaShell &  shell, const char *  sText, size_t  uTextLen, int  nState, const char *  sContext  )

inlinevirtual

Command tab completion generator.

Completes <group> [object]

Parameters

shell	Dynamixel shell.
sText	Partial text string to complete.
uTextLen	Length of text.
nState	Generator state. If FIRST, then initialize any statics.
sContext	Generator context (i.e. canonical command path).

Returns

If a first/next match is made, return allocated completed match.
Otherwise return NULL.

Reimplemented from DynaShellCmd.

Definition at line 210 of file dynashell_cmd_core.cxx.

References DynaShell::CmdListGenerator().

  {
    size_t      uCmdLen = strlen(m_sPubName);
    const char *sSubContext;

    // this case should not happen
    if( strlen(sContext) < uCmdLen )
    {
      return NULL;
    }

    // "help"
    else if( strlen(sContext) == uCmdLen )
    {
      sSubContext = "";
    }

    // "help group "
    else
    {
      sSubContext = sContext+uCmdLen+1;
    }

    return shell.CmdListGenerator(0, sText, uTextLen, nState, sSubContext);
  }

---

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

• dynashell/dynashell_cmd_core.cxx