OpenTTD Source
12.0-beta2
|
#include "stdafx.h"
#include "debug.h"
#include "core/alloc_func.hpp"
#include "core/math_func.hpp"
#include "string_func.h"
#include "string_base.h"
#include "table/control_codes.h"
#include <stdarg.h>
#include <ctype.h>
#include <sstream>
#include <unicode/ustring.h>
#include "language.h"
#include "gfx_func.h"
#include "safeguards.h"
#include <unicode/utext.h>
#include <unicode/brkiter.h>
Go to the source code of this file.
Data Structures | |
class | IcuStringIterator |
String iterator using ICU as a backend. More... | |
Functions | |
int CDECL | vseprintf (char *str, const char *last, const char *format, va_list ap) |
Safer implementation of vsnprintf; same as vsnprintf except: More... | |
char * | strecat (char *dst, const char *src, const char *last) |
Appends characters from one string to another. More... | |
char * | strecpy (char *dst, const char *src, const char *last) |
Copies characters from one buffer to another. More... | |
char * | stredup (const char *s, const char *last) |
Create a duplicate of the given string. More... | |
char *CDECL | str_fmt (const char *str,...) |
Format, "printf", into a newly allocated string. More... | |
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. More... | |
template<class T > | |
static void | StrMakeValidInPlace (T &dst, const char *str, const char *last, StringValidationSettings settings) |
void | StrMakeValidInPlace (char *str, const char *last, StringValidationSettings settings) |
Scans the string for invalid characters and replaces then with a question mark '?' (if not ignored). More... | |
void | StrMakeValidInPlace (char *str, StringValidationSettings settings) |
Scans the string for invalid characters and replaces then with a question mark '?' (if not ignored). More... | |
std::string | StrMakeValid (const std::string &str, StringValidationSettings settings) |
Scans the string for invalid characters and replaces then with a question mark '?' (if not ignored). More... | |
bool | StrValid (const char *str, const char *last) |
Checks whether the given string is valid, i.e. More... | |
static void | StrLeftTrimInPlace (std::string &str) |
Trim the spaces from the begin of given string in place, i.e. More... | |
static void | StrRightTrimInPlace (std::string &str) |
Trim the spaces from the end of given string in place, i.e. More... | |
void | StrTrimInPlace (std::string &str) |
Trim the spaces from given string in place, i.e. More... | |
bool | StrStartsWith (const std::string_view str, const std::string_view prefix) |
Check whether the given string starts with the given prefix. More... | |
bool | StrEndsWith (const std::string_view str, const std::string_view suffix) |
Check whether the given string ends with the given suffix. More... | |
void | str_strip_colours (char *str) |
Scans the string for colour codes and strips them. | |
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. More... | |
size_t | Utf8StringLength (const std::string &str) |
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. More... | |
bool | strtolower (char *str) |
Convert a given ASCII string to lowercase. More... | |
bool | strtolower (std::string &str, std::string::size_type offs) |
bool | IsValidChar (WChar key, CharSetFilter afilter) |
Only allow certain keys. More... | |
int CDECL | seprintf (char *str, const char *last, const char *format,...) |
Safer implementation of snprintf; same as snprintf except: More... | |
char * | md5sumToString (char *buf, const char *last, const uint8 md5sum[16]) |
Convert the md5sum to a hexadecimal string representation. More... | |
size_t | Utf8Decode (WChar *c, const char *s) |
Decode and consume the next UTF-8 encoded character. More... | |
template<class T > | |
size_t | Utf8Encode (T buf, WChar c) |
Encode a unicode character and place it in the buffer. More... | |
size_t | Utf8Encode (char *buf, WChar c) |
size_t | Utf8Encode (std::ostreambuf_iterator< char > &buf, WChar c) |
size_t | Utf8TrimString (char *s, size_t maxlen) |
Properly terminate an UTF8 string to some maximum length. More... | |
static const char * | SkipGarbage (const char *str) |
Skip some of the 'garbage' in the string that we don't want to use to sort on. More... | |
int | strnatcmp (const char *s1, const char *s2, bool ignore_garbage_at_front) |
Compares two strings using case insensitive natural sort. More... | |
Handling of C-type strings (char*).
Definition in file string.cpp.
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 476 of file string.cpp.
References CS_ALPHANUMERAL.
Referenced by IConsoleCmdExec().
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 553 of file string.cpp.
References seprintf().
Referenced by HandleSavegameLoadCrash(), IsGoodGRFConfigList(), OutputContentState(), PrintGrfInfo(), and ClientNetworkGameSocketHandler::Receive_SERVER_CHECK_NEWGRFS().
int CDECL seprintf | ( | char * | str, |
const char * | last, | ||
const char * | format, | ||
... | |||
) |
Safer implementation of snprintf; same as snprintf except:
str | buffer to write to up to last |
last | last character we may write to |
format | the formatting (see snprintf) |
Definition at line 535 of file string.cpp.
References vseprintf().
Referenced by NetworkError::AsString(), NetworkChatWindow::ChatTabCompletion(), ScriptAllocator::CheckAllocation(), CheckExternalFiles(), ScriptInfo::CheckMethod(), Squirrel::CompileError(), Squirrel::CreateClassInstanceVM(), DeleteGRFPresetFromConfig(), CrashLogOSX::DisplayCrashDialog(), AIInfo::DummyConstructor(), CrashLog::FillCrashLog(), GameScannerInfo::FindInfo(), AIScannerInfo::FindInfo(), GameScannerLibrary::FindLibrary(), AIScannerLibrary::FindLibrary(), FormatNumber(), StringSettingDesc::FormatValue(), CrashLog::GamelogFillCrashLog(), GamelogPrint(), BlitterFactory::GetBlittersInfo(), ScriptScanner::GetConsoleList(), DriverFactoryBase::GetDriversInfo(), GameScannerInfo::GetScriptName(), AIScannerInfo::GetScriptName(), GameScannerLibrary::GetScriptName(), AIScannerLibrary::GetScriptName(), BaseMedia< GraphicsSet >::GetSetsList(), GRFBuildParamList(), HandleSavegameLoadCrash(), ScriptInstance::LoadCompatibilityScripts(), LoadGRFPresetFromConfig(), CrashLog::LogCompiler(), CrashLog::LogConfiguration(), CrashLogWindows::LogError(), CrashLogUnix::LogError(), CrashLogOSX::LogError(), CrashLog::LogGamelog(), CrashLog::LogLibraries(), CrashLog::LogOpenTTDVersion(), CrashLogUnix::LogOSVersion(), CrashLogWindows::LogOSVersion(), CrashLog::LogRecentNews(), CrashLogWindows::LogRegisters(), CrashLogWindows::LogStacktrace(), CrashLogOSX::LogStacktrace(), CrashLogUnix::LogStacktrace(), md5sumToString(), PrintGrfInfo(), ScriptScanner::RegisterScript(), NetworkAddress::Resolve(), TCPConnecter::Resolve(), Squirrel::RunError(), SaveGRFPresetToConfig(), Script_CreateDummyInfo(), SetFallbackFont(), ScriptConfig::SettingsToString(), ShowHelp(), CrashLog::WriteCrashLog(), and CrashLog::WriteSavegame().
|
static |
Skip some of the 'garbage' in the string that we don't want to use to sort on.
This way the alphabetical sorting will work better as we would be actually using those characters instead of some other characters such as spaces and tildes at the begin of the name.
str | The string to skip the initial garbage of. |
Definition at line 704 of file string.cpp.
References IsInsideMM().
Referenced by strnatcmp().
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 169 of file string.cpp.
References Utf8Decode(), and Utf8EncodedCharLen().
char* CDECL str_fmt | ( | const char * | str, |
... | |||
) |
Format, "printf", into a newly allocated string.
str | The formatting string. |
Definition at line 150 of file string.cpp.
References lastof, and vseprintf().
Referenced by DEF_CONSOLE_CMD().
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 nullptr 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 84 of file string.cpp.
References strecpy().
Referenced by KeycodeToString(), Squirrel::PrintFunc(), SaveKeycodes(), and ScriptConfig::SettingsToString().
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 nullptr 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 112 of file string.cpp.
References Debug, and error().
Referenced by ScenarioScanner::AddFile(), Textbuf::Assign(), DriverFactoryBase::DriverFactoryBase(), GameScannerInfo::FindInfo(), AIScannerInfo::FindInfo(), BoolSettingDesc::FormatValue(), StringSettingDesc::FormatValue(), GamelogRevision(), GenerateTownNameString(), GetClipboardContents(), GRFBuildParamList(), FileStringReader::HandlePragma(), IConsoleAliasExec(), MakeCatalanTownName(), MakeCzechTownName(), MakeFinnishTownName(), MakeFrenchTownName(), MakeHungarianTownName(), MakeItalianTownName(), MakeNorwegianTownName(), MakeRomanianTownName(), MakeSillyTownName(), MakeSlovakTownName(), MakeSpanishTownName(), MakeSwissTownName(), MakeTurkishTownName(), mkpath(), NetworkFindBroadcastIPsInternal(), AIDebugWindow::OnEditboxChanged(), MusicDriver_ExtMidi::PlaySong(), StringListReader::ReadLine(), SetFallbackFont(), FileToSaveLoad::SetTitle(), strecat(), and DriverFactoryBase::~DriverFactoryBase().
char* stredup | ( | const char * | s, |
const char * | last | ||
) |
Create a duplicate of the given string.
s | The string to duplicate. |
last | The last character that is safe to duplicate. If nullptr, the whole string is duplicated. |
Definition at line 137 of file string.cpp.
References ttd_strnlen().
Referenced by ScriptConfig::Change(), NetworkChatWindow::ChatTabCompletion(), CmdSetGoalProgress(), CmdSetGoalText(), CmdSetStoryPageTitle(), AIInfo::Constructor(), ErrorMessageData::ErrorMessageData(), FileWriter::FileWriter(), GamelogSetting(), GetFontByFaceName(), GRFConfig::GRFConfig(), GRFFile::GRFFile(), IConsolePrint(), IsGoodGRFConfigList(), ScriptScanner::RegisterScript(), ScriptConfig::ScriptConfig(), ErrorMessageData::SetDParamStr(), AIConfig::SetSetting(), ScriptConfig::SetSetting(), SlError(), MusicDriver_ExtMidi::Start(), ScriptConfig::StringToSettings(), UpdateElement(), and UpdateOSKOriginalText().
bool StrEndsWith | ( | const std::string_view | str, |
const std::string_view | suffix | ||
) |
Check whether the given string ends with the given suffix.
str | The string to look at. |
suffix | The suffix to look for. |
Definition at line 380 of file string.cpp.
Referenced by GetSettingFromName().
|
static |
Trim the spaces from the begin of given string in place, i.e.
the string buffer that is passed will be modified whenever spaces exist in the given string. When there are spaces at the begin, the whole string is moved forward.
str | The string to perform the in place left trimming on. |
Definition at line 330 of file string.cpp.
Referenced by StrTrimInPlace().
std::string StrMakeValid | ( | const std::string & | str, |
StringValidationSettings | settings | ||
) |
Scans the string for invalid characters and replaces then with a question mark '?' (if not ignored).
str | The string to validate. |
settings | The settings for the string validation. |
Definition at line 281 of file string.cpp.
References settings, and StrMakeValidInPlace().
Referenced by IniGroup::IniGroup(), IniItem::IniItem(), IniLoadFile::LoadFromDisk(), StringSettingDesc::MakeValueValid(), and Packet::Recv_string().
void StrMakeValidInPlace | ( | char * | str, |
const char * | last, | ||
StringValidationSettings | settings | ||
) |
Scans the string for invalid characters and replaces then 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 255 of file string.cpp.
References settings, and StrMakeValidInPlace().
Referenced by StrMakeValid(), and StrMakeValidInPlace().
void StrMakeValidInPlace | ( | char * | str, |
StringValidationSettings | settings | ||
) |
Scans the string for invalid characters and replaces then with a question mark '?' (if not ignored).
Only use this function when you are sure the string ends with a '\0'; otherwise use StrMakeValidInPlace(str, last, settings) variant.
str | The string (of which you are sure ends with '\0') to validate. |
Definition at line 269 of file string.cpp.
References settings, and StrMakeValidInPlace().
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 718 of file string.cpp.
References _current_collator, and SkipGarbage().
Referenced by GRFSorter(), IndustryDirectoryWindow::IndustryNameSorter(), NetworkContentListWindow::NameSorter(), NewGRFWindow::NameSorter(), NetworkGameWindow::NGameNameSorter(), SignList::SignNameSorter(), CompanyStationsWindow::StationNameSorter(), TownDirectoryWindow::TownNameSorter(), and NetworkContentListWindow::TypeSorter().
|
static |
Trim the spaces from the end of given string in place, i.e.
the string buffer that is passed will be modified whenever spaces exist in the given string. When there are spaces at the end, the '\0' will be moved forward.
str | The string to perform the in place left trimming on. |
Definition at line 342 of file string.cpp.
Referenced by StrTrimInPlace().
bool StrStartsWith | ( | const std::string_view | str, |
const std::string_view | prefix | ||
) |
Check whether the given string starts with the given prefix.
str | The string to look at. |
prefix | The prefix to look for. |
Definition at line 367 of file string.cpp.
Referenced by ClientNetworkCoordinatorSocketHandler::ConnectToServer(), GetCompanySettingFromName(), and ServerAddress::Parse().
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 447 of file string.cpp.
Referenced by GameScannerInfo::FindInfo(), AIScannerInfo::FindInfo(), GameScannerLibrary::FindLibrary(), AIScannerLibrary::FindLibrary(), ScriptScanner::RegisterScript(), and SimplifyFileName().
void StrTrimInPlace | ( | std::string & | str | ) |
Trim the spaces from given string in place, i.e.
the string buffer that is passed will be modified whenever spaces exist in the given string. When there are spaces at the begin, the whole string is moved forward and when there are spaces at the back the '\0' termination is moved.
str | The string to perform the in place trimming on. |
Definition at line 355 of file string.cpp.
References StrLeftTrimInPlace(), and StrRightTrimInPlace().
Referenced by CheckClientAndServerName(), NetworkValidateClientName(), and NetworkValidateServerName().
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 300 of file string.cpp.
References Utf8Decode(), and Utf8EncodedCharLen().
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 574 of file string.cpp.
References GB(), and HasBit().
Referenced by Layouter::GetCharPosition(), Layouter::Layouter(), str_fix_scc_encoded(), str_strip_colours(), StrValid(), and TranslateTTDPatchCodes().
|
inline |
Encode a unicode character and place it in the buffer.
T | Type of the buffer. |
buf | Buffer to place character. |
c | Unicode character to encode. |
Definition at line 616 of file string.cpp.
Referenced by UnmappedChoiceList::Flush().
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 417 of file string.cpp.
Referenced by CmdAlterGroup(), CmdPlaceSign(), CmdRenameCompany(), CmdRenameDepot(), CmdRenameEngine(), CmdRenamePresident(), CmdRenameStation(), CmdRenameTown(), CmdRenameVehicle(), CmdRenameWaypoint(), Utf8StringLength(), and VerifyTownName().
size_t Utf8StringLength | ( | const std::string & | str | ) |
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 431 of file string.cpp.
References Utf8StringLength().
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 660 of file string.cpp.
References Utf8EncodedCharLen().
int CDECL vseprintf | ( | char * | str, |
const char * | last, | ||
const char * | format, | ||
va_list | ap | ||
) |
Safer implementation of vsnprintf; same as vsnprintf except:
str | buffer to write to up to last |
last | last character we may write to |
format | the formatting (see snprintf) |
ap | the list of arguments for the format |
Definition at line 61 of file string.cpp.
Referenced by error(), Squirrel::ErrorPrintFunc(), grfmsg(), MidiSendCommand(), Textbuf::Print(), Squirrel::PrintFunc(), seprintf(), ShowInfoF(), SlErrorCorruptFmt(), str_fmt(), and usererror().