src/game/game_text.hpp

   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 game_text.hpp Base functions regarding game texts. */
   9
  10 #ifndef GAME_TEXT_HPP
  11 #define GAME_TEXT_HPP
  12
  13 #include "../core/smallvec_type.hpp"
  14
  15 const char *GetGameStringPtr(uint id);
  16 void RegisterGameTranslation(class Squirrel *engine);
  17 void ReconsiderGameScriptLanguage();
  18
  19 /** Container for the raw (unencoded) language strings of a language. */
  20 struct LanguageStrings {
  21         std::string language; ///< Name of the language (base filename). Empty string if invalid.
  22         StringList  lines;    ///< The lines of the file to pass into the parser/encoder.
  23
  24         LanguageStrings() {}
  25         LanguageStrings(const std::string &lang) : language(lang) {}
  26         LanguageStrings(const LanguageStrings &other) : language(other.language), lines(other.lines) {}
  27         LanguageStrings(LanguageStrings &&other) : language(std::move(other.language)), lines(std::move(other.lines)) {}
  28
  29         bool IsValid() const { return !this->language.empty(); }
  30 };
  31
  32 /** Container for all the game strings. */
  33 struct GameStrings {
  34         uint version;                  ///< The version of the language strings.
  35         LanguageStrings *cur_language; ///< The current (compiled) language.
  36
  37         std::vector<LanguageStrings> raw_strings;      ///< The raw strings per language, first must be English/the master language!.
  38         std::vector<LanguageStrings> compiled_strings; ///< The compiled strings per language, first must be English/the master language!.
  39         StringList string_names;                       ///< The names of the compiled strings.
  40
  41         void Compile();
  42
  43         GameStrings() = default;
  44
  45         GameStrings(const GameStrings &) = delete;
  46         GameStrings(GameStrings &&) = delete;
  47         GameStrings &operator=(const GameStrings &) = delete;
  48         GameStrings &operator=(GameStrings &&) = delete;
  49 };
  50
  51 #endif /* GAME_TEXT_HPP */