include/MUtils/Global.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // 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
  20 //////////////////////////////////////////////////////////////////////////////////
  21
  22 #pragma once
  23
  24 #include <QString>
  25
  26 //Forward Declarations
  27 class QProcess;
  28
  29 ///////////////////////////////////////////////////////////////////////////////
  30
  31 //MUtils API
  32 #ifdef _MSC_VER
  33 #       ifdef MUTILS_DLL_EXPORT
  34 #               define MUTILS_API __declspec(dllexport)
  35 #       else
  36 #               ifndef MUTILS_STATIC_LIB
  37 #                       define MUTILS_API __declspec(dllimport)
  38 #               else
  39 #                       define MUTILS_API /*static lib*/
  40 #               endif
  41 #       endif
  42 #else
  43 #       define MUTILS_API
  44 #endif
  45
  46 //Helper Macros
  47 #define MUTILS_MAKE_STRING_HELPER(X) #X
  48 #define MUTILS_MAKE_STRING(X) MUTILS_MAKE_STRING_HELPER(X)
  49 #define MUTILS_COMPILER_WARNING(TXT) __pragma(message(__FILE__ "(" MUTILS_MAKE_STRING(__LINE__) ") : warning: " TXT))
  50
  51 //Check Debug Flags
  52 #if defined(_DEBUG) || defined(DEBUG) || (!defined(NDEBUG))
  53 #       define MUTILS_DEBUG (1)
  54 #       if defined(NDEBUG) || defined(QT_NO_DEBUG) || (!defined(QT_DEBUG))
  55 #               error Inconsistent DEBUG flags have been detected!
  56 #       endif
  57 #else
  58 #       define MUTILS_DEBUG (0)
  59 #       if (!defined(NDEBUG)) || (!defined(QT_NO_DEBUG)) || defined(QT_DEBUG)
  60 #               error Inconsistent DEBUG flags have been detected!
  61 #       endif
  62 #endif
  63
  64 //Check CPU options
  65 #if defined(_MSC_VER) && (!defined(_M_X64)) && defined(_M_IX86_FP)
  66         #if (_M_IX86_FP != 0)
  67                 #error We should not enabled SSE or SSE2 in release builds!
  68         #endif
  69 #endif
  70
  71 ///////////////////////////////////////////////////////////////////////////////
  72
  73 namespace MUtils
  74 {
  75         //Temp Folder
  76         MUTILS_API const QString& temp_folder(void);
  77
  78         //Process Utils
  79         MUTILS_API void init_process(QProcess &process, const QString &wokringDir, const bool bReplaceTempDir = true, const QStringList *const extraPaths = NULL);
  80
  81         //Random
  82         MUTILS_API void seed_rand(void);
  83         MUTILS_API QString rand_str(const bool &bLong = false);
  84         MUTILS_API quint32 next_rand32(void);
  85         MUTILS_API quint64 next_rand64(void);
  86
  87         //File Name
  88         MUTILS_API QString make_temp_file(const QString &basePath, const QString &extension, const bool placeholder = false);
  89         MUTILS_API QString make_unique_file(const QString &basePath, const QString &baseName, const QString &extension, const bool fancy = false);
  90
  91         //Parity
  92         MUTILS_API bool parity(quint32 value);
  93
  94         //Remove File/Dir
  95         MUTILS_API bool remove_file(const QString &fileName);
  96         MUTILS_API bool remove_directory(const QString &folderPath, const bool &recursive);
  97
  98         //String utils
  99         MUTILS_API QString& trim_right(QString &str);
 100         MUTILS_API QString& trim_left(QString &str);
 101         MUTILS_API QString trim_right(const QString &str);
 102         MUTILS_API QString trim_left(const QString &str);
 103
 104         //String sorting
 105         MUTILS_API void natural_string_sort(QStringList &list, const bool bIgnoreCase);
 106
 107         //Clean file path
 108         MUTILS_API QString clean_file_name(const QString &name);
 109         MUTILS_API QString clean_file_path(const QString &path);
 110
 111         //Regular expressions
 112         MUTILS_API bool regexp_parse_uint32(const QRegExp &regexp, quint32 &value);
 113         MUTILS_API bool regexp_parse_uint32(const QRegExp &regexp, quint32 *values, const size_t &count);
 114
 115         //Internationalization
 116         MUTILS_API QStringList available_codepages(const bool &noAliases = true);
 117
 118         //Internal
 119         namespace Internal
 120         {
 121                 MUTILS_API int selfTest(const char *const buildKey, const bool debug);
 122                 static const int s_selfTest = selfTest(__DATE__ "@" __TIME__, MUTILS_DEBUG);
 123         }
 124 }
 125
 126 ///////////////////////////////////////////////////////////////////////////////
 127
 128 //Delete helper
 129 #define MUTILS_DELETE(PTR) do { if((PTR)) { delete (PTR); (PTR) = NULL; } } while(0)
 130 #define MUTILS_DELETE_ARRAY(PTR) do { if((PTR)) { delete [] (PTR); (PTR) = NULL; } } while(0)
 131
 132 //Zero memory
 133 #define MUTILS_ZERO_MEMORY(PTR) memset(&(PTR), 0, sizeof((PTR)))
 134
 135 //String conversion macros
 136 #define MUTILS_WCHR(STR) (reinterpret_cast<const wchar_t*>((STR).utf16()))
 137 #define MUTILS_UTF8(STR) ((STR).toUtf8().constData())
 138 #define MUTILS_QSTR(STR) (QString::fromUtf16(reinterpret_cast<const unsigned short*>((STR))))
 139
 140 //Boolean helper
 141 #define MUTILS_BOOL2STR(X) ((X) ? "1" : "0")