<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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>wsdlpull: /builddir/build/BUILD/wsdlpull-1.23/src/xmlpull/ConfigFile.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_02f058d422e7266632662d1436e7c90d.html">src</a> » <a class="el" href="dir_d82d185bbcb80670a6f83c0b9bb31577.html">xmlpull</a>
</div>
</div>
<div class="contents">
<h1>ConfigFile.h</h1><a href="ConfigFile_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// ConfigFile.h</span>
<a name="l00002"></a>00002 <span class="comment">// Class for reading named values from configuration files</span>
<a name="l00003"></a>00003 <span class="comment">// Richard J. Wagner v2.1 24 May 2004 wagnerr@umich.edu</span>
<a name="l00004"></a>00004
<a name="l00005"></a>00005 <span class="comment">// Copyright (c) 2004 Richard J. Wagner</span>
<a name="l00006"></a>00006 <span class="comment">// </span>
<a name="l00007"></a>00007 <span class="comment">// Permission is hereby granted, free of charge, to any person obtaining a copy</span>
<a name="l00008"></a>00008 <span class="comment">// of this software and associated documentation files (the "Software"), to</span>
<a name="l00009"></a>00009 <span class="comment">// deal in the Software without restriction, including without limitation the</span>
<a name="l00010"></a>00010 <span class="comment">// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span>
<a name="l00011"></a>00011 <span class="comment">// sell copies of the Software, and to permit persons to whom the Software is</span>
<a name="l00012"></a>00012 <span class="comment">// furnished to do so, subject to the following conditions:</span>
<a name="l00013"></a>00013 <span class="comment">// </span>
<a name="l00014"></a>00014 <span class="comment">// The above copyright notice and this permission notice shall be included in</span>
<a name="l00015"></a>00015 <span class="comment">// all copies or substantial portions of the Software.</span>
<a name="l00016"></a>00016 <span class="comment">// </span>
<a name="l00017"></a>00017 <span class="comment">// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
<a name="l00018"></a>00018 <span class="comment">// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<a name="l00019"></a>00019 <span class="comment">// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
<a name="l00020"></a>00020 <span class="comment">// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<a name="l00021"></a>00021 <span class="comment">// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span>
<a name="l00022"></a>00022 <span class="comment">// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS</span>
<a name="l00023"></a>00023 <span class="comment">// IN THE SOFTWARE.</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="comment">// Typical usage</span>
<a name="l00026"></a>00026 <span class="comment">// -------------</span>
<a name="l00027"></a>00027 <span class="comment">// </span>
<a name="l00028"></a>00028 <span class="comment">// Given a configuration file "settings.inp":</span>
<a name="l00029"></a>00029 <span class="comment">// atoms = 25</span>
<a name="l00030"></a>00030 <span class="comment">// length = 8.0 # nanometers</span>
<a name="l00031"></a>00031 <span class="comment">// name = Reece Surcher</span>
<a name="l00032"></a>00032 <span class="comment">// </span>
<a name="l00033"></a>00033 <span class="comment">// Named values are read in various ways, with or without default values:</span>
<a name="l00034"></a>00034 <span class="comment">// ConfigFile config( "settings.inp" );</span>
<a name="l00035"></a>00035 <span class="comment">// int atoms = config.read<int>( "atoms" );</span>
<a name="l00036"></a>00036 <span class="comment">// double length = config.read( "length", 10.0 );</span>
<a name="l00037"></a>00037 <span class="comment">// string author, title;</span>
<a name="l00038"></a>00038 <span class="comment">// config.readInto( author, "name" );</span>
<a name="l00039"></a>00039 <span class="comment">// config.readInto( title, "title", string("Untitled") );</span>
<a name="l00040"></a>00040 <span class="comment">// </span>
<a name="l00041"></a>00041 <span class="comment">// See file example.cpp for more examples.</span>
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="preprocessor">#ifndef CONFIGFILE_H</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#define CONFIGFILE_H</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span>
<a name="l00046"></a>00046 <span class="preprocessor">#include <string></span>
<a name="l00047"></a>00047 <span class="preprocessor">#include <map></span>
<a name="l00048"></a>00048 <span class="preprocessor">#include <iostream></span>
<a name="l00049"></a>00049 <span class="preprocessor">#include <fstream></span>
<a name="l00050"></a>00050 <span class="preprocessor">#include <sstream></span>
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keyword">using</span> std::string;
<a name="l00053"></a>00053
<a name="l00054"></a><a class="code" href="classConfigFile.html">00054</a> <span class="keyword">class </span><a class="code" href="classConfigFile.html">ConfigFile</a> {
<a name="l00055"></a>00055 <span class="comment">// Data</span>
<a name="l00056"></a>00056 <span class="keyword">protected</span>:
<a name="l00057"></a><a class="code" href="classConfigFile.html#ad63f3e259f665192b64fb3e83c701425">00057</a> <span class="keywordtype">string</span> <a class="code" href="classConfigFile.html#ad63f3e259f665192b64fb3e83c701425">myDelimiter</a>; <span class="comment">// separator between key and value</span>
<a name="l00058"></a><a class="code" href="classConfigFile.html#a2c60a141e8ad012b86a0642ec8ec638d">00058</a> <span class="keywordtype">string</span> <a class="code" href="classConfigFile.html#a2c60a141e8ad012b86a0642ec8ec638d">myComment</a>; <span class="comment">// separator between value and comments</span>
<a name="l00059"></a><a class="code" href="classConfigFile.html#af066ec1942c50848a055350029ebbca5">00059</a> <span class="keywordtype">string</span> <a class="code" href="classConfigFile.html#af066ec1942c50848a055350029ebbca5">mySentry</a>; <span class="comment">// optional string to signal end of file</span>
<a name="l00060"></a><a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">00060</a> std::map<string,string> <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>; <span class="comment">// extracted keys and values</span>
<a name="l00061"></a>00061
<a name="l00062"></a><a class="code" href="classConfigFile.html#a91de4778982f558673be7465f33750f5">00062</a> <span class="keyword">typedef</span> std::map<string,string>::iterator <a class="code" href="classConfigFile.html#a91de4778982f558673be7465f33750f5">mapi</a>;
<a name="l00063"></a><a class="code" href="classConfigFile.html#af606aa032e366450b81792da67c984fc">00063</a> <span class="keyword">typedef</span> std::map<string,string>::const_iterator <a class="code" href="classConfigFile.html#af606aa032e366450b81792da67c984fc">mapci</a>;
<a name="l00064"></a><a class="code" href="classConfigFile.html#aa5cb7de8754cd596b0e7b1d306d143bf">00064</a> std::string <a class="code" href="classConfigFile.html#aa5cb7de8754cd596b0e7b1d306d143bf">file</a>;
<a name="l00065"></a><a class="code" href="classConfigFile.html#a0bc00d561b3a014e9b163901ccebde5f">00065</a> <span class="keywordtype">bool</span> <a class="code" href="classConfigFile.html#a0bc00d561b3a014e9b163901ccebde5f">listmode</a>;
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">// Methods</span>
<a name="l00068"></a>00068 <span class="keyword">public</span>:
<a name="l00069"></a>00069 <a class="code" href="classConfigFile.html#a9ce259defdfaabeedb2455849ca6bd1e">ConfigFile</a>( <span class="keywordtype">string</span> filename,
<a name="l00070"></a>00070 <span class="keywordtype">bool</span> isList=<span class="keyword">false</span>,
<a name="l00071"></a>00071 <span class="keywordtype">string</span> delimiter = <span class="stringliteral">"="</span>,
<a name="l00072"></a>00072 <span class="keywordtype">string</span> comment = <span class="stringliteral">"##"</span>,
<a name="l00073"></a>00073 <span class="keywordtype">string</span> sentry = <span class="stringliteral">"EndConfigFile"</span>
<a name="l00074"></a>00074 );
<a name="l00075"></a>00075 <a class="code" href="classConfigFile.html#a9ce259defdfaabeedb2455849ca6bd1e">ConfigFile</a>();
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="comment">// Search for key and read value or optional default value</span>
<a name="l00078"></a>00078 <span class="keyword">template</span><<span class="keyword">class</span> T> T <a class="code" href="classConfigFile.html#a2c870b7009aa29208838fc73f8dde6af">read</a>( <span class="keyword">const</span> <span class="keywordtype">string</span>& key ) <span class="keyword">const</span>; <span class="comment">// call as read<T></span>
<a name="l00079"></a>00079 <span class="keyword">template</span><<span class="keyword">class</span> T> T <a class="code" href="classConfigFile.html#a2c870b7009aa29208838fc73f8dde6af">read</a>( <span class="keyword">const</span> <span class="keywordtype">string</span>& key, <span class="keyword">const</span> T& value ) <span class="keyword">const</span>;
<a name="l00080"></a>00080 <span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keywordtype">bool</span> <a class="code" href="classConfigFile.html#a7526e5aad42677251502b67c579d1539">readInto</a>( T& var, <span class="keyword">const</span> <span class="keywordtype">string</span>& key ) <span class="keyword">const</span>;
<a name="l00081"></a>00081 <span class="keyword">template</span><<span class="keyword">class</span> T>
<a name="l00082"></a>00082 <span class="keywordtype">bool</span> <a class="code" href="classConfigFile.html#a7526e5aad42677251502b67c579d1539">readInto</a>( T& var, <span class="keyword">const</span> <span class="keywordtype">string</span>& key, <span class="keyword">const</span> T& value ) <span class="keyword">const</span>;
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="comment">// Modify keys and values</span>
<a name="l00085"></a>00085 <span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keywordtype">void</span> <a class="code" href="classConfigFile.html#aa209a19359ca5c657c2aae19932f066f">add</a>( <span class="keywordtype">string</span> key, <span class="keyword">const</span> T& value ,<span class="keywordtype">bool</span> store=<span class="keyword">false</span>);
<a name="l00086"></a>00086 <span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keywordtype">void</span> <a class="code" href="classConfigFile.html#aa209a19359ca5c657c2aae19932f066f">add</a>( <span class="keyword">const</span> T& key ,<span class="keywordtype">bool</span> store=<span class="keyword">false</span>); <span class="comment">//for simple list mode</span>
<a name="l00087"></a>00087 <span class="keywordtype">void</span> <span class="keyword">remove</span>( <span class="keyword">const</span> <span class="keywordtype">string</span>& key );
<a name="l00088"></a>00088 <span class="keyword">template</span><<span class="keyword">class</span> T><span class="keywordtype">void</span> <span class="keyword">remove</span>( <span class="keyword">const</span> T& key );<span class="comment">//simple list mode</span>
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="comment">// Check whether key exists in configuration</span>
<a name="l00091"></a>00091 <span class="keywordtype">bool</span> <a class="code" href="classConfigFile.html#afd3d1146ae212a7e5802961f5ad3fe91">keyExists</a>( <span class="keyword">const</span> <span class="keywordtype">string</span>& key ) <span class="keyword">const</span>;
<a name="l00092"></a>00092 <span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keywordtype">bool</span> <a class="code" href="classConfigFile.html#afd3d1146ae212a7e5802961f5ad3fe91">keyExists</a>(<span class="keyword">const</span> T & key) <span class="keyword">const</span>;<span class="comment">//for list mode</span>
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="comment">// Check or change configuration syntax</span>
<a name="l00095"></a><a class="code" href="classConfigFile.html#adcc1df41c7d669a7cc81c47b85b0ee14">00095</a> <span class="keywordtype">string</span> <a class="code" href="classConfigFile.html#adcc1df41c7d669a7cc81c47b85b0ee14">getDelimiter</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classConfigFile.html#ad63f3e259f665192b64fb3e83c701425">myDelimiter</a>; }
<a name="l00096"></a><a class="code" href="classConfigFile.html#a2b0cd50789ea83b1a12bf39293c7401a">00096</a> <span class="keywordtype">string</span> <a class="code" href="classConfigFile.html#a2b0cd50789ea83b1a12bf39293c7401a">getComment</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classConfigFile.html#a2c60a141e8ad012b86a0642ec8ec638d">myComment</a>; }
<a name="l00097"></a><a class="code" href="classConfigFile.html#adf270b0cf2a1b034fc18fd2e82296760">00097</a> <span class="keywordtype">string</span> <a class="code" href="classConfigFile.html#adf270b0cf2a1b034fc18fd2e82296760">getSentry</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classConfigFile.html#af066ec1942c50848a055350029ebbca5">mySentry</a>; }
<a name="l00098"></a><a class="code" href="classConfigFile.html#af28390aba7d8f399ac734c074e659b99">00098</a> <span class="keywordtype">string</span> <a class="code" href="classConfigFile.html#af28390aba7d8f399ac734c074e659b99">setDelimiter</a>( <span class="keyword">const</span> <span class="keywordtype">string</span>& s )
<a name="l00099"></a>00099 { <span class="keywordtype">string</span> old = <a class="code" href="classConfigFile.html#ad63f3e259f665192b64fb3e83c701425">myDelimiter</a>; <a class="code" href="classConfigFile.html#ad63f3e259f665192b64fb3e83c701425">myDelimiter</a> = s; <span class="keywordflow">return</span> old; }
<a name="l00100"></a><a class="code" href="classConfigFile.html#a2e06b3000fb45426c975b334b2cee148">00100</a> <span class="keywordtype">string</span> <a class="code" href="classConfigFile.html#a2e06b3000fb45426c975b334b2cee148">setComment</a>( <span class="keyword">const</span> <span class="keywordtype">string</span>& s )
<a name="l00101"></a>00101 { <span class="keywordtype">string</span> old = <a class="code" href="classConfigFile.html#a2c60a141e8ad012b86a0642ec8ec638d">myComment</a>; <a class="code" href="classConfigFile.html#a2c60a141e8ad012b86a0642ec8ec638d">myComment</a> = s; <span class="keywordflow">return</span> old; }
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="comment">// Write or read configuration</span>
<a name="l00104"></a>00104 <span class="keyword">friend</span> std::ostream& <a class="code" href="classConfigFile.html#a8ccacbc37db1992a5515e2c72fc83ce6">operator<<</a>( std::ostream& os, <span class="keyword">const</span> <a class="code" href="classConfigFile.html">ConfigFile</a>& cf );
<a name="l00105"></a>00105 <span class="keyword">friend</span> std::istream& <a class="code" href="classConfigFile.html#a25042475439039e70f90febe7d0e63ec">operator>></a>( std::istream& is, <a class="code" href="classConfigFile.html">ConfigFile</a>& cf );
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keywordtype">void</span> <a class="code" href="classConfigFile.html#aae6af4a2757d27461438600dafef3187">load</a>(<span class="keywordtype">string</span> filename,<span class="keywordtype">bool</span> isList=<span class="keyword">false</span>);
<a name="l00108"></a>00108 <span class="keywordtype">void</span> <a class="code" href="classConfigFile.html#ab13acdfb1472f6672574a30e7ae1ba2a">save</a>();
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="keyword">protected</span>:
<a name="l00111"></a>00111 <span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classConfigFile.html#a0b2ef4a39ca6ea31d186c301f1f52700">T_as_string</a>( <span class="keyword">const</span> T& t );
<a name="l00112"></a>00112 <span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">static</span> T <a class="code" href="classConfigFile.html#a741caa76c057b33332439cce2521b27e">string_as_T</a>( <span class="keyword">const</span> <span class="keywordtype">string</span>& s );
<a name="l00113"></a>00113 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classConfigFile.html#a6b445b393fcf42386a804fc4077fac10">trim</a>( <span class="keywordtype">string</span>& s );
<a name="l00114"></a>00114
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="comment">// Exception types</span>
<a name="l00117"></a>00117 <span class="keyword">public</span>:
<a name="l00118"></a><a class="code" href="structConfigFile_1_1file__not__found.html">00118</a> <span class="keyword">struct </span><a class="code" href="structConfigFile_1_1file__not__found.html">file_not_found</a> {
<a name="l00119"></a><a class="code" href="structConfigFile_1_1file__not__found.html#a25e11d11b1a9b0f4ca663b21816c2a9a">00119</a> <span class="keywordtype">string</span> <a class="code" href="structConfigFile_1_1file__not__found.html#a25e11d11b1a9b0f4ca663b21816c2a9a">filename</a>;
<a name="l00120"></a><a class="code" href="structConfigFile_1_1file__not__found.html#ab0fa2b6e7d1891136f82d4baf124725b">00120</a> <a class="code" href="structConfigFile_1_1file__not__found.html#ab0fa2b6e7d1891136f82d4baf124725b">file_not_found</a>( <span class="keyword">const</span> <span class="keywordtype">string</span>& filename_ = <span class="keywordtype">string</span>() )
<a name="l00121"></a>00121 : <a class="code" href="structConfigFile_1_1file__not__found.html#a25e11d11b1a9b0f4ca663b21816c2a9a">filename</a>(filename_) {} };
<a name="l00122"></a><a class="code" href="structConfigFile_1_1key__not__found.html">00122</a> <span class="keyword">struct </span><a class="code" href="structConfigFile_1_1key__not__found.html">key_not_found</a> { <span class="comment">// thrown only by T read(key) variant of read()</span>
<a name="l00123"></a><a class="code" href="structConfigFile_1_1key__not__found.html#a2872cbeb5ab860f357b3a58dd867b90b">00123</a> <span class="keywordtype">string</span> <a class="code" href="structConfigFile_1_1key__not__found.html#a2872cbeb5ab860f357b3a58dd867b90b">key</a>;
<a name="l00124"></a><a class="code" href="structConfigFile_1_1key__not__found.html#aedacf2df70a4aa179448706b4862d768">00124</a> <a class="code" href="structConfigFile_1_1key__not__found.html#aedacf2df70a4aa179448706b4862d768">key_not_found</a>( <span class="keyword">const</span> <span class="keywordtype">string</span>& key_ = <span class="keywordtype">string</span>() )
<a name="l00125"></a>00125 : <a class="code" href="structConfigFile_1_1key__not__found.html#a2872cbeb5ab860f357b3a58dd867b90b">key</a>(key_) {} };
<a name="l00126"></a>00126 };
<a name="l00127"></a>00127
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="comment">/* static */</span>
<a name="l00130"></a>00130 <span class="keyword">template</span><<span class="keyword">class</span> T>
<a name="l00131"></a><a class="code" href="classConfigFile.html#a0b2ef4a39ca6ea31d186c301f1f52700">00131</a> <span class="keywordtype">string</span> <a class="code" href="classConfigFile.html#a0b2ef4a39ca6ea31d186c301f1f52700">ConfigFile::T_as_string</a>( <span class="keyword">const</span> T& t )
<a name="l00132"></a>00132 {
<a name="l00133"></a>00133 <span class="comment">// Convert from a T to a string</span>
<a name="l00134"></a>00134 <span class="comment">// Type T must support << operator</span>
<a name="l00135"></a>00135 std::ostringstream ost;
<a name="l00136"></a>00136 ost << t;
<a name="l00137"></a>00137 <span class="keywordflow">return</span> ost.str();
<a name="l00138"></a>00138 }
<a name="l00139"></a>00139
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="comment">/* static */</span>
<a name="l00142"></a>00142 <span class="keyword">template</span><<span class="keyword">class</span> T>
<a name="l00143"></a><a class="code" href="classConfigFile.html#a741caa76c057b33332439cce2521b27e">00143</a> T <a class="code" href="classConfigFile.html#a741caa76c057b33332439cce2521b27e">ConfigFile::string_as_T</a>( <span class="keyword">const</span> <span class="keywordtype">string</span>& s )
<a name="l00144"></a>00144 {
<a name="l00145"></a>00145 <span class="comment">// Convert from a string to a T</span>
<a name="l00146"></a>00146 <span class="comment">// Type T must support >> operator</span>
<a name="l00147"></a>00147 T t;
<a name="l00148"></a>00148 std::istringstream ist(s);
<a name="l00149"></a>00149 ist >> t;
<a name="l00150"></a>00150 <span class="keywordflow">return</span> t;
<a name="l00151"></a>00151 }
<a name="l00152"></a>00152
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="comment">/* static */</span>
<a name="l00155"></a>00155 <span class="keyword">template</span><>
<a name="l00156"></a>00156 <span class="keyword">inline</span> <span class="keywordtype">string</span> ConfigFile::string_as_T<string>( <span class="keyword">const</span> <span class="keywordtype">string</span>& s )
<a name="l00157"></a>00157 {
<a name="l00158"></a>00158 <span class="comment">// Convert from a string to a string</span>
<a name="l00159"></a>00159 <span class="comment">// In other words, do nothing</span>
<a name="l00160"></a>00160 <span class="keywordflow">return</span> s;
<a name="l00161"></a>00161 }
<a name="l00162"></a>00162
<a name="l00163"></a>00163
<a name="l00164"></a>00164 <span class="comment">/* static */</span>
<a name="l00165"></a>00165 <span class="keyword">template</span><>
<a name="l00166"></a>00166 <span class="keyword">inline</span> <span class="keywordtype">bool</span> ConfigFile::string_as_T<bool>( <span class="keyword">const</span> <span class="keywordtype">string</span>& s )
<a name="l00167"></a>00167 {
<a name="l00168"></a>00168 <span class="comment">// Convert from a string to a bool</span>
<a name="l00169"></a>00169 <span class="comment">// Interpret "false", "F", "no", "n", "0" as false</span>
<a name="l00170"></a>00170 <span class="comment">// Interpret "true", "T", "yes", "y", "1", "-1", or anything else as true</span>
<a name="l00171"></a>00171 <span class="keywordtype">bool</span> b = <span class="keyword">true</span>;
<a name="l00172"></a>00172 <span class="keywordtype">string</span> sup = s;
<a name="l00173"></a>00173 <span class="keywordflow">for</span>( string::iterator p = sup.begin(); p != sup.end(); ++p )
<a name="l00174"></a>00174 *p = toupper(*p); <span class="comment">// make string all caps</span>
<a name="l00175"></a>00175 <span class="keywordflow">if</span>( sup==<span class="keywordtype">string</span>(<span class="stringliteral">"FALSE"</span>) || sup==string(<span class="stringliteral">"F"</span>) ||
<a name="l00176"></a>00176 sup==string(<span class="stringliteral">"NO"</span>) || sup==string(<span class="stringliteral">"N"</span>) ||
<a name="l00177"></a>00177 sup==string(<span class="stringliteral">"0"</span>) || sup==string(<span class="stringliteral">"NONE"</span>) )
<a name="l00178"></a>00178 b = <span class="keyword">false</span>;
<a name="l00179"></a>00179 <span class="keywordflow">return</span> b;
<a name="l00180"></a>00180 }
<a name="l00181"></a>00181
<a name="l00182"></a>00182
<a name="l00183"></a>00183 <span class="keyword">template</span><<span class="keyword">class</span> T>
<a name="l00184"></a><a class="code" href="classConfigFile.html#a2c870b7009aa29208838fc73f8dde6af">00184</a> T <a class="code" href="classConfigFile.html#a2c870b7009aa29208838fc73f8dde6af">ConfigFile::read</a>( <span class="keyword">const</span> <span class="keywordtype">string</span>& key )<span class="keyword"> const</span>
<a name="l00185"></a>00185 <span class="keyword"></span>{
<a name="l00186"></a>00186 <span class="comment">// Read the value corresponding to key</span>
<a name="l00187"></a>00187 <a class="code" href="classConfigFile.html#af606aa032e366450b81792da67c984fc">mapci</a> p = <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>.find(key);
<a name="l00188"></a>00188 <span class="keywordflow">if</span>( p == <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>.end() ) <span class="keywordflow">throw</span> <a class="code" href="structConfigFile_1_1key__not__found.html">key_not_found</a>(key);
<a name="l00189"></a>00189 <span class="keywordflow">return</span> string_as_T<T>( p->second );
<a name="l00190"></a>00190 }
<a name="l00191"></a>00191
<a name="l00192"></a>00192
<a name="l00193"></a>00193 <span class="keyword">template</span><<span class="keyword">class</span> T>
<a name="l00194"></a><a class="code" href="classConfigFile.html#a58fe3e41915e8f119a91d51d5d369014">00194</a> T <a class="code" href="classConfigFile.html#a2c870b7009aa29208838fc73f8dde6af">ConfigFile::read</a>( <span class="keyword">const</span> <span class="keywordtype">string</span>& key, <span class="keyword">const</span> T& value )<span class="keyword"> const</span>
<a name="l00195"></a>00195 <span class="keyword"></span>{
<a name="l00196"></a>00196 <span class="comment">// Return the value corresponding to key or given default value</span>
<a name="l00197"></a>00197 <span class="comment">// if key is not found</span>
<a name="l00198"></a>00198 <a class="code" href="classConfigFile.html#af606aa032e366450b81792da67c984fc">mapci</a> p = <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>.find(key);
<a name="l00199"></a>00199 <span class="keywordflow">if</span>( p == <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>.end() ) <span class="keywordflow">return</span> value;
<a name="l00200"></a>00200 <span class="keywordflow">return</span> string_as_T<T>( p->second );
<a name="l00201"></a>00201 }
<a name="l00202"></a>00202
<a name="l00203"></a>00203
<a name="l00204"></a>00204 <span class="keyword">template</span><<span class="keyword">class</span> T>
<a name="l00205"></a><a class="code" href="classConfigFile.html#a7526e5aad42677251502b67c579d1539">00205</a> <span class="keywordtype">bool</span> <a class="code" href="classConfigFile.html#a7526e5aad42677251502b67c579d1539">ConfigFile::readInto</a>( T& var, <span class="keyword">const</span> <span class="keywordtype">string</span>& key )<span class="keyword"> const</span>
<a name="l00206"></a>00206 <span class="keyword"></span>{
<a name="l00207"></a>00207 <span class="comment">// Get the value corresponding to key and store in var</span>
<a name="l00208"></a>00208 <span class="comment">// Return true if key is found</span>
<a name="l00209"></a>00209 <span class="comment">// Otherwise leave var untouched</span>
<a name="l00210"></a>00210 <a class="code" href="classConfigFile.html#af606aa032e366450b81792da67c984fc">mapci</a> p = <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>.find(key);
<a name="l00211"></a>00211 <span class="keywordtype">bool</span> found = ( p != <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>.end() );
<a name="l00212"></a>00212 <span class="keywordflow">if</span>( found ) var = string_as_T<T>( p->second );
<a name="l00213"></a>00213 <span class="keywordflow">return</span> found;
<a name="l00214"></a>00214 }
<a name="l00215"></a>00215
<a name="l00216"></a>00216
<a name="l00217"></a>00217 <span class="keyword">template</span><<span class="keyword">class</span> T>
<a name="l00218"></a><a class="code" href="classConfigFile.html#a22b3d7f8312ca371631d75d803263f10">00218</a> <span class="keywordtype">bool</span> <a class="code" href="classConfigFile.html#a7526e5aad42677251502b67c579d1539">ConfigFile::readInto</a>( T& var, <span class="keyword">const</span> <span class="keywordtype">string</span>& key, <span class="keyword">const</span> T& value )<span class="keyword"> const</span>
<a name="l00219"></a>00219 <span class="keyword"></span>{
<a name="l00220"></a>00220 <span class="comment">// Get the value corresponding to key and store in var</span>
<a name="l00221"></a>00221 <span class="comment">// Return true if key is found</span>
<a name="l00222"></a>00222 <span class="comment">// Otherwise set var to given default</span>
<a name="l00223"></a>00223 <a class="code" href="classConfigFile.html#af606aa032e366450b81792da67c984fc">mapci</a> p = <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>.find(key);
<a name="l00224"></a>00224 <span class="keywordtype">bool</span> found = ( p != <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>.end() );
<a name="l00225"></a>00225 <span class="keywordflow">if</span>( found )
<a name="l00226"></a>00226 var = string_as_T<T>( p->second );
<a name="l00227"></a>00227 <span class="keywordflow">else</span>
<a name="l00228"></a>00228 var = value;
<a name="l00229"></a>00229 <span class="keywordflow">return</span> found;
<a name="l00230"></a>00230 }
<a name="l00231"></a>00231
<a name="l00232"></a>00232
<a name="l00233"></a>00233 <span class="keyword">template</span><<span class="keyword">class</span> T>
<a name="l00234"></a><a class="code" href="classConfigFile.html#aa209a19359ca5c657c2aae19932f066f">00234</a> <span class="keywordtype">void</span> <a class="code" href="classConfigFile.html#aa209a19359ca5c657c2aae19932f066f">ConfigFile::add</a>( <span class="keywordtype">string</span> key, <span class="keyword">const</span> T& value ,<span class="keywordtype">bool</span> store)
<a name="l00235"></a>00235 {
<a name="l00236"></a>00236 <span class="comment">// Add a key with given value</span>
<a name="l00237"></a>00237 <span class="keywordtype">string</span> v = <a class="code" href="classConfigFile.html#a0b2ef4a39ca6ea31d186c301f1f52700">T_as_string</a>( value );
<a name="l00238"></a>00238 <a class="code" href="classConfigFile.html#a6b445b393fcf42386a804fc4077fac10">trim</a>(key);
<a name="l00239"></a>00239 <a class="code" href="classConfigFile.html#a6b445b393fcf42386a804fc4077fac10">trim</a>(v);
<a name="l00240"></a>00240 <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>[key] = v;
<a name="l00241"></a>00241 <span class="keywordflow">if</span> (store)
<a name="l00242"></a>00242 {
<a name="l00243"></a>00243 <span class="comment">//append the values in the file immediately</span>
<a name="l00244"></a>00244 std::ofstream os(<a class="code" href="classConfigFile.html#aa5cb7de8754cd596b0e7b1d306d143bf">file</a>.c_str(),std::ios::app);
<a name="l00245"></a>00245 os << key << <span class="stringliteral">" "</span> << <a class="code" href="classConfigFile.html#ad63f3e259f665192b64fb3e83c701425">myDelimiter</a> << <span class="stringliteral">" "</span>;
<a name="l00246"></a>00246 os << v << std::endl;
<a name="l00247"></a>00247 os.close();
<a name="l00248"></a>00248 }
<a name="l00249"></a>00249 <span class="keywordflow">return</span>;
<a name="l00250"></a>00250 }
<a name="l00251"></a>00251 <span class="comment">//for a list mode kind of config file</span>
<a name="l00252"></a>00252 <span class="keyword">template</span><<span class="keyword">class</span> T>
<a name="l00253"></a><a class="code" href="classConfigFile.html#a2ad47b1c6db0571f035e71909fece24e">00253</a> <span class="keywordtype">void</span> <a class="code" href="classConfigFile.html#aa209a19359ca5c657c2aae19932f066f">ConfigFile::add</a>( <span class="keyword">const</span> T& key ,<span class="keywordtype">bool</span> store)
<a name="l00254"></a>00254 {
<a name="l00255"></a>00255 <span class="keywordflow">if</span>(<a class="code" href="classConfigFile.html#afd3d1146ae212a7e5802961f5ad3fe91">keyExists</a>(key))
<a name="l00256"></a>00256 <span class="keywordflow">return</span>;
<a name="l00257"></a>00257 <span class="keywordtype">string</span> v = <a class="code" href="classConfigFile.html#a0b2ef4a39ca6ea31d186c301f1f52700">T_as_string</a>( key );
<a name="l00258"></a>00258 <a class="code" href="classConfigFile.html#a6b445b393fcf42386a804fc4077fac10">trim</a>(v);
<a name="l00259"></a>00259 <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>[v] = <span class="stringliteral">" "</span>;
<a name="l00260"></a>00260 <span class="keywordflow">if</span>(store)
<a name="l00261"></a>00261 {
<a name="l00262"></a>00262 std::ofstream os(<a class="code" href="classConfigFile.html#aa5cb7de8754cd596b0e7b1d306d143bf">file</a>.c_str(),std::ios::app);
<a name="l00263"></a>00263 os << v << std::endl;
<a name="l00264"></a>00264 os.close();
<a name="l00265"></a>00265 }
<a name="l00266"></a>00266
<a name="l00267"></a>00267 }
<a name="l00268"></a>00268
<a name="l00269"></a>00269 <span class="keyword">template</span><<span class="keyword">class</span> T>
<a name="l00270"></a><a class="code" href="classConfigFile.html#a154715f4b7602da0467dc0caa9d9ec08">00270</a> <span class="keywordtype">void</span> <a class="code" href="classConfigFile.html#afca295f72101b138ad2702a11c342f37">ConfigFile::remove</a>( <span class="keyword">const</span> T& key )
<a name="l00271"></a>00271 {
<a name="l00272"></a>00272 <span class="keywordflow">if</span>(<a class="code" href="classConfigFile.html#afd3d1146ae212a7e5802961f5ad3fe91">keyExists</a>(key))
<a name="l00273"></a>00273 <span class="keywordflow">return</span>;
<a name="l00274"></a>00274 <span class="keywordtype">string</span> v = <a class="code" href="classConfigFile.html#a0b2ef4a39ca6ea31d186c301f1f52700">T_as_string</a>( key );
<a name="l00275"></a>00275 <a class="code" href="classConfigFile.html#a6b445b393fcf42386a804fc4077fac10">trim</a>(v);
<a name="l00276"></a>00276 <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>.erase( <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>.find( v ) );
<a name="l00277"></a>00277 <a class="code" href="classConfigFile.html#ab13acdfb1472f6672574a30e7ae1ba2a">save</a>();
<a name="l00278"></a>00278
<a name="l00279"></a>00279 }
<a name="l00280"></a>00280 <span class="keyword">template</span><<span class="keyword">class</span> T>
<a name="l00281"></a><a class="code" href="classConfigFile.html#a1db64f1cbca25b9d744babca6e7b9382">00281</a> <span class="keywordtype">bool</span> <a class="code" href="classConfigFile.html#afd3d1146ae212a7e5802961f5ad3fe91">ConfigFile::keyExists</a>(<span class="keyword">const</span> T & key)<span class="keyword"> const</span>
<a name="l00282"></a>00282 <span class="keyword"></span>{
<a name="l00283"></a>00283
<a name="l00284"></a>00284 <span class="keywordtype">string</span> v = <a class="code" href="classConfigFile.html#a0b2ef4a39ca6ea31d186c301f1f52700">T_as_string</a>( key );
<a name="l00285"></a>00285 <a class="code" href="classConfigFile.html#af606aa032e366450b81792da67c984fc">mapci</a> p = <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>.find( v );
<a name="l00286"></a>00286 <span class="keywordflow">return</span> ( p != <a class="code" href="classConfigFile.html#a91b9b9e241d42bd3b1bb8b3e6355761f">myContents</a>.end() );
<a name="l00287"></a>00287
<a name="l00288"></a>00288 }
<a name="l00289"></a>00289 <span class="preprocessor">#endif // CONFIGFILE_H</span>
<a name="l00290"></a>00290 <span class="preprocessor"></span>
<a name="l00291"></a>00291 <span class="comment">// Release notes:</span>
<a name="l00292"></a>00292 <span class="comment">// v1.0 21 May 1999</span>
<a name="l00293"></a>00293 <span class="comment">// + First release</span>
<a name="l00294"></a>00294 <span class="comment">// + Template read() access only through non-member readConfigFile()</span>
<a name="l00295"></a>00295 <span class="comment">// + ConfigurationFileBool is only built-in helper class</span>
<a name="l00296"></a>00296 <span class="comment">// </span>
<a name="l00297"></a>00297 <span class="comment">// v2.0 3 May 2002</span>
<a name="l00298"></a>00298 <span class="comment">// + Shortened name from ConfigurationFile to ConfigFile</span>
<a name="l00299"></a>00299 <span class="comment">// + Implemented template member functions</span>
<a name="l00300"></a>00300 <span class="comment">// + Changed default comment separator from % to #</span>
<a name="l00301"></a>00301 <span class="comment">// + Enabled reading of multiple-line values</span>
<a name="l00302"></a>00302 <span class="comment">// </span>
<a name="l00303"></a>00303 <span class="comment">// v2.1 24 May 2004</span>
<a name="l00304"></a>00304 <span class="comment">// + Made template specializations inline to avoid compiler-dependent linkage</span>
<a name="l00305"></a>00305 <span class="comment">// + Allowed comments within multiple-line values</span>
<a name="l00306"></a>00306 <span class="comment">// + Enabled blank line termination for multiple-line values</span>
<a name="l00307"></a>00307 <span class="comment">// + Added optional sentry to detect end of configuration file</span>
<a name="l00308"></a>00308 <span class="comment">// + Rewrote messy trimWhitespace() function as elegant trim()</span>
</pre></div></div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
