X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/147043343ea6b36fd07f786ab4c5d2d6f6be09e6..3f0fb1d4165f622ab392a28c1a08a975aa7c5378:/include/wx/string.h diff --git a/include/wx/string.h b/include/wx/string.h index 098df32cf7..e36f11b7ec 100644 --- a/include/wx/string.h +++ b/include/wx/string.h @@ -29,15 +29,12 @@ // compile the std::string compatibility functions if defined #define wxSTD_STRING_COMPATIBILITY -// define to derive wxString from wxObject (deprecated!) -#ifdef WXSTRING_IS_WXOBJECT - #undef WXSTRING_IS_WXOBJECT -#endif - // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- +#include "wx/defs.h" // everybody should include this + #if defined(__WXMAC__) || defined(__VISAGECPP__) #include #endif @@ -65,29 +62,24 @@ #include // for strcasecmp() #endif // HAVE_STRINGS_H -#include "wx/defs.h" // everybody should include this #include "wx/wxchar.h" // for wxChar #include "wx/buffer.h" // for wxCharBuffer #include "wx/strconv.h" // for wxConvertXXX() macros and wxMBConv classes -#ifndef WX_PRECOMP - #ifdef WXSTRING_IS_WXOBJECT - #include "wx/object.h" // base class - #endif -#endif // !PCH - // --------------------------------------------------------------------------- // macros // --------------------------------------------------------------------------- -// 'naughty' cast +// casts [unfortunately!] needed to call some broken functions which require +// "char *" instead of "const char *" #define WXSTRINGCAST (wxChar *)(const wxChar *) #define wxCSTRINGCAST (wxChar *)(const wxChar *) #define wxMBSTRINGCAST (char *)(const char *) #define wxWCSTRINGCAST (wchar_t *)(const wchar_t *) // implementation only -#define ASSERT_VALID_INDEX(i) wxASSERT( (unsigned)(i) <= Len() ) +#define wxASSERT_VALID_INDEX(i) \ + wxASSERT_MSG( (size_t)(i) <= Len(), _T("invaid index in wxString") ) // ---------------------------------------------------------------------------- // constants @@ -243,15 +235,8 @@ struct WXDLLEXPORT wxStringData // - regular expressions support // --------------------------------------------------------------------------- -#ifdef WXSTRING_IS_WXOBJECT -class WXDLLEXPORT wxString : public wxObject -{ - DECLARE_DYNAMIC_CLASS(wxString) -#else //WXSTRING_IS_WXOBJECT class WXDLLEXPORT wxString { -#endif //WXSTRING_IS_WXOBJECT - friend class WXDLLEXPORT wxArrayString; // NB: special care was taken in arranging the member functions in such order @@ -311,7 +296,8 @@ public: // copy ctor wxString(const wxString& stringSrc) { - wxASSERT( stringSrc.GetStringData()->IsValid() ); + wxASSERT_MSG( stringSrc.GetStringData()->IsValid(), + _T("did you forget to call UngetWriteBuf()?") ); if ( stringSrc.IsEmpty() ) { // nothing to do for an empty string @@ -346,7 +332,7 @@ public: #if wxUSE_WCHAR_T // from wide (Unicode) string - wxString(const wchar_t *pwz, wxMBConv& conv = wxConvLibc); + wxString(const wchar_t *pwz, wxMBConv& conv = wxConvLibc, size_t nLength = wxSTRING_MAXLEN); #endif // !wxUSE_WCHAR_T // from wxCharBuffer @@ -379,8 +365,9 @@ public: if ( !GetStringData()->IsEmpty() ) Reinit(); - wxASSERT( GetStringData()->nDataLength == 0 ); // should be empty - wxASSERT( GetStringData()->nAllocLength == 0 ); // and not own any memory + wxASSERT_MSG( !GetStringData()->nDataLength && + !GetStringData()->nAllocLength, + _T("string should be empty after Clear()") ); } // contents test @@ -394,20 +381,29 @@ public: // data access (all indexes are 0 based) // read access wxChar GetChar(size_t n) const - { ASSERT_VALID_INDEX( n ); return m_pchData[n]; } + { wxASSERT_VALID_INDEX( n ); return m_pchData[n]; } // read/write access wxChar& GetWritableChar(size_t n) - { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; } + { wxASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; } // write access void SetChar(size_t n, wxChar ch) - { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); m_pchData[n] = ch; } + { wxASSERT_VALID_INDEX( n ); CopyBeforeWrite(); m_pchData[n] = ch; } // get last character wxChar Last() const - { wxASSERT( !IsEmpty() ); return m_pchData[Len() - 1]; } + { + wxASSERT_MSG( !IsEmpty(), _T("wxString: index out of bounds") ); + + return m_pchData[Len() - 1]; + } + // get writable last character wxChar& Last() - { wxASSERT( !IsEmpty() ); CopyBeforeWrite(); return m_pchData[Len()-1]; } + { + wxASSERT_MSG( !IsEmpty(), _T("wxString: index out of bounds") ); + CopyBeforeWrite(); + return m_pchData[Len()-1]; + } /* So why do we have all these overloaded operator[]s? A bit of history: @@ -433,24 +429,24 @@ public: // operator version of GetChar wxChar operator[](size_t n) const - { ASSERT_VALID_INDEX( n ); return m_pchData[n]; } + { wxASSERT_VALID_INDEX( n ); return m_pchData[n]; } // operator version of GetChar wxChar operator[](int n) const - { ASSERT_VALID_INDEX( n ); return m_pchData[n]; } + { wxASSERT_VALID_INDEX( n ); return m_pchData[n]; } // operator version of GetWriteableChar wxChar& operator[](size_t n) - { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; } + { wxASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; } #ifndef wxSIZE_T_IS_UINT // operator version of GetChar wxChar operator[](unsigned int n) const - { ASSERT_VALID_INDEX( n ); return m_pchData[n]; } + { wxASSERT_VALID_INDEX( n ); return m_pchData[n]; } // operator version of GetWriteableChar wxChar& operator[](unsigned int n) - { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; } + { wxASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; } #endif // size_t != unsigned int // implicit conversion to C string @@ -534,7 +530,8 @@ public: // string += string wxString& operator<<(const wxString& s) { - wxASSERT( s.GetStringData()->IsValid() ); + wxASSERT_MSG( s.GetStringData()->IsValid(), + _T("did you forget to call UngetWriteBuf()?") ); ConcatSelf(s.Len(), s); return *this; @@ -554,14 +551,27 @@ public: // string += buffer (i.e. from wxGetString) #if wxUSE_UNICODE - wxString& operator<<(const wxWCharBuffer& s) { (void)operator<<((const wchar_t *)s); return *this; } - void operator+=(const wxWCharBuffer& s) { (void)operator<<((const wchar_t *)s); } -#else - wxString& operator<<(const wxCharBuffer& s) { (void)operator<<((const char *)s); return *this; } - void operator+=(const wxCharBuffer& s) { (void)operator<<((const char *)s); } -#endif + wxString& operator<<(const wxWCharBuffer& s) + { (void)operator<<((const wchar_t *)s); return *this; } + void operator+=(const wxWCharBuffer& s) + { (void)operator<<((const wchar_t *)s); } +#else // !wxUSE_UNICODE + wxString& operator<<(const wxCharBuffer& s) + { (void)operator<<((const char *)s); return *this; } + void operator+=(const wxCharBuffer& s) + { (void)operator<<((const char *)s); } +#endif // wxUSE_UNICODE/!wxUSE_UNICODE // string += C string + wxString& Append(const wxString& s) + { + // test for IsEmpty() to share the string if possible + if ( IsEmpty() ) + *this = s; + else + ConcatSelf(s.Length(), s.c_str()); + return *this; + } wxString& Append(const wxChar* psz) { ConcatSelf(wxStrlen(psz), psz); return *this; } // append count copies of given character @@ -688,12 +698,15 @@ public: // check if the string contents matches a mask containing '*' and '?' bool Matches(const wxChar *szMask) const; - // conversion to numbers: all functions return TRUE only if the whole string - // is a number and put the value of this number into the pointer provided + // conversion to numbers: all functions return TRUE only if the whole + // string is a number and put the value of this number into the pointer + // provided, the base is the numeric base in which the conversion should be + // done and must be comprised between 2 and 36 or be 0 in which case the + // standard C rules apply (leading '0' => octal, "0x" => hex) // convert to a signed integer - bool ToLong(long *val, int base = 0) const; + bool ToLong(long *val, int base = 10) const; // convert to an unsigned integer - bool ToULong(unsigned long *val, int base = 0) const; + bool ToULong(unsigned long *val, int base = 10) const; // convert to a double bool ToDouble(double *val) const; @@ -783,7 +796,9 @@ public: // take nLen chars starting at nPos wxString(const wxString& str, size_t nPos, size_t nLen) { - wxASSERT( str.GetStringData()->IsValid() ); + wxASSERT_MSG( str.GetStringData()->IsValid(), + _T("did you forget to call UngetWriteBuf()?") ); + InitWith(str.c_str(), nPos, nLen == npos ? 0 : nLen); } // take all characters from pStart to pEnd @@ -989,9 +1004,17 @@ public: const wxString& second); // constructors and destructor - // default ctor: if autoSort is TRUE, the array is always sorted (in - // alphabetical order) - wxArrayString(bool autoSort = FALSE); + // default ctor + wxArrayString() { Init(FALSE); } + // if autoSort is TRUE, the array is always sorted (in alphabetical order) + // + // NB: the reason for using int and not bool is that like this we can avoid + // using this ctor for implicit conversions from "const char *" (which + // we'd like to be implicitly converted to wxString instead!) + // + // of course, using explicit would be even better - if all compilers + // supported it... + wxArrayString(int autoSort) { Init(autoSort != 0); } // copy ctor wxArrayString(const wxArrayString& array); // assignment operator @@ -1020,11 +1043,28 @@ public: // items access (range checking is done in debug version) // get item at position uiIndex wxString& Item(size_t nIndex) const - { wxASSERT( nIndex < m_nCount ); return *(wxString *)&(m_pItems[nIndex]); } + { + wxASSERT_MSG( nIndex < m_nCount, + _T("wxArrayString: index out of bounds") ); + + return *(wxString *)&(m_pItems[nIndex]); + } + // same as Item() wxString& operator[](size_t nIndex) const { return Item(nIndex); } // get last item - wxString& Last() const { wxASSERT( !IsEmpty() ); return Item(Count() - 1); } + wxString& Last() const + { + wxASSERT_MSG( !IsEmpty(), + _T("wxArrayString: index out of bounds") ); + return Item(Count() - 1); + } + + // return a wxString[], useful for the controls which + // take one in their ctor. You must delete[] it yourself + // once you are done with it. Will return NULL if the + // ArrayString was empty. + wxString* GetStringArray() const; // item management // Search the element in the array, starting from the beginning if @@ -1034,16 +1074,16 @@ public: int Index (const wxChar *sz, bool bCase = TRUE, bool bFromEnd = FALSE) const; // add new element at the end (if the array is not sorted), return its // index - size_t Add(const wxString& str); + size_t Add(const wxString& str, size_t nInsert = 1); // add new element at given position - void Insert(const wxString& str, size_t uiIndex); + void Insert(const wxString& str, size_t uiIndex, size_t nInsert = 1); // expand the array to have count elements void SetCount(size_t count); // remove first item matching this value void Remove(const wxChar *sz); // remove item by index - void Remove(size_t nIndex); - void RemoveAt(size_t nIndex) { Remove(nIndex); } + void Remove(size_t nIndex, size_t nRemove = 1); + void RemoveAt(size_t nIndex, size_t nRemove = 1) { Remove(nIndex, nRemove); } // sorting // sort array elements in alphabetical order (or reversed alphabetical @@ -1059,10 +1099,11 @@ public: bool operator!=(const wxArrayString& a) const { return !(*this == a); } protected: + void Init(bool autoSort); // common part of all ctors void Copy(const wxArrayString& src); // copies the contents of another array private: - void Grow(); // makes array bigger if needed + void Grow(size_t nIncrement = 0); // makes array bigger if needed void Free(); // free all the strings stored void DoSort(); // common part of all Sort() variants @@ -1192,7 +1233,7 @@ inline wxString operator+(const wxCharBuffer& buf, const wxString& string) // --------------------------------------------------------------------------- // don't pollute the library user's name space -#undef ASSERT_VALID_INDEX +#undef wxASSERT_VALID_INDEX #if defined(wxSTD_STRING_COMPATIBILITY) && wxUSE_STD_IOSTREAM