Archives/OpenTTD-patches
2
0
Fork 0
mirror of https://github.com/JGRennison/OpenTTD-patches.git synced 2024-11-09 19:10:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Codechange: Split types out of newgrf_text.h

Browse Source
This commit is contained in:
Peter Nelson 2024-06-06 08:29:20 +01:00 committed by Peter Nelson
parent fa24a3ec6b
commit fee73f3253
3 changed files with 52 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/CMakeLists.txt
View File

@ -307,6 +307,7 @@ add_files(
newgrf_storage.h
newgrf_text.cpp
newgrf_text.h
newgrf_text_type.h
newgrf_town.cpp
newgrf_town.h
newgrf_townname.cpp

40
src/newgrf_text.h
View File

@ -10,24 +10,9 @@
#ifndef NEWGRF_TEXT_H
#define NEWGRF_TEXT_H
#include "string_type.h"
#include "newgrf_text_type.h"
#include "strings_type.h"
#include "table/control_codes.h"
#include <utility>
/** This character, the thorn ('þ'), indicates a unicode string to NFO. */
static const char32_t NFO_UTF8_IDENTIFIER = 0x00DE;
/** A GRF text with associated language ID. */
struct GRFText {
uint8_t langid; ///< The language associated with this GRFText.
std::string text; ///< The actual (translated) text.
};
/** A GRF text with a list of translations. */
typedef std::vector<GRFText> GRFTextList;
/** Reference counted wrapper around a GRFText pointer. */
typedef std::shared_ptr<GRFTextList> GRFTextWrapper;
StringID AddGRFString(uint32_t grfid, uint16_t stringid, uint8_t langid, bool new_scheme, bool allow_newlines, std::string_view text_to_add, StringID def_string);
StringID GetGRFStringID(uint32_t grfid, StringID stringid);
@ -49,27 +34,4 @@ bool UsingNewGRFTextStack();
struct TextRefStack *CreateTextRefStackBackup();
void RestoreTextRefStackBackup(struct TextRefStack *backup);
/** Mapping of language data between a NewGRF and OpenTTD. */
struct LanguageMap {
/** Mapping between NewGRF and OpenTTD IDs. */
struct Mapping {
uint8_t newgrf_id; ///< NewGRF's internal ID for a case/gender.
uint8_t openttd_id; ///< OpenTTD's internal ID for a case/gender.
};
/* We need a vector and can't use SmallMap due to the fact that for "setting" a
* gender of a string or requesting a case for a substring we want to map from
* the NewGRF's internal ID to OpenTTD's ID whereas for the choice lists we map
* the genders/cases/plural OpenTTD IDs to the NewGRF's internal IDs. In this
* case a NewGRF developer/translator might want a different translation for
* both cases. Thus we are basically implementing a multi-map. */
std::vector<Mapping> gender_map; ///< Mapping of NewGRF and OpenTTD IDs for genders.
std::vector<Mapping> case_map; ///< Mapping of NewGRF and OpenTTD IDs for cases.
int plural_form; ///< The plural form used for this language.
int GetMapping(int newgrf_id, bool gender) const;
int GetReverseMapping(int openttd_id, bool gender) const;
static const LanguageMap *GetLanguageMap(uint32_t grfid, uint8_t language_id);
};
#endif /* NEWGRF_TEXT_H */

50
src/newgrf_text_type.h Normal file
View File

@ -0,0 +1,50 @@
/*
* 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_type.h Header of Action 04 "universal holder" structure */
#ifndef NEWGRF_TEXT_TYPE_H
#define NEWGRF_TEXT_TYPE_H
/** This character (thorn) indicates a unicode string to NFO. */
static const char32_t NFO_UTF8_IDENTIFIER = 0x00DE;
/** A GRF text with associated language ID. */
struct GRFText {
uint8_t langid; ///< The language associated with this GRFText.
std::string text; ///< The actual (translated) text.
};
/** A GRF text with a list of translations. */
using GRFTextList = std::vector<GRFText>;
/** Reference counted wrapper around a GRFText pointer. */
using GRFTextWrapper = std::shared_ptr<GRFTextList>;
/** Mapping of language data between a NewGRF and OpenTTD. */
struct LanguageMap {
/** Mapping between NewGRF and OpenTTD IDs. */
struct Mapping {
uint8_t newgrf_id; ///< NewGRF's internal ID for a case/gender.
uint8_t openttd_id; ///< OpenTTD's internal ID for a case/gender.
};
/* We need a vector and can't use SmallMap due to the fact that for "setting" a
* gender of a string or requesting a case for a substring we want to map from
* the NewGRF's internal ID to OpenTTD's ID whereas for the choice lists we map
* the genders/cases/plural OpenTTD IDs to the NewGRF's internal IDs. In this
* case a NewGRF developer/translator might want a different translation for
* both cases. Thus we are basically implementing a multi-map. */
std::vector<Mapping> gender_map; ///< Mapping of NewGRF and OpenTTD IDs for genders.
std::vector<Mapping> case_map; ///< Mapping of NewGRF and OpenTTD IDs for cases.
int plural_form; ///< The plural form used for this language.
int GetMapping(int newgrf_id, bool gender) const;
int GetReverseMapping(int openttd_id, bool gender) const;
static const LanguageMap *GetLanguageMap(uint32_t grfid, uint8_t language_id);
};
#endif /* NEWGRF_TEXT_TYPE_H */