README.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4   <meta charset="utf-8">
   5   <meta name="generator" content="pandoc">
   6   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
   7   <meta name="author" content="Created by LoRd_MuldeR &lt;mulder2@gmx&gt; – check http://muldersoft.com/ for news and updates!">
   8   <title>MUtilities – README</title>
   9   <style type="text/css">code{white-space: pre;}</style>
  10   <!--[if lt IE 9]>
  11     <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  12   <![endif]-->
  13   <style type="text/css">
  14   <!--
  15     body { font-family: "Times New Roman", Times, serif; color: #000000; background-color: #FFFFFF; }
  16     p { text-align: justify; }
  17     tt, pre, code { font-family: Courier New, Courier, mono; background-color: #EDF3F7; padding: 1px; }
  18     h1:not(.title) { margin-top: 2.25em; }
  19     h2:not(.author) { margin-top: 2.0em; }
  20     h3, h4 { margin-top: 1.75em; }
  21     a { color: #0000BB; text-decoration: none; }
  22     a:visited { color: #0000BB; text-decoration: none; }
  23     a:active { color: #0000FF; text-decoration: none; }
  24     a:hover { color: #0000FF; text-decoration: underline; }
  25     img { margin-bottom: 0.75em; }
  26     ul, ol  { margin-bottom: 2.0em; }
  27     li>ul, li>ol  { margin-bottom: 0em; }
  28   -->
  29   </style>
  30 </head>
  31 <body>
  32 <header>
  33 <h1 class="title">MUtilities – README</h1>
  34 <h2 class="author">Created by LoRd_MuldeR &lt;<script type="text/javascript">
  35 <!--
  36 h='&#x67;&#x6d;&#120;';a='&#64;';n='&#x6d;&#x75;&#108;&#100;&#x65;&#114;&#50;';e=n+a+h;
  37 document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'" clas'+'s="em' + 'ail">'+e+'<\/'+'a'+'>');
  38 // -->
  39 </script><noscript>&#x6d;&#x75;&#108;&#100;&#x65;&#114;&#50;&#32;&#x61;&#116;&#32;&#x67;&#x6d;&#120;</noscript>&gt; – check <a href="http://muldersoft.com/" class="uri">http://muldersoft.com/</a> for news and updates!</h2>
  40 </header>
  41 <nav id="TOC">
  42 <ul>
  43 <li><a href="#introduction"><span class="toc-section-number">1</span> Introduction</a></li>
  44 <li><a href="#project-structure"><span class="toc-section-number">2</span> Project Structure</a></li>
  45 <li><a href="#example"><span class="toc-section-number">3</span> Example</a><ul>
  46 <li><a href="#build-notes"><span class="toc-section-number">3.1</span> Build Notes</a></li>
  47 </ul></li>
  48 <li><a href="#api-documentation"><span class="toc-section-number">4</span> API Documentation</a></li>
  49 <li><a href="#license"><span class="toc-section-number">5</span> License</a></li>
  50 <li><a href="#acknowledgement"><span class="toc-section-number">6</span> Acknowledgement</a></li>
  51 </ul>
  52 </nav>
  53 <h1 id="introduction"><span class="header-section-number">1</span> Introduction</h1>
  54 <p>The <strong>MUtilities</strong> 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 &quot;side product&quot; of the <a href="http://lamexp.sourceforge.net/"><strong>LameXP</strong></a> application: Over the years, a lot of code, <strong>not</strong> 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 &quot;copy &amp; paste&quot; 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 <strong>MUtilities</strong> (aka &quot;MuldeR's Utilities for Qt&quot;) 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>
  55 <h1 id="project-structure"><span class="header-section-number">2</span> Project Structure</h1>
  56 <p>The <em>MUtilities</em> project directory is organized as follows:</p>
  57 <ul>
  58 <li><code>bin/</code> – compiled library files (static or shared), link those files in projects that use the MUtilities library</li>
  59 <li><code>docs/</code> – programming interface documentation, generated with Doxygen tool</li>
  60 <li><code>etc/</code> – miscellaneous files, everything that doesn't fit in anywhere else</li>
  61 <li><code>include/</code> – public header files, include this directory in projects that use the MUtilities library</li>
  62 <li><code>obj/</code> – object code files, intermediate files generated during the build process</li>
  63 <li><code>res/</code> – resource files, required for building the MUtilities library</li>
  64 <li><code>src/</code> – source code files, required for building the MUtilities library (third-party code in <code>src/3rd_party/</code>)</li>
  65 <li><code>test/</code> – unit tests, based on Google Test framework</li>
  66 <li><code>tmp/</code> – temporary files, automatically generated during the build process</li>
  67 </ul>
  68 <h1 id="example"><span class="header-section-number">3</span> Example</h1>
  69 <p>Here is a minimal example on how to use the <em>MUtilities</em> library in your project:</p>
  70 <pre><code>//MUtils
  71 #include &lt;MUtils/Global.h&gt;
  72
  73 int main(int argc, char **argv)
  74 {
  75     qDebug(&quot;Random number: %u\n&quot;, MUtils::next_rand_u32());
  76 }</code></pre>
  77 <h2 id="build-notes"><span class="header-section-number">3.1</span> Build Notes</h2>
  78 <ul>
  79 <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>
  80 <li>Additionally, make sure that <em>MUtilities'</em> <code>include/</code> directory is contained in your &quot;Additional Include Directories&quot; and that the <em>MUtilities'</em> <code>bin/</code> directory is contained in your &quot;Additional Library Directories&quot;.</li>
  81 <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/&lt;platform&gt;/&lt;config&gt;/</code> directory!</li>
  82 <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 &quot;Preprocessor Definitions&quot;.</li>
  83 </ul>
  84 <h1 id="api-documentation"><span class="header-section-number">4</span> API Documentation</h1>
  85 <p>A fully-fledged documentation of the <em>MUtilities</em> programming interface (API) is available thanks to <a href="http://www.stack.nl/~dimitri/doxygen/"><em>Doxygen</em></a>. Please see <a href="docs/index.html"><strong><code>docs/index.html</code></strong></a> for details!</p>
  86 <h1 id="license"><span class="header-section-number">5</span> License</h1>
  87 <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>
  88 <pre><code>MUtilities - MuldeR&#39;s Utilities for Qt
  89 Copyright (C) 2004-2019 LoRd_MuldeR &lt;MuldeR2@GMX.de&gt;. Some rights reserved.
  90
  91 This library is free software; you can redistribute it and/or
  92 modify it under the terms of the GNU Lesser General Public
  93 License as published by the Free Software Foundation; either
  94 version 2.1 of the License, or (at your option) any later version.
  95
  96 This library is distributed in the hope that it will be useful,
  97 but WITHOUT ANY WARRANTY; without even the implied warranty of
  98 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  99 Lesser General Public License for more details.
 100
 101 You should have received a copy of the GNU Lesser General Public
 102 License along with this library; if not, write to the Free Software
 103 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.</code></pre>
 104 <h1 id="acknowledgement"><span class="header-section-number">6</span> Acknowledgement</h1>
 105 <p>The following people have contributed in the development of the MUtilities library:</p>
 106 <ul>
 107 <li><strong>John Buonagurio &lt;<script type="text/javascript">
 108 <!--
 109 h='&#x65;&#120;&#112;&#x6f;&#110;&#x65;&#110;&#116;&#46;&#x63;&#x6f;&#x6d;';a='&#64;';n='&#106;&#98;&#x75;&#x6f;&#110;&#x61;&#x67;&#x75;&#114;&#x69;&#x6f;';e=n+a+h;
 110 document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'" clas'+'s="em' + 'ail">'+e+'<\/'+'a'+'>');
 111 // -->
 112 </script><noscript>&#106;&#98;&#x75;&#x6f;&#110;&#x61;&#x67;&#x75;&#114;&#x69;&#x6f;&#32;&#x61;&#116;&#32;&#x65;&#120;&#112;&#x6f;&#110;&#x65;&#110;&#116;&#32;&#100;&#x6f;&#116;&#32;&#x63;&#x6f;&#x6d;</noscript>&gt;</strong><br />
 113 Support for Qt5</li>
 114 </ul>
 115 <p>The following third-party code is used in the MUtilities library:</p>
 116 <ul>
 117 <li><p><strong>Keccak/SHA-3 Reference Implementation</strong><br />
 118 Implementation by the Keccak, Keyak and Ketje Teams, namely, Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche and Ronny Van Keer<br />
 119 No Copyright / Dedicated to the Public Domain</p></li>
 120 <li><p><strong>Natural Order String Comparison</strong><br />
 121 Copyright (C) 2000, 2004 by Martin Pool &lt;<script type="text/javascript">
 122 <!--
 123 h='&#x73;&#x6f;&#x75;&#114;&#x63;&#x65;&#102;&#114;&#x6f;&#x67;&#46;&#110;&#x65;&#116;';a='&#64;';n='&#x6d;&#98;&#112;';e=n+a+h;
 124 document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'" clas'+'s="em' + 'ail">'+e+'<\/'+'a'+'>');
 125 // -->
 126 </script><noscript>&#x6d;&#98;&#112;&#32;&#x61;&#116;&#32;&#x73;&#x6f;&#x75;&#114;&#x63;&#x65;&#102;&#114;&#x6f;&#x67;&#32;&#100;&#x6f;&#116;&#32;&#110;&#x65;&#116;</noscript>&gt;<br />
 127 Released under the zlib License</p></li>
 128 <li><p><strong>Adler-32 Checksum Algorithm (from zlib)</strong><br />
 129 Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler<br />
 130 Released under the zlib License</p></li>
 131 </ul>
 132 <p> </p>
 133 <p><strong>e.o.f.</strong></p>
 134 </body>
 135 </html>