Files
entt/range_8hpp_source.html
2021-07-28 10:12:19 +02:00

168 lines
18 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: src/entt/meta/range.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">3.8.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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_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_c5715f7ee899854a669b87bbaa642de0.html">meta</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">range.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_META_RANGE_HPP</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define ENTT_META_RANGE_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;cstddef&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;iterator&gt;</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; </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<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>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</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> Type, <span class="keyword">typename</span> Node = <span class="keyword">typename</span> Type::node_type&gt;</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classentt_1_1meta__range.html"> 18</a></span>&#160;<span class="keyword">class </span><a class="code" href="classentt_1_1meta__range.html">meta_range</a> {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keyword">struct </span>range_iterator {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">using</span> difference_type = std::ptrdiff_t;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keyword">using</span> value_type = Type;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">using</span> pointer = void;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">using</span> reference = value_type;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">using</span> iterator_category = std::input_iterator_tag;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">using</span> <a class="code" href="classentt_1_1meta__range.html#a432a47eca3a3f2615a989f74d45b08d8">node_type</a> = Node;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; range_iterator() ENTT_NOEXCEPT = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; range_iterator(<a class="code" href="classentt_1_1meta__range.html#a432a47eca3a3f2615a989f74d45b08d8">node_type</a> *head) ENTT_NOEXCEPT</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; : it{head}</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; {}</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; range_iterator &amp; operator++() ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">return</span> (it = it-&gt;next), *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; }</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; range_iterator operator++(<span class="keywordtype">int</span>) ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; range_iterator orig = *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">return</span> ++(*this), orig;</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; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; [[nodiscard]] reference operator*() <span class="keyword">const</span> ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span> it;</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; [[nodiscard]] <span class="keywordtype">bool</span> <a class="code" href="namespaceentt.html#af6de691c4ec15d4a63ea8960563bbea0">operator==</a>(<span class="keyword">const</span> range_iterator &amp;other) <span class="keyword">const</span> ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">return</span> other.it == it;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; }</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; [[nodiscard]] <span class="keywordtype">bool</span> <a class="code" href="namespaceentt.html#ae38ac5bc7b9097ec21eb1058db206cff">operator!=</a>(<span class="keyword">const</span> range_iterator &amp;other) <span class="keyword">const</span> ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">return</span> !(*<span class="keyword">this</span> == other);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; }</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="classentt_1_1meta__range.html#a432a47eca3a3f2615a989f74d45b08d8">node_type</a> *it{};</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; };</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classentt_1_1meta__range.html#a432a47eca3a3f2615a989f74d45b08d8"> 60</a></span>&#160; <span class="keyword">using</span> <a class="code" href="classentt_1_1meta__range.html#a432a47eca3a3f2615a989f74d45b08d8">node_type</a> = Node;</div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classentt_1_1meta__range.html#aee64416aa8a96b20e10c4879dd34d0db"> 62</a></span>&#160; <span class="keyword">using</span> <a class="code" href="classentt_1_1meta__range.html#aee64416aa8a96b20e10c4879dd34d0db">iterator</a> = range_iterator;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classentt_1_1meta__range.html#a9211ac6461120ea81c1ba632db875bbe"> 65</a></span>&#160; <a class="code" href="classentt_1_1meta__range.html#a9211ac6461120ea81c1ba632db875bbe">meta_range</a>() ENTT_NOEXCEPT = default;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classentt_1_1meta__range.html#aa9eb66c65013ff00985f88e956360511"> 71</a></span>&#160; <a class="code" href="classentt_1_1meta__range.html">meta_range</a>(<a class="code" href="classentt_1_1meta__range.html#a432a47eca3a3f2615a989f74d45b08d8">node_type</a> *head)</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; : node{head}</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; {}</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classentt_1_1meta__range.html#a87aca0f2c3f9d0c91e75ed9c9901569b"> 79</a></span>&#160; [[nodiscard]] <a class="code" href="classentt_1_1meta__range.html#aee64416aa8a96b20e10c4879dd34d0db">iterator</a> <a class="code" href="classentt_1_1meta__range.html#a87aca0f2c3f9d0c91e75ed9c9901569b">begin</a>() const ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classentt_1_1meta__range.html#aee64416aa8a96b20e10c4879dd34d0db">iterator</a>{node};</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; }</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classentt_1_1meta__range.html#ae941b7fcda707d80d62a173b353ab803"> 88</a></span>&#160; [[nodiscard]] <a class="code" href="classentt_1_1meta__range.html#aee64416aa8a96b20e10c4879dd34d0db">iterator</a> <a class="code" href="classentt_1_1meta__range.html#ae941b7fcda707d80d62a173b353ab803">end</a>() const ENTT_NOEXCEPT {</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classentt_1_1meta__range.html#aee64416aa8a96b20e10c4879dd34d0db">iterator</a>{};</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; }</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <a class="code" href="classentt_1_1meta__range.html#a432a47eca3a3f2615a989f74d45b08d8">node_type</a> *node{<span class="keyword">nullptr</span>};</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;};</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;}</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="l00100"></a><span class="lineno"> 100</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassentt_1_1meta__range_html"><div class="ttname"><a href="classentt_1_1meta__range.html">entt::meta_range</a></div><div class="ttdoc">Iterable range to use to iterate all types of meta objects.</div><div class="ttdef"><b>Definition:</b> <a href="range_8hpp_source.html#l00018">range.hpp:18</a></div></div>
<div class="ttc" id="aclassentt_1_1meta__range_html_a432a47eca3a3f2615a989f74d45b08d8"><div class="ttname"><a href="classentt_1_1meta__range.html#a432a47eca3a3f2615a989f74d45b08d8">entt::meta_range::node_type</a></div><div class="ttdeci">Node node_type</div><div class="ttdoc">Node type.</div><div class="ttdef"><b>Definition:</b> <a href="range_8hpp_source.html#l00060">range.hpp:60</a></div></div>
<div class="ttc" id="aclassentt_1_1meta__range_html_a87aca0f2c3f9d0c91e75ed9c9901569b"><div class="ttname"><a href="classentt_1_1meta__range.html#a87aca0f2c3f9d0c91e75ed9c9901569b">entt::meta_range::begin</a></div><div class="ttdeci">iterator begin() const ENTT_NOEXCEPT</div><div class="ttdoc">Returns an iterator to the beginning.</div><div class="ttdef"><b>Definition:</b> <a href="range_8hpp_source.html#l00079">range.hpp:79</a></div></div>
<div class="ttc" id="aclassentt_1_1meta__range_html_a9211ac6461120ea81c1ba632db875bbe"><div class="ttname"><a href="classentt_1_1meta__range.html#a9211ac6461120ea81c1ba632db875bbe">entt::meta_range::meta_range</a></div><div class="ttdeci">meta_range() ENTT_NOEXCEPT=default</div><div class="ttdoc">Default constructor.</div></div>
<div class="ttc" id="aclassentt_1_1meta__range_html_ae941b7fcda707d80d62a173b353ab803"><div class="ttname"><a href="classentt_1_1meta__range.html#ae941b7fcda707d80d62a173b353ab803">entt::meta_range::end</a></div><div class="ttdeci">iterator end() const ENTT_NOEXCEPT</div><div class="ttdoc">Returns an iterator to the end.</div><div class="ttdef"><b>Definition:</b> <a href="range_8hpp_source.html#l00088">range.hpp:88</a></div></div>
<div class="ttc" id="aclassentt_1_1meta__range_html_aee64416aa8a96b20e10c4879dd34d0db"><div class="ttname"><a href="classentt_1_1meta__range.html#aee64416aa8a96b20e10c4879dd34d0db">entt::meta_range::iterator</a></div><div class="ttdeci">range_iterator iterator</div><div class="ttdoc">Input iterator type.</div><div class="ttdef"><b>Definition:</b> <a href="range_8hpp_source.html#l00062">range.hpp:62</a></div></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="algorithm_8hpp_source.html#l00013">algorithm.hpp:13</a></div></div>
<div class="ttc" id="anamespaceentt_html_ae38ac5bc7b9097ec21eb1058db206cff"><div class="ttname"><a href="namespaceentt.html#ae38ac5bc7b9097ec21eb1058db206cff">entt::operator!=</a></div><div class="ttdeci">bool operator!=(const basic_any&lt; Len, Align &gt; &amp;lhs, const basic_any&lt; Len, Align &gt; &amp;rhs)</div><div class="ttdoc">Checks if two wrappers differ in their content.</div><div class="ttdef"><b>Definition:</b> <a href="any_8hpp_source.html#l00368">any.hpp:368</a></div></div>
<div class="ttc" id="anamespaceentt_html_af6de691c4ec15d4a63ea8960563bbea0"><div class="ttname"><a href="namespaceentt.html#af6de691c4ec15d4a63ea8960563bbea0">entt::operator==</a></div><div class="ttdeci">constexpr bool operator==(const Entity entity, const null_t other)</div><div class="ttdoc">Compares a null object and an entity identifier of any type.</div><div class="ttdef"><b>Definition:</b> <a href="entity_8hpp_source.html#l00219">entity.hpp:219</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>