X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fd34e3a57091ea00f576647343a506a4a56ea827..a9249b2eb2a40d8c71f828669045c4ddaa8dc5ff:/docs/latex/wx/wxstring.tex?ds=sidebyside diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index c4ea3afeca..7ad9ea73ad 100644 --- a/docs/latex/wx/wxstring.tex +++ b/docs/latex/wx/wxstring.tex @@ -16,6 +16,12 @@ None +\wxheading{Predefined objects} + +Objects: + +{\bf wxEmptyString} + \wxheading{See also} \overview{Overview}{wxstringoverview} @@ -87,16 +93,22 @@ 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) -as Cmp does. +as {\tt Cmp()} does. \helpref{Matches}{wxstringmatches} is a poor man's regular expression matcher: it only understands '*' and '?' metacharacters in the sense of DOS command line interpreter. +\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 +length of the prefix then. + \helpref{Cmp}{wxstringcmp}\\ \helpref{CmpNoCase}{wxstringcmpnocase}\\ \helpref{IsSameAs}{wxstringissameas}\\ -\helpref{Matches}{wxstringmatches} +\helpref{Matches}{wxstringmatches}\\ +\helpref{StartsWith}{wxstringstartswith} \membersection{Substring extraction} @@ -111,7 +123,8 @@ substring. \helpref{BeforeFirst}{wxstringbeforefirst}\\ \helpref{BeforeLast}{wxstringbeforelast}\\ \helpref{AfterFirst}{wxstringafterfirst}\\ -\helpref{AfterLast}{wxstringafterlast} +\helpref{AfterLast}{wxstringafterlast}\\ +\helpref{StartsWith}{wxstringstartswith} \membersection{Case conversion} @@ -132,11 +145,36 @@ functions. \helpref{Find}{wxstringfind}\\ \helpref{Replace}{wxstringreplace} +\membersection{Conversion to numbers} + +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 +converted to a number. + +\helpref{ToLong}{wxstringtolong}\\ +\helpref{ToULong}{wxstringtoulong}\\ +\helpref{ToDouble}{wxstringtodouble} + \membersection{Writing values into the string} Both formatted versions (\helpref{Printf}{wxstringprintf}) and stream-like -insertion operators exist (for basic types only). +insertion operators exist (for basic types only). Additionally, the +\helpref{Format}{wxstringformat} function allows to use simply append +formatted value to a string: + +\begin{verbatim} + // the following 2 snippets are equivalent + + wxString s = "..."; + s += wxString::Format("%d", n); + + wxString s; + s.Printf("...%d", n); +\end{verbatim} +\helpref{Format}{wxstringformat}\\ +\helpref{FormatV}{wxstringformatv}\\ \helpref{Printf}{wxstringprintf}\\ \helpref{PrintfV}{wxstringprintfv}\\ \helpref{operator \cinsert}{wxstringoperatorout} @@ -165,9 +203,9 @@ Other string functions. \helpref{Pad}{wxstringpad}\\ \helpref{Truncate}{wxstringtruncate} -\membersection{wxWindows 1.xx compatiblity functions} +\membersection{wxWindows 1.xx compatibility functions} -These functiosn are deprecated, please consider using new wxWindows 2.0 +These functions are deprecated, please consider using new wxWindows 2.0 functions instead of them (or, even better, std::string compatible variants). \helpref{SubString}{wxstringsubstring}\\ @@ -188,7 +226,7 @@ functions instead of them (or, even better, std::string compatible variants). \helpref{IsNumber}{wxstringisnumber}\\ \helpref{IsWord}{wxstringisword} -\membersection{std::string compatibility functions} +\membersection{std::string compatibility functions}\label{wxstringat} The supported functions are only listed here, please see any STL reference for their documentation. @@ -276,7 +314,7 @@ their documentation. // find first n characters of sz size_t find(const char* sz, size_t nStart = 0, size_t n = npos) const; - // find the first occurence of character ch after nStart + // find the first occurrence of character ch after nStart size_t find(char ch, size_t nStart = 0) const; // rfind() family is exactly like find() but works right to left @@ -290,7 +328,7 @@ their documentation. // as find, but from the end size_t rfind(char ch, size_t nStart = npos) const; - // find first/last occurence of any character in the set + // find first/last occurrence of any character in the set // size_t find_first_of(const wxString& str, size_t nStart = 0) const; @@ -305,7 +343,7 @@ their documentation. // same as rfind(char, size_t) size_t find_last_of (char c, size_t nStart = npos) const; - // find first/last occurence of any character not in the set + // find first/last occurrence of any character not in the set // size_t find_first_not_of(const wxString& str, size_t nStart = 0) const; @@ -364,7 +402,14 @@ Constructs a string of {\it n} copies of character {\it ch}. \func{}{wxString}{\param{const char*}{ psz}, \param{size\_t}{ nLength = wxSTRING\_MAXLEN}} Takes first {\it nLength} characters from the C string {\it psz}. -The default value of wxSTRING\_MAXLEN means take all the string. +The default value of wxSTRING\_MAXLEN means to take all the string. + +Note that this constructor may be used even if {\it psz} points to a buffer +with binary data (i.e. containing {\tt NUL} characters) as long as you provide +the correct value for {\it nLength}. However, the default form of it works +only with strings without intermediate {\tt NUL}s because it uses +{\tt strlen()} to calculate the effective length and it would not give correct +results otherwise. \func{}{wxString}{\param{const unsigned char*}{ psz}, \param{size\_t}{ nLength = wxSTRING\_MAXLEN}} @@ -433,30 +478,44 @@ to it. \constfunc{wxString}{AfterFirst}{\param{char}{ ch}} -Gets all the characters after the first occurence of {\it ch}. +Gets all the characters after the first occurrence of {\it ch}. Returns the empty string if {\it ch} is not found. \membersection{wxString::AfterLast}\label{wxstringafterlast} \constfunc{wxString}{AfterLast}{\param{char}{ ch}} -Gets all the characters after the last occurence of {\it ch}. +Gets all the characters after the last occurrence of {\it ch}. Returns the whole string if {\it ch} is not found. \membersection{wxString::BeforeFirst}\label{wxstringbeforefirst} \constfunc{wxString}{BeforeFirst}{\param{char}{ ch}} -Gets all characters before the first occurence of {\it ch}. +Gets all characters before the first occurrence of {\it ch}. Returns the whole string if {\it ch} is not found. \membersection{wxString::BeforeLast}\label{wxstringbeforelast} \constfunc{wxString}{BeforeLast}{\param{char}{ ch}} -Gets all characters before the last occurence of {\it ch}. +Gets all characters before the last occurrence of {\it ch}. Returns the empty string if {\it ch} is not found. +\membersection{wxString::c\_str}\label{wxstringcstr} + +\constfunc{const char *}{c\_str}{\void} + +Returns a pointer to the string data. + +\membersection{wxString::Clear}\label{wxstringclear} + +\func{void}{Clear}{\void} + +Empties the string and frees memory occupied by it. + +See also: \helpref{Empty}{wxstringempty} + \membersection{wxString::Cmp}\label{wxstringcmp} \constfunc{int}{Cmp}{\param{const char*}{ psz}} @@ -464,7 +523,7 @@ Returns the empty string if {\it ch} is not found. Case-sensitive comparison. Returns a positive value if the string is greater than the argument, zero if -it si equal to it or negative value if it is less than argument (same semantics +it is equal to it or a negative value if it is less than the argument (same semantics as the standard {\it strcmp()} function). See also \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas}. @@ -476,7 +535,7 @@ See also \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissa Case-insensitive comparison. Returns a positive value if the string is greater than the argument, zero if -it si equal to it or negative value if it is less than argument (same semantics +it is equal to it or a negative value if it is less than the argument (same semantics as the standard {\it strcmp()} function). See also \helpref{Cmp}{wxstringcmp}, \helpref{IsSameAs}{wxstringissameas}. @@ -487,7 +546,7 @@ See also \helpref{Cmp}{wxstringcmp}, \helpref{IsSameAs}{wxstringissameas}. #define NO_POS ((int)(-1)) // undefined position enum caseCompare {exact, ignoreCase}; \end{verbatim} - + \constfunc{int}{CompareTo}{\param{const char*}{ psz}, \param{caseCompare}{ cmp = exact}} Case-sensitive comparison. Returns 0 if equal, 1 if greater or -1 if less. @@ -502,7 +561,9 @@ Returns 1 if target appears anyhere in wxString; else 0. \func{void}{Empty}{\void} -Reinitializes the string and frees the data. +Makes the string empty, but doesn't free memory occupied by the string. + +See also: \helpref{Clear()}{wxstringclear}. \membersection{wxString::Find}\label{wxstringfind} @@ -526,11 +587,33 @@ Searches for the given string. Returns the starting index, or -1 if not found. Returns the first occurrence of the item. +\membersection{wxString::Format}\label{wxstringformat} + +\func{static wxString}{Format}{\param{const wxChar }{*format}, \param{}{...}} + +This static function returns the string containing the result of calling +\helpref{Printf}{wxstringprintf} with the passed parameters on it. + +\wxheading{See also} + +\helpref{FormatV}{wxstringformatv}, \helpref{Printf}{wxstringprintf} + +\membersection{wxString::FormatV}\label{wxstringformatv} + +\func{static wxString}{Format}{\param{const wxChar }{*format}, \param{va\_list }{argptr}} + +This static function returns the string containing the result of calling +\helpref{PrintfV}{wxstringprintfv} with the passed parameters on it. + +\wxheading{See also} + +\helpref{Format}{wxstringformat}, \helpref{PrintfV}{wxstringprintfv} + \membersection{wxString::Freq}\label{wxstringfreq} -\constfunc{int}{Frec}{\param{char }{ch}} +\constfunc{int}{Freq}{\param{char }{ch}} -Returns the number of occurences of {it ch} in the string. +Returns the number of occurrences of {\it ch} in the string. \membersection{wxString::GetChar}\label{wxstringgetchar} @@ -590,25 +673,25 @@ Returns the index of the first item matched, or NOT\_FOUND. \constfunc{bool}{IsAscii}{\void} -Returns TRUE if the string is ASCII. +Returns TRUE if the string contains only ASCII characters. \membersection{wxString::IsEmpty}\label{wxstringisempty} \constfunc{bool}{IsEmpty}{\void} -Returns TRUE if the string is NULL. +Returns TRUE if the string is empty. \membersection{wxString::IsNull}\label{wxstringisnull} \constfunc{bool}{IsNull}{\void} -Returns TRUE if the string is NULL (same as IsEmpty). +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 a number. +Returns TRUE if the string is an integer (with possible sign). \membersection{wxString::IsSameAs}\label{wxstringissameas} @@ -620,7 +703,18 @@ caseSensitive is TRUE by default (case matters). Returns TRUE if strings are equal, FALSE otherwise. -See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}. +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}} + +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. + +Returns TRUE if the string is equal to the character, FALSE otherwise. + +See also \helpref{Cmp}{wxstringcmp}, \helpref{CmpNoCase}{wxstringcmpnocase}, \helpref{IsSameAs}{wxstringissameas} \membersection{wxString::IsWord}\label{wxstringisword} @@ -646,7 +740,7 @@ Returns the first {\it count} characters. \constfunc{wxString}{Left}{\param{char}{ ch}} -Returns all characters before the first occurence of {\it ch}. +Returns all characters before the first occurrence of {\it ch}. Returns the whole string if {\it ch} is not found. \membersection{wxString::Len}\label{wxstringlen} @@ -739,7 +833,7 @@ Same as Truncate. Removes the portion from {\it pos} to the end of the string. \func{wxString\&}{Remove}{\param{size\_t}{ pos}, \param{size\_t}{ len}} -Removes the last {\it len} characters from the string, starting at {\it pos}. +Removes the {\it len} characters from the string, starting at {\it pos}. \membersection{wxString::RemoveLast}\label{wxstringremovelast} @@ -751,9 +845,9 @@ Removes the last character. \func{size\_t}{Replace}{\param{const char*}{ szOld}, \param{const char*}{ szNew}, \param{bool}{ replaceAll = TRUE}} -Replace first (or all) occurences of substring with another one. +Replace first (or all) occurrences of substring with another one. -{\it replaceAll}: global replace (default), or only the first occurence. +{\it replaceAll}: global replace (default), or only the first occurrence. Returns the number of replacements made. @@ -763,11 +857,6 @@ Returns the number of replacements made. Returns the last {\it count} characters. -\constfunc{wxString}{Right}{\param{char}{ ch}} - -Returns all characters after the last occurence of {\it ch}. -Returns the whole string if {\it ch} is not found. - \membersection{wxString::SetChar}\label{wxstringsetchar} \func{void}{SetChar}{\param{size\_t}{ n}, \param{char}{ch}} @@ -787,6 +876,16 @@ Minimizes the string's memory. This can be useful after a call to The same as Printf. +\membersection{wxString::StartsWith}\label{wxstringstartswith} + +\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 +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 +{\it rest}. + \membersection{wxString::Strip}\label{wxstringstrip} \begin{verbatim} @@ -800,9 +899,64 @@ doesn't change this string. \membersection{wxString::SubString}\label{wxstringsubstring} -\constfunc{wxString}{SubString}{\param{size\_t}{ to}, \param{size\_t}{ from}} +\constfunc{wxString}{SubString}{\param{size\_t}{ from}, \param{size\_t}{ to}} + +Deprecated, use \helpref{Mid}{wxstringmid} instead (but note that parameters +have different meaning). + +Returns the part of the string between the indices {\it from} and {\it to} +inclusive. -Same as \helpref{Mid}{wxstringmid}. +\membersection{wxString::ToDouble}\label{wxstringtodouble} + +\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 +if the string does not represent such number. + +\wxheading{See also} + +\helpref{wxString::ToLong}{wxstringtolong},\\ +\helpref{wxString::ToULong}{wxstringtoulong} + +\membersection{wxString::ToLong}\label{wxstringtolong} + +\constfunc{bool}{ToLong}{\param{long}{ *val}, \param{int }{base = 0}} + +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 +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. + +\wxheading{See also} + +\helpref{wxString::ToDouble}{wxstringtodouble},\\ +\helpref{wxString::ToULong}{wxstringtoulong} + +\membersection{wxString::ToULong}\label{wxstringtoulong} + +\constfunc{bool}{ToULong}{\param{unsigned long}{ *val}, \param{int }{base = 0}} + +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 +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. + +\wxheading{See also} + +\helpref{wxString::ToDouble}{wxstringtodouble},\\ +\helpref{wxString::ToLong}{wxstringtolong} \membersection{wxString::Trim}\label{wxstringtrim} @@ -861,7 +1015,7 @@ See also \helpref{IsEmpty()}{wxstringisempty}. Assignment: the effect of each operation is the same as for the corresponding constructor (see \helpref{wxString constructors}{wxstringconstruct}). -\membersection{operator wxString::$+$}\label{wxstringoperatorplus} +\membersection{wxString::operator $+$}\label{wxstringoperatorplus} Concatenation: all these operators return a new strign equal to the sum of the operands. @@ -962,3 +1116,57 @@ Implicit conversion to a C string. 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} + + + +\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. Basicly, 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. + +