CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

cfgfile.h

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 
00022 #include "iutil/cfgfile.h"
00023 #include "csutil/csvector.h"
00024 class csConfigNode;
00025 class csConfigIterator;
00026 
00030 class csConfigFile : public iConfigFile
00031 {
00032 public:
00033   SCF_DECLARE_IBASE;
00034 
00036   csConfigFile(const char *Filename = NULL, iVFS* = NULL);
00038   csConfigFile (iBase*);
00040   virtual ~csConfigFile();
00041 
00043   virtual const char *GetFileName () const;
00044 
00049   virtual iVFS* GetVFS () const;
00050 
00055   virtual void SetFileName (const char*, iVFS*);
00056 
00072   virtual bool Load (const char* iFileName, iVFS* = NULL, bool Merge = false,
00073     bool NewWins = true);
00074 
00079   virtual bool Save ();
00080 
00087   virtual bool Save (const char *iFileName, iVFS* = NULL);
00088 
00090   virtual void Clear();
00091 
00098   virtual csPtr<iConfigIterator> Enumerate(const char *Subsection = NULL);
00099 
00101   virtual bool KeyExists(const char *Key) const;
00103   virtual bool SubsectionExists(const char *Subsection) const;
00104 
00106   virtual int GetInt(const char *Key, int Def) const;
00108   virtual float GetFloat(const char *Key, float Def = 0.0) const;
00110   virtual const char *GetStr(const char *Key, const char *Def = "") const;
00112   virtual bool GetBool(const char *Key, bool Def = false) const;
00114   virtual const char *GetComment(const char *Key) const;
00115 
00117   virtual void SetStr (const char *Key, const char *Val);
00119   virtual void SetInt (const char *Key, int Value);
00121   virtual void SetFloat (const char *Key, float Value);
00123   virtual void SetBool (const char *Key, bool Value);
00130   virtual bool SetComment (const char *Key, const char *Text);
00132   virtual void DeleteKey(const char *Key);
00134   virtual void SetEOFComment(const char *Text);
00136   virtual const char *GetEOFComment() const;
00137 
00138 private:
00139   friend class csConfigIterator;
00140 
00141   /*
00142    * pointer to the root node (there are always two unnamed nodes at the
00143    * beginning and end of the list to make inserting and deleting nodes
00144    * easier).
00145    */
00146   csConfigNode *FirstNode, *LastNode;
00147   /*
00148    * list of all iterators for this config object. This is required because
00149    * changes to the configuration may affect the iterators (e.g. when
00150    * you delete a key). Sorry, but this can't be a typed vector!
00151    */
00152   csVector *Iterators;
00153   // current file name and file system
00154   char *Filename;
00155   // the VFS filesystem used for this file (or NULL if not used)
00156   csRef<iVFS> VFS;
00157   /*
00158    * are the current contents of this object different from the contents
00159    * stored in the config file?
00160    */
00161   bool Dirty;
00162   // final comment at the end of the configuration file
00163   char *EOFComment;
00164 
00165   // private initialization function
00166   void InitializeObject ();
00167   // load the configuration from a file, ignoring the dirty flag
00168   virtual bool LoadNow(const char *Filename, iVFS *vfs, bool overwrite);
00169   /*
00170    * load the configuration from a data buffer and add it to the current
00171    * configuration. This may modify the contents of the file buffer but
00172    * will not delete it. This function will set the dirty flag if any
00173    * options have been added or modified.
00174    */
00175   virtual void LoadFromBuffer(char *Filedata, bool overwrite);
00176   // return a pointer to the named node or the first node of a subsection.
00177   csConfigNode *FindNode(const char *Name, bool isSubsection = false) const;
00178   // create a new node in the list
00179   csConfigNode *CreateNode(const char *Name);
00180   // deregister an iterator
00181   void RemoveIterator(csConfigIterator *it) const;
00182   // save file without looking for dirty flag
00183   virtual bool SaveNow(const char *Filename, iVFS *vfs) const;
00184 };
00185 
00186 #endif // __CS_UTIL_CFGFILE_H__

Generated for Crystal Space by doxygen 1.2.14