From 3916593e6345c9210e157100dfaca008a579f387 Mon Sep 17 00:00:00 2001 From: LoRd_MuldeR Date: Tue, 7 May 2019 21:02:20 +0200 Subject: [PATCH] Added support for "roaming" application data directory to MUtils::OS::known_folder() function. Use FOLDER_ROAMING_DATA enumeration value. --- docs/d2/df4/namespace_m_utils_1_1_o_s.html | 19 ++++++++++++----- docs/d3/dc1/_o_s_support_8h.html | 13 ++++++++---- docs/d3/dc1/_o_s_support_8h_source.html | 34 ++++++++++++++++-------------- docs/namespacemembers.html | 6 ++++++ docs/namespacemembers_eval.html | 6 ++++++ docs/search/all_5.js | 2 ++ docs/search/enumvalues_1.js | 4 +++- include/MUtils/OSSupport.h | 11 +++++----- src/OSSupport_Win32.cpp | 12 ++++++----- 9 files changed, 71 insertions(+), 36 deletions(-) diff --git a/docs/d2/df4/namespace_m_utils_1_1_o_s.html b/docs/d2/df4/namespace_m_utils_1_1_o_s.html index 41bdd49..53ff670 100644 --- a/docs/d2/df4/namespace_m_utils_1_1_o_s.html +++ b/docs/d2/df4/namespace_m_utils_1_1_o_s.html @@ -93,10 +93,15 @@ typedef bool(* progress_ca - @@ -313,7 +318,11 @@ MUTILS_API void 

Enumerations

enum  known_folder_t { FOLDER_LOCALAPPDATA = 0, -FOLDER_PROGRAMFILES = 2, -FOLDER_SYSTEMFOLDER = 3, -FOLDER_SYSTROOT_DIR = 4 +
enum  known_folder_t {
+  FOLDER_ROAMING_DATA = 0, +FOLDER_LOCALAPPDATA = 1, +FOLDER_USER_PROFILE = 2, +FOLDER_PROGRAMFILES = 3, +
+  FOLDER_SYSTEMFOLDER = 4, +FOLDER_SYSTROOT_DIR = 5 +
}
 This enumeration specifies "known" folder identifiers. More...
 
fatal_exit

This enumeration specifies "known" folder identifiers.

- + + diff --git a/docs/d3/dc1/_o_s_support_8h.html b/docs/d3/dc1/_o_s_support_8h.html index 5d328e1..cc75f9b 100644 --- a/docs/d3/dc1/_o_s_support_8h.html +++ b/docs/d3/dc1/_o_s_support_8h.html @@ -123,10 +123,15 @@ Enumerations } - diff --git a/docs/d3/dc1/_o_s_support_8h_source.html b/docs/d3/dc1/_o_s_support_8h_source.html index 964bb93..ad12ac0 100644 --- a/docs/d3/dc1/_o_s_support_8h_source.html +++ b/docs/d3/dc1/_o_s_support_8h_source.html @@ -67,47 +67,49 @@ $(function() {
OSSupport.h
-Go to the documentation of this file.
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2019 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  {
112  }
114 
118  typedef enum
119  {
123  }
125 
129  typedef enum
130  {
137  }
138  drive_type_t;
139 
140  //System message
141  MUTILS_API void system_message_nfo(const wchar_t *const title, const wchar_t *const text);
142  MUTILS_API void system_message_wrn(const wchar_t *const title, const wchar_t *const text);
143  MUTILS_API void system_message_err(const wchar_t *const title, const wchar_t *const text);
144 
145  //CLI Arguments
146  typedef QMap<QString,QString> ArgumentMap;
147  MUTILS_API const QStringList crack_command_line(const QString &command_line = QString());
148  MUTILS_API const ArgumentMap &arguments(void);
149 
150  //Copy file
151  typedef bool (*progress_callback_t)(const double &progress, void *const userData);
152  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);
153 
154  //Get file version
155  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);
156 
157  //Get the OS version
158  MUTILS_API const Version::os_version_t &os_version(void);
159  MUTILS_API const char *os_friendly_name(const MUtils::OS::Version::os_version_t &os_version);
160  MUTILS_API const bool &running_on_wine(void);
161 
162  //Get known Folder
163  MUTILS_API const QString &known_folder(known_folder_t folder_id);
164 
165  //Current Date & Time
166  MUTILS_API QDate current_date(void);
167  MUTILS_API quint64 current_file_time(void);
168 
169  //Check for process elevation
170  MUTILS_API bool is_elevated(bool *bIsUacEnabled = NULL);
171  MUTILS_API bool user_is_admin(void);
172 
180  MUTILS_API int network_status(void);
181 
182  //Message handler
183  MUTILS_API bool handle_os_message(const void *const message, long *result);
184 
194  MUTILS_API void sleep_ms(const size_t &duration);
195 
196  //Is executable/library file?
197  MUTILS_API bool is_executable_file(const QString &path);
198  MUTILS_API bool is_library_file(const QString &path);
199 
200  //Shutdown & Hibernation
201  MUTILS_API bool is_hibernation_supported(void);
202  MUTILS_API bool shutdown_computer(const QString &message, const unsigned long timeout, const bool forceShutdown, const bool hibernate);
203 
204  //Free diskspace
205  MUTILS_API bool free_diskspace(const QString &path, quint64 &freeSpace);
206 
218  MUTILS_API drive_type_t get_drive_type(const QString &path, bool *fast_seeking = NULL);
219 
220  //Shell open
221  MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const bool explore = false);
222  MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const QString &parameters, const QString &directory, const bool explore = false);
223 
224  //Open media file
225  MUTILS_API bool open_media_file(const QString &mediaFilePath);
226 
227  //Process priority
228  MUTILS_API bool change_process_priority(const int priority);
229  MUTILS_API bool change_process_priority(const QProcess *proc, const int priority);
230 
231  //Process ID
232  MUTILS_API quint32 process_id(void);
233  MUTILS_API quint32 process_id(const QProcess *const proc);
234 
235  //Thread ID
236  MUTILS_API quint32 thread_id(void);
237  MUTILS_API quint32 thread_id(const QProcess *const proc);
238 
239  //Suspend or resume processv
240  MUTILS_API bool suspend_process(const QProcess *proc, const bool suspend);
241 
242  //System timer resolution
243  MUTILS_API bool setup_timer_resolution(const quint32 &interval = 1);
244  MUTILS_API bool reset_timer_resolution(const quint32 &interval = 1);
245 
246  //Set file time
247  MUTILS_API bool set_file_time(const QFile &file, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
248  MUTILS_API bool set_file_time(const QString &path, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
249 
250  //Keyboard support
251  MUTILS_API bool check_key_state_esc(void);
252 
253  //Shell notification
254  MUTILS_API void shell_change_notification(void);
255 
256  //Get file path from descriptor
257  MUTILS_API QString get_file_path(const int &fd);
258 
259  //WOW64 redirection
260  MUTILS_API bool wow64fsredir_disable(void *oldValue);
261  MUTILS_API bool wow64fsredir_revert (void *oldValue);
262 
263  //Environment variables
264  MUTILS_API QString get_envvar(const QString &name);
265  MUTILS_API bool set_envvar(const QString &name, const QString &value);
266 
267  //NULL device
268  MUTILS_API const QLatin1String &null_device(void);
269 
270  //Check if debugger is present
271  MUTILS_API void check_debugger(void);
272 
273  //Error handling
274  MUTILS_API void fatal_exit(const wchar_t* const errorMessage);
275  }
276 }
277 
MUTILS_API int network_status(void)
Check the network status.
+Go to the documentation of this file.
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2019 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  {
114  }
116 
120  typedef enum
121  {
125  }
127 
131  typedef enum
132  {
139  }
140  drive_type_t;
141 
142  //System message
143  MUTILS_API void system_message_nfo(const wchar_t *const title, const wchar_t *const text);
144  MUTILS_API void system_message_wrn(const wchar_t *const title, const wchar_t *const text);
145  MUTILS_API void system_message_err(const wchar_t *const title, const wchar_t *const text);
146 
147  //CLI Arguments
148  typedef QMap<QString,QString> ArgumentMap;
149  MUTILS_API const QStringList crack_command_line(const QString &command_line = QString());
150  MUTILS_API const ArgumentMap &arguments(void);
151 
152  //Copy file
153  typedef bool (*progress_callback_t)(const double &progress, void *const userData);
154  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);
155 
156  //Get file version
157  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);
158 
159  //Get the OS version
160  MUTILS_API const Version::os_version_t &os_version(void);
161  MUTILS_API const char *os_friendly_name(const MUtils::OS::Version::os_version_t &os_version);
162  MUTILS_API const bool &running_on_wine(void);
163 
164  //Get known Folder
165  MUTILS_API const QString &known_folder(known_folder_t folder_id);
166 
167  //Current Date & Time
168  MUTILS_API QDate current_date(void);
169  MUTILS_API quint64 current_file_time(void);
170 
171  //Check for process elevation
172  MUTILS_API bool is_elevated(bool *bIsUacEnabled = NULL);
173  MUTILS_API bool user_is_admin(void);
174 
182  MUTILS_API int network_status(void);
183 
184  //Message handler
185  MUTILS_API bool handle_os_message(const void *const message, long *result);
186 
196  MUTILS_API void sleep_ms(const size_t &duration);
197 
198  //Is executable/library file?
199  MUTILS_API bool is_executable_file(const QString &path);
200  MUTILS_API bool is_library_file(const QString &path);
201 
202  //Shutdown & Hibernation
203  MUTILS_API bool is_hibernation_supported(void);
204  MUTILS_API bool shutdown_computer(const QString &message, const unsigned long timeout, const bool forceShutdown, const bool hibernate);
205 
206  //Free diskspace
207  MUTILS_API bool free_diskspace(const QString &path, quint64 &freeSpace);
208 
220  MUTILS_API drive_type_t get_drive_type(const QString &path, bool *fast_seeking = NULL);
221 
222  //Shell open
223  MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const bool explore = false);
224  MUTILS_API bool shell_open(const QWidget *parent, const QString &url, const QString &parameters, const QString &directory, const bool explore = false);
225 
226  //Open media file
227  MUTILS_API bool open_media_file(const QString &mediaFilePath);
228 
229  //Process priority
230  MUTILS_API bool change_process_priority(const int priority);
231  MUTILS_API bool change_process_priority(const QProcess *proc, const int priority);
232 
233  //Process ID
234  MUTILS_API quint32 process_id(void);
235  MUTILS_API quint32 process_id(const QProcess *const proc);
236 
237  //Thread ID
238  MUTILS_API quint32 thread_id(void);
239  MUTILS_API quint32 thread_id(const QProcess *const proc);
240 
241  //Suspend or resume processv
242  MUTILS_API bool suspend_process(const QProcess *proc, const bool suspend);
243 
244  //System timer resolution
245  MUTILS_API bool setup_timer_resolution(const quint32 &interval = 1);
246  MUTILS_API bool reset_timer_resolution(const quint32 &interval = 1);
247 
248  //Set file time
249  MUTILS_API bool set_file_time(const QFile &file, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
250  MUTILS_API bool set_file_time(const QString &path, const QDateTime &created = QDateTime(), const QDateTime &modified = QDateTime(), const QDateTime &accessed = QDateTime());
251 
252  //Keyboard support
253  MUTILS_API bool check_key_state_esc(void);
254 
255  //Shell notification
256  MUTILS_API void shell_change_notification(void);
257 
258  //Get file path from descriptor
259  MUTILS_API QString get_file_path(const int &fd);
260 
261  //WOW64 redirection
262  MUTILS_API bool wow64fsredir_disable(void *oldValue);
263  MUTILS_API bool wow64fsredir_revert (void *oldValue);
264 
265  //Environment variables
266  MUTILS_API QString get_envvar(const QString &name);
267  MUTILS_API bool set_envvar(const QString &name, const QString &value);
268 
269  //NULL device
270  MUTILS_API const QLatin1String &null_device(void);
271 
272  //Check if debugger is present
273  MUTILS_API void check_debugger(void);
274 
275  //Error handling
276  MUTILS_API void fatal_exit(const wchar_t* const errorMessage);
277  }
278 }
279 
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:108
+
Local application data (non-roaming)
Definition: OSSupport.h:109
unsigned int versionMinor
The minor version of the underlaying operating system.
Definition: OSSupport.h:75
-
Program files.
Definition: OSSupport.h:109
+
Program files.
Definition: OSSupport.h:111
unsigned int versionBuild
The build number of the underlaying operating system.
Definition: OSSupport.h:76
-
System "root" directory.
Definition: OSSupport.h:111
+
System "root" directory.
Definition: OSSupport.h:113
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...
+
Application-specific data.
Definition: OSSupport.h:108
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:129
+
drive_type_t
This enumeration specifies drive types.
Definition: OSSupport.h:131
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:133
-
Optical disk srive, e.g. CD or DVD.
Definition: OSSupport.h:135
+
Hard Disk drive or Solid-State Drive.
Definition: OSSupport.h:135
+
Optical disk srive, e.g. CD or DVD.
Definition: OSSupport.h:137
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
unsigned int versionSPack
The service pack version of the underlaying operating system.
Definition: OSSupport.h:77
-
Remote/Network drive.
Definition: OSSupport.h:134
+
Remote/Network drive.
Definition: OSSupport.h:136
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:121
-
The drive type cannot be determined.
Definition: OSSupport.h:131
+
Computer is not connected to a network.
Definition: OSSupport.h:123
+
The drive type cannot be determined.
Definition: OSSupport.h:133
+
The user&#39;s profile folder.
Definition: OSSupport.h:110
MUTILS_API const os_version_t WINDOWS_WINXP
Operating system version constant.
-
Floppy Drive, or Flash Card reader.
Definition: OSSupport.h:132
-
RAM disk.
Definition: OSSupport.h:136
+
Floppy Drive, or Flash Card reader.
Definition: OSSupport.h:134
+
RAM disk.
Definition: OSSupport.h:138
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:118
-
Computer is connected to a network.
Definition: OSSupport.h:122
-
System directory.
Definition: OSSupport.h:110
+
network_type_t
This enumeration specifies network connection types.
Definition: OSSupport.h:120
+
Computer is connected to a network.
Definition: OSSupport.h:124
+
System directory.
Definition: OSSupport.h:112
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:106
MUTILS_API const os_version_t WINDOWS_XPX64
Operating system version constant.
-
Network connection is unknown.
Definition: OSSupport.h:120
+
Network connection is unknown.
Definition: OSSupport.h:122
Enumerator
FOLDER_LOCALAPPDATA 

Local application data (non-roaming)

+
Enumerator
FOLDER_ROAMING_DATA 

Application-specific data.

+
FOLDER_LOCALAPPDATA 

Local application data (non-roaming)

+
FOLDER_USER_PROFILE 

The user's profile folder.

FOLDER_PROGRAMFILES 

Program files.

 This enumeration specifies the type of the underlaying operating system. More...
 
enum  MUtils::OS::known_folder_t { MUtils::OS::FOLDER_LOCALAPPDATA = 0, -MUtils::OS::FOLDER_PROGRAMFILES = 2, -MUtils::OS::FOLDER_SYSTEMFOLDER = 3, -MUtils::OS::FOLDER_SYSTROOT_DIR = 4 +
enum  MUtils::OS::known_folder_t {
+  MUtils::OS::FOLDER_ROAMING_DATA = 0, +MUtils::OS::FOLDER_LOCALAPPDATA = 1, +MUtils::OS::FOLDER_USER_PROFILE = 2, +MUtils::OS::FOLDER_PROGRAMFILES = 3, +
+  MUtils::OS::FOLDER_SYSTEMFOLDER = 4, +MUtils::OS::FOLDER_SYSTROOT_DIR = 5 +
}
 This enumeration specifies "known" folder identifiers. More...