75 lines
24 KiB
HTML
75 lines
24 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: docs/md/core.md 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">3.2.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>
|
|
</div><!-- top -->
|
|
<!-- 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 class="header">
|
|
<div class="headertitle">
|
|
<div class="title">docs/md/core.md</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> # Crash Course: core functionalities</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</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> @cond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> --></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> # Table of Contents</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> * [Introduction](#introduction)</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> * [Compile-time identifiers](#compile-time-identifiers)</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> * [Runtime identifiers](#runtime-identifiers)</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> * [Hashed strings](#hashed-strings)</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  * [Wide characters](wide-characters)</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  * [Conflicts](#conflicts)</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> * [Monostate](#monostate)</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <!--</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> @endcond TURN_OFF_DOXYGEN</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> --></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> # Introduction</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> `EnTT` comes with a bunch of core functionalities mostly used by the other parts</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> of the library itself.<br/></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> Hardly users will include these features in their code, but it's worth</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> describing what `EnTT` offers so as not to reinvent the wheel in case of need.</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> # Compile-time identifiers</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> Sometimes it's useful to be able to give unique identifiers to types at</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> compile-time.<br/></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> There are plenty of different solutions out there and I could have used one of</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> them. However, I decided to spend my time to define a compact and versatile tool</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> that fully embraces what the modern C++ has to offer.</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> The _result of my efforts_ is the `identifier` class template:</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> ```cpp</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> #include <ident.hpp></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> // defines the identifiers for the given types</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> using id = entt::identifier<a_type, another_type>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> // ...</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> switch(a_type_identifier) {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> case id::type<a_type>:</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  // ...</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  break;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> case id::type<another_type>:</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>  break;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> default:</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  // ...</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> }</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="l00056"></a><span class="lineno"> 56</span> This is all what the class template has to offer: a `type` inline variable that</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> contains a numerical identifier for the given type. It can be used in any</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> context where constant expressions are required.</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> As long as the list remains unchanged, identifiers are also guaranteed to be the</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> same for every run. In case they have been used in a production environment and</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> a type has to be removed, one can just use a placeholder to left the other</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> identifiers unchanged:</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> ```cpp</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> template<typename> struct ignore_type {};</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> using id = entt::identifier<</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  a_type_still_valid,</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  ignore_type<a_type_no_longer_valid>,</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  another_type_still_valid</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="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> A bit ugly to see, but it works at least.</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> # Runtime identifiers</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> Sometimes it's useful to be able to give unique identifiers to types at</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> runtime.<br/></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> There are plenty of different solutions out there and I could have used one of</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> them. In fact, I adapted the most common one to my requirements and used it</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> extensively within the entire library.</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> It's the `family` class. Here is an example of use directly from the</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> entity-component system:</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> ```cpp</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> using component_family = entt::family<struct internal_registry_component_family>;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> // ...</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> template<typename Component></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> component_type component() const noexcept {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  return component_family::type<Component>;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</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="l00099"></a><span class="lineno"> 99</span> This is all what a _family_ has to offer: a `type` inline variable that contains</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> a numerical identifier for the given type.</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> Please, note that identifiers aren't guaranteed to be the same for every run.</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> Indeed it mostly depends on the flow of execution.</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> # Hashed strings</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> A hashed string is a zero overhead unique identifier. Users can use</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> human-readable identifiers in the codebase while using their numeric</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> counterparts at runtime, thus without affecting performance.<br/></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> The class has an implicit `constexpr` constructor that chews a bunch of</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> characters. Once created, all what one can do with it is getting back the</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> original string or converting it into a number.<br/></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> The good part is that a hashed string can be used wherever a constant expression</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> is required and no _string-to-number_ conversion will take place at runtime if</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> used carefully.</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> Example of use:</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> ```cpp</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> auto load(entt::hashed_string::hash_type resource) {</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  // uses the numeric representation of the resource to load and return it</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> auto resource = load(entt::hashed_string{"gui/background"});</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> ```</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> There is also a _user defined literal_ dedicated to hashed strings to make them</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> more user-friendly:</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> ```cpp</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> constexpr auto str = "text"_hs;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> ```</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> ## Wide characters</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> The hashed string has a design that is close to that of an `std::basic_string`.</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> It means that `hashed_string` is nothing more than an alias for</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> `basic_hashed_string<char>`. For those who want to use the C++ type for wide</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> character representation, there exists also the alias `hashed_wstring` for</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> `basic_hashed_string<wchar_t>`.<br/></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> In this case, the user defined literal to use to create hashed strings on the</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> fly is `_hws`:</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> ```cpp</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> constexpr auto str = "text"_hws;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> ```</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> Note that the hash type of the `hashed_wstring` is the same of its counterpart.</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> ## Conflicts</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> The hashed string class uses internally FNV-1a to compute the numeric</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> counterpart of a string. Because of the _pigeonhole principle_, conflicts are</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> possible. This is a fact.<br/></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> There is no silver bullet to solve the problem of conflicts when dealing with</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> hashing functions. In this case, the best solution seemed to be to give up.</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> That's all.<br/></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> After all, human-readable unique identifiers aren't something strictly defined</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> and over which users have not the control. Choosing a slightly different</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> identifier is probably the best solution to make the conflict disappear in this</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> case.</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> # Monostate</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> The monostate pattern is often presented as an alternative to a singleton based</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> configuration system. This is exactly its purpose in `EnTT`. Moreover, this</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> implementation is thread safe by design (hopefully).<br/></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> Keys are represented by hashed strings, values are basic types like `int`s or</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> `bool`s. Values of different types can be associated to each key, even more than</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> one at a time. Because of this, users must pay attention to use the same type</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> both during an assignment and when they try to read back their data. Otherwise,</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> they will probably incur in unexpected results.</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> Example of use:</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> ```cpp</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> entt::monostate<entt::hashed_string{"mykey"}>{} = true;</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> entt::monostate<"mykey"_hs>{} = 42;</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> // ...</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> const bool b = entt::monostate<"mykey"_hs>{};</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> const int i = entt::monostate<entt::hashed_string{"mykey"}>{};</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> ```</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>
|