X-Git-Url: http://git.osdn.net/view?a=blobdiff_plain;f=docs%2Fd3%2Fdc1%2F_o_s_support_8h_source.html;h=13e1be93abbaa8035e9589a21001c16f7ca77788;hb=cea3834ddf5651bd43d841fa062d8f8672011e55;hp=b967b9ccd427350a6a15cc986aedcfdbee1a57ba;hpb=cab5175f8c4d065cf8a80add3892feef704619e7;p=mutilities%2FMUtilities.git diff --git a/docs/d3/dc1/_o_s_support_8h_source.html b/docs/d3/dc1/_o_s_support_8h_source.html index b967b9c..13e1be9 100644 --- a/docs/d3/dc1/_o_s_support_8h_source.html +++ b/docs/d3/dc1/_o_s_support_8h_source.html @@ -67,9 +67,46 @@ $(function() {
OSSupport.h
-
1 // 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.
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 
22 #pragma once
23 
24 //MUtils
25 #include <MUtils/Global.h>
26 
27 //Qt
28 #include <QString>
29 #include <QMap>
30 #include <QDate>
31 
32 //Forward declaration
33 class QFile;
34 
36 
37 namespace MUtils
38 {
39  namespace OS
40  {
41  namespace Version
42  {
43  //Supported OS types
44  typedef enum
45  {
46  OS_UNKNOWN = 0,
47  OS_WINDOWS = 1
48  }
49  os_type_t;
50 
51  //OS version struct
52  typedef struct _os_version_t
53  {
54  unsigned int type;
55  unsigned int versionMajor;
56  unsigned int versionMinor;
57  unsigned int versionBuild;
58  bool overrideFlag;
59 
60  MUTILS_API bool operator== (const _os_version_t &rhs) const;
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  }
68 
69  //Known Windows NT versions
70  MUTILS_API extern const os_version_t WINDOWS_WIN2K; // 2000
71  MUTILS_API extern const os_version_t WINDOWS_WINXP; // XP
72  MUTILS_API extern const os_version_t WINDOWS_XPX64; // XP_x64
73  MUTILS_API extern const os_version_t WINDOWS_VISTA; // Vista
74  MUTILS_API extern const os_version_t WINDOWS_WIN70; // 7
75  MUTILS_API extern const os_version_t WINDOWS_WIN80; // 8
76  MUTILS_API extern const os_version_t WINDOWS_WIN81; // 8.1
77  MUTILS_API extern const os_version_t WINDOWS_WN100; // 10
78 
79  //Unknown OS
80  MUTILS_API extern const os_version_t UNKNOWN_OPSYS; // N/A
81  }
82 
83  //Known Folders IDs
84  typedef enum
85  {
86  FOLDER_LOCALAPPDATA = 0,
87  FOLDER_PROGRAMFILES = 2,
88  FOLDER_SYSTEMFOLDER = 3,
89  FOLDER_SYSTROOT_DIR = 4
90  }
91  known_folder_t;
92 
93  //Network connection types
94  typedef enum
95  {
96  NETWORK_TYPE_ERR = 0, /*unknown*/
97  NETWORK_TYPE_NON = 1, /*not connected*/
98  NETWORK_TYPE_YES = 2 /*connected*/
99  }
100  network_type_t;
101 
102  //System message
103  MUTILS_API void system_message_nfo(const wchar_t *const title, const wchar_t *const text);
104  MUTILS_API void system_message_wrn(const wchar_t *const title, const wchar_t *const text);
105  MUTILS_API void system_message_err(const wchar_t *const title, const wchar_t *const text);
106 
107  //CLI Arguments
108  typedef QMap<QString,QString> ArgumentMap;
109  MUTILS_API const QStringList crack_command_line(const QString &command_line = QString());
110  MUTILS_API const ArgumentMap &arguments(void);
111 
112  //Copy file
113  typedef bool (*progress_callback_t)(const double &progress, void *const userData);
114  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);
115 
116  //Get file version
117  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);
118 
119  //Get the OS version
120  MUTILS_API const Version::os_version_t &os_version(void);
121  MUTILS_API const char *os_friendly_name(const MUtils::OS::Version::os_version_t &os_version);
122  MUTILS_API const bool &running_on_wine(void);
123 
124  //Get known Folder
125  MUTILS_API const QString &known_folder(known_folder_t folder_id);
126 
127  //Current Date & Time
128  MUTILS_API QDate current_date(void);
129  MUTILS_API quint64 current_file_time(void);
130 
131  //Check for process elevation
132  MUTILS_API bool is_elevated(bool *bIsUacEnabled = NULL);
133  MUTILS_API bool user_is_admin(void);
134 
135  //Network Status
136  MUTILS_API int network_status(void);
137 
138  //Message handler
139  MUTILS_API bool handle_os_message(const void *const message, long *result);
140 
141  //Sleep
142  MUTILS_API void sleep_ms(const size_t &duration);
143 
144  //Is executable/library file?
145  MUTILS_API bool is_executable_file(const QString &path);
146  MUTILS_API bool is_library_file(const QString &path);
147 
148  //Shutdown & Hibernation
149  MUTILS_API bool is_hibernation_supported(void);
150  MUTILS_API bool shutdown_computer(const QString &message, const unsigned long timeout, const bool forceShutdown, const bool hibernate);
151 
152  //Free diskspace
153  MUTILS_API bool free_diskspace(const QString &path, quint64 &freeSpace);
154 
155  //Shell open
156  MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const bool explore = false);
157  MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const QString &parameters, const QString &directory, const bool explore = false);
158 
159  //Open media file
160  MUTILS_API bool open_media_file(const QString &mediaFilePath);
161 
162  //Process priority
163  MUTILS_API bool change_process_priority(const int priority);
164  MUTILS_API bool change_process_priority(const QProcess *proc, const int priority);
165 
166  //Process ID
167  MUTILS_API quint32 process_id(void);
168  MUTILS_API quint32 process_id(const QProcess *const proc);
169 
170  //Thread ID
171  MUTILS_API quint32 thread_id(void);
172  MUTILS_API quint32 thread_id(const QProcess *const proc);
173 
174  //Suspend or resume processv
175  MUTILS_API bool suspend_process(const QProcess *proc, const bool suspend);
176 
177  //System timer resolution
178  MUTILS_API bool setup_timer_resolution(const quint32 &interval = 1);
179  MUTILS_API bool reset_timer_resolution(const quint32 &interval = 1);
180 
181  //Set file time
182  MUTILS_API bool set_file_time(const QFile &file, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
183  MUTILS_API bool set_file_time(const QString &path, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
184 
185  //Keyboard support
186  MUTILS_API bool check_key_state_esc(void);
187 
188  //Shell notification
189  MUTILS_API void shell_change_notification(void);
190 
191  //Get file path from descriptor
192  MUTILS_API QString get_file_path(const int &fd);
193 
194  //WOW64 redirection
195  MUTILS_API bool wow64fsredir_disable(void *oldValue);
196  MUTILS_API bool wow64fsredir_revert (void *oldValue);
197 
198  //Environment variables
199  MUTILS_API QString get_envvar(const QString &name);
200  MUTILS_API bool set_envvar(const QString &name, const QString &value);
201 
202  //Check if debugger is present
203  MUTILS_API void check_debugger(void);
204 
205  //Error handling
206  MUTILS_API void fatal_exit(const wchar_t* const errorMessage);
207  }
208 }
209 
This file contains miscellaneous functions that are generally useful for Qt-based applications...
-
Definition: OSSupport.h:52
+Go to the documentation of this file.
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2017 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  bool overrideFlag;
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  MUTILS_API bool operator< (const _os_version_t &rhs) const;
84  MUTILS_API bool operator<= (const _os_version_t &rhs) const;
85  }
87 
88  //Known Windows NT versions
89  MUTILS_API extern const os_version_t WINDOWS_WIN2K;
90  MUTILS_API extern const os_version_t WINDOWS_WINXP;
91  MUTILS_API extern const os_version_t WINDOWS_XPX64;
92  MUTILS_API extern const os_version_t WINDOWS_VISTA;
93  MUTILS_API extern const os_version_t WINDOWS_WIN70;
94  MUTILS_API extern const os_version_t WINDOWS_WIN80;
95  MUTILS_API extern const os_version_t WINDOWS_WIN81;
96  MUTILS_API extern const os_version_t WINDOWS_WN100;
97 
98  //Unknown OS
99  MUTILS_API extern const os_version_t UNKNOWN_OPSYS;
100  }
101 
105  typedef enum
106  {
111  }
113 
117  typedef enum
118  {
122  }
124 
128  typedef enum
129  {
136  }
137  drive_type_t;
138 
139  //System message
140  MUTILS_API void system_message_nfo(const wchar_t *const title, const wchar_t *const text);
141  MUTILS_API void system_message_wrn(const wchar_t *const title, const wchar_t *const text);
142  MUTILS_API void system_message_err(const wchar_t *const title, const wchar_t *const text);
143 
144  //CLI Arguments
145  typedef QMap<QString,QString> ArgumentMap;
146  MUTILS_API const QStringList crack_command_line(const QString &command_line = QString());
147  MUTILS_API const ArgumentMap &arguments(void);
148 
149  //Copy file
150  typedef bool (*progress_callback_t)(const double &progress, void *const userData);
151  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);
152 
153  //Get file version
154  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);
155 
156  //Get the OS version
157  MUTILS_API const Version::os_version_t &os_version(void);
158  MUTILS_API const char *os_friendly_name(const MUtils::OS::Version::os_version_t &os_version);
159  MUTILS_API const bool &running_on_wine(void);
160 
161  //Get known Folder
162  MUTILS_API const QString &known_folder(known_folder_t folder_id);
163 
164  //Current Date & Time
165  MUTILS_API QDate current_date(void);
166  MUTILS_API quint64 current_file_time(void);
167 
168  //Check for process elevation
169  MUTILS_API bool is_elevated(bool *bIsUacEnabled = NULL);
170  MUTILS_API bool user_is_admin(void);
171 
179  MUTILS_API int network_status(void);
180 
181  //Message handler
182  MUTILS_API bool handle_os_message(const void *const message, long *result);
183 
193  MUTILS_API void sleep_ms(const size_t &duration);
194 
195  //Is executable/library file?
196  MUTILS_API bool is_executable_file(const QString &path);
197  MUTILS_API bool is_library_file(const QString &path);
198 
199  //Shutdown & Hibernation
200  MUTILS_API bool is_hibernation_supported(void);
201  MUTILS_API bool shutdown_computer(const QString &message, const unsigned long timeout, const bool forceShutdown, const bool hibernate);
202 
203  //Free diskspace
204  MUTILS_API bool free_diskspace(const QString &path, quint64 &freeSpace);
205 
217  MUTILS_API drive_type_t get_drive_type(const QString &path, bool *fast_seeking = NULL);
218 
219  //Shell open
220  MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const bool explore = false);
221  MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const QString &parameters, const QString &directory, const bool explore = false);
222 
223  //Open media file
224  MUTILS_API bool open_media_file(const QString &mediaFilePath);
225 
226  //Process priority
227  MUTILS_API bool change_process_priority(const int priority);
228  MUTILS_API bool change_process_priority(const QProcess *proc, const int priority);
229 
230  //Process ID
231  MUTILS_API quint32 process_id(void);
232  MUTILS_API quint32 process_id(const QProcess *const proc);
233 
234  //Thread ID
235  MUTILS_API quint32 thread_id(void);
236  MUTILS_API quint32 thread_id(const QProcess *const proc);
237 
238  //Suspend or resume processv
239  MUTILS_API bool suspend_process(const QProcess *proc, const bool suspend);
240 
241  //System timer resolution
242  MUTILS_API bool setup_timer_resolution(const quint32 &interval = 1);
243  MUTILS_API bool reset_timer_resolution(const quint32 &interval = 1);
244 
245  //Set file time
246  MUTILS_API bool set_file_time(const QFile &file, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
247  MUTILS_API bool set_file_time(const QString &path, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
248 
249  //Keyboard support
250  MUTILS_API bool check_key_state_esc(void);
251 
252  //Shell notification
253  MUTILS_API void shell_change_notification(void);
254 
255  //Get file path from descriptor
256  MUTILS_API QString get_file_path(const int &fd);
257 
258  //WOW64 redirection
259  MUTILS_API bool wow64fsredir_disable(void *oldValue);
260  MUTILS_API bool wow64fsredir_revert (void *oldValue);
261 
262  //Environment variables
263  MUTILS_API QString get_envvar(const QString &name);
264  MUTILS_API bool set_envvar(const QString &name, const QString &value);
265 
266  //Check if debugger is present
267  MUTILS_API void check_debugger(void);
268 
269  //Error handling
270  MUTILS_API void fatal_exit(const wchar_t* const errorMessage);
271  }
272 }
273 
MUTILS_API int network_status(void)
Check the network status.
+
MUTILS_API const os_version_t UNKNOWN_OPSYS
Operating system version constant.
+
Local application data (non-roaming)
Definition: OSSupport.h:107
+
unsigned int versionMinor
The minor version of the underlaying operating system.
Definition: OSSupport.h:75
+
Program files.
Definition: OSSupport.h:108
+
unsigned int versionBuild
The build number of the underlaying operating system.
Definition: OSSupport.h:76
+
System "root" directory.
Definition: OSSupport.h:110
+
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.
+
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...
+
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:128
+
MUTILS_API const os_version_t WINDOWS_WIN70
Operating system version constant.
+
MUTILS_API const os_version_t WINDOWS_WIN80
Operating system version constant.
+
MUTILS_API const os_version_t WINDOWS_WIN2K
Operating system version constant.
+
Hard Disk drive or Solid-State Drive.
Definition: OSSupport.h:132
+
Optical disk srive, e.g. CD or DVD.
Definition: OSSupport.h:134
+
Unknown operating system.
Definition: OSSupport.h:63
+
MUTILS_API const os_version_t WINDOWS_WN100
Operating system version constant.
+
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
+
Remote/Network drive.
Definition: OSSupport.h:133
+
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:120
+
The drive type cannot be determined.
Definition: OSSupport.h:130
+
MUTILS_API const os_version_t WINDOWS_WINXP
Operating system version constant.
+
Floppy Drive, or Flash Card reader.
Definition: OSSupport.h:131
+
RAM disk.
Definition: OSSupport.h:135
+
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:117
+
Computer is connected to a network.
Definition: OSSupport.h:121
+
System directory.
Definition: OSSupport.h:109
+
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
+
known_folder_t
This enumeration specifies "known" folder identifiers.
Definition: OSSupport.h:105
+
MUTILS_API const os_version_t WINDOWS_XPX64
Operating system version constant.
+
Network connection is unknown.
Definition: OSSupport.h:119