OSDN Git Service

Added function to detect the OS architecture (x86 vs x64).
[mutilities/MUtilities.git] / include / MUtils / OSSupport.h
index 88e7c3b..92bbd85 100644 (file)
@@ -1,6 +1,6 @@
 ///////////////////////////////////////////////////////////////////////////////
 // MuldeR's Utilities for Qt
-// Copyright (C) 2004-2017 LoRd_MuldeR <MuldeR2@GMX.de>
+// Copyright (C) 2004-2019 LoRd_MuldeR <MuldeR2@GMX.de>
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
@@ -74,6 +74,7 @@ namespace MUtils
                                unsigned int versionMajor;  ///< The *major* version of the underlaying operating system
                                unsigned int versionMinor;  ///< The *minor* version of the underlaying operating system
                                unsigned int versionBuild;  ///< The *build* number of the underlaying operating system
+                               unsigned int versionSPack;  ///< The *service pack* version of the underlaying operating system
                                bool overrideFlag;
 
                                MUTILS_API bool operator== (const _os_version_t &rhs) const;
@@ -100,14 +101,40 @@ namespace MUtils
                }
 
                /**
+               * \brief This enumeration specifies possible operating system architectures
+               */
+               typedef enum
+               {
+                       ARCH_X86 = 1, ///< Intel x86 or compatible [32-bit]
+                       ARCH_X64 = 2  ///< x86-64, aka AMD64, aka Intel 64 [64-bit]
+               }
+               os_arch_t;
+
+               /**
                * \brief This enumeration specifies "known" folder identifiers
                */
                typedef enum
                {
-                       FOLDER_LOCALAPPDATA = 0,  ///< Local application data (non-roaming)
-                       FOLDER_PROGRAMFILES = 2,  ///< Program files
-                       FOLDER_SYSTEMFOLDER = 3,  ///< System directory
-                       FOLDER_SYSTROOT_DIR = 4   ///< System "root" directory
+                       FOLDER_PROFILE_USER  =  1,  ///< The user's profile folder
+                       FOLDER_PROFILE_PUBL  =  2,  ///< The "all users" profile folder
+                       FOLDER_APPDATA_ROAM  =  3,  ///< Application-specific data
+                       FOLDER_APPDATA_LOCA  =  4,  ///< Local application data (non-roaming)
+                       FOLDER_DOCS_USER     =  5,  ///< The user's Documents directory
+                       FOLDER_DOCS_PUBL     =  6,  ///< The "all users" Documents directory
+                       FOLDER_DESKTOP_USER  =  7,  ///< The user's Desktop directory
+                       FOLDER_DESKTOP_PUBL  =  8,  ///< The "all users" Desktop directory
+                       FOLDER_PICTURES_USER =  9,  ///< The user's Music directory
+                       FOLDER_PICTURES_PUBL = 10,  ///< The user's Music directory
+                       FOLDER_MUSIC_USER    = 11,  ///< The user's Music directory
+                       FOLDER_MUSIC_PUBL    = 12,  ///< The "all users" Music directory
+                       FOLDER_VIDEO_USER    = 13,  ///< The user's Video directory
+                       FOLDER_VIDEO_PUBL    = 14,  ///< The "all users" Video directory
+                       FOLDER_PROGRAMS_DEF  = 15,  ///< Program files
+                       FOLDER_PROGRAMS_X86  = 16,  ///< Program files
+                       FOLDER_PROGRAMS_X64  = 17,  ///< Program files
+                       FOLDER_SYSROOT       = 18,  ///< System "root" directory
+                       FOLDER_SYSTEM_DEF    = 19,  ///< System directory
+                       FOLDER_SYSTEM_X86    = 20,  ///< System directory for x86 (32-Bit)
                }
                known_folder_t;
                
@@ -122,6 +149,20 @@ namespace MUtils
                }
                network_type_t;
                
+               /**
+               * \brief This enumeration specifies drive types
+               */
+               typedef enum
+               {
+                       DRIVE_TYPE_ERR = 0,  ///< The drive type cannot be determined
+                       DRIVE_TYPE_FDD = 1,  ///< Floppy Drive, or Flash Card reader
+                       DRIVE_TYPE_HDD = 2,  ///< Hard Disk drive or Solid-State Drive
+                       DRIVE_TYPE_NET = 3,  ///< Remote/Network drive
+                       DRIVE_TYPE_OPT = 4,  ///< Optical disk srive, e.g. CD or DVD
+                       DRIVE_TYPE_RAM = 5   ///< RAM disk
+               }
+               drive_type_t;
+
                //System message
                MUTILS_API void system_message_nfo(const wchar_t *const title, const wchar_t *const text);
                MUTILS_API void system_message_wrn(const wchar_t *const title, const wchar_t *const text);
@@ -143,9 +184,10 @@ namespace MUtils
                MUTILS_API const Version::os_version_t &os_version(void);
                MUTILS_API const char *os_friendly_name(const MUtils::OS::Version::os_version_t &os_version);
                MUTILS_API const bool &running_on_wine(void);
+               MUTILS_API const os_arch_t &os_architecture(void);
 
                //Get known Folder
-               MUTILS_API const QString &known_folder(known_folder_t folder_id);
+               MUTILS_API const QString &known_folder(const known_folder_t folder_id);
 
                //Current Date & Time
                MUTILS_API QDate current_date(void);
@@ -189,6 +231,19 @@ namespace MUtils
                //Free diskspace
                MUTILS_API bool free_diskspace(const QString &path, quint64 &freeSpace);
 
+               /**
+               * \brief Detect drive type
+               *
+               * This function detetcs the type of the drive to which the given path is pointing.
+               *
+               * \param path The path to the drive whose type is to be detected. On the Windows platform, only the drive letter is relevant.
+               *
+               * \param fast_seeking Pointer to a variable that will be set to TRUE, if the drive supports "fast" seeking (e.g. SSD or similar device), or to FALSE otherwise. This parameter is optional and may be NULL.
+               *
+               * \return The function returns the type of the drive as a `OS::drive_type_t` value. In case of error, the value `DRIVE_TYPE_ERR` will be returned.
+               */
+               MUTILS_API drive_type_t get_drive_type(const QString &path, bool *fast_seeking = NULL);
+
                //Shell open
                MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const bool explore = false);
                MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const QString &parameters, const QString &directory, const bool explore = false);
@@ -229,13 +284,16 @@ namespace MUtils
                MUTILS_API QString get_file_path(const int &fd);
 
                //WOW64 redirection
-               MUTILS_API bool wow64fsredir_disable(void *oldValue);
-               MUTILS_API bool wow64fsredir_revert (void *oldValue);
+               MUTILS_API bool wow64fsredir_disable(uintptr_t &oldValue);
+               MUTILS_API bool wow64fsredir_revert (const uintptr_t oldValue);
 
                //Environment variables
                MUTILS_API QString get_envvar(const QString &name);
                MUTILS_API bool set_envvar(const QString &name, const QString &value);
 
+               //NULL device
+               MUTILS_API const QLatin1String &null_device(void);
+
                //Check if debugger is present
                MUTILS_API void check_debugger(void);