Functions related to low-level strings. More...
#include "core/bitmath_func.hpp"
#include "string_type.h"
Go to the source code of this file.
Functions | |
void | ttd_strlcat (char *dst, const char *src, size_t size) |
Appends characters from one string to another. | |
void | ttd_strlcpy (char *dst, const char *src, size_t size) |
Copies characters from one buffer to another. | |
char * | strecat (char *dst, const char *src, const char *last) |
Appends characters from one string to another. | |
char * | strecpy (char *dst, const char *src, const char *last) |
Copies characters from one buffer to another. | |
int CDECL | seprintf (char *str, const char *last, const char *format,...) WARN_FORMAT(3 |
int CDECL char *CDECL | str_fmt (const char *str,...) WARN_FORMAT(1 |
int CDECL char *CDECL void | str_validate (char *str, const char *last, StringValidationSettings settings=SVS_REPLACE_WITH_QUESTION_MARK) |
Scans the string for valid characters and if it finds invalid ones, replaces them with a question mark '?' (if not ignored). | |
void | ValidateString (const char *str) |
Scans the string for valid characters and if it finds invalid ones, replaces them with a question mark '?'. | |
void | str_fix_scc_encoded (char *str, const char *last) |
Scan the string for old values of SCC_ENCODED and fix it to it's new, static value. | |
void | str_strip_colours (char *str) |
Scans the string for colour codes and strips them. | |
bool | strtolower (char *str) |
Convert a given ASCII string to lowercase. | |
bool | StrValid (const char *str, const char *last) |
Checks whether the given string is valid, i.e. | |
static bool | StrEmpty (const char *s) |
Check if a string buffer is empty. | |
static size_t | ttd_strnlen (const char *str, size_t maxlen) |
Get the length of a string, within a limited buffer. | |
char * | md5sumToString (char *buf, const char *last, const uint8 md5sum[16]) |
Convert the md5sum to a hexadecimal string representation. | |
bool | IsValidChar (WChar key, CharSetFilter afilter) |
Only allow certain keys. | |
size_t | Utf8Decode (WChar *c, const char *s) |
Decode and consume the next UTF-8 encoded character. | |
size_t | Utf8Encode (char *buf, WChar c) |
Encode a unicode character and place it in the buffer. | |
size_t | Utf8TrimString (char *s, size_t maxlen) |
Properly terminate an UTF8 string to some maximum length. | |
static WChar | Utf8Consume (const char **s) |
static int8 | Utf8CharLen (WChar c) |
Return the length of a UTF-8 encoded character. | |
static int8 | Utf8EncodedCharLen (char c) |
Return the length of an UTF-8 encoded value based on a single char. | |
static bool | IsUtf8Part (char c) |
static char * | Utf8PrevChar (char *s) |
Retrieve the previous UNICODE character in an UTF-8 encoded string. | |
static const char * | Utf8PrevChar (const char *s) |
size_t | Utf8StringLength (const char *s) |
Get the length of an UTF-8 encoded string in number of characters and thus not the number of bytes that the encoded string contains. | |
static bool | Utf16IsLeadSurrogate (uint c) |
Is the given character a lead surrogate code point? | |
static bool | Utf16IsTrailSurrogate (uint c) |
Is the given character a lead surrogate code point? | |
static WChar | Utf16DecodeSurrogate (uint lead, uint trail) |
Convert an UTF-16 surrogate pair to the corresponding Unicode character. | |
static WChar | Utf16DecodeChar (const uint16 *c) |
Decode an UTF-16 character. | |
static bool | IsTextDirectionChar (WChar c) |
Is the given character a text direction character. | |
static bool | IsPrintable (WChar c) |
static bool | IsWhitespace (WChar c) |
Check whether UNICODE character is whitespace or not, i.e. | |
int | strnatcmp (const char *s1, const char *s2, bool ignore_garbage_at_front=false) |
Compares two strings using case insensitive natural sort. |
Functions related to low-level strings.
Definition in file string_func.h.
static bool IsTextDirectionChar | ( | WChar | c | ) | [inline, static] |
Is the given character a text direction character.
c | The character to test. |
Definition at line 209 of file string_func.h.
References CHAR_TD_LRE, CHAR_TD_LRM, CHAR_TD_LRO, CHAR_TD_PDF, CHAR_TD_RLE, CHAR_TD_RLM, and CHAR_TD_RLO.
Referenced by MissingGlyphSearcher::FindMissingGlyphs(), GetLayouter(), and FallbackParagraphLayout::NextLine().
bool IsValidChar | ( | WChar | key, | |
CharSetFilter | afilter | |||
) |
Only allow certain keys.
You can define the filter to be used. This makes sure no invalid keys can get into an editbox, like BELL.
key | character to be checked | |
afilter | the filter to use |
Definition at line 368 of file string.cpp.
References CS_ALPHA, CS_ALPHANUMERAL, CS_HEXADECIMAL, CS_NUMERAL, and CS_NUMERAL_SPACE.
Referenced by IConsoleCmdExec(), Textbuf::InsertString(), OskWindow::OnClick(), TranslateTTDPatchCodes(), and OskWindow::UpdateOskState().
static bool IsWhitespace | ( | WChar | c | ) | [inline, static] |
Check whether UNICODE character is whitespace or not, i.e.
whether this is a potential line-break character.
c | UNICODE character to check |
Definition at line 241 of file string_func.h.
Referenced by IConsoleHistoryAdd(), IcuStringIterator::Next(), FallbackParagraphLayout::NextLine(), IcuStringIterator::Prev(), and StringFilter::SetFilterTerm().
char* md5sumToString | ( | char * | buf, | |
const char * | last, | |||
const uint8 | md5sum[16] | |||
) |
Convert the md5sum to a hexadecimal string representation.
buf | buffer to put the md5sum into | |
last | last character of buffer (usually lastof(buf)) | |
md5sum | the md5sum itself |
Definition at line 460 of file string.cpp.
References seprintf().
Referenced by HandleSavegameLoadCrash(), IsGoodGRFConfigList(), MakePNGImage(), NetworkContentListWindow::OpenExternalSearch(), OutputContentState(), PrintGrfInfo(), and ClientNetworkGameSocketHandler::Receive_SERVER_CHECK_NEWGRFS().
void str_fix_scc_encoded | ( | char * | str, | |
const char * | last | |||
) |
Scan the string for old values of SCC_ENCODED and fix it to it's new, static value.
str | the string to scan | |
last | the last valid character of str |
Definition at line 188 of file string.cpp.
References Utf8Decode(), Utf8Encode(), and Utf8EncodedCharLen().
Referenced by SlString().
int CDECL char* CDECL void str_validate | ( | char * | str, | |
const char * | last, | |||
StringValidationSettings | settings | |||
) |
Scans the string for valid characters and if it finds invalid ones, replaces them with a question mark '?' (if not ignored).
str | the string to validate | |
last | the last valid character of str | |
settings | the settings for the string validation. |
Definition at line 214 of file string.cpp.
References SVS_ALLOW_CONTROL_CODE, SVS_ALLOW_NEWLINE, SVS_REPLACE_WITH_QUESTION_MARK, Utf8Decode(), and Utf8EncodedCharLen().
Referenced by FiosFileScanner::AddFile(), FiosGetFileList(), GetFileTitle(), IConsolePrint(), IniGroup::IniGroup(), IniItem::IniItem(), IniLoadFile::LoadFromDisk(), LoadFromHighScore(), TextfileWindow::LoadTextfile(), Packet::Recv_string(), SlString(), and ValidateString().
char* strecat | ( | char * | dst, | |
const char * | src, | |||
const char * | last | |||
) |
Appends characters from one string to another.
Appends the source string to the destination string with respect of the terminating null-character and and the last pointer to the last element in the destination buffer. If the last pointer is set to NULL no boundary check is performed.
dst | The buffer containing the target string | |
src | The buffer containing the string to append | |
last | The pointer to the last element of the destination buffer |
Definition at line 118 of file string.cpp.
References strecpy().
char* strecpy | ( | char * | dst, | |
const char * | src, | |||
const char * | last | |||
) |
Copies characters from one buffer to another.
Copies the source string to the destination buffer with respect of the terminating null-character and the last pointer to the last element in the destination buffer. If the last pointer is set to NULL no boundary check is performed.
dst | The destination buffer | |
src | The buffer containing the string to copy | |
last | The pointer to the last element of the destination buffer |
Definition at line 68 of file depend.cpp.
References DEBUG, and error().
Referenced by ScriptScanner::AddFile(), ScenarioScanner::AddFile(), FiosFileScanner::AddFile(), TarScanner::AddFile(), CloneVehicleName(), DriverFactoryBase::DriverFactoryBase(), DumpDebugFacilityNames(), ExtractTar(), FioFOpenFile(), FiosGetFileList(), FiosMakeHeightmapName(), FormatNumber(), FormatString(), GamelogRevision(), GeneratePath(), GenerateTownNameString(), NetworkAddress::GetAddressAsString(), GetFileTitle(), GetKeyboardLayout(), GetTextfile(), GRFBuildParamList(), FileStringReader::HandlePragma(), IConsoleAliasExec(), IniSaveSettings(), IsSameScript(), LoadTranslations(), main(), MakeAustrianTownName(), MakeCatalanTownName(), MakeCzechTownName(), MakeDanishTownName(), MakeDutchTownName(), MakeEnglishAdditionalTownName(), MakeEnglishOriginalTownName(), MakeFinnishTownName(), MakeFrenchTownName(), MakeGermanTownName(), MakeHungarianTownName(), MakeItalianTownName(), MakeNorwegianTownName(), MakePNGImage(), MakePolishTownName(), MakeRomanianTownName(), MakeScreenshot(), MakeScreenshotName(), MakeSillyTownName(), MakeSlovakTownName(), MakeSpanishTownName(), MakeSwedishTownName(), MakeSwissTownName(), MakeTurkishTownName(), NetworkAddChatMessage(), NetworkAddress::NetworkAddress(), NetworkFindBroadcastIPsInternal(), NetworkGameListHandleDelayedInsert(), NetworkSendCommand(), NetworkServerChangeClientName(), NetworkServerSetCompanyPassword(), NetworkUDPQueryServer(), NetworkUpdateClientName(), SaveLoadWindow::OnClick(), BaseNetworkContentDownloadStatusWindow::OnDownloadProgress(), NetworkStartServerWindow::OnEditboxChanged(), NetworkGameWindow::OnEditboxChanged(), AIDebugWindow::OnEditboxChanged(), CustomCurrencyWindow::OnQueryTextFinished(), NetworkStartServerWindow::OnQueryTextFinished(), ClientNetworkContentSocketHandler::OnReceiveData(), NetworkContentListWindow::OpenExternalSearch(), openttd_main(), StringReader::ParseFile(), MusicDriver_Win32::PlaySong(), MusicDriver_ExtMidi::PlaySong(), ReadLanguagePack(), ServerNetworkUDPSocketHandler::Receive_CLIENT_FIND_SERVER(), ServerNetworkUDPSocketHandler::Receive_CLIENT_GET_NEWGRFS(), ClientNetworkGameSocketHandler::Receive_SERVER_CLIENT_INFO(), ReconsiderGameScriptLanguage(), NetworkAddress::Resolve(), IniFile::SaveToDisk(), FileScanner::Scan(), ScanFile(), Script_CreateDummy(), DriverFactoryBase::SelectDriverImpl(), ServerNetworkGameSocketHandler::SendCompanyInfo(), TextfileWindow::SetFontNames(), LanguagePackGlyphSearcher::SetFontNames(), SetScreenshotFormat(), ShowHelp(), strecat(), CrashLog::WriteScreenshot(), and DriverFactoryBase::~DriverFactoryBase().
static bool StrEmpty | ( | const char * | s | ) | [inline, static] |
Check if a string buffer is empty.
s | The pointer to the first element of the buffer |
Definition at line 58 of file string_func.h.
Referenced by FiosFileScanner::AddFile(), ServerNetworkAdminSocketHandler::AllowConnection(), CStrA::AppendStr(), CmdCompanyCtrl(), CmdCreateGoal(), CmdCreateStoryPage(), CmdCustomNewsItem(), CmdFoundTown(), CmdGoalQuestion(), CmdPlaceSign(), CmdRenameCompany(), CmdRenameDepot(), CmdRenameEngine(), CmdRenameGroup(), CmdRenamePresident(), CmdRenameSign(), CmdRenameStation(), CmdRenameTown(), CmdRenameVehicle(), CmdRenameWaypoint(), CmdSetGoalProgress(), CmdSetGoalText(), CmdSetStoryPageTitle(), CmdTownSetText(), NetworkContentListWindow::DrawDetails(), NetworkStartServerWindow::DrawWidget(), MusicTrackSelectionWindow::DrawWidget(), LandInfoWindow::DrawWidget(), AISettingsWindow::DrawWidget(), GenerateCompanyPasswordHash(), BlitterFactory::GetBlitterFactory(), ServerNetworkGameSocketHandler::GetClientName(), NetworkAddress::GetHostname(), GetKeyboardLayout(), GRFConfig::GetName(), GetSavegameFormat(), GRFLoadConfig(), IConsoleCmdExec(), IConsoleHistoryAdd(), InitializeMusic(), NetworkAddress::Listen(), LoadFreeTypeFont(), MakeScreenshotName(), NetworkAddress::NetworkAddress(), NetworkAutoCleanCompanies(), NetworkGameListAddItem(), NetworkGameListHandleDelayedInsert(), NetworkServerSetCompanyPassword(), NetworkStartUp(), NetworkGameWindow::NGameAllowedSorter(), NetworkGameWindow::OnEditboxChanged(), NewGRFWindow::OnInvalidateData(), NetworkContentListWindow::OnInvalidateData(), ScenarioEditorToolbarWindow::OnQueryTextFinished(), TimetableWindow::OnQueryTextFinished(), GameSettingsWindow::OnQueryTextFinished(), OrdersWindow::OnQueryTextFinished(), NewGRFParametersWindow::OnQueryTextFinished(), SpriteAlignerWindow::OnQueryTextFinished(), NetworkJoinStatusWindow::OnQueryTextFinished(), NetworkGameWindow::OnQueryTextFinished(), IndustryViewWindow::OnQueryTextFinished(), CreateScenarioWindow::OnQueryTextFinished(), GenerateLandscapeWindow::OnQueryTextFinished(), SelectCompanyManagerFaceWindow::OnQueryTextFinished(), CheatWindow::OnQueryTextFinished(), AISettingsWindow::OnQueryTextFinished(), openttd_main(), FileStringReader::ParseFile(), ServerNetworkUDPSocketHandler::Receive_CLIENT_FIND_SERVER(), ClientNetworkGameSocketHandler::Receive_SERVER_NEED_COMPANY_PASSWORD(), ClientNetworkGameSocketHandler::Receive_SERVER_NEED_GAME_PASSWORD(), ClientNetworkUDPSocketHandler::Receive_SERVER_NEWGRFS(), RenameSign(), NetworkAddress::Resolve(), SaveToHighScore(), BlitterFactory::SelectBlitter(), DriverFactoryBase::SelectDriver(), DriverFactoryBase::SelectDriverImpl(), SendChat(), ServerNetworkGameSocketHandler::SendCompanyInfo(), BaseMedia< Tbase_set >::SetSet(), MusicDriver_ExtMidi::Start(), TranslateGRFStrings(), MusicTrackSelectionWindow::UpdateWidgetSize(), LandInfoWindow::UpdateWidgetSize(), ValidatePlaylist(), and VerifyElementContentParameters().
int strnatcmp | ( | const char * | s1, | |
const char * | s2, | |||
bool | ignore_garbage_at_front | |||
) |
Compares two strings using case insensitive natural sort.
s1 | First string to compare. | |
s2 | Second string to compare. | |
ignore_garbage_at_front | Skip punctuation characters in the front |
Definition at line 623 of file string.cpp.
References _current_collator, DRAW_STRING_BUFFER, lengthof, and SkipGarbage().
Referenced by CargoSpecNameSorter(), EngineNameSorter(), VehicleGroupWindow::GroupNameSorter(), IndustryDirectoryWindow::IndustryNameSorter(), IndustryTypeNameSorter(), NewGRFWindow::NameSorter(), NetworkContentListWindow::NameSorter(), DropDownListStringItem::NatSortFunc(), NetworkGameWindow::NGameNameSorter(), SignList::SignNameSorter(), TownDirectoryWindow::TownNameSorter(), NetworkContentListWindow::TypeSorter(), and VehicleNameSorter().
bool strtolower | ( | char * | str | ) |
Convert a given ASCII string to lowercase.
NOTE: only support ASCII characters, no UTF8 fancy. As currently the function is only used to lowercase data-filenames if they are not found, this is sufficient. If more, or general functionality is needed, look to r7271 where it was removed because it was broken when using certain locales: eg in Turkish the uppercase 'I' was converted to '?', so just revert to the old functionality
str | string to convert |
Definition at line 350 of file string.cpp.
Referenced by GameScannerInfo::FindInfo(), AIScannerInfo::FindInfo(), GameScannerLibrary::FindLibrary(), AIScannerLibrary::FindLibrary(), FioFindFullPath(), FioFOpenFile(), FioOpenFile(), ScriptScanner::RegisterScript(), and SimplifyFileName().
bool StrValid | ( | const char * | str, | |
const char * | last | |||
) |
Checks whether the given string is valid, i.e.
contains only valid (printable) characters and is properly terminated.
str | The string to validate. | |
last | The last character of the string, i.e. the string must be terminated here or earlier. |
Definition at line 277 of file string.cpp.
References Utf8Decode(), and Utf8EncodedCharLen().
Referenced by LanguagePackHeader::IsValid().
void ttd_strlcat | ( | char * | dst, | |
const char * | src, | |||
size_t | size | |||
) |
Appends characters from one string to another.
Appends the source string to the destination string with respect of the terminating null-character and the maximum size of the destination buffer.
dst | The buffer containing the target string | |
src | The buffer containing the string to append | |
size | The maximum size of the destination buffer |
Definition at line 66 of file string.cpp.
References ttd_strlcpy().
Referenced by TarScanner::AddFile(), BuildWithFullPath(), and ScriptInstance::LoadCompatibilityScripts().
void ttd_strlcpy | ( | char * | dst, | |
const char * | src, | |||
size_t | size | |||
) |
Copies characters from one buffer to another.
Copies the source string to the destination buffer with respect of the terminating null-character and the maximum size of the destination buffer.
dst | The destination buffer | |
src | The buffer containing the string to copy | |
size | The maximum size of the destination buffer |
Definition at line 92 of file string.cpp.
Referenced by TarScanner::AddFile(), Textbuf::Assign(), BuildWithFullPath(), GameScannerInfo::FindInfo(), AIScannerInfo::FindInfo(), FioCreateDirectory(), ServerNetworkGameSocketHandler::GetClientName(), GetClipboardContents(), IniLoadSettings(), mkpath(), NetworkFindName(), SetSettingValue(), ShowMissingContentWindow(), and ttd_strlcat().
static size_t ttd_strnlen | ( | const char * | str, | |
size_t | maxlen | |||
) | [inline, static] |
Get the length of a string, within a limited buffer.
str | The pointer to the first element of the buffer | |
maxlen | The maximum size of the buffer |
Definition at line 70 of file string_func.h.
static WChar Utf16DecodeChar | ( | const uint16 * | c | ) | [inline, static] |
Decode an UTF-16 character.
c | Pointer to one or two UTF-16 code points. |
Definition at line 194 of file string_func.h.
References Utf16DecodeSurrogate(), and Utf16IsLeadSurrogate().
Referenced by IcuStringIterator::Next(), and IcuStringIterator::Prev().
static WChar Utf16DecodeSurrogate | ( | uint | lead, | |
uint | trail | |||
) | [inline, static] |
Convert an UTF-16 surrogate pair to the corresponding Unicode character.
lead | Lead surrogate code point. | |
trail | Trail surrogate code point. |
Definition at line 184 of file string_func.h.
Referenced by HandleCharMsg(), and Utf16DecodeChar().
static bool Utf16IsLeadSurrogate | ( | uint | c | ) | [inline, static] |
Is the given character a lead surrogate code point?
c | The character to test. |
Definition at line 163 of file string_func.h.
Referenced by HandleCharMsg(), HandleIMEComposition(), and Utf16DecodeChar().
static bool Utf16IsTrailSurrogate | ( | uint | c | ) | [inline, static] |
Is the given character a lead surrogate code point?
c | The character to test. |
Definition at line 173 of file string_func.h.
Referenced by HandleCharMsg().
static int8 Utf8CharLen | ( | WChar | c | ) | [inline, static] |
Return the length of a UTF-8 encoded character.
c | Unicode character. |
Definition at line 98 of file string_func.h.
Referenced by CopyFromOldName(), FormatString(), Textbuf::InsertString(), and Textbuf::UpdateSize().
size_t Utf8Decode | ( | WChar * | c, | |
const char * | s | |||
) |
Decode and consume the next UTF-8 encoded character.
c | Buffer to place decoded character. | |
s | Character stream to retrieve character from. |
Definition at line 481 of file string.cpp.
References GB(), and HasBit().
Referenced by Textbuf::DeleteChar(), FormatString(), Layouter::GetCharPosition(), GlobalVarChangeInfo(), Layouter::Layouter(), StringFilter::SetFilterTerm(), str_fix_scc_encoded(), str_strip_colours(), str_validate(), StrValid(), and TranslateTTDPatchCodes().
size_t Utf8Encode | ( | char * | buf, | |
WChar | c | |||
) |
Encode a unicode character and place it in the buffer.
buf | Buffer to place character. | |
c | Unicode character to encode. |
Definition at line 521 of file string.cpp.
References GB().
Referenced by CheckForMissingGlyphs(), CopyFromOldName(), DrawNewsString(), UnmappedChoiceList::Flush(), FormatString(), str_fix_scc_encoded(), and TranslateTTDPatchCodes().
static int8 Utf8EncodedCharLen | ( | char | c | ) | [inline, static] |
Return the length of an UTF-8 encoded value based on a single char.
This char should be the first byte of the UTF-8 encoding. If not, or encoding is invalid, return value is 0
c | char to query length of |
Definition at line 117 of file string_func.h.
References GB().
Referenced by str_fix_scc_encoded(), str_validate(), StrValid(), TranslateTTDPatchCodes(), and Utf8TrimString().
static char* Utf8PrevChar | ( | char * | s | ) | [inline, static] |
Retrieve the previous UNICODE character in an UTF-8 encoded string.
s | char pointer pointing to (the first char of) the next character |
Definition at line 142 of file string_func.h.
Referenced by Textbuf::DeleteChar().
size_t Utf8StringLength | ( | const char * | s | ) |
Get the length of an UTF-8 encoded string in number of characters and thus not the number of bytes that the encoded string contains.
s | The string to get the length for. |
Definition at line 330 of file string.cpp.
Referenced by CmdFoundTown(), CmdPlaceSign(), CmdRenameCompany(), CmdRenameDepot(), CmdRenameEngine(), CmdRenameGroup(), CmdRenamePresident(), CmdRenameSign(), CmdRenameStation(), CmdRenameTown(), CmdRenameVehicle(), CmdRenameWaypoint(), GenerateCompanyName(), GeneratePresidentName(), and VerifyTownName().
size_t Utf8TrimString | ( | char * | s, | |
size_t | maxlen | |||
) |
Properly terminate an UTF8 string to some maximum length.
s | string to check if it needs additional trimming | |
maxlen | the maximum length the buffer can have. |
Definition at line 555 of file string.cpp.
References Utf8EncodedCharLen().
Referenced by NetworkAddChatMessage().
void ValidateString | ( | const char * | str | ) |
Scans the string for valid characters and if it finds invalid ones, replaces them with a question mark '?'.
str | the string to validate |
Definition at line 263 of file string.cpp.
References str_validate().
Referenced by ScriptInfo::AddLabels(), ScriptInfo::AddSetting(), and DetermineBasePaths().