Gamedev Framework (gf)  0.12.0
A C++14 framework for 2D games
Id.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016-2019 Julien Bernard
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  * 2. Altered source versions must be plainly marked as such, and must not be
18  * misrepresented as being the original software.
19  * 3. This notice may not be removed or altered from any source distribution.
20  */
21 #ifndef GF_ID_H
22 #define GF_ID_H
23 
24 #include <cstdint>
25 #include <string>
26 
27 #include "Portability.h"
28 #include "StringRef.h"
29 
30 namespace gf {
31 #ifndef DOXYGEN_SHOULD_SKIP_THIS
32 inline namespace v1 {
33 #endif
34 
39  using Id = uint64_t;
40 
45  constexpr Id InvalidId = 0;
46 
63  constexpr Id hash(const char *str, std::size_t sz) {
64  Id value = UINT64_C(0xcbf29ce484222325);
65 
66  for (std::size_t i = 0; i < sz; ++i) {
67  value ^= static_cast<unsigned char>(str[i]);
68  value *= UINT64_C(0x100000001b3);
69  }
70 
71  return value;
72  }
73 
85  constexpr Id hash(StringRef str) {
86  return hash(str.getData(), str.getSize());
87  }
88 
89  namespace literals {
90 
104  constexpr gf::Id operator"" _id(const char *str, std::size_t sz) {
105  return gf::hash(str, sz);
106  }
107 
108  }
109 
110 #ifndef DOXYGEN_SHOULD_SKIP_THIS
111 }
112 #endif
113 }
114 
115 #endif // GF_ID_H
constexpr const char * getData() const noexcept
Get a pointer to the string.
Definition: StringRef.h:127
uint64_t Id
An identifier.
Definition: Id.h:39
constexpr Id hash(const char *str, std::size_t sz)
Get an identifier from a string.
Definition: Id.h:63
The namespace for gf classes.
Definition: Action.h:35
A constant reference to a string and its size.
Definition: StringRef.h:41
constexpr Id InvalidId
The invalid id (which is 0)
Definition: Id.h:45
constexpr std::size_t getSize() const noexcept
Get the size of the string.
Definition: StringRef.h:136