]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/wxcrt.h
make wxMouseState accessors const; document this class
[wxWidgets.git] / include / wx / wxcrt.h
index f8a5f592d4e781738384b306cb68ae86c6b1542b..1549dc436b918a69a666a567f5804db2bc86a711 100644 (file)
@@ -2,7 +2,7 @@
 // Name:        wx/wxcrt.h
 // Purpose:     Type-safe ANSI and Unicode builds compatible wrappers for
 //              CRT functions
-// Author:      Joel Farley, Ove Kåven
+// Author:      Joel Farley, Ove Kaaven
 // Modified by: Vadim Zeitlin, Robert Roebling, Ron Lee, Vaclav Slavik
 // Created:     1998/06/12
 // RCS-ID:      $Id$
 #include "wx/wxcrtbase.h"
 #include "wx/string.h"
 
+#ifndef __WX_SETUP_H__
+// For non-configure builds assume vsscanf is available, if not Visual C or DMC
+#if !defined (__VISUALC__) && !defined (__DMC__)
+    #define HAVE_VSSCANF 1
+#endif
+#endif
+
 // ============================================================================
 //                              misc functions
 // ============================================================================
@@ -32,9 +39,6 @@ inline bool wxIsEmpty(const wxString& s) { return s.empty(); }
 inline bool wxIsEmpty(const wxCStrData& s) { return s.AsString().empty(); }
 
 
-// FIXME-UTF8: get rid of this, it's ANSI only anyway
-WXDLLIMPEXP_BASE bool wxOKlibc(); /* for internal use */
-
 
 /* multibyte to wide char conversion functions and macros */
 
@@ -72,9 +76,9 @@ WXDLLIMPEXP_BASE bool wxOKlibc(); /* for internal use */
 //  (including even MSC) inline them just like we do right in their
 //  headers.
 //
-#if wxUSE_UNICODE
-    #include <string.h> //for mem funcs
+#include <string.h>
 
+#if wxUSE_UNICODE
     //implement our own wmem variants
     inline wxChar* wxTmemchr(const wxChar* s, wxChar c, size_t l)
     {
@@ -114,27 +118,21 @@ WXDLLIMPEXP_BASE bool wxOKlibc(); /* for internal use */
 
         return szRet;
     }
-
-    // and trivial wrappers for char* versions:
-    inline char* wxTmemchr(const char* s, char c, size_t len)
-        { return (char*)memchr(s, c, len); }
-    inline int wxTmemcmp(const char* sz1, const char* sz2, size_t len)
-        { return memcmp(sz1, sz2, len); }
-    inline char* wxTmemcpy(char* szOut, const char* szIn, size_t len)
-        { return (char*)memcpy(szOut, szIn, len); }
-    inline char* wxTmemmove(char* szOut, const char* szIn, size_t len)
-        { return (char*)memmove(szOut, szIn, len); }
-    inline char* wxTmemset(char* szOut, const char cIn, size_t len)
-        { return (char*)memset(szOut, cIn, len); }
-
-#else /* !wxUSE_UNICODE */
-    #define wxTmemchr memchr
-    #define wxTmemcmp memcmp
-    #define wxTmemcpy memcpy
-    #define wxTmemmove memmove
-    #define wxTmemset memset
-#endif /* wxUSE_UNICODE/!wxUSE_UNICODE */
-
+#endif /* wxUSE_UNICODE */
+
+// provide trivial wrappers for char* versions for both ANSI and Unicode builds
+// (notice that these intentionally return "char *" and not "void *" unlike the
+// standard memxxx() for symmetry with the wide char versions):
+inline char* wxTmemchr(const char* s, char c, size_t len)
+    { return (char*)memchr(s, c, len); }
+inline int wxTmemcmp(const char* sz1, const char* sz2, size_t len)
+    { return memcmp(sz1, sz2, len); }
+inline char* wxTmemcpy(char* szOut, const char* szIn, size_t len)
+    { return (char*)memcpy(szOut, szIn, len); }
+inline char* wxTmemmove(char* szOut, const char* szIn, size_t len)
+    { return (char*)memmove(szOut, szIn, len); }
+inline char* wxTmemset(char* szOut, const char cIn, size_t len)
+    { return (char*)memset(szOut, cIn, len); }
 
 
 // ============================================================================
@@ -160,7 +158,7 @@ WXDLLIMPEXP_BASE bool wxOKlibc(); /* for internal use */
 // ----------------------------------------------------------------------------
 
 // NB: we can't provide const wchar_t* (= wxChar*) overload, because calling
-//     wxSetlocale(category, NULL) -- which is a common thing to do --would be
+//     wxSetlocale(category, NULL) -- which is a common thing to do -- would be
 //     ambiguous
 WXDLLIMPEXP_BASE char* wxSetlocale(int category, const char *locale);
 inline char* wxSetlocale(int category, const wxCharBuffer& locale)
@@ -314,16 +312,16 @@ inline wchar_t *wxStrncat(wchar_t *dest, const char *src, size_t n)
         { return WX_STR_CALL(forString, wxString(s1), wxString(s2)); }        \
     inline rettype WX_STR_DECL(name, const wxCharBuffer&, const wxCharBuffer&)\
         { return WX_STR_CALL(crtA, s1.data(), s2.data()); }                   \
-    inline int WX_STR_DECL(name, const wxCharBuffer&, const wxWCharBuffer&)   \
+    inline rettype WX_STR_DECL(name, const wxCharBuffer&, const wxWCharBuffer&)   \
         { return WX_STR_CALL(forString, wxString(s1), wxString(s2)); }        \
                                                                               \
     inline rettype WX_STR_DECL(name, const wxWCharBuffer&, const wchar_t *)   \
         { return WX_STR_CALL(crtW, s1.data(), s2); }                          \
     inline rettype WX_STR_DECL(name, const wxWCharBuffer&, const char *)      \
         { return WX_STR_CALL(forString, wxString(s1), wxString(s2)); }        \
-    inline int WX_STR_DECL(name, const wxWCharBuffer&, const wxWCharBuffer&)  \
+    inline rettype WX_STR_DECL(name, const wxWCharBuffer&, const wxWCharBuffer&)  \
         { return WX_STR_CALL(crtW, s1.data(), s2.data()); }                   \
-    inline int WX_STR_DECL(name, const wxWCharBuffer&, const wxCharBuffer&)   \
+    inline rettype WX_STR_DECL(name, const wxWCharBuffer&, const wxCharBuffer&)   \
         { return WX_STR_CALL(forString, wxString(s1), wxString(s2)); }        \
                                                                               \
     inline rettype WX_STR_DECL(name, const wxString&, const char*)            \
@@ -414,18 +412,19 @@ inline int wxStricmp_String(const wxString& s1, const T& s2)
     { return s1.CmpNoCase(s2); }
 WX_STRCMP_FUNC(wxStricmp, wxCRT_StricmpA, wxCRT_StricmpW, wxStricmp_String)
 
+#if defined(wxCRT_StrcollA) && defined(wxCRT_StrcollW)
 
-// GCC 3.3 has a bug that causes it to fail compilation if the template's
-// implementation uses overloaded function declared later (see the wxStrcoll()
-// call in wxStrcoll_String<T>()), so we have to forward-declare the template
-// and implement it below WX_STRCMP_FUNC. OTOH, this fails to compile with VC6,
-// so we do it for GCC only.
-// The same is needed for HP CXX on OpenVMS 
-#if defined( __GNUG__ ) || defined( __VMS )
+// GCC 3.3 and other compilers have a bug that causes it to fail compilation if
+// the template's implementation uses overloaded function declared later (see
+// the wxStrcoll() call in wxStrcoll_String<T>()), so we have to
+// forward-declare the template and implement it below WX_STRCMP_FUNC. OTOH,
+// this fails to compile with VC6, so don't do it for VC. It also causes
+// problems with GCC visibility in newer GCC versions.
+#if !(defined(__VISUALC__) || wxCHECK_GCC_VERSION(3,4))
 template<typename T>
 inline int wxStrcoll_String(const wxString& s1, const T& s2);
 WX_STRCMP_FUNC(wxStrcoll, wxCRT_StrcollA, wxCRT_StrcollW, wxStrcoll_String)
-#endif // __GNUG__ or __VMS
+#endif // !__VISUALC__
 
 template<typename T>
 inline int wxStrcoll_String(const wxString& s1, const T& s2)
@@ -441,25 +440,26 @@ inline int wxStrcoll_String(const wxString& s1, const T& s2)
 #endif
 }
 
-#if !defined( __GNUG__ ) && !defined( __VMS )
+#if defined(__VISUALC__) || wxCHECK_GCC_VERSION(3,4)
 // this is exactly the same WX_STRCMP_FUNC line as above wxStrcoll_String<>
 WX_STRCMP_FUNC(wxStrcoll, wxCRT_StrcollA, wxCRT_StrcollW, wxStrcoll_String)
 #endif
 
+#endif // defined(wxCRT_Strcoll[AW])
 
 template<typename T>
-inline int wxStrspn_String(const wxString& s1, const T& s2)
+inline size_t wxStrspn_String(const wxString& s1, const T& s2)
 {
     size_t pos = s1.find_first_not_of(s2);
-    return (pos == wxString::npos) ? s1.length() : pos;
+    return pos == wxString::npos ? s1.length() : pos;
 }
 WX_STR_FUNC(size_t, wxStrspn, wxCRT_StrspnA, wxCRT_StrspnW, wxStrspn_String)
 
 template<typename T>
-inline int wxStrcspn_String(const wxString& s1, const T& s2)
+inline size_t wxStrcspn_String(const wxString& s1, const T& s2)
 {
     size_t pos = s1.find_first_of(s2);
-    return (pos == wxString::npos) ? s1.length() : pos;
+    return pos == wxString::npos ? s1.length() : pos;
 }
 WX_STR_FUNC(size_t, wxStrcspn, wxCRT_StrcspnA, wxCRT_StrcspnW, wxStrcspn_String)
 
@@ -484,6 +484,8 @@ WX_STRCMP_FUNC(wxStrnicmp, wxCRT_StrnicmpA, wxCRT_StrnicmpW, wxStrnicmp_String)
 #undef WX_STR_FUNC
 #undef WX_STR_FUNC_NO_INVERT
 
+#if defined(wxCRT_StrxfrmA) && defined(wxCRT_StrxfrmW)
+
 inline size_t wxStrxfrm(char *dest, const char *src, size_t n)
     { return wxCRT_StrxfrmA(dest, src, n); }
 inline size_t wxStrxfrm(wchar_t *dest, const wchar_t *src, size_t n)
@@ -500,6 +502,8 @@ inline size_t wxStrxfrm(char *dest, const wxCStrData& src, size_t n)
 inline size_t wxStrxfrm(wchar_t *dest, const wxCStrData& src, size_t n)
     { return wxCRT_StrxfrmW(dest, src.AsWCharBuf(), n); }
 
+#endif // defined(wxCRT_Strxfrm[AW])
+
 inline char *wxStrtok(char *str, const char *delim, char **saveptr)
     { return wxCRT_StrtokA(str, delim, saveptr); }
 inline wchar_t *wxStrtok(wchar_t *str, const wchar_t *delim, wchar_t **saveptr)
@@ -704,13 +708,6 @@ inline int wxRemove(const wxString& path)
 inline int wxRename(const wxString& oldpath, const wxString& newpath)
     { return wxCRT_Rename(oldpath.fn_str(), newpath.fn_str()); }
 
-// NB: we don't provide wxString/wxCStrData versions of wxTmpnam, because 's'
-//     is writable
-inline char *wxTmpnam(char *s)
-    { return wxCRT_TmpnamA(s); }
-inline wchar_t *wxTmpnam(wchar_t *s)
-    { return wxCRT_TmpnamW(s); }
-
 extern WXDLLIMPEXP_BASE int wxPuts(const wxString& s);
 extern WXDLLIMPEXP_BASE int wxFputs(const wxString& s, FILE *stream);
 extern WXDLLIMPEXP_BASE void wxPerror(const wxString& s);
@@ -779,11 +776,24 @@ inline double wxStrtod(const wxCharTypeBuffer<T>& nptr, T **endptr)
 // to be ever used, but it still has to compile).
 template<typename T> struct wxStrtoxCharType {};
 template<> struct wxStrtoxCharType<char**>
-    { typedef const char* Type; };
+{
+    typedef const char* Type;
+    static char** AsPointer(char **p) { return p; }
+};
 template<> struct wxStrtoxCharType<wchar_t**>
-    { typedef const wchar_t* Type; };
+{
+    typedef const wchar_t* Type;
+    static wchar_t** AsPointer(wchar_t **p) { return p; }
+};
 template<> struct wxStrtoxCharType<int>
-    { typedef const char* Type; /* this one is never used */ };
+{
+    typedef const char* Type; /* this one is never used */
+    static char** AsPointer(int WXUNUSED_UNLESS_DEBUG(p))
+    {
+        wxASSERT_MSG( p == 0, "passing non-NULL int is invalid" );
+        return NULL;
+    }
+};
 
 template<typename T>
 inline double wxStrtod(const wxString& nptr, T endptr)
@@ -800,7 +810,9 @@ inline double wxStrtod(const wxString& nptr, T endptr)
         // note that it is important to use c_str() here and not mb_str() or
         // wc_str(), because we store the pointer into (possibly converted)
         // buffer in endptr and so it must be valid even when wxStrtod() returns
-        return wxStrtod((typename wxStrtoxCharType<T>::Type)nptr.c_str(), endptr);
+        typedef typename wxStrtoxCharType<T>::Type CharType;
+        return wxStrtod((CharType)nptr.c_str(),
+                        wxStrtoxCharType<T>::AsPointer(endptr));
     }
 }
 template<typename T>
@@ -823,8 +835,12 @@ inline double wxStrtod(const wxCStrData& nptr, T endptr)
         if ( endptr == 0 )                                                    \
             return name(nptr.wx_str(), (wxStringCharType**)NULL, base);       \
         else                                                                  \
-            return name((typename wxStrtoxCharType<T>::Type)nptr.c_str(),     \
-                        endptr, base);                                        \
+        {                                                                     \
+            typedef typename wxStrtoxCharType<T>::Type CharType;              \
+            return name((CharType)nptr.c_str(),                               \
+                        wxStrtoxCharType<T>::AsPointer(endptr),               \
+                        base);                                                \
+        }                                                                     \
     }                                                                         \
     template<typename T>                                                      \
     inline rettype name(const wxCStrData& nptr, T endptr, int base)           \
@@ -832,12 +848,17 @@ inline double wxStrtod(const wxCStrData& nptr, T endptr)
 
 WX_STRTOX_FUNC(long, wxStrtol, wxCRT_StrtolA, wxCRT_StrtolW)
 WX_STRTOX_FUNC(unsigned long, wxStrtoul, wxCRT_StrtoulA, wxCRT_StrtoulW)
+#ifdef wxLongLong_t
 WX_STRTOX_FUNC(wxLongLong_t, wxStrtoll, wxCRT_StrtollA, wxCRT_StrtollW)
 WX_STRTOX_FUNC(wxULongLong_t, wxStrtoull, wxCRT_StrtoullA, wxCRT_StrtoullW)
+#endif // wxLongLong_t
 
 #undef WX_STRTOX_FUNC
 
 
+// there is no command interpreter under CE, hence no system()
+#ifndef __WXWINCE__
+
 // mingw32 doesn't provide _tsystem() even though it provides other stdlib.h
 // functions in their wide versions
 #ifdef wxCRT_SystemW
@@ -846,6 +867,8 @@ inline int wxSystem(const wxString& str) { return wxCRT_SystemW(str.wc_str()); }
 inline int wxSystem(const wxString& str) { return wxCRT_SystemA(str.mb_str()); }
 #endif
 
+#endif // !__WXWINCE__/__WXWINCE__
+
 inline char* wxGetenv(const char *name) { return wxCRT_GetenvA(name); }
 inline wchar_t* wxGetenv(const wchar_t *name) { return wxCRT_GetenvW(name); }
 inline char* wxGetenv(const wxString& name) { return wxCRT_GetenvA(name.mb_str()); }
@@ -853,7 +876,6 @@ inline char* wxGetenv(const wxCStrData& name) { return wxCRT_GetenvA(name.AsChar
 inline char* wxGetenv(const wxCharBuffer& name) { return wxCRT_GetenvA(name.data()); }
 inline wchar_t* wxGetenv(const wxWCharBuffer& name) { return wxCRT_GetenvW(name.data()); }
 
-
 // ----------------------------------------------------------------------------
 //                            time.h functions
 // ----------------------------------------------------------------------------
@@ -881,21 +903,20 @@ inline size_t wxStrftime(wchar_t *s, size_t max,
 
 // FIXME-UTF8: we'd be better off implementing these ourselves, as the CRT
 //             version is locale-dependent
-// FIXME-UTF8: should we return bool from these instead of int?
 // FIXME-UTF8: these don't work when EOF is passed in because of wxUniChar,
 //             is this OK or not?
 
-inline int wxIsalnum(const wxUniChar& c)  { return wxCRT_IsalnumW(c); }
-inline int wxIsalpha(const wxUniChar& c)  { return wxCRT_IsalphaW(c); }
-inline int wxIscntrl(const wxUniChar& c)  { return wxCRT_IscntrlW(c); }
-inline int wxIsdigit(const wxUniChar& c)  { return wxCRT_IsdigitW(c); }
-inline int wxIsgraph(const wxUniChar& c)  { return wxCRT_IsgraphW(c); }
-inline int wxIslower(const wxUniChar& c)  { return wxCRT_IslowerW(c); }
-inline int wxIsprint(const wxUniChar& c)  { return wxCRT_IsprintW(c); }
-inline int wxIspunct(const wxUniChar& c)  { return wxCRT_IspunctW(c); }
-inline int wxIsspace(const wxUniChar& c)  { return wxCRT_IsspaceW(c); }
-inline int wxIsupper(const wxUniChar& c)  { return wxCRT_IsupperW(c); }
-inline int wxIsxdigit(const wxUniChar& c) { return wxCRT_IsxdigitW(c); }
+inline bool wxIsalnum(const wxUniChar& c)  { return wxCRT_IsalnumW(c) != 0; }
+inline bool wxIsalpha(const wxUniChar& c)  { return wxCRT_IsalphaW(c) != 0; }
+inline bool wxIscntrl(const wxUniChar& c)  { return wxCRT_IscntrlW(c) != 0; }
+inline bool wxIsdigit(const wxUniChar& c)  { return wxCRT_IsdigitW(c) != 0; }
+inline bool wxIsgraph(const wxUniChar& c)  { return wxCRT_IsgraphW(c) != 0; }
+inline bool wxIslower(const wxUniChar& c)  { return wxCRT_IslowerW(c) != 0; }
+inline bool wxIsprint(const wxUniChar& c)  { return wxCRT_IsprintW(c) != 0; }
+inline bool wxIspunct(const wxUniChar& c)  { return wxCRT_IspunctW(c) != 0; }
+inline bool wxIsspace(const wxUniChar& c)  { return wxCRT_IsspaceW(c) != 0; }
+inline bool wxIsupper(const wxUniChar& c)  { return wxCRT_IsupperW(c) != 0; }
+inline bool wxIsxdigit(const wxUniChar& c) { return wxCRT_IsxdigitW(c) != 0; }
 
 inline wxUniChar wxTolower(const wxUniChar& c) { return wxCRT_TolowerW(c); }
 inline wxUniChar wxToupper(const wxUniChar& c) { return wxCRT_ToupperW(c); }