X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0a240683ed2ed0ad7efe733d451dd36740607605..5a224901b8ede55e1db9980f0fcaf7d2cb49285f:/include/wx/confbase.h diff --git a/include/wx/confbase.h b/include/wx/confbase.h index edbe8ca2ca..fbd1e57a13 100644 --- a/include/wx/confbase.h +++ b/include/wx/confbase.h @@ -1,7 +1,7 @@ /////////////////////////////////////////////////////////////////////////////// // 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) @@ -19,9 +19,6 @@ #endif #include "wx/defs.h" - -#if wxUSE_CONFIG - #include "wx/string.h" // ---------------------------------------------------------------------------- @@ -35,42 +32,34 @@ /// 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? +#if wxUSE_CONFIG + +#include "wx/string.h" + +/// 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) or wxIniConfig // (under Win16)) -#ifndef wxCONFIG_WIN32_NATIVE - #define wxCONFIG_WIN32_NATIVE TRUE +#ifndef wxUSE_CONFIG_NATIVE + #define wxUSE_CONFIG_NATIVE 1 #endif // Style flags for constructor style parameter -#define wxCONFIG_USE_LOCAL_FILE 1 -#define wxCONFIG_USE_GLOBAL_FILE 2 - -// ---------------------------------------------------------------------------- -// various helper global functions -// ---------------------------------------------------------------------------- - -/* - 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); - -/* - Split path into parts removing '..' in progress - */ -extern void wxSplitPath(wxArrayString& aParts, const char *sz); +enum +{ + wxCONFIG_USE_LOCAL_FILE = 1, + wxCONFIG_USE_GLOBAL_FILE = 2, + wxCONFIG_USE_RELATIVE_PATH = 4 +}; // ---------------------------------------------------------------------------- // abstract base class wxConfigBase which defines the interface for derived @@ -81,40 +70,51 @@ 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 WXDLLEXPORT 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; } // ctor & virtual dtor - // environment variable expansion is on by default -// wxConfigBase() { m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE; } - - // ctor - - // 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, + // 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, @@ -146,43 +146,67 @@ public: bool Exists(const wxString& strName) const { return HasGroup(strName) || HasEntry(strName); } + // 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(const wxString& key, wxString *pStr) const = 0; - virtual bool Read(const wxString& key, wxString *pStr, const wxString& defVal) const; - virtual wxString Read(const wxString& key, const wxString& defVal = wxEmptyString) const; + // read a string from the key + bool Read(const wxString& key, wxString *pStr) const; + bool Read(const wxString& key, wxString *pStr, const wxString& defVal) const; - virtual bool Read(const wxString& key, long *pl) const = 0; - virtual bool Read(const wxString& key, long *pl, long defVal) const; + // read a number (long) + bool Read(const wxString& key, long *pl) const; + bool Read(const wxString& key, long *pl, long defVal) const; - virtual long Read(const wxString& strKey, long defVal) const - { long l; Read(strKey, &l, defVal); return l; } + // read an int + bool Read(const wxString& key, int *pi) const; + bool Read(const wxString& key, int *pi, int defVal) const; - // Convenience functions that are built on other forms + // read a double + bool Read(const wxString& key, double* val) const; + bool Read(const wxString& key, double* val, double defVal) const; - // int - virtual bool Read(const wxString& key, int *pi) const; - virtual bool Read(const wxString& key, int *pi, int defVal) const; + // read a bool + bool Read(const wxString& key, bool* val) const; + bool Read(const wxString& key, bool* val, bool defVal) const; - // double - virtual bool Read(const wxString& key, double* val) const; - virtual bool Read(const wxString& key, double* val, double 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; } - // bool - virtual bool Read(const wxString& key, bool* val) const; - virtual bool Read(const wxString& key, bool* val, bool defVal) const; + 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 wxString& key, const wxString& value) = 0; - virtual bool Write(const wxString& key, long value) = 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); } - // Convenience functions - virtual bool Write(const wxString& key, double value); - virtual bool Write(const wxString& key, bool value); + bool Write(const wxString& key, double value) + { return DoWriteDouble(key, value); } - // permanently writes all changes + 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 @@ -217,22 +241,32 @@ public: wxString ExpandEnvVars(const wxString& str) const; // misc accessors - inline wxString GetAppName() const { return m_appName; } - inline wxString GetVendorName() const { return m_vendorName; } + wxString GetAppName() const { return m_appName; } + wxString GetVendorName() const { return m_vendorName; } - inline void SetAppName(const wxString& appName) { m_appName = appName; } - inline void SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; } + // Used wxIniConfig to set members in constructor + void SetAppName(const wxString& appName) { m_appName = appName; } + void SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; } - inline void SetStyle(long style) { m_style = style; } - inline long GetStyle() const { return m_style; } + void SetStyle(long style) { m_style = style; } + long GetStyle() const { return m_style; } protected: static bool IsImmutable(const wxString& key) - #ifndef __WXMAC__ - { return !key.IsEmpty() && key[0u] == wxCONFIG_IMMUTABLE_PREFIX; } - #else - { return !key.IsEmpty() && key[0ul] == wxCONFIG_IMMUTABLE_PREFIX; } - #endif + { 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? @@ -252,27 +286,27 @@ private: 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 wxConfigPathChanger - { - public: - // ctor/dtor do path changing/restorin - wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry); - ~wxConfigPathChanger(); - - // 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? - }; +// 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 wxConfigPathChanger +{ +public: + // ctor/dtor do path changing/restorin + wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry); + ~wxConfigPathChanger(); + + // 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? +}; // ---------------------------------------------------------------------------- @@ -280,7 +314,7 @@ private: // ---------------------------------------------------------------------------- // under Windows we prefer to use the native implementation -#if defined(__WXMSW__) && wxCONFIG_WIN32_NATIVE +#if defined(__WXMSW__) && wxUSE_CONFIG_NATIVE #ifdef __WIN32__ #define wxConfig wxRegConfig #define sm_classwxConfig sm_classwxRegConfig @@ -293,9 +327,21 @@ private: #define sm_classwxConfig sm_classwxFileConfig #endif -#endif - - // wxUSE_CONFIG +#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. +*/ + +WXDLLEXPORT wxString wxExpandEnvVars(const wxString &sz); + +/* + Split path into parts removing '..' in progress + */ +WXDLLEXPORT void wxSplitPath(wxArrayString& aParts, const wxChar *sz); + #endif // _WX_CONFIG_H_