OpenTTD
|
Handling of translated strings. More...
#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 "fontdetection.h"
#include "error.h"
#include "strings_func.h"
#include "rev.h"
#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 "game/game_text.hpp"
#include "network/network_content_gui.h"
#include <stack>
#include "table/strings.h"
#include "table/control_codes.h"
#include "safeguards.h"
Go to the source code of this file.
Data Structures | |
struct | LanguagePack |
struct | UnitConversion |
Helper for unit conversion. More... | |
struct | Units |
Information about a specific unit system. More... | |
struct | UnitsLong |
Information about a specific unit system with a long variant. More... | |
class | LanguagePackGlyphSearcher |
Helper for searching through the language pack. More... | |
Functions | |
void | SetDParamMaxValue (uint n, uint64 max_value, uint min_count, FontSize size) |
Set DParam n to some number that is suitable for string size computations. More... | |
void | SetDParamMaxDigits (uint n, uint count, FontSize size) |
Set DParam n to some number that is suitable for string size computations. More... | |
void | CopyInDParam (int offs, const uint64 *src, int num) |
Copy num string parameters from array src into the global string parameter array. More... | |
void | CopyOutDParam (uint64 *dst, int offs, int num) |
Copy num string parameters from the global string parameter array to the dst array. More... | |
void | CopyOutDParam (uint64 *dst, const char **strings, StringID string, int num) |
Copy num string parameters from the global string parameter array to the dst array. More... | |
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, const char *last, uint case_index, bool game_script, bool dry_run) |
Parse most format codes within a string and write the result to a buffer. More... | |
const char * | GetStringPtr (StringID string) |
char * | GetStringWithArgs (char *buffr, StringID string, StringParameters *args, const char *last, uint case_index, bool game_script) |
Get a parsed string with most special stringcodes replaced by the string parameters. More... | |
char * | GetString (char *buffr, StringID string, const char *last) |
void | SetDParamStr (uint n, const char *str) |
This function is used to "bind" a C string to a OpenTTD dparam slot. More... | |
void | InjectDParam (uint amount) |
Shift the string parameters in the global string parameter array by amount positions, making room at the beginning. More... | |
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. More... | |
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. More... | |
static char * | FormatYmdString (char *buff, Date date, const char *last, uint case_index) |
static char * | FormatMonthAndYear (char *buff, Date date, const char *last, uint case_index) |
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. More... | |
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. More... | |
uint | ConvertDisplaySpeedToSpeed (uint speed) |
Convert the given display speed to the (internal) speed. More... | |
uint | ConvertKmhishSpeedToDisplaySpeed (uint speed) |
Convert the given km/h-ish speed to the display speed. More... | |
uint | ConvertDisplaySpeedToKmhishSpeed (uint speed) |
Convert the given display speed to the km/h-ish speed. More... | |
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. More... | |
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. More... | |
int CDECL | StringIDSorter (const StringID *a, const StringID *b) |
const LanguageMetadata * | GetLanguage (byte newgrflangid) |
Get the language with the given NewGRF language ID. More... | |
static bool | GetLanguageFileHeader (const char *file, LanguagePackHeader *hdr) |
Reads the language file header and checks compatibility. More... | |
static void | GetLanguageList (const char *path) |
Gets a list of languages from the given directory. More... | |
void | InitializeLanguagePacks () |
Make a list of the available language packs. More... | |
const char * | GetCurrentLanguageIsoCode () |
Get the ISO language code of the currently loaded language. More... | |
void | CheckForMissingGlyphs (bool base_font, MissingGlyphSearcher *searcher) |
Check whether the currently loaded language pack uses characters that the currently loaded font does not support. More... | |
Variables | |
char | _config_language_file [MAX_PATH] |
The file (name) stored in the configuration. | |
LanguageList | _languages |
The actual list of language meta data. More... | |
const LanguageMetadata * | _current_language = NULL |
The currently loaded language. More... | |
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 [TEXT_TAB_END] |
Offset into langpack offs. | |
static uint | _langtab_start [TEXT_TAB_END] |
Offset into langpack offs. | |
static bool | _scan_for_gender_data = false |
Are we scanning for the gender of the current string? (instead of formatting it) | |
static const Units | _units_velocity [] |
Unit conversions for velocity. More... | |
static const Units | _units_power [] |
Unit conversions for velocity. More... | |
static const UnitsLong | _units_weight [] |
Unit conversions for weight. More... | |
static const UnitsLong | _units_volume [] |
Unit conversions for volume. More... | |
static const Units | _units_force [] |
Unit conversions for force. More... | |
static const Units | _units_height [] |
Unit conversions for height. More... | |
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 [] |
Handling of translated strings.
Definition in file strings.cpp.
void CheckForMissingGlyphs | ( | bool | base_font, |
MissingGlyphSearcher * | searcher | ||
) |
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.
base_font | Whether to look at the base font as well. |
searcher | The methods to use to search for strings to check. If NULL the loaded language pack searcher is used. |
Definition at line 2089 of file strings.cpp.
References MissingGlyphSearcher::FindMissingGlyphs().
Referenced by TextfileWindow::LoadTextfile(), and MissingGlyphSearcher::~MissingGlyphSearcher().
uint ConvertDisplaySpeedToKmhishSpeed | ( | uint | speed | ) |
Convert the given display speed to the km/h-ish speed.
speed | the speed to convert |
Definition at line 755 of file strings.cpp.
References _settings_game, Units::c, UnitConversion::FromDisplay(), GameSettings::locale, and LocaleSettings::units_velocity.
Referenced by TimetableWindow::OnQueryTextFinished().
uint ConvertDisplaySpeedToSpeed | ( | uint | speed | ) |
Convert the given display speed to the (internal) speed.
speed | the speed to convert |
Definition at line 735 of file strings.cpp.
References _settings_game, Units::c, UnitConversion::FromDisplay(), GameSettings::locale, and LocaleSettings::units_velocity.
Referenced by OrdersWindow::OnQueryTextFinished().
uint ConvertKmhishSpeedToDisplaySpeed | ( | uint | speed | ) |
Convert the given km/h-ish speed to the display speed.
speed | the speed to convert |
Definition at line 745 of file strings.cpp.
References _settings_game, Units::c, GameSettings::locale, UnitConversion::ToDisplay(), and LocaleSettings::units_velocity.
uint ConvertSpeedToDisplaySpeed | ( | uint | speed | ) |
Convert the given (internal) speed to the display speed.
speed | the speed to convert |
Definition at line 722 of file strings.cpp.
References _settings_game, Units::c, GameSettings::locale, UnitConversion::ToDisplay(), and LocaleSettings::units_velocity.
void CopyInDParam | ( | int | offs, |
const uint64 * | src, | ||
int | num | ||
) |
Copy num string parameters from array src into the global string parameter array.
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 138 of file strings.cpp.
References MemCpyT().
Referenced by ErrmsgWindow::DrawWidget(), SetDParam(), ErrmsgWindow::SetStringParameters(), QueryWindow::SetStringParameters(), 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.
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 149 of file strings.cpp.
References MemCpyT().
Referenced by ErrorMessageData::CopyOutDParams(), and SetDParam().
void CopyOutDParam | ( | uint64 * | dst, |
const char ** | strings, | ||
StringID | string, | ||
int | num | ||
) |
Copy num string parameters from the global string parameter array to the dst array.
Furthermore clone raw string parameters into strings and amend the data in dst.
dst | Destination array of string parameters. |
strings | Destination array for clone of the raw strings. Must be of same length as dst. Deallocation left to the caller. |
string | The string used to determine where raw strings are and where there are no raw strings. |
num | Number of string parameters to copy. |
Definition at line 162 of file strings.cpp.
References DRAW_STRING_BUFFER.
|
static |
Determine the "plural" index given a plural form and a number.
count | The number to get the plural index of. |
plural_form | The plural form we want an index for. |
Definition at line 502 of file strings.cpp.
References abs().
|
static |
Format a given number as a number of bytes with the SI prefix.
buff | the buffer to write to |
number | the number of bytes to write down |
last | the last element in the buffer |
Definition at line 372 of file strings.cpp.
|
static |
Format a number into a string.
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. |
Definition at line 304 of file strings.cpp.
References _settings_game, LanguagePackHeader::digit_decimal_separator, LocaleSettings::digit_decimal_separator, GameSettings::locale, seprintf(), and strecpy().
|
static |
Parse most format codes within a string and write the result to a buffer.
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. |
case_index | |
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 768 of file strings.cpp.
References CreateTextRefStackBackup(), StringParameters::HasTypeInformation(), StringParameters::offset, RestoreTextRefStackBackup(), and UsingNewGRFTextStack().
const char* GetCurrentLanguageIsoCode | ( | ) |
Get the ISO language code of the currently loaded language.
Definition at line 1992 of file strings.cpp.
References LanguagePackHeader::isocode.
Referenced by GameOptionsWindow::DrawWidget(), GetDParam(), 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.
param | environment variable to check conditionally if default ones are not set. Pass NULL if you don't want additional checks. |
Definition at line 1839 of file strings.cpp.
const LanguageMetadata* GetLanguage | ( | byte | newgrflangid | ) |
Get the language with the given NewGRF language ID.
newgrflangid | NewGRF languages ID to check. |
Definition at line 1875 of file strings.cpp.
References SmallVector< T, S >::Begin(), and SmallVector< T, S >::End().
|
static |
Reads the language file header and checks compatibility.
file | the file to read |
hdr | the place to write the header information to |
Definition at line 1890 of file strings.cpp.
|
static |
Gets a list of languages from the given directory.
path | the base directory to search in |
Definition at line 1912 of file strings.cpp.
References ttd_opendir().
char* GetStringWithArgs | ( | char * | buffr, |
StringID | string, | ||
StringParameters * | args, | ||
const char * | last, | ||
uint | case_index, | ||
bool | game_script | ||
) |
Get a parsed string with most special stringcodes replaced by the string 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. |
case_index | The "case index". This will only be set when FormatString wants to print the string in a different case. |
game_script | The string is coming directly from a game script. |
Definition at line 216 of file strings.cpp.
References GetStringIndex(), GetStringTab(), and GetStringWithArgs().
Referenced by GetStringWithArgs(), and GetTownName().
void InitializeLanguagePacks | ( | ) |
Make a list of the available language packs.
Put the data in _languages list.
< Matching the language in the configuration 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 1944 of file strings.cpp.
References FOR_ALL_SEARCHPATHS.
Referenced by GetDParam().
void InjectDParam | ( | uint | amount | ) |
Shift the string parameters in the global string parameter array by amount positions, making room at the beginning.
amount | Number of positions to shift. |
Definition at line 288 of file strings.cpp.
bool ReadLanguagePack | ( | const LanguageMetadata * | lang | ) |
Read a particular language.
lang | The metadata about the language. |
Definition at line 1716 of file strings.cpp.
References StringParameters::data, LanguageMetadata::file, free(), LanguagePackHeader::IsValid(), LanguagePackHeader::offsets, ReadFileToMem(), and TEXT_TAB_END.
void SetDParamMaxDigits | ( | uint | n, |
uint | count, | ||
FontSize | size | ||
) |
Set DParam n to some number that is suitable for string size computations.
n | Index of the string parameter. |
count | Number of digits which shall be displayable. |
size | Font of the number |
Definition at line 121 of file strings.cpp.
References GetBroadestDigit(), and SetDParam().
Referenced by SetDParam(), SetDParamMaxValue(), DepotWindow::UpdateWidgetSize(), and ScanProgressWindow::UpdateWidgetSize().
void SetDParamMaxValue | ( | uint | n, |
uint64 | max_value, | ||
uint | min_count, | ||
FontSize | size | ||
) |
Set DParam n to some number that is suitable for string size computations.
n | Index of the string parameter. |
max_value | The biggest value which shall be displayed. For the result only the number of digits of max_value matter. |
min_count | Minimum number of digits independent of max. |
size | Font of the number |
Definition at line 105 of file strings.cpp.
References max(), and SetDParamMaxDigits().
Referenced by TimetableWindow::DrawWidget(), OrdersWindow::DrawWidget(), SetDParam(), SetDateWindow::UpdateWidgetSize(), StatusBarWindow::UpdateWidgetSize(), TimetableWindow::UpdateWidgetSize(), NewGRFParametersWindow::UpdateWidgetSize(), CompanyFinancesWindow::UpdateWidgetSize(), GenerateLandscapeWindow::UpdateWidgetSize(), BaseGraphWindow::UpdateWidgetSize(), DepotWindow::UpdateWidgetSize(), CreateScenarioWindow::UpdateWidgetSize(), GenerateProgressWindow::UpdateWidgetSize(), VehicleDetailsWindow::UpdateWidgetSize(), and ScanProgressWindow::UpdateWidgetSize().
void SetDParamStr | ( | uint | n, |
const char * | str | ||
) |
This function is used to "bind" a C string to a OpenTTD dparam slot.
n | slot of the string |
str | string to bind |
Definition at line 279 of file strings.cpp.
References SetDParam().
Referenced by CompanyCheckBankrupt(), GameOptionsWindow::DrawWidget(), GoalQuestionWindow::DrawWidget(), NetworkChatWindow::DrawWidget(), MusicWindow::DrawWidget(), AIConfigWindow::DrawWidget(), ErrorUnknownCallbackResult(), StoryBookWindow::GetHeadHeight(), IndustryDirectoryWindow::GetIndustryString(), StoryBookWindow::GetPageElementHeight(), GetSavegameFormat(), GetSaveLoadErrorString(), GRFLoadConfig(), SaveFileError(), SetDParam(), ContentTextfileWindow::SetStringParameters(), BaseSetTextfileWindow< TBaseSet >::SetStringParameters(), StoryBookWindow::SetStringParameters(), AboutWindow::SetStringParameters(), NewGRFTextfileWindow::SetStringParameters(), ScriptTextfileWindow::SetStringParameters(), NewGRFWindow::SetStringParameters(), NetworkLobbyWindow::SetStringParameters(), CustomCurrencyWindow::SetStringParameters(), ShowNewGrfVehicleError(), LandInfoWindow::UpdateWidgetSize(), MusicTrackSelectionWindow::UpdateWidgetSize(), GameOptionsWindow::UpdateWidgetSize(), GoalQuestionWindow::UpdateWidgetSize(), NetworkChatWindow::UpdateWidgetSize(), MusicWindow::UpdateWidgetSize(), StoryBookWindow::UpdateWidgetSize(), and WarnCorruptSprite().
const LanguageMetadata* _current_language = NULL |
The currently loaded language.
Definition at line 50 of file strings.cpp.
Referenced by SelectGameWindow::UpdateWidgetSize().
|
static |
Definition at line 1593 of file strings.cpp.
LanguageList _languages |
The actual list of language meta data.
Definition at line 49 of file strings.cpp.
|
static |
Definition at line 1530 of file strings.cpp.
|
static |
Definition at line 1578 of file strings.cpp.
|
static |
Unit conversions for force.
Definition at line 704 of file strings.cpp.
|
static |
Unit conversions for height.
Definition at line 711 of file strings.cpp.
|
static |
Unit conversions for velocity.
Definition at line 683 of file strings.cpp.
|
static |
Unit conversions for velocity.
Definition at line 676 of file strings.cpp.
|
static |
Unit conversions for volume.
Definition at line 697 of file strings.cpp.
|
static |
Unit conversions for weight.
Definition at line 690 of file strings.cpp.