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 licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 /**
  11
  12 @page page_cppconst Preprocessor Symbols
  13
  14 @tableofcontents
  15
  16 These are preprocessor symbols used in the wxWidgets source, grouped by
  17 category (and sorted by alphabetical order inside each category). All of these
  18 macros except for the @c wxUSE_XXX variety is defined if the corresponding
  19 condition is @true and undefined if it isn't, so they should be always tested
  20 using @ifdef_ and not @if_.
  21
  22
  23
  24 @section page_cppconst_guisystem GUI system
  25
  26 @beginDefList
  27 @itemdef{__WXBASE__, Only wxBase, no GUI features (same as @c wxUSE_GUI == 0)}
  28 @itemdef{__WXCOCOA__, OS X using wxCocoa Port}
  29 @itemdef{__WXDFB__, wxUniversal using DirectFB}
  30 @itemdef{__WXWINCE__, Windows CE}
  31 @itemdef{__WXGTK__, GTK+}
  32 @itemdef{__WXGTK12__, GTK+ 1.2 or higher}
  33 @itemdef{__WXGTK20__, GTK+ 2.0 or higher}
  34 @itemdef{__WXGTK24__, GTK+ 2.4 or higher}
  35 @itemdef{__WXGTK26__, GTK+ 2.6 or higher}
  36 @itemdef{__WXGTK210__, GTK+ 2.10 or higher}
  37 @itemdef{__WXMAC__, old define, same as @c __WXOSX__}
  38 @itemdef{__WXMOTIF__, Motif}
  39 @itemdef{__WXMOTIF20__, Motif 2.0 or higher}
  40 @itemdef{__WXMSW__, GUI using <a href="http://en.wikipedia.org/wiki/Windows_User">Windows Controls</a>}
  41 @itemdef{__WXOSX__, OS X GUI using any Apple widget framework (Carbon, AppKit or UIKit)}
  42 @itemdef{__WXOSX_IPHONE__, OS X iPhone (UIKit)}
  43 @itemdef{__WXOSX_CARBON__, Mac OS X using Carbon}
  44 @itemdef{__WXOSX_COCOA__, Mac OS X using Cocoa (AppKit)}
  45 @itemdef{__WXOSX_MAC__, Mac OS X (Carbon or Cocoa)}
  46 @itemdef{__WXOSX_OR_COCOA__, Any Mac OS X port (wxOSX-Carbon, wxOSX-Cocoa or
  47                         wxCocoa)}
  48 @itemdef{__WXPM__, OS/2 native Presentation Manager}
  49 @itemdef{__WXSTUBS__, Stubbed version ('template' wxWin implementation)}
  50 @itemdef{__WXXT__, Xt; mutually exclusive with WX_MOTIF, not implemented in wxWidgets 2.x}
  51 @itemdef{__WXX11__, wxX11 (__WXUNIVERSAL__ will be also defined)}
  52 @itemdef{__WXWINE__, WINE (i.e. WIN32 on Unix)}
  53 @itemdef{__WXUNIVERSAL__, wxUniversal port, always defined in addition
  54                         to one of the symbols above so this should be tested first.}
  55 @itemdef{__X__, any X11-based GUI toolkit except GTK+}
  56 @endDefList
  57
  58 There are two wxWidgets ports to Mac OS X. One of them, wxOSX is the successor of the
  59 venerable wxMac, it currently exists in three versions: Carbon and Cocoa for the
  60 desktop and a very early iPhone port. And there is the Cocoa port named wxCocoa
  61 which has not been updated very actively since beginning 2008. To summarize:
  62
  63 @li If you want to test for wxOSX on the desktop, use
  64     @c __WXOSX_MAC__.
  65 @li If you want to test for wxOSX on the iPhone, use
  66     @c __WXOSX_IPHONE__.
  67 @li If you want to test for any GUI Mac port under OS X, use
  68     @c __WXOSX_OR_COCOA__.
  69 @li If you want to test for any port under Mac OS X, including, for
  70     example, wxGTK and also wxBase, use @c __DARWIN__ (see below).
  71
  72 The convention is to use the @c __WX prefix for these
  73 symbols, although this has not always been followed.
  74
  75
  76
  77 @section page_cppconst_os Operating Systems
  78
  79 @beginDefList
  80 @itemdef{__APPLE__, any Mac OS version}
  81 @itemdef{__AIX__, AIX}
  82 @itemdef{__BSD__, Any *BSD system}
  83 @itemdef{__CYGWIN__, Cygwin: Unix on Win32}
  84 @itemdef{__DARWIN__, Mac OS X (with BSD C library), using any port (see also @c __WXOSX__)}
  85 @itemdef{__DATA_GENERAL__, DG-UX}
  86 @itemdef{__FREEBSD__, FreeBSD}
  87 @itemdef{__HPUX__, HP-UX (Unix)}
  88 @itemdef{__GNU__, GNU Hurd}
  89 @itemdef{__LINUX__, Linux}
  90 @itemdef{__MACH__, Mach-O Architecture (Mac OS X only builds)}
  91 @itemdef{__OSF__, OSF/1}
  92 @itemdef{__QNX__, QNX Neutrino RTOS}
  93 @itemdef{__SGI__, IRIX}
  94 @itemdef{__SOLARIS__, Solaris}
  95 @itemdef{__SUN__, Any Sun}
  96 @itemdef{__SUNOS__, Sun OS}
  97 @itemdef{__SVR4__, SystemV R4}
  98 @itemdef{__SYSV__, SystemV generic}
  99 @itemdef{__ULTRIX__, Ultrix}
 100 @itemdef{__UNIX__, any Unix}
 101 @itemdef{__UNIX_LIKE__, Unix, BeOS or VMS}
 102 @itemdef{__VMS__, VMS}
 103 @itemdef{__WINDOWS__, Any Windows platform, using any port (see also @c __WXMSW__)}
 104 @itemdef{__WIN16__, Win16 API (not supported since wxWidgets 2.6)}
 105 @itemdef{__WIN32__, Win32 API}
 106 @itemdef{__WIN64__, Win64 (mostly same as Win32 but data type sizes are different)}
 107 @itemdef{__WINE__, Wine}
 108 @itemdef{_WIN32_WCE, Windows CE version}
 109 @endDefList
 110
 111
 112
 113 @section page_cppconst_cpu Hardware Architectures (CPU)
 114
 115 Note that not all of these symbols are always defined, it depends on the
 116 compiler used.
 117
 118 @beginDefList
 119 @itemdef{__ALPHA__, DEC Alpha architecture}
 120 @itemdef{__INTEL__, Intel i386 or compatible}
 121 @itemdef{__IA64__, Intel 64 bit architecture}
 122 @itemdef{__POWERPC__, Motorola Power PC}
 123 @endDefList
 124
 125
 126
 127 @section page_cppconst_hardware Hardware Type
 128
 129 @beginDefList
 130 @itemdef{__SMARTPHONE__, Generic mobile devices with phone buttons and a small display}
 131 @itemdef{__PDA__, Personal digital assistant, usually with touch screen}
 132 @itemdef{__HANDHELD__, Small but powerful computer, usually with a keyboard}
 133 @itemdef{__POCKETPC__, Microsoft-powered PocketPC devices with touch-screen}
 134 @itemdef{__WINCE_STANDARDSDK__, Microsoft-powered Windows CE devices, for generic Windows CE applications}
 135 @itemdef{__WINCE_NET__, Microsoft-powered Windows CE .NET devices (_WIN32_WCE is 400 or greater)}
 136 @itemdef{WIN32_PLATFORM_WFSP, Microsoft-powered smartphone}
 137 @endDefList
 138
 139
 140
 141 @section page_cppconst_compiler Compilers
 142
 143 @beginDefList
 144 @itemdef{__BORLANDC__, Borland C++. The value of the macro corresponds
 145                         to the compiler version: 500 is 5.0.}
 146 @itemdef{__DJGPP__, DJGPP}
 147 @itemdef{__DIGITALMARS__, Digital Mars}
 148 @itemdef{__EVC4__, Embedded Visual C++ 4 (can be only used for building wxWinCE)}
 149 @itemdef{__GNUG__, Gnu C++ on any platform, see also wxCHECK_GCC_VERSION}
 150 @itemdef{__GNUWIN32__, Gnu-Win32 compiler, see also wxCHECK_W32API_VERSION}
 151 @itemdef{__MINGW32__, MinGW}
 152 @itemdef{__SUNCC__, Sun CC, see also wxCHECK_SUNCC_VERSION}
 153 @itemdef{__SYMANTECC__, Symantec C++}
 154 @itemdef{__VISAGECPP__, IBM Visual Age (OS/2)}
 155 @itemdef{__VISUALC__, Microsoft Visual C++, see also ::wxCHECK_VISUALC_VERSION.
 156                     The value of this macro corresponds to the compiler version:
 157                     @c 1020 for @c 4.2 (the first supported version), @c 1100 for
 158                     @c 5.0, @c 1200 for @c 6.0 and so on. For convenience, the symbols
 159                     __VISUALCn__ are also defined for each major compiler version from
 160                     5 to 11, i.e. you can use tests such @ifdef_ __VISUALC7__ to test
 161                     for compiler version being precisely 7.}
 162 @itemdef{__XLC__, AIX compiler}
 163 @itemdef{__WATCOMC__, Watcom C++. The value of this macro corresponds to
 164                     the compiler version, @c 1100 is @c 11.0 and @c 1200 is OpenWatcom.}
 165 @endDefList
 166
 167
 168
 169 @section page_cppconst_featuretests Feature Tests
 170
 171 Some library features may not be always available even if they were selected
 172 by the user. To make it possible to check if this is the case, the library
 173 predefines the symbols in the form @c wxHAS_FEATURE. Unlike
 174 @c wxUSE_FEATURE symbols which are defined by the library user (directly
 175 in @c setup.h or by running configure script) and which must be always
 176 defined as either 0 or 1, the @c wxHAS symbols are only defined if
 177 the corresponding feature is available and not defined at all otherwise.
 178
 179 Currently the following symbols exist:
 180
 181 @beginDefList
 182 @itemdef{wxHAS_3STATE_CHECKBOX, Defined if wxCheckBox supports wxCHK_3STATE
 183     flag, i.e. is capable of showing three states and not only the usual two.
 184     Currently defined for almost all ports.}
 185 @itemdef{wxHAS_ATOMIC_OPS, Defined if wxAtomicInc() and wxAtomicDec() functions
 186     have an efficient (CPU-specific) implementation. Notice that the functions
 187     themselves are always available but can be prohibitively slow to use when
 188     implemented in a generic way, using a critical section.}
 189 @itemdef{wxHAS_BITMAPTOGGLEBUTTON, Defined in @c wx/tglbtn.h if
 190     wxBitmapToggleButton class is available in addition to wxToggleButton.}
 191 @itemdef{wxHAS_CONFIG_TEMPLATE_RW, Defined if the currently used compiler
 192     supports template Read() and Write() methods in wxConfig.}
 193 @itemdef{wxHAS_LARGE_FILES, Defined if wxFile supports files more than 4GB in
 194     size (notice that you must include @c wx/filefn.h before testing for this
 195     symbol).}
 196 @itemdef{wxHAS_LARGE_FFILES, Defined if wxFFile supports files more than 4GB in
 197     size (notice that you must include @c wx/filefn.h before testing for this
 198     symbol).}
 199 @itemdef{wxHAS_LONG_LONG_T_DIFFERENT_FROM_LONG, Defined if compiler supports a
 200     64 bit integer type (available as @c wxLongLong_t) and this type is
 201     different from long. Notice that, provided wxUSE_LONGLONG is not turned
 202     off, some 64 bit type is always available to wxWidgets programs and this
 203     symbol only indicates a presence of such primitive type. It is useful to
 204     decide whether some function should be overloaded for both
 205     <code>long</code> and <code>long long</code> types.}
 206 @itemdef{wxHAS_MULTIPLE_FILEDLG_FILTERS, Defined if wxFileDialog supports multiple ('|'-separated) filters.}
 207 @itemdef{wxHAS_IMAGES_IN_RESOURCES, Defined if <a href="http://en.wikipedia.org/wiki/Resource_(Windows)">
 208     Windows resource files</a> or OS/2 resource files are available on the current platform.}
 209 @itemdef{wxHAS_POWER_EVENTS, Defined if wxPowerEvent are ever generated on the current platform.}
 210 @itemdef{wxHAS_RADIO_MENU_ITEMS,
 211         Defined if the current port supports radio menu items (see wxMenu::AppendRadioItem).}
 212 @itemdef{wxHAS_RAW_BITMAP, Defined if direct access to bitmap data using the classes in @c wx/rawbmp.h is supported.}
 213 @itemdef{wxHAS_RAW_KEY_CODES, Defined if raw key codes (see wxKeyEvent::GetRawKeyCode are supported.}
 214 @itemdef{wxHAS_REGEX_ADVANCED, Defined if advanced syntax is available in wxRegEx.}
 215 @itemdef{wxHAS_TASK_BAR_ICON, Defined if wxTaskBarIcon is available on the current platform.}
 216 @endDefList
 217
 218
 219
 220 @section page_cppconst_msvc_setup_h Library Selection for MSVC
 221
 222 Microsoft Visual C++ users may use the special @c wx/setup.h file for this
 223 compiler in @c include/msvc subdirectory. This file implicitly links in all the
 224 wxWidgets libraries using MSVC-specific pragmas which usually is much more
 225 convenient than manually specifying the libraries list in all of the project
 226 configurations. However sometimes linking with all the libraries is not
 227 desirable, for example because some of them were not built and this is where
 228 the symbols in this section can be helpful: defining them allows to not link
 229 with the corresponding library. The following symbols are honoured:
 230
 231     - wxNO_ADV_LIB
 232     - wxNO_AUI_LIB
 233     - wxNO_HTML_LIB
 234     - wxNO_MEDIA_LIB
 235     - wxNO_NET_LIB
 236     - wxNO_PROPGRID_LIB
 237     - wxNO_QA_LIB
 238     - wxNO_RICHTEXT_LIB
 239     - wxNO_WEBVIEW_LIB
 240     - wxNO_XML_LIB
 241     - wxNO_REGEX_LIB
 242     - wxNO_EXPAT_LIB
 243     - wxNO_JPEG_LIB
 244     - wxNO_PNG_LIB
 245     - wxNO_TIFF_LIB
 246     - wxNO_ZLIB_LIB
 247
 248 Notice that the base library is always included and the core is always included
 249 for the GUI applications (i.e. those which don't define @c wxUSE_GUI as 0).
 250
 251
 252 @section page_cppconst_miscellaneous Miscellaneous
 253
 254 @beginDefList
 255 @itemdef{__WXWINDOWS__,
 256         always defined in wxWidgets applications, see also wxCHECK_VERSION}
 257 @itemdef{wxDEBUG_LEVEL, defined as 1 by default, may be pre-defined as 0 before
 258         including wxWidgets headers to disable generation of any code at all
 259         for the assertion macros, see @ref overview_debugging}
 260 @itemdef{__WXDEBUG__, defined if wxDEBUG_LEVEL is 1 or more, undefined otherwise}
 261 @itemdef{wxUSE_XXX,
 262         if defined as 1, feature XXX is active, see the
 263         @ref page_wxusedef (the symbols of this form are always defined,
 264         use @if_ and not @ifdef_ to test for them)}
 265 @itemdef{WX_PRECOMP,
 266         is defined if precompiled headers (PCH) are in use. In
 267         this case, @c wx/wxprec.h includes @c wx/wx.h which, in turn,
 268         includes a number of wxWidgets headers thus making it unnecessary to include
 269         them explicitly. However if this is not defined, you do need to include them
 270         and so the usual idiom which allows to support both cases is to first include
 271         @c wx/wxprec.h} and then, inside @ifndef_ WX_PRECOMP, individual
 272         headers you need.}
 273 @itemdef{_UNICODE and UNICODE, both are defined if wxUSE_UNICODE is set to @c 1}
 274 @itemdef{wxUSE_GUI,
 275         this particular feature test macro is defined to 1
 276         when compiling or using the library with the GUI features activated,
 277         if it is defined as @c 0, only wxBase is available.}
 278 @itemdef{wxUSE_BASE,
 279         only used by wxWidgets internally (defined as 1 when
 280         building wxBase code, either as a standalone library or as part of the
 281         monolithic wxWidgets library, defined as 0 when building GUI library only)}
 282 @itemdef{wxNO_RTTI, is defined if the compiler RTTI support has been switched off}
 283 @itemdef{wxNO_EXCEPTIONS,
 284         is defined if the compiler support for C++ exceptions has been switched off}
 285 @itemdef{wxNO_THREADS,
 286         if this macro is defined, the compilation options
 287         don't include compiler flags needed for multithreaded code generation. This
 288         implies that wxUSE_THREADS is 0 and also that other (non-wx-based) threading
 289         packages cannot be used neither.}
 290 @itemdef{WXMAKINGDLL_XXX,
 291         used internally and defined when building the
 292         library @c XXX as a DLL; when a monolithic wxWidgets build is used only a
 293         single @c WXMAKINGDLL symbol is defined}
 294 @itemdef{WXUSINGDLL,
 295         defined when compiling code which uses wxWidgets as a DLL/shared library}
 296 @itemdef{WXBUILDING,
 297         defined when building wxWidgets itself, whether as a static or shared library}
 298 @endDefList
 299
 300 */