game_text.cpp

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>.
 */

 
#include "../stdafx.h"
#include "../strgen/strgen.h"
#include "../debug.h"
#include "../fileio_func.h"
#include "../tar_type.h"
#include "../script/api/script_text.hpp"
#include "../script/squirrel_class.hpp"
#include "../strings_func.h"
#include "game_text.hpp"
#include "game.hpp"
#include "game_info.hpp"
 
#include "table/strings.h"
#include "../table/control_codes.h"
#include "../table/strgen_tables.h"
 
#include "../safeguards.h"
 
void CDECL StrgenWarningI(const std::string &msg)
{
  Debug(script, 0, "{}:{}: warning: {}", _strgen.file, _strgen.cur_line, msg);
  _strgen.warnings++;
}
 
void CDECL StrgenErrorI(const std::string &msg)
{
  Debug(script, 0, "{}:{}: error: {}", _strgen.file, _strgen.cur_line, msg);
  _strgen.errors++;
}
 
void CDECL StrgenFatalI(const std::string &msg)
{
  Debug(script, 0, "{}:{}: FATAL: {}", _strgen.file, _strgen.cur_line, msg);
  throw std::exception();
}

LanguageStrings ReadRawLanguageStrings(const std::string &file)
{
  size_t to_read;
  auto fh = FioFOpenFile(file, "rb", Subdirectory::Gs, &to_read);
  if (!fh.has_value()) return LanguageStrings();
 
  auto pos = file.rfind(PATHSEPCHAR);
  if (pos == std::string::npos) return LanguageStrings();
  std::string langname = file.substr(pos + 1);
 
  /* Check for invalid empty filename */
  if (langname.empty() || langname.front() == '.') return LanguageStrings();
 
  LanguageStrings ret(langname.substr(0, langname.find('.')));
 
  char buffer[2048];
  while (to_read != 0 && fgets(buffer, sizeof(buffer), *fh) != nullptr) {
    std::string_view view{buffer};
    ret.lines.emplace_back(StrTrimView(view, StringConsumer::WHITESPACE_OR_NEWLINE));
 
    if (view.size() > to_read) {
      to_read = 0;
    } else {
      to_read -= view.size();
    }
  }
 
  return ret;
}
 

struct StringListReader : StringReader {
  StringList::const_iterator p;   
  StringList::const_iterator end; 

  StringListReader(StringData &data, const LanguageStrings &strings, bool master, bool translation) :
      StringReader(data, strings.language, master, translation), p(strings.lines.begin()), end(strings.lines.end())
  {
  }
 
  std::optional<std::string> ReadLine() override
  {
    if (this->p == this->end) return std::nullopt;
    return *this->p++;
  }
};

struct TranslationWriter : LanguageWriter {
  StringList &strings; 

  TranslationWriter(StringList &strings) : strings(strings)
  {
  }
 
  void WriteHeader(const LanguagePackHeader *) override
  {
    /* We don't use the header. */
  }
 
  void Finalise() override
  {
    /* Nothing to do. */
  }
 
  void WriteLength(size_t) override
  {
    /* We don't write the length. */
  }
 
  void Write(std::string_view buffer) override
  {
    this->strings.emplace_back(buffer);
  }
};

struct StringNameWriter : HeaderWriter {
  StringList &strings; 

  StringNameWriter(StringList &strings) : strings(strings)
  {
  }
 
  void WriteStringID(const std::string &name, size_t stringid) override
  {
    if (stringid == this->strings.size()) this->strings.emplace_back(name);
  }
 
  void Finalise(const StringData &) override
  {
    /* Nothing to do. */
  }
};

class LanguageScanner : protected FileScanner {
private:
  std::weak_ptr<GameStrings> gs; 
  std::string exclude; 
 
public:
  LanguageScanner(std::weak_ptr<GameStrings> gs, const std::string &exclude) : gs(gs), exclude(exclude) {}

  void Scan(const std::string &directory)
  {
    this->FileScanner::Scan(".txt", directory, false);
  }
 
  bool AddFile(const std::string &filename, size_t, const std::string &) override
  {
    if (exclude == filename) return true;
 
    auto ls = ReadRawLanguageStrings(filename);
    if (!ls.IsValid()) return false;
 
    if (auto sp = this->gs.lock()) {
      sp->raw_strings.push_back(std::move(ls));
      return true;
    }
 
    return false;
  }
};

static std::shared_ptr<GameStrings> LoadTranslations()
{
  const GameInfo *info = Game::GetInfo();
  assert(info != nullptr);
  std::string basename(info->GetMainScript());
  auto e = basename.rfind(PATHSEPCHAR);
  if (e == std::string::npos) return nullptr;
  basename.erase(e + 1);
 
  std::string filename = basename + "lang" PATHSEP "english.txt";
  if (!FioCheckFileExists(filename, Subdirectory::Gs)) return nullptr;
 
  auto ls = ReadRawLanguageStrings(filename);
  if (!ls.IsValid()) return nullptr;
 
  auto gs = std::make_shared<GameStrings>();
  try {
    gs->raw_strings.push_back(std::move(ls));
 
    /* Scan for other language files */
    LanguageScanner scanner(gs, filename);
    std::string ldir = basename + "lang" PATHSEP;
 
    const std::string tar_filename = info->GetTarFile();
    TarList::iterator iter;
    if (!tar_filename.empty() && (iter = _tar_list[Subdirectory::Gs].find(tar_filename)) != _tar_list[Subdirectory::Gs].end()) {
      /* The main script is in a tar file, so find all files that
       * are in the same tar and add them to the langfile scanner. */
      for (const auto &[name, entry] : _tar_filelist[Subdirectory::Gs]) {
        /* Not in the same tar. */
        if (entry.tar_filename != iter->first) continue;
 
        /* Check the path and extension. */
        if (!name.starts_with(ldir)) continue;
        if (!name.ends_with(".txt")) continue;
 
        scanner.AddFile(name, 0, tar_filename);
      }
    } else {
      /* Scan filesystem */
      scanner.Scan(ldir);
    }
 
    gs->Compile();
    return gs;
  } catch (...) {
    return nullptr;
  }
}
 
static StringParam::ParamType GetParamType(const CmdStruct *cs)
{
  if (cs->value == SCC_RAW_STRING_POINTER) return StringParam::RAW_STRING;
  if (cs->value == SCC_STRING || cs != TranslateCmdForCompare(cs)) return StringParam::STRING;
  return StringParam::OTHER;
}
 
static void ExtractStringParams(const StringData &data, StringParamsList &params)
{
  for (size_t i = 0; i < data.max_strings; i++) {
    const LangString *ls = data.strings[i].get();
 
    if (ls != nullptr) {
      StringParams &param = params.emplace_back();
      ParsedCommandStruct pcs = ExtractCommandString(ls->english, false);
 
      for (auto it = pcs.consuming_commands.begin(); it != pcs.consuming_commands.end(); it++) {
        if (*it == nullptr) {
          /* Skip empty param unless a non empty param exist after it. */
          if (std::all_of(it, pcs.consuming_commands.end(), [](auto cs) { return cs == nullptr; })) break;
          param.emplace_back(StringParam::UNUSED, 1);
          continue;
        }
        const CmdStruct *cs = *it;
        param.emplace_back(GetParamType(cs), cs->consumes, cs->cmd);
      }
    }
  }
}

void GameStrings::Compile()
{
  StringData data(32);
  StringListReader master_reader(data, this->raw_strings[0], true, false);
  master_reader.ParseFile();
  if (_strgen.errors != 0) throw std::exception();
 
  this->version = data.Version();
 
  ExtractStringParams(data, this->string_params);
 
  StringNameWriter id_writer(this->string_names);
  id_writer.WriteHeader(data);
 
  for (const auto &p : this->raw_strings) {
    data.FreeTranslation();
    StringListReader translation_reader(data, p, false, p.language != "english");
    translation_reader.ParseFile();
    if (_strgen.errors != 0) throw std::exception();
 
    auto &strings = this->compiled_strings.emplace_back(p.language);
    TranslationWriter writer(strings.lines);
    writer.WriteLang(data);
  }
}

std::shared_ptr<GameStrings> _current_gamestrings_data = nullptr;

std::string_view GetGameStringPtr(StringIndexInTab id)
{
  if (_current_gamestrings_data == nullptr || _current_gamestrings_data->cur_language == nullptr || id.base() >= _current_gamestrings_data->cur_language->lines.size()) return GetStringPtr(STR_UNDEFINED);
  return _current_gamestrings_data->cur_language->lines[id];
}

const StringParams &GetGameStringParams(StringIndexInTab id)
{
  /* An empty result for STR_UNDEFINED. */
  static StringParams empty;
 
  if (id.base() >= _current_gamestrings_data->string_params.size()) return empty;
  return _current_gamestrings_data->string_params[id];
}

const std::string &GetGameStringName(StringIndexInTab id)
{
  /* The name for STR_UNDEFINED. */
  static const std::string undefined = "STR_UNDEFINED";
 
  if (id.base() >= _current_gamestrings_data->string_names.size()) return undefined;
  return _current_gamestrings_data->string_names[id];
}

void RegisterGameTranslation(Squirrel &engine)
{
  _current_gamestrings_data = LoadTranslations();
  if (_current_gamestrings_data == nullptr) return;
 
  HSQUIRRELVM vm = engine.GetVM();
  sq_pushroottable(vm);
  sq_pushstring(vm, "GSText");
  if (SQ_FAILED(sq_get(vm, -2))) return;
 
  int idx = 0;
  for (const auto &p : _current_gamestrings_data->string_names) {
    sq_pushstring(vm, p);
    sq_pushinteger(vm, idx);
    sq_rawset(vm, -3);
    idx++;
  }
 
  sq_pop(vm, 2);
 
  ScriptText::SetPadParameterCount(vm);
 
  ReconsiderGameScriptLanguage();
}

void ReconsiderGameScriptLanguage()
{
  if (_current_gamestrings_data == nullptr) return;
 
  std::string language = FS2OTTD(_current_language->file.stem().native());
  for (auto &p : _current_gamestrings_data->compiled_strings) {
    if (p.language == language) {
      _current_gamestrings_data->cur_language = &p;
      return;
    }
  }
 
  _current_gamestrings_data->cur_language = &_current_gamestrings_data->compiled_strings[0];
}