X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..d095f867de4d7c00fe9996f714892141d917f308:/interface/string.h diff --git a/interface/string.h b/interface/string.h index 4a2d2edb4d..038722cac1 100644 --- a/interface/string.h +++ b/interface/string.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: string.h -// Purpose: documentation for wxStringBuffer class +// Purpose: interface of wxStringBuffer // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -47,7 +47,7 @@ class wxStringBuffer public: /** Constructs a writable string buffer object associated with the given string - and containing enough space for at least @e len characters. Basically, this + and containing enough space for at least @a len characters. Basically, this is equivalent to calling wxString::GetWriteBuf and saving the result. */ @@ -63,70 +63,265 @@ public: Returns the writable pointer to a buffer of the size at least equal to the length specified in the constructor. */ - wxChar * operator wxChar *(); + wxChar* operator wxChar *(); }; + /** @class wxString @wxheader{string.h} - wxString is a class representing a character string. Please see the - @ref overview_wxstringoverview "wxString overview" for more information about - it. - - As explained there, wxString implements most of the methods of the std::string - class. - These standard functions are not documented in this manual, please see the - STL documentation). - The behaviour of all these functions is identical to the behaviour described - there. - - You may notice that wxString sometimes has many functions which do the same - thing like, for example, wxString::Length, - wxString::Len and @c length() which all return the string - length. In all cases of such duplication the @c std::string-compatible - method (@c length() in this case, always the lowercase version) should be + wxString is a class representing a character string. It uses + reference counting and copy-on-write internally and is not + thread-safe. Please see the + @ref overview_string "wxString overview" and the + @ref overview_unicode "Unicode overview" for more information + about it. + + Since wxWidgets 3.0 wxString internally uses UCS-2 (basically 2-byte per + character wchar_t) under Windows and UTF-8 under Unix, Linux and + OS X to store its content. Much work has been done to make + existing code using ANSI string literals work as before. + + wxString implements most of the methods of the + std::string class. These standard functions are not documented in + this manual, please see the STL documentation. The behaviour of + all these functions is identical to the behaviour described there. + + You may notice that wxString sometimes has many functions which do + the same thing like, for example, wxString::Length, wxString::Len and @c length() + which all return the string length. In all cases of such duplication the @c std::string + compatible method (@c length() in this case, always the lowercase version) should be used as it will ensure smoother transition to @c std::string when wxWidgets starts using it instead of wxString. + Anything may be concatenated (appended to) with a string. However, you can't + append something to a C string (including literal constants), so to do this it + should be converted to a wxString first. + + @li @ref operatorout() "operator " + @li operator+=() + @li operator+() + @li Append() + @li Prepend() + + 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. + + @li wxString() + @li operator=() + @li ~wxString + + The MakeXXX() variants modify the string in place, while the other functions + return a new string which contains the original text converted to the upper or + lower case and leave the original string unchanged. + + @li MakeUpper() + @li Upper() + @li MakeLower() + @li Lower() + + + 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 provoke an assert + failure in @ref overview_debugging "debug build", but no checks are + done in release builds. + This section also contains both implicit and explicit conversions to C style + strings. Although implicit conversion is quite convenient, it is advised to use + explicit c_str() method for the sake of clarity. + + @li GetChar() + @li GetWritableChar() + @li SetChar() + @li Last() + @li operator[] + @li c_str() + @li mb_str() + @li wc_str() + @li fn_str() + @li operator const char*() + + The default comparison function Cmp() is case-sensitive and + so is the default version of IsSameAs(). For case + insensitive comparisons you should use CmpNoCase() 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. + Matches() is a poor man's regular expression matcher: it only understands + '*' and '?' metacharacters in the sense of DOS command line interpreter. + StartsWith() is helpful when parsing a line of text which should start + with some predefined prefix and is more efficient than doing direct string + comparison as you would also have to precalculate the length of the prefix then. + + @li Cmp() + @li CmpNoCase() + @li IsSameAs() + @li Matches() + @li StartsWith() + @li EndsWith() + + 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 @b entire string could be + converted to a number. + + @li ToLong() + @li ToLongLong() + @li ToULong() + @li ToULongLong() + @li ToDouble() + + These are "advanced" functions and they will be needed quite rarely. + Alloc() and Shrink() are only interesting for optimization purposes. + wxStringBuffer and wxStringBufferLength classes may be very useful + when working with some external API which requires the caller to provide + a writable buffer. + + @li Alloc() + @li Shrink() + @li wxStringBuffer + @li wxStringBufferLength + + Misc. other string functions. + + @li Trim() + @li Truncate() + @li Pad() + + These functions return the string length and check whether the string + is empty or empty it. + + @li Len() + @li IsEmpty() + @li operator!() + @li Empty() + @li Clear() + + + These functions allow to extract substring from this string. All of them don't + modify the original string and return a new string containing the extracted + substring. + + @li Mid() + @li operator()() + @li Left() + @li Right() + @li BeforeFirst() + @li BeforeLast() + @li AfterFirst() + @li AfterLast() + @li StartsWith() + @li EndsWith() + + These functions replace the standard @e strchr() and @e strstr() + functions. + + @li Find() + @li Replace() + + Both formatted versions (Printf/() and stream-like insertion operators + exist (for basic types only). Additionally, the Format() function allows + to use simply append formatted value to a string: + + @li Format() + @li FormatV() + @li Printf() + @li PrintfV() + @li operator>>() + + These functions are deprecated, please consider using new wxWidgets 2.0 + functions instead of them (or, even better, std::string compatible variants). + + CompareTo(), Contains(), First(), Freq(), Index(), IsAscii(), IsNull(), + IsNumber(), IsWord(), Last(), Length(), LowerCase(), Remove(), Strip(), + SubString(), UpperCase() + @library{wxbase} @category{data} @stdobjects - Objects: - wxEmptyString + ::Objects:, ::wxEmptyString, - @seealso - @ref overview_wxstringoverview "wxString overview", @ref overview_unicode + @see @ref overview_string "wxString overview", @ref overview_unicode "Unicode overview" */ class wxString { public: - //@{ /** - Initializes the string from first @e nLength characters of C string. - The default value of @c wxSTRING_MAXLEN means take all the string. - In Unicode build, @e conv's - wxMBConv::MB2WC method is called to - convert @e psz to wide string (the default converter uses current locale's - charset). It is ignored in ANSI build. - - @sa @ref overview_mbconvclasses "wxMBConv classes", @ref mbstr() - mb_str, @ref wcstr() wc_str + Default constructor */ wxString(); - wxString(const wxString& x); - wxString(wxChar ch, size_t n = 1); - wxString(const wxChar* psz, size_t nLength = wxSTRING_MAXLEN); - wxString(const unsigned char* psz, - size_t nLength = wxSTRING_MAXLEN); - wxString(const wchar_t* psz, const wxMBConv& conv, - size_t nLength = wxSTRING_MAXLEN); - wxString(const char* psz, const wxMBConv& conv = wxConvLibc, - size_t nLength = wxSTRING_MAXLEN); - //@} + + /** + Creates a string from another string. Just increases the ref + count by 1. + */ + wxString(const wxString& stringSrc); + + + /** + Constructs a string from the string literal @c psz using + the current locale encoding to convert it to Unicode. + */ + wxString(const char *psz); + + /** + Constructs a string from the string literal @c psz using + @c conv to convert it Unicode. + */ + wxString(const char *psz, const wxMBConv& conv); + + /** + Constructs a string from the first @ nLength character of the string literal @c psz using + the current locale encoding to convert it to Unicode. + */ + wxString(const char *psz, size_t nLength); + + /** + Constructs a string from the first @ nLength character of the string literal @c psz using + @c conv to convert it Unicode. + */ + wxString(const char *psz, const wxMBConv& conv, size_t nLength); + + /** + Constructs a string from the string literal @c pwz. + */ + wxString(const wchar_t *pwz); + + /** + Constructs a string from the first @ nLength characters of the string literal @c pwz. + */ + wxString(const wchar_t *pwz, size_t nLength); + + /** + Constructs a string from @c buf using the using + the current locale encoding to convert it to Unicode. + */ + wxString(const wxCharBuffer& buf); + + /** + Constructs a string from @c buf. + */ + wxString(const wxWCharBuffer& buf); + + /** + Constructs a string from @str using the using + the current locale encoding to convert it to Unicode. + */ + wxString(const std::string& str); + + /** + Constructs a string from @str. + */ + wxString(const std::wstring& str); + /** String destructor. Note that this is not virtual, so wxString must not be @@ -136,32 +331,58 @@ public: /** Gets all the characters after the first occurrence of @e ch. - Returns the empty string if @e ch is not found. + Returns the empty string if @a ch is not found. */ - wxString AfterFirst(wxChar ch); + wxString AfterFirst(wxChar ch) const; /** Gets all the characters after the last occurrence of @e ch. - Returns the whole string if @e ch is not found. + Returns the whole string if @a ch is not found. */ - wxString AfterLast(wxChar ch); + wxString AfterLast(wxChar ch) const; /** - Preallocate enough space for wxString to store @e nLen characters. This function - may be used to increase speed when the string is constructed by repeated - concatenation as in - because it will avoid the need to reallocate string memory many times (in case - of long strings). Note that it does not set the maximal length of a string - it - will still expand if more than @e nLen characters are stored in it. Also, it - does not truncate the existing string (use - Truncate() for this) even if its current length is - greater than @e nLen + Preallocate enough space for wxString to store @a nLen characters. + + Please note that this method does the same thing as the standard + reserve() one and shouldn't be used in new code. + + This function may be used to increase speed when the string is + constructed by repeated concatenation as in + + @code + // delete all vowels from the string + wxString DeleteAllVowels(const wxString& original) + { + wxString result; + + size_t len = original.length(); + + result.Alloc(len); + + for ( size_t n = 0; n < len; n++ ) + { + if ( strchr("aeuio", tolower(original[n])) == NULL ) + result += original[n]; + } + + return result; + } + @endcode + + because it will avoid the need to reallocate string memory many times + (in case of long strings). Note that it does not set the maximal length + of a string -- it will still expand if more than @a nLen characters are + stored in it. Also, it does not truncate the existing string (use + Truncate() for this) even if its current length is greater than @a nLen. + + @return @true if memory was successfully allocated, @false otherwise. */ - void Alloc(size_t nLen); + bool Alloc(size_t nLen); //@{ /** - Concatenates character @e ch to this string, @e count times, returning a + Concatenates character @a ch to this string, @a count times, returning a reference to it. */ @@ -171,148 +392,74 @@ public: /** Gets all characters before the first occurrence of @e ch. - Returns the whole string if @e ch is not found. + Returns the whole string if @a ch is not found. */ - wxString BeforeFirst(wxChar ch); + wxString BeforeFirst(wxChar ch) const; /** Gets all characters before the last occurrence of @e ch. - Returns the empty string if @e ch is not found. - */ - wxString BeforeLast(wxChar ch); - - /** - The MakeXXX() variants modify the string in place, while the other functions - return a new string which contains the original text converted to the upper or - lower case and leave the original string unchanged. - - MakeUpper() - - Upper() - - MakeLower() - - Lower() - */ - - - /** - 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 provoke an assert - failure in @ref overview_debuggingoverview "debug build", but no checks are - done in - release builds. - - This section also contains both implicit and explicit conversions to C style - strings. Although implicit conversion is quite convenient, it is advised to use - explicit @ref cstr() c_str method for the sake of clarity. Also - see overview for the cases where it is necessary to - use it. - - GetChar() - - GetWritableChar() - - SetChar() - - Last() - - @ref operatorbracket() "operator []" - - @ref cstr() c_str - - @ref mbstr() mb_str - - @ref wcstr() wc_str - - @ref fnstr() fn_str - - @ref operatorconstcharpt() "operator const char*" + Returns the empty string if @a ch is not found. */ + wxString BeforeLast(wxChar ch) const; /** Empties the string and frees memory occupied by it. - See also: Empty() */ void Clear(); + /** + Returns a deep copy of the string. + + That is, the returned string is guaranteed to not share data with this + string when using reference-counted wxString implementation. + + This method is primarily useful for passing strings between threads + (because wxString is not thread-safe). Unlike creating a copy using + @c wxString(c_str()), Clone() handles embedded NULs correctly. + + @since 2.9.0 + */ + wxString Clone() const; + //@{ /** Case-sensitive comparison. - Returns a positive value if the string is greater than the argument, zero if it is equal to it or a negative value if it is less than the argument (same semantics as the standard @e strcmp() function). - See also CmpNoCase(), IsSameAs(). */ - int Cmp(const wxString& s); - int Cmp(const wxChar* psz); + int Cmp(const wxString& s) const; + const int Cmp(const wxChar* psz) const; //@} //@{ /** Case-insensitive comparison. - Returns a positive value if the string is greater than the argument, zero if it is equal to it or a negative value if it is less than the argument (same semantics as the standard @e strcmp() function). - See also Cmp(), IsSameAs(). */ - int CmpNoCase(const wxString& s); - int CmpNoCase(const wxChar* psz); + int CmpNoCase(const wxString& s) const; + const int CmpNoCase(const wxChar* psz) const; //@} /** Case-sensitive comparison. Returns 0 if equal, 1 if greater or -1 if less. - This is a wxWidgets 1.xx compatibility function; use Cmp() instead. */ - int CompareTo(const wxChar* psz, caseCompare cmp = exact); + int CompareTo(const wxChar* psz, caseCompare cmp = exact) const; - /** - The default comparison function Cmp() is case-sensitive and - so is the default version of IsSameAs(). For case - insensitive comparisons you should use CmpNoCase() 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 @c Cmp() does. - - Matches() is a poor man's regular expression matcher: - it only understands '*' and '?' metacharacters in the sense of DOS command line - interpreter. - - StartsWith() is helpful when parsing a line of - text which should start with some predefined prefix and is more efficient than - doing direct string comparison as you would also have to precalculate the - length of the prefix then. - - Cmp() - - CmpNoCase() - - IsSameAs() - - Matches() - - StartsWith() - - EndsWith() - */ //@{ /** - + */ bool operator ==(const wxString& x, const wxString& y); bool operator ==(const wxString& x, const wxChar* t); @@ -328,66 +475,17 @@ public: bool operator =(const wxString& x, const wxChar* t); //@} - /** - Anything may be concatenated (appended to) with a string. However, you can't - append something to a C string (including literal constants), so to do this it - should be converted to a wxString first. - - @ref operatorout() "operator " - - @ref plusequal() "operator +=" - - @ref operatorplus() "operator +" - - Append() - - Prepend() - */ - - - /** - 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. - - @ref construct() wxString - - @ref operatorassign() "operator =" - - @ref destruct() ~wxString - */ - /** Returns @true if target appears anywhere in wxString; else @false. - This is a wxWidgets 1.xx compatibility function; you should not use it in new code. */ - bool Contains(const wxString& str); - - /** - 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 @b entire string could be - converted to a number. - - ToLong() - - ToLongLong() - - ToULong() - - ToULongLong() - - ToDouble() - */ + bool Contains(const wxString& str) const; /** Makes the string empty, but doesn't free memory occupied by the string. - See also: Clear(). */ void Empty(); @@ -395,68 +493,65 @@ public: /** This function can be used to test if the string ends with the specified @e suffix. If it does, the function will return @true and put the - beginning of the string before the suffix into @e rest string if it is not + beginning of the string before the suffix into @a rest string if it is not @NULL. Otherwise, the function returns @false and doesn't modify the @e rest. */ - bool EndsWith(const wxString& suffix, wxString rest = @NULL); + bool EndsWith(const wxString& suffix, wxString rest = NULL) const; //@{ /** Searches for the given string. Returns the starting index, or @c wxNOT_FOUND if not found. */ - int Find(wxUniChar ch, bool fromEnd = @false); - int Find(const wxString& sub); + int Find(wxUniChar ch, bool fromEnd = false) const; + const int Find(const wxString& sub) const; //@} //@{ /** Same as Find(). - This is a wxWidgets 1.xx compatibility function; you should not use it in new code. */ - int First(wxChar c); - int First(const wxChar* psz); - int First(const wxString& str); + int First(wxChar c) const; + int First(const wxChar* psz) const; + const int First(const wxString& str) const; //@} /** This static function returns the string containing the result of calling Printf() with the passed parameters on it. - - @sa FormatV(), Printf() + + @see FormatV(), Printf() */ - static wxString Format(const wxChar format, ...); + static wxString Format(const wxChar format, ...); /** This static function returns the string containing the result of calling PrintfV() with the passed parameters on it. - - @sa Format(), PrintfV() + + @see Format(), PrintfV() */ static wxString FormatV(const wxChar format, va_list argptr); /** - Returns the number of occurrences of @e ch in the string. - + Returns the number of occurrences of @a ch in the string. This is a wxWidgets 1.xx compatibility function; you should not use it in new code. */ - int Freq(wxChar ch); + int Freq(wxChar ch) const; //@{ /** Converts given buffer of binary data from 8-bit string to wxString. In Unicode build, the string is interpreted as being in ISO-8859-1 encoding. The version - without @e len parameter takes NUL-terminated data. - + without @a len parameter takes NUL-terminated data. This is a convenience method useful when storing binary data in wxString. - - This function is new since wxWidgets version 2.8.4 - - @sa wxString::To8BitData + + @since 2.8.4 + + @see wxString::To8BitData */ static wxString From8BitData(const char* buf, size_t len); static wxString From8BitData(const char* buf); @@ -480,8 +575,7 @@ public: //@{ /** Converts C string encoded in UTF-8 to wxString. - - Note that this method assumes that @e s is a valid UTF-8 sequence and + Note that this method assumes that @a s is a valid UTF-8 sequence and doesn't do any validation in release builds, it's validity is only checked in debug builds. */ @@ -490,15 +584,15 @@ public: //@} /** - Returns the character at position @e n (read-only). + Returns the character at position @a n (read-only). */ - wxChar GetChar(size_t n); + wxChar GetChar(size_t n) const; /** wxWidgets compatibility conversion. Returns a constant pointer to the data in the string. */ - const wxChar* GetData(); + const wxChar* GetData() const; /** Returns a reference to the character at position @e n. @@ -506,13 +600,11 @@ public: wxChar GetWritableChar(size_t n); /** - Returns a writable buffer of at least @e len bytes. + Returns a writable buffer of at least @a len bytes. It returns a pointer to a new memory block, and the existing data will not be copied. - Call UngetWriteBuf() as soon as possible to put the string back into a reasonable state. - This method is deprecated, please use wxStringBuffer or wxStringBufferLength instead. @@ -522,102 +614,92 @@ public: //@{ /** Same as Find(). - This is a wxWidgets 1.xx compatibility function; you should not use it in new code. */ - size_t Index(wxChar ch); - size_t Index(const wxChar* sz); + size_t Index(wxChar ch) const; + const size_t Index(const wxChar* sz) const; //@} /** Returns @true if the string contains only ASCII characters. - This is a wxWidgets 1.xx compatibility function; you should not use it in new code. */ - bool IsAscii(); + bool IsAscii() const; /** Returns @true if the string is empty. */ - bool IsEmpty(); + bool IsEmpty() const; /** Returns @true if the string is empty (same as wxString::IsEmpty). - This is a wxWidgets 1.xx compatibility function; you should not use it in new code. */ - bool IsNull(); + bool IsNull() const; /** Returns @true if the string is an integer (with possible sign). - This is a wxWidgets 1.xx compatibility function; you should not use it in new code. */ - bool IsNumber(); + bool IsNumber() const; //@{ /** Test whether the string is equal to the single character @e c. The test is - case-sensitive if @e caseSensitive is @true (default) or not if it is @c + case-sensitive if @a caseSensitive is @true (default) or not if it is @c @false. - Returns @true if the string is equal to the character, @false otherwise. - See also Cmp(), CmpNoCase() */ - bool IsSameAs(const wxChar* psz, bool caseSensitive = @true); - bool IsSameAs(wxChar c, bool caseSensitive = @true); + bool IsSameAs(const wxChar* psz, bool caseSensitive = true) const; + const bool IsSameAs(wxChar c, bool caseSensitive = true) const; //@} /** Returns @true if the string is a word. - This is a wxWidgets 1.xx compatibility function; you should not use it in new code. */ - bool IsWord(); + bool IsWord() const; //@{ /** Returns a reference to the last character (writable). - This is a wxWidgets 1.xx compatibility function; you should not use it in new code. */ wxChar Last(); - wxChar Last(); + const wxChar Last(); //@} /** - Returns the first @e count characters of the string. + Returns the first @a count characters of the string. */ - wxString Left(size_t count); + wxString Left(size_t count) const; /** Returns the length of the string. */ -#define size_t Len() /* implementation is private */ + size_t Len() const; /** Returns the length of the string (same as Len). - This is a wxWidgets 1.xx compatibility function; you should not use it in new code. */ - size_t Length(); + size_t Length() const; /** Returns this string converted to the lower case. */ - wxString Lower(); + wxString Lower() const; /** Same as MakeLower. - This is a wxWidgets 1.xx compatibility function; you should not use it in new code. */ @@ -636,70 +718,39 @@ public: /** Returns @true if the string contents matches a mask containing '*' and '?'. */ - bool Matches(const wxString& mask); - - /** - These are "advanced" functions and they will be needed quite rarely. - Alloc() and Shrink() are only - interesting for optimization purposes. - wxStringBuffer - and wxStringBufferLength classes may be very - useful when working with some external API which requires the caller to provide - a writable buffer. - - Alloc() - - Shrink() - - wxStringBuffer - - wxStringBufferLength - */ - + bool Matches(const wxString& mask) const; /** Returns a substring starting at @e first, with length @e count, or the rest of - the string if @e count is the default value. - */ -#define wxString Mid(size_t first, size_t count = wxSTRING_MAXLEN) /* implementation is private */ - - /** - Other string functions. - - Trim() - - Truncate() - - Pad() + the string if @a count is the default value. */ + wxString Mid(size_t first, size_t count = wxSTRING_MAXLEN) const; /** - Adds @e count copies of @e pad to the beginning, or to the end of the string - (the default). - - Removes spaces from the left or from the right (default). + Adds @a count copies of @a pad to the beginning, or to the end of the + string (the default). Removes spaces from the left or from the right (default). */ -#define wxString Pad(size_t count, wxChar pad = ' ', - bool fromRight = @true) /* implementation is private */ + wxString Pad(size_t count, wxChar pad = ' ', + bool fromRight = true); /** - Prepends @e str to this string, returning a reference to this string. + Prepends @a str to this string, returning a reference to this string. */ wxString Prepend(const wxString& str); /** Similar to the standard function @e sprintf(). Returns the number of characters written, or an integer less than zero on error. - Note that if @c wxUSE_PRINTF_POS_PARAMS is set to 1, then this function supports Unix98-style positional parameters: - @b NB: This function will use a safe version of @e vsprintf() (usually called + + @note This function will use a safe version of @e vsprintf() (usually called @e vsnprintf()) whenever available to always allocate the buffer of correct size. Unfortunately, this function is not available on all platforms and the dangerous @e vsprintf() will be used then which may lead to buffer overflows. */ - int Printf(const wxChar* pszFormat, ...); + int Printf(const wxChar* pszFormat, ...); /** Similar to vprintf. Returns the number of characters written, or an integer @@ -710,8 +761,7 @@ public: //@{ /** - Removes @e len characters from the string, starting at @e pos. - + Removes @a len characters from the string, starting at @e pos. This is a wxWidgets 1.xx compatibility function; you should not use it in new code. */ @@ -726,28 +776,16 @@ public: /** Replace first (or all) occurrences of substring with another one. - @e replaceAll: global replace (default), or only the first occurrence. - Returns the number of replacements made. */ size_t Replace(const wxString& strOld, const wxString& strNew, - bool replaceAll = @true); + bool replaceAll = true); /** - Returns the last @e count characters. + Returns the last @a count characters. */ - wxString Right(size_t count); - - /** - These functions replace the standard @e strchr() and @e strstr() - functions. - - Find() - - Replace() - */ - + wxString Right(size_t count) const; /** Sets the character at position @e n. @@ -763,180 +801,129 @@ public: /** This function can be used to test if the string starts with the specified @e prefix. If it does, the function will return @true and put the rest - of the string (i.e. after the prefix) into @e rest string if it is not + of the string (i.e. after the prefix) into @a rest string if it is not @NULL. Otherwise, the function returns @false and doesn't modify the @e rest. */ - bool StartsWith(const wxString& prefix, wxString rest = @NULL); - - /** - These functions return the string length and check whether the string is empty - or empty it. - - Len() - - IsEmpty() - - @ref operatornot() operator! - - Empty() - - Clear() - */ - + bool StartsWith(const wxString& prefix, wxString rest = NULL) const; /** Strip characters at the front and/or end. The same as Trim except that it doesn't change this string. - This is a wxWidgets 1.xx compatibility function; you should not use it in new code. */ - wxString Strip(stripType s = trailing); + wxString Strip(stripType s = trailing) const; /** - Returns the part of the string between the indices @e from and @e to + Returns the part of the string between the indices @a from and @e to inclusive. - This is a wxWidgets 1.xx compatibility function, use Mid() instead (but note that parameters have different meaning). */ - wxString SubString(size_t from, size_t to); - - /** - These functions allow to extract substring from this string. All of them don't - modify the original string and return a new string containing the extracted - substring. - - Mid() - - @ref operatorparenth() operator - - Left() - - Right() - - BeforeFirst() - - BeforeLast() - - AfterFirst() - - AfterLast() - - StartsWith() - - EndsWith() - */ - + wxString SubString(size_t from, size_t to) const; //@{ /** Converts the string to an 8-bit string in ISO-8859-1 encoding in the form of a wxCharBuffer (Unicode builds only). - This is a convenience method useful when storing binary data in wxString. - - This function is new since wxWidgets version 2.8.4 - - @sa wxString::From8BitData + + @since 2.8.4 + + @see wxString::From8BitData */ - const char* To8BitData(); - const wxCharBuffer To8BitData(); + const char* To8BitData() const; + const const wxCharBuffer To8BitData() const; //@} //@{ /** Converts the string to an ASCII, 7-bit string in the form of a wxCharBuffer (Unicode builds only) or a C string (ANSI builds). - Note that this conversion only works if the string contains only ASCII characters. The @ref mbstr() mb_str method provides more powerful means of converting wxString to C string. */ - const char* ToAscii(); - const wxCharBuffer ToAscii(); + const char* ToAscii() const; + const const wxCharBuffer ToAscii() const; //@} /** Attempts to convert the string to a floating point number. Returns @true on success (the number is stored in the location pointed to by @e val) or @false - if the string does not represent such number (the value of @e val is not + if the string does not represent such number (the value of @a val is not modified in this case). - - @sa ToLong(), ToULong() + + @see ToLong(), ToULong() */ - bool ToDouble(double val); + bool ToDouble(double val) const; /** Attempts to convert the string to a signed integer in base @e base. Returns @true on success in which case the number is stored in the location - pointed to by @e val or @false if the string does not represent a - valid number in the given base (the value of @e val is not modified + pointed to by @a val or @false if the string does not represent a + valid number in the given base (the value of @a val is not modified in this case). - - The value of @e base must be comprised between 2 and 36, inclusive, or + The value of @a base must be comprised between 2 and 36, inclusive, or be a special value 0 which means that the usual rules of @c C numbers are applied: if the number starts with @c 0x it is considered to be in base 16, if it starts with @c 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. - - @sa ToDouble(), ToULong() + + @see ToDouble(), ToULong() */ - bool ToLong(long val, int base = 10); + bool ToLong(long val, int base = 10) const; /** This is exactly the same as ToLong() but works with 64 bit integer numbers. - Notice that currently it doesn't work (always returns @false) if parsing of 64 bit numbers is not supported by the underlying C run-time library. Compilers with C99 support and Microsoft Visual C++ version 7 and higher do support this. - - @sa ToLong(), ToULongLong() + + @see ToLong(), ToULongLong() */ - bool ToLongLong(wxLongLong_t val, int base = 10); + bool ToLongLong(wxLongLong_t val, int base = 10) const; /** Attempts to convert the string to an unsigned integer in base @e base. Returns @true on success in which case the number is stored in the - location pointed to by @e val or @false if the string does not - represent a valid number in the given base (the value of @e val is not + location pointed to by @a val or @false if the string does not + represent a valid number in the given base (the value of @a val is not modified in this case). Please notice that this function behaves in the same way as the standard @c strtoul() and so it simply converts negative numbers to unsigned representation instead of rejecting them (e.g. -1 is returned as @c ULONG_MAX). - See ToLong() for the more detailed - description of the @e base parameter. - - @sa ToDouble(), ToLong() + description of the @a base parameter. + + @see ToDouble(), ToLong() */ - bool ToULong(unsigned long val, int base = 10); + bool ToULong(unsigned long val, int base = 10) const; /** This is exactly the same as ToULong() but works with 64 bit integer numbers. - Please see ToLongLong() for additional remarks. */ - bool ToULongLong(wxULongLong_t val, int base = 10); + bool ToULongLong(wxULongLong_t val, int base = 10) const; //@{ /** Same as @ref wxString::utf8str utf8_str. */ - const char* ToUTF8(); - const wxCharBuffer ToUF8(); + const char* ToUTF8() const; + const const wxCharBuffer ToUF8() const; //@} /** Removes white-space (space, tabs, form feed, newline and carriage return) from the left or from the right end of the string (right is default). */ - wxString Trim(bool fromRight = @true); + wxString Trim(bool fromRight = true); /** Truncate the string to the given length. @@ -948,14 +935,12 @@ public: Puts the string back into a reasonable state (in which it can be used normally), after GetWriteBuf() was called. - - The version of the function without the @e len parameter will calculate the + The version of the function without the @a len parameter will calculate the new string length itself assuming that the string is terminated by the first @c 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 @c NULs (it is also slightly more efficient as @c strlen() doesn't have to be called). - This method is deprecated, please use wxStringBuffer or wxStringBufferLength instead. @@ -967,74 +952,43 @@ public: /** Returns this string converted to upper case. */ - wxString Upper(); + wxString Upper() const; /** The same as MakeUpper. - This is a wxWidgets 1.xx compatibility function; you should not use it in new code. */ void UpperCase(); /** - Both formatted versions (wxString::Printf) and stream-like - insertion operators exist (for basic types only). Additionally, the - Format() function allows to use simply append - formatted value to a string: - Format() - - FormatV() - - Printf() - - PrintfV() - - @ref operatorout() "operator " - */ - - - /** - Returns a pointer to the string data (@c const char* in ANSI build, - @c const wchar_t* in Unicode build). - + Returns a pointer to the string data (@c const char* when using UTF-8 + internally, @c const wchar_t* when using UCS-2 internally). Note that the returned value is not convertible to @c char* or - @c wchar_t*, use @ref charstr() char_str or - @ref wcharstr() wchar_string if you need to pass string value - to a function expecting non-const pointer. - - @sa @ref mbstr() mb_str, @ref wcstr() wc_str, @ref - fnstr() fn_str, @ref charstr() char_str, @ref - wcharstr() wchar_string + @c wchar_t*, use char_str() or wchar_str() if you need to pass + string value to a function expecting non-const pointer. */ - const wxChar * c_str(); + const wxChar* c_str() const; /** Returns an object with string data that is implicitly convertible to @c char* pointer. Note that any change to the returned buffer is lost and so this function is only usable for passing strings to legacy libraries that - don't have const-correct API. Use wxStringBuffer if - you want to modify the string. - - @sa @ref mbstr() mb_str, @ref wcstr() wc_str, @ref - fnstr() fn_str, @ref cstr() c_str, @ref - wcharstr() wchar_str + don't have const-correct API. Use wxStringBuffer if you want to modify + the string. + + @see c_str() */ - wxWritableCharBuffer char_str(const wxMBConv& conv = wxConvLibc); + wxWritableCharBuffer char_str(const wxMBConv& conv = wxConvLibc) const; //@{ /** Returns string representation suitable for passing to OS' functions for - file handling. In ANSI build, this is same as @ref cstr() c_str. - In Unicode build, returned value can be either wide character string - or C string in charset matching the @c wxConvFileName object, depending on - the OS. - - @sa wxMBConv, @ref wcstr() wc_str, @ref wcstr() mb_str + file handling. */ - const wchar_t* fn_str(); - const char* fn_str(); - const wxCharBuffer fn_str(); + const wchar_t* fn_str() const; + const const char* fn_str() const; + const const wxCharBuffer fn_str() const; //@} //@{ @@ -1044,12 +998,11 @@ public: method and returns wxCharBuffer. In ANSI build, this function is same as @ref cstr() c_str. The macro wxWX2MBbuf is defined as the correct return type (without const). - - @sa wxMBConv, @ref cstr() c_str, @ref wcstr() wc_str, @ref - fnstr() fn_str, @ref charstr() char_str + + @see wxMBConv, c_str(), wc_str(), fn_str(), char_str() */ - const char* mb_str(const wxMBConv& conv = wxConvLibc); - const wxCharBuffer mb_str(const wxMBConv& conv = wxConvLibc); + const char* mb_str(const wxMBConv& conv = wxConvLibc) const; + const const wxCharBuffer mb_str(const wxMBConv& conv = wxConvLibc) const; //@} /** @@ -1061,8 +1014,7 @@ public: /** These functions work as C++ stream insertion operators: they insert the given value into the string. Precision or format cannot be set using them, you can - use - Printf() for this. + use Printf() for this. */ wxString operator(const wxString& str); wxString operator(const wxChar* psz); @@ -1111,16 +1063,16 @@ public: /** Element extraction. */ - wxChar operator [](size_t i); - wxChar operator [](size_t i); - wxChar operator [](int i); - wxChar operator [](int i); + wxChar operator [](size_t i) const; + wxChar operator [](size_t i) const; + const wxChar operator [](int i) const; + wxChar operator [](int i) const; //@} /** Implicit conversion to a C string. */ - operator const wxChar*(); + operator const wxChar*() const; /** Empty string is @false, so !string will only return @true if the string is @@ -1128,10 +1080,9 @@ public: This allows the tests for @NULLness of a @e const wxChar * pointer and emptiness of the string to look the same in the code and makes it easier to port old code to wxString. - See also IsEmpty(). */ - bool operator!(); + bool operator!() const; /** The supported functions are only listed here, please see any STL reference for @@ -1145,23 +1096,21 @@ public: wxCharBuffer object or as a pointer to the internal string contents in UTF-8 build. */ - const char* utf8_str(); - const wxCharBuffer utf8_str(); + const char* utf8_str() const; + const const wxCharBuffer utf8_str() const; //@} //@{ /** Returns wide character representation of the string. - In ANSI build, converts using @e conv's wxMBConv::cMB2WC - method and returns wxWCharBuffer. In Unicode build, this function is same - as @ref cstr() c_str. - The macro wxWX2WCbuf is defined as the correct return type (without const). - - @sa wxMBConv, @ref cstr() c_str, @ref wcstr() mb_str, @ref - fnstr() fn_str, @ref wcharstr() wchar_str + In Unicode build, this function is same as c_str(). + The macro wxWX2WCbuf is defined as the correct return + type (without const). + + @see wxMBConv, c_str(), mb_str(), fn_str(), wchar_str() */ - const wchar_t* wc_str(const wxMBConv& conv); - const wxWCharBuffer wc_str(const wxMBConv& conv); + const wchar_t* wc_str(const wxMBConv& conv) const; + const const wxWCharBuffer wc_str(const wxMBConv& conv) const; //@} /** @@ -1170,52 +1119,28 @@ public: not be lost (depending on the build) and so this function is only usable for passing strings to legacy libraries that don't have const-correct API. Use wxStringBuffer if you want to modify the string. - - @sa @ref mbstr() mb_str, @ref wcstr() wc_str, @ref - fnstr() fn_str, @ref cstr() c_str, @ref - charstr() char_str - */ - wxWritableWCharBuffer wchar_str(); - /** - These functions are deprecated, please consider using new wxWidgets 2.0 - functions instead of them (or, even better, std::string compatible variants). - - CompareTo() - - Contains() - - First() - - Freq() - - Index() - - IsAscii() - - IsNull() - - IsNumber() - - IsWord() - - Last() - - Length() - - LowerCase() - - Remove() - - Strip() - - SubString() - - UpperCase() + @see mb_str(), wc_str(), fn_str(), c_str(), char_str() */ + wxWritableWCharBuffer wchar_str() const; + }; +/** + FIXME +*/ +wxString Objects: +; + +/** + FIXME +*/ +wxString wxEmptyString; + + + + /** @class wxStringBufferLength @wxheader{string.h} @@ -1263,7 +1188,7 @@ class wxStringBufferLength public: /** Constructs a writable string buffer object associated with the given string - and containing enough space for at least @e len characters. Basically, this + and containing enough space for at least @a len characters. Basically, this is equivalent to calling wxString::GetWriteBuf and saving the result. */ @@ -1277,8 +1202,7 @@ public: /** Sets the internal length of the string referred to by wxStringBufferLength to - @e nLength characters. - + @a nLength characters. Must be called before wxStringBufferLength destructs. */ void SetLength(size_t nLength); @@ -1287,29 +1211,6 @@ public: Returns the writable pointer to a buffer of the size at least equal to the length specified in the constructor. */ - wxChar * operator wxChar *(); + wxChar* operator wxChar *(); }; - -// ============================================================================ -// Global functions/macros -// ============================================================================ - -//@{ -/** - Converts its argument to string. - See also: wxFromString. -*/ -wxString wxToString(const wxColour& col); -wxString wxToString(const wxFont& col); -//@} - -//@{ -/** - Converts string to the type of the second argument. Returns @true on success. - See also: wxToString. -*/ -bool wxFromString(const wxString& str, wxColour* col); -bool wxFromString(const wxString& str, wxFont* col); -//@} -