ucommon::shell::Option Class Reference

A base class used to create parsable shell options. More...

#include <shell.h>

Inheritance diagram for ucommon::shell::Option:

[legend]Collaboration diagram for ucommon::shell::Option:

[legend]

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=((void *) 0), char *value_type=((void *) 0), char *help=((void *) 0))
	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

---

Detailed Description

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.

Author:

David Sugar <dyfet@gnutelephony.org>

Definition at line 187 of file shell.h.

---

Constructor & Destructor Documentation

ucommon::shell::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.

Parameters:

	short_option	for single character code.
	long_option	for extended string.
	value_type	if -x value or -long=yyy.
	help	string, future use.

---

Member Function Documentation

virtual char* ucommon::shell::Option::assign

(

char *

value

)

[pure virtual]

Used to send option into derived receiver.

Parameters:

value

option that was received.

Returns:

NULL or error string to use.

Implemented in ucommon::shell::stringopt, ucommon::shell::charopt, ucommon::shell::numericopt, and ucommon::shell::counteropt.

void ucommon::shell::Option::disable

(

void

)

Disable a option.

Might happen if argv0 name suggests an option is no longer actively needed.

---

The documentation for this class was generated from the following file:

• ucommon/shell.h

---