ultimatepp/uppsrc/Core/src.tpp/String$en-us.tpp
cbpporter b3995e25c2 Documentation updates
git-svn-id: svn://ultimatepp.org/upp/trunk@636 f0d560ea-af0d-0410-9eb7-867de7ffcac7
2008-11-14 20:18:06 +00:00

631 lines
No EOL
31 KiB
C++

topic "[W]String and [W]StringBuffer";
[2 $$0,0#00000000000000000000000000000000:Default]
[i448;a25;kKO9;2 $$1,0#37138531426314131252341829483380:class]
[l288;2 $$2,0#27521748481378242620020725143825:desc]
[0 $$3,0#96390100711032703541132217272105:end]
[H6;0 $$4,0#05600065144404261032431302351956:begin]
[i448;a25;kKO9;2 $$5,0#37138531426314131252341829483370:item]
[l288;a4;*@5;1 $$6,6#70004532496200323422659154056402:requirement]
[l288;i1121;b17;O9;~~~.1408;2 $$7,0#10431211400427159095818037425705:param]
[i448;b42;O9;2 $$8,8#61672508125594000341940100500538:tparam]
[b42;2 $$9,9#13035079074754324216151401829390:normal]
[{_}
[s0;%% [*@3;4 String]&]
[s1;:String`:`:class: [@(0.0.255)3 class][3 _][*3 String][3 _:_][@(0.0.255)3 public][3 _][*@3;3 Move
able][@(0.0.255)3 <][*3 String][3 , ][_^AString^3 AString][@(0.0.255)3 <][_^String0^3 String0
][@(0.0.255)3 >][3 _>_]&]
[s0;3 &]
[s0;%% String is a value class that contains an array of characters.
It is designed to have fast copy operations. The array of characters
is zero terminated. String provides non`-mutable access to the
array of characters. String can store 8 bit encoded string or
an Utf8 encoded string&]
[s0;%% &]
[s0;%% WString is similar to String, but it uses 16 bit Ucs2 encoding.
String and WString share a number of common functions through
the AString interface.&]
[s1;%% &]
[ {{10000F(128)G(128)@1 [s0;%% [* Constructor Detail]]}}&]
[s0; &]
[s5;:String`:`:String`(`): [* String]()&]
[s2;%% Default constructor. Constructs empty String.&]
[s3; &]
[s4; &]
[s5;:String`:`:String`(const String`&`): [* String]([@(0.0.255) const]_[* String][@(0.0.255) `&
]_[*@3 s])&]
[s2;%% Default copy constructor..&]
[s3;%% &]
[s4; &]
[s5;:String`:`:String`(const char`*`): [* String]([@(0.0.255) const]_[@(0.0.255) char]_`*[*@3 s
])&]
[s2;%% Creates a copy of zero terminated string [%-*@3 s].&]
[s3;%% &]
[s4; &]
[s5;:String`:`:String`(const char`*`,int`): [* String]([@(0.0.255) const]_[@(0.0.255) char]_
`*[*@3 s], [@(0.0.255) int]_[*@3 n])&]
[s2;%% Constructs a string equal to first [%-*@3 n] characters of zero
terminated string [%-*@3 s].&]
[s3;%% &]
[s4; &]
[s5;:String`:`:String`(const String`&`,int`): [* String]([@(0.0.255) const]_[* String][@(0.0.255) `&
]_[*@3 s], [@(0.0.255) int]_[*@3 n])&]
[s2;%% Constructs a string equal to first [%-*@3 n] characters of String
[%-*@3 s].&]
[s3;%% &]
[s4; &]
[s5;:String`:`:String`(const byte`*`,int`): [* String]([@(0.0.255) const]_[_^byte^ byte]_`*
[*@3 s], [@(0.0.255) int]_[*@3 n])&]
[s2;%% Constructs a string equal to first [%-*@3 n] bytes of [%-*@3 s].&]
[s3;%% &]
[s4; &]
[s5;:String`:`:String`(const char`*`,const char`*`): [* String]([@(0.0.255) const]_[@(0.0.255) c
har]_`*[*@3 s], [@(0.0.255) const]_[@(0.0.255) char]_`*[*@3 lim])&]
[s2;%% Constructs a string equal to first [%-*@3 lim] `- [%-*@3 s] characters
of [%-*@3 s].&]
[s3;%% &]
[s4; &]
[s5;:String`:`:String`(int`,int`): [* String]([@(0.0.255) int]_[*@3 chr],
[@(0.0.255) int]_[*@3 count])&]
[s2;%% Constructs a string consisting of [%-*@3 count] characters equal
to [%-*@3 chr].&]
[s3;%% &]
[s4; &]
[s5;:String`:`:String`(StringBuffer`&`): [* String]([_^StringBuffer^ StringBuffer][@(0.0.255) `&
]_[*@3 b])&]
[s2;%% Constructs a string from [%-*@3 b]. [%-*@3 b] is emptied by this
operation.&]
[s3;%% &]
[s4; &]
[s5;:String`:`:String`(const Nuller`&`): [* String]([@(0.0.255) const]_[_^Nuller^ Nuller][@(0.0.255) `&
])&]
[s2;%% Constructs empty `[W`]String. This variant is important to
allow assigning Null to String (which is same as assigning the
empty String).&]
[s3; &]
[s4; &]
[s5;:String`:`:String`(const string`&`): [* String]([@(0.0.255) const]_std`::string[@(0.0.255) `&
]_[*@3 s])&]
[s2;%% Constructor to achieve minimal STL compatibility.&]
[s1;%% &]
[ {{10000F(128)G(128)@1 [s0;%% [* Public Member List]]}}&]
[s0; &]
[s5;:String`:`:Shrink`(`): [@(0.0.255) void]_[* Shrink]()&]
[s2;%% Reduces memory used by string to minimum (size optimization).&]
[s4; &]
[s5;:String`:`:ToWString`(`)const: [_^WString^ WString]_[* ToWString]()_[@(0.0.255) const]&]
[s2;%% Convert String to WString using current default character
set.&]
[s3; &]
[s4; &]
[s5;:String`:`:ToString`(`)const: [@(0.0.255) const]_[_^String^ String][@(0.0.255) `&]_[* ToS
tring]()_[@(0.0.255) const]&]
[s2;%% Returns `*this. Useful because ToString is standard method
to convert concrete type to text, used by AsString template (and
therefore by operator << as well).&]
[s3; &]
[s4; &]
[s5;:String`:`:GetVoid`(`): [@(0.0.255) static] [_^String^ String]_[* GetVoid]()&]
[s2;%% Returns special Void value. This value is same as empty string,
but IsVoid method returns true for it. It can be used in special
scenarios where client code needs to distinguish between two
empty values (let us say Void is `"more empty`"...). For example,
LoadFile returns Void string if file failed to load, but normal
empty string if it is empty.&]
[s3; &]
[s4; &]
[s5;:String`:`:IsVoid`(`)const: [@(0.0.255) bool]_[* IsVoid]()_[@(0.0.255) const]&]
[s2;%% Returns true if String is special value returned by GetVoid.&]
[s3; &]
[s4; &]
[s5;:String0`:`:IsEqual`(const String0`&`)const: [@(0.0.255) bool]_[* IsEqual]([@(0.0.255) c
onst]_[_^String0^ String][@(0.0.255) `&]_[*@3 s])_[@(0.0.255) const]&]
[s2;%% Return true if string is equal to [%-*@3 s].&]
[s3;%% &]
[s4; &]
[s5;:String0`:`:Compare`(const String0`&`)const: [@(0.0.255) int]_[* Compare]([@(0.0.255) c
onst]_[_^String0^ String0][@(0.0.255) `&]_[*@3 s])_[@(0.0.255) const]&]
[s2;%% Lexicographic comparison, return `-1 if this string is lower,
0 for equality, 1 if this string is greater. Individual characters
are compared as unsigned integer values.&]
[s3;%% &]
[s4; &]
[s5;:String0`:`:GetHashValue`(`)const: [@(0.0.255) unsigned]_[* GetHashValue]()_[@(0.0.255) c
onst]&]
[s2;%% Returns the hash value of the string.&]
[s3; &]
[s4; &]
[s5;:String0`:`:Cat`(int`): [@(0.0.255) void]_[* Cat]([@(0.0.255) int]_[*@3 c])&]
[s2;%% Appends single character [%-*@3 c]. This operations has constant
amortized time (in other words, internal space used by implementation
grows exponentially, like with Vector or std`::vector).&]
[s3;%% &]
[s4; &]
[s5;:String0`:`:Cat`(const char`*`,int`): [@(0.0.255) void]_[* Cat]([@(0.0.255) const]_[@(0.0.255) c
har]_`*[*@3 s], [@(0.0.255) int]_[*@3 len])&]
[s2; [%% Appends ][*@3 len][%% characters from string ][*@3 s] ([*@3 s ]can
contain zero characters).&]
[s3;%% &]
[s4; &]
[s5;:String0`:`:Set`(int`,int`): [@(0.0.255) void]_[* Set]([@(0.0.255) int]_[*@3 i],
[@(0.0.255) int]_[*@3 chr])&]
[s2;%% Replace character at position [%-*@3 i] with [%-*@3 chr].&]
[s3;%% &]
[s4; &]
[s5;:String0`:`:Trim`(int`): [@(0.0.255) void]_[* Trim]([@(0.0.255) int]_[*@3 pos])&]
[s2;%% Sets the number of characters (length) to [%-*@3 pos].&]
[s3;%% &]
[s4; &]
[s5;:String0`:`:Begin`(`)const: [@(0.0.255) const]_[@(0.0.255) char]_`*[* Begin]()_[@(0.0.255) c
onst]&]
[s2;%% Returns a pointer to the first character.&]
[s3; &]
[s4; &]
[s5;:String0`:`:End`(`)const: [@(0.0.255) const]_[@(0.0.255) char]_`*[* End]()_[@(0.0.255) co
nst]&]
[s2;%% Returns a pointer to ending zero.&]
[s3; &]
[s4; &]
[s5;:String0`:`:Remove`(int`,int`): [@(0.0.255) void]_[* Remove]([@(0.0.255) int]_[*@3 pos],
[@(0.0.255) int]_[*@3 count]_`=_[@3 1])&]
[s2;%% Removes [%-*@3 count] element starting at position [%-*@3 pos].&]
[s3;%% &]
[s4; &]
[s5;:String0`:`:Clear`(`): [@(0.0.255) void]_[* Clear]()&]
[s2;%% Empties the string.&]
[s3; &]
[s4; &]
[s5;:String0`:`:GetCount`(`)const: [@(0.0.255) int]_[* GetCount]()_[@(0.0.255) const]&]
[s5;:String0`:`:GetLength`(`)const: [@(0.0.255) int]_[* GetLength]()_[@(0.0.255) const]&]
[s2;%% Returns the number of characters.&]
[s3; &]
[s4; &]
[s5;:String0`:`:GetAlloc`(`)const: [@(0.0.255) int]_[* GetAlloc]()_[@(0.0.255) const]&]
[s2;%% Returns the number of allocated characters (maximum string
length before it has to grow) &]
[s3; &]
[s4; &]
[s5;:String0`:`:Reserve`(int`): [@(0.0.255) void]_[* Reserve]([@(0.0.255) int]_[*@3 r])&]
[s2;%% Reserves [%-*@3 r] characters of internal storage for future
concatenation operations.&]
[s3;%% &]
[s3; &]
[s3; &]
[s0;@(0.0.255)%% &]
[s0; [*+117 `[W`]String common methods]&]
[s0;@(0.0.255)%% &]
[s4; &]
[s5;:String0`:`:Remove`(int`,int`): [@(0.0.255) void]_[* Remove]([@(0.0.255) int]_[*@3 pos],
[@(0.0.255) int]_[*@3 count]_`=_[@3 1])&]
[s5;:WString0`:`:Remove`(int`,int`): [@(0.0.255) void]_[* Remove]([@(0.0.255) int]_[*@3 pos],
[@(0.0.255) int]_[*@3 count]_`=_[@3 1])&]
[s2;%% Removes [%-*@3 count] element starting at position [%-*@3 at].&]
[s0;%% &]
[s5;K:`:`:AString`:`:Set`(int`,int`): [@(0.0.255) void][@(64) _]Set[@(64) (][@(0.0.255) int][@(64) _
][@3 at][@(64) , ][@(0.0.255) int][@(64) _][@3 chr][@(64) )]&]
[s2;%% Replace character at position [%-*@3 at] with [%-*@3 chr].&]
[s0;%% &]
[s5;K:`:`:AString`:`:Trim`(int`): [@(0.0.255) void][@(64) _]Trim[@(64) (][@(0.0.255) int][@(64) _
][@3 at][@(64) )]&]
[s2;%% Sets the number of characters (length) to [%-*@3 at].&]
[s0;%% &]
[s5;K:`:`:AString`:`:GetLength`(`)const: [@(0.0.255) int][@(64) _]GetLength[@(64) ()_][@(0.0.255) c
onst]&]
[s5;K:`:`:AString`:`:GetCount`(`)const: [@(0.0.255) int][@(64) _]GetCount[@(64) ()_][@(0.0.255) c
onst]&]
[s2;%% Returns the number of characters.&]
[s0;%% &]
[s5;K:`:`:AString`:`:IsEmpty`(`)const: [@(0.0.255) bool][@(64) _]IsEmpty[@(64) ()_][@(0.0.255) c
onst]&]
[s2;%% Same as GetCount() `=`= 0.&]
[s0;%% &]
[s5;K:`:`:AString`:`:Find`(int`,int`)const: [@(0.0.255) int][@(64) _]Find[@(64) (][@(0.0.255) i
nt][@(64) _][@3 chr][@(64) , ][@(0.0.255) int][@(64) _][@3 from][@(64) _`=_][@3 0][@(64) )_][@(0.0.255) c
onst]&]
[s2;%% Returns a position of character equal to [%-*@3 chr] greater
or equal to [%-*@3 from], or `-1 if not found.&]
[s0;%% &]
[s5;K:`:`:AString`:`:ReverseFind`(int`,int`)const: [@(0.0.255) int][@(64) _]ReverseFind[@(64) (
][@(0.0.255) int][@(64) _][@3 chr][@(64) , ][@(0.0.255) int][@(64) _][@3 from][@(64) )_][@(0.0.255) c
onst]&]
[s2;%% Returns a position of [/ last] character equal to [%-*@3 chr]
lower or equal to [%-*@3 from], or `-1 if not found.&]
[s0;%% &]
[s5;K:`:`:AString`:`:ReverseFind`(int`)const: [@(0.0.255) int][@(64) _]ReverseFind[@(64) (][@(0.0.255) i
nt][@(64) _][@3 chr][@(64) )_][@(0.0.255) const]&]
[s2;%% Returns a position of [/ last] character equal to [%-*@3 chr],
or `-1 if not found.&]
[s0;%% &]
[s5;K:`:`:AString`:`:Find`(int`,const T`*`,int`)const: [@(0.0.255) int][@(64) _]Find[@(64) (
][@(0.0.255) int][@(64) _][@3 len][@(64) , ][@(0.0.255) const_`[w`]char][@(64) _`*][@3 s][@(64) ,
][@(0.0.255) int][@(64) _][@3 from][@(64) )_][@(0.0.255) const]&]
[s2;%% Returns a position of substring of [%-*@3 len] characters [%-*@3 s]
greater or equal to [%-*@3 from], or `-1 if not found.&]
[s0;%% &]
[s5;K:`:`:AString`:`:Find`(const T`*`,int`)const: [@(0.0.255) int][@(64) _]Find[@(64) (][@(0.0.255) c
onst][@(64) _][@(0.0.255) `[w`]char][@(64) _`*][@3 s][@(64) , ][@(0.0.255) int][@(64) _][@3 from][@(64) _
`=_][@3 0][@(64) )_][@(0.0.255) const]&]
[s2;%% Same as Find(strlen(s), s, from).&]
[s0;%% &]
[s5;K:`:`:AString`:`:Find`(const S`&`,int`)const: [@(0.0.255) int][@(64) _]Find[@(64) (][@(0.0.255) c
onst][@(64) _]`[W`]String[@(64) `&_][@3 s][@(64) , ][@(0.0.255) int][@(64) _][@3 from][@(64) _`=_
][@3 0][@(64) )_][@(0.0.255) const]&]
[s2;%% Same as Find(s.GetLength(), s, from). &]
[s0;%% &]
[s5;K:`:`:AString`:`:StartsWith`(const T`*`,int`)const: [@(0.0.255) bool][@(64) _]StartsW
ith[@(64) (][@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _`*][@3 s][@(64) ,
][@(0.0.255) int][@(64) _][@3 len][@(64) )_][@(0.0.255) const]&]
[s2;%% Returns true if string [/ starts] with [%-*@3 len] characters
[%-*@3 s].&]
[s0;%% &]
[s5;K:`:`:AString`:`:StartsWith`(const T`*`)const: [@(0.0.255) bool][@(64) _]StartsWith[@(64) (
][@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _`*][@3 s][@(64) )_][@(0.0.255) const]&]
[s2;%% Same as StartsWith(s, strlen(s)).&]
[s0;%% &]
[s5;K:`:`:AString`:`:StartsWith`(const S`&`)const: [@(0.0.255) bool][@(64) _]StartsWith[@(64) (
][@(0.0.255) const][@(64) _]`[W`]String[@(64) `&_][@3 s][@(64) )_][@(0.0.255) const]&]
[s2;%% Same as StartsWith(s, s.GetLength()).&]
[s0;%% &]
[s5;K:`:`:AString`:`:EndsWith`(const T`*`,int`)const: [@(0.0.255) bool][@(64) _]EndsWith[@(64) (
][@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _`*][@3 s][@(64) ,
][@(0.0.255) int][@(64) _][@3 len][@(64) )_][@(0.0.255) const]&]
[s2;%% Returns true if string [/ ends] with [%-*@3 len] characters [%-*@3 s].&]
[s0;%% &]
[s5;K:`:`:AString`:`:EndsWith`(const T`*`)const: [@(0.0.255) bool][@(64) _]EndsWith[@(64) (
][@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _`*][@3 s][@(64) )_][@(0.0.255) const]&]
[s2;%% Same as EndsWith(s, strlen(s)).&]
[s0;%% &]
[s5;K:`:`:AString`:`:EndsWith`(const S`&`)const: [@(0.0.255) bool][@(64) _]EndsWith[@(64) (
][@(0.0.255) const][@(64) _]`[W`]String[@(64) `&_][@3 s][@(64) )_][@(0.0.255) const]&]
[s2;%% Same as EndsWith(s, s.GetLength()).&]
[s0;%% &]
[s5;K:`:`:AString`:`:Clear`(`): [@(0.0.255) void][@(64) _]Clear[@(64) ()]&]
[s2;%% Empties the string.&]
[s0;%% &]
[s5;K:`:`:AString`:`:Shrink`(`): [@(0.0.255) void][@(64) _]Shrink[@(64) ()]&]
[s2;%% Reduces memory used by string to minimum (size optimization).&]
[s0;%% &]
[s5;K:`:`:AString`:`:Reserve`(int`): [@(0.0.255) void][@(64) _]Reserve[@(64) (][@(0.0.255) in
t][@(64) _][@3 len][@(64) )]&]
[s2;%% Preallocates enough memory to hold [%-*@3 len] (speed optimization).&]
[s0;%% &]
[s5;K:`:`:AString`:`:Begin`(`)const: [@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _
`*]Begin[@(64) ()_][@(0.0.255) const]&]
[s2;%% Returns a pointer to the first character.&]
[s0;%% &]
[s5;K:`:`:AString`:`:End`(`)const: [@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _`*
]End[@(64) ()_][@(0.0.255) const]&]
[s2;%% Returns a pointer to the ending zero.&]
[s0;%% &]
[s5;K:`:`:AString`:`:Last`(`)const: [@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _
`*]Last[@(64) ()_][@(0.0.255) const]&]
[s2;%% Returns a pointer to the last character or to the ending zero
if there are no characters in string.&]
[s0;%% &]
[s5;K:`:`:String`:`:Cat`(int`): [@(0.0.255) void][@(64) _]Cat[@(64) (][@(0.0.255) int][@(64) _][@3 c
][@(64) )]&]
[s5;K:`:`:String`:`:operator`+`=`(char`): [@(0.0.255) const][@(64) _][^`:`:String^@(64) Str
ing][@(64) `&_]operator`+`=[@(64) (][@(0.0.255) `[w`]char][@(64) _][@3 c][@(64) )]&]
[s2;%% Appends single character. This operations has constant amortized
time (in other words, internal space used by implementation grows
exponentially, like with Vector or std`::vector).&]
[s0;%% &]
[s5;K:`:`:String`:`:Cat`(const char`*`): [@(0.0.255) void][@(64) _]Cat[@(64) (][@(0.0.255) co
nst][@(64) _][@(0.0.255) `[w`]char][@(64) _`*][@3 s][@(64) )]&]
[s5;K:`:`:String`:`:operator`+`=`(const char`*`): [@(0.0.255) const][@(64) _][^`:`:String^@(64) `[
W`]String][@(64) `&_]operator`+`=[@(64) (][@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _
`*][@3 s][@(64) )]&]
[s2;%% Appends a zero terminated string.&]
[s0;%% &]
[s5;K:`:`:String`:`:Cat`(const`:`:String`&`): [@(0.0.255) void][@(64) _]Cat[@(64) (][@(0.0.255) c
onst][@(64) _][^`:`:String^@(64) `[W`]String][@(64) `&_][@3 s][@(64) )]&]
[s5;K:`:`:String`:`:operator`+`=`(const`:`:String`&`): [@(0.0.255) const][@(64) _][^`:`:String^@(64) `[
W`]String][@(64) `&_]operator`+`=[@(64) (][@(0.0.255) const][@(64) _][^`:`:String^@(64) `[W
`]String][@(64) `&_][@3 s][@(64) )]&]
[s2;%% Appends another strings.&]
[s0;%% &]
[s5;K:`:`:String`:`:Cat`(int`,int`): [@(0.0.255) void][@(64) _]Cat[@(64) (][@(0.0.255) int][@(64) _
][@3 c][@(64) , ][@(0.0.255) int][@(64) _][@3 count][@(64) )]&]
[s2;%% Appends character [%-*@3 c] [%-*@3 count] times.&]
[s0;%% &]
[s5;K:`:`:String`:`:Cat`(const char`*`,int`): [@(0.0.255) void][@(64) _]Cat[@(64) (][@(0.0.255) c
onst][@(64) _][@(0.0.255) char][@(64) _`*][@3 s][@(64) , ][@(0.0.255) int][@(64) _][@3 len][@(64) )
]&]
[s2;%% Appends string [%-*@3 s] with [%-*@3 len]. (There can be zeros
in [%-*@3 s]).&]
[s0;%% &]
[s5;K:`:`:String`:`:Cat`(const char`*`,const char`*`): [@(0.0.255) void][@(64) _]Cat[@(64) (
][@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _`*][@3 s][@(64) ,
][@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _`*][@3 lim][@(64) )]&]
[s2;%% Same as Cat([%-*@3 s], [%-*@3 lim] `- [%-*@3 s]).&]
[s0;%% &]
[s5;K:`:`:String`:`:Cat`(const`:`:String`&`,int`): [@(0.0.255) void][@(64) _]Cat[@(64) (][@(0.0.255) c
onst][@(64) _][^`:`:String^@(64) `[W`]String][@(64) `&_][@3 s][@(64) ,
][@(0.0.255) int][@(64) _][@3 len][@(64) )]&]
[s2;%% Appends [%-*@3 len] characters from [%-*@3 s].&]
[s0;%% &]
[s5;K:`:`:String`:`:Cat`(`): [^`:`:String^ `[W`]String]`&_Cat[@(64) ()]&]
[s2;%% Returns `*this. This very specific functions is used to create
strings `"in`-place`" when calling other functions, e.g. Foo(String().Cat()
<< a << `" `= `" << b). Note that simple Foo(String() << a <<
`" `= `" << b) does not work with standard C`+`+ as you cannot
pass temporary as non`-const parameter of `"<<`".&]
[s0;%% &]
[s5;K:`:`:String`:`:operator`=`(const char`*`): [^`:`:String^ `[W`]String]`&_operator`=
[@(64) (][@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _`*][@3 s][@(64) )]&]
[s2;%% Assigns zero terminated string.&]
[s0;%% &]
[s5;K:`:`:String`:`:operator`=`(const`:`:String`&`): [^`:`:String^ `[W`]String]`&_opera
tor`=[@(64) (][@(0.0.255) const][@(64) _][^`:`:String^@(64) `[W`]String][@(64) `&_][@3 s][@(64) )
]&]
[s2;%% Assigns another string. This operations is relatively fast
and does not depend on the length of string.&]
[s0;%% &]
[s5;K:`:`:String`:`:operator`=`(`:`:String`:`:Buffer`&`): [^`:`:String^ String]`&_opera
tor`=[@(64) (][^`:`:String`:`:Buffer^@(64) `[W`]StringBuffer][@(64) `&_][@3 b][@(64) )]&]
[s2;%% Assigns the content of `[W`]StringBuffer. After the operation,
sources is empty.&]
[s0;%% &]
[s5;K:`:`:String`:`:operator`<`<`=`(const`:`:String`&`): [^`:`:String^ String]`&_operat
or<<`=[@(64) (][@(0.0.255) const][@(64) _][^`:`:String^@(64) String][@(64) `&_][@3 s][@(64) )]&]
[s2;%% `"Deep`" assignment. It is equivalent of standard assignment
followed by Shrink operation (in other words, internal buffer
gets reallocated to the exact size of source).&]
[s0;%% &]
[s5;K:`:`:String`:`:Insert`(int`,int`): [@(0.0.255) void][@(64) _]Insert[@(64) (][@(0.0.255) i
nt][@(64) _][@3 at][@(64) , ][@(0.0.255) int][@(64) _][@3 c][@(64) )]&]
[s2;%% Insert character [%-*@3 c] at position [%-*@3 at].&]
[s0;%% &]
[s5;K:`:`:String`:`:Insert`(int`,const`:`:String`&`): [@(0.0.255) void][@(64) _]Insert[@(64) (
][@(0.0.255) int][@(64) _][@3 at][@(64) , ][@(0.0.255) const][@(64) _][^`:`:String`:`:Buffer^@(64) `[
W`]][^`:`:String^@(64) String][@(64) `&_][@3 s][@(64) )]&]
[s2;%% Insert character [%-*@3 s] at position [%-*@3 at].&]
[s0;%% &]
[s5;K:`:`:String`:`:Insert`(int`,const char`*`,int`): [@(0.0.255) void][@(64) _]Insert[@(64) (
][@(0.0.255) int][@(64) _][@3 at][@(64) , ][@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _
`*][@3 s][@(64) , ][@(0.0.255) int][@(64) _][@3 l][@(64) )]&]
[s2;%% Inserts first [%-*@3 l] characters of [%-*@3 s] at position [%-*@3 at].&]
[s0;%% &]
[s5;K:`:`:String`:`:Insert`(int`,const char`*`): [@(0.0.255) void][@(64) _]Insert[@(64) (][@(0.0.255) i
nt][@(64) _][@3 at][@(64) , ][@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _`*][@3 s][@(64) )
]&]
[s2;%% Inserts zero terminated [%-*@3 s] at position [%-*@3 at].&]
[s0;%% &]
[s5;K:`:`:String`:`:Mid`(int`,int`)const: [^`:`:String`:`:Buffer^ `[W`]][^`:`:String^ Str
ing]_Mid[@(64) (][@(0.0.255) int][@(64) _][@3 pos][@(64) , ][@(0.0.255) int][@(64) _][@3 length][@(64) )
_][@(0.0.255) const]&]
[s2;%% Returns the substring starting at [%-*@3 pos] of [%-*@3 length]
characters.&]
[s0;%% &]
[s5;K:`:`:String`:`:Mid`(int`)const: [^`:`:String`:`:Buffer^ `[W`]][^`:`:String^ String]_
Mid[@(64) (][@(0.0.255) int][@(64) _][@3 pos][@(64) )_][@(0.0.255) const]&]
[s2;%% Inserts a substring starting at [%-*@3 pos] till the end of
string.&]
[s0;%% &]
[s5;K:`:`:String`:`:Right`(int`)const: [^`:`:String`:`:Buffer^ `[W`]][^`:`:String^ String
]_Right[@(64) (][@(0.0.255) int][@(64) _][@3 count][@(64) )_][@(0.0.255) const]&]
[s2;%% Returns last [%-*@3 count] characters.&]
[s0;%% &]
[s5;K:`:`:String`:`:Left`(int`)const: [^`:`:String`:`:Buffer^ `[W`]][^`:`:String^ String]_
Left[@(64) (][@(0.0.255) int][@(64) _][@3 count][@(64) )_][@(0.0.255) const]&]
[s2;%% Returns firs [%-*@3 count] characters (same as Mid(0, [%-*@3 count])).&]
[s0;%% &]
[s5;K:`:`:String`:`:IsEqual`(const`:`:String`&`)const: [@(0.0.255) bool][@(64) _]IsEqual[@(64) (
][@(0.0.255) const][@(64) _][^`:`:String`:`:Buffer^@(64) `[W`]][^`:`:String^@(64) String][@(64) `&
_][@3 s][@(64) )_][@(0.0.255) const]&]
[s2;%% True if strings are equal.&]
[s0;%% &]
[s5;K:`:`:String`:`:IsEqual`(const char`*`)const: [@(0.0.255) bool][@(64) _]IsEqual[@(64) (
][@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _`*][@3 s][@(64) )_][@(0.0.255) const]&]
[s2;%% True if strings are equal. [%-@3 s] is zero terminated.&]
[s0;%% &]
[s5;K:`:`:String`:`:Compare`(const`:`:String`&`)const: [@(0.0.255) int][@(64) _]Compare[@(64) (
][@(0.0.255) const][@(64) _][^`:`:String`:`:Buffer^@(64) `[W`]][^`:`:String^@(64) String][@(64) `&
_][@3 s][@(64) )_][@(0.0.255) const]&]
[s2;%% Lexicographic comparison, return `-1 if this string is lower,
0 for equality, 1 if this string is greater. Individual characters
are compared as unsigned integer values.&]
[s0;%% &]
[s5;K:`:`:String`:`:Compare`(const char`*`)const: [@(0.0.255) int][@(64) _]Compare[@(64) (][@(0.0.255) c
onst][@(64) _][@(0.0.255) `[w`]char][@(64) _`*][@3 s][@(64) )_][@(0.0.255) const]&]
[s2;%% Lexicographic comparison with zero terminated [%-*@3 s].&]
[s0;%% &]
[s5;K:`:`:String`:`:operator`~`(`)const: [@(0.0.255) const][@(64) _][@(0.0.255) `[w`]char][@(64) _
`*]operator`~[@(64) ()_][@(0.0.255) const]&]
[s5;K:`:`:String`:`:operator const char`*`(`)const: operator[@(64) _][@(0.0.255) const][@(64) _
][@(0.0.255) `[w`]char][@(64) `*()_][@(0.0.255) const]&]
[s2;%% Return a immutable pointer to zero terminated sequence of
characters with string`'s content (a pointer to String internal
buffer). This pointer is only valid until next modifying operation
on string (destructor included).&]
[s0;%% &]
[s5;K:`:`:String`:`:operator`*`(`)const: [@(0.0.255) int][@(64) _]operator`*[@(64) ()_][@(0.0.255) c
onst]&]
[s2;%% Returns first character of string or 0 if string is empty.&]
[s0;%% &]
[s5;K:`:`:String`:`:operator`[`]`(int`)const: [@(0.0.255) int][@(64) _]operator`[`][@(64) (
][@(0.0.255) int][@(64) _][@3 i][@(64) )_][@(0.0.255) const]&]
[s2;%% Returns [%-*@3 i] character of string.&]
[s0;%% &]
[s5;K:`:`:String`:`:IsVoid`(`)const: [@(0.0.255) bool][@(64) _]IsVoid[@(64) ()_][@(0.0.255) c
onst]&]
[s2;%% Returns true if String is special value returned by GetVoid.&]
[s0;%% &]
[s5;K:`:`:String`:`:IsZero`(`)const: static [^`:`:String`:`:Buffer^ `[W`]][^`:`:String^ S
tring]_GetVoid[@(64) ()]&]
[s2;%% Returns special Void value. This value is same as empty string,
but IsVoid method returns true for it. It can be used in special
scenarios where client code needs to distinguish between two
empty values (let us say Void is `"more empty`"...). For example,
LoadFile returns Void string if file failed to load, but normal
empty string if it is empty.&]
[s0;%% &]
[s5;K:`:`:String`:`:ToString`(`)const: [@(0.0.255) const][@(64) _][^`:`:String`:`:Buffer^@(64) `[
W`]][^`:`:String^@(64) String][@(64) `&_]ToString[@(64) ()_][@(0.0.255) const]&]
[s2;%% Returns `*this. Useful because ToString is standard method
to convert concrete type to text, used by AsString template (and
therefore by operator << as well).&]
[s0;%% &]
[s5;K:`:`:String`:`:`:`:String`(`): `[W`]String[@(64) ()]&]
[s2;%% Constructs empty `[W`]String.&]
[s0;%% &]
[s5;K:`:`:String`:`:`:`:String`(const`:`:Nuller`&`): `[W`]String[@(64) (][@(0.0.255) cons
t][@(64) _][^`:`:Nuller^@(64) Nuller][@(64) `&)]&]
[s2;%% Constructs empty `[W`]String. This variant is important to
allow assigning Null to String (which is same as assigning the
empty String).&]
[s0;%% &]
[s5;K:`:`:String`:`:`:`:String`(const`:`:String`&`): `[W`]String[@(64) (][@(0.0.255) cons
t][@(64) _]`[W`]String[@(64) `&_][@3 s][@(64) )]&]
[s2;%% Copy constructor.&]
[s0;%% &]
[s5;K:`:`:String`:`:`:`:String`(const char`*`): `[W`]String[@(64) (][@(0.0.255) const][@(64) _
][@(0.0.255) `[w`]char][@(64) _`*][@3 s][@(64) )]&]
[s2;%% Constructor form zero terminated string.&]
[s0;%% &]
[s5;K:`:`:String`:`:`:`:String`(const`:`:String`&`,int`): `[W`]String[@(64) (][@(0.0.255) c
onst][@(64) _]`[W`]String[@(64) `&_][@3 s][@(64) , ][@(0.0.255) int][@(64) _][@3 n][@(64) )]&]
[s2;%% Constructs a string equal to first [%-*@3 n] characters of [%-*@3 s].&]
[s0;%% &]
[s5;K:`:`:String`:`:`:`:String`(const char`*`,int`): `[W`]String[@(64) (][@(0.0.255) cons
t][@(64) _][@(0.0.255) `[w`]char][@(64) _`*][@3 s][@(64) , ][@(0.0.255) int][@(64) _][@3 n][@(64) )
]&]
[s2;%% Constructs a string equal to first [%-*@3 n] characters of [%-*@3 s].&]
[s0;%% &]
[s5;K:`:`:String`:`:`:`:String`(const char`*`,const char`*`): `[W`]String[@(64) (][@(0.0.255) c
onst][@(64) _][@(0.0.255) `[w`]char][@(64) _`*][@3 s][@(64) , ][@(0.0.255) const][@(64) _][@(0.0.255) `[
w`]char][@(64) _`*][@3 lim][@(64) )]&]
[s2;%% Constructs a string equal to first [%-*@3 lim] `- [%-*@3 s] characters
of [%-*@3 s].&]
[s0;%% &]
[s5;K:`:`:String`:`:`:`:String`(int`,int`): `[W`]String[@(64) (][@(0.0.255) int][@(64) _][@3 c
hr][@(64) , ][@(0.0.255) int][@(64) _][@3 count][@(64) )]&]
[s2;%% Constructs a string consisting of [%-*@3 count] characters
[%-*@3 chr].&]
[s0;%% &]
[s5;K:`:`:String`:`:`:`:String`(`:`:String`:`:Buffer`&`): `[W`]String[@(64) (][^`:`:String`:`:Buffer^@(64) `[
W`]StringBuffer][@(64) `&_][@3 b][@(64) )]&]
[s2;%% Constructs a string from [%-*@3 b]. [%-*@3 b] is emptied by this
operation.&]
[s0;%% &]
[s5;K:`:`:String`:`:Swap`(`:`:String`&`,`:`:String`&`): friend_[@(0.0.255) void][@(64) _]S
wap[@(64) (][^`:`:String^@(64) String][@(64) `&_][@3 a][@(64) , ][^`:`:String^@(64) String][@(64) `&
_][@3 b][@(64) )]&]
[s2;%% Optimized swap operation.&]
[s0;%% &]
[s5;K:`:`:String`:`:`:`:String`(const std`:`:string`&`): String[@(64) (][@(0.0.255) const
][@(64) _][^std`:`:string^@(64) std`::string][@(64) `&_][@3 s][@(64) )]&]
[s2;%% Constructor to achieve minimal STL compatibility.&]
[s0;%% &]
[s0;%% &]
[s0;%% [*+117 String specific methods]&]
[s0;%% &]
[s5;K:`:`:String`:`:Cat`(const`:`:byte`*`,int`): [@(0.0.255) void][@(64) _]Cat[@(64) (][@(0.0.255) c
onst][@(64) _][^`:`:byte^@(64) byte][@(64) _`*][@3 s][@(64) , ][@(0.0.255) int][@(64) _][@3 len][@(64) )
]&]
[s2;%% Appends [%-*@3 len] bytes starting at [%-*@3 s] to String.&]
[s5;K^`:`:WString^%% &]
[s5;K:`:`:String`:`:operator const void`*`(`)const: operator[@(64) _][@(0.0.255) const][@(64) _
][@(0.0.255) void][@(64) `*()_][@(0.0.255) const]&]
[s5;K:`:`:String`:`:operator const`:`:byte`*`(`)const: operator[@(64) _][@(0.0.255) const
][@(64) _byte`*()_][@(0.0.255) const]&]
[s2;%% Return a immutable pointer to zero terminated sequence of
bytes with string`'s content (a pointer to String internal buffer).
This pointer is only valid until next modifying operation on
string (destructor included).&]
[s0;@(0.0.255)%% &]
[s5;K:`:`:String`:`:ToWString`(`)const: [^`:`:WString^ WString]_ToWString[@(64) ()_][@(0.0.255) c
onst]&]
[s2;%% Convert String to WString using current default charset.&]
[s0;%% &]
[s5;K:`:`:String`:`:`:`:String`(const`:`:byte`*`,int`): String[@(64) (][@(0.0.255) const][@(64) _
][^`:`:byte^@(64) byte][@(64) _`*][@3 s][@(64) , ][@(0.0.255) int][@(64) _][@3 n][@(64) )]&]
[s2;%% Constructs string equal to first [%-*@3 n] bytes of [%-*@3 s].&]
[s0;%% &]
[s0;%% &]
[s0;%% [*+117 WString specific methods]&]
[s0;*%% &]
[s5;K:`:`:WString`:`:ToString`(`)const: [^`:`:String^ String]_ToString[@(64) ()_][@(0.0.255) c
onst]&]
[s2;%% Converts WString to String using current default charset.
Also serves as standard text conversion (for AsString and operator<<
templates).&]
[s0;%% &]
[s0;%% &]
[s0;%% &]
[s0;%% &]
[s0;%% [*+117 `[W`]StringBuffer methods]&]
[s0;%% &]
[s0;%% &]
[s5;K:`:`:AStringBuffer`:`:operator T`*`(`): operator[@(64) _][@(0.0.255) `[w`]char][@(64) `*
()]&]
[s5;K:`:`:AStringBuffer`:`:operator void`*`(`): operator[@(64) _][@(0.0.255) void][@(64) `*
()]&]
[s5;K:`:`:AStringBuffer`:`:operator`~`(`): [@(0.0.255) `[w`]char][@(64) _]`*operator`~[@(64) (
)]&]
[s5;K:`:`:AStringBuffer`:`:Begin`(`): [@4 T]_`*Begin[@(64) ()]&]
[s2;%% Returns a pointer to the buffer of characters. Mutating operations
invalidate this pointer.&]
[s0;%% &]
[s5;K:`:`:AStringBuffer`:`:End`(`): T_`*End[@(64) ()]&]
[s2;%% Returns Begin() `+ GetCount(). Mutating operations invalidate
this pointer.&]
[s0;%% &]
[s5;K:`:`:AStringBuffer`:`:Cat`(int`): [@(0.0.255) void][@(64) _]Cat[@(64) (][@(0.0.255) int][@(64) _
][@3 c][@(64) )]&]
[s2;%% Appends single character.&]
[s0;%% &]
[s5;K:`:`:AStringBuffer`:`:Cat`(int`,int`): [@(0.0.255) void][@(64) _]Cat[@(64) (][@(0.0.255) i
nt][@(64) _][@3 c][@(64) , ][@(0.0.255) int][@(64) _][@3 count][@(64) )]&]
[s2;%% Appends [%-*@3 count] characters [%-*@3 c].&]
[s0;%% &]
[s5;K:`:`:AStringBuffer`:`:Cat`(const T`*`,int`): [@(0.0.255) void][@(64) _]Cat[@(64) (][@(0.0.255) c
onst][@(64) _][@4 T][@(64) _`*][@3 s][@(64) , ][@(0.0.255) int][@(64) _][@3 len][@(64) )]&]
[s2;%% Appends [%-*@3 len] characters of [%-*@3 s].&]
[s0;%% &]
[s5;K:`:`:AStringBuffer`:`:GetLength`(`)const: [@(0.0.255) int][@(64) _]GetLength[@(64) ()_
][@(0.0.255) const]&]
[s5;K:`:`:AStringBuffer`:`:GetCount`(`)const: [@(0.0.255) int][@(64) _]GetCount[@(64) ()_][@(0.0.255) c
onst]&]
[s2;%% Returns the number of characters in the buffer.&]
[s0;%% &]
[s5;K:`:`:AStringBuffer`:`:SetLength`(int`): [@4 T][@(64) _`*]SetLength[@(64) (][@(0.0.255) i
nt][@(64) _][@3 len][@(64) )]&]
[s5;K:`:`:AStringBuffer`:`:SetCount`(int`): [@4 T][@(64) _`*]SetCount[@(64) (][@(0.0.255) int
][@(64) _][@3 len][@(64) )]&]
[s2;%% [%-*@3 len] &]
[s2;%% Returns a pointer to the buffer of characters. Mutating operations
invalidate this pointer.&]
[s0;%% &]
[s5;K:`:`:AStringBuffer`:`:Clear`(`): [@(0.0.255) void][@(64) _]Clear[@(64) ()]&]
[s2;%% Clears the content of StringBuffer.&]
[s0;%% &]
[s5;K:`:`:AStringBuffer`:`:Reserve`(int`): [@(0.0.255) void][@(64) _]Reserve[@(64) (][@(0.0.255) i
nt][@(64) _][@3 alloc][@(64) )]&]
[s2;%% Preallocates internal buffer (avoids resizing of internal
buffer up to [%-@3 alloc] characters).&]
[s0;%% &]
[s5;K:`:`:String`:`:Buffer`:`:Strlen`(`): [@(0.0.255) void][@(64) _]Strlen[@(64) ()]&]
[s2;%% Same as SetCount(strlen(Begin())). Useful for converting C
strings returned from system to String.&]
[s0;%% &]
[s5;K:`:`:String`:`:Buffer`:`:operator`=`(`:`:String`&`): [@(0.0.255) void][@(64) _]opera
tor`=[@(64) (][@(0.0.255) `[W`]][^`:`:String^@(64) String][@(64) `&_][@3 s][@(64) )]&]
[s2;%% Assigns content of [%-*@3 s] to StringBuffer. Clears [%-*@3 s].&]
[s0;%% &]
[s5;K:`:`:String`:`:Buffer`:`:`:`:String`:`:Buffer`(`): Buffer[@(64) ()]&]
[s2;%% Constructs empty buffer.&]
[s0;%% &]
[s5;K:`:`:String`:`:Buffer`:`:`:`:String`:`:Buffer`(int`): Buffer[@(64) (][@(0.0.255) int
][@(64) _][@3 length][@(64) )]&]
[s2;%% Constructs buffer of [%-*@3 length] characters.&]
[s0;%% &]
[s5;K:`:`:String`:`:Buffer`:`:`:`:String`:`:Buffer`(`:`:String`&`): Buffer[@(64) (][@(0.0.255) `[
W`]][^`:`:String^@(64) String][@(64) `&_][@3 text][@(64) )]&]
[s2;%% Assigns content of [%-*@3 s] to StringBuffer. Clears [%-*@3 s].&]
[s0;%% &]
[s5;K:`:`:String`:`:Buffer`:`:`:`:String`:`:Buffer`(`:`:String`&`,int`): Buffer[@(64) (
][@(0.0.255) `[W`]][^`:`:String^@(64) String][@(64) `&_][@3 text][@(64) ,
][@(0.0.255) int][@(64) _][@3 length][@(64) )]&]
[s2;%% Assigns content of [%-*@3 s] to StringBuffer and trims the length.
Clears [%-*@3 s].&]
[s0; ]