src/newgrf_text.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * 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.
   4  * 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.
   5  * 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/>.
   6  */
   7
   8 /** @file newgrf_text.h Header of Action 04 "universal holder" structure and functions */
   9
  10 #ifndef NEWGRF_TEXT_H
  11 #define NEWGRF_TEXT_H
  12
  13 #include "string_type.h"
  14 #include "strings_type.h"
  15 #include "core/smallvec_type.hpp"
  16 #include "table/control_codes.h"
  17 #include <utility>
  18 #include <vector>
  19 #include <string>
  20
  21 /** This character, the thorn ('þ'), indicates a unicode string to NFO. */
  22 static const WChar NFO_UTF8_IDENTIFIER = 0x00DE;
  23
  24 /** A GRF text with associated language ID. */
  25 struct GRFText {
  26         byte langid;      ///< The language associated with this GRFText.
  27         std::string text; ///< The actual (translated) text.
  28 };
  29
  30 /** A GRF text with a list of translations. */
  31 typedef std::vector<GRFText> GRFTextList;
  32 /** Reference counted wrapper around a GRFText pointer. */
  33 typedef std::shared_ptr<GRFTextList> GRFTextWrapper;
  34
  35 StringID AddGRFString(uint32 grfid, uint16 stringid, byte langid, bool new_scheme, bool allow_newlines, const char *text_to_add, StringID def_string);
  36 StringID GetGRFStringID(uint32 grfid, StringID stringid);
  37 const char *GetGRFStringFromGRFText(const GRFTextList &text_list);
  38 const char *GetGRFStringFromGRFText(const GRFTextWrapper &text);
  39 const char *GetGRFStringPtr(uint16 stringid);
  40 void CleanUpStrings();
  41 void SetCurrentGrfLangID(byte language_id);
  42 std::string TranslateTTDPatchCodes(uint32 grfid, uint8 language_id, bool allow_newlines, const std::string &str, StringControlCode byte80 = SCC_NEWGRF_PRINT_WORD_STRING_ID);
  43 void AddGRFTextToList(GRFTextList &list, byte langid, uint32 grfid, bool allow_newlines, const char *text_to_add);
  44 void AddGRFTextToList(GRFTextWrapper &list, byte langid, uint32 grfid, bool allow_newlines, const char *text_to_add);
  45 void AddGRFTextToList(GRFTextWrapper &list, const std::string &text_to_add);
  46
  47 bool CheckGrfLangID(byte lang_id, byte grf_version);
  48
  49 void StartTextRefStackUsage(const struct GRFFile *grffile, byte numEntries, const uint32 *values = nullptr);
  50 void StopTextRefStackUsage();
  51 void RewindTextRefStack();
  52 bool UsingNewGRFTextStack();
  53 struct TextRefStack *CreateTextRefStackBackup();
  54 void RestoreTextRefStackBackup(struct TextRefStack *backup);
  55 uint RemapNewGRFStringControlCode(uint scc, char *buf_start, char **buff, const char **str, int64 *argv, uint argv_size, bool modify_argv);
  56
  57 /** Mapping of language data between a NewGRF and OpenTTD. */
  58 struct LanguageMap {
  59         /** Mapping between NewGRF and OpenTTD IDs. */
  60         struct Mapping {
  61                 byte newgrf_id;  ///< NewGRF's internal ID for a case/gender.
  62                 byte openttd_id; ///< OpenTTD's internal ID for a case/gender.
  63         };
  64
  65         /* We need a vector and can't use SmallMap due to the fact that for "setting" a
  66          * gender of a string or requesting a case for a substring we want to map from
  67          * the NewGRF's internal ID to OpenTTD's ID whereas for the choice lists we map
  68          * the genders/cases/plural OpenTTD IDs to the NewGRF's internal IDs. In this
  69          * case a NewGRF developer/translator might want a different translation for
  70          * both cases. Thus we are basically implementing a multi-map. */
  71         std::vector<Mapping> gender_map; ///< Mapping of NewGRF and OpenTTD IDs for genders.
  72         std::vector<Mapping> case_map;   ///< Mapping of NewGRF and OpenTTD IDs for cases.
  73         int plural_form;                 ///< The plural form used for this language.
  74
  75         int GetMapping(int newgrf_id, bool gender) const;
  76         int GetReverseMapping(int openttd_id, bool gender) const;
  77         static const LanguageMap *GetLanguageMap(uint32 grfid, uint8 language_id);
  78 };
  79
  80 #endif /* NEWGRF_TEXT_H */