include/MUtils/OSSupport.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // MuldeR's Utilities for Qt
   3 // Copyright (C) 2004-2023 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
  79                                 MUTILS_API bool operator>  (const _os_version_t &rhs) const;
  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                         }
  84                         os_version_t;
  85
  86                         //Known Windows NT versions
  87                         MUTILS_API extern const os_version_t WINDOWS_WIN2K;  ///< \brief Operating system version constant \details Microsoft(R) Windows 2000
  88                         MUTILS_API extern const os_version_t WINDOWS_WINXP;  ///< \brief Operating system version constant \details Microsoft(R) Windows XP
  89                         MUTILS_API extern const os_version_t WINDOWS_XPX64;  ///< \brief Operating system version constant \details Microsoft(R) Windows XP x64-edition
  90                         MUTILS_API extern const os_version_t WINDOWS_VISTA;  ///< \brief Operating system version constant \details Microsoft(R) Windows Vista
  91                         MUTILS_API extern const os_version_t WINDOWS_WIN70;  ///< \brief Operating system version constant \details Microsoft(R) Windows 7
  92                         MUTILS_API extern const os_version_t WINDOWS_WIN80;  ///< \brief Operating system version constant \details Microsoft(R) Windows 8
  93                         MUTILS_API extern const os_version_t WINDOWS_WIN81;  ///< \brief Operating system version constant \details Microsoft(R) Windows 8.1
  94                         MUTILS_API extern const os_version_t WINDOWS_WIN10;  ///< \brief Operating system version constant \details Microsoft(R) Windows 10
  95                         MUTILS_API extern const os_version_t WINDOWS_WIN11;  ///< \brief Operating system version constant \details Microsoft(R) Windows 11
  96
  97                         //Unknown OS
  98                         MUTILS_API extern const os_version_t UNKNOWN_OPSYS;  ///< \brief Operating system version constant \details Unknown operating system version
  99                 }
 100
 101                 /**
 102                 * \brief This enumeration specifies possible operating system architectures
 103                 */
 104                 typedef enum
 105                 {
 106                         ARCH_X86 = 1, ///< Intel x86 or compatible [32-bit]
 107                         ARCH_X64 = 2  ///< x86-64, aka AMD64, aka Intel 64 [64-bit]
 108                 }
 109                 os_arch_t;
 110
 111                 /**
 112                 * \brief This enumeration specifies "known" folder identifiers
 113                 */
 114                 typedef enum
 115                 {
 116                         FOLDER_PROFILE_USER  =  1,  ///< The user's profile folder
 117                         FOLDER_PROFILE_PUBL  =  2,  ///< The "all users" profile folder
 118                         FOLDER_APPDATA_ROAM  =  3,  ///< Application-specific data
 119                         FOLDER_APPDATA_LOCA  =  4,  ///< Local application data (non-roaming)
 120                         FOLDER_DOCS_USER     =  5,  ///< The user's Documents directory
 121                         FOLDER_DOCS_PUBL     =  6,  ///< The "all users" Documents directory
 122                         FOLDER_DESKTOP_USER  =  7,  ///< The user's Desktop directory
 123                         FOLDER_DESKTOP_PUBL  =  8,  ///< The "all users" Desktop directory
 124                         FOLDER_PICTURES_USER =  9,  ///< The user's Music directory
 125                         FOLDER_PICTURES_PUBL = 10,  ///< The user's Music directory
 126                         FOLDER_MUSIC_USER    = 11,  ///< The user's Music directory
 127                         FOLDER_MUSIC_PUBL    = 12,  ///< The "all users" Music directory
 128                         FOLDER_VIDEO_USER    = 13,  ///< The user's Video directory
 129                         FOLDER_VIDEO_PUBL    = 14,  ///< The "all users" Video directory
 130                         FOLDER_PROGRAMS_DEF  = 15,  ///< Program files
 131                         FOLDER_PROGRAMS_X86  = 16,  ///< Program files
 132                         FOLDER_PROGRAMS_X64  = 17,  ///< Program files
 133                         FOLDER_SYSROOT       = 18,  ///< System "root" directory
 134                         FOLDER_SYSTEM_DEF    = 19,  ///< System directory
 135                         FOLDER_SYSTEM_X86    = 20,  ///< System directory for x86 (32-Bit)
 136                 }
 137                 known_folder_t;
 138
 139                 /**
 140                 * \brief This enumeration specifies network connection types
 141                 */
 142                 typedef enum
 143                 {
 144                         NETWORK_TYPE_ERR = 0,  ///< Network connection is unknown
 145                         NETWORK_TYPE_NON = 1,  ///< Computer is **not** connected to a network
 146                         NETWORK_TYPE_YES = 2   ///< Computer *is* connected to a network
 147                 }
 148                 network_type_t;
 149
 150                 /**
 151                 * \brief This enumeration specifies drive types
 152                 */
 153                 typedef enum
 154                 {
 155                         DRIVE_TYPE_ERR = 0,  ///< The drive type cannot be determined
 156                         DRIVE_TYPE_FDD = 1,  ///< Floppy Drive, or Flash Card reader
 157                         DRIVE_TYPE_HDD = 2,  ///< Hard Disk drive or Solid-State Drive
 158                         DRIVE_TYPE_NET = 3,  ///< Remote/Network drive
 159                         DRIVE_TYPE_OPT = 4,  ///< Optical disk srive, e.g. CD or DVD
 160                         DRIVE_TYPE_RAM = 5   ///< RAM disk
 161                 }
 162                 drive_type_t;
 163
 164                 //System message
 165                 MUTILS_API void system_message_nfo(const wchar_t *const title, const wchar_t *const text);
 166                 MUTILS_API void system_message_wrn(const wchar_t *const title, const wchar_t *const text);
 167                 MUTILS_API void system_message_err(const wchar_t *const title, const wchar_t *const text);
 168
 169                 //CLI Arguments
 170                 typedef QMap<QString,QString> ArgumentMap;
 171                 MUTILS_API const QStringList crack_command_line(const QString &command_line = QString());
 172                 MUTILS_API const ArgumentMap &arguments(void);
 173
 174                 //Copy file
 175                 typedef bool (*progress_callback_t)(const double &progress, void *const userData);
 176                 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);
 177
 178                 //Get file version
 179                 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);
 180
 181                 //Get the OS version
 182                 MUTILS_API const Version::os_version_t &os_version(void);
 183                 MUTILS_API const char *os_friendly_name(const MUtils::OS::Version::os_version_t &os_version);
 184                 MUTILS_API const bool &running_on_wine(void);
 185                 MUTILS_API const os_arch_t &os_architecture(void);
 186
 187                 //Get known Folder
 188                 MUTILS_API const QString &known_folder(const known_folder_t folder_id);
 189
 190                 //Current Date & Time
 191                 MUTILS_API QDate current_date(void);
 192                 MUTILS_API quint64 current_file_time(void);
 193
 194                 //Check for process elevation
 195                 MUTILS_API bool is_elevated(bool *bIsUacEnabled = NULL);
 196                 MUTILS_API bool user_is_admin(void);
 197
 198                 /**
 199                 * \brief Check the network status
 200                 *
 201                 * Checks whether the computer is *currently* connected to a network. Note that an existing network connection does **not** necessarily imply actual Internet access!
 202                 *
 203                 * \return The function returns the current network status as a `OS::network_type_t` value.
 204                 */
 205                 MUTILS_API int network_status(void);
 206
 207                 //Message handler
 208                 MUTILS_API bool handle_os_message(const void *const message, long *result);
 209
 210                 /**
 211                 * \brief Suspend calling thread
 212                 *
 213                 * 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.
 214                 *
 215                 * 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.
 216                 *
 217                 * \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!
 218                 */
 219                 MUTILS_API void sleep_ms(const size_t &duration);
 220
 221                 //Is executable/library file?
 222                 MUTILS_API bool is_executable_file(const QString &path);
 223                 MUTILS_API bool is_library_file(const QString &path);
 224
 225                 //Shutdown & Hibernation
 226                 MUTILS_API bool is_hibernation_supported(void);
 227                 MUTILS_API bool shutdown_computer(const QString &message, const unsigned long timeout, const bool forceShutdown, const bool hibernate);
 228
 229                 //Free diskspace
 230                 MUTILS_API bool free_diskspace(const QString &path, quint64 &freeSpace);
 231
 232                 /**
 233                 * \brief Detect drive type
 234                 *
 235                 * This function detetcs the type of the drive to which the given path is pointing.
 236                 *
 237                 * \param path The path to the drive whose type is to be detected. On the Windows platform, only the drive letter is relevant.
 238                 *
 239                 * \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.
 240                 *
 241                 * \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.
 242                 */
 243                 MUTILS_API drive_type_t get_drive_type(const QString &path, bool *fast_seeking = NULL);
 244
 245                 //Shell open
 246                 MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const bool explore = false);
 247                 MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const QString &parameters, const QString &directory, const bool explore = false);
 248
 249                 //Open media file
 250                 MUTILS_API bool open_media_file(const QString &mediaFilePath);
 251
 252                 //Process priority
 253                 MUTILS_API bool change_process_priority(const int priority);
 254                 MUTILS_API bool change_process_priority(const QProcess *proc, const int priority);
 255
 256                 //Process ID
 257                 MUTILS_API quint32 process_id(void);
 258                 MUTILS_API quint32 process_id(const QProcess *const proc);
 259
 260                 //Thread ID
 261                 MUTILS_API quint32 thread_id(void);
 262                 MUTILS_API quint32 thread_id(const QProcess *const proc);
 263
 264                 //Suspend or resume processv
 265                 MUTILS_API bool suspend_process(const QProcess *proc, const bool suspend);
 266
 267                 //System timer resolution
 268                 MUTILS_API bool setup_timer_resolution(const quint32 &interval = 1);
 269                 MUTILS_API bool reset_timer_resolution(const quint32 &interval = 1);
 270
 271                 //Set file time
 272                 MUTILS_API bool set_file_time(const QFile &file,   const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
 273                 MUTILS_API bool set_file_time(const QString &path, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
 274
 275                 //Keyboard support
 276                 MUTILS_API bool check_key_state_esc(void);
 277
 278                 //Shell notification
 279                 MUTILS_API void shell_change_notification(void);
 280
 281                 //Get file path from descriptor
 282                 MUTILS_API QString get_file_path(const int &fd);
 283
 284                 //WOW64 redirection
 285                 MUTILS_API bool wow64fsredir_disable(uintptr_t &oldValue);
 286                 MUTILS_API bool wow64fsredir_revert (const uintptr_t oldValue);
 287
 288                 //Environment variables
 289                 MUTILS_API QString get_envvar(const QString &name);
 290                 MUTILS_API bool set_envvar(const QString &name, const QString &value);
 291
 292                 //NULL device
 293                 MUTILS_API const QLatin1String &null_device(void);
 294
 295                 //Check if debugger is present
 296                 MUTILS_API void check_debugger(void);
 297
 298                 //Error handling
 299                 MUTILS_API void fatal_exit(const wchar_t* const errorMessage);
 300         }
 301 }
 302
 303 ///////////////////////////////////////////////////////////////////////////////