X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c67daf87774c71ae9f73af9969008af220e52a11..c3008402f72bf26f81fb54d9737fa06d9ca0c3c8:/include/wx/confbase.h diff --git a/include/wx/confbase.h b/include/wx/confbase.h index eac77600e5..63b755f0f9 100644 --- a/include/wx/confbase.h +++ b/include/wx/confbase.h @@ -1,31 +1,23 @@ /////////////////////////////////////////////////////////////////////////////// // Name: confbase.h // Purpose: declaration of the base class of all config implementations -// (see also: fileconf.h and msw/regconf.h) +// (see also: fileconf.h and msw/regconf.h and iniconf.h) // Author: Karsten Ballüder & Vadim Zeitlin // Modified by: // Created: 07.04.98 (adapted from appconf.h) // RCS-ID: $Id$ // Copyright: (c) 1997 Karsten Ballüder Ballueder@usa.net // Vadim Zeitlin -// Licence: wxWindows license +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #ifndef _WX_CONFBASE_H_ #define _WX_CONFBASE_H_ -#ifdef __GNUG__ -#pragma interface "confbase.h" -#endif +#include "wx/defs.h" +#include "wx/string.h" -// ---------------------------------------------------------------------------- -// compile options -// ---------------------------------------------------------------------------- - -// it won't compile without it anyhow -#ifndef USE_WXCONFIG - #error "Please define USE_WXCONFIG or remove config.cpp from your makefile" -#endif // USE_WXCONFIG +class WXDLLIMPEXP_BASE wxArrayString; // ---------------------------------------------------------------------------- // constants @@ -33,46 +25,42 @@ /// shall we be case sensitive in parsing variable names? #ifndef wxCONFIG_CASE_SENSITIVE - #define wxCONFIG_CASE_SENSITIVE FALSE + #define wxCONFIG_CASE_SENSITIVE 0 #endif /// separates group and entry names (probably shouldn't be changed) #ifndef wxCONFIG_PATH_SEPARATOR - #define wxCONFIG_PATH_SEPARATOR '/' + #define wxCONFIG_PATH_SEPARATOR _T('/') #endif /// introduces immutable entries // (i.e. the ones which can't be changed from the local config file) #ifndef wxCONFIG_IMMUTABLE_PREFIX - #define wxCONFIG_IMMUTABLE_PREFIX '!' + #define wxCONFIG_IMMUTABLE_PREFIX _T('!') #endif -/// should we use registry instead of configuration files under Win32? -// (i.e. whether wxConfigBase::Create() will create a wxFileConfig (if it's -// FALSE) or wxRegConfig (if it's true and we're under Win32) or wxIniConfig -// (under Win16)) -#ifndef wxCONFIG_WIN32_NATIVE - #define wxCONFIG_WIN32_NATIVE TRUE -#endif +#if wxUSE_CONFIG -// ---------------------------------------------------------------------------- -// various helper global functions -// ---------------------------------------------------------------------------- +#include "wx/string.h" -/* - Replace environment variables ($SOMETHING) with their values. The format is - $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and - '_' only. '$' must be escaped ('\$') in order to be taken literally. - */ -extern wxString wxExpandEnvVars(const wxString &sz); +/// should we use registry instead of configuration files under Windows? +// (i.e. whether wxConfigBase::Create() will create a wxFileConfig (if it's +// false) or wxRegConfig (if it's true and we're under Win32)) +#ifndef wxUSE_CONFIG_NATIVE + #define wxUSE_CONFIG_NATIVE 1 +#endif -/* - Split path into parts removing '..' in progress - */ -extern void wxSplitPath(wxArrayString& aParts, const char *sz); +// Style flags for constructor style parameter +enum +{ + wxCONFIG_USE_LOCAL_FILE = 1, + wxCONFIG_USE_GLOBAL_FILE = 2, + wxCONFIG_USE_RELATIVE_PATH = 4, + wxCONFIG_USE_NO_ESCAPE_CHARACTERS = 8 +}; // ---------------------------------------------------------------------------- -// abstract base class wxConfigBase which defines the interface for derived +// abstract base class wxConfigBase which defines the interface for derived // classes // // wxConfig organizes the items in a tree-like structure (modeled after the @@ -80,30 +68,52 @@ extern void wxSplitPath(wxArrayString& aParts, const char *sz); // There is always one current group given by the current path. // // Keys are pairs "key_name = value" where value may be of string or integer -// (long) type (@@@ doubles and other types such as wxDate coming soon). +// (long) type (TODO doubles and other types such as wxDate coming soon). // ---------------------------------------------------------------------------- -class wxConfigBase + +class WXDLLIMPEXP_BASE wxConfigBase { public: + // constants + // the type of an entry + enum EntryType + { + Type_Unknown, + Type_String, + Type_Boolean, + Type_Integer, // use Read(long *) + Type_Float // use Read(double *) + }; + // static functions // sets the config object, returns the previous pointer static wxConfigBase *Set(wxConfigBase *pConfig); // get the config object, creates it on demand unless DontCreateOnDemand // was called - static wxConfigBase *Get() { if ( !ms_pConfig ) Create(); return ms_pConfig; } + static wxConfigBase *Get(bool createOnDemand = true) + { if ( createOnDemand && (!ms_pConfig) ) Create(); return ms_pConfig; } // create a new config object: this function will create the "best" // implementation of wxConfig available for the current platform, see - // comments near definition wxCONFIG_WIN32_NATIVE for details. It returns + // comments near definition wxUSE_CONFIG_NATIVE for details. It returns // the created object and also sets it as ms_pConfig. static wxConfigBase *Create(); // should Get() try to create a new log object if the current one is NULL? - static void DontCreateOnDemand() { ms_bAutoCreate = FALSE; } + static void DontCreateOnDemand() { ms_bAutoCreate = false; } // ctor & virtual dtor - // environment variable expansion is on by default - wxConfigBase() { m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE; } + // ctor (can be used as default ctor too) + // + // Not all args will always be used by derived classes, but including + // them all in each class ensures compatibility. If appName is empty, + // uses wxApp name + wxConfigBase(const wxString& appName = wxEmptyString, + const wxString& vendorName = wxEmptyString, + const wxString& localFilename = wxEmptyString, + const wxString& globalFilename = wxEmptyString, + long style = 0); + // empty but ensures that dtor of all derived classes is virtual - virtual ~wxConfigBase() { } + virtual ~wxConfigBase(); // path management // set current path: if the first character is '/', it's the absolute path, @@ -123,46 +133,97 @@ public: virtual bool GetNextEntry (wxString& str, long& lIndex) const = 0; // get number of entries/subgroups in the current group, with or without // it's subgroups - virtual size_t GetNumberOfEntries(bool bRecursive = FALSE) const = 0; - virtual size_t GetNumberOfGroups(bool bRecursive = FALSE) const = 0; + virtual size_t GetNumberOfEntries(bool bRecursive = false) const = 0; + virtual size_t GetNumberOfGroups(bool bRecursive = false) const = 0; // tests of existence - // returns TRUE if the group by this name exists + // returns true if the group by this name exists virtual bool HasGroup(const wxString& strName) const = 0; // same as above, but for an entry virtual bool HasEntry(const wxString& strName) const = 0; - // returns TRUE if either a group or an entry with a given name exist + // returns true if either a group or an entry with a given name exist bool Exists(const wxString& strName) const { return HasGroup(strName) || HasEntry(strName); } - // key access: returns TRUE if value was really read, FALSE if default used + // get the entry type + virtual EntryType GetEntryType(const wxString& name) const + { + // by default all entries are strings + return HasEntry(name) ? Type_String : Type_Unknown; + } + + // key access: returns true if value was really read, false if default used // (and if the key is not found the default value is returned.) + // read a string from the key - virtual bool Read(wxString *pStr, const char *szKey, - const char *szDefault = (const char *) NULL) const = 0; - // another version using statis buffer - it means it will be overwritten - // after each call to this function! - virtual const char *Read(const char *szKey, - const char *szDefault = (const char *) NULL) const; - // the same for longs - virtual long Read(const char *szKey, long lDefault) const - { long l; Read(&l, szKey, lDefault); return l; } - // and another version: returns true if default value is returned - virtual bool Read(long *pl, const char *szKey, long lDefault = 0) const = 0; + bool Read(const wxString& key, wxString *pStr) const; + bool Read(const wxString& key, wxString *pStr, const wxString& defVal) const; + + // read a number (long) + bool Read(const wxString& key, long *pl) const; + bool Read(const wxString& key, long *pl, long defVal) const; + + // read an int + bool Read(const wxString& key, int *pi) const; + bool Read(const wxString& key, int *pi, int defVal) const; + + // read a double + bool Read(const wxString& key, double* val) const; + bool Read(const wxString& key, double* val, double defVal) const; + + // read a bool + bool Read(const wxString& key, bool* val) const; + bool Read(const wxString& key, bool* val, bool defVal) const; + + // convenience functions returning directly the value (we don't have them for + // int/double/bool as there would be ambiguities with the long one then) + wxString Read(const wxString& key, + const wxString& defVal = wxEmptyString) const + { wxString s; (void)Read(key, &s, defVal); return s; } + + long Read(const wxString& key, long defVal) const + { long l; (void)Read(key, &l, defVal); return l; } // write the value (return true on success) - virtual bool Write(const char *szKey, const char *szValue) = 0; - virtual bool Write(const char *szKey, long lValue) = 0; - // permanently writes all changes - virtual bool Flush(bool bCurrentOnly = FALSE) = 0; + bool Write(const wxString& key, const wxString& value) + { return DoWriteString(key, value); } + + bool Write(const wxString& key, long value) + { return DoWriteLong(key, value); } + + bool Write(const wxString& key, int value) + { return DoWriteInt(key, value); } + + bool Write(const wxString& key, double value) + { return DoWriteDouble(key, value); } + + bool Write(const wxString& key, bool value) + { return DoWriteBool(key, value); } + + // we have to provide a separate version for C strings as otherwise they + // would be converted to bool and not to wxString as expected! + bool Write(const wxString& key, const wxChar *value) + { return Write(key, wxString(value)); } + + // permanently writes all changes + virtual bool Flush(bool bCurrentOnly = false) = 0; + + // renaming, all functions return false on failure (probably because the new + // name is already taken by an existing entry) + // rename an entry + virtual bool RenameEntry(const wxString& oldName, + const wxString& newName) = 0; + // rename a group + virtual bool RenameGroup(const wxString& oldName, + const wxString& newName) = 0; // delete entries/groups // deletes the specified entry and the group it belongs to if // it was the last key in it and the second parameter is true - virtual bool DeleteEntry(const char *szKey, - bool bDeleteGroupIfEmpty = TRUE) = 0; + virtual bool DeleteEntry(const wxString& key, + bool bDeleteGroupIfEmpty = true) = 0; // delete the group (with all subgroups) - virtual bool DeleteGroup(const char *szKey) = 0; + virtual bool DeleteGroup(const wxString& key) = 0; // delete the whole underlying object (disk file, registry key, ...) // primarly for use by desinstallation routine. virtual bool DeleteAll() = 0; @@ -171,74 +232,120 @@ public: // we can automatically expand environment variables in the config entries // (this option is on by default, you can turn it on/off at any time) bool IsExpandingEnvVars() const { return m_bExpandEnvVars; } - void SetExpandEnvVars(bool bDoIt = TRUE) { m_bExpandEnvVars = bDoIt; } + void SetExpandEnvVars(bool bDoIt = true) { m_bExpandEnvVars = bDoIt; } // recording of default values - void SetRecordDefaults(bool bDoIt = TRUE) { m_bRecordDefaults = bDoIt; } + void SetRecordDefaults(bool bDoIt = true) { m_bRecordDefaults = bDoIt; } bool IsRecordingDefaults() const { return m_bRecordDefaults; } // does expansion only if needed - wxString ExpandEnvVars(const wxString& str) const - { - wxString tmp; // Required for BC++ - if (IsExpandingEnvVars()) - tmp = wxExpandEnvVars(str); - else - tmp = str; - return tmp; - } + wxString ExpandEnvVars(const wxString& str) const; + + // misc accessors + wxString GetAppName() const { return m_appName; } + wxString GetVendorName() const { return m_vendorName; } + + // Used wxIniConfig to set members in constructor + void SetAppName(const wxString& appName) { m_appName = appName; } + void SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; } + + void SetStyle(long style) { m_style = style; } + long GetStyle() const { return m_style; } protected: - static bool IsImmutable(const char *szKey) - { return *szKey == wxCONFIG_IMMUTABLE_PREFIX; } - - // a handy little class which changes current path to the path of given entry - // and restores it in dtor: so if you declare a local variable of this type, - // you work in the entry directory and the path is automatically restored - // when the function returns - class PathChanger - { - public: - // ctor/dtor do path changing/restorin - PathChanger(const wxConfigBase *pContainer, const wxString& strEntry); - ~PathChanger(); - - // get the key name - const wxString& Name() const { return m_strName; } - - private: - wxConfigBase *m_pContainer; // object we live in - wxString m_strName, // name of entry (i.e. name only) - m_strOldPath; // saved path - bool m_bChanged; // was the path changed? - }; + static bool IsImmutable(const wxString& key) + { return !key.IsEmpty() && key[0] == wxCONFIG_IMMUTABLE_PREFIX; } + + // do read/write the values of different types + virtual bool DoReadString(const wxString& key, wxString *pStr) const = 0; + virtual bool DoReadLong(const wxString& key, long *pl) const = 0; + virtual bool DoReadInt(const wxString& key, int *pi) const; + virtual bool DoReadDouble(const wxString& key, double* val) const; + virtual bool DoReadBool(const wxString& key, bool* val) const; + + virtual bool DoWriteString(const wxString& key, const wxString& value) = 0; + virtual bool DoWriteLong(const wxString& key, long value) = 0; + virtual bool DoWriteInt(const wxString& key, int value); + virtual bool DoWriteDouble(const wxString& key, double value); + virtual bool DoWriteBool(const wxString& key, bool value); private: // are we doing automatic environment variable expansion? bool m_bExpandEnvVars; // do we record default values? bool m_bRecordDefaults; - + // static variables static wxConfigBase *ms_pConfig; static bool ms_bAutoCreate; + + // Application name and organisation name + wxString m_appName; + wxString m_vendorName; + + // Style flag + long m_style; }; +// a handy little class which changes current path to the path of given entry +// and restores it in dtor: so if you declare a local variable of this type, +// you work in the entry directory and the path is automatically restored +// when the function returns +// Taken out of wxConfig since not all compilers can cope with nested classes. +class WXDLLIMPEXP_BASE wxConfigPathChanger +{ +public: + // ctor/dtor do path changing/restoring of the path + wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry); + ~wxConfigPathChanger(); + + // get the key name + const wxString& Name() const { return m_strName; } + + // this method must be called if the original path (i.e. the current path at + // the moment of creation of this object) could have been deleted to prevent + // us from restoring the not existing (any more) path + // + // if the original path doesn't exist any more, the path will be restored to + // the deepest still existing component of the old path + void UpdateIfDeleted(); + +private: + wxConfigBase *m_pContainer; // object we live in + wxString m_strName, // name of entry (i.e. name only) + m_strOldPath; // saved path + bool m_bChanged; // was the path changed? + + DECLARE_NO_COPY_CLASS(wxConfigPathChanger) +}; + + // ---------------------------------------------------------------------------- // the native wxConfigBase implementation // ---------------------------------------------------------------------------- // under Windows we prefer to use the native implementation -#if defined(__WXMSW__) && wxCONFIG_WIN32_NATIVE - #ifdef __WIN32__ +// wxIniConfig isn't native anywhere after droping win16 in wxWidgets 2.6 +#if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE #define wxConfig wxRegConfig - #define classwxConfig classwxRegConfig - #else //WIN16 - #define wxConfig wxIniConfig - #define classwxConfig classwxIniConfig - #endif #else // either we're under Unix or wish to use files even under Windows #define wxConfig wxFileConfig - #define classwxConfig classwxFileConfig #endif -#endif // _WX_CONFIG_H_ +#endif // wxUSE_CONFIG + +/* + Replace environment variables ($SOMETHING) with their values. The format is + $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and + '_' only. '$' must be escaped ('\$') in order to be taken literally. +*/ + +WXDLLIMPEXP_BASE wxString wxExpandEnvVars(const wxString &sz); + +/* + Split path into parts removing '..' in progress + */ +WXDLLIMPEXP_BASE void wxSplitPath(wxArrayString& aParts, const wxChar *sz); + + +#endif + // _WX_CONFIG_H_