Files
Bomberman/Callback_8hpp_source.html
2021-06-26 11:31:13 +00:00

147 lines
16 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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Bomberman: lib/wal/sources/Models/Callback.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">Bomberman
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="dir_0b4831311044d013096ae27e916683ee.html">wal</a></li><li class="navelem"><a class="el" href="dir_d2f550de4c275647d2c0a50b557bd3a7.html">sources</a></li><li class="navelem"><a class="el" href="dir_03844c54c5a081543e79d2b40621bd20.html">Models</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Callback.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="Callback_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Created by Zoe Roux on 5/21/21.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">//</span></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; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</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;<span class="preprocessor">#include &lt;functional&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;unordered_map&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceWAL.html">WAL</a></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;{</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> ...Types&gt;</div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classWAL_1_1Callback.html"> 16</a></span>&#160; <span class="keyword">class </span><a class="code" href="classWAL_1_1Callback.html">Callback</a></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classWAL_1_1Callback.html#a57d3fff6c3d00027d635430c6e425020"> 19</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classWAL_1_1Callback.html#a57d3fff6c3d00027d635430c6e425020">_nextID</a> = 0;</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classWAL_1_1Callback.html#af4548751e47bbcb84ae52c78de15ef14"> 21</a></span>&#160; std::unordered_map&lt;int, std::function&lt;void (Types...)&gt;&gt; <a class="code" href="classWAL_1_1Callback.html#af4548751e47bbcb84ae52c78de15ef14">_functions</a> = {};</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Func&gt;</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classWAL_1_1Callback.html#a3706378bf1ee6b6db1a9d900403d30e2"> 28</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classWAL_1_1Callback.html#a3706378bf1ee6b6db1a9d900403d30e2">addCallback</a>(Func callback)</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordtype">int</span> <span class="keywordtype">id</span> = this-&gt;_nextID++;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">if</span> constexpr(std::is_same_v&lt;Func, std::function&lt;<span class="keywordtype">void</span> (Types...)&gt;&gt;)</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; this-&gt;_functions[id] = std::move(callback);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; this-&gt;_functions[id] = std::function&lt;void (Types...)&gt;(callback);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordflow">return</span> id;</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="l00040"></a><span class="lineno"><a class="line" href="classWAL_1_1Callback.html#accc0ebb93411e0a12a131991afe45a50"> 40</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classWAL_1_1Callback.html#accc0ebb93411e0a12a131991afe45a50">removeCallback</a>(<span class="keywordtype">int</span> <span class="keywordtype">id</span>)</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; this-&gt;_functions.erase(<span class="keywordtype">id</span>);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; }</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"><a class="line" href="classWAL_1_1Callback.html#a74837f6a75e085479bede9d631a9a14e"> 45</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classWAL_1_1Callback.html#a74837f6a75e085479bede9d631a9a14e">operator()</a>(Types ...args)<span class="keyword"> const</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span> &amp;[_, callback] : this-&gt;_functions)</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; callback(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="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="classWAL_1_1Callback.html#a5d957e6ca965a021f812cdd5a884b4ad">Callback</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="classWAL_1_1Callback.html#a5d957e6ca965a021f812cdd5a884b4ad">Callback</a>(<span class="keyword">const</span> <a class="code" href="classWAL_1_1Callback.html">Callback</a> &amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="classWAL_1_1Callback.html#a8ec1ef40b5431f2c1759f9174bf21301">~Callback</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="classWAL_1_1Callback.html">Callback</a> &amp;<a class="code" href="classWAL_1_1Callback.html#a5500cc251b0be65962511c704b4ab25c">operator=</a>(<span class="keyword">const</span> <a class="code" href="classWAL_1_1Callback.html">Callback</a> &amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Func&gt;</div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classWAL_1_1Callback.html#abcfcd4cd75584751f240319ccb2acc67"> 62</a></span>&#160; <a class="code" href="classWAL_1_1Callback.html#abcfcd4cd75584751f240319ccb2acc67">Callback</a>(Func callback) <span class="comment">// NOLINT(google-explicit-constructor)</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; {</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; this-&gt;<a class="code" href="classWAL_1_1Callback.html#a3706378bf1ee6b6db1a9d900403d30e2">addCallback</a>(callback);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; }</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; };</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;} <span class="comment">// namespace WAL</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassWAL_1_1Callback_html_a8ec1ef40b5431f2c1759f9174bf21301"><div class="ttname"><a href="classWAL_1_1Callback.html#a8ec1ef40b5431f2c1759f9174bf21301">WAL::Callback::~Callback</a></div><div class="ttdeci">~Callback()=default</div><div class="ttdoc">A default destructor.</div></div>
<div class="ttc" id="anamespaceWAL_html"><div class="ttname"><a href="namespaceWAL.html">WAL</a></div><div class="ttdef"><b>Definition:</b> Component.cpp:7</div></div>
<div class="ttc" id="aclassWAL_1_1Callback_html_a5500cc251b0be65962511c704b4ab25c"><div class="ttname"><a href="classWAL_1_1Callback.html#a5500cc251b0be65962511c704b4ab25c">WAL::Callback::operator=</a></div><div class="ttdeci">Callback &amp; operator=(const Callback &amp;)=default</div><div class="ttdoc">A default assignment operator.</div></div>
<div class="ttc" id="aclassWAL_1_1Callback_html_a3706378bf1ee6b6db1a9d900403d30e2"><div class="ttname"><a href="classWAL_1_1Callback.html#a3706378bf1ee6b6db1a9d900403d30e2">WAL::Callback::addCallback</a></div><div class="ttdeci">int addCallback(Func callback)</div><div class="ttdoc">Add a method to be called when this callback is invoked.</div><div class="ttdef"><b>Definition:</b> Callback.hpp:28</div></div>
<div class="ttc" id="aclassWAL_1_1Callback_html_a5d957e6ca965a021f812cdd5a884b4ad"><div class="ttname"><a href="classWAL_1_1Callback.html#a5d957e6ca965a021f812cdd5a884b4ad">WAL::Callback::Callback</a></div><div class="ttdeci">Callback()=default</div><div class="ttdoc">A default constructor.</div></div>
<div class="ttc" id="aclassWAL_1_1Callback_html"><div class="ttname"><a href="classWAL_1_1Callback.html">WAL::Callback</a></div><div class="ttdoc">A callback where you can subscribe to and emit it.</div><div class="ttdef"><b>Definition:</b> Callback.hpp:16</div></div>
<div class="ttc" id="aclassWAL_1_1Callback_html_abcfcd4cd75584751f240319ccb2acc67"><div class="ttname"><a href="classWAL_1_1Callback.html#abcfcd4cd75584751f240319ccb2acc67">WAL::Callback::Callback</a></div><div class="ttdeci">Callback(Func callback)</div><div class="ttdoc">Implicitly transform a callable into a callback.</div><div class="ttdef"><b>Definition:</b> Callback.hpp:62</div></div>
<div class="ttc" id="aclassWAL_1_1Callback_html_a57d3fff6c3d00027d635430c6e425020"><div class="ttname"><a href="classWAL_1_1Callback.html#a57d3fff6c3d00027d635430c6e425020">WAL::Callback::_nextID</a></div><div class="ttdeci">int _nextID</div><div class="ttdef"><b>Definition:</b> Callback.hpp:19</div></div>
<div class="ttc" id="aclassWAL_1_1Callback_html_accc0ebb93411e0a12a131991afe45a50"><div class="ttname"><a href="classWAL_1_1Callback.html#accc0ebb93411e0a12a131991afe45a50">WAL::Callback::removeCallback</a></div><div class="ttdeci">void removeCallback(int id)</div><div class="ttdoc">Remove a function from this callback.</div><div class="ttdef"><b>Definition:</b> Callback.hpp:40</div></div>
<div class="ttc" id="aclassWAL_1_1Callback_html_a74837f6a75e085479bede9d631a9a14e"><div class="ttname"><a href="classWAL_1_1Callback.html#a74837f6a75e085479bede9d631a9a14e">WAL::Callback::operator()</a></div><div class="ttdeci">void operator()(Types ...args) const</div><div class="ttdef"><b>Definition:</b> Callback.hpp:45</div></div>
<div class="ttc" id="aclassWAL_1_1Callback_html_af4548751e47bbcb84ae52c78de15ef14"><div class="ttname"><a href="classWAL_1_1Callback.html#af4548751e47bbcb84ae52c78de15ef14">WAL::Callback::_functions</a></div><div class="ttdeci">std::unordered_map&lt; int, std::function&lt; void(Types...)&gt; &gt; _functions</div><div class="ttdoc">The list of functions to call.</div><div class="ttdef"><b>Definition:</b> Callback.hpp:21</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.17
</small></address>
</body>
</html>