<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>edelib: edelib/Config.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">edelib
 <span id="projectnumber">2.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">edelib/Config.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * $Id: Config.h 3264 2012-04-25 15:39:56Z karijes $</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Config file reader and writer</span>
<a name="l00005"></a>00005 <span class="comment"> * Copyright (c) 2005-2007 edelib authors</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00008"></a>00008 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00009"></a>00009 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00010"></a>00010 <span class="comment"> * version 2 of the License, or (at your option) any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> * This library is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00015"></a>00015 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU Lesser General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with this library. If not, see <http://www.gnu.org/licenses/>.</span>
<a name="l00019"></a>00019 <span class="comment"> */</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef __EDELIB_CONFIG_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define __EDELIB_CONFIG_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <stdio.h></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "List.h"</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 EDELIB_NS_BEGIN
<a name="l00028"></a>00028
<a name="l00033"></a><a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9">00033</a> <span class="keyword">enum</span> <a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9" title="Error codes from Config class.">ConfigErrors</a> {
<a name="l00034"></a><a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9abd7a4cb05398d92afae8dbb830c1faa1">00034</a> <a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9abd7a4cb05398d92afae8dbb830c1faa1" title="successful operation">CONF_SUCCESS</a> = 0,
<a name="l00035"></a><a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9a6e8deeec513f7e0c7250256114e9c735">00035</a> <a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9a6e8deeec513f7e0c7250256114e9c735" title="trouble accessing config file or directory">CONF_ERR_FILE</a>,
<a name="l00036"></a><a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9abd60b043520a56bb43d5357d57c440ae">00036</a> <a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9abd60b043520a56bb43d5357d57c440ae" title="malformed file">CONF_ERR_BAD</a>,
<a name="l00037"></a><a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9a7e4d3999a27dc2d12836077c11bacfc1">00037</a> <a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9a7e4d3999a27dc2d12836077c11bacfc1" title="requested section was not found">CONF_ERR_SECTION</a>,
<a name="l00038"></a><a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9ae6e0a27e8047da4f185433df0b8d5599">00038</a> <a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9ae6e0a27e8047da4f185433df0b8d5599" title="requested key was not found">CONF_ERR_KEY</a>,
<a name="l00039"></a><a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9ad5c95e38ce323b54b4816fe8ff40d99f">00039</a> <a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9ad5c95e38ce323b54b4816fe8ff40d99f" title="memory allocation error">CONF_ERR_MEMORY</a>,
<a name="l00040"></a><a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9ada3016514d2fe07d12c097d02fab7684">00040</a> <a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9ada3016514d2fe07d12c097d02fab7684" title="key found, but invalid value associated with it">CONF_ERR_NOVALUE</a>
<a name="l00041"></a>00041 };
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="keyword">class </span>Config;
<a name="l00044"></a>00044 <span class="keyword">class </span>ConfigSection;
<a name="l00045"></a>00045 <span class="keyword">class </span>ConfigEntry;
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="preprocessor">#ifndef SKIP_DOCS</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="keyword">typedef</span> list<ConfigEntry*> EntryList;
<a name="l00049"></a>00049 <span class="keyword">typedef</span> list<ConfigEntry*>::iterator EntryListIter;
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keyword">typedef</span> list<ConfigSection*> SectionList;
<a name="l00052"></a>00052 <span class="keyword">typedef</span> list<ConfigSection*>::iterator SectionListIter;
<a name="l00053"></a>00053 <span class="preprocessor">#endif</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span>
<a name="l00112"></a><a class="code" href="classedelib_1_1Config.html">00112</a> <span class="keyword">class </span>EDELIB_API <a class="code" href="classedelib_1_1Config.html" title="A config file reader.">Config</a> {
<a name="l00113"></a>00113 <span class="keyword">private</span>:
<a name="l00114"></a>00114 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> errcode;
<a name="l00115"></a>00115 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> linenum;
<a name="l00116"></a>00116 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sectnum;
<a name="l00117"></a>00117 ConfigSection* cached;
<a name="l00118"></a>00118
<a name="l00119"></a>00119 SectionList section_list;
<a name="l00120"></a>00120
<a name="l00121"></a>00121 ConfigSection* add_section(<span class="keyword">const</span> <span class="keywordtype">char</span>* section);
<a name="l00122"></a>00122 ConfigSection* find_section(<span class="keyword">const</span> <span class="keywordtype">char</span>* section);
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <a class="code" href="group__macros.html#gaef9b2427c1dfe072bc563a6051cc385c">E_DISABLE_CLASS_COPY</a>(<a class="code" href="classedelib_1_1Config.html" title="A config file reader.">Config</a>)
<a name="l00125"></a>00125 <span class="keyword">public</span>:
<a name="l00127"></a>00127 <a class="code" href="classedelib_1_1Config.html" title="A config file reader.">Config</a>();
<a name="l00128"></a>00128
<a name="l00130"></a><a class="code" href="classedelib_1_1Config.html#a54dfba499c9d9e1003d4c9bcbe6ad1c5">00130</a> <a class="code" href="classedelib_1_1Config.html#a54dfba499c9d9e1003d4c9bcbe6ad1c5">~Config</a>() { clear(); }
<a name="l00131"></a>00131
<a name="l00138"></a>00138 <span class="keywordtype">bool</span> load(<span class="keyword">const</span> <span class="keywordtype">char</span>* fname);
<a name="l00139"></a>00139
<a name="l00148"></a>00148 <span class="keywordtype">bool</span> save(<span class="keyword">const</span> <span class="keywordtype">char</span>* fname);
<a name="l00149"></a>00149
<a name="l00163"></a><a class="code" href="classedelib_1_1Config.html#a4e78e3cd062c82439dffc9cddbdd8a20">00163</a> <a class="code" href="classedelib_1_1Config.html#a4e78e3cd062c82439dffc9cddbdd8a20">operator bool</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> ((errcode == <a class="code" href="namespaceedelib.html#ad351b23fe0550b14aaf53305a15ffdb9abd7a4cb05398d92afae8dbb830c1faa1" title="successful operation">CONF_SUCCESS</a>) ? 1 : 0); }
<a name="l00164"></a>00164
<a name="l00168"></a>00168 <span class="keywordtype">void</span> clear(<span class="keywordtype">void</span>);
<a name="l00169"></a>00169
<a name="l00179"></a>00179 <span class="keywordtype">bool</span> <span class="keyword">get</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">char</span>* ret, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size);
<a name="l00180"></a>00180
<a name="l00203"></a>00203 <span class="keywordtype">bool</span> get_localized(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">char</span>* ret, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size);
<a name="l00204"></a>00204
<a name="l00216"></a>00216 <span class="keywordtype">bool</span> get_allocated(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">char</span>** ret, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>& retsize);
<a name="l00217"></a>00217
<a name="l00227"></a>00227 <span class="keywordtype">bool</span> <span class="keyword">get</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">bool</span>& ret, <span class="keywordtype">bool</span> dfl = <span class="keyword">false</span>);
<a name="l00228"></a>00228
<a name="l00238"></a>00238 <span class="keywordtype">bool</span> <span class="keyword">get</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">int</span>& ret, <span class="keywordtype">int</span> dfl = 0);
<a name="l00239"></a>00239
<a name="l00249"></a>00249 <span class="keywordtype">bool</span> <span class="keyword">get</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">float</span>& ret, <span class="keywordtype">float</span> dfl = 0);
<a name="l00250"></a>00250
<a name="l00260"></a>00260 <span class="keywordtype">bool</span> <span class="keyword">get</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">long</span>& ret, <span class="keywordtype">long</span> dfl = 0);
<a name="l00261"></a>00261
<a name="l00271"></a>00271 <span class="keywordtype">bool</span> <span class="keyword">get</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">double</span>& ret, <span class="keywordtype">double</span> dfl = 0);
<a name="l00272"></a>00272
<a name="l00282"></a>00282 <span class="keywordtype">bool</span> <span class="keyword">get</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">char</span>& ret, <span class="keywordtype">char</span> dfl = 0);
<a name="l00283"></a>00283
<a name="l00292"></a>00292 <span class="keywordtype">void</span> <span class="keyword">set</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">char</span>* val);
<a name="l00293"></a>00293
<a name="l00302"></a>00302 <span class="keywordtype">void</span> <span class="keyword">set</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keyword">const</span> <span class="keywordtype">char</span>* val);
<a name="l00303"></a>00303
<a name="l00312"></a>00312 <span class="keywordtype">void</span> set_localized(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">char</span>* val);
<a name="l00313"></a>00313
<a name="l00322"></a>00322 <span class="keywordtype">void</span> set_localized(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keyword">const</span> <span class="keywordtype">char</span>* val);
<a name="l00323"></a>00323
<a name="l00332"></a>00332 <span class="keywordtype">void</span> <span class="keyword">set</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">bool</span> val);
<a name="l00333"></a>00333
<a name="l00342"></a>00342 <span class="keywordtype">void</span> <span class="keyword">set</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">int</span> val);
<a name="l00343"></a>00343
<a name="l00352"></a>00352 <span class="keywordtype">void</span> <span class="keyword">set</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">long</span> val);
<a name="l00353"></a>00353
<a name="l00362"></a>00362 <span class="keywordtype">void</span> <span class="keyword">set</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">float</span> val);
<a name="l00363"></a>00363
<a name="l00372"></a>00372 <span class="keywordtype">void</span> <span class="keyword">set</span>(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key, <span class="keywordtype">double</span> val);
<a name="l00373"></a>00373
<a name="l00379"></a>00379 <span class="keywordtype">bool</span> exist(<span class="keyword">const</span> <span class="keywordtype">char</span>* section);
<a name="l00380"></a>00380
<a name="l00386"></a>00386 <span class="keywordtype">bool</span> key_exist(<span class="keyword">const</span> <span class="keywordtype">char</span>* section, <span class="keyword">const</span> <span class="keywordtype">char</span>* key);
<a name="l00387"></a>00387
<a name="l00393"></a>00393 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> num_sections(<span class="keywordtype">void</span>);
<a name="l00394"></a>00394
<a name="l00401"></a>00401 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> line(<span class="keywordtype">void</span>);
<a name="l00402"></a>00402
<a name="l00409"></a>00409 <span class="keywordtype">int</span> error(<span class="keywordtype">void</span>);
<a name="l00410"></a>00410
<a name="l00415"></a>00415 <span class="keyword">const</span> <span class="keywordtype">char</span>* strerror(<span class="keywordtype">void</span>);
<a name="l00416"></a>00416
<a name="l00422"></a>00422 <span class="keyword">const</span> <span class="keywordtype">char</span>* strerror(<span class="keywordtype">int</span> code);
<a name="l00423"></a>00423 };
<a name="l00424"></a>00424
<a name="l00425"></a>00425 <span class="preprocessor">#ifndef SKIP_DOCS</span>
<a name="l00426"></a>00426 <span class="preprocessor"></span><span class="comment">/* This function is for unit test only and should not be used in application code */</span>
<a name="l00427"></a>00427 EDELIB_API <span class="keywordtype">int</span> config_getline(<span class="keywordtype">char</span>** buff, <span class="keywordtype">int</span>* len, FILE* f);
<a name="l00428"></a>00428 <span class="preprocessor">#endif</span>
<a name="l00429"></a>00429 <span class="preprocessor"></span>
<a name="l00430"></a>00430 EDELIB_NS_END
<a name="l00431"></a>00431 <span class="preprocessor">#endif</span>
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 5 2012 17:49:02 for edelib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
