include/MUtils/OSSupport.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // MuldeR's Utilities for Qt
   3 // Copyright (C) 2004-2019 LoRd_MuldeR <MuldeR2@GMX.de>
   4 //
   5 // This library is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU Lesser General Public
   7 // License as published by the Free Software Foundation; either
   8 // version 2.1 of the License, or (at your option) any later version.
   9 //
  10 // This library is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // Lesser General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU Lesser General Public
  16 // License along with this library; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  18 //
  19 // http://www.gnu.org/licenses/lgpl-2.1.txt
  20 //////////////////////////////////////////////////////////////////////////////////
  21
  22 /**
  23  * @file
  24  * @brief This file contains function that wrap OS-specific functionality in a platform-independent way
  25  */
  26
  27 #pragma once
  28
  29 //MUtils
  30 #include <MUtils/Global.h>
  31
  32 //Qt
  33 #include <QString>
  34 #include <QMap>
  35 #include <QDate>
  36 #include <QWidget>
  37
  38 //Forward declaration
  39 class QFile;
  40
  41 ///////////////////////////////////////////////////////////////////////////////
  42
  43 /**
  44 * \brief Global MUtils namespace
  45 */
  46 namespace MUtils
  47 {
  48         /**
  49         * \brief MUtils OS-specific functions namespace
  50         */
  51         namespace OS
  52         {
  53                 /**
  54                 * \brief OS version information namespace
  55                 */
  56                 namespace Version
  57                 {
  58                         /**
  59                         * \brief This enumeration specifies the type of the underlaying operating system
  60                         */
  61                         typedef enum
  62                         {
  63                                 OS_UNKNOWN = 0,  ///< Unknown operating system
  64                                 OS_WINDOWS = 1   ///< Microsoft(R) Windows
  65                         }
  66                         os_type_t;
  67
  68                         /**
  69                         * \brief This struct contains version information about the underlaying operating system. See `_os_version_t` for details!
  70                         */
  71                         typedef struct _os_version_t
  72                         {
  73                                 unsigned int type;          ///< The type of the underlaying operating system, as `os_type_t`
  74                                 unsigned int versionMajor;  ///< The *major* version of the underlaying operating system
  75                                 unsigned int versionMinor;  ///< The *minor* version of the underlaying operating system
  76                                 unsigned int versionBuild;  ///< The *build* number of the underlaying operating system
  77                                 unsigned int versionSPack;  ///< The *service pack* version of the underlaying operating system
  78                                 bool overrideFlag;
  79
  80                                 MUTILS_API bool operator== (const _os_version_t &rhs) const;
  81                                 MUTILS_API bool operator!= (const _os_version_t &rhs) const;
  82                                 MUTILS_API bool operator>  (const _os_version_t &rhs) const;
  83                                 MUTILS_API bool operator>= (const _os_version_t &rhs) const;
  84                                 MUTILS_API bool operator<  (const _os_version_t &rhs) const;
  85                                 MUTILS_API bool operator<= (const _os_version_t &rhs) const;
  86                         }
  87                         os_version_t;
  88
  89                         //Known Windows NT versions
  90                         MUTILS_API extern const os_version_t WINDOWS_WIN2K;  ///< \brief Operating system version constant \details Microsoft(R) Windows 2000
  91                         MUTILS_API extern const os_version_t WINDOWS_WINXP;  ///< \brief Operating system version constant \details Microsoft(R) Windows XP
  92                         MUTILS_API extern const os_version_t WINDOWS_XPX64;  ///< \brief Operating system version constant \details Microsoft(R) Windows XP x64-edition
  93                         MUTILS_API extern const os_version_t WINDOWS_VISTA;  ///< \brief Operating system version constant \details Microsoft(R) Windows Vista
  94                         MUTILS_API extern const os_version_t WINDOWS_WIN70;  ///< \brief Operating system version constant \details Microsoft(R) Windows 7
  95                         MUTILS_API extern const os_version_t WINDOWS_WIN80;  ///< \brief Operating system version constant \details Microsoft(R) Windows 8
  96                         MUTILS_API extern const os_version_t WINDOWS_WIN81;  ///< \brief Operating system version constant \details Microsoft(R) Windows 8.1
  97                         MUTILS_API extern const os_version_t WINDOWS_WN100;  ///< \brief Operating system version constant \details Microsoft(R) Windows 10
  98
  99                         //Unknown OS
 100                         MUTILS_API extern const os_version_t UNKNOWN_OPSYS;  ///< \brief Operating system version constant \details Unknown operating system version
 101                 }
 102
 103                 /**
 104                 * \brief This enumeration specifies "known" folder identifiers
 105                 */
 106                 typedef enum
 107                 {
 108                         FOLDER_PROFILE_USER  =  1,  ///< The user's profile folder
 109                         FOLDER_PROFILE_PUBL  =  2,  ///< The "all users" profile folder
 110                         FOLDER_APPDATA_ROAM  =  3,  ///< Application-specific data
 111                         FOLDER_APPDATA_LOCA  =  4,  ///< Local application data (non-roaming)
 112                         FOLDER_DOCS_USER     =  5,  ///< The user's Documents directory
 113                         FOLDER_DOCS_PUBL     =  6,  ///< The "all users" Documents directory
 114                         FOLDER_DESKTOP_USER  =  7,  ///< The user's Desktop directory
 115                         FOLDER_DESKTOP_PUBL  =  8,  ///< The "all users" Desktop directory
 116                         FOLDER_PICTURES_USER =  9,  ///< The user's Music directory
 117                         FOLDER_PICTURES_PUBL = 10,  ///< The user's Music directory
 118                         FOLDER_MUSIC_USER    = 11,  ///< The user's Music directory
 119                         FOLDER_MUSIC_PUBL    = 12,  ///< The "all users" Music directory
 120                         FOLDER_VIDEO_USER    = 13,  ///< The user's Video directory
 121                         FOLDER_VIDEO_PUBL    = 14,  ///< The "all users" Video directory
 122                         FOLDER_PROGRAMFILES  = 15,  ///< Program files
 123                         FOLDER_SYSROOT       = 16,  ///< System "root" directory
 124                         FOLDER_SYSTEM_DEF    = 17,  ///< System directory
 125                         FOLDER_SYSTEM_X86    = 18,  ///< System directory for x86 (32-Bit)
 126                 }
 127                 known_folder_t;
 128
 129                 /**
 130                 * \brief This enumeration specifies network connection types
 131                 */
 132                 typedef enum
 133                 {
 134                         NETWORK_TYPE_ERR = 0,  ///< Network connection is unknown
 135                         NETWORK_TYPE_NON = 1,  ///< Computer is **not** connected to a network
 136                         NETWORK_TYPE_YES = 2   ///< Computer *is* connected to a network
 137                 }
 138                 network_type_t;
 139
 140                 /**
 141                 * \brief This enumeration specifies drive types
 142                 */
 143                 typedef enum
 144                 {
 145                         DRIVE_TYPE_ERR = 0,  ///< The drive type cannot be determined
 146                         DRIVE_TYPE_FDD = 1,  ///< Floppy Drive, or Flash Card reader
 147                         DRIVE_TYPE_HDD = 2,  ///< Hard Disk drive or Solid-State Drive
 148                         DRIVE_TYPE_NET = 3,  ///< Remote/Network drive
 149                         DRIVE_TYPE_OPT = 4,  ///< Optical disk srive, e.g. CD or DVD
 150                         DRIVE_TYPE_RAM = 5   ///< RAM disk
 151                 }
 152                 drive_type_t;
 153
 154                 //System message
 155                 MUTILS_API void system_message_nfo(const wchar_t *const title, const wchar_t *const text);
 156                 MUTILS_API void system_message_wrn(const wchar_t *const title, const wchar_t *const text);
 157                 MUTILS_API void system_message_err(const wchar_t *const title, const wchar_t *const text);
 158
 159                 //CLI Arguments
 160                 typedef QMap<QString,QString> ArgumentMap;
 161                 MUTILS_API const QStringList crack_command_line(const QString &command_line = QString());
 162                 MUTILS_API const ArgumentMap &arguments(void);
 163
 164                 //Copy file
 165                 typedef bool (*progress_callback_t)(const double &progress, void *const userData);
 166                 MUTILS_API bool copy_file(const QString &sourcePath, const QString &outputPath, const bool &overwrite = true, const progress_callback_t callback = NULL, void *const userData = NULL);
 167
 168                 //Get file version
 169                 MUTILS_API bool get_file_version(const QString fileName, quint16 *const major = NULL, quint16 *const minor = NULL, quint16 *const patch = NULL, quint16 *const build = NULL);
 170
 171                 //Get the OS version
 172                 MUTILS_API const Version::os_version_t &os_version(void);
 173                 MUTILS_API const char *os_friendly_name(const MUtils::OS::Version::os_version_t &os_version);
 174                 MUTILS_API const bool &running_on_wine(void);
 175
 176                 //Get known Folder
 177                 MUTILS_API const QString &known_folder(const known_folder_t folder_id);
 178
 179                 //Current Date & Time
 180                 MUTILS_API QDate current_date(void);
 181                 MUTILS_API quint64 current_file_time(void);
 182
 183                 //Check for process elevation
 184                 MUTILS_API bool is_elevated(bool *bIsUacEnabled = NULL);
 185                 MUTILS_API bool user_is_admin(void);
 186
 187                 /**
 188                 * \brief Check the network status
 189                 *
 190                 * Checks whether the computer is *currently* connected to a network. Note that an existing network connection does **not** necessarily imply actual Internet access!
 191                 *
 192                 * \return The function returns the current network status as a `OS::network_type_t` value.
 193                 */
 194                 MUTILS_API int network_status(void);
 195
 196                 //Message handler
 197                 MUTILS_API bool handle_os_message(const void *const message, long *result);
 198
 199                 /**
 200                 * \brief Suspend calling thread
 201                 *
 202                 * This function suspends the calling thread. The thread will give up its current time-slice and enter "sleeping" state. The thread will remain in "sleeping" for the specified duration. After the specified duration has elapsed, the thread will be resumed.
 203                 *
 204                 * Note that it depends on the operating system's scheduling decisions, when the thread will actually be allowed to execute again! While the thread is still in "sleeping" state, it can **not** be selected for execution by the operating system's scheduler. Once the thread is *no* longer in "sleeping" state, i.e. the specified period has elapsed, the thread *can* be selected for execution by the operating system's scheduler again - but this does **not** need to happen *immediately*! The scheduler decides which thread is allowed to execute next, taking into consideration thread priorities.
 205                 *
 206                 * \param duration The amount of time that the thread will be suspended, in milliseconds. A value of **0** means that the thread will *not* actually enter "sleeping" state, but it will still give up its current time-slice!
 207                 */
 208                 MUTILS_API void sleep_ms(const size_t &duration);
 209
 210                 //Is executable/library file?
 211                 MUTILS_API bool is_executable_file(const QString &path);
 212                 MUTILS_API bool is_library_file(const QString &path);
 213
 214                 //Shutdown & Hibernation
 215                 MUTILS_API bool is_hibernation_supported(void);
 216                 MUTILS_API bool shutdown_computer(const QString &message, const unsigned long timeout, const bool forceShutdown, const bool hibernate);
 217
 218                 //Free diskspace
 219                 MUTILS_API bool free_diskspace(const QString &path, quint64 &freeSpace);
 220
 221                 /**
 222                 * \brief Detect drive type
 223                 *
 224                 * This function detetcs the type of the drive to which the given path is pointing.
 225                 *
 226                 * \param path The path to the drive whose type is to be detected. On the Windows platform, only the drive letter is relevant.
 227                 *
 228                 * \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.
 229                 *
 230                 * \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.
 231                 */
 232                 MUTILS_API drive_type_t get_drive_type(const QString &path, bool *fast_seeking = NULL);
 233
 234                 //Shell open
 235                 MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const bool explore = false);
 236                 MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const QString &parameters, const QString &directory, const bool explore = false);
 237
 238                 //Open media file
 239                 MUTILS_API bool open_media_file(const QString &mediaFilePath);
 240
 241                 //Process priority
 242                 MUTILS_API bool change_process_priority(const int priority);
 243                 MUTILS_API bool change_process_priority(const QProcess *proc, const int priority);
 244
 245                 //Process ID
 246                 MUTILS_API quint32 process_id(void);
 247                 MUTILS_API quint32 process_id(const QProcess *const proc);
 248
 249                 //Thread ID
 250                 MUTILS_API quint32 thread_id(void);
 251                 MUTILS_API quint32 thread_id(const QProcess *const proc);
 252
 253                 //Suspend or resume processv
 254                 MUTILS_API bool suspend_process(const QProcess *proc, const bool suspend);
 255
 256                 //System timer resolution
 257                 MUTILS_API bool setup_timer_resolution(const quint32 &interval = 1);
 258                 MUTILS_API bool reset_timer_resolution(const quint32 &interval = 1);
 259
 260                 //Set file time
 261                 MUTILS_API bool set_file_time(const QFile &file,   const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
 262                 MUTILS_API bool set_file_time(const QString &path, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
 263
 264                 //Keyboard support
 265                 MUTILS_API bool check_key_state_esc(void);
 266
 267                 //Shell notification
 268                 MUTILS_API void shell_change_notification(void);
 269
 270                 //Get file path from descriptor
 271                 MUTILS_API QString get_file_path(const int &fd);
 272
 273                 //WOW64 redirection
 274                 MUTILS_API bool wow64fsredir_disable(uintptr_t &oldValue);
 275                 MUTILS_API bool wow64fsredir_revert (const uintptr_t oldValue);
 276
 277                 //Environment variables
 278                 MUTILS_API QString get_envvar(const QString &name);
 279                 MUTILS_API bool set_envvar(const QString &name, const QString &value);
 280
 281                 //NULL device
 282                 MUTILS_API const QLatin1String &null_device(void);
 283
 284                 //Check if debugger is present
 285                 MUTILS_API void check_debugger(void);
 286
 287                 //Error handling
 288                 MUTILS_API void fatal_exit(const wchar_t* const errorMessage);
 289         }
 290 }
 291
 292 ///////////////////////////////////////////////////////////////////////////////