Corrected a return type

[wxWidgets.git] / wxPython / src / utils.i

diff --git a/wxPython/src/utils.i b/wxPython/src/utils.i
index a7646992a49d741177479d841c21fe208edf3cd0..0f4a5a537df26a56c74a6b62a5d6bae981d15ea6 100644 (file)
--- a/wxPython/src/utils.i
+++ b/wxPython/src/utils.i
@@ -14,12 +14,19 @@
 %module utils
 
 %{
 %module utils
 
 %{

-#include "export.h"
+#include "helpers.h"

 #include <wx/config.h>
 #include <wx/fileconf.h>
 #include <wx/datetime.h>
 %}
 
 #include <wx/config.h>
 #include <wx/fileconf.h>
 #include <wx/datetime.h>
 %}
 

+//---------------------------------------------------------------------------
+%{
+    // Put some wx default wxChar* values into wxStrings.
+    DECLARE_DEF_STRING2(DateFormatStr, wxT("%c"));
+    static const wxString wxPyEmptyString(wxT(""));
+
+%}

 //---------------------------------------------------------------------------
 
 %include typemaps.i
 //---------------------------------------------------------------------------
 
 %include typemaps.i


@@ -28,19 +35,21 @@
 // Import some definitions of other classes, etc.
 %import _defs.i
 
 // Import some definitions of other classes, etc.
 %import _defs.i
 

-%pragma(python) code = "import string"
+%pragma(python) code = "import wx"

 
 
 //---------------------------------------------------------------------------
 
 %{
 
 
 //---------------------------------------------------------------------------
 
 %{

-    static wxString wxPyEmptyStr("");
-

     static PyObject* __EnumerationHelper(bool flag, wxString& str, long index) {
         PyObject* ret = PyTuple_New(3);
         if (ret) {
             PyTuple_SET_ITEM(ret, 0, PyInt_FromLong(flag));
     static PyObject* __EnumerationHelper(bool flag, wxString& str, long index) {
         PyObject* ret = PyTuple_New(3);
         if (ret) {
             PyTuple_SET_ITEM(ret, 0, PyInt_FromLong(flag));

-            PyTuple_SET_ITEM(ret, 1, PyString_FromString(str));
+#if wxUSE_UNICODE
+           PyTuple_SET_ITEM(ret, 1, PyUnicode_FromWideChar(str.c_str(), str.Len()));
+#else
+            PyTuple_SET_ITEM(ret, 1, PyString_FromStringAndSize(str.c_str(), str.Len()));
+#endif

             PyTuple_SET_ITEM(ret, 2, PyInt_FromLong(index));
         }
         return ret;
             PyTuple_SET_ITEM(ret, 2, PyInt_FromLong(index));
         }
         return ret;


@@ -51,19 +60,20 @@
 
 enum
 {
 
 enum
 {

-    wxCONFIG_USE_LOCAL_FILE = 1,
-    wxCONFIG_USE_GLOBAL_FILE = 2,
-    wxCONFIG_USE_RELATIVE_PATH = 4
+    wxCONFIG_USE_LOCAL_FILE,
+    wxCONFIG_USE_GLOBAL_FILE,
+    wxCONFIG_USE_RELATIVE_PATH,
+    wxCONFIG_USE_NO_ESCAPE_CHARACTERS

 };
 
 //---------------------------------------------------------------------------
 
 class wxConfigBase {
 public:
 };
 
 //---------------------------------------------------------------------------
 
 class wxConfigBase {
 public:

-//      wxConfigBase(const wxString& appName = wxPyEmptyStr,       **** An ABC
-//                   const wxString& vendorName = wxPyEmptyStr,
-//                   const wxString& localFilename = wxPyEmptyStr,
-//                   const wxString& globalFilename = wxPyEmptyStr,
+//      wxConfigBase(const wxString& appName = wxPyEmptyString,       **** An ABC
+//                   const wxString& vendorName = wxPyEmptyString,
+//                   const wxString& localFilename = wxPyEmptyString,
+//                   const wxString& globalFilename = wxPyEmptyString,

 //                   long style = 0);
     ~wxConfigBase();
 
 //                   long style = 0);
     ~wxConfigBase();
 


@@ -148,9 +158,25 @@ public:
     bool IsExpandingEnvVars();
     bool IsRecordingDefaults();
 
     bool IsExpandingEnvVars();
     bool IsRecordingDefaults();
 

-    wxString Read(const wxString& key, const wxString& defaultVal = wxPyEmptyStr);
-    %name(ReadInt)long Read(const wxString& key, long defaultVal = 0);
-    %name(ReadFloat)double Read(const wxString& key, double defaultVal = 0.0);
+    wxString Read(const wxString& key, const wxString& defaultVal = wxPyEmptyString);
+
+    %addmethods {
+        long ReadInt(const wxString& key, long defaultVal = 0) {
+            long rv;
+            self->Read(key, &rv, defaultVal);
+            return rv;
+        }
+        double ReadFloat(const wxString& key, double defaultVal = 0.0) {
+            double rv;
+            self->Read(key, &rv, defaultVal);
+            return rv;
+        }
+        bool ReadBool(const wxString& key, bool defaultVal = FALSE) {
+            bool rv;
+            self->Read(key, &rv, defaultVal);
+            return rv;
+        }
+    }

 
     void SetExpandEnvVars (bool bDoIt = TRUE);
     void SetPath(const wxString& strPath);
 
     void SetExpandEnvVars (bool bDoIt = TRUE);
     void SetPath(const wxString& strPath);


@@ -164,6 +190,7 @@ public:
     bool Write(const wxString& key, const wxString& value);
     %name(WriteInt)bool Write(const wxString& key, long value);
     %name(WriteFloat)bool Write(const wxString& key, double value);
     bool Write(const wxString& key, const wxString& value);
     %name(WriteInt)bool Write(const wxString& key, long value);
     %name(WriteFloat)bool Write(const wxString& key, double value);

+    %name(WriteBool)bool Write(const wxString& key, bool value);

 
     EntryType GetEntryType(const wxString& name);
     bool RenameEntry(const wxString& oldName,
 
     EntryType GetEntryType(const wxString& name);
     bool RenameEntry(const wxString& oldName,


@@ -175,24 +202,28 @@ public:
 
 };
 
 
 };
 

+

 //---------------------------------------------------------------------------
 
 //---------------------------------------------------------------------------
 

+// This will be a wxRegConfig on Win32 and wxFileConfig otherwise.

 class wxConfig : public wxConfigBase {
 public:
 class wxConfig : public wxConfigBase {
 public:

-    wxConfig(const wxString& appName = wxPyEmptyStr,
-             const wxString& vendorName = wxPyEmptyStr,
-             const wxString& localFilename = wxPyEmptyStr,
-             const wxString& globalFilename = wxPyEmptyStr,
+    wxConfig(const wxString& appName = wxPyEmptyString,
+             const wxString& vendorName = wxPyEmptyString,
+             const wxString& localFilename = wxPyEmptyString,
+             const wxString& globalFilename = wxPyEmptyString,

              long style = 0);
     ~wxConfig();
 };
 
              long style = 0);
     ~wxConfig();
 };
 

+
+// Sometimes it's nice to explicitly have a wxFileConfig too.

 class wxFileConfig : public wxConfigBase {
 public:
 class wxFileConfig : public wxConfigBase {
 public:

-    wxFileConfig(const wxString& appName = wxPyEmptyStr,
-                 const wxString& vendorName = wxPyEmptyStr,
-                 const wxString& localFilename = wxPyEmptyStr,
-                 const wxString& globalFilename = wxPyEmptyStr,
+    wxFileConfig(const wxString& appName = wxPyEmptyString,
+                 const wxString& vendorName = wxPyEmptyString,
+                 const wxString& localFilename = wxPyEmptyString,
+                 const wxString& globalFilename = wxPyEmptyString,

                  long style = 0);
     ~wxFileConfig();
 };
                  long style = 0);
     ~wxFileConfig();
 };


@@ -418,6 +449,10 @@ public:
         // return the wxDateTime object for the current time
     static inline wxDateTime Now();
 
         // return the wxDateTime object for the current time
     static inline wxDateTime Now();
 

+        // return the wxDateTime object for the current time with millisecond
+        // precision (if available on this platform)
+    static wxDateTime UNow();
+

         // return the wxDateTime object for today midnight: i.e. as Now() but
         // with time set to 0
     static inline wxDateTime Today();
         // return the wxDateTime object for today midnight: i.e. as Now() but
         // with time set to 0
     static inline wxDateTime Today();


@@ -497,8 +532,8 @@ public:
     // calendar calculations
 
         // set to the given week day in the same week as this one
     // calendar calculations
 
         // set to the given week day in the same week as this one

-    wxDateTime& SetToWeekDayInSameWeek(WeekDay weekday);
-    wxDateTime GetWeekDayInSameWeek(WeekDay weekday);
+    wxDateTime& SetToWeekDayInSameWeek(WeekDay weekday, WeekFlags flags = Monday_First);
+    wxDateTime GetWeekDayInSameWeek(WeekDay weekday, WeekFlags flags = Monday_First);

 
         // set to the next week day following this one
     wxDateTime& SetToNextWeekDay(WeekDay weekday);
 
         // set to the next week day following this one
     wxDateTime& SetToNextWeekDay(WeekDay weekday);


@@ -516,10 +551,10 @@ public:
                       int n = 1,
                       Month month = Inv_Month,
                       int year = Inv_Year);
                       int n = 1,
                       Month month = Inv_Month,
                       int year = Inv_Year);

-    wxDateTime GetWeekDay(WeekDay weekday,
-                          int n = 1,
-                          Month month = Inv_Month,
-                          int year = Inv_Year);
+//      wxDateTime GetWeekDay(WeekDay weekday,
+//                            int n = 1,
+//                            Month month = Inv_Month,
+//                            int year = Inv_Year);

 
         // sets to the last weekday in the given month, year
     bool SetToLastWeekDay(WeekDay weekday,
 
         // sets to the last weekday in the given month, year
     bool SetToLastWeekDay(WeekDay weekday,


@@ -532,8 +567,8 @@ public:
         // sets the date to the given day of the given week in the year,
         // returns TRUE on success and FALSE if given date doesn't exist (e.g.
         // numWeek is > 53)
         // sets the date to the given day of the given week in the year,
         // returns TRUE on success and FALSE if given date doesn't exist (e.g.
         // numWeek is > 53)

-    bool SetToTheWeek(wxDateTime_t numWeek, WeekDay weekday = Mon);
-    wxDateTime GetWeek(wxDateTime_t numWeek, WeekDay weekday = Mon);
+    bool SetToTheWeek(wxDateTime_t numWeek, WeekDay weekday = Mon, WeekFlags flags = Monday_First);
+    wxDateTime GetWeek(wxDateTime_t numWeek, WeekDay weekday = Mon, WeekFlags flags = Monday_First);

 
         // sets the date to the last day of the given (or current) month or the
         // given (or current) year
 
         // sets the date to the last day of the given (or current) month or the
         // given (or current) year


@@ -717,63 +752,100 @@ public:
         wxDateTime __sub__TS(const wxTimeSpan& other) { return *self - other; }
         wxDateTime __sub__DS(const wxDateSpan& other) { return *self - other; }
 
         wxDateTime __sub__TS(const wxTimeSpan& other) { return *self - other; }
         wxDateTime __sub__DS(const wxDateSpan& other) { return *self - other; }
 

-        int __cmp__(const wxDateTime& other) {
-            if (*self <  other) return -1;
-            if (*self == other) return 0;
+        int __cmp__(const wxDateTime* other) {
+            if (! other) return -1;
+            if (*self <  *other) return -1;
+            if (*self == *other) return 0;

             return 1;
         }
     }
 
     %pragma(python) addtoclass = "
     def __add__(self, other):
             return 1;
         }
     }
 
     %pragma(python) addtoclass = "
     def __add__(self, other):

-        if string.find(other.this, 'wxTimeSpan') != -1:
+        if isinstance(other, wxTimeSpanPtr):

             return self.__add__TS(other)
             return self.__add__TS(other)

-        if string.find(other.this, 'wxDateSpan') != -1:
+        if isinstance(other, wxDateSpanPtr):

             return self.__add__DS(other)
         raise TypeError, 'Invalid r.h.s. type for __add__'
     def __sub__(self, other):
             return self.__add__DS(other)
         raise TypeError, 'Invalid r.h.s. type for __add__'
     def __sub__(self, other):

-        if string.find(other.this, 'wxDateTime') != -1:
+        if isinstance(other, wxDateTimePtr):

             return self.__sub__DT(other)
             return self.__sub__DT(other)

-        if string.find(other.this, 'wxTimeSpan') != -1:
+        if isinstance(other, wxTimeSpanPtr):

             return self.__sub__TS(other)
             return self.__sub__TS(other)

-        if string.find(other.this, 'wxDateSpan') != -1:
+        if isinstance(other, wxDateSpanPtr):

             return self.__sub__DS(other)
         raise TypeError, 'Invalid r.h.s. type for __sub__'
 "
 
     // ------------------------------------------------------------------------
             return self.__sub__DS(other)
         raise TypeError, 'Invalid r.h.s. type for __sub__'
 "
 
     // ------------------------------------------------------------------------

-    // conversion to/from text: all conversions from text return the pointer to
-    // the next character following the date specification (i.e. the one where
-    // the scan had to stop) or NULL on failure.
+    // conversion from text: all conversions from text return -1 on failure,
+    // or the index in the string where the next character following the date
+    // specification (i.e. the one where the scan had to stop) is located.
+
+    %addmethods {

 
         // parse a string in RFC 822 format (found e.g. in mail headers and
         // having the form "Wed, 10 Feb 1999 19:07:07 +0100")
 
         // parse a string in RFC 822 format (found e.g. in mail headers and
         // having the form "Wed, 10 Feb 1999 19:07:07 +0100")

-    const char *ParseRfc822Date(const char* date);
+        int ParseRfc822Date(const wxString& date) {
+            const wxChar* rv;
+            const wxChar* _date = date;
+            rv = self->ParseRfc822Date(_date);
+            if (rv == NULL) return -1;
+            return rv - _date;
+        }
+

 
         // parse a date/time in the given format (see strptime(3)), fill in
         // the missing (in the string) fields with the values of dateDef (by
         // default, they will not change if they had valid values or will
         // default to Today() otherwise)
 
         // parse a date/time in the given format (see strptime(3)), fill in
         // the missing (in the string) fields with the values of dateDef (by
         // default, they will not change if they had valid values or will
         // default to Today() otherwise)

-    const char *ParseFormat(const char *date,
-                              const char *format = "%c",
-                              const wxDateTime& dateDef = wxDefaultDateTime);
+        int ParseFormat(const wxString& date,
+                        const wxString& format = wxPyDateFormatStr,
+                        const wxDateTime& dateDef = wxDefaultDateTime) {
+            const wxChar* rv;
+            const wxChar* _date = date;
+            rv = self->ParseFormat(_date, format, dateDef);
+            if (rv == NULL) return -1;
+            return rv - _date;
+        }

 
         // parse a string containing the date/time in "free" format, this
         // function will try to make an educated guess at the string contents
 
         // parse a string containing the date/time in "free" format, this
         // function will try to make an educated guess at the string contents

-    const char *ParseDateTime(const char *datetime);
+        int ParseDateTime(const wxString& datetime) {
+            const wxChar* rv;
+            const wxChar* _datetime = datetime;
+            rv = self->ParseDateTime(_datetime);
+            if (rv == NULL) return -1;
+            return rv - _datetime;
+        }
+

 
         // parse a string containing the date only in "free" format (less
         // flexible than ParseDateTime)
 
         // parse a string containing the date only in "free" format (less
         // flexible than ParseDateTime)

-    const char *ParseDate(const char *date);
+        int ParseDate(const wxString& date) {
+            const wxChar* rv;
+            const wxChar* _date = date;
+            rv = self->ParseDate(_date);
+            if (rv == NULL) return -1;
+            return rv - _date;
+        }

 
         // parse a string containing the time only in "free" format
 
         // parse a string containing the time only in "free" format

-    const char *ParseTime(const char *time);
+        int ParseTime(const wxString& time) {
+            const wxChar* rv;
+            const wxChar* _time = time;
+            rv = self->ParseTime(_time);
+            if (rv == NULL) return -1;
+            return rv - _time;
+        }
+    }
+

 
         // this function accepts strftime()-like format string (default
         // argument corresponds to the preferred date and time representation
         // for the current locale) and returns the string containing the
         // resulting text representation
 
         // this function accepts strftime()-like format string (default
         // argument corresponds to the preferred date and time representation
         // for the current locale) and returns the string containing the
         // resulting text representation

-    wxString Format(const char *format = "%c",
+    wxString Format(const wxString& format = wxPyDateFormatStr,

                     const wxDateTime::TimeZone& tz = LOCAL) const;
 
         // preferred date representation for the current locale
                     const wxDateTime::TimeZone& tz = LOCAL) const;
 
         // preferred date representation for the current locale


@@ -864,9 +936,10 @@ public:
         wxTimeSpan __mul__(int n)                   { return *self * n; }
         wxTimeSpan __rmul__(int n)                  { return n * *self; }
         wxTimeSpan __neg__()                        { return self->Negate(); }
         wxTimeSpan __mul__(int n)                   { return *self * n; }
         wxTimeSpan __rmul__(int n)                  { return n * *self; }
         wxTimeSpan __neg__()                        { return self->Negate(); }

-        int __cmp__(const wxTimeSpan& other) {
-            if (*self <  other) return -1;
-            if (*self == other) return 0;
+        int __cmp__(const wxTimeSpan* other) {
+            if (! other) return -1;
+            if (*self <  *other) return -1;
+            if (*self == *other) return 0;

             return 1;
         }
     }
             return 1;
         }
     }


@@ -923,7 +996,7 @@ public:
         // resulting text representation. Notice that only some of format
         // specifiers valid for wxDateTime are valid for wxTimeSpan: hours,
         // minutes and seconds make sense, but not "PM/AM" string for example.
         // resulting text representation. Notice that only some of format
         // specifiers valid for wxDateTime are valid for wxTimeSpan: hours,
         // minutes and seconds make sense, but not "PM/AM" string for example.

-    wxString Format(const char *format = "%c") const;
+    wxString Format(const wxString& format = wxPyDateFormatStr) const;

 
 //          // preferred date representation for the current locale
 //      wxString FormatDate() const;
 
 //          // preferred date representation for the current locale
 //      wxString FormatDate() const;


@@ -1032,10 +1105,6 @@ wxLongLong wxGetLocalTimeMillis();
 //---------------------------------------------------------------------------
 
 %init %{
 //---------------------------------------------------------------------------
 
 %init %{

-
-//    wxClassInfo::CleanUpClasses();
-//    wxClassInfo::InitializeClasses();
-

 %}
 
 //---------------------------------------------------------------------------
 %}
 
 //---------------------------------------------------------------------------