docs/doxygen/mainpages/const_cpp.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        const_cpp.h
   3 // Purpose:     Preprocessor symbols
   4 // Author:      Vadim Zeitlin
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 /**
  11
  12 @page page_cppconst Preprocessor symbols defined by wxWidgets
  13
  14 These are preprocessor symbols used in the wxWidgets source, grouped
  15 by category (and sorted by alphabetical order inside each category).
  16 All of these macros except for the @c wxUSE_XXX variety is defined if the
  17 corresponding condition is @true and undefined if it isn't, so they should be
  18 always tested using @ifdef_ and not @if_.
  19
  20 @li @ref page_cppconst_guisystem
  21 @li @ref page_cppconst_os
  22 @li @ref page_cppconst_cpu
  23 @li @ref page_cppconst_hardware
  24 @li @ref page_cppconst_compiler
  25 @li @ref page_cppconst_featuretests
  26 @li @ref page_cppconst_miscellaneous
  27
  28 <hr>
  29
  30
  31 @section page_cppconst_guisystem GUI system
  32
  33 @beginDefList
  34 @itemdef{__WINDOWS__, any Windows, you may also use __WXMSW__}
  35 @itemdef{__WIN16__, Win16 API (not supported since wxWidgets 2.6)}
  36 @itemdef{__WIN32__, Win32 API}
  37 @itemdef{__WXBASE__, Only wxBase, no GUI features (same as @c wxUSE_GUI $== 0$)}
  38 @itemdef{__WXCOCOA__, OS X using Cocoa API}
  39 @itemdef{__WXDFB__, wxUniversal using DirectFB}
  40 @itemdef{__WXWINCE__, Windows CE}
  41 @itemdef{__WXGTK__, GTK+}
  42 @itemdef{__WXGTK12__, GTK+ 1.2 or higher}
  43 @itemdef{__WXGTK20__, GTK+ 2.0 or higher}
  44 @itemdef{__WXGTK24__, GTK+ 2.4 or higher}
  45 @itemdef{__WXGTK26__, GTK+ 2.6 or higher}
  46 @itemdef{__WXGTK210__, GTK+ 2.10 or higher}
  47 @itemdef{__WXMOTIF__, Motif}
  48 @itemdef{__WXMOTIF20__, Motif 2.0 or higher}
  49 @itemdef{__WXMAC__, Mac OS all targets}
  50 @itemdef{__WXMAC_CLASSIC__, MacOS for Classic}
  51 @itemdef{__WXMAC_CARBON__, MacOS for Carbon CFM (running under Classic or OSX)
  52                             or true OS X Mach-O Builds}
  53 @itemdef{__WXMAC_OSX__, MacOS X Carbon Mach-O Builds}
  54 @itemdef{__WXMGL__, SciTech Soft MGL (__WXUNIVERSAL__ will be also defined)}
  55 @itemdef{__WXMSW__, Any Windows}
  56 @itemdef{__WXOSX__, Any Mac OS X port (either Carbon or Cocoa)}
  57 @itemdef{__WXPALMOS__, PalmOS}
  58 @itemdef{__WXPM__, OS/2 native Presentation Manager}
  59 @itemdef{__WXSTUBS__, Stubbed version ('template' wxWin implementation)}
  60 @itemdef{__WXXT__, Xt; mutually exclusive with WX_MOTIF, not implemented in wxWidgets 2.x}
  61 @itemdef{__WXX11__, wxX11 (__WXUNIVERSAL__ will be also defined)}
  62 @itemdef{__WXWINE__, WINE (i.e. WIN32 on Unix)}
  63 @itemdef{__WXUNIVERSAL__, wxUniversal port, always defined in addition
  64                         to one of the symbols above so this should be tested first.}
  65 @itemdef{__X__, any X11-based GUI toolkit except GTK+}
  66 @endDefList
  67
  68 There are two wxWidgets ports to Mac OS. One of them, wxMac, exists in two versions:
  69 Classic and Carbon. The Classic version is the only one to work on Mac OS version 8.
  70 The Carbon version may be built either as CFM or Mach-O (binary format, like ELF)
  71 and the former may run under OS 9 while the latter only runs under OS X.
  72 Finally, there is a new Cocoa port which can only be used under OS X. To
  73 summarize:
  74
  75 @li If you want to test for all Mac platforms, classic and OS X, you
  76     should test both @c __WXMAC__ and @c __WXCOCOA__.
  77 @li If you want to test for any GUI Mac port under OS X, use
  78     @c __WXOSX__.
  79 @li If you want to test for any port under Mac OS X, including, for
  80     example, wxGTK and also wxBase, use @c __DARWIN__ (see below).
  81
  82 The convention is to use the @c __WX prefix for these
  83 symbols, although this has not always been followed.
  84
  85
  86 @section page_cppconst_os Operating systems
  87
  88 @beginDefList
  89 @itemdef{__APPLE__, any Mac OS version}
  90 @itemdef{__AIX__, AIX}
  91 @itemdef{__BSD__, Any *BSD system}
  92 @itemdef{__CYGWIN__, Cygwin: Unix on Win32}
  93 @itemdef{__DARWIN__, Mac OS X using the BSD Unix C library
  94                     (as opposed to using the Metrowerks MSL C/C++ library)}
  95 @itemdef{__DATA_GENERAL__, DG-UX}
  96 @itemdef{__DOS_GENERAL__, DOS (used with wxMGL only)}
  97 @itemdef{__FREEBSD__, FreeBSD}
  98 @itemdef{__HPUX__, HP-UX (Unix)}
  99 @itemdef{__GNU__, GNU Hurd}
 100 @itemdef{__LINUX__, Linux}
 101 @itemdef{__MACH__, Mach-O Architecture (Mac OS X only builds)}
 102 @itemdef{__OSF__, OSF/1}
 103 @itemdef{__PALMOS__, PalmOS}
 104 @itemdef{__SGI__, IRIX}
 105 @itemdef{__SOLARIS__, Solaris}
 106 @itemdef{__SUN__, Any Sun}
 107 @itemdef{__SUNOS__, Sun OS}
 108 @itemdef{__SVR4__, SystemV R4}
 109 @itemdef{__SYSV__, SystemV generic}
 110 @itemdef{__ULTRIX__, Ultrix}
 111 @itemdef{__UNIX__, any Unix}
 112 @itemdef{__UNIX_LIKE__, Unix, BeOS or VMS}
 113 @itemdef{__VMS__, VMS}
 114 @itemdef{__WINDOWS__, any Windows}
 115 @itemdef{__WINE__, Wine}
 116 @endDefList
 117
 118
 119
 120 @section page_cppconst_cpu Hardware architectures (CPU)
 121
 122 Note that not all of these symbols are always defined, it depends on the
 123 compiler used.
 124
 125 @beginDefList
 126 @itemdef{__ALPHA__, DEC Alpha architecture}
 127 @itemdef{__INTEL__, Intel i386 or compatible}
 128 @itemdef{__IA64__, Intel 64 bit architecture}
 129 @itemdef{__POWERPC__, Motorola Power PC}
 130 @endDefList
 131
 132
 133
 134 @section page_cppconst_hardware Hardware type
 135
 136 @beginDefList
 137 @itemdef{__SMARTPHONE__, Generic mobile devices with phone buttons and a small display}
 138 @itemdef{__PDA__, Personal digital assistant, usually with touch screen}
 139 @itemdef{__HANDHELD__, Small but powerful computer, usually with a keyboard}
 140 @itemdef{__POCKETPC__, Microsoft-powered PocketPC devices with touch-screen}
 141 @itemdef{__WINCE_STANDARDSDK__, Microsoft-powered Windows CE devices, for generic Windows CE applications}
 142 @itemdef{__WINCE_NET__, Microsoft-powered Windows CE .NET devices (_WIN32_WCE is 400 or greater)}
 143 @itemdef{WIN32_PLATFORM_WFSP, Microsoft-powered smartphone}
 144 @endDefList
 145
 146
 147
 148 @section page_cppconst_compiler Compilers
 149
 150 @beginDefList
 151 @itemdef{__BORLANDC__, Borland C++. The value of the macro corresponds
 152                         to the compiler version: $500$ is $5.0$.}
 153 @itemdef{__DJGPP__, DJGPP}
 154 @itemdef{__DIGITALMARS__, Digital Mars}
 155 @itemdef{__GNUG__, Gnu C++ on any platform, see also wxCHECK_GCC_VERSION}
 156 @itemdef{__GNUWIN32__, Gnu-Win32 compiler, see also wxCHECK_W32API_VERSION}
 157 @itemdef{__MINGW32__, MinGW}
 158 @itemdef{__MWERKS__, CodeWarrior MetroWerks compiler}
 159 @itemdef{__SUNCC__, Sun CC, see also wxCHECK_SUNCC_VERSION}
 160 @itemdef{__SYMANTECC__, Symantec C++}
 161 @itemdef{__VISAGECPP__, IBM Visual Age (OS/2)}
 162 @itemdef{__VISUALC__, Microsoft Visual C++, see also wxCHECK_VISUALC_VERSION.
 163                     The value of this macro corresponds to the compiler version:
 164                     @c 1020 for @c 4.2 (the first supported version), @c 1100 for
 165                     @c 5.0, @c 1200 for @c 6.0 and so on. For convenience, the symbols
 166                     __VISUALCn__ are also defined for each major compiler version from
 167                     5 to 9, i.e. you can use tests such @ifdef_ __VISUALC7__ to test
 168                     for compiler version being precisely 7.}
 169 @itemdef{__XLC__, AIX compiler}
 170 @itemdef{__WATCOMC__, Watcom C++. The value of this macro corresponds to
 171                     the compiler version, @c 1100 is @c 11.0 and @c 1200 is OpenWatcom.}
 172 @itemdef{_WIN32_WCE, Windows CE version}
 173 @endDefList
 174
 175
 176
 177 @section page_cppconst_featuretests Feature tests
 178
 179 Some library features may not be always available even if they were selected
 180 by the user. To make it possible to check if this is the case, the library
 181 predefines the symbols in the form @c wxHAS_FEATURE. Unlike
 182 @c wxUSE_FEATURE symbols which are defined by the library user (directly
 183 in @c setup.h or by running configure script) and which must be always
 184 defined as either $0$ or $1$, the @c wxHAS symbols are only defined if
 185 the corresponding feature is available and not defined at all otherwise.
 186
 187 Currently the following symbols exist:
 188
 189 @beginDefList
 190 @itemdef{wxHAS_LARGE_FILES, Defined if wxFile supports files more than 4GB in size.}
 191 @itemdef{wxHAS_LARGE_FFILES, Defined if wxFFile supports files more than 4GB in size.}
 192 @itemdef{wxHAS_POWER_EVENTS, Defined if wxPowerEvent are ever generated on the current platform.}
 193 @itemdef{wxHAS_RADIO_MENU_ITEMS,
 194         Defined if the current port supports radio menu items (see wxMenu::AppendRadioItem).}
 195 @itemdef{wxHAS_RAW_KEY_CODES, Defined if raw key codes (see wxKeyEvent::GetRawKeyCode are supported.}
 196 @itemdef{wxHAS_REGEX_ADVANCED, Defined if advanced syntax is available in wxRegEx.}
 197 @itemdef{wxHAS_TASK_BAR_ICON, Defined if wxTaskBarIcon is available on the current platform.}
 198 @endDefList
 199
 200
 201
 202 @section page_cppconst_miscellaneous Miscellaneous
 203
 204 @beginDefList
 205 @itemdef{__WXWINDOWS__,
 206         always defined in wxWidgets applications, see also wxCHECK_VERSION}
 207 @itemdef{__WXDEBUG__, defined in debug mode, undefined in release mode}
 208 @itemdef{wxUSE_XXX,
 209         if defined as $1$, feature XXX is active, see the
 210         @ref page_wxusedef (the symbols of this form are always defined,
 211         use @if_ and not @ifdef_ to test for them)}
 212 @itemdef{WX_PRECOMP,
 213         is defined if precompiled headers (PCH) are in use. In
 214         this case, @c wx/wxprec.h includes @c wx/wx.h which, in turn,
 215         includes a number of wxWidgets headers thus making it unnecessary to include
 216         them explicitly. However if this is not defined, you do need to include them
 217         and so the usual idiom which allows to support both cases is to first include
 218         @c wx/wxprec.h} and then, inside @ifndef_ WX_PRECOMP, individual
 219         headers you need.}
 220 @itemdef{_UNICODE and UNICODE, both are defined if wxUSE_UNICODE is set to @c 1}
 221 @itemdef{wxUSE_GUI,
 222         this particular feature test macro is defined to $1$
 223         when compiling or using the library with the GUI features activated,
 224         if it is defined as @c 0, only wxBase is available.}
 225 @itemdef{wxUSE_BASE,
 226         only used by wxWidgets internally (defined as $1$ when
 227         building wxBase code, either as a standalone library or as part of the
 228         monolithic wxWidgets library, defined as $0$ when building GUI library only)}
 229 @itemdef{wxNO_RTTI, is defined if the compiler RTTI support has been switched off}
 230 @itemdef{wxNO_EXCEPTIONS,
 231         is defined if the compiler support for C++ exceptions has been switched off}
 232 @itemdef{wxNO_THREADS,
 233         if this macro is defined, the compilation options
 234         don't include compiler flags needed for multithreaded code generation. This
 235         implies that wxUSE_THREADS is $0$ and also that other (non-wx-based) threading
 236         packages cannot be used neither.}
 237 @itemdef{WXMAKINGDLL_XXX,
 238         used internally and defined when building the
 239         library @c XXX as a DLL; when a monolithic wxWidgets build is used only a
 240         single @c WXMAKINGDLL symbol is defined}
 241 @itemdef{WXUSINGDLL,
 242         defined when compiling code which uses wxWidgets as a DLL/shared library}
 243 @itemdef{WXBUILDING,
 244         defined when building wxWidgets itself, whether as a static or shared library}
 245 @endDefList
 246
 247 */