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