X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6e94fff95aea3738611fb9c251e1ff089ea2eaff..9cc311d32c3eeca78030e3c45d7829f1059befcc:/include/wx/string.h diff --git a/include/wx/string.h b/include/wx/string.h index dc0d6497dd..4162fe4fc8 100644 --- a/include/wx/string.h +++ b/include/wx/string.h @@ -1,5 +1,5 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: string.h +// Name: wx/string.h // Purpose: wxString and wxArrayString classes // Author: Vadim Zeitlin // Modified by: @@ -11,7 +11,7 @@ /* Efficient string class [more or less] compatible with MFC CString, - wxWindows version 1 wxString and std::string and some handy functions + wxWidgets version 1 wxString and std::string and some handy functions missing from string.h. */ @@ -47,14 +47,20 @@ # include #endif -#ifdef HAVE_STRINGS_H +#ifdef HAVE_STRCASECMP_IN_STRINGS_H #include // for strcasecmp() -#endif // HAVE_STRINGS_H +#endif // HAVE_STRCASECMP_IN_STRINGS_H + +#ifdef __WXPALMOS__ + #include +#endif #include "wx/wxchar.h" // for wxChar #include "wx/buffer.h" // for wxCharBuffer #include "wx/strconv.h" // for wxConvertXXX() macros and wxMBConv classes +class WXDLLIMPEXP_BASE wxString; + // --------------------------------------------------------------------------- // macros // --------------------------------------------------------------------------- @@ -74,16 +80,8 @@ // constants // ---------------------------------------------------------------------------- -#if defined(__VISAGECPP__) && __IBMCPP__ >= 400 -// must define this static for VA or else you get multiply defined symbols everywhere -extern const unsigned int wxSTRING_MAXLEN; - -#else // maximum possible length for a string means "take all string" everywhere -// (as sizeof(StringData) is unknown here, we substract 100) -const unsigned int wxSTRING_MAXLEN = UINT_MAX - 100; - -#endif +#define wxSTRING_MAXLEN wxStringBase::npos // ---------------------------------------------------------------------------- // global data @@ -134,7 +132,10 @@ inline int Stricmp(const char *psz1, const char *psz2) return stricmp(psz1, psz2); #elif defined(__WXPM__) return stricmp(psz1, psz2); -#elif defined(__UNIX__) || defined(__GNUWIN32__) +#elif defined(__WXPALMOS__) || \ + defined(HAVE_STRCASECMP_IN_STRING_H) || \ + defined(HAVE_STRCASECMP_IN_STRINGS_H) || \ + defined(__GNUWIN32__) return strcasecmp(psz1, psz2); #elif defined(__MWERKS__) && !defined(__INTEL__) register char c1, c2; @@ -162,10 +163,6 @@ inline int Stricmp(const char *psz1, const char *psz2) #endif // OS/compiler } -// return an empty wxString -class WXDLLIMPEXP_BASE wxString; // not yet defined -inline const wxString& wxGetEmptyString() { return *(wxString *)&wxEmptyString; } - #if wxUSE_STL #include "wx/beforestd.h" @@ -216,7 +213,7 @@ struct WXDLLIMPEXP_BASE wxStringData // VC++ will refuse to inline Unlock but profiling shows that it is wrong #if defined(__VISUALC__) && (__VISUALC__ >= 1200) - __forceinline + __forceinline #endif // VC++ free must take place in same DLL as allocation when using non dll // run-time library (e.g. Multithreaded instead of Multithreaded DLL) @@ -331,21 +328,21 @@ public: wxStringBase(const void *pStart, const void *pEnd); // dtor is not virtual, this class must not be inherited from! - ~wxStringBase() - { + ~wxStringBase() + { #if defined(__VISUALC__) && (__VISUALC__ >= 1200) - //RN - according to the above VC++ does indeed inline this, - //even though it spits out two warnings - #pragma warning (disable:4714) + //RN - according to the above VC++ does indeed inline this, + //even though it spits out two warnings + #pragma warning (disable:4714) #endif - GetStringData()->Unlock(); + GetStringData()->Unlock(); } #if defined(__VISUALC__) && (__VISUALC__ >= 1200) - //re-enable inlining warning - #pragma warning (default:4714) -#endif + //re-enable inlining warning + #pragma warning (default:4714) +#endif // overloaded assignment // from another wxString wxStringBase& operator=(const wxStringBase& stringSrc); @@ -427,9 +424,9 @@ public: const_iterator end() const { return m_pchData + length(); } // first valid index position - iterator begin() { CopyBeforeWrite(); return m_pchData; } + iterator begin(); // position one after the last valid one - iterator end() { CopyBeforeWrite(); return m_pchData + length(); } + iterator end(); // insert another string wxStringBase& insert(size_t nPos, const wxStringBase& str) @@ -452,7 +449,7 @@ public: wxStringBase& insert(size_t nPos, size_t n, wxChar ch) { return insert(nPos, wxStringBase(n, ch)); } iterator insert(iterator it, wxChar ch) - { size_t idx = it - begin(); insert(idx, 1, ch); return begin() + idx; } + { size_t idx = it - begin(); insert(idx, 1, ch); return begin() + idx; } void insert(iterator it, const_iterator first, const_iterator last) { insert(it - begin(), first, last - first); } void insert(iterator it, size_type n, wxChar ch) @@ -572,17 +569,15 @@ public: // All compare functions return -1, 0 or 1 if the [sub]string is less, // equal or greater than the compare() argument. - // just like strcmp() - int compare(const wxStringBase& str) const - { return wxStrcmp(c_str(), str.c_str()); } + // comparison with another string + int compare(const wxStringBase& str) const; // comparison with a substring int compare(size_t nStart, size_t nLen, const wxStringBase& str) const; // comparison of 2 substrings int compare(size_t nStart, size_t nLen, const wxStringBase& str, size_t nStart2, size_t nLen2) const; - // just like strcmp() - int compare(const wxChar* sz) const - { return wxStrcmp(c_str(), sz); } + // comparison with a c string + int compare(const wxChar* sz) const; // substring comparison with first nCount characters of sz int compare(size_t nStart, size_t nLen, const wxChar* sz, size_t nCount = npos) const; @@ -602,27 +597,9 @@ public: #endif // !wxUSE_STL -// --------------------------------------------------------------------------- -// This is (yet another one) String class for C++ programmers. It doesn't use -// any of "advanced" C++ features (i.e. templates, exceptions, namespaces...) -// thus you should be able to compile it with practicaly any C++ compiler. -// This class uses copy-on-write technique, i.e. identical strings share the -// same memory as long as neither of them is changed. -// -// This class aims to be as compatible as possible with the new standard -// std::string class, but adds some additional functions and should be at -// least as efficient than the standard implementation. -// -// Performance note: it's more efficient to write functions which take "const -// String&" arguments than "const char *" if you assign the argument to -// another string. -// -// It was compiled and tested under Win32, Linux (libc 5 & 6), Solaris 5.5. -// -// To do: -// - ressource support (string tables in ressources) -// - more wide character (UNICODE) support -// - regular expressions support +// ---------------------------------------------------------------------------- +// wxString: string class trying to be compatible with std::string, MFC +// CString and wxWindows 1.x wxString all at once // --------------------------------------------------------------------------- class WXDLLIMPEXP_BASE wxString : public wxStringBase @@ -673,8 +650,6 @@ public: #if wxUSE_UNICODE // from multibyte string - // (NB: nLength is right now number of Unicode characters, not - // characters in psz! So try not to use it yet!) wxString(const char *psz, wxMBConv& conv, size_t nLength = npos); // from wxWCharBuffer (i.e. return from wxGetString) wxString(const wxWCharBuffer& psz) : wxStringBase(psz.data()) { } @@ -690,7 +665,7 @@ public: // from wxCharBuffer wxString(const wxCharBuffer& psz) - : wxStringBase(psz, npos) { } + : wxStringBase(psz) { } #endif // Unicode/ANSI // generic attributes & operations @@ -698,7 +673,7 @@ public: size_t Len() const { return length(); } // string contains any characters? bool IsEmpty() const { return empty(); } - // empty string is "FALSE", so !str will return TRUE + // empty string is "false", so !str will return true bool operator!() const { return IsEmpty(); } // truncate the string to given length wxString& Truncate(size_t uiLen); @@ -823,8 +798,7 @@ public: // type differs because a function may either return pointer to the buffer // directly or have to use intermediate buffer for translation. #if wxUSE_UNICODE - const wxCharBuffer mb_str(wxMBConv& conv = wxConvLibc) const - { return conv.cWC2MB(c_str()); } + const wxCharBuffer mb_str(wxMBConv& conv = wxConvLibc) const; const wxWX2MBbuf mbc_str() const { return mb_str(*wxConvCurrent); } @@ -847,11 +821,13 @@ public: const wxWX2MBbuf mbc_str() const { return mb_str(); } #if wxUSE_WCHAR_T - const wxWCharBuffer wc_str(wxMBConv& conv) const - { return conv.cMB2WC(c_str()); } + const wxWCharBuffer wc_str(wxMBConv& conv) const; #endif // wxUSE_WCHAR_T - +#ifdef __WXOSX__ + const wxCharBuffer fn_str() const { return wxConvFile.cWC2WX( wc_str( wxConvLocal ) ); } +#else const wxChar* fn_str() const { return c_str(); } +#endif #endif // Unicode/ANSI // overloaded assignment @@ -973,15 +949,17 @@ public: // string comparison // case-sensitive comparison (returns a value < 0, = 0 or > 0) - int Cmp(const wxChar *psz) const { return wxStrcmp(c_str(), psz); } + int Cmp(const wxChar *psz) const; + int Cmp(const wxString& s) const; // same as Cmp() but not case-sensitive - int CmpNoCase(const wxChar *psz) const { return wxStricmp(c_str(), psz); } + int CmpNoCase(const wxChar *psz) const; + int CmpNoCase(const wxString& s) const; // test for the string equality, either considering case or not // (if compareWithCase then the case matters) - bool IsSameAs(const wxChar *psz, bool compareWithCase = TRUE) const + bool IsSameAs(const wxChar *psz, bool compareWithCase = true) const { return (compareWithCase ? Cmp(psz) : CmpNoCase(psz)) == 0; } - // comparison with a signle character: returns TRUE if equal - bool IsSameAs(wxChar c, bool compareWithCase = TRUE) const + // comparison with a signle character: returns true if equal + bool IsSameAs(wxChar c, bool compareWithCase = true) const { return (length() == 1) && (compareWithCase ? GetChar(0u) == c : wxToupper(GetChar(0u)) == wxToupper(c)); @@ -998,7 +976,7 @@ public: // check that the string starts with prefix and return the rest of the // string in the provided pointer if it is not NULL, otherwise return - // FALSE + // false bool StartsWith(const wxChar *prefix, wxString *rest = NULL) const; // get first nCount characters @@ -1035,25 +1013,25 @@ public: // trimming/padding whitespace (either side) and truncating // remove spaces from left or from right (default) side - wxString& Trim(bool bFromRight = TRUE); + wxString& Trim(bool bFromRight = true); // add nCount copies chPad in the beginning or at the end (default) - wxString& Pad(size_t nCount, wxChar chPad = wxT(' '), bool bFromRight = TRUE); + wxString& Pad(size_t nCount, wxChar chPad = wxT(' '), bool bFromRight = true); // searching and replacing // searching (return starting index, or -1 if not found) - int Find(wxChar ch, bool bFromEnd = FALSE) const; // like strchr/strrchr + int Find(wxChar ch, bool bFromEnd = false) const; // like strchr/strrchr // searching (return starting index, or -1 if not found) int Find(const wxChar *pszSub) const; // like strstr // replace first (or all of bReplaceAll) occurences of substring with // another string, returns the number of replacements made size_t Replace(const wxChar *szOld, const wxChar *szNew, - bool bReplaceAll = TRUE); + bool bReplaceAll = true); // 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 + // 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 @@ -1093,7 +1071,7 @@ public: void UngetWriteBuf(size_t nLen); #endif - // wxWindows version 1 compatibility functions + // wxWidgets version 1 compatibility functions // use Mid() wxString SubString(size_t from, size_t to) const @@ -1136,8 +1114,8 @@ public: int First( const wxChar ch ) const { return Find(ch); } int First( const wxChar* psz ) const { return Find(psz); } int First( const wxString &str ) const { return Find(str); } - int Last( const wxChar ch ) const { return Find(ch, TRUE); } - bool Contains(const wxString& str) const { return Find(str) != -1; } + int Last( const wxChar ch ) const { return Find(ch, true); } + bool Contains(const wxString& str) const { return Find(str) != wxNOT_FOUND; } // use IsEmpty() bool IsNull() const { return IsEmpty(); } @@ -1222,7 +1200,7 @@ public: wxString& insert(size_t nPos, size_t n, wxChar ch) { return (wxString&)wxStringBase::insert(nPos, n, ch); } iterator insert(iterator it, wxChar ch) - { return wxStringBase::insert(it, ch); } + { return wxStringBase::insert(it, ch); } void insert(iterator it, const_iterator first, const_iterator last) { wxStringBase::insert(it, first, last); } void insert(iterator it, size_type n, wxChar ch) @@ -1287,6 +1265,17 @@ public: #include "wx/arrstr.h" #endif +#if wxUSE_STL + // return an empty wxString (not very useful with wxUSE_STL == 1) + inline const wxString wxGetEmptyString() { return wxString(); } +#else // !wxUSE_STL + // return an empty wxString (more efficient than wxString() here) + inline const wxString& wxGetEmptyString() + { + return *(wxString *)&wxEmptyString; + } +#endif // wxUSE_STL/!wxUSE_STL + // ---------------------------------------------------------------------------- // wxStringBuffer: a tiny class allowing to get a writable pointer into string // ---------------------------------------------------------------------------- @@ -1369,7 +1358,10 @@ class WXDLLIMPEXP_BASE wxStringBufferLength public: wxStringBufferLength(wxString& str, size_t lenWanted = 1024) : m_str(str), m_buf(NULL), m_len(0), m_lenSet(false) - { m_buf = m_str.GetWriteBuf(lenWanted); } + { + m_buf = m_str.GetWriteBuf(lenWanted); + wxASSERT(m_buf != NULL); + } ~wxStringBufferLength() { @@ -1395,46 +1387,10 @@ private: // wxString comparison functions: operator versions are always case sensitive // --------------------------------------------------------------------------- -#if wxUSE_STL - -inline bool operator==(const wxString& s1, const wxString& s2) - { return s1.compare(s2) == 0; } -inline bool operator==(const wxString& s1, const wxChar * s2) - { return s1.compare(s2) == 0; } -inline bool operator==(const wxChar * s1, const wxString& s2) - { return s2.compare(s1) == 0; } -inline bool operator!=(const wxString& s1, const wxString& s2) - { return s1.compare(s2) != 0; } -inline bool operator!=(const wxString& s1, const wxChar * s2) - { return s1.compare(s2) != 0; } -inline bool operator!=(const wxChar * s1, const wxString& s2) - { return s2.compare(s1) != 0; } -inline bool operator< (const wxString& s1, const wxString& s2) - { return s1.compare(s2) < 0; } -inline bool operator< (const wxString& s1, const wxChar * s2) - { return s1.compare(s2) < 0; } -inline bool operator< (const wxChar * s1, const wxString& s2) - { return s2.compare(s1) > 0; } -inline bool operator> (const wxString& s1, const wxString& s2) - { return s1.compare(s2) > 0; } -inline bool operator> (const wxString& s1, const wxChar * s2) - { return s1.compare(s2) > 0; } -inline bool operator> (const wxChar * s1, const wxString& s2) - { return s2.compare(s1) < 0; } -inline bool operator<=(const wxString& s1, const wxString& s2) - { return s1.compare(s2) <= 0; } -inline bool operator<=(const wxString& s1, const wxChar * s2) - { return s1.compare(s2) <= 0; } -inline bool operator<=(const wxChar * s1, const wxString& s2) - { return s2.compare(s1) >= 0; } -inline bool operator>=(const wxString& s1, const wxString& s2) - { return s1.compare(s2) >= 0; } -inline bool operator>=(const wxString& s1, const wxChar * s2) - { return s1.compare(s2) >= 0; } -inline bool operator>=(const wxChar * s1, const wxString& s2) - { return s2.compare(s1) <= 0; } - -#else // if !wxUSE_STL +// note that when wxUSE_STL == 1 the comparison operators taking std::string +// are used and defining them also for wxString would only result in +// compilation ambiguities when comparing std::string and wxString +#if !wxUSE_STL inline bool operator==(const wxString& s1, const wxString& s2) { return (s1.Len() == s2.Len()) && (s1.Cmp(s2) == 0); } @@ -1473,14 +1429,6 @@ inline bool operator>=(const wxString& s1, const wxChar * s2) inline bool operator>=(const wxChar * s1, const wxString& s2) { return s2.Cmp(s1) <= 0; } -#endif // !wxUSE_STL - -// comparison with char -inline bool operator==(wxChar c, const wxString& s) { return s.IsSameAs(c); } -inline bool operator==(const wxString& s, wxChar c) { return s.IsSameAs(c); } -inline bool operator!=(wxChar c, const wxString& s) { return !s.IsSameAs(c); } -inline bool operator!=(const wxString& s, wxChar c) { return !s.IsSameAs(c); } - #if wxUSE_UNICODE inline bool operator==(const wxString& s1, const wxWCharBuffer& s2) { return (s1.Cmp((const wchar_t *)s2) == 0); } @@ -1501,16 +1449,12 @@ inline bool operator!=(const wxCharBuffer& s1, const wxString& s2) { return (s2.Cmp((const char *)s1) != 0); } #endif // wxUSE_UNICODE/!wxUSE_UNICODE -#if !wxUSE_STL - wxString WXDLLIMPEXP_BASE operator+(const wxString& string1, const wxString& string2); wxString WXDLLIMPEXP_BASE operator+(const wxString& string, wxChar ch); wxString WXDLLIMPEXP_BASE operator+(wxChar ch, const wxString& string); wxString WXDLLIMPEXP_BASE operator+(const wxString& string, const wxChar *psz); wxString WXDLLIMPEXP_BASE operator+(const wxChar *psz, const wxString& string); -#endif // !wxUSE_STL - #if wxUSE_UNICODE inline wxString operator+(const wxString& string, const wxWCharBuffer& buf) { return string + (const wchar_t *)buf; } @@ -1523,6 +1467,15 @@ inline wxString operator+(const wxCharBuffer& buf, const wxString& string) { return (const char *)buf + string; } #endif // wxUSE_UNICODE/!wxUSE_UNICODE +#endif // !wxUSE_STL + +// comparison with char (those are not defined by std::[w]string and so should +// be always available) +inline bool operator==(wxChar c, const wxString& s) { return s.IsSameAs(c); } +inline bool operator==(const wxString& s, wxChar c) { return s.IsSameAs(c); } +inline bool operator!=(wxChar c, const wxString& s) { return !s.IsSameAs(c); } +inline bool operator!=(const wxString& s, wxChar c) { return !s.IsSameAs(c); } + // --------------------------------------------------------------------------- // Implementation only from here until the end of file // ---------------------------------------------------------------------------