CConfigurator Class Reference

#include <Configurator.h>

Collaboration diagram for CConfigurator:

Detailed Description

Definition at line 119 of file Configurator.h.


Public Member Functions
	CConfigurator (class CConfigurator parent, char name, char value, char text, size_t textlen)
	Constructor.
	~CConfigurator (void)
	Destructor.
char *	strip_string (char *c)
	Reduce a quoted string to it's real value.
void	add_value (char n, char v)
	Add a value to our list of values.
char *	get_text_value (const char *n)
char *	get_text_value (const char n, const char def)
	Return a text value, if the name of the value can't be found in our list of values, return def.
bool	get_bool_value (const char *n)
bool	get_bool_value (const char *n, bool def)
	Return a boolean value, if the name of the value can't be found in our list of values, or if the value isn't valid, return def.
u64	get_num_value (const char *n, bool decimal_suffixes)
u64	get_num_value (const char *n, bool decimal_suffixes, u64 def)
	Return a numeric value, if the name of the value can't be found in our list of values, return def.
classid	get_class_id ()
void *	get_device ()
int	get_flags ()
char *	get_myName ()
char *	get_myValue ()
CConfigurator *	get_myParent ()
void	initialize ()
	Determine what device this configurator represents, and instantiate it; then call initialize for our children.
Private Attributes
class CConfigurator *	pParent
class CConfigurator *	pChildren [25]
int	iNumChildren
char *	myName
char *	myValue
void *	myDevice
classid	myClassId
int	myFlags
int	iNumValues
struct CConfigurator::SCfg_Value	pValues [50]
Data Structures
struct	SCfg_Value

Constructor & Destructor Documentation

CConfigurator::CConfigurator	(	class CConfigurator *	parent,
		char *	name,
		char *	value,
		char *	text,
		size_t	textlen
	)

Constructor.

The portion of the configuration file that corresponds with the device we are the configurator for is passed as text, with a length of textlen. We parse this text portion, creating values and children configurators as needed. If parent is NULL, we are the master configurator, and we will call initialize for our children (probably GUI and System) so they can instantiate the classes that correspond to the devices that they configure for. The children will in turn initialize their children.

Bug:: This needs to be more robust! As it is now, this code was more or less "hacked together" in a few minutes. Also, more comments should be provided to make it more readable.

Definition at line 157 of file Configurator.cpp.

References add_value(), FAILURE_2, FAILURE_3, initialize(), iNumChildren, iNumValues, myFlags, myName, myValue, pChildren, pParent, and strip_string().

CConfigurator::~CConfigurator ( void )

Destructor.

Bug:

This does nothing now; it should:

if we are a top-level component (System or GUI) delete the component (which will delete the components children).
delete our children.
free memory we allocated for values.

Definition at line 484 of file Configurator.cpp.

Member Function Documentation

char * CConfigurator::strip_string ( char * c )

Reduce a quoted string to it's real value.

Some values are enclosed in double quotes("), in this case, we take off the quotes, and replace all double double quotes ("") with single double quotes ("). Quoting values is particularly useful if values contain forbidden characters such as spaces, quotes, semicolons, etc. e.g. a text like "c:\program files\putty\putty.exe" telnet://localhost:8000 should be quoted as """c: files\putty\putty.exe"" telnet://localhost:8000"

Definition at line 497 of file Configurator.cpp.

Referenced by CConfigurator().