Counter option for shell parsing. More...
#include <shell.h>
Inheritance diagram for ucommon::shell::counteropt:
Collaboration diagram for ucommon::shell::counteropt:
Public Member Functions | |
| counteropt (char short_option, const char *long_option=NULL, const char *help=NULL, const char *type="numeric", long def_value=0) | |
| operator bool () const | |
| operator long () const | |
| bool | operator! () const |
| long | operator* () const |
| counteropt & | operator= (long value) |
| void | set (long value) |
 Public Member Functions inherited from ucommon::shell::Option | |
| void | disable (void) |
| Disable a option. More... | |
| Option (char short_option=0, const char *long_option=NULL, const char *value_type=NULL, const char *help=NULL) | |
| Construct a shell parser option. More... | |
| Public Member Functions inherited from ucommon::LinkedObject | |
| void | delist (LinkedObject **root) |
| Locate and remove ourselves from a list of objects. More... | |
| void | enlist (LinkedObject **root) |
| Add our object to an existing linked list through a pointer. More... | |
| LinkedObject * | getNext (void) const |
| Get next effective object when iterating. More... | |
| bool | is_member (LinkedObject *list) const |
| Search to see if we are a member of a specific list. More... | |
| virtual void | release (void) |
| Release list, mark as no longer linked. More... | |
| virtual void | retain (void) |
| Retain by marking as self referenced list. More... | |
| Public Member Functions inherited from ucommon::ObjectProtocol | |
| 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 const char * | assign (const char *value) |
| Used to send option into derived receiver. More... | |
| Protected Member Functions inherited from ucommon::LinkedObject | |
| LinkedObject (LinkedObject **root) | |
| Construct base class attached to a chain of objects. More... | |
| LinkedObject () | |
| Construct base class unattached to anyone. More... | |
| LinkedObject (const LinkedObject &from) | |
Protected Attributes | |
| long | number |
| Protected Attributes inherited from ucommon::LinkedObject | |
| LinkedObject * | Next |
Additional Inherited Members | |
| Static Public Member Functions inherited from ucommon::shell::Option | |
| static LinkedObject * | first (void) |
| static void | reset (void) |
| Static Public Member Functions inherited from ucommon::LinkedObject | |
| static unsigned | count (const LinkedObject *root) |
| Count the number of linked objects in a list. More... | |
| static LinkedObject * | getIndexed (LinkedObject *root, unsigned index) |
| Get member by index. More... | |
| static void | purge (LinkedObject *root) |
| Release all objects from a list. More... | |
| Data Fields inherited from ucommon::shell::Option | |
| const char * | help_string |
| const char * | long_option |
| char | short_option |
| bool | trigger_option |
| const char * | uses_option |
Detailed Description
Counter option for shell parsing.
This offers a quick-use class to parse a shell flag, along with a numeric value that may be saved and a use counter, as multiple invocations is an error. Unlike numeric options, the short mode flag is a trigger option, and each use of the short flag is considered a counter increment.
Member Function Documentation
◆ assign()
|
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:
- ucommon/shell.h
