docs/doxygen/mainpages/const_cpp.h

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