strings.cpp File Reference

Handling of translated strings. More...

#include "stdafx.h"
#include "currency.h"
#include "station_base.h"
#include "town.h"
#include "screenshot.h"
#include "waypoint_base.h"
#include "depot_base.h"
#include "industry.h"
#include "newgrf_text.h"
#include "fileio_func.h"
#include "group.h"
#include "signs_base.h"
#include "cargotype.h"
#include "fontcache.h"
#include "gui.h"
#include "strings_func.h"
#include "rev.h"
#include "core/alloc_type.hpp"
#include "core/endian_func.hpp"
#include "date_func.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 <stack>
#include "table/strings.h"
#include "table/control_codes.h"

Go to the source code of this file.

Data Structures

struct  LanguagePack
struct  UnitConversion
 Helper for unit conversion. More...
struct  Units

Functions

void CopyInDParam (int offs, const uint64 *src, int num)
 Copy num string parameters from array src into the global string parameter array.
void CopyOutDParam (uint64 *dst, int offs, int num)
 Copy num string parameters from the global string parameter array to the dst array.
static char * StationGetSpecialString (char *buff, int x, const char *last)
static char * GetSpecialTownNameString (char *buff, int ind, uint32 seed, const char *last)
static char * GetSpecialNameString (char *buff, int ind, StringParameters *args, const char *last)
static char * FormatString (char *buff, const char *str_arg, StringParameters *args, uint casei, const char *last, bool dry_run)
 Parse most format codes within a string and write the result to a buffer.
const char * GetStringPtr (StringID string)
char * GetStringWithArgs (char *buffr, uint string, StringParameters *args, const char *last)
 The highest 8 bits of string contain the "case index".
char * GetString (char *buffr, StringID string, const char *last)
char * InlineString (char *buf, StringID string)
void SetDParamStr (uint n, const char *str)
 This function is used to "bind" a C string to a OpenTTD dparam slot.
void InjectDParam (uint amount)
 Shift the string parameters in the global string parameter array by amount positions, making room at the beginning.
static char * FormatNumber (char *buff, int64 number, const char *last, const char *separator, int zerofill=1, int fractional_digits=0)
 Format a number into a string.
static char * FormatCommaNumber (char *buff, int64 number, const char *last, int fractional_digits=0)
static char * FormatNoCommaNumber (char *buff, int64 number, const char *last)
static char * FormatZerofillNumber (char *buff, int64 number, int64 count, const char *last)
static char * FormatHexNumber (char *buff, uint64 number, const char *last)
static char * FormatBytes (char *buff, int64 number, const char *last)
 Format a given number as a number of bytes with the SI prefix.
static char * FormatYmdString (char *buff, Date date, uint modifier, const char *last)
static char * FormatMonthAndYear (char *buff, Date date, uint modifier, const char *last)
static char * FormatTinyOrISODate (char *buff, Date date, StringID str, const char *last)
static char * FormatGenericCurrency (char *buff, const CurrencySpec *spec, Money number, bool compact, const char *last)
static int DeterminePluralForm (int64 count, int plural_form)
 Determine the "plural" index given a plural form and a number.
static const char * ParseStringChoice (const char *b, uint form, char **dst, const char *last)
uint ConvertSpeedToDisplaySpeed (uint speed)
 Convert the given (internal) speed to the display speed.
uint ConvertDisplaySpeedToSpeed (uint speed)
 Convert the given display speed to the (internal) speed.
static char * GenAndCoName (char *buff, uint32 arg, const char *last)
static char * GenPresidentName (char *buff, uint32 x, const char *last)
void SortNetworkLanguages ()
bool ReadLanguagePack (const LanguageMetadata *lang)
 Read a particular language.
const char * GetCurrentLocale (const char *param)
 Determine the current charset based on the environment First check some default values, after this one we passed ourselves and if none exist return the value for $LANG.
int CDECL StringIDSorter (const StringID *a, const StringID *b)
const LanguageMetadataGetLanguage (byte newgrflangid)
 Get the language with the given NewGRF language ID.
static bool GetLanguageFileHeader (const char *file, LanguagePackHeader *hdr)
 Reads the language file header and checks compatability.
static void GetLanguageList (const char *path)
 Gets a list of languages from the given directory.
void InitializeLanguagePacks ()
 Make a list of the available language packs.
const char * GetCurrentLanguageIsoCode ()
 Get the ISO language code of the currently loaded language.
static bool FindMissingGlyphs (const char **str)
 Check whether there are glyphs missing in the current language.
void CheckForMissingGlyphsInLoadedLanguagePack ()
 Check whether the currently loaded language pack uses characters that the currently loaded font does not support.

Variables

char _config_language_file [MAX_PATH]
 The file (name) stored in the configuration.
LanguageList _languages
 The actual list of language meta data.
const LanguageMetadata_current_language = NULL
 The currently loaded language.
TextDirection _current_text_dir
 Text direction of the currently selected language.
Collator * _current_collator = NULL
 Collator for the language currently in use.
static uint64 _global_string_params_data [20]
 Global array of string parameters. To access, use SetDParam.
static WChar _global_string_params_type [20]
 Type of parameters stored in _decode_parameters.
StringParameters _global_string_params (_global_string_params_data, 20, _global_string_params_type)
static char ** _langpack_offs
static LanguagePack_langpack
static uint _langtab_num [32]
 Offset into langpack offs.
static uint _langtab_start [32]
 Offset into langpack offs.
static bool _keep_gender_data = false
 Should we retain the gender data in the current string?
static const Units _units []
static const char *const _silly_company_names []
static const char *const _surname_list []
static const char *const _silly_surname_list []
static const char _initial_name_letters []

Detailed Description

Handling of translated strings.

Definition in file strings.cpp.


Function Documentation

void CheckForMissingGlyphsInLoadedLanguagePack (  ) 

Check whether the currently loaded language pack uses characters that the currently loaded font does not support.

If this is the case an error message will be shown in English. The error message will not be localized because that would mean it might use characters that are not in the font, which is the whole reason this check has been added.

Definition at line 1809 of file strings.cpp.

References _current_text_dir, FindMissingGlyphs(), INVALID_STRING_ID, LanguagePackHeader::isocode, LoadStringWidthTable(), SetDParamStr(), SetFallbackFont(), ShowErrorMessage(), TD_LTR, UninitFreeType(), Utf8Encode(), LanguagePackHeader::winlangid, WL_ERROR, and WL_WARNING.

Referenced by GameOptionsWindow::OnDropdownSelect().

uint ConvertDisplaySpeedToSpeed ( uint  speed  ) 

Convert the given display speed to the (internal) speed.

Parameters:
speed the speed to convert
Returns:
the converted speed.

Definition at line 652 of file strings.cpp.

References _settings_game, Units::c_velocity, UnitConversion::FromDisplay(), GameSettings::locale, and LocaleSettings::units.

Referenced by OrdersWindow::OnQueryTextFinished().

uint ConvertSpeedToDisplaySpeed ( uint  speed  ) 

Convert the given (internal) speed to the display speed.

Parameters:
speed the speed to convert
Returns:
the converted speed.

Definition at line 639 of file strings.cpp.

References _settings_game, Units::c_velocity, GameSettings::locale, UnitConversion::ToDisplay(), and LocaleSettings::units.

Referenced by DrawOrderString(), FormatString(), OrdersWindow::OnClick(), and OrdersWindow::SetStringParameters().

void CopyInDParam ( int  offs,
const uint64 *  src,
int  num 
)

Copy num string parameters from array src into the global string parameter array.

Parameters:
offs Index in the global array to copy the first string parameter to.
src Source array of string parameters.
num Number of string parameters to copy.

Definition at line 83 of file strings.cpp.

References StringParameters::GetPointerToOffset(), and MemCpyT().

Referenced by DrawNewsString(), NewsWindow::DrawWidget(), ErrmsgWindow::DrawWidget(), QueryWindow::SetStringParameters(), ErrmsgWindow::SetStringParameters(), NewsWindow::UpdateWidgetSize(), and ErrmsgWindow::UpdateWidgetSize().

void CopyOutDParam ( uint64 *  dst,
int  offs,
int  num 
)

Copy num string parameters from the global string parameter array to the dst array.

Parameters:
dst Destination array of string parameters.
offs Index in the global array to copy the first string parameter from.
num Number of string parameters to copy.

Definition at line 94 of file strings.cpp.

References StringParameters::GetPointerToOffset(), and MemCpyT().

Referenced by AddNewsItem().

static int DeterminePluralForm ( int64  count,
int  plural_form 
) [static]

Determine the "plural" index given a plural form and a number.

Parameters:
count The number to get the plural index of.
plural_form The plural form we want an index for.
Returns:
The plural index for the given form.

Definition at line 435 of file strings.cpp.

References abs().

Referenced by FormatString().

static bool FindMissingGlyphs ( const char **  str  )  [static]

Check whether there are glyphs missing in the current language.

Parameters:
Pointer to an address for storing the text pointer.
Returns:
If glyphs are missing, return true, else return .
Postcondition:
If true is returned and str is not NULL, *str points to a string that is found to contain at least one missing glyph.

Definition at line 1759 of file strings.cpp.

References _langtab_num, _langtab_start, FS_BEGIN, FS_LARGE, FS_NORMAL, FS_SMALL, IsTextDirectionChar(), SCC_BIGFONT, SCC_TINYFONT, and UninitFreeType().

Referenced by CheckForMissingGlyphsInLoadedLanguagePack().

static char* FormatBytes ( char *  buff,
int64  number,
const char *  last 
) [static]

Format a given number as a number of bytes with the SI prefix.

Parameters:
buff the buffer to write to
number the number of bytes to write down
last the last element in the buffer
Returns:
till where we wrote

Definition at line 305 of file strings.cpp.

References _settings_game, LanguagePackHeader::digit_decimal_separator, LocaleSettings::digit_decimal_separator, lengthof, GameSettings::locale, and seprintf().

Referenced by FormatString().

static char* FormatNumber ( char *  buff,
int64  number,
const char *  last,
const char *  separator,
int  zerofill = 1,
int  fractional_digits = 0 
) [static]

Format a number into a string.

Parameters:
buff the buffer to write to
number the number to write down
last the last element in the buffer
separator the thousands-separator to use
zerofill minimum number of digits to print for the integer part. The number will be filled with zeros at the front if necessary.
fractional_digits number of fractional digits to display after a decimal separator. The decimal separator is inserted in front of the fractional_digits last digit of number.
Returns:
till where we wrote

Definition at line 237 of file strings.cpp.

References _settings_game, LanguagePackHeader::digit_decimal_separator, LocaleSettings::digit_decimal_separator, GameSettings::locale, seprintf(), and strecpy().

static char * FormatString ( char *  buff,
const char *  str_arg,
StringParameters args,
uint  casei,
const char *  last,
bool  dry_run 
) [static]

Parse most format codes within a string and write the result to a buffer.

Parameters:
buff The buffer to write the final string to.
str The original string with format codes.
args Pointer to extra arguments used by various string codes.
casei 
last Pointer to just past the end of the buff array.
dry_run True when the argt array is not yet initialized.

Definition at line 666 of file strings.cpp.

References _keep_gender_data, _resolutions, _settings_game, Units::c_force, Units::c_height, Units::c_power, Units::c_volume, Units::c_weight, ConvertSpeedToDisplaySpeed(), CreateTextRefStackBackup(), CT_INVALID, DeterminePluralForm(), FACIL_AIRPORT, FACIL_BUS_STOP, FACIL_DOCK, FACIL_TRAIN, FACIL_TRUCK_STOP, Units::force, FormatBytes(), GameSettings::game_creation, GB(), GenerateTownNameString(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_sign_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_group_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_town_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_depot_pool >::Get(), SpecializedStation< Waypoint, true >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_industry_pool >::Get(), CargoSpec::Get(), StringParameters::GetDataPointer(), SpecializedStation< Station, false >::GetIfValid(), GetIndustrySpec(), StringParameters::GetInt32(), StringParameters::GetInt64(), StringParameters::GetPointerToOffset(), GetScreenshotFormatDesc(), GetStringWithArgs(), GetTownName(), StringParameters::GetTypeAtOffset(), StringParameters::HasTypeInformation(), Units::height, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, Station::indtype, Engine::IsEnabled(), IsInsideMM(), Company::IsValidHumanID(), Units::l_volume, Units::l_weight, GameCreationSettings::landscape, lastof, lengthof, GameSettings::locale, CompanyProperties::name, Vehicle::name, Engine::name, Group::name, BaseStation::name, IndustrySpec::name, CompanyProperties::name_1, CompanyProperties::name_2, StringParameters::num_param, StringParameters::offset, LanguagePackHeader::own_name, Units::power, CompanyProperties::president_name, CompanyProperties::president_name_1, CompanyProperties::president_name_2, CargoSpec::quantifier, RemapNewGRFStringControlCode(), RestoreTextRefStackBackup(), Units::s_volume, Units::s_weight, SCC_NEWGRF_FIRST, SCC_NEWGRF_PRINT_STRING_ID, SCC_NEWGRF_STRINL, seprintf(), IndustrySpec::station_name, strecpy(), EngineInfo::string_id, BaseStation::string_id, UnitConversion::ToDisplay(), BaseStation::town, Industry::town, Depot::town_cn, Waypoint::town_cn, BaseVehicle::type, Industry::type, Vehicle::unitnumber, LocaleSettings::units, UsingNewGRFTextStack(), Utf8CharLen(), Utf8Encode(), VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, VEH_TRAIN, and Units::velocity.

Referenced by GetStringWithArgs().

const char* GetCurrentLanguageIsoCode (  ) 

Get the ISO language code of the currently loaded language.

Returns:
the ISO code.

Definition at line 1748 of file strings.cpp.

References LanguagePackHeader::isocode.

Referenced by GameOptionsWindow::DrawWidget(), and GameOptionsWindow::UpdateWidgetSize().

const char* GetCurrentLocale ( const char *  param  ) 

Determine the current charset based on the environment First check some default values, after this one we passed ourselves and if none exist return the value for $LANG.

Parameters:
param environment variable to check conditionally if default ones are not set. Pass NULL if you don't want additional checks.
Returns:
return string containing current charset, or NULL if not-determinable

Definition at line 1598 of file strings.cpp.

const LanguageMetadata* GetLanguage ( byte  newgrflangid  ) 

Get the language with the given NewGRF language ID.

Parameters:
newgrflangid NewGRF languages ID to check.
Returns:
The language's metadata, or NULL if it is not known.

Definition at line 1634 of file strings.cpp.

References SmallVector< T, S >::Begin(), and SmallVector< T, S >::End().

Referenced by GetLanguageList().

static bool GetLanguageFileHeader ( const char *  file,
LanguagePackHeader hdr 
) [static]

Reads the language file header and checks compatability.

Parameters:
file the file to read
hdr the place to write the header information to
Returns:
true if and only if the language file is of a compatible version

Definition at line 1649 of file strings.cpp.

References LanguagePackHeader::IsValid(), and LanguagePackHeader::winlangid.

Referenced by GetLanguageList().

static void GetLanguageList ( const char *  path  )  [static]

Gets a list of languages from the given directory.

Parameters:
path the base directory to search in

Definition at line 1668 of file strings.cpp.

References SmallVector< T, S >::Append(), DEBUG, LanguageMetadata::file, FS2OTTD(), GetLanguage(), GetLanguageFileHeader(), lastof, LanguagePackHeader::newgrflangid, seprintf(), and ttd_opendir().

Referenced by InitializeLanguagePacks().

char* GetStringWithArgs ( char *  buffr,
uint  string,
StringParameters args,
const char *  last 
)

The highest 8 bits of string contain the "case index".

These 8 bits will only be set when FormatString wants to print the string in a different case. No one else except FormatString should set those bits, therefore string CANNOT be StringID, but uint32.

Parameters:
buffr Pointer to a string buffer where the formatted string should be written to.
string 
args Arguments for the string.
last Pointer just past the end of buffr.
Returns:
Pointer to the final zero byte of the formatted string.

Definition at line 139 of file strings.cpp.

References _langtab_num, error(), FormatString(), GB(), GetGRFStringID(), GetGRFStringPtr(), StringParameters::GetInt32(), GetStringWithArgs(), and HasBit().

Referenced by FormatString(), GetStringWithArgs(), and GetTownName().

void InitializeLanguagePacks (  ) 

Make a list of the available language packs.

put the data in _dynlang struct.

< Matching the language in the configuartion file or the current locale

< Using pt_PT for pt_BR locale when pt_BR is not available

< Fallback when no locale-matching language has been found

Definition at line 1700 of file strings.cpp.

References _config_language_file, SmallVector< T, S >::Begin(), SmallVector< T, S >::End(), LanguageMetadata::file, FOR_ALL_SEARCHPATHS, GetCurrentLocale(), GetLanguageList(), LANG_DIR, SmallVector< T, S >::Length(), lengthof, ReadLanguagePack(), and usererror().

void InjectDParam ( uint  amount  ) 

Shift the string parameters in the global string parameter array by amount positions, making room at the beginning.

Parameters:
amount Number of positions to shift.

Definition at line 221 of file strings.cpp.

References StringParameters::ShiftParameters().

Referenced by Subsidy::AwardTo().

bool ReadLanguagePack ( const LanguageMetadata lang  ) 
void SetDParamStr ( uint  n,
const char *  str 
)

This function is used to "bind" a C string to a OpenTTD dparam slot.

Parameters:
n slot of the string
str string to bind

Definition at line 212 of file strings.cpp.

References SetDParam().

Referenced by Subsidy::AwardTo(), CheckForMissingGlyphsInLoadedLanguagePack(), CmdCompanyCtrl(), CmdFoundTown(), CompanyCheckBankrupt(), DrawCargoListText(), NetworkContentListWindow::DrawDetails(), IndustryViewWindow::DrawInfo(), GameOptionsWindow::DrawWidget(), NewsWindow::DrawWidget(), NewGRFParametersWindow::DrawWidget(), NetworkContentDownloadStatusWindow::DrawWidget(), NetworkChatWindow::DrawWidget(), MusicWindow::DrawWidget(), MusicTrackSelectionWindow::DrawWidget(), LandInfoWindow::DrawWidget(), BuildIndustryWindow::DrawWidget(), SaveLoadWindow::DrawWidget(), AIConfigWindow::DrawWidget(), AISettingsWindow::DrawWidget(), AIListWindow::DrawWidget(), GenerateCompanyName(), IndustryDirectoryWindow::GetIndustryString(), GetSaveLoadErrorString(), IndustryProductionCallback(), MakeScreenshot(), CustomCurrencyWindow::OnClick(), NetworkStartServerWindow::OnClick(), NetworkGameWindow::OnClick(), LandInfoWindow::OnInit(), IConsoleWindow::OnPaint(), SaveFileError(), CustomCurrencyWindow::SetStringParameters(), GameOptionsWindow::SetStringParameters(), NewGRFWindow::SetStringParameters(), SpriteAlignerWindow::SetStringParameters(), NetworkLobbyWindow::SetStringParameters(), AboutWindow::SetStringParameters(), AIDebugWindow::SetStringParameters(), ShowNewGRFError(), ShowNewGrfVehicleError(), ShowRefitOptionsList(), GameOptionsWindow::UpdateWidgetSize(), NewGRFWindow::UpdateWidgetSize(), NetworkChatWindow::UpdateWidgetSize(), MusicWindow::UpdateWidgetSize(), MusicTrackSelectionWindow::UpdateWidgetSize(), LandInfoWindow::UpdateWidgetSize(), BuildIndustryWindow::UpdateWidgetSize(), and WarnCorruptSprite().


Variable Documentation

const char _initial_name_letters[] [static]
Initial value:
 {
  'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J',
  'K', 'L', 'M', 'N', 'P', 'R', 'S', 'T', 'W',
}

Definition at line 1355 of file strings.cpp.

The actual list of language meta data.

Definition at line 47 of file strings.cpp.

Referenced by GameOptionsWindow::BuildDropDownList(), and GameOptionsWindow::OnDropdownSelect().

const char* const _silly_company_names[] [static]
Initial value:
 {
  "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."
}

Definition at line 1292 of file strings.cpp.

const char* const _silly_surname_list[] [static]
Initial value:
 {
  "Grumpy",
  "Dozy",
  "Speedy",
  "Nosey",
  "Dribble",
  "Mushroom",
  "Cabbage",
  "Sniffle",
  "Fishy",
  "Swindle",
  "Sneaky",
  "Nutkins"
}

Definition at line 1340 of file strings.cpp.

const Units _units[] [static]
Initial value:
 {
  { 
    {   1,  0}, STR_UNITS_VELOCITY_IMPERIAL,
    {   1,  0}, STR_UNITS_POWER_IMPERIAL,
    {   1,  0}, STR_UNITS_WEIGHT_SHORT_METRIC, STR_UNITS_WEIGHT_LONG_METRIC,
    {1000,  0}, STR_UNITS_VOLUME_SHORT_METRIC, STR_UNITS_VOLUME_LONG_METRIC,
    {   1,  0}, STR_UNITS_FORCE_SI,
    {   3,  0}, STR_UNITS_HEIGHT_IMPERIAL, 
  },
  { 
    { 103,  6}, STR_UNITS_VELOCITY_METRIC,
    {4153, 12}, STR_UNITS_POWER_METRIC,
    {   1,  0}, STR_UNITS_WEIGHT_SHORT_METRIC, STR_UNITS_WEIGHT_LONG_METRIC,
    {1000,  0}, STR_UNITS_VOLUME_SHORT_METRIC, STR_UNITS_VOLUME_LONG_METRIC,
    {   1,  0}, STR_UNITS_FORCE_SI,
    {   1,  0}, STR_UNITS_HEIGHT_SI,
  },
  { 
    {1831, 12}, STR_UNITS_VELOCITY_SI,
    {6109, 13}, STR_UNITS_POWER_SI,
    {1000,  0}, STR_UNITS_WEIGHT_SHORT_SI, STR_UNITS_WEIGHT_LONG_SI,
    {   1,  0}, STR_UNITS_VOLUME_SHORT_SI, STR_UNITS_VOLUME_LONG_SI,
    {   1,  0}, STR_UNITS_FORCE_SI,
    {   1,  0}, STR_UNITS_HEIGHT_SI,
  },
}

Definition at line 607 of file strings.cpp.


Generated on Fri May 27 04:20:05 2011 for OpenTTD by  doxygen 1.6.1