Updated wxSTC's copy of Scintilla to version 1.61

[wxWidgets.git] / include / wx / string.h

diff --git a/include/wx/string.h b/include/wx/string.h
index 0d8bcc184cfc8c24250def6a6467b4930f553528..888a1faaf44b6cef18f83b6e544434c296882fb9 100644 (file)
--- a/include/wx/string.h
+++ b/include/wx/string.h
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        string.h
+// Name:        wx/string.h

 // Purpose:     wxString and wxArrayString classes
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     wxString and wxArrayString classes
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -11,14 +11,14 @@
 
 /*
     Efficient string class [more or less] compatible with MFC CString,
 
 /*
     Efficient string class [more or less] compatible with MFC CString,

-    wxWindows version 1 wxString and std::string and some handy functions
+    wxWidgets version 1 wxString and std::string and some handy functions

     missing from string.h.
 */
 
 #ifndef _WX_WXSTRINGH__
 #define _WX_WXSTRINGH__
 
     missing from string.h.
 */
 
 #ifndef _WX_WXSTRINGH__
 #define _WX_WXSTRINGH__
 

-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "string.h"
 #endif
 
     #pragma interface "string.h"
 #endif
 


@@ -32,10 +32,6 @@
     #include <ctype.h>
 #endif
 
     #include <ctype.h>
 #endif
 

-#ifdef __EMX__
-    #include <std.h>
-#endif
-

 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
    // problem in VACPP V4 with including stdlib.h multiple times
    // strconv includes it anyway
 #if defined(__VISAGECPP__) && __IBMCPP__ >= 400
    // problem in VACPP V4 with including stdlib.h multiple times
    // strconv includes it anyway


@@ -51,14 +47,16 @@
 #  include <stdlib.h>
 #endif
 
 #  include <stdlib.h>
 #endif
 

-#ifdef HAVE_STRINGS_H
+#ifdef HAVE_STRCASECMP_IN_STRINGS_H

     #include <strings.h>    // for strcasecmp()
     #include <strings.h>    // for strcasecmp()

-#endif // HAVE_STRINGS_H
+#endif // HAVE_STRCASECMP_IN_STRINGS_H

 
 #include "wx/wxchar.h"      // for wxChar
 #include "wx/buffer.h"      // for wxCharBuffer
 #include "wx/strconv.h"     // for wxConvertXXX() macros and wxMBConv classes
 
 
 #include "wx/wxchar.h"      // for wxChar
 #include "wx/buffer.h"      // for wxCharBuffer
 #include "wx/strconv.h"     // for wxConvertXXX() macros and wxMBConv classes
 

+class WXDLLIMPEXP_BASE wxString;
+

 // ---------------------------------------------------------------------------
 // macros
 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------
 // macros
 // ---------------------------------------------------------------------------


@@ -138,7 +136,9 @@ inline int Stricmp(const char *psz1, const char *psz2)
   return stricmp(psz1, psz2);
 #elif defined(__WXPM__)
   return stricmp(psz1, psz2);
   return stricmp(psz1, psz2);
 #elif defined(__WXPM__)
   return stricmp(psz1, psz2);

-#elif defined(__UNIX__) || defined(__GNUWIN32__)
+#elif defined(HAVE_STRCASECMP_IN_STRING_H) || \
+      defined(HAVE_STRCASECMP_IN_STRINGS_H) || \
+      defined(__GNUWIN32__)

   return strcasecmp(psz1, psz2);
 #elif defined(__MWERKS__) && !defined(__INTEL__)
   register char c1, c2;
   return strcasecmp(psz1, psz2);
 #elif defined(__MWERKS__) && !defined(__INTEL__)
   register char c1, c2;


@@ -166,18 +166,17 @@ inline int Stricmp(const char *psz1, const char *psz2)
 #endif  // OS/compiler
 }
 
 #endif  // OS/compiler
 }
 

-// return an empty wxString
-class WXDLLIMPEXP_BASE wxString; // not yet defined
-inline const wxString& wxGetEmptyString() { return *(wxString *)&wxEmptyString; }
-

 #if wxUSE_STL
 
 #if wxUSE_STL
 

+// return an empty wxString (doesn't make much sense with wxUSE_STL == 1)
+inline const wxString wxGetEmptyString() { wxString(); }
+

 #include "wx/beforestd.h"
 #include <string>
 #include "wx/afterstd.h"
 
 #if wxUSE_UNICODE
 #include "wx/beforestd.h"
 #include <string>
 #include "wx/afterstd.h"
 
 #if wxUSE_UNICODE

-    #if HAVE_STD_WSTRING
+    #ifdef HAVE_STD_WSTRING

         typedef std::wstring wxStringBase;
     #else
         typedef std::basic_string<wxChar> wxStringBase;
         typedef std::wstring wxStringBase;
     #else
         typedef std::basic_string<wxChar> wxStringBase;


@@ -187,12 +186,15 @@ inline const wxString& wxGetEmptyString() { return *(wxString *)&wxEmptyString;
 #endif
 
 #if (defined(__GNUG__) && (__GNUG__ < 3)) || \
 #endif
 
 #if (defined(__GNUG__) && (__GNUG__ < 3)) || \

-    (defined(_MSC_VER) && (_MSC_VER <= 1100))
+    (defined(_MSC_VER) && (_MSC_VER <= 1200))

     #define wxSTRING_BASE_HASNT_CLEAR
 #endif
 
 #else // if !wxUSE_STL
 
     #define wxSTRING_BASE_HASNT_CLEAR
 #endif
 
 #else // if !wxUSE_STL
 

+// return an empty wxString
+inline const wxString& wxGetEmptyString() { return *(wxString *)&wxEmptyString; }
+

 #ifndef HAVE_STD_STRING_COMPARE
     #define HAVE_STD_STRING_COMPARE
 #endif
 #ifndef HAVE_STD_STRING_COMPARE
     #define HAVE_STD_STRING_COMPARE
 #endif


@@ -243,6 +245,9 @@ class WXDLLIMPEXP_BASE wxStringBase
 #if !wxUSE_STL
 friend class WXDLLIMPEXP_BASE wxArrayString;
 #endif
 #if !wxUSE_STL
 friend class WXDLLIMPEXP_BASE wxArrayString;
 #endif

+public :
+  // an 'invalid' value for string index, moved to this place due to a CW bug
+  static const size_t npos;

 protected:
   // points to data preceded by wxStringData structure with ref count info
   wxChar *m_pchData;
 protected:
   // points to data preceded by wxStringData structure with ref count info
   wxChar *m_pchData;


@@ -291,9 +296,6 @@ public:
   typedef value_type *iterator;
   typedef const value_type *const_iterator;
 
   typedef value_type *iterator;
   typedef const value_type *const_iterator;
 

-  // an 'invalid' value for string index
-  static const size_t npos;
-

   // constructors and destructor
     // ctor for an empty string
   wxStringBase() { Init(); }
   // constructors and destructor
     // ctor for an empty string
   wxStringBase() { Init(); }


@@ -335,8 +337,21 @@ public:
   wxStringBase(const void *pStart, const void *pEnd);
 
     // dtor is not virtual, this class must not be inherited from!
   wxStringBase(const void *pStart, const void *pEnd);
 
     // dtor is not virtual, this class must not be inherited from!

-  ~wxStringBase() { GetStringData()->Unlock(); }
+  ~wxStringBase()
+  {
+#if defined(__VISUALC__) && (__VISUALC__ >= 1200)
+      //RN - according to the above VC++ does indeed inline this,
+      //even though it spits out two warnings
+      #pragma warning (disable:4714)
+#endif
+
+      GetStringData()->Unlock();
+  }

 
 

+#if defined(__VISUALC__) && (__VISUALC__ >= 1200)
+    //re-enable inlining warning
+    #pragma warning (default:4714)
+#endif

   // overloaded assignment
     // from another wxString
   wxStringBase& operator=(const wxStringBase& stringSrc);
   // overloaded assignment
     // from another wxString
   wxStringBase& operator=(const wxStringBase& stringSrc);


@@ -418,9 +433,9 @@ public:
   const_iterator end() const { return m_pchData + length(); }
 
   // first valid index position
   const_iterator end() const { return m_pchData + length(); }
 
   // first valid index position

-  iterator begin() { CopyBeforeWrite(); return m_pchData; }
+  iterator begin();

   // position one after the last valid one
   // position one after the last valid one

-  iterator end() { CopyBeforeWrite(); return m_pchData + length(); }
+  iterator end();

 
     // insert another string
   wxStringBase& insert(size_t nPos, const wxStringBase& str)
 
     // insert another string
   wxStringBase& insert(size_t nPos, const wxStringBase& str)


@@ -443,7 +458,7 @@ public:
   wxStringBase& insert(size_t nPos, size_t n, wxChar ch)
     { return insert(nPos, wxStringBase(n, ch)); }
   iterator insert(iterator it, wxChar ch)
   wxStringBase& insert(size_t nPos, size_t n, wxChar ch)
     { return insert(nPos, wxStringBase(n, ch)); }
   iterator insert(iterator it, wxChar ch)

-    { size_t idx = it - begin(); insert(idx, 1, ch); return begin() + idx; } 
+    { size_t idx = it - begin(); insert(idx, 1, ch); return begin() + idx; }

   void insert(iterator it, const_iterator first, const_iterator last)
     { insert(it - begin(), first, last - first); }
   void insert(iterator it, size_type n, wxChar ch)
   void insert(iterator it, const_iterator first, const_iterator last)
     { insert(it - begin(), first, last - first); }
   void insert(iterator it, size_type n, wxChar ch)


@@ -505,11 +520,9 @@ public:
   size_t find(const wxChar* sz, size_t nStart = 0, size_t n = npos) const;
 #endif // VC++ 1.5
 
   size_t find(const wxChar* sz, size_t nStart = 0, size_t n = npos) const;
 #endif // VC++ 1.5
 

-  // 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;
     // find the first occurence of character ch after nStart
   size_t find(wxChar ch, size_t nStart = 0) const;

-#endif
+

     // rfind() family is exactly like find() but works right to left
 
     // as find, but from the end
     // rfind() family is exactly like find() but works right to left
 
     // as find, but from the end


@@ -529,6 +542,7 @@ public:
     { return find_first_of(str.c_str(), nStart); }
     // same as above
   size_t find_first_of(const wxChar* sz, 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;

+  size_t find_first_of(const wxChar* sz, size_t nStart, size_t n) const;

     // same as find(char, size_t)
   size_t find_first_of(wxChar c, size_t nStart = 0) const
     { return find(c, nStart); }
     // same as find(char, size_t)
   size_t find_first_of(wxChar c, size_t nStart = 0) const
     { return find(c, nStart); }


@@ -537,6 +551,7 @@ public:
     { return find_last_of(str.c_str(), nStart); }
     // same as above
   size_t find_last_of (const wxChar* sz, 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;

+  size_t find_last_of(const wxChar* sz, size_t nStart, size_t n) const;

     // same as above
   size_t find_last_of(wxChar c, size_t nStart = npos) const
     { return rfind(c, nStart); }
     // same as above
   size_t find_last_of(wxChar c, size_t nStart = npos) const
     { return rfind(c, nStart); }


@@ -548,13 +563,15 @@ public:
     { 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;
     { 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;

+  size_t find_first_not_of(const wxChar* sz, size_t nStart, size_t n) 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 wxStringBase& str, size_t nStart = npos) 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 wxStringBase& str, size_t nStart = npos) const

-    { return find_first_not_of(str.c_str(), nStart); }
+    { return find_last_not_of(str.c_str(), nStart); }

     // 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(const wxChar* sz, size_t nStart = npos) const;

+  size_t find_last_not_of(const wxChar* sz, size_t nStart, size_t n) const;

     // same as above
   size_t find_last_not_of(wxChar ch, size_t nStart = npos) const;
 
     // same as above
   size_t find_last_not_of(wxChar ch, size_t nStart = npos) const;
 


@@ -662,8 +679,6 @@ public:
 
 #if wxUSE_UNICODE
     // from multibyte string
 
 #if wxUSE_UNICODE
     // from multibyte string

-    // (NB: nLength is right now number of Unicode characters, not
-    //  characters in psz! So try not to use it yet!)

   wxString(const char *psz, wxMBConv& conv, size_t nLength = npos);
     // from wxWCharBuffer (i.e. return from wxGetString)
   wxString(const wxWCharBuffer& psz) : wxStringBase(psz.data()) { }
   wxString(const char *psz, wxMBConv& conv, size_t nLength = npos);
     // from wxWCharBuffer (i.e. return from wxGetString)
   wxString(const wxWCharBuffer& psz) : wxStringBase(psz.data()) { }


@@ -679,7 +694,7 @@ public:
 
     // from wxCharBuffer
   wxString(const wxCharBuffer& psz)
 
     // from wxCharBuffer
   wxString(const wxCharBuffer& psz)

-      : wxStringBase(psz, npos) { }
+      : wxStringBase(psz) { }

 #endif // Unicode/ANSI
 
   // generic attributes & operations
 #endif // Unicode/ANSI
 
   // generic attributes & operations


@@ -687,7 +702,7 @@ public:
   size_t Len() const { return length(); }
     // string contains any characters?
   bool IsEmpty() const { return empty(); }
   size_t Len() const { return length(); }
     // string contains any characters?
   bool IsEmpty() const { return empty(); }

-    // empty string is "FALSE", so !str will return TRUE
+    // empty string is "false", so !str will return true

   bool operator!() const { return IsEmpty(); }
     // truncate the string to given length
   wxString& Truncate(size_t uiLen);
   bool operator!() const { return IsEmpty(); }
     // truncate the string to given length
   wxString& Truncate(size_t uiLen);


@@ -967,10 +982,10 @@ public:
   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)
   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
+  bool IsSameAs(const wxChar *psz, bool compareWithCase = true) const

     { return (compareWithCase ? Cmp(psz) : CmpNoCase(psz)) == 0; }
     { return (compareWithCase ? Cmp(psz) : CmpNoCase(psz)) == 0; }

-    // comparison with a signle character: returns TRUE if equal
-  bool IsSameAs(wxChar c, bool compareWithCase = TRUE) const
+    // comparison with a signle character: returns true if equal
+  bool IsSameAs(wxChar c, bool compareWithCase = true) const

     {
       return (length() == 1) && (compareWithCase ? GetChar(0u) == c
                               : wxToupper(GetChar(0u)) == wxToupper(c));
     {
       return (length() == 1) && (compareWithCase ? GetChar(0u) == c
                               : wxToupper(GetChar(0u)) == wxToupper(c));


@@ -987,7 +1002,7 @@ public:
 
       // check that the string starts with prefix and return the rest of the
       // string in the provided pointer if it is not NULL, otherwise return
 
       // check that the string starts with prefix and return the rest of the
       // string in the provided pointer if it is not NULL, otherwise return

-      // FALSE
+      // false

   bool StartsWith(const wxChar *prefix, wxString *rest = NULL) const;
 
       // get first nCount characters
   bool StartsWith(const wxChar *prefix, wxString *rest = NULL) const;
 
       // get first nCount characters


@@ -1024,25 +1039,25 @@ public:
 
   // 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);
+  wxString& Trim(bool bFromRight = true);

       // add nCount copies chPad in the beginning or at the end (default)
       // add nCount copies chPad in the beginning or at the end (default)

-  wxString& Pad(size_t nCount, wxChar chPad = wxT(' '), bool bFromRight = TRUE);
+  wxString& Pad(size_t nCount, wxChar chPad = wxT(' '), bool bFromRight = true);

 
   // searching and replacing
       // searching (return starting index, or -1 if not found)
 
   // searching and replacing
       // searching (return starting index, or -1 if not found)

-  int Find(wxChar ch, bool bFromEnd = FALSE) const;   // like strchr/strrchr
+  int Find(wxChar ch, bool bFromEnd = false) const;   // like strchr/strrchr

       // searching (return starting index, or -1 if not found)
   int Find(const wxChar *pszSub) const;               // like strstr
       // replace first (or all of bReplaceAll) occurences of substring with
       // another string, returns the number of replacements made
   size_t Replace(const wxChar *szOld,
                  const wxChar *szNew,
       // searching (return starting index, or -1 if not found)
   int Find(const wxChar *pszSub) const;               // like strstr
       // replace first (or all of bReplaceAll) occurences of substring with
       // another string, returns the number of replacements made
   size_t Replace(const wxChar *szOld,
                  const wxChar *szNew,

-                 bool bReplaceAll = TRUE);
+                 bool bReplaceAll = true);

 
     // check if the string contents matches a mask containing '*' and '?'
   bool Matches(const wxChar *szMask) const;
 
 
     // check if the string contents matches a mask containing '*' and '?'
   bool Matches(const wxChar *szMask) const;
 

-    // conversion to numbers: all functions return TRUE only if the whole
+    // conversion to numbers: all functions return true only if the whole

     // string is a number and put the value of this number into the pointer
     // provided, the base is the numeric base in which the conversion should be
     // done and must be comprised between 2 and 36 or be 0 in which case the
     // string is a number and put the value of this number into the pointer
     // provided, the base is the numeric base in which the conversion should be
     // done and must be comprised between 2 and 36 or be 0 in which case the


@@ -1082,7 +1097,7 @@ public:
   void UngetWriteBuf(size_t nLen);
 #endif
 
   void UngetWriteBuf(size_t nLen);
 #endif
 

-  // wxWindows version 1 compatibility functions
+  // wxWidgets version 1 compatibility functions

 
   // use Mid()
   wxString SubString(size_t from, size_t to) const
 
   // use Mid()
   wxString SubString(size_t from, size_t to) const


@@ -1125,8 +1140,8 @@ public:
   int First( const wxChar ch ) const { return Find(ch); }
   int First( const wxChar* psz ) const { return Find(psz); }
   int First( const wxString &str ) const { return Find(str); }
   int First( const wxChar ch ) const { return Find(ch); }
   int First( const wxChar* psz ) const { return Find(psz); }
   int First( const wxString &str ) const { return Find(str); }

-  int Last( const wxChar ch ) const { return Find(ch, TRUE); }
-  bool Contains(const wxString& str) const { return Find(str) != -1; }
+  int Last( const wxChar ch ) const { return Find(ch, true); }
+  bool Contains(const wxString& str) const { return Find(str) != wxNOT_FOUND; }

 
     // use IsEmpty()
   bool IsNull() const { return IsEmpty(); }
 
     // use IsEmpty()
   bool IsNull() const { return IsEmpty(); }


@@ -1138,7 +1153,7 @@ public:
       : wxStringBase(str, nPos, nLen) { }
     // take all characters from pStart to pEnd
   wxString(const void *pStart, const void *pEnd)
       : wxStringBase(str, nPos, nLen) { }
     // take all characters from pStart to pEnd
   wxString(const void *pStart, const void *pEnd)

-      : wxStringBase((const char*)pStart, (const char*)pEnd) { }
+      : wxStringBase((const wxChar*)pStart, (const wxChar*)pEnd) { }

 #if wxUSE_STL
   wxString(const_iterator first, const_iterator last)
       : wxStringBase(first, last) { }
 #if wxUSE_STL
   wxString(const_iterator first, const_iterator last)
       : wxStringBase(first, last) { }


@@ -1211,7 +1226,7 @@ public:
   wxString& insert(size_t nPos, size_t n, wxChar ch)
     { return (wxString&)wxStringBase::insert(nPos, n, ch); }
   iterator insert(iterator it, wxChar ch)
   wxString& insert(size_t nPos, size_t n, wxChar ch)
     { return (wxString&)wxStringBase::insert(nPos, n, ch); }
   iterator insert(iterator it, wxChar ch)

-    { return wxStringBase::insert(it, ch); } 
+    { return wxStringBase::insert(it, ch); }

   void insert(iterator it, const_iterator first, const_iterator last)
     { wxStringBase::insert(it, first, last); }
   void insert(iterator it, size_type n, wxChar ch)
   void insert(iterator it, const_iterator first, const_iterator last)
     { wxStringBase::insert(it, first, last); }
   void insert(iterator it, size_type n, wxChar ch)