<!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/cfgdoc.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/cfgdoc.h</h1><a href="cfgdoc_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) 2004 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment"> (C) 2004 by Frank Richter</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment"> License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment"> version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment"> License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_UTIL_CFGDOC_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_UTIL_CFGDOC_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="csstring_8h.html" title="String utility class.">csutil/csstring.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="hash_8h.html" title="A generic hash table.">csutil/hash.h</a>"</span>
<a name="l00030"></a>00030 <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="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="iutil_2cfgfile_8h.html" title="Configuration file interface.">iutil/cfgfile.h</a>"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "<a class="code" href="document_8h.html" title="Document Interface.">iutil/document.h</a>"</span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">class </span>csConfigDocumentIterator;
<a name="l00035"></a>00035
<a name="l00040"></a><a class="code" href="classcsConfigDocument.html">00040</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsConfigDocument.html" title="iConfigFile implementation for configurations stored in documents.">csConfigDocument</a> :
<a name="l00041"></a>00041 <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a><csConfigDocument,iConfigFile>
<a name="l00042"></a>00042 {
<a name="l00043"></a><a class="code" href="classcsConfigDocument.html#40b56b4fed8981bee67e66ee7d5c9110">00043</a> <span class="keyword">friend</span> <span class="keyword">class </span>csConfigDocumentIterator;
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="keywordtype">char</span>* filename;
<a name="l00046"></a>00046 <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iDocument></a> document;
<a name="l00047"></a>00047 <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iVFS></a> fileVFS;
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">struct </span>CS_CRYSTALSPACE_EXPORT KeyInfo
<a name="l00050"></a>00050 {
<a name="l00051"></a>00051 <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iDocumentNode></a> comment;
<a name="l00052"></a>00052 <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iDocumentNode></a> node;
<a name="l00053"></a>00053 <span class="keywordtype">char</span>* cachedStringValue;
<a name="l00054"></a>00054 <span class="keywordtype">char</span>* cachedComment;
<a name="l00055"></a>00055 <span class="keywordtype">char</span>* originalKey;
<a name="l00056"></a>00056
<a name="l00057"></a>00057 KeyInfo () : cachedStringValue(0), cachedComment(0), originalKey(0) {}
<a name="l00058"></a>00058 KeyInfo (<span class="keyword">const</span> KeyInfo& other)
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 cachedStringValue = <a class="code" href="group__util.html#gc3a6e34ea28a22fdeda8802c872ce2d0" title="Allocate a new char [] and copy the string into the newly allocated storage.">csStrNew</a> (other.cachedStringValue);
<a name="l00061"></a>00061 cachedComment = <a class="code" href="group__util.html#gc3a6e34ea28a22fdeda8802c872ce2d0" title="Allocate a new char [] and copy the string into the newly allocated storage.">csStrNew</a> (other.cachedComment);
<a name="l00062"></a>00062 originalKey = <a class="code" href="group__util.html#gc3a6e34ea28a22fdeda8802c872ce2d0" title="Allocate a new char [] and copy the string into the newly allocated storage.">csStrNew</a> (other.originalKey);
<a name="l00063"></a>00063 }
<a name="l00064"></a>00064 ~KeyInfo()
<a name="l00065"></a>00065 {
<a name="l00066"></a>00066 <span class="keyword">delete</span>[] cachedStringValue;
<a name="l00067"></a>00067 <span class="keyword">delete</span>[] cachedComment;
<a name="l00068"></a>00068 <span class="keyword">delete</span>[] originalKey;
<a name="l00069"></a>00069 }
<a name="l00070"></a>00070 };
<a name="l00071"></a>00071 <a class="code" href="classcsHash.html" title="A generic hash table class, which grows dynamically and whose buckets are unsorted...">csHash<KeyInfo, csString></a> keys;
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keywordtype">void</span> ParseDocument (<a class="code" href="structiDocument.html" title="Representation of a document containing a hierarchical structure of nodes.">iDocument</a>* doc, <span class="keywordtype">bool</span> Merge = <span class="keyword">false</span>,
<a name="l00074"></a>00074 <span class="keywordtype">bool</span> NewWins = <span class="keyword">true</span>);
<a name="l00075"></a>00075 <span class="keywordtype">void</span> ParseNode (<span class="keyword">const</span> <span class="keywordtype">char</span>* parent, <a class="code" href="structiDocumentNode.html" title="Representation of a node in a document.">iDocumentNode</a>* node,
<a name="l00076"></a>00076 <span class="keywordtype">bool</span> NewWins = <span class="keyword">true</span>);
<a name="l00077"></a>00077 <span class="keyword">public</span>:
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <a class="code" href="classcsConfigDocument.html" title="iConfigFile implementation for configurations stored in documents.">csConfigDocument</a> ();
<a name="l00080"></a>00080 <a class="code" href="classcsConfigDocument.html" title="iConfigFile implementation for configurations stored in documents.">csConfigDocument</a> (<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>* = 0);
<a name="l00081"></a>00081 <a class="code" href="classcsConfigDocument.html" title="iConfigFile implementation for configurations stored in documents.">csConfigDocument</a> (<a class="code" href="structiDocument.html" title="Representation of a document containing a hierarchical structure of nodes.">iDocument</a>* doc);
<a name="l00082"></a>00082 <a class="code" href="classcsConfigDocument.html" title="iConfigFile implementation for configurations stored in documents.">csConfigDocument</a> (<a class="code" href="structiDocumentNode.html" title="Representation of a node in a document.">iDocumentNode</a>* node);
<a name="l00083"></a>00083 <span class="keyword">virtual</span> ~<a class="code" href="classcsConfigDocument.html" title="iConfigFile implementation for configurations stored in documents.">csConfigDocument</a>();
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetFileName () <span class="keyword">const</span>;
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <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="l00088"></a>00088
<a name="l00089"></a>00089 <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="l00090"></a>00090
<a name="l00091"></a>00091 <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="l00092"></a>00092 <span class="keywordtype">bool</span> NewWins = <span class="keyword">true</span>);
<a name="l00093"></a>00093 <span class="keywordtype">bool</span> LoadNode (<a class="code" href="structiDocumentNode.html" title="Representation of a node in a document.">iDocumentNode</a>* node, <span class="keywordtype">bool</span> Merge = <span class="keyword">false</span>, <span class="keywordtype">bool</span> NewWins = <span class="keyword">true</span>);
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Save ();
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <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="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Clear ();
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <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="l00102"></a>00102
<a name="l00103"></a>00103 <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="l00104"></a>00104 <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="l00105"></a>00105
<a name="l00106"></a>00106 <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="l00107"></a>00107 <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="l00108"></a>00108 <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="l00109"></a>00109 <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="l00110"></a>00110 <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="l00111"></a>00111 <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="l00112"></a>00112
<a name="l00113"></a>00113 <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="l00114"></a>00114 <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="l00115"></a>00115 <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="l00116"></a>00116 <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="l00117"></a>00117 <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="l00118"></a>00118 <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="l00119"></a>00119 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DeleteKey (<span class="keyword">const</span> <span class="keywordtype">char</span> *Key);
<a name="l00120"></a>00120 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *GetEOFComment () <span class="keyword">const</span>;
<a name="l00121"></a>00121 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetEOFComment (<span class="keyword">const</span> <span class="keywordtype">char</span> *Text);
<a name="l00122"></a>00122 };
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="preprocessor">#endif // __CS_UTIL_CFGDOC_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
>
70
