are not supported, nor all methods which use them).
These standard functions are not documented in this manual so please see the STL documentation.
The behaviour of all these functions is identical to the behaviour described
-there.
+there (except that wxString is sensitive to null character).
+
+You may notice that wxString sometimes has many functions which do the same
+thing like, for example, \helpref{Length()}{wxstringlength},
+\helpref{Len()}{wxstringlen} and {\tt length()} which all return the string
+length. In all cases of such duplication the {\tt std::string}-compatible
+method ({\tt length()} in this case, always the lowercase version) should be
+used as it will ensure smoother transition to {\tt std::string} when wxWindows
+starts using it instead of wxString.
\wxheading{Derived from}
\membersection{Constructors and assignment operators}
-A strign may be constructed either from a C string, (some number of copies of)
+A string may be constructed either from a C string, (some number of copies of)
a single character or a wide (UNICODE) string. For all constructors (except the
default which creates an empty string) there is also a corresponding assignment
operator.
Many functions in this section take a character index in the string. As with C
strings and/or arrays, the indices start from $0$, so the first character of a
string is string[$0$]. Attempt to access a character beyond the end of the
-string (which may be even $0$ if the string is empty) will provocate an assert
+string (which may be even $0$ if the string is empty) will provoke an assert
failure in \helpref{debug build}{debuggingoverview}, but no checks are done in
release builds.
insensitive comparisons you should use \helpref{CmpNoCase}{wxstringcmpnocase} or
give a second parameter to IsSameAs. This last function is may be more
convenient if only equality of the strings matters because it returns a boolean
-true value if the strings are the same and not 0 (which is usually FALSE in C)
+true value if the strings are the same and not 0 (which is usually false in C)
as {\tt Cmp()} does.
\helpref{Matches}{wxstringmatches} is a poor man's regular expression matcher:
\helpref{StartsWith}{wxstringstartswith} is helpful when parsing a line of
text which should start with some predefined prefix and is more efficient than
-doing direct string comparaison as you would also have to precalculate the
+doing direct string comparison as you would also have to precalculate the
length of the prefix then.
\helpref{Cmp}{wxstringcmp}\\
\membersection{Case conversion}
The MakeXXX() variants modify the string in place, while the other functions
-return a new string which containts the original text converted to the upper or
+return a new string which contains the original text converted to the upper or
lower case and leave the original string unchanged.
\helpref{MakeUpper}{wxstringmakeupper}\\
The string provides functions for conversion to signed and unsigned integer and
floating point numbers. All three functions take a pointer to the variable to
-put the numeric value in and return TRUE if the {\bf entire} string could be
+put the numeric value in and return true if the {\bf entire} string could be
converted to a number.
\helpref{ToLong}{wxstringtolong}\\
\membersection{Memory management}
-These are "advanced" functions and they will be needed quite rarily.
+These are "advanced" functions and they will be needed quite rarely.
\helpref{Alloc}{wxstringalloc} and \helpref{Shrink}{wxstringshrink} are only
interesting for optimization purposes.
\helpref{GetWriteBuf}{wxstringgetwritebuf} may be very useful when working with
\membersection{wxString::Find}\label{wxstringfind}
-\constfunc{int}{Find}{\param{char}{ ch}, \param{bool}{ fromEnd = FALSE}}
+\constfunc{int}{Find}{\param{char}{ ch}, \param{bool}{ fromEnd = false}}
Searches for the given character. Returns the starting index, or -1 if not found.
\membersection{wxString::First}\label{wxstringfirst}
-\func{size\_t}{First}{\param{char}{ c}}
-
-\constfunc{size\_t}{First}{\param{const char*}{ psz}}
+\func{int}{First}{\param{char}{ c}}
-\constfunc{size\_t}{First}{\param{const wxString\&}{ str}}
+\constfunc{int}{First}{\param{const char*}{ psz}}
-\constfunc{size\_t}{First}{\param{const char}{ ch}}
+\constfunc{int}{First}{\param{const wxString\&}{ str}}
-Returns the first occurrence of the item.
+Same as \helpref{Find}{wxstringfind}.
\membersection{wxString::Format}\label{wxstringformat}
\membersection{wxString::GetWriteBuf}\label{wxstringgetwritebuf}
-\func{char*}{GetWriteBuf}{\param{size\_t}{ len}}
+\func{wxChar*}{GetWriteBuf}{\param{size\_t}{ len}}
Returns a writable buffer of at least {\it len} bytes.
+It returns a pointer to a new memory block, and the
+existing data will not be copied.
Call \helpref{wxString::UngetWriteBuf}{wxstringungetwritebuf} as soon as possible
to put the string back into a reasonable state.
\membersection{wxString::Index}\label{wxstringindex}
-\constfunc{size\_t}{Index}{\param{char}{ ch}, \param{int}{ startpos = 0}}
-
-Same as \helpref{wxString::Find}{wxstringfind}.
+\constfunc{size\_t}{Index}{\param{char}{ ch}}
\constfunc{size\_t}{Index}{\param{const char*}{ sz}}
Same as \helpref{wxString::Find}{wxstringfind}.
-\constfunc{size\_t}{Index}{\param{const char*}{ sz}, \param{bool}{ caseSensitive = TRUE}, \param{bool}{ fromEnd = FALSE}}
+\constfunc{size\_t}{Index}{\param{const char*}{ sz}, \param{bool}{ caseSensitive = true}, \param{bool}{ fromEnd = false}}
Search the element in the array, starting from either side.
-If {\it fromEnd} is TRUE, reverse search direction.
+If {\it fromEnd} is true, reverse search direction.
If {\bf caseSensitive}, comparison is case sensitive (the default).
-Returns the index of the first item matched, or NOT\_FOUND.
+Returns the index of the first item matched, or wxNOT\_FOUND.
% TODO
%\membersection{wxString::insert}\label{wxstringinsert}
\constfunc{bool}{IsAscii}{\void}
-Returns TRUE if the string contains only ASCII characters.
+Returns true if the string contains only ASCII characters.
\membersection{wxString::IsEmpty}\label{wxstringisempty}
\constfunc{bool}{IsEmpty}{\void}
-Returns TRUE if the string is empty.
+Returns true if the string is empty.
\membersection{wxString::IsNull}\label{wxstringisnull}
\constfunc{bool}{IsNull}{\void}
-Returns TRUE if the string is empty (same as \helpref{IsEmpty}{wxstringisempty}).
+Returns true if the string is empty (same as \helpref{IsEmpty}{wxstringisempty}).
\membersection{wxString::IsNumber}\label{wxstringisnumber}
\constfunc{bool}{IsNumber}{\void}
-Returns TRUE if the string is an integer (with possible sign).
+Returns true if the string is an integer (with possible sign).
\membersection{wxString::IsSameAs}\label{wxstringissameas}
-\constfunc{bool}{IsSameAs}{\param{const char*}{ psz}, \param{bool}{ caseSensitive = TRUE}}
+\constfunc{bool}{IsSameAs}{\param{const char*}{ psz}, \param{bool}{ caseSensitive = true}}
Test for string equality, case-sensitive (default) or not.
-caseSensitive is TRUE by default (case matters).
+caseSensitive is true by default (case matters).
-Returns TRUE if strings are equal, FALSE otherwise.
+Returns true if strings are equal, false otherwise.
See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas2}
\membersection{wxString::IsSameAs}\label{wxstringissameas2}
-\constfunc{bool}{IsSameAs}{\param{char}{ c}, \param{bool}{ caseSensitive = TRUE}}
+\constfunc{bool}{IsSameAs}{\param{char}{ c}, \param{bool}{ caseSensitive = true}}
Test whether the string is equal to the single character {\it c}. The test is
-case-sensitive if {\it caseSensitive} is TRUE (default) or not if it is FALSE.
+case-sensitive if {\it caseSensitive} is true (default) or not if it is false.
-Returns TRUE if the string is equal to the character, FALSE otherwise.
+Returns true if the string is equal to the character, false otherwise.
See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas}
\constfunc{bool}{IsWord}{\void}
-Returns TRUE if the string is a word. TODO: what's the definition of a word?
+Returns true if the string is a word. TODO: what's the definition of a word?
\membersection{wxString::Last}\label{wxstringlast}
\constfunc{wxString}{Left}{\param{size\_t}{ count}}
-Returns the first {\it count} characters.
-
-\constfunc{wxString}{Left}{\param{char}{ ch}}
-
-Returns all characters before the first occurrence of {\it ch}.
-Returns the whole string if {\it ch} is not found.
+Returns the first {\it count} characters of the string.
\membersection{wxString::Len}\label{wxstringlen}
\membersection{wxString::MakeLower}\label{wxstringmakelower}
-\func{void}{MakeLower}{\void}
+\func{wxString\&}{MakeLower}{\void}
-Converts all characters to lower case.
+Converts all characters to lower case and returns the result.
\membersection{wxString::MakeUpper}\label{wxstringmakeupper}
-\func{void}{MakeUpper}{\void}
+\func{wxString\&}{MakeUpper}{\void}
-Converts all characters to upper case.
+Converts all characters to upper case and returns the result.
\membersection{wxString::Matches}\label{wxstringmatches}
\constfunc{bool}{Matches}{\param{const char*}{ szMask}}
-Returns TRUE if the string contents matches a mask containing '*' and '?'.
+Returns true if the string contents matches a mask containing '*' and '?'.
\membersection{wxString::Mid}\label{wxstringmid}
\membersection{wxString::Pad}\label{wxstringpad}
-\func{wxString\&}{Pad}{\param{size\_t}{ count}, \param{char}{ pad = ' '}, \param{bool}{ fromRight = TRUE}}
+\func{wxString\&}{Pad}{\param{size\_t}{ count}, \param{char}{ pad = ' '}, \param{bool}{ fromRight = true}}
Adds {\it count} copies of {\it pad} to the beginning, or to the end of the string (the default).
\membersection{wxString::Replace}\label{wxstringreplace}
-\func{size\_t}{Replace}{\param{const char*}{ szOld}, \param{const char*}{ szNew}, \param{bool}{ replaceAll = TRUE}}
+\func{size\_t}{Replace}{\param{const char*}{ szOld}, \param{const char*}{ szNew}, \param{bool}{ replaceAll = true}}
Replace first (or all) occurrences of substring with another one.
\constfunc{bool}{StartsWith}{\param{const wxChar }{*prefix}, \param{wxString }{*rest = NULL}}
This function can be used to test if the string starts with the specified
-{\it prefix}. If it does, the function will return {\tt TRUE} and put the rest
+{\it prefix}. If it does, the function will return {\tt true} and put the rest
of the string (i.e. after the prefix) into {\it rest} string if it is not
-{\tt NULL}. Otherwise, the function returns {\tt FALSE} and doesn't modify the
+{\tt NULL}. Otherwise, the function returns {\tt false} and doesn't modify the
{\it rest}.
\membersection{wxString::Strip}\label{wxstringstrip}
\constfunc{bool}{ToDouble}{\param{double}{ *val}}
-Attempts to convert the string to a floating point number. Returns TRUE on
-success (the number is stored in the location pointed to by {\it val}) or FALSE
+Attempts to convert the string to a floating point number. Returns true on
+success (the number is stored in the location pointed to by {\it val}) or false
if the string does not represent such number.
\wxheading{See also}
\membersection{wxString::ToLong}\label{wxstringtolong}
-\constfunc{bool}{ToLong}{\param{long}{ *val}, \param{int }{base = 0}}
+\constfunc{bool}{ToLong}{\param{long}{ *val}, \param{int }{base = $10$}}
Attempts to convert the string to a signed integer in base {\it base}. Returns
-{\tt TRUE} on success in which case the number is stored in the location
-pointed to by {\it val} or {\tt FALSE} if the string does not represent a
+{\tt true} on success in which case the number is stored in the location
+pointed to by {\it val} or {\tt false} if the string does not represent a
valid number in the given base.
-The default value of {\it base} $0$ is special and means that the usual rules
-of {\tt C} numbers are applied: if the number starts with {\tt 0x} it is
-considered to be in base $16$, if it starts with {\tt 0} - in base $8$ and in
-base $10$ otherwise.
+The value of {\it base} must be comprised between $2$ and $36$, inclusive, or
+be a special value $0$ which means that the usual rules of {\tt C} numbers are
+applied: if the number starts with {\tt 0x} it is considered to be in base
+$16$, if it starts with {\tt 0} - in base $8$ and in base $10$ otherwise. Note
+that you may not want to specify the base $0$ if you are parsing the numbers
+which may have leading zeroes as they can yield unexpected (to the user not
+familiar with C) results.
\wxheading{See also}
\membersection{wxString::ToULong}\label{wxstringtoulong}
-\constfunc{bool}{ToULong}{\param{unsigned long}{ *val}, \param{int }{base = 0}}
+\constfunc{bool}{ToULong}{\param{unsigned long}{ *val}, \param{int }{base = $10$}}
Attempts to convert the string to a ansigned integer in base {\it base}.
-Returns {\tt TRUE} on success in which case the number is stored in the
-location pointed to by {\it val} or {\tt FALSE} if the string does not
+Returns {\tt true} on success in which case the number is stored in the
+location pointed to by {\it val} or {\tt false} if the string does not
represent a valid number in the given base.
-The default value of {\it base} $0$ is special and means that the usual rules
-of {\tt C} numbers are applied: if the number starts with {\tt 0x} it is
-considered to be in base $16$, if it starts with {\tt 0} - in base $8$ and in
-base $10$ otherwise.
+See \helpref{wxString::ToLong}{wxstringtolong} for the more detailed
+description of the {\it base} parameter.
\wxheading{See also}
\membersection{wxString::Trim}\label{wxstringtrim}
-\func{wxString\&}{Trim}{\param{bool}{ fromRight = TRUE}}
+\func{wxString\&}{Trim}{\param{bool}{ fromRight = true}}
Removes spaces from the left or from the right (default).
\func{void}{UngetWriteBuf}{\void}
-Puts the string back into a reasonable state, after
+\func{void}{UngetWriteBuf}{\param{size\_t }{len}}
+
+Puts the string back into a reasonable state (in which it can be used
+normally), after
\rtfsp\helpref{wxString::GetWriteBuf}{wxstringgetwritebuf} was called.
+The version of the function without the {\it len} parameter will calculate the
+new string length itself assuming that the string is terminated by the first
+{\tt NUL} character in it while the second one will use the specified length
+and thus is the only version which should be used with the strings with
+embedded {\tt NUL}s (it is also slightly more efficient as {\tt strlen()}
+doesn't have to be called).
+
\membersection{wxString::Upper}\label{wxstringupper}
\constfunc{wxString}{Upper}{\void}
\constfunc{bool}{operator!}{\void}
-Empty string is FALSE, so !string will only return TRUE if the string is empty.
+Empty string is false, so !string will only return true if the string is empty.
This allows the tests for NULLness of a {\it const char *} pointer and emptyness
of the string to look the same in the code and makes it easier to port old code
to wxString.
These comparisons are case-sensitive.
+
+\section{\class{wxStringBuffer}}\label{wxstringbuffer}
+
+This tiny class allows to conveniently access the \helpref{wxString}{wxstring}
+internal buffer as a writable pointer without any risk to forget to restore
+the string to the usable state later.
+
+For example, assuming you have a low-level OS function called
+{\tt GetMeaningOfLifeAsString(char *)} returning the value in the provided
+buffer (which must be writable, of course) you might call it like this:
+
+\begin{verbatim}
+ wxString theAnswer;
+ GetMeaningOfLifeAsString(wxStringBuffer(theAnswer, 1024));
+ if ( theAnswer != "42" )
+ {
+ wxLogError("Something is very wrong!");
+ }
+\end{verbatim}
+
+\wxheading{Derived from}
+
+None
+
+\wxheading{Include files}
+
+<wx/string.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxStringBuffer::wxStringBuffer}
+
+\func{}{wxStringBuffer}{\param{const wxString\& }{str}, \param{size\_t }{len}}
+
+Constructs a writable string buffer object associated with the given string
+and containing enough space for at least {\it len} characters. Basically, this
+is equivalent to calling \helpref{GetWriteBuf}{wxstringgetwritebuf} and
+saving the result.
+
+\membersection{wxStringBuffer::\destruct{wxStringBuffer}}
+
+\func{}{\destruct{wxStringBuffer}}{\void}
+
+Restores the string passed to the constructor to the usable state by calling
+\helpref{UngetWriteBuf}{wxstringungetwritebuf} on it.
+
+\membersection{wxStringBuffer::operator wxChar *}
+
+\constfunc{wxChar *}{operator wxChar *}{\void}
+
+Returns the writable pointer to a buffer of the size at least equal to the
+length specified in the constructor.
+
+
projects / wxWidgets.git / blobdiff