mirror of
https://github.com/JGRennison/OpenTTD-patches.git
synced 2024-10-31 15:20:10 +00:00
88670a230f
# Conflicts: # src/articulated_vehicles.cpp # src/articulated_vehicles.h # src/base_media_base.h # src/base_media_func.h # src/build_vehicle_gui.cpp # src/dock_gui.cpp # src/main_gui.cpp # src/music_gui.cpp # src/network/network_chat_gui.cpp # src/network/network_content.cpp # src/newgrf.cpp # src/newgrf_roadstop.cpp # src/os/windows/string_uniscribe.h # src/os/windows/win32.cpp # src/rail_gui.cpp # src/road.cpp # src/road_gui.cpp # src/settings.cpp # src/settings_gui.cpp # src/smallmap_gui.cpp # src/strings.cpp # src/terraform_gui.cpp # src/tests/test_script_admin.cpp # src/tests/test_window_desc.cpp # src/timer/timer_game_calendar.h # src/vehicle.cpp # src/vehicle_base.h # src/viewport.cpp # src/widget_type.h # src/window.cpp # src/window_gui.h
1129 lines
37 KiB
C++
1129 lines
37 KiB
C++
/*
|
|
* 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 newgrf_text.cpp
|
|
* Implementation of Action 04 "universal holder" structure and functions.
|
|
* This file implements a linked-lists of strings,
|
|
* holding everything that the newgrf action 04 will send over to OpenTTD.
|
|
* One of the biggest problems is that Dynamic lang Array uses ISO codes
|
|
* as way to identifying current user lang, while newgrf uses bit shift codes
|
|
* not related to ISO. So equivalence functionality had to be set.
|
|
*/
|
|
|
|
#include "stdafx.h"
|
|
|
|
#include <array>
|
|
|
|
#include "newgrf.h"
|
|
#include "strings_func.h"
|
|
#include "newgrf_storage.h"
|
|
#include "newgrf_text.h"
|
|
#include "newgrf_cargo.h"
|
|
#include "newgrf_config.h"
|
|
#include "string_func.h"
|
|
#include "date_type.h"
|
|
#include "debug.h"
|
|
#include "core/alloc_type.hpp"
|
|
#include "language.h"
|
|
#include <sstream>
|
|
#include <map>
|
|
|
|
#include "table/strings.h"
|
|
#include "table/control_codes.h"
|
|
|
|
#include <array>
|
|
#include <utility>
|
|
|
|
#include "safeguards.h"
|
|
|
|
/**
|
|
* Explains the newgrf shift bit positioning.
|
|
* the grf base will not be used in order to find the string, but rather for
|
|
* jumping from standard langID scheme to the new one.
|
|
*/
|
|
enum GRFBaseLanguages {
|
|
GRFLB_AMERICAN = 0x01,
|
|
GRFLB_ENGLISH = 0x02,
|
|
GRFLB_GERMAN = 0x04,
|
|
GRFLB_FRENCH = 0x08,
|
|
GRFLB_SPANISH = 0x10,
|
|
GRFLB_GENERIC = 0x80,
|
|
};
|
|
|
|
enum GRFExtendedLanguages {
|
|
GRFLX_AMERICAN = 0x00,
|
|
GRFLX_ENGLISH = 0x01,
|
|
GRFLX_GERMAN = 0x02,
|
|
GRFLX_FRENCH = 0x03,
|
|
GRFLX_SPANISH = 0x04,
|
|
GRFLX_UNSPECIFIED = 0x7F,
|
|
};
|
|
|
|
|
|
/**
|
|
* Holder of the above structure.
|
|
* Putting both grfid and stringid together allows us to avoid duplicates,
|
|
* since it is NOT SUPPOSED to happen.
|
|
*/
|
|
struct GRFTextEntry {
|
|
GRFTextList textholder;
|
|
StringID def_string;
|
|
uint32 grfid;
|
|
uint16 stringid;
|
|
};
|
|
|
|
|
|
static std::vector<GRFTextEntry> _grf_text;
|
|
static byte _currentLangID = GRFLX_ENGLISH; ///< by default, english is used.
|
|
|
|
/**
|
|
* Get the mapping from the NewGRF supplied ID to OpenTTD's internal ID.
|
|
* @param newgrf_id The NewGRF ID to map.
|
|
* @param gender Whether to map genders or cases.
|
|
* @return The, to OpenTTD's internal ID, mapped index, or -1 if there is no mapping.
|
|
*/
|
|
int LanguageMap::GetMapping(int newgrf_id, bool gender) const
|
|
{
|
|
const std::vector<Mapping> &map = gender ? this->gender_map : this->case_map;
|
|
for (const Mapping &m : map) {
|
|
if (m.newgrf_id == newgrf_id) return m.openttd_id;
|
|
}
|
|
return -1;
|
|
}
|
|
|
|
/**
|
|
* Get the mapping from OpenTTD's internal ID to the NewGRF supplied ID.
|
|
* @param openttd_id The OpenTTD ID to map.
|
|
* @param gender Whether to map genders or cases.
|
|
* @return The, to the NewGRF supplied ID, mapped index, or -1 if there is no mapping.
|
|
*/
|
|
int LanguageMap::GetReverseMapping(int openttd_id, bool gender) const
|
|
{
|
|
const std::vector<Mapping> &map = gender ? this->gender_map : this->case_map;
|
|
for (const Mapping &m : map) {
|
|
if (m.openttd_id == openttd_id) return m.newgrf_id;
|
|
}
|
|
return -1;
|
|
}
|
|
|
|
/** Helper structure for mapping choice lists. */
|
|
struct UnmappedChoiceList {
|
|
/**
|
|
* Initialise the mapping.
|
|
* @param type The type of mapping.
|
|
* @param offset The offset to get the plural/gender from.
|
|
*/
|
|
UnmappedChoiceList(StringControlCode type, int offset) :
|
|
type(type), offset(offset)
|
|
{
|
|
}
|
|
|
|
StringControlCode type; ///< The type of choice list.
|
|
int offset; ///< The offset for the plural/gender form.
|
|
|
|
/** Mapping of NewGRF supplied ID to the different strings in the choice list. */
|
|
std::map<byte, std::stringstream> strings;
|
|
|
|
/**
|
|
* Flush this choice list into the destination string.
|
|
* @param lm The current language mapping.
|
|
* @param dest Target to write to.
|
|
*/
|
|
void Flush(const LanguageMap *lm, std::ostringstream &dest)
|
|
{
|
|
if (this->strings.find(0) == this->strings.end()) {
|
|
/* In case of a (broken) NewGRF without a default,
|
|
* assume an empty string. */
|
|
grfmsg(1, "choice list misses default value");
|
|
this->strings[0] = std::stringstream();
|
|
}
|
|
|
|
std::ostreambuf_iterator<char> d(dest);
|
|
|
|
if (lm == nullptr) {
|
|
/* In case there is no mapping, just ignore everything but the default.
|
|
* A probable cause for this happening is when the language file has
|
|
* been removed by the user and as such no mapping could be made. */
|
|
dest << this->strings[0].rdbuf();
|
|
return;
|
|
}
|
|
|
|
Utf8Encode(d, this->type);
|
|
|
|
if (this->type == SCC_SWITCH_CASE) {
|
|
/*
|
|
* Format for case switch:
|
|
* <NUM CASES> <CASE1> <LEN1> <STRING1> <CASE2> <LEN2> <STRING2> <CASE3> <LEN3> <STRING3> <STRINGDEFAULT>
|
|
* Each LEN is printed using 2 bytes in big endian order.
|
|
*/
|
|
|
|
/* "<NUM CASES>" */
|
|
int count = 0;
|
|
for (uint8 i = 0; i < _current_language->num_cases; i++) {
|
|
/* Count the ones we have a mapped string for. */
|
|
if (this->strings.find(lm->GetReverseMapping(i, false)) != this->strings.end()) count++;
|
|
}
|
|
*d++ = count;
|
|
|
|
for (uint8 i = 0; i < _current_language->num_cases; i++) {
|
|
/* Resolve the string we're looking for. */
|
|
int idx = lm->GetReverseMapping(i, false);
|
|
if (this->strings.find(idx) == this->strings.end()) continue;
|
|
auto str = this->strings[idx].str();
|
|
|
|
/* "<CASEn>" */
|
|
*d++ = i + 1;
|
|
|
|
/* "<LENn>": Limit the length of the string to 0xFFFE to leave space for the '\0'. */
|
|
size_t len = std::min<size_t>(0xFFFE, str.size());
|
|
*d++ = GB(len + 1, 8, 8);
|
|
*d++ = GB(len + 1, 0, 8);
|
|
|
|
/* "<STRINGn>" */
|
|
dest.write(str.c_str(), len);
|
|
*d++ = '\0';
|
|
}
|
|
|
|
/* "<STRINGDEFAULT>" */
|
|
dest << this->strings[0].rdbuf() << '\0';
|
|
} else {
|
|
if (this->type == SCC_PLURAL_LIST) {
|
|
*d++ = lm->plural_form;
|
|
}
|
|
|
|
/*
|
|
* Format for choice list:
|
|
* <OFFSET> <NUM CHOICES> <LENs> <STRINGs>
|
|
*/
|
|
|
|
/* "<OFFSET>" */
|
|
*d++ = this->offset - 0x80;
|
|
|
|
/* "<NUM CHOICES>" */
|
|
int count = (this->type == SCC_GENDER_LIST ? _current_language->num_genders : LANGUAGE_MAX_PLURAL_FORMS);
|
|
*d++ = count;
|
|
|
|
/* "<LENs>" */
|
|
for (int i = 0; i < count; i++) {
|
|
int idx = (this->type == SCC_GENDER_LIST ? lm->GetReverseMapping(i, true) : i + 1);
|
|
const auto &str = this->strings[this->strings.find(idx) != this->strings.end() ? idx : 0].str();
|
|
size_t len = str.size() + 1;
|
|
if (len > 0xFF) grfmsg(1, "choice list string is too long");
|
|
*d++ = GB(len, 0, 8);
|
|
}
|
|
|
|
/* "<STRINGs>" */
|
|
for (int i = 0; i < count; i++) {
|
|
int idx = (this->type == SCC_GENDER_LIST ? lm->GetReverseMapping(i, true) : i + 1);
|
|
const auto &str = this->strings[this->strings.find(idx) != this->strings.end() ? idx : 0].str();
|
|
/* Limit the length of the string we copy to 0xFE. The length is written above
|
|
* as a byte and we need room for the final '\0'. */
|
|
size_t len = std::min<size_t>(0xFE, str.size());
|
|
dest.write(str.c_str(), len);
|
|
*d++ = '\0';
|
|
}
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Translate TTDPatch string codes into something OpenTTD can handle (better).
|
|
* @param grfid The (NewGRF) ID associated with this string
|
|
* @param language_id The (NewGRF) language ID associated with this string.
|
|
* @param allow_newlines Whether newlines are allowed in the string or not.
|
|
* @param str The string to translate.
|
|
* @param byte80 The control code to use as replacement for the 0x80-value.
|
|
* @return The translated string.
|
|
*/
|
|
std::string TranslateTTDPatchCodes(uint32 grfid, uint8 language_id, bool allow_newlines, const std::string &str, StringControlCode byte80)
|
|
{
|
|
/* Empty input string? Nothing to do here. */
|
|
if (str.empty()) return str;
|
|
|
|
std::string::const_iterator src = str.cbegin();
|
|
|
|
/* Is this an unicode string? */
|
|
bool unicode = false;
|
|
WChar marker;
|
|
size_t len = Utf8Decode(&marker, &*src);
|
|
|
|
if (marker == NFO_UTF8_IDENTIFIER) {
|
|
unicode = true;
|
|
src += len;
|
|
}
|
|
|
|
/* Helper variable for a possible (string) mapping. */
|
|
UnmappedChoiceList *mapping = nullptr;
|
|
|
|
std::ostringstream dest;
|
|
std::ostreambuf_iterator<char> d(dest);
|
|
while (src != str.cend()) {
|
|
WChar c;
|
|
|
|
if (unicode && Utf8EncodedCharLen(*src) != 0) {
|
|
c = Utf8Consume(src);
|
|
/* 'Magic' range of control codes. */
|
|
if (GB(c, 8, 8) == 0xE0) {
|
|
c = GB(c, 0, 8);
|
|
} else if (c >= 0x20) {
|
|
if (!IsValidChar(c, CS_ALPHANUMERAL)) c = '?';
|
|
Utf8Encode(d, c);
|
|
continue;
|
|
}
|
|
} else {
|
|
c = (byte)*src++;
|
|
}
|
|
|
|
if (c == '\0') break;
|
|
|
|
switch (c) {
|
|
case 0x01:
|
|
if (*src == '\0') goto string_end;
|
|
Utf8Encode(d, ' ');
|
|
src++;
|
|
break;
|
|
case 0x0A: break;
|
|
case 0x0D:
|
|
if (allow_newlines) {
|
|
*d++ = 0x0A;
|
|
} else {
|
|
grfmsg(1, "Detected newline in string that does not allow one");
|
|
}
|
|
break;
|
|
case 0x0E: Utf8Encode(d, SCC_TINYFONT); break;
|
|
case 0x0F: Utf8Encode(d, SCC_BIGFONT); break;
|
|
case 0x1F:
|
|
if (src[0] == '\0' || src[1] == '\0') goto string_end;
|
|
Utf8Encode(d, ' ');
|
|
src += 2;
|
|
break;
|
|
case 0x7B:
|
|
case 0x7C:
|
|
case 0x7D:
|
|
case 0x7E:
|
|
case 0x7F: Utf8Encode(d, SCC_NEWGRF_PRINT_DWORD_SIGNED + c - 0x7B); break;
|
|
case 0x80: Utf8Encode(d, byte80); break;
|
|
case 0x81:
|
|
{
|
|
if (src[0] == '\0' || src[1] == '\0') goto string_end;
|
|
StringID string;
|
|
string = ((uint8)* src++);
|
|
string |= ((uint8)* src++) << 8;
|
|
Utf8Encode(d, SCC_NEWGRF_STRINL);
|
|
Utf8Encode(d, MapGRFStringID(grfid, string));
|
|
break;
|
|
}
|
|
case 0x82:
|
|
case 0x83:
|
|
case 0x84: Utf8Encode(d, SCC_NEWGRF_PRINT_WORD_DATE_LONG + c - 0x82); break;
|
|
case 0x85: Utf8Encode(d, SCC_NEWGRF_DISCARD_WORD); break;
|
|
case 0x86: Utf8Encode(d, SCC_NEWGRF_ROTATE_TOP_4_WORDS); break;
|
|
case 0x87: Utf8Encode(d, SCC_NEWGRF_PRINT_WORD_VOLUME_LONG); break;
|
|
case 0x88: Utf8Encode(d, SCC_BLUE); break;
|
|
case 0x89: Utf8Encode(d, SCC_SILVER); break;
|
|
case 0x8A: Utf8Encode(d, SCC_GOLD); break;
|
|
case 0x8B: Utf8Encode(d, SCC_RED); break;
|
|
case 0x8C: Utf8Encode(d, SCC_PURPLE); break;
|
|
case 0x8D: Utf8Encode(d, SCC_LTBROWN); break;
|
|
case 0x8E: Utf8Encode(d, SCC_ORANGE); break;
|
|
case 0x8F: Utf8Encode(d, SCC_GREEN); break;
|
|
case 0x90: Utf8Encode(d, SCC_YELLOW); break;
|
|
case 0x91: Utf8Encode(d, SCC_DKGREEN); break;
|
|
case 0x92: Utf8Encode(d, SCC_CREAM); break;
|
|
case 0x93: Utf8Encode(d, SCC_BROWN); break;
|
|
case 0x94: Utf8Encode(d, SCC_WHITE); break;
|
|
case 0x95: Utf8Encode(d, SCC_LTBLUE); break;
|
|
case 0x96: Utf8Encode(d, SCC_GRAY); break;
|
|
case 0x97: Utf8Encode(d, SCC_DKBLUE); break;
|
|
case 0x98: Utf8Encode(d, SCC_BLACK); break;
|
|
case 0x9A:
|
|
{
|
|
int code = *src++;
|
|
switch (code) {
|
|
case 0x00: goto string_end;
|
|
case 0x01: Utf8Encode(d, SCC_NEWGRF_PRINT_QWORD_CURRENCY); break;
|
|
/* 0x02: ignore next colour byte is not supported. It works on the final
|
|
* string and as such hooks into the string drawing routine. At that
|
|
* point many things already happened, such as splitting up of strings
|
|
* when drawn over multiple lines or right-to-left translations, which
|
|
* make the behaviour peculiar, e.g. only happening at specific width
|
|
* of windows. Or we need to add another pass over the string to just
|
|
* support this. As such it is not implemented in OpenTTD. */
|
|
case 0x03:
|
|
{
|
|
if (src[0] == '\0' || src[1] == '\0') goto string_end;
|
|
uint16 tmp = ((uint8)* src++);
|
|
tmp |= ((uint8)* src++) << 8;
|
|
Utf8Encode(d, SCC_NEWGRF_PUSH_WORD);
|
|
Utf8Encode(d, tmp);
|
|
break;
|
|
}
|
|
case 0x04:
|
|
if (src[0] == '\0') goto string_end;
|
|
Utf8Encode(d, SCC_NEWGRF_UNPRINT);
|
|
Utf8Encode(d, *src++);
|
|
break;
|
|
case 0x06: Utf8Encode(d, SCC_NEWGRF_PRINT_BYTE_HEX); break;
|
|
case 0x07: Utf8Encode(d, SCC_NEWGRF_PRINT_WORD_HEX); break;
|
|
case 0x08: Utf8Encode(d, SCC_NEWGRF_PRINT_DWORD_HEX); break;
|
|
/* 0x09, 0x0A are TTDPatch internal use only string codes. */
|
|
case 0x0B: Utf8Encode(d, SCC_NEWGRF_PRINT_QWORD_HEX); break;
|
|
case 0x0C: Utf8Encode(d, SCC_NEWGRF_PRINT_WORD_STATION_NAME); break;
|
|
case 0x0D: Utf8Encode(d, SCC_NEWGRF_PRINT_WORD_WEIGHT_LONG); break;
|
|
case 0x0E:
|
|
case 0x0F:
|
|
{
|
|
if (str[0] == '\0') goto string_end;
|
|
const LanguageMap *lm = LanguageMap::GetLanguageMap(grfid, language_id);
|
|
int index = *src++;
|
|
int mapped = lm != nullptr ? lm->GetMapping(index, code == 0x0E) : -1;
|
|
if (mapped >= 0) {
|
|
Utf8Encode(d, code == 0x0E ? SCC_GENDER_INDEX : SCC_SET_CASE);
|
|
Utf8Encode(d, code == 0x0E ? mapped : mapped + 1);
|
|
}
|
|
break;
|
|
}
|
|
|
|
case 0x10:
|
|
case 0x11:
|
|
if (str[0] == '\0') goto string_end;
|
|
if (mapping == nullptr) {
|
|
if (code == 0x10) src++; // Skip the index
|
|
grfmsg(1, "choice list %s marker found when not expected", code == 0x10 ? "next" : "default");
|
|
break;
|
|
} else {
|
|
int index = (code == 0x10 ? *src++ : 0);
|
|
if (mapping->strings.find(index) != mapping->strings.end()) {
|
|
grfmsg(1, "duplicate choice list string, ignoring");
|
|
} else {
|
|
d = std::ostreambuf_iterator<char>(mapping->strings[index]);
|
|
}
|
|
}
|
|
break;
|
|
|
|
case 0x12:
|
|
if (mapping == nullptr) {
|
|
grfmsg(1, "choice list end marker found when not expected");
|
|
} else {
|
|
/* Now we can start flushing everything and clean everything up. */
|
|
mapping->Flush(LanguageMap::GetLanguageMap(grfid, language_id), dest);
|
|
delete mapping;
|
|
mapping = nullptr;
|
|
|
|
d = std::ostreambuf_iterator<char>(dest);
|
|
}
|
|
break;
|
|
|
|
case 0x13:
|
|
case 0x14:
|
|
case 0x15:
|
|
if (src[0] == '\0') goto string_end;
|
|
if (mapping != nullptr) {
|
|
grfmsg(1, "choice lists can't be stacked, it's going to get messy now...");
|
|
if (code != 0x14) src++;
|
|
} else {
|
|
static const StringControlCode mp[] = { SCC_GENDER_LIST, SCC_SWITCH_CASE, SCC_PLURAL_LIST };
|
|
mapping = new UnmappedChoiceList(mp[code - 0x13], code == 0x14 ? 0 : *src++);
|
|
}
|
|
break;
|
|
|
|
case 0x16:
|
|
case 0x17:
|
|
case 0x18:
|
|
case 0x19:
|
|
case 0x1A:
|
|
case 0x1B:
|
|
case 0x1C:
|
|
case 0x1D:
|
|
case 0x1E:
|
|
Utf8Encode(d, SCC_NEWGRF_PRINT_DWORD_DATE_LONG + code - 0x16);
|
|
break;
|
|
|
|
case 0x1F: Utf8Encode(d, SCC_PUSH_COLOUR); break;
|
|
case 0x20: Utf8Encode(d, SCC_POP_COLOUR); break;
|
|
|
|
case 0x21: Utf8Encode(d, SCC_NEWGRF_PRINT_DWORD_FORCE); break;
|
|
|
|
default:
|
|
grfmsg(1, "missing handler for extended format code");
|
|
break;
|
|
}
|
|
break;
|
|
}
|
|
|
|
case 0x9E: Utf8Encode(d, 0x20AC); break; // Euro
|
|
case 0x9F: Utf8Encode(d, 0x0178); break; // Y with diaeresis
|
|
case 0xA0: Utf8Encode(d, SCC_UP_ARROW); break;
|
|
case 0xAA: Utf8Encode(d, SCC_DOWN_ARROW); break;
|
|
case 0xAC: Utf8Encode(d, SCC_CHECKMARK); break;
|
|
case 0xAD: Utf8Encode(d, SCC_CROSS); break;
|
|
case 0xAF: Utf8Encode(d, SCC_RIGHT_ARROW); break;
|
|
case 0xB4: Utf8Encode(d, SCC_TRAIN); break;
|
|
case 0xB5: Utf8Encode(d, SCC_LORRY); break;
|
|
case 0xB6: Utf8Encode(d, SCC_BUS); break;
|
|
case 0xB7: Utf8Encode(d, SCC_PLANE); break;
|
|
case 0xB8: Utf8Encode(d, SCC_SHIP); break;
|
|
case 0xB9: Utf8Encode(d, SCC_SUPERSCRIPT_M1); break;
|
|
case 0xBC: Utf8Encode(d, SCC_SMALL_UP_ARROW); break;
|
|
case 0xBD: Utf8Encode(d, SCC_SMALL_DOWN_ARROW); break;
|
|
default:
|
|
/* Validate any unhandled character */
|
|
if (!IsValidChar(c, CS_ALPHANUMERAL)) c = '?';
|
|
Utf8Encode(d, c);
|
|
break;
|
|
}
|
|
}
|
|
|
|
string_end:
|
|
if (mapping != nullptr) {
|
|
grfmsg(1, "choice list was incomplete, the whole list is ignored");
|
|
delete mapping;
|
|
}
|
|
|
|
return dest.str();
|
|
}
|
|
|
|
/**
|
|
* Add a new text to a GRFText list.
|
|
* @param list The list where the text should be added to.
|
|
* @param langid The The language of the new text.
|
|
* @param text_to_add The text to add to the list.
|
|
*/
|
|
static void AddGRFTextToList(GRFTextList &list, byte langid, const std::string &text_to_add)
|
|
{
|
|
/* Loop through all languages and see if we can replace a string */
|
|
for (auto &text : list) {
|
|
if (text.langid == langid) {
|
|
text.text = text_to_add;
|
|
return;
|
|
}
|
|
}
|
|
|
|
/* If a string wasn't replaced, then we must append the new string */
|
|
list.push_back(GRFText{ langid, text_to_add });
|
|
}
|
|
|
|
/**
|
|
* Add a string to a GRFText list.
|
|
* @param list The list where the text should be added to.
|
|
* @param langid The language of the new text.
|
|
* @param grfid The grfid where this string is defined.
|
|
* @param allow_newlines Whether newlines are allowed in this string.
|
|
* @param text_to_add The text to add to the list.
|
|
* @note All text-codes will be translated.
|
|
*/
|
|
void AddGRFTextToList(GRFTextList &list, byte langid, uint32 grfid, bool allow_newlines, const char *text_to_add)
|
|
{
|
|
AddGRFTextToList(list, langid, TranslateTTDPatchCodes(grfid, langid, allow_newlines, text_to_add));
|
|
}
|
|
|
|
/**
|
|
* Add a string to a GRFText list.
|
|
* @param list The list where the text should be added to.
|
|
* @param langid The language of the new text.
|
|
* @param grfid The grfid where this string is defined.
|
|
* @param allow_newlines Whether newlines are allowed in this string.
|
|
* @param text_to_add The text to add to the list.
|
|
* @note All text-codes will be translated.
|
|
*/
|
|
void AddGRFTextToList(GRFTextWrapper &list, byte langid, uint32 grfid, bool allow_newlines, const char *text_to_add)
|
|
{
|
|
if (!list) list.reset(new GRFTextList());
|
|
AddGRFTextToList(*list, langid, grfid, allow_newlines, text_to_add);
|
|
}
|
|
|
|
/**
|
|
* Add a GRFText to a GRFText list. The text should not contain any text-codes.
|
|
* The text will be added as a 'default language'-text.
|
|
* @param list The list where the text should be added to.
|
|
* @param text_to_add The text to add to the list.
|
|
*/
|
|
void AddGRFTextToList(GRFTextWrapper &list, const std::string &text_to_add)
|
|
{
|
|
if (!list) list.reset(new GRFTextList());
|
|
AddGRFTextToList(*list, GRFLX_UNSPECIFIED, text_to_add);
|
|
}
|
|
|
|
/**
|
|
* Add the new read string into our structure.
|
|
*/
|
|
StringID AddGRFString(uint32 grfid, uint16 stringid, byte langid_to_add, bool new_scheme, bool allow_newlines, const char *text_to_add, StringID def_string)
|
|
{
|
|
/* When working with the old language scheme (grf_version is less than 7) and
|
|
* English or American is among the set bits, simply add it as English in
|
|
* the new scheme, i.e. as langid = 1.
|
|
* If English is set, it is pretty safe to assume the translations are not
|
|
* actually translated.
|
|
*/
|
|
if (!new_scheme) {
|
|
if (langid_to_add & (GRFLB_AMERICAN | GRFLB_ENGLISH)) {
|
|
langid_to_add = GRFLX_ENGLISH;
|
|
} else {
|
|
StringID ret = STR_EMPTY;
|
|
if (langid_to_add & GRFLB_GERMAN) ret = AddGRFString(grfid, stringid, GRFLX_GERMAN, true, allow_newlines, text_to_add, def_string);
|
|
if (langid_to_add & GRFLB_FRENCH) ret = AddGRFString(grfid, stringid, GRFLX_FRENCH, true, allow_newlines, text_to_add, def_string);
|
|
if (langid_to_add & GRFLB_SPANISH) ret = AddGRFString(grfid, stringid, GRFLX_SPANISH, true, allow_newlines, text_to_add, def_string);
|
|
return ret;
|
|
}
|
|
}
|
|
|
|
uint id;
|
|
extern GRFFile *GetFileByGRFIDExpectCurrent(uint32 grfid);
|
|
GRFFile *grf = GetFileByGRFIDExpectCurrent(grfid);
|
|
if (grf == nullptr) return STR_EMPTY;
|
|
|
|
auto iter = grf->string_map.lower_bound(stringid);
|
|
if (iter != grf->string_map.end() && iter->first == stringid) {
|
|
/* Found */
|
|
id = iter->second;
|
|
} else {
|
|
/* Too many strings allocated, return empty */
|
|
if (_grf_text.size() == TAB_SIZE_NEWGRF) {
|
|
_grf_bug_too_many_strings = true;
|
|
return STR_EMPTY;
|
|
}
|
|
|
|
/* Allocate new ID */
|
|
id = (uint)_grf_text.size();
|
|
GRFTextEntry &entry = _grf_text.emplace_back();
|
|
entry.grfid = grfid;
|
|
entry.stringid = stringid;
|
|
entry.def_string = def_string;
|
|
|
|
grf->string_map.insert(iter, std::make_pair(stringid, id));
|
|
}
|
|
|
|
std::string newtext = TranslateTTDPatchCodes(grfid, langid_to_add, allow_newlines, text_to_add);
|
|
AddGRFTextToList(_grf_text[id].textholder, langid_to_add, newtext);
|
|
|
|
grfmsg(3, "Added 0x%X: grfid %08X string 0x%X lang 0x%X string '%s' (%X)", id, grfid, stringid, langid_to_add, newtext.c_str(), MakeStringID(TEXT_TAB_NEWGRF_START, id));
|
|
|
|
return MakeStringID(TEXT_TAB_NEWGRF_START, id);
|
|
}
|
|
|
|
/**
|
|
* Returns the index for this stringid associated with its grfID
|
|
*/
|
|
StringID GetGRFStringID(uint32 grfid, StringID stringid)
|
|
{
|
|
if (stringid > UINT16_MAX) return STR_UNDEFINED;
|
|
|
|
extern GRFFile *GetFileByGRFIDExpectCurrent(uint32 grfid);
|
|
GRFFile *grf = GetFileByGRFIDExpectCurrent(grfid);
|
|
if (unlikely(grf == nullptr)) {
|
|
for (uint id = 0; id < (uint)_grf_text.size(); id++) {
|
|
if (_grf_text[id].grfid == grfid && _grf_text[id].stringid == stringid) {
|
|
return MakeStringID(TEXT_TAB_NEWGRF_START, id);
|
|
}
|
|
}
|
|
} else {
|
|
auto iter = grf->string_map.find(stringid);
|
|
if (iter != grf->string_map.end()) return MakeStringID(TEXT_TAB_NEWGRF_START, iter->second);
|
|
}
|
|
|
|
return STR_UNDEFINED;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get a C-string from a GRFText-list. If there is a translation for the
|
|
* current language it is returned, otherwise the default translation
|
|
* is returned. If there is neither a default nor a translation for the
|
|
* current language nullptr is returned.
|
|
* @param text_list The GRFTextList to get the string from.
|
|
*/
|
|
const char *GetGRFStringFromGRFText(const GRFTextList &text_list)
|
|
{
|
|
const char *default_text = nullptr;
|
|
|
|
/* Search the list of lang-strings of this stringid for current lang */
|
|
for (const auto &text : text_list) {
|
|
if (text.langid == _currentLangID) return text.text.c_str();
|
|
|
|
/* If the current string is English or American, set it as the
|
|
* fallback language if the specific language isn't available. */
|
|
if (text.langid == GRFLX_UNSPECIFIED || (default_text == nullptr && (text.langid == GRFLX_ENGLISH || text.langid == GRFLX_AMERICAN))) {
|
|
default_text = text.text.c_str();
|
|
}
|
|
}
|
|
|
|
return default_text;
|
|
}
|
|
|
|
const char *GetDefaultLangGRFStringFromGRFText(const GRFTextList &text_list)
|
|
{
|
|
const char *default_text = nullptr;
|
|
|
|
for (const auto &text : text_list) {
|
|
/* If the current string is English or American, set it as the
|
|
* fallback language if the specific language isn't available. */
|
|
if (text.langid == GRFLX_UNSPECIFIED || (default_text == nullptr && (text.langid == GRFLX_ENGLISH || text.langid == GRFLX_AMERICAN))) {
|
|
default_text = text.text.c_str();
|
|
}
|
|
}
|
|
|
|
return default_text;
|
|
}
|
|
|
|
static std::array<std::pair<uint32, const char *>, 16> _grf_string_ptr_log;
|
|
static unsigned int _grf_string_ptr_log_next = 0;
|
|
|
|
/**
|
|
* Get a C-string from a GRFText-list. If there is a translation for the
|
|
* current language it is returned, otherwise the default translation
|
|
* is returned. If there is neither a default nor a translation for the
|
|
* current language nullptr is returned.
|
|
* @param text The GRFTextList to get the string from.
|
|
*/
|
|
const char *GetGRFStringFromGRFText(const GRFTextWrapper &text)
|
|
{
|
|
return text ? GetGRFStringFromGRFText(*text) : nullptr;
|
|
}
|
|
|
|
const char *GetDefaultLangGRFStringFromGRFText(const GRFTextWrapper &text)
|
|
{
|
|
return text ? GetDefaultLangGRFStringFromGRFText(*text) : nullptr;
|
|
}
|
|
|
|
/**
|
|
* Get a C-string from a stringid set by a newgrf.
|
|
*/
|
|
const char *GetGRFStringPtr(uint32 stringid)
|
|
{
|
|
#if 0
|
|
assert_msg(stringid < _grf_text.size(), "stringid: %u, size: %u", stringid, (uint)_grf_text.size());
|
|
assert_msg(_grf_text[stringid].grfid != 0, "stringid: %u", stringid);
|
|
#endif
|
|
|
|
if (stringid >= _grf_text.size() || _grf_text[stringid].grfid == 0) {
|
|
DEBUG(misc, 0, "Invalid NewGRF string ID: %d", stringid);
|
|
return "(invalid StringID)";
|
|
}
|
|
|
|
const char *str = GetGRFStringFromGRFText(_grf_text[stringid].textholder);
|
|
if (str == nullptr) {
|
|
/* Use the default string ID if the fallback string isn't available */
|
|
str = GetStringPtr(_grf_text[stringid].def_string);
|
|
}
|
|
|
|
_grf_string_ptr_log[_grf_string_ptr_log_next] = std::pair<uint32, const char *>(stringid, str);
|
|
_grf_string_ptr_log_next = (_grf_string_ptr_log_next + 1) % _grf_string_ptr_log.size();
|
|
|
|
return str;
|
|
}
|
|
|
|
/**
|
|
* Equivalence Setter function between game and newgrf langID.
|
|
* This function will adjust _currentLangID as to what is the LangID
|
|
* of the current language set by the user.
|
|
* This function is called after the user changed language,
|
|
* from strings.cpp:ReadLanguagePack
|
|
* @param language_id iso code of current selection
|
|
*/
|
|
void SetCurrentGrfLangID(byte language_id)
|
|
{
|
|
_currentLangID = language_id;
|
|
}
|
|
|
|
byte GetCurrentGrfLangID()
|
|
{
|
|
return _currentLangID;
|
|
}
|
|
|
|
bool CheckGrfLangID(byte lang_id, byte grf_version)
|
|
{
|
|
if (grf_version < 7) {
|
|
switch (_currentLangID) {
|
|
case GRFLX_GERMAN: return (lang_id & GRFLB_GERMAN) != 0;
|
|
case GRFLX_FRENCH: return (lang_id & GRFLB_FRENCH) != 0;
|
|
case GRFLX_SPANISH: return (lang_id & GRFLB_SPANISH) != 0;
|
|
default: return (lang_id & (GRFLB_ENGLISH | GRFLB_AMERICAN)) != 0;
|
|
}
|
|
}
|
|
|
|
return (lang_id == _currentLangID || lang_id == GRFLX_UNSPECIFIED);
|
|
}
|
|
|
|
/**
|
|
* House cleaning.
|
|
* Remove all strings.
|
|
*/
|
|
void CleanUpStrings()
|
|
{
|
|
_grf_text.clear();
|
|
|
|
_grf_string_ptr_log.fill({ 0, nullptr });
|
|
}
|
|
|
|
struct TextRefStack {
|
|
std::array<byte, 0x30> stack;
|
|
byte position;
|
|
const GRFFile *grffile;
|
|
bool used;
|
|
|
|
TextRefStack() : position(0), grffile(nullptr), used(false) {}
|
|
|
|
uint8 PopUnsignedByte() { assert(this->position < this->stack.size()); return this->stack[this->position++]; }
|
|
int8 PopSignedByte() { return (int8)this->PopUnsignedByte(); }
|
|
|
|
uint16 PopUnsignedWord()
|
|
{
|
|
uint16 val = this->PopUnsignedByte();
|
|
return val | (this->PopUnsignedByte() << 8);
|
|
}
|
|
int16 PopSignedWord() { return (int32)this->PopUnsignedWord(); }
|
|
|
|
uint32 PopUnsignedDWord()
|
|
{
|
|
uint32 val = this->PopUnsignedWord();
|
|
return val | (this->PopUnsignedWord() << 16);
|
|
}
|
|
int32 PopSignedDWord() { return (int32)this->PopUnsignedDWord(); }
|
|
|
|
uint64 PopUnsignedQWord()
|
|
{
|
|
uint64 val = this->PopUnsignedDWord();
|
|
return val | (((uint64)this->PopUnsignedDWord()) << 32);
|
|
}
|
|
int64 PopSignedQWord() { return (int64)this->PopUnsignedQWord(); }
|
|
|
|
/** Rotate the top four words down: W1, W2, W3, W4 -> W4, W1, W2, W3 */
|
|
void RotateTop4Words()
|
|
{
|
|
byte tmp[2];
|
|
for (int i = 0; i < 2; i++) tmp[i] = this->stack[this->position + i + 6];
|
|
for (int i = 5; i >= 0; i--) this->stack[this->position + i + 2] = this->stack[this->position + i];
|
|
for (int i = 0; i < 2; i++) this->stack[this->position + i] = tmp[i];
|
|
}
|
|
|
|
void PushWord(uint16 word)
|
|
{
|
|
if (this->position >= 2) {
|
|
this->position -= 2;
|
|
} else {
|
|
// Rotate right 2 positions
|
|
std::rotate(this->stack.rbegin(), this->stack.rbegin() + 2, this->stack.rend());
|
|
}
|
|
this->stack[this->position] = GB(word, 0, 8);
|
|
this->stack[this->position + 1] = GB(word, 8, 8);
|
|
}
|
|
|
|
void ResetStack(const GRFFile *grffile)
|
|
{
|
|
assert(grffile != nullptr);
|
|
this->position = 0;
|
|
this->grffile = grffile;
|
|
this->used = true;
|
|
}
|
|
};
|
|
|
|
/** The stack that is used for TTDP compatible string code parsing */
|
|
static TextRefStack _newgrf_textrefstack;
|
|
|
|
/**
|
|
* Check whether the NewGRF text stack is in use.
|
|
* @return True iff the NewGRF text stack is used.
|
|
*/
|
|
bool UsingNewGRFTextStack()
|
|
{
|
|
return _newgrf_textrefstack.used;
|
|
}
|
|
|
|
/**
|
|
* Create a backup of the current NewGRF text stack.
|
|
* @return A copy of the current text stack.
|
|
*/
|
|
struct TextRefStack *CreateTextRefStackBackup()
|
|
{
|
|
return new TextRefStack(_newgrf_textrefstack);
|
|
}
|
|
|
|
/**
|
|
* Restore a copy of the text stack to the used stack.
|
|
* @param backup The copy to restore.
|
|
*/
|
|
void RestoreTextRefStackBackup(struct TextRefStack *backup)
|
|
{
|
|
_newgrf_textrefstack = *backup;
|
|
delete backup;
|
|
}
|
|
|
|
/**
|
|
* Start using the TTDP compatible string code parsing.
|
|
*
|
|
* On start a number of values is copied on the #TextRefStack.
|
|
* You can then use #GetString() and the normal string drawing functions,
|
|
* and they will use the #TextRefStack for NewGRF string codes.
|
|
*
|
|
* However, when you want to draw a string multiple times using the same stack,
|
|
* you have to call #RewindTextRefStack() between draws.
|
|
*
|
|
* After you are done with drawing, you must disable usage of the #TextRefStack
|
|
* by calling #StopTextRefStackUsage(), so NewGRF string codes operate on the
|
|
* normal string parameters again.
|
|
*
|
|
* @param grffile the NewGRF providing the stack data
|
|
* @param numEntries number of entries to copy from the registers
|
|
* @param values values to copy onto the stack; if nullptr the temporary NewGRF registers will be used instead
|
|
*/
|
|
void StartTextRefStackUsage(const GRFFile *grffile, byte numEntries, const uint32 *values)
|
|
{
|
|
extern TemporaryStorageArray<int32, 0x110> _temp_store;
|
|
|
|
_newgrf_textrefstack.ResetStack(grffile);
|
|
|
|
auto stack_it = _newgrf_textrefstack.stack.begin();
|
|
for (uint i = 0; i < numEntries; i++) {
|
|
uint32 value = values != nullptr ? values[i] : _temp_store.GetValue(0x100 + i);
|
|
for (uint j = 0; j < 32; j += 8) {
|
|
*stack_it = GB(value, j, 8);
|
|
stack_it++;
|
|
}
|
|
}
|
|
}
|
|
|
|
/** Stop using the TTDP compatible string code parsing */
|
|
void StopTextRefStackUsage()
|
|
{
|
|
_newgrf_textrefstack.used = false;
|
|
}
|
|
|
|
/**
|
|
* FormatString for NewGRF specific "magic" string control codes
|
|
* @param scc the string control code that has been read
|
|
* @param buff the buffer we're writing to
|
|
* @param str the string that we need to write
|
|
* @param parameters the OpenTTD string formatting parameters
|
|
* @param modify_parameters When true, modify the OpenTTD string formatting parameters.
|
|
* @return the string control code to "execute" now
|
|
*/
|
|
uint RemapNewGRFStringControlCode(uint scc, char *buf_start, char **buff, const char **str, StringParameters ¶meters, bool modify_parameters)
|
|
{
|
|
auto too_many_newgrf_params = [&]() {
|
|
const char *buffer = *str;
|
|
uint32 grfid = 0;
|
|
for (uint entry = 0; entry < _grf_string_ptr_log.size(); entry++) {
|
|
const char *txt = _grf_string_ptr_log[entry].second;
|
|
uint32 stringid = _grf_string_ptr_log[entry].first;
|
|
if (txt != nullptr &&
|
|
buffer >= txt && buffer < txt + 8192 &&
|
|
buffer < txt + strlen(txt) &&
|
|
_grf_text[stringid].grfid != 0) {
|
|
grfid = _grf_text[stringid].grfid;
|
|
break;
|
|
}
|
|
}
|
|
if (grfid) {
|
|
extern GRFFile *GetFileByGRFID(uint32 grfid);
|
|
const GRFFile *grffile = GetFileByGRFID(grfid);
|
|
DEBUG(misc, 0, "Too many NewGRF string parameters (in %X, %s).", BSWAP32(grfid), grffile ? grffile->filename.c_str() : "????");
|
|
} else {
|
|
DEBUG(misc, 0, "Too many NewGRF string parameters.");
|
|
}
|
|
};
|
|
|
|
switch (scc) {
|
|
default: break;
|
|
|
|
/* These control codes take one string parameter, check there are at least that many available. */
|
|
case SCC_NEWGRF_PRINT_DWORD_SIGNED:
|
|
case SCC_NEWGRF_PRINT_WORD_SIGNED:
|
|
case SCC_NEWGRF_PRINT_BYTE_SIGNED:
|
|
case SCC_NEWGRF_PRINT_WORD_UNSIGNED:
|
|
case SCC_NEWGRF_PRINT_BYTE_HEX:
|
|
case SCC_NEWGRF_PRINT_WORD_HEX:
|
|
case SCC_NEWGRF_PRINT_DWORD_HEX:
|
|
case SCC_NEWGRF_PRINT_QWORD_HEX:
|
|
case SCC_NEWGRF_PRINT_DWORD_CURRENCY:
|
|
case SCC_NEWGRF_PRINT_QWORD_CURRENCY:
|
|
case SCC_NEWGRF_PRINT_WORD_STRING_ID:
|
|
case SCC_NEWGRF_PRINT_WORD_DATE_LONG:
|
|
case SCC_NEWGRF_PRINT_DWORD_DATE_LONG:
|
|
case SCC_NEWGRF_PRINT_WORD_DATE_SHORT:
|
|
case SCC_NEWGRF_PRINT_DWORD_DATE_SHORT:
|
|
case SCC_NEWGRF_PRINT_WORD_SPEED:
|
|
case SCC_NEWGRF_PRINT_WORD_VOLUME_LONG:
|
|
case SCC_NEWGRF_PRINT_WORD_VOLUME_SHORT:
|
|
case SCC_NEWGRF_PRINT_WORD_WEIGHT_LONG:
|
|
case SCC_NEWGRF_PRINT_WORD_WEIGHT_SHORT:
|
|
case SCC_NEWGRF_PRINT_WORD_POWER:
|
|
case SCC_NEWGRF_PRINT_DWORD_FORCE:
|
|
case SCC_NEWGRF_PRINT_WORD_STATION_NAME:
|
|
case SCC_NEWGRF_PRINT_WORD_CARGO_NAME:
|
|
if (parameters.GetDataLeft() < 1) {
|
|
too_many_newgrf_params();
|
|
return 0;
|
|
}
|
|
break;
|
|
|
|
/* These string code take two string parameters, check there are at least that many available. */
|
|
case SCC_NEWGRF_PRINT_WORD_CARGO_LONG:
|
|
case SCC_NEWGRF_PRINT_WORD_CARGO_SHORT:
|
|
case SCC_NEWGRF_PRINT_WORD_CARGO_TINY:
|
|
if (parameters.GetDataLeft() < 2) {
|
|
too_many_newgrf_params();
|
|
return 0;
|
|
}
|
|
break;
|
|
}
|
|
|
|
if (_newgrf_textrefstack.used && modify_parameters) {
|
|
/* There is data on the NewGRF text stack, and we want to move them to OpenTTD's string stack.
|
|
* After this call, a new call is made with `modify_parameters` set to false when the string is finally formatted. */
|
|
switch (scc) {
|
|
default: NOT_REACHED();
|
|
case SCC_NEWGRF_PRINT_BYTE_SIGNED: parameters.SetParam(0, _newgrf_textrefstack.PopSignedByte()); break;
|
|
case SCC_NEWGRF_PRINT_QWORD_CURRENCY: parameters.SetParam(0, _newgrf_textrefstack.PopSignedQWord()); break;
|
|
|
|
case SCC_NEWGRF_PRINT_DWORD_CURRENCY:
|
|
case SCC_NEWGRF_PRINT_DWORD_SIGNED: parameters.SetParam(0, _newgrf_textrefstack.PopSignedDWord()); break;
|
|
|
|
case SCC_NEWGRF_PRINT_BYTE_HEX: parameters.SetParam(0, _newgrf_textrefstack.PopUnsignedByte()); break;
|
|
case SCC_NEWGRF_PRINT_QWORD_HEX: parameters.SetParam(0, _newgrf_textrefstack.PopUnsignedQWord()); break;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_SPEED:
|
|
case SCC_NEWGRF_PRINT_WORD_VOLUME_LONG:
|
|
case SCC_NEWGRF_PRINT_WORD_VOLUME_SHORT:
|
|
case SCC_NEWGRF_PRINT_WORD_SIGNED: parameters.SetParam(0, _newgrf_textrefstack.PopSignedWord()); break;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_HEX:
|
|
case SCC_NEWGRF_PRINT_WORD_WEIGHT_LONG:
|
|
case SCC_NEWGRF_PRINT_WORD_WEIGHT_SHORT:
|
|
case SCC_NEWGRF_PRINT_WORD_POWER:
|
|
case SCC_NEWGRF_PRINT_WORD_STATION_NAME:
|
|
case SCC_NEWGRF_PRINT_WORD_UNSIGNED: parameters.SetParam(0, _newgrf_textrefstack.PopUnsignedWord()); break;
|
|
|
|
case SCC_NEWGRF_PRINT_DWORD_FORCE:
|
|
case SCC_NEWGRF_PRINT_DWORD_DATE_LONG:
|
|
case SCC_NEWGRF_PRINT_DWORD_DATE_SHORT:
|
|
case SCC_NEWGRF_PRINT_DWORD_HEX: parameters.SetParam(0, _newgrf_textrefstack.PopUnsignedDWord()); break;
|
|
|
|
/* Dates from NewGRFs have 1920-01-01 as their zero point, convert it to OpenTTD's epoch. */
|
|
case SCC_NEWGRF_PRINT_WORD_DATE_LONG:
|
|
case SCC_NEWGRF_PRINT_WORD_DATE_SHORT: parameters.SetParam(0, _newgrf_textrefstack.PopUnsignedWord() + DAYS_TILL_ORIGINAL_BASE_YEAR); break;
|
|
|
|
case SCC_NEWGRF_DISCARD_WORD: _newgrf_textrefstack.PopUnsignedWord(); break;
|
|
|
|
case SCC_NEWGRF_ROTATE_TOP_4_WORDS: _newgrf_textrefstack.RotateTop4Words(); break;
|
|
case SCC_NEWGRF_PUSH_WORD: _newgrf_textrefstack.PushWord(Utf8Consume(str)); break;
|
|
case SCC_NEWGRF_UNPRINT: *buff = std::max(*buff - Utf8Consume(str), buf_start); break;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_CARGO_LONG:
|
|
case SCC_NEWGRF_PRINT_WORD_CARGO_SHORT:
|
|
case SCC_NEWGRF_PRINT_WORD_CARGO_TINY:
|
|
parameters.SetParam(0, GetCargoTranslation(_newgrf_textrefstack.PopUnsignedWord(), _newgrf_textrefstack.grffile));
|
|
parameters.SetParam(1, _newgrf_textrefstack.PopUnsignedWord());
|
|
break;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_STRING_ID:
|
|
parameters.SetParam(0, MapGRFStringID(_newgrf_textrefstack.grffile->grfid, _newgrf_textrefstack.PopUnsignedWord()));
|
|
break;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_CARGO_NAME: {
|
|
CargoID cargo = GetCargoTranslation(_newgrf_textrefstack.PopUnsignedWord(), _newgrf_textrefstack.grffile);
|
|
parameters.SetParam(0, cargo < NUM_CARGO ? 1ULL << cargo : 0);
|
|
break;
|
|
}
|
|
}
|
|
} else {
|
|
/* Consume additional parameter characters that follow the NewGRF string code. */
|
|
switch (scc) {
|
|
default: break;
|
|
|
|
case SCC_NEWGRF_PUSH_WORD:
|
|
case SCC_NEWGRF_UNPRINT:
|
|
Utf8Consume(str);
|
|
break;
|
|
}
|
|
}
|
|
|
|
/* Emit OpenTTD's internal string code for the different NewGRF variants. */
|
|
switch (scc) {
|
|
default: NOT_REACHED();
|
|
case SCC_NEWGRF_PRINT_DWORD_SIGNED:
|
|
case SCC_NEWGRF_PRINT_WORD_SIGNED:
|
|
case SCC_NEWGRF_PRINT_BYTE_SIGNED:
|
|
case SCC_NEWGRF_PRINT_WORD_UNSIGNED:
|
|
return SCC_COMMA;
|
|
|
|
case SCC_NEWGRF_PRINT_BYTE_HEX:
|
|
case SCC_NEWGRF_PRINT_WORD_HEX:
|
|
case SCC_NEWGRF_PRINT_DWORD_HEX:
|
|
case SCC_NEWGRF_PRINT_QWORD_HEX:
|
|
return SCC_HEX;
|
|
|
|
case SCC_NEWGRF_PRINT_DWORD_CURRENCY:
|
|
case SCC_NEWGRF_PRINT_QWORD_CURRENCY:
|
|
return SCC_CURRENCY_LONG;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_STRING_ID:
|
|
return SCC_NEWGRF_PRINT_WORD_STRING_ID;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_DATE_LONG:
|
|
case SCC_NEWGRF_PRINT_DWORD_DATE_LONG:
|
|
return SCC_DATE_LONG;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_DATE_SHORT:
|
|
case SCC_NEWGRF_PRINT_DWORD_DATE_SHORT:
|
|
return SCC_DATE_SHORT;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_SPEED:
|
|
return SCC_VELOCITY;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_VOLUME_LONG:
|
|
return SCC_VOLUME_LONG;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_VOLUME_SHORT:
|
|
return SCC_VOLUME_SHORT;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_WEIGHT_LONG:
|
|
return SCC_WEIGHT_LONG;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_WEIGHT_SHORT:
|
|
return SCC_WEIGHT_SHORT;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_POWER:
|
|
return SCC_POWER;
|
|
|
|
case SCC_NEWGRF_PRINT_DWORD_FORCE:
|
|
return SCC_FORCE;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_CARGO_LONG:
|
|
return SCC_CARGO_LONG;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_CARGO_SHORT:
|
|
return SCC_CARGO_SHORT;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_CARGO_TINY:
|
|
return SCC_CARGO_TINY;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_CARGO_NAME:
|
|
return SCC_CARGO_LIST;
|
|
|
|
case SCC_NEWGRF_PRINT_WORD_STATION_NAME:
|
|
return SCC_STATION_NAME;
|
|
|
|
/* These NewGRF string codes modify the NewGRF stack or otherwise do not map to OpenTTD string codes. */
|
|
case SCC_NEWGRF_DISCARD_WORD:
|
|
case SCC_NEWGRF_ROTATE_TOP_4_WORDS:
|
|
case SCC_NEWGRF_PUSH_WORD:
|
|
case SCC_NEWGRF_UNPRINT:
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
uint32 GetStringGRFID(StringID string)
|
|
{
|
|
switch (GetStringTab(string)) {
|
|
case TEXT_TAB_NEWGRF_START:
|
|
return _grf_text[GetStringIndex(string)].grfid;
|
|
default:
|
|
return 0;
|
|
}
|
|
}
|