ScummVM API documentation
AGS3::AGS::Shared::String Class Reference

Public Member Functions

 String (const String &)
 
 String (String &&)
 
 String (const char *cstr)
 
 String (const char *cstr, size_t length)
 
 String (char c, size_t count)
 
 String (const Common::String &s)
 
const char * GetCStr () const
 
size_t GetLength () const
 
bool IsEmpty () const
 
bool IsNullOrSpace () const
 
void Read (Stream *in, size_t max_chars=5 *1024 *1024, bool stop_at_limit=false)
 
void ReadCount (Stream *in, size_t count)
 
void Write (Stream *out) const
 
void WriteCount (Stream *out, size_t count) const
 
int Compare (const String &str) const
 
int Compare (const char *cstr) const
 
int CompareNoCase (const String &str) const
 
int CompareNoCase (const char *cstr) const
 
int CompareLeft (const String &str, size_t count=-1) const
 
int CompareLeft (const char *cstr, size_t count=-1) const
 
int CompareLeftNoCase (const String &str, size_t count=-1) const
 
int CompareLeftNoCase (const char *cstr, size_t count=-1) const
 
int CompareMid (const String &str, size_t from, size_t count=-1) const
 
int CompareMid (const char *cstr, size_t from, size_t count=-1) const
 
int CompareMidNoCase (const String &str, size_t from, size_t count=-1) const
 
int CompareMidNoCase (const char *cstr, size_t from, size_t count=-1) const
 
int CompareRight (const String &str, size_t count=-1) const
 
int CompareRight (const char *cstr, size_t count=-1) const
 
int CompareRightNoCase (const String &str, size_t count=-1) const
 
int CompareRightNoCase (const char *cstr, size_t count=-1) const
 
bool Equals (const String &str) const
 
bool Equals (const char *cstr) const
 
bool StartsWith (const String &str) const
 
bool StartsWith (const char *cstr) const
 
bool EndsWidth (const String &str) const
 
bool EndsWidth (const char *cstr) const
 
size_t FindChar (char c, size_t from=0) const
 
size_t FindCharReverse (char c, size_t from=-1) const
 
size_t FindString (const String &str, size_t from=0) const
 
size_t FindString (const char *cstr, size_t from=0) const
 
bool FindSection (char separator, size_t first, size_t last, bool exclude_first_sep, bool exclude_last_sep, size_t &from, size_t &to) const
 
char GetAt (size_t index) const
 
char GetLast () const
 
int ToInt () const
 
String Lower () const
 
String Upper () const
 
String Left (size_t count) const
 
String Mid (size_t from, size_t count=-1) const
 
String Right (size_t count) const
 
String LeftSection (char separator, bool exclude_separator=true) const
 
String RightSection (char separator, bool exclude_separator=true) const
 
String Section (char separator, size_t first, size_t last, bool exclude_first_sep=true, bool exclude_last_sep=true) const
 
std::vector< StringSplit (char separator) const
 
void Reserve (size_t max_length)
 
void ReserveMore (size_t more_length)
 
void Compact ()
 
void Append (const String &str)
 
void Append (const char *cstr)
 
void Append (const char *cstr, size_t len)
 
void AppendChar (char c)
 
void AppendFmt (MSVC_PRINTF const char *fcstr,...) GCC_PRINTF(2
 
void void AppendFmtv (const char *fcstr, va_list argptr)
 
void ClipLeft (size_t count)
 
void ClipMid (size_t from, size_t count=-1)
 
void ClipRight (size_t count)
 
void ClipLeftSection (char separator, bool include_separator=true)
 
void ClipRightSection (char separator, bool include_separator=true)
 
void ClipSection (char separator, size_t first, size_t last, bool include_first_sep=true, bool include_last_sep=true)
 
void Empty ()
 
void FillString (char c, size_t count)
 
void Format (const char *fcstr,...)
 
void FormatV (const char *fcstr, va_list argptr)
 
void Free ()
 
void MakeLower ()
 
void MakeUpper ()
 
void MergeSequences (char c=0)
 
void Prepend (const String &str)
 
void Prepend (const char *cstr)
 
void PrependChar (char c)
 
void Replace (char what, char with)
 
void Replace (const String &what, const String &with)
 
void Replace (const char *what, const char *with)
 
void ReplaceMid (size_t from, size_t count, const String &str)
 
void ReplaceMid (size_t from, size_t count, const char *cstr)
 
void Reverse ()
 
void ReverseUTF8 ()
 
void SetAt (size_t index, char c)
 
void SetString (const char *cstr, size_t length=-1)
 
void Trim (char c=0)
 
void TrimLeft (char c=0)
 
void TrimRight (char c=0)
 
void TruncateToLeft (size_t count)
 
void TruncateToMid (size_t from, size_t count=-1)
 
void TruncateToRight (size_t count)
 
void TruncateToLeftSection (char separator, bool exclude_separator=true)
 
void TruncateToRightSection (char separator, bool exclude_separator=true)
 
void TruncateToSection (char separator, size_t first, size_t last, bool exclude_first_sep=true, bool exclude_last_sep=true)
 
void Wrap (const char *cstr)
 
Stringoperator= (const String &str)
 
Stringoperator= (String &&str)
 
Stringoperator= (const char *cstr)
 
char operator[] (size_t index) const
 
bool operator== (const String &str) const
 
bool operator== (const char *cstr) const
 
bool operator!= (const String &str) const
 
bool operator!= (const char *cstr) const
 
bool operator< (const String &str) const
 
bool operator< (const char *cstr) const
 
 operator Common::String () const
 
 operator bool () const
 
 operator const char * () const
 

Static Public Member Functions

static String Wrapper (const char *cstr)
 
static String FromFormat (const char *fcstr,...)
 
static String FromFormatV (const char *fcstr, va_list argptr)
 
static String FromStream (Stream *in, size_t max_chars=5 *1024 *1024, bool stop_at_limit=false)
 
static String FromStreamCount (Stream *in, size_t count)
 

Static Public Attributes

static const size_t NoIndex = (size_t)-1
 

The documentation for this class was generated from the following file: