compilation fix for cygwin

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

diff --git a/include/wx/string.h b/include/wx/string.h
index 92c9058418974332b79dd57b2a70eee3b82d0e58..1c6dbc1f0b6a49201c5ae4278dff38e6c8a165dc 100644 (file)
--- a/include/wx/string.h
+++ b/include/wx/string.h
@@ -18,7 +18,7 @@
 #ifndef _WX_WXSTRINGH__
 #define _WX_WXSTRINGH__
 
 #ifndef _WX_WXSTRINGH__
 #define _WX_WXSTRINGH__
 

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

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


@@ -79,7 +79,7 @@
 
 // implementation only
 #define   wxASSERT_VALID_INDEX(i) \
 
 // implementation only
 #define   wxASSERT_VALID_INDEX(i) \

-    wxASSERT_MSG( (size_t)(i) <= Len(), _T("invaid index in wxString") )
+    wxASSERT_MSG( (size_t)(i) <= Len(), _T("invalid index in wxString") )

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -165,15 +165,6 @@ inline int Stricmp(const char *psz1, const char *psz2)
 #endif  // OS/compiler
 }
 
 #endif  // OS/compiler
 }
 

-// 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, ...);
-
-// 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 WXDLLEXPORT wxString; // not yet defined
 inline const wxString& wxGetEmptyString() { return *(wxString *)&wxEmptyString; }
 // return an empty wxString
 class WXDLLEXPORT wxString; // not yet defined
 inline const wxString& wxGetEmptyString() { return *(wxString *)&wxEmptyString; }


@@ -259,20 +250,20 @@ private:
   void Reinit() { GetStringData()->Unlock(); Init(); }
 
   // memory allocation
   void Reinit() { GetStringData()->Unlock(); Init(); }
 
   // memory allocation

-    // allocates memory for string of lenght nLen
-  void AllocBuffer(size_t nLen);
+    // allocates memory for string of length nLen
+  bool AllocBuffer(size_t nLen);

     // copies data to another string
     // copies data to another string

-  void AllocCopy(wxString&, int, int) const;
+  bool AllocCopy(wxString&, int, int) const;

     // effectively copies data to string
     // effectively copies data to string

-  void AssignCopy(size_t, const wxChar *);
+  bool AssignCopy(size_t, const wxChar *);

 
   // append a (sub)string
 
   // append a (sub)string

-  void ConcatSelf(int nLen, const wxChar *src);
+  bool 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)
 
   // 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);
+  bool CopyBeforeWrite();
+  bool AllocBeforeWrite(size_t);

 
   // if we hadn't made these operators private, it would be possible to
   // compile "wxString s; s = 17;" without any warnings as 17 is implicitly
 
   // if we hadn't made these operators private, it would be possible to
   // compile "wxString s; s = 17;" without any warnings as 17 is implicitly


@@ -292,11 +283,12 @@ private:
 public:
   // constructors and destructor
     // ctor for an empty string
 public:
   // constructors and destructor
     // ctor for an empty string

-  wxString() { Init(); }
+  wxString() : m_pchData(NULL) { Init(); }

     // copy ctor
     // copy ctor

-  wxString(const wxString& stringSrc)
+  wxString(const wxString& stringSrc) : m_pchData(NULL)

   {
   {

-    wxASSERT( stringSrc.GetStringData()->IsValid() );
+    wxASSERT_MSG( stringSrc.GetStringData()->IsValid(),
+                  _T("did you forget to call UngetWriteBuf()?") );

 
     if ( stringSrc.IsEmpty() ) {
       // nothing to do for an empty string
 
     if ( stringSrc.IsEmpty() ) {
       // nothing to do for an empty string


@@ -312,9 +304,11 @@ public:
     // 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)
     // 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); }
+      : m_pchData(NULL)
+      { InitWith(psz, 0, nLength); }

   wxString(const wxChar *psz, wxMBConv& WXUNUSED(conv), size_t nLength = wxSTRING_MAXLEN)
   wxString(const wxChar *psz, wxMBConv& WXUNUSED(conv), size_t nLength = wxSTRING_MAXLEN)

-    { InitWith(psz, 0, nLength); }
+      : m_pchData(NULL)
+      { InitWith(psz, 0, nLength); }

 
 #if wxUSE_UNICODE
     // from multibyte string
 
 #if wxUSE_UNICODE
     // from multibyte string


@@ -327,7 +321,8 @@ public:
 #else // ANSI
     // from C string (for compilers using unsigned char)
   wxString(const unsigned char* psz, size_t nLength = 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); }
+      : m_pchData(NULL)
+      { InitWith((const char*)psz, 0, nLength); }

 
 #if wxUSE_WCHAR_T
     // from wide (Unicode) string
 
 #if wxUSE_WCHAR_T
     // from wide (Unicode) string


@@ -336,7 +331,8 @@ public:
 
     // from wxCharBuffer
   wxString(const wxCharBuffer& psz)
 
     // from wxCharBuffer
   wxString(const wxCharBuffer& psz)

-    { InitWith(psz, 0, wxSTRING_MAXLEN); }
+      : m_pchData(NULL)
+      { InitWith(psz, 0, wxSTRING_MAXLEN); }

 #endif // Unicode/ANSI
 
     // dtor is not virtual, this class must not be inherited from!
 #endif // Unicode/ANSI
 
     // dtor is not virtual, this class must not be inherited from!


@@ -364,8 +360,9 @@ public:
     if ( !GetStringData()->IsEmpty() )
       Reinit();
 
     if ( !GetStringData()->IsEmpty() )
       Reinit();
 

-    wxASSERT( GetStringData()->nDataLength == 0 );  // should be empty
-    wxASSERT( GetStringData()->nAllocLength == 0 ); // and not own any memory
+    wxASSERT_MSG( !GetStringData()->nDataLength &&
+                  !GetStringData()->nAllocLength,
+                  _T("string should be empty after Clear()") );

   }
 
   // contents test
   }
 
   // contents test


@@ -389,10 +386,19 @@ public:
 
     // get last character
     wxChar  Last() const
 
     // get last character
     wxChar  Last() const

-      { wxASSERT( !IsEmpty() ); return m_pchData[Len() - 1]; }
+      {
+          wxASSERT_MSG( !IsEmpty(), _T("wxString: index out of bounds") );
+
+          return m_pchData[Len() - 1];
+      }
+

     // get writable last character
     wxChar& Last()
     // get writable last character
     wxChar& Last()

-      { wxASSERT( !IsEmpty() ); CopyBeforeWrite(); return m_pchData[Len()-1]; }
+      {
+          wxASSERT_MSG( !IsEmpty(), _T("wxString: index out of bounds") );
+          CopyBeforeWrite();
+          return m_pchData[Len()-1];
+      }

 
     /*
         So why do we have all these overloaded operator[]s? A bit of history:
 
     /*
         So why do we have all these overloaded operator[]s? A bit of history:


@@ -440,13 +446,28 @@ public:
 
     // implicit conversion to C string
     operator const wxChar*() const { return m_pchData; }
 
     // 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; }
     // explicit conversion to C string (use this with printf()!)
     const wxChar* c_str()   const { return m_pchData; }

-    // identical to c_str()
+    // identical to c_str(), for wxWin 1.6x compatibility

     const wxChar* wx_str()  const { return m_pchData; }
     const wxChar* wx_str()  const { return m_pchData; }

-    // identical to c_str()
+    // identical to c_str(), for MFC compatibility

     const wxChar* GetData() const { return m_pchData; }
 
     const wxChar* GetData() const { return m_pchData; }
 

+    // conversion to/from plain (i.e. 7 bit) ASCII: this is useful for
+    // converting numbers or strings which are certain not to contain special
+    // chars (typically system functions, X atoms, environment variables etc.)
+    //
+    // the behaviour of these functions with the strings containing anything
+    // else than 7 bit ASCII characters is undefined, use at your own risk.
+#if wxUSE_UNICODE
+    static wxString FromAscii(const char *ascii);
+    const wxCharBuffer ToAscii() const;
+#else // ANSI
+    static wxString FromAscii(const char *ascii) { return wxString( ascii ); }
+    const char *ToAscii() const { return c_str(); }
+#endif // Unicode/!Unicode
+

     // conversions with (possible) format convertions: have to return a
     // buffer with temporary data
     //
     // conversions with (possible) format convertions: have to return a
     // buffer with temporary data
     //


@@ -497,7 +518,8 @@ public:
   wxString& operator=(const wxChar *psz);
 #if wxUSE_UNICODE
     // from wxWCharBuffer
   wxString& operator=(const wxChar *psz);
 #if wxUSE_UNICODE
     // from wxWCharBuffer

-  wxString& operator=(const wxWCharBuffer& psz) { return operator=((const wchar_t *)psz); }
+  wxString& operator=(const wxWCharBuffer& psz)
+  { (void) operator=((const wchar_t *)psz); return *this; }

 #else // ANSI
     // from another kind of C string
   wxString& operator=(const unsigned char* psz);
 #else // ANSI
     // from another kind of C string
   wxString& operator=(const unsigned char* psz);


@@ -506,7 +528,8 @@ public:
   wxString& operator=(const wchar_t *pwz);
 #endif
     // from wxCharBuffer
   wxString& operator=(const wchar_t *pwz);
 #endif
     // from wxCharBuffer

-  wxString& operator=(const wxCharBuffer& psz) { return operator=((const char *)psz); }
+  wxString& operator=(const wxCharBuffer& psz)
+  { (void) operator=((const char *)psz); return *this; }

 #endif // Unicode/ANSI
 
   // string concatenation
 #endif // Unicode/ANSI
 
   // string concatenation


@@ -519,7 +542,8 @@ public:
       // string += string
   wxString& operator<<(const wxString& s)
   {
       // string += string
   wxString& operator<<(const wxString& s)
   {

-    wxASSERT( s.GetStringData()->IsValid() );
+    wxASSERT_MSG( s.GetStringData()->IsValid(),
+                  _T("did you forget to call UngetWriteBuf()?") );

 
     ConcatSelf(s.Len(), s);
     return *this;
 
     ConcatSelf(s.Len(), s);
     return *this;


@@ -539,14 +563,27 @@ public:
 
       // string += buffer (i.e. from wxGetString)
 #if wxUSE_UNICODE
 
       // 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
+  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 // !wxUSE_UNICODE
+  wxString& operator<<(const wxCharBuffer& s)
+    { (void)operator<<((const char *)s); return *this; }
+  void operator+=(const wxCharBuffer& s)
+    { (void)operator<<((const char *)s); }
+#endif // wxUSE_UNICODE/!wxUSE_UNICODE

 
     // string += C string
 
     // string += C string

+  wxString& Append(const wxString& s)
+    {
+        // test for IsEmpty() to share the string if possible
+        if ( IsEmpty() )
+            *this = s;
+        else
+            ConcatSelf(s.Length(), s.c_str());
+        return *this;
+    }

   wxString& Append(const wxChar* psz)
     { ConcatSelf(wxStrlen(psz), psz); return *this; }
     // append count copies of given character
   wxString& Append(const wxChar* psz)
     { ConcatSelf(wxStrlen(psz), psz); return *this; }
     // append count copies of given character


@@ -687,22 +724,23 @@ public:
 
   // formated input/output
     // as sprintf(), returns the number of characters written or < 0 on error
 
   // formated input/output
     // as sprintf(), returns the number of characters written or < 0 on error

-  int Printf(const wxChar *pszFormat, ...);
+    // (take 'this' into account in attribute parameter count)
+  int Printf(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_2;

     // 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
     // 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, ...);
+  static wxString Format(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_1;

     // 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
     // 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(size_t nLen);
+  bool Alloc(size_t nLen);

     // minimize the string's memory
     // only works if the data of this string is not shared
     // minimize the string's memory
     // only works if the data of this string is not shared

-  void Shrink();
+  bool 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!
   wxChar *GetWriteBuf(size_t nLen);
     // 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);


@@ -720,8 +758,9 @@ public:
     // values for first parameter of Strip function
   enum stripType {leading = 0x1, trailing = 0x2, both = 0x3};
 
     // values for first parameter of Strip function
   enum stripType {leading = 0x1, trailing = 0x2, both = 0x3};
 

-    // use Printf()
-  int sprintf(const wxChar *pszFormat, ...);
+  // use Printf()
+  // (take 'this' into account in attribute parameter count)
+  int sprintf(const wxChar *pszFormat, ...) ATTRIBUTE_PRINTF_2;

 
     // use Cmp()
   inline int CompareTo(const wxChar* psz, caseCompare cmp = exact) const
 
     // use Cmp()
   inline int CompareTo(const wxChar* psz, caseCompare cmp = exact) const


@@ -770,8 +809,11 @@ public:
   // constructors
     // take nLen chars starting at nPos
   wxString(const wxString& str, size_t nPos, size_t nLen)
   // constructors
     // take nLen chars starting at nPos
   wxString(const wxString& str, size_t nPos, size_t nLen)

+      : m_pchData(NULL)

   {
   {

-    wxASSERT( str.GetStringData()->IsValid() );
+    wxASSERT_MSG( str.GetStringData()->IsValid(),
+                  _T("did you forget to call UngetWriteBuf()?") );
+

     InitWith(str.c_str(), nPos, nLen == npos ? 0 : nLen);
   }
     // take all characters from pStart to pEnd
     InitWith(str.c_str(), nPos, nLen == npos ? 0 : nLen);
   }
     // take all characters from pStart to pEnd


@@ -978,7 +1020,9 @@ public:
 
   // constructors and destructor
     // default ctor
 
   // constructors and destructor
     // default ctor

-  wxArrayString() { Init(FALSE); }
+  wxArrayString()
+      : m_nSize(0), m_nCount(0), m_pItems(NULL), m_autoSort(FALSE)
+      { Init(FALSE); }

     // if autoSort is TRUE, the array is always sorted (in alphabetical order)
     //
     // NB: the reason for using int and not bool is that like this we can avoid
     // if autoSort is TRUE, the array is always sorted (in alphabetical order)
     //
     // NB: the reason for using int and not bool is that like this we can avoid


@@ -987,7 +1031,9 @@ public:
     //
     //     of course, using explicit would be even better - if all compilers
     //     supported it...
     //
     //     of course, using explicit would be even better - if all compilers
     //     supported it...

-  wxArrayString(int autoSort) { Init(autoSort != 0); }
+  wxArrayString(int autoSort)
+      : m_nSize(0), m_nCount(0), m_pItems(NULL), m_autoSort(FALSE)
+      { Init(autoSort != 0); }

     // copy ctor
   wxArrayString(const wxArrayString& array);
     // assignment operator
     // copy ctor
   wxArrayString(const wxArrayString& array);
     // assignment operator


@@ -1016,11 +1062,22 @@ public:
   // items access (range checking is done in debug version)
     // get item at position uiIndex
   wxString& Item(size_t nIndex) const
   // 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]); }
+    {
+        wxASSERT_MSG( nIndex < m_nCount,
+                      _T("wxArrayString: index out of bounds") );
+
+        return *(wxString *)&(m_pItems[nIndex]);
+    }
+

     // same as Item()
   wxString& operator[](size_t nIndex) const { return Item(nIndex); }
     // get last item
     // same as Item()
   wxString& operator[](size_t nIndex) const { return Item(nIndex); }
     // get last item

-  wxString& Last() const { wxASSERT( !IsEmpty() ); return Item(Count() - 1); }
+  wxString& Last() const
+  {
+      wxASSERT_MSG( !IsEmpty(),
+                    _T("wxArrayString: index out of bounds") );
+      return Item(Count() - 1);
+  }

 
     // return a wxString[], useful for the controls which
     // take one in their ctor.  You must delete[] it yourself
 
     // return a wxString[], useful for the controls which
     // take one in their ctor.  You must delete[] it yourself


@@ -1095,7 +1152,8 @@ class WXDLLEXPORT wxStringBuffer
 {
 public:
     wxStringBuffer(wxString& str, size_t lenWanted = 1024)
 {
 public:
     wxStringBuffer(wxString& str, size_t lenWanted = 1024)

-        : m_str(str) { m_buf = m_str.GetWriteBuf(lenWanted); }
+        : m_str(str), m_buf(NULL)
+        { m_buf = m_str.GetWriteBuf(lenWanted); }

 
     ~wxStringBuffer() { m_str.UngetWriteBuf(); }
 
 
     ~wxStringBuffer() { m_str.UngetWriteBuf(); }
 


@@ -1104,6 +1162,8 @@ public:
 private:
     wxString& m_str;
     wxChar   *m_buf;
 private:
     wxString& m_str;
     wxChar   *m_buf;

+
+    DECLARE_NO_COPY_CLASS(wxStringBuffer)

 };
 
 // ---------------------------------------------------------------------------
 };
 
 // ---------------------------------------------------------------------------