<li><code>etc/</code> – miscellaneous files, everything that doesn't fit in anywhere else</li>
<li><code>include/</code> – public header files, include this directory in projects that use the MUtilities library</li>
<li><code>obj/</code> – object code files, intermediate files generated during the build process</li>
-<li><code>res/</code> – resouce files, required for building the MUtilities library</li>
+<li><code>res/</code> – resource files, required for building the MUtilities library</li>
<li><code>src/</code> – source code files, required for building the MUtilities library (third-party code in <code>src/3rd_party/</code>)</li>
<li><code>test/</code> – unit tests, based on Google Test framework</li>
<li><code>tmp/</code> – temporary files, automatically generated during the build process</li>
<ul>
<li>In order to use the <em>MUtilities</em> library in your project, your build environment must have already been set up for building Qt-based projects. Setting up Qt is <em>not</em> covered by this document.</li>
<li>Additionally, make sure that <em>MUtilities'</em> <code>include/</code> directory is contained in your "Additional Include Directories" and that the <em>MUtilities'</em> <code>bin/</code> directory is contained in your "Additional Library Directories".</li>
-<li>Finally, make sure that your project links against the <code>MUtils32-1.lib</code> library file. For each build configuration you have to pick the proper <strong>.lib</strong> file from the correspnding <code>bin/<platform>/<config>/</code> directory!</li>
+<li>Finally, make sure that your project links against the <code>MUtils32-1.lib</code> library file. For each build configuration, pick the proper <strong>.lib</strong> file from the corresponding <code>bin/<platform>/<config>/</code> directory!</li>
<li>If your projects intends to use the <em>MUtilities</em> library as a <strong>static</strong> library, then the macro <code>MUTILS_STATIC_LIB</code> <em>must</em> be added to your project's "Preprocessor Definitions".</li>
</ul>
<h1 id="api-documentation"><span class="header-section-number">4</span> API Documentation</h1>
* `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/` – resouce files, required for building the MUtilities library
+* `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
* 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
you have to pick the proper **.lib** file from the correspnding `bin/<platform>/<config>/` directory!
+* 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".
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">basePath</td><td>Specifies the "base" directory where the unique file is supposed to be created. This must be a valid <em>existing</em> directory.</td></tr>
- <tr><td class="paramname">baseName</td><td>Specifies the desired "base" file name of the unqiue file. Do <b>not</b> include a file extension.</td></tr>
- <tr><td class="paramname">extension</td><td>Specifies the desired file extensions of the unqiue file. Do <b>not</b> include a leading dot (<code>.</code>) character.</td></tr>
+ <tr><td class="paramname">baseName</td><td>Specifies the desired "base" file name of the unique file. Do <b>not</b> include a file extension.</td></tr>
+ <tr><td class="paramname">extension</td><td>Specifies the desired file extensions of the unique file. Do <b>not</b> include a leading dot (<code>.</code>) character.</td></tr>
<tr><td class="paramname">fancy</td><td>If set to <code>true</code>, the file name is generated according to the <code>"<basedir>/<basename> (N).<ext>"</code> pattern; if set to <code>false</code>, the file name is generated according to the <code>"<basedir>/<basename>.XXXX.<ext>"</code> pattern.</td></tr>
</table>
</dd>
<p>This function implements a sort algorithm that orders alphanumeric strings in the way a human being would. See <a href="http://sourcefrog.net/projects/natsort/"><em>Natural Order String Comparison</em></a> for details!</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramname">list</td><td>A reference to the QStringList object to be sorted. The list will be sorted "in place". </td></tr>
+ <tr><td class="paramname">list</td><td>A reference to the QStringList object to be sorted. The list will be sorted "in place".</td></tr>
+ <tr><td class="paramname">bIgnoreCase</td><td>If set to <code>true</code>, 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 <code>false</code>, the character case <em>is</em> taken into account. </td></tr>
</table>
</dd>
</dl>
</table>
</dd>
</dl>
-<dl class="section return"><dt>Returns</dt><dd>The function retruns a QString holding a <em>random</em> hexadecimal string </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>The function returns a QString holding a <em>random</em> hexadecimal string </dd></dl>
</div>
</div>
<p>Generates a <em>random</em> unsigned 32-Bit value. </p>
<p>The <em>random</em> value is created using a "strong" PRNG of the underlying system, if possible. Otherwise a fallback PRNG is used. It is <b>not</b> required or useful to call <code>srand()</code> or <code>qsrand()</code> prior to using this function. If necessary, the seeding of the PRNG happen <em>automatically</em> on the first call.</p>
-<dl class="section return"><dt>Returns</dt><dd>The function retruns a <em>random</em> unsigned 32-Bit value. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>The function returns a <em>random</em> unsigned 32-Bit value. </dd></dl>
</div>
</div>
<p>Generates a <em>random</em> unsigned 64-Bit value. </p>
<p>The <em>random</em> value is created using a "strong" PRNG of the underlying system, if possible. Otherwise a fallback PRNG is used. It is <b>not</b> required or useful to call <code>srand()</code> or <code>qsrand()</code> prior to using this function. If necessary, the seeding of the PRNG happen <em>automatically</em> on the first call.</p>
-<dl class="section return"><dt>Returns</dt><dd>The function retruns a <em>random</em> unsigned 64-Bit value. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>The function returns a <em>random</em> unsigned 64-Bit value. </dd></dl>
</div>
</div>
</div><div class="memdoc">
<p>Recursively deletes the specified directory. </p>
-<p>The function deletes the specified directory. In <em>recusive</em> mode, the directory will be removed including all of its files and sub-directories. Files are deleted using the <code><a class="el" href="../../d5/d3b/_global_8h.html#a12259acdd6aff74ee83819d3aebd8ba9" title="Deletes the specified file. ">remove_file()</a></code> function.</p>
+<p>The function deletes the specified directory. In <em>recu
rsive</em> mode, the directory will be removed including all of its files and sub-directories. Files are deleted using the <code><a class="el" href="../../d5/d3b/_global_8h.html#a12259acdd6aff74ee83819d3aebd8ba9" title="Deletes the specified file. ">remove_file()</a></code> function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">folderPath</td><td>The path to the directory to be deleted. This should be a full path.</td></tr>
</div><div class="memdoc">
<p>Rerieves the full path of the application's <em>Temp</em> folder. </p>
-<p>The application's <em>Temp</em> 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 <em>Temp</em> folder will be created as a sub-folder of the system's global <em>Temp</em> folder, as indicated by the <code>TMP</code> or <code>TEMP</code> environment variables. However, it may be created at a different place (e.g. in the users <em>Profile</em> directory), if those environment variables don't point to a usable directory. In any case, this function makes sure that the application's <em>Temp</em> folder exists for the whole lifetime of the application and that it is writable. When the application is about to terminate, the application's <em>Temp</em> folder and all files or sub-directories thereof will be <em>removed</em> automatically!</p>
+<p>The application's <em>Temp</em> 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 <em>Temp</em> folder will be created as a sub-folder of the system's global <em>Temp</em> folder, as indicated by the <code>TMP</code> or <code>TEMP</code> environment variables. However, it may be created at a different place (e.g. in the users <em>Profile</em> directory), if those environment variables don't point to a usable directory. In any case, this function makes sure that the application's <em>Temp</em> folder exists for the whole lifetime of the application and that it is writable. When the application terminates normally, the application's <em>Temp</em> folder and all files or sub-directories thereof will be <em>removed</em> automatically!</p>
<dl class="section return"><dt>Returns</dt><dd>If the function succeeds, it returns a read-only reference to a QString holding the full path of the application's <em>Temp</em> folder; otherwise a read-only reference to a default-constructed QString is returned. </dd></dl>
</div>
<div class="title">Global.h</div> </div>
</div><!--header-->
<div class="contents">
-<a href="../../d5/d3b/_global_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// MuldeR's Utilities for Qt</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de></span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// This library is free software; you can redistribute it and/or</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// modify it under the terms of the GNU Lesser General Public</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// License as published by the Free Software Foundation; either</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// version 2.1 of the License, or (at your option) any later version.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">//</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// This library is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// Lesser General Public License for more details.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">//</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// You should have received a copy of the GNU Lesser General Public</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// License along with this library; if not, write to the Free Software</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// http://www.gnu.org/licenses/lgpl-2.1.txt</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <QString></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">//Forward Declarations</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>QProcess;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">//MUtils API</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#ifdef _MSC_VER</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"># ifdef MUTILS_DLL_EXPORT</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"># define MUTILS_API __declspec(dllexport)</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"># else</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"># ifndef MUTILS_STATIC_LIB</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"># define MUTILS_API __declspec(dllimport)</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"># else</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"># define MUTILS_API </span><span class="comment">/*static lib*/</span><span class="preprocessor"></span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"># endif</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"># endif</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor"># define MUTILS_API</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">//Helper Macros</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#define MUTILS_MAKE_STRING_HELPER(X) #X</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#define MUTILS_MAKE_STRING(X) MUTILS_MAKE_STRING_HELPER(X)</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#define MUTILS_COMPILER_WARNING(TXT) __pragma(message(__FILE__ "(" MUTILS_MAKE_STRING(__LINE__) ") : warning: " TXT))</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">//Check Debug Flags</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#if defined(_DEBUG) || defined(DEBUG) || (!defined(NDEBUG))</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"># define MUTILS_DEBUG (1)</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor"># if defined(NDEBUG) || defined(QT_NO_DEBUG) || (!defined(QT_DEBUG))</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor"># error Inconsistent DEBUG flags have been detected!</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"># endif</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor"># define MUTILS_DEBUG (0)</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"># if (!defined(NDEBUG)) || (!defined(QT_NO_DEBUG)) || defined(QT_DEBUG)</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor"># error Inconsistent DEBUG flags have been detected!</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"># endif</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">//Check CPU options</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#if defined(_MSC_VER) && (!defined(__INTELLISENSE__)) && (!defined(_M_X64)) && defined(_M_IX86_FP)</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"> #if (_M_IX86_FP != 0)</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"> #error We should not enabled SSE or SSE2 in release builds!</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"> #endif</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00
114"></a><span class="lineno"> 114</span> <span class="keyword">namespace </span><a class="code" href="../../d3/da6/namespace_m_utils.html">MUtils</a></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> {</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  MUTILS_API <span class="keyword">const</span> QString& <a class="code" href="../../d5/d3b/_global_8h.html#a9ddb9a2039585b1ef3429db16ea84292">temp_folder</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="comment">//Process Utils</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  MUTILS_API <span class="keywordtype">void</span> init_process(QProcess &process, <span class="keyword">const</span> QString &wokringDir, <span class="keyword">const</span> <span class="keywordtype">bool</span> bReplaceTempDir = <span class="keyword">true</span>, <span class="keyword">const</span> QStringList *<span class="keyword">const</span> extraPaths = NULL);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  MUTILS_API quint32 <a class="code" href="../../d5/d3b/_global_8h.html#a4dc7dccb81653ae28e0d37a7c2f62112">next_rand_u32</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  MUTILS_API quint64 <a class="code" href="../../d5/d3b/_global_8h.html#a15762bf5b0239e5f67a3815d63ed441a">next_rand_u64</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  MUTILS_API QString <a class="code" href="../../d5/d3b/_global_8h.html#a996b60884ddf7728178e94f34ca12570">next_rand_str</a>(<span class="keyword">const</span> <span class="keywordtype">bool</span> &bLong = <span class="keyword">false</span>);</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  MUTILS_API QString <a class="code" href="../../d5/d3b/_global_8h.html#a67cb16c62b213da5135a6fa076f3f005">make_temp_file</a>(<span class="keyword">const</span> QString &basePath, <span class="keyword">const</span> QString &extension, <span class="keyword">const</span> <span class="keywordtype">bool</span> placeholder = <span class="keyword">false</span>);</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  MUTILS_API QString <a class="code" href="../../d5/d3b/_global_8h.html#a390e56e35eb9329d2e67fa9741d07536">make_unique_file</a>(<span class="keyword">const</span> QString &basePath, <span class="keyword">const</span> QString &baseName, <span class="keyword">const</span> QString &extension, <span class="keyword">const</span> <span class="keywordtype">bool</span> fancy = <span class="keyword">false</span>);</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> </div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  MUTILS_API <span class="keywordtype">bool</span> <a class="code" href="../../d5/d3b/_global_8h.html#ad1bdb5e416839b1f85f6df68e58ae28c">parity</a>(quint32 value);</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  MUTILS_API <span class="keywordtype">bool</span> <a class="code" href="../../d5/d3b/_global_8h.html#a12259acdd6aff74ee83819d3aebd8ba9">remove_file</a>(<span class="keyword">const</span> QString &fileName);</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  MUTILS_API <span class="keywordtype">bool</span> <a class="code" href="../../d5/d3b/_global_8h.html#ac7d2c9bd5c49230b2fed72e3410c3f7d">remove_directory</a>(<span class="keyword">const</span> QString &folderPath, <span class="keyword">const</span> <span class="keywordtype">bool</span> &recursive);</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  MUTILS_API QString& <a class="code" href="../../d5/d3b/_global_8h.html#a9290a3fe637a05ad2a7515f36fad79bd">trim_right</a>(QString &str);</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> </div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  MUTILS_API QString& <a class="code" href="../../d5/d3b/_global_8h.html#af089c8a40b6ec2e19db3fe612aa81c8c">trim_left</a>(QString &str);</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  MUTILS_API QString <a class="code" href="../../d5/d3b/_global_8h.html#a9290a3fe637a05ad2a7515f36fad79bd">trim_right</a>(<span class="keyword">const</span> QString &str);</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> </div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  MUTILS_API QString <a class="code" href="../../d5/d3b/_global_8h.html#af089c8a40b6ec2e19db3fe612aa81c8c">trim_left</a>(<span class="keyword">const</span> QString &str);</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> </div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  MUTILS_API <span class="keywordtype">void</span> <a class="code" href="../../d5/d3b/_global_8h.html#a09e919d419ded903481cf7aba702dcba">natural_string_sort</a>(QStringList &list, <span class="keyword">const</span> <span class="keywordtype">bool</span> bIgnoreCase);</div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> </div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> </div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  MUTILS_API QString clean_file_name(<span class="keyword">const</span> QString &name);</div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  MUTILS_API QString clean_file_path(<span class="keyword">const</span> QString &path);</div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> </div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  MUTILS_API <span class="keywordtype">bool</span> <a class="code" href="../../d5/d3b/_global_8h.html#a45cb0d1e6a55cf5ffda3b626c25fd957">regexp_parse_uint32</a>(<span class="keyword">const</span> QRegExp &regexp, quint32 &value);</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> </div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  MUTILS_API <span class="keywordtype">bool</span> <a class="code" href="../../d5/d3b/_global_8h.html#a45cb0d1e6a55cf5ffda3b626c25fd957">regexp_parse_uint32</a>(<span class="keyword">const</span> QRegExp &regexp, quint32 *values, <span class="keyword">const</span> <span class="keywordtype">size_t</span> &count);</div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> </div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  MUTILS_API QStringList <a class="code" href="../../d5/d3b/_global_8h.html#a4fcbdafffc1224776616fcc6aec8278b">available_codepages</a>(<span class="keyword">const</span> <span class="keywordtype">bool</span> &noAliases = <span class="keyword">true</span>);</div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> </div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  <span class="comment">//Internal</span></div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  <span class="keyword">namespace </span>Internal</div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  {</div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  MUTILS_API <span class="keywordtype">int</span> selfTest(<span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keyword">const</span> buildKey, <span class="keyword">const</span> <span class="keywordtype">bool</span> debug);</div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> s_selfTest = selfTest(__DATE__ <span class="stringliteral">"@"</span> __TIME__, MUTILS_DEBUG);</div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>  }</div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span> }</div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span> </div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span> </div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment">//Delete helper</span></div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="preprocessor">#define MUTILS_DELETE(PTR) do { if((PTR)) { delete (PTR); (PTR) = NULL; } } while(0)</span></div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="preprocessor">#define MUTILS_DELETE_ARRAY(PTR) do { if((PTR)) { delete [] (PTR); (PTR) = NULL; } } while(0)</span></div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span> </div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment">//Zero memory</span></div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="preprocessor">#define MUTILS_ZERO_MEMORY(PTR) memset(&(PTR), 0, sizeof((PTR)))</span></div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> </div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment">//String conversion macros</span></div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="preprocessor">#define MUTILS_WCHR(STR) (reinterpret_cast<const wchar_t*>((STR).utf16()))</span></div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="preprocessor">#define MUTILS_UTF8(STR) ((STR).toUtf8().constData())</span></div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="preprocessor">#define MUTILS_QSTR(STR) (QString::fromUtf16(reinterpret_cast<const unsigned short*>((STR))))</span></div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span> </div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment">//Boolean helper</span></div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="preprocessor">#define MUTILS_BOOL2STR(X) ((X) ? "1" : "0")</span></div><div class="ttc" id="_global_8h_html_a12259acdd6aff74ee83819d3aebd8ba9"><div class="ttname"><a href="../../d5/d3b/_global_8h.html#a12259acdd6aff74ee83819d3aebd8ba9">MUtils::remove_file</a></div><div class="ttdeci">bool remove_file(const QString &fileName)</div><div class="ttdoc">Deletes the specified file. </div></div>
+<a href="../../d5/d3b/_global_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// MuldeR's Utilities for Qt</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de></span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// This library is free software; you can redistribute it and/or</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// modify it under the terms of the GNU Lesser General Public</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// License as published by the Free Software Foundation; either</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// version 2.1 of the License, or (at your option) any later version.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">//</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// This library is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// Lesser General Public License for more details.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">//</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// You should have received a copy of the GNU Lesser General Public</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// License along with this library; if not, write to the Free Software</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// http://www.gnu.org/licenses/lgpl-2.1.txt</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <QString></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">//Forward Declarations</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>QProcess;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">//MUtils API</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#ifdef _MSC_VER</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"># ifdef MUTILS_DLL_EXPORT</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"># define MUTILS_API __declspec(dllexport)</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"># else</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"># ifndef MUTILS_STATIC_LIB</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"># define MUTILS_API __declspec(dllimport)</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"># else</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"># define MUTILS_API </span><span class="comment">/*static lib*/</span><span class="preprocessor"></span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"># endif</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"># endif</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor"># define MUTILS_API</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">//Helper Macros</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#define MUTILS_MAKE_STRING_HELPER(X) #X</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#define MUTILS_MAKE_STRING(X) MUTILS_MAKE_STRING_HELPER(X)</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#define MUTILS_COMPILER_WARNING(TXT) __pragma(message(__FILE__ "(" MUTILS_MAKE_STRING(__LINE__) ") : warning: " TXT))</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">//Check Debug Flags</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#if defined(_DEBUG) || defined(DEBUG) || (!defined(NDEBUG))</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"># define MUTILS_DEBUG (1)</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor"># if defined(NDEBUG) || defined(QT_NO_DEBUG) || (!defined(QT_DEBUG))</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor"># error Inconsistent DEBUG flags have been detected!</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"># endif</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor"># define MUTILS_DEBUG (0)</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"># if (!defined(NDEBUG)) || (!defined(QT_NO_DEBUG)) || defined(QT_DEBUG)</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor"># error Inconsistent DEBUG flags have been detected!</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"># endif</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">//Check CPU options</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#if defined(_MSC_VER) && (!defined(__INTELLISENSE__)) && (!defined(_M_X64)) && defined(_M_IX86_FP)</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"> #if (_M_IX86_FP != 0)</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"> #error We should not enabled SSE or SSE2 in release builds!</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"> #endif</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00
078"></a><span class="lineno"> 78</span> <span class="keyword">namespace </span><a class="code" href="../../d3/da6/namespace_m_utils.html">MUtils</a></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  MUTILS_API <span class="keyword">const</span> QString& <a class="code" href="../../d5/d3b/_global_8h.html#a9ddb9a2039585b1ef3429db16ea84292">temp_folder</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="comment">//Process Utils</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  MUTILS_API <span class="keywordtype">void</span> init_process(QProcess &process, <span class="keyword">const</span> QString &wokringDir, <span class="keyword">const</span> <span class="keywordtype">bool</span> bReplaceTempDir = <span class="keyword">true</span>, <span class="keyword">const</span> QStringList *<span class="keyword">const</span> extraPaths = NULL);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  MUTILS_API quint32 <a class="code" href="../../d5/d3b/_global_8h.html#a4dc7dccb81653ae28e0d37a7c2f62112">next_rand_u32</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  MUTILS_API quint64 <a class="code" href="../../d5/d3b/_global_8h.html#a15762bf5b0239e5f67a3815d63ed441a">next_rand_u64</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  MUTILS_API QString <a class="code" href="../../d5/d3b/_global_8h.html#a996b60884ddf7728178e94f34ca12570">next_rand_str</a>(<span class="keyword">const</span> <span class="keywordtype">bool</span> &bLong = <span class="keyword">false</span>);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  MUTILS_API QString <a class="code" href="../../d5/d3b/_global_8h.html#a67cb16c62b213da5135a6fa076f3f005">make_temp_file</a>(<span class="keyword">const</span> QString &basePath, <span class="keyword">const</span> QString &extension, <span class="keyword">const</span> <span class="keywordtype">bool</span> placeholder = <span class="keyword">false</span>);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  MUTILS_API QString <a class="code" href="../../d5/d3b/_global_8h.html#a390e56e35eb9329d2e67fa9741d07536">make_unique_file</a>(<span class="keyword">const</span> QString &basePath, <span class="keyword">const</span> QString &baseName, <span class="keyword">const</span> QString &extension, <span class="keyword">const</span> <span class="keywordtype">bool</span> fancy = <span class="keyword">false</span>);</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  MUTILS_API <span class="keywordtype">bool</span> <a class="code" href="../../d5/d3b/_global_8h.html#ad1bdb5e416839b1f85f6df68e58ae28c">parity</a>(quint32 value);</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  MUTILS_API <span class="keywordtype">bool</span> <a class="code" href="../../d5/d3b/_global_8h.html#a12259acdd6aff74ee83819d3aebd8ba9">remove_file</a>(<span class="keyword">const</span> QString &fileName);</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  MUTILS_API <span class="keywordtype">bool</span> <a class="code" href="../../d5/d3b/_global_8h.html#ac7d2c9bd5c49230b2fed72e3410c3f7d">remove_directory</a>(<span class="keyword">const</span> QString &folderPath, <span class="keyword">const</span> <span class="keywordtype">bool</span> &recursive);</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  MUTILS_API QString& <a class="code" href="../../d5/d3b/_global_8h.html#a9290a3fe637a05ad2a7515f36fad79bd">trim_right</a>(QString &str);</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> </div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  MUTILS_API QString& <a class="code" href="../../d5/d3b/_global_8h.html#af089c8a40b6ec2e19db3fe612aa81c8c">trim_left</a>(QString &str);</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  MUTILS_API QString <a class="code" href="../../d5/d3b/_global_8h.html#a9290a3fe637a05ad2a7515f36fad79bd">trim_right</a>(<span class="keyword">const</span> QString &str);</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> </div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  MUTILS_API QString <a class="code" href="../../d5/d3b/_global_8h.html#af089c8a40b6ec2e19db3fe612aa81c8c">trim_left</a>(<span class="keyword">const</span> QString &str);</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  MUTILS_API <span class="keywordtype">void</span> <a class="code" href="../../d5/d3b/_global_8h.html#a09e919d419ded903481cf7aba702dcba">natural_string_sort</a>(QStringList &list, <span class="keyword">const</span> <span class="keywordtype">bool</span> bIgnoreCase);</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  MUTILS_API QString clean_file_name(<span class="keyword">const</span> QString &name);</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  MUTILS_API QString clean_file_path(<span class="keyword">const</span> QString &path);</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  MUTILS_API <span class="keywordtype">bool</span> <a class="code" href="../../d5/d3b/_global_8h.html#a45cb0d1e6a55cf5ffda3b626c25fd957">regexp_parse_uint32</a>(<span class="keyword">const</span> QRegExp &regexp, quint32 &value);</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> </div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  MUTILS_API <span class="keywordtype">bool</span> <a class="code" href="../../d5/d3b/_global_8h.html#a45cb0d1e6a55cf5ffda3b626c25fd957">regexp_parse_uint32</a>(<span class="keyword">const</span> QRegExp &regexp, quint32 *values, <span class="keyword">const</span> <span class="keywordtype">size_t</span> &count);</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> </div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  MUTILS_API QStringList <a class="code" href="../../d5/d3b/_global_8h.html#a4fcbdafffc1224776616fcc6aec8278b">available_codepages</a>(<span class="keyword">const</span> <span class="keywordtype">bool</span> &noAliases = <span class="keyword">true</span>);</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> </div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  <span class="comment">//Internal</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  <span class="keyword">namespace </span>Internal</div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  {</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  MUTILS_API <span class="keywordtype">int</span> selfTest(<span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keyword">const</span> buildKey, <span class="keyword">const</span> <span class="keywordtype">bool</span> debug);</div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> s_selfTest = selfTest(__DATE__ <span class="stringliteral">"@"</span> __TIME__, MUTILS_DEBUG);</div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  }</div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> }</div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> </div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> </div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment">//Delete helper</span></div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="preprocessor">#define MUTILS_DELETE(PTR) do { if((PTR)) { delete (PTR); (PTR) = NULL; } } while(0)</span></div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="preprocessor">#define MUTILS_DELETE_ARRAY(PTR) do { if((PTR)) { delete [] (PTR); (PTR) = NULL; } } while(0)</span></div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> </div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment">//Zero memory</span></div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="preprocessor">#define MUTILS_ZERO_MEMORY(PTR) memset(&(PTR), 0, sizeof((PTR)))</span></div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> </div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment">//String conversion macros</span></div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="preprocessor">#define MUTILS_WCHR(STR) (reinterpret_cast<const wchar_t*>((STR).utf16()))</span></div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="preprocessor">#define MUTILS_UTF8(STR) ((STR).toUtf8().constData())</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="preprocessor">#define MUTILS_QSTR(STR) (QString::fromUtf16(reinterpret_cast<const unsigned short*>((STR))))</span></div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> </div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment">//Boolean helper</span></div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="preprocessor">#define MUTILS_BOOL2STR(X) ((X) ? "1" : "0")</span></div><div class="ttc" id="_global_8h_html_a12259acdd6aff74ee83819d3aebd8ba9"><div class="ttname"><a href="../../d5/d3b/_global_8h.html#a12259acdd6aff74ee83819d3aebd8ba9">MUtils::remove_file</a></div><div class="ttdeci">bool remove_file(const QString &fileName)</div><div class="ttdoc">Deletes the specified file. </div></div>
<div class="ttc" id="_global_8h_html_a4dc7dccb81653ae28e0d37a7c2f62112"><div class="ttname"><a href="../../d5/d3b/_global_8h.html#a4dc7dccb81653ae28e0d37a7c2f62112">MUtils::next_rand_u32</a></div><div class="ttdeci">quint32 next_rand_u32(void)</div><div class="ttdoc">Generates a random unsigned 32-Bit value. </div></div>
<div class="ttc" id="_global_8h_html_ad1bdb5e416839b1f85f6df68e58ae28c"><div class="ttname"><a href="../../d5/d3b/_global_8h.html#ad1bdb5e416839b1f85f6df68e58ae28c">MUtils::parity</a></div><div class="ttdeci">bool parity(quint32 value)</div><div class="ttdoc">Computes the parity of the given unsigned 32-Bit value. </div></div>
<div class="ttc" id="_global_8h_html_a390e56e35eb9329d2e67fa9741d07536"><div class="ttname"><a href="../../d5/d3b/_global_8h.html#a390e56e35eb9329d2e67fa9741d07536">MUtils::make_unique_file</a></div><div class="ttdeci">QString make_unique_file(const QString &basePath, const QString &baseName, const QString &extension, const bool fancy=false)</div><div class="ttdoc">Generates a unique file name. </div></div>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>MuldeR's Utilities for Qt: MuldeR's Utilities for Qt</title>
+<title>MuldeR's Utilities for Qt: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<div class="header">
<div class="headertitle">
-<div class="title">MuldeR's Utilities for Qt </div> </div>
+<div class="title">MuldeR's Utilities for Qt Documentation</div> </div>
</div><!--header-->
<div class="contents">
-<div class="textblock"><p>The <b>MUtilities</b> library is a collection of routines and classes to extend the <a href="http://qt-project.org/"><em>Qt cross-platform framework</em></a>. 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 <a href="http://lamexp.sourceforge.net/"><b>LameXP</b></a> application: Over the years, a lot of code, <b>not</b> really specific to <em>LameXP</em>, had accumulated in the <em>LameXP</em> 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 <b>MUtilities</b> (aka "MuldeR's Utilities for Qt") library. This library now forms the foundation of <em>LameXP</em> and <a href="https://github.com/lordmulder"><em>other OpenSource projects</em></a>.</p>
-<h3>API-Documentation</h3>
-<p>The public API of the <em>MUtilities</em> library is defined in the following header files:</p><ul>
+<div class="textblock"><h1>Introduction</h1>
+<p>The <b>MUtilities</b> library is a collection of routines and classes to extend the <a href="http://qt-project.org/"><em>Qt cross-platform framework</em></a>. 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 <a href="http://lamexp.sourceforge.net/"><b>LameXP</b></a> application: Over the years, a lot of code, <b>not</b> really specific to <em>LameXP</em>, had accumulated in the <em>LameXP</em> 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 <b>MUtilities</b> (aka "MuldeR's Utilities for Qt") library. This library now forms the foundation of <em>LameXP</em> and <a href="https://github.com/lordmulder"><em>other OpenSource projects</em></a>.</p>
+<h1>Project Structure</h1>
+<p>The <em>MUtilities</em> project directory is organized as follows:</p>
+<ul>
+<li><code>bin/</code> – compiled library files (static or shared), link those files in projects that use the MUtilities library</li>
+<li><code>docs/</code> – programming interface documentation, generated with Doxygen tool</li>
+<li><code>etc/</code> – miscellaneous files, everything that doesn't fit in anywhere else</li>
+<li><code>include/</code> – public header files, include this directory in projects that use the MUtilities library</li>
+<li><code>obj/</code> – object code files, intermediate files generated during the build process</li>
+<li><code>res/</code> – resource files, required for building the MUtilities library</li>
+<li><code>src/</code> – source code files, required for building the MUtilities library (third-party code in <code>src/3rd_party/</code>)</li>
+<li><code>test/</code> – unit tests, based on Google Test framework</li>
+<li><code>tmp/</code> – temporary files, automatically generated during the build process</li>
+</ul>
+<h1>API Documentation</h1>
+<p>The public API of the <em>MUtilities</em> library is defined in the following header files (select file for details):</p><ul>
<li><b><a class="el" href="d5/d3b/_global_8h.html" title="This file contains miscellaneous functions that are generally useful for Qt-based applications...">Global.h</a></b> – miscellaneous useful functions</li>
</ul>
-<h3>License</h3>
-<p>This library is free software. It is released under the terms of the <a href="https://www.gnu.org/licenses/lgpl-2.1.html">GNU Lesser General Public License (LGPL), Version 2.1</a>.</p>
-<div class="fragment"><div class="line">MUtilities - MuldeR<span class="stringliteral">'s Utilities for Qt</span></div><div class="line"><span class="stringliteral">Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de>. Some rights reserved.</span></div><div class="line"><span class="stringliteral"></span></div><div class="line"><span class="stringliteral">This library is free software; you can redistribute it and/or</span></div><div class="line"><span class="stringliteral">modify it under the terms of the GNU Lesser General Public</span></div><div class="line"><span class="stringliteral">License as published by the Free Software Foundation; either</span></div><div class="line"><span class="stringliteral">version 2.1 of the License, or (at your option) any later version.</span></div><div class="line"><span class="stringliteral"></span></div><div class="line"><span class="stringliteral">This library is distributed in the hope that it will be useful,</span></div><div class="line"><span class="stringliteral">but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><span class="stringliteral">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div><div class="line"><span class="stringliteral">Lesser General Public License for more details.</span></div><div class="line"><span class="stringliteral"></span></div><div class="line"><span class="stringliteral">You should have received a copy of the GNU Lesser General Public</span></div><div class="line"><span class="stringliteral">License along with this library; if not, write to the Free Software</span></div><div class="line"><span class="stringliteral">Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span></div></div><!-- fragment --> </div></div><!-- contents -->
+<h1>Example</h1>
+<p>Here is a minimal example on how to use the <em>MUtilities</em> library in your project: </p><pre class="fragment">//MUtils
+#include <MUtils/Global.h>
+
+int main(int argc, char **argv)
+{
+ qDebug("Random number: %u\n", MUtils::next_rand_u32());
+}
+</pre><h2>Build Notes</h2>
+<ul>
+<li>In order to use the <em>MUtilities</em> library in your project, your build environment must have already been set up for building Qt-based projects. Setting up Qt is <em>not</em> covered by this document.</li>
+<li>Additionally, make sure that <em>MUtilities'</em> <code>include/</code> directory is contained in your "Additional Include Directories" and that the <em>MUtilities'</em> <code>bin/</code> directory is contained in your "Additional Library Directories".</li>
+<li>Finally, make sure that your project links against the <code>MUtils32-1.lib</code> library file. For each build configuration, pick the proper **.lib** file from the corresponding <code>bin/<platform>/<config>/</code> directory!</li>
+<li>If your projects intends to use the <em>MUtilities</em> library as a <b>static</b> library, then the macro <code>MUTILS_STATIC_LIB</code> <em>must</em> be added to your project's "Preprocessor Definitions".</li>
+</ul>
+<h1>License</h1>
+<p>This library is free software. It is released under the terms of the <a href="https://www.gnu.org/licenses/lgpl-2.1.html"><em>GNU Lesser General Public License (LGPL), Version 2.1</em></a>. </p><pre class="fragment">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.
+</pre><h1>Acknowledgement</h1>
+<p>The following third-party code is used in the MUtilities library:</p>
+<ul>
+<li><b>Keccak/SHA-3 Reference Implementation</b> 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</li>
+<li><b>Natural Order String Comparison</b> Copyright (C) 2000, 2004 by Martin Pool <a href="#" onclick="location.href='mai'+'lto:'+'mbp'+'@s'+'our'+'ce'+'fro'+'g.'+'net'; return false;">mbp@s<span style="display: none;">.nosp@m.</span>ourc<span style="display: none;">.nosp@m.</span>efrog<span style="display: none;">.nosp@m.</span>.net</a> Released under the zlib License</li>
+<li><b>Adler-32 Checksum Algorithm (from zlib)</b> Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler Released under the zlib License </li>
+</ul>
+</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
var searchData=
[
- ['mulder_27s_20utilities_20for_20qt',['MuldeR's Utilities for Qt',['../index.html',1,'']]],
['make_5ftemp_5ffile',['make_temp_file',['../d5/d3b/_global_8h.html#a67cb16c62b213da5135a6fa076f3f005',1,'MUtils']]],
['make_5funique_5ffile',['make_unique_file',['../d5/d3b/_global_8h.html#a390e56e35eb9329d2e67fa9741d07536',1,'MUtils']]]
];
+++ /dev/null
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html><head><title></title>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<meta name="generator" content="Doxygen 1.8.12"/>
-<link rel="stylesheet" type="text/css" href="search.css"/>
-<script type="text/javascript" src="pages_0.js"></script>
-<script type="text/javascript" src="search.js"></script>
-</head>
-<body class="SRPage">
-<div id="SRIndex">
-<div class="SRStatus" id="Loading">Loading...</div>
-<div id="SRResults"></div>
-<script type="text/javascript"><!--
-createResults();
---></script>
-<div class="SRStatus" id="Searching">Searching...</div>
-<div class="SRStatus" id="NoMatches">No Matches</div>
-<script type="text/javascript"><!--
-document.getElementById("Loading").style.display="none";
-document.getElementById("NoMatches").style.display="none";
-var searchResults = new SearchResults("searchResults");
-searchResults.Search();
---></script>
-</div>
-</body>
-</html>
+++ /dev/null
-var searchData=
-[
- ['mulder_27s_20utilities_20for_20qt',['MuldeR's Utilities for Qt',['../index.html',1,'']]]
-];
0: "_abgijkmnprstuv",
1: "_bijkrstuv",
2: "g",
- 3: "amnprt",
- 4: "m"
+ 3: "amnprt"
};
var indexSectionNames =
0: "all",
1: "classes",
2: "files",
- 3: "functions",
- 4: "pages"
+ 3: "functions"
};
var indexSectionLabels =
0: "All",
1: "Classes",
2: "Files",
- 3: "Functions",
- 4: "Pages"
+ 3: "Functions"
};
///////////////////////////////////////////////////////////////////////////////
-/**
-* \mainpage MuldeR's Utilities for Qt
-*
-* The **MUtilities** library is a collection of routines and classes to extend the [*Qt cross-platform framework*](http://qt-project.org/). 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**](http://lamexp.sourceforge.net/) 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*](https://github.com/lordmulder).
-*
-*
-* ### API-Documentation
-*
-* The public API of the *MUtilities* library is defined in the following header files:
-* - **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](https://www.gnu.org/licenses/lgpl-2.1.html).
-*
-* ```
-* 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.
-* ```
-*/
-
namespace MUtils
{
/**
* \brief Rerieves the full path of the application's *Temp* folder.
*
- * 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 is about to terminate, the application's *Temp* folder and all files or sub-directories thereof will be *removed* automatically!
+ * 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!
*
* \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.
*/
*
* 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.
*
- * \return The function retruns a *random* unsigned 32-Bit value.
+ * \return The function returns a *random* unsigned 32-Bit value.
*/
MUTILS_API quint32 next_rand_u32(void);
*
* 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.
*
- * \return The function retruns a *random* unsigned 64-Bit value.
+ * \return The function returns a *random* unsigned 64-Bit value.
*/
MUTILS_API quint64 next_rand_u64(void);
*
* \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.
*
- * \return The function retruns a QString holding a *random* hexadecimal string
+ * \return The function returns a QString holding a *random* hexadecimal string
*/
MUTILS_API QString next_rand_str(const bool &bLong = false);
*
* \param basePath Specifies the "base" directory where the unique file is supposed to be created. This must be a valid *existing* directory.
*
- * \param baseName Specifies the desired "base" file name of the unqiue file. Do **not** include a file extension.
+ * \param baseName Specifies the desired "base" file name of the unique file. Do **not** include a file extension.
*
- * \param extension Specifies the desired file extensions of the unqiue file. Do **not** include a leading dot (`.`) character.
+ * \param extension Specifies the desired file extensions of the unique file. Do **not** include a leading dot (`.`) character.
*
* \param 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.
*
/**
* \brief Recursively deletes the specified directory
*
- * The function deletes the specified directory. In *recusive* mode, the directory will be removed including all of its files and sub-directories. Files are deleted using the `remove_file()` function.
+ * 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.
*
* \param folderPath The path to the directory to be deleted. This should be a full path.
*
* 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!
*
* \param list A reference to the QStringList object to be sorted. The list will be sorted "in place".
+ *
+ * \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.
*/
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);
--- /dev/null
+/**
+ * @mainpage
+ *
+ * # Introduction #
+ *
+ * The **MUtilities** library is a collection of routines and classes to extend the [*Qt cross-platform framework*](http://qt-project.org/). 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**](http://lamexp.sourceforge.net/) 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*](https://github.com/lordmulder).
+ *
+ *
+ * # 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
+ *
+ *
+ * # 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*](https://www.gnu.org/licenses/lgpl-2.1.html).
+ *
+ * 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@sourcefrog.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
+ */
\ No newline at end of file
OSDN Git Service
