Files
rippled/flags_8cpp_source.html
2025-11-10 09:36:27 -08:00

161 lines
19 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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: flags.cpp 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="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">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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" 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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(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_120ed4da3e3217b1e7fc0b4f48568e79.html">test</a></li><li class="navelem"><a class="el" href="dir_ffd09a46879067226d7ad9ce2abbf5ef.html">jtx</a></li><li class="navelem"><a class="el" href="dir_b6e1af3af959840d44bdaef0b719b3f9.html">impl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">flags.cpp</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="preprocessor">#include &lt;test/jtx/flags.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;xrpl/protocol/jss.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">namespace </span>test {</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span>jtx {</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
<div class="foldopen" id="foldopen00010" data-start="{" data-end="}">
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="namespaceripple_1_1test_1_1jtx.html#a50cacef3867fc01273aa9c29231f9a7c"> 10</a></span><a class="code hl_function" href="namespaceripple_1_1test_1_1jtx.html#a50cacef3867fc01273aa9c29231f9a7c">fset</a>(<a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1Account.html">Account</a> <span class="keyword">const</span>&amp; account, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> on, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> off)</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>{</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> jv;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> jv[jss::Account] = account.human();</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> jv[jss::TransactionType] = jss::AccountSet;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keywordflow">if</span> (on != 0)</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> jv[jss::SetFlag] = on;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keywordflow">if</span> (off != 0)</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> jv[jss::ClearFlag] = off;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keywordflow">return</span> jv;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>}</div>
</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00023" data-start="{" data-end="}">
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1flags.html#a390d8429c73a27b265cfa45c4a46ec0e"> 23</a></span><a class="code hl_function" href="classripple_1_1test_1_1jtx_1_1flags.html#a390d8429c73a27b265cfa45c4a46ec0e">flags::operator()</a>(<a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1Env.html">Env</a>&amp; env)<span class="keyword"> const</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">auto</span> <span class="keyword">const</span> sle = env.<a class="code hl_function" href="classripple_1_1test_1_1jtx_1_1Env.html#af928cd176555b2cf28da85e274c571bc">le</a>(<a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1flags.html#a77797c93fb70a8a758142d7149357cfd">account_</a>);</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordflow">if</span> (!sle)</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> env.<a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1Env.html#a404fe165c9a8096d23b0ec3f2f99dada">test</a>.<a class="code hl_function" href="classbeast_1_1unit__test_1_1suite.html#af5ea30f883ad3a2a841af60a9a82c29c">fail</a>();</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (sle-&gt;isFieldPresent(sfFlags))</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> env.<a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1Env.html#a404fe165c9a8096d23b0ec3f2f99dada">test</a>.<a class="code hl_function" href="classbeast_1_1unit__test_1_1suite.html#ac6fc161c3c00cfbbc9590afe9e4559aa">expect</a>((sle-&gt;getFieldU32(sfFlags) &amp; <a class="code hl_variable" href="classripple_1_1detail_1_1flags__helper.html#a7fd1547afccb6bcbe5157ac3845daa62">mask_</a>) == <a class="code hl_variable" href="classripple_1_1detail_1_1flags__helper.html#a7fd1547afccb6bcbe5157ac3845daa62">mask_</a>);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> env.<a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1Env.html#a404fe165c9a8096d23b0ec3f2f99dada">test</a>.<a class="code hl_function" href="classbeast_1_1unit__test_1_1suite.html#ac6fc161c3c00cfbbc9590afe9e4559aa">expect</a>(<a class="code hl_variable" href="classripple_1_1detail_1_1flags__helper.html#a7fd1547afccb6bcbe5157ac3845daa62">mask_</a> == 0);</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span>}</div>
</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="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00035" data-start="{" data-end="}">
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1nflags.html#ae6f4af0f7acd5cb26bd7fd57d6bd233d"> 35</a></span><a class="code hl_function" href="classripple_1_1test_1_1jtx_1_1nflags.html#ae6f4af0f7acd5cb26bd7fd57d6bd233d">nflags::operator()</a>(<a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1Env.html">Env</a>&amp; env)<span class="keyword"> const</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">auto</span> <span class="keyword">const</span> sle = env.<a class="code hl_function" href="classripple_1_1test_1_1jtx_1_1Env.html#af928cd176555b2cf28da85e274c571bc">le</a>(<a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1nflags.html#a33ca5fe77c838d0fc17a4bcefbe7783d">account_</a>);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordflow">if</span> (!sle)</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> env.<a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1Env.html#a404fe165c9a8096d23b0ec3f2f99dada">test</a>.<a class="code hl_function" href="classbeast_1_1unit__test_1_1suite.html#af5ea30f883ad3a2a841af60a9a82c29c">fail</a>();</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (sle-&gt;isFieldPresent(sfFlags))</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> env.<a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1Env.html#a404fe165c9a8096d23b0ec3f2f99dada">test</a>.<a class="code hl_function" href="classbeast_1_1unit__test_1_1suite.html#ac6fc161c3c00cfbbc9590afe9e4559aa">expect</a>((sle-&gt;getFieldU32(sfFlags) &amp; <a class="code hl_variable" href="classripple_1_1detail_1_1flags__helper.html#a7fd1547afccb6bcbe5157ac3845daa62">mask_</a>) == 0);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> env.<a class="code hl_variable" href="classripple_1_1test_1_1jtx_1_1Env.html#a404fe165c9a8096d23b0ec3f2f99dada">test</a>.<a class="code hl_function" href="classbeast_1_1unit__test_1_1suite.html#a5c723fb774d3c25ba877c5b9ce681d6f">pass</a>();</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>}</div>
</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>} <span class="comment">// namespace jtx</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>} <span class="comment">// namespace test</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span>} <span class="comment">// namespace ripple</span></div>
<div class="ttc" id="aclassJson_1_1Value_html"><div class="ttname"><a href="classJson_1_1Value.html">Json::Value</a></div><div class="ttdoc">Represents a JSON value.</div><div class="ttdef"><b>Definition</b> <a href="json__value_8h_source.html#l00130">json_value.h:131</a></div></div>
<div class="ttc" id="aclassbeast_1_1unit__test_1_1suite_html_a5c723fb774d3c25ba877c5b9ce681d6f"><div class="ttname"><a href="classbeast_1_1unit__test_1_1suite.html#a5c723fb774d3c25ba877c5b9ce681d6f">beast::unit_test::suite::pass</a></div><div class="ttdeci">void pass()</div><div class="ttdoc">Record a successful test condition.</div><div class="ttdef"><b>Definition</b> <a href="suite_8h_source.html#l00508">suite.h:508</a></div></div>
<div class="ttc" id="aclassbeast_1_1unit__test_1_1suite_html_ac6fc161c3c00cfbbc9590afe9e4559aa"><div class="ttname"><a href="classbeast_1_1unit__test_1_1suite.html#ac6fc161c3c00cfbbc9590afe9e4559aa">beast::unit_test::suite::expect</a></div><div class="ttdeci">bool expect(Condition const &amp;shouldBeTrue)</div><div class="ttdoc">Evaluate a test condition.</div><div class="ttdef"><b>Definition</b> <a href="suite_8h_source.html#l00226">suite.h:226</a></div></div>
<div class="ttc" id="aclassbeast_1_1unit__test_1_1suite_html_af5ea30f883ad3a2a841af60a9a82c29c"><div class="ttname"><a href="classbeast_1_1unit__test_1_1suite.html#af5ea30f883ad3a2a841af60a9a82c29c">beast::unit_test::suite::fail</a></div><div class="ttdeci">void fail(String const &amp;reason, char const *file, int line)</div><div class="ttdoc">Record a failure.</div><div class="ttdef"><b>Definition</b> <a href="suite_8h_source.html#l00530">suite.h:530</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1flags__helper_html_a7fd1547afccb6bcbe5157ac3845daa62"><div class="ttname"><a href="classripple_1_1detail_1_1flags__helper.html#a7fd1547afccb6bcbe5157ac3845daa62">ripple::detail::flags_helper::mask_</a></div><div class="ttdeci">std::uint32_t mask_</div><div class="ttdef"><b>Definition</b> <a href="flags_8h_source.html#l00016">flags.h:16</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1Account_html"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1Account.html">ripple::test::jtx::Account</a></div><div class="ttdoc">Immutable cryptographic account descriptor.</div><div class="ttdef"><b>Definition</b> <a href="Account_8h_source.html#l00019">Account.h:20</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1Env_html"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1Env.html">ripple::test::jtx::Env</a></div><div class="ttdoc">A transaction testing environment.</div><div class="ttdef"><b>Definition</b> <a href="Env_8h_source.html#l00101">Env.h:102</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1Env_html_a404fe165c9a8096d23b0ec3f2f99dada"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1Env.html#a404fe165c9a8096d23b0ec3f2f99dada">ripple::test::jtx::Env::test</a></div><div class="ttdeci">beast::unit_test::suite &amp; test</div><div class="ttdef"><b>Definition</b> <a href="Env_8h_source.html#l00104">Env.h:104</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1Env_html_af928cd176555b2cf28da85e274c571bc"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1Env.html#af928cd176555b2cf28da85e274c571bc">ripple::test::jtx::Env::le</a></div><div class="ttdeci">std::shared_ptr&lt; SLE const &gt; le(Account const &amp;account) const</div><div class="ttdoc">Return an account root.</div><div class="ttdef"><b>Definition</b> <a href="Env_8cpp_source.html#l00259">Env.cpp:259</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1flags_html_a390d8429c73a27b265cfa45c4a46ec0e"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1flags.html#a390d8429c73a27b265cfa45c4a46ec0e">ripple::test::jtx::flags::operator()</a></div><div class="ttdeci">void operator()(Env &amp;env) const</div><div class="ttdef"><b>Definition</b> <a href="flags_8cpp_source.html#l00023">flags.cpp:23</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1flags_html_a77797c93fb70a8a758142d7149357cfd"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1flags.html#a77797c93fb70a8a758142d7149357cfd">ripple::test::jtx::flags::account_</a></div><div class="ttdeci">Account account_</div><div class="ttdef"><b>Definition</b> <a href="flags_8h_source.html#l00111">flags.h:111</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1nflags_html_a33ca5fe77c838d0fc17a4bcefbe7783d"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1nflags.html#a33ca5fe77c838d0fc17a4bcefbe7783d">ripple::test::jtx::nflags::account_</a></div><div class="ttdeci">Account account_</div><div class="ttdef"><b>Definition</b> <a href="flags_8h_source.html#l00128">flags.h:128</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1nflags_html_ae6f4af0f7acd5cb26bd7fd57d6bd233d"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1nflags.html#ae6f4af0f7acd5cb26bd7fd57d6bd233d">ripple::test::jtx::nflags::operator()</a></div><div class="ttdeci">void operator()(Env &amp;env) const</div><div class="ttdef"><b>Definition</b> <a href="flags_8cpp_source.html#l00035">flags.cpp:35</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div></div>
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_html_a50cacef3867fc01273aa9c29231f9a7c"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx.html#a50cacef3867fc01273aa9c29231f9a7c">ripple::test::jtx::fset</a></div><div class="ttdeci">Json::Value fset(Account const &amp;account, std::uint32_t on, std::uint32_t off=0)</div><div class="ttdoc">Add and/or remove flag.</div><div class="ttdef"><b>Definition</b> <a href="flags_8cpp_source.html#l00010">flags.cpp:10</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>