Small usability improvements

[wxWidgets.git] / include / wx / wxcrtbase.h

diff --git a/include/wx/wxcrtbase.h b/include/wx/wxcrtbase.h
index 0e0a0dfcede03d866cfd12b5c7c7bb214408c46e..476fb654e7d264d1ff6a97e789d6f1253829e25c 100644 (file)
--- a/include/wx/wxcrtbase.h
+++ b/include/wx/wxcrtbase.h
@@ -2,7 +2,7 @@
  * Name:        wx/wxcrtbase.h
  * Purpose:     Type-safe ANSI and Unicode builds compatible wrappers for
  *              CRT functions
  * Name:        wx/wxcrtbase.h
  * Purpose:     Type-safe ANSI and Unicode builds compatible wrappers for
  *              CRT functions

- * Author:      Joel Farley, Ove Kåven
+ * Author:      Joel Farley, Ove K�ven

  * Modified by: Vadim Zeitlin, Robert Roebling, Ron Lee
  * Created:     1998/06/12
  * RCS-ID:      $Id$
  * Modified by: Vadim Zeitlin, Robert Roebling, Ron Lee
  * Created:     1998/06/12
  * RCS-ID:      $Id$


@@ -34,6 +34,9 @@
 #include <wctype.h>
 #include <time.h>
 
 #include <wctype.h>
 #include <time.h>
 

+#if defined(__WINDOWS__) && !defined(__WXWINCE__)
+    #include <io.h>
+#endif

 
 #if defined(HAVE_STRTOK_R) && defined(__DARWIN__) && defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
     char *strtok_r(char *, const char *, char **);
 
 #if defined(HAVE_STRTOK_R) && defined(__DARWIN__) && defined(_MSL_USING_MW_C_HEADERS) && _MSL_USING_MW_C_HEADERS
     char *strtok_r(char *, const char *, char **);


@@ -107,19 +110,19 @@ WXDLLIMPEXP_BASE void *calloc( size_t num, size_t size );
 
 #ifdef __cplusplus
     #if wxUSE_UNICODE_UTF8
 
 #ifdef __cplusplus
     #if wxUSE_UNICODE_UTF8

-        // flag indicating whether the current locale uses UTF-8 or not; must be
-        // updated every time the locale is changed!
+        /* flag indicating whether the current locale uses UTF-8 or not; must be
+           updated every time the locale is changed! */

         #if wxUSE_UTF8_LOCALE_ONLY
         #define wxLocaleIsUtf8 true
         #else
         extern WXDLLIMPEXP_BASE bool wxLocaleIsUtf8;
         #endif
         #if wxUSE_UTF8_LOCALE_ONLY
         #define wxLocaleIsUtf8 true
         #else
         extern WXDLLIMPEXP_BASE bool wxLocaleIsUtf8;
         #endif

-        // function used to update the flag:
+        /* function used to update the flag: */

         extern WXDLLIMPEXP_BASE void wxUpdateLocaleIsUtf8();
         extern WXDLLIMPEXP_BASE void wxUpdateLocaleIsUtf8();

-    #else // !wxUSE_UNICODE_UTF8
+    #else /* !wxUSE_UNICODE_UTF8 */

         inline void wxUpdateLocaleIsUtf8() {}
         inline void wxUpdateLocaleIsUtf8() {}

-    #endif // wxUSE_UNICODE_UTF8/!wxUSE_UNICODE_UTF8
-#endif // __cplusplus
+    #endif /* wxUSE_UNICODE_UTF8/!wxUSE_UNICODE_UTF8 */
+#endif /* __cplusplus */

 
 
 /* -------------------------------------------------------------------------
 
 
 /* -------------------------------------------------------------------------


@@ -129,7 +132,6 @@ WXDLLIMPEXP_BASE void *calloc( size_t num, size_t size );
 #define wxCRT_StrcatA    strcat
 #define wxCRT_StrchrA    strchr
 #define wxCRT_StrcmpA    strcmp
 #define wxCRT_StrcatA    strcat
 #define wxCRT_StrchrA    strchr
 #define wxCRT_StrcmpA    strcmp

-#define wxCRT_StrcollA   strcoll

 #define wxCRT_StrcpyA    strcpy
 #define wxCRT_StrcspnA   strcspn
 #define wxCRT_StrlenA    strlen
 #define wxCRT_StrcpyA    strcpy
 #define wxCRT_StrcspnA   strcspn
 #define wxCRT_StrlenA    strlen


@@ -140,12 +142,10 @@ WXDLLIMPEXP_BASE void *calloc( size_t num, size_t size );
 #define wxCRT_StrrchrA   strrchr
 #define wxCRT_StrspnA    strspn
 #define wxCRT_StrstrA    strstr
 #define wxCRT_StrrchrA   strrchr
 #define wxCRT_StrspnA    strspn
 #define wxCRT_StrstrA    strstr

-#define wxCRT_StrxfrmA   strxfrm

 
 #define wxCRT_StrcatW    wcscat
 #define wxCRT_StrchrW    wcschr
 #define wxCRT_StrcmpW    wcscmp
 
 #define wxCRT_StrcatW    wcscat
 #define wxCRT_StrchrW    wcschr
 #define wxCRT_StrcmpW    wcscmp

-#define wxCRT_StrcollW   wcscoll

 #define wxCRT_StrcpyW    wcscpy
 #define wxCRT_StrcspnW   wcscspn
 #define wxCRT_StrncatW   wcsncat
 #define wxCRT_StrcpyW    wcscpy
 #define wxCRT_StrcspnW   wcscspn
 #define wxCRT_StrncatW   wcsncat


@@ -155,7 +155,15 @@ WXDLLIMPEXP_BASE void *calloc( size_t num, size_t size );
 #define wxCRT_StrrchrW   wcsrchr
 #define wxCRT_StrspnW    wcsspn
 #define wxCRT_StrstrW    wcsstr
 #define wxCRT_StrrchrW   wcsrchr
 #define wxCRT_StrspnW    wcsspn
 #define wxCRT_StrstrW    wcsstr

-#define wxCRT_StrxfrmW   wcsxfrm
+
+/* these functions are not defined under CE, at least in VC8 CRT */
+#ifndef __WXWINCE__
+    #define wxCRT_StrcollA   strcoll
+    #define wxCRT_StrxfrmA   strxfrm
+
+    #define wxCRT_StrcollW   wcscoll
+    #define wxCRT_StrxfrmW   wcsxfrm
+#endif /* __WXWINCE__ */

 
 /* Almost all compiler have strdup(), but not quite all: CodeWarrior under
    Mac and VC++ for Windows CE don't provide it; additionally, gcc under
 
 /* Almost all compiler have strdup(), but not quite all: CodeWarrior under
    Mac and VC++ for Windows CE don't provide it; additionally, gcc under


@@ -167,7 +175,7 @@ WXDLLIMPEXP_BASE void *calloc( size_t num, size_t size );
 #endif
 #if defined(__WINDOWS__)
     #define wxCRT_StrdupW _wcsdup
 #endif
 #if defined(__WINDOWS__)
     #define wxCRT_StrdupW _wcsdup

-#elif !defined(__DARWIN__) && !defined( __VMS )
+#elif defined(HAVE_WCSDUP)

     #define wxCRT_StrdupW wcsdup
 #endif
 
     #define wxCRT_StrdupW wcsdup
 #endif
 


@@ -369,14 +377,24 @@ WXDLLIMPEXP_BASE wchar_t *wxCRT_StrtokW(wchar_t *psz, const wchar_t *delim, wcha
 #endif
 
 /* supply strtoll and strtoull, if needed */
 #endif
 
 /* supply strtoll and strtoull, if needed */

-#ifndef wxCRT_StrtollA
-    WXDLLIMPEXP_BASE wxLongLong_t wxCRT_StrtollA(const char* nptr, char** endptr, int base);
-    WXDLLIMPEXP_BASE wxULongLong_t wxCRT_StrtoullA(const char* nptr, char** endptr, int base);
-#endif
-#ifndef wxCRT_StrtollW
-    WXDLLIMPEXP_BASE wxLongLong_t wxCRT_StrtollW(const wchar_t* nptr, wchar_t** endptr, int base);
-    WXDLLIMPEXP_BASE wxULongLong_t wxCRT_StrtoullW(const wchar_t* nptr, wchar_t** endptr, int base);
-#endif
+#ifdef wxLongLong_t
+    #ifndef wxCRT_StrtollA
+        WXDLLIMPEXP_BASE wxLongLong_t wxCRT_StrtollA(const char* nptr,
+                                                     char** endptr,
+                                                     int base);
+        WXDLLIMPEXP_BASE wxULongLong_t wxCRT_StrtoullA(const char* nptr,
+                                                       char** endptr,
+                                                       int base);
+    #endif
+    #ifndef wxCRT_StrtollW
+        WXDLLIMPEXP_BASE wxLongLong_t wxCRT_StrtollW(const wchar_t* nptr,
+                                                     wchar_t** endptr,
+                                                     int base);
+        WXDLLIMPEXP_BASE wxULongLong_t wxCRT_StrtoullW(const wchar_t* nptr,
+                                                       wchar_t** endptr,
+                                                       int base);
+    #endif
+#endif // wxLongLong_t

 
 
 /* -------------------------------------------------------------------------
 
 
 /* -------------------------------------------------------------------------


@@ -392,15 +410,14 @@ WXDLLIMPEXP_BASE wchar_t *wxCRT_StrtokW(wchar_t *psz, const wchar_t *delim, wcha
 
 /* these functions are only needed in the form used for filenames (i.e. char*
    on Unix, wchar_t* on Windows), so we don't need to use A/W suffix: */
 
 /* these functions are only needed in the form used for filenames (i.e. char*
    on Unix, wchar_t* on Windows), so we don't need to use A/W suffix: */

-#if wxMBFILES || !wxUSE_UNICODE // ANSI filenames
+#if wxMBFILES || !wxUSE_UNICODE /* ANSI filenames */

 
     #define wxCRT_Fopen   fopen
     #define wxCRT_Freopen freopen
     #define wxCRT_Remove  remove
     #define wxCRT_Rename  rename
 
 
     #define wxCRT_Fopen   fopen
     #define wxCRT_Freopen freopen
     #define wxCRT_Remove  remove
     #define wxCRT_Rename  rename
 

-#else // Unicode filenames
-
+#else /* Unicode filenames */

     /* special case: these functions are missing under Win9x with Unicows so we
        have to implement them ourselves */
     #if wxUSE_UNICODE_MSLU
     /* special case: these functions are missing under Win9x with Unicows so we
        have to implement them ourselves */
     #if wxUSE_UNICODE_MSLU


@@ -413,20 +430,20 @@ WXDLLIMPEXP_BASE wchar_t *wxCRT_StrtokW(wchar_t *psz, const wchar_t *delim, wcha
             #define wxCRT_Remove    wxMSLU__wremove
             #define wxCRT_Rename    wxMSLU__wrename
     #else
             #define wxCRT_Remove    wxMSLU__wremove
             #define wxCRT_Rename    wxMSLU__wrename
     #else

-        #define wxCRT_Rename   _wrename
-        #define wxCRT_Fopen    _wfopen
-        #define wxCRT_Freopen  _wfreopen
+        /* WinCE CRT doesn't provide these functions so use our own */

         #ifdef __WXWINCE__
         #ifdef __WXWINCE__

-            /* carefully: wxCRT_Remove() must return 0 on success while
-               DeleteFile() returns 0 on error, so don't just define one as
-               the other */
-            int wxCRT_Remove(const wchar_t *path);
+            WXDLLIMPEXP_BASE int wxCRT_Rename(const wchar_t *src,
+                                              const wchar_t *dst);
+            WXDLLIMPEXP_BASE int wxCRT_Remove(const wchar_t *path);

         #else
         #else

+            #define wxCRT_Rename   _wrename

             #define wxCRT_Remove _wremove
         #endif
             #define wxCRT_Remove _wremove
         #endif

+        #define wxCRT_Fopen    _wfopen
+        #define wxCRT_Freopen  _wfreopen

     #endif
 
     #endif
 

-#endif // wxMBFILES/!wxMBFILES
+#endif /* wxMBFILES/!wxMBFILES */

 
 #define wxCRT_PutsA       puts
 #define wxCRT_FputsA      fputs
 
 #define wxCRT_PutsA       puts
 #define wxCRT_FputsA      fputs


@@ -463,20 +480,23 @@ WXDLLIMPEXP_BASE int wxCRT_FputsW(const wchar_t *ch, FILE *stream);
 WXDLLIMPEXP_BASE int wxCRT_FputcW(wchar_t wc, FILE *stream);
 #endif
 
 WXDLLIMPEXP_BASE int wxCRT_FputcW(wchar_t wc, FILE *stream);
 #endif
 

-#define wxCRT_TmpnamA     tmpnam
-#ifdef _ttmpnam
-    #define wxCRT_TmpnamW _wtmpnam
-#endif
+/*
+   NB: tmpnam() is unsafe and thus is not wrapped!
+       Use other wxWidgets facilities instead:
+        wxFileName::CreateTempFileName, wxTempFile, or wxTempFileOutputStream
+*/
+#define wxTmpnam(x)         wxTmpnam_is_insecure_use_wxTempFile_instead

 
 

-#ifndef wxCRT_TmpnamW
-WXDLLIMPEXP_BASE wchar_t *wxCRT_TmpnamW(wchar_t *s);
-#endif
+/* FIXME-CE: provide our own perror() using ::GetLastError() */
+#ifndef __WXWINCE__

 
 #define wxCRT_PerrorA   perror
 #ifdef wxHAVE_TCHAR_SUPPORT
     #define wxCRT_PerrorW _wperror
 #endif
 
 
 #define wxCRT_PerrorA   perror
 #ifdef wxHAVE_TCHAR_SUPPORT
     #define wxCRT_PerrorW _wperror
 #endif
 

+#endif /* !__WXWINCE__ */
+

 /* -------------------------------------------------------------------------
                                   stdlib.h
    ------------------------------------------------------------------------- */
 /* -------------------------------------------------------------------------
                                   stdlib.h
    ------------------------------------------------------------------------- */


@@ -484,8 +504,8 @@ WXDLLIMPEXP_BASE wchar_t *wxCRT_TmpnamW(wchar_t *s);
 /* there are no env vars at all under CE, so no _tgetenv neither */
 #ifdef __WXWINCE__
     /* can't define as inline function as this is a C file... */
 /* there are no env vars at all under CE, so no _tgetenv neither */
 #ifdef __WXWINCE__
     /* can't define as inline function as this is a C file... */

-    #define wxCRT_GetenvA(name)     ((char*)NULL)
-    #define wxCRT_GetenvW(name)     ((wchar_t*)NULL)
+    #define wxCRT_GetenvA(name)     (name, NULL)
+    #define wxCRT_GetenvW(name)     (name, NULL)

 #else
     #define wxCRT_GetenvA           getenv
     #ifdef _tgetenv
 #else
     #define wxCRT_GetenvA           getenv
     #ifdef _tgetenv


@@ -521,7 +541,7 @@ WXDLLIMPEXP_BASE wchar_t * wxCRT_GetenvW(const wchar_t *name);
     /* _wtof doesn't exist */
 #else
 #ifndef __VMS
     /* _wtof doesn't exist */
 #else
 #ifndef __VMS

-    #define wxCRT_AtofW(s)         wcstof(s, NULL)
+    #define wxCRT_AtofW(s)         wcstod(s, NULL)

 #endif
     #define wxCRT_AtolW(s)         wcstol(s, NULL, 10)
     /* wcstoi doesn't exist */
 #endif
     #define wxCRT_AtolW(s)         wcstol(s, NULL, 10)
     /* wcstoi doesn't exist */


@@ -609,12 +629,12 @@ WXDLLIMPEXP_BASE size_t wxCRT_StrftimeW(wchar_t *s, size_t max,
         #define wxCRT_TolowerW   towlower
         #define wxCRT_ToupperW   towupper
     #endif
         #define wxCRT_TolowerW   towlower
         #define wxCRT_ToupperW   towupper
     #endif

-#else // !__GLIBC__
+#else /* !__GLIBC__ */

     /* There is a bug in VC6 C RTL: toxxx() functions dosn't do anything
        with signed chars < 0, so "fix" it here. */
     #define wxCRT_TolowerW(c)   towlower((wxUChar)(wxChar)(c))
     #define wxCRT_ToupperW(c)   towupper((wxUChar)(wxChar)(c))
     /* There is a bug in VC6 C RTL: toxxx() functions dosn't do anything
        with signed chars < 0, so "fix" it here. */
     #define wxCRT_TolowerW(c)   towlower((wxUChar)(wxChar)(c))
     #define wxCRT_ToupperW(c)   towupper((wxUChar)(wxChar)(c))

-#endif // __GLIBC__/!__GLIBC__
+#endif /* __GLIBC__/!__GLIBC__ */