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