1. deprecate redundantly sounding wxArtProvider::FooProvider() to just Foo()

[wxWidgets.git] / src / common / string.cpp

diff --git a/src/common/string.cpp b/src/common/string.cpp
index ffae5b4e127c85156ec36b5b77423ed4a3053fb7..98a635bc49d24c45a96db207566518d985b4be37 100644 (file)
--- a/src/common/string.cpp
+++ b/src/common/string.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        string.cpp
+// Name:        src/common/string.cpp

 // Purpose:     wxString class
 // Author:      Vadim Zeitlin, Ryan Norton
 // Modified by:
 // Purpose:     wxString class
 // Author:      Vadim Zeitlin, Ryan Norton
 // Modified by:


@@ -25,26 +25,21 @@
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-  #pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #ifndef WX_PRECOMP
 #endif
 
 #ifndef WX_PRECOMP

-  #include "wx/defs.h"
-  #include "wx/string.h"
-  #include "wx/intl.h"
-  #include "wx/thread.h"
+    #include "wx/string.h"
+    #include "wx/intl.h"
+    #include "wx/thread.h"

 #endif
 
 #include <ctype.h>
 #include <string.h>
 #include <stdlib.h>
 
 #endif
 
 #include <ctype.h>
 #include <string.h>
 #include <stdlib.h>
 

-#ifndef __WXMSW__
-#include <errno.h>
-#endif
-

 #ifdef __SALFORDC__
 #ifdef __SALFORDC__

-  #include <clib.h>
+    #include <clib.h>

 #endif
 
 // allocating extra space for each string consumes more memory but speeds up
 #endif
 
 // allocating extra space for each string consumes more memory but speeds up


@@ -91,44 +86,8 @@ extern const wxChar WXDLLIMPEXP_BASE *wxEmptyString = &g_strEmpty.dummy;
 
 #if wxUSE_STD_IOSTREAM
 
 
 #if wxUSE_STD_IOSTREAM
 

-// MS Visual C++ version 5.0 provides the new STL headers as well as the old
-// iostream ones.
-//
-// ATTN: you can _not_ use both of these in the same program!
-

 #include <iostream>
 
 #include <iostream>
 

-wxSTD istream& operator>>(wxSTD istream& is, wxString& WXUNUSED(str))
-{
-#if 0
-  int w = is.width(0);
-  if ( is.ipfx(0) ) {
-    streambuf *sb = is.rdbuf();
-    str.erase();
-    while ( true ) {
-      int ch = sb->sbumpc ();
-      if ( ch == EOF ) {
-        is.setstate(ios::eofbit);
-        break;
-      }
-      else if ( isspace(ch) ) {
-        sb->sungetc();
-        break;
-      }
-
-      str += ch;
-      if ( --w == 1 )
-        break;
-    }
-  }
-
-  is.isfx();
-  if ( str.length() == 0 )
-    is.setstate(ios::failbit);
-#endif
-  return is;
-}
-

 wxSTD ostream& operator<<(wxSTD ostream& os, const wxString& str)
 {
 #ifdef __BORLANDC__
 wxSTD ostream& operator<<(wxSTD ostream& os, const wxString& str)
 {
 #ifdef __BORLANDC__


@@ -365,8 +324,8 @@ bool wxStringBase::Alloc(size_t nLen)
     if ( pData->IsEmpty() ) {
       nLen += EXTRA_ALLOC;
 
     if ( pData->IsEmpty() ) {
       nLen += EXTRA_ALLOC;
 

-      wxStringData* pData = (wxStringData*)
-          malloc(sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar));
+      pData = (wxStringData *)
+                malloc(sizeof(wxStringData) + (nLen + 1)*sizeof(wxChar));

 
       if ( pData == NULL ) {
         // allocation failure handled by caller
 
       if ( pData == NULL ) {
         // allocation failure handled by caller


@@ -1010,114 +969,58 @@ int STRINGCLASS::compare(size_t nStart, size_t nLen,
 #if wxUSE_UNICODE
 
 // from multibyte string
 #if wxUSE_UNICODE
 
 // from multibyte string

-wxString::wxString(const char *psz, wxMBConv& conv, size_t nLength)
+wxString::wxString(const char *psz, const wxMBConv& conv, size_t nLength)

 {
 {

-    // if nLength != npos, then we have to make a NULL-terminated copy
-    // of first nLength bytes of psz first because the input buffer to MB2WC
-    // must always be NULL-terminated:
-    wxCharBuffer inBuf((const char *)NULL);
-    if (nLength != npos)
-    {
-        wxASSERT( psz != NULL );
-        wxCharBuffer tmp(nLength);
-        memcpy(tmp.data(), psz, nLength);
-        tmp.data()[nLength] = '\0';
-        inBuf = tmp;
-        psz = inBuf.data();
-    }
-
-    // first get the size of the buffer we need
-    size_t nLen;
-    if ( psz )
-    {
-        // calculate the needed size ourselves or use the provided one
-        if (nLength == npos)
-            nLen = strlen(psz);
-        else
-            nLen = nLength;
-    }
-    else
-    {
-        // nothing to convert
-        nLen = 0;
-    }
-
-

     // anything to do?
     // anything to do?

-    if ( (nLen != 0) && (nLen != (size_t)-1) )
+    if ( psz && nLength != 0 )

     {
     {

-        //Convert string
-        size_t nRealSize;
-        wxWCharBuffer theBuffer = conv.cMB2WC(psz, nLen, &nRealSize);
+        if ( nLength == npos )
+        {
+            nLength = wxNO_LEN;
+        }
+
+        size_t nLenWide;
+        wxWCharBuffer wbuf = conv.cMB2WC(psz, nLength, &nLenWide);

 
 

-        //Copy
-        if (nRealSize)
-            assign( theBuffer.data() , nRealSize - 1 );
+        if ( nLenWide )
+            assign(wbuf, nLenWide);

     }
 }
 
 //Convert wxString in Unicode mode to a multi-byte string
     }
 }
 
 //Convert wxString in Unicode mode to a multi-byte string

-const wxCharBuffer wxString::mb_str(wxMBConv& conv) const
+const wxCharBuffer wxString::mb_str(const wxMBConv& conv) const

 {
 {

-    size_t dwOutSize;
-    return conv.cWC2MB(c_str(), length(), &dwOutSize);
+    return conv.cWC2MB(c_str(), length() + 1 /* size, not length */, NULL);

 }
 
 #else // ANSI
 
 #if wxUSE_WCHAR_T
 }
 
 #else // ANSI
 
 #if wxUSE_WCHAR_T

+

 // from wide string
 // from wide string

-wxString::wxString(const wchar_t *pwz, wxMBConv& conv, size_t nLength)
+wxString::wxString(const wchar_t *pwz, const wxMBConv& conv, size_t nLength)

 {
 {

-    // if nLength != npos, then we have to make a NULL-terminated copy
-    // of first nLength chars of psz first because the input buffer to WC2MB
-    // must always be NULL-terminated:
-    wxWCharBuffer inBuf((const wchar_t *)NULL);
-    if (nLength != npos)
-    {
-        wxASSERT( pwz != NULL );
-        wxWCharBuffer tmp(nLength);
-        memcpy(tmp.data(), pwz, nLength * sizeof(wchar_t));
-        tmp.data()[nLength] = '\0';
-        inBuf = tmp;
-        pwz = inBuf.data();
-    }
-
-    // first get the size of the buffer we need
-    size_t nLen;
-    if ( pwz )
-    {
-        // calculate the needed size ourselves or use the provided one
-        if (nLength == npos)
-            nLen = wxWcslen(pwz);
-        else
-            nLen = nLength;
-    }
-    else
-    {
-        // nothing to convert
-        nLen = 0;
-    }
-

     // anything to do?
     // anything to do?

-    if ( (nLen != 0) && (nLen != (size_t)-1) )
+    if ( pwz && nLength != 0 )

     {
     {

-        //Convert string
-        size_t nRealSize;
-        wxCharBuffer theBuffer = conv.cWC2MB(pwz, nLen, &nRealSize);
+        if ( nLength == npos )
+        {
+            nLength = wxNO_LEN;
+        }
+
+        size_t nLenMB;
+        wxCharBuffer buf = conv.cWC2MB(pwz, nLength, &nLenMB);

 
 

-        //Copy
-        if (nRealSize)
-            assign( theBuffer.data() , nRealSize - 1 );
+        if ( nLenMB )
+            assign(buf, nLenMB);

     }
 }
 
 //Converts this string to a wide character string if unicode
 //mode is not enabled and wxUSE_WCHAR_T is enabled
     }
 }
 
 //Converts this string to a wide character string if unicode
 //mode is not enabled and wxUSE_WCHAR_T is enabled

-const wxWCharBuffer wxString::wc_str(wxMBConv& conv) const
+const wxWCharBuffer wxString::wc_str(const wxMBConv& conv) const

 {
 {

-    size_t dwOutSize;
-    return conv.cMB2WC(c_str(), length(), &dwOutSize);
+    return conv.cMB2WC(c_str(), length() + 1 /* size, not length */, NULL);

 }
 
 #endif // wxUSE_WCHAR_T
 }
 
 #endif // wxUSE_WCHAR_T


@@ -1201,70 +1104,70 @@ wxString& wxString::operator=(const wchar_t *pwz)
 wxString operator+(const wxString& str1, const wxString& str2)
 {
 #if !wxUSE_STL
 wxString operator+(const wxString& str1, const wxString& str2)
 {
 #if !wxUSE_STL

-  wxASSERT( str1.GetStringData()->IsValid() );
-  wxASSERT( str2.GetStringData()->IsValid() );
+    wxASSERT( str1.GetStringData()->IsValid() );
+    wxASSERT( str2.GetStringData()->IsValid() );

 #endif
 
 #endif
 

-  wxString s = str1;
-  s += str2;
+    wxString s = str1;
+    s += str2;

 
 

-  return s;
+    return s;

 }
 
 wxString operator+(const wxString& str, wxChar ch)
 {
 #if !wxUSE_STL
 }
 
 wxString operator+(const wxString& str, wxChar ch)
 {
 #if !wxUSE_STL

-  wxASSERT( str.GetStringData()->IsValid() );
+    wxASSERT( str.GetStringData()->IsValid() );

 #endif
 
 #endif
 

-  wxString s = str;
-  s += ch;
+    wxString s = str;
+    s += ch;

 
 

-  return s;
+    return s;

 }
 
 wxString operator+(wxChar ch, const wxString& str)
 {
 #if !wxUSE_STL
 }
 
 wxString operator+(wxChar ch, const wxString& str)
 {
 #if !wxUSE_STL

-  wxASSERT( str.GetStringData()->IsValid() );
+    wxASSERT( str.GetStringData()->IsValid() );

 #endif
 
 #endif
 

-  wxString s = ch;
-  s += str;
+    wxString s = ch;
+    s += str;

 
 

-  return s;
+    return s;

 }
 
 wxString operator+(const wxString& str, const wxChar *psz)
 {
 #if !wxUSE_STL
 }
 
 wxString operator+(const wxString& str, const wxChar *psz)
 {
 #if !wxUSE_STL

-  wxASSERT( str.GetStringData()->IsValid() );
+    wxASSERT( str.GetStringData()->IsValid() );

 #endif
 
 #endif
 

-  wxString s;
-  if ( !s.Alloc(wxStrlen(psz) + str.Len()) ) {
-    wxFAIL_MSG( _T("out of memory in wxString::operator+") );
-  }
-  s += str;
-  s += psz;
+    wxString s;
+    if ( !s.Alloc(wxStrlen(psz) + str.length()) ) {
+        wxFAIL_MSG( _T("out of memory in wxString::operator+") );
+    }
+    s += str;
+    s += psz;

 
 

-  return s;
+    return s;

 }
 
 wxString operator+(const wxChar *psz, const wxString& str)
 {
 #if !wxUSE_STL
 }
 
 wxString operator+(const wxChar *psz, const wxString& str)
 {
 #if !wxUSE_STL

-  wxASSERT( str.GetStringData()->IsValid() );
+    wxASSERT( str.GetStringData()->IsValid() );

 #endif
 
 #endif
 

-  wxString s;
-  if ( !s.Alloc(wxStrlen(psz) + str.Len()) ) {
-    wxFAIL_MSG( _T("out of memory in wxString::operator+") );
-  }
-  s = psz;
-  s += str;
+    wxString s;
+    if ( !s.Alloc(wxStrlen(psz) + str.length()) ) {
+        wxFAIL_MSG( _T("out of memory in wxString::operator+") );
+    }
+    s = psz;
+    s += str;

 
 

-  return s;
+    return s;

 }
 
 // ===========================================================================
 }
 
 // ===========================================================================


@@ -1455,6 +1358,27 @@ bool wxString::StartsWith(const wxChar *prefix, wxString *rest) const
     return true;
 }
 
     return true;
 }
 

+
+// check that the string ends with suffix and return the rest of it in the
+// provided pointer if it is not NULL, otherwise return false
+bool wxString::EndsWith(const wxChar *suffix, wxString *rest) const
+{
+    wxASSERT_MSG( suffix, _T("invalid parameter in wxString::EndssWith") );
+
+    int start = length() - wxStrlen(suffix);
+    if ( start < 0 || wxStrcmp(c_str() + start, suffix) != 0 )
+        return false;
+
+    if ( rest )
+    {
+        // put the rest of the string into provided pointer
+        rest->assign(*this, 0, start);
+    }
+
+    return true;
+}
+
+

 // extract nCount last (rightmost) characters
 wxString wxString::Right(size_t nCount) const
 {
 // extract nCount last (rightmost) characters
 wxString wxString::Right(size_t nCount) const
 {


@@ -1646,65 +1570,65 @@ inline int wxSafeIsspace(wxChar ch) { return (ch < 127) && wxIsspace(ch); }
 // trims spaces (in the sense of isspace) from left or right side
 wxString& wxString::Trim(bool bFromRight)
 {
 // trims spaces (in the sense of isspace) from left or right side
 wxString& wxString::Trim(bool bFromRight)
 {

-  // first check if we're going to modify the string at all
-  if ( !empty() &&
-       (
-        (bFromRight && wxSafeIsspace(GetChar(Len() - 1))) ||
-        (!bFromRight && wxSafeIsspace(GetChar(0u)))
+    // first check if we're going to modify the string at all
+    if ( !empty() &&
+         (
+          (bFromRight && wxSafeIsspace(GetChar(length() - 1))) ||
+          (!bFromRight && wxSafeIsspace(GetChar(0u)))
+         )

        )
        )

-     )
-  {
-    if ( bFromRight )

     {
     {

-      // find last non-space character
-      iterator psz = begin() + length() - 1;
-      while ( wxSafeIsspace(*psz) && (psz >= begin()) )
-        psz--;
-
-      // truncate at trailing space start
-      *++psz = wxT('\0');
-      erase(psz, end());
-    }
-    else
-    {
-      // find first non-space character
-      iterator psz = begin();
-      while ( wxSafeIsspace(*psz) )
-        psz++;
+        if ( bFromRight )
+        {
+            // find last non-space character
+            reverse_iterator psz = rbegin();
+            while ( (psz != rend()) && wxSafeIsspace(*psz) )
+                psz++;
+            
+            // truncate at trailing space start
+            erase(psz.base(), end());
+        }
+        else
+        {
+            // find first non-space character
+            iterator psz = begin();
+            while ( (psz != end()) && wxSafeIsspace(*psz) )
+                psz++;

 
 

-      // fix up data and length
-      erase(begin(), psz);
+            // fix up data and length
+            erase(begin(), psz);
+        }

     }
     }

-  }

 
 

-  return *this;
+    return *this;

 }
 
 // adds nCount characters chPad to the string from either side
 wxString& wxString::Pad(size_t nCount, wxChar chPad, bool bFromRight)
 {
 }
 
 // adds nCount characters chPad to the string from either side
 wxString& wxString::Pad(size_t nCount, wxChar chPad, bool bFromRight)
 {

-  wxString s(chPad, nCount);
+    wxString s(chPad, nCount);

 
 

-  if ( bFromRight )
-    *this += s;
-  else
-  {
-    s += *this;
-    swap(s);
-  }
+    if ( bFromRight )
+        *this += s;
+    else
+    {
+        s += *this;
+        swap(s);
+    }

 
 

-  return *this;
+    return *this;

 }
 
 // truncate the string
 wxString& wxString::Truncate(size_t uiLen)
 {
 }
 
 // truncate the string
 wxString& wxString::Truncate(size_t uiLen)
 {

-  if ( uiLen < Len() ) {
-    erase(begin() + uiLen, end());
-  }
-  //else: nothing to do, string is already short enough
+    if ( uiLen < length() )
+    {
+        erase(begin() + uiLen, end());
+    }
+    //else: nothing to do, string is already short enough

 
 

-  return *this;
+    return *this;

 }
 
 // ---------------------------------------------------------------------------
 }
 
 // ---------------------------------------------------------------------------


@@ -1714,17 +1638,17 @@ wxString& wxString::Truncate(size_t uiLen)
 // find a character
 int wxString::Find(wxChar ch, bool bFromEnd) const
 {
 // find a character
 int wxString::Find(wxChar ch, bool bFromEnd) const
 {

-  size_type idx = bFromEnd ? find_last_of(ch) : find_first_of(ch);
+    size_type idx = bFromEnd ? find_last_of(ch) : find_first_of(ch);

 
 

-  return (idx == npos) ? wxNOT_FOUND : (int)idx;
+    return (idx == npos) ? wxNOT_FOUND : (int)idx;

 }
 
 // find a sub-string (like strstr)
 int wxString::Find(const wxChar *pszSub) const
 {
 }
 
 // find a sub-string (like strstr)
 int wxString::Find(const wxChar *pszSub) const
 {

-  size_type idx = find(pszSub);
+    size_type idx = find(pszSub);

 
 

-  return (idx == npos) ? wxNOT_FOUND : (int)idx;
+    return (idx == npos) ? wxNOT_FOUND : (int)idx;

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -1817,7 +1741,7 @@ int wxString::PrintfV(const wxChar* pszFormat, va_list argptr)
     for ( ;; )
     {
         wxStringBuffer tmp(*this, size + 1);
     for ( ;; )
     {
         wxStringBuffer tmp(*this, size + 1);

-        wxChar* buf = tmp;
+        wxChar *buf = tmp;

 
         if ( !buf )
         {
 
         if ( !buf )
         {


@@ -1839,31 +1763,27 @@ int wxString::PrintfV(const wxChar* pszFormat, va_list argptr)
 
         // vsnprintf() may return either -1 (traditional Unix behaviour) or the
         // total number of characters which would have been written if the
 
         // vsnprintf() may return either -1 (traditional Unix behaviour) or the
         // total number of characters which would have been written if the

-        // buffer were large enough
-        if ( len >= 0 && len <= size )
+        // buffer were large enough (newer standards such as Unix98)
+        if ( len < 0 )

         {
         {

-            // ok, there was enough space
-            break;
+            // still not enough, as we don't know how much we need, double the
+            // current size of the buffer
+            size *= 2;

         }
         }

-
-#ifdef EOVERFLOW
-        // if the error is not due to not having enough space (it could be e.g.
-        // EILSEQ), break too -- we'd just eat all available memory uselessly
-        if ( errno != EOVERFLOW )
+        else if ( len > size )
+        {
+            size = len;
+        }
+        else // ok, there was enough space

         {
         {

-            // no sense in continuing

             break;
         }
             break;
         }

-#endif // EOVERFLOW
-
-        // still not enough, double it again
-        size *= 2;

     }
 
     // we could have overshot
     Shrink();
 
     }
 
     // we could have overshot
     Shrink();
 

-    return Len();
+    return length();

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -2012,7 +1932,7 @@ match:
 int wxString::Freq(wxChar ch) const
 {
     int count = 0;
 int wxString::Freq(wxChar ch) const
 {
     int count = 0;

-    int len = Len();
+    int len = length();

     for (int i = 0; i < len; i++)
     {
         if (GetChar(i) == ch)
     for (int i = 0; i < len; i++)
     {
         if (GetChar(i) == ch)


@@ -2441,19 +2361,7 @@ void wxArrayString::assign(const_iterator first, const_iterator last)
 #if wxUSE_THREADS
   // need a critical section to protect access to gs_compareFunction and
   // gs_sortAscending variables
 #if wxUSE_THREADS
   // need a critical section to protect access to gs_compareFunction and
   // gs_sortAscending variables

-  static wxCriticalSection *gs_critsectStringSort = NULL;
-
-  // call this before the value of the global sort vars is changed/after
-  // you're finished with them
-  #define START_SORT()     wxASSERT( !gs_critsectStringSort );                \
-                           gs_critsectStringSort = new wxCriticalSection;     \
-                           gs_critsectStringSort->Enter()
-  #define END_SORT()       gs_critsectStringSort->Leave();                    \
-                           delete gs_critsectStringSort;                      \
-                           gs_critsectStringSort = NULL
-#else // !threads
-  #define START_SORT()
-  #define END_SORT()
+  static wxCriticalSection gs_critsectStringSort;

 #endif // wxUSE_THREADS
 
 // function to use for string comparaison
 #endif // wxUSE_THREADS
 
 // function to use for string comparaison


@@ -2484,7 +2392,7 @@ wxStringCompareFunction(const void *first, const void *second)
 // sort array elements using passed comparaison function
 void wxArrayString::Sort(CompareFunction compareFunction)
 {
 // sort array elements using passed comparaison function
 void wxArrayString::Sort(CompareFunction compareFunction)
 {

-  START_SORT();
+  wxCRIT_SECT_LOCKER(lockCmpFunc, gs_critsectStringSort);

 
   wxASSERT( !gs_compareFunction );  // must have been reset to NULL
   gs_compareFunction = compareFunction;
 
   wxASSERT( !gs_compareFunction );  // must have been reset to NULL
   gs_compareFunction = compareFunction;


@@ -2493,8 +2401,6 @@ void wxArrayString::Sort(CompareFunction compareFunction)
 
   // reset it to NULL so that Sort(bool) will work the next time
   gs_compareFunction = NULL;
 
   // reset it to NULL so that Sort(bool) will work the next time
   gs_compareFunction = NULL;

-
-  END_SORT();

 }
 
 extern "C"
 }
 
 extern "C"