X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6b95b20d03620ba6807ba0e42bf3347a802ca725..695237bccd652c60deba347117ba5ab32067880c:/include/wx/string.h diff --git a/include/wx/string.h b/include/wx/string.h index 7aa6819b92..1b0c138ea9 100644 --- a/include/wx/string.h +++ b/include/wx/string.h @@ -1,94 +1,159 @@ -///////////////////////////////////////////////////////////////////////////// +/////////////////////////////////////////////////////////////////////////////// // Name: string.h -// Purpose: wxString class +// Purpose: wxString and wxArrayString classes // Author: Vadim Zeitlin // Modified by: // Created: 29/01/98 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin // Licence: wxWindows license -///////////////////////////////////////////////////////////////////////////// +/////////////////////////////////////////////////////////////////////////////// -#ifndef __WXSTRINGH__ -#define __WXSTRINGH__ +/* + Efficient string class [more or less] compatible with MFC CString, + wxWindows version 1 wxString and std::string and some handy functions + missing from string.h. +*/ + +#ifndef _WX_WXSTRINGH__ +#define _WX_WXSTRINGH__ #ifdef __GNUG__ -#pragma interface "string.h" + #pragma interface "string.h" #endif -/* Dependencies (should be included before this header): - * string.h - * stdio.h - * stdarg.h - * limits.h - */ -#include -#include -#include -#include -#include +// ---------------------------------------------------------------------------- +// conditinal compilation +// ---------------------------------------------------------------------------- + +// compile the std::string compatibility functions if defined +#define wxSTD_STRING_COMPATIBILITY -#ifndef WX_PRECOMP - #include "wx/defs.h" // Robert Roebling - #ifdef WXSTRING_IS_WXOBJECT - #include "wx/object.h" - #endif +// define to derive wxString from wxObject (deprecated!) +#ifdef WXSTRING_IS_WXOBJECT + #undef WXSTRING_IS_WXOBJECT #endif -#include "wx/debug.h" +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- -/** @name wxString library - @memo Efficient wxString class [more or less] compatible with MFC CString, - wxWindows wxString and std::string and some handy functions - missing from string.h. - */ -//@{ +#if defined(__WXMAC__) || defined(__VISAGECPP__) + #include +#endif + +#ifdef __EMX__ + #include +#endif + +#if defined(__VISAGECPP__) && __IBMCPP__ >= 400 + // problem in VACPP V4 with including stdlib.h multiple times + // strconv includes it anyway +# include +# include +# include +# include +#else +# include +# include +# include +# include +# include +#endif + +#ifdef HAVE_STRINGS_H + #include // for strcasecmp() +#endif // AIX + +#include "wx/defs.h" // everybody should include this +#include "wx/debug.h" // for wxASSERT() +#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 // --------------------------------------------------------------------------- -/** @name Macros - @memo You can switch off wxString/std::string compatibility if desired - */ -/// compile the std::string compatibility functions -#define STD_STRING_COMPATIBILITY +// 'naughty' cast +#define WXSTRINGCAST (wxChar *)(const wxChar *) +#define wxCSTRINGCAST (wxChar *)(const wxChar *) +#define wxMBSTRINGCAST (char *)(const char *) +#define wxWCSTRINGCAST (wchar_t *)(const wchar_t *) -/// define to derive wxString from wxObject -#undef WXSTRING_IS_WXOBJECT +// implementation only +#define ASSERT_VALID_INDEX(i) wxASSERT( (unsigned)(i) <= Len() ) -/// maximum possible length for a string means "take all string" everywhere -// (as sizeof(StringData) is unknown here we substract 100) -#define STRING_MAXLEN (UINT_MAX - 100) +// ---------------------------------------------------------------------------- +// constants +// ---------------------------------------------------------------------------- -// 'naughty' cast -#define WXSTRINGCAST (char *)(const char *) +#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; -// NB: works only inside wxString class -#define ASSERT_VALID_INDEX(i) wxASSERT( (unsigned)(i) < Len() ) +#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 + +// ---------------------------------------------------------------------------- +// global data +// ---------------------------------------------------------------------------- + +// global pointer to empty string +WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString; // --------------------------------------------------------------------------- -/** @name Global functions complementing standard C string library - @memo replacements for strlen() and portable strcasecmp() - */ -// --------------------------------------------------------------------------- +// global functions complementing standard C string library replacements for +// strlen() and portable strcasecmp() +//--------------------------------------------------------------------------- -/// checks whether the passed in pointer is NULL and if the string is empty -inline bool WXDLLEXPORT IsEmpty(const char *p) { return !p || !*p; } +// Use wxXXX() functions from wxchar.h instead! These functions are for +// backwards compatibility only. -/// safe version of strlen() (returns 0 if passed NULL pointer) -inline size_t WXDLLEXPORT Strlen(const char *psz) +// checks whether the passed in pointer is NULL and if the string is empty +inline bool WXDLLEXPORT IsEmpty(const char *p) { return (!p || !*p); } + +// safe version of strlen() (returns 0 if passed NULL pointer) +inline size_t WXDLLEXPORT Strlen(const char *psz) { return psz ? strlen(psz) : 0; } -/// portable strcasecmp/_stricmp +// portable strcasecmp/_stricmp inline int WXDLLEXPORT Stricmp(const char *psz1, const char *psz2) { -#if defined(_MSC_VER) +#if defined(__VISUALC__) || ( defined(__MWERKS__) && defined(__INTEL__) ) + return _stricmp(psz1, psz2); +#elif defined(__SC__) return _stricmp(psz1, psz2); +#elif defined(__SALFORDC__) + return stricmp(psz1, psz2); #elif defined(__BORLANDC__) return stricmp(psz1, psz2); -#elif defined(__UNIX__) || defined(__GNUWIN32__) +#elif defined(__WATCOMC__) + return stricmp(psz1, psz2); +#elif defined(__EMX__) + return stricmp(psz1, psz2); +#elif defined(__WXPM__) + return stricmp(psz1, psz2); +#elif defined(__UNIX__) || defined(__GNUWIN32__) return strcasecmp(psz1, psz2); +#elif defined(__MWERKS__) && !defined(__INTEL__) + register char c1, c2; + do { + c1 = tolower(*psz1++); + c2 = tolower(*psz2++); + } while ( c1 && (c1 == c2) ); + + return c1 - c2; #else // almost all compilers/libraries provide this function (unfortunately under // different names), that's why we don't implement our own which will surely @@ -107,33 +172,36 @@ inline int WXDLLEXPORT Stricmp(const char *psz1, const char *psz2) #endif // OS/compiler } -// ---------------------------------------------------------------------------- -// global data -// ---------------------------------------------------------------------------- +// 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, ...); -// global pointer to empty string -extern const char *g_szNul; +// 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 wxString; // not yet defined -inline const wxString& wxGetEmptyString() { return *(wxString *)&g_szNul; } +class WXDLLEXPORT wxString; // not yet defined +inline const wxString& wxGetEmptyString() { return *(wxString *)&wxEmptyString; } // --------------------------------------------------------------------------- // string data prepended with some housekeeping info (used by wxString class), // is never used directly (but had to be put here to allow inlining) // --------------------------------------------------------------------------- + struct WXDLLEXPORT wxStringData { int nRefs; // reference count - uint nDataLength, // actual string length + size_t nDataLength, // actual string length nAllocLength; // allocated memory size - // mimics declaration 'char data[nAllocLength]' - char* data() const { return (char*)(this + 1); } + // mimics declaration 'wxChar data[nAllocLength]' + wxChar* data() const { return (wxChar*)(this + 1); } // empty string has a special ref count so it's never deleted - bool IsEmpty() const { return nRefs == -1; } - bool IsShared() const { return nRefs > 1; } + bool IsEmpty() const { return (nRefs == -1); } + bool IsShared() const { return (nRefs > 1); } // lock/unlock void Lock() { if ( !IsEmpty() ) nRefs++; } @@ -141,54 +209,50 @@ struct WXDLLEXPORT wxStringData // if we had taken control over string memory (GetWriteBuf), it's // intentionally put in invalid state - void Validate(bool b) { nRefs = b ? 1 : 0; } - bool IsValid() const { return nRefs != 0; } + void Validate(bool b) { nRefs = (b ? 1 : 0); } + bool IsValid() const { return (nRefs != 0); } }; // --------------------------------------------------------------------------- -/** - 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 - -@memo A non-template portable wxString class implementing copy-on-write. -@author VZ -@version 1.3 -*/ +// 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 // --------------------------------------------------------------------------- + #ifdef WXSTRING_IS_WXOBJECT - class WXDLLEXPORT wxString : public wxObject - { +class WXDLLEXPORT wxString : public wxObject +{ DECLARE_DYNAMIC_CLASS(wxString) #else //WXSTRING_IS_WXOBJECT - class WXDLLEXPORT wxString - { +class WXDLLEXPORT wxString +{ #endif //WXSTRING_IS_WXOBJECT -friend class wxArrayString; +friend class WXDLLEXPORT wxArrayString; - // NB: special care was taken in arrangin the member functions in such order - // that all inline functions can be effectively inlined + // NB: special care was taken in arranging the member functions in such order + // that all inline functions can be effectively inlined, verify that all + // performace critical functions are still inlined if you change order! private: // points to data preceded by wxStringData structure with ref count info - char *m_pchData; + wxChar *m_pchData; // accessor to string data wxStringData* GetStringData() const { return (wxStringData*)m_pchData - 1; } @@ -196,9 +260,9 @@ private: // string (re)initialization functions // initializes the string to the empty value (must be called only from // ctors, use Reinit() otherwise) - void Init() { m_pchData = (char *)g_szNul; } + void Init() { m_pchData = (wxChar *)wxEmptyString; } // initializaes the string with (a part of) C-string - void InitWith(const char *psz, size_t nPos = 0, size_t nLen = STRING_MAXLEN); + void InitWith(const wxChar *psz, size_t nPos = 0, size_t nLen = wxSTRING_MAXLEN); // as Init, but also frees old data void Reinit() { GetStringData()->Unlock(); Init(); } @@ -208,22 +272,30 @@ private: // copies data to another string void AllocCopy(wxString&, int, int) const; // effectively copies data to string - void AssignCopy(size_t, const char *); + void AssignCopy(size_t, const wxChar *); // append a (sub)string - void ConcatSelf(int nLen, const char *src); + void ConcatSelf(int 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) void CopyBeforeWrite(); void AllocBeforeWrite(size_t); + // this method is not implemented - there is _no_ conversion from int to + // string, you're doing something wrong if the compiler wants to call it! + // + // try `s << i' or `s.Printf("%d", i)' instead + wxString(int); + wxString(unsigned int); + wxString(long); + wxString(unsigned long); + public: - /** @name constructors & dtor */ - //@{ - /// ctor for an empty string + // constructors and destructor + // ctor for an empty string wxString() { Init(); } - /// copy ctor + // copy ctor wxString(const wxString& stringSrc) { wxASSERT( stringSrc.GetStringData()->IsValid() ); @@ -237,103 +309,182 @@ public: GetStringData()->Lock(); // => one more copy } } - /// string containing nRepeat copies of ch - wxString(char ch, size_t nRepeat = 1); - /// ctor takes first nLength characters from C string - // (default value of STRING_MAXLEN means take all the string) - wxString(const char *psz, size_t nLength = STRING_MAXLEN) + // string containing nRepeat copies of ch + wxString(wxChar ch, size_t nRepeat = 1); + // ctor takes first nLength characters from C string + // (default value of wxSTRING_MAXLEN means take all the string) + wxString(const wxChar *psz, size_t nLength = wxSTRING_MAXLEN) + { InitWith(psz, 0, nLength); } + +#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 = wxConvLibc, size_t nLength = wxSTRING_MAXLEN); + // from wxWCharBuffer (i.e. return from wxGetString) + wxString(const wxWCharBuffer& psz) + { InitWith(psz, 0, wxSTRING_MAXLEN); } +#else // ANSI + // from C string (for compilers using unsigned char) + wxString(const unsigned char* psz, size_t nLength = wxSTRING_MAXLEN) + { InitWith((const char*)psz, 0, nLength); } + // from multibyte string + wxString(const char *psz, wxMBConv& WXUNUSED(conv) , size_t nLength = wxSTRING_MAXLEN) { InitWith(psz, 0, nLength); } - /// from C string (for compilers using unsigned char) - wxString(const unsigned char* psz, size_t nLength = STRING_MAXLEN); - /// from wide (UNICODE) string + +#if wxUSE_WCHAR_T + // from wide (Unicode) string wxString(const wchar_t *pwz); - /// dtor is not virtual, this class must not be inherited from! +#endif // !wxUSE_WCHAR_T + + // from wxCharBuffer + wxString(const wxCharBuffer& psz) + { InitWith(psz, 0, wxSTRING_MAXLEN); } +#endif // Unicode/ANSI + + // dtor is not virtual, this class must not be inherited from! ~wxString() { GetStringData()->Unlock(); } - //@} - /** @name generic attributes & operations */ - //@{ - /// as standard strlen() - uint Len() const { return GetStringData()->nDataLength; } - /// string contains any characters? + // generic attributes & operations + // as standard strlen() + size_t Len() const { return GetStringData()->nDataLength; } + // string contains any characters? bool IsEmpty() const { return Len() == 0; } - /// reinitialize string (and free data!) + // empty string is "FALSE", so !str will return TRUE + bool operator!() const { return IsEmpty(); } + // empty string contents void Empty() { - if ( GetStringData()->nDataLength != 0 ) + if ( !IsEmpty() ) Reinit(); + // should be empty wxASSERT( GetStringData()->nDataLength == 0 ); - wxASSERT( GetStringData()->nAllocLength == 0 ); + } + // empty the string and free memory + void Clear() + { + if ( !GetStringData()->IsEmpty() ) + Reinit(); + + wxASSERT( GetStringData()->nDataLength == 0 ); // should be empty + wxASSERT( GetStringData()->nAllocLength == 0 ); // and not own any memory } - /// Is an ascii value + // contents test + // Is an ascii value bool IsAscii() const; - /// Is a number + // Is a number bool IsNumber() const; - /// Is a word + // Is a word bool IsWord() const; - //@} - /** @name data access (all indexes are 0 based) */ - //@{ - /// read access - char GetChar(size_t n) const + // data access (all indexes are 0 based) + // read access + wxChar GetChar(size_t n) const { ASSERT_VALID_INDEX( n ); return m_pchData[n]; } - /// read/write access - char& GetWritableChar(size_t n) + // read/write access + wxChar& GetWritableChar(size_t n) { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; } - /// write access - void SetChar(size_t n, char ch) + // write access + void SetChar(size_t n, wxChar ch) { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); m_pchData[n] = ch; } - /// get last character - char Last() const + // get last character + wxChar Last() const { wxASSERT( !IsEmpty() ); return m_pchData[Len() - 1]; } - /// get writable last character - char& Last() + // get writable last character + wxChar& Last() { wxASSERT( !IsEmpty() ); CopyBeforeWrite(); return m_pchData[Len()-1]; } - /// operator version of GetChar - char operator[](size_t n) const + // operator version of GetChar + wxChar operator[](size_t n) const + { ASSERT_VALID_INDEX( n ); return m_pchData[n]; } + + // operator version of GetChar + wxChar operator[](int n) const { ASSERT_VALID_INDEX( n ); return m_pchData[n]; } - /// operator version of GetChar - char operator[](int n) const +#ifdef __alpha__ + // operator version of GetChar + wxChar operator[](unsigned int n) const { ASSERT_VALID_INDEX( n ); return m_pchData[n]; } - /// operator version of GetWritableChar - char& operator[](size_t n) +#endif + + // operator version of GetWriteableChar + wxChar& operator[](size_t n) + { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; } +#ifdef __alpha__ + // operator version of GetWriteableChar + wxChar& operator[](unsigned int n) { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; } +#endif - /// implicit conversion to C string - operator const char*() const { return m_pchData; } - /// explicit conversion to C string (use this with printf()!) - const char* c_str() const { return m_pchData; } - /// - const char* GetData() const { return m_pchData; } - //@} - - /** @name overloaded assignment */ - //@{ - /// + // 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; } + // (and this with [wx]Printf()!) + const wxChar* wx_str() const { return m_pchData; } + // identical to c_str() + const wxChar* GetData() const { return m_pchData; } + + // conversions with (possible) format convertions: have to return a + // buffer with temporary data +#if wxUSE_UNICODE + const wxCharBuffer mb_str(wxMBConv& conv = wxConvLibc) const { return conv.cWC2MB(m_pchData); } + const wxWX2MBbuf mbc_str() const { return mb_str(*wxConvCurrent); } + + const wxChar* wc_str(wxMBConv& WXUNUSED(conv) = wxConvLibc) const { return m_pchData; } + +#if wxMBFILES + const wxCharBuffer fn_str() const { return mb_str(wxConvFile); } +#else // !wxMBFILES + const wxChar* fn_str() const { return m_pchData; } +#endif // wxMBFILES/!wxMBFILES +#else // ANSI +#if wxUSE_MULTIBYTE + const wxChar* mb_str(wxMBConv& WXUNUSED(conv) = wxConvLibc) const + { return m_pchData; } + const wxWX2MBbuf mbc_str() const { return mb_str(*wxConvCurrent); } +#else // !mmultibyte + const wxChar* mb_str() const { return m_pchData; } + const wxWX2MBbuf mbc_str() const { return mb_str(); } +#endif // multibyte/!multibyte +#if wxUSE_WCHAR_T + const wxWCharBuffer wc_str(wxMBConv& conv) const { return conv.cMB2WC(m_pchData); } +#endif // wxUSE_WCHAR_T + const wxChar* fn_str() const { return m_pchData; } +#endif // Unicode/ANSI + + // overloaded assignment + // from another wxString wxString& operator=(const wxString& stringSrc); - /// - wxString& operator=(char ch); - /// - wxString& operator=(const char *psz); - /// + // from a character + wxString& operator=(wxChar ch); + // from a C string + wxString& operator=(const wxChar *psz); +#if wxUSE_UNICODE + // from wxWCharBuffer + wxString& operator=(const wxWCharBuffer& psz) { return operator=((const wchar_t *)psz); } +#else // ANSI + // from another kind of C string wxString& operator=(const unsigned char* psz); - /// +#if wxUSE_WCHAR_T + // from a wide string wxString& operator=(const wchar_t *pwz); - //@} - - /** @name string concatenation */ - //@{ - /** @name in place concatenation */ - /** @name concatenate and return the result - left to right associativity of << allows to write - things like "str << str1 << str2 << ..." */ - //@{ - /// as += +#endif + // from wxCharBuffer + wxString& operator=(const wxCharBuffer& psz) { return operator=((const char *)psz); } +#endif // Unicode/ANSI + + // string concatenation + // in place concatenation + /* + Concatenate and return the result. Note that the left to right + associativity of << allows to write things like "str << str1 << str2 + << ..." (unlike with +=) + */ + // string += string wxString& operator<<(const wxString& s) { wxASSERT( s.GetStringData()->IsValid() ); @@ -341,594 +492,624 @@ public: ConcatSelf(s.Len(), s); return *this; } - /// as += - wxString& operator<<(const char *psz) - { ConcatSelf(Strlen(psz), psz); return *this; } - /// as += - wxString& operator<<(char ch) { ConcatSelf(1, &ch); return *this; } - //@} - - //@{ - /// string += string + // string += C string + wxString& operator<<(const wxChar *psz) + { ConcatSelf(wxStrlen(psz), psz); return *this; } + // string += char + wxString& operator<<(wxChar ch) { ConcatSelf(1, &ch); return *this; } + + // string += string void operator+=(const wxString& s) { (void)operator<<(s); } - /// string += C string - void operator+=(const char *psz) { (void)operator<<(psz); } - /// string += char - void operator+=(char ch) { (void)operator<<(ch); } - //@} - - /** @name return resulting string */ - //@{ - /// - friend wxString operator+(const wxString& string1, const wxString& string2); - /// - friend wxString operator+(const wxString& string, char ch); - /// - friend wxString operator+(char ch, const wxString& string); - /// - friend wxString operator+(const wxString& string, const char *psz); - /// - friend wxString operator+(const char *psz, const wxString& string); - //@} - //@} - - /** @name string comparison */ - //@{ - /** - case-sensitive comparaison - @return 0 if equal, +1 if greater or -1 if less - @see CmpNoCase, IsSameAs - */ - int Cmp(const char *psz) const { return strcmp(c_str(), psz); } - /** - case-insensitive comparaison, return code as for wxString::Cmp() - @see: Cmp, IsSameAs - */ - int CmpNoCase(const char *psz) const { return Stricmp(c_str(), psz); } - /** - test for string equality, case-sensitive (default) or not - @param bCase is TRUE by default (case matters) - @return TRUE if strings are equal, FALSE otherwise - @see Cmp, CmpNoCase - */ - bool IsSameAs(const char *psz, bool bCase = TRUE) const - { return !(bCase ? Cmp(psz) : CmpNoCase(psz)); } - //@} - - /** @name other standard string operations */ - //@{ - /** @name simple sub-string extraction - */ - //@{ - /** - return substring starting at nFirst of length - nCount (or till the end if nCount = default value) - */ - wxString Mid(size_t nFirst, size_t nCount = STRING_MAXLEN) const; - /// get first nCount characters + // string += C string + void operator+=(const wxChar *psz) { (void)operator<<(psz); } + // string += char + void operator+=(wxChar ch) { (void)operator<<(ch); } + + // 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 + + // string += C string + wxString& Append(const wxChar* psz) + { ConcatSelf(wxStrlen(psz), psz); return *this; } + // append count copies of given character + wxString& Append(wxChar ch, size_t count = 1u) + { wxString str(ch, count); return *this << str; } + wxString& Append(const wxChar* psz, size_t nLen) + { ConcatSelf(nLen, psz); return *this; } + + // prepend a string, return the string itself + wxString& Prepend(const wxString& str) + { *this = str + *this; return *this; } + + // non-destructive concatenation + // + friend wxString WXDLLEXPORT operator+(const wxString& string1, const wxString& string2); + // + friend wxString WXDLLEXPORT operator+(const wxString& string, wxChar ch); + // + friend wxString WXDLLEXPORT operator+(wxChar ch, const wxString& string); + // + friend wxString WXDLLEXPORT operator+(const wxString& string, const wxChar *psz); + // + friend wxString WXDLLEXPORT operator+(const wxChar *psz, const wxString& string); + + // stream-like functions + // insert an int into string + wxString& operator<<(int i) + { return (*this) << Format(_T("%d"), i); } + // insert an unsigned int into string + wxString& operator<<(unsigned int ui) + { return (*this) << Format(_T("%u"), ui); } + // insert a long into string + wxString& operator<<(long l) + { return (*this) << Format(_T("%ld"), l); } + // insert an unsigned long into string + wxString& operator<<(unsigned long ul) + { return (*this) << Format(_T("%lu"), ul); } + // insert a float into string + wxString& operator<<(float f) + { return (*this) << Format(_T("%f"), f); } + // insert a double into string + wxString& operator<<(double d) + { return (*this) << Format(_T("%g"), d); } + + // string comparison + // case-sensitive comparison (returns a value < 0, = 0 or > 0) + int Cmp(const wxChar *psz) const { return wxStrcmp(c_str(), psz); } + // same as Cmp() but not case-sensitive + int CmpNoCase(const wxChar *psz) const { return wxStricmp(c_str(), psz); } + // 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 + { return (compareWithCase ? Cmp(psz) : CmpNoCase(psz)) == 0; } + // comparison with a signle character: returns TRUE if equal + bool IsSameAs(wxChar c, bool compareWithCase = TRUE) const + { + return (Len() == 1) && (compareWithCase ? GetChar(0u) == c + : wxToupper(GetChar(0u)) == wxToupper(c)); + } + + // simple sub-string extraction + // return substring starting at nFirst of length nCount (or till the end + // if nCount = default value) + wxString Mid(size_t nFirst, size_t nCount = wxSTRING_MAXLEN) const; + + // operator version of Mid() + wxString operator()(size_t start, size_t len) const + { return Mid(start, len); } + + // get first nCount characters wxString Left(size_t nCount) const; - /// get all characters before the first occurence of ch - /// (returns the whole string if ch not found) - wxString Left(char ch) const; - /// get all characters before the last occurence of ch - /// (returns empty string if ch not found) - wxString Before(char ch) const; - /// get all characters after the first occurence of ch - /// (returns empty string if ch not found) - wxString After(char ch) const; - /// get last nCount characters + // get last nCount characters wxString Right(size_t nCount) const; - /// get all characters after the last occurence of ch - /// (returns the whole string if ch not found) - wxString Right(char ch) const; - //@} - - /** @name case conversion */ - //@{ - /// + // get all characters before the first occurence of ch + // (returns the whole string if ch not found) + wxString BeforeFirst(wxChar ch) const; + // get all characters before the last occurence of ch + // (returns empty string if ch not found) + wxString BeforeLast(wxChar ch) const; + // get all characters after the first occurence of ch + // (returns empty string if ch not found) + wxString AfterFirst(wxChar ch) const; + // get all characters after the last occurence of ch + // (returns the whole string if ch not found) + wxString AfterLast(wxChar ch) const; + + // for compatibility only, use more explicitly named functions above + wxString Before(wxChar ch) const { return BeforeLast(ch); } + wxString After(wxChar ch) const { return AfterFirst(ch); } + + // case conversion + // convert to upper case in place, return the string itself wxString& MakeUpper(); - /// + // convert to upper case, return the copy of the string + // Here's something to remember: BC++ doesn't like returns in inlines. + wxString Upper() const ; + // convert to lower case in place, return the string itself wxString& MakeLower(); - //@} + // convert to lower case, return the copy of the string + wxString Lower() const ; - /** @name trimming/padding whitespace (either side) and truncating */ - //@{ - /// remove spaces from left or from right (default) side + // trimming/padding whitespace (either side) and truncating + // remove spaces from left or from right (default) side wxString& Trim(bool bFromRight = TRUE); - /// add nCount copies chPad in the beginning or at the end (default) - wxString& Pad(size_t nCount, char chPad = ' ', bool bFromRight = TRUE); - /// truncate string to given length + // add nCount copies chPad in the beginning or at the end (default) + wxString& Pad(size_t nCount, wxChar chPad = wxT(' '), bool bFromRight = TRUE); + // truncate string to given length wxString& Truncate(size_t uiLen); - //@} - - /** @name searching and replacing */ - //@{ - /// searching (return starting index, or -1 if not found) - int Find(char ch, bool bFromEnd = FALSE) const; // like strchr/strrchr - /// searching (return starting index, or -1 if not found) - int Find(const char *pszSub) const; // like strstr - /** - replace first (or all) occurences of substring with another one - @param bReplaceAll: global replace (default) or only the first occurence - @return the number of replacements made - */ - uint Replace(const char *szOld, const char *szNew, bool bReplaceAll = TRUE); - //@} - - /// check if the string contents matches a mask containing '*' and '?' - bool Matches(const char *szMask) const; - //@} - - /** @name formated input/output */ - //@{ - /// as sprintf(), returns the number of characters written or < 0 on error - int Printf(const char *pszFormat, ...); - /// as vprintf(), returns the number of characters written or < 0 on error - int PrintfV(const char* pszFormat, va_list argptr); - //@} - - /** @name raw access to string memory */ - //@{ - /// ensure that string has space for at least nLen characters + + // searching and replacing + // searching (return starting index, or -1 if not found) + 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); + + // 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 + // convert to a signed integer + bool ToLong(long *val) const; + // convert to an unsigned integer + bool ToULong(unsigned long *val) const; + // convert to a double + bool ToDouble(double *val) const; + + // formated input/output + // as sprintf(), returns the number of characters written or < 0 on error + int Printf(const wxChar *pszFormat, ...); + // 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, ...); + // the same as above, but takes a va_list + static wxString FormatV(const wxChar *pszFormat, va_list argptr); + + // raw access to string memory + // ensure that string has space for at least nLen characters // only works if the data of this string is not shared - void Alloc(uint nLen); - /// minimize the string's memory + void Alloc(size_t nLen); + // minimize the string's memory // only works if the data of this string is not shared void Shrink(); - /** - get writable buffer of at least nLen bytes. - Unget() *must* be called a.s.a.p. to put string back in a reasonable - state! - */ - char *GetWriteBuf(uint nLen); - /// call this immediately after GetWriteBuf() has been used + // get writable buffer of at least nLen bytes. Unget() *must* be called + // a.s.a.p. to put string back in a reasonable state! + wxChar *GetWriteBuf(size_t nLen); + // call this immediately after GetWriteBuf() has been used void UngetWriteBuf(); - //@} + void UngetWriteBuf(size_t nLen); - /** @name wxWindows compatibility functions */ - //@{ - /// values for second parameter of CompareTo function + // wxWindows version 1 compatibility functions + + // use Mid() + wxString SubString(size_t from, size_t to) const + { return Mid(from, (to - from + 1)); } + // values for second parameter of CompareTo function enum caseCompare {exact, ignoreCase}; - /// values for first parameter of Strip function + // values for first parameter of Strip function enum stripType {leading = 0x1, trailing = 0x2, both = 0x3}; - /// same as Printf() - inline int sprintf(const char *pszFormat, ...) - { - va_list argptr; - va_start(argptr, pszFormat); - int iLen = PrintfV(pszFormat, argptr); - va_end(argptr); - return iLen; - } - /// same as Cmp - inline int CompareTo(const char* psz, caseCompare cmp = exact) const - { return cmp == exact ? Cmp(psz) : CmpNoCase(psz); } - - /// same as Mid (substring extraction) - inline wxString operator()(size_t start, size_t len) const - { return Mid(start, len); } + // use Printf() + int sprintf(const wxChar *pszFormat, ...); - /// same as += or << - inline wxString& Append(const char* psz) { return *this << psz; } - inline wxString& Append(char ch, int count = 1) - { wxString str(ch, count); (*this) += str; return *this; } + // use Cmp() + inline int CompareTo(const wxChar* psz, caseCompare cmp = exact) const + { return cmp == exact ? Cmp(psz) : CmpNoCase(psz); } - /// - wxString& Prepend(const wxString& str) - { *this = str + *this; return *this; } - /// same as Len + // use Len size_t Length() const { return Len(); } - /// same as MakeLower + // Count the number of characters + int Freq(wxChar ch) const; + // use MakeLower void LowerCase() { MakeLower(); } - /// same as MakeUpper + // use MakeUpper void UpperCase() { MakeUpper(); } - /// same as Trim except that it doesn't change this string + // use Trim except that it doesn't change this string wxString Strip(stripType w = trailing) const; - /// same as Find (more general variants not yet supported) - size_t Index(const char* psz) const { return Find(psz); } - size_t Index(char ch) const { return Find(ch); } - /// same as Truncate + // use Find (more general variants not yet supported) + size_t Index(const wxChar* psz) const { return Find(psz); } + size_t Index(wxChar ch) const { return Find(ch); } + // use Truncate wxString& Remove(size_t pos) { return Truncate(pos); } wxString& RemoveLast() { return Truncate(Len() - 1); } - // Robert Roebling - wxString& Remove(size_t nStart, size_t nLen) - { return erase( nStart, nLen ); } + wxString& Remove(size_t nStart, size_t nLen) { return erase( nStart, nLen ); } - size_t First( const char ch ) const { return find(ch); } - size_t First( const char* psz ) const { return find(psz); } - size_t First( const wxString &str ) const { return find(str); } + // use Find() + 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; } - size_t Last( const char ch ) const { return rfind(ch,0); } - size_t Last( const char* psz ) const { return rfind(psz,0); } - size_t Last( const wxString &str ) const { return rfind(str,0); } - - /// same as IsEmpty + // use IsEmpty() bool IsNull() const { return IsEmpty(); } - //@} -#ifdef STD_STRING_COMPATIBILITY - /** @name std::string compatibility functions */ +#ifdef wxSTD_STRING_COMPATIBILITY + // std::string compatibility functions + + // standard types + typedef wxChar value_type; + typedef const value_type *const_iterator; - /// an 'invalid' value for string index + // an 'invalid' value for string index static const size_t npos; - //@{ - /** @name constructors */ - //@{ - /// take nLen chars starting at nPos - wxString(const wxString& str, size_t nPos, size_t nLen = npos) - { - wxASSERT( str.GetStringData()->IsValid() ); - InitWith(str.c_str(), nPos, nLen == npos ? 0 : nLen); - } - /// take all characters from pStart to pEnd - wxString(const void *pStart, const void *pEnd); - //@} - /** @name lib.string.capacity */ - //@{ - /// return the length of the string - size_t size() const { return Len(); } - /// return the length of the string - size_t length() const { return Len(); } - /// return the maximum size of the string - size_t max_size() const { return STRING_MAXLEN; } - /// resize the string, filling the space with c if c != 0 - void resize(size_t nSize, char ch = '\0'); - /// delete the contents of the string - void clear() { Empty(); } - /// returns true if the string is empty - bool empty() const { return IsEmpty(); } - //@} - /** @name lib.string.access */ - //@{ - /// return the character at position n - char at(size_t n) const { return GetChar(n); } - /// returns the writable character at position n - char& at(size_t n) { return GetWritableChar(n); } - //@} - /** @name lib.string.modifiers */ - //@{ - /** @name append something to the end of this one */ - //@{ - /// append a string - wxString& append(const wxString& str) - { *this += str; return *this; } - /// append elements str[pos], ..., str[pos+n] - wxString& append(const wxString& str, size_t pos, size_t n) - { ConcatSelf(n, str.c_str() + pos); return *this; } - /// append first n (or all if n == npos) characters of sz - wxString& append(const char *sz, size_t n = npos) - { ConcatSelf(n == npos ? Strlen(sz) : n, sz); return *this; } - - /// append n copies of ch - wxString& append(size_t n, char ch) { return Pad(n, ch); } - //@} - - /** @name replaces the contents of this string with another one */ - //@{ - /// same as `this_string = str' - wxString& assign(const wxString& str) { return (*this) = str; } - /// same as ` = str[pos..pos + n] - wxString& assign(const wxString& str, size_t pos, size_t n) - { return *this = wxString((const char *)str + pos, n); } - /// same as `= first n (or all if n == npos) characters of sz' - wxString& assign(const char *sz, size_t n = npos) - { return *this = wxString(sz, n); } - /// same as `= n copies of ch' - wxString& assign(size_t n, char ch) - { return *this = wxString(ch, n); } - - //@} - - /** @name inserts something at position nPos into this one */ - //@{ - /// insert another string - wxString& insert(size_t nPos, const wxString& str); - /// insert n chars of str starting at nStart (in str) - wxString& insert(size_t nPos, const wxString& str, size_t nStart, size_t n) - { return insert(nPos, wxString((const char *)str + nStart, n)); } - - /// insert first n (or all if n == npos) characters of sz - wxString& insert(size_t nPos, const char *sz, size_t n = npos) - { return insert(nPos, wxString(sz, n)); } - /// insert n copies of ch - wxString& insert(size_t nPos, size_t n, char ch) - { return insert(nPos, wxString(ch, n)); } - - //@} - - /** @name deletes a part of the string */ - //@{ - /// delete characters from nStart to nStart + nLen - wxString& erase(size_t nStart = 0, size_t nLen = npos); - //@} - - /** @name replaces a substring of this string with another one */ - //@{ - /// replaces the substring of length nLen starting at nStart - wxString& replace(size_t nStart, size_t nLen, const char* sz); - /// replaces the substring with nCount copies of ch - wxString& replace(size_t nStart, size_t nLen, size_t nCount, char ch); - /// replaces a substring with another substring - wxString& replace(size_t nStart, size_t nLen, - const wxString& str, size_t nStart2, size_t nLen2); - /// replaces the substring with first nCount chars of sz - wxString& replace(size_t nStart, size_t nLen, - const char* sz, size_t nCount); - //@} - //@} - - /// swap two strings - void swap(wxString& str); - - /** @name string operations */ - //@{ - /** All find() functions take the nStart argument which specifies - the position to start the search on, the default value is 0. - - All functions return npos if there were no match. - - @name string search - */ - //@{ - /** - @name find a match for the string/character in this string - */ - //@{ - /// find a substring - size_t find(const wxString& str, size_t nStart = 0) const; - - // VC++ 1.5 can't cope with this syntax. -#if ! (defined(_MSC_VER) && !defined(__WIN32__)) - /// find first n characters of sz - size_t find(const char* sz, size_t nStart = 0, size_t n = npos) const; + // constructors + // take nLen chars starting at nPos + wxString(const wxString& str, size_t nPos, size_t nLen) + { + wxASSERT( str.GetStringData()->IsValid() ); + InitWith(str.c_str(), nPos, nLen == npos ? 0 : nLen); + } + // take all characters from pStart to pEnd + wxString(const void *pStart, const void *pEnd); + + // lib.string.capacity + // return the length of the string + size_t size() const { return Len(); } + // return the length of the string + size_t length() const { return Len(); } + // return the maximum size of the string + size_t max_size() const { return wxSTRING_MAXLEN; } + // resize the string, filling the space with c if c != 0 + void resize(size_t nSize, wxChar ch = wxT('\0')); + // delete the contents of the string + void clear() { Empty(); } + // 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); } + + // lib.string.access + // return the character at position n + wxChar at(size_t n) const { return GetChar(n); } + // returns the writable character at position n + wxChar& at(size_t n) { return GetWritableChar(n); } + + // first valid index position + const_iterator begin() const { return wx_str(); } + // position one after the last valid one + const_iterator end() const { return wx_str() + length(); } + + // lib.string.modifiers + // append a string + wxString& append(const wxString& str) + { *this += str; return *this; } + // append elements str[pos], ..., str[pos+n] + wxString& append(const wxString& str, size_t pos, size_t n) + { ConcatSelf(n, str.c_str() + pos); return *this; } + // append first n (or all if n == npos) characters of sz + wxString& append(const wxChar *sz, size_t n = npos) + { ConcatSelf(n == npos ? wxStrlen(sz) : n, sz); return *this; } + + // append n copies of ch + wxString& append(size_t n, wxChar ch) { return Pad(n, ch); } + + // same as `this_string = str' + wxString& assign(const wxString& str) { return (*this) = str; } + // same as ` = str[pos..pos + n] + wxString& assign(const wxString& str, size_t pos, size_t n) + { return *this = wxString((const wxChar *)str + pos, n); } + // same as `= first n (or all if n == npos) characters of sz' + wxString& assign(const wxChar *sz, size_t n = npos) + { return *this = wxString(sz, n); } + // same as `= n copies of ch' + wxString& assign(size_t n, wxChar ch) + { return *this = wxString(ch, n); } + + // insert another string + wxString& insert(size_t nPos, const wxString& str); + // insert n chars of str starting at nStart (in str) + wxString& insert(size_t nPos, const wxString& str, size_t nStart, size_t n) + { return insert(nPos, wxString((const wxChar *)str + nStart, n)); } + + // insert first n (or all if n == npos) characters of sz + wxString& insert(size_t nPos, const wxChar *sz, size_t n = npos) + { return insert(nPos, wxString(sz, n)); } + // insert n copies of ch + wxString& insert(size_t nPos, size_t n, wxChar ch) + { return insert(nPos, wxString(ch, n)); } + + // delete characters from nStart to nStart + nLen + wxString& erase(size_t nStart = 0, size_t nLen = npos); + + // replaces the substring of length nLen starting at nStart + wxString& replace(size_t nStart, size_t nLen, const wxChar* sz); + // replaces the substring with nCount copies of ch + wxString& replace(size_t nStart, size_t nLen, size_t nCount, wxChar ch); + // replaces a substring with another substring + wxString& replace(size_t nStart, size_t nLen, + const wxString& str, size_t nStart2, size_t nLen2); + // replaces the substring with first nCount chars of sz + wxString& replace(size_t nStart, size_t nLen, + const wxChar* sz, size_t nCount); + + // swap two strings + void swap(wxString& str); + + // All find() functions take the nStart argument which specifies the + // position to start the search on, the default value is 0. All functions + // return npos if there were no match. + + // find a substring + size_t find(const wxString& str, size_t nStart = 0) const; + + // VC++ 1.5 can't cope with this syntax. +#if !defined(__VISUALC__) || defined(__WIN32__) + // find first n characters of sz + size_t find(const wxChar* sz, size_t nStart = 0, size_t n = npos) const; #endif - /// find the first occurence of character ch after nStart - size_t find(char ch, size_t nStart = 0) const; - - // wxWin compatibility - inline bool Contains(const wxString& str) { return Find(str) != -1; } - - //@} - - /** - @name rfind() family is exactly like find() but works right to left - */ - //@{ - /// as find, but from the end - size_t rfind(const wxString& str, size_t nStart = npos) const; - /// as find, but from the end - // VC++ 1.5 can't cope with this syntax. -#if ! (defined(_MSC_VER) && !defined(__WIN32__)) - size_t rfind(const char* sz, size_t nStart = npos, - size_t n = npos) const; - /// as find, but from the end - size_t rfind(char ch, size_t nStart = npos) const; + + // Gives a duplicate symbol (presumably a case-insensitivity problem) +#if !defined(__BORLANDC__) + // find the first occurence of character ch after nStart + size_t find(wxChar ch, size_t nStart = 0) const; #endif - //@} - - /** - @name find first/last occurence of any character in the set - */ - //@{ - /// - size_t find_first_of(const wxString& str, size_t nStart = 0) const; - /// - size_t find_first_of(const char* sz, size_t nStart = 0) const; - /// same as find(char, size_t) - size_t find_first_of(char c, size_t nStart = 0) const; - - /// - size_t find_last_of (const wxString& str, size_t nStart = npos) const; - /// - size_t find_last_of (const char* s, size_t nStart = npos) const; - /// same as rfind(char, size_t) - size_t find_last_of (char c, size_t nStart = npos) const; - //@} - - /** - @name find first/last occurence of any character not in the set - */ - //@{ - /// - size_t find_first_not_of(const wxString& str, size_t nStart = 0) const; - /// - size_t find_first_not_of(const char* s, size_t nStart = 0) const; - /// - size_t find_first_not_of(char ch, size_t nStart = 0) const; - - /// - size_t find_last_not_of(const wxString& str, size_t nStart=npos) const; - /// - size_t find_last_not_of(const char* s, size_t nStart = npos) const; - /// - size_t find_last_not_of(char ch, size_t nStart = npos) const; - //@} - //@} - - /** - All compare functions return -1, 0 or 1 if the [sub]string - is less, equal or greater than the compare() argument. - - @name comparison - */ - //@{ - /// just like strcmp() - int compare(const wxString& str) const { return Cmp(str); } - /// comparaison with a substring - int compare(size_t nStart, size_t nLen, const wxString& str) const; - /// comparaison of 2 substrings - int compare(size_t nStart, size_t nLen, - const wxString& str, size_t nStart2, size_t nLen2) const; - /// just like strcmp() - int compare(const char* sz) const { return Cmp(sz); } - /// substring comparaison with first nCount characters of sz - int compare(size_t nStart, size_t nLen, - const char* sz, size_t nCount = npos) const; - //@} - wxString substr(size_t nStart = 0, size_t nLen = npos) const; - //@} + // rfind() family is exactly like find() but works right to left + + // as find, but from the end + size_t rfind(const wxString& str, size_t nStart = npos) const; + + // VC++ 1.5 can't cope with this syntax. +#if !defined(__VISUALC__) || defined(__WIN32__) + // as find, but from the end + size_t rfind(const wxChar* sz, size_t nStart = npos, + size_t n = npos) const; + // as find, but from the end + size_t rfind(wxChar ch, size_t nStart = npos) const; #endif + + // find first/last occurence of any character in the set + + // as strpbrk() but starts at nStart, returns npos if not found + size_t find_first_of(const wxString& str, size_t nStart = 0) const + { return find_first_of(str.c_str(), nStart); } + // same as above + size_t find_first_of(const wxChar* sz, size_t nStart = 0) const; + // same as find(char, size_t) + size_t find_first_of(wxChar c, size_t nStart = 0) const + { return find(c, nStart); } + // find the last (starting from nStart) char from str in this string + size_t find_last_of (const wxString& str, size_t nStart = npos) const + { return find_last_of(str.c_str(), nStart); } + // same as above + size_t find_last_of (const wxChar* sz, size_t nStart = npos) const; + // same as above + size_t find_last_of(wxChar c, size_t nStart = npos) const + { return rfind(c, nStart); } + + // find first/last occurence of any character not in the set + + // as strspn() (starting from nStart), returns npos on failure + size_t find_first_not_of(const wxString& str, size_t nStart = 0) const + { return find_first_not_of(str.c_str(), nStart); } + // same as above + size_t find_first_not_of(const wxChar* sz, size_t nStart = 0) const; + // same as above + size_t find_first_not_of(wxChar ch, size_t nStart = 0) const; + // as strcspn() + size_t find_last_not_of(const wxString& str, size_t nStart=npos) const; + // same as above + size_t find_last_not_of(const wxChar* sz, size_t nStart = npos) const; + // same as above + size_t find_last_not_of(wxChar ch, size_t nStart = npos) const; + + // 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 wxString& str) const { return Cmp(str); } + // comparison with a substring + int compare(size_t nStart, size_t nLen, const wxString& str) const; + // comparison of 2 substrings + int compare(size_t nStart, size_t nLen, + const wxString& str, size_t nStart2, size_t nLen2) const; + // just like strcmp() + int compare(const wxChar* sz) const { return Cmp(sz); } + // substring comparison with first nCount characters of sz + int compare(size_t nStart, size_t nLen, + const wxChar* sz, size_t nCount = npos) const; + + // substring extraction + wxString substr(size_t nStart = 0, size_t nLen = npos) const + { return Mid(nStart, nLen); } +#endif // wxSTD_STRING_COMPATIBILITY }; // ---------------------------------------------------------------------------- -/** The string array uses it's knowledge of internal structure of the String - class to optimize string storage. Normally, we would store pointers to - string, but as String is, in fact, itself a pointer (sizeof(String) is - sizeof(char *)) we store these pointers instead. The cast to "String *" - is really all we need to turn such pointer into a string! - - Of course, it can be called a dirty hack, but we use twice less memory - and this approach is also more speed efficient, so it's probably worth it. - - Usage notes: when a string is added/inserted, a new copy of it is created, - so the original string may be safely deleted. When a string is retrieved - from the array (operator[] or Item() method), a reference is returned. - - @name wxArrayString - @memo probably the most commonly used array type - array of strings - */ +// The string array uses it's knowledge of internal structure of the wxString +// class to optimize string storage. Normally, we would store pointers to +// string, but as wxString is, in fact, itself a pointer (sizeof(wxString) is +// sizeof(char *)) we store these pointers instead. The cast to "wxString *" is +// really all we need to turn such pointer into a string! +// +// Of course, it can be called a dirty hack, but we use twice less memory and +// this approach is also more speed efficient, so it's probably worth it. +// +// Usage notes: when a string is added/inserted, a new copy of it is created, +// so the original string may be safely deleted. When a string is retrieved +// from the array (operator[] or Item() method), a reference is returned. // ---------------------------------------------------------------------------- -class wxArrayString + +class WXDLLEXPORT wxArrayString { public: - /** @name ctors and dtor */ - //@{ - /// default ctor - wxArrayString(); - /// copy ctor + // type of function used by wxArrayString::Sort() + typedef int (*CompareFunction)(const wxString& first, + const wxString& second); + + // constructors and destructor + // default ctor: if autoSort is TRUE, the array is always sorted (in + // alphabetical order) + wxArrayString(bool autoSort = FALSE); + // copy ctor wxArrayString(const wxArrayString& array); - /// assignment operator + // assignment operator wxArrayString& operator=(const wxArrayString& src); - /// not virtual, this class can't be derived from + // not virtual, this class should not be derived from ~wxArrayString(); - //@} - /** @name memory management */ - //@{ - /// empties the list, but doesn't release memory + // memory management + // empties the list, but doesn't release memory void Empty(); - /// empties the list and releases memory + // empties the list and releases memory void Clear(); - /// preallocates memory for given number of items + // preallocates memory for given number of items void Alloc(size_t nCount); - /// minimzes the memory usage (by freeing all extra memory) + // minimzes the memory usage (by freeing all extra memory) void Shrink(); - //@} - - /** @name simple accessors */ - //@{ - /// number of elements in the array - uint Count() const { return m_nCount; } - /// is it empty? - bool IsEmpty() const { return m_nCount == 0; } - //@} - - /** @name items access (range checking is done in debug version) */ - //@{ - /// get item at position uiIndex + + // simple accessors + // number of elements in the array + size_t GetCount() const { return m_nCount; } + // is it empty? + bool IsEmpty() const { return m_nCount == 0; } + // number of elements in the array (GetCount is preferred API) + size_t Count() const { return m_nCount; } + + // 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]); } - /// same as Item() + // same as Item() wxString& operator[](size_t nIndex) const { return Item(nIndex); } - /// get last item + // get last item wxString& Last() const { wxASSERT( !IsEmpty() ); return Item(Count() - 1); } - //@} - - /** @name item management */ - //@{ - /** - Search the element in the array, starting from the either side - @param if bFromEnd reverse search direction - @param if bCase, comparaison is case sensitive (default) - @return index of the first item matched or NOT_FOUND - @see NOT_FOUND - */ - int Index (const char *sz, bool bCase = TRUE, bool bFromEnd = FALSE) const; - /// add new element at the end - void Add (const wxString& str); - /// add new element at given position - void Insert(const wxString& str, uint uiIndex); - /// remove first item matching this value - void Remove(const char *sz); - /// remove item by index + + // item management + // Search the element in the array, starting from the beginning if + // bFromEnd is FALSE or from end otherwise. If bCase, comparison is case + // sensitive (default). Returns index of the first item matched or + // wxNOT_FOUND + 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); + // add new element at given position + void Insert(const wxString& str, size_t uiIndex); + // remove first item matching this value + void Remove(const wxChar *sz); + // remove item by index void Remove(size_t nIndex); - //@} - /// sort array elements - void Sort(bool bCase = TRUE, bool bReverse = FALSE); + // sorting + // sort array elements in alphabetical order (or reversed alphabetical + // order if reverseOrder parameter is TRUE) + void Sort(bool reverseOrder = FALSE); + // sort array elements using specified comparaison function + void Sort(CompareFunction compareFunction); + +protected: + void Copy(const wxArrayString& src); // copies the contents of another array private: - void Grow(); // makes array bigger if needed - void Free(); // free the string stored + void Grow(); // makes array bigger if needed + void Free(); // free all the strings stored + + void DoSort(); // common part of all Sort() variants size_t m_nSize, // current size of the array m_nCount; // current number of elements - char **m_pItems; // pointer to data + wxChar **m_pItems; // pointer to data + + bool m_autoSort; // if TRUE, keep the array always sorted +}; + +class WXDLLEXPORT wxSortedArrayString : public wxArrayString +{ +public: + wxSortedArrayString() : wxArrayString(TRUE) + { } + wxSortedArrayString(const wxArrayString& array) : wxArrayString(TRUE) + { Copy(array); } }; // --------------------------------------------------------------------------- -/** @name wxString comparaison functions - @memo Comparaisons are case sensitive - */ +// wxString comparison functions: operator versions are always case sensitive // --------------------------------------------------------------------------- -//@{ -inline bool operator==(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) == 0; } -/// -inline bool operator==(const wxString& s1, const char * s2) { return s1.Cmp(s2) == 0; } -/// -inline bool operator==(const char * s1, const wxString& s2) { return s2.Cmp(s1) == 0; } -/// -inline bool operator!=(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) != 0; } -/// -inline bool operator!=(const wxString& s1, const char * s2) { return s1.Cmp(s2) != 0; } -/// -inline bool operator!=(const char * s1, const wxString& s2) { return s2.Cmp(s1) != 0; } -/// -inline bool operator< (const wxString& s1, const wxString& s2) { return s1.Cmp(s2) < 0; } -/// -inline bool operator< (const wxString& s1, const char * s2) { return s1.Cmp(s2) < 0; } -/// -inline bool operator< (const char * s1, const wxString& s2) { return s2.Cmp(s1) > 0; } -/// -inline bool operator> (const wxString& s1, const wxString& s2) { return s1.Cmp(s2) > 0; } -/// -inline bool operator> (const wxString& s1, const char * s2) { return s1.Cmp(s2) > 0; } -/// -inline bool operator> (const char * s1, const wxString& s2) { return s2.Cmp(s1) < 0; } -/// -inline bool operator<=(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) <= 0; } -/// -inline bool operator<=(const wxString& s1, const char * s2) { return s1.Cmp(s2) <= 0; } -/// -inline bool operator<=(const char * s1, const wxString& s2) { return s2.Cmp(s1) >= 0; } -/// -inline bool operator>=(const wxString& s1, const wxString& s2) { return s1.Cmp(s2) >= 0; } -/// -inline bool operator>=(const wxString& s1, const char * s2) { return s1.Cmp(s2) >= 0; } -/// -inline bool operator>=(const char * s1, const wxString& s2) { return s2.Cmp(s1) <= 0; } -//@} + +// +inline bool operator==(const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) == 0); } +// +inline bool operator==(const wxString& s1, const wxChar * s2) { return (s1.Cmp(s2) == 0); } +// +inline bool operator==(const wxChar * s1, const wxString& s2) { return (s2.Cmp(s1) == 0); } +// +inline bool operator!=(const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) != 0); } +// +inline bool operator!=(const wxString& s1, const wxChar * s2) { return (s1.Cmp(s2) != 0); } +// +inline bool operator!=(const wxChar * s1, const wxString& s2) { return (s2.Cmp(s1) != 0); } +// +inline bool operator< (const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) < 0); } +// +inline bool operator< (const wxString& s1, const wxChar * s2) { return (s1.Cmp(s2) < 0); } +// +inline bool operator< (const wxChar * s1, const wxString& s2) { return (s2.Cmp(s1) > 0); } +// +inline bool operator> (const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) > 0); } +// +inline bool operator> (const wxString& s1, const wxChar * s2) { return (s1.Cmp(s2) > 0); } +// +inline bool operator> (const wxChar * s1, const wxString& s2) { return (s2.Cmp(s1) < 0); } +// +inline bool operator<=(const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) <= 0); } +// +inline bool operator<=(const wxString& s1, const wxChar * s2) { return (s1.Cmp(s2) <= 0); } +// +inline bool operator<=(const wxChar * s1, const wxString& s2) { return (s2.Cmp(s1) >= 0); } +// +inline bool operator>=(const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) >= 0); } +// +inline bool operator>=(const wxString& s1, const wxChar * s2) { return (s1.Cmp(s2) >= 0); } +// +inline bool operator>=(const wxChar * s1, const wxString& s2) { return (s2.Cmp(s1) <= 0); } + +// 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); } +inline bool operator==(const wxWCharBuffer& s1, const wxString& s2) + { return (s2.Cmp((const wchar_t *)s1) == 0); } +#else +inline bool operator==(const wxString& s1, const wxCharBuffer& s2) + { return (s1.Cmp((const char *)s2) == 0); } +inline bool operator==(const wxCharBuffer& s1, const wxString& s2) + { return (s2.Cmp((const char *)s1) == 0); } +#endif + +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); +#if wxUSE_UNICODE +inline wxString WXDLLEXPORT operator+(const wxString& string, const wxWCharBuffer& buf) + { return string + (const wchar_t *)buf; } +inline wxString WXDLLEXPORT operator+(const wxWCharBuffer& buf, const wxString& string) + { return (const wchar_t *)buf + string; } +#else +inline wxString WXDLLEXPORT operator+(const wxString& string, const wxCharBuffer& buf) + { return string + (const char *)buf; } +inline wxString WXDLLEXPORT operator+(const wxCharBuffer& buf, const wxString& string) + { return (const char *)buf + string; } +#endif // --------------------------------------------------------------------------- -/** @name Global functions complementing standard C string library - @memo replacements for strlen() and portable strcasecmp() - */ +// Implementation only from here until the end of file // --------------------------------------------------------------------------- -#ifdef STD_STRING_COMPATIBILITY +// don't pollute the library user's name space +#undef ASSERT_VALID_INDEX -// fwd decl -class WXDLLEXPORT istream; +#if defined(wxSTD_STRING_COMPATIBILITY) && wxUSE_STD_IOSTREAM -istream& WXDLLEXPORT operator>>(istream& is, wxString& str); +#include "wx/ioswrap.h" -#endif //std::string compatibility +WXDLLEXPORT istream& operator>>(istream&, wxString&); +WXDLLEXPORT ostream& operator<<(ostream&, const wxString&); -#endif // __WXSTRINGH__ +#endif // wxSTD_STRING_COMPATIBILITY -//@} +#endif // _WX_WXSTRINGH__