// RCS-ID: $Id$
// Copyright: (c) 1997 Karsten Ballüder Ballueder@usa.net
// Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// ----------------------------------------------------------------------------
#endif
#include "wx/config.h"
+#include "wx/intl.h"
+#include "wx/log.h"
#if wxUSE_CONFIG && ((wxUSE_FILE && wxUSE_TEXTFILE) || wxUSE_CONFIG_NATIVE)
#include "wx/app.h"
#include "wx/file.h"
-#include "wx/log.h"
#include "wx/textfile.h"
#include "wx/utils.h"
-#include "wx/log.h"
#include "wx/utils.h"
-#include "wx/intl.h"
#include <stdlib.h>
#include <math.h>
#include <ctype.h>
+#include <limits.h> // for INT_MAX
// ----------------------------------------------------------------------------
// global and class static variables
long style)
: m_appName(appName), m_vendorName(vendorName), m_style(style)
{
- m_bExpandEnvVars = TRUE; m_bRecordDefaults = FALSE;
+ m_bExpandEnvVars = TRUE;
+ m_bRecordDefaults = FALSE;
}
wxConfigBase::~wxConfigBase()
return ms_pConfig;
}
-wxString wxConfigBase::Read(const wxString& key, const wxString& defVal) const
-{
- wxString s;
- Read(key, &s, defVal);
- return s;
-}
+// ----------------------------------------------------------------------------
+// wxConfigBase reading entries
+// ----------------------------------------------------------------------------
-bool wxConfigBase::Read(const wxString& key, wxString *str, const wxString& defVal) const
-{
- if (!Read(key, str))
- {
- *str = ExpandEnvVars(defVal);
- return FALSE;
+// implement both Read() overloads for the given type in terms of DoRead()
+#define IMPLEMENT_READ_FOR_TYPE(name, type, deftype, extra) \
+ bool wxConfigBase::Read(const wxString& key, type *val) const \
+ { \
+ wxCHECK_MSG( val, FALSE, _T("wxConfig::Read(): NULL parameter") ); \
+ \
+ if ( !DoRead##name(key, val) ) \
+ return FALSE; \
+ \
+ *val = extra(*val); \
+ \
+ return TRUE; \
+ } \
+ \
+ bool wxConfigBase::Read(const wxString& key, \
+ type *val, \
+ deftype defVal) const \
+ { \
+ wxCHECK_MSG( val, FALSE, _T("wxConfig::Read(): NULL parameter") ); \
+ \
+ bool read = DoRead##name(key, val); \
+ if ( !read ) \
+ { \
+ if ( IsRecordingDefaults() ) \
+ { \
+ ((wxConfigBase *)this)->DoWrite##name(key, defVal); \
+ } \
+ \
+ *val = defVal; \
+ } \
+ \
+ *val = extra(*val); \
+ \
+ return read; \
}
- else
- return TRUE;
-}
-bool wxConfigBase::Read(const wxString& key, long *pl, long defVal) const
-{
- if (!Read(key, pl))
- {
- *pl = defVal;
- return FALSE;
- }
- else
- return TRUE;
-}
-bool wxConfigBase::Read(const wxString& key, double* val) const
-{
- wxString str;
- if ( Read(key, &str) )
- {
- return str.ToDouble(val);
- }
+IMPLEMENT_READ_FOR_TYPE(String, wxString, const wxString&, ExpandEnvVars)
+IMPLEMENT_READ_FOR_TYPE(Long, long, long, long)
+IMPLEMENT_READ_FOR_TYPE(Int, int, int, int)
+IMPLEMENT_READ_FOR_TYPE(Double, double, double, double)
+IMPLEMENT_READ_FOR_TYPE(Bool, bool, bool, bool)
- return FALSE;
-}
+#undef IMPLEMENT_READ_FOR_TYPE
-bool wxConfigBase::Read(const wxString& key, double* val, double defVal) const
+// the DoReadXXX() for the other types have implementation in the base class
+// but can be overridden in the derived ones
+bool wxConfigBase::DoReadInt(const wxString& key, int *pi) const
{
- if (!Read(key, val))
- {
- *val = defVal;
- return FALSE;
- }
- else
- return TRUE;
-}
+ wxCHECK_MSG( pi, FALSE, _T("wxConfig::Read(): NULL parameter") );
-bool wxConfigBase::Read(const wxString& key, bool* val) const
-{
long l;
- if (Read(key, & l))
- {
- *val = (l != 0);
- return TRUE;
- }
- else
+ if ( !DoReadLong(key, &l) )
return FALSE;
-}
-bool wxConfigBase::Read(const wxString& key, bool* val, bool defVal) const
-{
- if (!Read(key, val))
- {
- *val = defVal;
- return FALSE;
- }
- else
- return TRUE;
-}
+ wxASSERT_MSG( l < INT_MAX, _T("overflow in wxConfig::DoReadInt") );
-// Convenience functions
+ *pi = (int)l;
-bool wxConfigBase::Read(const wxString& key, int *pi) const
-{
- long l;
- bool ret = Read(key, &l);
- if (ret)
- *pi = (int) l;
- return ret;
+ return TRUE;
}
-bool wxConfigBase::Read(const wxString& key, int *pi, int defVal) const
+bool wxConfigBase::DoReadBool(const wxString& key, bool* val) const
{
+ wxCHECK_MSG( val, FALSE, _T("wxConfig::Read(): NULL parameter") );
+
long l;
- bool ret = Read(key, &l, (long) defVal);
- if (ret)
- *pi = (int) l;
- return ret;
-}
+ if ( !DoReadLong(key, &l) )
+ return FALSE;
-bool wxConfigBase::Write(const wxString& key, double val)
-{
- wxString str;
- str.Printf(wxT("%g"), val);
- return Write(key, str);
-}
+ wxASSERT_MSG( l == 0 || l == 1, _T("bad bool value in wxConfig::DoReadInt") );
-bool wxConfigBase::Write(const wxString& key, bool value)
-{
- return Write(key, value ? 1l : 0l);
+ *val = l != 0;
+
+ return TRUE;
}
-bool wxConfigBase::Write(const wxString& key, const wxChar *value)
+bool wxConfigBase::DoReadDouble(const wxString& key, double* val) const
{
- // explicit cast needed, otherwise value would have been converted to bool
- return Write(key, wxString(value));
+ wxString str;
+ if ( Read(key, &str) )
+ {
+ return str.ToDouble(val);
+ }
+
+ return FALSE;
}
+// string reading helper
wxString wxConfigBase::ExpandEnvVars(const wxString& str) const
{
wxString tmp; // Required for BC++
return tmp;
}
+// ----------------------------------------------------------------------------
+// wxConfigBase writing
+// ----------------------------------------------------------------------------
+
+bool wxConfigBase::DoWriteDouble(const wxString& key, double val)
+{
+ return DoWriteString(key, wxString::Format(_T("%g"), val));
+}
+
+bool wxConfigBase::DoWriteInt(const wxString& key, int value)
+{
+ return DoWriteLong(key, (long)value);
+}
+
+bool wxConfigBase::DoWriteBool(const wxString& key, bool value)
+{
+ return DoWriteLong(key, value ? 1l : 0l);
+}
+
// ----------------------------------------------------------------------------
// wxConfigPathChanger
// ----------------------------------------------------------------------------
{
Bracket_None,
Bracket_Normal = ')',
- Bracket_Curly = '}'
+ Bracket_Curly = '}',
#ifdef __WXMSW__
- ,Bracket_Windows = '%' // yeah, Windows people are a bit strange ;-)
+ Bracket_Windows = '%', // yeah, Windows people are a bit strange ;-)
#endif
+ Bracket_Max
};
size_t m;
// check the closing bracket
if ( bracket != Bracket_None ) {
if ( m == str.Len() || str[m] != (char)bracket ) {
- wxLogWarning(_("Environment variables expansion failed: missing '%c' at position %d in '%s'."),
- (char)bracket, m + 1, str.c_str());
+ // under MSW it's common to have '%' characters in the registry
+ // and it's annoying to have warnings about them each time, so
+ // ignroe them silently if they are not used for env vars
+ //
+ // under Unix, OTOH, this warning could be useful for the user to
+ // understand why isn't the variable expanded as intended
+ #ifndef __WXMSW__
+ wxLogWarning(_("Environment variables expansion failed: missing '%c' at position %d in '%s'."),
+ (char)bracket, m + 1, str.c_str());
+ #endif // __WXMSW__
}
else {
// skip closing bracket unless the variables wasn't expanded
}
// this function is used to properly interpret '..' in path
-/// separates group and entry names (probably shouldn't be changed)
-
void wxSplitPath(wxArrayString& aParts, const wxChar *sz)
{
aParts.Empty();