Improved handling of command-line arguments: Arguments are now provided in the from...
[MUtilities.git] / include / MUtils / OSSupport.h
blob59f5cf856fd785354a81032d051a614d67771c81
1 ///////////////////////////////////////////////////////////////////////////////
2 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2014 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>
32 ///////////////////////////////////////////////////////////////////////////////
34 namespace MUtils
36 namespace OS
38 namespace Version
40 //Supported OS types
41 typedef enum
43 OS_UNKNOWN = 0,
44 OS_WINDOWS = 1
46 os_type_t;
48 //OS version struct
49 typedef struct _os_info_t
51 unsigned int type;
52 unsigned int versionMajor;
53 unsigned int versionMinor;
54 bool overrideFlag;
56 MUTILS_API bool operator== (const _os_info_t &rhs) const;
57 MUTILS_API bool operator!= (const _os_info_t &rhs) const;
58 MUTILS_API bool operator> (const _os_info_t &rhs) const;
59 MUTILS_API bool operator>= (const _os_info_t &rhs) const;
60 MUTILS_API bool operator< (const _os_info_t &rhs) const;
61 MUTILS_API bool operator<= (const _os_info_t &rhs) const;
63 os_version_t;
65 //Known Windows NT versions
66 MUTILS_API extern const os_version_t WINDOWS_WIN2K; // 2000
67 MUTILS_API extern const os_version_t WINDOWS_WINXP; // XP
68 MUTILS_API extern const os_version_t WINDOWS_XPX64; // XP_x64
69 MUTILS_API extern const os_version_t WINDOWS_VISTA; // Vista
70 MUTILS_API extern const os_version_t WINDOWS_WIN70; // 7
71 MUTILS_API extern const os_version_t WINDOWS_WIN80; // 8
72 MUTILS_API extern const os_version_t WINDOWS_WIN81; // 8.1
73 MUTILS_API extern const os_version_t WINDOWS_WN100; // 10
75 //Unknown OS
76 MUTILS_API extern const os_version_t UNKNOWN_OPSYS; // N/A
79 //Known Folders IDs
80 typedef enum
82 FOLDER_LOCALAPPDATA = 0,
83 FOLDER_PROGRAMFILES = 2,
84 FOLDER_SYSTEMFOLDER = 3,
85 FOLDER_SYSTROOT_DIR = 4
87 known_folder_t;
89 //Network connection types
90 typedef enum
92 NETWORK_TYPE_ERR = 0, /*unknown*/
93 NETWORK_TYPE_NON = 1, /*not connected*/
94 NETWORK_TYPE_YES = 2 /*connected*/
96 network_type_t;
98 //System message
99 MUTILS_API void system_message_nfo(const wchar_t *const title, const wchar_t *const text);
100 MUTILS_API void system_message_wrn(const wchar_t *const title, const wchar_t *const text);
101 MUTILS_API void system_message_err(const wchar_t *const title, const wchar_t *const text);
103 //CLI Arguments
104 typedef QMap<QString,QString> ArgumentMap;
105 MUTILS_API const ArgumentMap &arguments(void);
107 //Copy file
108 MUTILS_API bool copy_file(const QString &sourcePath, const QString &outputPath, const bool &overwrite = true);
110 //Get the OS version
111 MUTILS_API const Version::os_version_t &os_version(void);
112 MUTILS_API const char *os_friendly_name(const MUtils::OS::Version::os_version_t &os_version);
113 MUTILS_API const bool &running_on_wine(void);
115 //Get known Folder
116 MUTILS_API const QString &known_folder(known_folder_t folder_id);
118 //Current Date & Time
119 MUTILS_API QDate current_date(void);
120 MUTILS_API quint64 current_file_time(void);
122 //Check for process elevation
123 MUTILS_API bool is_elevated(bool *bIsUacEnabled = NULL);
124 MUTILS_API bool user_is_admin(void);
126 //Network Status
127 MUTILS_API int network_status(void);
129 //Message handler
130 MUTILS_API bool handle_os_message(const void *const message, long *result);
132 //Sleep
133 MUTILS_API void sleep_ms(const size_t &duration);
135 //Is executable file?
136 MUTILS_API bool is_executable_file(const QString &path);
138 //Shutdown & Hibernation
139 MUTILS_API bool is_hibernation_supported(void);
140 MUTILS_API bool shutdown_computer(const QString &message, const unsigned long timeout, const bool forceShutdown, const bool hibernate);
142 //Free diskspace
143 MUTILS_API bool free_diskspace(const QString &path, quint64 &freeSpace);
145 //Shell open
146 MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const bool explore = false);
147 MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const QString &parameters, const QString &directory, const bool explore = false);
149 //Open media file
150 MUTILS_API bool open_media_file(const QString &mediaFilePath);
152 //Process priority
153 MUTILS_API bool change_process_priority(const int priority);
154 MUTILS_API bool change_process_priority(const QProcess *proc, const int priority);
156 //Process ID
157 MUTILS_API quint32 process_id(const QProcess *proc);
159 //System timer resolution
160 MUTILS_API bool setup_timer_resolution(const quint32 &interval = 1);
161 MUTILS_API bool reset_timer_resolution(const quint32 &interval = 1);
163 MUTILS_API bool check_key_state_esc(void);
165 //Check if debugger is present
166 MUTILS_API void check_debugger(void);
168 //Error handling
169 MUTILS_API void fatal_exit(const wchar_t* const errorMessage);
173 ///////////////////////////////////////////////////////////////////////////////