CrystalSpace

Public API Reference

csutil/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 "csutil/scf_implementation.h"
00029 #include "iutil/cfgfile.h"
00030 #include "iutil/vfs.h"
00031 
00032 class csConfigNode;
00033 class csConfigIterator;
00034 struct iCommandLineParser;
00035 
00039 class CS_CRYSTALSPACE_EXPORT csConfigFile : 
00040   public scfImplementation1<csConfigFile, iConfigFile>
00041 {
00042 public:
00044   csConfigFile(const char *Filename = 0, iVFS* = 0);
00046   csConfigFile (iBase*);
00048   virtual ~csConfigFile();
00049 
00051   virtual bool IsEmpty() const;
00052 
00054   virtual const char *GetFileName () const;
00055 
00060   virtual iVFS* GetVFS () const;
00061 
00066   virtual void SetFileName (const char*, iVFS*);
00067 
00083   virtual bool Load (const char* iFileName, iVFS* = 0, bool Merge = false,
00084     bool NewWins = true);
00085 
00090   virtual bool Save ();
00091 
00098   virtual bool Save (const char *iFileName, iVFS* = 0);
00099 
00101   virtual void Clear();
00102 
00109   virtual csPtr<iConfigIterator> Enumerate(const char *Subsection = 0);
00110 
00112   virtual bool KeyExists(const char *Key) const;
00114   virtual bool SubsectionExists(const char *Subsection) const;
00115 
00117   virtual int GetInt(const char *Key, int Def) const;
00119   virtual float GetFloat(const char *Key, float Def = 0.0) const;
00121   virtual const char *GetStr(const char *Key, const char *Def = "") const;
00123   virtual bool GetBool(const char *Key, bool Def = false) const;
00125   virtual const char *GetComment(const char *Key) const;
00126 
00128   virtual void SetStr (const char *Key, const char *Val);
00130   virtual void SetInt (const char *Key, int Value);
00132   virtual void SetFloat (const char *Key, float Value);
00134   virtual void SetBool (const char *Key, bool Value);
00141   virtual bool SetComment (const char *Key, const char *Text);
00143   virtual void DeleteKey(const char *Key);
00145   virtual void SetEOFComment(const char *Text);
00147   virtual const char *GetEOFComment() const;
00148 
00157   virtual void ParseCommandLine (iCommandLineParser* cmdline, iVFS* vfs,
00158     bool Merge = false, bool NewWins = true);
00159 private:
00160   friend class csConfigIterator;
00161 
00162   /*
00163    * pointer to the root node (there are always two unnamed nodes at the
00164    * beginning and end of the list to make inserting and deleting nodes
00165    * easier).
00166    */
00167   csConfigNode *FirstNode, *LastNode;
00168   /*
00169    * list of all iterators for this config object. This is required because
00170    * changes to the configuration may affect the iterators (e.g. when
00171    * you delete a key). Sorry, but this can't be a typed vector!
00172    */
00173   csArray<csConfigIterator*> *Iterators;
00174   // current file name and file system
00175   char *Filename;
00176   // the VFS filesystem used for this file (or 0 if not used)
00177   csRef<iVFS> VFS;
00178   /*
00179    * are the current contents of this object different from the contents
00180    * stored in the config file?
00181    */
00182   bool Dirty;
00183   // final comment at the end of the configuration file
00184   char *EOFComment;
00185 
00186   // private initialization function
00187   void InitializeObject ();
00188   // load the configuration from a file, ignoring the dirty flag
00189   virtual bool LoadNow(const char *Filename, iVFS *vfs, bool overwrite);
00190   /*
00191    * load the configuration from a data buffer and add it to the current
00192    * configuration. This may modify the contents of the file buffer but
00193    * will not delete it. This function will set the dirty flag if any
00194    * options have been added or modified.
00195    */
00196   virtual void LoadFromBuffer(const char *Filedata, bool overwrite);
00197   // return a pointer to the named node or the first node of a subsection.
00198   csConfigNode *FindNode(const char *Name, bool isSubsection = false) const;
00199   // create a new node in the list
00200   csConfigNode *CreateNode(const char *Name);
00201   // deregister an iterator
00202   void RemoveIterator(csConfigIterator *it) const;
00203   // save file without looking for dirty flag
00204   virtual bool SaveNow(const char *Filename, iVFS *vfs) const;
00205 };
00206 
00207 #endif // __CS_UTIL_CFGFILE_H__

Generated for Crystal Space 1.0.2 by doxygen 1.4.7