objtree Namespace Reference [Object Tree API]

Classes
struct	property_t
	abstraction of a general property of an object More...
struct	property_set_t
	a set of properties. More...
class	List
	How you interact with this object is the key to the objtree library. More...
class	Tree
	the root object for discovering objects More...
struct	color_t
struct	font_t
Functions
static void	verifyLowerCase (IN const char *p)
static bool	idMatchesQuery (IN const char *id, IN const char *query)
bool	isValidPropertyName (IN const char *candidate_name) throw ()
	returns true if the given name is an acceptable property name
bool	isTrue (IN const char *text) throw ()
void	persist (IN const property_t &p, OUT std::string &val)
void	depersist (IN const char *text, OUT property_t &prop)
void	save (IN std::ostream &stream, IN const property_set_t &pset)
void	load (IN std::istream &stream, OUT property_set_t &pset)
smart_ptr< Datahash >	getDatahash (IN const property_set_t &pset)
	given a property set, serialize into a datahash object
void	getPropertySet (IN const Datahash *hash, OUT property_set_t &pset)
	given a datahash, deserialize into a property set
static bool	getBoolean (IN const dictionary_t &data, IN const char *key)
static void	addBooleanIfTrue (IO std::ostream &out, IN const char *key, IN bool val)
static void	addPrettyIfTrue (IO std::ostream &out, IN const char *key, IN bool val)
static std::string	escape (IN const char *p)
static std::string	unescape (IN const char *p)
static void	validateColorComponent (IN int x)
static void	addColorComponent (IO std::string &s, IN const char *tag, IN int x, IN int default_value)
color_t	getColorFromString (IN const char *text)
void	getStringFromColor (IN const color_t &c, OUT std::string &s)
void	getFontFromString (IN const char *info, OUT font_t &font)
void	getStringFromFont (IN const font_t &font, OUT std::string &out)
void	getDisplayStringFromFont (IN const font_t &font, OUT std::string &out)
Variables
static const char	s_escape = (char) 205

---

Function Documentation

static void objtree::verifyLowerCase

(

IN const char *

p

)

[static]

Definition at line 52 of file objtree.cpp.

static bool objtree::idMatchesQuery	(	IN const char *	id,
		IN const char *	query
	)			[static]

Definition at line 66 of file objtree.cpp.

bool objtree::isValidPropertyName

(

IN const char *

candidate_name

)

throw ()

returns true if the given name is an acceptable property name

property names are very restricted! alphanumerics and hyphens only goal is names that do not need to be URL encoded etc

void objtree::persist	(	IN const property_t &	p,
		OUT std::string &	val
	)

Definition at line 499 of file objtree.cpp.

void objtree::depersist	(	IN const char *	text,
		OUT property_t &	prop
	)

Definition at line 516 of file objtree.cpp.

void objtree::save	(	IN std::ostream &	stream,
		IN const property_set_t &	pset
	)

Definition at line 544 of file objtree.cpp.

void objtree::load	(	IN std::istream &	stream,
		OUT property_set_t &	pset
	)

Definition at line 567 of file objtree.cpp.

static bool objtree::getBoolean	(	IN const dictionary_t &	data,
		IN const char *	key
	)			[static]

Definition at line 50 of file prop_types.cpp.

static void objtree::addBooleanIfTrue	(	IO std::ostream &	out,
		IN const char *	key,
		IN bool	val
	)			[static]

Definition at line 65 of file prop_types.cpp.

static void objtree::addPrettyIfTrue	(	IO std::ostream &	out,
		IN const char *	key,
		IN bool	val
	)			[static]

Definition at line 83 of file prop_types.cpp.

static std::string objtree::escape

(

IN const char *

p

)

[static]

Definition at line 97 of file prop_types.cpp.

static std::string objtree::unescape

(

IN const char *

p

)

[static]

Definition at line 118 of file prop_types.cpp.

static void objtree::validateColorComponent

(

IN int

x

)

[static]

Definition at line 139 of file prop_types.cpp.

static void objtree::addColorComponent	(	IO std::string &	s,
		IN const char *	tag,
		IN int	x,
		IN int	default_value
	)			[static]

Definition at line 153 of file prop_types.cpp.

color_t objtree::getColorFromString

(

IN const char *

text

)

void objtree::getStringFromColor	(	IN const color_t &	c,
		OUT std::string &	s
	)

void objtree::getFontFromString	(	IN const char *	info,
		OUT font_t &	font
	)

void objtree::getStringFromFont	(	IN const font_t &	font,
		OUT std::string &	out
	)

void objtree::getDisplayStringFromFont	(	IN const font_t &	font,
		OUT std::string &	out
	)

---

Variable Documentation

const char objtree::s_escape = (char) 205 [static]

Definition at line 39 of file prop_types.cpp.