Revert "Make wxMSW stack walking methods work with Unicode identifiers."

[wxWidgets.git] / include / wx / fileconf.h

diff --git a/include/wx/fileconf.h b/include/wx/fileconf.h
index 4b1dbceaaa25c0f8d9a1d4266752d99c258dc9b4..c16129a5b14c40cdeb91c216ee64260c42e63d09 100644 (file)
--- a/include/wx/fileconf.h
+++ b/include/wx/fileconf.h
@@ -1,34 +1,25 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        fileconf.h
+// Name:        wx/fileconf.h

 // Purpose:     wxFileConfig derivation of wxConfigBase
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     07.04.98 (adapted from appconf.cpp)
 // Purpose:     wxFileConfig derivation of wxConfigBase
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     07.04.98 (adapted from appconf.cpp)

-// RCS-ID:      $Id$
-// Copyright:   (c) 1997 Karsten Ballüder   &  Vadim Zeitlin
+// Copyright:   (c) 1997 Karsten Ballueder   &  Vadim Zeitlin

 //                       Ballueder@usa.net     <zeitlin@dptmaths.ens-cachan.fr>
 //                       Ballueder@usa.net     <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _FILECONF_H
 #define   _FILECONF_H
 
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _FILECONF_H
 #define   _FILECONF_H
 

-#ifdef __GNUG__
-#pragma interface "fileconf.h"
-#endif
-

 #include "wx/defs.h"
 #include "wx/defs.h"

-#include "wx/textfile.h"
-#include "wx/string.h"

 
 

-// ----------------------------------------------------------------------------
-// compile options
-// ----------------------------------------------------------------------------
+#if wxUSE_CONFIG

 
 

-// it won't compile without it anyhow
-#ifndef USE_CONFIG
-  #error "Please define USE_CONFIG or remove fileconf.cpp from your makefile"
-#endif // USE_CONFIG
+#include "wx/textfile.h"
+#include "wx/string.h"
+#include "wx/confbase.h"
+#include "wx/filename.h"

 
 // ----------------------------------------------------------------------------
 // wxFileConfig
 
 // ----------------------------------------------------------------------------
 // wxFileConfig


@@ -94,12 +85,20 @@
   in the entries it reads: for example, if you have an entry
     score_file = $HOME/.score
   a call to Read(&str, "score_file") will return a complete path to .score file
   in the entries it reads: for example, if you have an entry
     score_file = $HOME/.score
   a call to Read(&str, "score_file") will return a complete path to .score file

-  unless the expansion was previousle disabled with SetExpandEnvVars(FALSE) call
+  unless the expansion was previously disabled with SetExpandEnvVars(false) call

   (it's on by default, the current status can be retrieved with
    IsExpandingEnvVars function).
 */
   (it's on by default, the current status can be retrieved with
    IsExpandingEnvVars function).
 */

+class WXDLLIMPEXP_FWD_BASE wxFileConfigGroup;
+class WXDLLIMPEXP_FWD_BASE wxFileConfigEntry;
+class WXDLLIMPEXP_FWD_BASE wxFileConfigLineList;
+
+#if wxUSE_STREAMS
+class WXDLLIMPEXP_FWD_BASE wxInputStream;
+class WXDLLIMPEXP_FWD_BASE wxOutputStream;
+#endif // wxUSE_STREAMS

 
 

-class wxFileConfig : public wxConfigBase
+class WXDLLIMPEXP_BASE wxFileConfig : public wxConfigBase

 {
 public:
   // construct the "standard" full name for global (system-wide) and
 {
 public:
   // construct the "standard" full name for global (system-wide) and


@@ -110,116 +109,104 @@ public:
   // Unix   /etc/file.ext           ~/.file
   // Win    %windir%\file.ext   %USERPROFILE%\file.ext
   //
   // Unix   /etc/file.ext           ~/.file
   // Win    %windir%\file.ext   %USERPROFILE%\file.ext
   //

-  // where file is the basename of szFile, ext is it's extension
+  // where file is the basename of szFile, ext is its extension

   // or .conf (Unix) or .ini (Win) if it has none
   // or .conf (Unix) or .ini (Win) if it has none

-  static wxString GetGlobalFileName(const char *szFile);
-  static wxString GetLocalFileName(const char *szFile);
+  static wxFileName GetGlobalFile(const wxString& szFile);
+  static wxFileName GetLocalFile(const wxString& szFile, int style = 0);

 
 

-  // ctor & dtor
+  static wxString GetGlobalFileName(const wxString& szFile)
+  {
+      return GetGlobalFile(szFile).GetFullPath();
+  }

 
 

-#if 0
-    // the names of local and global (if not disabled) config files are
-    // constructed using Get{Local|Global}FileName functions described above
-    // (szAppName is just the (short) name of your application)
-  wxFileConfig(const char *szAppName, bool bLocalOnly = FALSE);
-    // this ctor allows you to specify custom names for both files (if strGlobal
-    // isn't a full path, it's considered to be relative to the standard
-    // directory, i.e. /etc under Unix and %windir% under Windows, if strLocal
-    // is not an absolute path, it's considered to be relative to the user's
-    // directory). If either of strings is empty, the corresponding file is not
-    // used.
-  wxFileConfig(const wxString& strLocal, const wxString& strGlobal);
-#endif
+  static wxString GetLocalFileName(const wxString& szFile, int style = 0)
+  {
+      return GetLocalFile(szFile, style).GetFullPath();
+  }

 
 

-   // New constructor: one size fits all. Specify wxCONFIG_USE_LOCAL_FILE
-   // or wxCONFIG_USE_GLOBAL_FILE to say which files should be used.
-  wxFileConfig(const wxString& appName, const wxString& vendorName = "",
-               const wxString& localFilename = "", const wxString& globalFilename = "",
-               long style = wxCONFIG_USE_LOCAL_FILE);
+  // ctor & dtor
+    // New constructor: one size fits all. Specify wxCONFIG_USE_LOCAL_FILE or
+    // wxCONFIG_USE_GLOBAL_FILE to say which files should be used.
+  wxFileConfig(const wxString& appName = wxEmptyString,
+               const wxString& vendorName = wxEmptyString,
+               const wxString& localFilename = wxEmptyString,
+               const wxString& globalFilename = wxEmptyString,
+               long style = wxCONFIG_USE_LOCAL_FILE | wxCONFIG_USE_GLOBAL_FILE,
+               const wxMBConv& conv = wxConvAuto());
+
+#if wxUSE_STREAMS
+    // ctor that takes an input stream.
+  wxFileConfig(wxInputStream &inStream, const wxMBConv& conv = wxConvAuto());
+#endif // wxUSE_STREAMS

 
     // dtor will save unsaved data
   virtual ~wxFileConfig();
 
 
     // dtor will save unsaved data
   virtual ~wxFileConfig();
 

+  // under Unix, set the umask to be used for the file creation, do nothing
+  // under other systems
+#ifdef __UNIX__
+  void SetUmask(int mode) { m_umask = mode; }
+#else // !__UNIX__
+  void SetUmask(int WXUNUSED(mode)) { }
+#endif // __UNIX__/!__UNIX__
+

   // implement inherited pure virtual functions
   virtual void SetPath(const wxString& strPath);
   // implement inherited pure virtual functions
   virtual void SetPath(const wxString& strPath);

-  virtual const wxString& GetPath() const { return m_strPath; }
+  virtual const wxString& GetPath() const;

 
   virtual bool GetFirstGroup(wxString& str, long& lIndex) const;
   virtual bool GetNextGroup (wxString& str, long& lIndex) const;
   virtual bool GetFirstEntry(wxString& str, long& lIndex) const;
   virtual bool GetNextEntry (wxString& str, long& lIndex) const;
 
 
   virtual bool GetFirstGroup(wxString& str, long& lIndex) const;
   virtual bool GetNextGroup (wxString& str, long& lIndex) const;
   virtual bool GetFirstEntry(wxString& str, long& lIndex) const;
   virtual bool GetNextEntry (wxString& str, long& lIndex) const;
 

-  virtual size_t GetNumberOfEntries(bool bRecursive = FALSE) const;
-  virtual size_t GetNumberOfGroups(bool bRecursive = FALSE) const;
+  virtual size_t GetNumberOfEntries(bool bRecursive = false) const;
+  virtual size_t GetNumberOfGroups(bool bRecursive = false) const;

 
   virtual bool HasGroup(const wxString& strName) const;
   virtual bool HasEntry(const wxString& strName) const;
 
 
   virtual bool HasGroup(const wxString& strName) const;
   virtual bool HasEntry(const wxString& strName) const;
 

-  virtual bool Read(const wxString& key, wxString *pStr) const;
-  virtual bool Read(const wxString& key, wxString *pStr, const wxString& defValue) const;
-  virtual bool Read(const wxString& key, long *pl) const;
-
-  // The following are necessary to satisfy the compiler
-  wxString Read(const wxString& key, const wxString& defVal) const
-  { return wxConfigBase::Read(key, defVal); }
-  bool Read(const wxString& key, long *pl, long defVal) const
-  { return wxConfigBase::Read(key, pl, defVal); }
-  long Read(const wxString& key, long defVal) const
-  { return wxConfigBase::Read(key, defVal); }
-  bool Read(const wxString& key, double* val) const
-  { return wxConfigBase::Read(key, val); }
-  bool Read(const wxString& key, double* val, double defVal) const
-  { return wxConfigBase::Read(key, val, defVal); }
-
-  virtual bool Write(const wxString& key, const wxString& szValue);
-  virtual bool Write(const wxString& key, long lValue);
+  virtual bool Flush(bool bCurrentOnly = false);

 
 

-  virtual bool Flush(bool bCurrentOnly = FALSE);
+  virtual bool RenameEntry(const wxString& oldName, const wxString& newName);
+  virtual bool RenameGroup(const wxString& oldName, const wxString& newName);

 
 

-  virtual bool DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso);
+  virtual bool DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso = true);

   virtual bool DeleteGroup(const wxString& szKey);
   virtual bool DeleteAll();
 
   virtual bool DeleteGroup(const wxString& szKey);
   virtual bool DeleteAll();
 

-public:
-  // fwd decl
-  class ConfigGroup;
-  class ConfigEntry;
-
-  // we store all lines of the local config file as a linked list in memory
-  class LineList
-  {
-  public:
-    // ctor
-    LineList(const wxString& str, LineList *pNext = (LineList *) NULL) : m_strLine(str)
-      { SetNext(pNext); SetPrev((LineList *) NULL); }
-
-    //
-    LineList *Next() const              { return m_pNext;  }
-    LineList *Prev() const              { return m_pPrev;  }
-    void      SetNext(LineList *pNext)  { m_pNext = pNext; }
-    void      SetPrev(LineList *pPrev)  { m_pPrev = pPrev; }
-
-    //
-    void SetText(const wxString& str) { m_strLine = str;  }
-    const wxString& Text() const      { return m_strLine; }
-
-  private:
-    wxString  m_strLine;      // line contents
-    LineList *m_pNext,        // next node
-             *m_pPrev;        // previous one
-  };
+  // additional, wxFileConfig-specific, functionality
+#if wxUSE_STREAMS
+  // save the entire config file text to the given stream, note that the text
+  // won't be saved again in dtor when Flush() is called if you use this method
+  // as it won't be "changed" any more
+  virtual bool Save(wxOutputStream& os, const wxMBConv& conv = wxConvAuto());
+#endif // wxUSE_STREAMS

 
 

+public:

   // functions to work with this list
   // functions to work with this list

-  LineList *LineListAppend(const wxString& str);
-  LineList *LineListInsert(const wxString& str,
-                           LineList *pLine);    // NULL => Prepend()
-  void      LineListRemove(LineList *pLine);
+  wxFileConfigLineList *LineListAppend(const wxString& str);
+  wxFileConfigLineList *LineListInsert(const wxString& str,
+                           wxFileConfigLineList *pLine);    // NULL => Prepend()
+  void      LineListRemove(wxFileConfigLineList *pLine);

   bool      LineListIsEmpty();
 
   bool      LineListIsEmpty();
 

+protected:
+  virtual bool DoReadString(const wxString& key, wxString *pStr) const;
+  virtual bool DoReadLong(const wxString& key, long *pl) const;
+#if wxUSE_BASE64
+  virtual bool DoReadBinary(const wxString& key, wxMemoryBuffer* buf) const;
+#endif // wxUSE_BASE64
+
+  virtual bool DoWriteString(const wxString& key, const wxString& szValue);
+  virtual bool DoWriteLong(const wxString& key, long lValue);
+#if wxUSE_BASE64
+  virtual bool DoWriteBinary(const wxString& key, const wxMemoryBuffer& buf);
+#endif // wxUSE_BASE64
+

 private:
 private:

-  // GetXXXFileame helpers: return ('/' terminated) directory names
+  // GetXXXFileName helpers: return ('/' terminated) directory names

   static wxString GetGlobalDir();
   static wxString GetGlobalDir();

-  static wxString GetLocalDir();
+  static wxString GetLocalDir(int style = 0);

 
   // common part of all ctors (assumes that m_str{Local|Global}File are already
   // initialized
 
   // common part of all ctors (assumes that m_str{Local|Global}File are already
   // initialized


@@ -229,122 +216,48 @@ private:
   void CleanUp();
 
   // parse the whole file
   void CleanUp();
 
   // parse the whole file

-  void Parse(wxTextFile& file, bool bLocal);
+  void Parse(const wxTextBuffer& buffer, bool bLocal);

 
   // the same as SetPath("/")
   void SetRootPath();
 
 
   // the same as SetPath("/")
   void SetRootPath();
 

+  // real SetPath() implementation, returns true if path could be set or false
+  // if path doesn't exist and createMissingComponents == false
+  bool DoSetPath(const wxString& strPath, bool createMissingComponents);
+
+  // set/test the dirty flag
+  void SetDirty() { m_isDirty = true; }
+  void ResetDirty() { m_isDirty = false; }
+  bool IsDirty() const { return m_isDirty; }
+
+

   // member variables
   // ----------------
   // member variables
   // ----------------

-  LineList   *m_linesHead,        // head of the linked list
-             *m_linesTail;        // tail
+  wxFileConfigLineList *m_linesHead,    // head of the linked list
+                       *m_linesTail;    // tail

 
 

-  wxString    m_strLocalFile,     // local  file name passed to ctor
-              m_strGlobalFile;    // global
-  wxString    m_strPath;          // current path (not '/' terminated)
+  wxFileName  m_fnLocalFile,            // local  file name passed to ctor
+              m_fnGlobalFile;           // global
+  wxString    m_strPath;                // current path (not '/' terminated)

 
 

-  ConfigGroup *m_pRootGroup,      // the top (unnamed) group
-              *m_pCurrentGroup;   // the current group
+  wxFileConfigGroup *m_pRootGroup,      // the top (unnamed) group
+                    *m_pCurrentGroup;   // the current group

 
 

-//protected: --- if wxFileConfig::ConfigEntry is not public, functions in
-//               ConfigGroup such as Find/AddEntry can't return "ConfigEntry *"
-public:
-  WX_DEFINE_SORTED_ARRAY(ConfigEntry *, ArrayEntries);
-  WX_DEFINE_SORTED_ARRAY(ConfigGroup *, ArrayGroups);
+  wxMBConv    *m_conv;

 
 

-  class ConfigEntry
-  {
-  private:
-    ConfigGroup  *m_pParent;      // group that contains us
-    wxString      m_strName,      // entry name
-                  m_strValue;     //       value
-    bool          m_bDirty,       // changed since last read?
-                  m_bImmutable;   // can be overriden locally?
-    int           m_nLine;        // used if m_pLine == NULL only
-    LineList     *m_pLine;        // pointer to our line in the linked list
-                                  // or NULL if it was found in global file
-
-  public:
-    ConfigEntry(ConfigGroup *pParent, const wxString& strName, int nLine);
-
-    // simple accessors
-    const wxString& Name()        const { return m_strName;    }
-    const wxString& Value()       const { return m_strValue;   }
-    ConfigGroup    *Group()       const { return m_pParent;    }
-    bool            IsDirty()     const { return m_bDirty;     }
-    bool            IsImmutable() const { return m_bImmutable; }
-    bool            IsLocal()     const { return m_pLine != 0; }
-    int             Line()        const { return m_nLine;      }
-    LineList       *GetLine()     const { return m_pLine;      }
-
-    // modify entry attributes
-    void SetValue(const wxString& strValue, bool bUser = TRUE);
-    void SetDirty();
-    void SetLine(LineList *pLine);
-  };
-
-  class ConfigGroup
-  {
-  private:
-    wxFileConfig *m_pConfig;        // config object we belong to
-    ConfigGroup  *m_pParent;        // parent group (NULL for root group)
-    ArrayEntries  m_aEntries;       // entries in this group
-    ArrayGroups   m_aSubgroups;     // subgroups
-    wxString      m_strName;        // group's name
-    bool          m_bDirty;         // if FALSE => all subgroups are not dirty
-    LineList     *m_pLine;          // pointer to our line in the linked list
-    ConfigEntry  *m_pLastEntry;     // last entry/subgroup of this group in the
-    ConfigGroup  *m_pLastGroup;     // local file (we insert new ones after it)
-
-    // DeleteSubgroupByName helper
-    bool DeleteSubgroup(ConfigGroup *pGroup);
-
-  public:
-    // ctor
-    ConfigGroup(ConfigGroup *pParent, const wxString& strName, wxFileConfig *);
-
-    // dtor deletes all entries and subgroups also
-    ~ConfigGroup();
-
-    // simple accessors
-    const wxString& Name()    const { return m_strName; }
-    ConfigGroup    *Parent()  const { return m_pParent; }
-    wxFileConfig   *Config()  const { return m_pConfig; }
-    bool            IsDirty() const { return m_bDirty;  }
-
-    bool  IsEmpty() const { return Entries().IsEmpty() && Groups().IsEmpty(); }
-    const ArrayEntries& Entries() const { return m_aEntries;   }
-    const ArrayGroups&  Groups()  const { return m_aSubgroups; }
-
-    // find entry/subgroup (NULL if not found)
-    ConfigGroup *FindSubgroup(const char *szName) const;
-    ConfigEntry *FindEntry   (const char *szName) const;
-
-    // delete entry/subgroup, return FALSE if doesn't exist
-    bool DeleteSubgroupByName(const char *szName);
-    bool DeleteEntry(const char *szName);
-
-    // create new entry/subgroup returning pointer to newly created element
-    ConfigGroup *AddSubgroup(const wxString& strName);
-    ConfigEntry *AddEntry   (const wxString& strName, int nLine = NOT_FOUND);
-
-    // will also recursively set parent's dirty flag
-    void SetDirty();
-    void SetLine(LineList *pLine);
-
-    //
-    wxString GetFullName() const;
-
-    // get the last line belonging to an entry/subgroup of this group
-    LineList *GetGroupLine();     // line which contains [group]
-    LineList *GetLastEntryLine(); // after which our subgroups start
-    LineList *GetLastGroupLine(); // after which the next group starts
-
-    // called by entries/subgroups when they're created/deleted
-    void SetLastEntry(ConfigEntry *pEntry) { m_pLastEntry = pEntry; }
-    void SetLastGroup(ConfigGroup *pGroup) { m_pLastGroup = pGroup; }
-  };
+#ifdef __UNIX__
+  int m_umask;                          // the umask to use for file creation
+#endif // __UNIX__
+
+  bool m_isDirty;                       // if true, we have unsaved changes
+
+  wxDECLARE_NO_COPY_CLASS(wxFileConfig);
+  DECLARE_ABSTRACT_CLASS(wxFileConfig)

 };
 
 };
 

-#endif  //_FILECONF_H
+#endif
+  // wxUSE_CONFIG
+
+#endif
+  //_FILECONF_H