]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/unichar.h
don't use C++ comments in C files
[wxWidgets.git] / include / wx / unichar.h
index 20b1376e44c486652799d40232b49ecd6dbd0bf3..f035f3892f85151db85c44a9dfbb51585c199a56 100644 (file)
 
 #include "wx/defs.h"
 #include "wx/chartype.h"
+#include "wx/stringimpl.h"
+
+// wint_t is just a typedef for wchar_t for many old compilers but for modern
+// ones it's a separate type and we must provide a conversion to it to allow
+// passing wxUniChar[Ref] to functions taking wint_t such as iswalnum() &c
+#if (defined(__GNUC__) && \
+        !defined(__DARWIN__) && !defined(__OS2__) && !defined(__DOS__)) || \
+    (defined(__VISUALC__) && defined(_NATIVE_WCHAR_T_DEFINED)) || \
+    wxCHECK_SUNCC_VERSION(5, 9)
+    #define wxWINT_T_IS_SEPARATE_TYPE
+#endif
+
+// helper macro for doing something dependent on whether wint_t is or isn't a
+// typedef inside another macro
+#ifdef wxWINT_T_IS_SEPARATE_TYPE
+    #define wxIF_WINT_T_TYPE(x) x
+#else // !wxWINT_T_IS_SEPARATE_TYPE
+    #define wxIF_WINT_T_TYPE(x)
+#endif // wxWINT_T_IS_SEPARATE_TYPE/!wxWINT_T_IS_SEPARATE_TYPE
+
+// wchar_t seems to be defined as unsigned short by all Windows compilers but
+// unsigned int everywhere else
+#ifndef __WIN32__
+    #define wxWCHAR_T_IS_UINT
+#endif
 
 class WXDLLIMPEXP_BASE wxUniCharRef;
+class WXDLLIMPEXP_BASE wxStringIteratorNode;
 
 // This class represents single Unicode character. It can be converted to
 // and from char or wchar_t and implements commonly used character operations.
@@ -35,20 +61,44 @@ public:
 
     // Create the character from a wchar_t character value.
     wxUniChar(wchar_t c) { m_value = c; }
+#ifdef wxWINT_T_IS_SEPARATE_TYPE
+    wxUniChar(wint_t c) { m_value = c; }
+#endif
 
     wxUniChar(int c) { m_value = c; }
+    wxUniChar(long 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; }
+
     // 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; }
+    operator long int() const { return m_value; }
+#ifndef wxWCHAR_T_IS_UINT
+    operator unsigned int() const { return m_value; }
+#endif
 
     // More conversions needed for other standard functions: uchar is for VC++
     // _mbxxx() ones (to which toxxx/isxxx() are mapped when _MBCS is defined)
@@ -56,7 +106,7 @@ public:
     // 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__)
+#ifdef wxWINT_T_IS_SEPARATE_TYPE
     operator wint_t() const { return m_value; }
 #endif
 
@@ -67,17 +117,21 @@ 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=(char c) { m_value = From8bit(c); return *this; }
+    wxUniChar& operator=(unsigned char c) { m_value = From8bit((char)c); return *this; }
     wxUniChar& operator=(wchar_t c) { m_value = c; return *this; }
+    wxUniChar& operator=(int c) { m_value = c; return *this; }
+    wxUniChar& operator=(long int c) { m_value = c; return *this; }
+#ifdef wxWINT_T_IS_SEPARATE_TYPE
+    wxUniChar& operator=(wint_t c) { m_value = c; return *this; }
+#endif
 
     // Comparison operators:
 
@@ -85,7 +139,11 @@ 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); } \
+    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(long int c) const { return m_value op (value_type)c; }   \
+    wxIF_WINT_T_TYPE( bool operator op(wint_t c) const { return m_value op (value_type)c; } )
 
     wxFOR_ALL_COMPARISONS(wxDEFINE_UNICHAR_OPERATOR)
 
@@ -94,7 +152,11 @@ 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; }
+#ifdef wxWINT_T_IS_SEPARATE_TYPE
+    int operator-(wint_t c) const { return m_value - (value_type)c; }
+#endif
 
 private:
     static value_type From8bit(char c);
@@ -112,9 +174,14 @@ private:
 class WXDLLIMPEXP_BASE wxUniCharRef
 {
 private:
+    typedef wxStringImpl::iterator iterator;
+
     // create the reference
-    // FIXME-UTF8: the interface will need changes for UTF-8 build
-    wxUniCharRef(wxChar *pos) : m_pos(pos) {}
+#if wxUSE_UNICODE_UTF8
+    wxUniCharRef(wxStringIteratorNode& node, iterator pos) : m_node(node), 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
@@ -122,37 +189,53 @@ 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!):
-    //
-    // FIXME-UTF8: the interface will need changes for UTF-8 build
-    static wxUniCharRef CreateForString(wxChar *pos)
+#if wxUSE_UNICODE_UTF8
+    static wxUniCharRef CreateForString(wxStringIteratorNode& node, iterator pos)
+        { return wxUniCharRef(node, 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(); }
+
     // 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)
+        { return *this = c.UniChar(); }
 
     wxUniCharRef& operator=(char c) { return *this = wxUniChar(c); }
+    wxUniCharRef& operator=(unsigned char c) { return *this = wxUniChar(c); }
     wxUniCharRef& operator=(wchar_t c) { return *this = wxUniChar(c); }
+    wxUniCharRef& operator=(int c) { return *this = wxUniChar(c); }
+    wxUniCharRef& operator=(long int c) { return *this = wxUniChar(c); }
+#ifdef wxWINT_T_IS_SEPARATE_TYPE
+    wxUniCharRef& operator=(wint_t c) { return *this = wxUniChar(c); }
+#endif
 
     // 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 long int() const { return UniChar(); }
     operator unsigned char() const { return UniChar(); }
-#if defined(__GNUC__) && !defined(__DARWIN__)
+    operator wchar_t() const { return UniChar(); }
+#ifdef wxWINT_T_IS_SEPARATE_TYPE
     operator wint_t() const { return UniChar(); }
 #endif
+#ifndef wxWCHAR_T_IS_UINT
+    operator unsigned int() const { return UniChar(); }
+#endif
 
     // see wxUniChar::operator bool etc. for explanation
     operator bool() const { return (bool)UniChar(); }
@@ -167,7 +250,11 @@ public:
     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; }        \
+    bool operator op(wchar_t c) const { return UniChar() op c; }              \
+    bool operator op(int c) const { return UniChar() op c; }                  \
+    bool operator op(long int c) const { return UniChar() op c; }             \
+    wxIF_WINT_T_TYPE( bool operator op(wint_t c) const { return UniChar() op c; } )
 
     wxFOR_ALL_COMPARISONS(wxDEFINE_UNICHARREF_OPERATOR)
 
@@ -177,15 +264,27 @@ 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; }
+#ifdef wxWINT_T_IS_SEPARATE_TYPE
+    int operator-(wint_t c) const { return UniChar() - c; }
+#endif
 
 private:
+#if wxUSE_UNICODE_UTF8
+    wxUniChar UniChar() const;
+#else
     wxUniChar UniChar() const { return *m_pos; }
+#endif
+
     friend class WXDLLIMPEXP_BASE wxUniChar;
 
 private:
-    // pointer to the character in string
-    wxChar *m_pos;
+    // reference to the string and pointer to the character in string
+#if wxUSE_UNICODE_UTF8
+    wxStringIteratorNode& m_node;
+#endif
+    iterator m_pos;
 };
 
 inline wxUniChar::wxUniChar(const wxUniCharRef& c)
@@ -204,13 +303,21 @@ wxDEFINE_COMPARISONS(char, const wxUniCharRef&, wxCMP_REVERSE)
 wxDEFINE_COMPARISONS(wchar_t, const wxUniChar&, wxCMP_REVERSE)
 wxDEFINE_COMPARISONS(wchar_t, const wxUniCharRef&, wxCMP_REVERSE)
 
+#ifdef wxWINT_T_IS_SEPARATE_TYPE
+wxDEFINE_COMPARISONS(wint_t, const wxUniChar&, wxCMP_REVERSE)
+wxDEFINE_COMPARISONS(wint_t, const wxUniCharRef&, wxCMP_REVERSE)
+#endif
+
 wxDEFINE_COMPARISONS(const wxUniChar&, const wxUniCharRef&, wxCMP_REVERSE)
 
 #undef 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); }
+#ifdef wxWINT_T_IS_SEPARATE_TYPE
+inline int operator-(wint_t c1, const wxUniCharRef& c2) { return -(c2 - c1); }
+#endif
 
 #endif /* _WX_UNICHAR_H_ */