CommandTable Module Client Specifications

Purpose

Client Data Model

Importing Information

#include "LineScanner.h"
#include "CommandTable.h"

Public Data Types

• CommandProcedure - CommandProcedure is the type name for command procedure variables and parameters.

Public Functions

Command table construction

• void addCommand(char * syn, char * desc, CommandProcedure proc)
  addCommand(syn, desc, proc) adds a command to the command table. The parameter syn is a string that contains the name of the command, followed by names for its arguments. The parameter desc is a string that describes what the command does with its arguments. The parameter proc is the name of the procedure that executes the command.

• void executeCommand(LineScanner comm)
  executeCommand(comm) executes the command contained in comm. If there are any errors they are printed on stdout.

• void displayMenu(LineScanner args)
  displayMenu(args) displays a menu of all commands in the command table. The commands are displayed in the order that they were added. The parameter args is ignored.

• void doNothing(LineScanner args)
  doNothing(args) does nothing, treating the rest of the command line as a comment.

• void quit(LineScanner args)
  quit(args) terminates the program.