native font dialog implementation for mac os x 10.2+

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

diff --git a/include/wx/string.h b/include/wx/string.h
index 3c00f4a892f470940c48c49dea676885e75c663e..e05371a9e4b564412027f9edcf582f27456dc7e2 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,7 +11,7 @@
 
 /*
     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.
 */
 
     missing from string.h.
 */
 


@@ -47,9 +47,9 @@
 #  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/wxchar.h"      // for wxChar
 #include "wx/buffer.h"      // for wxCharBuffer


@@ -134,7 +134,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;


@@ -183,7 +185,7 @@ 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
 
     #define wxSTRING_BASE_HASNT_CLEAR
 #endif
 


@@ -216,8 +218,7 @@ struct WXDLLIMPEXP_BASE wxStringData
 
   // VC++ will refuse to inline Unlock but profiling shows that it is wrong
 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
 
   // VC++ will refuse to inline Unlock but profiling shows that it is wrong
 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)

-//     RN - VC6  Refuses to inline this anyway and spits out 2 warnings...
-//  __forceinline
+  __forceinline

 #endif
   // VC++ free must take place in same DLL as allocation when using non dll
   // run-time library (e.g. Multithreaded instead of Multithreaded DLL)
 #endif
   // VC++ free must take place in same DLL as allocation when using non dll
   // run-time library (e.g. Multithreaded instead of Multithreaded DLL)


@@ -332,8 +333,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);


@@ -415,9 +429,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)


@@ -440,7 +454,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)


@@ -661,8 +675,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()) { }


@@ -678,7 +690,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


@@ -686,7 +698,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);


@@ -966,10 +978,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));


@@ -986,7 +998,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


@@ -1023,25 +1035,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


@@ -1081,7 +1093,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


@@ -1124,8 +1136,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(); }


@@ -1137,7 +1149,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) { }


@@ -1210,7 +1222,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)