ucommon::shell::stringopt Class Reference

Text option for shell parsing. More...

#include <shell.h>

Inheritance diagram for ucommon::shell::stringopt:

Collaboration diagram for ucommon::shell::stringopt:

Public Member Functions
	operator bool () const
	operator const char * () const
bool	operator! () const
const char *	operator* () const
stringopt &	operator= (const char *string)
void	set (const char *string)
	stringopt (char short_option, const char *long_option=NULL, const char *help=NULL, const char *type="text", const char *def_text=NULL)
Public Member Functions inherited from ucommon::shell::Option
void	disable (void)
	Disable a option.
	Option (char short_option=0, const char *long_option=NULL, const char *value_type=NULL, const char *help=NULL)
	Construct a shell parser option.
Public Member Functions inherited from ucommon::LinkedObject
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.
LinkedObject *	getNext (void) const
	Get next effective object when iterating.
bool	is_member (LinkedObject *list) const
	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.
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.
Protected Member Functions inherited from ucommon::LinkedObject
	LinkedObject ()
	Construct base class unattached to anyone.
	LinkedObject (const LinkedObject &from)
	LinkedObject (LinkedObject **root)
	Construct base class attached to a chain of objects.

Protected Attributes
const char *	text
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.
static LinkedObject *	getIndexed (LinkedObject *root, unsigned index)
	Get member by index.
static void	purge (LinkedObject *root)
	Release all objects from a list.
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

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 295 of file shell.h.

Member Function Documentation

assign()

virtual const char * ucommon::shell::stringopt::assign ( const 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.

Here is the call graph for this function:

operator bool()

ucommon::shell::stringopt::operator bool ( ) const

inline

Definition at line 319 of file shell.h.

operator const char *()

ucommon::shell::stringopt::operator const char * ( ) const

inline

Definition at line 327 of file shell.h.

operator!()

bool ucommon::shell::stringopt::operator! ( ) const

inline

Definition at line 323 of file shell.h.

operator*()

const char * ucommon::shell::stringopt::operator* ( ) const

inline

Definition at line 331 of file shell.h.

operator=()

stringopt & ucommon::shell::stringopt::operator= ( const char * string )

inline

Definition at line 314 of file shell.h.

set()

void ucommon::shell::stringopt::set ( const char * string )

inline

Definition at line 310 of file shell.h.

Field Documentation

text

const char* ucommon::shell::stringopt::text

protected

Definition at line 303 of file shell.h.

---

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

• /builddir/build/BUILD/ucommon-7.0.0-build/ucommon-7.0.0/inc/ucommon/shell.h