strings_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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef STRINGS_TYPE_H
#define STRINGS_TYPE_H
 
#include "core/strong_typedef_type.hpp"
 
typedef uint32_t StringID;
static const StringID INVALID_STRING_ID = 0xFFFF; 
static const int MAX_CHAR_LENGTH        = 4;      
static const uint MAX_LANG              = 0x7F;   
 
enum TextDirection : uint8_t {
  TD_LTR, 
  TD_RTL, 
};
 
enum StringTab : uint8_t {
  /* Tabs 0..1 for regular strings */
  TEXT_TAB_TOWN             =  4,
  TEXT_TAB_INDUSTRY         =  9,
  TEXT_TAB_STATION          = 12,
  TEXT_TAB_SPECIAL          = 14,
  TEXT_TAB_OLD_CUSTOM       = 15,
  TEXT_TAB_VEHICLE          = 16,
  /* Tab 17 for regular strings */
  TEXT_TAB_OLD_NEWGRF       = 26,
  TEXT_TAB_END              = 32, 
  TEXT_TAB_GAMESCRIPT_START = 32, 
  TEXT_TAB_NEWGRF_START     = 64, 
};
 
using StringIndexInTab = StrongType::Typedef<uint32_t, struct StringIndexInTabTag, StrongType::Compare, StrongType::Integer>;
 
static const uint TAB_SIZE_BITS       = 11;
static const uint TAB_SIZE            = 1 << TAB_SIZE_BITS;
 
static const uint TAB_SIZE_GAMESCRIPT = TAB_SIZE * 32;
 
static const uint TAB_SIZE_NEWGRF     = TAB_SIZE * 256;
 
static constexpr uint32_t BUILTIN_TOWNNAME_GENERATOR_COUNT = 21;
 
static constexpr StringID SPECSTR_TOWNNAME_START = 0x20C0;
static constexpr StringID SPECSTR_TOWNNAME_END = SPECSTR_TOWNNAME_START + BUILTIN_TOWNNAME_GENERATOR_COUNT;
 
static constexpr StringID SPECSTR_COMPANY_NAME_START = 0x70EA;
static constexpr StringID SPECSTR_COMPANY_NAME_END = SPECSTR_COMPANY_NAME_START + BUILTIN_TOWNNAME_GENERATOR_COUNT;
 
static constexpr StringID SPECSTR_SILLY_NAME = 0x70E5; 
static constexpr StringID SPECSTR_ANDCO_NAME = 0x70E6; 
static constexpr StringID SPECSTR_PRESIDENT_NAME = 0x70E7; 
 
using StringParameterData = std::variant<uint64_t, std::string>;
 
#endif /* STRINGS_TYPE_H */