include/wx/platinfo.h

   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 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_PLATINFO_H_
  13 #define _WX_PLATINFO_H_
  14
  15 #include "wx/string.h"
  16
  17 // ----------------------------------------------------------------------------
  18 // wxPlatformInfo enums & structs
  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
  26 enum 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.
  66 enum 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
  77     wxPORT_PM       = 1 << 6,       // wxOS2, using OS/2 Presentation Manager
  78     wxPORT_OS2      = wxPORT_PM,    // wxOS2, using OS/2 Presentation Manager
  79     wxPORT_MAC      = 1 << 7,       // wxOSX (former wxMac), using Cocoa, Carbon or iPhone API
  80     wxPORT_OSX      = wxPORT_MAC,   // wxOSX, using Cocoa, Carbon or iPhone API
  81     wxPORT_COCOA    = 1 << 8,       // wxCocoa, using Cocoa NextStep/Mac API
  82     wxPORT_WINCE    = 1 << 9,       // wxWinCE, toolkit is WinCE SDK API
  83     wxPORT_DFB      = 1 << 10       // wxDFB, using wxUniversal
  84 };
  85
  86 // architecture of the operating system
  87 // (regardless of the build environment of wxWidgets library - see
  88 // wxIsPlatform64bit documentation for more info)
  89 enum 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
 101 enum 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 // informations about a linux distro returned by the lsb_release utility
 113 struct wxLinuxDistributionInfo
 114 {
 115     wxString Id;
 116     wxString Release;
 117     wxString CodeName;
 118     wxString Description;
 119
 120     bool operator==(const wxLinuxDistributionInfo& ldi) const
 121     {
 122         return Id == ldi.Id &&
 123                Release == ldi.Release &&
 124                CodeName == ldi.CodeName &&
 125                Description == ldi.Description;
 126     }
 127
 128     bool operator!=(const wxLinuxDistributionInfo& ldi) const
 129     { return !(*this == ldi); }
 130 };
 131
 132
 133 // ----------------------------------------------------------------------------
 134 // wxPlatformInfo
 135 // ----------------------------------------------------------------------------
 136
 137 // Information about the toolkit that the app is running under and some basic
 138 // platform and architecture info
 139 class WXDLLIMPEXP_BASE wxPlatformInfo
 140 {
 141 public:
 142     wxPlatformInfo();
 143     wxPlatformInfo(wxPortId pid,
 144                    int tkMajor = -1, int tkMinor = -1,
 145                    wxOperatingSystemId id = wxOS_UNKNOWN,
 146                    int osMajor = -1, int osMinor = -1,
 147                    wxArchitecture arch = wxARCH_INVALID,
 148                    wxEndianness endian = wxENDIAN_INVALID,
 149                    bool usingUniversal = false);
 150
 151     // default copy ctor, assignment operator and dtor are ok
 152
 153     bool operator==(const wxPlatformInfo &t) const;
 154
 155     bool operator!=(const wxPlatformInfo &t) const
 156         { return !(*this == t); }
 157
 158     // Gets a wxPlatformInfo already initialized with the values for
 159     // the currently running platform.
 160     static const wxPlatformInfo& Get();
 161
 162
 163
 164     // string -> enum conversions
 165     // ---------------------------------
 166
 167     static wxOperatingSystemId GetOperatingSystemId(const wxString &name);
 168     static wxPortId GetPortId(const wxString &portname);
 169
 170     static wxArchitecture GetArch(const wxString &arch);
 171     static wxEndianness GetEndianness(const wxString &end);
 172
 173     // enum -> string conversions
 174     // ---------------------------------
 175
 176     static wxString GetOperatingSystemFamilyName(wxOperatingSystemId os);
 177     static wxString GetOperatingSystemIdName(wxOperatingSystemId os);
 178     static wxString GetPortIdName(wxPortId port, bool usingUniversal);
 179     static wxString GetPortIdShortName(wxPortId port, bool usingUniversal);
 180
 181     static wxString GetArchName(wxArchitecture arch);
 182     static wxString GetEndiannessName(wxEndianness end);
 183
 184
 185     // getters
 186     // -----------------
 187
 188     int GetOSMajorVersion() const
 189         { return m_osVersionMajor; }
 190     int GetOSMinorVersion() const
 191         { return m_osVersionMinor; }
 192
 193     // return true if the OS version >= major.minor
 194     bool CheckOSVersion(int major, int minor) const
 195     {
 196         return DoCheckVersion(GetOSMajorVersion(),
 197                               GetOSMinorVersion(),
 198                               major,
 199                               minor);
 200     }
 201
 202     int GetToolkitMajorVersion() const
 203         { return m_tkVersionMajor; }
 204     int GetToolkitMinorVersion() const
 205         { return m_tkVersionMinor; }
 206
 207     bool CheckToolkitVersion(int major, int minor) const
 208     {
 209         return DoCheckVersion(GetToolkitMajorVersion(),
 210                               GetToolkitMinorVersion(),
 211                               major,
 212                               minor);
 213     }
 214
 215     bool IsUsingUniversalWidgets() const
 216         { return m_usingUniversal; }
 217
 218     wxOperatingSystemId GetOperatingSystemId() const
 219         { return m_os; }
 220     wxLinuxDistributionInfo GetLinuxDistributionInfo() const
 221         { return m_ldi; }
 222     wxPortId GetPortId() const
 223         { return m_port; }
 224     wxArchitecture GetArchitecture() const
 225         { return m_arch; }
 226     wxEndianness GetEndianness() const
 227         { return m_endian; }
 228
 229
 230     // string getters
 231     // -----------------
 232
 233     wxString GetOperatingSystemFamilyName() const
 234         { return GetOperatingSystemFamilyName(m_os); }
 235     wxString GetOperatingSystemIdName() const
 236         { return GetOperatingSystemIdName(m_os); }
 237     wxString GetPortIdName() const
 238         { return GetPortIdName(m_port, m_usingUniversal); }
 239     wxString GetPortIdShortName() const
 240         { return GetPortIdShortName(m_port, m_usingUniversal); }
 241     wxString GetArchName() const
 242         { return GetArchName(m_arch); }
 243     wxString GetEndiannessName() const
 244         { return GetEndiannessName(m_endian); }
 245     wxString GetOperatingSystemDescription() const
 246         { return m_osDesc; }
 247     wxString GetDesktopEnvironment() const
 248         { return m_desktopEnv; }
 249
 250     static wxString GetOperatingSystemDirectory();
 251         // doesn't make sense to store inside wxPlatformInfo the OS directory,
 252         // thus this function is static; note that this function simply calls
 253         // wxGetOSDirectory() and is here just to make it easier for the user to
 254         // find it that feature (global functions can be difficult to find in the docs)
 255
 256     // setters
 257     // -----------------
 258
 259     void SetOSVersion(int major, int minor)
 260         { m_osVersionMajor=major; m_osVersionMinor=minor; }
 261     void SetToolkitVersion(int major, int minor)
 262         { m_tkVersionMajor=major; m_tkVersionMinor=minor; }
 263
 264     void SetOperatingSystemId(wxOperatingSystemId n)
 265         { m_os = n; }
 266     void SetOperatingSystemDescription(const wxString& desc)
 267         { m_osDesc = desc; }
 268     void SetPortId(wxPortId n)
 269         { m_port = n; }
 270     void SetArchitecture(wxArchitecture n)
 271         { m_arch = n; }
 272     void SetEndianness(wxEndianness n)
 273         { m_endian = n; }
 274
 275     void SetDesktopEnvironment(const wxString& de)
 276         { m_desktopEnv = de; }
 277     void SetLinuxDistributionInfo(const wxLinuxDistributionInfo& di)
 278         { m_ldi = di; }
 279
 280
 281     // miscellaneous
 282     // -----------------
 283
 284     bool IsOk() const
 285     {
 286         return m_osVersionMajor != -1 && m_osVersionMinor != -1 &&
 287                m_os != wxOS_UNKNOWN &&
 288                !m_osDesc.IsEmpty() &&
 289                m_tkVersionMajor != -1 && m_tkVersionMinor != -1 &&
 290                m_port != wxPORT_UNKNOWN &&
 291                m_arch != wxARCH_INVALID &&
 292                m_endian != wxENDIAN_INVALID;
 293
 294                // do not check linux-specific info; it's ok to have them empty
 295     }
 296
 297
 298 protected:
 299     static bool DoCheckVersion(int majorCur, int minorCur, int major, int minor)
 300     {
 301         return majorCur > major || (majorCur == major && minorCur >= minor);
 302     }
 303
 304     void InitForCurrentPlatform();
 305
 306
 307     // OS stuff
 308     // -----------------
 309
 310     // Version of the OS; valid if m_os != wxOS_UNKNOWN
 311     // (-1 means not initialized yet).
 312     int m_osVersionMajor,
 313         m_osVersionMinor;
 314
 315     // Operating system ID.
 316     wxOperatingSystemId m_os;
 317
 318     // Operating system description.
 319     wxString m_osDesc;
 320
 321
 322     // linux-specific
 323     // -----------------
 324
 325     wxString m_desktopEnv;
 326     wxLinuxDistributionInfo m_ldi;
 327
 328
 329     // toolkit
 330     // -----------------
 331
 332     // Version of the underlying toolkit
 333     // (-1 means not initialized yet; zero means no toolkit).
 334     int m_tkVersionMajor, m_tkVersionMinor;
 335
 336     // name of the wxWidgets port
 337     wxPortId m_port;
 338
 339     // is using wxUniversal widgets?
 340     bool m_usingUniversal;
 341
 342
 343     // others
 344     // -----------------
 345
 346     // architecture of the OS/machine
 347     wxArchitecture m_arch;
 348
 349     // endianness of the machine
 350     wxEndianness m_endian;
 351 };
 352
 353
 354 #if WXWIN_COMPATIBILITY_2_6
 355     #define wxUNKNOWN_PLATFORM      wxOS_UNKNOWN
 356     #define wxUnix                  wxOS_UNIX
 357     #define wxWin95                 wxOS_WINDOWS_9X
 358     #define wxWIN95                 wxOS_WINDOWS_9X
 359     #define wxWINDOWS_NT            wxOS_WINDOWS_NT
 360     #define wxMSW                   wxOS_WINDOWS
 361     #define wxWinCE                 wxOS_WINDOWS_CE
 362     #define wxWIN32S                wxOS_WINDOWS_9X
 363
 364     #define wxOS2                   wxPORT_OS2
 365     #define wxMGL                   wxPORT_MGL
 366     #define wxCocoa                 wxPORT_MAC
 367     #define wxMac                   wxPORT_MAC
 368     #define wxMotif                 wxPORT_MOTIF
 369     #define wxGTK                   wxPORT_GTK
 370 #endif // WXWIN_COMPATIBILITY_2_6
 371
 372 #endif // _WX_PLATINFO_H_