Added Qt5 support, contributed by John Buonagurio <jbuonagurio@exponent.com>.
[MUtilities.git] / include / MUtils / OSSupport.h
blob671b96fa3d828bebc661675c1f558ab16161db3a
1 ///////////////////////////////////////////////////////////////////////////////
2 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2016 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.
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
19 // http://www.gnu.org/licenses/lgpl-2.1.txt
20 //////////////////////////////////////////////////////////////////////////////////
22 #pragma once
24 //MUtils
25 #include <MUtils/Global.h>
27 //Qt
28 #include <QString>
29 #include <QMap>
30 #include <QDate>
31 #include <QWidget>
33 //Forward declaration
34 class QFile;
36 ///////////////////////////////////////////////////////////////////////////////
38 namespace MUtils
40 namespace OS
42 namespace Version
44 //Supported OS types
45 typedef enum
47 OS_UNKNOWN = 0,
48 OS_WINDOWS = 1
50 os_type_t;
52 //OS version struct
53 typedef struct _os_version_t
55 unsigned int type;
56 unsigned int versionMajor;
57 unsigned int versionMinor;
58 unsigned int versionBuild;
59 bool overrideFlag;
61 MUTILS_API bool operator== (const _os_version_t &rhs) const;
62 MUTILS_API bool operator!= (const _os_version_t &rhs) const;
63 MUTILS_API bool operator> (const _os_version_t &rhs) const;
64 MUTILS_API bool operator>= (const _os_version_t &rhs) const;
65 MUTILS_API bool operator< (const _os_version_t &rhs) const;
66 MUTILS_API bool operator<= (const _os_version_t &rhs) const;
68 os_version_t;
70 //Known Windows NT versions
71 MUTILS_API extern const os_version_t WINDOWS_WIN2K; // 2000
72 MUTILS_API extern const os_version_t WINDOWS_WINXP; // XP
73 MUTILS_API extern const os_version_t WINDOWS_XPX64; // XP_x64
74 MUTILS_API extern const os_version_t WINDOWS_VISTA; // Vista
75 MUTILS_API extern const os_version_t WINDOWS_WIN70; // 7
76 MUTILS_API extern const os_version_t WINDOWS_WIN80; // 8
77 MUTILS_API extern const os_version_t WINDOWS_WIN81; // 8.1
78 MUTILS_API extern const os_version_t WINDOWS_WN100; // 10
80 //Unknown OS
81 MUTILS_API extern const os_version_t UNKNOWN_OPSYS; // N/A
84 //Known Folders IDs
85 typedef enum
87 FOLDER_LOCALAPPDATA = 0,
88 FOLDER_PROGRAMFILES = 2,
89 FOLDER_SYSTEMFOLDER = 3,
90 FOLDER_SYSTROOT_DIR = 4
92 known_folder_t;
94 //Network connection types
95 typedef enum
97 NETWORK_TYPE_ERR = 0, /*unknown*/
98 NETWORK_TYPE_NON = 1, /*not connected*/
99 NETWORK_TYPE_YES = 2 /*connected*/
101 network_type_t;
103 //System message
104 MUTILS_API void system_message_nfo(const wchar_t *const title, const wchar_t *const text);
105 MUTILS_API void system_message_wrn(const wchar_t *const title, const wchar_t *const text);
106 MUTILS_API void system_message_err(const wchar_t *const title, const wchar_t *const text);
108 //CLI Arguments
109 typedef QMap<QString,QString> ArgumentMap;
110 MUTILS_API const QStringList crack_command_line(const QString &command_line = QString());
111 MUTILS_API const ArgumentMap &arguments(void);
113 //Copy file
114 typedef bool (*progress_callback_t)(const double &progress, void *const userData);
115 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);
117 //Get file version
118 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);
120 //Get the OS version
121 MUTILS_API const Version::os_version_t &os_version(void);
122 MUTILS_API const char *os_friendly_name(const MUtils::OS::Version::os_version_t &os_version);
123 MUTILS_API const bool &running_on_wine(void);
125 //Get known Folder
126 MUTILS_API const QString &known_folder(known_folder_t folder_id);
128 //Current Date & Time
129 MUTILS_API QDate current_date(void);
130 MUTILS_API quint64 current_file_time(void);
132 //Check for process elevation
133 MUTILS_API bool is_elevated(bool *bIsUacEnabled = NULL);
134 MUTILS_API bool user_is_admin(void);
136 //Network Status
137 MUTILS_API int network_status(void);
139 //Message handler
140 MUTILS_API bool handle_os_message(const void *const message, long *result);
142 //Sleep
143 MUTILS_API void sleep_ms(const size_t &duration);
145 //Is executable/library file?
146 MUTILS_API bool is_executable_file(const QString &path);
147 MUTILS_API bool is_library_file(const QString &path);
149 //Shutdown & Hibernation
150 MUTILS_API bool is_hibernation_supported(void);
151 MUTILS_API bool shutdown_computer(const QString &message, const unsigned long timeout, const bool forceShutdown, const bool hibernate);
153 //Free diskspace
154 MUTILS_API bool free_diskspace(const QString &path, quint64 &freeSpace);
156 //Shell open
157 MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const bool explore = false);
158 MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const QString &parameters, const QString &directory, const bool explore = false);
160 //Open media file
161 MUTILS_API bool open_media_file(const QString &mediaFilePath);
163 //Process priority
164 MUTILS_API bool change_process_priority(const int priority);
165 MUTILS_API bool change_process_priority(const QProcess *proc, const int priority);
167 //Process ID
168 MUTILS_API quint32 process_id(void);
169 MUTILS_API quint32 process_id(const QProcess *const proc);
171 //Thread ID
172 MUTILS_API quint32 thread_id(void);
173 MUTILS_API quint32 thread_id(const QProcess *const proc);
175 //Suspend or resume processv
176 MUTILS_API bool suspend_process(const QProcess *proc, const bool suspend);
178 //System timer resolution
179 MUTILS_API bool setup_timer_resolution(const quint32 &interval = 1);
180 MUTILS_API bool reset_timer_resolution(const quint32 &interval = 1);
182 //Set file time
183 MUTILS_API bool set_file_time(const QFile &file, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
184 MUTILS_API bool set_file_time(const QString &path, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
186 //Keyboard support
187 MUTILS_API bool check_key_state_esc(void);
189 //Shell notification
190 MUTILS_API void shell_change_notification(void);
192 //Get file path from descriptor
193 MUTILS_API QString get_file_path(const int &fd);
195 //WOW64 redirection
196 MUTILS_API bool wow64fsredir_disable(void *oldValue);
197 MUTILS_API bool wow64fsredir_revert (void *oldValue);
199 //Environment variables
200 MUTILS_API QString get_envvar(const QString &name);
201 MUTILS_API bool set_envvar(const QString &name, const QString &value);
203 //Check if debugger is present
204 MUTILS_API void check_debugger(void);
206 //Error handling
207 MUTILS_API void fatal_exit(const wchar_t* const errorMessage);
211 ///////////////////////////////////////////////////////////////////////////////