2023-05-11 21:30:58 +02:00
|
|
|
/*
|
|
|
|
* This file is part of OpenTTD.
|
|
|
|
* 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.
|
|
|
|
* 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.
|
|
|
|
* 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/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** @file strings_interal.h Types and functions related to the internal workings of formatting OpenTTD's strings. */
|
|
|
|
|
|
|
|
#ifndef STRINGS_INTERNAL_H
|
|
|
|
#define STRINGS_INTERNAL_H
|
|
|
|
|
2023-05-18 18:33:18 +02:00
|
|
|
#include "strings_func.h"
|
|
|
|
|
2023-05-11 21:30:58 +02:00
|
|
|
/**
|
|
|
|
* Equivalent to the std::back_insert_iterator in function, with some
|
|
|
|
* convenience helpers for string concatenation.
|
|
|
|
*/
|
|
|
|
class StringBuilder {
|
2023-06-05 16:49:18 +02:00
|
|
|
std::string *string;
|
2023-05-11 21:30:58 +02:00
|
|
|
|
|
|
|
public:
|
|
|
|
/* Required type for this to be an output_iterator; mimics std::back_insert_iterator. */
|
|
|
|
using value_type = void;
|
|
|
|
using difference_type = void;
|
|
|
|
using iterator_category = std::output_iterator_tag;
|
|
|
|
using pointer = void;
|
|
|
|
using reference = void;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create the builder of an external buffer.
|
|
|
|
* @param start The start location to write to.
|
|
|
|
* @param last The last location to write to.
|
|
|
|
*/
|
2023-06-05 16:49:18 +02:00
|
|
|
StringBuilder(std::string &string) : string(&string) {}
|
2023-05-11 21:30:58 +02:00
|
|
|
|
|
|
|
/* Required operators for this to be an output_iterator; mimics std::back_insert_iterator, which has no-ops. */
|
|
|
|
StringBuilder &operator++() { return *this; }
|
|
|
|
StringBuilder operator++(int) { return *this; }
|
|
|
|
StringBuilder &operator*() { return *this; }
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Operator to add a character to the end of the buffer. Like the back
|
|
|
|
* insert iterators this also increases the position of the end of the
|
|
|
|
* buffer.
|
|
|
|
* @param value The character to add.
|
|
|
|
* @return Reference to this inserter.
|
|
|
|
*/
|
|
|
|
StringBuilder &operator=(const char value)
|
|
|
|
{
|
|
|
|
return this->operator+=(value);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Operator to add a character to the end of the buffer.
|
|
|
|
* @param value The character to add.
|
|
|
|
* @return Reference to this inserter.
|
|
|
|
*/
|
|
|
|
StringBuilder &operator+=(const char value)
|
|
|
|
{
|
2023-06-05 16:49:18 +02:00
|
|
|
this->string->push_back(value);
|
2023-05-11 21:30:58 +02:00
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Operator to append the given string to the output buffer.
|
|
|
|
* @param str The string to add.
|
|
|
|
* @return Reference to this inserter.
|
|
|
|
*/
|
2023-06-05 16:49:18 +02:00
|
|
|
StringBuilder &operator+=(std::string_view str)
|
2023-05-11 21:30:58 +02:00
|
|
|
{
|
2023-06-05 16:49:18 +02:00
|
|
|
*this->string += str;
|
2023-05-11 21:30:58 +02:00
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Encode the given Utf8 character into the output buffer.
|
|
|
|
* @param c The character to encode.
|
|
|
|
*/
|
2023-06-05 16:52:42 +02:00
|
|
|
void Utf8Encode(WChar c)
|
2023-05-11 21:30:58 +02:00
|
|
|
{
|
2023-06-05 16:49:18 +02:00
|
|
|
auto iterator = std::back_inserter(*this->string);
|
|
|
|
::Utf8Encode(iterator, c);
|
2023-05-11 21:30:58 +02:00
|
|
|
}
|
|
|
|
|
2023-05-11 21:30:58 +02:00
|
|
|
/**
|
|
|
|
* Remove the given amount of characters from the back of the string.
|
|
|
|
* @param amount The amount of characters to remove.
|
2023-06-05 16:49:18 +02:00
|
|
|
* @return true iff there was enough space and the character got added.
|
2023-05-11 21:30:58 +02:00
|
|
|
*/
|
|
|
|
void RemoveElementsFromBack(size_t amount)
|
|
|
|
{
|
2023-06-05 16:49:18 +02:00
|
|
|
this->string->erase(this->string->size() - std::min(amount, this->string->size()));
|
2023-05-11 21:30:58 +02:00
|
|
|
}
|
|
|
|
|
2023-05-18 17:25:35 +02:00
|
|
|
/**
|
2023-05-11 21:30:58 +02:00
|
|
|
* Get the current index in the string.
|
|
|
|
* @return The index.
|
|
|
|
*/
|
|
|
|
size_t CurrentIndex()
|
|
|
|
{
|
2023-06-05 16:49:18 +02:00
|
|
|
return this->string->size();
|
2023-05-11 21:30:58 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the reference to the character at the given index.
|
|
|
|
* @return The reference to the character.
|
2023-05-18 17:25:35 +02:00
|
|
|
*/
|
2023-05-11 21:30:58 +02:00
|
|
|
char &operator[](size_t index)
|
2023-05-18 17:25:35 +02:00
|
|
|
{
|
2023-06-05 16:49:18 +02:00
|
|
|
return (*this->string)[index];
|
2023-05-18 17:25:35 +02:00
|
|
|
}
|
2023-05-11 21:30:58 +02:00
|
|
|
};
|
|
|
|
|
2023-05-18 18:33:18 +02:00
|
|
|
void GetStringWithArgs(StringBuilder &builder, StringID string, StringParameters *args, uint case_index = 0, bool game_script = false);
|
|
|
|
|
|
|
|
/* Do not leak the StringBuilder to everywhere. */
|
2023-05-11 21:30:58 +02:00
|
|
|
void GenerateTownNameString(StringBuilder &builder, size_t lang, uint32_t seed);
|
2023-05-18 18:33:18 +02:00
|
|
|
void GetTownName(StringBuilder &builder, const struct Town *t);
|
|
|
|
void GRFTownNameGenerate(StringBuilder &builder, uint32 grfid, uint16 gen, uint32 seed);
|
|
|
|
|
2023-05-11 21:30:58 +02:00
|
|
|
#endif /* STRINGS_INTERNAL_H */
|