<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<title>openPilotLog: src/functions/log.h Source File</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>
<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="custom_dark_theme.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<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="projectlogo"><img alt="Logo" src="icon_main.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">openPilotLog
</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&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&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&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('log_8h_source.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="header">
<div class="headertitle">
<div class="title">log.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *openPilotLog - A FOSS Pilot Logbook Application</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *Copyright (C) 2020-2022 Felix Turowsky</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 program is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *(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 program 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</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *GNU 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 General Public License</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *along with this program. If not, see <https://www.gnu.org/licenses/>.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef LOG_H</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define LOG_H</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <QTime></span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <QFile></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <QFileInfo></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <QDebug></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <QDir></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <QFileInfoList></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <iostream></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <QDebug></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">namespace </span><a class="code" href="namespace_o_p_l_1_1_log.html">OPL::Log</a></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="keyword">static</span> QDir logFolder;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">static</span> QString logFileName;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">int</span> numberOfLogs = 10; <span class="comment">// max number of log files to keep</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">int</span> sizeOfLogs = 1024 * 100; <span class="comment">// max log size in bytes, = 100kB</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="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> DEB_HEADER = QLatin1String(<span class="stringliteral">" [DEBG]:\t"</span>);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> INFO_HEADER = QLatin1String(<span class="stringliteral">" [INFO]:\t"</span>);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> WARN_HEADER = QLatin1String(<span class="stringliteral">" [WARN]:\t"</span>);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> CRIT_HEADER = QLatin1String(<span class="stringliteral">" [CRIT]:\t"</span>);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> DEB_HEADER_CONSOLE = QLatin1String(<span class="stringliteral">"\u001b[38;5;75m[DEBG]:\t"</span>);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> INFO_HEADER_CONSOLE = QLatin1String(<span class="stringliteral">"\033[32m[INFO]:\t\033[m"</span>);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> WARN_HEADER_CONSOLE = QLatin1String(<span class="stringliteral">"\033[33m[WARN]:\t\033[m"</span>);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> CRIT_HEADER_CONSOLE = QLatin1String(<span class="stringliteral">"\033[35m[CRIT]:\t\033[m"</span>);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> SPACER = QLatin1String(<span class="stringliteral">"\t\t"</span>);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> D_SPACER = QLatin1String(<span class="stringliteral">"\t\t\t\t"</span>);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">bool</span> <a class="code" href="namespace_o_p_l_1_1_log.html#afabb6a7d16c19b3f439cdd0a3ccf11d9">init</a>(<span class="keywordtype">bool</span> log_debug = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">void</span> <a class="code" href="namespace_o_p_l_1_1_log.html#a3366094ad1b6e443a332fdf72c2cb60a">setLogFileName</a>();</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">void</span> <a class="code" href="namespace_o_p_l_1_1_log.html#a7efc415f9f4a8abf734760ccc32dfbbb">deleteOldLogs</a>();</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">void</span> <a class="code" href="namespace_o_p_l_1_1_log.html#ace3191abb660b9aa017d252e1ab6b6be">aMessageHandler</a>(QtMsgType type, <span class="keyword">const</span> QMessageLogContext &context, <span class="keyword">const</span> QString& msg);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> QString timeNow(){<span class="keywordflow">return</span> QTime::currentTime().toString(Qt::ISODate);}</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> } <span class="comment">// namespace ALog</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor">#define REPR(cls, str) \</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor">friend \</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">QDebug operator<<(QDebug qdb, const cls& object) \</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor">{ \</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor"> qdb << QString(#cls) + '(' + str + ')'; \</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor"> return qdb; \</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor">}</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor">#endif </span><span class="comment">// LOG_H</span></div>
<div class="ttc" id="anamespace_o_p_l_1_1_log_html"><div class="ttname"><a href="namespace_o_p_l_1_1_log.html">OPL::Log</a></div><div class="ttdoc">The OPL::Log namespace encapsulates constants and functions used to provide logging to files and logg...</div><div class="ttdef"><b>Definition:</b> log.cpp:23</div></div>
<div class="ttc" id="anamespace_o_p_l_1_1_log_html_a3366094ad1b6e443a332fdf72c2cb60a"><div class="ttname"><a href="namespace_o_p_l_1_1_log.html#a3366094ad1b6e443a332fdf72c2cb60a">OPL::Log::setLogFileName</a></div><div class="ttdeci">void setLogFileName()</div><div class="ttdoc">setLogFileName sets a log file name ("Log_<Date>_<Time>.txt")</div><div class="ttdef"><b>Definition:</b> log.cpp:30</div></div>
<div class="ttc" id="anamespace_o_p_l_1_1_log_html_a7efc415f9f4a8abf734760ccc32dfbbb"><div class="ttname"><a href="namespace_o_p_l_1_1_log.html#a7efc415f9f4a8abf734760ccc32dfbbb">OPL::Log::deleteOldLogs</a></div><div class="ttdeci">void deleteOldLogs()</div><div class="ttdoc">Cleans up old logs and initializes logging by preparing and installing a QMessageHandler.</div><div class="ttdef"><b>Definition:</b> log.cpp:41</div></div>
<div class="ttc" id="anamespace_o_p_l_1_1_log_html_ace3191abb660b9aa017d252e1ab6b6be"><div class="ttname"><a href="namespace_o_p_l_1_1_log.html#ace3191abb660b9aa017d252e1ab6b6be">OPL::Log::aMessageHandler</a></div><div class="ttdeci">void aMessageHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg)</div><div class="ttdoc">aMessageHandler Intercepts Messages and prints to console and log file</div><div class="ttdef"><b>Definition:</b> log.cpp:94</div></div>
<div class="ttc" id="anamespace_o_p_l_1_1_log_html_afabb6a7d16c19b3f439cdd0a3ccf11d9"><div class="ttname"><a href="namespace_o_p_l_1_1_log.html#afabb6a7d16c19b3f439cdd0a3ccf11d9">OPL::Log::init</a></div><div class="ttdeci">bool init(bool log_debug)</div><div class="ttdoc">initialise logging, clean up logfiles and install a QMessageHandler. To enable logging of debug messa...</div><div class="ttdef"><b>Definition:</b> log.cpp:61</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_e823141bb13a34caac0c96ccd0d33fcf.html">functions</a></li><li class="navelem"><b>log.h</b></li>
<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>