]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/string.h
more stream-like insertion operators
[wxWidgets.git] / include / wx / string.h
index 97e65cc9415dabf6a21c95beeece6d4445e81760..f9155fbf60e9114c06c8a3bbb3bddff225be913f 100644 (file)
 // Licence:     wxWindows license
 ///////////////////////////////////////////////////////////////////////////////
 
+/*
+    Efficient string class [more or less] compatible with MFC CString,
+    wxWindows version 1 wxString and std::string and some handy functions
+    missing from string.h.
+*/
+
 #ifndef _WX_WXSTRINGH__
 #define _WX_WXSTRINGH__
 
 #ifdef __GNUG__
-#pragma interface "string.h"
+    #pragma interface "string.h"
+#endif
+
+// ----------------------------------------------------------------------------
+// conditinal compilation
+// ----------------------------------------------------------------------------
+
+// compile the std::string compatibility functions if defined
+#define   wxSTD_STRING_COMPATIBILITY
+
+// define to derive wxString from wxObject (deprecated!)
+#ifdef WXSTRING_IS_WXOBJECT
+    #undef WXSTRING_IS_WXOBJECT
 #endif
 
-#ifdef __WXMAC__
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+#if defined(__WXMAC__) || defined(__VISAGECPP__)
     #include <ctype.h>
 #endif
 
-#include <string.h>
-#include <stdio.h>
-#include <stdarg.h>
-#include <limits.h>
-#include <stdlib.h>
+#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
+#  include <stdio.h>
+#  include <string.h>
+#  include <stdarg.h>
+#  include <limits.h>
+#else
+#  include <string.h>
+#  include <stdio.h>
+#  include <stdarg.h>
+#  include <limits.h>
+#  include <stdlib.h>
+#endif
 
 #ifdef HAVE_STRINGS_H
     #include <strings.h>    // for strcasecmp()
 #endif // AIX
 
-#ifndef  WX_PRECOMP
-  #include "wx/defs.h"
+#include "wx/defs.h"        // everybody should include this
+#include "wx/debug.h"       // for wxASSERT()
+#include "wx/wxchar.h"      // for wxChar
+#include "wx/buffer.h"      // for wxCharBuffer
+#include "wx/strconv.h"     // for wxConvertXXX() macros and wxMBConv classes
 
+#ifndef  WX_PRECOMP
   #ifdef    WXSTRING_IS_WXOBJECT
-    #include "wx/object.h"
+    #include "wx/object.h" // base class
   #endif
 #endif // !PCH
 
-#include "wx/debug.h"
-
-/*
-    Efficient string class [more or less] compatible with MFC CString,
-    wxWindows version 1 wxString and std::string and some handy functions
-    missing from string.h.
-*/
-
 // ---------------------------------------------------------------------------
 // macros
 // ---------------------------------------------------------------------------
 
-// compile the std::string compatibility functions if defined
-#define   wxSTD_STRING_COMPATIBILITY
+// 'naughty' cast
+#define   WXSTRINGCAST (wxChar *)(const wxChar *)
+#define   wxCSTRINGCAST (wxChar *)(const wxChar *)
+#define   wxMBSTRINGCAST (char *)(const char *)
+#define   wxWCSTRINGCAST (wchar_t *)(const wchar_t *)
 
-// define to derive wxString from wxObject
-#ifdef    WXSTRING_IS_WXOBJECT
-#undef    WXSTRING_IS_WXOBJECT
-#endif
+// implementation only
+#define   ASSERT_VALID_INDEX(i) wxASSERT( (unsigned)(i) <= Len() )
+
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
 
 // maximum possible length for a string means "take all string" everywhere
-//  (as sizeof(StringData) is unknown here we substract 100)
+//  (as sizeof(StringData) is unknown here, we substract 100)
 const unsigned int wxSTRING_MAXLEN = UINT_MAX - 100;
 
-// 'naughty' cast
-#define   WXSTRINGCAST (char *)(const char *)
+// ----------------------------------------------------------------------------
+// global data
+// ----------------------------------------------------------------------------
 
-// implementation only
-#define   ASSERT_VALID_INDEX(i) wxASSERT( (unsigned)(i) < Len() )
+// global pointer to empty string
+WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
 
 // ---------------------------------------------------------------------------
-// Global functions complementing standard C string library replacements for
+// global functions complementing standard C string library replacements for
 // strlen() and portable strcasecmp()
 //---------------------------------------------------------------------------
 
+// Use wxXXX() functions from wxchar.h instead! These functions are for
+// backwards compatibility only.
+
 // checks whether the passed in pointer is NULL and if the string is empty
 inline bool WXDLLEXPORT IsEmpty(const char *p) { return (!p || !*p); }
 
@@ -83,17 +123,21 @@ inline size_t WXDLLEXPORT Strlen(const char *psz)
 // portable strcasecmp/_stricmp
 inline int WXDLLEXPORT Stricmp(const char *psz1, const char *psz2)
 {
-#if     defined(__VISUALC__) || ( defined(__MWERKS__) && defined(__INTEL__) )
+#if defined(__VISUALC__) || ( defined(__MWERKS__) && defined(__INTEL__) )
   return _stricmp(psz1, psz2);
-#elif     defined(__SC__)
+#elif defined(__SC__)
   return _stricmp(psz1, psz2);
-#elif     defined(__SALFORDC__)
+#elif defined(__SALFORDC__)
   return stricmp(psz1, psz2);
 #elif defined(__BORLANDC__)
   return stricmp(psz1, psz2);
 #elif defined(__WATCOMC__)
   return stricmp(psz1, psz2);
-#elif   defined(__UNIX__) || defined(__GNUWIN32__)
+#elif defined(__EMX__)
+  return stricmp(psz1, psz2);
+#elif defined(__WXPM__)
+  return stricmp(psz1, psz2);
+#elif defined(__UNIX__) || defined(__GNUWIN32__)
   return strcasecmp(psz1, psz2);
 #elif defined(__MWERKS__) && !defined(__INTEL__)
   register char c1, c2;
@@ -121,31 +165,32 @@ inline int WXDLLEXPORT Stricmp(const char *psz1, const char *psz2)
 #endif  // OS/compiler
 }
 
-// ----------------------------------------------------------------------------
-// global data
-// ----------------------------------------------------------------------------
+// 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, ...);
 
-WXDLLEXPORT_DATA(extern const char*) wxEmptyString;
-
-// global pointer to empty string
-WXDLLEXPORT_DATA(extern const char*) g_szNul;
+// 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 *)&g_szNul; }
+inline const wxString& wxGetEmptyString() { return *(wxString *)&wxEmptyString; }
 
 // ---------------------------------------------------------------------------
 // string data prepended with some housekeeping info (used by wxString class),
 // is never used directly (but had to be put here to allow inlining)
 // ---------------------------------------------------------------------------
+
 struct WXDLLEXPORT wxStringData
 {
   int     nRefs;        // reference count
   size_t  nDataLength,  // actual string length
           nAllocLength; // allocated memory size
 
-  // mimics declaration 'char data[nAllocLength]'
-  char* data() const { return (char*)(this + 1); }
+  // mimics declaration 'wxChar data[nAllocLength]'
+  wxChar* data() const { return (wxChar*)(this + 1); }
 
   // empty string has a special ref count so it's never deleted
   bool  IsEmpty()   const { return (nRefs == -1); }
@@ -200,7 +245,7 @@ friend class WXDLLEXPORT wxArrayString;
   //     performace critical functions are still inlined if you change order!
 private:
   // points to data preceded by wxStringData structure with ref count info
-  char *m_pchData;
+  wxChar *m_pchData;
 
   // accessor to string data
   wxStringData* GetStringData() const { return (wxStringData*)m_pchData - 1; }
@@ -208,9 +253,9 @@ private:
   // string (re)initialization functions
     // initializes the string to the empty value (must be called only from
     // ctors, use Reinit() otherwise)
-  void Init() { m_pchData = (char *)g_szNul; }
+  void Init() { m_pchData = (wxChar *)wxEmptyString; }
     // initializaes the string with (a part of) C-string
-  void InitWith(const char *psz, size_t nPos = 0, size_t nLen = wxSTRING_MAXLEN);
+  void InitWith(const wxChar *psz, size_t nPos = 0, size_t nLen = wxSTRING_MAXLEN);
     // as Init, but also frees old data
   void Reinit() { GetStringData()->Unlock(); Init(); }
 
@@ -220,10 +265,10 @@ private:
     // copies data to another string
   void AllocCopy(wxString&, int, int) const;
     // effectively copies data to string
-  void AssignCopy(size_t, const char *);
+  void AssignCopy(size_t, const wxChar *);
 
   // append a (sub)string
-  void ConcatSelf(int nLen, const char *src);
+  void 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)
@@ -235,7 +280,9 @@ private:
   //
   // try `s << i' or `s.Printf("%d", i)' instead
   wxString(int);
+  wxString(unsigned int);
   wxString(long);
+  wxString(unsigned long);
 
 public:
   // constructors and destructor
@@ -256,15 +303,38 @@ public:
     }
   }
     // string containing nRepeat copies of ch
-  wxString(char ch, size_t nRepeat = 1);
+  wxString(wxChar ch, size_t nRepeat = 1);
     // ctor takes first nLength characters from C string
     // (default value of wxSTRING_MAXLEN means take all the string)
-  wxString(const char *psz, size_t nLength = wxSTRING_MAXLEN)
+  wxString(const wxChar *psz, size_t nLength = wxSTRING_MAXLEN)
     { InitWith(psz, 0, nLength); }
+
+#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 = wxConvLibc, size_t nLength = wxSTRING_MAXLEN);
+    // from wxWCharBuffer (i.e. return from wxGetString)
+  wxString(const wxWCharBuffer& psz)
+    { InitWith(psz, 0, wxSTRING_MAXLEN); }
+#else // ANSI
     // from C string (for compilers using unsigned char)
-  wxString(const unsigned char* psz, size_t nLength = wxSTRING_MAXLEN);
-    // from wide (UNICODE) string
+  wxString(const unsigned char* psz, size_t nLength = wxSTRING_MAXLEN)
+    { InitWith((const char*)psz, 0, nLength); }
+    // from multibyte string
+  wxString(const char *psz, wxMBConv& WXUNUSED(conv) , size_t nLength = wxSTRING_MAXLEN)
+    { InitWith(psz, 0, nLength); }
+
+#if wxUSE_WCHAR_T
+    // from wide (Unicode) string
   wxString(const wchar_t *pwz);
+#endif // !wxUSE_WCHAR_T
+
+    // from wxCharBuffer
+  wxString(const wxCharBuffer& psz)
+    { InitWith(psz, 0, wxSTRING_MAXLEN); }
+#endif // Unicode/ANSI
+
     // dtor is not virtual, this class must not be inherited from!
  ~wxString() { GetStringData()->Unlock(); }
 
@@ -304,56 +374,101 @@ public:
 
   // data access (all indexes are 0 based)
     // read access
-    char  GetChar(size_t n) const
+    wxChar  GetChar(size_t n) const
       { ASSERT_VALID_INDEX( n );  return m_pchData[n]; }
     // read/write access
-    char& GetWritableChar(size_t n)
+    wxChar& GetWritableChar(size_t n)
       { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
     // write access
-    void  SetChar(size_t n, char ch)
+    void  SetChar(size_t n, wxChar ch)
       { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); m_pchData[n] = ch; }
 
     // get last character
-    char  Last() const
+    wxChar  Last() const
       { wxASSERT( !IsEmpty() ); return m_pchData[Len() - 1]; }
     // get writable last character
-    char& Last()
+    wxChar& Last()
       { wxASSERT( !IsEmpty() ); CopyBeforeWrite(); return m_pchData[Len()-1]; }
 
-    // under Unix it is tested with configure, assume it works on other
-    // platforms (there might be overloading problems if size_t and int are
-    // the same type)
-#if !defined(__UNIX__) || defined(wxUSE_SIZE_T_STRING_OPERATOR)
     // operator version of GetChar
-    char  operator[](size_t n) const
+    wxChar  operator[](size_t n) const
       { ASSERT_VALID_INDEX( n ); return m_pchData[n]; }
-#endif
 
     // operator version of GetChar
-    char  operator[](int n) const
+    wxChar  operator[](int n) const
+      { ASSERT_VALID_INDEX( n ); return m_pchData[n]; }
+#ifdef __alpha__
+    // operator version of GetChar
+    wxChar  operator[](unsigned int n) const
       { ASSERT_VALID_INDEX( n ); return m_pchData[n]; }
-    // operator version of GetWritableChar
-    char& operator[](size_t n)
+#endif
+
+    // operator version of GetWriteableChar
+    wxChar& operator[](size_t n)
+      { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
+#ifdef __alpha__
+    // operator version of GetWriteableChar
+    wxChar&  operator[](unsigned int n)
       { ASSERT_VALID_INDEX( n ); CopyBeforeWrite(); return m_pchData[n]; }
+#endif
 
     // implicit conversion to C string
-    operator const char*() const { return m_pchData; }
+    operator const wxChar*() const { return m_pchData; }
     // explicit conversion to C string (use this with printf()!)
-    const char* c_str()   const { return m_pchData; }
-    //
-    const char* GetData() const { return m_pchData; }
+    const wxChar* c_str()   const { return m_pchData; }
+    // (and this with [wx]Printf()!)
+    const wxChar* wx_str()  const { return m_pchData; }
+    // identical to c_str()
+    const wxChar* GetData() const { return m_pchData; }
+
+    // conversions with (possible) format convertions: have to return a
+    // buffer with temporary data
+#if wxUSE_UNICODE
+    const wxCharBuffer mb_str(wxMBConv& conv = wxConvLibc) const { return conv.cWC2MB(m_pchData); }
+    const wxWX2MBbuf mbc_str() const { return mb_str(*wxConvCurrent); }
+
+    const wxChar* wc_str(wxMBConv& WXUNUSED(conv) = wxConvLibc) const { return m_pchData; }
+
+#if wxMBFILES
+    const wxCharBuffer fn_str() const { return mb_str(wxConvFile); }
+#else // !wxMBFILES
+    const wxChar* fn_str() const { return m_pchData; }
+#endif // wxMBFILES/!wxMBFILES
+#else // ANSI
+#if wxUSE_MULTIBYTE
+    const wxChar* mb_str(wxMBConv& WXUNUSED(conv) = wxConvLibc) const
+        { return m_pchData; }
+    const wxWX2MBbuf mbc_str() const { return mb_str(*wxConvCurrent); }
+#else // !mmultibyte
+    const wxChar* mb_str() const { return m_pchData; }
+    const wxWX2MBbuf mbc_str() const { return mb_str(); }
+#endif // multibyte/!multibyte
+#if wxUSE_WCHAR_T
+    const wxWCharBuffer wc_str(wxMBConv& conv) const { return conv.cMB2WC(m_pchData); }
+#endif // wxUSE_WCHAR_T
+    const wxChar* fn_str() const { return m_pchData; }
+#endif // Unicode/ANSI
 
   // overloaded assignment
     // from another wxString
   wxString& operator=(const wxString& stringSrc);
     // from a character
-  wxString& operator=(char ch);
+  wxString& operator=(wxChar ch);
     // from a C string
-  wxString& operator=(const char *psz);
+  wxString& operator=(const wxChar *psz);
+#if wxUSE_UNICODE
+    // from wxWCharBuffer
+  wxString& operator=(const wxWCharBuffer& psz) { return operator=((const wchar_t *)psz); }
+#else // ANSI
     // from another kind of C string
   wxString& operator=(const unsigned char* psz);
+#if wxUSE_WCHAR_T
     // from a wide string
   wxString& operator=(const wchar_t *pwz);
+#endif
+    // from wxCharBuffer
+  wxString& operator=(const wxCharBuffer& psz) { return operator=((const char *)psz); }
+#endif // Unicode/ANSI
 
   // string concatenation
     // in place concatenation
@@ -371,23 +486,32 @@ public:
     return *this;
   }
       // string += C string
-  wxString& operator<<(const char *psz)
-    { ConcatSelf(Strlen(psz), psz); return *this; }
+  wxString& operator<<(const wxChar *psz)
+    { ConcatSelf(wxStrlen(psz), psz); return *this; }
       // string += char
-  wxString& operator<<(char ch) { ConcatSelf(1, &ch); return *this; }
+  wxString& operator<<(wxChar ch) { ConcatSelf(1, &ch); return *this; }
 
       // string += string
   void operator+=(const wxString& s) { (void)operator<<(s); }
       // string += C string
-  void operator+=(const char *psz) { (void)operator<<(psz); }
+  void operator+=(const wxChar *psz) { (void)operator<<(psz); }
       // string += char
-  void operator+=(char ch) { (void)operator<<(ch); }
+  void operator+=(wxChar ch) { (void)operator<<(ch); }
+
+      // 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
 
     // string += C string
-  wxString& Append(const char* psz)
-    { ConcatSelf(Strlen(psz), psz); return *this; }
+  wxString& Append(const wxChar* psz)
+    { ConcatSelf(wxStrlen(psz), psz); return *this; }
     // append count copies of given character
-  wxString& Append(char ch, size_t count = 1u)
+  wxString& Append(wxChar ch, size_t count = 1u)
     { wxString str(ch, count); return *this << str; }
 
     // prepend a string, return the string itself
@@ -398,31 +522,49 @@ public:
       //
   friend wxString WXDLLEXPORT operator+(const wxString& string1,  const wxString& string2);
       //
-  friend wxString WXDLLEXPORT operator+(const wxString& string, char ch);
+  friend wxString WXDLLEXPORT operator+(const wxString& string, wxChar ch);
       //
-  friend wxString WXDLLEXPORT operator+(char ch, const wxString& string);
+  friend wxString WXDLLEXPORT operator+(wxChar ch, const wxString& string);
       //
-  friend wxString WXDLLEXPORT operator+(const wxString& string, const char *psz);
+  friend wxString WXDLLEXPORT operator+(const wxString& string, const wxChar *psz);
       //
-  friend wxString WXDLLEXPORT operator+(const char *psz, const wxString& string);
+  friend wxString WXDLLEXPORT operator+(const wxChar *psz, const wxString& string);
 
   // stream-like functions
       // insert an int into string
-  wxString& operator<<(int i);
+  wxString& operator<<(int i)
+    { return (*this) << Format(_T("%d"), i); }
+      // insert an unsigned int into string
+  wxString& operator<<(unsigned int ui)
+    { return (*this) << Format(_T("%u"), ui); }
+      // insert a long into string
+  wxString& operator<<(long l)
+    { return (*this) << Format(_T("%ld"), l); }
+      // insert an unsigned long into string
+  wxString& operator<<(unsigned long ul)
+    { return (*this) << Format(_T("%lu"), ul); }
       // insert a float into string
-  wxString& operator<<(float f);
+  wxString& operator<<(float f)
+    { return (*this) << Format(_T("%f"), f); }
       // insert a double into string
-  wxString& operator<<(double d);
+  wxString& operator<<(double d)
+    { return (*this) << Format(_T("%g"), d); }
 
   // string comparison
     // case-sensitive comparison (returns a value < 0, = 0 or > 0)
-  int  Cmp(const char *psz) const { return strcmp(c_str(), psz); }
+  int Cmp(const wxChar *psz) const { return wxStrcmp(c_str(), psz); }
     // same as Cmp() but not case-sensitive
-  int  CmpNoCase(const char *psz) const { return Stricmp(c_str(), psz); }
+  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 char *psz, bool compareWithCase = TRUE) const
+  bool IsSameAs(const wxChar *psz, bool compareWithCase = TRUE) const
     { return (compareWithCase ? Cmp(psz) : CmpNoCase(psz)) == 0; }
+    // comparison with a signle character: returns TRUE if equal
+  bool IsSameAs(wxChar c, bool compareWithCase = TRUE) const
+    {
+      return (Len() == 1) && (compareWithCase ? GetChar(0u) == c
+                              : wxToupper(GetChar(0u)) == wxToupper(c));
+    }
 
   // simple sub-string extraction
       // return substring starting at nFirst of length nCount (or till the end
@@ -439,20 +581,20 @@ public:
   wxString Right(size_t nCount) const;
       // get all characters before the first occurence of ch
       // (returns the whole string if ch not found)
-  wxString BeforeFirst(char ch) const;
+  wxString BeforeFirst(wxChar ch) const;
       // get all characters before the last occurence of ch
       // (returns empty string if ch not found)
-  wxString BeforeLast(char ch) const;
+  wxString BeforeLast(wxChar ch) const;
       // get all characters after the first occurence of ch
       // (returns empty string if ch not found)
-  wxString AfterFirst(char ch) const;
+  wxString AfterFirst(wxChar ch) const;
       // get all characters after the last occurence of ch
       // (returns the whole string if ch not found)
-  wxString AfterLast(char ch) const;
+  wxString AfterLast(wxChar ch) const;
 
     // for compatibility only, use more explicitly named functions above
-  wxString Before(char ch) const { return BeforeLast(ch); }
-  wxString After(char ch) const { return AfterFirst(ch); }
+  wxString Before(wxChar ch) const { return BeforeLast(ch); }
+  wxString After(wxChar ch) const { return AfterFirst(ch); }
 
   // case conversion
       // convert to upper case in place, return the string itself
@@ -469,29 +611,43 @@ public:
       // remove spaces from left or from right (default) side
   wxString& Trim(bool bFromRight = TRUE);
       // add nCount copies chPad in the beginning or at the end (default)
-  wxString& Pad(size_t nCount, char chPad = ' ', bool bFromRight = TRUE);
+  wxString& Pad(size_t nCount, wxChar chPad = wxT(' '), bool bFromRight = TRUE);
       // truncate string to given length
   wxString& Truncate(size_t uiLen);
 
   // searching and replacing
       // searching (return starting index, or -1 if not found)
-  int Find(char 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 char *pszSub) const;               // like strstr
+  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 char *szOld,
-                 const char *szNew,
+  size_t Replace(const wxChar *szOld,
+                 const wxChar *szNew,
                  bool bReplaceAll = TRUE);
 
     // check if the string contents matches a mask containing '*' and '?'
-  bool Matches(const char *szMask) const;
+  bool Matches(const wxChar *szMask) const;
+
+    // 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
+        // convert to a signed integer
+    bool ToLong(long *val) const;
+        // convert to an unsigned integer
+    bool ToULong(unsigned long *val) const;
+        // convert to a double
+    bool ToDouble(double *val) const;
 
   // formated input/output
     // as sprintf(), returns the number of characters written or < 0 on error
-  int Printf(const char *pszFormat, ...);
+  int Printf(const wxChar *pszFormat, ...);
     // as vprintf(), returns the number of characters written or < 0 on error
-  int PrintfV(const char* pszFormat, va_list argptr);
+  int PrintfV(const wxChar* pszFormat, va_list argptr);
+
+    // returns the string containing the result of Printf() to it
+  static wxString Format(const wxChar *pszFormat, ...);
+    // 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
@@ -502,7 +658,7 @@ public:
   void 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!
-  char *GetWriteBuf(size_t nLen);
+  wxChar *GetWriteBuf(size_t nLen);
     // call this immediately after GetWriteBuf() has been used
   void UngetWriteBuf();
 
@@ -517,16 +673,16 @@ public:
   enum stripType {leading = 0x1, trailing = 0x2, both = 0x3};
 
     // use Printf()
-  int sprintf(const char *pszFormat, ...);
+  int sprintf(const wxChar *pszFormat, ...);
 
     // use Cmp()
-  inline int CompareTo(const char* psz, caseCompare cmp = exact) const
+  inline int CompareTo(const wxChar* psz, caseCompare cmp = exact) const
     { return cmp == exact ? Cmp(psz) : CmpNoCase(psz); }
 
     // use Len
   size_t Length() const { return Len(); }
     // Count the number of characters
-  int Freq(char ch) const;
+  int Freq(wxChar ch) const;
     // use MakeLower
   void LowerCase() { MakeLower(); }
     // use MakeUpper
@@ -535,8 +691,8 @@ public:
   wxString Strip(stripType w = trailing) const;
 
     // use Find (more general variants not yet supported)
-  size_t Index(const char* psz) const { return Find(psz); }
-  size_t Index(char ch)         const { return Find(ch);  }
+  size_t Index(const wxChar* psz) const { return Find(psz); }
+  size_t Index(wxChar ch)         const { return Find(ch);  }
     // use Truncate
   wxString& Remove(size_t pos) { return Truncate(pos); }
   wxString& RemoveLast() { return Truncate(Len() - 1); }
@@ -544,10 +700,10 @@ public:
   wxString& Remove(size_t nStart, size_t nLen) { return erase( nStart, nLen ); }
 
     // use Find()
-  int First( const char ch ) const { return Find(ch); }
-  int First( const char* psz ) const { return Find(psz); }
+  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 char ch ) const { return Find(ch, TRUE); }
+  int Last( const wxChar ch ) const { return Find(ch, TRUE); }
   bool Contains(const wxString& str) const { return Find(str) != -1; }
 
     // use IsEmpty()
@@ -556,6 +712,10 @@ public:
 #ifdef  wxSTD_STRING_COMPATIBILITY
   // std::string compatibility functions
 
+  // standard types
+  typedef wxChar value_type;
+  typedef const value_type *const_iterator;
+
   // an 'invalid' value for string index
   static const size_t npos;
 
@@ -577,17 +737,24 @@ public:
     // return the maximum size of the string
   size_t max_size() const { return wxSTRING_MAXLEN; }
     // resize the string, filling the space with c if c != 0
-  void resize(size_t nSize, char ch = '\0');
+  void resize(size_t nSize, wxChar ch = wxT('\0'));
     // delete the contents of the string
   void clear() { Empty(); }
     // returns true if the string is empty
   bool empty() const { return IsEmpty(); }
+    // inform string about planned change in size
+  void reserve(size_t size) { Alloc(size); }
 
   // lib.string.access
     // return the character at position n
-  char at(size_t n) const { return GetChar(n); }
+  wxChar at(size_t n) const { return GetChar(n); }
     // returns the writable character at position n
-  char& at(size_t n) { return GetWritableChar(n); }
+  wxChar& at(size_t n) { return GetWritableChar(n); }
+
+    // first valid index position
+  const_iterator begin() const { return wx_str(); }
+    // position one after the last valid one
+  const_iterator end() const { return wx_str() + length(); }
 
   // lib.string.modifiers
     // append a string
@@ -597,50 +764,50 @@ public:
   wxString& append(const wxString& str, size_t pos, size_t n)
     { ConcatSelf(n, str.c_str() + pos); return *this; }
     // append first n (or all if n == npos) characters of sz
-  wxString& append(const char *sz, size_t n = npos)
-    { ConcatSelf(n == npos ? Strlen(sz) : n, sz); return *this; }
+  wxString& append(const wxChar *sz, size_t n = npos)
+    { ConcatSelf(n == npos ? wxStrlen(sz) : n, sz); return *this; }
 
     // append n copies of ch
-  wxString& append(size_t n, char ch) { return Pad(n, ch); }
+  wxString& append(size_t n, wxChar ch) { return Pad(n, ch); }
 
     // same as `this_string = str'
   wxString& assign(const wxString& str) { return (*this) = str; }
     // same as ` = str[pos..pos + n]
   wxString& assign(const wxString& str, size_t pos, size_t n)
-    { return *this = wxString((const char *)str + pos, n); }
+    { return *this = wxString((const wxChar *)str + pos, n); }
     // same as `= first n (or all if n == npos) characters of sz'
-  wxString& assign(const char *sz, size_t n = npos)
+  wxString& assign(const wxChar *sz, size_t n = npos)
     { return *this = wxString(sz, n); }
     // same as `= n copies of ch'
-  wxString& assign(size_t n, char ch)
+  wxString& assign(size_t n, wxChar ch)
     { return *this = wxString(ch, n); }
 
     // insert another string
   wxString& insert(size_t nPos, const wxString& str);
     // insert n chars of str starting at nStart (in str)
   wxString& insert(size_t nPos, const wxString& str, size_t nStart, size_t n)
-    { return insert(nPos, wxString((const char *)str + nStart, n)); }
+    { return insert(nPos, wxString((const wxChar *)str + nStart, n)); }
 
     // insert first n (or all if n == npos) characters of sz
-  wxString& insert(size_t nPos, const char *sz, size_t n = npos)
+  wxString& insert(size_t nPos, const wxChar *sz, size_t n = npos)
     { return insert(nPos, wxString(sz, n)); }
     // insert n copies of ch
-  wxString& insert(size_t nPos, size_t n, char ch)
+  wxString& insert(size_t nPos, size_t n, wxChar ch)
     { return insert(nPos, wxString(ch, n)); }
 
     // delete characters from nStart to nStart + nLen
   wxString& erase(size_t nStart = 0, size_t nLen = npos);
 
     // replaces the substring of length nLen starting at nStart
-  wxString& replace(size_t nStart, size_t nLen, const char* sz);
+  wxString& replace(size_t nStart, size_t nLen, const wxChar* sz);
     // replaces the substring with nCount copies of ch
-  wxString& replace(size_t nStart, size_t nLen, size_t nCount, char ch);
+  wxString& replace(size_t nStart, size_t nLen, size_t nCount, wxChar ch);
     // replaces a substring with another substring
   wxString& replace(size_t nStart, size_t nLen,
                     const wxString& str, size_t nStart2, size_t nLen2);
     // replaces the substring with first nCount chars of sz
     wxString& replace(size_t nStart, size_t nLen,
-                      const char* sz, size_t nCount);
+                      const wxChar* sz, size_t nCount);
 
     // swap two strings
   void swap(wxString& str);
@@ -655,13 +822,13 @@ public:
   // VC++ 1.5 can't cope with this syntax.
 #if !defined(__VISUALC__) || defined(__WIN32__)
     // find first n characters of sz
-  size_t find(const char* sz, size_t nStart = 0, size_t n = npos) const;
+  size_t find(const wxChar* sz, size_t nStart = 0, size_t n = npos) const;
 #endif
 
   // Gives a duplicate symbol (presumably a case-insensitivity problem)
 #if !defined(__BORLANDC__)
     // find the first occurence of character ch after nStart
-  size_t find(char ch, size_t nStart = 0) const;
+  size_t find(wxChar ch, size_t nStart = 0) const;
 #endif
     // rfind() family is exactly like find() but works right to left
 
@@ -671,41 +838,46 @@ public:
   // VC++ 1.5 can't cope with this syntax.
 #if !defined(__VISUALC__) || defined(__WIN32__)
     // as find, but from the end
-  size_t rfind(const char* sz, size_t nStart = npos,
+  size_t rfind(const wxChar* sz, size_t nStart = npos,
           size_t n = npos) const;
     // as find, but from the end
-  size_t rfind(char ch, size_t nStart = npos) const;
+  size_t rfind(wxChar ch, size_t nStart = npos) const;
 #endif
 
     // find first/last occurence of any character in the set
 
-    //
-  size_t find_first_of(const wxString& str, size_t nStart = 0) const;
-    //
-  size_t find_first_of(const char* sz, size_t nStart = 0) const;
+    // as strpbrk() but starts at nStart, returns npos if not found
+  size_t find_first_of(const wxString& str, 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;
     // same as find(char, size_t)
-  size_t find_first_of(char c, size_t nStart = 0) const;
-    //
-  size_t find_last_of (const wxString& str, size_t nStart = npos) const;
-    //
-  size_t find_last_of (const char* s, size_t nStart = npos) const;
-    // same as rfind(char, size_t)
-  size_t find_last_of (char c, size_t nStart = npos) const;
+  size_t find_first_of(wxChar c, size_t nStart = 0) const
+    { return find(c, nStart); }
+    // find the last (starting from nStart) char from str in this string
+  size_t find_last_of (const wxString& str, 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;
+    // same as above
+  size_t find_last_of(wxChar c, size_t nStart = npos) const
+    { return rfind(c, nStart); }
 
     // find first/last occurence of any character not in the set
 
-    //
-  size_t find_first_not_of(const wxString& str, size_t nStart = 0) const;
-    //
-  size_t find_first_not_of(const char* s, size_t nStart = 0) const;
-    //
-  size_t find_first_not_of(char ch, size_t nStart = 0) const;
-    //
+    // as strspn() (starting from nStart), returns npos on failure
+  size_t find_first_not_of(const wxString& str, 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;
+    // 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 wxString& str, size_t nStart=npos) const;
-    //
-  size_t find_last_not_of(const char* s, size_t nStart = npos) const;
-    //
-  size_t find_last_not_of(char ch, size_t nStart = npos) const;
+    // 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(wxChar ch, size_t nStart = npos) const;
 
     // All compare functions return -1, 0 or 1 if the [sub]string is less,
     // equal or greater than the compare() argument.
@@ -718,13 +890,14 @@ public:
   int compare(size_t nStart, size_t nLen,
               const wxString& str, size_t nStart2, size_t nLen2) const;
     // just like strcmp()
-  int compare(const char* sz) const { return Cmp(sz); }
+  int compare(const wxChar* sz) const { return Cmp(sz); }
     // substring comparison with first nCount characters of sz
   int compare(size_t nStart, size_t nLen,
-              const char* sz, size_t nCount = npos) const;
+              const wxChar* sz, size_t nCount = npos) const;
 
   // substring extraction
-  wxString substr(size_t nStart = 0, size_t nLen = npos) const;
+  wxString substr(size_t nStart = 0, size_t nLen = npos) const
+    { return Mid(nStart, nLen); }
 #endif // wxSTD_STRING_COMPATIBILITY
 };
 
@@ -742,6 +915,7 @@ public:
 // so the original string may be safely deleted. When a string is retrieved
 // from the array (operator[] or Item() method), a reference is returned.
 // ----------------------------------------------------------------------------
+
 class WXDLLEXPORT wxArrayString
 {
 public:
@@ -750,8 +924,9 @@ public:
                                  const wxString& second);
 
   // constructors and destructor
-    // default ctor
-  wxArrayString();
+    // default ctor: if autoSort is TRUE, the array is always sorted (in
+    // alphabetical order)
+  wxArrayString(bool autoSort = FALSE);
     // copy ctor
   wxArrayString(const wxArrayString& array);
     // assignment operator
@@ -791,13 +966,14 @@ public:
     // bFromEnd is FALSE or from end otherwise. If bCase, comparison is case
     // sensitive (default). Returns index of the first item matched or
     // wxNOT_FOUND
-  int  Index (const char *sz, bool bCase = TRUE, bool bFromEnd = FALSE) const;
-    // add new element at the end
-  void Add(const wxString& str);
+  int  Index (const wxChar *sz, bool bCase = TRUE, bool bFromEnd = FALSE) const;
+    // add new element at the end (if the array is not sorted), return its
+    // index
+  size_t Add(const wxString& str);
     // add new element at given position
   void Insert(const wxString& str, size_t uiIndex);
     // remove first item matching this value
-  void Remove(const char *sz);
+  void Remove(const wxChar *sz);
     // remove item by index
   void Remove(size_t nIndex);
 
@@ -808,73 +984,121 @@ public:
     // sort array elements using specified comparaison function
   void Sort(CompareFunction compareFunction);
 
+protected:
+  void Copy(const wxArrayString& src);  // copies the contents of another array
+
 private:
-  void    Grow();     // makes array bigger if needed
-  void    Free();     // free the string stored
+  void Grow();                          // makes array bigger if needed
+  void Free();                          // free all the strings stored
 
-  void    DoSort();   // common part of all Sort() variants
+  void DoSort();                        // common part of all Sort() variants
 
   size_t  m_nSize,    // current size of the array
           m_nCount;   // current number of elements
 
-  char  **m_pItems;   // pointer to data
+  wxChar  **m_pItems; // pointer to data
+
+  bool    m_autoSort; // if TRUE, keep the array always sorted
+};
+
+class WXDLLEXPORT wxSortedArrayString : public wxArrayString
+{
+public:
+  wxSortedArrayString() : wxArrayString(TRUE)
+    { }
+  wxSortedArrayString(const wxArrayString& array) : wxArrayString(TRUE)
+    { Copy(array); }
 };
 
 // ---------------------------------------------------------------------------
 // wxString comparison functions: operator versions are always case sensitive
 // ---------------------------------------------------------------------------
+
 //
 inline bool operator==(const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) == 0); }
 //
-inline bool operator==(const wxString& s1, const char  * s2) { return (s1.Cmp(s2) == 0); }
+inline bool operator==(const wxString& s1, const wxChar  * s2) { return (s1.Cmp(s2) == 0); }
 //
-inline bool operator==(const char  * s1, const wxString& s2) { return (s2.Cmp(s1) == 0); }
+inline bool operator==(const wxChar  * s1, const wxString& s2) { return (s2.Cmp(s1) == 0); }
 //
 inline bool operator!=(const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) != 0); }
 //
-inline bool operator!=(const wxString& s1, const char  * s2) { return (s1.Cmp(s2) != 0); }
+inline bool operator!=(const wxString& s1, const wxChar  * s2) { return (s1.Cmp(s2) != 0); }
 //
-inline bool operator!=(const char  * s1, const wxString& s2) { return (s2.Cmp(s1) != 0); }
+inline bool operator!=(const wxChar  * s1, const wxString& s2) { return (s2.Cmp(s1) != 0); }
 //
 inline bool operator< (const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) < 0); }
 //
-inline bool operator< (const wxString& s1, const char  * s2) { return (s1.Cmp(s2) <  0); }
+inline bool operator< (const wxString& s1, const wxChar  * s2) { return (s1.Cmp(s2) <  0); }
 //
-inline bool operator< (const char  * s1, const wxString& s2) { return (s2.Cmp(s1) >  0); }
+inline bool operator< (const wxChar  * s1, const wxString& s2) { return (s2.Cmp(s1) >  0); }
 //
 inline bool operator> (const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) >  0); }
 //
-inline bool operator> (const wxString& s1, const char  * s2) { return (s1.Cmp(s2) >  0); }
+inline bool operator> (const wxString& s1, const wxChar  * s2) { return (s1.Cmp(s2) >  0); }
 //
-inline bool operator> (const char  * s1, const wxString& s2) { return (s2.Cmp(s1) <  0); }
+inline bool operator> (const wxChar  * s1, const wxString& s2) { return (s2.Cmp(s1) <  0); }
 //
 inline bool operator<=(const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) <= 0); }
 //
-inline bool operator<=(const wxString& s1, const char  * s2) { return (s1.Cmp(s2) <= 0); }
+inline bool operator<=(const wxString& s1, const wxChar  * s2) { return (s1.Cmp(s2) <= 0); }
 //
-inline bool operator<=(const char  * s1, const wxString& s2) { return (s2.Cmp(s1) >= 0); }
+inline bool operator<=(const wxChar  * s1, const wxString& s2) { return (s2.Cmp(s1) >= 0); }
 //
 inline bool operator>=(const wxString& s1, const wxString& s2) { return (s1.Cmp(s2) >= 0); }
 //
-inline bool operator>=(const wxString& s1, const char  * s2) { return (s1.Cmp(s2) >= 0); }
+inline bool operator>=(const wxString& s1, const wxChar  * s2) { return (s1.Cmp(s2) >= 0); }
 //
-inline bool operator>=(const char  * s1, const wxString& s2) { return (s2.Cmp(s1) <= 0); }
+inline bool operator>=(const wxChar  * s1, const wxString& s2) { return (s2.Cmp(s1) <= 0); }
+
+// comparison with char
+inline bool operator==(wxChar c, const wxString& s) { return s.IsSameAs(c); }
+inline bool operator==(const wxString& s, wxChar c) { return s.IsSameAs(c); }
+inline bool operator!=(wxChar c, const wxString& s) { return !s.IsSameAs(c); }
+inline bool operator!=(const wxString& s, wxChar c) { return !s.IsSameAs(c); }
+
+#if wxUSE_UNICODE
+inline bool operator==(const wxString& s1, const wxWCharBuffer& s2)
+    { return (s1.Cmp((const wchar_t *)s2) == 0); }
+inline bool operator==(const wxWCharBuffer& s1, const wxString& s2)
+    { return (s2.Cmp((const wchar_t *)s1) == 0); }
+#else
+inline bool operator==(const wxString& s1, const wxCharBuffer& s2)
+    { return (s1.Cmp((const char *)s2) == 0); }
+inline bool operator==(const wxCharBuffer& s1, const wxString& s2)
+    { return (s2.Cmp((const char *)s1) == 0); }
+#endif
 
 wxString WXDLLEXPORT operator+(const wxString& string1,  const wxString& string2);
-wxString WXDLLEXPORT operator+(const wxString& string, char ch);
-wxString WXDLLEXPORT operator+(char ch, const wxString& string);
-wxString WXDLLEXPORT operator+(const wxString& string, const char *psz);
-wxString WXDLLEXPORT operator+(const char *psz, const wxString& string);
+wxString WXDLLEXPORT operator+(const wxString& string, wxChar ch);
+wxString WXDLLEXPORT operator+(wxChar ch, const wxString& string);
+wxString WXDLLEXPORT operator+(const wxString& string, const wxChar *psz);
+wxString WXDLLEXPORT operator+(const wxChar *psz, const wxString& string);
+#if wxUSE_UNICODE
+inline wxString WXDLLEXPORT operator+(const wxString& string, const wxWCharBuffer& buf)
+    { return string + (const wchar_t *)buf; }
+inline wxString WXDLLEXPORT operator+(const wxWCharBuffer& buf, const wxString& string)
+    { return (const wchar_t *)buf + string; }
+#else
+inline wxString WXDLLEXPORT operator+(const wxString& string, const wxCharBuffer& buf)
+    { return string + (const char *)buf; }
+inline wxString WXDLLEXPORT operator+(const wxCharBuffer& buf, const wxString& string)
+    { return (const char *)buf + string; }
+#endif
 
 // ---------------------------------------------------------------------------
 // Implementation only from here until the end of file
 // ---------------------------------------------------------------------------
 
-#ifdef wxSTD_STRING_COMPATIBILITY
+// don't pollute the library user's name space
+#undef ASSERT_VALID_INDEX
+
+#if defined(wxSTD_STRING_COMPATIBILITY) && wxUSE_STD_IOSTREAM
 
 #include "wx/ioswrap.h"
 
-WXDLLEXPORT istream& operator>>(istream& is, wxString& str);
+WXDLLEXPORT istream& operator>>(istream&, wxString&);
+WXDLLEXPORT ostream& operator<<(ostream&, const wxString&);
 
 #endif  // wxSTD_STRING_COMPATIBILITY