CCAFFEINE
0.8.8
|
#include <CmdAction.h>
Public Member Functions | |
virtual int | doIt (CmdContext *cc, JCPN(Vector)*args)=0 |
virtual char * | help ()=0 |
virtual char * | argtype ()=0 |
virtual char ** | names (int &len)=0 |
virtual int CmdAction::doIt | ( | CmdContext * | cc, |
JCPN(Vector)* | args | ||
) | [pure virtual] |
Does the action, called with the CmdContext of the interpreter and with a vector that matches the signature given by argtype(). The exit command returns 1; others return 0.
Implemented in CmdActionCCAPath, CmdActionCCAInstantiate, CmdActionHelp, CmdActionCCAGo, CmdActionCCARepository, CmdActionCCADisplay, CmdActionCCAShell, CmdActionCCAArena, CmdActionCCADebug, CmdActionCCALinks, CmdActionCCANoDebug, CmdActionCCAPallet, CmdActionCCAProperties, CmdActionCCAConfig, CmdActionCCAPortProperties, CmdActionExit, CmdActionCCAConnect, CmdActionCCADisconnect, CmdActionCCANuke, and CmdActionCCARemove.
virtual char* CmdAction::help | ( | ) | [pure virtual] |
Returns a string containing the description of this command.
Implemented in CmdActionCCAPath, CmdActionHelp, CmdActionCCAGo, CmdActionCCAInstantiate, CmdActionCCADisplay, CmdActionCCARepository, CmdActionExit, CmdActionCCAShell, CmdActionCCAArena, CmdActionCCAConnect, CmdActionCCADebug, CmdActionCCALinks, CmdActionCCANoDebug, CmdActionCCAPallet, CmdActionCCAProperties, CmdActionCCAConfig, CmdActionCCADisconnect, CmdActionCCAPortProperties, CmdActionCCANuke, and CmdActionCCARemove.
virtual char* CmdAction::argtype | ( | ) | [pure virtual] |
Describes the args Vector wanted by this Command.
This is our hack to get around stupid varargs-lessness in java. Each character indicates a separate user argument and its type. Type checked user input: C --> class named by user. c --> optional class named by user. I --> instance named by user. i --> optional instance named by user. S --> string token from user. s --> optional string token from user. K --> long token from user. k --> optional long token from user. D --> int token from user. d --> optional int token from user. B --> bool token from user. b --> optional bool token from user. G --> double token from user. g --> optional double token from user. * --> repeat previous character ad infinitum. can only appear last. Special (cannot be followed directly by *): A --> all of the line after the command name token as a single string. a --> all of the line after the command name token as optional string. L --> the list of known CmdActions. P --> the command parser itself.
Implemented in CmdActionHelp, CmdActionCCAPath, CmdActionExit, CmdActionCCAConnect, CmdActionCCADisconnect, CmdActionCCAGo, CmdActionCCADisplay, CmdActionCCAInstantiate, CmdActionCCAShell, CmdActionCCAArena, CmdActionCCARepository, CmdActionCCADebug, CmdActionCCALinks, CmdActionCCANoDebug, CmdActionCCAPallet, CmdActionCCAProperties, CmdActionCCAConfig, CmdActionCCAPortProperties, CmdActionCCANuke, and CmdActionCCARemove.
virtual char** CmdAction::names | ( | int & | len | ) | [pure virtual] |
name(s) of the function. Do not free them. on exit len is number of names.
Implemented in CmdActionHelp, CmdActionCCAPath, CmdActionExit, CmdActionCCAConnect, CmdActionCCADisconnect, CmdActionCCAGo, CmdActionCCADisplay, CmdActionCCAInstantiate, CmdActionCCARepository, CmdActionCCAShell, CmdActionCCAArena, CmdActionCCADebug, CmdActionCCALinks, CmdActionCCANoDebug, CmdActionCCAPallet, CmdActionCCAProperties, CmdActionCCAConfig, CmdActionCCAPortProperties, CmdActionCCANuke, and CmdActionCCARemove.