include/MUtils/Global.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // 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
  20 //////////////////////////////////////////////////////////////////////////////////
  21
  22 /**
  23  * @file
  24  * @brief This file contains miscellaneous functions that are generally useful for Qt-based applications
  25  */
  26
  27 #pragma once
  28
  29 #include <QString>
  30
  31 //Forward Declarations
  32 class QProcess;
  33
  34 ///////////////////////////////////////////////////////////////////////////////
  35
  36 /** \cond INTERNAL
  37  */
  38
  39 //MUtils API
  40 #ifdef _MSC_VER
  41 #       ifdef MUTILS_DLL_EXPORT
  42 #               define MUTILS_API __declspec(dllexport)
  43 #       else
  44 #               ifndef MUTILS_STATIC_LIB
  45 #                       define MUTILS_API __declspec(dllimport)
  46 #               else
  47 #                       define MUTILS_API /*static lib*/
  48 #               endif
  49 #       endif
  50 #else
  51 #       define MUTILS_API
  52 #endif
  53
  54 #define MUTILS_MAKE_STRING_HELPER(X) #X
  55 #define MUTILS_MAKE_STRING(X) MUTILS_MAKE_STRING_HELPER(X)
  56 #define MUTILS_COMPILER_WARNING(TXT) __pragma(message(__FILE__ "(" MUTILS_MAKE_STRING(__LINE__) ") : warning: " TXT))
  57
  58 //Check Debug Flags
  59 #if defined(_DEBUG) || defined(DEBUG) || (!defined(NDEBUG))
  60 #       define MUTILS_DEBUG (1)
  61 #       if defined(NDEBUG) || defined(QT_NO_DEBUG) || (!defined(QT_DEBUG))
  62 #               error Inconsistent DEBUG flags have been detected!
  63 #       endif
  64 #else
  65 #       define MUTILS_DEBUG (0)
  66 #       if (!defined(NDEBUG)) || (!defined(QT_NO_DEBUG)) || defined(QT_DEBUG)
  67 #               error Inconsistent DEBUG flags have been detected!
  68 #       endif
  69 #endif
  70
  71 //Check CPU options
  72 #if defined(_MSC_VER) && (!defined(__INTELLISENSE__)) && (!defined(_M_X64)) && defined(_M_IX86_FP)
  73         #if (_M_IX86_FP != 0)
  74                 #error We should not enabled SSE or SSE2 in release builds!
  75         #endif
  76 #endif
  77
  78 /** \endcond INTERNAL
  79  */
  80
  81 ///////////////////////////////////////////////////////////////////////////////
  82
  83 /**
  84 * \brief Global MUtils namespace
  85 */
  86 namespace MUtils
  87 {
  88         /**
  89         * \brief Rerieves the full path of the application's *Temp* folder.
  90         *
  91         * The application's *Temp* folder is a unique application-specific folder, intended to store any temporary files that the application may need. It will be created when this function is called for the first time (lazy initialization); subsequent calls are guaranteed to return the same path. Usually the application's *Temp* folder will be created as a sub-folder of the system's global *Temp* folder, as indicated by the `TMP` or `TEMP` environment variables. However, it may be created at a different place (e.g. in the users *Profile* directory), if those environment variables don't point to a usable directory. In any case, this function makes sure that the application's *Temp* folder exists for the whole lifetime of the application and that it is writable. When the application terminates normally, the application's *Temp* folder and all files or sub-directories thereof will be *removed* automatically!
  92         *
  93         * \return If the function succeeds, it returns a read-only reference to a QString holding the full path of the application's *Temp* folder; otherwise a read-only reference to a default-constructed QString is returned.
  94         */
  95         MUTILS_API const QString& temp_folder(void);
  96
  97         /**
  98         * \brief Initialize a given [QProcess](http://doc.qt.io/qt-4.8/qprocess.html) object.
  99         *
 100         * This function prepares a given [QProcess](http://doc.qt.io/qt-4.8/qprocess.html) object for sub-process creation. It does so by setting up combined *stdout* and *stderr* redirection for the sub-process, cleaning up the sub-process' environment variables, as well as setting up the sub-process' working directory. Optionally, the *Temp* directory for the sub-process can be set to the application-specific *Temp* directory, which is achieved by overwriting the corresponding environment variables (e.g. `TMP` and `TEMP`). Furthermore, additional paths can be added to the `PATH` environment variable of the sub-process.
 101         *
 102         * \param process A reference to the [QProcess](http://doc.qt.io/qt-4.8/qprocess.html) object to be initialized. The [QProcess](http://doc.qt.io/qt-4.8/qprocess.html) object must be initialized *before* calling the `QProcess::start()` method.
 103         *
 104         * \param process A read-only reference to a QString holding the path of the working directory for the sub-process.
 105         *
 106         * \param bReplaceTempDir If set to `true`, the *Temp* directory for the sub-process is set to the application-specific *Temp* directory; if set to `false`, the default *Temp* directory is retained.
 107         *
 108         * \param extraPaths A read-only pointer to a QStringList object containing additional paths that will be added (prepended) to the sub-process' `PATH` environment variable. This parameter can be `NULL`, in which case *no* additional paths are added.
 109         */
 110         MUTILS_API void init_process(QProcess &process, const QString &wokringDir, const bool bReplaceTempDir = true, const QStringList *const extraPaths = NULL);
 111
 112         /**
 113         * \brief Generates a *random* unsigned 32-Bit value.
 114         *
 115         * The *random* value is created using a "strong" PRNG of the underlying system, if possible. Otherwise a fallback PRNG is used. It is **not** required or useful to call `srand()` or `qsrand()` prior to using this function. If necessary, the seeding of the PRNG happen *automatically* on the first call.
 116         *
 117         * \return The function returns a *random* unsigned 32-Bit value.
 118         */
 119         MUTILS_API quint32 next_rand_u32(void);
 120
 121         /**
 122         * \brief Generates a *random* unsigned 64-Bit value.
 123         *
 124         * The *random* value is created using a "strong" PRNG of the underlying system, if possible. Otherwise a fallback PRNG is used. It is **not** required or useful to call `srand()` or `qsrand()` prior to using this function. If necessary, the seeding of the PRNG happen *automatically* on the first call.
 125         *
 126         * \return The function returns a *random* unsigned 64-Bit value.
 127         */
 128         MUTILS_API quint64 next_rand_u64(void);
 129
 130         /**
 131         * \brief Generates a *random* string.
 132         *
 133         * The random string is generated using the same PRNG as the `next_rand_u64()` function. The *random* bytes are converted to a hexadecimal string and, if necessary, zero-padded to a toal length of 16 or 32 characters. There is **no** `0x`-prefix included in the result.
 134         *
 135         * \param bLong If set to `true`, a "long" random string (32 characters) will be generated; if set to `false`, a "short" random string (16 characters) is generated.
 136         *
 137         * \return The function returns a QString holding a *random* hexadecimal string
 138         */
 139         MUTILS_API QString next_rand_str(const bool &bLong = false);
 140
 141         /**
 142         * \brief Generates a temporary file name.
 143         *
 144         * The function generates a file name that contains a *random* component and that is guaranteed to **not** exist yet. The generated file name follows a `"<basedir>/<random>.<ext>"` pattern. This is useful (not only) for creating temporary files.
 145         *
 146         * \param basePath Specifies the "base" directory where the temporary file is supposed to be created. This must be a valid *existing* directory.
 147         *
 148         * \param extension Specifies the desired file extensions of the temporary file. Do **not** include a leading dot (`.`) character.
 149         *
 150         * \param placeholder If set to `true`, the function creates an empty "placeholder" file under the returned file name; if set to `false`, it does *not*.
 151         *
 152         * \return If the function succeeds, it returns a QString holding the full path of the temporary file; otherwise it returns a default-constructed QString.
 153         */
 154         MUTILS_API QString make_temp_file(const QString &basePath, const QString &extension, const bool placeholder = false);
 155
 156         /**
 157         * \brief Generates a unique file name.
 158         *
 159         * The function generates a unique file name in the specified directory. The function guarantees that the returned file name does *not* exist yet. If necessary, a *counter* will be included in the file name in order to ensure its uniqueness.
 160         *
 161         * \param basePath Specifies the "base" directory where the unique file is supposed to be created. This must be a valid *existing* directory.
 162         *
 163         * \param baseName Specifies the desired "base" file name of the unique file. Do **not** include a file extension.
 164         *
 165         * \param extension Specifies the desired file extensions of the unique file. Do **not** include a leading dot (`.`) character.
 166         *
 167         * \param fancy If set to `true`, the unique file name is generated according to the `"<basedir>/<basename> (N).<ext>"` pattern; if set to `false`, it is generated according to the `"<basedir>/<basename>.XXXX.<ext>"` pattern. Also, if set to `true`, a counter is only included in the file name, if the file name *without* counter already exists; if set to `false`, a counter is always included. Finally, if set to `true`, the counter starts at **2** and is printed in decimal format; if set to `false`, the counter starts at **0** and is printed in zero-padded hexadecimal format.
 168         *
 169         * \return If the function succeeds, it returns a QString holding the full path of the unique file; otherwise it returns a default-constructed QString.
 170         */
 171         MUTILS_API QString make_unique_file(const QString &basePath, const QString &baseName, const QString &extension, const bool fancy = false);
 172
 173         /**
 174         * \brief Computes the *parity* of the given unsigned 32-Bit value
 175         *
 176         * \param value The 32-Bit unsigned value from which the parity is to be computed.
 177         *
 178         * \return The function returns `true`, if the number of **1** bits in the given value is *odd*; it returns `false`, if the number of **1** bits in the given value is *even*.
 179         */
 180         MUTILS_API bool parity(quint32 value);
 181
 182         /**
 183         * \brief Deletes the specified file
 184         *
 185         * The function deletes the specified file, even if it has the "read only" flag set. If the file is currently locked (e.g. by another process), the function retries multiple times to delete the file before it fails.
 186         *
 187         * \param fileName The path to the file to be deleted. This should be a full path.
 188         *
 189         * \return The function returns `true`, if the file was deleted successfully or if the file doesn't exist; it returns `false`, if the file could *not* be deleted.
 190         */
 191         MUTILS_API bool remove_file(const QString &fileName);
 192
 193         /**
 194         * \brief Recursively deletes the specified directory
 195         *
 196         * The function deletes the specified directory. In *recursive* mode, the directory will be removed including all of its files and sub-directories. Files are deleted using the `remove_file()` function.
 197         *
 198         * \param folderPath The path to the directory to be deleted. This should be a full path.
 199         *
 200         * \param recursive If set to `true` the function removes all files and sub-directories in the specified directory; if set to `false`, the function will *not* try to delete any files or sub-directories, which means that it will fail on non-empty directories.
 201         *
 202         * \return The function returns `true`, if the directory was deleted successfully or if the directory doesn't exist; it returns `false`, if the directory could *not* be deleted.
 203         */
 204         MUTILS_API bool remove_directory(const QString &folderPath, const bool &recursive);
 205
 206         /**
 207         * \brief Remove *trailing* white-space characters
 208         *
 209         * The function removes all *trailing* white-space characters from the specified string. Leading white-space characters are *not* removed. White-space characters are defined by the `\s` character class.
 210         *
 211         * \param str A reference to the QString object to be trimmed. This QString object will be modified directly.
 212         *
 213         * \return A reference to the trimmed QString object. This is the same QString object that was specified in the `str` parameter.
 214         */
 215         MUTILS_API QString& trim_right(QString &str);
 216
 217         /**
 218         * \brief Remove *leading* white-space characters
 219         *
 220         * The function removes all *leading* white-space characters from the specified string. Trailing white-space characters are *not* removed. White-space characters are defined by the `\s` character class.
 221         *
 222         * \param str A reference to the QString object to be trimmed. This QString object will be modified directly.
 223         *
 224         * \return A reference to the trimmed QString object. This is the same QString object that was specified in the `str` parameter.
 225         */
 226         MUTILS_API QString& trim_left(QString &str);
 227
 228         /**
 229         * \brief Remove *trailing* white-space characters
 230         *
 231         * The function removes all *trailing* white-space characters from the specified string. Leading white-space characters are *not* removed. White-space characters are defined by the `\s` character class.
 232         *
 233         * \param str A read-only reference to the QString object to be trimmed. The original QString object is *not* modified.
 234         *
 235         * \return A new QString object that equals the original QString object, except that it has all *trailing* white-space characters removed.
 236         */
 237         MUTILS_API QString trim_right(const QString &str);
 238
 239         /**
 240         * \brief Remove *trailing* white-space characters
 241         *
 242         * The function removes all *leading* white-space characters from the specified string. Trailing white-space characters are *not* removed. White-space characters are defined by the `\s` character class.
 243         *
 244         * \param str A read-only reference to the QString object to be trimmed. The original QString object is *not* modified.
 245         *
 246         * \return A new QString object that equals the original QString object, except that it has all *leading* white-space characters removed.
 247         */
 248         MUTILS_API QString trim_left(const QString &str);
 249
 250         /**
 251         * \brief Sort a list of strings using "natural ordering" algorithm
 252         *
 253         * This function implements a sort algorithm that orders alphanumeric strings in the way a human being would. See [*Natural Order String Comparison*](http://sourcefrog.net/projects/natsort/) for details!
 254         *
 255         * \param list A reference to the QStringList object to be sorted. The list will be sorted "in place".
 256         *
 257         * \param bIgnoreCase If set to `true`, the list will be sorted disregarding the character case, i.e. upper-case and lower-case characters (of the same letter) are treated the same; if set to `false`, the character case *is* taken into account.
 258         */
 259         MUTILS_API void natural_string_sort(QStringList &list, const bool bIgnoreCase);
 260
 261         /**
 262         * \brief Clean up a file name string
 263         *
 264         * This function ensures that the given string is a valid file (or directory) name. It does so by replacing any illegal characters, i.e. any characters *not* allowed in file names (which explicitly *includes* directory separators). Furthermore, the function will trim/remove specific characters that are *not* allowed directly at the beginning or end of a file name. Finally, the function takes care of special "reserved" file names that are forbidden by the file system. You can use this function to convert user inputs into a valid file name.
 265         *
 266         * \param name A read-only reference to the QString holding the original, potentially invalid file name.
 267         *
 268         * \param pretty If set to `true`, the function tries to generate a "pretty" file name from the given file name. Otherwise, the function simply replaces each forbidden file name character by an underscore character.
 269         *
 270         * \return The function returns a QString holding a valid file name. If, however, the input string was empty or contained only white-space characters, the returned sting can be empty.
 271         */
 272         MUTILS_API QString clean_file_name(const QString &name, const bool &pretty);
 273
 274         /**
 275         * \brief Clean up a file path string
 276         *
 277         * This function ensures that the given string is a valid file (or directory) path. It does so by replacing any illegal characters, i.e. any characters *not* allowed in file paths. Directory separators are preserved, but they will be "canonicalized". Furthermore, in each path component, the function will trim/remove specific characters that are *not* allowed directly at the beginning or end of a path component. Finally, the function takes care of special "reserved" file names that are forbidden by the file system. You can use this function to convert user inputs into a valid file path.
 278         *
 279         * \param path A read-only reference to the QString holding the original, potentially invalid file path.
 280         *
 281         * \param pretty If set to `true`, the function tries to generate "pretty" file names from the given file names. Otherwise, the function simply replaces each forbidden file name character by an underscore character.
 282         *
 283         * \return The function returns a QString holding a valid file path. If, however, the input string was empty or contained only white-space characters, the returned sting can be empty.
 284         */
 285         MUTILS_API QString clean_file_path(const QString &path, const bool &pretty);
 286
 287         /**
 288         * \brief Parse regular expression results
 289         *
 290         * This function tries to parses the result (capture) of a regular expression as an unsigned 32-Bit value. The given regular expression must contain at least *one* capture. Only the *first* capture is considered, additional captures are ignored.
 291         *
 292         * \param regexp A read-only reference to the [QRegExp](http://doc.qt.io/qt-4.8/qregexp.html) object whose result (capture) will be parsed. This [QRegExp](http://doc.qt.io/qt-4.8/qregexp.html) must already have been *successfully* matched against the respective input string, e.g. via `QRegExp::indexIn()`, prior to calling this function.
 293         *
 294         * \param value A reference to a variable of type `quint32`, where the unsigned 32-Bit representation of the result will be stored. The contents of this variable are *undefined*, if the function failed.
 295         *
 296         * \return The function returns `true`, if the regular expression's capture could be parsed successfully; it returns `false`, if the capture contains an invalid string or if there are insufficient captures in given the [QRegExp](http://doc.qt.io/qt-4.8/qregexp.html) object.
 297         */
 298         MUTILS_API bool regexp_parse_uint32(const QRegExp &regexp, quint32 &value);
 299
 300         /**
 301         * \brief Parse regular expression results
 302         *
 303         * This function tries to parses the results (captures) of a regular expression as unsigned 32-Bit values. The given regular expression must contain at least \p count captures. Only the *first* \p count captures are considered, additional captures are ignored.
 304         *
 305         * \param regexp A read-only reference to the [QRegExp](http://doc.qt.io/qt-4.8/qregexp.html) object whose results (captures) will be parsed. This [QRegExp](http://doc.qt.io/qt-4.8/qregexp.html) must already have been *successfully* matched against the respective input string, e.g. via `QRegExp::indexIn()`, prior to calling this function.
 306         *
 307         * \param value A pointer to an array of type `quint32`, where the unsigned 32-Bit representations of the results will be stored (the `n`-th result is stored at `value[n-1]`). The array must be at least \p count elements in length. The contents of this array are *undefined*, if the function failed.
 308         *
 309         * \param count Specifies the number of results (captures) in the given [QRegExp](http://doc.qt.io/qt-4.8/qregexp.html) object. The function tries to parse the first \p count captures and ignores any additional captures that may exist. This parameter also determines the required (minimum) length of the \p value array.
 310         *
 311         * \return The function returns `true`, if all of the regular expression's captures could be parsed successfully; it returns `false`, if any of the captures contain an invalid string or if there are insufficient captures in given the [QRegExp](http://doc.qt.io/qt-4.8/qregexp.html) object.
 312         */
 313         MUTILS_API bool regexp_parse_uint32(const QRegExp &regexp, quint32 *values, const size_t &count);
 314
 315         /**
 316         * \brief Retrieve a list of all available codepages
 317         *
 318         * The function generates a list of all codepages that are available on the system. Each codepage name returned by this function may be passed to the `QTextCodec::codecForName()` function in order to obtain a corresponding [QTextCodec](http://doc.qt.io/qt-4.8/qtextcodec.html) object.
 319         *
 320         * \param noAliases If set to `true`, only distinct codepages are returned, i.e. any codepage aliases are discarded from the list; if set to `false`, the returned list may (and usually will) also contain codepage aliases.
 321         *
 322         * \return If the function succeeds, it returns a QStringList holding the names of all codepages available on the system; otherwise it returns a default-constructed QStringList.
 323         */
 324         MUTILS_API QStringList available_codepages(const bool &noAliases = true);
 325
 326         //Internal
 327         namespace Internal
 328         {
 329                 MUTILS_API int selfTest(const char *const buildKey, const bool debug);
 330                 static const int s_selfTest = selfTest(__DATE__ "@" __TIME__, MUTILS_DEBUG);
 331         }
 332 }
 333
 334 ///////////////////////////////////////////////////////////////////////////////
 335
 336 /** \brief Deletes the object, if and only if the given pointer is *not* NULL. Also sets pointer to NULL after object has been deleted.
 337 */
 338 #define MUTILS_DELETE(PTR) do { if((PTR)) { delete (PTR); (PTR) = NULL; } } while(0)
 339
 340 /** \brief Deletes the array, if and only if the given pointer is *not* NULL. Also sets pointer to NULL after array has been deleted.
 341 */
 342 #define MUTILS_DELETE_ARRAY(PTR) do { if((PTR)) { delete [] (PTR); (PTR) = NULL; } } while(0)
 343
 344 /** \brief Clears the specified variable or struct by setting all of its bytes to *zero* (`0x00`). Do **not** use for arrays.
 345 */
 346 #define MUTILS_ZERO_MEMORY(PTR) memset(&(PTR), 0, sizeof((PTR)))
 347
 348 /** \brief Converts a given QString object to a `wchar_t*` pointer. Does **not** copy the string data, so do **not** free the pointer! The returned pointer only remains valid until the underlying QString is modified or goes out of scope.
 349 */
 350 #define MUTILS_WCHR(STR) (reinterpret_cast<const wchar_t*>((STR).utf16()))
 351
 352 /** \brief Converts a given QString object to a `char*` pointer. The string is converted to UTF-8 encoding. The pointer is valid *only* while the expression is being evaluated, so do **not** free or store this pointer! Mainly useful for function calls that require a `char*` argument.
 353 */
 354 #define MUTILS_UTF8(STR) ((STR).toUtf8().constData())
 355
 356 /** \brief Creates a QString object from a given `wchar_t*` buffer. The buffer is expected to conatin a NULL-terminated string in UTF-16 encoding. The string data is copied into the new QString object, however the original buffer will **not** be freed automatically!
 357 */
 358 #define MUTILS_QSTR(STR) (QString::fromUtf16(reinterpret_cast<const unsigned short*>((STR))))
 359
 360 /** \brief Converts a boolean expression into a string. A *true* boolean expression is converted to the string `"1"`; a *false* boolean expression is converted to the string `"0"`.
 361 */
 362 #define MUTILS_BOOL2STR(X) ((X) ? "1" : "0")
 363
 364 /** \brief Disables copy constructor and assignment operator in the specified class. This macro should be used in the "private" section of the class' declaration.
 365 */
 366 #define MUTILS_NO_COPY(CLASS) \
 367         CLASS(const CLASS &) { throw "Copy constructor is disabled!"; } \
 368         CLASS &operator=(const CLASS &) { throw "Assignment operator is disabled!"; }