/// shall we be case sensitive in parsing variable names?
#ifndef APPCONF_CASE_SENSITIVE
- #define APPCONF_CASE_SENSITIVE FALSE
+ #define APPCONF_CASE_SENSITIVE false
#endif
/// separates group and entry names
/// should we use registry instead of configuration files under Win32?
#ifndef APPCONF_WIN32_NATIVE
- #define APPCONF_WIN32_NATIVE TRUE
+ #define APPCONF_WIN32_NATIVE true
#endif
// ----------------------------------------------------------------------------
-// global functions
+// 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.
-*/
-wxString ExpandEnvVars(const wxString& str);
+ */
+extern wxString ExpandEnvVars(const wxString& str);
+
+/*
+ Split path into parts removing '..' in progress
+ */
+extern void SplitPath(wxArrayString& aParts, const char *sz);
// ----------------------------------------------------------------------------
// abstract base class wxConfig which defines the interface for derived classes
class wxConfig
{
public:
+ // static functions
+ // sets the config object, returns the previous pointer
+ static wxConfig *Set(wxConfig *pConfig);
+ // get the config object, creates it on demand
+ static wxConfig *Get() { if ( !ms_pConfig ) Create(); return ms_pConfig; }
+ // create a new config object
+ static void Create();
+
// ctor & virtual dtor
wxConfig() { }
virtual ~wxConfig();
virtual bool GetFirstEntry(wxString& str, long& lIndex) = 0;
virtual bool GetNextEntry (wxString& str, long& lIndex) = 0;
- // key access
- // read a string or long value from the key. If the key is not
- // found the default value is returned.
- virtual const char *Read(const char *szKey,
- const char *szDefault = NULL) const = 0;
- virtual long Read(const char *szKey, long lDefault) const = 0;
+ // 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 = 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 = NULL) const;
+ // the same for longs
+ 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;
// 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;
+ virtual bool Flush(bool bCurrentOnly = false) = 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;
+ bool bDeleteGroupIfEmpty = true) = 0;
// delete the group (with all subgroups)
virtual bool DeleteGroup(const char *szKey) = 0;
// delete the whole underlying object (disk file, registry key, ...)
virtual bool DeleteAll() = 0;
protected:
- // true if environment variables are to be auto-expanded
+ static bool IsImmutable(const char *szKey)
+ { return *szKey == APPCONF_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 function returns
+ class PathChanger
+ {
+ public:
+ // ctor/dtor do path changing/restorin
+ PathChanger(const wxConfig *pContainer, const wxString& strEntry);
+ ~PathChanger();
+
+ // get the key name
+ const wxString& Name() const { return m_strName; }
+
+ private:
+ wxConfig *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?
+ };
+
+ // are we doing automatic environment variable expansion?
bool m_bExpandEnvVars;
-};
-// ----------------------------------------------------------------------------
-// functions to create different config implementations
-// ----------------------------------------------------------------------------
-
-wxConfig *CreateFileConfig(const wxString& strFile, bool bLocalOnly = FALSE);
+ // static variables
+ static wxConfig *ms_pConfig;
+};
#endif //_APPCONF_H
///////////////////////////////////////////////////////////////////////////////
// ============================================================================
-// headers
+// declarations
// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
#ifdef __GNUG__
-#pragma implementation "app.h"
+ #pragma implementation "config.h"
#endif
#include "wx/wxprec.h"
#pragma hdrstop
#endif //__BORLANDC__
-#include <wx/string.h>
-#include <wx/intl.h>
+#ifndef WX_PRECOMP
+ #include <wx/string.h>
+ #include <wx/intl.h>
+#endif //WX_PRECOMP
+
+#include <wx/app.h>
#include <wx/file.h>
#include <wx/log.h>
#include <wx/textfile.h>
#include <wx/config.h>
+#include <wx/fileconf.h>
-#include <stdlib.h>
-#include <ctype.h>
+#include <ctype.h> // for isalnum()
+
+// ----------------------------------------------------------------------------
+// global and class static variables
+// ----------------------------------------------------------------------------
+
+wxConfig *wxConfig::ms_pConfig = NULL;
// ============================================================================
// implementation
{
}
+wxConfig *wxConfig::Set(wxConfig *pConfig)
+{
+ wxConfig *pOld = ms_pConfig;
+ ms_pConfig = pConfig;
+ return pOld;
+}
+
+void wxConfig::Create()
+{
+ ms_pConfig = wxTheApp->CreateConfig();
+}
+
+const char *wxConfig::Read(const char *szKey, const char *szDefault) const
+{
+ static char s_szBuf[1024];
+ wxString s;
+ Read(&s, szKey, szDefault);
+ strncpy(s_szBuf, s, WXSIZEOF(s_szBuf));
+
+ return s_szBuf;
+}
+
+// ----------------------------------------------------------------------------
+// Config::PathChanger
+// ----------------------------------------------------------------------------
+
+wxConfig::PathChanger::PathChanger(const wxConfig *pContainer,
+ const wxString& strEntry)
+{
+ m_pContainer = (wxConfig *)pContainer;
+ wxString strPath = strEntry.Before(APPCONF_PATH_SEPARATOR);
+
+ // special case of "/keyname" when there is nothing before "/"
+ if ( strPath.IsEmpty() && strEntry[0] == APPCONF_PATH_SEPARATOR )
+ strPath = APPCONF_PATH_SEPARATOR;
+
+ if ( !strPath.IsEmpty() ) {
+ // do change the path
+ m_bChanged = TRUE;
+ m_strName = strEntry.Right(APPCONF_PATH_SEPARATOR);
+ m_strOldPath = m_pContainer->GetPath();
+ m_strOldPath += APPCONF_PATH_SEPARATOR;
+ m_pContainer->SetPath(strPath);
+ }
+ else {
+ // it's a name only, without path - nothing to do
+ m_bChanged = FALSE;
+ m_strName = strEntry;
+ }
+}
+
+wxConfig::PathChanger::~PathChanger()
+{
+ // only restore path if it was changed
+ if ( m_bChanged ) {
+ m_pContainer->SetPath(m_strOldPath);
+ }
+}
+
// ----------------------------------------------------------------------------
// static & global functions
// ----------------------------------------------------------------------------
return strResult;
}
+
+// this function is used to properly interpret '..' in path
+void SplitPath(wxArrayString& aParts, const char *sz)
+{
+ aParts.Empty();
+
+ wxString strCurrent;
+ const char *pc = sz;
+ for ( ;; ) {
+ if ( *pc == '\0' || *pc == APPCONF_PATH_SEPARATOR ) {
+ if ( strCurrent == "." ) {
+ // ignore
+ }
+ else if ( strCurrent == ".." ) {
+ // go up one level
+ if ( aParts.IsEmpty() )
+ wxLogWarning("'%s' has extra '..', ignored.", sz);
+ else
+ aParts.Remove(aParts.Count() - 1);
+ }
+ else if ( !strCurrent.IsEmpty() ) {
+ aParts.Add(strCurrent);
+ strCurrent.Empty();
+ }
+ //else:
+ // could log an error here, but we prefer to ignore extra '/'
+
+ if ( *pc == '\0' )
+ return;
+ }
+ else
+ strCurrent += *pc;
+
+ pc++;
+ }
+}
+