Renameing funktions to prevent name clashes

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

diff --git a/include/wx/string.h b/include/wx/string.h
index bbcd039ea3392483e7bde30f3521dde58a5f0500..993e8a928323722de720c1a754a6b48f46663fd3 100644 (file)
--- a/include/wx/string.h
+++ b/include/wx/string.h
@@ -20,6 +20,10 @@
     #include <ctype.h>
 #endif
 
     #include <ctype.h>
 #endif
 

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

 #include <string.h>
 #include <stdio.h>
 #include <stdarg.h>
 #include <string.h>
 #include <stdio.h>
 #include <stdarg.h>


@@ -66,12 +70,16 @@ const unsigned int wxSTRING_MAXLEN = UINT_MAX - 100;
 
 // 'naughty' cast
 #define   WXSTRINGCAST (wxChar *)(const wxChar *)
 
 // 'naughty' cast
 #define   WXSTRINGCAST (wxChar *)(const wxChar *)

+#define   WXCSTRINGCAST (wxChar *)(const wxChar *)

 #define   MBSTRINGCAST (char *)(const char *)
 #define   WCSTRINGCAST (wchar_t *)(const wchar_t *)
 
 // implementation only
 #define   ASSERT_VALID_INDEX(i) wxASSERT( (unsigned)(i) <= Len() )
 
 #define   MBSTRINGCAST (char *)(const char *)
 #define   WCSTRINGCAST (wchar_t *)(const wchar_t *)
 
 // implementation only
 #define   ASSERT_VALID_INDEX(i) wxASSERT( (unsigned)(i) <= Len() )
 

+// include conversion classes
+#include "wx/strconv.h"
+

 // ---------------------------------------------------------------------------
 // Global functions complementing standard C string library replacements for
 // strlen() and portable strcasecmp()
 // ---------------------------------------------------------------------------
 // Global functions complementing standard C string library replacements for
 // strlen() and portable strcasecmp()


@@ -88,17 +96,21 @@ inline size_t WXDLLEXPORT Strlen(const char *psz)
 // portable strcasecmp/_stricmp
 inline int WXDLLEXPORT Stricmp(const char *psz1, const char *psz2)
 {
 // 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);
   return _stricmp(psz1, psz2);

-#elif     defined(__SC__)
+#elif defined(__SC__)

   return _stricmp(psz1, psz2);
   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);
   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;
   return strcasecmp(psz1, psz2);
 #elif defined(__MWERKS__) && !defined(__INTEL__)
   register char c1, c2;


@@ -166,82 +178,6 @@ struct WXDLLEXPORT wxStringData
   bool  IsValid() const   { return (nRefs != 0); }
 };
 
   bool  IsValid() const   { return (nRefs != 0); }
 };
 

-// ---------------------------------------------------------------------------
-// types of multibyte<->Unicode conversions
-// ---------------------------------------------------------------------------
-class WXDLLEXPORT wxMBConv
-{
- public:
-  virtual size_t MB2WC(wchar_t *buf, const char *psz, size_t n) const;
-  virtual size_t WC2MB(char *buf, const wchar_t *psz, size_t n) const;
-  const wxWCharBuffer cMB2WC(const char *psz) const
-    {
-      size_t nLen = MB2WC((wchar_t *) NULL, psz, 0);
-      wxWCharBuffer buf(nLen);
-      MB2WC(WCSTRINGCAST buf, psz, nLen);
-      return buf;
-    }
-  const wxCharBuffer cWC2MB(const wchar_t *psz) const
-    {
-      size_t nLen = WC2MB((char *) NULL, psz, 0);
-      wxCharBuffer buf(nLen);
-      WC2MB(MBSTRINGCAST buf, psz, nLen);
-      return buf;
-    }
-#if wxUSE_UNICODE
-  const wxWCharBuffer cMB2WX(const char *psz) const { return cMB2WC(psz); }
-  const wxCharBuffer cWX2MB(const wchar_t *psz) const { return cWC2MB(psz); }
-  const wchar_t* cWC2WX(const wchar_t *psz) const { return psz; }
-  const wchar_t* cMB2WC(const wchar_t *psz) const { return psz; }
-#else
-  const char* cMB2WX(const char *psz) const { return psz; }
-  const char* cWX2MB(const char *psz) const { return psz; }
-  const wxCharBuffer cWC2WX(const wchar_t *psz) const { return cWC2MB(psz); }
-  const wxWCharBuffer cWX2WC(const char *psz) const { return cMB2WC(psz); }
-#endif
-};
-WXDLLEXPORT_DATA(extern wxMBConv) wxConv_libc;
-
-#define wxANOTHER_MBCONV(type) \
-class type : public wxMBConv { \
- public: \
-  virtual size_t MB2WC(wchar_t *buf, const char *psz, size_t n) const; \
-  virtual size_t WC2MB(char *buf, const wchar_t *psz, size_t n) const; \
-}
-
-WXDLLEXPORT_DATA(extern wxANOTHER_MBCONV(wxMBConv_file)) wxConv_file;
-WXDLLEXPORT_DATA(extern wxANOTHER_MBCONV(wxMBConv_UTF7)) wxConv_UTF7;
-WXDLLEXPORT_DATA(extern wxANOTHER_MBCONV(wxMBConv_UTF8)) wxConv_UTF8;
-#ifdef __WXGTK__
-WXDLLEXPORT_DATA(extern wxANOTHER_MBCONV(wxMBConv_gdk)) wxConv_gdk;
-#endif
-
-class WXDLLEXPORT wxCSConv : public wxMBConv
-{
- private:
-  wxChar *data;
- public:
-  wxCSConv(const wxChar *charset);
-  virtual ~wxCSConv(void);
-  virtual size_t MB2WC(wchar_t *buf, const char *psz, size_t n) const;
-  virtual size_t WC2MB(char *buf, const wchar_t *psz, size_t n) const;
-};
-
-// filenames are multibyte on Unix and probably widechar on Windows?
-#ifdef __UNIX__
-#define wxMBFILES 1
-#else
-#define wxMBFILES 0
-#endif
-
-#if wxMBFILES
-#define wxFNCONV(name) wxConv_file.cWX2MB(name)
-#define FNSTRINGCAST MBSTRINGCAST
-#else
-#define wxFNCONV(name) name
-#define FNSTRINGCAST WXSTRINGCAST
-#endif
-

 // ---------------------------------------------------------------------------
 // This is (yet another one) String class for C++ programmers. It doesn't use
 // any of "advanced" C++ features (i.e. templates, exceptions, namespaces...)
 // ---------------------------------------------------------------------------
 // This is (yet another one) String class for C++ programmers. It doesn't use
 // any of "advanced" C++ features (i.e. templates, exceptions, namespaces...)


@@ -346,7 +282,7 @@ public:
     // from multibyte string
     // (NB: nLength is right now number of Unicode characters, not
     //  characters in psz! So try not to use it yet!)
     // 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 = wxConv_libc, size_t nLength = wxSTRING_MAXLEN);
+  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); }
     // from wxWCharBuffer (i.e. return from wxGetString)
   wxString(const wxWCharBuffer& psz)
     { InitWith(psz, 0, wxSTRING_MAXLEN); }


@@ -354,8 +290,13 @@ public:
     // from C string (for compilers using unsigned char)
   wxString(const unsigned char* psz, size_t nLength = wxSTRING_MAXLEN)
     { InitWith((const char*)psz, 0, nLength); }
     // from C string (for compilers using unsigned char)
   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);
     // from wide (Unicode) string
   wxString(const wchar_t *pwz);

+#endif

     // from wxCharBuffer
   wxString(const wxCharBuffer& psz)
     { InitWith(psz, 0, wxSTRING_MAXLEN); }
     // from wxCharBuffer
   wxString(const wxCharBuffer& psz)
     { InitWith(psz, 0, wxSTRING_MAXLEN); }


@@ -435,21 +376,27 @@ public:
     operator const wxChar*() const { return m_pchData; }
     // explicit conversion to C string (use this with printf()!)
     const wxChar* c_str()   const { return m_pchData; }
     operator const wxChar*() const { return m_pchData; }
     // explicit conversion to C string (use this with printf()!)
     const wxChar* c_str()   const { return m_pchData; }

+    // (and this with [wx]Printf()!)
+    const wxChar* wx_str()  const { return m_pchData; }

     //
     const wxChar* GetData() const { return m_pchData; }
 #if wxUSE_UNICODE
     //
     const wxChar* GetData() const { return m_pchData; }
 #if wxUSE_UNICODE

-    const wxCharBuffer mb_str(wxMBConv& conv = wxConv_libc) const { return conv.cWC2MB(m_pchData); }
-    const wxChar* wc_str(wxMBConv& WXUNUSED(conv) = wxConv_libc) const { return m_pchData; }
+    const wxCharBuffer mb_str(wxMBConv& conv = wxConvLibc) const { return conv.cWC2MB(m_pchData); }
+    const wxChar* wc_str(wxMBConv& WXUNUSED(conv) = wxConvLibc) const { return m_pchData; }

 #if wxMBFILES
 #if wxMBFILES

-    const wxCharBuffer fn_str() const { return mb_str(wxConv_file); }
+    const wxCharBuffer fn_str() const { return mb_str(wxConvFile); }

 #else
     const wxChar* fn_str() const { return m_pchData; }
 #endif
 #else
 #else
     const wxChar* fn_str() const { return m_pchData; }
 #endif
 #else

-    const wxChar* mb_str(wxMBConv& WXUNUSED(conv) = wxConv_libc ) const { return m_pchData; }
+    const wxChar* mb_str(wxMBConv& WXUNUSED(conv) = wxConvLibc ) const { return m_pchData; }
+#if wxUSE_WCHAR_T

     const wxWCharBuffer wc_str(wxMBConv& conv) const { return conv.cMB2WC(m_pchData); }
     const wxWCharBuffer wc_str(wxMBConv& conv) const { return conv.cMB2WC(m_pchData); }

+#endif

     const wxChar* fn_str() const { return m_pchData; }
 #endif
     const wxChar* fn_str() const { return m_pchData; }
 #endif

+    // for convenience
+    const wxWX2MBbuf mbc_str() const { return mb_str(*wxConvCurrent); }

 
   // overloaded assignment
     // from another wxString
 
   // overloaded assignment
     // from another wxString


@@ -464,8 +411,10 @@ public:
 #else
     // from another kind of C string
   wxString& operator=(const unsigned char* psz);
 #else
     // 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);
     // from a wide string
   wxString& operator=(const wchar_t *pwz);

+#endif

     // from wxCharBuffer
   wxString& operator=(const wxCharBuffer& psz) { return operator=((const char *)psz); }
 #endif
     // from wxCharBuffer
   wxString& operator=(const wxCharBuffer& psz) { return operator=((const char *)psz); }
 #endif


@@ -540,13 +489,19 @@ public:
 
   // string comparison
     // case-sensitive comparison (returns a value < 0, = 0 or > 0)
 
   // string comparison
     // case-sensitive comparison (returns a value < 0, = 0 or > 0)

-  int  Cmp(const wxChar *psz) const { return wxStrcmp(c_str(), psz); }
+  int Cmp(const wxChar *psz) const { return wxStrcmp(c_str(), psz); }

     // same as Cmp() but not case-sensitive
     // same as Cmp() but not case-sensitive

-  int  CmpNoCase(const wxChar *psz) const { return wxStricmp(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 wxChar *psz, bool compareWithCase = TRUE) const
     { return (compareWithCase ? Cmp(psz) : CmpNoCase(psz)) == 0; }
     // 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
     { 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
 
   // simple sub-string extraction
       // return substring starting at nFirst of length nCount (or till the end


@@ -680,6 +635,10 @@ public:
 #ifdef  wxSTD_STRING_COMPATIBILITY
   // std::string compatibility functions
 
 #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;
 
   // an 'invalid' value for string index
   static const size_t npos;
 


@@ -713,6 +672,11 @@ public:
     // returns the writable character at position n
   wxChar& at(size_t n) { return GetWritableChar(n); }
 
     // returns the writable character at position 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
   wxString& append(const wxString& str)
   // lib.string.modifiers
     // append a string
   wxString& append(const wxString& str)


@@ -803,32 +767,37 @@ public:
 
     // find first/last occurence of any character in the set
 
 
     // find first/last occurence of any character in the set
 

-    //
-  size_t find_first_of(const wxString& str, 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(const wxChar* sz, size_t nStart = 0) const;
     // same as find(char, size_t)

-  size_t find_first_of(wxChar 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 wxChar* s, size_t nStart = npos) const;
-    // same as rfind(char, size_t)
-  size_t find_last_of (wxChar 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
 
 
     // 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 wxChar* s, 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;
   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 wxString& str, size_t nStart=npos) const;

-    //
-  size_t find_last_not_of(const wxChar* s, 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,
   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,


@@ -947,6 +916,7 @@ private:
 // ---------------------------------------------------------------------------
 // wxString comparison functions: operator versions are always case sensitive
 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------
 // 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 wxString& s2) { return (s1.Cmp(s2) == 0); }
 //


@@ -984,17 +954,46 @@ inline bool operator>=(const wxString& s1, const wxChar  * s2) { return (s1.Cmp(
 //
 inline bool operator>=(const wxChar  * 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, 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);
 wxString WXDLLEXPORT operator+(const wxString& string1,  const wxString& string2);
 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
 // ---------------------------------------------------------------------------
 
 
 // ---------------------------------------------------------------------------
 // Implementation only from here until the end of file
 // ---------------------------------------------------------------------------
 

-#ifdef wxSTD_STRING_COMPATIBILITY
+#if defined(wxSTD_STRING_COMPATIBILITY) && wxUSE_STD_IOSTREAM

 
 #include "wx/ioswrap.h"
 
 
 #include "wx/ioswrap.h"