CDevJoud/Minecraft-Community-Edition
1
0
Fork 0
mirror of https://github.com/CDevJoud/Minecraft-Community-Edition.git synced 2026-07-16 20:30:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ef7efddeef5f7ce086c1a53dd6ee0eb2e9727e86
Minecraft-Community-Edition/doc/html/classmce_1_1_function_container.html
Joud Kandeel ef7efddeef added docs
2026-04-01 20:47:40 +02:00

400 lines
20 KiB
HTML
Raw Blame History

<!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.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Minecraft Community Edition: mce::FunctionContainer Class Reference</title>
<link rel="icon" href="logo channel.png" type="image/x-icon" />
<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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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">Minecraft Community Edition<span id="projectnumber">&#160;0.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</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',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('classmce_1_1_function_container.html','','classmce_1_1_function_container-members'); });
</script>
<div id="container">
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle"><div class="title">mce::FunctionContainer Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Container for storing and invoking named functions.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_function_container_8hpp_source.html">FunctionContainer.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad88b85713ffa87b60972a43be7da9517" id="r_ad88b85713ffa87b60972a43be7da9517"><td class="memItemLeft"><a id="ad88b85713ffa87b60972a43be7da9517" name="ad88b85713ffa87b60972a43be7da9517"></a>
&#160;</td><td class="memItemRight"><b>FunctionContainer</b> ()=default</td></tr>
<tr class="memdesc:ad88b85713ffa87b60972a43be7da9517"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="memitem:a56021097f6d60531a37b7c6158b88ec7" id="r_a56021097f6d60531a37b7c6158b88ec7"><td class="memItemLeft">&#160;</td><td class="memItemRight"><a class="el" href="#a56021097f6d60531a37b7c6158b88ec7">FunctionContainer</a> (<a class="el" href="classmce_1_1_q_event_bus.html">QEventBus</a> &amp;qBus, std::initializer_list&lt; std::pair&lt; eastl::string, eastl::any &gt; &gt; initlist)</td></tr>
<tr class="memdesc:a56021097f6d60531a37b7c6158b88ec7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the container with an initializer list of name/value pairs. <br /></td></tr>
<tr class="memitem:abaabfec7793c0a261354f592f20062ce" id="r_abaabfec7793c0a261354f592f20062ce"><td class="memTemplParams" colspan="2">template&lt;typename Functor&gt; </td></tr>
<tr class="memitem:abaabfec7793c0a261354f592f20062ce template"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#abaabfec7793c0a261354f592f20062ce">addFunction</a> (const eastl::string &amp;name, Functor functor)</td></tr>
<tr class="memdesc:abaabfec7793c0a261354f592f20062ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a function to the container. <br /></td></tr>
<tr class="memitem:a302e97f87b554bbaac24ca5d7f884385" id="r_a302e97f87b554bbaac24ca5d7f884385"><td class="memTemplParams" colspan="2">template&lt;typename Return, typename... Arguments&gt; </td></tr>
<tr class="memitem:a302e97f87b554bbaac24ca5d7f884385 template"><td class="memItemLeft">Return&#160;</td><td class="memItemRight"><a class="el" href="#a302e97f87b554bbaac24ca5d7f884385">callFunction</a> (const eastl::string &amp;name, Arguments &amp;&amp;... args)</td></tr>
<tr class="memdesc:a302e97f87b554bbaac24ca5d7f884385"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call a stored function by name with the provided arguments. <br /></td></tr>
<tr class="memitem:aeb8c83b9b780a1990007da8e8e5f3133" id="r_aeb8c83b9b780a1990007da8e8e5f3133"><td class="memItemLeft">bool&#160;</td><td class="memItemRight"><a class="el" href="#aeb8c83b9b780a1990007da8e8e5f3133">findFunction</a> (const eastl::string &amp;name)</td></tr>
<tr class="memdesc:aeb8c83b9b780a1990007da8e8e5f3133"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a function with the given name exists in the container. <br /></td></tr>
<tr class="memitem:ab0271b06ab337b65ae2a4ac79c80c55c" id="r_ab0271b06ab337b65ae2a4ac79c80c55c"><td class="memTemplParams" colspan="2">template&lt;typename Return, typename... Arguments&gt; </td></tr>
<tr class="memitem:ab0271b06ab337b65ae2a4ac79c80c55c template"><td class="memItemLeft">eastl::function&lt; Return(Arguments...)&gt;&#160;</td><td class="memItemRight"><a class="el" href="#ab0271b06ab337b65ae2a4ac79c80c55c">operator[]</a> (const eastl::string &amp;name)</td></tr>
<tr class="memdesc:ab0271b06ab337b65ae2a4ac79c80c55c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve a stored function as an eastl::function via operator[]. <br /></td></tr>
<tr class="memitem:a3d754d6d89dc40e1bb7c178941687b16" id="r_a3d754d6d89dc40e1bb7c178941687b16"><td class="memTemplParams" colspan="2">template&lt;typename Return, typename... Arguments&gt; </td></tr>
<tr class="memitem:a3d754d6d89dc40e1bb7c178941687b16 template"><td class="memItemLeft">eastl::function&lt; Return(Arguments...)&gt;&#160;</td><td class="memItemRight"><a class="el" href="#a3d754d6d89dc40e1bb7c178941687b16">getFunction</a> (const eastl::string &amp;name)</td></tr>
<tr class="memdesc:a3d754d6d89dc40e1bb7c178941687b16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve a stored function as an eastl::function. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Container for storing and invoking named functions. </p>
<p>This class allows storing callables (wrapped as eastl::any) associated with string keys. Functions can be retrieved, cast to the expected signature, and invoked. The API supports adding functions, calling them by name, checking for existence, and retrieving a stored function as an eastl::function object.</p>
<p>A usage example: <a class="el" href="classmce_1_1_function_container.html" title="Container for storing and invoking named functions.">FunctionContainer</a> fc = { { "foo", eastl::function&lt;int(int)&gt;([](int value) -&gt; int{ return value + 1; }) } }; if(fc.findFunction("foo") fc.callFunction&lt;int, int&gt;("foo", 1); </p>
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a56021097f6d60531a37b7c6158b88ec7" name="a56021097f6d60531a37b7c6158b88ec7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56021097f6d60531a37b7c6158b88ec7">&#9670;&#160;</a></span>FunctionContainer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mce::FunctionContainer::FunctionContainer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmce_1_1_q_event_bus.html">QEventBus</a> &amp;</td> <td class="paramname"><span class="paramname"><em>qBus</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::initializer_list&lt; std::pair&lt; eastl::string, eastl::any &gt; &gt;</td> <td class="paramname"><span class="paramname"><em>initlist</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct the container with an initializer list of name/value pairs. </p>
<p>The initializer list should contain pairs of function name and eastl::any containing the callable.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">initlist</td><td>Initializer list of pairs (name, callable-as-eastl::any). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="abaabfec7793c0a261354f592f20062ce" name="abaabfec7793c0a261354f592f20062ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abaabfec7793c0a261354f592f20062ce">&#9670;&#160;</a></span>addFunction()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Functor&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void mce::FunctionContainer::addFunction </td>
<td>(</td>
<td class="paramtype">const eastl::string &amp;</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Functor</td> <td class="paramname"><span class="paramname"><em>functor</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a function to the container. </p>
<p>Add a function implementation.</p>
<p>The callable will be stored in the internal map under the provided name. The callable is stored as an eastl::any and should be retrievable later by using the same signature when casting.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Functor</td><td>Type of the callable being stored. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name under which the function will be stored. </td></tr>
<tr><td class="paramname">functor</td><td>The callable to store.</td></tr>
</table>
</dd>
</dl>
<p>See addFunction documentation above. </p>
</div>
</div>
<a id="a302e97f87b554bbaac24ca5d7f884385" name="a302e97f87b554bbaac24ca5d7f884385"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a302e97f87b554bbaac24ca5d7f884385">&#9670;&#160;</a></span>callFunction()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Return, typename ... Arguments&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Return mce::FunctionContainer::callFunction </td>
<td>(</td>
<td class="paramtype">const eastl::string &amp;</td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Arguments &amp;&amp;...</td> <td class="paramname"><span class="paramname"><em>args</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Call a stored function by name with the provided arguments. </p>
<p>Call a stored function implementation.</p>
<p>The template parameters specify the expected return type and argument types of the stored function. If the named function exists it will be cast to eastl::function&lt;Return(Arguments...)&gt; and invoked. If the function is not found an error is logged via MCE_ERROR and behavior is undefined for the returned value.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Return</td><td>The expected return type of the function. </td></tr>
<tr><td class="paramname">Arguments</td><td>The expected argument types of the function. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the function to call. </td></tr>
<tr><td class="paramname">args</td><td>Arguments to forward to the function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return The value returned by the invoked function.</dd></dl>
<p>See callFunction documentation above. </p>
</div>
</div>
<a id="aeb8c83b9b780a1990007da8e8e5f3133" name="aeb8c83b9b780a1990007da8e8e5f3133"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb8c83b9b780a1990007da8e8e5f3133">&#9670;&#160;</a></span>findFunction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mce::FunctionContainer::findFunction </td>
<td>(</td>
<td class="paramtype">const eastl::string &amp;</td> <td class="paramname"><span class="paramname"><em>name</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether a function with the given name exists in the container. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name to check for. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if a function with the given name exists, false otherwise. </dd></dl>
</div>
</div>
<a id="a3d754d6d89dc40e1bb7c178941687b16" name="a3d754d6d89dc40e1bb7c178941687b16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d754d6d89dc40e1bb7c178941687b16">&#9670;&#160;</a></span>getFunction()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Return, typename ... Arguments&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">eastl::function&lt; Return(Arguments...)&gt; mce::FunctionContainer::getFunction </td>
<td>(</td>
<td class="paramtype">const eastl::string &amp;</td> <td class="paramname"><span class="paramname"><em>name</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a stored function as an eastl::function. </p>
<p>getFunction implementation to retrieve stored function.</p>
<p>Same behavior as operator[] but provided with an explicit named method.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Return</td><td>The return type of the function. </td></tr>
<tr><td class="paramname">Arguments</td><td>The argument types of the function. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the stored function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>eastl::function&lt;Return(Arguments...)&gt; The callable if found; a null function otherwise.</dd></dl>
<p>See getFunction documentation above. </p>
</div>
</div>
<a id="ab0271b06ab337b65ae2a4ac79c80c55c" name="ab0271b06ab337b65ae2a4ac79c80c55c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0271b06ab337b65ae2a4ac79c80c55c">&#9670;&#160;</a></span>operator[]()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Return, typename ... Arguments&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">eastl::function&lt; Return(Arguments...)&gt; mce::FunctionContainer::operator[] </td>
<td>(</td>
<td class="paramtype">const eastl::string &amp;</td> <td class="paramname"><span class="paramname"><em>name</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a stored function as an eastl::function via operator[]. </p>
<p>operator[] implementation to retrieve stored function.</p>
<p>The template specifies the expected signature of the function stored under the given name. If no function exists an error is logged and a null function is returned.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Return</td><td>The return type of the function. </td></tr>
<tr><td class="paramname">Arguments</td><td>The argument types of the function. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the stored function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>eastl::function&lt;Return(Arguments...)&gt; The callable if found; a null function otherwise.</dd></dl>
<p>See operator[] documentation above. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Core/<a class="el" href="_function_container_8hpp_source.html">FunctionContainer.hpp</a></li>
<li>Core/<b>FunctionContainer.cpp</b></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>mce</b></li><li class="navelem"><a href="classmce_1_1_function_container.html">FunctionContainer</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink