docs/latex/wx/cppconst.tex

   1 \section{Preprocesser symbols defined by wxWidgets}\label{cppconst}
   2
   3 These are preprocessor symbols used in the wxWidgets source, grouped
   4 by category (and sorted by alphabetical order inside each category). All of
   5 these macros except for the \texttt{wxUSE\_XXX} variety is defined if the
   6 corresponding condition is true and undefined if it isn't, so they should be
   7 always tested using \texttt{#ifdef} and not \texttt{#if}.
   8
   9 \subsection{GUI system}\label{guisystemconst}
  10
  11 \begin{twocollist}\itemsep=0pt
  12 \twocolitem{\_\_WINDOWS\_\_}{any Windows, yom may also use \_\_WXMSW\_\_}
  13 \twocolitem{\_\_WIN16\_\_}{Win16 API (not supported since wxWidgets 2.6)}
  14 \twocolitem{\_\_WIN32\_\_}{Win32 API}
  15 \twocolitem{\_\_WIN95\_\_}{Windows 95 or NT 4.0 and above system (not NT 3.5x)}
  16 \twocolitem{\_\_WXBASE\_\_}{Only wxBase, no GUI features (same as \texttt{wxUSE\_GUI} $== 0$)}
  17 \twocolitem{\_\_WXCOCOA\_\_}{OS X using Cocoa API}
  18 \twocolitem{\_\_WXWINCE\_\_}{Windows CE}
  19 \twocolitem{\_\_WXGTK\_\_}{GTK+}
  20 \twocolitem{\_\_WXGTK12\_\_}{GTK+ 1.2 or higher}
  21 \twocolitem{\_\_WXGTK20\_\_}{GTK+ 2.0 or higher}
  22 \twocolitem{\_\_WXMOTIF\_\_}{Motif}
  23 \twocolitem{\_\_WXMOTIF20\_\_}{Motif 2.0 or higher}
  24 \twocolitem{\_\_WXMAC\_\_}{Mac OS all targets}
  25 \twocolitem{\_\_WXMAC\_CLASSIC\_\_}{MacOS for Classic}
  26 \twocolitem{\_\_WXMAC\_CARBON\_\_}{MacOS for Carbon CFM (running under Classic or OSX) or true OS X Mach-O Builds}
  27 \twocolitem{\_\_WXMAC\_OSX\_\_}{MacOS X Carbon Mach-O Builds}
  28 \twocolitem{\_\_WXMGL\_\_}{SciTech Soft MGL (\_\_WXUNIVERSAL\_\_ will be also
  29 defined)}
  30 \twocolitem{\_\_WXMSW\_\_}{Any Windows}
  31 \twocolitem{\_\_WXOS2\_\_}{Identical to \_\_WXPM\_\_}
  32 \twocolitem{\_\_WXOSX\_\_}{Any Mac OS X port (either Carbon or Cocoa)}
  33 \twocolitem{\_\_WXPALMOS\_\_}{PalmOS}
  34 \twocolitem{\_\_WXPM\_\_}{OS/2 native Presentation Manager}
  35 \twocolitem{\_\_WXSTUBS\_\_}{Stubbed version ('template' wxWin implementation)}
  36 \twocolitem{\_\_WXXT\_\_}{Xt; mutually exclusive with WX\_MOTIF, not
  37 implemented in wxWidgets 2.x}
  38 \twocolitem{\_\_WXX11\_\_}{wxX11 (\_\_WXUNIVERSAL\_\_ will be also defined)}
  39 \twocolitem{\_\_WXWINE\_\_}{WINE (i.e. WIN32 on Unix)}
  40 \twocolitem{\_\_WXUNIVERSAL\_\_}{wxUniversal port, always defined in addition
  41 to one of the symbols above so this should be tested first.}
  42 \twocolitem{\_\_X\_\_}{any X11-based GUI toolkit except GTK+}
  43 \end{twocollist}
  44
  45 There are two wxWidgets ports to Mac OS. One of them, wxMac, exists in two versions: Classic and
  46 Carbon. The Classic version is the only one to work on Mac OS version 8. The
  47 Carbon version may be built either as CFM or Mach-O (binary format, like ELF)
  48 and the former may run under OS 9 while the latter only runs under OS X.
  49 Finally, there is a new Cocoa port which can only be used under OS X. To
  50 summarize:
  51
  52 \begin{itemize}
  53 \item If you want to test for all Mac platforms, classic and OS X, you
  54 should test both \texttt{\_\_WXMAC\_\_} and \texttt{\_\_WXCOCOA\_\_}.
  55 \item If you want to test for any GUI Mac port under OS X, use
  56 \texttt{\_\_WXOSX\_\_}.
  57 \item If you want to test for any port under Mac OS X, including, for
  58 example, wxGTK and also wxBase, use \texttt{\_\_DARWIN\_\_} (see below).
  59 \end{itemize}
  60
  61 The convention is to use the \texttt{\_\_WX} prefix for these
  62 symbols, although this has not always been followed.
  63
  64 \subsection{Operating systems}\label{osconst}
  65
  66 \begin{twocollist}\itemsep=0pt
  67 \twocolitem{\_\_APPLE\_\_}{any Mac OS version}
  68 \twocolitem{\_\_AIX\_\_}{AIX}
  69 \twocolitem{\_\_BSD\_\_}{Any *BSD system}
  70 \twocolitem{\_\_CYGWIN\_\_}{Cygwin: Unix on Win32}
  71 \twocolitem{\_\_DARWIN\_\_}{Mac OS X using the BSD Unix C library (as opposed to using the Metrowerks MSL C/C++ library)}
  72 \twocolitem{\_\_DATA\_GENERAL\_\_}{DG-UX}
  73 \twocolitem{\_\_DOS\_GENERAL\_\_}{DOS (used with wxMGL only)}
  74 \twocolitem{\_\_FREEBSD\_\_}{FreeBSD}
  75 \twocolitem{\_\_HPUX\_\_}{HP-UX (Unix)}
  76 \twocolitem{\_\_GNU\_\_}{GNU Hurd}
  77 \twocolitem{\_\_LINUX\_\_}{Linux}
  78 \twocolitem{\_\_MACH\_\_}{Mach-O Architecture (Mac OS X only builds)}
  79 \twocolitem{\_\_OSF\_\_}{OSF/1}
  80 \twocolitem{\_\_PALMOS\_\_}{PalmOS}
  81 \twocolitem{\_\_SGI\_\_}{IRIX}
  82 \twocolitem{\_\_SOLARIS\_\_}{Solaris}
  83 \twocolitem{\_\_SUN\_\_}{Any Sun}
  84 \twocolitem{\_\_SUNOS\_\_}{Sun OS}
  85 \twocolitem{\_\_SVR4\_\_}{SystemV R4}
  86 \twocolitem{\_\_SYSV\_\_}{SystemV generic}
  87 \twocolitem{\_\_ULTRIX\_\_}{Ultrix}
  88 \twocolitem{\_\_UNIX\_\_}{any Unix}
  89 \twocolitem{\_\_UNIX\_LIKE\_\_}{Unix, BeOS or VMS}
  90 \twocolitem{\_\_VMS\_\_}{VMS}
  91 \twocolitem{\_\_WINDOWS\_\_}{any Windows}
  92 \end{twocollist}
  93
  94
  95 \subsection{Hardware architectures (CPU)}\label{cpuconst}
  96
  97 Note that not all of these symbols are always defined, it depends on the
  98 compiler used.
  99
 100 \begin{twocollist}\itemsep=0pt
 101 \twocolitem{\_\_ALPHA\_\_}{DEC Alpha architecture}
 102 \twocolitem{\_\_INTEL\_\_}{Intel i386 or compatible}
 103 \twocolitem{\_\_IA64\_\_}{Intel 64 bit architecture}
 104 \twocolitem{\_\_POWERPC\_\_}{Motorola Power PC}
 105 \end{twocollist}
 106
 107
 108 \subsection{Hardware type}\label{hardwareconst}
 109
 110 % Note: previous documentation referred to __SMARTPHONE__ as a generic (non-MS-specific) symbol
 111 % but we should go back to using it for a specific SDK, because trying to be
 112 % generic doesn't really work
 113
 114 \begin{twocollist}\itemsep=0pt
 115 \twocolitem{\_\_SMARTPHONE\_\_}{Microsoft-powered mobile devices with phone buttons and a small display}
 116 \twocolitem{\_\_POCKETPC\_\_}{Microsoft-powered PocketPC devices with touch-screen}
 117 \twocolitem{\_\_WINCE\_STANDARDSDK\_\_}{Microsoft-powered Windows CE devices, for generic Windows CE applications}
 118 \twocolitem{\_\_WINCE\_NET\_\_}{Microsoft-powered Windows CE .NET devices (\_WIN32\_WCE is 400 or greater)}
 119 % Note to doc writers: these symbols are pretty useless because of the blurred
 120 % dividing lines between these machines, plus they're not actually used.
 121 %\twocolitem{\_\_PDA\_\_}{Personal digital assistant usually with touch screen and
 122 %middle sized screen (not yet defined anywhere)}
 123 %\twocolitem{\_\_HANDHELD\_\_}{Small enough but powerful computer (not yet defined anywhere)}
 124 \end{twocollist}
 125
 126
 127 \subsection{Compilers}\label{compilerconst}
 128
 129 \begin{twocollist}\itemsep=0pt
 130 \twocolitem{\_\_BORLANDC\_\_}{Borland C++. The value of the macro corresponds
 131 to the compiler version: $500$ is $5.0$.}
 132 \twocolitem{\_\_DJGPP\_\_}{DJGPP}
 133 \twocolitem{\_\_DIGITALMARS\_\_}{Digital Mars}
 134 \twocolitem{\_\_GNUG\_\_}{Gnu C++ on any platform, see also
 135 \helpref{wxCHECK\_GCC\_VERSION}{wxcheckgccversion}}
 136 \twocolitem{\_\_GNUWIN32\_\_}{Gnu-Win32 compiler, see also
 137 \helpref{wxCHECK\_W32API\_VERSION}{wxcheckw32apiversion}}
 138 \twocolitem{\_\_MINGW32\_\_}{MinGW}
 139 \twocolitem{\_\_MWERKS\_\_}{CodeWarrior MetroWerks compiler}
 140 \twocolitem{\_\_SUNCC\_\_}{Sun CC}
 141 \twocolitem{\_\_SYMANTECC\_\_}{Symantec C++}
 142 \twocolitem{\_\_VISAGECPP\_\_}{IBM Visual Age (OS/2)}
 143 \twocolitem{\_\_VISUALC\_\_}{Microsoft Visual C++. The value of this macro
 144 corresponds to the compiler version: $1020$ for $4.2$ (the first supported
 145 version), $1100$ for $5.0$, $1200$ for $6.0$ and so on}
 146 \twocolitem{\_\_XLC\_\_}{AIX compiler}
 147 \twocolitem{\_\_WATCOMC\_\_}{Watcom C++. The value of this macro corresponds to
 148 the compiler version, $1100$ is $11.0$ and $1200$ is OpenWatcom.}
 149 \twocolitem{\_WIN32\_WCE}{Windows CE version}
 150 \end{twocollist}
 151
 152
 153 \subsection{Miscellaneous}\label{miscellaneousconst}
 154
 155 \begin{twocollist}\itemsep=0pt
 156 \twocolitem{\_\_WXWINDOWS\_\_}{always defined in wxWidgets applications, see
 157 also \helpref{wxCHECK\_VERSION}{wxcheckversion}}
 158 \twocolitem{\_\_WXDEBUG\_\_}{defined in debug mode, undefined in release mode}
 159 \twocolitem{wxUSE\_XXX}{if defined as $1$, feature XXX is active
 160 (the symbols of this form are always defined, use \#if and not \#ifdef to test
 161  for them)}
 162 \twocolitem{\_UNICODE and UNICODE}{both are defined if wxUSE\_UNICODE is set to $1$}
 163 \twocolitem{wxUSE\_GUI}{this particular feature test macro is defined to $1$
 164 when compiling or using the library with the GUI features activated, if it is
 165 defined as $0$, only wxBase is available.}
 166 \twocolitem{wxUSE\_BASE}{only used by wxWidgets internally (defined as $1$ when
 167 building wxBase code, either as a standalone library or as part of the
 168 monolithic wxWidgets library, defined as $0$ when building GUI library only)}
 169 \twocolitem{wxNO\_RTTI}{is defined if the compiler RTTI support has been switched off}
 170 \twocolitem{wxNO\_EXCEPTIONS}{is defined if the compiler support for C++
 171 exceptions has been switched off}
 172 \twocolitem{wxNO\_THREADS}{if this macro is defined, the compilation options
 173 don't include compiler flags needed for multithreaded code generation. This
 174 implies that wxUSE\_THREADS is $0$ and also that other (non wx-based) threading
 175 packages cannot be used neither.}
 176 \end{twocollist}
 177