]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/unichar.h
Fix missing documentation for several GDI functions.
[wxWidgets.git] / include / wx / unichar.h
index 584b85cb4b34a8e8b15078815c1fd8ec08193e2f..be2ce619ed51c39b2a1123cb5579d7e9242e5ea3 100644 (file)
 #include "wx/chartype.h"
 #include "wx/stringimpl.h"
 
-#ifndef wxWCHAR_T_IS_SEPARATE_TYPE
-    // older versions of VC++ have wchar_t as typedef by default; this is
-    // configurable, so we have to check which behaviour is enabled
-    #if defined(__VISUALC__) && !defined(_NATIVE_WCHAR_T_DEFINED)
-        #define wxWCHAR_T_IS_SEPARATE_TYPE 0
-    #else
-        #define wxWCHAR_T_IS_SEPARATE_TYPE 1
-    #endif
-#endif
-
-// helper macro for doing something dependent on whether wchar_t is or isn't a
-// typedef inside another macro
-#if wxWCHAR_T_IS_SEPARATE_TYPE
-    #define wxIF_WCHAR_T_TYPE(x) x
-#else // !wxWCHAR_T_IS_SEPARATE_TYPE
-    #define wxIF_WCHAR_T_TYPE(x)
-#endif // wxWCHAR_T_IS_SEPARATE_TYPE/!wxWCHAR_T_IS_SEPARATE_TYPE
-
-class WXDLLIMPEXP_BASE wxUniCharRef;
-class WXDLLIMPEXP_BASE wxStringIteratorNode;
+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.
@@ -53,17 +35,10 @@ public:
     wxUniChar(char c) { m_value = From8bit(c); }
     wxUniChar(unsigned char c) { m_value = From8bit((char)c); }
 
-    // Create the character from a wchar_t character value.
-#if wxWCHAR_T_IS_SEPARATE_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; }
+#define wxUNICHAR_DEFINE_CTOR(type) \
+    wxUniChar(type c) { m_value = c; }
+    wxDO_FOR_INT_TYPES(wxUNICHAR_DEFINE_CTOR)
+#undef wxUNICHAR_DEFINE_CTOR
 
     wxUniChar(const wxUniCharRef& c);
 
@@ -86,20 +61,37 @@ public:
     // 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 unsigned char() const { return (unsigned char)To8bit(m_value); }
-#if wxWCHAR_T_IS_SEPARATE_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; }
+
+#define wxUNICHAR_DEFINE_OPERATOR_PAREN(type) \
+    operator type() const { return (type)m_value; }
+    wxDO_FOR_INT_TYPES(wxUNICHAR_DEFINE_OPERATOR_PAREN)
+#undef wxUNICHAR_DEFINE_OPERATOR_PAREN
 
     // We need this operator for the "*p" part of expressions like "for (
     // const_iterator p = begin() + nStart; *p; ++p )". In this case,
@@ -114,38 +106,31 @@ public:
     bool operator&&(bool v) const { return (bool)*this && v; }
 
     // 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_SEPARATE_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; }
+
+#define wxUNICHAR_DEFINE_OPERATOR_EQUAL(type) \
+    wxUniChar& operator=(type c) { m_value = c; return *this; }
+    wxDO_FOR_INT_TYPES(wxUNICHAR_DEFINE_OPERATOR_EQUAL)
+#undef wxUNICHAR_DEFINE_OPERATOR_EQUAL
 
     // Comparison operators:
+#define wxDEFINE_UNICHAR_CMP_WITH_INT(T, op) \
+    bool operator op(T c) const { return m_value op (value_type)c; }
 
     // define the given comparison operator for all the types
 #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(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; }
+    wxDO_FOR_INT_TYPES_1(wxDEFINE_UNICHAR_CMP_WITH_INT, op)
 
     wxFOR_ALL_COMPARISONS(wxDEFINE_UNICHAR_OPERATOR)
 
 #undef wxDEFINE_UNICHAR_OPERATOR
+#undef wxDEFINE_UNCHAR_CMP_WITH_INT
 
     // this is needed for expressions like 'Z'-c
     int operator-(const wxUniChar& c) const { return m_value - c.m_value; }
@@ -155,8 +140,36 @@ public:
 
 
 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;
@@ -174,7 +187,7 @@ private:
 
     // create the reference
 #if wxUSE_UNICODE_UTF8
-    wxUniCharRef(wxStringIteratorNode& node, iterator pos) : m_node(node), m_pos(pos) {}
+    wxUniCharRef(wxString& str, iterator pos) : m_str(str), m_pos(pos) {}
 #else
     wxUniCharRef(iterator pos) : m_pos(pos) {}
 #endif
@@ -186,8 +199,8 @@ public:
     //     that must be used explicitly (this is more than using 'explicit'
     //     keyword on ctor!):
 #if wxUSE_UNICODE_UTF8
-    static wxUniCharRef CreateForString(wxStringIteratorNode& node, iterator pos)
-        { return wxUniCharRef(node, pos); }
+    static wxUniCharRef CreateForString(wxString& str, iterator pos)
+        { return wxUniCharRef(str, pos); }
 #else
     static wxUniCharRef CreateForString(iterator pos)
         { return wxUniCharRef(pos); }
@@ -200,6 +213,7 @@ public:
 #endif // wxUSE_UNICODE_UTF8
 
     bool IsAscii() const { return UniChar().IsAscii(); }
+    bool GetAsChar(char *c) const { return UniChar().GetAsChar(c); }
 
     // Assignment operators:
 #if wxUSE_UNICODE_UTF8
@@ -209,55 +223,37 @@ public:
 #endif
 
     wxUniCharRef& operator=(const wxUniCharRef& c)
-        { return *this = c.UniChar(); }
+        { 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_SEPARATE_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); }
+#define wxUNICHAR_REF_DEFINE_OPERATOR_EQUAL(type) \
+    wxUniCharRef& operator=(type c) { return *this = wxUniChar(c); }
+    wxDO_FOR_CHAR_INT_TYPES(wxUNICHAR_REF_DEFINE_OPERATOR_EQUAL)
+#undef wxUNICHAR_REF_DEFINE_OPERATOR_EQUAL
 
     // Conversions to the same types as wxUniChar is convertible too:
-    operator char() const { return UniChar(); }
-    operator unsigned char() const { return UniChar(); }
-#if wxWCHAR_T_IS_SEPARATE_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(); }
+#define wxUNICHAR_REF_DEFINE_OPERATOR_PAREN(type) \
+    operator type() const { return UniChar(); }
+    wxDO_FOR_CHAR_INT_TYPES(wxUNICHAR_REF_DEFINE_OPERATOR_PAREN)
+#undef wxUNICHAR_REF_DEFINE_OPERATOR_PAREN
 
     // see wxUniChar::operator bool etc. for explanation
     operator bool() const { return (bool)UniChar(); }
     bool operator!() const { return !UniChar(); }
     bool operator&&(bool v) const { return UniChar() && v; }
 
+#define wxDEFINE_UNICHARREF_CMP_WITH_INT(T, op) \
+    bool operator op(T c) const { return UniChar() op c; }
+
     // 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(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; }
+    wxDO_FOR_CHAR_INT_TYPES_1(wxDEFINE_UNICHARREF_CMP_WITH_INT, op)
 
     wxFOR_ALL_COMPARISONS(wxDEFINE_UNICHARREF_OPERATOR)
 
 #undef wxDEFINE_UNICHARREF_OPERATOR
+#undef wxDEFINE_UNICHARREF_CMP_WITH_INT
 
     // for expressions like c-'A':
     int operator-(const wxUniCharRef& c) const { return UniChar() - c.UniChar(); }
@@ -273,12 +269,12 @@ private:
     wxUniChar UniChar() const { return *m_pos; }
 #endif
 
-    friend class WXDLLIMPEXP_BASE wxUniChar;
+    friend class WXDLLIMPEXP_FWD_BASE wxUniChar;
 
 private:
     // reference to the string and pointer to the character in string
 #if wxUSE_UNICODE_UTF8
-    wxStringIteratorNode& m_node;
+    wxString& m_str;
 #endif
     iterator m_pos;
 };
@@ -297,17 +293,13 @@ inline wxUniChar& wxUniChar::operator=(const wxUniCharRef& c)
 // Comparison operators for the case when wxUniChar(Ref) is the second operand
 // implemented in terms of member comparison functions
 
-#define wxCMP_REVERSE(c1, c2, op) c2 op c1
-
-wxDEFINE_COMPARISONS(char, const wxUniChar&, wxCMP_REVERSE)
-wxDEFINE_COMPARISONS(char, const wxUniCharRef&, wxCMP_REVERSE)
-
-wxDEFINE_COMPARISONS(wchar_t, const wxUniChar&, wxCMP_REVERSE)
-wxDEFINE_COMPARISONS(wchar_t, const wxUniCharRef&, wxCMP_REVERSE)
+wxDEFINE_COMPARISONS_BY_REV(char, const wxUniChar&)
+wxDEFINE_COMPARISONS_BY_REV(char, const wxUniCharRef&)
 
-wxDEFINE_COMPARISONS(const wxUniChar&, const wxUniCharRef&, wxCMP_REVERSE)
+wxDEFINE_COMPARISONS_BY_REV(wchar_t, const wxUniChar&)
+wxDEFINE_COMPARISONS_BY_REV(wchar_t, const wxUniCharRef&)
 
-#undef wxCMP_REVERSE
+wxDEFINE_COMPARISONS_BY_REV(const wxUniChar&, const wxUniCharRef&)
 
 // for expressions like c-'A':
 inline int operator-(char c1, const wxUniCharRef& c2) { return -(c2 - c1); }