159 lines
14 KiB
HTML
159 lines
14 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">
|
|
<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>sapphirec: src/utils.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="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only.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="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">sapphirec
|
|
</div>
|
|
<div id="projectbrief">The Sapphire documentation</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('utils_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">utils.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="utils_8h.html">Go to the documentation of this file.</a><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"> * @file utils.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Miscellaneous utilities to use in the compiler, such as string manipulation/conversion</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * functions, and benchmarking utilities.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "<a class="code" href="_format_string_8hpp.html">FormatString/FormatString.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="sapphirepch_8h.html">sapphirepch.h</a>"</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <chrono></span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Replaces all ocurrences of a substring with another one in a string.</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * @param[in] str The input string.</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * @param[in] from The substring to remove.</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * @param[in] to The substring to add.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * @param[out] replaced Whether anything was replaced.</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keywordtype">bool</span> <a class="code" href="utils_8h.html#a0159b96c217d65d379016f6aa2c4dd57">replace</a>(std::string& str, <span class="keyword">const</span> std::string& from, <span class="keyword">const</span> std::string& to);</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="comment">/* Easy way of converting an int to a string without writing 5 lines of code every time you want to do it. */</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> std::string <a class="code" href="utils_8h.html#a661f7549af1d9a364fde170b2c7ae0c3">to_string</a>(<span class="keyword">const</span> <span class="keywordtype">int</span>& value);</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/* Easy way of converting a float to a string without writing 5 lines of code every time you want to do it. */</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> std::string <a class="code" href="utils_8h.html#a661f7549af1d9a364fde170b2c7ae0c3">to_string</a>(<span class="keyword">const</span> <span class="keywordtype">float</span>& value);</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/* Benchmarking utilities. */</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="class____benchmark__impl.html"> 29</a></span> <span class="keyword">class </span><a class="code" href="class____benchmark__impl.html">__benchmark_impl</a></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="class____benchmark__impl.html#a2efd5ebe7e24a9a6ead5b205d0fe05f8">__benchmark_impl</a>(std::string_view __function_name);</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="class____benchmark__impl.html#aa91ff70297183c7c20c198096a671f73">~__benchmark_impl</a>();</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class____benchmark__impl.html#abef5e19af3518d080c6988fc7558870d">enable</a>();</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class____benchmark__impl.html#a5ddf5a17aee0bc1bab08229e574dad76">disable</a>();</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class____benchmark__impl.html#a6f260fa4d0f93d4a14d6b2a56d91773a">init</a>();</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  std::chrono::time_point<std::chrono::high_resolution_clock> m_StartTimePoint;</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  std::string_view m_FunctionName;</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> m_BenchmarkingEnabled;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">bool</span> m_InternalBenchmarkingEnabled;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> };</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="_arguments_8cpp.html#ab219e0457ba1898f28a0a8ca1c22bb33"> 47</a></span> <span class="preprocessor">#define benchmark(message) __benchmark_impl __benchmark_impl_timer(message)</span></div>
|
|
<div class="ttc" id="a_format_string_8hpp_html"><div class="ttname"><a href="_format_string_8hpp.html">FormatString.hpp</a></div></div>
|
|
<div class="ttc" id="aclass____benchmark__impl_html"><div class="ttname"><a href="class____benchmark__impl.html">__benchmark_impl</a></div><div class="ttdef"><b>Definition:</b> utils.h:30</div></div>
|
|
<div class="ttc" id="aclass____benchmark__impl_html_a2efd5ebe7e24a9a6ead5b205d0fe05f8"><div class="ttname"><a href="class____benchmark__impl.html#a2efd5ebe7e24a9a6ead5b205d0fe05f8">__benchmark_impl::__benchmark_impl</a></div><div class="ttdeci">__benchmark_impl(std::string_view __function_name)</div><div class="ttdef"><b>Definition:</b> utils.cpp:26</div></div>
|
|
<div class="ttc" id="aclass____benchmark__impl_html_a5ddf5a17aee0bc1bab08229e574dad76"><div class="ttname"><a href="class____benchmark__impl.html#a5ddf5a17aee0bc1bab08229e574dad76">__benchmark_impl::disable</a></div><div class="ttdeci">static void disable()</div><div class="ttdef"><b>Definition:</b> utils.cpp:52</div></div>
|
|
<div class="ttc" id="aclass____benchmark__impl_html_a6f260fa4d0f93d4a14d6b2a56d91773a"><div class="ttname"><a href="class____benchmark__impl.html#a6f260fa4d0f93d4a14d6b2a56d91773a">__benchmark_impl::init</a></div><div class="ttdeci">static void init()</div><div class="ttdef"><b>Definition:</b> utils.cpp:47</div></div>
|
|
<div class="ttc" id="aclass____benchmark__impl_html_aa91ff70297183c7c20c198096a671f73"><div class="ttname"><a href="class____benchmark__impl.html#aa91ff70297183c7c20c198096a671f73">__benchmark_impl::~__benchmark_impl</a></div><div class="ttdeci">~__benchmark_impl()</div><div class="ttdef"><b>Definition:</b> utils.cpp:33</div></div>
|
|
<div class="ttc" id="aclass____benchmark__impl_html_abef5e19af3518d080c6988fc7558870d"><div class="ttname"><a href="class____benchmark__impl.html#abef5e19af3518d080c6988fc7558870d">__benchmark_impl::enable</a></div><div class="ttdeci">static void enable()</div><div class="ttdef"><b>Definition:</b> utils.cpp:57</div></div>
|
|
<div class="ttc" id="asapphirepch_8h_html"><div class="ttname"><a href="sapphirepch_8h.html">sapphirepch.h</a></div></div>
|
|
<div class="ttc" id="autils_8h_html_a0159b96c217d65d379016f6aa2c4dd57"><div class="ttname"><a href="utils_8h.html#a0159b96c217d65d379016f6aa2c4dd57">replace</a></div><div class="ttdeci">bool replace(std::string &str, const std::string &from, const std::string &to)</div><div class="ttdef"><b>Definition:</b> utils.cpp:4</div></div>
|
|
<div class="ttc" id="autils_8h_html_a661f7549af1d9a364fde170b2c7ae0c3"><div class="ttname"><a href="utils_8h.html#a661f7549af1d9a364fde170b2c7ae0c3">to_string</a></div><div class="ttdeci">std::string to_string(const int &value)</div><div class="ttdef"><b>Definition:</b> utils.cpp:12</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="utils_8h.html">utils.h</a></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>
|