Files
M5Utility/string_8hpp_source.html

169 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" 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.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>M5Utility: src/m5_utility/string.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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.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">M5Utility<span id="projectnumber">&#160;0.0.12 git rev:13bfbd6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('string_8hpp_source.html',''); initResizable(true); });
/* @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">
<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 class="header">
<div class="headertitle"><div class="title">string.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="string_8hpp.html">Go to the documentation of this file.</a><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-FileCopyrightText: 2024 M5Stack Technology CO LTD</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * SPDX-License-Identifier: MIT</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> */</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#ifndef M5_UTILITY_STRING_HPP</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#define M5_UTILITY_STRING_HPP</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &lt;cstdint&gt;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacem5.html">m5</a> {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceutility.html">utility</a> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>std::string <a class="code hl_function" href="string_8cpp.html#a03bf2d05084e4b976b506790101c35fa">formatString</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* fmt, ...);</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>std::string&amp; <a class="code hl_function" href="string_8cpp.html#ab3c8cd8feeaa81314afa25e976bef9e2">trimRight</a>(std::string&amp; s);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span>std::string&amp; <a class="code hl_function" href="string_8cpp.html#ace0c56ab88b9c6cb62d4f643a734b713">trimLeft</a>(std::string&amp; s);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>std::string&amp; <a class="code hl_function" href="string_8cpp.html#a8a66786875d5eb891e00a11c550261c8">trim</a>(std::string&amp; s);</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="keyword">template</span> &lt;<span class="keywordtype">bool</span> Case = true&gt;</div>
<div class="foldopen" id="foldopen00040" data-start="{" data-end="}">
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="string_8hpp.html#a1c125564d7e0042fe6ee8914306bd53d"> 40</a></span><span class="keyword">constexpr</span> <span class="keywordtype">char</span> <a class="code hl_function" href="string_8hpp.html#a1c125564d7e0042fe6ee8914306bd53d">uintToHexChar</a>(<span class="keyword">const</span> uint8_t v)</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>{</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">return</span> (v &amp; 0x0F) &lt; 10 ? <span class="charliteral">&#39;0&#39;</span> + (v &amp; 0x0F) : (Case ? <span class="charliteral">&#39;A&#39;</span> : <span class="charliteral">&#39;a&#39;</span>) + ((v &amp; 0x0F) - 10);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>}</div>
</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, <span class="keywordtype">bool</span> Case = true&gt;</div>
<div class="foldopen" id="foldopen00050" data-start="{" data-end="}">
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="string_8hpp.html#aa3d3d6ec09396e3dc6eabf9fc5e86d24"> 50</a></span>std::string <a class="code hl_function" href="string_8hpp.html#aa3d3d6ec09396e3dc6eabf9fc5e86d24">unsignedToHexString</a>(<span class="keyword">const</span> T&amp; v)</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>{</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">static_assert</span>(std::is_integral&lt;T&gt;::value &amp;&amp; std::is_unsigned&lt;T&gt;::value, <span class="stringliteral">&quot;T must be unsigned integer&quot;</span>);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> std::string s;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = <span class="keyword">sizeof</span>(T); i &gt; 0; --i) {</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> uint8_t u8 = (v &gt;&gt; ((i - 1) * 8)) &amp; 0xFF;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> s += uintToHexChar&lt;Case&gt;((u8 &gt;&gt; 4) &amp; 0x0F);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> s += uintToHexChar&lt;Case&gt;(u8 &amp; 0x0F);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> }</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordflow">return</span> s;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>}</div>
</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span>} <span class="comment">// namespace utility</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>} <span class="comment">// namespace m5</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="anamespacem5_html"><div class="ttname"><a href="namespacem5.html">m5</a></div><div class="ttdoc">Top level namespace of M5.</div><div class="ttdef"><b>Definition</b> base64.cpp:39</div></div>
<div class="ttc" id="anamespaceutility_html"><div class="ttname"><a href="namespaceutility.html">utility</a></div><div class="ttdoc">For utilities.</div></div>
<div class="ttc" id="astring_8cpp_html_a03bf2d05084e4b976b506790101c35fa"><div class="ttname"><a href="string_8cpp.html#a03bf2d05084e4b976b506790101c35fa">m5::utility::formatString</a></div><div class="ttdeci">std::string formatString(const char *fmt,...)</div><div class="ttdoc">Create a string in a format similar to printf.</div><div class="ttdef"><b>Definition</b> string.cpp:17</div></div>
<div class="ttc" id="astring_8cpp_html_a8a66786875d5eb891e00a11c550261c8"><div class="ttname"><a href="string_8cpp.html#a8a66786875d5eb891e00a11c550261c8">m5::utility::trim</a></div><div class="ttdeci">std::string &amp; trim(std::string &amp;s)</div><div class="ttdoc">Trim both ends.</div><div class="ttdef"><b>Definition</b> string.cpp:46</div></div>
<div class="ttc" id="astring_8cpp_html_ab3c8cd8feeaa81314afa25e976bef9e2"><div class="ttname"><a href="string_8cpp.html#ab3c8cd8feeaa81314afa25e976bef9e2">m5::utility::trimRight</a></div><div class="ttdeci">std::string &amp; trimRight(std::string &amp;s)</div><div class="ttdoc">Trim right.</div><div class="ttdef"><b>Definition</b> string.cpp:31</div></div>
<div class="ttc" id="astring_8cpp_html_ace0c56ab88b9c6cb62d4f643a734b713"><div class="ttname"><a href="string_8cpp.html#ace0c56ab88b9c6cb62d4f643a734b713">m5::utility::trimLeft</a></div><div class="ttdeci">std::string &amp; trimLeft(std::string &amp;s)</div><div class="ttdoc">Trim left.</div><div class="ttdef"><b>Definition</b> string.cpp:39</div></div>
<div class="ttc" id="astring_8hpp_html_a1c125564d7e0042fe6ee8914306bd53d"><div class="ttname"><a href="string_8hpp.html#a1c125564d7e0042fe6ee8914306bd53d">m5::utility::uintToHexChar</a></div><div class="ttdeci">constexpr char uintToHexChar(const uint8_t v)</div><div class="ttdoc">Convert from 0~15 to hexadecimal character.</div><div class="ttdef"><b>Definition</b> string.hpp:40</div></div>
<div class="ttc" id="astring_8hpp_html_aa3d3d6ec09396e3dc6eabf9fc5e86d24"><div class="ttname"><a href="string_8hpp.html#aa3d3d6ec09396e3dc6eabf9fc5e86d24">m5::utility::unsignedToHexString</a></div><div class="ttdeci">std::string unsignedToHexString(const T &amp;v)</div><div class="ttdoc">Convert any one unsigned integer to a hexadecimal string.</div><div class="ttdef"><b>Definition</b> string.hpp:50</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_c43ce1a5a207b5021ecda6c5900e5b5f.html">m5_utility</a></li><li class="navelem"><a class="el" href="string_8hpp.html">string.hpp</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.11.0 </li>
</ul>
</div>
</body>
</html>