Files
entt/utility_8hpp_source.html
2020-03-07 18:44:24 +01:00

152 lines
15 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.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: src/entt/core/utility.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>
<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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EnTT
&#160;<span id="projectnumber">3.3.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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&amp;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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_66e9674e8206a335795995fa32a03c91.html">entt</a></li><li class="navelem"><a class="el" href="dir_de8f4e6ba3f54a2a21309f742e93a373.html">core</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">utility.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef ENTT_CORE_UTILITY_HPP</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define ENTT_CORE_UTILITY_HPP</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &quot;../config/config.h&quot;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceentt.html">entt</a> {</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="structentt_1_1identity.html"> 13</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structentt_1_1identity.html">identity</a> {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">class</span> Type&gt;</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="structentt_1_1identity.html#a4663a97f57bf16459d1ca94b74965b5e"> 21</a></span>&#160; constexpr Type &amp;&amp; <a class="code" href="structentt_1_1identity.html#a4663a97f57bf16459d1ca94b74965b5e">operator()</a>(Type &amp;&amp;value) <span class="keyword">const</span> ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keywordflow">return</span> std::forward&lt;Type&gt;(value);</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; }</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;};</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Type, <span class="keyword">typename</span> Class&gt;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="namespaceentt.html#ae289e7f5640bb43223901039346e5ce0"> 35</a></span>&#160;constexpr <span class="keyword">auto</span> <a class="code" href="namespaceentt.html#ae289e7f5640bb43223901039346e5ce0">overload</a>(Type Class:: *member) ENTT_NOEXCEPT { <span class="keywordflow">return</span> member; }</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Func&gt;</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="namespaceentt.html#a0b5d877510362b358a9e83b0222aca55"> 45</a></span>&#160;constexpr <span class="keyword">auto</span> <a class="code" href="namespaceentt.html#ae289e7f5640bb43223901039346e5ce0">overload</a>(Func *func) ENTT_NOEXCEPT { <span class="keywordflow">return</span> func; }</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">class</span>... Func&gt;</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structentt_1_1overloaded.html"> 53</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structentt_1_1overloaded.html">overloaded</a>: Func... {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">using</span> Func::operator()...;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;};</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">class</span>... Func&gt;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<a class="code" href="namespaceentt.html#a26eb67ac302229374c5fb623d529f5eb">overloaded</a>(Func...) -&gt; <a class="code" href="structentt_1_1overloaded.html">overloaded</a>&lt;Func...&gt;;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">class</span> Func&gt;</div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="structentt_1_1y__combinator.html"> 71</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structentt_1_1y__combinator.html">y_combinator</a> {</div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="structentt_1_1y__combinator.html#a3ef9b5550c3de06bed6297ae3b79815f"> 76</a></span>&#160; <a class="code" href="structentt_1_1y__combinator.html#a3ef9b5550c3de06bed6297ae3b79815f">y_combinator</a>(Func recursive):</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; func{std::move(recursive)}</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; {}</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">class</span>... Args&gt;</div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="structentt_1_1y__combinator.html#aaf600432620d702c835ff5555f962c40"> 87</a></span>&#160; decltype(<span class="keyword">auto</span>) operator()(Args &amp;&amp;... args)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">return</span> func(*<span class="keyword">this</span>, std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; }</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">class</span>... Args&gt;</div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="structentt_1_1y__combinator.html#ab87fd1de40da60ffef1d0ed9b76280a8"> 93</a></span>&#160; decltype(<span class="keyword">auto</span>) operator()(Args &amp;&amp;... args) {</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordflow">return</span> func(*<span class="keyword">this</span>, std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; }</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; Func func;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;};</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;}</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="astructentt_1_1identity_html"><div class="ttname"><a href="structentt_1_1identity.html">entt::identity</a></div><div class="ttdoc">Identity function object (waiting for C++20).</div><div class="ttdef"><b>Definition:</b> <a href="utility_8hpp_source.html#l00013">utility.hpp:13</a></div></div>
<div class="ttc" id="astructentt_1_1identity_html_a4663a97f57bf16459d1ca94b74965b5e"><div class="ttname"><a href="structentt_1_1identity.html#a4663a97f57bf16459d1ca94b74965b5e">entt::identity::operator()</a></div><div class="ttdeci">constexpr Type &amp;&amp; operator()(Type &amp;&amp;value) const ENTT_NOEXCEPT</div><div class="ttdoc">Returns its argument unchanged.</div><div class="ttdef"><b>Definition:</b> <a href="utility_8hpp_source.html#l00021">utility.hpp:21</a></div></div>
<div class="ttc" id="anamespaceentt_html"><div class="ttname"><a href="namespaceentt.html">entt</a></div><div class="ttdoc">EnTT default namespace.</div><div class="ttdef"><b>Definition:</b> <a href="algorithm_8hpp_source.html#l00013">algorithm.hpp:13</a></div></div>
<div class="ttc" id="astructentt_1_1y__combinator_html"><div class="ttname"><a href="structentt_1_1y__combinator.html">entt::y_combinator</a></div><div class="ttdoc">Basic implementation of a y-combinator.</div><div class="ttdef"><b>Definition:</b> <a href="utility_8hpp_source.html#l00071">utility.hpp:71</a></div></div>
<div class="ttc" id="anamespaceentt_html_ae289e7f5640bb43223901039346e5ce0"><div class="ttname"><a href="namespaceentt.html#ae289e7f5640bb43223901039346e5ce0">entt::overload</a></div><div class="ttdeci">constexpr auto overload(Type Class::*member) ENTT_NOEXCEPT</div><div class="ttdoc">Constant utility to disambiguate overloaded members of a class.</div><div class="ttdef"><b>Definition:</b> <a href="utility_8hpp_source.html#l00035">utility.hpp:35</a></div></div>
<div class="ttc" id="anamespaceentt_html_a26eb67ac302229374c5fb623d529f5eb"><div class="ttname"><a href="namespaceentt.html#a26eb67ac302229374c5fb623d529f5eb">entt::overloaded</a></div><div class="ttdeci">overloaded(Func...) -&gt; overloaded&lt; Func... &gt;</div><div class="ttdoc">Deduction guide.</div></div>
<div class="ttc" id="astructentt_1_1overloaded_html"><div class="ttname"><a href="structentt_1_1overloaded.html">entt::overloaded</a></div><div class="ttdoc">Helper type for visitors.</div><div class="ttdef"><b>Definition:</b> <a href="utility_8hpp_source.html#l00053">utility.hpp:53</a></div></div>
<div class="ttc" id="astructentt_1_1y__combinator_html_a3ef9b5550c3de06bed6297ae3b79815f"><div class="ttname"><a href="structentt_1_1y__combinator.html#a3ef9b5550c3de06bed6297ae3b79815f">entt::y_combinator::y_combinator</a></div><div class="ttdeci">y_combinator(Func recursive)</div><div class="ttdoc">Constructs a y-combinator from a given function.</div><div class="ttdef"><b>Definition:</b> <a href="utility_8hpp_source.html#l00076">utility.hpp:76</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>