]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/string.cpp
Fixed doubled-up key effects in wxTextCtrl by resetting m_lastMsg to 0
[wxWidgets.git] / src / common / string.cpp
index 56808169b19521d747ab0806d05b36873b0f6f33..54a87d7ba5bb2006d656d4b0bd0308a69577f7a7 100644 (file)
@@ -10,7 +10,7 @@
 /////////////////////////////////////////////////////////////////////////////
 
 #ifdef __GNUG__
-#pragma implementation "string.h"
+  #pragma implementation "string.h"
 #endif
 
 /*
@@ -28,7 +28,7 @@
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
-#pragma hdrstop
+  #pragma hdrstop
 #endif
 
 #ifndef WX_PRECOMP
 #include <string.h>
 #include <stdlib.h>
 
+#ifdef __SALFORDC__
+  #include <clib.h>
+#endif
+
+#if wxUSE_WCSRTOMBS
+  #include <wchar.h>    // for wcsrtombs(), see comments where it's used
+#endif // GNU
+
 #ifdef  WXSTRING_IS_WXOBJECT
   IMPLEMENT_DYNAMIC_CLASS(wxString, wxObject)
 #endif  //WXSTRING_IS_WXOBJECT
@@ -54,9 +62,9 @@
 // static class variables definition
 // ---------------------------------------------------------------------------
 
-#ifdef  STD_STRING_COMPATIBILITY
-  const size_t wxString::npos = STRING_MAXLEN;
-#endif
+#ifdef  wxSTD_STRING_COMPATIBILITY
+  const size_t wxString::npos = wxSTRING_MAXLEN;
+#endif // wxSTD_STRING_COMPATIBILITY
 
 // ----------------------------------------------------------------------------
 // static data
@@ -72,37 +80,67 @@ static const struct
 } g_strEmpty = { {-1, 0, 0}, '\0' };
 
 // empty C style string: points to 'string data' byte of g_strEmpty
-extern const char *g_szNul = &g_strEmpty.dummy;
+extern const char WXDLLEXPORT *g_szNul = &g_strEmpty.dummy;
+
+// ----------------------------------------------------------------------------
+// conditional compilation
+// ----------------------------------------------------------------------------
+
+// we want to find out if the current platform supports vsnprintf()-like
+// function: for Unix this is done with configure, for Windows we test the
+// compiler explicitly.
+#ifdef __WXMSW__
+    #ifdef __VISUALC__
+        #define wxVsprintf     _vsnprintf
+    #endif
+#else   // !Windows
+    #ifdef HAVE_VSNPRINTF
+        #define wxVsprintf       vsnprintf
+    #endif
+#endif  // Windows/!Windows
+
+#ifndef wxVsprintf
+    // in this case we'll use vsprintf() (which is ANSI and thus should be
+    // always available), but it's unsafe because it doesn't check for buffer
+    // size - so give a warning
+    #define wxVsprintf(buffer,len,format,argptr) vsprintf(buffer,format, argptr)
+
+    #if defined(__VISUALC__)
+        #pragma message("Using sprintf() because no snprintf()-like function defined")
+    #elif defined(__GNUG__) && !defined(__UNIX__)
+        #warning "Using sprintf() because no snprintf()-like function defined"
+    #elif defined(__MWERKS__)
+           #warning "Using sprintf() because no snprintf()-like function defined"
+    #endif //compiler
+#endif // no vsnprintf
+
+#ifdef _AIX
+  // AIX has vsnprintf, but there's no prototype in the system headers.
+  extern "C" int vsnprintf(char* str, size_t n, const char* format, va_list ap);
+#endif
 
 // ----------------------------------------------------------------------------
 // global functions
 // ----------------------------------------------------------------------------
 
-#ifdef  STD_STRING_COMPATIBILITY
+#ifdef  wxSTD_STRING_COMPATIBILITY
 
 // 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!
-#if 0 // def  _MSC_VER
-  #include  <iostream>
-  #define   NAMESPACE   std::
-#else
-  #include  <iostream.h>
-  #define   NAMESPACE
-#endif  //Visual C++
 
-NAMESPACE istream& operator>>(NAMESPACE istream& is, wxString& WXUNUSED(str))
+istream& operator>>(istream& is, wxString& WXUNUSED(str))
 {
 #if 0
   int w = is.width(0);
   if ( is.ipfx(0) ) {
-    NAMESPACE streambuf *sb = is.rdbuf();
+    streambuf *sb = is.rdbuf();
     str.erase();
     while ( true ) {
       int ch = sb->sbumpc ();
       if ( ch == EOF ) {
-        is.setstate(NAMESPACE ios::eofbit);
+        is.setstate(ios::eofbit);
         break;
       }
       else if ( isspace(ch) ) {
@@ -118,7 +156,7 @@ NAMESPACE istream& operator>>(NAMESPACE istream& is, wxString& WXUNUSED(str))
 
   is.isfx();
   if ( str.length() == 0 )
-    is.setstate(NAMESPACE ios::failbit);
+    is.setstate(ios::failbit);
 #endif
   return is;
 }
@@ -183,7 +221,7 @@ void wxString::InitWith(const char *psz, size_t nPos, size_t nLength)
 
   wxASSERT( nPos <= Strlen(psz) );
 
-  if ( nLength == STRING_MAXLEN )
+  if ( nLength == wxSTRING_MAXLEN )
     nLength = Strlen(psz + nPos);
 
   STATISTICS_ADD(InitialLength, nLength);
@@ -201,7 +239,7 @@ wxString::wxString(const unsigned char* psz, size_t nLength)
   InitWith((const char *)psz, 0, nLength);
 }
 
-#ifdef  STD_STRING_COMPATIBILITY
+#ifdef  wxSTD_STRING_COMPATIBILITY
 
 // poor man's iterators are "void *" pointers
 wxString::wxString(const void *pStart, const void *pEnd)
@@ -216,7 +254,17 @@ wxString::wxString(const void *pStart, const void *pEnd)
 wxString::wxString(const wchar_t *pwz)
 {
   // first get necessary size
+
+  // NB: GNU libc5 wcstombs() is completely broken, don't use it (it doesn't
+  //     honor the 3rd parameter, thus it will happily crash here).
+#if wxUSE_WCSRTOMBS
+  // don't know if it's really needed (or if we can pass NULL), but better safe
+  // than quick
+  mbstate_t mbstate;  
+  size_t nLen = wcsrtombs((char *) NULL, &pwz, 0, &mbstate);
+#else  // !GNU libc
   size_t nLen = wcstombs((char *) NULL, pwz, 0);
+#endif // GNU
 
   // empty?
   if ( nLen != 0 ) {
@@ -279,6 +327,10 @@ void wxString::AllocBeforeWrite(size_t nLen)
     pData->Unlock();
     AllocBuffer(nLen);
   }
+  else {
+    // update the string length
+    pData->nDataLength = nLen;
+  }
 
   wxASSERT( !GetStringData()->IsShared() );  // we must be the only owner
 }
@@ -569,8 +621,8 @@ wxString wxString::Mid(size_t nFirst, size_t nCount) const
   wxStringData *pData = GetStringData();
   size_t nLen = pData->nDataLength;
 
-  // default value of nCount is STRING_MAXLEN and means "till the end"
-  if ( nCount == STRING_MAXLEN )
+  // default value of nCount is wxSTRING_MAXLEN and means "till the end"
+  if ( nCount == wxSTRING_MAXLEN )
   {
     nCount = nLen - nFirst;
   }
@@ -606,11 +658,11 @@ wxString wxString::Right(size_t nCount) const
 
 // get all characters after the last occurence of ch
 // (returns the whole string if ch not found)
-wxString wxString::Right(char ch) const
+wxString wxString::AfterLast(char ch) const
 {
   wxString str;
   int iPos = Find(ch, TRUE);
-  if ( iPos == NOT_FOUND )
+  if ( iPos == wxNOT_FOUND )
     str = *this;
   else
     str = c_str() + iPos + 1;
@@ -631,7 +683,7 @@ wxString wxString::Left(size_t nCount) const
 
 // get all characters before the first occurence of ch
 // (returns the whole string if ch not found)
-wxString wxString::Left(char ch) const
+wxString wxString::BeforeFirst(char ch) const
 {
   wxString str;
   for ( const char *pc = m_pchData; *pc != '\0' && *pc != ch; pc++ )
@@ -642,11 +694,11 @@ wxString wxString::Left(char ch) const
 
 /// get all characters before the last occurence of ch
 /// (returns empty string if ch not found)
-wxString wxString::Before(char ch) const
+wxString wxString::BeforeLast(char ch) const
 {
   wxString str;
   int iPos = Find(ch, TRUE);
-  if ( iPos != NOT_FOUND && iPos != 0 )
+  if ( iPos != wxNOT_FOUND && iPos != 0 )
     str = wxString(c_str(), iPos);
 
   return str;
@@ -654,11 +706,11 @@ wxString wxString::Before(char ch) const
 
 /// get all characters after the first occurence of ch
 /// (returns empty string if ch not found)
-wxString wxString::After(char ch) const
+wxString wxString::AfterFirst(char ch) const
 {
   wxString str;
   int iPos = Find(ch);
-  if ( iPos != NOT_FOUND )
+  if ( iPos != wxNOT_FOUND )
     str = c_str() + iPos + 1;
 
   return str;
@@ -805,7 +857,7 @@ wxString& wxString::Trim(bool bFromRight)
         psz++;
 
       // fix up data and length
-      int nDataLength = GetStringData()->nDataLength - (psz - m_pchData);
+      int nDataLength = GetStringData()->nDataLength - (psz - (const char*) m_pchData);
       memmove(m_pchData, psz, (nDataLength + 1)*sizeof(char));
       GetStringData()->nDataLength = nDataLength;
     }
@@ -833,14 +885,19 @@ wxString& wxString::Pad(size_t nCount, char chPad, bool bFromRight)
 // truncate the string
 wxString& wxString::Truncate(size_t uiLen)
 {
-  *(m_pchData + uiLen) = '\0';
-  GetStringData()->nDataLength = uiLen;
+  if ( uiLen < Len() ) {
+    CopyBeforeWrite();
+
+    *(m_pchData + uiLen) = '\0';
+    GetStringData()->nDataLength = uiLen;
+  }
+  //else: nothing to do, string is already short enough
 
   return *this;
 }
 
 // ---------------------------------------------------------------------------
-// finding (return NOT_FOUND if not found and index otherwise)
+// finding (return wxNOT_FOUND if not found and index otherwise)
 // ---------------------------------------------------------------------------
 
 // find a character
@@ -848,7 +905,7 @@ int wxString::Find(char ch, bool bFromEnd) const
 {
   const char *psz = bFromEnd ? strrchr(m_pchData, ch) : strchr(m_pchData, ch);
 
-  return (psz == NULL) ? NOT_FOUND : psz - m_pchData;
+  return (psz == NULL) ? wxNOT_FOUND : psz - (const char*) m_pchData;
 }
 
 // find a sub-string (like strstr)
@@ -856,7 +913,34 @@ int wxString::Find(const char *pszSub) const
 {
   const char *psz = strstr(m_pchData, pszSub);
 
-  return (psz == NULL) ? NOT_FOUND : psz - m_pchData;
+  return (psz == NULL) ? wxNOT_FOUND : psz - (const char*) m_pchData;
+}
+
+// ---------------------------------------------------------------------------
+// stream-like operators
+// ---------------------------------------------------------------------------
+wxString& wxString::operator<<(int i)
+{
+    wxString res;
+    res.Printf("%d", i);
+
+    return (*this) << res;
+}
+
+wxString& wxString::operator<<(float f)
+{
+    wxString res;
+    res.Printf("%f", f);
+
+    return (*this) << res;
+}
+
+wxString& wxString::operator<<(double d)
+{
+    wxString res;
+    res.Printf("%g", d);
+
+    return (*this) << res;
 }
 
 // ---------------------------------------------------------------------------
@@ -876,11 +960,41 @@ int wxString::Printf(const char *pszFormat, ...)
 
 int wxString::PrintfV(const char* pszFormat, va_list argptr)
 {
+  // static buffer to avoid dynamic memory allocation each time
   static char s_szScratch[1024];
 
-  int iLen = vsprintf(s_szScratch, pszFormat, argptr);
+  // NB: wxVsprintf() may return either less than the buffer size or -1 if there
+  //     is not enough place depending on implementation
+  int iLen = wxVsprintf(s_szScratch, WXSIZEOF(s_szScratch), pszFormat, argptr);
+  char *buffer;
+  if ( iLen < (int)WXSIZEOF(s_szScratch) ) {
+    buffer = s_szScratch;
+  }
+  else {
+      int size = WXSIZEOF(s_szScratch) * 2;
+      buffer = (char *)malloc(size);
+      while ( buffer != NULL ) {
+          iLen = wxVsprintf(buffer, WXSIZEOF(s_szScratch), pszFormat, argptr);
+          if ( iLen < size ) {
+              // ok, there was enough space
+              break;
+          }
+
+          // still not enough, double it again
+          buffer = (char *)realloc(buffer, size *= 2);
+      }
+
+      if ( !buffer ) {
+          // out of memory
+          return -1;
+      }
+  }
+
   AllocBeforeWrite(iLen);
-  strcpy(m_pchData, s_szScratch);
+  strcpy(m_pchData, buffer);
+
+  if ( buffer != s_szScratch )
+      free(buffer);
 
   return iLen;
 }
@@ -947,10 +1061,39 @@ bool wxString::Matches(const char *pszMask) const
   return *pszTxt == '\0';
 }
 
+// Count the number of chars
+int wxString::Freq(char ch) const
+{
+    int count = 0;
+    int len = Len();
+    for (int i = 0; i < len; i++)
+    {
+        if (GetChar(i) == ch)
+            count ++;
+    }
+    return count;
+}
+
+// convert to upper case, return the copy of the string
+wxString wxString::Upper() const
+{ wxString s(*this); return s.MakeUpper(); }
+
+// convert to lower case, return the copy of the string
+wxString wxString::Lower() const { wxString s(*this); return s.MakeLower(); }
+
+int wxString::sprintf(const char *pszFormat, ...)
+  {
+    va_list argptr;
+    va_start(argptr, pszFormat);
+    int iLen = PrintfV(pszFormat, argptr);
+    va_end(argptr);
+    return iLen;
+  }
+
 // ---------------------------------------------------------------------------
 // standard C++ library string functions
 // ---------------------------------------------------------------------------
-#ifdef  STD_STRING_COMPATIBILITY
+#ifdef  wxSTD_STRING_COMPATIBILITY
 
 wxString& wxString::insert(size_t nPos, const wxString& str)
 {
@@ -981,13 +1124,15 @@ size_t wxString::find(const wxString& str, size_t nStart) const
 }
 
 // VC++ 1.5 can't cope with the default argument in the header.
-#if ! (defined(_MSC_VER) && !defined(__WIN32__))
+#if !defined(__VISUALC__) || defined(__WIN32__)
 size_t wxString::find(const char* sz, size_t nStart, size_t n) const
 {
   return find(wxString(sz, n == npos ? 0 : n), nStart);
 }
-#endif
+#endif // VC++ 1.5
 
+// Gives a duplicate symbol (presumably a case-insensitivity problem)
+#if !defined(__BORLANDC__)
 size_t wxString::find(char ch, size_t nStart) const
 {
   wxASSERT( nStart <= Len() );
@@ -996,6 +1141,7 @@ size_t wxString::find(char ch, size_t nStart) const
 
   return p == NULL ? npos : p - c_str();
 }
+#endif
 
 size_t wxString::rfind(const wxString& str, size_t nStart) const
 {
@@ -1014,7 +1160,7 @@ size_t wxString::rfind(const wxString& str, size_t nStart) const
 }
 
 // VC++ 1.5 can't cope with the default argument in the header.
-#if ! (defined(_MSC_VER) && !defined(__WIN32__))
+#if !defined(__VISUALC__) || defined(__WIN32__)
 size_t wxString::rfind(const char* sz, size_t nStart, size_t n) const
 {
   return rfind(wxString(sz, n == npos ? 0 : n), nStart);
@@ -1028,7 +1174,7 @@ size_t wxString::rfind(char ch, size_t nStart) const
 
   return p == NULL ? npos : p - c_str();
 }
-#endif
+#endif // VC++ 1.5
 
 wxString wxString::substr(size_t nStart, size_t nLen) const
 {
@@ -1241,7 +1387,7 @@ int wxArrayString::Index(const char *sz, bool bCase, bool bFromEnd) const
     }
   }
 
-  return NOT_FOUND;
+  return wxNOT_FOUND;
 }
 
 // add item at the end
@@ -1292,16 +1438,89 @@ void wxArrayString::Remove(const char *sz)
 {
   int iIndex = Index(sz);
 
-  wxCHECK_RET( iIndex != NOT_FOUND,
+  wxCHECK_RET( iIndex != wxNOT_FOUND,
                _("removing inexistent element in wxArrayString::Remove") );
 
   Remove(iIndex);
 }
 
+// ----------------------------------------------------------------------------
+// sorting
+// ----------------------------------------------------------------------------
+
+// we can only sort one array at a time with the quick-sort based
+// implementation
+#if wxUSE_THREADS
+  #include <wx/thread.h>
+
+  // 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()
+#endif // wxUSE_THREADS
+
+// function to use for string comparaison
+static wxArrayString::CompareFunction gs_compareFunction = NULL;
+
+// if we don't use the compare function, this flag tells us if we sort the
+// array in ascending or descending order
+static bool gs_sortAscending = TRUE;
+
+// function which is called by quick sort
+static int wxStringCompareFunction(const void *first, const void *second)
+{
+  wxString *strFirst = (wxString *)first;
+  wxString *strSecond = (wxString *)second;
+
+  if ( gs_compareFunction ) {
+    return gs_compareFunction(*strFirst, *strSecond);
+  }
+  else {
+    int result = strcmp(strFirst->c_str(), strSecond->c_str());
+
+    return gs_sortAscending ? result : -result;
+  }
+}
+
 // sort array elements using passed comparaison function
+void wxArrayString::Sort(CompareFunction compareFunction)
+{
+  START_SORT();
+
+  wxASSERT( !gs_compareFunction );  // must have been reset to NULL
+  gs_compareFunction = compareFunction;
+
+  DoSort();
+
+  END_SORT();
+}
+
+void wxArrayString::Sort(bool reverseOrder)
+{
+  START_SORT();
+
+  wxASSERT( !gs_compareFunction );  // must have been reset to NULL
+  gs_sortAscending = !reverseOrder;
+
+  DoSort();
+
+  END_SORT();
+}
 
-void wxArrayString::Sort(bool WXUNUSED(bCase), bool WXUNUSED(bReverse) )
+void wxArrayString::DoSort()
 {
-  //@@@@ TO DO
-  //qsort(m_pItems, m_nCount, sizeof(char *), fCmp);
+  // just sort the pointers using qsort() - of course it only works because
+  // wxString() *is* a pointer to its data
+  qsort(m_pItems, m_nCount, sizeof(char *), wxStringCompareFunction);
 }