]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/unichar.h
Ensure wxCharTypeBuffer data is NUL-terminated after extend() call.
[wxWidgets.git] / include / wx / unichar.h
index e9645cfcabfe43d2552f2186ddb8beeac8e51f08..5d019f52ba25de34844783c5f1165ff1a498dadf 100644 (file)
@@ -15,7 +15,8 @@
 #include "wx/chartype.h"
 #include "wx/stringimpl.h"
 
-class WXDLLIMPEXP_BASE wxUniCharRef;
+class WXDLLIMPEXP_FWD_BASE wxUniCharRef;
+class WXDLLIMPEXP_FWD_BASE wxString;
 
 // This class represents single Unicode character. It can be converted to
 // and from char or wchar_t and implements commonly used character operations.
@@ -35,31 +36,73 @@ public:
     wxUniChar(unsigned char c) { m_value = From8bit((char)c); }
 
     // Create the character from a wchar_t character value.
+#if wxWCHAR_T_IS_REAL_TYPE
     wxUniChar(wchar_t c) { m_value = c; }
+#endif
 
     wxUniChar(int c) { m_value = c; }
+    wxUniChar(unsigned int c) { m_value = c; }
+    wxUniChar(long int c) { m_value = c; }
+    wxUniChar(unsigned long int c) { m_value = c; }
+    wxUniChar(short int c) { m_value = c; }
+    wxUniChar(unsigned short int c) { m_value = c; }
 
     wxUniChar(const wxUniCharRef& c);
 
     // Returns Unicode code point value of the character
     value_type GetValue() const { return m_value; }
 
+#if wxUSE_UNICODE_UTF8
+    // buffer for single UTF-8 character
+    struct Utf8CharBuffer
+    {
+        char data[5];
+        operator const char*() const { return data; }
+    };
+
+    // returns the character encoded as UTF-8
+    // (NB: implemented in stringops.cpp)
+    Utf8CharBuffer AsUTF8() const;
+#endif // wxUSE_UNICODE_UTF8
+
+    // Returns true if the character is an ASCII character:
+    bool IsAscii() const { return m_value < 0x80; }
+
+    // Returns true if the character is representable as a single byte in the
+    // current locale encoding and return this byte in output argument c (which
+    // must be non-NULL)
+    bool GetAsChar(char *c) const
+    {
+#if wxUSE_UNICODE
+        if ( !IsAscii() )
+        {
+#if !wxUSE_UTF8_LOCALE_ONLY
+            if ( GetAsHi8bit(m_value, c) )
+                return true;
+#endif // !wxUSE_UTF8_LOCALE_ONLY
+
+            return false;
+        }
+#endif // wxUSE_UNICODE
+
+        *c = wx_truncate_cast(char, m_value);
+        return true;
+    }
+
     // Conversions to char and wchar_t types: all of those are needed to be
     // able to pass wxUniChars to verious standard narrow and wide character
     // functions
     operator char() const { return To8bit(m_value); }
-    operator wchar_t() const { return m_value; }
-    operator int() const { return m_value; }
-
-    // More conversions needed for other standard functions: uchar is for VC++
-    // _mbxxx() ones (to which toxxx/isxxx() are mapped when _MBCS is defined)
-    // and some wide character functions take wint_t which happens to be the
-    // same as wchar_t for Windows compilers but not for g++ (except for the
-    // special Apple version)
     operator unsigned char() const { return (unsigned char)To8bit(m_value); }
-#if defined(__GNUC__) && !defined(__DARWIN__)
-    operator wint_t() const { return m_value; }
+#if wxWCHAR_T_IS_REAL_TYPE
+    operator wchar_t() const { return (wchar_t)m_value; }
 #endif
+    operator int() const { return (int)m_value; }
+    operator unsigned int() const { return (unsigned int)m_value; }
+    operator long int() const { return (long int)m_value; }
+    operator unsigned long int() const { return (unsigned long)m_value; }
+    operator short int() const { return (short int)m_value; }
+    operator unsigned short int() const { return (unsigned short int)m_value; }
 
     // We need this operator for the "*p" part of expressions like "for (
     // const_iterator p = begin() + nStart; *p; ++p )". In this case,
@@ -68,17 +111,25 @@ public:
     // operator unspecified_bool_type() would only makes the ambiguity worse.)
     operator bool() const { return m_value != 0; }
     bool operator!() const { return !((bool)*this); }
-#if (defined(__VISUALC__) && __VISUALC__ < 1400) || \
-    defined(__DIGITALMARS__) || defined(__BORLANDC__)
-    // We need this for VC++ < 8 or DigitalMars and expressions like
-    // "str[0] && *p":
+
+    // And this one is needed by some (not all, but not using ifdefs makes the
+    // code easier) compilers to parse "str[0] && *p" successfully
     bool operator&&(bool v) const { return (bool)*this && v; }
-#endif
 
     // Assignment operators:
-    wxUniChar& operator=(const wxUniChar& c) { m_value = c.m_value; return *this; }
+    wxUniChar& operator=(const wxUniChar& c) { if (&c != this) m_value = c.m_value; return *this; }
+    wxUniChar& operator=(const wxUniCharRef& c);
     wxUniChar& operator=(char c) { m_value = From8bit(c); return *this; }
+    wxUniChar& operator=(unsigned char c) { m_value = From8bit((char)c); return *this; }
+#if wxWCHAR_T_IS_REAL_TYPE
     wxUniChar& operator=(wchar_t c) { m_value = c; return *this; }
+#endif
+    wxUniChar& operator=(int c) { m_value = c; return *this; }
+    wxUniChar& operator=(unsigned int c) { m_value = c; return *this; }
+    wxUniChar& operator=(long int c) { m_value = c; return *this; }
+    wxUniChar& operator=(unsigned long int c) { m_value = c; return *this; }
+    wxUniChar& operator=(short int c) { m_value = c; return *this; }
+    wxUniChar& operator=(unsigned short int c) { m_value = c; return *this; }
 
     // Comparison operators:
 
@@ -86,7 +137,14 @@ public:
 #define wxDEFINE_UNICHAR_OPERATOR(op)                                         \
     bool operator op(const wxUniChar& c) const { return m_value op c.m_value; }\
     bool operator op(char c) const { return m_value op From8bit(c); }         \
-    bool operator op(wchar_t c) const { return m_value op (value_type)c; }
+    bool operator op(unsigned char c) const { return m_value op From8bit((char)c); } \
+    wxIF_WCHAR_T_TYPE( bool operator op(wchar_t c) const { return m_value op (value_type)c; } )    \
+    bool operator op(int c) const { return m_value op (value_type)c; }        \
+    bool operator op(unsigned int c) const { return m_value op (value_type)c; }        \
+    bool operator op(short int c) const { return m_value op (value_type)c; }  \
+    bool operator op(unsigned short int c) const { return m_value op (value_type)c; }  \
+    bool operator op(long int c) const { return m_value op (value_type)c; }   \
+    bool operator op(unsigned long int c) const { return m_value op (value_type)c; }
 
     wxFOR_ALL_COMPARISONS(wxDEFINE_UNICHAR_OPERATOR)
 
@@ -95,11 +153,41 @@ public:
     // this is needed for expressions like 'Z'-c
     int operator-(const wxUniChar& c) const { return m_value - c.m_value; }
     int operator-(char c) const { return m_value - From8bit(c); }
+    int operator-(unsigned char c) const { return m_value - From8bit((char)c); }
     int operator-(wchar_t c) const { return m_value - (value_type)c; }
 
+
 private:
-    static value_type From8bit(char c);
-    static char To8bit(value_type c);
+    // notice that we implement these functions inline for 7-bit ASCII
+    // characters purely for performance reasons
+    static value_type From8bit(char c)
+    {
+#if wxUSE_UNICODE
+        if ( (unsigned char)c < 0x80 )
+            return c;
+
+        return FromHi8bit(c);
+#else
+        return c;
+#endif
+    }
+
+    static char To8bit(value_type c)
+    {
+#if wxUSE_UNICODE
+        if ( c < 0x80 )
+            return wx_truncate_cast(char, c);
+
+        return ToHi8bit(c);
+#else
+        return c;
+#endif
+    }
+
+    // helpers of the functions above called to deal with non-ASCII chars
+    static value_type FromHi8bit(char c);
+    static char ToHi8bit(value_type v);
+    static bool GetAsHi8bit(value_type v, char *c);
 
 private:
     value_type m_value;
@@ -116,7 +204,11 @@ private:
     typedef wxStringImpl::iterator iterator;
 
     // create the reference
+#if wxUSE_UNICODE_UTF8
+    wxUniCharRef(wxString& str, iterator pos) : m_str(str), m_pos(pos) {}
+#else
     wxUniCharRef(iterator pos) : m_pos(pos) {}
+#endif
 
 public:
     // NB: we have to make this public, because we don't have wxString
@@ -124,50 +216,76 @@ public:
     //     as friend; so at least don't use a ctor but a static function
     //     that must be used explicitly (this is more than using 'explicit'
     //     keyword on ctor!):
+#if wxUSE_UNICODE_UTF8
+    static wxUniCharRef CreateForString(wxString& str, iterator pos)
+        { return wxUniCharRef(str, pos); }
+#else
     static wxUniCharRef CreateForString(iterator pos)
         { return wxUniCharRef(pos); }
+#endif
 
     wxUniChar::value_type GetValue() const { return UniChar().GetValue(); }
 
+#if wxUSE_UNICODE_UTF8
+    wxUniChar::Utf8CharBuffer AsUTF8() const { return UniChar().AsUTF8(); }
+#endif // wxUSE_UNICODE_UTF8
+
+    bool IsAscii() const { return UniChar().IsAscii(); }
+    bool GetAsChar(char *c) const { return UniChar().GetAsChar(c); }
+
     // Assignment operators:
-    wxUniCharRef& operator=(const wxUniCharRef& c)
-    {
-        *m_pos = *c.m_pos;
-        return *this;
-    };
+#if wxUSE_UNICODE_UTF8
+    wxUniCharRef& operator=(const wxUniChar& c);
+#else
+    wxUniCharRef& operator=(const wxUniChar& c) { *m_pos = c; return *this; }
+#endif
 
-    wxUniCharRef& operator=(const wxUniChar& c)
-    {
-        *m_pos = c;
-        return *this;
-    };
+    wxUniCharRef& operator=(const wxUniCharRef& c)
+        { if (&c != this) *this = c.UniChar(); return *this; }
 
     wxUniCharRef& operator=(char c) { return *this = wxUniChar(c); }
+    wxUniCharRef& operator=(unsigned char c) { return *this = wxUniChar(c); }
+#if wxWCHAR_T_IS_REAL_TYPE
     wxUniCharRef& operator=(wchar_t c) { return *this = wxUniChar(c); }
+#endif
+    wxUniCharRef& operator=(int c) { return *this = wxUniChar(c); }
+    wxUniCharRef& operator=(unsigned int c) { return *this = wxUniChar(c); }
+    wxUniCharRef& operator=(short int c) { return *this = wxUniChar(c); }
+    wxUniCharRef& operator=(unsigned short int c) { return *this = wxUniChar(c); }
+    wxUniCharRef& operator=(long int c) { return *this = wxUniChar(c); }
+    wxUniCharRef& operator=(unsigned long int c) { return *this = wxUniChar(c); }
 
     // Conversions to the same types as wxUniChar is convertible too:
     operator char() const { return UniChar(); }
-    operator wchar_t() const { return UniChar(); }
-    operator int() const { return UniChar(); }
     operator unsigned char() const { return UniChar(); }
-#if defined(__GNUC__) && !defined(__DARWIN__)
-    operator wint_t() const { return UniChar(); }
+#if wxWCHAR_T_IS_REAL_TYPE
+    operator wchar_t() const { return UniChar(); }
 #endif
+    operator int() const { return UniChar(); }
+    operator unsigned int() const { return UniChar(); }
+    operator short int() const { return UniChar(); }
+    operator unsigned short int() const { return UniChar(); }
+    operator long int() const { return UniChar(); }
+    operator unsigned long int() const { return UniChar(); }
 
     // see wxUniChar::operator bool etc. for explanation
     operator bool() const { return (bool)UniChar(); }
     bool operator!() const { return !UniChar(); }
-#if (defined(__VISUALC__) && __VISUALC__ < 1400) || \
-    defined(__DIGITALMARS__) || defined(__BORLANDC__)
     bool operator&&(bool v) const { return UniChar() && v; }
-#endif
 
     // Comparison operators:
 #define wxDEFINE_UNICHARREF_OPERATOR(op)                                      \
     bool operator op(const wxUniCharRef& c) const { return UniChar() op c.UniChar(); }\
     bool operator op(const wxUniChar& c) const { return UniChar() op c; }     \
     bool operator op(char c) const { return UniChar() op c; }                 \
-    bool operator op(wchar_t c) const { return UniChar() op c; }
+    bool operator op(unsigned char c) const { return UniChar() op c; }        \
+    wxIF_WCHAR_T_TYPE( bool operator op(wchar_t c) const { return UniChar() op c; } ) \
+    bool operator op(int c) const { return UniChar() op c; }                  \
+    bool operator op(unsigned int c) const { return UniChar() op c; }         \
+    bool operator op(short int c) const { return UniChar() op c; }             \
+    bool operator op(unsigned short int c) const { return UniChar() op c; }    \
+    bool operator op(long int c) const { return UniChar() op c; }             \
+    bool operator op(unsigned long int c) const { return UniChar() op c; }
 
     wxFOR_ALL_COMPARISONS(wxDEFINE_UNICHARREF_OPERATOR)
 
@@ -177,14 +295,23 @@ public:
     int operator-(const wxUniCharRef& c) const { return UniChar() - c.UniChar(); }
     int operator-(const wxUniChar& c) const { return UniChar() - c; }
     int operator-(char c) const { return UniChar() - c; }
+    int operator-(unsigned char c) const { return UniChar() - c; }
     int operator-(wchar_t c) const { return UniChar() - c; }
 
 private:
+#if wxUSE_UNICODE_UTF8
+    wxUniChar UniChar() const;
+#else
     wxUniChar UniChar() const { return *m_pos; }
-    friend class WXDLLIMPEXP_BASE wxUniChar;
+#endif
+
+    friend class WXDLLIMPEXP_FWD_BASE wxUniChar;
 
 private:
-    // pointer to the character in string
+    // reference to the string and pointer to the character in string
+#if wxUSE_UNICODE_UTF8
+    wxString& m_str;
+#endif
     iterator m_pos;
 };
 
@@ -193,6 +320,12 @@ inline wxUniChar::wxUniChar(const wxUniCharRef& c)
     m_value = c.UniChar().m_value;
 }
 
+inline wxUniChar& wxUniChar::operator=(const wxUniCharRef& c)
+{
+    m_value = c.UniChar().m_value;
+    return *this;
+}
+
 // Comparison operators for the case when wxUniChar(Ref) is the second operand
 // implemented in terms of member comparison functions
 
@@ -210,7 +343,7 @@ wxDEFINE_COMPARISONS(const wxUniChar&, const wxUniCharRef&, wxCMP_REVERSE)
 
 // for expressions like c-'A':
 inline int operator-(char c1, const wxUniCharRef& c2) { return -(c2 - c1); }
-inline int operator-(wchar_t c1, const wxUniCharRef& c2) { return -(c2 - c1); }
 inline int operator-(const wxUniChar& c1, const wxUniCharRef& c2) { return -(c2 - c1); }
+inline int operator-(wchar_t c1, const wxUniCharRef& c2) { return -(c2 - c1); }
 
 #endif /* _WX_UNICHAR_H_ */