MuldeR's Utilities for Qt
MUtilities
OSSupport.h
Go to the documentation of this file.
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2021 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
21 
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 
42 
46 namespace MUtils
47 {
51  namespace OS
52  {
56  namespace Version
57  {
61  typedef enum
62  {
63  OS_UNKNOWN = 0,
65  }
66  os_type_t;
67 
71  typedef struct _os_version_t
72  {
73  unsigned int type;
74  unsigned int versionMajor;
75  unsigned int versionMinor;
76  unsigned int versionBuild;
77  unsigned int versionSPack;
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  }
88 
89  //Known Windows NT versions
90  MUTILS_API extern const os_version_t WINDOWS_WIN2K;
91  MUTILS_API extern const os_version_t WINDOWS_WINXP;
92  MUTILS_API extern const os_version_t WINDOWS_XPX64;
93  MUTILS_API extern const os_version_t WINDOWS_VISTA;
94  MUTILS_API extern const os_version_t WINDOWS_WIN70;
95  MUTILS_API extern const os_version_t WINDOWS_WIN80;
96  MUTILS_API extern const os_version_t WINDOWS_WIN81;
97  MUTILS_API extern const os_version_t WINDOWS_WN100;
98 
99  //Unknown OS
100  MUTILS_API extern const os_version_t UNKNOWN_OPSYS;
101  }
102 
106  typedef enum
107  {
108  ARCH_X86 = 1,
109  ARCH_X64 = 2
110  }
111  os_arch_t;
112 
116  typedef enum
117  {
138  }
140 
144  typedef enum
145  {
149  }
151 
155  typedef enum
156  {
163  }
164  drive_type_t;
165 
166  //System message
167  MUTILS_API void system_message_nfo(const wchar_t *const title, const wchar_t *const text);
168  MUTILS_API void system_message_wrn(const wchar_t *const title, const wchar_t *const text);
169  MUTILS_API void system_message_err(const wchar_t *const title, const wchar_t *const text);
170 
171  //CLI Arguments
172  typedef QMap<QString,QString> ArgumentMap;
173  MUTILS_API const QStringList crack_command_line(const QString &command_line = QString());
174  MUTILS_API const ArgumentMap &arguments(void);
175 
176  //Copy file
177  typedef bool (*progress_callback_t)(const double &progress, void *const userData);
178  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);
179 
180  //Get file version
181  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);
182 
183  //Get the OS version
184  MUTILS_API const Version::os_version_t &os_version(void);
185  MUTILS_API const char *os_friendly_name(const MUtils::OS::Version::os_version_t &os_version);
186  MUTILS_API const bool &running_on_wine(void);
187  MUTILS_API const os_arch_t &os_architecture(void);
188 
189  //Get known Folder
190  MUTILS_API const QString &known_folder(const known_folder_t folder_id);
191 
192  //Current Date & Time
193  MUTILS_API QDate current_date(void);
194  MUTILS_API quint64 current_file_time(void);
195 
196  //Check for process elevation
197  MUTILS_API bool is_elevated(bool *bIsUacEnabled = NULL);
198  MUTILS_API bool user_is_admin(void);
199 
207  MUTILS_API int network_status(void);
208 
209  //Message handler
210  MUTILS_API bool handle_os_message(const void *const message, long *result);
211 
221  MUTILS_API void sleep_ms(const size_t &duration);
222 
223  //Is executable/library file?
224  MUTILS_API bool is_executable_file(const QString &path);
225  MUTILS_API bool is_library_file(const QString &path);
226 
227  //Shutdown & Hibernation
228  MUTILS_API bool is_hibernation_supported(void);
229  MUTILS_API bool shutdown_computer(const QString &message, const unsigned long timeout, const bool forceShutdown, const bool hibernate);
230 
231  //Free diskspace
232  MUTILS_API bool free_diskspace(const QString &path, quint64 &freeSpace);
233 
245  MUTILS_API drive_type_t get_drive_type(const QString &path, bool *fast_seeking = NULL);
246 
247  //Shell open
248  MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const bool explore = false);
249  MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const QString &parameters, const QString &directory, const bool explore = false);
250 
251  //Open media file
252  MUTILS_API bool open_media_file(const QString &mediaFilePath);
253 
254  //Process priority
255  MUTILS_API bool change_process_priority(const int priority);
256  MUTILS_API bool change_process_priority(const QProcess *proc, const int priority);
257 
258  //Process ID
259  MUTILS_API quint32 process_id(void);
260  MUTILS_API quint32 process_id(const QProcess *const proc);
261 
262  //Thread ID
263  MUTILS_API quint32 thread_id(void);
264  MUTILS_API quint32 thread_id(const QProcess *const proc);
265 
266  //Suspend or resume processv
267  MUTILS_API bool suspend_process(const QProcess *proc, const bool suspend);
268 
269  //System timer resolution
270  MUTILS_API bool setup_timer_resolution(const quint32 &interval = 1);
271  MUTILS_API bool reset_timer_resolution(const quint32 &interval = 1);
272 
273  //Set file time
274  MUTILS_API bool set_file_time(const QFile &file, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
275  MUTILS_API bool set_file_time(const QString &path, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
276 
277  //Keyboard support
278  MUTILS_API bool check_key_state_esc(void);
279 
280  //Shell notification
281  MUTILS_API void shell_change_notification(void);
282 
283  //Get file path from descriptor
284  MUTILS_API QString get_file_path(const int &fd);
285 
286  //WOW64 redirection
287  MUTILS_API bool wow64fsredir_disable(uintptr_t &oldValue);
288  MUTILS_API bool wow64fsredir_revert (const uintptr_t oldValue);
289 
290  //Environment variables
291  MUTILS_API QString get_envvar(const QString &name);
292  MUTILS_API bool set_envvar(const QString &name, const QString &value);
293 
294  //NULL device
295  MUTILS_API const QLatin1String &null_device(void);
296 
297  //Check if debugger is present
298  MUTILS_API void check_debugger(void);
299 
300  //Error handling
301  MUTILS_API void fatal_exit(const wchar_t* const errorMessage);
302  }
303 }
304 
The "all users" Documents directory.
Definition: OSSupport.h:123
MUTILS_API int network_status(void)
Check the network status.
MUTILS_API const os_version_t UNKNOWN_OPSYS
Operating system version constant.
Program files.
Definition: OSSupport.h:134
unsigned int versionMinor
The minor version of the underlaying operating system.
Definition: OSSupport.h:75
The user&#39;s Music directory.
Definition: OSSupport.h:127
The "all users" Video directory.
Definition: OSSupport.h:131
unsigned int versionBuild
The build number of the underlaying operating system.
Definition: OSSupport.h:76
Definition: Version.h:34
This file contains miscellaneous functions that are generally useful for Qt-based applications...
MUTILS_API void sleep_ms(const size_t &duration)
Suspend calling thread.
System "root" directory.
Definition: OSSupport.h:135
struct MUtils::OS::Version::_os_version_t os_version_t
This struct contains version information about the underlaying operating system. See _os_version_t fo...
The user&#39;s Music directory.
Definition: OSSupport.h:126
unsigned int versionMajor
The major version of the underlaying operating system.
Definition: OSSupport.h:74
drive_type_t
This enumeration specifies drive types.
Definition: OSSupport.h:155
Local application data (non-roaming)
Definition: OSSupport.h:121
MUTILS_API const os_version_t WINDOWS_WIN70
Operating system version constant.
x86-64, aka AMD64, aka Intel 64 [64-bit]
Definition: OSSupport.h:109
MUTILS_API const os_version_t WINDOWS_WIN80
Operating system version constant.
System directory for x86 (32-Bit)
Definition: OSSupport.h:137
MUTILS_API const os_version_t WINDOWS_WIN2K
Operating system version constant.
Hard Disk drive or Solid-State Drive.
Definition: OSSupport.h:159
The user&#39;s profile folder.
Definition: OSSupport.h:118
The user&#39;s Music directory.
Definition: OSSupport.h:128
Optical disk srive, e.g. CD or DVD.
Definition: OSSupport.h:161
Unknown operating system.
Definition: OSSupport.h:63
Application-specific data.
Definition: OSSupport.h:120
Intel x86 or compatible [32-bit].
Definition: OSSupport.h:108
The "all users" Music directory.
Definition: OSSupport.h:129
MUTILS_API const os_version_t WINDOWS_WN100
Operating system version constant.
Program files.
Definition: OSSupport.h:132
os_type_t
This enumeration specifies the type of the underlaying operating system.
Definition: OSSupport.h:61
MUTILS_API const os_version_t WINDOWS_WIN81
Operating system version constant.
This struct contains version information about the underlaying operating system. See _os_version_t fo...
Definition: OSSupport.h:71
os_arch_t
This enumeration specifies possible operating system architectures.
Definition: OSSupport.h:106
unsigned int versionSPack
The service pack version of the underlaying operating system.
Definition: OSSupport.h:77
The "all users" Desktop directory.
Definition: OSSupport.h:125
The user&#39;s Video directory.
Definition: OSSupport.h:130
Remote/Network drive.
Definition: OSSupport.h:160
MUTILS_API const os_version_t WINDOWS_VISTA
Operating system version constant.
Global MUtils namespace.
Definition: CPUFeatures.h:37
Computer is not connected to a network.
Definition: OSSupport.h:147
System directory.
Definition: OSSupport.h:136
The drive type cannot be determined.
Definition: OSSupport.h:157
The user&#39;s Documents directory.
Definition: OSSupport.h:122
MUTILS_API const os_version_t WINDOWS_WINXP
Operating system version constant.
Floppy Drive, or Flash Card reader.
Definition: OSSupport.h:158
The user&#39;s Desktop directory.
Definition: OSSupport.h:124
The "all users" profile folder.
Definition: OSSupport.h:119
RAM disk.
Definition: OSSupport.h:162
MUTILS_API drive_type_t get_drive_type(const QString &path, bool *fast_seeking=NULL)
Detect drive type.
network_type_t
This enumeration specifies network connection types.
Definition: OSSupport.h:144
Computer is connected to a network.
Definition: OSSupport.h:148
Microsoft(R) Windows.
Definition: OSSupport.h:64
unsigned int type
The type of the underlaying operating system, as os_type_t
Definition: OSSupport.h:73
Program files.
Definition: OSSupport.h:133
known_folder_t
This enumeration specifies "known" folder identifiers.
Definition: OSSupport.h:116
MUTILS_API const os_version_t WINDOWS_XPX64
Operating system version constant.
Network connection is unknown.
Definition: OSSupport.h:146