220 lines
21 KiB
HTML
220 lines
21 KiB
HTML
<!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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.10.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>stdex: include/stdex/debug.hpp 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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<script type="text/javascript" src="cookie.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" />
|
|
</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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">stdex
|
|
</div>
|
|
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.10.0 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_fca3c47b2ea228727bd6729832f89576.html">stdex</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">debug.hpp</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> SPDX-License-Identifier: MIT</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> Copyright © 2023-2024 Amebis</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">*/</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "compat.hpp"</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "string.hpp"</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include <stdarg.h></span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include <stdint.h></span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include <stdio.h></span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include <chrono></span></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">namespace </span>stdex</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>{</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span>diag {</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> vprintf(_In_z_ _Printf_format_string_ <span class="keyword">const</span> <span class="keywordtype">char</span>* format, _In_ va_list arg)</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> {</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#if defined(NDEBUG)</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> UNREFERENCED_PARAMETER(format);</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> UNREFERENCED_PARAMETER(arg);</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#elif defined(_WIN32)</span></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">auto</span> tmp = stdex::vsprintf(format, stdex::locale_default, arg);</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> OutputDebugStringA(tmp.c_str());</div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#else</span></div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> vfprintf(stdout, format, arg);</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> }</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> vprintf(_In_z_ _Printf_format_string_ <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* format, _In_ va_list arg)</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> {</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#if defined(NDEBUG)</span></div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> UNREFERENCED_PARAMETER(format);</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> UNREFERENCED_PARAMETER(arg);</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="preprocessor">#elif defined(_WIN32)</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">auto</span> tmp = stdex::vsprintf(format, stdex::locale_default, arg);</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> OutputDebugStringW(tmp.c_str());</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="preprocessor">#else</span></div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> vfwprintf(stdout, format, arg);</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> printf(_In_z_ _Printf_format_string_ <span class="keyword">const</span> T* format, ...)</div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> {</div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="preprocessor">#if defined(NDEBUG)</span></div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> UNREFERENCED_PARAMETER(format);</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="preprocessor">#else</span></div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> va_list arg;</div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> va_start(arg, format);</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> vprintf(format, arg);</div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> va_end(arg);</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> }</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> }</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">namespace </span>err {</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> vprintf(_In_z_ _Printf_format_string_ <span class="keyword">const</span> <span class="keywordtype">char</span>* format, _In_ va_list arg)</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> {</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="preprocessor">#if defined(NDEBUG)</span></div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> UNREFERENCED_PARAMETER(format);</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> UNREFERENCED_PARAMETER(arg);</div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="preprocessor">#elif defined(_WIN32)</span></div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">auto</span> tmp = stdex::vsprintf(format, stdex::locale_default, arg);</div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> OutputDebugStringA(tmp.c_str());</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="preprocessor">#else</span></div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> vfprintf(stderr, format, arg);</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> }</div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> vprintf(_In_z_ _Printf_format_string_ <span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* format, _In_ va_list arg)</div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> {</div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="preprocessor">#if defined(NDEBUG)</span></div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> UNREFERENCED_PARAMETER(format);</div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> UNREFERENCED_PARAMETER(arg);</div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="preprocessor">#elif defined(_WIN32)</span></div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">auto</span> tmp = stdex::vsprintf(format, stdex::locale_default, arg);</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> OutputDebugStringW(tmp.c_str());</div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="preprocessor">#else</span></div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> vfwprintf(stderr, format, arg);</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> }</div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> printf(_In_z_ _Printf_format_string_ <span class="keyword">const</span> T* format, ...)</div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> {</div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="preprocessor">#if defined(NDEBUG)</span></div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> UNREFERENCED_PARAMETER(format);</div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="preprocessor">#else</span></div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> va_list arg;</div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> va_start(arg, format);</div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> vprintf(format, arg);</div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> va_end(arg);</div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> }</div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> }</div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
|
|
<div class="foldopen" id="foldopen00124" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="classstdex_1_1benchmark.html"> 124</a></span> <span class="keyword">class </span><a class="code hl_class" href="classstdex_1_1benchmark.html">benchmark</a></div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> {</div>
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> <span class="keyword">public</span>:</div>
|
|
<div class="foldopen" id="foldopen00132" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"><a class="line" href="classstdex_1_1benchmark.html#a004f16b1c20325b8fbb578f250c406c4"> 132</a></span> <a class="code hl_function" href="classstdex_1_1benchmark.html#a004f16b1c20325b8fbb578f250c406c4">benchmark</a>(_In_z_ <span class="keyword">const</span> <span class="keywordtype">char</span>* task_name) :</div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> m_task_name(task_name),</div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> m_start(std::chrono::high_resolution_clock::now())</div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> {}</div>
|
|
</div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> </div>
|
|
<div class="foldopen" id="foldopen00140" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"><a class="line" href="classstdex_1_1benchmark.html#ad84dd386789e370b4a8113d7bc39f663"> 140</a></span> <a class="code hl_function" href="classstdex_1_1benchmark.html#ad84dd386789e370b4a8113d7bc39f663">~benchmark</a>()</div>
|
|
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> {</div>
|
|
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> <span class="keyword">auto</span> duration(std::chrono::high_resolution_clock::now() - m_start);</div>
|
|
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> stdex::diag::printf(<span class="stringliteral">"%s took %I64i ns\n"</span>, m_task_name, <span class="keyword">static_cast<</span>int64_t<span class="keyword">></span>(duration.count()));</div>
|
|
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> </div>
|
|
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* m_task_name;</div>
|
|
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> std::chrono::time_point<std::chrono::high_resolution_clock> m_start;</div>
|
|
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> };</div>
|
|
</div>
|
|
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span>}</div>
|
|
<div class="ttc" id="aclassstdex_1_1benchmark_html"><div class="ttname"><a href="classstdex_1_1benchmark.html">stdex::benchmark</a></div><div class="ttdoc">Measures time between initialization and going out of scope.</div><div class="ttdef"><b>Definition</b> debug.hpp:125</div></div>
|
|
<div class="ttc" id="aclassstdex_1_1benchmark_html_a004f16b1c20325b8fbb578f250c406c4"><div class="ttname"><a href="classstdex_1_1benchmark.html#a004f16b1c20325b8fbb578f250c406c4">stdex::benchmark::benchmark</a></div><div class="ttdeci">benchmark(const char *task_name)</div><div class="ttdoc">Starts the measurement.</div><div class="ttdef"><b>Definition</b> debug.hpp:132</div></div>
|
|
<div class="ttc" id="aclassstdex_1_1benchmark_html_ad84dd386789e370b4a8113d7bc39f663"><div class="ttname"><a href="classstdex_1_1benchmark.html#ad84dd386789e370b4a8113d7bc39f663">stdex::benchmark::~benchmark</a></div><div class="ttdeci">~benchmark()</div><div class="ttdoc">Stops the measurement and outputs the result to the diagnostic console.</div><div class="ttdef"><b>Definition</b> debug.hpp:140</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Thu Feb 8 2024 11:12:04 for stdex by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
|
|
</small></address>
|
|
</body>
|
|
</html>
|