Gamedev Framework (gf)  0.8.0
A C++14 framework for 2D games
StringRef.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016-2018 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_STRING_REF_H
22 #define GF_STRING_REF_H
23 
24 #include <cstring>
25 #include <string>
26 
27 namespace gf {
28 #ifndef DOXYGEN_SHOULD_SKIP_THIS
29 inline namespace v1 {
30 #endif
31 
41  class StringRef {
42  public:
48  constexpr StringRef()
49  : m_data(nullptr)
50  , m_size(0)
51  {
52 
53  }
54 
60  constexpr StringRef(std::nullptr_t)
61  : m_data(nullptr)
62  , m_size(0)
63  {
64 
65  }
66 
73  constexpr StringRef(const char *str, std::size_t size)
74  : m_data(str)
75  , m_size(size)
76  {
77 
78  }
79 
87  StringRef(const char *str)
88  : m_data(str)
89  , m_size(std::strlen(str))
90  {
91 
92  }
93 
99  StringRef(const std::string& str)
100  : m_data(str.data())
101  , m_size(str.size())
102  {
103 
104  }
105 
111  constexpr const char *getData() const noexcept {
112  return m_data;
113  }
114 
120  constexpr std::size_t getSize() const noexcept {
121  return m_size;
122  }
123 
131  constexpr bool isEmpty() const noexcept {
132  return m_size == 0;
133  }
134 
142  constexpr const char *begin() const noexcept {
143  return m_data;
144  }
145 
153  constexpr const char *end() const noexcept {
154  return m_data + m_size;
155  }
156 
165  constexpr char operator[](std::size_t index) const {
166  return m_data[index];
167  }
168 
174  std::string toString() const {
175  if (m_size == 0 || m_data == nullptr) {
176  return "";
177  }
178 
179  return std::string(m_data, m_size);
180  }
181 
182  private:
183  const char *m_data;
184  std::size_t m_size;
185  };
186 
187 
188 #ifndef DOXYGEN_SHOULD_SKIP_THIS
189 }
190 #endif
191 }
192 
193 #endif // GF_STRING_REF_H
constexpr StringRef()
Default constructor.
Definition: StringRef.h:48
StringRef(const std::string &str)
Constructor from a std::string
Definition: StringRef.h:99
constexpr const char * getData() const noexcept
Get a pointer to the string.
Definition: StringRef.h:111
constexpr bool isEmpty() const noexcept
Check if the string is empty.
Definition: StringRef.h:131
STL namespace.
The namespace for gf classes.
Definition: Action.h:34
constexpr StringRef(std::nullptr_t)
Null constructor.
Definition: StringRef.h:60
constexpr const char * begin() const noexcept
Get an iterator to the beginning of the string.
Definition: StringRef.h:142
constexpr const char * end() const noexcept
Get an iterator past the end of the string.
Definition: StringRef.h:153
std::string toString() const
Get a std::string.
Definition: StringRef.h:174
A constant reference to a string and its size.
Definition: StringRef.h:41
constexpr char operator[](std::size_t index) const
Get a character at a given index.
Definition: StringRef.h:165
constexpr std::size_t getSize() const noexcept
Get the size of the string.
Definition: StringRef.h:120
StringRef(const char *str)
Constructor from a null-terminated string.
Definition: StringRef.h:87
constexpr StringRef(const char *str, std::size_t size)
Constructor from a pointer and a size.
Definition: StringRef.h:73