Header of Action 04 "universal holder" structure and functions. More...
#include "string_type.h"
#include "strings_type.h"
#include "core/smallvec_type.hpp"
Go to the source code of this file.
Data Structures | |
struct | LanguageMap |
Mapping of language data between a NewGRF and OpenTTD. More... | |
struct | LanguageMap::Mapping |
Mapping between NewGRF and OpenTTD IDs. More... | |
Functions | |
StringID | AddGRFString (uint32 grfid, uint16 stringid, byte langid, bool new_scheme, const char *text_to_add, StringID def_string) |
Add the new read string into our structure. | |
StringID | GetGRFStringID (uint32 grfid, uint16 stringid) |
Returns the index for this stringid associated with its grfID. | |
const char * | GetGRFStringFromGRFText (const struct GRFText *text) |
const char * | GetGRFStringPtr (uint16 stringid) |
Get a C-string from a stringid set by a newgrf. | |
void | CleanUpStrings () |
House cleaning. | |
void | SetCurrentGrfLangID (byte language_id) |
Equivalence Setter function between game and newgrf langID. | |
char * | TranslateTTDPatchCodes (uint32 grfid, uint8 language_id, const char *str, int *olen=NULL) |
Translate TTDPatch string codes into something OpenTTD can handle (better). | |
struct GRFText * | DuplicateGRFText (struct GRFText *orig) |
Create a copy of this GRFText list. | |
void | AddGRFTextToList (struct GRFText **list, struct GRFText *text_to_add) |
Add a GRFText to a GRFText list. | |
void | AddGRFTextToList (struct GRFText **list, byte langid, uint32 grfid, const char *text_to_add) |
Add a string to a GRFText list. | |
void | AddGRFTextToList (struct GRFText **list, const char *text_to_add) |
Add a GRFText to a GRFText list. | |
void | CleanUpGRFText (struct GRFText *grftext) |
Delete all items of a linked GRFText list. | |
bool | CheckGrfLangID (byte lang_id, byte grf_version) |
void | StartTextRefStackUsage (byte numEntries, const uint32 *values=NULL) |
Start using the TTDP compatible string code parsing. | |
void | StopTextRefStackUsage () |
Stop using the TTDP compatible string code parsing. | |
void | RewindTextRefStack () |
bool | UsingNewGRFTextStack () |
Check whether the NewGRF text stack is in use. | |
struct TextRefStack * | CreateTextRefStackBackup () |
Create a backup of the current NewGRF text stack. | |
void | RestoreTextRefStackBackup (struct TextRefStack *backup) |
Restore a copy of the text stack to the used stack. | |
uint | RemapNewGRFStringControlCode (uint scc, char *buf_start, char **buff, const char **str, int64 *argv) |
FormatString for NewGRF specific "magic" string control codes. | |
StringID | TTDPStringIDToOTTDStringIDMapping (StringID string) |
Perform a mapping from TTDPatch's string IDs to OpenTTD's string IDs, but only for the ones we are aware off; the rest like likely unused and will show a warning. | |
Variables | |
static const WChar | NFO_UTF8_IDENTIFIER = 0x00DE |
This character, the thorn ('þ'), indicates a unicode string to NFO. |
Header of Action 04 "universal holder" structure and functions.
Definition in file newgrf_text.h.
Add a GRFText to a GRFText list.
list | The list where the text should be added to. | |
text_to_add | The GRFText to add to the list. |
Definition at line 617 of file newgrf_text.cpp.
References GRFText::langid, and GRFText::next.
Referenced by AddGRFString(), AddGRFTextToList(), ChangeGRFDescription(), ChangeGRFName(), ChangeGRFParamDescription(), ChangeGRFParamName(), ChangeGRFParamValueNames(), DEF_UDP_RECEIVE_COMMAND(), and FindUnknownGRFName().
void AddGRFTextToList | ( | struct GRFText ** | list, | |
byte | langid, | |||
uint32 | grfid, | |||
const char * | text_to_add | |||
) |
Add a string to a GRFText list.
list | The list where the text should be added to. | |
langid | The language of the new text. | |
grfid | The grfid where this string is defined. | |
text_to_add | The text to add to the list. |
Definition at line 643 of file newgrf_text.cpp.
References AddGRFTextToList(), GRFText::New(), and TranslateTTDPatchCodes().
void AddGRFTextToList | ( | struct GRFText ** | list, | |
const char * | text_to_add | |||
) |
Add a GRFText to a GRFText list.
The text should not contain any text-codes. The text will be added as a 'default language'-text.
list | The list where the text should be added to. | |
text_to_add | The text to add to the list. |
Definition at line 659 of file newgrf_text.cpp.
References AddGRFTextToList(), and GRFText::New().
void CleanUpGRFText | ( | GRFText * | grftext | ) |
Delete all items of a linked GRFText list.
grftext | the head of the list to delete |
Definition at line 833 of file newgrf_text.cpp.
References GRFText::next.
Referenced by CleanUpStrings(), GRFParameterInfo::~GRFParameterInfo(), and GRFTextWrapper::~GRFTextWrapper().
void CleanUpStrings | ( | ) |
House cleaning.
Remove all strings and reset the text counter.
Definition at line 846 of file newgrf_text.cpp.
References CleanUpGRFText().
Referenced by ResetNewGRFData().
struct TextRefStack* CreateTextRefStackBackup | ( | ) | [read] |
Create a backup of the current NewGRF text stack.
Definition at line 940 of file newgrf_text.cpp.
Referenced by FormatString().
Create a copy of this GRFText list.
orig | The GRFText list to copy. |
Definition at line 669 of file newgrf_text.cpp.
References GRFText::Copy(), and GRFText::next.
Referenced by GRFParameterInfo::GRFParameterInfo().
uint RemapNewGRFStringControlCode | ( | uint | scc, | |
char * | buf_start, | |||
char ** | buff, | |||
const char ** | str, | |||
int64 * | argv | |||
) |
FormatString for NewGRF specific "magic" string control codes.
scc | the string control code that has been read | |
buff | the buffer we're writing to | |
str | the string that we need to write | |
argv | the OpenTTD stack of values |
Definition at line 1007 of file newgrf_text.cpp.
References max(), TextRefStack::RotateTop4Words(), SCC_NEWGRF_DISCARD_WORD, SCC_NEWGRF_PRINT_DATE, SCC_NEWGRF_PRINT_DWORD, SCC_NEWGRF_PRINT_DWORD_CURRENCY, SCC_NEWGRF_PRINT_HEX_BYTE, SCC_NEWGRF_PRINT_HEX_DWORD, SCC_NEWGRF_PRINT_HEX_QWORD, SCC_NEWGRF_PRINT_HEX_WORD, SCC_NEWGRF_PRINT_MONTH_YEAR, SCC_NEWGRF_PRINT_QWORD_CURRENCY, SCC_NEWGRF_PRINT_SIGNED_BYTE, SCC_NEWGRF_PRINT_SIGNED_WORD, SCC_NEWGRF_PRINT_STRING_ID, SCC_NEWGRF_PRINT_UNSIGNED_WORD, SCC_NEWGRF_PRINT_WORD_SPEED, SCC_NEWGRF_PRINT_WORD_STATION_NAME, SCC_NEWGRF_PRINT_WORD_VOLUME, SCC_NEWGRF_PRINT_WORD_WEIGHT, SCC_NEWGRF_PUSH_WORD, SCC_NEWGRF_ROTATE_TOP_4_WORDS, SCC_NEWGRF_UNPRINT, and TTDPStringIDToOTTDStringIDMapping().
Referenced by FormatString().
void RestoreTextRefStackBackup | ( | struct TextRefStack * | backup | ) |
Restore a copy of the text stack to the used stack.
backup | The copy to restore. |
Definition at line 949 of file newgrf_text.cpp.
Referenced by FormatString().
void SetCurrentGrfLangID | ( | byte | language_id | ) |
Equivalence Setter function between game and newgrf langID.
This function will adjust _currentLangID as to what is the LangID of the current language set by the user. This function is called after the user changed language, from strings.cpp:ReadLanguagePack
language_id | iso code of current selection |
Definition at line 810 of file newgrf_text.cpp.
References _currentLangID.
void StartTextRefStackUsage | ( | byte | numEntries, | |
const uint32 * | values | |||
) |
Start using the TTDP compatible string code parsing.
On start a number of values is copied on the TextRefStack. You can then use GetString() and the normal string drawing functions, and they will use the TextRefStack for NewGRF string codes.
However, when you want to draw a string multiple times using the same stack, you have to call RewindTextRefStack() between draws.
After you are done with drawing, you must disable usage of the TextRefStack by calling StopTextRefStackUsage(), so NewGRF string codes operate on the normal string parameters again.
numEntries | number of entries to copy from the registers | |
values | values to copy onto the stack; if NULL the temporary NewGRF registers will be used instead |
Definition at line 972 of file newgrf_text.cpp.
References GB(), and TemporaryStorageArray< TYPE, SIZE >::Get().
Referenced by IndustryViewWindow::DrawInfo(), BuildObjectWindow::DrawWidget(), ErrmsgWindow::DrawWidget(), BuildIndustryWindow::DrawWidget(), GetCargoSuffix(), ShowAdditionalText(), ShowErrorMessage(), and ErrmsgWindow::UpdateWidgetSize().
char* TranslateTTDPatchCodes | ( | uint32 | grfid, | |
uint8 | language_id, | |||
const char * | str, | |||
int * | olen | |||
) |
Translate TTDPatch string codes into something OpenTTD can handle (better).
grfid | The (NewGRF) ID associated with this string | |
language_id | The (NewGRF) language ID associated with this string. | |
str | The string to translate. | |
[out] | olen | The length of the final string. |
Definition at line 392 of file newgrf_text.cpp.
References SmallMap< T, U, S >::Contains(), CS_ALPHANUMERAL, UnmappedChoiceList::Flush(), GB(), LanguageMap::GetLanguageMap(), LanguageMap::GetMapping(), grfmsg(), IsValidChar(), MapGRFStringID(), NFO_UTF8_IDENTIFIER, ReallocT(), SCC_BIGFONT, SCC_NEWGRF_DISCARD_WORD, SCC_NEWGRF_PRINT_DATE, SCC_NEWGRF_PRINT_DWORD, SCC_NEWGRF_PRINT_HEX_BYTE, SCC_NEWGRF_PRINT_HEX_DWORD, SCC_NEWGRF_PRINT_HEX_QWORD, SCC_NEWGRF_PRINT_HEX_WORD, SCC_NEWGRF_PRINT_QWORD_CURRENCY, SCC_NEWGRF_PRINT_WORD_STATION_NAME, SCC_NEWGRF_PRINT_WORD_VOLUME, SCC_NEWGRF_PRINT_WORD_WEIGHT, SCC_NEWGRF_PUSH_WORD, SCC_NEWGRF_ROTATE_TOP_4_WORDS, SCC_NEWGRF_STRINL, SCC_NEWGRF_UNPRINT, SCC_TINYFONT, UnmappedChoiceList::strings, Utf8Decode(), Utf8Encode(), and Utf8EncodedCharLen().
Referenced by AddGRFString(), and AddGRFTextToList().
Perform a mapping from TTDPatch's string IDs to OpenTTD's string IDs, but only for the ones we are aware off; the rest like likely unused and will show a warning.
str | the string ID to convert |
Definition at line 45 of file newgrf_text.cpp.
References DEBUG, and IsInsideMM().
Referenced by MapGRFStringID(), and RemapNewGRFStringControlCode().
bool UsingNewGRFTextStack | ( | ) |
Check whether the NewGRF text stack is in use.
Definition at line 931 of file newgrf_text.cpp.
Referenced by FormatString().
const WChar NFO_UTF8_IDENTIFIER = 0x00DE [static] |
This character, the thorn ('þ'), indicates a unicode string to NFO.
Definition at line 20 of file newgrf_text.h.
Referenced by TranslateTTDPatchCodes().