OpenTTD
Data Structures | Functions
string.cpp File Reference

Handling of C-type strings (char*). More...

#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 <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...
 
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) More...
 
void ValidateString (const char *str)
 Scans the string for valid characters and if it finds invalid ones, replaces them with a question mark '?'. More...
 
bool StrValid (const char *str, const char *last)
 Checks whether the given string is valid, i.e. 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...
 
bool strtolower (char *str)
 Convert a given ASCII string to lowercase. More...
 
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...
 
size_t Utf8Encode (char *buf, WChar c)
 Encode a unicode character and place it in the buffer. More...
 
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...
 

Detailed Description

Handling of C-type strings (char*).

Definition in file string.cpp.

Function Documentation

◆ IsValidChar()

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.

Parameters
keycharacter to be checked
afilterthe filter to use
Returns
true or false depending if the character is printable/valid or not

Definition at line 338 of file string.cpp.

References CS_ALPHANUMERAL.

Referenced by IConsoleCmdExec(), and ttd_strnlen().

◆ md5sumToString()

char* md5sumToString ( char *  buf,
const char *  last,
const uint8  md5sum[16] 
)

Convert the md5sum to a hexadecimal string representation.

Parameters
bufbuffer to put the md5sum into
lastlast character of buffer (usually lastof(buf))
md5sumthe md5sum itself
Returns
a pointer to the next character after the md5sum

Definition at line 416 of file string.cpp.

References seprintf().

Referenced by HandleSavegameLoadCrash(), IsGoodGRFConfigList(), PrintGrfInfo(), ClientNetworkGameSocketHandler::Receive_SERVER_CHECK_NEWGRFS(), and ttd_strnlen().

◆ seprintf()

int CDECL seprintf ( char *  str,
const char *  last,
const char *  format,
  ... 
)

Safer implementation of snprintf; same as snprintf except:

  • last instead of size, i.e. replace sizeof with lastof.
  • return gives the amount of characters added, not what it would add.
    Parameters
    strbuffer to write to up to last
    lastlast character we may write to
    formatthe formatting (see snprintf)
    Returns
    the number of added characters

Definition at line 398 of file string.cpp.

References vseprintf().

Referenced by ScriptInfo::AddLabels(), ScriptInfo::AddSetting(), CheckExternalFiles(), ScriptInfo::CheckMethod(), CloneVehicleName(), CmdRenamePresident(), Squirrel::CompileError(), Squirrel::CreateClassInstanceVM(), DeleteGRFPresetFromConfig(), CrashLogOSX::DisplayCrashDialog(), ClientNetworkContentSocketHandler::DownloadSelectedContentHTTP(), AIInfo::DummyConstructor(), CrashLog::FillCrashLog(), GameScannerInfo::FindInfo(), AIScannerInfo::FindInfo(), GameScannerLibrary::FindLibrary(), AIScannerLibrary::FindLibrary(), FiosMakeFilename(), FormatNumber(), CrashLog::GamelogFillCrashLog(), GenerateCompanyPasswordHash(), NetworkAddress::GetAddressAsString(), BlitterFactory::GetBlittersInfo(), ServerNetworkGameSocketHandler::GetClientName(), 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(), CrashLogWindows::LogRegisters(), CrashLogWindows::LogStacktrace(), CrashLogOSX::LogStacktrace(), CrashLogUnix::LogStacktrace(), MakeOneOfMany(), md5sumToString(), NetworkFindName(), PrintGrfInfo(), ClientNetworkUDPSocketHandler::Receive_SERVER_RESPONSE(), ScriptScanner::RegisterScript(), NetworkAddress::Resolve(), Squirrel::RunError(), SaveGRFPresetToConfig(), SaveVersionInConfig(), Script_CreateDummyInfo(), SetFallbackFont(), ScriptConfig::SettingsToString(), ShowHelp(), CrashLog::WriteCrashLog(), and CrashLog::WriteSavegame().

◆ SkipGarbage()

static const char* SkipGarbage ( const char *  str)
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.

Parameters
strThe string to skip the initial garbage of.
Returns
The string with the garbage skipped.

Definition at line 555 of file string.cpp.

References IsInsideMM().

Referenced by strnatcmp().

◆ str_fix_scc_encoded()

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.

Parameters
strthe string to scan
lastthe last valid character of str

Definition at line 158 of file string.cpp.

References Utf8Decode(), and Utf8EncodedCharLen().

◆ str_fmt()

char* CDECL str_fmt ( const char *  str,
  ... 
)

Format, "printf", into a newly allocated string.

Parameters
strThe formatting string.
Returns
The formatted string. You must free this!

Definition at line 139 of file string.cpp.

References lastof, and vseprintf().

Referenced by DEF_CONSOLE_CMD().

◆ str_validate()

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)

Parameters
strthe string to validate
lastthe last valid character of str
settingsthe settings for the string validation.

Definition at line 184 of file string.cpp.

References Utf8Decode(), and Utf8EncodedCharLen().

Referenced by IniGroup::IniGroup(), IniItem::IniItem(), TextfileWindow::LoadTextfile(), Packet::Recv_string(), and ValidateString().

◆ strecat()

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.

Note
usage: strecat(dst, src, lastof(dst));
lastof() applies only to fixed size arrays
Parameters
dstThe buffer containing the target string
srcThe buffer containing the string to append
lastThe pointer to the last element of the destination buffer
Returns
The pointer to the terminating null-character in the destination buffer

Definition at line 73 of file string.cpp.

◆ 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.

Note
usage: strecpy(dst, src, lastof(dst));
lastof() applies only to fixed size arrays
Parameters
dstThe destination buffer
srcThe buffer containing the string to copy
lastThe pointer to the last element of the destination buffer
Returns
The pointer to the terminating null-character in the destination buffer

Definition at line 101 of file string.cpp.

◆ stredup()

char* stredup ( const char *  s,
const char *  last 
)

Create a duplicate of the given string.

Parameters
sThe string to duplicate.
lastThe last character that is safe to duplicate. If NULL, the whole string is duplicated.
Note
The maximum length of the resulting string might therefore be last - s + 1.
Returns
The duplicate of the string.

Definition at line 126 of file string.cpp.

References ttd_strnlen().

Referenced by ScriptScanner::AddFile(), BaseMedia< GraphicsSet >::AddFile(), ScriptInfo::AddLabels(), ScriptInfo::AddSetting(), ScriptConfig::Change(), CloneVehicleName(), CmdRenameCompany(), CmdRenameDepot(), CmdRenameEngine(), CmdRenamePresident(), CmdRenameTown(), CmdRenameVehicle(), CmdRenameWaypoint(), CmdSetGoalProgress(), CmdSetGoalText(), CmdSetStoryPageTitle(), CmdTownSetText(), AIInfo::Constructor(), ScriptInfo::Constructor(), BaseConsist::CopyConsistPropertiesFrom(), DisableStaticNewGRFInfluencingNonStaticNewGRFs(), DriverFactoryBase::DriverFactoryBase(), ErrorMessageData::ErrorMessageData(), FileWriter::FileWriter(), BaseSet< GraphicsSet, MAX_GFT, true >::FillSetDetails(), UnmappedChoiceList::Flush(), GetFontByFaceName(), IniLoadFile::GetGroup(), GRFConfig::GRFConfig(), GRFError::GRFError(), GRFFile::GRFFile(), IConsoleAliasRegister(), IniGroup::IniGroup(), IniItem::IniItem(), IniLoadSettingList(), IsGoodGRFConfigList(), LanguageStrings::LanguageStrings(), NetworkServerKickOrBanIP(), ScriptScanner::RegisterScript(), ScriptConfig::ScriptConfig(), ErrorMessageData::SetDParamStr(), AIConfig::SetSetting(), ScriptConfig::SetSetting(), IniItem::SetValue(), SlError(), MusicDriver_ExtMidi::Start(), ScriptConfig::StringToSettings(), UpdateElement(), UpdateOSKOriginalText(), and StringNameWriter::WriteStringID().

◆ strnatcmp()

int strnatcmp ( const char *  s1,
const char *  s2,
bool  ignore_garbage_at_front 
)

Compares two strings using case insensitive natural sort.

Parameters
s1First string to compare.
s2Second string to compare.
ignore_garbage_at_frontSkip punctuation characters in the front
Returns
Less than zero if s1 < s2, zero if s1 == s2, greater than zero if s1 > s2.

Definition at line 569 of file string.cpp.

References _current_collator, and SkipGarbage().

Referenced by GRFSorter(), IsWhitespace(), NetworkContentListWindow::NameSorter(), NewGRFWindow::NameSorter(), NetworkGameWindow::NGameNameSorter(), and NetworkContentListWindow::TypeSorter().

◆ strtolower()

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

Parameters
strstring to convert
Returns
String has changed.

Definition at line 320 of file string.cpp.

Referenced by GameScannerInfo::FindInfo(), AIScannerInfo::FindInfo(), GameScannerLibrary::FindLibrary(), AIScannerLibrary::FindLibrary(), ScriptScanner::RegisterScript(), and SimplifyFileName().

◆ StrValid()

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.

Parameters
strThe string to validate.
lastThe last character of the string, i.e. the string must be terminated here or earlier.

Definition at line 247 of file string.cpp.

References Utf8Decode(), and Utf8EncodedCharLen().

◆ Utf8Decode()

size_t Utf8Decode ( WChar c,
const char *  s 
)

Decode and consume the next UTF-8 encoded character.

Parameters
cBuffer to place decoded character.
sCharacter stream to retrieve character from.
Returns
Number of characters in the sequence.

Definition at line 437 of file string.cpp.

Referenced by Layouter::GetCharPosition(), Layouter::Layouter(), str_fix_scc_encoded(), str_strip_colours(), str_validate(), StrValid(), TranslateTTDPatchCodes(), and ttd_strnlen().

◆ Utf8Encode()

size_t Utf8Encode ( char *  buf,
WChar  c 
)

Encode a unicode character and place it in the buffer.

Parameters
bufBuffer to place character.
cUnicode character to encode.
Returns
Number of characters in the encoded sequence.

Definition at line 477 of file string.cpp.

References GB().

Referenced by UnmappedChoiceList::Flush(), and ttd_strnlen().

◆ Utf8StringLength()

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.

Parameters
sThe string to get the length for.
Returns
The length of the string in characters.

Definition at line 300 of file string.cpp.

Referenced by CmdAlterGroup(), CmdPlaceSign(), CmdRenameCompany(), CmdRenameDepot(), CmdRenameEngine(), CmdRenamePresident(), CmdRenameStation(), CmdRenameTown(), CmdRenameVehicle(), CmdRenameWaypoint(), and VerifyTownName().

◆ Utf8TrimString()

size_t Utf8TrimString ( char *  s,
size_t  maxlen 
)

Properly terminate an UTF8 string to some maximum length.

Parameters
sstring to check if it needs additional trimming
maxlenthe maximum length the buffer can have.
Returns
the new length in bytes of the string (eg. strlen(new_string))
Note
maxlen is the string length INCLUDING the terminating '\0'

Definition at line 511 of file string.cpp.

References Utf8EncodedCharLen().

Referenced by NetworkAddChatMessage(), and ttd_strnlen().

◆ ValidateString()

void ValidateString ( const char *  str)

Scans the string for valid characters and if it finds invalid ones, replaces them with a question mark '?'.

Parameters
strthe string to validate

Definition at line 233 of file string.cpp.

References str_validate().

Referenced by ScriptInfo::AddLabels(), and ScriptInfo::AddSetting().

◆ vseprintf()

int CDECL vseprintf ( char *  str,
const char *  last,
const char *  format,
va_list  ap 
)

Safer implementation of vsnprintf; same as vsnprintf except:

  • last instead of size, i.e. replace sizeof with lastof.
  • return gives the amount of characters added, not what it would add.
    Parameters
    strbuffer to write to up to last
    lastlast character we may write to
    formatthe formatting (see snprintf)
    apthe list of arguments for the format
    Returns
    the number of added characters

Definition at line 50 of file string.cpp.

References min().

Referenced by CStrA::AddFormatL(), debug(), error(), Squirrel::ErrorPrintFunc(), grfmsg(), MidiSendCommand(), NetworkAddChatMessage(), Textbuf::Print(), Squirrel::PrintFunc(), seprintf(), ShowInfoF(), str_fmt(), and usererror().