Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
cfgfile.h
Go to the documentation of this file.00001 /* 00002 Copyright (C) 2001 by Martin Geisse <mgeisse@gmx.net> 00003 00004 This library is free software; you can redistribute it and/or 00005 modify it under the terms of the GNU Library General Public 00006 License as published by the Free Software Foundation; either 00007 version 2 of the License, or (at your option) any later version. 00008 00009 This library is distributed in the hope that it will be useful, 00010 but WITHOUT ANY WARRANTY; without even the implied warranty of 00011 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00012 Library General Public License for more details. 00013 00014 You should have received a copy of the GNU Library General Public 00015 License along with this library; if not, write to the Free 00016 Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 00017 */ 00018 00019 #ifndef __CS_UTIL_CFGFILE_H__ 00020 #define __CS_UTIL_CFGFILE_H__ 00021 00026 #include "csextern.h" 00027 #include "csutil/array.h" 00028 #include "iutil/cfgfile.h" 00029 #include "iutil/vfs.h" 00030 00031 class csConfigNode; 00032 class csConfigIterator; 00033 00037 class CS_CRYSTALSPACE_EXPORT csConfigFile : public iConfigFile 00038 { 00039 public: 00040 SCF_DECLARE_IBASE; 00041 00043 csConfigFile(const char *Filename = 0, iVFS* = 0); 00045 csConfigFile (iBase*); 00047 virtual ~csConfigFile(); 00048 00050 virtual bool IsEmpty() const; 00051 00053 virtual const char *GetFileName () const; 00054 00059 virtual iVFS* GetVFS () const; 00060 00065 virtual void SetFileName (const char*, iVFS*); 00066 00082 virtual bool Load (const char* iFileName, iVFS* = 0, bool Merge = false, 00083 bool NewWins = true); 00084 00089 virtual bool Save (); 00090 00097 virtual bool Save (const char *iFileName, iVFS* = 0); 00098 00100 virtual void Clear(); 00101 00108 virtual csPtr<iConfigIterator> Enumerate(const char *Subsection = 0); 00109 00111 virtual bool KeyExists(const char *Key) const; 00113 virtual bool SubsectionExists(const char *Subsection) const; 00114 00116 virtual int GetInt(const char *Key, int Def) const; 00118 virtual float GetFloat(const char *Key, float Def = 0.0) const; 00120 virtual const char *GetStr(const char *Key, const char *Def = "") const; 00122 virtual bool GetBool(const char *Key, bool Def = false) const; 00124 virtual const char *GetComment(const char *Key) const; 00125 00127 virtual void SetStr (const char *Key, const char *Val); 00129 virtual void SetInt (const char *Key, int Value); 00131 virtual void SetFloat (const char *Key, float Value); 00133 virtual void SetBool (const char *Key, bool Value); 00140 virtual bool SetComment (const char *Key, const char *Text); 00142 virtual void DeleteKey(const char *Key); 00144 virtual void SetEOFComment(const char *Text); 00146 virtual const char *GetEOFComment() const; 00147 00148 private: 00149 friend class csConfigIterator; 00150 00151 /* 00152 * pointer to the root node (there are always two unnamed nodes at the 00153 * beginning and end of the list to make inserting and deleting nodes 00154 * easier). 00155 */ 00156 csConfigNode *FirstNode, *LastNode; 00157 /* 00158 * list of all iterators for this config object. This is required because 00159 * changes to the configuration may affect the iterators (e.g. when 00160 * you delete a key). Sorry, but this can't be a typed vector! 00161 */ 00162 csArray<csConfigIterator*> *Iterators; 00163 // current file name and file system 00164 char *Filename; 00165 // the VFS filesystem used for this file (or 0 if not used) 00166 csRef<iVFS> VFS; 00167 /* 00168 * are the current contents of this object different from the contents 00169 * stored in the config file? 00170 */ 00171 bool Dirty; 00172 // final comment at the end of the configuration file 00173 char *EOFComment; 00174 00175 // private initialization function 00176 void InitializeObject (); 00177 // load the configuration from a file, ignoring the dirty flag 00178 virtual bool LoadNow(const char *Filename, iVFS *vfs, bool overwrite); 00179 /* 00180 * load the configuration from a data buffer and add it to the current 00181 * configuration. This may modify the contents of the file buffer but 00182 * will not delete it. This function will set the dirty flag if any 00183 * options have been added or modified. 00184 */ 00185 virtual void LoadFromBuffer(char *Filedata, bool overwrite); 00186 // return a pointer to the named node or the first node of a subsection. 00187 csConfigNode *FindNode(const char *Name, bool isSubsection = false) const; 00188 // create a new node in the list 00189 csConfigNode *CreateNode(const char *Name); 00190 // deregister an iterator 00191 void RemoveIterator(csConfigIterator *it) const; 00192 // save file without looking for dirty flag 00193 virtual bool SaveNow(const char *Filename, iVFS *vfs) const; 00194 }; 00195 00196 #endif // __CS_UTIL_CFGFILE_H__
Generated for Crystal Space by doxygen 1.4.4