OpenTTD Source  20241125-master-g5b02f51e17
strings_internal.h
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #ifndef STRINGS_INTERNAL_H
11 #define STRINGS_INTERNAL_H
12 
13 #include "strings_func.h"
14 #include "string_func.h"
15 
18  StringParameterData data;
19  char32_t type;
20 };
21 
23 protected:
24  StringParameters *parent = nullptr;
25  std::span<StringParameter> parameters = {};
26 
27  size_t offset = 0;
28  char32_t next_type = 0;
29 
30  StringParameters(std::span<StringParameter> parameters = {}) :
32  {}
33 
35 
36 public:
42  parent(&parent),
43  parameters(parent.parameters.subspan(parent.offset, size))
44  {}
45 
46  void PrepareForNextRun();
47  void SetTypeOfNextParameter(char32_t type) { this->next_type = type; }
48 
54  size_t GetOffset() { return this->offset; }
55 
61  void SetOffset(size_t offset)
62  {
63  /*
64  * The offset must be fewer than the number of parameters when it is
65  * being set. Unless restoring a backup, then the original value is
66  * correct as well as long as the offset was not changed. In other
67  * words, when the offset was already at the end of the parameters and
68  * the string did not consume any parameters.
69  */
70  assert(offset < this->parameters.size() || this->offset == offset);
71  this->offset = offset;
72  }
73 
79  void AdvanceOffset(size_t advance)
80  {
81  this->offset += advance;
82  assert(this->offset <= this->parameters.size());
83  }
84 
91  template <typename T>
93  {
94  struct visitor {
95  uint64_t operator()(const uint64_t &arg) { return arg; }
96  uint64_t operator()(const std::string &) { throw std::out_of_range("Attempt to read string parameter as integer"); }
97  };
98 
99  const auto &param = GetNextParameterReference();
100  return static_cast<T>(std::visit(visitor{}, param.data));
101  }
102 
110  {
111  struct visitor {
112  const char *operator()(const uint64_t &) { throw std::out_of_range("Attempt to read integer parameter as string"); }
113  const char *operator()(const std::string &arg) { return arg.c_str(); }
114  };
115 
116  const auto &param = GetNextParameterReference();
117  return std::visit(visitor{}, param.data);
118  }
119 
129 
141  {
142  return StringParameters(this->parameters.subspan(offset, this->parameters.size() - offset));
143  }
144 
146  size_t GetDataLeft() const
147  {
148  return this->parameters.size() - this->offset;
149  }
150 
152  char32_t GetTypeAtOffset(size_t offset) const
153  {
154  assert(offset < this->parameters.size());
155  return this->parameters[offset].type;
156  }
157 
158  void SetParam(size_t n, const StringParameterData &v)
159  {
160  assert(n < this->parameters.size());
161  this->parameters[n].data = v;
162  }
163 
164  void SetParam(size_t n, uint64_t v)
165  {
166  assert(n < this->parameters.size());
167  this->parameters[n].data = v;
168  }
169 
170  template <typename T, std::enable_if_t<std::is_base_of<StrongTypedefBase, T>::value, int> = 0>
171  void SetParam(size_t n, T v)
172  {
173  SetParam(n, v.base());
174  }
175 
176  void SetParam(size_t n, const char *str)
177  {
178  assert(n < this->parameters.size());
179  this->parameters[n].data = str;
180  }
181 
182  void SetParam(size_t n, const std::string &str) { this->SetParam(n, str.c_str()); }
183 
184  void SetParam(size_t n, std::string &&str)
185  {
186  assert(n < this->parameters.size());
187  this->parameters[n].data = std::move(str);
188  }
189 
190  const StringParameterData &GetParam(size_t n) const
191  {
192  assert(n < this->parameters.size());
193  return this->parameters[n].data;
194  }
195 };
196 
201 template <size_t N>
203  std::array<StringParameter, N> params{};
204 
205 public:
207  {
208  this->parameters = std::span(params.data(), params.size());
209  }
210 
212  {
213  *this = std::move(other);
214  }
215 
216  ArrayStringParameters& operator=(ArrayStringParameters &&other) noexcept
217  {
218  this->offset = other.offset;
219  this->next_type = other.next_type;
220  this->params = std::move(other.params);
221  this->parameters = std::span(params.data(), params.size());
222  return *this;
223  }
224 
225  ArrayStringParameters(const ArrayStringParameters &other) = delete;
226  ArrayStringParameters& operator=(const ArrayStringParameters &other) = delete;
227 };
228 
235 template <typename... Args>
236 static auto MakeParameters(const Args&... args)
237 {
238  ArrayStringParameters<sizeof...(args)> parameters;
239  size_t index = 0;
240  (parameters.SetParam(index++, std::forward<const Args&>(args)), ...);
241  return parameters;
242 }
243 
249  std::string *string;
250 
251 public:
252  /* Required type for this to be an output_iterator; mimics std::back_insert_iterator. */
253  using value_type = void;
254  using difference_type = void;
255  using iterator_category = std::output_iterator_tag;
256  using pointer = void;
257  using reference = void;
258 
263  StringBuilder(std::string &string) : string(&string) {}
264 
265  /* Required operators for this to be an output_iterator; mimics std::back_insert_iterator, which has no-ops. */
266  StringBuilder &operator++() { return *this; }
267  StringBuilder operator++(int) { return *this; }
268  StringBuilder &operator*() { return *this; }
269 
277  StringBuilder &operator=(const char value)
278  {
279  return this->operator+=(value);
280  }
281 
287  StringBuilder &operator+=(const char value)
288  {
289  this->string->push_back(value);
290  return *this;
291  }
292 
298  StringBuilder &operator+=(std::string_view str)
299  {
300  *this->string += str;
301  return *this;
302  }
303 
308  void Utf8Encode(char32_t c)
309  {
310  auto iterator = std::back_inserter(*this->string);
311  ::Utf8Encode(iterator, c);
312  }
313 
318  void RemoveElementsFromBack(size_t amount)
319  {
320  this->string->erase(this->string->size() - std::min(amount, this->string->size()));
321  }
322 
327  size_t CurrentIndex()
328  {
329  return this->string->size();
330  }
331 
336  char &operator[](size_t index)
337  {
338  return (*this->string)[index];
339  }
340 };
341 
342 void GetStringWithArgs(StringBuilder &builder, StringID string, StringParameters &args, uint case_index = 0, bool game_script = false);
343 std::string GetStringWithArgs(StringID string, StringParameters &args);
344 
345 /* Do not leak the StringBuilder to everywhere. */
346 void GenerateTownNameString(StringBuilder &builder, size_t lang, uint32_t seed);
347 void GetTownName(StringBuilder &builder, const struct Town *t);
348 void GRFTownNameGenerate(StringBuilder &builder, uint32_t grfid, uint16_t gen, uint32_t seed);
349 
350 uint RemapNewGRFStringControlCode(uint scc, const char **str, StringParameters &parameters, bool modify_parameters);
351 
352 #endif /* STRINGS_INTERNAL_H */
Extension of StringParameters with its own statically sized buffer for the parameters.
std::array< StringParameter, N > params
The actual parameters.
Equivalent to the std::back_insert_iterator in function, with some convenience helpers for string con...
void RemoveElementsFromBack(size_t amount)
Remove the given amount of characters from the back of the string.
StringBuilder & operator+=(const char value)
Operator to add a character to the end of the buffer.
StringBuilder & operator=(const char value)
Operator to add a character to the end of the buffer.
StringBuilder & operator+=(std::string_view str)
Operator to append the given string to the output buffer.
void Utf8Encode(char32_t c)
Encode the given Utf8 character into the output buffer.
size_t CurrentIndex()
Get the current index in the string.
StringBuilder(std::string &string)
Create the builder of an external buffer.
char & operator[](size_t index)
Get the reference to the character at the given index.
StringParameters * parent
If not nullptr, this instance references data from this parent instance.
void SetOffset(size_t offset)
Set the offset within the string from where to return the next result of GetInt64 or GetInt32.
StringParameters GetRemainingParameters()
Get a new instance of StringParameters that is a "range" into the remaining existing parameters.
std::span< StringParameter > parameters
Array with the actual parameters.
void PrepareForNextRun()
Prepare the string parameters for the next formatting run.
Definition: strings.cpp:68
const StringParameter & GetNextParameterReference()
Get the next parameter from our parameters.
Definition: strings.cpp:81
void AdvanceOffset(size_t advance)
Advance the offset within the string from where to return the next result of GetInt64 or GetInt32.
const char * GetNextParameterString()
Get the next string parameter from our parameters.
size_t offset
Current offset in the parameters span.
StringParameters(StringParameters &parent, size_t size)
Create a new StringParameters instance that can reference part of the data of the given parent instan...
T GetNextParameter()
Get the next parameter from our parameters.
char32_t next_type
The type of the next data that is retrieved.
size_t GetOffset()
Get the current offset, so it can be backed up for certain processing steps, or be used to offset the...
size_t GetDataLeft() const
Return the amount of elements which can still be read.
char32_t GetTypeAtOffset(size_t offset) const
Get the type of a specific element.
StringParameters GetRemainingParameters(size_t offset)
Get a new instance of StringParameters that is a "range" into the remaining existing parameters from ...
uint RemapNewGRFStringControlCode(uint scc, const char **str, StringParameters &parameters, bool modify_parameters)
FormatString for NewGRF specific "magic" string control codes.
Functions related to low-level strings.
void GetStringWithArgs(StringBuilder &builder, StringID string, StringParameters &args, uint case_index, bool game_script)
Get a parsed string with most special stringcodes replaced by the string parameters.
Definition: strings.cpp:243
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
The data required to format and validate a single parameter of a string.
StringParameterData data
The data of the parameter.
char32_t type
The StringControlCode to interpret this data with when it's the first parameter, otherwise '\0'.
Town data structure.
Definition: town.h:54
static void GetTownName(StringBuilder &builder, const TownNameParams *par, uint32_t townnameparts)
Fills builder with specified town name.
Definition: townname.cpp:48
void GenerateTownNameString(StringBuilder &builder, size_t lang, uint32_t seed)
Generates town name from given seed.
Definition: townname.cpp:1013