10 #ifndef STRINGS_INTERNAL_H
11 #define STRINGS_INTERNAL_H
47 void SetTypeOfNextParameter(char32_t type) { this->next_type = type; }
81 this->offset += advance;
82 assert(this->offset <= this->
parameters.size());
95 const uint64_t *data = std::get_if<uint64_t>(¶m.data);
96 if (data !=
nullptr)
return static_cast<T
>(*data);
97 throw std::out_of_range(
"Attempt to read string parameter as integer");
109 const std::string *data = std::get_if<std::string>(¶m.data);
110 if (data !=
nullptr)
return data->c_str();
111 throw std::out_of_range(
"Attempt to read integer parameter as string");
142 return this->parameters.size() - this->
offset;
149 return this->parameters[
offset].type;
152 void SetParam(
size_t n,
const StringParameterData &v)
155 this->parameters[n].data = v;
158 void SetParam(
size_t n, uint64_t v)
161 this->parameters[n].data = v;
164 template <typename T, std::enable_if_t<std::is_base_of<StrongTypedefBase, T>::value,
int> = 0>
165 void SetParam(
size_t n, T v)
167 SetParam(n, v.base());
170 void SetParam(
size_t n,
const char *str)
173 this->parameters[n].data = str;
176 void SetParam(
size_t n,
const std::string &str) { this->SetParam(n, str.c_str()); }
178 void SetParam(
size_t n, std::string &&str)
181 this->parameters[n].data = std::move(str);
184 const StringParameterData &GetParam(
size_t n)
const
187 return this->parameters[n].data;
202 this->parameters = std::span(
params.data(),
params.size());
207 *
this = std::move(other);
212 this->offset = other.
offset;
213 this->next_type = other.next_type;
214 this->
params = std::move(other.params);
215 this->parameters = std::span(
params.data(),
params.size());
229 template <
typename... Args>
230 static auto MakeParameters(
const Args&... args)
234 (parameters.SetParam(index++, std::forward<const Args&>(args)), ...);
247 using value_type = void;
248 using difference_type = void;
249 using iterator_category = std::output_iterator_tag;
250 using pointer = void;
251 using reference = void;
283 this->
string->push_back(value);
294 *this->
string += str;
304 auto iterator = std::back_inserter(*this->
string);
314 this->
string->erase(this->string->size() - std::min(amount, this->string->size()));
323 return this->
string->size();
332 return (*this->
string)[index];
342 void GRFTownNameGenerate(
StringBuilder &builder, uint32_t grfid, uint16_t gen, uint32_t seed);
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.
const StringParameter & GetNextParameterReference()
Get the next parameter from our parameters.
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 ¶meters, 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.
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
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'.
static void GetTownName(StringBuilder &builder, const TownNameParams *par, uint32_t townnameparts)
Fills builder with specified town name.
void GenerateTownNameString(StringBuilder &builder, size_t lang, uint32_t seed)
Generates town name from given seed.