MuldeR's Utilities for Qt: include/MUtils/OSSupport.h Source File

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-2022 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,
64 OS_WINDOWS = 1
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
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;
88 MUTILS_API extern const os_version_t WINDOWS_WINXP;
89 MUTILS_API extern const os_version_t WINDOWS_XPX64;
90 MUTILS_API extern const os_version_t WINDOWS_VISTA;
91 MUTILS_API extern const os_version_t WINDOWS_WIN70;
92 MUTILS_API extern const os_version_t WINDOWS_WIN80;
93 MUTILS_API extern const os_version_t WINDOWS_WIN81;
94 MUTILS_API extern const os_version_t WINDOWS_WIN10;
95 MUTILS_API extern const os_version_t WINDOWS_WIN11;
96
97 //Unknown OS
98 MUTILS_API extern const os_version_t UNKNOWN_OPSYS;
99 }
100
104 typedef enum
105 {
106 ARCH_X86 = 1,
107 ARCH_X64 = 2
108 }
109 os_arch_t;
110
114 typedef enum
115 {
116 FOLDER_PROFILE_USER = 1,
117 FOLDER_PROFILE_PUBL = 2,
118 FOLDER_APPDATA_ROAM = 3,
119 FOLDER_APPDATA_LOCA = 4,
120 FOLDER_DOCS_USER = 5,
121 FOLDER_DOCS_PUBL = 6,
122 FOLDER_DESKTOP_USER = 7,
123 FOLDER_DESKTOP_PUBL = 8,
124 FOLDER_PICTURES_USER = 9,
125 FOLDER_PICTURES_PUBL = 10,
126 FOLDER_MUSIC_USER = 11,
127 FOLDER_MUSIC_PUBL = 12,
128 FOLDER_VIDEO_USER = 13,
129 FOLDER_VIDEO_PUBL = 14,
130 FOLDER_PROGRAMS_DEF = 15,
131 FOLDER_PROGRAMS_X86 = 16,
132 FOLDER_PROGRAMS_X64 = 17,
133 FOLDER_SYSROOT = 18,
134 FOLDER_SYSTEM_DEF = 19,
135 FOLDER_SYSTEM_X86 = 20,
136 }
137 known_folder_t;
138
142 typedef enum
143 {
144 NETWORK_TYPE_ERR = 0,
145 NETWORK_TYPE_NON = 1,
146 NETWORK_TYPE_YES = 2
147 }
148 network_type_t;
149
153 typedef enum
154 {
155 DRIVE_TYPE_ERR = 0,
156 DRIVE_TYPE_FDD = 1,
157 DRIVE_TYPE_HDD = 2,
158 DRIVE_TYPE_NET = 3,
159 DRIVE_TYPE_OPT = 4,
160 DRIVE_TYPE_RAM = 5
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
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
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
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
MUtils::OS::FOLDER_DOCS_PUBL
The "all users" Documents directory.
Definition: OSSupport.h:121
MUtils::OS::network_status
MUTILS_API int network_status(void)
Check the network status.
MUtils::OS::Version::UNKNOWN_OPSYS
MUTILS_API const os_version_t UNKNOWN_OPSYS
Operating system version constant.
MUtils::OS::FOLDER_PROGRAMS_X64
Program files.
Definition: OSSupport.h:132
MUtils::OS::Version::_os_version_t::versionMinor
unsigned int versionMinor
The minor version of the underlaying operating system.
Definition: OSSupport.h:75
MUtils::OS::FOLDER_PICTURES_PUBL
The user&#39;s Music directory.
Definition: OSSupport.h:125
MUtils::OS::FOLDER_VIDEO_PUBL
The "all users" Video directory.
Definition: OSSupport.h:129
MUtils::OS::Version::_os_version_t::versionBuild
unsigned int versionBuild
The build number of the underlaying operating system.
Definition: OSSupport.h:76
MUtils::Version
Definition: Version.h:34
Global.h
This file contains miscellaneous functions that are generally useful for Qt-based applications...
MUtils::OS::sleep_ms
MUTILS_API void sleep_ms(const size_t &duration)
Suspend calling thread.
MUtils::OS::FOLDER_SYSROOT
System "root" directory.
Definition: OSSupport.h:133
MUtils::OS::Version::os_version_t
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...
MUtils::OS::FOLDER_PICTURES_USER
The user&#39;s Music directory.
Definition: OSSupport.h:124
MUtils::OS::Version::_os_version_t::versionMajor
unsigned int versionMajor
The major version of the underlaying operating system.
Definition: OSSupport.h:74
MUtils::OS::drive_type_t
drive_type_t
This enumeration specifies drive types.
Definition: OSSupport.h:153
MUtils::OS::FOLDER_APPDATA_LOCA
Local application data (non-roaming)
Definition: OSSupport.h:119
MUtils::OS::Version::WINDOWS_WIN70
MUTILS_API const os_version_t WINDOWS_WIN70
Operating system version constant.
MUtils::OS::Version::WINDOWS_WIN11
MUTILS_API const os_version_t WINDOWS_WIN11
Operating system version constant.
MUtils::OS::ARCH_X64
x86-64, aka AMD64, aka Intel 64 [64-bit]
Definition: OSSupport.h:107
MUtils::OS::Version::WINDOWS_WIN80
MUTILS_API const os_version_t WINDOWS_WIN80
Operating system version constant.
MUtils::OS::FOLDER_SYSTEM_X86
System directory for x86 (32-Bit)
Definition: OSSupport.h:135
MUtils::OS::Version::WINDOWS_WIN2K
MUTILS_API const os_version_t WINDOWS_WIN2K
Operating system version constant.
MUtils::OS::DRIVE_TYPE_HDD
Hard Disk drive or Solid-State Drive.
Definition: OSSupport.h:157
MUtils::OS::FOLDER_PROFILE_USER
The user&#39;s profile folder.
Definition: OSSupport.h:116
MUtils::OS::FOLDER_MUSIC_USER
The user&#39;s Music directory.
Definition: OSSupport.h:126
MUtils::OS::DRIVE_TYPE_OPT
Optical disk srive, e.g. CD or DVD.
Definition: OSSupport.h:159
MUtils::OS::Version::OS_UNKNOWN
Unknown operating system.
Definition: OSSupport.h:63
MUtils::OS::FOLDER_APPDATA_ROAM
Application-specific data.
Definition: OSSupport.h:118
MUtils::OS::ARCH_X86
Intel x86 or compatible [32-bit].
Definition: OSSupport.h:106
MUtils::OS::FOLDER_MUSIC_PUBL
The "all users" Music directory.
Definition: OSSupport.h:127
MUtils::OS::FOLDER_PROGRAMS_DEF
Program files.
Definition: OSSupport.h:130
MUtils::OS::Version::WINDOWS_WIN10
MUTILS_API const os_version_t WINDOWS_WIN10
Operating system version constant.
MUtils::OS::Version::os_type_t
os_type_t
This enumeration specifies the type of the underlaying operating system.
Definition: OSSupport.h:61
MUtils::OS::Version::WINDOWS_WIN81
MUTILS_API const os_version_t WINDOWS_WIN81
Operating system version constant.
MUtils::OS::Version::_os_version_t
This struct contains version information about the underlaying operating system. See _os_version_t fo...
Definition: OSSupport.h:71
MUtils::OS::os_arch_t
os_arch_t
This enumeration specifies possible operating system architectures.
Definition: OSSupport.h:104
MUtils::OS::Version::_os_version_t::versionSPack
unsigned int versionSPack
The service pack version of the underlaying operating system.
Definition: OSSupport.h:77
MUtils::OS::FOLDER_DESKTOP_PUBL
The "all users" Desktop directory.
Definition: OSSupport.h:123
MUtils::OS::FOLDER_VIDEO_USER
The user&#39;s Video directory.
Definition: OSSupport.h:128
MUtils::OS::DRIVE_TYPE_NET
Remote/Network drive.
Definition: OSSupport.h:158
MUtils::OS::Version::WINDOWS_VISTA
MUTILS_API const os_version_t WINDOWS_VISTA
Operating system version constant.
MUtils
Global MUtils namespace.
Definition: CPUFeatures.h:37
MUtils::OS::NETWORK_TYPE_NON
Computer is not connected to a network.
Definition: OSSupport.h:145
MUtils::OS::FOLDER_SYSTEM_DEF
System directory.
Definition: OSSupport.h:134
MUtils::OS::DRIVE_TYPE_ERR
The drive type cannot be determined.
Definition: OSSupport.h:155
MUtils::OS::FOLDER_DOCS_USER
The user&#39;s Documents directory.
Definition: OSSupport.h:120
MUtils::OS::Version::WINDOWS_WINXP
MUTILS_API const os_version_t WINDOWS_WINXP
Operating system version constant.
MUtils::OS::DRIVE_TYPE_FDD
Floppy Drive, or Flash Card reader.
Definition: OSSupport.h:156
MUtils::OS::FOLDER_DESKTOP_USER
The user&#39;s Desktop directory.
Definition: OSSupport.h:122
MUtils::OS::FOLDER_PROFILE_PUBL
The "all users" profile folder.
Definition: OSSupport.h:117
MUtils::OS::DRIVE_TYPE_RAM
RAM disk.
Definition: OSSupport.h:160
MUtils::OS::get_drive_type
MUTILS_API drive_type_t get_drive_type(const QString &path, bool *fast_seeking=NULL)
Detect drive type.
MUtils::OS::network_type_t
network_type_t
This enumeration specifies network connection types.
Definition: OSSupport.h:142
MUtils::OS::NETWORK_TYPE_YES
Computer is connected to a network.
Definition: OSSupport.h:146
MUtils::OS::Version::OS_WINDOWS
Microsoft(R) Windows.
Definition: OSSupport.h:64
MUtils::OS::Version::_os_version_t::type
unsigned int type
The type of the underlaying operating system, as os_type_t
Definition: OSSupport.h:73
MUtils::OS::FOLDER_PROGRAMS_X86
Program files.
Definition: OSSupport.h:131
MUtils::OS::known_folder_t
known_folder_t
This enumeration specifies "known" folder identifiers.
Definition: OSSupport.h:114
MUtils::OS::Version::WINDOWS_XPX64
MUTILS_API const os_version_t WINDOWS_XPX64
Operating system version constant.
MUtils::OS::NETWORK_TYPE_ERR
Network connection is unknown.
Definition: OSSupport.h:144