A base class used to create parsable shell options. More...
#include <shell.h>
Public Member Functions | |
virtual char * | assign (char *value)=0 |
Used to send option into derived receiver. | |
void | disable (void) |
Disable a option. | |
Option (char short_option=0, char *long_option=NULL, char *value_type=NULL, char *help=NULL) | |
Construct a shell parser option. | |
Static Public Member Functions | |
static LinkedObject * | first (void) |
static void | reset (void) |
Data Fields | |
char * | help_string |
char * | long_option |
char | short_option |
bool | trigger_option |
char * | uses_option |
A base class used to create parsable shell options.
The virtual is invoked when the shell option is detected. Both short and long forms of argument parsing are supported. An instance of a derived class is created to perform the argument parsing.
Definition at line 314 of file shell.h.
ucc::shell::Option::Option | ( | char | short_option = 0 , |
|
char * | long_option = NULL , |
|||
char * | value_type = NULL , |
|||
char * | help = NULL | |||
) |
Construct a shell parser option.
short_option | for single character code. | |
long_option | for extended string. | |
value_type | if -x value or -long=yyy. | |
help | string, future use. |
virtual char* ucc::shell::Option::assign | ( | char * | value | ) | [pure virtual] |
Used to send option into derived receiver.
value | option that was received. |
Implemented in ucc::shell::stringopt, ucc::shell::charopt, ucc::shell::numericopt, and ucc::shell::counteropt.
void ucc::shell::Option::disable | ( | void | ) |
Disable a option.
Might happen if argv0 name suggests an option is no longer actively needed.