]> 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
rename the ID parameter
[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
61 wxOS_OS2 = 1 << 16 // OS/2
62};
63
64// list of wxWidgets ports - some of them can be used with more than
65// a single toolkit.
66enum wxPortId
67{
68 wxPORT_UNKNOWN = 0, // returned on error
69
70 wxPORT_BASE = 1 << 0, // wxBase, no native toolkit used
71
72 wxPORT_MSW = 1 << 1, // wxMSW, native toolkit is Windows API
73 wxPORT_MOTIF = 1 << 2, // wxMotif, using [Open]Motif or Lesstif
74 wxPORT_GTK = 1 << 3, // wxGTK, using GTK+ 1.x, 2.x, GPE or Maemo
75 wxPORT_MGL = 1 << 4, // wxMGL, using wxUniversal
76 wxPORT_X11 = 1 << 5, // wxX11, using wxUniversal
8ab09e65
SN		 77 wxPORT_PM = 1 << 6, // wxOS2, using OS/2 Presentation Manager
78 wxPORT_OS2 = wxPORT_PM, // wxOS2, using OS/2 Presentation Manager
8bb6b2c0
VZ		 79 wxPORT_MAC = 1 << 7, // wxMac, using Carbon or Classic Mac API
80 wxPORT_COCOA = 1 << 8, // wxCocoa, using Cocoa NextStep/Mac API
81 wxPORT_WINCE = 1 << 9, // wxWinCE, toolkit is WinCE SDK API
b3c86150
VS		 82 wxPORT_PALMOS = 1 << 10, // wxPalmOS, toolkit is PalmOS API
83 wxPORT_DFB = 1 << 11 // wxDFB, using wxUniversal
8bb6b2c0
VZ		 84};
85
86// architecture of the operating system
87// (regardless of the build environment of wxWidgets library - see
88// wxIsPlatform64bit documentation for more info)
89enum wxArchitecture
90{
91 wxARCH_INVALID = -1, // returned on error
92
93 wxARCH_32, // 32 bit
94 wxARCH_64,
95
96 wxARCH_MAX
97};
98
99
100// endian-ness of the machine
101enum wxEndianness
102{
103 wxENDIAN_INVALID = -1, // returned on error
104
105 wxENDIAN_BIG, // 4321
106 wxENDIAN_LITTLE, // 1234
107 wxENDIAN_PDP, // 3412
108
109 wxENDIAN_MAX
110};
111
112// Information about the toolkit that the app is running under and some basic
113// platform and architecture info
114class WXDLLIMPEXP_BASE wxPlatformInfo
115{
116public:
117 wxPlatformInfo();
118 wxPlatformInfo(wxPortId pid,
119 int tkMajor = -1, int tkMinor = -1,
120 wxOperatingSystemId id = wxOS_UNKNOWN,
121 int osMajor = -1, int osMinor = -1,
122 wxArchitecture arch = wxARCH_INVALID,
b98bd6af
VS		 123 wxEndianness endian = wxENDIAN_INVALID,
124 bool usingUniversal = false);
8bb6b2c0
VZ		 125
126 // default copy ctor, assignment operator and dtor are ok
127
128 bool operator==(const wxPlatformInfo &t) const;
129
130 bool operator!=(const wxPlatformInfo &t) const
131 { return !(*this == t); }
132
133
134 // string -> enum conversions
135 // ---------------------------------
136
137 static wxOperatingSystemId GetOperatingSystemId(const wxString &name);
138 static wxPortId GetPortId(const wxString &portname);
139
140 static wxArchitecture GetArch(const wxString &arch);
141 static wxEndianness GetEndianness(const wxString &end);
142
143 // enum -> string conversions
144 // ---------------------------------
145
146 static wxString GetOperatingSystemFamilyName(wxOperatingSystemId os);
147 static wxString GetOperatingSystemIdName(wxOperatingSystemId os);
b98bd6af
VS		 148 static wxString GetPortIdName(wxPortId port, bool usingUniversal);
149 static wxString GetPortIdShortName(wxPortId port, bool usingUniversal);
8bb6b2c0
VZ		 150
151 static wxString GetArchName(wxArchitecture arch);
152 static wxString GetEndiannessName(wxEndianness end);
153
154 // getters
155 // -----------------
156
157 int GetOSMajorVersion() const
158 { return m_osVersionMajor; }
159 int GetOSMinorVersion() const
160 { return m_osVersionMinor; }
161
a24db82d
VZ		 162 // return true if the OS version >= major.minor
163 bool CheckOSVersion(int major, int minor) const
164 {
165 return DoCheckVersion(GetOSMajorVersion(),
166 GetOSMinorVersion(),
167 major,
168 minor);
169 }
170
8bb6b2c0
VZ		 171 int GetToolkitMajorVersion() const
172 { return m_tkVersionMajor; }
173 int GetToolkitMinorVersion() const
174 { return m_tkVersionMinor; }
175
a24db82d
VZ		 176 bool CheckToolkitVersion(int major, int minor) const
177 {
178 return DoCheckVersion(GetToolkitMajorVersion(),
179 GetToolkitMinorVersion(),
180 major,
181 minor);
182 }
183
b98bd6af
VS		 184 bool IsUsingUniversalWidgets() const
185 { return m_usingUniversal; }
186
8bb6b2c0
VZ		 187 wxOperatingSystemId GetOperatingSystemId() const
188 { return m_os; }
189 wxPortId GetPortId() const
190 { return m_port; }
191 wxArchitecture GetArchitecture() const
192 { return m_arch; }
193 wxEndianness GetEndianness() const
194 { return m_endian; }
195
196
197 // string getters
198 // -----------------
199
200 wxString GetOperatingSystemFamilyName() const
201 { return GetOperatingSystemFamilyName(m_os); }
202 wxString GetOperatingSystemIdName() const
203 { return GetOperatingSystemIdName(m_os); }
204 wxString GetPortIdName() const
b98bd6af 205 { return GetPortIdName(m_port, m_usingUniversal); }
8bb6b2c0 206 wxString GetPortIdShortName() const
b98bd6af 207 { return GetPortIdShortName(m_port, m_usingUniversal); }
8bb6b2c0
VZ		 208 wxString GetArchName() const
209 { return GetArchName(m_arch); }
210 wxString GetEndiannessName() const
211 { return GetEndiannessName(m_endian); }
212
213 // setters
214 // -----------------
215
216 void SetOSVersion(int major, int minor)
217 { m_osVersionMajor=major; m_osVersionMinor=minor; }
218 void SetToolkitVersion(int major, int minor)
219 { m_tkVersionMajor=major; m_tkVersionMinor=minor; }
220
221 void SetOperatingSystemId(wxOperatingSystemId n)
a24db82d 222 { m_os = n; }
8bb6b2c0 223 void SetPortId(wxPortId n)
a24db82d 224 { m_port = n; }
8bb6b2c0 225 void SetArchitecture(wxArchitecture n)
a24db82d 226 { m_arch = n; }
8bb6b2c0 227 void SetEndianness(wxEndianness n)
a24db82d 228 { m_endian = n; }
8bb6b2c0
VZ		 229
230 // miscellaneous
231 // -----------------
232
233 bool IsOk() const
234 {
235 return m_osVersionMajor != -1 && m_osVersionMinor != -1 &&
236 m_os != wxOS_UNKNOWN &&
237 m_tkVersionMajor != -1 && m_tkVersionMinor != -1 &&
238 m_port != wxPORT_UNKNOWN &&
239 m_arch != wxARCH_INVALID && m_endian != wxENDIAN_INVALID;
240 }
241
8bb6b2c0
VZ		 242
243protected:
a24db82d
VZ		 244 static bool DoCheckVersion(int majorCur, int minorCur, int major, int minor)
245 {
246 return majorCur > major || (majorCur == major && minorCur >= minor);
247 }
248
8bb6b2c0
VZ		 249 // OS stuff
250 // -----------------
251
252 // Version of the OS; valid if m_os != wxOS_UNKNOWN
253 // (-1 means not initialized yet).
a24db82d
VZ		 254 int m_osVersionMajor,
255 m_osVersionMinor;
8bb6b2c0
VZ		 256
257 // Operating system ID.
258 wxOperatingSystemId m_os;
259
260
261 // toolkit
262 // -----------------
263
264 // Version of the underlying toolkit
265 // (-1 means not initialized yet; zero means no toolkit).
266 int m_tkVersionMajor, m_tkVersionMinor;
267
268 // name of the wxWidgets port
269 wxPortId m_port;
270
b98bd6af
VS		 271 // is using wxUniversal widgets?
272 bool m_usingUniversal;
273
8bb6b2c0
VZ		 274
275 // others
276 // -----------------
277
278 // architecture of the OS
279 wxArchitecture m_arch;
280
281 // endianness of the machine
282 wxEndianness m_endian;
283};
284
285
286#if WXWIN_COMPATIBILITY_2_6
287 #define wxUNKNOWN_PLATFORM wxOS_UNKNOWN
288 #define wxUnix wxOS_UNIX
289 #define wxWin95 wxOS_WINDOWS_9X
290 #define wxWIN95 wxOS_WINDOWS_9X
291 #define wxWINDOWS_NT wxOS_WINDOWS_NT
292 #define wxMSW wxOS_WINDOWS
293 #define wxWinCE wxOS_WINDOWS_CE
294 #define wxWIN32S wxOS_WINDOWS_9X
295
296 #define wxPalmOS wxPORT_PALMOS
297 #define wxOS2 wxPORT_OS2
298 #define wxMGL wxPORT_MGL
299 #define wxCocoa wxPORT_MAC
300 #define wxMac wxPORT_MAC
301 #define wxMotif wxPORT_MOTIF
302 #define wxGTK wxPORT_GTK
303#endif // WXWIN_COMPATIBILITY_2_6
304
305#endif // _WX_PLATINFO_H_
wxWidgets (Impactor)