newgrf_text_type.h

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 NEWGRF_TEXT_TYPE_H
#define NEWGRF_TEXT_TYPE_H
 
#include "core/strong_typedef_type.hpp"
#include "newgrf_type.h"

using GRFStringID = StrongType::Typedef<uint32_t, struct GRFStringIDTag, StrongType::Compare, StrongType::Integer>;
 
static constexpr GRFStringID GRFSTR_MISC_GRF_TEXT{0xD000}; 

static const char32_t NFO_UTF8_IDENTIFIER = 0x00DE;

enum class GRFLanguage : uint8_t {
  American = 0, 
  English = 1, 
  German = 2, 
  French = 3, 
  Spanish = 4, 
 
  Unspecified = 0x7F, 
  End = 0x7F, 
 
  Fallback = American, 
};

struct GRFText {
  GRFLanguage langid; 
  std::string text; 
};

using GRFTextList = std::vector<GRFText>;
using GRFTextWrapper = std::shared_ptr<GRFTextList>;

struct LanguageMap {
  struct Mapping {
    uint8_t newgrf_id;  
    uint8_t openttd_id; 
  };
 
  /* We need a vector and can't use SmallMap due to the fact that for "setting" a
   * gender of a string or requesting a case for a substring we want to map from
   * the NewGRF's internal ID to OpenTTD's ID whereas for the choice lists we map
   * the genders/cases/plural OpenTTD IDs to the NewGRF's internal IDs. In this
   * case a NewGRF developer/translator might want a different translation for
   * both cases. Thus we are basically implementing a multi-map. */
  std::vector<Mapping> gender_map; 
  std::vector<Mapping> case_map;   
  int plural_form;                 
 
  int GetMapping(int newgrf_id, bool gender) const;
  int GetReverseMapping(int openttd_id, bool gender) const;
  static const LanguageMap *GetLanguageMap(GrfID grfid, GRFLanguage language_id);
};
 
#endif /* NEWGRF_TEXT_TYPE_H */