src/game/game_text.hpp

   1 /* $Id$ */
   2
   3 /*
   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/>.
   8  */
   9
  10 /** @file game_text.hpp Base functions regarding game texts. */
  11
  12 #ifndef GAME_TEXT_HPP
  13 #define GAME_TEXT_HPP
  14
  15 #include "../core/smallvec_type.hpp"
  16
  17 const char *GetGameStringPtr(uint id);
  18 void RegisterGameTranslation(class Squirrel *engine);
  19 void ReconsiderGameScriptLanguage();
  20
  21 /** Container for the raw (unencoded) language strings of a language. */
  22 struct LanguageStrings {
  23         const char *language; ///< Name of the language (base filename).
  24         StringList lines;     ///< The lines of the file to pass into the parser/encoder.
  25
  26         LanguageStrings(const char *language, const char *end = NULL);
  27         ~LanguageStrings();
  28 };
  29
  30 /** Container for all the game strings. */
  31 struct GameStrings {
  32         uint version;                  ///< The version of the language strings.
  33         LanguageStrings *cur_language; ///< The current (compiled) language.
  34
  35         AutoDeleteSmallVector<LanguageStrings *, 4> raw_strings;      ///< The raw strings per language, first must be English/the master language!.
  36         AutoDeleteSmallVector<LanguageStrings *, 4> compiled_strings; ///< The compiled strings per language, first must be English/the master language!.
  37         StringList string_names;                                      ///< The names of the compiled strings.
  38
  39         void Compile();
  40 };
  41
  42 #endif /* GAME_TEXT_HPP */