4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
10 /** @file newgrf_text.h Header of Action 04 "universal holder" structure and functions */
15 #include "string_type.h"
16 #include "strings_type.h"
17 #include "core/smallvec_type.hpp"
18 #include "table/control_codes.h"
20 /** This character, the thorn ('รพ'), indicates a unicode string to NFO. */
21 static const WChar NFO_UTF8_IDENTIFIER
= 0x00DE;
23 StringID
AddGRFString(uint32 grfid
, uint16 stringid
, byte langid
, bool new_scheme
, bool allow_newlines
, const char *text_to_add
, StringID def_string
);
24 StringID
GetGRFStringID(uint32 grfid
, uint16 stringid
);
25 const char *GetGRFStringFromGRFText(const struct GRFText
*text
);
26 const char *GetGRFStringPtr(uint16 stringid
);
27 void CleanUpStrings();
28 void SetCurrentGrfLangID(byte language_id
);
29 char *TranslateTTDPatchCodes(uint32 grfid
, uint8 language_id
, bool allow_newlines
, const char *str
, int *olen
= NULL
, StringControlCode byte80
= SCC_NEWGRF_PRINT_WORD_STRING_ID
);
30 struct GRFText
*DuplicateGRFText(struct GRFText
*orig
);
31 void AddGRFTextToList(struct GRFText
**list
, struct GRFText
*text_to_add
);
32 void AddGRFTextToList(struct GRFText
**list
, byte langid
, uint32 grfid
, bool allow_newlines
, const char *text_to_add
);
33 void AddGRFTextToList(struct GRFText
**list
, const char *text_to_add
);
34 void CleanUpGRFText(struct GRFText
*grftext
);
36 bool CheckGrfLangID(byte lang_id
, byte grf_version
);
38 void StartTextRefStackUsage(byte numEntries
, const uint32
*values
= NULL
);
39 void StopTextRefStackUsage();
40 void RewindTextRefStack();
41 bool UsingNewGRFTextStack();
42 struct TextRefStack
*CreateTextRefStackBackup();
43 void RestoreTextRefStackBackup(struct TextRefStack
*backup
);
44 uint
RemapNewGRFStringControlCode(uint scc
, char *buf_start
, char **buff
, const char **str
, int64
*argv
, bool modify_argv
);
46 StringID
TTDPStringIDToOTTDStringIDMapping(StringID string
);
48 /** Mapping of language data between a NewGRF and OpenTTD. */
50 /** Mapping between NewGRF and OpenTTD IDs. */
52 byte newgrf_id
; ///< NewGRF's internal ID for a case/gender.
53 byte openttd_id
; ///< OpenTTD's internal ID for a case/gender.
56 /* We need a vector and can't use SmallMap due to the fact that for "setting" a
57 * gender of a string or requesting a case for a substring we want to map from
58 * the NewGRF's internal ID to OpenTTD's ID whereas for the choice lists we map
59 * the genders/cases/plural OpenTTD IDs to the NewGRF's internal IDs. In this
60 * case a NewGRF developer/translator might want a different translation for
61 * both cases. Thus we are basically implementing a multi-map. */
62 SmallVector
<Mapping
, 1> gender_map
; ///< Mapping of NewGRF and OpenTTD IDs for genders.
63 SmallVector
<Mapping
, 1> case_map
; ///< Mapping of NewGRF and OpenTTD IDs for cases.
64 int plural_form
; ///< The plural form used for this language.
66 int GetMapping(int newgrf_id
, bool gender
) const;
67 int GetReverseMapping(int openttd_id
, bool gender
) const;
68 static const LanguageMap
*GetLanguageMap(uint32 grfid
, uint8 language_id
);
71 #endif /* NEWGRF_TEXT_H */