89 lines
19 KiB
HTML
89 lines
19 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
|
|
 <span id="projectnumber">2.6.1</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> <span class="preprocessor">#ifndef ENTT_SIGNAL_DELEGATE_HPP</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define ENTT_SIGNAL_DELEGATE_HPP</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "../config/config.h"</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">template</span><<span class="keyword">typename</span>></div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate.html"> 19</a></span> <span class="keyword">class </span><a class="code" href="classentt_1_1Delegate.html">Delegate</a>;</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> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">template</span><<span class="keyword">typename</span> Ret, <span class="keyword">typename</span>... Args></div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html"> 36</a></span> <span class="keyword">class </span><a class="code" href="classentt_1_1Delegate.html">Delegate</a><Ret(Args...)> final {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">using</span> proto_fn_type = Ret(<span class="keywordtype">void</span> *, Args...);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">using</span> stub_type = std::pair<void *, proto_fn_type *>;</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">template</span><Ret(*Function)(Args...)></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">static</span> Ret proto(<span class="keywordtype">void</span> *, Args... args) {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">return</span> (Function)(args...);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  }</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Class, Ret(Class:: *Member)(Args...)></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">static</span> Ret proto(<span class="keywordtype">void</span> *instance, Args... args) {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">return</span> (static_cast<Class *>(instance)->*Member)(args...);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  }</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a57a011f4b42c3358ee5219f63997e00b"> 52</a></span>  <a class="code" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a57a011f4b42c3358ee5219f63997e00b">Delegate</a>() ENTT_NOEXCEPT</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  : stub{}</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  {}</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#ab776848ee5ece9b92740d8a2ad0b84a8"> 60</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#ab776848ee5ece9b92740d8a2ad0b84a8">empty</a>() const ENTT_NOEXCEPT {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// no need to test also stub.first</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">return</span> !stub.second;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">template</span><Ret(*Function)(Args...)></div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a51d3c462c56349e09a1c7fe0d58859b7"> 70</a></span>  <span class="keywordtype">void</span> <a class="code" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a51d3c462c56349e09a1c7fe0d58859b7">connect</a>() ENTT_NOEXCEPT {</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  stub = std::make_pair(<span class="keyword">nullptr</span>, &proto<Function>);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Class, Ret(Class:: *Member)(Args...)></div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a453219af4b49ccaf258e564006ed1f07"> 86</a></span>  <span class="keywordtype">void</span> <a class="code" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a453219af4b49ccaf258e564006ed1f07">connect</a>(Class *instance) ENTT_NOEXCEPT {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  stub = std::make_pair(instance, &proto<Class, Member>);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  }</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a77c5b9a98a0636391955de940dad0b4f"> 95</a></span>  <span class="keywordtype">void</span> <a class="code" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a77c5b9a98a0636391955de940dad0b4f">reset</a>() ENTT_NOEXCEPT {</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  stub.second = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  }</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a3259f295bc4ea1da8307d1be65c83d6a"> 104</a></span>  Ret <a class="code" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a3259f295bc4ea1da8307d1be65c83d6a">operator()</a>(Args... args)<span class="keyword"> const </span>{</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">return</span> stub.second(stub.first, args...);</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a7fd87003864d2a56baa7d2c8a9317509"> 116</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a7fd87003864d2a56baa7d2c8a9317509">operator==</a>(<span class="keyword">const</span> <a class="code" href="classentt_1_1Delegate.html">Delegate</a><Ret(Args...)> &other) <span class="keyword">const</span> ENTT_NOEXCEPT {</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">return</span> stub.first == other.stub.first && stub.second == other.stub.second;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  stub_type stub;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> };</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="keyword">template</span><<span class="keyword">typename</span> Ret, <span class="keyword">typename</span>... Args></div><div class="line"><a name="l00137"></a><span class="lineno"><a class="line" href="namespaceentt.html#aef8743ab32f59bd2905b9fa2938318b6"> 137</a></span> <span class="keywordtype">bool</span> <a class="code" href="namespaceentt.html#a8a638f5585d404bbdcfd8efdfeb39203">operator!=</a>(<span class="keyword">const</span> <a class="code" href="classentt_1_1Delegate.html">Delegate</a><Ret(Args...)> &lhs, <span class="keyword">const</span> <a class="code" href="classentt_1_1Delegate.html">Delegate</a><Ret(Args...)> &rhs) ENTT_NOEXCEPT {</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordflow">return</span> !(lhs == rhs);</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> }</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> }</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="preprocessor">#endif // ENTT_SIGNAL_DELEGATE_HPP</span></div><div class="ttc" id="namespaceentt_html_a8a638f5585d404bbdcfd8efdfeb39203"><div class="ttname"><a href="namespaceentt.html#a8a638f5585d404bbdcfd8efdfeb39203">entt::operator!=</a></div><div class="ttdeci">constexpr bool operator!=(const HashedString &lhs, const HashedString &rhs) ENTT_NOEXCEPT</div><div class="ttdoc">Compares two hashed strings. </div><div class="ttdef"><b>Definition:</b> <a href="hashed__string_8hpp_source.html#l00103">hashed_string.hpp:103</a></div></div>
|
|
<div class="ttc" id="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4_html_a51d3c462c56349e09a1c7fe0d58859b7"><div class="ttname"><a href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a51d3c462c56349e09a1c7fe0d58859b7">entt::Delegate< Ret(Args...)>::connect</a></div><div class="ttdeci">void connect() ENTT_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#l00070">delegate.hpp:70</a></div></div>
|
|
<div class="ttc" id="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4_html_a3259f295bc4ea1da8307d1be65c83d6a"><div class="ttname"><a href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a3259f295bc4ea1da8307d1be65c83d6a">entt::Delegate< Ret(Args...)>::operator()</a></div><div class="ttdeci">Ret operator()(Args... args) const</div><div class="ttdoc">Triggers a delegate. </div><div class="ttdef"><b>Definition:</b> <a href="delegate_8hpp_source.html#l00104">delegate.hpp:104</a></div></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="algorithm_8hpp_source.html#l00010">algorithm.hpp:10</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#l00019">delegate.hpp:19</a></div></div>
|
|
<div class="ttc" id="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4_html_a57a011f4b42c3358ee5219f63997e00b"><div class="ttname"><a href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a57a011f4b42c3358ee5219f63997e00b">entt::Delegate< Ret(Args...)>::Delegate</a></div><div class="ttdeci">Delegate() ENTT_NOEXCEPT</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> <a href="delegate_8hpp_source.html#l00052">delegate.hpp:52</a></div></div>
|
|
<div class="ttc" id="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4_html_a7fd87003864d2a56baa7d2c8a9317509"><div class="ttname"><a href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a7fd87003864d2a56baa7d2c8a9317509">entt::Delegate< Ret(Args...)>::operator==</a></div><div class="ttdeci">bool operator==(const Delegate< Ret(Args...)> &other) const ENTT_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#l00116">delegate.hpp:116</a></div></div>
|
|
<div class="ttc" id="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4_html_ab776848ee5ece9b92740d8a2ad0b84a8"><div class="ttname"><a href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#ab776848ee5ece9b92740d8a2ad0b84a8">entt::Delegate< Ret(Args...)>::empty</a></div><div class="ttdeci">bool empty() const ENTT_NOEXCEPT</div><div class="ttdoc">Checks whether a delegate actually stores a listener. </div><div class="ttdef"><b>Definition:</b> <a href="delegate_8hpp_source.html#l00060">delegate.hpp:60</a></div></div>
|
|
<div class="ttc" id="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4_html_a77c5b9a98a0636391955de940dad0b4f"><div class="ttname"><a href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a77c5b9a98a0636391955de940dad0b4f">entt::Delegate< Ret(Args...)>::reset</a></div><div class="ttdeci">void reset() ENTT_NOEXCEPT</div><div class="ttdoc">Resets a delegate. </div><div class="ttdef"><b>Definition:</b> <a href="delegate_8hpp_source.html#l00095">delegate.hpp:95</a></div></div>
|
|
<div class="ttc" id="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4_html_a453219af4b49ccaf258e564006ed1f07"><div class="ttname"><a href="classentt_1_1Delegate_3_01Ret_07Args_8_8_8_08_4.html#a453219af4b49ccaf258e564006ed1f07">entt::Delegate< Ret(Args...)>::connect</a></div><div class="ttdeci">void connect(Class *instance) ENTT_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#l00086">delegate.hpp:86</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|