1 files changed, 411 insertions, 0 deletions
diff --git a/md_CHANGELOG.html b/md_CHANGELOG.html
new file mode 100644
index 0000000..6df0b55
--- /dev/null
+++ b/md_CHANGELOG.html
@@ -0,0 +1,411 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.9.1"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<!-- BEGIN opengraph metadata -->
+<meta property="og:title" content="Doxygen Awesome" />
+<meta property="og:image" content="https://repository-images.githubusercontent.com/348492097/4f16df80-88fb-11eb-9d31-4015ff22c452" />
+<meta property="og:description" content="Custom CSS theme for doxygen html-documentation with lots of customization parameters." />
+<meta property="og:url" content="https://jothepro.github.io/doxygen-awesome-css/" />
+<!-- END opengraph metadata -->
+<!-- BEGIN twitter metadata -->
+<meta name="twitter:image:src" content="https://repository-images.githubusercontent.com/348492097/4f16df80-88fb-11eb-9d31-4015ff22c452" />
+<meta name="twitter:title" content="Doxygen Awesome" />
+<meta name="twitter:description" content="Custom CSS theme for doxygen html-documentation with lots of customization parameters." />
+<!-- END twitter metadata -->
+<title>SingleApplication: Changelog</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link rel="icon" type="image/svg+xml" href="logo.drawio.svg"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
+<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
+<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
+<script type="text/javascript" src="toggle-alternative-theme.js"></script>
+<script type="text/javascript">
+    DoxygenAwesomeFragmentCopyButton.init()
+    DoxygenAwesomeDarkModeToggle.init()
+    DoxygenAwesomeParagraphLink.init()
+</script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- https://tholman.com/github-corners/ -->
+<a href="https://github.com/itay-grudev/SingleApplication" class="github-corner" title="View source on GitHub" target="_blank">
+    <svg viewBox="0 0 250 250" width="40" height="40" style="position: absolute; top: 0; border: 0; right: 0; z-index: 99;" aria-hidden="true">
+    <path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a><style>.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}</style>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">SingleApplication
+   </div>
+   <div id="projectbrief">Replacement for QtSingleApplication</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.9.1 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+/* @license-end */</script>
+<div id="main-nav"></div>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+  <div id="nav-tree">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(document).ready(function(){initNavTree('md_CHANGELOG.html',''); initResizable(); });
+/* @license-end */
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="PageDoc"><div class="header">
+  <div class="headertitle">
+<div class="title">Changelog </div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><h1><a class="anchor" id="autotoc_md1"></a>
+3.4.0</h1>
+<ul>
+<li>Provide API for blocking sendMessage. - <em>Christoph Cullmann</em></li>
+</ul>
+<h1><a class="anchor" id="autotoc_md2"></a>
+3.3.4</h1>
+<ul>
+<li>Fix compilation under Qt 6.2+ and stricter Qt compile settings. - <em>Christoph Cullmann</em></li>
+</ul>
+<h1><a class="anchor" id="autotoc_md3"></a>
+3.3.3</h1>
+<ul>
+<li>Support for Qt 6.3+ - Fixed deprecated <code>QCryptographicHash::addData()</code> that will only support <code>QByteArrayView</code> going further. - <em>Moody Liu</em></li>
+</ul>
+<h1><a class="anchor" id="autotoc_md4"></a>
+3.3.2</h1>
+<ul>
+<li>Fixed crash caused by sending a <code>writeAck</code> on a removed connection. - <em>Nicolas Werner</em></li>
+</ul>
+<h1><a class="anchor" id="autotoc_md5"></a>
+3.3.1</h1>
+<ul>
+<li>Added support for <em>AppImage</em> dynamic executable paths. - <em>Michael Klein</em></li>
+</ul>
+<h1><a class="anchor" id="autotoc_md6"></a>
+3.3.0</h1>
+<ul>
+<li>Fixed message fragmentation issue causing crashes and incorrectly / inconsistently received messages. - <em>Nils Jeisecke</em></li>
+</ul>
+<h1><a class="anchor" id="autotoc_md7"></a>
+3.2.0</h1>
+<ul>
+<li>Added support for Qt 6 - <em>Jonas Kvinge</em></li>
+<li>Fixed warning in <code>Qt 5.9</code> with <code>min</code>/<code>max</code> functions on Windows - <em>Nick Korotysh</em></li>
+<li>Fix return value of connectToPrimary() when connect is successful - <em>Jonas Kvinge</em></li>
+<li>Fix build issue with MinGW GCC pedantic mode - <em>Iakov Kirilenko</em></li>
+<li>Fixed conversion from <code>int</code> to <code>quint32</code> and Clang Tidy warnings - <em>Hennadii Chernyshchyk</em></li>
+</ul>
+<h1><a class="anchor" id="autotoc_md8"></a>
+3.1.5</h1>
+<ul>
+<li>Improved library stability in edge cases and very rapid process initialisation</li>
+<li>Fixed Bug where the shared memory block may have been modified without a lock</li>
+<li>Fixed Bug causing <code>instanceStarted()</code> to not get emitted when a second instance has been started before the primary has initiated it's <code>QLocalServer</code>.</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md9"></a>
+3.1.4</h1>
+<ul>
+<li>Officially supporting and build-testing against Qt 5.15</li>
+<li><p class="startli">Fixed an MSVC C4996 warning that suggests using <code>strncpy_s</code>.</p>
+<p class="startli"><em>Hennadii Chernyshchyk</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md10"></a>
+3.1.3.1</h1>
+<ul>
+<li>CMake build system improvements</li>
+<li><p class="startli">Fixed Clang Tidy warnings</p>
+<p class="startli"><em>Hennadii Chernyshchyk</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md11"></a>
+3.1.3</h1>
+<ul>
+<li><p class="startli">Improved <code>CMakeLists.txt</code></p>
+<p class="startli"><em>Hennadii Chernyshchyk</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md12"></a>
+3.1.2</h1>
+<ul>
+<li><p class="startli">Fix a crash when exiting an application on Android and iOS</p>
+<p class="startli"><em>Emeric Grange</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md13"></a>
+3.1.1a</h1>
+<ul>
+<li><p class="startli">Added currentUser() method that returns the user the current instance is running as.</p>
+<p class="startli"><em>Leander Schulten</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md14"></a>
+3.1.0a</h1>
+<ul>
+<li>Added primaryUser() method that returns the user the primary instance is running as.</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md15"></a>
+3.0.19</h1>
+<ul>
+<li><p class="startli">Fixed code warning for depricated functions in Qt 5.10 related to <code>QTime</code> and <code>qrand()</code>.</p>
+<p class="startli"><em>Hennadii Chernyshchyk</em> <br  />
+ <em>Anton Filimonov</em> <br  />
+ <em>Jonas Kvinge</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md16"></a>
+3.0.18</h1>
+<ul>
+<li>Fallback to standard QApplication class on iOS and Android systems where the library is not supported.</li>
+<li><p class="startli">Added Build CI tests to verify the library builds successfully on Linux, Windows and MacOS across multiple Qt versions.</p>
+<p class="startli"><em>Anton Filimonov</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md17"></a>
+3.0.17</h1>
+<ul>
+<li><p class="startli">Fixed compilation warning/error caused by <code>geteuid()</code> on unix based systems.</p>
+<p class="startli"><em>Iakov Kirilenko</em></p>
+</li>
+<li><p class="startli">Added CMake support</p>
+<p class="startli"><em>Hennadii Chernyshchyk</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md18"></a>
+3.0.16</h1>
+<ul>
+<li><p class="startli">Use geteuid and getpwuid to get username on Unix, fallback to environment variable.</p>
+<p class="startli"><em>Jonas Kvinge</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md19"></a>
+3.0.15</h1>
+<ul>
+<li><p class="startli">Bug Fix: sendMessage() might return false even though data was actually written.</p>
+<p class="startli"><em>Jonas Kvinge</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md20"></a>
+3.0.14</h1>
+<ul>
+<li>Fixed uninitialised variables in the <code>SingleApplicationPrivate</code> constructor.</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md21"></a>
+3.0.13a</h1>
+<ul>
+<li>Process socket events asynchronously</li>
+<li><p class="startli">Fix undefined variable error on Windows</p>
+<p class="startli"><em>Francis Giraldeau</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md22"></a>
+3.0.12a</h1>
+<ul>
+<li>Removed signal handling.</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md23"></a>
+3.0.11a</h1>
+<ul>
+<li><p class="startli">Fixed bug where the message sent by the second process was not received correctly when the message is sent immediately following a connection.</p>
+<p class="startli"><em>Francis Giraldeau</em></p>
+</li>
+<li>Refactored code and implemented shared memory block consistency checks via <code>qChecksum()</code> (CRC-16).</li>
+<li>Explicit <code>qWarning</code> and <code>qCritical</code> when the library is unable to initialise correctly.</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md24"></a>
+3.0.10</h1>
+<ul>
+<li>Removed C style casts and eliminated all clang warnings. Fixed <code>instanceId</code> reading from only one byte in the message deserialization. Cleaned up serialization code using <code>QDataStream</code>. Changed connection type to use <code>quint8 enum</code> rather than <code>char</code>.</li>
+<li><p class="startli">Renamed <code>SingleAppConnectionType</code> to <code>ConnectionType</code>. Added initialization values to all <code>ConnectionType</code> enum cases.</p>
+<p class="startli"><em>Jedidiah Buck McCready</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md25"></a>
+3.0.9</h1>
+<ul>
+<li><p class="startli">Added SingleApplicationPrivate::primaryPid() as a solution to allow bringing the primary window of an application to the foreground on Windows.</p>
+<p class="startli"><em>Eelco van Dam from Peacs BV</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md26"></a>
+3.0.8</h1>
+<ul>
+<li><p class="startli">Bug fix - changed QApplication::instance() to QCoreApplication::instance()</p>
+<p class="startli"><em>Evgeniy Bazhenov</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md27"></a>
+3.0.7a</h1>
+<ul>
+<li>Fixed compilation error with Mingw32 in MXE thanks to Vitaly Tonkacheyev.</li>
+<li>Removed QMutex used for thread safe behaviour. The implementation now uses QCoreApplication::instance() to get an instance to <a class="el" href="classSingleApplication.html" title="Handles multiple instances of the same Application.">SingleApplication</a> for memory deallocation.</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md28"></a>
+3.0.6a</h1>
+<ul>
+<li>Reverted GetUserName API usage on Windows. Fixed bug with missing library.</li>
+<li><p class="startli">Fixed bug in the Calculator example, preventing it's window to be raised on Windows.</p>
+<p class="startli">Special thanks to Charles Gunawan.</p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md29"></a>
+3.0.5a</h1>
+<ul>
+<li><p class="startli">Fixed a memory leak in the SingleApplicationPrivate destructor.</p>
+<p class="startli"><em>Sergei Moiseev</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md30"></a>
+3.0.4a</h1>
+<ul>
+<li><p class="startli">Fixed shadow and uninitialised variable warnings.</p>
+<p class="startli"><em>Paul Walmsley</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md31"></a>
+3.0.3a</h1>
+<ul>
+<li>Removed Microsoft Windows specific code for getting username due to multiple problems and compiler differences on Windows platforms. On Windows the shared memory block in User mode now includes the user's home path (which contains the user's username).</li>
+<li>Explicitly getting absolute path of the user's home directory as on Unix a relative path (<code>~</code>) may be returned.</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md32"></a>
+3.0.2a</h1>
+<ul>
+<li><p class="startli">Fixed bug on Windows when username containing wide characters causes the library to crash.</p>
+<p class="startli"><em>Le Liu</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md33"></a>
+3.0.1a</h1>
+<ul>
+<li>Allows the application path and version to be excluded from the server name hash. The following flags were added for this purpose:<ul>
+<li><code>SingleApplication::Mode::ExcludeAppVersion</code></li>
+<li><code>SingleApplication::Mode::ExcludeAppPath</code></li>
+</ul>
+</li>
+<li>Allow a non elevated process to connect to a local server created by an elevated process run by the same user on Windows</li>
+<li><p class="startli">Fixes a problem with upper case letters in paths on Windows</p>
+<p class="startli"><em>Le Liu</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md34"></a>
+v3.0a</h1>
+<ul>
+<li>Deprecated secondary instances count.</li>
+<li>Added a sendMessage() method to send a message to the primary instance.</li>
+<li>Added a receivedMessage() signal, emitted when a message is received from a secondary instance.</li>
+<li>The <a class="el" href="classSingleApplication.html" title="Handles multiple instances of the same Application.">SingleApplication</a> constructor's third parameter is now a bool specifying if the current instance should be allowed to run as a secondary instance if there is already a primary instance.</li>
+<li>The <a class="el" href="classSingleApplication.html" title="Handles multiple instances of the same Application.">SingleApplication</a> constructor accept a fourth parameter specifying if the <a class="el" href="classSingleApplication.html" title="Handles multiple instances of the same Application.">SingleApplication</a> block should be User-wide or System-wide.</li>
+<li><a class="el" href="classSingleApplication.html" title="Handles multiple instances of the same Application.">SingleApplication</a> no longer relies on <code>applicationName</code> and <code>organizationName</code> to be set. It instead concatenates all of the following data and computes a <code>SHA256</code> hash which is used as the key of the <code>QSharedMemory</code> block and the <code>QLocalServer</code>. Since at least <code>applicationFilePath</code> is always present there is no need to explicitly set any of the following prior to initialising <code><a class="el" href="classSingleApplication.html" title="Handles multiple instances of the same Application.">SingleApplication</a></code>.<ul>
+<li><code>QCoreApplication::applicationName</code></li>
+<li><code>QCoreApplication::applicationVersion</code></li>
+<li><code>QCoreApplication::applicationFilePath</code></li>
+<li><code>QCoreApplication::organizationName</code></li>
+<li><code>QCoreApplication::organizationDomain</code></li>
+<li>User name or home directory path if in User mode</li>
+</ul>
+</li>
+<li>The primary instance is no longer notified when a secondary instance had been started by default. A <code>Mode</code> flag for this feature exists.</li>
+<li>Added <code>instanceNumber()</code> which represents a unique identifier for each secondary instance started. When called from the primary instance will return <code>0</code>.</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md35"></a>
+v2.4</h1>
+<ul>
+<li>Stability improvements</li>
+<li>Support for secondary instances.</li>
+<li>The library now recovers safely after the primary process has crashed and the shared memory had not been deleted.</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md36"></a>
+v2.3</h1>
+<ul>
+<li><p class="startli">Improved pimpl design and inheritance safety.</p>
+<p class="startli"><em>Vladislav Pyatnichenko</em></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md37"></a>
+v2.2</h1>
+<ul>
+<li>The <code>QAPPLICATION_CLASS</code> macro can now be defined in the file including the Single Application header or with a <code>DEFINES+=</code> statement in the project file.</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md38"></a>
+v2.1</h1>
+<ul>
+<li><p class="startli">A race condition can no longer occur when starting two processes nearly simultaneously.</p>
+<p class="startli">Fix issue <a href="https://github.com/itay-grudev/SingleApplication/issues/3">#3</a></p>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md39"></a>
+v2.0</h1>
+<ul>
+<li><p class="startli"><a class="el" href="classSingleApplication.html" title="Handles multiple instances of the same Application.">SingleApplication</a> is now being passed a reference to <code>argc</code> instead of a copy.</p>
+<p class="startli">Fix issue <a href="https://github.com/itay-grudev/SingleApplication/issues/1">#1</a></p>
+</li>
+<li>Improved documentation. </li>
+</ul>
+</div></div><!-- contents -->
+</div><!-- PageDoc -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
+  </ul>
+</div>
+</body>
+</html>