Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 1423

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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/cfgmgr.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&nbsp;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&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csutil/cfgmgr.h</h1><a href="csutil_2cfgmgr_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 &lt;mgeisse@gmx.net&gt;</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_CFGMGR_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CFGMGR_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="refarr_8h.html" title="Smart Pointer array.">csutil/refarr.h</a>"</span>
<a name="l00029"></a>00029 <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="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="iutil_2cfgmgr_8h.html" title="Configuration manager interface,.">iutil/cfgmgr.h</a>"</span>
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="keyword">class </span>csConfigManagerIterator;
<a name="l00034"></a>00034 
<a name="l00040"></a><a class="code" href="classcsConfigManager.html">00040</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsConfigManager.html" title="A configuration manager makes a number of individual iConfigFile objects appear to...">csConfigManager</a>
<a name="l00041"></a>00041   : <span class="keyword">public</span> <a class="code" href="classscfImplementation2.html">scfImplementation2</a>&lt;csConfigManager,
<a name="l00042"></a>00042                               iConfigManager,
<a name="l00043"></a>00043                               scfFakeInterface&lt;iConfigFile&gt; &gt;
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="keyword">public</span>:
<a name="l00046"></a>00046 
<a name="l00060"></a>00060   <a class="code" href="classcsConfigManager.html" title="A configuration manager makes a number of individual iConfigFile objects appear to...">csConfigManager</a>(<a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a> *DynamicDomain = 0, <span class="keywordtype">bool</span> Optimize = <span class="keyword">false</span>);
<a name="l00062"></a>00062   <span class="keyword">virtual</span> ~<a class="code" href="classcsConfigManager.html" title="A configuration manager makes a number of individual iConfigFile objects appear to...">csConfigManager</a>();
<a name="l00063"></a>00063 
<a name="l00068"></a>00068   <span class="keyword">virtual</span> <span class="keywordtype">void</span> AddDomain(<a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a>*, <span class="keywordtype">int</span> priority);
<a name="l00078"></a>00078   <span class="keyword">virtual</span> <a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a>* AddDomain(<span class="keywordtype">char</span> <span class="keyword">const</span>* path, <a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a>*, <span class="keywordtype">int</span> priority);
<a name="l00086"></a>00086   <span class="keyword">virtual</span> <span class="keywordtype">void</span> RemoveDomain(<a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a>*);
<a name="l00088"></a>00088   <span class="keyword">virtual</span> <span class="keywordtype">void</span> RemoveDomain(<span class="keywordtype">char</span> <span class="keyword">const</span>* path);
<a name="l00093"></a>00093   <span class="keyword">virtual</span> <a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a>* LookupDomain(<span class="keywordtype">char</span> <span class="keyword">const</span>* path) <span class="keyword">const</span>;
<a name="l00095"></a>00095   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetDomainPriority(<span class="keywordtype">char</span> <span class="keyword">const</span>* path, <span class="keywordtype">int</span> priority);
<a name="l00100"></a>00100   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetDomainPriority(<a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a>*, <span class="keywordtype">int</span> priority);
<a name="l00105"></a>00105   <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetDomainPriority(<span class="keywordtype">char</span> <span class="keyword">const</span>* path) <span class="keyword">const</span>;
<a name="l00110"></a>00110   <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetDomainPriority(<a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a>*) <span class="keyword">const</span>;
<a name="l00111"></a>00111 
<a name="l00117"></a>00117   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> SetDynamicDomain(<a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a>*);
<a name="l00123"></a>00123   <span class="keyword">virtual</span> <a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a> *GetDynamicDomain() <span class="keyword">const</span>;
<a name="l00125"></a>00125   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetDynamicDomainPriority(<span class="keywordtype">int</span> priority);
<a name="l00127"></a>00127   <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetDynamicDomainPriority() <span class="keyword">const</span>;
<a name="l00128"></a>00128 
<a name="l00130"></a>00130   <span class="keyword">virtual</span> <span class="keywordtype">void</span> FlushRemoved();
<a name="l00131"></a>00131 
<a name="l00136"></a>00136   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetFileName () <span class="keyword">const</span>;
<a name="l00137"></a>00137 
<a name="l00142"></a>00142   <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="l00143"></a>00143 
<a name="l00150"></a>00150   <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="l00151"></a>00151 
<a name="l00168"></a>00168   <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="l00169"></a>00169     <span class="keywordtype">bool</span> NewWins = <span class="keyword">true</span>);
<a name="l00170"></a>00170 
<a name="l00175"></a>00175   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Save ();
<a name="l00176"></a>00176 
<a name="l00183"></a>00183   <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="l00184"></a>00184 
<a name="l00186"></a>00186   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Clear ();
<a name="l00187"></a>00187 
<a name="l00189"></a>00189   <span class="keywordtype">void</span> CleanUp ();
<a name="l00190"></a>00190 
<a name="l00197"></a>00197   <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;iConfigIterator&gt;</a> Enumerate(<span class="keyword">const</span> <span class="keywordtype">char</span> *Subsection = 0);
<a name="l00198"></a>00198 
<a name="l00200"></a>00200   <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="l00202"></a>00202   <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="l00203"></a>00203 
<a name="l00205"></a>00205   <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 = 0) <span class="keyword">const</span>;
<a name="l00207"></a>00207   <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="l00209"></a>00209   <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="l00211"></a>00211   <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="l00213"></a>00213   <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;iStringArray&gt;</a> GetTuple(<span class="keyword">const</span> <span class="keywordtype">char</span> *Key) <span class="keyword">const</span>;
<a name="l00215"></a>00215   <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="l00216"></a>00216 
<a name="l00218"></a>00218   <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="l00220"></a>00220   <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="l00222"></a>00222   <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="l00224"></a>00224   <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="l00226"></a>00226   <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="l00233"></a>00233   <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="l00235"></a>00235   <span class="keyword">virtual</span> <span class="keywordtype">void</span> DeleteKey(<span class="keyword">const</span> <span class="keywordtype">char</span> *Key);
<a name="l00237"></a>00237   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *GetEOFComment() <span class="keyword">const</span>;
<a name="l00239"></a>00239   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetEOFComment(<span class="keyword">const</span> <span class="keywordtype">char</span> *Text);
<a name="l00240"></a>00240 
<a name="l00241"></a>00241 <span class="keyword">private</span>:
<a name="l00242"></a><a class="code" href="classcsConfigManager.html#d7255606f41886727310689b5f8de04a">00242</a>   <span class="keyword">friend</span> <span class="keyword">class </span>csConfigManagerIterator;
<a name="l00244"></a>00244   <span class="keywordtype">bool</span> Optimize;
<a name="l00246"></a>00246   <span class="keyword">class </span>csConfigDomain *DynamicDomain;
<a name="l00248"></a>00248   <span class="keyword">class </span>csConfigDomain *FirstDomain, *LastDomain;
<a name="l00250"></a>00250   <a class="code" href="classcsRefArray.html" title="An array of smart pointers.">csRefArray&lt;iConfigFile&gt;</a> Removed;
<a name="l00252"></a>00252   <a class="code" href="classcsArray.html" title="A templated array class.">csArray&lt;iConfigIterator*&gt;</a> Iterators;
<a name="l00253"></a>00253 
<a name="l00254"></a>00254   csConfigDomain *FindConfig(<a class="code" href="structiConfigFile.html" title="Configuration file interface.">iConfigFile</a> *cfg) <span class="keyword">const</span>;
<a name="l00255"></a>00255   csConfigDomain *FindConfig(<span class="keyword">const</span> <span class="keywordtype">char</span> *name) <span class="keyword">const</span>;
<a name="l00256"></a>00256   <span class="keywordtype">void</span> ClearKeyAboveDynamic(<span class="keyword">const</span> <span class="keywordtype">char</span> *Key);
<a name="l00257"></a>00257   <span class="keywordtype">void</span> RemoveIterator(csConfigManagerIterator *it);
<a name="l00258"></a>00258   <span class="keywordtype">void</span> FlushRemoved(<span class="keywordtype">size_t</span> n);
<a name="l00259"></a>00259   <span class="keywordtype">size_t</span> FindRemoved(<span class="keyword">const</span> <span class="keywordtype">char</span> *Filename) <span class="keyword">const</span>;
<a name="l00260"></a>00260   <span class="keywordtype">void</span> RemoveDomain(<span class="keyword">class</span> csConfigDomain *cfg);
<a name="l00261"></a>00261 };
<a name="l00262"></a>00262 
<a name="l00263"></a>00263 <span class="preprocessor">#endif // __CS_CFGMGR_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>