String

String
Scaleform::String
Declaration
class String;
Description

String is UTF-8 based string class with heap support. String is the base to the two other classes StringLH and StringDH, allowing all string argument passing to be done by String&, and hence passing a specific derived class is not necessary. By default, String allocates memory from global heap. 

Strings do NOT mutate heaps on assignment, so a data copy will be made if a string is copied to a different heap; this data copy and allocation is avoided if heaps on both sides of assignment do match.

Methods
Method 
Description 
Appends a character to the string. 
Appends a specified string to the end of the string. 
Assigns a string with dynamic data (copied through initializer). 
Assigns a string with known size. 
Case sensitive Bernstein string hash function and computes hash. 
Case insensitive Bernstein string hash function and computes hash. 
Deletes the string. 
Compares two stings and is case-insensitive. 
Escapes the encoded/decoded special HTML characters in a string. 
Gets the byte index of the character at the position specified by the passed index value. 
Returns the character at specified index. 
Get file extension with a dot. 
Returns the file name, including extension. 
Returns the first character of the UTF-8 character string. 
Returns the memory heap used for String based on the HeapType. 
Returns the number of characters in the string. 
Returns the next character in the UTF-8 encoded character string. 
Returns file path with trailing '/'. 
Returns protocol, if any, with trailing '://'. 
Returns the number of bytes in the string. 
Determines whether the file path name is an absolute or relative path. 
Determines whether an extension is included along with the file name. 
Determines whether there is any protocol (such as 'file://', 'http://') in front of the string which represents a file path. 
Inserts a substring to the original string at the specified position. 
Inserts a new character at desired position. 
String constructors. 
IsEmpty determines whether the string is empty or not. 
String constructors. 
Copy constructors. 
Strips off trailing extension in the file name. 
Strips off the front protocol, if any, from the string. 
Substring returns a substring of the original String. 
ToCStr obtains a pointer to raw buffer of string. 
Converts the character string to lowercase. 
Converts the character string to uppercase. 
Removes the character at the specified index. 
Unescapes the encoded/decoded special HTML characters in a string. 
Operators
Operator 
Description 
!= 
Determines the inequality of Strings. 
[] 
Returns the byte in the data array at the specified index. 
+ 
Concatenates two strings. 
+= 
Returns a new String which is a concatenation of the original string with the parameter. 
< 
Returns the result of lexicographical comparison between two strings. 
= 
Assignment operation. 
== 
Comparison operation. 
> 
Returns the result of lexicographical comparison between two strings. 
Operator function for casting to a pointer of type char. 
Structures
Structure 
Description 
Hash functor used for strings. 
Structure for initializing string with dynamic buffer. 
Case -insensitive hash functor used for strings. Supports additional lookup based on NoCaseKey
Structure for case insensitive keys which are used to look up insensitive string in hash tables for SWF files with versions before SWF 7. 
File

SF_String.h