<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csutil/cfgfile.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<h1>csutil/cfgfile.h</h1><a href="csutil_2cfgfile_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2001 by Martin Geisse <mgeisse@gmx.net></span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment"> License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment"> version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00012"></a>00012 <span class="comment"> Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment"> License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_UTIL_CFGFILE_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_UTIL_CFGFILE_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="csutil_2array_8h.html" title="Generic Array Template.">csutil/array.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="scf__implementation_8h.html" title="Crystal Space Shared Class Facility (SCF) - implementation creation support.">csutil/scf_implementation.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="iutil_2cfgfile_8h.html" title="Configuration file interface.">iutil/cfgfile.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="vfs_8h.html" title="Virtual File System SCF interface.">iutil/vfs.h</a>"</span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">class </span>csConfigNode;
<a name="l00033"></a>00033 <span class="keyword">class </span>csConfigIterator;
<a name="l00034"></a>00034 <span class="keyword">struct </span><a class="code" href="structiCommandLineParser.html" title="A utility class that makes it easier to parse the command line.">iCommandLineParser</a>;
<a name="l00035"></a>00035
<a name="l00039"></a><a class="code" href="classcsConfigFile.html">00039</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsConfigFile.html" title="Configuration file which implements the iConfigFile SCF interface.">csConfigFile</a> :
<a name="l00040"></a>00040 <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a><csConfigFile, iConfigFile>
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 <span class="keyword">public</span>:
<a name="l00044"></a>00044 <a class="code" href="classcsConfigFile.html" title="Configuration file which implements the iConfigFile SCF interface.">csConfigFile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *Filename = 0, <a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a>* = 0);
<a name="l00046"></a>00046 <a class="code" href="classcsConfigFile.html" title="Configuration file which implements the iConfigFile SCF interface.">csConfigFile</a> (<a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>*);
<a name="l00048"></a>00048 <span class="keyword">virtual</span> ~<a class="code" href="classcsConfigFile.html" title="Configuration file which implements the iConfigFile SCF interface.">csConfigFile</a>();
<a name="l00049"></a>00049
<a name="l00051"></a>00051 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsEmpty() <span class="keyword">const</span>;
<a name="l00052"></a>00052
<a name="l00054"></a>00054 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *GetFileName () <span class="keyword">const</span>;
<a name="l00055"></a>00055
<a name="l00060"></a>00060 <span class="keyword">virtual</span> <a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a>* GetVFS () <span class="keyword">const</span>;
<a name="l00061"></a>00061
<a name="l00066"></a>00066 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetFileName (<span class="keyword">const</span> <span class="keywordtype">char</span>*, <a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a>*);
<a name="l00067"></a>00067
<a name="l00083"></a>00083 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Load (<span class="keyword">const</span> <span class="keywordtype">char</span>* iFileName, <a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a>* = 0, <span class="keywordtype">bool</span> Merge = <span class="keyword">false</span>,
<a name="l00084"></a>00084 <span class="keywordtype">bool</span> NewWins = <span class="keyword">true</span>);
<a name="l00085"></a>00085
<a name="l00092"></a>00092 <span class="keyword">virtual</span> <span class="keywordtype">void</span> LoadFromBuffer(<span class="keyword">const</span> <span class="keywordtype">char</span> *Filedata, <span class="keywordtype">bool</span> overwrite);
<a name="l00093"></a>00093
<a name="l00098"></a>00098 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Save ();
<a name="l00099"></a>00099
<a name="l00106"></a>00106 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Save (<span class="keyword">const</span> <span class="keywordtype">char</span> *iFileName, <a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a>* = 0);
<a name="l00107"></a>00107
<a name="l00109"></a>00109 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Clear();
<a name="l00110"></a>00110
<a name="l00117"></a>00117 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iConfigIterator></a> Enumerate(<span class="keyword">const</span> <span class="keywordtype">char</span> *Subsection = 0);
<a name="l00118"></a>00118
<a name="l00120"></a>00120 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> KeyExists(<span class="keyword">const</span> <span class="keywordtype">char</span> *Key) <span class="keyword">const</span>;
<a name="l00122"></a>00122 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> SubsectionExists(<span class="keyword">const</span> <span class="keywordtype">char</span> *Subsection) <span class="keyword">const</span>;
<a name="l00123"></a>00123
<a name="l00125"></a>00125 <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetInt(<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keywordtype">int</span> Def) <span class="keyword">const</span>;
<a name="l00127"></a>00127 <span class="keyword">virtual</span> <span class="keywordtype">float</span> GetFloat(<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keywordtype">float</span> Def = 0.0) <span class="keyword">const</span>;
<a name="l00129"></a>00129 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *GetStr(<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keyword">const</span> <span class="keywordtype">char</span> *Def = <span class="stringliteral">""</span>) <span class="keyword">const</span>;
<a name="l00131"></a>00131 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> GetBool(<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keywordtype">bool</span> Def = <span class="keyword">false</span>) <span class="keyword">const</span>;
<a name="l00133"></a>00133 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iStringArray></a> GetTuple(<span class="keyword">const</span> <span class="keywordtype">char</span> *Key) <span class="keyword">const</span>;
<a name="l00135"></a>00135 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *GetComment(<span class="keyword">const</span> <span class="keywordtype">char</span> *Key) <span class="keyword">const</span>;
<a name="l00136"></a>00136
<a name="l00138"></a>00138 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetStr (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keyword">const</span> <span class="keywordtype">char</span> *Val);
<a name="l00140"></a>00140 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetInt (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keywordtype">int</span> Value);
<a name="l00142"></a>00142 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetFloat (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keywordtype">float</span> Value);
<a name="l00144"></a>00144 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetBool (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keywordtype">bool</span> Value);
<a name="l00146"></a>00146 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetTuple (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <a class="code" href="structiStringArray.html" title="This is an SCF-compatible interface for csStringArray.">iStringArray</a>* Value);
<a name="l00153"></a>00153 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> SetComment (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key, <span class="keyword">const</span> <span class="keywordtype">char</span> *Text);
<a name="l00155"></a>00155 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DeleteKey(<span class="keyword">const</span> <span class="keywordtype">char</span> *Key);
<a name="l00157"></a>00157 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetEOFComment(<span class="keyword">const</span> <span class="keywordtype">char</span> *Text);
<a name="l00159"></a>00159 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *GetEOFComment() <span class="keyword">const</span>;
<a name="l00160"></a>00160
<a name="l00169"></a>00169 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ParseCommandLine (<a class="code" href="structiCommandLineParser.html" title="A utility class that makes it easier to parse the command line.">iCommandLineParser</a>* cmdline, <a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a>* vfs,
<a name="l00170"></a>00170 <span class="keywordtype">bool</span> Merge = <span class="keyword">false</span>, <span class="keywordtype">bool</span> NewWins = <span class="keyword">true</span>);
<a name="l00171"></a>00171 <span class="keyword">private</span>:
<a name="l00172"></a><a class="code" href="classcsConfigFile.html#5bcc04b44ae878b5fa61f65570ab6cbe">00172</a> <span class="keyword">friend</span> <span class="keyword">class </span>csConfigIterator;
<a name="l00173"></a>00173
<a name="l00174"></a>00174 <span class="comment">/*</span>
<a name="l00175"></a>00175 <span class="comment"> * pointer to the root node (there are always two unnamed nodes at the</span>
<a name="l00176"></a>00176 <span class="comment"> * beginning and end of the list to make inserting and deleting nodes</span>
<a name="l00177"></a>00177 <span class="comment"> * easier).</span>
<a name="l00178"></a>00178 <span class="comment"> */</span>
<a name="l00179"></a>00179 csConfigNode *FirstNode, *LastNode;
<a name="l00180"></a>00180 <span class="comment">/*</span>
<a name="l00181"></a>00181 <span class="comment"> * list of all iterators for this config object. This is required because</span>
<a name="l00182"></a>00182 <span class="comment"> * changes to the configuration may affect the iterators (e.g. when</span>
<a name="l00183"></a>00183 <span class="comment"> * you delete a key). Sorry, but this can't be a typed vector!</span>
<a name="l00184"></a>00184 <span class="comment"> */</span>
<a name="l00185"></a>00185 <a class="code" href="classcsArray.html" title="A templated array class.">csArray<csConfigIterator*></a> *Iterators;
<a name="l00186"></a>00186 <span class="comment">// current file name and file system</span>
<a name="l00187"></a>00187 <span class="keywordtype">char</span> *Filename;
<a name="l00188"></a>00188 <span class="comment">// the VFS filesystem used for this file (or 0 if not used)</span>
<a name="l00189"></a>00189 <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iVFS></a> VFS;
<a name="l00190"></a>00190 <span class="comment">/*</span>
<a name="l00191"></a>00191 <span class="comment"> * are the current contents of this object different from the contents</span>
<a name="l00192"></a>00192 <span class="comment"> * stored in the config file?</span>
<a name="l00193"></a>00193 <span class="comment"> */</span>
<a name="l00194"></a>00194 <span class="keywordtype">bool</span> Dirty;
<a name="l00195"></a>00195 <span class="comment">// final comment at the end of the configuration file</span>
<a name="l00196"></a>00196 <span class="keywordtype">char</span> *EOFComment;
<a name="l00197"></a>00197
<a name="l00198"></a>00198 <span class="comment">// private initialization function</span>
<a name="l00199"></a>00199 <span class="keywordtype">void</span> InitializeObject ();
<a name="l00200"></a>00200 <span class="comment">// load the configuration from a file, ignoring the dirty flag</span>
<a name="l00201"></a>00201 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> LoadNow(<span class="keyword">const</span> <span class="keywordtype">char</span> *Filename, <a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a> *vfs, <span class="keywordtype">bool</span> overwrite);
<a name="l00202"></a>00202
<a name="l00203"></a>00203 <span class="comment">// return a pointer to the named node or the first node of a subsection.</span>
<a name="l00204"></a>00204 csConfigNode *FindNode(<span class="keyword">const</span> <span class="keywordtype">char</span> *Name, <span class="keywordtype">bool</span> isSubsection = <span class="keyword">false</span>) <span class="keyword">const</span>;
<a name="l00205"></a>00205 <span class="comment">// create a new node in the list</span>
<a name="l00206"></a>00206 csConfigNode *CreateNode(<span class="keyword">const</span> <span class="keywordtype">char</span> *Name);
<a name="l00207"></a>00207 <span class="comment">// deregister an iterator</span>
<a name="l00208"></a>00208 <span class="keywordtype">void</span> RemoveIterator(csConfigIterator *it) <span class="keyword">const</span>;
<a name="l00209"></a>00209 <span class="comment">// save file without looking for dirty flag</span>
<a name="l00210"></a>00210 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> SaveNow(<span class="keyword">const</span> <span class="keywordtype">char</span> *Filename, <a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a> *vfs) <span class="keyword">const</span>;
<a name="l00211"></a>00211 };
<a name="l00212"></a>00212
<a name="l00213"></a>00213 <span class="preprocessor">#endif // __CS_UTIL_CFGFILE_H__</span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
1421
