CrystalSpace

Public API Reference

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

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/array.h"
00024 
00025 class csConfigNode;
00026 class csConfigIterator;
00027 
00031 class csConfigFile : public iConfigFile
00032 {
00033 public:
00034   SCF_DECLARE_IBASE;
00035 
00037   csConfigFile(const char *Filename = 0, iVFS* = 0);
00039   csConfigFile (iBase*);
00041   virtual ~csConfigFile();
00042 
00044   virtual const char *GetFileName () const;
00045 
00050   virtual iVFS* GetVFS () const;
00051 
00056   virtual void SetFileName (const char*, iVFS*);
00057 
00073   virtual bool Load (const char* iFileName, iVFS* = 0, bool Merge = false,
00074     bool NewWins = true);
00075 
00080   virtual bool Save ();
00081 
00088   virtual bool Save (const char *iFileName, iVFS* = 0);
00089 
00091   virtual void Clear();
00092 
00099   virtual csPtr<iConfigIterator> Enumerate(const char *Subsection = 0);
00100 
00102   virtual bool KeyExists(const char *Key) const;
00104   virtual bool SubsectionExists(const char *Subsection) const;
00105 
00107   virtual int GetInt(const char *Key, int Def) const;
00109   virtual float GetFloat(const char *Key, float Def = 0.0) const;
00111   virtual const char *GetStr(const char *Key, const char *Def = "") const;
00113   virtual bool GetBool(const char *Key, bool Def = false) const;
00115   virtual const char *GetComment(const char *Key) const;
00116 
00118   virtual void SetStr (const char *Key, const char *Val);
00120   virtual void SetInt (const char *Key, int Value);
00122   virtual void SetFloat (const char *Key, float Value);
00124   virtual void SetBool (const char *Key, bool Value);
00131   virtual bool SetComment (const char *Key, const char *Text);
00133   virtual void DeleteKey(const char *Key);
00135   virtual void SetEOFComment(const char *Text);
00137   virtual const char *GetEOFComment() const;
00138 
00139 private:
00140   friend class csConfigIterator;
00141 
00142   /*
00143    * pointer to the root node (there are always two unnamed nodes at the
00144    * beginning and end of the list to make inserting and deleting nodes
00145    * easier).
00146    */
00147   csConfigNode *FirstNode, *LastNode;
00148   /*
00149    * list of all iterators for this config object. This is required because
00150    * changes to the configuration may affect the iterators (e.g. when
00151    * you delete a key). Sorry, but this can't be a typed vector!
00152    */
00153   csArray<csConfigIterator*> *Iterators;
00154   // current file name and file system
00155   char *Filename;
00156   // the VFS filesystem used for this file (or 0 if not used)
00157   csRef<iVFS> VFS;
00158   /*
00159    * are the current contents of this object different from the contents
00160    * stored in the config file?
00161    */
00162   bool Dirty;
00163   // final comment at the end of the configuration file
00164   char *EOFComment;
00165 
00166   // private initialization function
00167   void InitializeObject ();
00168   // load the configuration from a file, ignoring the dirty flag
00169   virtual bool LoadNow(const char *Filename, iVFS *vfs, bool overwrite);
00170   /*
00171    * load the configuration from a data buffer and add it to the current
00172    * configuration. This may modify the contents of the file buffer but
00173    * will not delete it. This function will set the dirty flag if any
00174    * options have been added or modified.
00175    */
00176   virtual void LoadFromBuffer(char *Filedata, bool overwrite);
00177   // return a pointer to the named node or the first node of a subsection.
00178   csConfigNode *FindNode(const char *Name, bool isSubsection = false) const;
00179   // create a new node in the list
00180   csConfigNode *CreateNode(const char *Name);
00181   // deregister an iterator
00182   void RemoveIterator(csConfigIterator *it) const;
00183   // save file without looking for dirty flag
00184   virtual bool SaveNow(const char *Filename, iVFS *vfs) const;
00185 };
00186 
00187 #endif // __CS_UTIL_CFGFILE_H__

Generated for Crystal Space by doxygen 1.2.14