Text option for shell parsing.
More...
#include <shell.h>
Public Member Functions |
| operator bool () |
| operator char * () |
bool | operator! () |
char * | operator* () |
void | set (char *string) |
| stringopt (char short_option, char *long_option=((void *) 0), char *help=((void *) 0), char *type="text", char *def_text=((void *) 0)) |
void | disable (void) |
| Disable a option.
|
| Option (char short_option=0, char *long_option=((void *) 0), char *value_type=((void *) 0), char *help=((void *) 0)) |
| Construct a shell parser option.
|
void | delist (OrderedIndex *index) |
| Remove our ordered object from an existing index.
|
virtual void | enlist (OrderedIndex *index) |
| List our ordered object in default strategy mode.
|
void | enlistHead (OrderedIndex *index) |
| List our ordered object at start of a linked list on an index.
|
void | enlistTail (OrderedIndex *index) |
| List our ordered object at end of a linked list on an index.
|
OrderedObject * | getNext (void) |
| Get next ordered member when iterating.
|
void | delist (LinkedObject **root) |
| Locate and remove ourselves from a list of objects.
|
void | enlist (LinkedObject **root) |
| Add our object to an existing linked list through a pointer.
|
bool | isMember (LinkedObject *list) |
| Search to see if we are a member of a specific list.
|
virtual void | release (void) |
| Release list, mark as no longer linked.
|
virtual void | retain (void) |
| Retain by marking as self referenced list.
|
ObjectProtocol * | copy (void) |
| Retain (increase retention of) object when copying.
|
void | operator++ (void) |
| Increase retention operator.
|
void | operator-- (void) |
| Decrease retention operator.
|
virtual | ~ObjectProtocol () |
| Required virtual destructor.
|
Protected Member Functions |
virtual char * | assign (char *value) |
| Used to send option into derived receiver.
|
Protected Attributes |
char * | text |
Additional Inherited Members |
static LinkedObject * | first (void) |
static void | reset (void) |
char * | help_string |
char * | long_option |
char | short_option |
bool | trigger_option |
char * | uses_option |
Detailed Description
Text option for shell parsing.
This offers a quick-use class to parse a shell flag, along with a numeric text that may be saved and a use counter, as multiple invocations is an error.
- Author:
- David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org
Definition at line 429 of file shell.h.
Member Function Documentation
virtual char* ucommon::shell::stringopt::assign |
( |
char * |
value | ) |
|
|
protectedvirtual |
Used to send option into derived receiver.
- Parameters:
-
value | option that was received. |
- Returns:
- NULL or error string to use.
Implements ucommon::shell::Option.
The documentation for this class was generated from the following file: