-Go to the documentation of this file.

 // MuldeR's Utilities for Qt
 // Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de>
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 // License as published by the Free Software Foundation; either
 // version 2.1 of the License, or (at your option) any later version.
 //
 // This library is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 // Lesser General Public License for more details.
 //
 // You should have received a copy of the GNU Lesser General Public
 // License along with this library; if not, write to the Free Software
 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 //
 // http://www.gnu.org/licenses/lgpl-2.1.txt
 
 #pragma once
 
 #include <QString>
 
 //Forward Declarations
 class QProcess;
 
 
 //MUtils API
 #ifdef _MSC_VER
 #   ifdef MUTILS_DLL_EXPORT
 #       define MUTILS_API __declspec(dllexport)
 #   else
 #       ifndef MUTILS_STATIC_LIB
 #           define MUTILS_API __declspec(dllimport)
 #       else
 #           define MUTILS_API /*static lib*/
 #       endif
 #   endif
 #else
 #   define MUTILS_API
 #endif
 
 //Helper Macros
 #define MUTILS_MAKE_STRING_HELPER(X) #X
 #define MUTILS_MAKE_STRING(X) MUTILS_MAKE_STRING_HELPER(X)
 #define MUTILS_COMPILER_WARNING(TXT) __pragma(message(__FILE__ "(" MUTILS_MAKE_STRING(__LINE__) ") : warning: " TXT))
 
 //Check Debug Flags
 #if defined(_DEBUG) || defined(DEBUG) || (!defined(NDEBUG))
 #   define MUTILS_DEBUG (1)
 #   if defined(NDEBUG) || defined(QT_NO_DEBUG) || (!defined(QT_DEBUG))
 #       error Inconsistent DEBUG flags have been detected!
 #   endif
 #else
 #   define MUTILS_DEBUG (0)
 #   if (!defined(NDEBUG)) || (!defined(QT_NO_DEBUG)) || defined(QT_DEBUG)
 #       error Inconsistent DEBUG flags have been detected!
 #   endif
 #endif
 
 //Check CPU options
 #if defined(_MSC_VER) && (!defined(__INTELLISENSE__)) && (!defined(_M_X64)) && defined(_M_IX86_FP)
     #if (_M_IX86_FP != 0)
         #error We should not enabled SSE or SSE2 in release builds!
     #endif
 #endif
 
 
 namespace MUtils
 {
     MUTILS_API const QString& temp_folder(void);
 
     //Process Utils
     MUTILS_API void init_process(QProcess &process, const QString &wokringDir, const bool bReplaceTempDir = true, const QStringList *const extraPaths = NULL);
 
     MUTILS_API quint32 next_rand_u32(void);
     
     MUTILS_API quint64 next_rand_u64(void);
     
     MUTILS_API QString next_rand_str(const bool &bLong = false);
 
     MUTILS_API QString make_temp_file(const QString &basePath, const QString &extension, const bool placeholder = false);
 
     MUTILS_API QString make_unique_file(const QString &basePath, const QString &baseName, const QString &extension, const bool fancy = false);
 
     MUTILS_API bool parity(quint32 value);
 
     MUTILS_API bool remove_file(const QString &fileName);
 
     MUTILS_API bool remove_directory(const QString &folderPath, const bool &recursive);
 
     MUTILS_API QString& trim_right(QString &str);
 
     MUTILS_API QString& trim_left(QString &str);
 
     MUTILS_API QString trim_right(const QString &str);
 
     MUTILS_API QString trim_left(const QString &str);
 
     MUTILS_API void natural_string_sort(QStringList &list, const bool bIgnoreCase);
 
 
     MUTILS_API QString clean_file_name(const QString &name);
     MUTILS_API QString clean_file_path(const QString &path);
 
     MUTILS_API bool regexp_parse_uint32(const QRegExp &regexp, quint32 &value);
 
     MUTILS_API bool regexp_parse_uint32(const QRegExp &regexp, quint32 *values, const size_t &count);
 
     MUTILS_API QStringList available_codepages(const bool &noAliases = true);
 
     //Internal
     namespace Internal
     {
         MUTILS_API int selfTest(const char *const buildKey, const bool debug);
         static const int s_selfTest = selfTest(__DATE__ "@" __TIME__, MUTILS_DEBUG);
     }
 }
 
 
 //Delete helper
 #define MUTILS_DELETE(PTR) do { if((PTR)) { delete (PTR); (PTR) = NULL; } } while(0)
 #define MUTILS_DELETE_ARRAY(PTR) do { if((PTR)) { delete [] (PTR); (PTR) = NULL; } } while(0)
 
 //Zero memory
 #define MUTILS_ZERO_MEMORY(PTR) memset(&(PTR), 0, sizeof((PTR)))
 
 //String conversion macros
 #define MUTILS_WCHR(STR) (reinterpret_cast<const wchar_t*>((STR).utf16()))
 #define MUTILS_UTF8(STR) ((STR).toUtf8().constData())
 #define MUTILS_QSTR(STR) (QString::fromUtf16(reinterpret_cast<const unsigned short*>((STR))))
 
 //Boolean helper
 #define MUTILS_BOOL2STR(X) ((X) ? "1" : "0")

+Go to the documentation of this file. // MuldeR's Utilities for Qt
 // Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de>
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 // License as published by the Free Software Foundation; either
 // version 2.1 of the License, or (at your option) any later version.
 //
 // This library is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 // Lesser General Public License for more details.
 //
 // You should have received a copy of the GNU Lesser General Public
 // License along with this library; if not, write to the Free Software
 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 //
 // http://www.gnu.org/licenses/lgpl-2.1.txt
 
 #pragma once
 
 #include <QString>
 
 //Forward Declarations
 class QProcess;
 
 
 //MUtils API
 #ifdef _MSC_VER
 #   ifdef MUTILS_DLL_EXPORT
 #       define MUTILS_API __declspec(dllexport)
 #   else
 #       ifndef MUTILS_STATIC_LIB
 #           define MUTILS_API __declspec(dllimport)
 #       else
 #           define MUTILS_API /*static lib*/
 #       endif
 #   endif
 #else
 #   define MUTILS_API
 #endif
 
 //Helper Macros
 #define MUTILS_MAKE_STRING_HELPER(X) #X
 #define MUTILS_MAKE_STRING(X) MUTILS_MAKE_STRING_HELPER(X)
 #define MUTILS_COMPILER_WARNING(TXT) __pragma(message(__FILE__ "(" MUTILS_MAKE_STRING(__LINE__) ") : warning: " TXT))
 
 //Check Debug Flags
 #if defined(_DEBUG) || defined(DEBUG) || (!defined(NDEBUG))
 #   define MUTILS_DEBUG (1)
 #   if defined(NDEBUG) || defined(QT_NO_DEBUG) || (!defined(QT_DEBUG))
 #       error Inconsistent DEBUG flags have been detected!
 #   endif
 #else
 #   define MUTILS_DEBUG (0)
 #   if (!defined(NDEBUG)) || (!defined(QT_NO_DEBUG)) || defined(QT_DEBUG)
 #       error Inconsistent DEBUG flags have been detected!
 #   endif
 #endif
 
 //Check CPU options
 #if defined(_MSC_VER) && (!defined(__INTELLISENSE__)) && (!defined(_M_X64)) && defined(_M_IX86_FP)
     #if (_M_IX86_FP != 0)
         #error We should not enabled SSE or SSE2 in release builds!
     #endif
 #endif
 
 
 namespace MUtils
 {
     MUTILS_API const QString& temp_folder(void);
 
     //Process Utils
     MUTILS_API void init_process(QProcess &process, const QString &wokringDir, const bool bReplaceTempDir = true, const QStringList *const extraPaths = NULL);
 
     MUTILS_API quint32 next_rand_u32(void);
     
     MUTILS_API quint64 next_rand_u64(void);
     
     MUTILS_API QString next_rand_str(const bool &bLong = false);
 
     MUTILS_API QString make_temp_file(const QString &basePath, const QString &extension, const bool placeholder = false);
 
     MUTILS_API QString make_unique_file(const QString &basePath, const QString &baseName, const QString &extension, const bool fancy = false);
 
     MUTILS_API bool parity(quint32 value);
 
     MUTILS_API bool remove_file(const QString &fileName);
 
     MUTILS_API bool remove_directory(const QString &folderPath, const bool &recursive);
 
     MUTILS_API QString& trim_right(QString &str);
 
     MUTILS_API QString& trim_left(QString &str);
 
     MUTILS_API QString trim_right(const QString &str);
 
     MUTILS_API QString trim_left(const QString &str);
 
     MUTILS_API void natural_string_sort(QStringList &list, const bool bIgnoreCase);
 
     MUTILS_API QString clean_file_name(const QString &name);
     MUTILS_API QString clean_file_path(const QString &path);
 
     MUTILS_API bool regexp_parse_uint32(const QRegExp &regexp, quint32 &value);
 
     MUTILS_API bool regexp_parse_uint32(const QRegExp &regexp, quint32 *values, const size_t &count);
 
     MUTILS_API QStringList available_codepages(const bool &noAliases = true);
 
     //Internal
     namespace Internal
     {
         MUTILS_API int selfTest(const char *const buildKey, const bool debug);
         static const int s_selfTest = selfTest(__DATE__ "@" __TIME__, MUTILS_DEBUG);
     }
 }
 
 
 //Delete helper
 #define MUTILS_DELETE(PTR) do { if((PTR)) { delete (PTR); (PTR) = NULL; } } while(0)
 #define MUTILS_DELETE_ARRAY(PTR) do { if((PTR)) { delete [] (PTR); (PTR) = NULL; } } while(0)
 
 //Zero memory
 #define MUTILS_ZERO_MEMORY(PTR) memset(&(PTR), 0, sizeof((PTR)))
 
 //String conversion macros
 #define MUTILS_WCHR(STR) (reinterpret_cast<const wchar_t*>((STR).utf16()))
 #define MUTILS_UTF8(STR) ((STR).toUtf8().constData())
 #define MUTILS_QSTR(STR) (QString::fromUtf16(reinterpret_cast<const unsigned short*>((STR))))
 
 //Boolean helper
 #define MUTILS_BOOL2STR(X) ((X) ? "1" : "0")

diff --git a/docs/index.html b/docs/index.html
index f37c015..565e796 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -5,7 +5,7 @@
 
-MuldeR's Utilities for Qt: MuldeR's Utilities for Qt
+MuldeR's Utilities for Qt: Main Page
@@ -60,17 +60,68 @@ $(function() {
 
 
-MuldeR's Utilities for Qt 

+MuldeR's Utilities for Qt Documentation

-The MUtilities library is a collection of routines and classes to extend the Qt cross-platform framework. It contains various convenience and utility functions as well as wrappers for OS-specific functionalities. The library was originally created as a "side product" of the LameXP application: Over the years, a lot of code, not really specific to LameXP, had accumulated in the LameXP code base. Some of that code even had been used in other projects too, in a "copy & paste" fashion – which had lead to redundancy and much complicated maintenance. In order to clean-up the LameXP code base, to eliminate the ugly redundancy and to simplify maintenance, the code in question has finally been refactored into the MUtilities (aka "MuldeR's Utilities for Qt") library. This library now forms the foundation of LameXP and other OpenSource projects.

-API-Documentation
-The public API of the MUtilities library is defined in the following header files:

+Introduction
+The MUtilities library is a collection of routines and classes to extend the Qt cross-platform framework. It contains various convenience and utility functions as well as wrappers for OS-specific functionalities. The library was originally created as a "side product" of the LameXP application: Over the years, a lot of code, not really specific to LameXP, had accumulated in the LameXP code base. Some of that code even had been used in other projects too, in a "copy & paste" fashion – which had lead to redundancy and much complicated maintenance. In order to clean-up the LameXP code base, to eliminate the ugly redundancy and to simplify maintenance, the code in question has finally been refactored into the MUtilities (aka "MuldeR's Utilities for Qt") library. This library now forms the foundation of LameXP and other OpenSource projects.

+Project Structure
+The MUtilities project directory is organized as follows:

+
+bin/ – compiled library files (static or shared), link those files in projects that use the MUtilities library

+docs/ – programming interface documentation, generated with Doxygen tool

+etc/ – miscellaneous files, everything that doesn't fit in anywhere else

+include/ – public header files, include this directory in projects that use the MUtilities library

+obj/ – object code files, intermediate files generated during the build process

+res/ – resource files, required for building the MUtilities library

+src/ – source code files, required for building the MUtilities library (third-party code in src/3rd_party/)

+test/ – unit tests, based on Google Test framework

+tmp/ – temporary files, automatically generated during the build process

+
+API Documentation
+The public API of the MUtilities library is defined in the following header files (select file for details):
Global.h – miscellaneous useful functions

-License
-This library is free software. It is released under the terms of the GNU Lesser General Public License (LGPL), Version 2.1.

-MUtilities - MuldeR's Utilities for Qt
Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de>. Some rights reserved.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.

+Example
+Here is a minimal example on how to use the MUtilities library in your project: 
//MUtils
+#include <MUtils/Global.h>
+
+int main(int argc, char **argv)
+{
+    qDebug("Random number: %u\n", MUtils::next_rand_u32());
+}
+Build Notes
+
+In order to use the MUtilities library in your project, your build environment must have already been set up for building Qt-based projects. Setting up Qt is not covered by this document.

+Additionally, make sure that MUtilities' include/ directory is contained in your "Additional Include Directories" and that the MUtilities' bin/ directory is contained in your "Additional Library Directories".

+Finally, make sure that your project links against the MUtils32-1.lib library file. For each build configuration, pick the proper **.lib** file from the corresponding bin/<platform>/<config>/ directory!

+If your projects intends to use the MUtilities library as a static library, then the macro MUTILS_STATIC_LIB must be added to your project's "Preprocessor Definitions".

+
+License
+This library is free software. It is released under the terms of the GNU Lesser General Public License (LGPL), Version 2.1. 
MUtilities - MuldeR's Utilities for Qt
+Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de>. Some rights reserved.
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.
+Acknowledgement
+The following third-party code is used in the MUtilities library:

+
+Keccak/SHA-3 Reference Implementation Implementation by the Keccak, Keyak and Ketje Teams, namely, Guido Bertoni, Joan Daemen, MichaÃ«l Peeters, Gilles Van Assche and Ronny Van Keer No Copyright / Dedicated to the Public Domain

+Natural Order String Comparison Copyright (C) 2000, 2004 by Martin Pool mbp@s.nosp@m.ourc.nosp@m.efrog.nosp@m..net Released under the zlib License

+Adler-32 Checksum Algorithm (from zlib) Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler Released under the zlib License 

+
+

basePath	Specifies the "base" directory where the unique file is supposed to be created. This must be a valid existing directory.
baseName	Specifies the desired "base" file name of the unqiue file. Do not include a file extension.
extension	Specifies the desired file extensions of the unqiue file. Do not include a leading dot (`.`) character.
baseName	Specifies the desired "base" file name of the unique file. Do not include a file extension.
extension	Specifies the desired file extensions of the unique file. Do not include a leading dot (`.`) character.
fancy	If set to `true`, the file name is generated according to the `"<basedir>/<basename> (N).<ext>"` pattern; if set to `false`, the file name is generated according to the `"<basedir>/<basename>.XXXX.<ext>"` pattern.

list	A reference to the QStringList object to be sorted. The list will be sorted "in place".
list	A reference to the QStringList object to be sorted. The list will be sorted "in place".
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.

4 API Documentation

API-Documentation

Introduction

Project Structure

API Documentation

License

Example

Build Notes

License

Acknowledgement