-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_id_8h_source.html
75 lines (75 loc) · 23.3 KB
/
_id_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<!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>Gamedev Framework (gf): Id.h 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/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.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="projectlogo"><img alt="Logo" src="gf_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Gamedev Framework (gf)
 <span id="projectnumber">0.6.0</span>
</div>
<div id="projectbrief">A C++11 framework for 2D games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_6d069d519ae9d12fa11dd8e685586b60.html">gf</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Id.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Gamedev Framework (gf)</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2016-2017 Julien Bernard</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This software is provided 'as-is', without any express or implied</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * warranty. In no event will the authors be held liable for any damages</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * arising from the use of this software.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Permission is granted to anyone to use this software for any purpose,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * including commercial applications, and to alter it and redistribute it</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * freely, subject to the following restrictions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * 1. The origin of this software must not be misrepresented; you must not</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * claim that you wrote the original software. If you use this software</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * in a product, an acknowledgment in the product documentation would be</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * appreciated but is not required.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * 2. Altered source versions must be plainly marked as such, and must not be</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * misrepresented as being the original software.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * 3. This notice may not be removed or altered from any source distribution.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">GF_ID_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">GF_ID_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <span class="preprocessor"><</span><span class="preprocessor">cstdint</span><span class="preprocessor">></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <span class="preprocessor"><</span><span class="preprocessor">string</span><span class="preprocessor">></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="_portability_8h.html">"Portability.h"</a></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="_string_ref_8h.html">"StringRef.h"</a></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace</span> <a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">inline</span> <span class="keyword">namespace</span> v1 {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">/**</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * @ingroup core</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * @brief An identifier</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> */</span></div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="group__core.html#ga375ce9d7d861b67c78398d51c1769410"> 39</a></span>  <span class="keyword">using</span> Id = uint64_t;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">/**</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @ingroup core</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * @brief The invalid id (which is 0)</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> */</span></div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="group__core.html#ga63cc77139085fae86503ed552b1c52ee"> 45</a></span>  <span class="keyword">constexpr</span> Id <a class="code" href="group__core.html#ga63cc77139085fae86503ed552b1c52ee">InvalidId</a> = 0;</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>  <span class="comment">/**</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @ingroup core</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @brief Get an identifier from a string</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> *</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * The hash is a Fowler–Noll–Vo 1a hash. This function is mainly for</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * internal use. You should instead use the user-defined literal `_id`.</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> *</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * Example:</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> *</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * ~~~{.cc}</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * gf::Id id = "A string"_id; // computed at compile time</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * ~~~</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> *</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * @param str The string</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * @param sz The size of the string</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> */</span></div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a"> 63</a></span>  <span class="keyword">constexpr</span> Id <a class="code" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">hash</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *str, std::size_t sz) {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> sz == 0 ? 0xcbf29ce484222325 : (str[sz - 1] ^ <a class="code" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">hash</a><a class="code" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">(</a>str<a class="code" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">,</a> sz - 1<a class="code" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">)</a>) * 0x100000001b3;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">/**</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * @ingroup core</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * @brief Get an idenfitier from a string</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> *</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * The hash is a Fowler–Noll–Vo 1a hash. This function can be used</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * for computing an id at runtime. For computing an id from a string</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * at compile time, you should use the the user-defined literal `_id`.</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> *</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * @param str The string</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * @returns The hash of the string</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> */</span></div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="group__core.html#gae369c6dfc94eb885a40137e0d66f2d80"> 78</a></span>  <span class="keyword">constexpr</span> Id <a class="code" href="group__core.html#gae369c6dfc94eb885a40137e0d66f2d80">hash</a>(<a class="code" href="classgf_1_1_string_ref.html">StringRef</a> str) {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">return</span> <a class="code" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">hash</a><a class="code" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">(</a>str<a class="code" href="classgf_1_1_string_ref.html#aaf842fe1a7a4594b4be5df29d3cf41a1">.</a><a class="code" href="classgf_1_1_string_ref.html#aaf842fe1a7a4594b4be5df29d3cf41a1">getData</a><a class="code" href="classgf_1_1_string_ref.html#aaf842fe1a7a4594b4be5df29d3cf41a1">(</a><a class="code" href="classgf_1_1_string_ref.html#aaf842fe1a7a4594b4be5df29d3cf41a1">)</a><a class="code" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">,</a> str<a class="code" href="classgf_1_1_string_ref.html#a19b252c627d906593f1cde39c2d4a3e9">.</a><a class="code" href="classgf_1_1_string_ref.html#a19b252c627d906593f1cde39c2d4a3e9">getSize</a><a class="code" href="classgf_1_1_string_ref.html#a19b252c627d906593f1cde39c2d4a3e9">(</a><a class="code" href="classgf_1_1_string_ref.html#a19b252c627d906593f1cde39c2d4a3e9">)</a><a class="code" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">)</a>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  }</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="namespacegf_1_1literals.html"> 82</a></span>  <span class="keyword">namespace</span> <a class="code" href="namespacegf_1_1literals.html">literals</a> {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">/**</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * @brief User defined operator for creating compile time ids from strings</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> *</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * To use it, you have to use the `gf::literals` namespace:</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> *</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * ~~~{.cc}</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * using namespace gf::literals;</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> *</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * Id id = "FooBar"_id;</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * ~~~</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> *</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> */</span></div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="namespacegf_1_1literals.html#aec3130535a52fd1c241a4bfecffcbffb"> 96</a></span>  <span class="keyword">constexpr</span> <a class="code" href="namespacegf.html">gf</a>::Id <a class="code" href="namespacegf_1_1literals.html#aec3130535a52fd1c241a4bfecffcbffb">operator</a><span class="stringliteral">""</span> <a class="code" href="namespacegf_1_1literals.html#aec3130535a52fd1c241a4bfecffcbffb">_id</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *str, std::size_t sz) {</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">return</span> <a class="code" href="namespacegf.html">gf</a><a class="code" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">::</a><a class="code" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">hash</a><a class="code" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">(</a>str<a class="code" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">,</a> sz<a class="code" href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">)</a>;</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> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  }</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> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> }</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> }</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> <span class="preprocessor">#</span><span class="preprocessor">endif</span> <span class="comment">// GF_ID_H</span></div><div class="ttc" id="classgf_1_1_string_ref_html_aaf842fe1a7a4594b4be5df29d3cf41a1"><div class="ttname"><a href="classgf_1_1_string_ref.html#aaf842fe1a7a4594b4be5df29d3cf41a1">gf::StringRef::getData</a></div><div class="ttdeci">constexpr const char * getData() const noexcept</div><div class="ttdoc">Get a pointer to the string. </div><div class="ttdef"><b>Definition:</b> StringRef.h:111</div></div>
<div class="ttc" id="group__core_html_gae369c6dfc94eb885a40137e0d66f2d80"><div class="ttname"><a href="group__core.html#gae369c6dfc94eb885a40137e0d66f2d80">gf::hash</a></div><div class="ttdeci">constexpr Id hash(StringRef str)</div><div class="ttdoc">Get an idenfitier from a string. </div><div class="ttdef"><b>Definition:</b> Id.h:78</div></div>
<div class="ttc" id="namespacegf_1_1literals_html"><div class="ttname"><a href="namespacegf_1_1literals.html">gf::literals</a></div><div class="ttdoc">The namespace for literals. </div><div class="ttdef"><b>Definition:</b> Id.h:82</div></div>
<div class="ttc" id="group__core_html_gafb2a827226f08af1ff5ef7bfae6f525a"><div class="ttname"><a href="group__core.html#gafb2a827226f08af1ff5ef7bfae6f525a">gf::hash</a></div><div class="ttdeci">constexpr Id hash(const char *str, std::size_t sz)</div><div class="ttdoc">Get an identifier from a string. </div><div class="ttdef"><b>Definition:</b> Id.h:63</div></div>
<div class="ttc" id="namespacegf_html"><div class="ttname"><a href="namespacegf.html">gf</a></div><div class="ttdoc">The namespace for gf classes. </div><div class="ttdef"><b>Definition:</b> Action.h:34</div></div>
<div class="ttc" id="classgf_1_1_string_ref_html"><div class="ttname"><a href="classgf_1_1_string_ref.html">gf::StringRef</a></div><div class="ttdoc">A constant reference to a string and its size. </div><div class="ttdef"><b>Definition:</b> StringRef.h:41</div></div>
<div class="ttc" id="namespacegf_1_1literals_html_aec3130535a52fd1c241a4bfecffcbffb"><div class="ttname"><a href="namespacegf_1_1literals.html#aec3130535a52fd1c241a4bfecffcbffb">gf::literals::operator"" _id</a></div><div class="ttdeci">constexpr gf::Id operator"" _id(const char *str, std::size_t sz)</div><div class="ttdoc">User defined operator for creating compile time ids from strings. </div><div class="ttdef"><b>Definition:</b> Id.h:96</div></div>
<div class="ttc" id="group__core_html_ga63cc77139085fae86503ed552b1c52ee"><div class="ttname"><a href="group__core.html#ga63cc77139085fae86503ed552b1c52ee">gf::InvalidId</a></div><div class="ttdeci">constexpr Id InvalidId</div><div class="ttdoc">The invalid id (which is 0) </div><div class="ttdef"><b>Definition:</b> Id.h:45</div></div>
<div class="ttc" id="classgf_1_1_string_ref_html_a19b252c627d906593f1cde39c2d4a3e9"><div class="ttname"><a href="classgf_1_1_string_ref.html#a19b252c627d906593f1cde39c2d4a3e9">gf::StringRef::getSize</a></div><div class="ttdeci">constexpr std::size_t getSize() const noexcept</div><div class="ttdoc">Get the size of the string. </div><div class="ttdef"><b>Definition:</b> StringRef.h:120</div></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>