Home Explore Help
Register Sign In
sweproj.com
/
openPilotLog
mirror of https://github.com/fiffty-50/openPilotLog
2
0
Fork 0
Files Issues 0 Wiki
Tree: 66754f580c
Branches Tags
openPilotLog
/
docs
/
html
/
alog_8h_source.html

alog_8h_source.html 17 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.18"/>
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
    8. 

  8. <title>openPilotLog: src/functions/alog.h Source File</title>
    9. 

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
    13. 

  13. <script type="text/javascript" src="resize.js"></script>
    14. 

  14. <script type="text/javascript" src="navtreedata.js"></script>
    15. 

  15. <script type="text/javascript" src="navtree.js"></script>
    16. 

  16. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    17. 

  17. <script type="text/javascript" src="search/searchdata.js"></script>
    18. 

  18. <script type="text/javascript" src="search/search.js"></script>
    19. 

  19. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    20. 

  20. <link href="custom_dark_theme.css" rel="stylesheet" type="text/css"/>
    21. 

  21. </head>
    22. 

  22. <body>
    23. 

  23. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    24. 

  24. <div id="titlearea">
    25. 

  25. <table cellspacing="0" cellpadding="0">
    26. 

  26.  <tbody>
    27. 

  27.  <tr style="height: 56px;">
    28. 

  28.   <td id="projectlogo"><img alt="Logo" src="icon_main.png"/></td>
    29. 

  29.   <td id="projectalign" style="padding-left: 0.5em;">
    30. 

  30.    <div id="projectname">openPilotLog
    31. 

  31.    </div>
    32. 

  32.   </td>
    33. 

  33.  </tr>
    34. 

  34.  </tbody>
    35. 

  35. </table>
    36. 

  36. </div>
    37. 

  37. <!-- end header part -->
    38. 

  38. <!-- Generated by Doxygen 1.8.18 -->
    39. 

  39. <script type="text/javascript">
    40. 

  40. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
    41. 

  41. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    42. 

  42. /* @license-end */
    43. 

  43. </script>
    44. 

  44. <script type="text/javascript" src="menudata.js"></script>
    45. 

  45. <script type="text/javascript" src="menu.js"></script>
    46. 

  46. <script type="text/javascript">
    47. 

  47. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
    48. 

  48. $(function() {
    49. 

  49.   initMenu('',true,false,'search.php','Search');
    50. 

  50.   $(document).ready(function() { init_search(); });
    51. 

  51. });
    52. 

  52. /* @license-end */</script>
    53. 

  53. <div id="main-nav"></div>
    54. 

  54. </div><!-- top -->
    55. 

  55. <div id="side-nav" class="ui-resizable side-nav-resizable">
    56. 

  56.   <div id="nav-tree">
    57. 

  57.     <div id="nav-tree-contents">
    58. 

  58.       <div id="nav-sync" class="sync"></div>
    59. 

  59.     </div>
    60. 

  60.   </div>
    61. 

  61.   <div id="splitbar" style="-moz-user-select:none;" 
    62. 

  62.        class="ui-resizable-handle">
    63. 

  63.   </div>
    64. 

  64. </div>
    65. 

  65. <script type="text/javascript">
    66. 

  66. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
    67. 

  67. $(document).ready(function(){initNavTree('alog_8h_source.html',''); initResizable(); });
    68. 

  68. /* @license-end */
    69. 

  69. </script>
    70. 

  70. <div id="doc-content">
    71. 

  71. <!-- window showing the filter options -->
    72. 

  72. <div id="MSearchSelectWindow"
    73. 

  73.      onmouseover="return searchBox.OnSearchSelectShow()"
    74. 

  74.      onmouseout="return searchBox.OnSearchSelectHide()"
    75. 

  75.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    76. 

  76. </div>
    77. 

  77. 

  78. <!-- iframe showing the search results (closed by default) -->
    79. 

  79. <div id="MSearchResultsWindow">
    80. 

  80. <iframe src="javascript:void(0)" frameborder="0" 
    81. 

  81.         name="MSearchResults" id="MSearchResults">
    82. 

  82. </iframe>
    83. 

  83. </div>
    84. 

  84. 

  85. <div class="header">
    86. 

  86.   <div class="headertitle">
    87. 

  87. <div class="title">alog.h</div>  </div>
    88. 

  88. </div><!--header-->
    89. 

  89. <div class="contents">
    90. 

  90. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
    91. 

  91. <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *openPilotLog - A FOSS Pilot Logbook Application</span></div>
    92. 

  92. <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *Copyright (C) 2020-2021 Felix Turowsky</span></div>
    93. 

  93. <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>
    94. 

  94. <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *This program is free software: you can redistribute it and/or modify</span></div>
    95. 

  95. <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *it under the terms of the GNU General Public License as published by</span></div>
    96. 

  96. <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> *the Free Software Foundation, either version 3 of the License, or</span></div>
    97. 

  97. <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *(at your option) any later version.</span></div>
    98. 

  98. <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *</span></div>
    99. 

  99. <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *This program is distributed in the hope that it will be useful,</span></div>
    100. 

  100. <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> *but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
    101. 

  101. <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span></div>
    102. 

  102. <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *GNU General Public License for more details.</span></div>
    103. 

  103. <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *</span></div>
    104. 

  104. <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *You should have received a copy of the GNU General Public License</span></div>
    105. 

  105. <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *along with this program.  If not, see &lt;https://www.gnu.org/licenses/&gt;.</span></div>
    106. 

  106. <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> */</span></div>
    107. 

  107. <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#ifndef ALOG_H</span></div>
    108. 

  108. <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#define ALOG_H</span></div>
    109. 

  109. <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160; </div>
    110. 

  110. <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;QTime&gt;</span></div>
    111. 

  111. <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &lt;QFile&gt;</span></div>
    112. 

  112. <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &lt;QFileInfo&gt;</span></div>
    113. 

  113. <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#include &lt;QDebug&gt;</span></div>
    114. 

  114. <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &lt;QDir&gt;</span></div>
    115. 

  115. <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &lt;QFileInfoList&gt;</span></div>
    116. 

  116. <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &lt;iostream&gt;</span></div>
    117. 

  117. <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#include &lt;QDebug&gt;</span></div>
    118. 

  118. <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#include &quot;src/classes/astandardpaths.h&quot;</span></div>
    119. 

  119. <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160; </div>
    120. 

  120. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_a_log.html">ALog</a></div>
    121. 

  121. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;{</div>
    122. 

  122. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <span class="keyword">static</span> QDir logFolder;</div>
    123. 

  123. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    <span class="keyword">static</span> QString logFileName;</div>
    124. 

  124. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <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>
    125. 

  125. <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <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>
    126. 

  126. <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>
    127. 

  127. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> DEB_HEADER  = QLatin1String(<span class="stringliteral">&quot; [DEBG]:\t&quot;</span>);</div>
    128. 

  128. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> INFO_HEADER = QLatin1String(<span class="stringliteral">&quot; [INFO]:\t&quot;</span>);</div>
    129. 

  129. <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> WARN_HEADER = QLatin1String(<span class="stringliteral">&quot; [WARN]:\t&quot;</span>);</div>
    130. 

  130. <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> CRIT_HEADER = QLatin1String(<span class="stringliteral">&quot; [CRIT]:\t&quot;</span>);</div>
    131. 

  131. <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> DEB_HEADER_CONSOLE  = QLatin1String(<span class="stringliteral">&quot;\u001b[38;5;75m[DEBG]:\t&quot;</span>);</div>
    132. 

  132. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> INFO_HEADER_CONSOLE = QLatin1String(<span class="stringliteral">&quot;\033[32m[INFO]:\t\033[m&quot;</span>);</div>
    133. 

  133. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> WARN_HEADER_CONSOLE = QLatin1String(<span class="stringliteral">&quot;\033[33m[WARN]:\t\033[m&quot;</span>);</div>
    134. 

  134. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> CRIT_HEADER_CONSOLE = QLatin1String(<span class="stringliteral">&quot;\033[35m[CRIT]:\t\033[m&quot;</span>);</div>
    135. 

  135. <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> SPACER = QLatin1String(<span class="stringliteral">&quot;\t\t&quot;</span>);</div>
    136. 

  136. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    <span class="keyword">const</span> <span class="keyword">static</span> <span class="keyword">auto</span> D_SPACER = QLatin1String(<span class="stringliteral">&quot;\t\t\t\t&quot;</span>);</div>
    137. 

  137. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160; </div>
    138. 

  138. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="namespace_a_log.html#ac797ea9883ac75b58c2b08a64bcc26d7">init</a>(<span class="keywordtype">bool</span> log_debug = <span class="keyword">false</span>);</div>
    139. 

  139. <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="namespace_a_log.html#a1eeade2b758f2d452e40426f8d37c41a">setLogFileName</a>();</div>
    140. 

  140. <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="namespace_a_log.html#ae110fbae5b42a1dd106a9c53be104b13">deleteOldLogs</a>();</div>
    141. 

  141. <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="namespace_a_log.html#a421bd504f26d924e0557d6359d853f69">aMessageHandler</a>(QtMsgType type, <span class="keyword">const</span> QMessageLogContext &amp;context, <span class="keyword">const</span> QString&amp; msg);</div>
    142. 

  142. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <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>
    143. 

  143. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160; </div>
    144. 

  144. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;} <span class="comment">// namespace ALog</span></div>
    145. 

  145. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160; </div>
    146. 

  146. <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="preprocessor">#define REPR(cls, str) \</span></div>
    147. 

  147. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="preprocessor">friend \</span></div>
    148. 

  148. <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="preprocessor">QDebug operator&lt;&lt;(QDebug qdb, const cls&amp; object) \</span></div>
    149. 

  149. <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="preprocessor">{ \</span></div>
    150. 

  150. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="preprocessor">    qdb &lt;&lt; QString(#cls) + &#39;(&#39; + str + &#39;)&#39;; \</span></div>
    151. 

  151. <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="preprocessor">    return qdb; \</span></div>
    152. 

  152. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="preprocessor">}</span></div>
    153. 

  153. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160; </div>
    154. 

  154. <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="preprocessor">#endif // ALOG_H</span></div>
    155. 

  155. </div><!-- fragment --></div><!-- contents -->
    156. 

  156. </div><!-- doc-content -->
    157. 

  157. <div class="ttc" id="anamespace_a_log_html"><div class="ttname"><a href="namespace_a_log.html">ALog</a></div><div class="ttdoc">The ALog namespace encapsulates constants and functions used to provide logging to files and logging ...</div><div class="ttdef"><b>Definition:</b> alog.cpp:21</div></div>
    158. 

  158. <div class="ttc" id="anamespace_a_log_html_a421bd504f26d924e0557d6359d853f69"><div class="ttname"><a href="namespace_a_log.html#a421bd504f26d924e0557d6359d853f69">ALog::aMessageHandler</a></div><div class="ttdeci">void aMessageHandler(QtMsgType type, const QMessageLogContext &amp;context, const QString &amp;msg)</div><div class="ttdoc">aMessageHandler Intercepts Messages and prints to console and log file</div><div class="ttdef"><b>Definition:</b> alog.cpp:84</div></div>
    159. 

  159. <div class="ttc" id="anamespace_a_log_html_a1eeade2b758f2d452e40426f8d37c41a"><div class="ttname"><a href="namespace_a_log.html#a1eeade2b758f2d452e40426f8d37c41a">ALog::setLogFileName</a></div><div class="ttdeci">void setLogFileName()</div><div class="ttdoc">setLogFileName sets a log file name (&quot;Log_&lt;Date&gt;_&lt;Time&gt;.txt&quot;)</div><div class="ttdef"><b>Definition:</b> alog.cpp:28</div></div>
    160. 

  160. <div class="ttc" id="anamespace_a_log_html_ae110fbae5b42a1dd106a9c53be104b13"><div class="ttname"><a href="namespace_a_log.html#ae110fbae5b42a1dd106a9c53be104b13">ALog::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> alog.cpp:39</div></div>
    161. 

  161. <div class="ttc" id="anamespace_a_log_html_ac797ea9883ac75b58c2b08a64bcc26d7"><div class="ttname"><a href="namespace_a_log.html#ac797ea9883ac75b58c2b08a64bcc26d7">ALog::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> alog.cpp:59</div></div>
    162. 

  162. <!-- start footer part -->
    163. 

  163. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    164. 

  164.   <ul>
    165. 

  165.     <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>alog.h</b></li>
    166. 

  166.     <li class="footer">Generated by
    167. 

  167.     <a href="http://www.doxygen.org/index.html">
    168. 

  168.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li>
    169. 

  169.   </ul>
    170. 

  170. </div>
    171. 

  171. </body>
    172. 

  172. </html>
    173.