Added wxPGChoices::Copy(), tweaked related documentation

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

diff --git a/include/wx/platform.h b/include/wx/platform.h
index afc1f824153a5e76400047f958f393f73e4fee8e..7e1124426eef93a0e2870354aec67c66a9087e98 100644 (file)
--- a/include/wx/platform.h
+++ b/include/wx/platform.h
@@ -21,26 +21,50 @@
 */
 #ifdef __MWERKS__
 #   include <stddef.h>
 */
 #ifdef __MWERKS__
 #   include <stddef.h>

-#endif

 
 

-/*
-    This header must be included before anything else under VMS
- */
-#ifdef __VMS
-#   include <vms_jackets.h>
-#   undef ConnectionNumber
+#  if !defined(__WXMAC__) && !defined(__WINDOWS__) && !defined(WIN32) && !defined(_WIN32_WCE)
+#    define __PALMOS__ 0x05000000
+#  endif

 #endif
 
 /*
 #endif
 
 /*

-    WXMAC variants
-    __WXMAC_CLASSIC__ means ppc non-carbon builds, __WXMAC_CARBON__ means
-    carbon API available (mach or cfm builds) , __WXMAC_OSX__ means mach-o
-    builds, running under 10.2 + only
+    WXOSX targets
+    __WXOSX_MAC__ means Mac OS X, non embedded
+    __WXOSX_IPHONE__ means OS X iPhone

 */
 */

-#ifdef __WXMAC__
+
+/* backwards compatible define, until configure gets updated */
+#if defined __WXMAC__
+#define __WXOSX_CARBON__
+#endif
+
+#if defined(__WXOSX_CARBON__) || defined(__WXOSX_COCOA__) || defined(__WXOSX_IPHONE__) 
+#   define __WXOSX__
+#endif
+
+#ifdef __WXOSX__
+/* for backwards compatibility of code (including our own) define __WXMAC__ */
+#   ifndef __WXMAC__
+#       define __WXMAC__
+#   endif
+/* setup precise defines according to sdk used */
+#   include <TargetConditionals.h>
+#   if defined(__WXOSX_IPHONE__) 
+#       if !( defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE )
+#           error "incorrect SDK for an iPhone build"
+#       endif
+#   elif defined(__WXOSX_CARBON__) || defined(__WXOSX_COCOA__)
+#       if !( defined(TARGET_OS_MAC) && TARGET_OS_MAC )
+#           error "incorrect SDK for a Mac OS X build"
+#       endif
+#       define __WXOSX_MAC__
+#   else
+#       error "one of __WXOSX_IPHONE__, __WXOSX_CARBON__ or __WXOSX_COCOA__ must be defined"
+#   endif
+#endif
+
+#ifdef __WXOSX_MAC__

 #    if defined(__MACH__)
 #    if defined(__MACH__)

-#        define __WXMAC_OSX__
-#        define __WXMAC_CARBON__

 #        include <AvailabilityMacros.h>
 #        ifndef MAC_OS_X_VERSION_10_4
 #           define MAC_OS_X_VERSION_10_4 1040
 #        include <AvailabilityMacros.h>
 #        ifndef MAC_OS_X_VERSION_10_4
 #           define MAC_OS_X_VERSION_10_4 1040


@@ -48,26 +72,45 @@
 #        ifndef MAC_OS_X_VERSION_10_5
 #           define MAC_OS_X_VERSION_10_5 1050
 #        endif
 #        ifndef MAC_OS_X_VERSION_10_5
 #           define MAC_OS_X_VERSION_10_5 1050
 #        endif

-#        ifdef __WXMAC_XCODE__
-#            include <unistd.h>
-#            include "wx/mac/carbon/config_xcode.h"
+#        ifndef MAC_OS_X_VERSION_10_6
+#           define MAC_OS_X_VERSION_10_6 1060

 #        endif
 #    else
 #        endif
 #    else

-#        if TARGET_CARBON
-#            define __WXMAC_CARBON__
-#        else
-#            define __WXMAC_CLASSIC__
-#        endif
+#        error "only mach-o configurations are supported"

 #    endif
 #endif
 
 /*
 #    endif
 #endif
 
 /*

-    __WXOSX__ is a common define to wxMac (Carbon) and wxCocoa ports under OS X.
+    __WXOSX_OR_COCOA__ is a common define to wxOSX (Carbon or Cocoa) and wxCocoa ports under OS X.
+
+    DO NOT use this define in base library code.  Although wxMac has its own
+    private base library (and thus __WXOSX_OR_COCOA__,__WXMAC__ and related defines are
+    valid there), wxCocoa shares its library with other ports like wxGTK and wxX11.
+
+    To keep wx authors from screwing this up, only enable __WXOSX_OR_COCOA__ for wxCocoa when
+    not compiling the base library.  We determine this by first checking if
+    wxUSE_BASE is not defined.  If it is not defined, then we're not buildling
+    the base library, and possibly not building wx at all (but actually building
+    user code that's using wx). If it is defined then we must check to make sure
+    it is not true.  If it is true, we're building base.
+
+    If you want it in the common darwin base library then use __DARWIN__.  You
+    can use any Darwin-available libraries like CoreFoundation but please avoid
+    using OS X libraries like Carbon or CoreServices.
+

  */
  */

-#if defined(__WXMAC_OSX__) || defined(__WXCOCOA__)
-#   define __WXOSX__
+#if defined(__WXOSX__) || (defined(__WXCOCOA__) && (!defined(wxUSE_BASE) || !wxUSE_BASE))
+#   define __WXOSX_OR_COCOA__

 #endif
 
 #endif
 

+#ifdef __WXOSX_OR_COCOA__
+#    ifdef __WXMAC_XCODE__
+#        include <unistd.h>
+#        include <TargetConditionals.h>
+#        include <AvailabilityMacros.h>
+#        include "wx/osx/config_xcode.h"
+#    endif
+#endif

 /*
    first define Windows symbols if they're not defined on the command line: we
    can autodetect everything we need if _WIN32 is defined
 /*
    first define Windows symbols if they're not defined on the command line: we
    can autodetect everything we need if _WIN32 is defined


@@ -76,25 +119,17 @@
 #    ifndef __WXMSW__
 #        define __WXMSW__
 #    endif
 #    ifndef __WXMSW__
 #        define __WXMSW__
 #    endif

-
-#    ifndef _WIN32
-#        define _WIN32
-#    endif
-
-#    ifndef WIN32
-#        define WIN32
-#    endif

 #endif
 
 #if defined(__PALMOS__)
 #   if __PALMOS__ == 0x06000000
 #endif
 
 #if defined(__PALMOS__)
 #   if __PALMOS__ == 0x06000000

-#       define __WXPALMOS6__
+#       define __WXPALMOS6__ 1

 #   endif
 #   if __PALMOS__ == 0x05000000
 #   endif
 #   if __PALMOS__ == 0x05000000

-#       define __WXPALMOS5__
+#       define __WXPALMOS5__ 1

 #   endif
 #   ifndef __WXPALMOS__
 #   endif
 #   ifndef __WXPALMOS__

-#       define __WXPALMOS__
+#       define __WXPALMOS__ 1

 #   endif
 #   ifdef __WXMSW__
 #       undef __WXMSW__
 #   endif
 #   ifdef __WXMSW__
 #       undef __WXMSW__


@@ -133,17 +168,25 @@
 #    ifndef __WXMSW__
 #        define __WXMSW__
 #    endif
 #    ifndef __WXMSW__
 #        define __WXMSW__
 #    endif

-
-#    ifndef __WIN32__
-#        define __WIN32__
-#    endif

 #endif /* Win32 */
 
 #endif /* Win32 */
 

-#if defined(__WXMSW__) || defined(__WIN32__)
+#if defined(__WXMSW__)

 #   if !defined(__WINDOWS__)
 #       define __WINDOWS__
 #   endif
 #   if !defined(__WINDOWS__)
 #       define __WINDOWS__
 #   endif

-#endif
+
+#   ifndef _WIN32
+#        define _WIN32
+#   endif
+
+#   ifndef WIN32
+#        define WIN32
+#   endif
+
+#   ifndef __WIN32__
+#        define __WIN32__
+#   endif
+#endif /* __WXMSW__ */

 
 /* detect MS SmartPhone */
 #if defined( WIN32_PLATFORM_WFSP )
 
 /* detect MS SmartPhone */
 #if defined( WIN32_PLATFORM_WFSP )


@@ -201,7 +244,15 @@
    Note that it must be included before defining hardware symbols below as they
    could be already defined by configure
  */
    Note that it must be included before defining hardware symbols below as they
    could be already defined by configure
  */

-#include "wx/setup.h"
+#ifdef __GCCXML__
+    /*
+        we're using gccxml to create an XML representation of the entire
+        wxWidgets interface; pass it a special setup.h file
+    */
+    #include "wx/setup_gccxml.h"
+#else
+    #include "wx/setup.h"
+#endif

 
 /*
    Hardware platform detection.
 
 /*
    Hardware platform detection.


@@ -220,7 +271,7 @@
     #endif
 #endif /* ia64 */
 
     #endif
 #endif /* ia64 */
 

-#if defined(_M_MPPC) || defined(__PPC__)
+#if defined(_M_MPPC) || defined(__PPC__) || defined(__ppc__)

     #ifndef __POWERPC__
         #define __POWERPC__
     #endif
     #ifndef __POWERPC__
         #define __POWERPC__
     #endif


@@ -265,6 +316,21 @@
 #endif
 
 
 #endif
 
 

+/*
+   test for old versions of Borland C, normally need at least 5.82, Turbo
+   explorer, available for free at http://www.turboexplorer.com/downloads
+*/
+#if defined(__BORLANDC__) && (__BORLANDC__ < 0x550)
+#   error "wxWidgets requires a newer version of Borland, we recommend upgrading to 5.82 (Turbo Explorer). You may at your own risk remove this line and try building but be prepared to get build errors."
+#endif /* __BORLANDC__ */
+
+#if defined(__BORLANDC__) && (__BORLANDC__ < 0x582) && (__BORLANDC__ > 0x559)
+#   ifndef _USE_OLD_RW_STL
+#       error "wxWidgets is incompatible with default Borland C++ 5.6 STL library, please add -D_USE_OLD_RW_STL to your bcc32.cfg to use RogueWave STL implementation."
+#   endif
+#endif /* __BORLANDC__ */
+
+

 /*
    This macro can be used to test the Open Watcom version.
 */
 /*
    This macro can be used to test the Open Watcom version.
 */


@@ -302,11 +368,12 @@
 /*
    OS: then test for generic Unix defines, then for particular flavours and
        finally for Unix-like systems
 /*
    OS: then test for generic Unix defines, then for particular flavours and
        finally for Unix-like systems

+       Mac OS X matches this case (__MACH__), prior Mac OS do not.

  */
 #elif defined(__UNIX__) || defined(__unix) || defined(__unix__) || \
       defined(____SVR4____) || defined(__LINUX__) || defined(__sgi) || \
       defined(__hpux) || defined(sun) || defined(__SUN__) || defined(_AIX) || \
  */
 #elif defined(__UNIX__) || defined(__unix) || defined(__unix__) || \
       defined(____SVR4____) || defined(__LINUX__) || defined(__sgi) || \
       defined(__hpux) || defined(sun) || defined(__SUN__) || defined(_AIX) || \

-      defined(__EMX__) || defined(__VMS) || defined(__BEOS__)
+      defined(__EMX__) || defined(__VMS) || defined(__BEOS__) || defined(__MACH__)

 
 #    define __UNIX_LIKE__
 
 
 #    define __UNIX_LIKE__
 


@@ -348,6 +415,35 @@
 #            define wxSIZE_T_IS_UINT
 #        endif
 #    endif
 #            define wxSIZE_T_IS_UINT
 #        endif
 #    endif

+
+    /*  All of these should already be defined by including configure-
+        generated setup.h but we wish to support Xcode compilation without
+        requiring the user to define these himself.
+     */
+#    if defined(__APPLE__) && defined(__MACH__)
+#        ifndef __UNIX__
+#            define __UNIX__ 1
+#        endif
+#        ifndef __BSD__
+#            define __BSD__ 1
+#        endif
+        /*  __DARWIN__ is our own define to mean OS X or pure Darwin */
+#        ifndef __DARWIN__
+#            define __DARWIN__ 1
+#        endif
+        /*  NOTE: TARGET_CARBON is actually a 0/1 and must be 1 for OS X */
+#        ifndef TARGET_CARBON
+#            define TARGET_CARBON 1
+#        endif
+        /* OS X uses unsigned long size_t for both ILP32 and LP64 modes. */
+#        if !defined(wxSIZE_T_IS_UINT) && !defined(wxSIZE_T_IS_ULONG)
+#            define wxSIZE_T_IS_ULONG
+#        endif
+#    endif
+
+/*
+   OS: Classic Mac OS
+ */

 #elif defined(applec) || \
       defined(THINK_C) || \
       (defined(__MWERKS__) && !defined(__INTEL__))
 #elif defined(applec) || \
       defined(THINK_C) || \
       (defined(__MWERKS__) && !defined(__INTEL__))


@@ -355,38 +451,10 @@
 #    if !defined(wxSIZE_T_IS_UINT) && !defined(wxSIZE_T_IS_ULONG)
 #        define wxSIZE_T_IS_ULONG
 #    endif
 #    if !defined(wxSIZE_T_IS_UINT) && !defined(wxSIZE_T_IS_ULONG)
 #        define wxSIZE_T_IS_ULONG
 #    endif

-#elif defined(__WXMAC__) && defined(__APPLE__)
-    /* Mac OS X */
-#    define __UNIX_LIKE__
-
-    /*
-      These defines are needed when compiling using Project Builder
-      with a non generated setup0.h
-    */
-#    ifndef __UNIX__
-#        define __UNIX__ 1
-#    endif
-#    ifndef __BSD__
-#        define __BSD__ 1
-#    endif
-#    ifndef __DARWIN__
-#        define __DARWIN__ 1
-#    endif
-#    ifndef __POWERPC__
-#        define __POWERPC__ 1
-#    endif
-#    ifndef TARGET_CARBON
-#        define TARGET_CARBON 1
-#    endif

 
 

-#    if !defined(wxSIZE_T_IS_UINT) && !defined(wxSIZE_T_IS_ULONG)
-#        define wxSIZE_T_IS_ULONG
-#    endif
-    /*
-       Some code has been added to workaround defects(?) in the
-       bundled gcc compiler. These corrections are identified by
-       __DARWIN__ for Darwin related corrections (wxMac, wxMotif)
-     */
+/*
+   OS: OS/2
+ */

 #elif defined(__OS2__)
 
     /* wxOS2 vs. non wxOS2 ports on OS2 platform */
 #elif defined(__OS2__)
 
     /* wxOS2 vs. non wxOS2 ports on OS2 platform */


@@ -407,6 +475,9 @@
 #    endif
 #    define wxSIZE_T_IS_UINT
 
 #    endif
 #    define wxSIZE_T_IS_UINT
 

+/*
+   OS: Palm OS
+ */

 #elif defined(__PALMOS__)
 #    ifdef __WIN32__
 #        error "__WIN32__ should not be defined for PalmOS"
 #elif defined(__PALMOS__)
 #    ifdef __WIN32__
 #        error "__WIN32__ should not be defined for PalmOS"


@@ -418,6 +489,9 @@
 #        error "__WXMSW__ should not be defined for PalmOS"
 #    endif
 
 #        error "__WXMSW__ should not be defined for PalmOS"
 #    endif
 

+/*
+   OS: Otherwise it must be Windows
+ */

 #else   /* Windows */
 #    ifndef __WINDOWS__
 #        define __WINDOWS__
 #else   /* Windows */
 #    ifndef __WINDOWS__
 #        define __WINDOWS__


@@ -434,6 +508,27 @@
      */
 #    if defined(_MSC_VER) && !defined(__MWERKS__)
 #        define __VISUALC__ _MSC_VER
      */
 #    if defined(_MSC_VER) && !defined(__MWERKS__)
 #        define __VISUALC__ _MSC_VER

+
+    /*
+       define special symbols for different VC version instead of writing tests
+       for magic numbers such as 1200, 1300 &c repeatedly
+     */
+#   if __VISUALC__ < 1100
+#       error "This Visual C++ version is too old and not supported any longer."
+#   elif __VISUALC__ < 1200
+#       define __VISUALC5__
+#   elif __VISUALC__ < 1300
+#       define __VISUALC6__
+#   elif __VISUALC__ < 1400
+#       define __VISUALC7__
+#   elif __VISUALC__ < 1500
+#       define __VISUALC8__
+#   elif __VISUALC__ < 1600
+#       define __VISUALC9__
+#   else
+#       pragma message("Please update this code for the next VC++ version")
+#   endif
+

 #    elif defined(__BCPLUSPLUS__) && !defined(__BORLANDC__)
 #        define __BORLANDC__
 #    elif defined(__WATCOMC__)
 #    elif defined(__BCPLUSPLUS__) && !defined(__BORLANDC__)
 #        define __BORLANDC__
 #    elif defined(__WATCOMC__)


@@ -443,7 +538,7 @@
 
     /* size_t is the same as unsigned int for all Windows compilers we know, */
     /* so define it if it hadn't been done by configure yet */
 
     /* size_t is the same as unsigned int for all Windows compilers we know, */
     /* so define it if it hadn't been done by configure yet */

-#    if !defined(wxSIZE_T_IS_UINT) && !defined(wxSIZE_T_IS_ULONG)
+#    if !defined(wxSIZE_T_IS_UINT) && !defined(wxSIZE_T_IS_ULONG) && !defined(__WIN64__)

 #        define wxSIZE_T_IS_UINT
 #    endif
 #endif  /* OS */
 #        define wxSIZE_T_IS_UINT
 #    endif
 #endif  /* OS */


@@ -508,6 +603,17 @@
 #define wxNEEDS_CHARPP
 #endif
 
 #define wxNEEDS_CHARPP
 #endif
 

+/*
+   This macro can be used to test the Visual C++ version.
+*/
+#ifndef __VISUALC__
+#   define wxVISUALC_VERSION(major) 0
+#   define wxCHECK_VISUALC_VERSION(major) 0
+#else
+#   define wxVISUALC_VERSION(major) ( (6 + major) * 100 )
+#   define wxCHECK_VISUALC_VERSION(major) ( __VISUALC__ >= wxVISUALC_VERSION(major) )
+#endif
+

 /*
    This macro can be used to check that the version of mingw32 compiler is
    at least maj.min
 /*
    This macro can be used to check that the version of mingw32 compiler is
    at least maj.min


@@ -539,20 +645,41 @@
     #define wxCHECK_SUNCC_VERSION(maj, min) (0)
 #endif
 
     #define wxCHECK_SUNCC_VERSION(maj, min) (0)
 #endif
 

-#if defined (__WXMSW__)
-#    if !defined(__WATCOMC__)
-#        define wxHAVE_RAW_BITMAP
-#    endif
-#endif
-
-#if defined (__WXMAC__)
-#    if ( !defined(__MACH__) || ( defined(__BIG_ENDIAN__) && __BIG_ENDIAN__ ) )
-#        define WORDS_BIGENDIAN 1
-#    else
-#        undef WORDS_BIGENDIAN
-#    endif
+/*
+    Handle Darwin gcc universal compilation.  Don't do this in an Apple-
+    specific case since no sane compiler should be defining either
+    __BIG_ENDIAN__ or __LITTLE_ENDIAN__ unless it really is generating
+    code that will be hosted on a machine with the appropriate endianness.
+    If a compiler defines neither, assume the user or configure set
+    WORDS_BIGENDIAN appropriately.
+ */
+#if defined(__BIG_ENDIAN__)
+#    undef WORDS_BIGENDIAN
+#    define WORDS_BIGENDIAN 1
+#elif defined(__LITTLE_ENDIAN__)
+#    undef WORDS_BIGENDIAN
+#elif defined(__WXMAC__) && !defined(WORDS_BIGENDIAN)
+/*  According to Stefan even ancient Mac compilers defined __BIG_ENDIAN__ */
+#    warning "Compiling wxMac with probably wrong endianness"
+#endif
+/* also the 32/64 bit universal builds must be handled accordingly */
+#ifdef __DARWIN__
+#      ifdef __LP64__
+#              undef SIZEOF_VOID_P 
+#              undef SIZEOF_LONG 
+#              undef SIZEOF_SIZE_T 
+#              define SIZEOF_VOID_P 8
+#              define SIZEOF_LONG 8
+#              define SIZEOF_SIZE_T 8
+#      else
+#              undef SIZEOF_VOID_P 
+#              undef SIZEOF_LONG 
+#              undef SIZEOF_SIZE_T 
+#              define SIZEOF_VOID_P 4
+#              define SIZEOF_LONG 4
+#              define SIZEOF_SIZE_T 4
+#      endif

 #endif
 #endif

-

 /*
    check the consistency of the settings in setup.h: note that this must be
    done after setting wxUSE_UNICODE correctly as it is used in wx/chkconf.h
 /*
    check the consistency of the settings in setup.h: note that this must be
    done after setting wxUSE_UNICODE correctly as it is used in wx/chkconf.h


@@ -600,6 +727,15 @@
 # define wxVMS_USE_STD
 #endif
 
 # define wxVMS_USE_STD
 #endif
 

+#ifdef __VMS
+#define XtDisplay XTDISPLAY
+#ifdef __WXMOTIF__
+#define XtParent XTPARENT
+#define XtScreen XTSCREEN
+#define XtWindow XTWINDOW
+#endif
+#endif
+

 /* Choose which method we will use for updating menus
  * - in OnIdle, or when we receive a wxEVT_MENU_OPEN event.
  * Presently, only Windows and GTK+ support wxEVT_MENU_OPEN.
 /* Choose which method we will use for updating menus
  * - in OnIdle, or when we receive a wxEVT_MENU_OPEN event.
  * Presently, only Windows and GTK+ support wxEVT_MENU_OPEN.


@@ -619,7 +755,7 @@
  */
 
 #ifndef wxUSE_FILECONFIG
  */
 
 #ifndef wxUSE_FILECONFIG

-#    if wxUSE_CONFIG
+#    if wxUSE_CONFIG && wxUSE_TEXTFILE

 #        define wxUSE_FILECONFIG 1
 #    else
 #        define wxUSE_FILECONFIG 0
 #        define wxUSE_FILECONFIG 1
 #    else
 #        define wxUSE_FILECONFIG 0


@@ -643,4 +779,29 @@
     #include <AvailabilityMacros.h>
 #endif
 
     #include <AvailabilityMacros.h>
 #endif
 

+#if defined (__WXPALMOS__)
+#include "wx/palmos/missing.h"
+#endif // __WXPALMOS__
+
+#if !defined (__WXPALMOS5__)
+#define POSSEC_APPBASE
+#define POSSEC_ARCHIVE
+#define POSSEC_CLNTDATA
+#define POSSEC_CMDLINE
+#define POSSEC_CONFIG
+#define POSSEC_DATETIME
+#define POSSEC_DATETIME2
+#define POSSEC_DATSTRM
+#define POSSEC_DIRCMN
+#define POSSEC_DYNARRAY
+#define POSSEC_DYNLIB
+#define POSSEC_DYNLOAD
+#define POSSEC_ENCCONV
+#define POSSEC_EXTENDED
+#define POSSEC_FFILE
+#define POSSEC_FILE
+#define POSSEC_FILECONF
+#define POSSEC_FILEFN
+#endif // __WXPALMOS5__
+

 #endif /* _WX_PLATFORM_H_ */
 #endif /* _WX_PLATFORM_H_ */