<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU CommonC++: ost::Keydata Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_keydata.html">Keydata</a>
</div>
</div>
<div class="contents">
<h1>ost::Keydata Class Reference</h1><!-- doxytag: class="ost::Keydata" --><!-- doxytag: inherits="ost::MemPager" -->
<p><a class="el" href="classost_1_1_keydata.html" title="Keydata objects are used to load and hold "configuration" data for a given...">Keydata</a> objects are used to load and hold "configuration" data for a given application.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="misc_8h_source.html">misc.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::Keydata:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_keydata.png" usemap="#ost::Keydata_map" alt=""/>
<map id="ost::Keydata_map" name="ost::Keydata_map">
<area href="classost_1_1_mem_pager.html" alt="ost::MemPager" shape="rect" coords="0,0,95,24"/>
</map>
</div>
</div>
<p><a href="classost_1_1_keydata-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structost_1_1_keydata_1_1_define.html">Define</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structost_1_1_keydata_1_1_keysym.html">Keysym</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structost_1_1_keydata_1_1_keyval.html">Keyval</a></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#aaa445cbcd2cb56f8fab7e3063a55ba24">load</a> (const char *keypath)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load additional key values into the currrent object from the specfied config source (a config file/section pair). <a href="#aaa445cbcd2cb56f8fab7e3063a55ba24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#ad5c9a37238043d8daf932e0fdc9c64e1">loadPrefix</a> (const char *prefix, const char *keypath)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load additional key values into the currrent object from the specfied config source (a config file/section pair). <a href="#ad5c9a37238043d8daf932e0fdc9c64e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a739656231534d299d250d7ac85cb5b52">loadFile</a> (const char *filepath, const char *keys=NULL, const char *pre=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load additional keys into the current object using a real filename that is directly passed rather than a computed key path. <a href="#a739656231534d299d250d7ac85cb5b52"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a824f678a4920e40704ae17ef70b47290">load</a> (<a class="el" href="structost_1_1_keydata_1_1_define.html">Define</a> *pairs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load default keywords into the current object. <a href="#a824f678a4920e40704ae17ef70b47290"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a7b38a93f1804700e069c071e7e71ec82">Keydata</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty key data object. <a href="#a7b38a93f1804700e069c071e7e71ec82"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a5d1fabffff1ebfef8b8ef3fcb610497d">Keydata</a> (const char *keypath)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new key data object and use "Load" method to load an initial config file section into it. <a href="#a5d1fabffff1ebfef8b8ef3fcb610497d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a2ffbfc1fc3162cf22bfd3699a61aa58b">Keydata</a> (<a class="el" href="structost_1_1_keydata_1_1_define.html">Define</a> *pairs, const char *keypath=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Alternate constructor can take a define list and an optional pathfile to parse. <a href="#a2ffbfc1fc3162cf22bfd3699a61aa58b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#aea7231d3fea8750126d1904699638c94">~Keydata</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the keydata object and all allocated memory. <a href="#aea7231d3fea8750126d1904699638c94"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a5a9b6469b627a674e5e9856707732b29">unlink</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unlink the keydata object from the cache file stream. <a href="#a5a9b6469b627a674e5e9856707732b29"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a5d2ee13740be6e901db41dfb0e0033b6">getCount</a> (const char *sym)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a count of the number of data "values" that is associated with a specific keyword. <a href="#a5d2ee13740be6e901db41dfb0e0033b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a2412a569a18725e0368f445f4f1cc07a">getFirst</a> (const char *sym)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the first data value for a given keyword. <a href="#a2412a569a18725e0368f445f4f1cc07a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#ab2286284aff76cf9e310698ff6f22107">getLast</a> (const char *sym)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the last (most recently set) value for a given keyword. <a href="#ab2286284aff76cf9e310698ff6f22107"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a73ef6b10342042f626b109c24e821b22">isKey</a> (const char *sym)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find if a given key exists. <a href="#a73ef6b10342042f626b109c24e821b22"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a7fcd3ce05319e4268064386784a714c5">getString</a> (const char *sym, const char *def=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a string value, with an optional default if missing. <a href="#a7fcd3ce05319e4268064386784a714c5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#ad950a91035be68c3b790dc783d286651">getLong</a> (const char *sym, long def=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a long value, with an optional default if missing. <a href="#ad950a91035be68c3b790dc783d286651"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a297f5a7239a22576f770b038baac564f">getBool</a> (const char *key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a bool value. <a href="#a297f5a7239a22576f770b038baac564f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a727c000bb0cbbe8132d676e00e4b7424">getDouble</a> (const char *key, double def=0.)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a floating value. <a href="#a727c000bb0cbbe8132d676e00e4b7424"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a85b680ae3a530b5261c9e4993365e6cd">getIndex</a> (char **data, unsigned max)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an index array of ALL keywords that are stored by the current keydata object. <a href="#a85b680ae3a530b5261c9e4993365e6cd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a177f94fc01430d2f5e4a79cbbea64b03">getCount</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the count of keyword indexes that are actually available so one can allocate a table to receive getIndex. <a href="#a177f94fc01430d2f5e4a79cbbea64b03"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a815ad7e73ec110d57f205f8971972a0c">setValue</a> (const char *sym, const char *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set (replace) the value of a given keyword. <a href="#a815ad7e73ec110d57f205f8971972a0c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *const * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#affdaf274202fe5bb12b6dc720f2cb3b7">getList</a> (const char *sym)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a list of all values set for the given keyword returned in order. <a href="#affdaf274202fe5bb12b6dc720f2cb3b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a68af2fafb65d0d583d62c351faca42cd">clrValue</a> (const char *sym)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear all values associated with a given keyword. <a href="#a68af2fafb65d0d583d62c351faca42cd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a1891928115aa1007abe42d81a695c205">operator[]</a> (const char *keyword)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A convient notation for accessing the keydata as an associative array of keyword/value pairs through the [] operator. <a href="#a1891928115aa1007abe42d81a695c205"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#af16246e1f7c5af075493bf37d7e1b48f">end</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">static member to end keydata i/o allocations. <a href="#af16246e1f7c5af075493bf37d7e1b48f"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structost_1_1_keydata_1_1_keysym.html">Keysym</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#a76bcec1ca452d8811d797a7fea2c9e96">getSymbol</a> (const char *sym, bool create)</td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#ab2cdccf30c8543716905fbc6dfa29c92">endKeydata</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shutdown the file stream cache. <a href="#ab2cdccf30c8543716905fbc6dfa29c92"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classost_1_1_keydata.html" title="Keydata objects are used to load and hold "configuration" data for a given...">Keydata</a> objects are used to load and hold "configuration" data for a given application. </p>
<p>This class is used to load and then hold "<code>keyword = value</code>" pairs parsed from a text based "config" file that has been divided into "<code>[sections]</code>". The syntax is:</p>
<p><code></p>
<pre>
[section_name]
key1=value1
key2=value2</pre><p></code></p>
<p>Essentially, the "path" is a "keypath" into a theoretical namespace of key pairs, hence one does not use "real" filepaths that may be OS dependent. The "<code>/</code>" path refers to "<code>/etc</code>" prefixed (on UNIX) directories and this is processed within the constructor. It could refer to the <code>/config</code> prefix on QNX, or even, gasp, a "<code>C:\WINDOWS</code>". Hence, a keypath of "<code>/bayonne.d/vmhost/smtp</code>" actually resolves to a "<code>/etc/bayonne.d/vmhost.conf</code>" and loads key value pairs from the <code>[smtp]</code> section of that <code>.conf</code> file.</p>
<p>Similarly, something like "<code>~bayonne/smtp</code>" path refers to a "<code>~/.bayonnerc</code>" and loads key pairs from the <code>[smtp]</code> section. This coercion occurs before the name is passed to the open call.</p>
<p>I actually use derived keydata based classes as global initialized objects, and they hence automatically load and parse config file entries even before "main" has started.</p>
<p><a class="el" href="classost_1_1_keydata.html" title="Keydata objects are used to load and hold "configuration" data for a given...">Keydata</a> can hold multiple values for the same key pair. This can occur either from storing a "list" of data items in a config file, or when overlaying multiple config sources (such as <code>/etc/....conf</code> and <code>~/.confrc</code> segments) into a single object. The keys are stored as cumulative (read-only/replacable) config values under a hash index system for quick retrieval.</p>
<p><a class="el" href="classost_1_1_keydata.html" title="Keydata objects are used to load and hold "configuration" data for a given...">Keydata</a> can also load a table of "initialization" values for keyword pairs that were not found in the external file.</p>
<p>One typically derives an application specific keydata class to load a specific portion of a known config file and initialize it's values. One can then declare a global instance of these objects and have configuration data initialized automatically as the executable is loaded.</p>
<p>Hence, if I have a "[paths]" section in a "<code>/etc/server.conf?</code>" file, I might define something like:</p>
<p><code></p>
<pre>
class KeyPaths : public <a class="el" href="classost_1_1_keydata.html" title="Keydata objects are used to load and hold "configuration" data for a given...">Keydata</a>
{
public:
KeyPaths() : <a class="el" href="classost_1_1_keydata.html" title="Keydata objects are used to load and hold "configuration" data for a given...">Keydata</a>("/server/paths")
{
static <a class="el" href="structost_1_1_keydata_1_1_define.html">Keydata::Define</a> *defvalues = {
{"datafiles", "/var/server"},
{NULL, NULL}};</pre><p></code></p>
<p><code></p>
<pre> // override with [paths] from "~/.serverrc" if avail.</pre><p></code></p>
<p><code></p>
<pre> load("~server/paths");
load(defvalues);
}
};</pre><p></code></p>
<p><code></p>
<pre> KeyPaths keypaths;
</pre><p></code></p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> load text configuration files into keyword pairs. </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7b38a93f1804700e069c071e7e71ec82"></a><!-- doxytag: member="ost::Keydata::Keydata" ref="a7b38a93f1804700e069c071e7e71ec82" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::Keydata::Keydata </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an empty key data object. </p>
</div>
</div>
<a class="anchor" id="a5d1fabffff1ebfef8b8ef3fcb610497d"></a><!-- doxytag: member="ost::Keydata::Keydata" ref="a5d1fabffff1ebfef8b8ef3fcb610497d" args="(const char *keypath)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::Keydata::Keydata </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>keypath</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new key data object and use "Load" method to load an initial config file section into it. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>keypath</em> </td><td>(filepath/section) specifies the home path. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2ffbfc1fc3162cf22bfd3699a61aa58b"></a><!-- doxytag: member="ost::Keydata::Keydata" ref="a2ffbfc1fc3162cf22bfd3699a61aa58b" args="(Define *pairs, const char *keypath=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::Keydata::Keydata </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structost_1_1_keydata_1_1_define.html">Define</a> * </td>
<td class="paramname"> <em>pairs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>keypath</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Alternate constructor can take a define list and an optional pathfile to parse. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pairs</em> </td><td>of keyword values from a define list </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keypath</em> </td><td>of optional file and section to load from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aea7231d3fea8750126d1904699638c94"></a><!-- doxytag: member="ost::Keydata::~Keydata" ref="aea7231d3fea8750126d1904699638c94" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::Keydata::~Keydata </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy the keydata object and all allocated memory. </p>
<p>This may also clear the "cache" file stream if no other keydata objects currently reference it. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a68af2fafb65d0d583d62c351faca42cd"></a><!-- doxytag: member="ost::Keydata::clrValue" ref="a68af2fafb65d0d583d62c351faca42cd" args="(const char *sym)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::Keydata::clrValue </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>sym</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clear all values associated with a given keyword. </p>
<p>This does not de-allocate the keyword from memory, however.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>keyword name to clear. </dd></dl>
</div>
</div>
<a class="anchor" id="af16246e1f7c5af075493bf37d7e1b48f"></a><!-- doxytag: member="ost::Keydata::end" ref="af16246e1f7c5af075493bf37d7e1b48f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void ost::Keydata::end </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>static member to end keydata i/o allocations. </p>
<p>Referenced by <a class="el" href="misc_8h_source.html#l00622">ost::endKeydata()</a>.</p>
</div>
</div>
<a class="anchor" id="a297f5a7239a22576f770b038baac564f"></a><!-- doxytag: member="ost::Keydata::getBool" ref="a297f5a7239a22576f770b038baac564f" args="(const char *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::Keydata::getBool </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>key</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a bool value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sym</em> </td><td>keyword name. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true or false. </dd></dl>
</div>
</div>
<a class="anchor" id="a177f94fc01430d2f5e4a79cbbea64b03"></a><!-- doxytag: member="ost::Keydata::getCount" ref="a177f94fc01430d2f5e4a79cbbea64b03" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ost::Keydata::getCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the count of keyword indexes that are actually available so one can allocate a table to receive getIndex. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of keywords found. </dd></dl>
</div>
</div>
<a class="anchor" id="a5d2ee13740be6e901db41dfb0e0033b6"></a><!-- doxytag: member="ost::Keydata::getCount" ref="a5d2ee13740be6e901db41dfb0e0033b6" args="(const char *sym)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::Keydata::getCount </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>sym</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a count of the number of data "values" that is associated with a specific keyword. </p>
<p>Each value is from an accumulation of "<code>load()</code>" requests.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sym</em> </td><td>keyword symbol name. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>count of values associated with keyword. </dd></dl>
</div>
</div>
<a class="anchor" id="a727c000bb0cbbe8132d676e00e4b7424"></a><!-- doxytag: member="ost::Keydata::getDouble" ref="a727c000bb0cbbe8132d676e00e4b7424" args="(const char *key, double def=0.)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double ost::Keydata::getDouble </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>def</em> = <code>0.</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a floating value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sym</em> </td><td>keyword name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>default</em> </td><td>if not set. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>value of key. </dd></dl>
</div>
</div>
<a class="anchor" id="a2412a569a18725e0368f445f4f1cc07a"></a><!-- doxytag: member="ost::Keydata::getFirst" ref="a2412a569a18725e0368f445f4f1cc07a" args="(const char *sym)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ost::Keydata::getFirst </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>sym</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the first data value for a given keyword. </p>
<p>This will typically be the <code>/etc</code> set global default.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sym</em> </td><td>keyword symbol name. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>first set value for this symbol. </dd></dl>
</div>
</div>
<a class="anchor" id="a85b680ae3a530b5261c9e4993365e6cd"></a><!-- doxytag: member="ost::Keydata::getIndex" ref="a85b680ae3a530b5261c9e4993365e6cd" args="(char **data, unsigned max)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ost::Keydata::getIndex </td>
<td>(</td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>max</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get an index array of ALL keywords that are stored by the current keydata object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of keywords found. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>pointer of array to hold keyword strings. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>number of entries the array can hold. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab2286284aff76cf9e310698ff6f22107"></a><!-- doxytag: member="ost::Keydata::getLast" ref="ab2286284aff76cf9e310698ff6f22107" args="(const char *sym)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ost::Keydata::getLast </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>sym</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the last (most recently set) value for a given keyword. </p>
<p>This is typically the value actually used.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sym</em> </td><td>keyword symbol name. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>last set value for this symbol. </dd></dl>
</div>
</div>
<a class="anchor" id="affdaf274202fe5bb12b6dc720f2cb3b7"></a><!-- doxytag: member="ost::Keydata::getList" ref="affdaf274202fe5bb12b6dc720f2cb3b7" args="(const char *sym)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const* ost::Keydata::getList </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>sym</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a list of all values set for the given keyword returned in order. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>list pointer of array holding all keyword values. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sym</em> </td><td>keyword name to fetch. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad950a91035be68c3b790dc783d286651"></a><!-- doxytag: member="ost::Keydata::getLong" ref="ad950a91035be68c3b790dc783d286651" args="(const char *sym, long def=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long ost::Keydata::getLong </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>sym</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>def</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a long value, with an optional default if missing. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sym</em> </td><td>keyword name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>default</em> </td><td>if not present. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>long value of key. </dd></dl>
</div>
</div>
<a class="anchor" id="a7fcd3ce05319e4268064386784a714c5"></a><!-- doxytag: member="ost::Keydata::getString" ref="a7fcd3ce05319e4268064386784a714c5" args="(const char *sym, const char *def=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ost::Keydata::getString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>sym</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>def</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a string value, with an optional default if missing. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sym</em> </td><td>keyword name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>default</em> </td><td>if not present. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>string value of key. </dd></dl>
</div>
</div>
<a class="anchor" id="a76bcec1ca452d8811d797a7fea2c9e96"></a><!-- doxytag: member="ost::Keydata::getSymbol" ref="a76bcec1ca452d8811d797a7fea2c9e96" args="(const char *sym, bool create)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structost_1_1_keydata_1_1_keysym.html">Keysym</a>* ost::Keydata::getSymbol </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>sym</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>create</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a73ef6b10342042f626b109c24e821b22"></a><!-- doxytag: member="ost::Keydata::isKey" ref="a73ef6b10342042f626b109c24e821b22" args="(const char *sym)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::Keydata::isKey </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>sym</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find if a given key exists. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sym</em> </td><td>keyword to find. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if exists. </dd></dl>
</div>
</div>
<a class="anchor" id="a824f678a4920e40704ae17ef70b47290"></a><!-- doxytag: member="ost::Keydata::load" ref="a824f678a4920e40704ae17ef70b47290" args="(Define *pairs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::Keydata::load </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structost_1_1_keydata_1_1_define.html">Define</a> * </td>
<td class="paramname"> <em>pairs</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Load default keywords into the current object. </p>
<p>This only loads keyword entries which have not already been defined to reduce memory usage. This form of Load is also commonly used in the constructor of a derived <a class="el" href="classost_1_1_keydata.html" title="Keydata objects are used to load and hold "configuration" data for a given...">Keydata</a> class.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pairs</em> </td><td>list of NULL terminated default keyword/value pairs. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aaa445cbcd2cb56f8fab7e3063a55ba24"></a><!-- doxytag: member="ost::Keydata::load" ref="aaa445cbcd2cb56f8fab7e3063a55ba24" args="(const char *keypath)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::Keydata::load </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>keypath</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Load additional key values into the currrent object from the specfied config source (a config file/section pair). </p>
<p>These values will overlay the current keywords when matches are found. This can be used typically in a derived config object class constructor to first load a <code>/etc</code> section, and then load a matching user specific entry from <code>~/.</code> to override default system values with user specific keyword values.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>keypath</em> </td><td>(filepath/section) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a739656231534d299d250d7ac85cb5b52"></a><!-- doxytag: member="ost::Keydata::loadFile" ref="a739656231534d299d250d7ac85cb5b52" args="(const char *filepath, const char *keys=NULL, const char *pre=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::Keydata::loadFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filepath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>keys</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pre</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Load additional keys into the current object using a real filename that is directly passed rather than a computed key path. </p>
<p>This also uses a [keys] section as passed to the object.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filepath</em> </td><td>to load from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keys</em> </td><td>section to parse from, or NULL to parse from head </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pre</em> </td><td>optional key prefix </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad5c9a37238043d8daf932e0fdc9c64e1"></a><!-- doxytag: member="ost::Keydata::loadPrefix" ref="ad5c9a37238043d8daf932e0fdc9c64e1" args="(const char *prefix, const char *keypath)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::Keydata::loadPrefix </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>prefix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>keypath</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Load additional key values into the currrent object from the specfied config source (a config file/section pair). </p>
<p>These values will overlay the current keywords when matches are found. This can be used typically in a derived config object class constructor to first load a <code>/etc</code> section, and then load a matching user specific entry from <code>~/.</code> to override default system values with user specific keyword values. This varient puts a prefix in front of the key name.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>prefix</em> </td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>keypath</em> </td><td>(filepath/section) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1891928115aa1007abe42d81a695c205"></a><!-- doxytag: member="ost::Keydata::operator[]" ref="a1891928115aa1007abe42d81a695c205" args="(const char *keyword)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ost::Keydata::operator[] </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>keyword</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A convient notation for accessing the keydata as an associative array of keyword/value pairs through the [] operator. </p>
</div>
</div>
<a class="anchor" id="a815ad7e73ec110d57f205f8971972a0c"></a><!-- doxytag: member="ost::Keydata::setValue" ref="a815ad7e73ec110d57f205f8971972a0c" args="(const char *sym, const char *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::Keydata::setValue </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>sym</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set (replace) the value of a given keyword. </p>
<p>This new value will become the value returned from <a class="el" href="classost_1_1_keydata.html#ab2286284aff76cf9e310698ff6f22107" title="Get the last (most recently set) value for a given keyword.">getLast()</a>, while the prior value will still be stored and found from <code><a class="el" href="classost_1_1_keydata.html#affdaf274202fe5bb12b6dc720f2cb3b7" title="Return a list of all values set for the given keyword returned in order.">getList()</a></code>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sym</em> </td><td>keyword name to set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>string to store for the keyword. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5a9b6469b627a674e5e9856707732b29"></a><!-- doxytag: member="ost::Keydata::unlink" ref="a5a9b6469b627a674e5e9856707732b29" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::Keydata::unlink </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unlink the keydata object from the cache file stream. </p>
<p>This should be used if you plan to keepa <a class="el" href="classost_1_1_keydata.html" title="Keydata objects are used to load and hold "configuration" data for a given...">Keydata</a> object after it is loaded once all keydata objects have been loaded, otherwise the cfgFile stream will remain open. You can also use <a class="el" href="classost_1_1_keydata.html#ab2cdccf30c8543716905fbc6dfa29c92" title="Shutdown the file stream cache.">endKeydata()</a>. </p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="ab2cdccf30c8543716905fbc6dfa29c92"></a><!-- doxytag: member="ost::Keydata::endKeydata" ref="ab2cdccf30c8543716905fbc6dfa29c92" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void endKeydata </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Shutdown the file stream cache. </p>
<p>This should be used before detaching a deamon, <code>exec()</code>, <code>fork()</code>, etc. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="misc_8h_source.html">misc.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 2010 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
ed376d6842ea322c25405e7c23b3bc12
>
files
>
229
