X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b1801e0eb80854c1b96950de5c7082ec02346798..e433504316adbf73756f7f5e2e79564b1659ab98:/include/wx/string.h diff --git a/include/wx/string.h b/include/wx/string.h index af6c1ab17f..8c8379b0db 100644 --- a/include/wx/string.h +++ b/include/wx/string.h @@ -6,7 +6,7 @@ // Created: 29/01/98 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin -// Licence: wxWindows license +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// /* @@ -18,7 +18,7 @@ #ifndef _WX_WXSTRINGH__ #define _WX_WXSTRINGH__ -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(__APPLE__) #pragma interface "string.h" #endif @@ -101,7 +101,7 @@ const unsigned int wxSTRING_MAXLEN = UINT_MAX - 100; // ---------------------------------------------------------------------------- // global pointer to empty string -WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString; +extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxEmptyString; // --------------------------------------------------------------------------- // global functions complementing standard C string library replacements for @@ -165,17 +165,8 @@ inline int Stricmp(const char *psz1, const char *psz2) #endif // OS/compiler } -// wxSnprintf() is like snprintf() if it's available and sprintf() (always -// available, but dangerous!) if not -extern int WXDLLEXPORT wxSnprintf(wxChar *buf, size_t len, - const wxChar *format, ...); - -// and wxVsnprintf() is like vsnprintf() or vsprintf() -extern int WXDLLEXPORT wxVsnprintf(wxChar *buf, size_t len, - const wxChar *format, va_list argptr); - // return an empty wxString -class WXDLLEXPORT wxString; // not yet defined +class WXDLLIMPEXP_BASE wxString; // not yet defined inline const wxString& wxGetEmptyString() { return *(wxString *)&wxEmptyString; } // --------------------------------------------------------------------------- @@ -183,7 +174,7 @@ inline const wxString& wxGetEmptyString() { return *(wxString *)&wxEmptyString; // is never used directly (but had to be put here to allow inlining) // --------------------------------------------------------------------------- -struct WXDLLEXPORT wxStringData +struct WXDLLIMPEXP_BASE wxStringData { int nRefs; // reference count size_t nDataLength, // actual string length @@ -199,12 +190,19 @@ struct WXDLLEXPORT wxStringData // lock/unlock void Lock() { if ( !IsEmpty() ) nRefs++; } - // VC++ will refuse to inline this function but profiling shows that it - // is wrong + // VC++ will refuse to inline Unlock but profiling shows that it is wrong #if defined(__VISUALC__) && (__VISUALC__ >= 1200) __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) +#if defined(__VISUALC__) && defined(_MT) && !defined(_DLL) + void Unlock() { if ( !IsEmpty() && --nRefs == 0) Free(); } + // we must not inline deallocation since allocation is not inlined + void Free(); +#else void Unlock() { if ( !IsEmpty() && --nRefs == 0) free(this); } +#endif // if we had taken control over string memory (GetWriteBuf), it's // intentionally put in invalid state @@ -235,9 +233,9 @@ struct WXDLLEXPORT wxStringData // - regular expressions support // --------------------------------------------------------------------------- -class WXDLLEXPORT wxString +class WXDLLIMPEXP_BASE wxString { -friend class WXDLLEXPORT wxArrayString; +friend class WXDLLIMPEXP_BASE wxArrayString; // NB: special care was taken in arranging the member functions in such order // that all inline functions can be effectively inlined, verify that all @@ -267,7 +265,7 @@ private: bool AssignCopy(size_t, const wxChar *); // append a (sub)string - bool ConcatSelf(int nLen, const wxChar *src); + bool ConcatSelf(size_t nLen, const wxChar *src); // functions called before writing to the string: they copy it if there // are other references to our data (should be the only owner when writing) @@ -323,7 +321,7 @@ public: // 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 = wxConvLibc, size_t nLength = wxSTRING_MAXLEN); + wxString(const char *psz, wxMBConv& conv, size_t nLength = wxSTRING_MAXLEN); // from wxWCharBuffer (i.e. return from wxGetString) wxString(const wxWCharBuffer& psz) { InitWith(psz, 0, wxSTRING_MAXLEN); } @@ -455,14 +453,31 @@ public: // implicit conversion to C string operator const wxChar*() const { return m_pchData; } + // explicit conversion to C string (use this with printf()!) const wxChar* c_str() const { return m_pchData; } - // identical to c_str() + // identical to c_str(), for wxWin 1.6x compatibility const wxChar* wx_str() const { return m_pchData; } - // identical to c_str() + // identical to c_str(), for MFC compatibility const wxChar* GetData() const { return m_pchData; } - // conversions with (possible) format convertions: have to return a + // conversion to/from plain (i.e. 7 bit) ASCII: this is useful for + // converting numbers or strings which are certain not to contain special + // chars (typically system functions, X atoms, environment variables etc.) + // + // the behaviour of these functions with the strings containing anything + // else than 7 bit ASCII characters is undefined, use at your own risk. +#if wxUSE_UNICODE + static wxString FromAscii(const char *ascii); // string + static wxString FromAscii(const char ascii); // char + const wxCharBuffer ToAscii() const; +#else // ANSI + static wxString FromAscii(const char *ascii) { return wxString( ascii ); } + static wxString FromAscii(const char ascii) { return wxString( ascii ); } + const char *ToAscii() const { return c_str(); } +#endif // Unicode/!Unicode + + // conversions with (possible) format conversions: have to return a // buffer with temporary data // // the functions defined (in either Unicode or ANSI) mode are mb_str() to @@ -592,15 +607,15 @@ public: // non-destructive concatenation // - friend wxString WXDLLEXPORT operator+(const wxString& string1, const wxString& string2); + friend wxString WXDLLIMPEXP_BASE operator+(const wxString& string1, const wxString& string2); // - friend wxString WXDLLEXPORT operator+(const wxString& string, wxChar ch); + friend wxString WXDLLIMPEXP_BASE operator+(const wxString& string, wxChar ch); // - friend wxString WXDLLEXPORT operator+(wxChar ch, const wxString& string); + friend wxString WXDLLIMPEXP_BASE operator+(wxChar ch, const wxString& string); // - friend wxString WXDLLEXPORT operator+(const wxString& string, const wxChar *psz); + friend wxString WXDLLIMPEXP_BASE operator+(const wxString& string, const wxChar *psz); // - friend wxString WXDLLEXPORT operator+(const wxChar *psz, const wxString& string); + friend wxString WXDLLIMPEXP_BASE operator+(const wxChar *psz, const wxString& string); // stream-like functions // insert an int into string @@ -718,12 +733,13 @@ public: // formated input/output // as sprintf(), returns the number of characters written or < 0 on error - int Printf(const wxChar *pszFormat, ...); + // (take 'this' into account in attribute parameter count) + int Printf(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_2; // as vprintf(), returns the number of characters written or < 0 on error int PrintfV(const wxChar* pszFormat, va_list argptr); // returns the string containing the result of Printf() to it - static wxString Format(const wxChar *pszFormat, ...); + static wxString Format(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_1; // the same as above, but takes a va_list static wxString FormatV(const wxChar *pszFormat, va_list argptr); @@ -751,8 +767,9 @@ public: // values for first parameter of Strip function enum stripType {leading = 0x1, trailing = 0x2, both = 0x3}; - // use Printf() - int sprintf(const wxChar *pszFormat, ...); + // use Printf() + // (take 'this' into account in attribute parameter count) + int sprintf(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_2; // use Cmp() inline int CompareTo(const wxChar* psz, caseCompare cmp = exact) const @@ -793,6 +810,8 @@ public: // standard types typedef wxChar value_type; + typedef size_t size_type; + typedef value_type *iterator; typedef const value_type *const_iterator; // an 'invalid' value for string index @@ -825,7 +844,7 @@ public: // returns true if the string is empty bool empty() const { return IsEmpty(); } // inform string about planned change in size - void reserve(size_t size) { Alloc(size); } + void reserve(size_t sz) { Alloc(sz); } // lib.string.access // return the character at position n @@ -838,6 +857,11 @@ public: // position one after the last valid one const_iterator end() const { return wx_str() + length(); } + // first valid index position + iterator begin() { CopyBeforeWrite(); return m_pchData; } + // position one after the last valid one + iterator end() { CopyBeforeWrite(); return m_pchData + length(); } + // lib.string.modifiers // append a string wxString& append(const wxString& str) @@ -1003,12 +1027,19 @@ public: // from the array (operator[] or Item() method), a reference is returned. // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxArrayString +int WXDLLIMPEXP_BASE wxStringSortAscending(wxString*, wxString*); +int WXDLLIMPEXP_BASE wxStringSortDescending(wxString*, wxString*); + +class WXDLLIMPEXP_BASE wxArrayString { public: // type of function used by wxArrayString::Sort() typedef int (*CompareFunction)(const wxString& first, const wxString& second); + // type of function used by wxArrayString::Sort(), for compatibility with + // wxArray + typedef int (*CompareFunction2)(wxString* first, + wxString* second); // constructors and destructor // default ctor @@ -1071,11 +1102,13 @@ public: return Item(Count() - 1); } +#if WXWIN_COMPATIBILITY_2_4 // 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; +#endif // item management // Search the element in the array, starting from the beginning if @@ -1093,8 +1126,10 @@ public: // remove first item matching this value void Remove(const wxChar *sz); // remove item by index - void Remove(size_t nIndex, size_t nRemove = 1); - void RemoveAt(size_t nIndex, size_t nRemove = 1) { Remove(nIndex, nRemove); } +#if WXWIN_COMPATIBILITY_2_4 + void Remove(size_t nIndex, size_t nRemove = 1) { RemoveAt(nIndex, nRemove); } +#endif + void RemoveAt(size_t nIndex, size_t nRemove = 1); // sorting // sort array elements in alphabetical order (or reversed alphabetical @@ -1102,6 +1137,7 @@ public: void Sort(bool reverseOrder = FALSE); // sort array elements using specified comparaison function void Sort(CompareFunction compareFunction); + void Sort(CompareFunction2 compareFunction); // comparison // compare two arrays case sensitively @@ -1127,7 +1163,7 @@ private: bool m_autoSort; // if TRUE, keep the array always sorted }; -class WXDLLEXPORT wxSortedArrayString : public wxArrayString +class WXDLLIMPEXP_BASE wxSortedArrayString : public wxArrayString { public: wxSortedArrayString() : wxArrayString(TRUE) @@ -1140,22 +1176,22 @@ public: // wxStringBuffer: a tiny class allowing to get a writable pointer into string // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxStringBuffer +class WXDLLIMPEXP_BASE wxStringBuffer { - DECLARE_NO_COPY_CLASS(wxStringBuffer) - public: wxStringBuffer(wxString& str, size_t lenWanted = 1024) : m_str(str), m_buf(NULL) { m_buf = m_str.GetWriteBuf(lenWanted); } - + ~wxStringBuffer() { m_str.UngetWriteBuf(); } - + operator wxChar*() const { return m_buf; } - + private: wxString& m_str; wxChar *m_buf; + + DECLARE_NO_COPY_CLASS(wxStringBuffer) }; // --------------------------------------------------------------------------- @@ -1225,11 +1261,11 @@ inline bool operator!=(const wxCharBuffer& s1, const wxString& s2) { return (s2.Cmp((const char *)s1) != 0); } #endif // wxUSE_UNICODE/!wxUSE_UNICODE -wxString WXDLLEXPORT operator+(const wxString& string1, const wxString& string2); -wxString WXDLLEXPORT operator+(const wxString& string, wxChar ch); -wxString WXDLLEXPORT operator+(wxChar ch, const wxString& string); -wxString WXDLLEXPORT operator+(const wxString& string, const wxChar *psz); -wxString WXDLLEXPORT operator+(const wxChar *psz, const wxString& string); +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); #if wxUSE_UNICODE inline wxString operator+(const wxString& string, const wxWCharBuffer& buf) { return string + (const wchar_t *)buf; } @@ -1251,10 +1287,10 @@ inline wxString operator+(const wxCharBuffer& buf, const wxString& string) #if defined(wxSTD_STRING_COMPATIBILITY) && wxUSE_STD_IOSTREAM -#include "wx/ioswrap.h" +#include "wx/iosfwrap.h" -WXDLLEXPORT wxSTD istream& operator>>(wxSTD istream&, wxString&); -WXDLLEXPORT wxSTD ostream& operator<<(wxSTD ostream&, const wxString&); +WXDLLIMPEXP_BASE wxSTD istream& operator>>(wxSTD istream&, wxString&); +WXDLLIMPEXP_BASE wxSTD ostream& operator<<(wxSTD ostream&, const wxString&); #endif // wxSTD_STRING_COMPATIBILITY