game_text.hpp

Go to the documentation of this file.

/*
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef GAME_TEXT_HPP
#define GAME_TEXT_HPP
 
#include "../string_type.h"
#include "../strings_type.h"
 
struct StringParam {
  enum ParamType : uint8_t {
    UNUSED,
    RAW_STRING,
    STRING,
    OTHER
  };
 
  ParamType type;
  uint8_t consumes;
  std::string_view cmd;
 
  StringParam(ParamType type, uint8_t consumes, std::string_view cmd = {}) : type(type), consumes(consumes), cmd(cmd) {}
};
using StringParams = std::vector<StringParam>;
using StringParamsList = std::vector<StringParams>;
 
std::string_view GetGameStringPtr(StringIndexInTab id);
const StringParams &GetGameStringParams(StringIndexInTab id);
const std::string &GetGameStringName(StringIndexInTab id);
void RegisterGameTranslation(class Squirrel &engine);
void ReconsiderGameScriptLanguage();

struct LanguageStrings {
  std::string language; 
  TypedIndexContainer<StringList, StringIndexInTab> lines; 
 
  LanguageStrings() {}
  LanguageStrings(const std::string &lang) : language(lang) {}
  LanguageStrings(const LanguageStrings &other) : language(other.language), lines(other.lines) {}
  LanguageStrings(LanguageStrings &&other) : language(std::move(other.language)), lines(std::move(other.lines)) {}
 
  bool IsValid() const { return !this->language.empty(); }
};

struct GameStrings {
  uint version;                  
  LanguageStrings *cur_language; 
 
  std::vector<LanguageStrings> raw_strings;      
  std::vector<LanguageStrings> compiled_strings; 
  TypedIndexContainer<StringList, StringIndexInTab> string_names; 
  TypedIndexContainer<StringParamsList, StringIndexInTab> string_params; 
 
  void Compile();
 
  GameStrings() = default;
 
  GameStrings(const GameStrings &) = delete;
  GameStrings(GameStrings &&) = delete;
  GameStrings &operator=(const GameStrings &) = delete;
  GameStrings &operator=(GameStrings &&) = delete;
};
 
#endif /* GAME_TEXT_HPP */