strings.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 "currency.h"
#include "station_base.h"
#include "town.h"
#include "waypoint_base.h"
#include "depot_base.h"
#include "industry.h"
#include "newgrf_text.h"
#include "fileio_func.h"
#include "signs_base.h"
#include "error.h"
#include "error_func.h"
#include "strings_func.h"
#include "rev.h"
#include "core/endian_func.hpp"
#include "timer/timer_game_calendar.h"
#include "vehicle_base.h"
#include "engine_base.h"
#include "language.h"
#include "townname_func.h"
#include "string_func.h"
#include "company_base.h"
#include "smallmap_gui.h"
#include "window_func.h"
#include "debug.h"
#include "game/game_text.hpp"
#include "network/network_content_gui.h"
#include "newgrf_engine.h"
#include "core/backup_type.hpp"
#include "gfx_layout.h"
#include "core/utf8.hpp"
#include "core/string_consumer.hpp"
#include <stack>
 
#include "table/strings.h"
#include "table/control_codes.h"
#include "3rdparty/fmt/std.h"
 
#include "strings_internal.h"
 
#include "safeguards.h"
 
std::string _config_language_file;                
LanguageList _languages;                          
const LanguageMetadata *_current_language = nullptr; 
 
TextDirection _current_text_dir; 
 
#ifdef WITH_ICU_I18N
std::unique_ptr<icu::Collator> _current_collator;    
#endif /* WITH_ICU_I18N */
 
const StringParameter &StringParameters::GetNextParameterReference()
{
  assert(this->next_type == 0 || (SCC_CONTROL_START <= this->next_type && this->next_type <= SCC_CONTROL_END));
  if (this->offset >= this->parameters.size()) {
    throw std::out_of_range("Trying to read invalid string parameter");
  }
 
  auto &param = this->parameters[this->offset++];
  if (param.type != 0 && param.type != this->next_type) {
    this->next_type = 0;
    throw std::out_of_range("Trying to read string parameter with wrong type");
  }
  param.type = this->next_type;
  this->next_type = 0;
  return param;
}
 
EncodedString GetEncodedString(StringID str)
{
  return GetEncodedStringWithArgs(str, {});
}
 
EncodedString GetEncodedStringWithArgs(StringID str, std::span<const StringParameter> params)
{
  std::string result;
  StringBuilder builder(result);
  builder.PutUtf8(SCC_ENCODED_INTERNAL);
  builder.PutIntegerBase(str, 16);
 
  struct visitor {
    StringBuilder &builder;
 
    void operator()(const std::monostate &) {}
 
    void operator()(const uint64_t &arg)
    {
      this->builder.PutUtf8(SCC_ENCODED_NUMERIC);
      this->builder.PutIntegerBase(arg, 16);
    }
 
    void operator()(const std::string &value)
    {
#ifdef WITH_ASSERT
      /* Don't allow an encoded string to contain another encoded string. */
      {
        auto [len, c] = DecodeUtf8(value);
        assert(len == 0 || (c != SCC_ENCODED && c != SCC_ENCODED_INTERNAL && c != SCC_RECORD_SEPARATOR));
      }
#endif /* WITH_ASSERT */
      this->builder.PutUtf8(SCC_ENCODED_STRING);
      this->builder += value;
    }
  };
 
  visitor v{builder};
  for (const auto &param : params) {
    builder.PutUtf8(SCC_RECORD_SEPARATOR);
    std::visit(v, param.data);
  }
 
  return EncodedString{std::move(result)};
}
 
EncodedString EncodedString::ReplaceParam(size_t param, StringParameter &&data) const
{
  if (this->empty()) return {};
 
  std::vector<StringParameter> params;
  StringConsumer consumer(this->string);
 
  if (!consumer.ReadUtf8If(SCC_ENCODED_INTERNAL)) return {};
 
  StringID str;
  if (auto r = consumer.TryReadIntegerBase<uint32_t>(16); r.has_value()) {
    str = *r;
  } else {
    return {};
  }
  if (consumer.AnyBytesLeft() && !consumer.ReadUtf8If(SCC_RECORD_SEPARATOR)) return {};
 
  while (consumer.AnyBytesLeft()) {
    StringConsumer record(consumer.ReadUntilUtf8(SCC_RECORD_SEPARATOR, StringConsumer::SKIP_ONE_SEPARATOR));
 
    if (!record.AnyBytesLeft()) {
      /* This is an empty parameter. */
      params.emplace_back(std::monostate{});
      continue;
    }
 
    /* Get the parameter type. */
    char32_t parameter_type = record.ReadUtf8();
    switch (parameter_type) {
      case SCC_ENCODED_NUMERIC: {
        uint64_t value = record.ReadIntegerBase<uint64_t>(16);
        assert(!record.AnyBytesLeft());
        params.emplace_back(value);
        break;
      }
 
      case SCC_ENCODED_STRING: {
        params.emplace_back(record.Read(StringConsumer::npos));
        break;
      }
 
      default:
        /* Unknown parameter, make it blank. */
        params.emplace_back(std::monostate{});
        break;
    }
  }
 
  if (param >= std::size(params)) return {};
  params[param] = data;
  return GetEncodedStringWithArgs(str, params);
}
 
std::string EncodedString::GetDecodedString() const
{
  return GetString(STR_JUST_RAW_STRING, this->string);
}
 
uint64_t GetParamMaxDigits(uint count, FontSize size)
{
  auto [front, next] = GetBroadestDigit(size);
  uint64_t val = count > 1 ? front : next;
  for (; count > 1; count--) {
    val = 10 * val + next;
  }
  return val;
}
 
uint64_t GetParamMaxValue(uint64_t max_value, uint min_count, FontSize size)
{
  uint num_digits = 1;
  while (max_value >= 10) {
    num_digits++;
    max_value /= 10;
  }
  return GetParamMaxDigits(std::max(min_count, num_digits), size);
}
 
static void StationGetSpecialString(StringBuilder &builder, StationFacilities x);
static bool GetSpecialNameString(StringBuilder &builder, StringID string, StringParameters &args);
 
static void FormatString(StringBuilder &builder, std::string_view str, StringParameters &args, uint case_index = 0, bool game_script = false, bool dry_run = false);
 
static void FormatString(StringBuilder &builder, std::string_view str, std::span<StringParameter> params, uint case_index = 0, bool game_script = false, bool dry_run = false)
{
  StringParameters tmp_params{params};
  FormatString(builder, str, tmp_params, case_index, game_script, dry_run);
}
 
struct LanguagePack : public LanguagePackHeader {
  char data[]; // list of strings
};
 
struct LanguagePackDeleter {
  void operator()(LanguagePack *langpack)
  {
    /* LanguagePack is in fact reinterpreted char[], we need to reinterpret it back to free it properly. */
    delete[] reinterpret_cast<char *>(langpack);
  }
};
 
struct LoadedLanguagePack {
  std::unique_ptr<LanguagePack, LanguagePackDeleter> langpack;
 
  std::vector<std::string_view> strings;
 
  std::array<uint, TEXT_TAB_END> langtab_num;   
  std::array<uint, TEXT_TAB_END> langtab_start; 
 
  std::string list_separator; 
  std::string ellipsis; 
};
 
static LoadedLanguagePack _langpack;
 
static bool _scan_for_gender_data = false;  
 
std::string_view GetListSeparator()
{
  return _langpack.list_separator;
}
 
std::string_view GetEllipsis()
{
  return _langpack.ellipsis;
}
 
std::string_view GetStringPtr(StringID string)
{
  switch (GetStringTab(string)) {
    case TEXT_TAB_GAMESCRIPT_START: return GetGameStringPtr(GetStringIndex(string));
    /* 0xD0xx and 0xD4xx IDs have been converted earlier. */
    case TEXT_TAB_OLD_NEWGRF: NOT_REACHED();
    case TEXT_TAB_NEWGRF_START: return GetGRFStringPtr(GetStringIndex(string));
    default: {
      const size_t offset = _langpack.langtab_start[GetStringTab(string)] + GetStringIndex(string).base();
      if (offset < _langpack.strings.size()) return _langpack.strings[offset];
      return "(undefined string)";
    }
  }
}
 
void GetStringWithArgs(StringBuilder &builder, StringID string, StringParameters &args, uint case_index, bool game_script)
{
  if (string == 0) {
    GetStringWithArgs(builder, STR_UNDEFINED, args);
    return;
  }
 
  StringIndexInTab index = GetStringIndex(string);
  StringTab tab = GetStringTab(string);
 
  switch (tab) {
    case TEXT_TAB_TOWN:
      if (IsInsideMM(string, SPECSTR_TOWNNAME_START, SPECSTR_TOWNNAME_END) && !game_script) {
        try {
          GenerateTownNameString(builder, string - SPECSTR_TOWNNAME_START, args.GetNextParameter<uint32_t>());
        } catch (const std::runtime_error &e) {
          Debug(misc, 0, "GetStringWithArgs: {}", e.what());
          builder += "(invalid string parameter)";
        }
        return;
      }
      break;
 
    case TEXT_TAB_SPECIAL:
      if (!game_script) {
        try {
          if (GetSpecialNameString(builder, string, args)) return;
        } catch (const std::runtime_error &e) {
          Debug(misc, 0, "GetStringWithArgs: {}", e.what());
          builder += "(invalid string parameter)";
          return;
        }
      }
      break;
 
    case TEXT_TAB_OLD_CUSTOM:
      /* Old table for custom names. This is no longer used */
      if (!game_script) {
        FatalError("Incorrect conversion of custom name string.");
      }
      break;
 
    case TEXT_TAB_GAMESCRIPT_START: {
      FormatString(builder, GetGameStringPtr(index), args, case_index, true);
      return;
    }
 
    case TEXT_TAB_OLD_NEWGRF:
      NOT_REACHED();
 
    case TEXT_TAB_NEWGRF_START: {
      FormatString(builder, GetGRFStringPtr(index), args, case_index);
      return;
    }
 
    default:
      break;
  }
 
  if (index >= _langpack.langtab_num[tab]) {
    if (game_script) {
      return GetStringWithArgs(builder, STR_UNDEFINED, args);
    }
    FatalError("String 0x{:X} is invalid. You are probably using an old version of the .lng file.\n", string);
  }
 
  FormatString(builder, GetStringPtr(string), args, case_index);
}
 
void GetStringWithArgs(StringBuilder &builder, StringID string, std::span<StringParameter> params, uint case_index, bool game_script)
{
  StringParameters tmp_params{params};
  GetStringWithArgs(builder, string, tmp_params, case_index, game_script);
}
 
std::string GetString(StringID string)
{
  return GetStringWithArgs(string, {});
}
 
void AppendStringInPlace(std::string &result, StringID string)
{
  StringBuilder builder(result);
  GetStringWithArgs(builder, string, {});
}
 
void AppendStringWithArgsInPlace(std::string &result, StringID string, std::span<StringParameter> params)
{
  StringParameters tmp_params{params};
  StringBuilder builder(result);
  GetStringWithArgs(builder, string, tmp_params);
}
 
std::string GetStringWithArgs(StringID string, StringParameters &args)
{
  std::string result;
  StringBuilder builder(result);
  GetStringWithArgs(builder, string, args);
  return result;
}
 
std::string GetStringWithArgs(StringID string, std::span<StringParameter> args)
{
  std::string result;
  StringBuilder builder(result);
  GetStringWithArgs(builder, string, args);
  return result;
}
 
static std::string_view GetDecimalSeparator()
{
  std::string_view decimal_separator = _settings_game.locale.digit_decimal_separator;
  if (decimal_separator.empty()) decimal_separator = _langpack.langpack->digit_decimal_separator;
  return decimal_separator;
}
 
static void FormatNumber(StringBuilder &builder, int64_t number, std::string_view separator)
{
  static const int max_digits = 20;
  uint64_t divisor = 10000000000000000000ULL;
  int thousands_offset = (max_digits - 1) % 3;
 
  if (number < 0) {
    builder.PutChar('-');
    number = -number;
  }
 
  uint64_t num = number;
  uint64_t tot = 0;
  for (int i = 0; i < max_digits; i++) {
    uint64_t quot = 0;
    if (num >= divisor) {
      quot = num / divisor;
      num = num % divisor;
    }
    if ((tot |= quot) || i == max_digits - 1) {
      builder.PutChar('0' + quot); // quot is a single digit
      if ((i % 3) == thousands_offset && i < max_digits - 1) builder += separator;
    }
 
    divisor /= 10;
  }
}
 
static void FormatCommaNumber(StringBuilder &builder, int64_t number)
{
  std::string_view separator = _settings_game.locale.digit_group_separator;
  if (separator.empty()) separator = _langpack.langpack->digit_group_separator;
  FormatNumber(builder, number, separator);
}
 
static void FormatNoCommaNumber(StringBuilder &builder, int64_t number)
{
  fmt::format_to(builder.back_inserter(), "{}", number);
}
 
static void FormatZerofillNumber(StringBuilder &builder, int64_t number, int count)
{
  fmt::format_to(builder.back_inserter(), "{:0{}d}", number, count);
}
 
static void FormatHexNumber(StringBuilder &builder, uint64_t number)
{
  fmt::format_to(builder.back_inserter(), "0x{:X}", number);
}
 
static void FormatBytes(StringBuilder &builder, int64_t number)
{
  assert(number >= 0);
 
  /*                                              1   2^10  2^20  2^30  2^40  2^50  2^60 */
  static const std::string_view iec_prefixes[] = {"", "Ki", "Mi", "Gi", "Ti", "Pi", "Ei"};
  uint id = 1;
  while (number >= 1024 * 1024) {
    number /= 1024;
    id++;
  }
 
  if (number < 1024) {
    id = 0;
    fmt::format_to(builder.back_inserter(), "{}", number);
  } else if (number < 1024 * 10) {
    fmt::format_to(builder.back_inserter(), "{}{}{:02}", number / 1024, GetDecimalSeparator(), (number % 1024) * 100 / 1024);
  } else if (number < 1024 * 100) {
    fmt::format_to(builder.back_inserter(), "{}{}{:01}", number / 1024, GetDecimalSeparator(), (number % 1024) * 10 / 1024);
  } else {
    assert(number < 1024 * 1024);
    fmt::format_to(builder.back_inserter(), "{}", number / 1024);
  }
 
  assert(id < lengthof(iec_prefixes));
  fmt::format_to(builder.back_inserter(), NBSP "{}B", iec_prefixes[id]);
}
 
static void FormatYmdString(StringBuilder &builder, TimerGameCalendar::Date date, uint case_index)
{
  TimerGameCalendar::YearMonthDay ymd = TimerGameCalendar::ConvertDateToYMD(date);
 
  auto tmp_params = MakeParameters(STR_DAY_NUMBER_1ST + ymd.day - 1, STR_MONTH_ABBREV_JAN + ymd.month, ymd.year);
  FormatString(builder, GetStringPtr(STR_FORMAT_DATE_LONG), tmp_params, case_index);
}
 
static void FormatMonthAndYear(StringBuilder &builder, TimerGameCalendar::Date date, uint case_index)
{
  TimerGameCalendar::YearMonthDay ymd = TimerGameCalendar::ConvertDateToYMD(date);
 
  auto tmp_params = MakeParameters(STR_MONTH_JAN + ymd.month, ymd.year);
  FormatString(builder, GetStringPtr(STR_FORMAT_DATE_SHORT), tmp_params, case_index);
}
 
static void FormatTinyOrISODate(StringBuilder &builder, TimerGameCalendar::Date date, StringID str)
{
  TimerGameCalendar::YearMonthDay ymd = TimerGameCalendar::ConvertDateToYMD(date);
 
  /* Day and month are zero-padded with ZEROFILL_NUM, hence the two 2s. */
  auto tmp_params = MakeParameters(ymd.day, 2, ymd.month + 1, 2, ymd.year);
  FormatString(builder, GetStringPtr(str), tmp_params);
}
 
static void FormatGenericCurrency(StringBuilder &builder, const CurrencySpec *spec, Money number, bool compact)
{
  /* We are going to make number absolute for printing, so
   * keep this piece of data as we need it later on */
  bool negative = number < 0;
 
  number *= spec->rate;
 
  /* convert from negative */
  if (number < 0) {
    builder.PutUtf8(SCC_PUSH_COLOUR);
    builder.PutUtf8(SCC_RED);
    builder.PutChar('-');
    number = -number;
  }
 
  /* Add prefix part, following symbol_pos specification.
   * Here, it can can be either 0 (prefix) or 2 (both prefix and suffix).
   * The only remaining value is 1 (suffix), so everything that is not 1 */
  if (spec->symbol_pos != 1) builder += spec->prefix;
 
  StringID number_str = STR_NULL;
 
  /* For huge numbers, compact the number. */
  if (compact) {
    /* Take care of the thousand rounding. Having 1 000 000 k
     * and 1 000 M is inconsistent, so always use 1 000 M. */
    if (number >= Money(1'000'000'000'000'000) - 500'000'000) {
      number = (number + Money(500'000'000'000)) / Money(1'000'000'000'000);
      number_str = STR_CURRENCY_SHORT_TERA;
    } else if (number >= Money(1'000'000'000'000) - 500'000) {
      number = (number + 500'000'000) / 1'000'000'000;
      number_str = STR_CURRENCY_SHORT_GIGA;
    } else if (number >= 1'000'000'000 - 500) {
      number = (number + 500'000) / 1'000'000;
      number_str = STR_CURRENCY_SHORT_MEGA;
    } else if (number >= 1'000'000) {
      number = (number + 500) / 1'000;
      number_str = STR_CURRENCY_SHORT_KILO;
    }
  }
 
  std::string_view separator = _settings_game.locale.digit_group_separator_currency;
  if (separator.empty()) separator = GetCurrency().separator;
  if (separator.empty()) separator = _langpack.langpack->digit_group_separator_currency;
  FormatNumber(builder, number, separator);
  if (number_str != STR_NULL) {
    FormatString(builder, GetStringPtr(number_str), {});
  }
 
  /* Add suffix part, following symbol_pos specification.
   * Here, it can can be either 1 (suffix) or 2 (both prefix and suffix).
   * The only remaining value is 1 (prefix), so everything that is not 0 */
  if (spec->symbol_pos != 0) builder += spec->suffix;
 
  if (negative) {
    builder.PutUtf8(SCC_POP_COLOUR);
  }
}
 
static int DeterminePluralForm(int64_t count, uint plural_form)
{
  /* The absolute value determines plurality */
  uint64_t n = abs(count);
 
  switch (plural_form) {
    default:
      NOT_REACHED();
 
    /* Two forms: singular used for one only.
     * Used in:
     *   Danish, Dutch, English, German, Norwegian, Swedish, Estonian, Finnish,
     *   Greek, Hebrew, Italian, Portuguese, Spanish, Esperanto */
    case 0:
      return n != 1 ? 1 : 0;
 
    /* Only one form.
     * Used in:
     *   Hungarian, Japanese, Turkish */
    case 1:
      return 0;
 
    /* Two forms: singular used for 0 and 1.
     * Used in:
     *   French, Brazilian Portuguese */
    case 2:
      return n > 1 ? 1 : 0;
 
    /* Three forms: special cases for 0, and numbers ending in 1 except when ending in 11.
     * Note: Cases are out of order for hysterical reasons. '0' is last.
     * Used in:
     *   Latvian */
    case 3:
      return n % 10 == 1 && n % 100 != 11 ? 0 : n != 0 ? 1 : 2;
 
    /* Five forms: special cases for 1, 2, 3 to 6, and 7 to 10.
     * Used in:
     *   Gaelige (Irish) */
    case 4:
      return n == 1 ? 0 : n == 2 ? 1 : n < 7 ? 2 : n < 11 ? 3 : 4;
 
    /* Three forms: special cases for numbers ending in 1 except when ending in 11, and 2 to 9 except when ending in 12 to 19.
     * Used in:
     *   Lithuanian */
    case 5:
      return n % 10 == 1 && n % 100 != 11 ? 0 : n % 10 >= 2 && (n % 100 < 10 || n % 100 >= 20) ? 1 : 2;
 
    /* Three forms: special cases for numbers ending in 1 except when ending in 11, and 2 to 4 except when ending in 12 to 14.
     * Used in:
     *   Croatian, Russian, Ukrainian */
    case 6:
      return n % 10 == 1 && n % 100 != 11 ? 0 : n % 10 >= 2 && n % 10 <= 4 && (n % 100 < 10 || n % 100 >= 20) ? 1 : 2;
 
    /* Three forms: special cases for 1, and numbers ending in 2 to 4 except when ending in 12 to 14.
     * Used in:
     *   Polish */
    case 7:
      return n == 1 ? 0 : n % 10 >= 2 && n % 10 <= 4 && (n % 100 < 10 || n % 100 >= 20) ? 1 : 2;
 
    /* Four forms: special cases for numbers ending in 01, 02, and 03 to 04.
     * Used in:
     *   Slovenian */
    case 8:
      return n % 100 == 1 ? 0 : n % 100 == 2 ? 1 : n % 100 == 3 || n % 100 == 4 ? 2 : 3;
 
    /* Two forms: singular used for numbers ending in 1 except when ending in 11.
     * Used in:
     *   Icelandic */
    case 9:
      return n % 10 == 1 && n % 100 != 11 ? 0 : 1;
 
    /* Three forms: special cases for 1, and 2 to 4
     * Used in:
     *   Czech, Slovak */
    case 10:
      return n == 1 ? 0 : n >= 2 && n <= 4 ? 1 : 2;
 
    /* Two forms: cases for numbers ending with a consonant, and with a vowel.
     * Korean doesn't have the concept of plural, but depending on how a
     * number is pronounced it needs another version of a particle.
     * As such the plural system is misused to give this distinction.
     */
    case 11:
      switch (n % 10) {
        case 0: // yeong
        case 1: // il
        case 3: // sam
        case 6: // yuk
        case 7: // chil
        case 8: // pal
          return 0;
 
        case 2: // i
        case 4: // sa
        case 5: // o
        case 9: // gu
          return 1;
 
        default:
          NOT_REACHED();
      }
 
    /* Four forms: special cases for 1, 0 and numbers ending in 02 to 10, and numbers ending in 11 to 19.
     * Used in:
     *  Maltese */
    case 12:
      return (n == 1 ? 0 : n == 0 || (n % 100 > 1 && n % 100 < 11) ? 1 : (n % 100 > 10 && n % 100 < 20) ? 2 : 3);
    /* Four forms: special cases for 1 and 11, 2 and 12, 3 .. 10 and 13 .. 19, other
     * Used in:
     *  Scottish Gaelic */
    case 13:
      return ((n == 1 || n == 11) ? 0 : (n == 2 || n == 12) ? 1 : ((n > 2 && n < 11) || (n > 12 && n < 20)) ? 2 : 3);
 
    /* Three forms: special cases for 1, 0 and numbers ending in 01 to 19.
     * Used in:
     *   Romanian */
    case 14:
      return n == 1 ? 0 : (n == 0 || (n % 100 > 0 && n % 100 < 20)) ? 1 : 2;
  }
}
 
static void SkipStringChoice(StringConsumer &consumer)
{
  uint n = consumer.ReadUint8();
  uint len = 0;
  for (uint i = 0; i != n; i++) {
    len += consumer.ReadUint8();
  }
  consumer.Skip(len);
}
 
static void ParseStringChoice(StringConsumer &consumer, uint form, StringBuilder &builder)
{
  /* <NUM> {Length of each string} {each string} */
  uint n = consumer.ReadUint8();
  size_t form_pre = 0, form_len = 0, form_post = 0;
  for (uint i = 0; i != n; i++) {
    uint len = consumer.ReadUint8();
    if (i < form) {
      form_pre += len;
    } else if (i > form) {
      form_post += len;
    } else {
      form_len = len;
    }
  }
 
  consumer.Skip(form_pre);
  builder += consumer.Read(form_len);
  consumer.Skip(form_post);
}
 
struct UnitConversion {
  double factor; 
 
  int64_t ToDisplay(int64_t input, bool round = true) const
  {
    return round
      ? (int64_t)std::round(input * this->factor)
      : (int64_t)(input * this->factor);
  }
 
  int64_t FromDisplay(int64_t input, bool round = true, int64_t divider = 1) const
  {
    return round
      ? (int64_t)std::round(input / this->factor / divider)
      : (int64_t)(input / this->factor / divider);
  }
};
 
struct Units {
  UnitConversion c; 
  StringID s;       
  unsigned int decimal_places; 
};
 
struct UnitsLong {
  UnitConversion c; 
  StringID s;       
  StringID l;       
  unsigned int decimal_places; 
};
 
static const Units _units_velocity_calendar[] = {
  { { 1.0      }, STR_UNITS_VELOCITY_IMPERIAL,      0 },
  { { 1.609344 }, STR_UNITS_VELOCITY_METRIC,        0 },
  { { 0.44704  }, STR_UNITS_VELOCITY_SI,            0 },
  { { 0.578125 }, STR_UNITS_VELOCITY_GAMEUNITS_DAY, 1 },
  { { 0.868976 }, STR_UNITS_VELOCITY_KNOTS,         0 },
};
 
static const Units _units_velocity_realtime[] = {
  { { 1.0      }, STR_UNITS_VELOCITY_IMPERIAL,      0 },
  { { 1.609344 }, STR_UNITS_VELOCITY_METRIC,        0 },
  { { 0.44704  }, STR_UNITS_VELOCITY_SI,            0 },
  { { 0.289352 }, STR_UNITS_VELOCITY_GAMEUNITS_SEC, 1 },
  { { 0.868976 }, STR_UNITS_VELOCITY_KNOTS,         0 },
};
 
static const Units _units_power[] = {
  { { 1.0      }, STR_UNITS_POWER_IMPERIAL, 0 },
  { { 1.01387  }, STR_UNITS_POWER_METRIC,   0 },
  { { 0.745699 }, STR_UNITS_POWER_SI,       0 },
};
 
static const Units _units_power_to_weight[] = {
  { { 0.907185 }, STR_UNITS_POWER_IMPERIAL_TO_WEIGHT_IMPERIAL, 1 },
  { { 1.0      }, STR_UNITS_POWER_IMPERIAL_TO_WEIGHT_METRIC,   1 },
  { { 1.0      }, STR_UNITS_POWER_IMPERIAL_TO_WEIGHT_SI,       1 },
  { { 0.919768 }, STR_UNITS_POWER_METRIC_TO_WEIGHT_IMPERIAL,   1 },
  { { 1.01387  }, STR_UNITS_POWER_METRIC_TO_WEIGHT_METRIC,     1 },
  { { 1.01387  }, STR_UNITS_POWER_METRIC_TO_WEIGHT_SI,         1 },
  { { 0.676487 }, STR_UNITS_POWER_SI_TO_WEIGHT_IMPERIAL,       1 },
  { { 0.745699 }, STR_UNITS_POWER_SI_TO_WEIGHT_METRIC,         1 },
  { { 0.745699 }, STR_UNITS_POWER_SI_TO_WEIGHT_SI,             1 },
};
 
static const UnitsLong _units_weight[] = {
  { {    1.102311 }, STR_UNITS_WEIGHT_SHORT_IMPERIAL, STR_UNITS_WEIGHT_LONG_IMPERIAL, 0 },
  { {    1.0      }, STR_UNITS_WEIGHT_SHORT_METRIC,   STR_UNITS_WEIGHT_LONG_METRIC,   0 },
  { { 1000.0      }, STR_UNITS_WEIGHT_SHORT_SI,       STR_UNITS_WEIGHT_LONG_SI,       0 },
};
 
static const UnitsLong _units_volume[] = {
  { {  264.172 }, STR_UNITS_VOLUME_SHORT_IMPERIAL, STR_UNITS_VOLUME_LONG_IMPERIAL, 0 },
  { { 1000.0   }, STR_UNITS_VOLUME_SHORT_METRIC,   STR_UNITS_VOLUME_LONG_METRIC,   0 },
  { {    1.0   }, STR_UNITS_VOLUME_SHORT_SI,       STR_UNITS_VOLUME_LONG_SI,       0 },
};
 
static const Units _units_force[] = {
  { { 0.224809 }, STR_UNITS_FORCE_IMPERIAL, 0 },
  { { 0.101972 }, STR_UNITS_FORCE_METRIC,   0 },
  { { 0.001    }, STR_UNITS_FORCE_SI,       0 },
};
 
static const Units _units_height[] = {
  { { 3.0 }, STR_UNITS_HEIGHT_IMPERIAL, 0 }, // "Wrong" conversion factor for more nicer GUI values
  { { 1.0 }, STR_UNITS_HEIGHT_METRIC,   0 },
  { { 1.0 }, STR_UNITS_HEIGHT_SI,       0 },
  { { .02 }, STR_UNITS_HEIGHT_GAMEUNITS,0 },
};
 
static const Units _units_time_days_or_seconds[] = {
  { { 1 }, STR_UNITS_DAYS,    0 },
  { { 2 }, STR_UNITS_SECONDS, 0 },
};
 
static const Units _units_time_months_or_minutes[] = {
  { { 1 }, STR_UNITS_MONTHS,  0 },
  { { 1 }, STR_UNITS_MINUTES, 0 },
};
 
static const Units _units_time_years_or_periods[] = {
  { { 1 }, STR_UNITS_YEARS,  0 },
  { { 1 }, STR_UNITS_PERIODS, 0 },
};
 
static const Units _units_time_years_or_minutes[] = {
  { { 1  }, STR_UNITS_YEARS,  0 },
  { { 12 }, STR_UNITS_MINUTES, 0 },
};
 
static const Units GetVelocityUnits(VehicleType type)
{
  uint8_t setting = (type == VEH_SHIP || type == VEH_AIRCRAFT) ? _settings_game.locale.units_velocity_nautical : _settings_game.locale.units_velocity;
 
  assert(setting < lengthof(_units_velocity_calendar));
  assert(setting < lengthof(_units_velocity_realtime));
 
  if (TimerGameEconomy::UsingWallclockUnits()) return _units_velocity_realtime[setting];
 
  return _units_velocity_calendar[setting];
}
 
uint ConvertSpeedToDisplaySpeed(uint speed, VehicleType type)
{
  /* For historical reasons we don't want to mess with the
   * conversion for speed. So, don't round it and keep the
   * original conversion factors instead of the real ones. */
  return GetVelocityUnits(type).c.ToDisplay(speed, false);
}
 
uint ConvertDisplaySpeedToSpeed(uint speed, VehicleType type)
{
  return GetVelocityUnits(type).c.FromDisplay(speed);
}
 
uint ConvertKmhishSpeedToDisplaySpeed(uint speed, VehicleType type)
{
  return GetVelocityUnits(type).c.ToDisplay(speed * 10, false) / 16;
}
 
uint ConvertDisplaySpeedToKmhishSpeed(uint speed, VehicleType type)
{
  return GetVelocityUnits(type).c.FromDisplay(speed * 16, true, 10);
}
 
static void DecodeEncodedString(StringConsumer &consumer, bool game_script, StringBuilder &builder)
{
  std::vector<StringParameter> sub_args;
 
  StringIndexInTab id(consumer.ReadIntegerBase<uint32_t>(16));
  if (consumer.AnyBytesLeft() && !consumer.PeekUtf8If(SCC_RECORD_SEPARATOR)) {
    consumer.SkipAll();
    builder += "(invalid SCC_ENCODED)";
    return;
  }
  if (game_script && id >= TAB_SIZE_GAMESCRIPT) {
    consumer.SkipAll();
    builder += "(invalid StringID)";
    return;
  }
 
  while (consumer.AnyBytesLeft()) {
    consumer.SkipUtf8If(SCC_RECORD_SEPARATOR);
    StringConsumer record(consumer.ReadUntilUtf8(SCC_RECORD_SEPARATOR, StringConsumer::KEEP_SEPARATOR));
 
    if (!record.AnyBytesLeft()) {
      /* This is an empty parameter. */
      sub_args.emplace_back(std::monostate{});
      continue;
    }
 
    /* Get the parameter type. */
    char32_t parameter_type = record.ReadUtf8();
    switch (parameter_type) {
      case SCC_ENCODED: {
        uint64_t param = record.ReadIntegerBase<uint64_t>(16);
        if (param >= TAB_SIZE_GAMESCRIPT) {
          builder += "(invalid sub-StringID)";
          return;
        }
        assert(!record.AnyBytesLeft());
        param = MakeStringID(TEXT_TAB_GAMESCRIPT_START, StringIndexInTab(param));
        sub_args.emplace_back(param);
        break;
      }
 
      case SCC_ENCODED_NUMERIC: {
        uint64_t param = record.ReadIntegerBase<uint64_t>(16);
        assert(!record.AnyBytesLeft());
        sub_args.emplace_back(param);
        break;
      }
 
      case SCC_ENCODED_STRING: {
        sub_args.emplace_back(record.Read(StringConsumer::npos));
        break;
      }
 
      default:
        /* Unknown parameter, make it blank. */
        sub_args.emplace_back(std::monostate{});
        break;
    }
  }
 
  StringID stringid = game_script ? MakeStringID(TEXT_TAB_GAMESCRIPT_START, id) : StringID{id.base()};
  GetStringWithArgs(builder, stringid, sub_args, true);
}
 
static bool IsColourSafe(std::string_view buffer)
{
  int safety = 0;
  for (char32_t ch : Utf8View(buffer)) {
    if (ch == SCC_PUSH_COLOUR) {
      ++safety;
    } else if (ch == SCC_POP_COLOUR) {
      --safety;
      if (safety < 0) return false;
    } else if ((ch >= SCC_BLUE && ch <= SCC_BLACK) || ch == SCC_COLOUR) {
      if (safety == 0) return false;
    }
  }
  return true;
}
 
static void FormatString(StringBuilder &builder, std::string_view str_arg, StringParameters &args, uint orig_case_index, bool game_script, bool dry_run)
{
  size_t orig_first_param_offset = args.GetOffset();
  bool emit_automatic_push_pop = false;
 
  if (!dry_run) {
    /*
     * This function is normally called with `dry_run` false, then we call this function again
     * with `dry_run` being true. The dry run is required for the gender formatting. For the
     * gender determination we need to format a sub string to get the gender, but for that we
     * need to know as what string control code type the specific parameter is encoded. Since
     * gendered words can be before the "parameter" words, this needs to be determined before
     * the actual formatting.
     */
    std::string buffer;
    StringBuilder dry_run_builder(buffer);
    FormatString(dry_run_builder, str_arg, args, orig_case_index, game_script, true);
    emit_automatic_push_pop = !IsColourSafe(buffer);
    /* We have to restore the original offset here to to read the correct values. */
    args.SetOffset(orig_first_param_offset);
  }
  uint next_substr_case_index = 0;
  struct StrStackItem {
    StringConsumer consumer;
    size_t first_param_offset;
    uint case_index;
 
    StrStackItem(std::string_view view, size_t first_param_offset, uint case_index)
      : consumer(view), first_param_offset(first_param_offset), case_index(case_index)
    {}
  };
  std::stack<StrStackItem, std::vector<StrStackItem>> str_stack;
  str_stack.emplace(str_arg, orig_first_param_offset, orig_case_index);
 
  if (emit_automatic_push_pop) builder.PutUtf8(SCC_PUSH_COLOUR);
 
  for (;;) {
    try {
      while (!str_stack.empty() && !str_stack.top().consumer.AnyBytesLeft()) {
        str_stack.pop();
      }
      if (str_stack.empty()) break;
      StringConsumer &consumer = str_stack.top().consumer;
      const size_t ref_param_offset = str_stack.top().first_param_offset;
      const uint case_index = str_stack.top().case_index;
      char32_t b = consumer.ReadUtf8();
      assert(b != 0);
      if (b == 0) {
        /* A NUL character should never be encountered, but for non-debug builds handle it gracefully. */
        builder += "(unexpected NUL)";
        continue;
      }
 
      if (SCC_NEWGRF_FIRST <= b && b <= SCC_NEWGRF_LAST) {
        /* We need to pass some stuff as it might be modified. */
        b = RemapNewGRFStringControlCode(b, consumer);
        if (b == 0) continue;
      }
 
      if (b < SCC_CONTROL_START || b > SCC_CONTROL_END) {
        builder.PutUtf8(b);
        continue;
      }
 
      args.SetTypeOfNextParameter(b);
      switch (b) {
        case SCC_ENCODED:
        case SCC_ENCODED_INTERNAL:
          DecodeEncodedString(consumer, b == SCC_ENCODED, builder);
          break;
 
        case SCC_NEWGRF_STRINL: {
          StringID substr = consumer.ReadUtf8(STR_NULL);
          std::string_view ptr = GetStringPtr(substr);
          str_stack.emplace(ptr, args.GetOffset(), next_substr_case_index); // this may invalidate "consumer"
          next_substr_case_index = 0;
          break;
        }
 
        case SCC_NEWGRF_PRINT_WORD_STRING_ID: {
          StringID substr = args.GetNextParameter<StringID>();
          std::string_view ptr = GetStringPtr(substr);
          str_stack.emplace(ptr, args.GetOffset(), next_substr_case_index); // this may invalidate "consumer"
          next_substr_case_index = 0;
          break;
        }
 
        case SCC_GENDER_LIST: { // {G 0 Der Die Das}
          /* First read the meta data from the language file. */
          size_t offset = ref_param_offset + consumer.ReadUint8();
          uint8_t gender = 0;
          if (offset >= args.GetNumParameters()) {
            /* The offset may come from an external NewGRF, and be invalid. */
            builder += "(invalid GENDER parameter)";
          } else if (!dry_run && args.GetTypeAtOffset(offset) != 0) {
            /* Now we need to figure out what text to resolve, i.e.
             * what do we need to draw? So get the actual raw string
             * first using the control code to get said string. */
            std::string input;
            {
              StringBuilder tmp_builder(input);
              tmp_builder.PutUtf8(args.GetTypeAtOffset(offset));
            }
 
            std::string buffer;
            {
              AutoRestoreBackup sgd_backup(_scan_for_gender_data, true);
              StringBuilder tmp_builder(buffer);
              StringParameters tmp_params = args.GetRemainingParameters(offset);
              FormatString(tmp_builder, input, tmp_params);
            }
 
            /* The gender is stored at the start of the formatted string.
             * Does this string have a gender, if so, set it. */
            StringConsumer gender_consumer(buffer);
            if (gender_consumer.ReadUtf8If(SCC_GENDER_INDEX)) {
              gender = gender_consumer.ReadUint8();
            }
          }
          ParseStringChoice(consumer, gender, builder);
          break;
        }
 
        /* This sets up the gender for the string.
         * We just ignore this one. It's used in {G 0 Der Die Das} to determine the case. */
        case SCC_GENDER_INDEX: { // {GENDER 0}
          uint8_t gender = consumer.ReadUint8();
          if (_scan_for_gender_data) {
            builder.PutUtf8(SCC_GENDER_INDEX);
            builder.PutUint8(gender);
          }
          break;
        }
 
        case SCC_PLURAL_LIST: { // {P}
          uint8_t plural_form = consumer.ReadUint8();  // contains the plural form for this string
          size_t offset = ref_param_offset + consumer.ReadUint8();
          const uint64_t *v = nullptr;
          /* The offset may come from an external NewGRF, and be invalid. */
          if (offset < args.GetNumParameters()) {
            v = std::get_if<uint64_t>(&args.GetParam(offset)); // contains the number that determines plural
          }
          if (v != nullptr) {
            ParseStringChoice(consumer, DeterminePluralForm(static_cast<int64_t>(*v), plural_form), builder);
          } else {
            SkipStringChoice(consumer);
            builder += "(invalid PLURAL parameter)";
          }
          break;
        }
 
        case SCC_ARG_INDEX: { // Move argument pointer
          args.SetOffset(ref_param_offset + consumer.ReadUint8());
          break;
        }
 
        case SCC_SET_CASE: { // {SET_CASE}
          /* This is a pseudo command, it's outputted when someone does {STRING.ack}
           * The modifier is added to all subsequent GetStringWithArgs that accept the modifier. */
          next_substr_case_index = consumer.ReadUint8();
          break;
        }
 
        case SCC_SWITCH_CASE: { // {Used to implement case switching}
          /* <0x9E> <NUM CASES> <CASE1> <LEN1> <STRING1> <CASE2> <LEN2> <STRING2> <CASE3> <LEN3> <STRING3> <LENDEFAULT> <STRINGDEFAULT>
           * Each LEN is printed using 2 bytes in little endian order. */
          uint num = consumer.ReadUint8();
          std::optional<std::string_view> found;
          for (; num > 0; --num) {
            uint8_t index = consumer.ReadUint8();
            uint16_t len = consumer.ReadUint16LE();
            auto case_str = consumer.Read(len);
            if (index == case_index) {
              /* Found the case */
              found = case_str;
            }
          }
          uint16_t default_len = consumer.ReadUint16LE();
          auto default_str = consumer.Read(default_len);
          if (!found.has_value()) found = default_str;
          str_stack.emplace(*found, ref_param_offset, case_index); // this may invalidate "consumer"
          break;
        }
 
        case SCC_REVISION: // {REV}
          builder += _openttd_revision;
          break;
 
        case SCC_RAW_STRING_POINTER: // {RAW_STRING}
          FormatString(builder, args.GetNextParameterString(), args);
          break;
 
        case SCC_STRING: {// {STRING}
          StringID string_id = args.GetNextParameter<StringID>();
          if (game_script && GetStringTab(string_id) != TEXT_TAB_GAMESCRIPT_START) break;
          /* It's prohibited for the included string to consume any arguments. */
          StringParameters tmp_params(args, game_script ? args.GetDataLeft() : 0);
          GetStringWithArgs(builder, string_id, tmp_params, next_substr_case_index, game_script);
          next_substr_case_index = 0;
          break;
        }
 
        case SCC_STRING1:
        case SCC_STRING2:
        case SCC_STRING3:
        case SCC_STRING4:
        case SCC_STRING5:
        case SCC_STRING6:
        case SCC_STRING7: { // {STRING1..7}
          /* Strings that consume arguments */
          StringID string_id = args.GetNextParameter<StringID>();
          if (game_script && GetStringTab(string_id) != TEXT_TAB_GAMESCRIPT_START) break;
          uint size = b - SCC_STRING1 + 1;
          if (size > args.GetDataLeft()) {
            builder += "(consumed too many parameters)";
          } else {
            StringParameters sub_args(args, game_script ? args.GetDataLeft() : size);
            GetStringWithArgs(builder, string_id, sub_args, next_substr_case_index, game_script);
            args.AdvanceOffset(size);
          }
          next_substr_case_index = 0;
          break;
        }
 
        case SCC_COMMA: // {COMMA}
          FormatCommaNumber(builder, args.GetNextParameter<int64_t>());
          break;
 
        case SCC_DECIMAL: { // {DECIMAL}
          int64_t number = args.GetNextParameter<int64_t>();
          int digits = args.GetNextParameter<int>();
          if (digits == 0) {
            FormatCommaNumber(builder, number);
            break;
          }
 
          int64_t divisor = PowerOfTen(digits);
          int64_t fractional = number % divisor;
          number /= divisor;
          FormatCommaNumber(builder, number);
          fmt::format_to(builder.back_inserter(), "{}{:0{}d}", GetDecimalSeparator(), fractional, digits);
          break;
        }
 
        case SCC_NUM: // {NUM}
          FormatNoCommaNumber(builder, args.GetNextParameter<int64_t>());
          break;
 
        case SCC_ZEROFILL_NUM: { // {ZEROFILL_NUM}
          int64_t num = args.GetNextParameter<int64_t>();
          FormatZerofillNumber(builder, num, args.GetNextParameter<int>());
          break;
        }
 
        case SCC_HEX: // {HEX}
          FormatHexNumber(builder, args.GetNextParameter<uint64_t>());
          break;
 
        case SCC_BYTES: // {BYTES}
          FormatBytes(builder, args.GetNextParameter<int64_t>());
          break;
 
        case SCC_CARGO_TINY: { // {CARGO_TINY}
          /* Tiny description of cargotypes. Layout:
           * param 1: cargo type
           * param 2: cargo count */
          CargoType cargo = args.GetNextParameter<CargoType>();
          int64_t amount = args.GetNextParameter<int64_t>();
 
          if (cargo >= CargoSpec::GetArraySize()) {
            builder += "(invalid cargo type)";
            break;
          }
 
          switch (CargoSpec::Get(cargo)->units_volume) {
            case STR_TONS:
              amount = _units_weight[_settings_game.locale.units_weight].c.ToDisplay(amount);
              break;
 
            case STR_LITERS:
              amount = _units_volume[_settings_game.locale.units_volume].c.ToDisplay(amount);
              break;
 
            default:
              break;
          }
 
          FormatCommaNumber(builder, amount);
          break;
        }
 
        case SCC_CARGO_SHORT: { // {CARGO_SHORT}
          /* Short description of cargotypes. Layout:
           * param 1: cargo type
           * param 2: cargo count */
          CargoType cargo = args.GetNextParameter<CargoType>();
          int64_t amount = args.GetNextParameter<int64_t>();
 
          if (cargo >= CargoSpec::GetArraySize()) {
            builder += "(invalid cargo type)";
            break;
          }
 
          StringID cargo_str = CargoSpec::Get(cargo)->units_volume;
          switch (cargo_str) {
            case STR_TONS: {
              assert(_settings_game.locale.units_weight < lengthof(_units_weight));
              const auto &x = _units_weight[_settings_game.locale.units_weight];
              auto tmp_params = MakeParameters(x.c.ToDisplay(amount), x.decimal_places);
              FormatString(builder, GetStringPtr(x.l), tmp_params);
              break;
            }
 
            case STR_LITERS: {
              assert(_settings_game.locale.units_volume < lengthof(_units_volume));
              const auto &x = _units_volume[_settings_game.locale.units_volume];
              auto tmp_params = MakeParameters(x.c.ToDisplay(amount), x.decimal_places);
              FormatString(builder, GetStringPtr(x.l), tmp_params);
              break;
            }
 
            default: {
              auto tmp_params = MakeParameters(amount);
              GetStringWithArgs(builder, cargo_str, tmp_params);
              break;
            }
          }
          break;
        }
 
        case SCC_CARGO_LONG: { // {CARGO_LONG}
          /* First parameter is cargo type, second parameter is cargo count */
          CargoType cargo = args.GetNextParameter<CargoType>();
          int64_t amount = args.GetNextParameter<int64_t>();
          if (cargo < CargoSpec::GetArraySize()) {
            auto tmp_args = MakeParameters(amount);
            GetStringWithArgs(builder, CargoSpec::Get(cargo)->quantifier, tmp_args);
          } else if (!IsValidCargoType(cargo)) {
            GetStringWithArgs(builder, STR_QUANTITY_N_A, {});
          } else {
            builder += "(invalid cargo type)";
          }
          break;
        }
 
        case SCC_CARGO_LIST: { // {CARGO_LIST}
          CargoTypes cmask = args.GetNextParameter<CargoTypes>();
          bool first = true;
 
          std::string_view list_separator = GetListSeparator();
          for (const auto &cs : _sorted_cargo_specs) {
            if (!HasBit(cmask, cs->Index())) continue;
 
            if (first) {
              first = false;
            } else {
              /* Add a comma if this is not the first item */
              builder += list_separator;
            }
 
            GetStringWithArgs(builder, cs->name, args, next_substr_case_index, game_script);
          }
 
          /* If first is still true then no cargo is accepted */
          if (first) GetStringWithArgs(builder, STR_JUST_NOTHING, args, next_substr_case_index, game_script);
 
          next_substr_case_index = 0;
          break;
        }
 
        case SCC_CURRENCY_SHORT: // {CURRENCY_SHORT}
          FormatGenericCurrency(builder, &GetCurrency(), args.GetNextParameter<int64_t>(), true);
          break;
 
        case SCC_CURRENCY_LONG: // {CURRENCY_LONG}
          FormatGenericCurrency(builder, &GetCurrency(), args.GetNextParameter<int64_t>(), false);
          break;
 
        case SCC_DATE_TINY: // {DATE_TINY}
          FormatTinyOrISODate(builder, args.GetNextParameter<TimerGameCalendar::Date>(), STR_FORMAT_DATE_TINY);
          break;
 
        case SCC_DATE_SHORT: // {DATE_SHORT}
          FormatMonthAndYear(builder, args.GetNextParameter<TimerGameCalendar::Date>(), next_substr_case_index);
          next_substr_case_index = 0;
          break;
 
        case SCC_DATE_LONG: // {DATE_LONG}
          FormatYmdString(builder, args.GetNextParameter<TimerGameCalendar::Date>(), next_substr_case_index);
          next_substr_case_index = 0;
          break;
 
        case SCC_DATE_ISO: // {DATE_ISO}
          FormatTinyOrISODate(builder, args.GetNextParameter<TimerGameCalendar::Date>(), STR_FORMAT_DATE_ISO);
          break;
 
        case SCC_FORCE: { // {FORCE}
          assert(_settings_game.locale.units_force < lengthof(_units_force));
          const auto &x = _units_force[_settings_game.locale.units_force];
          auto tmp_params = MakeParameters(x.c.ToDisplay(args.GetNextParameter<int64_t>()), x.decimal_places);
          FormatString(builder, GetStringPtr(x.s), tmp_params);
          break;
        }
 
        case SCC_HEIGHT: { // {HEIGHT}
          assert(_settings_game.locale.units_height < lengthof(_units_height));
          const auto &x = _units_height[_settings_game.locale.units_height];
          auto tmp_params = MakeParameters(x.c.ToDisplay(args.GetNextParameter<int64_t>()), x.decimal_places);
          FormatString(builder, GetStringPtr(x.s), tmp_params);
          break;
        }
 
        case SCC_POWER: { // {POWER}
          assert(_settings_game.locale.units_power < lengthof(_units_power));
          const auto &x = _units_power[_settings_game.locale.units_power];
          auto tmp_params = MakeParameters(x.c.ToDisplay(args.GetNextParameter<int64_t>()), x.decimal_places);
          FormatString(builder, GetStringPtr(x.s), tmp_params);
          break;
        }
 
        case SCC_POWER_TO_WEIGHT: { // {POWER_TO_WEIGHT}
          auto setting = _settings_game.locale.units_power * 3u + _settings_game.locale.units_weight;
          assert(setting < lengthof(_units_power_to_weight));
          const auto &x = _units_power_to_weight[setting];
          auto tmp_params = MakeParameters(x.c.ToDisplay(args.GetNextParameter<int64_t>()), x.decimal_places);
          FormatString(builder, GetStringPtr(x.s), tmp_params);
          break;
        }
 
        case SCC_VELOCITY: { // {VELOCITY}
          int64_t arg = args.GetNextParameter<int64_t>();
          /* Unpack vehicle type from packed argument to get desired units. */
          VehicleType vt = static_cast<VehicleType>(GB(arg, 56, 8));
          const auto &x = GetVelocityUnits(vt);
          auto tmp_params = MakeParameters(ConvertKmhishSpeedToDisplaySpeed(GB(arg, 0, 56), vt), x.decimal_places);
          FormatString(builder, GetStringPtr(x.s), tmp_params);
          break;
        }
 
        case SCC_VOLUME_SHORT: { // {VOLUME_SHORT}
          assert(_settings_game.locale.units_volume < lengthof(_units_volume));
          const auto &x = _units_volume[_settings_game.locale.units_volume];
          auto tmp_params = MakeParameters(x.c.ToDisplay(args.GetNextParameter<int64_t>()), x.decimal_places);
          FormatString(builder, GetStringPtr(x.s), tmp_params);
          break;
        }
 
        case SCC_VOLUME_LONG: { // {VOLUME_LONG}
          assert(_settings_game.locale.units_volume < lengthof(_units_volume));
          const auto &x = _units_volume[_settings_game.locale.units_volume];
          auto tmp_params = MakeParameters(x.c.ToDisplay(args.GetNextParameter<int64_t>()), x.decimal_places);
          FormatString(builder, GetStringPtr(x.l), tmp_params);
          break;
        }
 
        case SCC_WEIGHT_SHORT: { // {WEIGHT_SHORT}
          assert(_settings_game.locale.units_weight < lengthof(_units_weight));
          const auto &x = _units_weight[_settings_game.locale.units_weight];
          auto tmp_params = MakeParameters(x.c.ToDisplay(args.GetNextParameter<int64_t>()), x.decimal_places);
          FormatString(builder, GetStringPtr(x.s), tmp_params);
          break;
        }
 
        case SCC_WEIGHT_LONG: { // {WEIGHT_LONG}
          assert(_settings_game.locale.units_weight < lengthof(_units_weight));
          const auto &x = _units_weight[_settings_game.locale.units_weight];
          auto tmp_params = MakeParameters(x.c.ToDisplay(args.GetNextParameter<int64_t>()), x.decimal_places);
          FormatString(builder, GetStringPtr(x.l), tmp_params);
          break;
        }
 
        case SCC_UNITS_DAYS_OR_SECONDS: { // {UNITS_DAYS_OR_SECONDS}
          uint8_t realtime = TimerGameEconomy::UsingWallclockUnits(_game_mode == GM_MENU);
          const auto &x = _units_time_days_or_seconds[realtime];
          auto tmp_params = MakeParameters(x.c.ToDisplay(args.GetNextParameter<int64_t>()), x.decimal_places);
          FormatString(builder, GetStringPtr(x.s), tmp_params);
          break;
        }
 
        case SCC_UNITS_MONTHS_OR_MINUTES: { // {UNITS_MONTHS_OR_MINUTES}
          uint8_t realtime = TimerGameEconomy::UsingWallclockUnits(_game_mode == GM_MENU);
          const auto &x = _units_time_months_or_minutes[realtime];
          auto tmp_params = MakeParameters(x.c.ToDisplay(args.GetNextParameter<int64_t>()), x.decimal_places);
          FormatString(builder, GetStringPtr(x.s), tmp_params);
          break;
        }
 
        case SCC_UNITS_YEARS_OR_PERIODS: { // {UNITS_YEARS_OR_PERIODS}
          uint8_t realtime = TimerGameEconomy::UsingWallclockUnits(_game_mode == GM_MENU);
          const auto &x = _units_time_years_or_periods[realtime];
          auto tmp_params = MakeParameters(x.c.ToDisplay(args.GetNextParameter<int64_t>()), x.decimal_places);
          FormatString(builder, GetStringPtr(x.s), tmp_params);
          break;
        }
 
        case SCC_UNITS_YEARS_OR_MINUTES: { // {UNITS_YEARS_OR_MINUTES}
          uint8_t realtime = TimerGameEconomy::UsingWallclockUnits(_game_mode == GM_MENU);
          const auto &x = _units_time_years_or_minutes[realtime];
          auto tmp_params = MakeParameters(x.c.ToDisplay(args.GetNextParameter<int64_t>()), x.decimal_places);
          FormatString(builder, GetStringPtr(x.s), tmp_params);
          break;
        }
 
        case SCC_COMPANY_NAME: { // {COMPANY}
          const Company *c = Company::GetIfValid(args.GetNextParameter<CompanyID>());
          if (c == nullptr) break;
 
          if (!c->name.empty()) {
            auto tmp_params = MakeParameters(c->name);
            GetStringWithArgs(builder, STR_JUST_RAW_STRING, tmp_params);
          } else {
            auto tmp_params = MakeParameters(c->name_2);
            GetStringWithArgs(builder, c->name_1, tmp_params);
          }
          break;
        }
 
        case SCC_COMPANY_NUM: { // {COMPANY_NUM}
          CompanyID company = args.GetNextParameter<CompanyID>();
 
          /* Nothing is added for AI or inactive companies */
          if (Company::IsValidHumanID(company)) {
            auto tmp_params = MakeParameters(company + 1);
            GetStringWithArgs(builder, STR_FORMAT_COMPANY_NUM, tmp_params);
          }
          break;
        }
 
        case SCC_DEPOT_NAME: { // {DEPOT}
          VehicleType vt = args.GetNextParameter<VehicleType>();
          if (vt == VEH_AIRCRAFT) {
            auto tmp_params = MakeParameters(args.GetNextParameter<StationID>());
            GetStringWithArgs(builder, STR_FORMAT_DEPOT_NAME_AIRCRAFT, tmp_params);
            break;
          }
 
          const Depot *d = Depot::Get(args.GetNextParameter<DepotID>());
          if (!d->name.empty()) {
            auto tmp_params = MakeParameters(d->name);
            GetStringWithArgs(builder, STR_JUST_RAW_STRING, tmp_params);
          } else {
            auto tmp_params = MakeParameters(d->town->index, d->town_cn + 1);
            GetStringWithArgs(builder, STR_FORMAT_DEPOT_NAME_TRAIN + 2 * vt + (d->town_cn == 0 ? 0 : 1), tmp_params);
          }
          break;
        }
 
        case SCC_ENGINE_NAME: { // {ENGINE}
          int64_t arg = args.GetNextParameter<int64_t>();
          const Engine *e = Engine::GetIfValid(static_cast<EngineID>(arg));
          if (e == nullptr) break;
 
          if (!e->name.empty() && e->IsEnabled()) {
            auto tmp_params = MakeParameters(e->name);
            GetStringWithArgs(builder, STR_JUST_RAW_STRING, tmp_params);
            break;
          }
 
          if (e->info.callback_mask.Test(VehicleCallbackMask::Name)) {
            std::array<int32_t, 16> regs100;
            uint16_t callback = GetVehicleCallback(CBID_VEHICLE_NAME, static_cast<uint32_t>(arg >> 32), 0, e->index, nullptr, regs100);
            /* Not calling ErrorUnknownCallbackResult due to being inside string processing. */
            if (callback == 0x40F) {
              const GRFFile *grffile = e->GetGRF();
              assert(grffile != nullptr);
 
              builder += GetGRFStringWithTextStack(grffile, static_cast<GRFStringID>(regs100[0]), std::span{regs100}.subspan(1));
              break;
            } else if (callback < 0x400) {
              const GRFFile *grffile = e->GetGRF();
              assert(grffile != nullptr);
 
              builder += GetGRFStringWithTextStack(grffile, GRFSTR_MISC_GRF_TEXT + callback, regs100);
              break;
            }
          }
 
          GetStringWithArgs(builder, e->info.string_id, {});
          break;
        }
 
        case SCC_GROUP_NAME: { // {GROUP}
          const Group *g = Group::GetIfValid(args.GetNextParameter<GroupID>());
          if (g == nullptr) break;
 
          if (!g->name.empty()) {
            auto tmp_params = MakeParameters(g->name);
            GetStringWithArgs(builder, STR_JUST_RAW_STRING, tmp_params);
          } else {
            auto tmp_params = MakeParameters(g->number);
            GetStringWithArgs(builder, STR_FORMAT_GROUP_NAME, tmp_params);
          }
          break;
        }
 
        case SCC_INDUSTRY_NAME: { // {INDUSTRY}
          const Industry *i = Industry::GetIfValid(args.GetNextParameter<IndustryID>());
          if (i == nullptr) break;
 
          static bool use_cache = true;
          if (_scan_for_gender_data) {
            /* Gender is defined by the industry type.
             * STR_FORMAT_INDUSTRY_NAME may have the town first, so it would result in the gender of the town name */
            FormatString(builder, GetStringPtr(GetIndustrySpec(i->type)->name), {}, next_substr_case_index);
          } else if (use_cache) { // Use cached version if first call
            AutoRestoreBackup cache_backup(use_cache, false);
            builder += i->GetCachedName();
          } else {
            /* First print the town name and the industry type name. */
            auto tmp_params = MakeParameters(i->town->index, GetIndustrySpec(i->type)->name);
            FormatString(builder, GetStringPtr(STR_FORMAT_INDUSTRY_NAME), tmp_params, next_substr_case_index);
          }
          next_substr_case_index = 0;
          break;
        }
 
        case SCC_PRESIDENT_NAME: { // {PRESIDENT_NAME}
          const Company *c = Company::GetIfValid(args.GetNextParameter<CompanyID>());
          if (c == nullptr) break;
 
          if (!c->president_name.empty()) {
            auto tmp_params = MakeParameters(c->president_name);
            GetStringWithArgs(builder, STR_JUST_RAW_STRING, tmp_params);
          } else {
            auto tmp_params = MakeParameters(c->president_name_2);
            GetStringWithArgs(builder, c->president_name_1, tmp_params);
          }
          break;
        }
 
        case SCC_STATION_NAME: { // {STATION}
          StationID sid = args.GetNextParameter<StationID>();
          const Station *st = Station::GetIfValid(sid);
 
          if (st == nullptr) {
            /* The station doesn't exist anymore. The only place where we might
             * be "drawing" an invalid station is in the case of cargo that is
             * in transit. */
            GetStringWithArgs(builder, STR_UNKNOWN_STATION, {});
            break;
          }
 
          static bool use_cache = true;
          if (use_cache) { // Use cached version if first call
            AutoRestoreBackup cache_backup(use_cache, false);
            builder += st->GetCachedName();
          } else if (!st->name.empty()) {
            auto tmp_params = MakeParameters(st->name);
            GetStringWithArgs(builder, STR_JUST_RAW_STRING, tmp_params);
          } else {
            StringID string_id = st->string_id;
            if (st->indtype != IT_INVALID) {
              /* Special case where the industry provides the name for the station */
              const IndustrySpec *indsp = GetIndustrySpec(st->indtype);
 
              /* Industry GRFs can change which might remove the station name and
               * thus cause very strange things. Here we check for that before we
               * actually set the station name. */
              if (indsp->station_name != STR_NULL && indsp->station_name != STR_UNDEFINED) {
                string_id = indsp->station_name;
              }
            }
 
            auto tmp_params = MakeParameters(STR_TOWN_NAME, st->town->index, st->index);
            GetStringWithArgs(builder, string_id, tmp_params);
          }
          break;
        }
 
        case SCC_TOWN_NAME: { // {TOWN}
          const Town *t = Town::GetIfValid(args.GetNextParameter<TownID>());
          if (t == nullptr) break;
 
          static bool use_cache = true;
          if (use_cache) { // Use cached version if first call
            AutoRestoreBackup cache_backup(use_cache, false);
            builder += t->GetCachedName();
          } else if (!t->name.empty()) {
            auto tmp_params = MakeParameters(t->name);
            GetStringWithArgs(builder, STR_JUST_RAW_STRING, tmp_params);
          } else {
            GetTownName(builder, t);
          }
          break;
        }
 
        case SCC_WAYPOINT_NAME: { // {WAYPOINT}
          Waypoint *wp = Waypoint::GetIfValid(args.GetNextParameter<StationID>());
          if (wp == nullptr) break;
 
          if (!wp->name.empty()) {
            auto tmp_params = MakeParameters(wp->name);
            GetStringWithArgs(builder, STR_JUST_RAW_STRING, tmp_params);
          } else {
            auto tmp_params = MakeParameters(wp->town->index, wp->town_cn + 1);
            StringID string_id = ((wp->string_id == STR_SV_STNAME_BUOY) ? STR_FORMAT_BUOY_NAME : STR_FORMAT_WAYPOINT_NAME);
            if (wp->town_cn != 0) string_id++;
            GetStringWithArgs(builder, string_id, tmp_params);
          }
          break;
        }
 
        case SCC_VEHICLE_NAME: { // {VEHICLE}
          const Vehicle *v = Vehicle::GetIfValid(args.GetNextParameter<VehicleID>());
          if (v == nullptr) break;
 
          if (!v->name.empty()) {
            auto tmp_params = MakeParameters(v->name);
            GetStringWithArgs(builder, STR_JUST_RAW_STRING, tmp_params);
          } else if (v->group_id != DEFAULT_GROUP) {
            /* The vehicle has no name, but is member of a group, so print group name */
            auto tmp_params = MakeParameters(v->group_id, v->unitnumber);
            GetStringWithArgs(builder, STR_FORMAT_GROUP_VEHICLE_NAME, tmp_params);
          } else {
            auto tmp_params = MakeParameters(v->unitnumber);
 
            StringID string_id;
            switch (v->type) {
              default:           string_id = STR_INVALID_VEHICLE; break;
              case VEH_TRAIN:    string_id = STR_SV_TRAIN_NAME; break;
              case VEH_ROAD:     string_id = STR_SV_ROAD_VEHICLE_NAME; break;
              case VEH_SHIP:     string_id = STR_SV_SHIP_NAME; break;
              case VEH_AIRCRAFT: string_id = STR_SV_AIRCRAFT_NAME; break;
            }
 
            GetStringWithArgs(builder, string_id, tmp_params);
          }
          break;
        }
 
        case SCC_SIGN_NAME: { // {SIGN}
          const Sign *si = Sign::GetIfValid(args.GetNextParameter<SignID>());
          if (si == nullptr) break;
 
          if (!si->name.empty()) {
            auto tmp_params = MakeParameters(si->name);
            GetStringWithArgs(builder, STR_JUST_RAW_STRING, tmp_params);
          } else {
            GetStringWithArgs(builder, STR_DEFAULT_SIGN_NAME, {});
          }
          break;
        }
 
        case SCC_STATION_FEATURES: { // {STATIONFEATURES}
          StationGetSpecialString(builder, args.GetNextParameter<StationFacilities>());
          break;
        }
 
        case SCC_COLOUR: { // {COLOUR}
          StringControlCode scc = (StringControlCode)(SCC_BLUE + args.GetNextParameter<Colours>());
          if (IsInsideMM(scc, SCC_BLUE, SCC_COLOUR)) builder.PutUtf8(scc);
          break;
        }
 
        default:
          builder.PutUtf8(b);
          break;
      }
    } catch (std::out_of_range &e) {
      Debug(misc, 0, "FormatString: {}", e.what());
      builder += "(invalid parameter)";
    }
  }
 
  if (emit_automatic_push_pop) builder.PutUtf8(SCC_POP_COLOUR);
}
 
 
static void StationGetSpecialString(StringBuilder &builder, StationFacilities x)
{
  if (x.Test(StationFacility::Train)) builder.PutUtf8(SCC_TRAIN);
  if (x.Test(StationFacility::TruckStop)) builder.PutUtf8(SCC_LORRY);
  if (x.Test(StationFacility::BusStop)) builder.PutUtf8(SCC_BUS);
  if (x.Test(StationFacility::Dock)) builder.PutUtf8(SCC_SHIP);
  if (x.Test(StationFacility::Airport)) builder.PutUtf8(SCC_PLANE);
}
 
static const std::string_view _silly_company_names[] = {
  "Bloggs Brothers",
  "Tiny Transport Ltd.",
  "Express Travel",
  "Comfy-Coach & Co.",
  "Crush & Bump Ltd.",
  "Broken & Late Ltd.",
  "Sam Speedy & Son",
  "Supersonic Travel",
  "Mike's Motors",
  "Lightning International",
  "Pannik & Loozit Ltd.",
  "Inter-City Transport",
  "Getout & Pushit Ltd."
};
 
static const std::string_view _surname_list[] = {
  "Adams",
  "Allan",
  "Baker",
  "Bigwig",
  "Black",
  "Bloggs",
  "Brown",
  "Campbell",
  "Gordon",
  "Hamilton",
  "Hawthorn",
  "Higgins",
  "Green",
  "Gribble",
  "Jones",
  "McAlpine",
  "MacDonald",
  "McIntosh",
  "Muir",
  "Murphy",
  "Nelson",
  "O'Donnell",
  "Parker",
  "Phillips",
  "Pilkington",
  "Quigley",
  "Sharkey",
  "Thomson",
  "Watkins"
};
 
static const std::string_view _silly_surname_list[] = {
  "Grumpy",
  "Dozy",
  "Speedy",
  "Nosey",
  "Dribble",
  "Mushroom",
  "Cabbage",
  "Sniffle",
  "Fishy",
  "Swindle",
  "Sneaky",
  "Nutkins"
};
 
static const char _initial_name_letters[] = {
  'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J',
  'K', 'L', 'M', 'N', 'P', 'R', 'S', 'T', 'W',
};
 
static std::span<const std::string_view> GetSurnameOptions()
{
  if (_settings_game.game_creation.landscape == LandscapeType::Toyland) return _silly_surname_list;
  return _surname_list;
}
 
static std::string_view GetSurname(uint32_t seed)
{
  auto surname_options = GetSurnameOptions();
  return surname_options[surname_options.size() * GB(seed, 16, 8) >> 8];
}
 
static void GenAndCoName(StringBuilder &builder, uint32_t seed)
{
  builder += GetSurname(seed);
  builder += " & Co.";
}
 
static void GenPresidentName(StringBuilder &builder, uint32_t seed)
{
  builder.PutChar(_initial_name_letters[std::size(_initial_name_letters) * GB(seed, 0, 8) >> 8]);
  builder += ". ";
 
  /* The second initial is optional. */
  size_t index = (std::size(_initial_name_letters) + 35) * GB(seed, 8, 8) >> 8;
  if (index < std::size(_initial_name_letters)) {
    builder.PutChar(_initial_name_letters[index]);
    builder += ". ";
  }
 
  builder += GetSurname(seed);
}
 
static bool GetSpecialNameString(StringBuilder &builder, StringID string, StringParameters &args)
{
  switch (string) {
    case SPECSTR_SILLY_NAME: // Not used in new companies, but retained for old-loader savegames
      builder += _silly_company_names[std::min<size_t>(args.GetNextParameter<uint16_t>(), std::size(_silly_company_names) - 1)];
      return true;
 
    case SPECSTR_ANDCO_NAME: // used for Foobar & Co company names
      GenAndCoName(builder, args.GetNextParameter<uint32_t>());
      return true;
 
    case SPECSTR_PRESIDENT_NAME: // President name
      GenPresidentName(builder, args.GetNextParameter<uint32_t>());
      return true;
  }
 
  /* TownName Transport company names, with the appropriate town name. */
  if (IsInsideMM(string, SPECSTR_COMPANY_NAME_START, SPECSTR_COMPANY_NAME_END)) {
    GenerateTownNameString(builder, string - SPECSTR_COMPANY_NAME_START, args.GetNextParameter<uint32_t>());
    builder += " Transport";
    return true;
  }
 
  return false;
}
 
bool LanguagePackHeader::IsValid() const
{
  return this->ident        == TO_LE32(LanguagePackHeader::IDENT) &&
         this->version      == TO_LE32(LANGUAGE_PACK_VERSION) &&
         this->plural_form  <  LANGUAGE_MAX_PLURAL &&
         this->text_dir     <= 1 &&
         this->newgrflangid < MAX_LANG &&
         this->num_genders  < MAX_NUM_GENDERS &&
         this->num_cases    < MAX_NUM_CASES &&
         StrValid(this->name) &&
         StrValid(this->own_name) &&
         StrValid(this->isocode) &&
         StrValid(this->digit_group_separator) &&
         StrValid(this->digit_group_separator_currency) &&
         StrValid(this->digit_decimal_separator);
}
 
bool LanguagePackHeader::IsReasonablyFinished() const
{
  /* "Less than 25% missing" is "sufficiently finished". */
  return 4 * this->missing < LANGUAGE_TOTAL_STRINGS;
}
 
bool ReadLanguagePack(const LanguageMetadata *lang)
{
  /* Current language pack */
  size_t total_len = 0;
  std::unique_ptr<LanguagePack, LanguagePackDeleter> lang_pack(reinterpret_cast<LanguagePack *>(ReadFileToMem(FS2OTTD(lang->file.native()), total_len, 1U << 20).release()));
  if (!lang_pack) return false;
 
  /* End of read data (+ terminating zero added in ReadFileToMem()) */
  const char *end = (char *)lang_pack.get() + total_len + 1;
 
  /* We need at least one byte of lang_pack->data */
  if (end <= lang_pack->data || !lang_pack->IsValid()) {
    return false;
  }
 
  std::array<uint, TEXT_TAB_END> tab_start, tab_num;
 
  uint count = 0;
  for (uint i = 0; i < TEXT_TAB_END; i++) {
    uint16_t num = FROM_LE16(lang_pack->offsets[i]);
    if (num > TAB_SIZE) return false;
 
    tab_start[i] = count;
    tab_num[i] = num;
    count += num;
  }
 
  /* Allocate offsets */
  std::vector<std::string_view> strings;
 
  /* Fill offsets */
  char *s = lang_pack->data;
  for (uint i = 0; i < count; i++) {
    size_t len = static_cast<uint8_t>(*s++);
    if (s + len >= end) return false;
 
    if (len >= 0xC0) {
      len = ((len & 0x3F) << 8) + static_cast<uint8_t>(*s++);
      if (s + len >= end) return false;
    }
    strings.emplace_back(s, len);
    s += len;
  }
  assert(strings.size() == count);
 
  _langpack.langpack = std::move(lang_pack);
  _langpack.strings = std::move(strings);
  _langpack.langtab_num = tab_num;
  _langpack.langtab_start = tab_start;
 
  _current_language = lang;
  _current_text_dir = (TextDirection)_current_language->text_dir;
  _config_language_file = FS2OTTD(_current_language->file.filename().native());
  SetCurrentGrfLangID(_current_language->newgrflangid);
  _langpack.list_separator = GetString(STR_LIST_SEPARATOR);
  _langpack.ellipsis = GetString(STR_TRUNCATION_ELLIPSIS);
 
#ifdef _WIN32
  extern void Win32SetCurrentLocaleName(std::string iso_code);
  Win32SetCurrentLocaleName(_current_language->isocode);
#endif
 
#ifdef WITH_COCOA
  extern void MacOSSetCurrentLocaleName(std::string_view iso_code);
  MacOSSetCurrentLocaleName(_current_language->isocode);
#endif
 
#ifdef WITH_ICU_I18N
  /* Create a collator instance for our current locale. */
  UErrorCode status = U_ZERO_ERROR;
  _current_collator.reset(icu::Collator::createInstance(icu::Locale(_current_language->isocode), status));
  /* Sort number substrings by their numerical value. */
  if (_current_collator) _current_collator->setAttribute(UCOL_NUMERIC_COLLATION, UCOL_ON, status);
  /* Avoid using the collator if it is not correctly set. */
  if (U_FAILURE(status)) {
    _current_collator.reset();
  }
#endif /* WITH_ICU_I18N */
 
  Layouter::Initialize();
 
  /* Some lists need to be sorted again after a language change. */
  ReconsiderGameScriptLanguage();
  InitializeSortedCargoSpecs();
  SortIndustryTypes();
  BuildIndustriesLegend();
  BuildContentTypeStringList();
  InvalidateWindowClassesData(WC_BUILD_VEHICLE);      // Build vehicle window.
  InvalidateWindowClassesData(WC_TRAINS_LIST);        // Train group window.
  InvalidateWindowClassesData(WC_ROADVEH_LIST);       // Road vehicle group window.
  InvalidateWindowClassesData(WC_SHIPS_LIST);         // Ship group window.
  InvalidateWindowClassesData(WC_AIRCRAFT_LIST);      // Aircraft group window.
  InvalidateWindowClassesData(WC_INDUSTRY_DIRECTORY); // Industry directory window.
  InvalidateWindowClassesData(WC_STATION_LIST);       // Station list window.
 
  return true;
}
 
/* Win32 implementation in win32.cpp.
 * OS X implementation in os/macosx/macos.mm. */
#if !(defined(_WIN32) || defined(__APPLE__))
std::optional<std::string> GetCurrentLocale(const char *param)
{
  auto env = GetEnv("LANGUAGE");
  if (env.has_value()) return std::string{*env};
 
  env = GetEnv("LC_ALL");
  if (env.has_value()) return std::string{*env};
 
  if (param != nullptr) {
    env = GetEnv(param);
    if (env.has_value()) return std::string{*env};
  }
 
  env = GetEnv("LANG");
  if (env.has_value()) return std::string{*env};
 
  return std::nullopt;
}
#else
std::optional<std::string> GetCurrentLocale(const char *param);
#endif /* !(defined(_WIN32) || defined(__APPLE__)) */
 
const LanguageMetadata *GetLanguage(uint8_t newgrflangid)
{
  for (const LanguageMetadata &lang : _languages) {
    if (newgrflangid == lang.newgrflangid) return &lang;
  }
 
  return nullptr;
}
 
static bool GetLanguageFileHeader(const std::string &file, LanguagePackHeader *hdr)
{
  auto f = FileHandle::Open(file, "rb");
  if (!f.has_value()) return false;
 
  size_t read = fread(hdr, sizeof(*hdr), 1, *f);
 
  bool ret = read == 1 && hdr->IsValid();
 
  /* Convert endianness for the windows language ID */
  if (ret) {
    hdr->missing = FROM_LE16(hdr->missing);
    hdr->winlangid = FROM_LE16(hdr->winlangid);
  }
  return ret;
}
 
static void FillLanguageList(const std::string &path)
{
  std::error_code error_code;
  for (const auto &dir_entry : std::filesystem::directory_iterator(OTTD2FS(path), error_code)) {
    if (!dir_entry.is_regular_file()) continue;
    if (dir_entry.path().extension() != ".lng") continue;
 
    LanguageMetadata lmd;
    lmd.file = dir_entry.path();
 
    /* Check whether the file is of the correct version */
    std::string file = FS2OTTD(lmd.file.native());
    if (!GetLanguageFileHeader(file, &lmd)) {
      Debug(misc, 3, "{} is not a valid language file", file);
    } else if (GetLanguage(lmd.newgrflangid) != nullptr) {
      Debug(misc, 3, "{}'s language ID is already known", file);
    } else {
      _languages.push_back(std::move(lmd));
    }
  }
  if (error_code) {
    Debug(misc, 9, "Unable to open directory {}: {}", path, error_code.message());
  }
}
 
void InitializeLanguagePacks()
{
  for (Searchpath sp : _valid_searchpaths) {
    FillLanguageList(FioGetDirectory(sp, LANG_DIR));
  }
  if (_languages.empty()) UserError("No available language packs (invalid versions?)");
 
  /* Acquire the locale of the current system */
  auto str_lang = GetCurrentLocale("LC_MESSAGES");
  std::string_view lang = str_lang.has_value() ? std::string_view{*str_lang} : "en_GB";
 
  const LanguageMetadata *chosen_language   = nullptr; 
  const LanguageMetadata *language_fallback = nullptr; 
  const LanguageMetadata *en_GB_fallback    = _languages.data(); 
 
  /* Find a proper language. */
  for (const LanguageMetadata &lng : _languages) {
    /* We are trying to find a default language. The priority is by
     * configuration file, local environment and last, if nothing found,
     * English. */
    if (_config_language_file == FS2OTTD(lng.file.filename().native())) {
      chosen_language = &lng;
      break;
    }
 
    std::string_view iso_code = lng.isocode;
    if (iso_code == "en_GB") en_GB_fallback = &lng;
 
    /* Only auto-pick finished translations */
    if (!lng.IsReasonablyFinished()) continue;
 
    if (iso_code.starts_with(lang.substr(0, 5))) chosen_language = &lng;
    if (iso_code.starts_with(lang.substr(0, 2))) language_fallback = &lng;
  }
 
  /* We haven't found the language in the config nor the one in the locale.
   * Now we set it to one of the fallback languages */
  if (chosen_language == nullptr) {
    chosen_language = (language_fallback != nullptr) ? language_fallback : en_GB_fallback;
  }
 
  if (!ReadLanguagePack(chosen_language)) UserError("Can't read language pack '{}'", FS2OTTD(chosen_language->file.native()));
}
 
std::string_view GetCurrentLanguageIsoCode()
{
  return _langpack.langpack->isocode;
}
 
bool MissingGlyphSearcher::FindMissingGlyphs()
{
  FontCache::LoadFontCaches(this->Monospace() ? FontSizes{FS_MONO} : FONTSIZES_REQUIRED);
 
  this->Reset();
  for (auto text = this->NextString(); text.has_value(); text = this->NextString()) {
    FontSize size = this->DefaultSize();
    FontCache *fc = FontCache::Get(size);
    for (char32_t c : Utf8View(*text)) {
      if (c >= SCC_FIRST_FONT && c <= SCC_LAST_FONT) {
        size = (FontSize)(c - SCC_FIRST_FONT);
        fc = FontCache::Get(size);
      } else if (!IsInsideMM(c, SCC_SPRITE_START, SCC_SPRITE_END) && IsPrintable(c) && !IsTextDirectionChar(c) && fc->MapCharToGlyph(c, false) == 0) {
        /* The character is printable, but not in the normal font. This is the case we were testing for. */
        Debug(fontcache, 0, "Font is missing glyphs to display char 0x{:X} in {} font size", static_cast<uint32_t>(c), FontSizeToName(size));
        return true;
      }
    }
  }
  return false;
}
 
class LanguagePackGlyphSearcher : public MissingGlyphSearcher {
  uint i; 
  uint j; 
 
  void Reset() override
  {
    this->i = 0;
    this->j = 0;
  }
 
  FontSize DefaultSize() override
  {
    return FS_NORMAL;
  }
 
  std::optional<std::string_view> NextString() override
  {
    if (this->i >= TEXT_TAB_END) return std::nullopt;
 
    std::string_view ret = _langpack.strings[_langpack.langtab_start[this->i] + this->j];
 
    this->j++;
    while (this->i < TEXT_TAB_END && this->j >= _langpack.langtab_num[this->i]) {
      this->i++;
      this->j = 0;
    }
 
    return ret;
  }
 
  bool Monospace() override
  {
    return false;
  }
 
  void SetFontNames([[maybe_unused]] FontCacheSettings *settings, [[maybe_unused]] std::string_view font_name, [[maybe_unused]] const void *os_data) override
  {
#if defined(WITH_FREETYPE) || defined(_WIN32) || defined(WITH_COCOA)
    settings->small.font = font_name;
    settings->medium.font = font_name;
    settings->large.font = font_name;
 
    settings->small.os_handle = os_data;
    settings->medium.os_handle = os_data;
    settings->large.os_handle = os_data;
#endif
  }
};
 
void CheckForMissingGlyphs(MissingGlyphSearcher *searcher)
{
  static LanguagePackGlyphSearcher pack_searcher;
  if (searcher == nullptr) searcher = &pack_searcher;
  bool bad_font = searcher->FindMissingGlyphs();
#if defined(WITH_FREETYPE) || defined(_WIN32) || defined(WITH_COCOA)
  if (bad_font) {
    /* We found an unprintable character... lets try whether we can find
     * a fallback font that can print the characters in the current language. */
    bool any_font_configured = !_fcsettings.medium.font.empty();
    FontCacheSettings backup = _fcsettings;
 
    _fcsettings.mono.os_handle = nullptr;
    _fcsettings.medium.os_handle = nullptr;
 
    bad_font = !FontProviderManager::FindFallbackFont(&_fcsettings, _langpack.langpack->isocode, searcher);
 
    _fcsettings = std::move(backup);
 
    if (!bad_font && any_font_configured) {
      /* If the user configured a bad font, and we found a better one,
       * show that we loaded the better font instead of the configured one.
       */
      std::string err_str;
      StringBuilder builder(err_str);
      builder.PutUtf8(SCC_YELLOW);
      builder.Put("The current font is missing some of the characters used in the texts for this language. Using system fallback font instead.");
      ShowErrorMessage(GetEncodedString(STR_JUST_RAW_STRING, std::move(err_str)), {}, WL_WARNING);
    }
 
    if (bad_font) {
      /* Our fallback font does miss characters too, so keep the
       * user chosen font as that is more likely to be any good than
       * the wild guess we made */
      FontCache::LoadFontCaches(searcher->Monospace() ? FontSizes{FS_MONO} : FONTSIZES_REQUIRED);
    }
  }
#endif
 
  if (bad_font) {
    /* All attempts have failed. Display an error. As we do not want the string to be translated by
     * the translators, we 'force' it into the binary and 'load' it via a BindCString. To do this
     * properly we have to set the colour of the string, otherwise we end up with a lot of artifacts.
     */
    std::string err_str;
    StringBuilder builder(err_str);
    builder.PutUtf8(SCC_YELLOW);
    builder.Put("The current font is missing some of the characters used in the texts for this language. Go to Help & Manuals > Fonts, or read the file docs/fonts.md in your OpenTTD directory, to see how to solve this.");
    ShowErrorMessage(GetEncodedString(STR_JUST_RAW_STRING, std::move(err_str)), {}, WL_WARNING);
 
    /* Reset the font width */
    LoadStringWidthTable(searcher->Monospace() ? FontSizes{FS_MONO} : FONTSIZES_REQUIRED);
    return;
  }
 
  /* Update the font with cache */
  LoadStringWidthTable(searcher->Monospace() ? FontSizes{FS_MONO} : FONTSIZES_REQUIRED);
 
#if !(defined(WITH_ICU_I18N) && defined(WITH_HARFBUZZ)) && !defined(WITH_UNISCRIBE) && !defined(WITH_COCOA)
  /*
   * For right-to-left languages we need the ICU library. If
   * we do not have support for that library we warn the user
   * about it with a message. As we do not want the string to
   * be translated by the translators, we 'force' it into the
   * binary and 'load' it via a BindCString. To do this
   * properly we have to set the colour of the string,
   * otherwise we end up with a lot of artifacts.
   */
  if (_current_text_dir != TD_LTR) {
    std::string err_str;
    StringBuilder builder(err_str);
    builder.PutUtf8(SCC_YELLOW);
    builder.Put("This version of OpenTTD does not support right-to-left languages. Recompile with ICU + Harfbuzz enabled.");
    ShowErrorMessage(GetEncodedString(STR_JUST_RAW_STRING, std::move(err_str)), {}, WL_ERROR);
  }
#endif /* !(WITH_ICU_I18N && WITH_HARFBUZZ) && !WITH_UNISCRIBE && !WITH_COCOA */
}