Files
entt/delegate_8hpp_source.html
2017-12-14 23:18:50 +01:00

88 lines
18 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>entt: src/entt/signal/delegate.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">2.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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_a53318306f6ac0f7fe657839abd543ab.html">signal</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">delegate.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_SIGNAL_DELEGATE_HPP</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define ENTT_SIGNAL_DELEGATE_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;</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;<span class="keyword">namespace </span><a class="code" href="namespaceentt.html">entt</a> {</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span>&gt;</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate.html"> 18</a></span>&#160;<span class="keyword">class </span><a class="code" href="classentt_1_1Delegate.html">Delegate</a>;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</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> Ret, <span class="keyword">typename</span>... Args&gt;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html"> 35</a></span>&#160;<span class="keyword">class </span><a class="code" href="classentt_1_1Delegate.html">Delegate</a>&lt;Ret(Args...)&gt; final {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">using</span> proto_type = Ret(*)(<span class="keywordtype">void</span> *, Args...);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">using</span> stub_type = std::pair&lt;void *, proto_type&gt;;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">static</span> Ret fallback(<span class="keywordtype">void</span> *, Args...) noexcept { <span class="keywordflow">return</span> {}; }</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">template</span>&lt;Ret(*Function)(Args...)&gt;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">static</span> Ret proto(<span class="keywordtype">void</span> *, Args... args) {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span> (Function)(args...);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; }</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Class, Ret(Class::*Member)(Args...)&gt;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">static</span> Ret proto(<span class="keywordtype">void</span> *instance, Args... args) {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">return</span> (static_cast&lt;Class *&gt;(instance)-&gt;*Member)(args...);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a8b504177dc08056d91ac4a6a79dd962b"> 53</a></span>&#160; <a class="code" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a8b504177dc08056d91ac4a6a79dd962b">Delegate</a>() noexcept</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; : stub{std::make_pair(<span class="keyword">nullptr</span>, &amp;fallback)}</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="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">template</span>&lt;Ret(*Function)(Args...)&gt;</div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a6c5cf47394e3f12aeae6e3aaf628e111"> 62</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a6c5cf47394e3f12aeae6e3aaf628e111">connect</a>() noexcept {</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; stub = std::make_pair(<span class="keyword">nullptr</span>, &amp;proto&lt;Function&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="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Class, Ret(Class::*Member)(Args...)&gt;</div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#af3e93f1fa84aed2c9c12ee057c284e38"> 78</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#af3e93f1fa84aed2c9c12ee057c284e38">connect</a>(Class *instance) noexcept {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; stub = std::make_pair(instance, &amp;proto&lt;Class, Member&gt;);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; }</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#ac78d4694fd87d0ea899fb2fdead21af7"> 87</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#ac78d4694fd87d0ea899fb2fdead21af7">reset</a>() noexcept {</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; stub = std::make_pair(<span class="keyword">nullptr</span>, &amp;fallback);</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="l00096"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#afd708468edef730ab00d8c1ebfb2913a"> 96</a></span>&#160; Ret <a class="code" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#afd708468edef730ab00d8c1ebfb2913a">operator()</a>(Args... args) {</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordflow">return</span> stub.second(stub.first, args...);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; }</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#aa152d818f1df16bcd61ee16f2e4d3c2a"> 108</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#aa152d818f1df16bcd61ee16f2e4d3c2a">operator==</a>(<span class="keyword">const</span> <a class="code" href="classentt_1_1Delegate.html">Delegate</a>&lt;Ret(Args...)&gt; &amp;other) <span class="keyword">const</span> noexcept {</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordflow">return</span> stub.first == other.stub.first &amp;&amp; stub.second == other.stub.second;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; }</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; stub_type stub;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;};</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Ret, <span class="keyword">typename</span>... Args&gt;</div><div class="line"><a name="l00129"></a><span class="lineno"><a class="line" href="namespaceentt.html#a64f7dae72cdd5f224fa9bad1c4628bf7"> 129</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="namespaceentt.html#a18e1a7cdfcb0c0ba075e0beeda95285f">operator!=</a>(<span class="keyword">const</span> <a class="code" href="classentt_1_1Delegate.html">Delegate</a>&lt;Ret(Args...)&gt; &amp;lhs, <span class="keyword">const</span> <a class="code" href="classentt_1_1Delegate.html">Delegate</a>&lt;Ret(Args...)&gt; &amp;rhs) noexcept {</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keywordflow">return</span> !(lhs == rhs);</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;}</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;}</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="preprocessor">#endif // ENTT_SIGNAL_DELEGATE_HPP</span></div><div class="ttc" id="namespaceentt_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="family_8hpp_source.html#l00009">family.hpp:9</a></div></div>
<div class="ttc" id="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4_html_a8b504177dc08056d91ac4a6a79dd962b"><div class="ttname"><a href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a8b504177dc08056d91ac4a6a79dd962b">entt::Delegate&lt; Ret(Args...)&gt;::Delegate</a></div><div class="ttdeci">Delegate() noexcept</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> <a href="delegate_8hpp_source.html#l00053">delegate.hpp:53</a></div></div>
<div class="ttc" id="classentt_1_1Delegate_html"><div class="ttname"><a href="classentt_1_1Delegate.html">entt::Delegate</a></div><div class="ttdoc">Basic delegate implementation. </div><div class="ttdef"><b>Definition:</b> <a href="delegate_8hpp_source.html#l00018">delegate.hpp:18</a></div></div>
<div class="ttc" id="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4_html_aa152d818f1df16bcd61ee16f2e4d3c2a"><div class="ttname"><a href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#aa152d818f1df16bcd61ee16f2e4d3c2a">entt::Delegate&lt; Ret(Args...)&gt;::operator==</a></div><div class="ttdeci">bool operator==(const Delegate&lt; Ret(Args...)&gt; &amp;other) const noexcept</div><div class="ttdoc">Checks if the contents of the two delegates are different. </div><div class="ttdef"><b>Definition:</b> <a href="delegate_8hpp_source.html#l00108">delegate.hpp:108</a></div></div>
<div class="ttc" id="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4_html_af3e93f1fa84aed2c9c12ee057c284e38"><div class="ttname"><a href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#af3e93f1fa84aed2c9c12ee057c284e38">entt::Delegate&lt; Ret(Args...)&gt;::connect</a></div><div class="ttdeci">void connect(Class *instance) noexcept</div><div class="ttdoc">Connects a member function for a given instance to a delegate. </div><div class="ttdef"><b>Definition:</b> <a href="delegate_8hpp_source.html#l00078">delegate.hpp:78</a></div></div>
<div class="ttc" id="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4_html_a6c5cf47394e3f12aeae6e3aaf628e111"><div class="ttname"><a href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a6c5cf47394e3f12aeae6e3aaf628e111">entt::Delegate&lt; Ret(Args...)&gt;::connect</a></div><div class="ttdeci">void connect() noexcept</div><div class="ttdoc">Binds a free function to a delegate. </div><div class="ttdef"><b>Definition:</b> <a href="delegate_8hpp_source.html#l00062">delegate.hpp:62</a></div></div>
<div class="ttc" id="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4_html_afd708468edef730ab00d8c1ebfb2913a"><div class="ttname"><a href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#afd708468edef730ab00d8c1ebfb2913a">entt::Delegate&lt; Ret(Args...)&gt;::operator()</a></div><div class="ttdeci">Ret operator()(Args... args)</div><div class="ttdoc">Triggers a delegate. </div><div class="ttdef"><b>Definition:</b> <a href="delegate_8hpp_source.html#l00096">delegate.hpp:96</a></div></div>
<div class="ttc" id="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4_html_ac78d4694fd87d0ea899fb2fdead21af7"><div class="ttname"><a href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#ac78d4694fd87d0ea899fb2fdead21af7">entt::Delegate&lt; Ret(Args...)&gt;::reset</a></div><div class="ttdeci">void reset() noexcept</div><div class="ttdoc">Resets a delegate. </div><div class="ttdef"><b>Definition:</b> <a href="delegate_8hpp_source.html#l00087">delegate.hpp:87</a></div></div>
<div class="ttc" id="namespaceentt_html_a18e1a7cdfcb0c0ba075e0beeda95285f"><div class="ttname"><a href="namespaceentt.html#a18e1a7cdfcb0c0ba075e0beeda95285f">entt::operator!=</a></div><div class="ttdeci">constexpr bool operator!=(const HashedString &amp;lhs, const HashedString &amp;rhs) noexcept</div><div class="ttdoc">Compares two hashed strings. </div><div class="ttdef"><b>Definition:</b> <a href="hashed__string_8hpp_source.html#l00101">hashed_string.hpp:101</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- 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.13
</small></address>
</body>
</html>