<!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>ucommon: ucommon/keydata.h Source File</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="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>ucommon/keydata.h</h1><a href="a00187.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (C) 2006-2010 David Sugar, Tycho Softworks.</span>
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// This file is part of GNU uCommon C++.</span>
<a name="l00004"></a>00004 <span class="comment">//</span>
<a name="l00005"></a>00005 <span class="comment">// GNU uCommon C++ is free software: you can redistribute it and/or modify</span>
<a name="l00006"></a>00006 <span class="comment">// it under the terms of the GNU Lesser General Public License as published</span>
<a name="l00007"></a>00007 <span class="comment">// by the Free Software Foundation, either version 3 of the License, or</span>
<a name="l00008"></a>00008 <span class="comment">// (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment">//</span>
<a name="l00010"></a>00010 <span class="comment">// GNU uCommon C++ is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00013"></a>00013 <span class="comment">// GNU Lesser General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment">//</span>
<a name="l00015"></a>00015 <span class="comment">// You should have received a copy of the GNU Lesser General Public License</span>
<a name="l00016"></a>00016 <span class="comment">// along with GNU uCommon C++. If not, see <http://www.gnu.org/licenses/>.</span>
<a name="l00017"></a>00017
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef _UCOMMON_KEYDATA_H_</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define _UCOMMON_KEYDATA_H_</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#ifndef _UCOMMON_CONFIG_H_</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="a00194.html" title="Various miscellaneous platform specific headers and defines.">ucommon/platform.h</a>></span>
<a name="l00035"></a>00035 <span class="preprocessor">#endif</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span>
<a name="l00037"></a>00037 <span class="preprocessor">#ifndef _UCOMMON_LINKED_H_</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="a00188.html" title="Linked objects, lists, templates, and containers.">ucommon/linked.h</a>></span>
<a name="l00039"></a>00039 <span class="preprocessor">#endif</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>
<a name="l00041"></a>00041 <span class="preprocessor">#ifndef _UCOMMON_MEMORY_H_</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="a00190.html" title="Private heaps, pools, and associations.">ucommon/memory.h</a>></span>
<a name="l00043"></a>00043 <span class="preprocessor">#endif</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span>
<a name="l00045"></a>00045 NAMESPACE_UCOMMON
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">class </span>keyfile;
<a name="l00048"></a>00048
<a name="l00057"></a><a class="code" href="a00055.html">00057</a> <span class="keyword">class </span>__EXPORT <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> : <span class="keyword">public</span> <a class="code" href="a00101.html" title="A linked object base class for ordered objects.">OrderedObject</a>
<a name="l00058"></a>00058 {
<a name="l00059"></a>00059 <span class="keyword">private</span>:
<a name="l00060"></a>00060 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="a00057.html" title="Traditional keypair config file parsing class.">keyfile</a>;
<a name="l00061"></a>00061 <a class="code" href="a00100.html" title="An index container for maintaining an ordered list of objects.">OrderedIndex</a> index;
<a name="l00062"></a>00062 <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a>(<a class="code" href="a00057.html" title="Traditional keypair config file parsing class.">keyfile</a> *file);
<a name="l00063"></a>00063 <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a>(<a class="code" href="a00057.html" title="Traditional keypair config file parsing class.">keyfile</a> *file, <span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">id</span>);
<a name="l00064"></a>00064 <span class="keyword">const</span> <span class="keywordtype">char</span> *name;
<a name="l00065"></a>00065 <a class="code" href="a00057.html" title="Traditional keypair config file parsing class.">keyfile</a> *root;
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="keyword">public</span>:
<a name="l00073"></a><a class="code" href="a00056.html">00073</a> <span class="keyword">class </span>__LOCAL <a class="code" href="a00056.html" title="A key value set is used for iterative access.">keyvalue</a> : <span class="keyword">public</span> <a class="code" href="a00101.html" title="A linked object base class for ordered objects.">OrderedObject</a>
<a name="l00074"></a>00074 {
<a name="l00075"></a>00075 <span class="keyword">private</span>:
<a name="l00076"></a>00076 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a>;
<a name="l00077"></a>00077 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="a00057.html" title="Traditional keypair config file parsing class.">keyfile</a>;
<a name="l00078"></a>00078 <a class="code" href="a00056.html" title="A key value set is used for iterative access.">keyvalue</a>(<a class="code" href="a00057.html" title="Traditional keypair config file parsing class.">keyfile</a> *allocator, <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> *section, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keyword">const</span> <span class="keywordtype">char</span> *data);
<a name="l00079"></a>00079 <span class="keyword">public</span>:
<a name="l00080"></a>00080 <span class="keyword">const</span> <span class="keywordtype">char</span> *id;
<a name="l00081"></a>00081 <span class="keyword">const</span> <span class="keywordtype">char</span> *value;
<a name="l00082"></a>00082 };
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="a00056.html" title="A key value set is used for iterative access.">keyvalue</a>;
<a name="l00085"></a>00085
<a name="l00091"></a>00091 <span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keyword">get</span>(<span class="keyword">const</span> <span class="keywordtype">char</span> *id) <span class="keyword">const</span>;
<a name="l00092"></a>00092
<a name="l00098"></a><a class="code" href="a00055.html#a0338964ff3210151768c0fccc716ba05">00098</a> <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *operator()(<span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">id</span>)<span class="keyword"> const</span>
<a name="l00099"></a>00099 <span class="keyword"> </span>{<span class="keywordflow">return</span> <span class="keyword">get</span>(id);};
<a name="l00100"></a>00100
<a name="l00108"></a>00108 <span class="keywordtype">void</span> <span class="keyword">set</span>(<span class="keyword">const</span> <span class="keywordtype">char</span> *id, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);
<a name="l00109"></a>00109
<a name="l00115"></a>00115 <span class="keywordtype">void</span> clear(<span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">id</span>);
<a name="l00116"></a>00116
<a name="l00121"></a><a class="code" href="a00055.html#a1f4b88e46ab4e6203fe8e2d0631ead40">00121</a> <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keyword">get</span>(void) <span class="keyword">const</span>
<a name="l00122"></a>00122 {<span class="keywordflow">return</span> name;};
<a name="l00123"></a>00123
<a name="l00128"></a><a class="code" href="a00055.html#af23a3e409c20fdcd4845da4242460c43">00128</a> <span class="keyword">inline</span> <a class="code" href="a00056.html" title="A key value set is used for iterative access.">keyvalue</a> *begin(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
<a name="l00129"></a>00129 <span class="keyword"> </span>{<span class="keywordflow">return</span> (<a class="code" href="a00056.html" title="A key value set is used for iterative access.">keyvalue</a> *)index.begin();};
<a name="l00130"></a>00130
<a name="l00135"></a><a class="code" href="a00055.html#ab5ffa876cf803de3d0b9d1d8e5a6c6c6">00135</a> <span class="keyword">inline</span> <a class="code" href="a00056.html" title="A key value set is used for iterative access.">keyvalue</a> *end(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
<a name="l00136"></a><a class="code" href="a00055.html#ae9eda78ae34d8fa51fc38127dda3cf00">00136</a> <span class="keyword"> </span>{<span class="keywordflow">return</span> (<a class="code" href="a00056.html" title="A key value set is used for iterative access.">keyvalue</a>*)index.end();};
<a name="l00137"></a>00137
<a name="l00141"></a>00141 <span class="keyword">typedef</span> <a class="code" href="a00062.html" title="A smart pointer template for iterating linked lists.">linked_pointer<keyvalue></a> iterator;
<a name="l00142"></a>00142 };
<a name="l00143"></a>00143
<a name="l00150"></a><a class="code" href="a00057.html">00150</a> <span class="keyword">class </span>__EXPORT <a class="code" href="a00057.html" title="Traditional keypair config file parsing class.">keyfile</a> : <span class="keyword">public</span> <a class="code" href="a00079.html" title="A memory protocol pager for private heap manager.">memalloc</a>
<a name="l00151"></a>00151 {
<a name="l00152"></a>00152 <span class="keyword">private</span>:
<a name="l00153"></a>00153 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a>;
<a name="l00154"></a>00154 <a class="code" href="a00100.html" title="An index container for maintaining an ordered list of objects.">OrderedIndex</a> index;
<a name="l00155"></a>00155 <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> *defaults;
<a name="l00156"></a>00156 <span class="keywordtype">int</span> errcode;
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="keyword">protected</span>:
<a name="l00159"></a>00159 <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> *create(<span class="keyword">const</span> <span class="keywordtype">char</span> *section);
<a name="l00160"></a>00160
<a name="l00161"></a>00161 <span class="preprocessor">#ifdef _MSWINDOWS_</span>
<a name="l00162"></a>00162 <span class="preprocessor"></span> <span class="keywordtype">void</span> load(HKEY root, <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> *section = NULL, <span class="keyword">const</span> <span class="keywordtype">char</span> *path = NULL);
<a name="l00163"></a>00163 <span class="keywordtype">bool</span> save(HKEY root, <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> *section = NULL, <span class="keyword">const</span> <span class="keywordtype">char</span> *path = NULL);
<a name="l00164"></a>00164 <span class="preprocessor">#endif</span>
<a name="l00165"></a>00165 <span class="preprocessor"></span>
<a name="l00166"></a>00166 <span class="keyword">public</span>:
<a name="l00171"></a>00171 <a class="code" href="a00057.html" title="Traditional keypair config file parsing class.">keyfile</a>(<span class="keywordtype">size_t</span> pagesize = 0);
<a name="l00172"></a>00172
<a name="l00178"></a>00178 <a class="code" href="a00057.html" title="Traditional keypair config file parsing class.">keyfile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keywordtype">size_t</span> pagesize = 0);
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <a class="code" href="a00057.html" title="Traditional keypair config file parsing class.">keyfile</a>(<span class="keyword">const</span> <a class="code" href="a00057.html" title="Traditional keypair config file parsing class.">keyfile</a> &<a class="code" href="a00208.html#aa948d5926268ce79c22778bd81cc6ed9" title="Convenience function to access object copy.">copy</a>, <span class="keywordtype">size_t</span> pagesize = 0);
<a name="l00181"></a>00181
<a name="l00188"></a>00188 <span class="keywordtype">void</span> load(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);
<a name="l00189"></a>00189
<a name="l00195"></a>00195 <span class="keywordtype">bool</span> save(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);
<a name="l00196"></a>00196
<a name="l00201"></a>00201 <span class="keywordtype">void</span> load(<span class="keyword">const</span> <a class="code" href="a00057.html" title="Traditional keypair config file parsing class.">keyfile</a> *source);
<a name="l00202"></a>00202
<a name="l00207"></a>00207 <span class="keywordtype">void</span> load(<span class="keyword">const</span> <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> *source);
<a name="l00208"></a>00208
<a name="l00212"></a>00212 <span class="keywordtype">void</span> <a class="code" href="a00208.html#a8df8e4b667d68be02961ff0d4cd84224" title="Convenience function to unlock shared object through it&#39;s protocol.">release</a>(<span class="keywordtype">void</span>);
<a name="l00213"></a>00213
<a name="l00219"></a>00219 <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> *<span class="keyword">get</span>(<span class="keyword">const</span> <span class="keywordtype">char</span> *section) <span class="keyword">const</span>;
<a name="l00220"></a>00220
<a name="l00221"></a>00221 <span class="keyword">inline</span> <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> *operator()(<span class="keyword">const</span> <span class="keywordtype">char</span> *section)<span class="keyword"> const</span>
<a name="l00222"></a>00222 <span class="keyword"> </span>{<span class="keywordflow">return</span> <span class="keyword">get</span>(section);};
<a name="l00223"></a>00223
<a name="l00224"></a>00224 <span class="keyword">inline</span> <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> *operator[](<span class="keyword">const</span> <span class="keywordtype">char</span> *section)<span class="keyword"> const</span>
<a name="l00225"></a>00225 <span class="keyword"> </span>{<span class="keywordflow">return</span> <span class="keyword">get</span>(section);};
<a name="l00226"></a>00226
<a name="l00231"></a><a class="code" href="a00057.html#a6aa22ef2b174406f5c4bc8cd3803579f">00231</a> <span class="keyword">inline</span> <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> *<span class="keyword">get</span>(void) <span class="keyword">const</span>
<a name="l00232"></a>00232 {<span class="keywordflow">return</span> defaults;};
<a name="l00233"></a>00233
<a name="l00238"></a><a class="code" href="a00057.html#a6ce23475b935daae23d2fdbc3fbfd9af">00238</a> <span class="keyword">inline</span> <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> *begin(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
<a name="l00239"></a>00239 <span class="keyword"> </span>{<span class="keywordflow">return</span> (<a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> *)index.begin();};
<a name="l00240"></a>00240
<a name="l00245"></a><a class="code" href="a00057.html#a0642706d42847a0ad3efc1a9d1a168b8">00245</a> <span class="keyword">inline</span> <a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> *end(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
<a name="l00246"></a><a class="code" href="a00057.html#aa89b48626d2a1d539c7f1cfb2015a23a">00246</a> <span class="keyword"> </span>{<span class="keywordflow">return</span> (<a class="code" href="a00055.html" title="Data keys parsed from a keyfile.">keydata</a> *)index.end();};
<a name="l00247"></a>00247
<a name="l00251"></a>00251 <span class="keyword">typedef</span> <a class="code" href="a00062.html" title="A smart pointer template for iterating linked lists.">linked_pointer<keydata></a> iterator;
<a name="l00252"></a>00252
<a name="l00253"></a>00253 <span class="keyword">inline</span> <span class="keywordtype">int</span> err(<span class="keywordtype">void</span>)
<a name="l00254"></a>00254 {<span class="keywordflow">return</span> errcode;}
<a name="l00255"></a>00255 };
<a name="l00256"></a>00256
<a name="l00257"></a>00257 END_NAMESPACE
<a name="l00258"></a>00258
<a name="l00259"></a>00259 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:38:56 2011 for ucommon 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>
