WBA_Shell

wba

1998 12-05

CLASS

WBA_Shell - C++ well-behaved shell

SYNOPSIS

WBA_Shell class provides standard semantics for well-behaved shells. This is an abstract base class and must be extended prior to use. Derived classes should provide their own version of Process().

CONSTRUCTOR

WBA_Shell(WBA_Application * current)

WBA_Application::WBA_Application

PARENTS

WBA_Application

public

MEMBER FUNCTIONS

virtual int Main(void)

continueProcessing

FALSE

Print prompt
Print the current prompt (see SetPrompt()).
Get line of input
Get a line of input from the standard input device.
Check for command
Check to see if the first word of the input is a valid command. If so, execute the command. If not, print a list of valid commands.
Do Process()
Call the Process() member function.

WBA_Application::exitCode

void SetPrompt(const GPL_String & p)
Set the shell prompt. The default shell prompt is the application name (as returned by GetName()).

void AddCommand(WBA_CommandHandler *command)
Add the command handler, command. In Main() a list of command handlers is maintained against which input lines are checked. If an input line matches a command handler the command handler's HandleCommand() method is called.

void RemoveCommand(WBA_CommandHandler *command)
Remove the command handler, command.

void DoneProcessing(void)
Set continueProcessing to FALSE.

void PrintHandlerHelp(WBA_CommandHandler *handler)
Print the help for the command handler, handler.

void AddCommandInput(const GPL_String & string)
Add the line, string to the input to the shell.

void SetEchoMode(const GPL_Boolean mode)
If mode is TRUE, enables the display of commands which are executed. If mode is FALSE disables such display.

void SetInputEchoMode(const GPL_Boolean mode)
If mode is TRUE, enables the display of characters which are typed. If mode is FALSE, disables such display.

void SetLineInterpreter(WBA_LineInterpreter *i)
Set the line interpreter used to interpret input lines to i. The default is an object-specific instance of WBA_BourneShellLineInterpreter.

void PrintCommands(void)
Print all the valid commands.

virtual void Process(void)
Perform functionality of the shell that may not be command-specific.

MEMBER DATA

GPL_Boolean continueProcessing

WBA_Shell::Main()