]> git.saurik.com Git - wxWidgets.git/blame - include/wx/platinfo.h
projects / wxWidgets.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
deprecate Create() function in favour of CreateThread(); its name is too generic...
[wxWidgets.git] / include / wx / platinfo.h
CommitLineData
8bb6b2c0
VZ		 1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/platinfo.h
3// Purpose: declaration of the wxPlatformInfo class
4// Author: Francesco Montorsi
5// Modified by:
6// Created: 07.07.2006 (based on wxToolkitInfo)
7// RCS-ID: $Id$
8// Copyright: (c) 2006 Francesco Montorsi
9// License: wxWindows license
10///////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_PLATINFO_H_
13#define _WX_PLATINFO_H_
14
b20ca997 15#include "wx/string.h"
8bb6b2c0
VZ		 16
17// ----------------------------------------------------------------------------
18// wxPlatformInfo
19// ----------------------------------------------------------------------------
20
21// VERY IMPORTANT: when changing these enum values, also change the relative
22// string tables in src/common/platinfo.cpp
23
24
25// families & sub-families of operating systems
26enum wxOperatingSystemId
27{
28 wxOS_UNKNOWN = 0, // returned on error
29
30 wxOS_MAC_OS = 1 << 0, // Apple Mac OS 8/9/X with Mac paths
31 wxOS_MAC_OSX_DARWIN = 1 << 1, // Apple Mac OS X with Unix paths
32 wxOS_MAC = wxOS_MAC_OS|wxOS_MAC_OSX_DARWIN,
33
34 wxOS_WINDOWS_9X = 1 << 2, // Windows 9x family (95/98/ME)
35 wxOS_WINDOWS_NT = 1 << 3, // Windows NT family (NT/2000/XP)
36 wxOS_WINDOWS_MICRO = 1 << 4, // MicroWindows
37 wxOS_WINDOWS_CE = 1 << 5, // Windows CE (Window Mobile)
38 wxOS_WINDOWS = wxOS_WINDOWS_9X |
39 wxOS_WINDOWS_NT |
40 wxOS_WINDOWS_MICRO |
41 wxOS_WINDOWS_CE,
42
43 wxOS_UNIX_LINUX = 1 << 6, // Linux
44 wxOS_UNIX_FREEBSD = 1 << 7, // FreeBSD
45 wxOS_UNIX_OPENBSD = 1 << 8, // OpenBSD
46 wxOS_UNIX_NETBSD = 1 << 9, // NetBSD
47 wxOS_UNIX_SOLARIS = 1 << 10, // SunOS
48 wxOS_UNIX_AIX = 1 << 11, // AIX
49 wxOS_UNIX_HPUX = 1 << 12, // HP/UX
50 wxOS_UNIX = wxOS_UNIX_LINUX |
51 wxOS_UNIX_FREEBSD |
52 wxOS_UNIX_OPENBSD |
53 wxOS_UNIX_NETBSD |
54 wxOS_UNIX_SOLARIS |
55 wxOS_UNIX_AIX |
56 wxOS_UNIX_HPUX,
57
58 // 1<<13 and 1<<14 available for other Unix flavours
59
60 wxOS_DOS = 1 << 15, // Microsoft DOS
027fe16c
VZ		 61 wxOS_OS2 = 1 << 16, // OS/2
62
63 wxOS_PALM_OS = 1 << 17, // Pure Palm OS
64 wxOS_PALM_LINUX = 1 << 18, // Palm over linux
3be25921 65 wxOS_PALM = wxOS_PALM_OS | wxOS_PALM_LINUX
8bb6b2c0
VZ		 66};
67
68// list of wxWidgets ports - some of them can be used with more than
69// a single toolkit.
70enum wxPortId
71{
72 wxPORT_UNKNOWN = 0, // returned on error
73
74 wxPORT_BASE = 1 << 0, // wxBase, no native toolkit used
75
76 wxPORT_MSW = 1 << 1, // wxMSW, native toolkit is Windows API
77 wxPORT_MOTIF = 1 << 2, // wxMotif, using [Open]Motif or Lesstif
78 wxPORT_GTK = 1 << 3, // wxGTK, using GTK+ 1.x, 2.x, GPE or Maemo
79 wxPORT_MGL = 1 << 4, // wxMGL, using wxUniversal
80 wxPORT_X11 = 1 << 5, // wxX11, using wxUniversal
8ab09e65
SN		 81 wxPORT_PM = 1 << 6, // wxOS2, using OS/2 Presentation Manager
82 wxPORT_OS2 = wxPORT_PM, // wxOS2, using OS/2 Presentation Manager
ac9e3f1f
SC		 83 wxPORT_MAC = 1 << 7, // wxOSX (former wxMac), using Cocoa, Carbon or iPhone API
84 wxPORT_OSX = wxPORT_MAC, // wxOSX, using Cocoa, Carbon or iPhone API
8bb6b2c0
VZ		 85 wxPORT_COCOA = 1 << 8, // wxCocoa, using Cocoa NextStep/Mac API
86 wxPORT_WINCE = 1 << 9, // wxWinCE, toolkit is WinCE SDK API
b3c86150
VS		 87 wxPORT_PALMOS = 1 << 10, // wxPalmOS, toolkit is PalmOS API
88 wxPORT_DFB = 1 << 11 // wxDFB, using wxUniversal
8bb6b2c0
VZ		 89};
90
91// architecture of the operating system
92// (regardless of the build environment of wxWidgets library - see
93// wxIsPlatform64bit documentation for more info)
94enum wxArchitecture
95{
96 wxARCH_INVALID = -1, // returned on error
97
98 wxARCH_32, // 32 bit
99 wxARCH_64,
100
101 wxARCH_MAX
102};
103
104
105// endian-ness of the machine
106enum wxEndianness
107{
108 wxENDIAN_INVALID = -1, // returned on error
109
110 wxENDIAN_BIG, // 4321
111 wxENDIAN_LITTLE, // 1234
112 wxENDIAN_PDP, // 3412
113
114 wxENDIAN_MAX
115};
116
117// Information about the toolkit that the app is running under and some basic
118// platform and architecture info
119class WXDLLIMPEXP_BASE wxPlatformInfo
120{
121public:
122 wxPlatformInfo();
123 wxPlatformInfo(wxPortId pid,
124 int tkMajor = -1, int tkMinor = -1,
125 wxOperatingSystemId id = wxOS_UNKNOWN,
126 int osMajor = -1, int osMinor = -1,
127 wxArchitecture arch = wxARCH_INVALID,
b98bd6af
VS		 128 wxEndianness endian = wxENDIAN_INVALID,
129 bool usingUniversal = false);
8bb6b2c0
VZ		 130
131 // default copy ctor, assignment operator and dtor are ok
132
133 bool operator==(const wxPlatformInfo &t) const;
134
135 bool operator!=(const wxPlatformInfo &t) const
136 { return !(*this == t); }
137
449090b5
VZ		 138 // Gets a wxPlatformInfo already initialized with the values for
139 // the currently running platform.
140 static const wxPlatformInfo& Get();
141
142
8bb6b2c0
VZ		 143
144 // string -> enum conversions
145 // ---------------------------------
146
147 static wxOperatingSystemId GetOperatingSystemId(const wxString &name);
148 static wxPortId GetPortId(const wxString &portname);
149
150 static wxArchitecture GetArch(const wxString &arch);
151 static wxEndianness GetEndianness(const wxString &end);
152
153 // enum -> string conversions
154 // ---------------------------------
155
156 static wxString GetOperatingSystemFamilyName(wxOperatingSystemId os);
157 static wxString GetOperatingSystemIdName(wxOperatingSystemId os);
b98bd6af
VS		 158 static wxString GetPortIdName(wxPortId port, bool usingUniversal);
159 static wxString GetPortIdShortName(wxPortId port, bool usingUniversal);
8bb6b2c0
VZ		 160
161 static wxString GetArchName(wxArchitecture arch);
162 static wxString GetEndiannessName(wxEndianness end);
163
164 // getters
165 // -----------------
166
167 int GetOSMajorVersion() const
168 { return m_osVersionMajor; }
169 int GetOSMinorVersion() const
170 { return m_osVersionMinor; }
171
a24db82d
VZ		 172 // return true if the OS version >= major.minor
173 bool CheckOSVersion(int major, int minor) const
174 {
175 return DoCheckVersion(GetOSMajorVersion(),
176 GetOSMinorVersion(),
177 major,
178 minor);
179 }
180
8bb6b2c0
VZ		 181 int GetToolkitMajorVersion() const
182 { return m_tkVersionMajor; }
183 int GetToolkitMinorVersion() const
184 { return m_tkVersionMinor; }
185
a24db82d
VZ		 186 bool CheckToolkitVersion(int major, int minor) const
187 {
188 return DoCheckVersion(GetToolkitMajorVersion(),
189 GetToolkitMinorVersion(),
190 major,
191 minor);
192 }
193
b98bd6af
VS		 194 bool IsUsingUniversalWidgets() const
195 { return m_usingUniversal; }
196
8bb6b2c0
VZ		 197 wxOperatingSystemId GetOperatingSystemId() const
198 { return m_os; }
199 wxPortId GetPortId() const
200 { return m_port; }
201 wxArchitecture GetArchitecture() const
202 { return m_arch; }
203 wxEndianness GetEndianness() const
204 { return m_endian; }
205
206
207 // string getters
208 // -----------------
209
210 wxString GetOperatingSystemFamilyName() const
211 { return GetOperatingSystemFamilyName(m_os); }
212 wxString GetOperatingSystemIdName() const
213 { return GetOperatingSystemIdName(m_os); }
214 wxString GetPortIdName() const
b98bd6af 215 { return GetPortIdName(m_port, m_usingUniversal); }
8bb6b2c0 216 wxString GetPortIdShortName() const
b98bd6af 217 { return GetPortIdShortName(m_port, m_usingUniversal); }
8bb6b2c0
VZ		 218 wxString GetArchName() const
219 { return GetArchName(m_arch); }
220 wxString GetEndiannessName() const
221 { return GetEndiannessName(m_endian); }
222
223 // setters
224 // -----------------
225
226 void SetOSVersion(int major, int minor)
227 { m_osVersionMajor=major; m_osVersionMinor=minor; }
228 void SetToolkitVersion(int major, int minor)
229 { m_tkVersionMajor=major; m_tkVersionMinor=minor; }
230
231 void SetOperatingSystemId(wxOperatingSystemId n)
a24db82d 232 { m_os = n; }
8bb6b2c0 233 void SetPortId(wxPortId n)
a24db82d 234 { m_port = n; }
8bb6b2c0 235 void SetArchitecture(wxArchitecture n)
a24db82d 236 { m_arch = n; }
8bb6b2c0 237 void SetEndianness(wxEndianness n)
a24db82d 238 { m_endian = n; }
8bb6b2c0
VZ		 239
240 // miscellaneous
241 // -----------------
242
243 bool IsOk() const
244 {
245 return m_osVersionMajor != -1 && m_osVersionMinor != -1 &&
246 m_os != wxOS_UNKNOWN &&
247 m_tkVersionMajor != -1 && m_tkVersionMinor != -1 &&
248 m_port != wxPORT_UNKNOWN &&
249 m_arch != wxARCH_INVALID && m_endian != wxENDIAN_INVALID;
250 }
251
8bb6b2c0
VZ		 252
253protected:
a24db82d
VZ		 254 static bool DoCheckVersion(int majorCur, int minorCur, int major, int minor)
255 {
256 return majorCur > major || (majorCur == major && minorCur >= minor);
257 }
258
449090b5
VZ		 259 void InitForCurrentPlatform();
260
261
8bb6b2c0
VZ		 262 // OS stuff
263 // -----------------
264
265 // Version of the OS; valid if m_os != wxOS_UNKNOWN
266 // (-1 means not initialized yet).
a24db82d
VZ		 267 int m_osVersionMajor,
268 m_osVersionMinor;
8bb6b2c0
VZ		 269
270 // Operating system ID.
271 wxOperatingSystemId m_os;
272
273
274 // toolkit
275 // -----------------
276
277 // Version of the underlying toolkit
278 // (-1 means not initialized yet; zero means no toolkit).
279 int m_tkVersionMajor, m_tkVersionMinor;
280
281 // name of the wxWidgets port
282 wxPortId m_port;
283
b98bd6af
VS		 284 // is using wxUniversal widgets?
285 bool m_usingUniversal;
286
8bb6b2c0
VZ		 287
288 // others
289 // -----------------
290
291 // architecture of the OS
292 wxArchitecture m_arch;
293
294 // endianness of the machine
295 wxEndianness m_endian;
296};
297
298
299#if WXWIN_COMPATIBILITY_2_6
300 #define wxUNKNOWN_PLATFORM wxOS_UNKNOWN
301 #define wxUnix wxOS_UNIX
302 #define wxWin95 wxOS_WINDOWS_9X
303 #define wxWIN95 wxOS_WINDOWS_9X
304 #define wxWINDOWS_NT wxOS_WINDOWS_NT
305 #define wxMSW wxOS_WINDOWS
306 #define wxWinCE wxOS_WINDOWS_CE
307 #define wxWIN32S wxOS_WINDOWS_9X
308
309 #define wxPalmOS wxPORT_PALMOS
310 #define wxOS2 wxPORT_OS2
311 #define wxMGL wxPORT_MGL
312 #define wxCocoa wxPORT_MAC
313 #define wxMac wxPORT_MAC
314 #define wxMotif wxPORT_MOTIF
315 #define wxGTK wxPORT_GTK
316#endif // WXWIN_COMPATIBILITY_2_6
317
318#endif // _WX_PLATINFO_H_
wxWidgets (Impactor)