170 lines
17 KiB
HTML
170 lines
17 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" 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.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: src/entt/core/tuple.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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.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-awesome.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">EnTT<span id="projectnumber"> 3.15.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',false);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){ initResizable(false); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- 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 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 id="doc-content">
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">tuple.hpp</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef ENTT_CORE_TUPLE_HPP</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ENTT_CORE_TUPLE_HPP</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <tuple></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <type_traits></span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <utility></span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceentt.html">entt</a> {</div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="structentt_1_1is__tuple.html"> 16</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structentt_1_1is__tuple.html">is_tuple</a>: std::false_type {};</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">template</span><<span class="keyword">typename</span>... Args></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="structentt_1_1is__tuple_3_01std_1_1tuple_3_01Args_8_8_8_01_4_01_4.html"> 23</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structentt_1_1is__tuple.html">is_tuple</a><std::tuple<Args...>>: std::true_type {};</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span></div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="namespaceentt.html#a0617c69b8aa01b123162d23d7213c6aa"> 30</a></span><span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="namespaceentt.html#a0617c69b8aa01b123162d23d7213c6aa">is_tuple_v</a> = <a class="code hl_struct" href="structentt_1_1is__tuple.html">is_tuple<Type>::value</a>;</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span></div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="foldopen" id="foldopen00040" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="namespaceentt.html#abf2665e41871f7493f674c8dbba0a593"> 40</a></span><span class="keyword">constexpr</span> <span class="keyword">decltype</span>(<span class="keyword">auto</span>) <a class="code hl_function" href="namespaceentt.html#abf2665e41871f7493f674c8dbba0a593">unwrap_tuple</a>(Type &&value) <span class="keyword">noexcept</span> {</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordflow">if</span> <span class="keyword">constexpr</span>(std::tuple_size_v<std::remove_reference_t<Type>> == 1u) {</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">return</span> std::get<0>(std::forward<Type>(value));</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> } <span class="keywordflow">else</span> {</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordflow">return</span> std::forward<Type>(value);</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> }</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>}</div>
|
|
</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span></div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="keyword">template</span><<span class="keyword">typename</span> Func></div>
|
|
<div class="foldopen" id="foldopen00053" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="structentt_1_1forward__apply.html"> 53</a></span><span class="keyword">struct </span><a class="code hl_function" href="structentt_1_1forward__apply.html#a15ad53ead573c72820db3f8ff8f60fb5">forward_apply</a>: <span class="keyword">private</span> Func {</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">template</span><<span class="keyword">typename</span>... Args></div>
|
|
<div class="foldopen" id="foldopen00060" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="structentt_1_1forward__apply.html#a15ad53ead573c72820db3f8ff8f60fb5"> 60</a></span> <span class="keyword">constexpr</span> <a class="code hl_function" href="structentt_1_1forward__apply.html#a15ad53ead573c72820db3f8ff8f60fb5">forward_apply</a>(Args &&...args) <span class="keyword">noexcept</span>(std::is_nothrow_constructible_v<Func, Args...>)</div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> : Func{std::forward<Args>(args)...} {}</div>
|
|
</div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span></div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="foldopen" id="foldopen00070" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="structentt_1_1forward__apply.html#a151fa7f389efe40a8b4c09c1bd055ec2"> 70</a></span> <span class="keyword">constexpr</span> <span class="keyword">decltype</span>(<span class="keyword">auto</span>) <a class="code hl_function" href="structentt_1_1forward__apply.html#a151fa7f389efe40a8b4c09c1bd055ec2">operator()</a>(Type &&args) <span class="keyword">noexcept</span>(<span class="keyword">noexcept</span>(std::apply(std::declval<Func &>(), args))) {</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keywordflow">return</span> std::apply(<span class="keyword">static_cast<</span>Func &<span class="keyword">></span>(*<span class="keyword">this</span>), std::forward<Type>(args));</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span></div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">template</span><<span class="keyword">typename</span> Type></div>
|
|
<div class="foldopen" id="foldopen00076" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="structentt_1_1forward__apply.html#afc1bb10152536953a716529e1772a418"> 76</a></span> <span class="keyword">constexpr</span> <span class="keyword">decltype</span>(<span class="keyword">auto</span>) <span class="keyword">operator</span>()(Type &&args) <span class="keyword">const</span> <span class="keyword">noexcept</span>(<span class="keyword">noexcept</span>(std::apply(std::declval<const Func &>(), args))) {</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keywordflow">return</span> std::apply(<span class="keyword">static_cast<</span><span class="keyword">const </span>Func &<span class="keyword">></span>(*<span class="keyword">this</span>), std::forward<Type>(args));</div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span></div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="keyword">template</span><<span class="keyword">typename</span> Func></div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="namespaceentt.html#a0662ddd2021dbf1513b7d0b40c50b9b2"> 86</a></span><a class="code hl_function" href="namespaceentt.html#a0662ddd2021dbf1513b7d0b40c50b9b2">forward_apply</a>(Func) -> <a class="code hl_struct" href="structentt_1_1forward__apply.html">forward_apply<std::remove_reference_t<std::remove_cv_t<Func></a>>>;</div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>} <span class="comment">// namespace entt</span></div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="preprocessor">#endif</span></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="dense__map_8hpp_source.html#l00022">dense_map.hpp:22</a></div></div>
|
|
<div class="ttc" id="anamespaceentt_html_a0617c69b8aa01b123162d23d7213c6aa"><div class="ttname"><a href="namespaceentt.html#a0617c69b8aa01b123162d23d7213c6aa">entt::is_tuple_v</a></div><div class="ttdeci">constexpr bool is_tuple_v</div><div class="ttdoc">Helper variable template.</div><div class="ttdef"><b>Definition</b> <a href="#l00030">tuple.hpp:30</a></div></div>
|
|
<div class="ttc" id="anamespaceentt_html_a0662ddd2021dbf1513b7d0b40c50b9b2"><div class="ttname"><a href="namespaceentt.html#a0662ddd2021dbf1513b7d0b40c50b9b2">entt::forward_apply</a></div><div class="ttdeci">forward_apply(Func) -> forward_apply< std::remove_reference_t< std::remove_cv_t< Func > > ></div><div class="ttdoc">Deduction guide.</div></div>
|
|
<div class="ttc" id="anamespaceentt_html_abf2665e41871f7493f674c8dbba0a593"><div class="ttname"><a href="namespaceentt.html#abf2665e41871f7493f674c8dbba0a593">entt::unwrap_tuple</a></div><div class="ttdeci">constexpr decltype(auto) unwrap_tuple(Type &&value) noexcept</div><div class="ttdoc">Utility function to unwrap tuples of a single element.</div><div class="ttdef"><b>Definition</b> <a href="#l00040">tuple.hpp:40</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1forward__apply_html"><div class="ttname"><a href="structentt_1_1forward__apply.html">entt::forward_apply</a></div><div class="ttdoc">Utility class to forward-and-apply tuple objects.</div><div class="ttdef"><b>Definition</b> <a href="#l00053">tuple.hpp:53</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1forward__apply_html_a151fa7f389efe40a8b4c09c1bd055ec2"><div class="ttname"><a href="structentt_1_1forward__apply.html#a151fa7f389efe40a8b4c09c1bd055ec2">entt::forward_apply::operator()</a></div><div class="ttdeci">constexpr decltype(auto) operator()(Type &&args) noexcept(noexcept(std::apply(std::declval< Func & >(), args)))</div><div class="ttdoc">Forwards and applies the arguments with the underlying function.</div><div class="ttdef"><b>Definition</b> <a href="#l00070">tuple.hpp:70</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1forward__apply_html_a15ad53ead573c72820db3f8ff8f60fb5"><div class="ttname"><a href="structentt_1_1forward__apply.html#a15ad53ead573c72820db3f8ff8f60fb5">entt::forward_apply::forward_apply</a></div><div class="ttdeci">constexpr forward_apply(Args &&...args) noexcept(std::is_nothrow_constructible_v< Func, Args... >)</div><div class="ttdoc">Constructs a forward-and-apply object.</div><div class="ttdef"><b>Definition</b> <a href="#l00060">tuple.hpp:60</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1is__tuple_html"><div class="ttname"><a href="structentt_1_1is__tuple.html">entt::is_tuple</a></div><div class="ttdoc">Provides the member constant value to true if a given type is a tuple, false otherwise.</div><div class="ttdef"><b>Definition</b> <a href="#l00016">tuple.hpp:16</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
|
|
</small></address>
|
|
</div><!-- doc-content -->
|
|
</body>
|
|
</html>
|