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