]> git.saurik.com Git - wxWidgets.git/blob - include/wx/platform.h
More parameter variable names fixed to make them more readable by replacing abbreviat...
[wxWidgets.git] / include / wx / platform.h
1 /**
2 * Name: wx/platform.h
3 * Purpose: define the OS and compiler identification macros
4 * Author: Vadim Zeitlin
5 * Modified by:
6 * Created: 29.10.01 (extracted from wx/defs.h)
7 * RCS-ID: $Id$
8 * Copyright: (c) 1997-2001 wxWidgets team
9 * Licence: wxWindows licence
10 */
11
12 /* THIS IS A C FILE, DON'T USE C++ FEATURES (IN PARTICULAR COMMENTS) IN IT */
13
14 #ifndef _WX_PLATFORM_H_
15 #define _WX_PLATFORM_H_
16
17
18 /*
19 Codewarrior doesn't define any Windows symbols until some headers
20 are included
21 */
22 #if __MWERKS__
23 # include <stddef.h>
24 #endif
25
26 /*
27 WXMAC variants
28 __WXMAC_CLASSIC__ means ppc non-carbon builds, __WXMAC_CARBON__ means
29 carbon API available (mach or cfm builds) , __WXMAC_OSX__ means mach-o
30 builds, running under 10.2 + only
31 */
32 #ifdef __WXMAC__
33 # if defined(__MACH__)
34 # define __WXMAC_OSX__
35 # define __WXMAC_CARBON__
36 # ifdef __WXMAC_XCODE__
37 # include "wx/mac/carbon/config_xcode.h"
38 # endif
39 # else
40 # if TARGET_CARBON
41 # define __WXMAC_CARBON__
42 # else
43 # define __WXMAC_CLASSIC__
44 # endif
45 # endif
46 #endif
47
48 /*
49 __WXOSX__ is a common define to wxMac (Carbon) and wxCocoa ports under OS X.
50 */
51 #if defined(__WXMAC_OSX__) || defined(__WXCOCOA__)
52 # define __WXOSX__
53 #endif
54
55 /*
56 first define Windows symbols if they're not defined on the command line: we
57 can autodetect everything we need if _WIN32 is defined
58 */
59 #if defined(__CYGWIN32__) && !defined(__WXMOTIF__) && !defined(__WXGTK__) \
60 && !defined(__WXX11__)
61 /* for Cygwin, default to wxMSW unless otherwise specified */
62 # ifndef __WXMSW__
63 # define __WXMSW__
64 # endif
65
66 # ifndef _WIN32
67 # define _WIN32
68 # endif
69
70 # ifndef WIN32
71 # define WIN32
72 # endif
73 #endif
74
75 #if defined(__PALMOS__)
76 # ifndef __WXPALMOS__
77 # define __WXPALMOS__
78 # endif
79 # ifdef __WXMSW__
80 # undef __WXMSW__
81 # endif
82 # ifdef __WINDOWS__
83 # undef __WINDOWS__
84 # endif
85 # ifdef __WIN32__
86 # undef __WIN32__
87 # endif
88 # ifdef WIN32
89 # undef WIN32
90 # endif
91 # ifdef _WIN32
92 # undef _WIN32
93 # endif
94 #endif
95
96 #if defined(_WIN64)
97 # ifndef _WIN32
98 /*
99 a lot of code (mistakenly) uses #ifdef _WIN32 to either test for
100 Windows or to test for !__WIN16__, so we must define _WIN32 for
101 Win64 as well to ensure that the existing code continues to work.
102 */
103 # define _WIN32
104 # endif /* !_WIN32 */
105
106 # ifndef __WIN64__
107 # define __WIN64__
108 # endif /* !__WIN64__ */
109 #endif /* _WIN64 */
110
111 #if (defined(_WIN32) || defined(WIN32) || defined(__NT__) || defined(__WXWINCE__)) \
112 && !defined(__WXMOTIF__) && !defined(__WXGTK__) && !defined(__WXX11__)
113 # ifndef __WXMSW__
114 # define __WXMSW__
115 # endif
116
117 # ifndef __WIN32__
118 # define __WIN32__
119 # endif
120
121 /*
122 The library user may override the default setting of WINVER by defining
123 it in his own makefile or project file -- if it is defined, we don't
124 touch it at all.
125
126 It makes sense to define WINVER as:
127 - either some lowish value (e.g. 0x0302) to not even compile in the
128 features not available in Windows version lower than some given
129 one
130 - or to a higher value than the one used by default for the given
131 compiler if you updated its headers to newer version of Platform
132 SDK, e.g. VC6 ships with 0x0400 headers by default but may also
133 work with 0x0500 headers and beyond
134 */
135 # ifndef WINVER
136 # if defined(_MSC_VER) && _MSC_VER < 1300
137 /*
138 VC6 defines some stuff in its default headers which is normally
139 only present if WINVER >= 0x0500 (FLASHW_XXX constants) which
140 means that our usual tests not involving WINVER sometimes fail
141 with it, hence explicitly define a lower WINVER value for it.
142 */
143 # define WINVER 0x0400
144 # elif defined(__DMC__)
145 /*
146 Digital Mars is distributed with a little outdated headers.
147 */
148 # define WINVER 0x0400
149 # else /* !VC++ 6 */
150 /*
151 see MSDN for the description of possible WINVER values, this one
152 is the highest one defined right now (Windows Server 2003) and
153 we use it unless it was explicitly overridden by the user to
154 disable recent features support as we check for all of the
155 features we use which could be not available on earlier Windows
156 systems during run-time anyhow, so there is almost no
157 disadvantage in using it.
158 */
159 # define WINVER 0x0502
160 # endif /* VC++ 6/!VC++6 */
161 # endif
162
163 /* Win95 means Win95-style UI, i.e. Win9x/NT 4+ */
164 # if !defined(__WIN95__) && (WINVER >= 0x0400)
165 # define __WIN95__
166 # endif
167 #endif /* Win32 */
168
169 #if defined(__WXMSW__) || defined(__WIN32__)
170 # if !defined(__WINDOWS__)
171 # define __WINDOWS__
172 # endif
173 #endif
174
175 #ifdef __WINE__
176 # ifndef __WIN95__
177 # define __WIN95__
178 # endif
179 #endif /* WINE */
180
181 /* detect MS SmartPhone */
182 #if defined( WIN32_PLATFORM_WFSP )
183 # ifndef __SMARTPHONE__
184 # define __SMARTPHONE__
185 # endif
186 # ifndef __WXWINCE__
187 # define __WXWINCE__
188 # endif
189 #endif
190
191 /* detect PocketPC */
192 #if defined( WIN32_PLATFORM_PSPC )
193 # ifndef __POCKETPC__
194 # define __POCKETPC__
195 # endif
196 # ifndef __WXWINCE__
197 # define __WXWINCE__
198 # endif
199 #endif
200
201 /* detect Standard WinCE SDK */
202 #if defined( WCE_PLATFORM_STANDARDSDK )
203 # ifndef __WINCE_STANDARDSDK__
204 # define __WINCE_STANDARDSDK__
205 # endif
206 # ifndef __WXWINCE__
207 # define __WXWINCE__
208 # endif
209 #endif
210
211 #if defined(_WIN32_WCE) && !defined(WIN32_PLATFORM_WFSP) && !defined(WIN32_PLATFORM_PSPC)
212 # if (_WIN32_WCE >= 400)
213 # ifndef __WINCE_NET__
214 # define __WINCE_NET__
215 # endif
216 # elif (_WIN32_WCE >= 200)
217 # ifndef __HANDHELDPC__
218 # define __HANDHELDPC__
219 # endif
220 # endif
221 # ifndef __WXWINCE__
222 # define __WXWINCE__
223 # endif
224 #endif
225
226 /*
227 Include wx/setup.h for the Unix platform defines generated by configure and
228 the library compilation options
229 */
230 #include "wx/setup.h"
231
232 /* check the consistency of the settings in setup.h */
233 #include "wx/chkconf.h"
234
235 /*
236 adjust the Unicode setting: wxUSE_UNICODE should be defined as 0 or 1
237 and is used by wxWidgets, _UNICODE and/or UNICODE may be defined or used by
238 the system headers so bring these settings in sync
239 */
240
241 /* set wxUSE_UNICODE to 1 if UNICODE or _UNICODE is defined */
242 #if defined(_UNICODE) || defined(UNICODE)
243 # undef wxUSE_UNICODE
244 # define wxUSE_UNICODE 1
245 #else /* !UNICODE */
246 # ifndef wxUSE_UNICODE
247 # define wxUSE_UNICODE 0
248 # endif
249 #endif /* UNICODE/!UNICODE */
250
251 /* and vice versa: define UNICODE and _UNICODE if wxUSE_UNICODE is 1 */
252 #if wxUSE_UNICODE
253 # ifndef _UNICODE
254 # define _UNICODE
255 # endif
256 # ifndef UNICODE
257 # define UNICODE
258 # endif
259 #endif /* wxUSE_UNICODE */
260
261 #if defined( __MWERKS__ ) && !defined(__INTEL__)
262 // otherwise MSL headers bring in WIN32 dependant APIs
263 #undef UNICODE
264 #endif
265 /*
266 some compilers don't support iostream.h any longer, while some of theme
267 are not updated with <iostream> yet, so override the users setting here
268 in such case.
269 */
270 #if defined(_MSC_VER) && (_MSC_VER >= 1310)
271 # undef wxUSE_IOSTREAMH
272 # define wxUSE_IOSTREAMH 0
273 #elif defined(__DMC__) || defined(__WATCOMC__)
274 # undef wxUSE_IOSTREAMH
275 # define wxUSE_IOSTREAMH 1
276 #elif defined(__MINGW32__)
277 # undef wxUSE_IOSTREAMH
278 # define wxUSE_IOSTREAMH 0
279 #endif /* compilers with/without iostream.h */
280
281 /*
282 old C++ headers (like <iostream.h>) declare classes in the global namespace
283 while the new, standard ones (like <iostream>) do it in std:: namespace
284
285 using this macro allows constuctions like "wxSTD iostream" to work in
286 either case
287 */
288 #if !wxUSE_IOSTREAMH
289 # define wxSTD std::
290 #else
291 # define wxSTD
292 #endif
293
294 /*
295 OS: first of all, test for MS-DOS platform. We must do this before testing
296 for Unix, because DJGPP compiler defines __unix__ under MS-DOS
297 */
298 #if defined(__GO32__) || defined(__DJGPP__) || defined(__DOS__)
299 # ifndef __DOS__
300 # define __DOS__
301 # endif
302 /* size_t is the same as unsigned int for Watcom 11 compiler, */
303 /* so define it if it hadn't been done by configure yet */
304 # if !defined(wxSIZE_T_IS_UINT) && !defined(wxSIZE_T_IS_ULONG)
305 # ifdef __WATCOMC__
306 # define wxSIZE_T_IS_UINT
307 # endif
308 # ifdef __DJGPP__
309 # define wxSIZE_T_IS_ULONG
310 # endif
311 # endif
312
313 /*
314 OS: then test for generic Unix defines, then for particular flavours and
315 finally for Unix-like systems
316 */
317 #elif defined(__UNIX__) || defined(__unix) || defined(__unix__) || \
318 defined(____SVR4____) || defined(__LINUX__) || defined(__sgi) || \
319 defined(__hpux) || defined(sun) || defined(__SUN__) || defined(_AIX) || \
320 defined(__EMX__) || defined(__VMS) || defined(__BEOS__)
321
322 # define __UNIX_LIKE__
323
324 /* Helps SGI compilation, apparently */
325 # ifdef __SGI__
326 # ifdef __GNUG__
327 # define __need_wchar_t
328 # else /* !gcc */
329 /*
330 Note I use the term __SGI_CC__ for both cc and CC, its not a good
331 idea to mix gcc and cc/CC, the name mangling is different
332 */
333 # define __SGI_CC__
334 # endif /* gcc/!gcc */
335 # endif /* SGI */
336
337 # if defined(sun) || defined(__SUN__)
338 # ifndef __GNUG__
339 # ifndef __SUNCC__
340 # define __SUNCC__
341 # endif /* Sun CC */
342 # endif
343 # endif /* Sun */
344
345 # ifdef __EMX__
346 # define OS2EMX_PLAIN_CHAR
347 # endif
348
349 /* define __HPUX__ for HP-UX where standard macro is __hpux */
350 # if defined(__hpux) && !defined(__HPUX__)
351 # define __HPUX__
352 # endif /* HP-UX */
353
354 # if defined(__CYGWIN__) || defined(__WINE__)
355 # if !defined(wxSIZE_T_IS_UINT)
356 # define wxSIZE_T_IS_UINT
357 # endif
358 # endif
359 #elif defined(applec) || \
360 defined(THINK_C) || \
361 (defined(__MWERKS__) && !defined(__INTEL__))
362 /* MacOS */
363 # if !defined(wxSIZE_T_IS_UINT) && !defined(wxSIZE_T_IS_ULONG)
364 # define wxSIZE_T_IS_ULONG
365 # endif
366 #elif defined(__WXMAC__) && defined(__APPLE__)
367 /* Mac OS X */
368 # define __UNIX_LIKE__
369
370 /*
371 These defines are needed when compiling using Project Builder
372 with a non generated setup0.h
373 */
374 # ifndef __UNIX__
375 # define __UNIX__ 1
376 # endif
377 # ifndef __BSD__
378 # define __BSD__ 1
379 # endif
380 # ifndef __DARWIN__
381 # define __DARWIN__ 1
382 # endif
383 # ifndef __POWERPC__
384 # define __POWERPC__ 1
385 # endif
386 # ifndef TARGET_CARBON
387 # define TARGET_CARBON 1
388 # endif
389
390 # if !defined(wxSIZE_T_IS_UINT) && !defined(wxSIZE_T_IS_ULONG)
391 # define wxSIZE_T_IS_ULONG
392 # endif
393 /*
394 Some code has been added to workaround defects(?) in the
395 bundled gcc compiler. These corrections are identified by
396 __DARWIN__ for Darwin related corrections (wxMac, wxMotif)
397 */
398 #elif defined(__OS2__)
399 # if defined(__IBMCPP__)
400 # define __VISAGEAVER__ __IBMCPP__
401 # endif
402 # ifndef __WXOS2__
403 # define __WXOS2__
404 # endif
405 # ifndef __WXPM__
406 # define __WXPM__
407 # endif
408
409 /* Place other OS/2 compiler environment defines here */
410 # if defined(__VISAGECPP__)
411 /* VisualAge is the only thing that understands _Optlink */
412 # define LINKAGEMODE _Optlink
413 # endif
414 # define wxSIZE_T_IS_UINT
415
416 #elif defined(__PALMOS__)
417 # ifdef __WIN32__
418 # error "__WIN32__ should not be defined for PalmOS"
419 # endif
420 # ifdef __WINDOWS__
421 # error "__WINDOWS__ should not be defined for PalmOS"
422 # endif
423 # ifdef __WXMSW__
424 # error "__WXMSW__ should not be defined for PalmOS"
425 # endif
426
427 #else /* Windows */
428 # ifndef __WINDOWS__
429 # define __WINDOWS__
430 # endif /* Windows */
431
432 /* to be changed for Win64! */
433 # ifndef __WIN32__
434 # error "__WIN32__ should be defined for Win32 and Win64, Win16 is not supported"
435 # endif
436
437 /*
438 define another standard symbol for Microsoft Visual C++: the standard
439 one (_MSC_VER) is also defined by Metrowerks compiler
440 */
441 # if defined(_MSC_VER) && !defined(__MWERKS__)
442 # define __VISUALC__ _MSC_VER
443 # elif defined(__BCPLUSPLUS__) && !defined(__BORLANDC__)
444 # define __BORLANDC__
445 # elif defined(__WATCOMC__)
446 # elif defined(__SC__)
447 # define __SYMANTECC__
448 # endif /* compiler */
449
450 /* size_t is the same as unsigned int for all Windows compilers we know, */
451 /* so define it if it hadn't been done by configure yet */
452 # if !defined(wxSIZE_T_IS_UINT) && !defined(wxSIZE_T_IS_ULONG)
453 # define wxSIZE_T_IS_UINT
454 # endif
455 #endif /* OS */
456
457 /*
458 if we're on a Unix system but didn't use configure (so that setup.h didn't
459 define __UNIX__), do define __UNIX__ now
460 */
461 #if !defined(__UNIX__) && defined(__UNIX_LIKE__)
462 # define __UNIX__
463 #endif /* Unix */
464
465 #if defined(__WXMOTIF__) || defined(__WXX11__)
466 # define __X__
467 #endif
468
469 #ifdef __SC__
470 # ifdef __DMC__
471 # define __DIGITALMARS__
472 # else
473 # define __SYMANTEC__
474 # endif
475 #endif
476
477 /* Force linking against required libraries under Windows CE: */
478 #ifdef __WXWINCE__
479 # include "wx/msw/wince/libraries.h"
480 #endif
481
482 /*
483 This macro can be used to test the gcc version and can be used like this:
484
485 # if wxCHECK_GCC_VERSION(3, 1)
486 ... we have gcc 3.1 or later ...
487 # else
488 ... no gcc at all or gcc < 3.1 ...
489 # endif
490 */
491 #define wxCHECK_GCC_VERSION( major, minor ) \
492 ( defined(__GNUC__) && defined(__GNUC_MINOR__) \
493 && ( ( __GNUC__ > (major) ) \
494 || ( __GNUC__ == (major) && __GNUC_MINOR__ >= (minor) ) ) )
495
496 /*
497 This macro can be used to check that the version of mingw32 compiler is
498 at least maj.min
499 */
500 #if defined(__WXPALMOS__)
501 # include "wx/palmos/gccpriv.h"
502 #elif ( defined( __GNUWIN32__ ) || defined( __MINGW32__ ) || \
503 defined( __CYGWIN__ ) || \
504 (defined(__WATCOMC__) && __WATCOMC__ >= 1200) ) && \
505 !defined(__DOS__) && !defined(__WXMOTIF__) && !defined(__WXGTK__) && !defined(__WXX11__)
506 # include "wx/msw/gccpriv.h"
507 #else
508 # undef wxCHECK_W32API_VERSION
509 # define wxCHECK_W32API_VERSION(maj, min) (0)
510 #endif
511
512 #if defined (__WXMSW__)
513 # if !defined(__WATCOMC__)
514 # define wxHAVE_RAW_BITMAP
515 # endif
516 #endif
517
518 #if defined (__WXMAC__)
519 # ifndef WORDS_BIGENDIAN
520 # define WORDS_BIGENDIAN 1
521 # endif
522 #endif
523
524 /* Choose which method we will use for updating menus
525 * - in OnIdle, or when we receive a wxEVT_MENU_OPEN event.
526 * Presently, only Windows and GTK+ support wxEVT_MENU_OPEN.
527 */
528 #ifndef wxUSE_IDLEMENUUPDATES
529 # if (defined(__WXMSW__) || defined(__WXGTK__)) && !defined(__WXUNIVERSAL__)
530 # define wxUSE_IDLEMENUUPDATES 0
531 # else
532 # define wxUSE_IDLEMENUUPDATES 1
533 # endif
534 #endif
535
536 /*
537 * Define symbols that are not yet in
538 * configure or possibly some setup.h files.
539 * They will need to be added.
540 */
541
542 #ifndef wxUSE_FILECONFIG
543 # if wxUSE_CONFIG
544 # define wxUSE_FILECONFIG 1
545 # else
546 # define wxUSE_FILECONFIG 0
547 # endif
548 #endif
549
550 #ifndef wxUSE_HOTKEY
551 # define wxUSE_HOTKEY 0
552 #endif
553
554 #if !defined(wxUSE_WXDIB) && defined(__WXMSW__)
555 # define wxUSE_WXDIB 1
556 #endif
557
558 /*
559 We need AvailabilityMacros.h for ifdefing out things that don't exist on
560 OSX 10.2 and lower
561 FIXME: We need a better way to detect for 10.3 then including a system header
562 */
563 #ifdef __DARWIN__
564 #include <AvailabilityMacros.h>
565 #endif
566
567 #endif /* _WX_PLATFORM_H_ */
568