wxWidgets/include/wx/unichar.h

///////////////////////////////////////////////////////////////////////////////
// Name:        wx/unichar.h
// Purpose:     wxUniChar and wxUniCharRef classes
// Author:      Vaclav Slavik
// Created:     2007-03-19
// RCS-ID:      $Id$
// Copyright:   (c) 2007 REA Elektronik GmbH
// Licence:     wxWindows licence
///////////////////////////////////////////////////////////////////////////////

#ifndef _WX_UNICHAR_H_
#define _WX_UNICHAR_H_

#include "wx/defs.h"
#include "wx/chartype.h"

class WXDLLIMPEXP_BASE wxUniCharRef;

// This class represents single Unicode character. It can be converted to
// and from char or wchar_t and implements commonly used character operations.
class WXDLLIMPEXP_BASE wxUniChar
{
public:
    // NB: this is not wchar_t on purpose, it needs to represent the entire
    //     Unicode code points range and wchar_t may be too small for that
    //     (e.g. on Win32 where wchar_t* is encoded in UTF-16)
    typedef wxUint32 value_type;

    wxUniChar() : m_value(0) {}

    // Create the character from 8bit character value encoded in the current
    // locale's charset.
    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.
    wxUniChar(wchar_t c) { m_value = c; }

#ifndef wxWINT_T_IS_TYPEDEF
    // Create the character from a wint_t character value.
    wxUniChar(wint_t c) { m_value = c; }
#endif

    wxUniChar(int c) { m_value = c; }

    wxUniChar(const wxUniCharRef& c);

    // Returns Unicode code point value of the character
    value_type GetValue() const { return m_value; }

    // Casts to char and wchar_t types:
    operator char() const { return To8bit(m_value); }
    operator unsigned char() const { return (unsigned char)To8bit(m_value); }
    operator wchar_t() const { return m_value; }
#ifndef wxWINT_T_IS_TYPEDEF
    operator wint_t() const { return m_value; }
#endif
    operator int() const { return m_value; }

    // We need this operator for the "*p" part of expressions like "for (
    // const_iterator p = begin() + nStart; *p; ++p )". In this case,
    // compilation would fail without it because the conversion to bool would
    // be ambiguous (there are all these int types conversions...). (And adding
    // 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":
    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=(wchar_t c) { m_value = c; return *this; }
#ifndef wxWINT_T_IS_TYPEDEF
    wxUniChar& operator=(wint_t c) { m_value = c; return *this; }
#endif

    // Comparision operators:
    bool operator==(const wxUniChar& c) const { return m_value == c.m_value; }
    bool operator==(char c) const { return m_value == From8bit(c); }
    bool operator==(wchar_t c) const { return m_value == (value_type)c; }
#ifndef wxWINT_T_IS_TYPEDEF
    bool operator==(wint_t c) const { return m_value == (value_type)c; }
#endif

    bool operator!=(const wxUniChar& c) const { return m_value != c.m_value; }
    bool operator!=(char c) const { return m_value != From8bit(c); }
    bool operator!=(wchar_t c) const { return m_value != (value_type)c; }
#ifndef wxWINT_T_IS_TYPEDEF
    bool operator!=(wint_t c) const { return m_value != (value_type)c; }
#endif

    bool operator>(const wxUniChar& c) const { return m_value > c.m_value; }
    bool operator>(char c) const { return m_value > (value_type)c; }
    bool operator>(wchar_t c) const { return m_value > (value_type)c; }
#ifndef wxWINT_T_IS_TYPEDEF
    bool operator>(wint_t c) const { return m_value > (value_type)c; }
#endif

    bool operator<(const wxUniChar& c) const { return m_value < c.m_value; }
    bool operator<(char c) const { return m_value < From8bit(c); }
    bool operator<(wchar_t c) const { return m_value < (value_type)c; }
#ifndef wxWINT_T_IS_TYPEDEF
    bool operator<(wint_t c) const { return m_value < (value_type)c; }
#endif

    bool operator>=(const wxUniChar& c) const { return m_value >= c.m_value; }
    bool operator>=(char c) const { return m_value >= From8bit(c); }
    bool operator>=(wchar_t c) const { return m_value >= (value_type)c; }
#ifndef wxWINT_T_IS_TYPEDEF
    bool operator>=(wint_t c) const { return m_value >= (value_type)c; }
#endif

    bool operator<=(const wxUniChar& c) const { return m_value <= c.m_value; }
    bool operator<=(char c) const { return m_value <= From8bit(c); }
    bool operator<=(wchar_t c) const { return m_value <= (value_type)c; }
#ifndef wxWINT_T_IS_TYPEDEF
    bool operator<=(wint_t c) const { return m_value <= (value_type)c; }
#endif

    int operator-(const wxUniChar& c) const { return m_value - c.m_value; }
    int operator-(char c) const { return m_value - From8bit(c); }
    int operator-(wchar_t c) const { return m_value - (value_type)c; }
#ifndef wxWINT_T_IS_TYPEDEF
    int operator-(wint_t c) const { return m_value - (value_type)c; }
#endif

private:
    static value_type From8bit(char c);
    static char To8bit(value_type c);

private:
    value_type m_value;
};


// Writeable reference to a character in wxString.
//
// This class can be used in the same way wxChar is used, except that changing
// its value updates the underlying string object.
class WXDLLIMPEXP_BASE wxUniCharRef
{
private:
    // create the reference
    // FIXME-UTF8: the interface will need changes for UTF-8 build
    wxUniCharRef(wxChar *pos) : m_pos(pos) {}

public:
    // NB: we have to make this public, because we don't have wxString
    //     declaration available here and so can't declare wxString::iterator
    //     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)
        { return wxUniCharRef(pos); }

    wxUniChar::value_type GetValue() const { return UniChar().GetValue(); }

    // Assignment operators:
    wxUniCharRef& operator=(const wxUniCharRef& c)
    {
        *m_pos = *c.m_pos;
        return *this;
    };

    wxUniCharRef& operator=(const wxUniChar& c)
    {
        *m_pos = c;
        return *this;
    };

    wxUniCharRef& operator=(char c) { return *this = wxUniChar(c); }
    wxUniCharRef& operator=(wchar_t c) { return *this = wxUniChar(c); }

    // Casts to wxUniChar type:
    operator char() const { return UniChar(); }
    operator unsigned char() const { return UniChar(); }
    operator wchar_t() const { return UniChar(); }
#ifndef wxWINT_T_IS_TYPEDEF
    operator wint_t() const { return UniChar(); }
#endif
    operator 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

    // Comparision operators:
    bool operator==(const wxUniCharRef& c) const { return m_pos == c.m_pos; }
    bool operator==(const wxUniChar& c) const { return UniChar() == c; }
    bool operator==(char c) const { return UniChar() == c; }
    bool operator==(wchar_t c) const { return UniChar() == c; }
#ifndef wxWINT_T_IS_TYPEDEF
    bool operator==(wint_t c) const { return UniChar() == c; }
#endif

    bool operator!=(const wxUniCharRef& c) const { return m_pos != c.m_pos; }
    bool operator!=(const wxUniChar& c) const { return UniChar() != c; }
    bool operator!=(char c) const { return UniChar() != c; }
    bool operator!=(wchar_t c) const { return UniChar() != c; }
#ifndef wxWINT_T_IS_TYPEDEF
    bool operator!=(wint_t c) const { return UniChar() != c; }
#endif

    bool operator>(const wxUniCharRef& c) const { return UniChar() > c.UniChar(); }
    bool operator>(const wxUniChar& c) const { return UniChar() > c; }
    bool operator>(char c) const { return UniChar() > c; }
    bool operator>(wchar_t c) const { return UniChar() > c; }
#ifndef wxWINT_T_IS_TYPEDEF
    bool operator>(wint_t c) const { return UniChar() > c; }
#endif

    bool operator<(const wxUniCharRef& c) const { return UniChar() < c.UniChar(); }
    bool operator<(const wxUniChar& c) const { return UniChar() < c; }
    bool operator<(char c) const { return UniChar() < c; }
    bool operator<(wchar_t c) const { return UniChar() < c; }
#ifndef wxWINT_T_IS_TYPEDEF
    bool operator<(wint_t c) const { return UniChar() < c; }
#endif

    bool operator>=(const wxUniCharRef& c) const { return UniChar() >= c.UniChar(); }
    bool operator>=(const wxUniChar& c) const { return UniChar() >= c; }
    bool operator>=(char c) const { return UniChar() >= c; }
    bool operator>=(wchar_t c) const { return UniChar() >= c; }
#ifndef wxWINT_T_IS_TYPEDEF
    bool operator>=(wint_t c) const { return UniChar() >= c; }
#endif

    bool operator<=(const wxUniCharRef& c) const { return UniChar() <= c.UniChar(); }
    bool operator<=(const wxUniChar& c) const { return UniChar() <= c; }
    bool operator<=(char c) const { return UniChar() <= c; }
    bool operator<=(wchar_t c) const { return UniChar() <= c; }
#ifndef wxWINT_T_IS_TYPEDEF
    bool operator<=(wint_t c) const { return UniChar() <= c; }
#endif

    // for expressions like c-'A':
    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-(wchar_t c) const { return UniChar() - c; }
#ifndef wxWINT_T_IS_TYPEDEF
    int operator-(wint_t c) const { return UniChar() - c; }
#endif

private:
    wxUniChar UniChar() const { return *m_pos; }
    friend class WXDLLIMPEXP_BASE wxUniChar;

private:
    // pointer to the character in string
    wxChar *m_pos;
};

inline wxUniChar::wxUniChar(const wxUniCharRef& c)
{
    m_value = c.UniChar().m_value;
}

// Comparision operators for the case when wxUniChar(Ref) is the second operand:
inline bool operator==(char c1, const wxUniChar& c2) { return c2 == c1; }
inline bool operator==(wchar_t c1, const wxUniChar& c2) { return c2 == c1; }
#ifndef wxWINT_T_IS_TYPEDEF
inline bool operator==(wint_t c1, const wxUniChar& c2) { return c2 == c1; }
#endif

inline bool operator!=(char c1, const wxUniChar& c2) { return c2 != c1; }
inline bool operator!=(wchar_t c1, const wxUniChar& c2) { return c2 != c1; }
#ifndef wxWINT_T_IS_TYPEDEF
inline bool operator!=(wint_t c1, const wxUniChar& c2) { return c2 != c1; }
#endif

inline bool operator>(char c1, const wxUniChar& c2) { return c2 < c1; }
inline bool operator>(wchar_t c1, const wxUniChar& c2) { return c2 < c1; }
#ifndef wxWINT_T_IS_TYPEDEF
inline bool operator>(wint_t c1, const wxUniChar& c2) { return c2 < c1; }
#endif

inline bool operator<(char c1, const wxUniChar& c2) { return c2 > c1; }
inline bool operator<(wchar_t c1, const wxUniChar& c2) { return c2 > c1; }
#ifndef wxWINT_T_IS_TYPEDEF
inline bool operator<(wint_t c1, const wxUniChar& c2) { return c2 > c1; }
#endif

inline bool operator>=(char c1, const wxUniChar& c2) { return c2 <= c1; }
inline bool operator>=(wchar_t c1, const wxUniChar& c2) { return c2 <= c1; }
#ifndef wxWINT_T_IS_TYPEDEF
inline bool operator>=(wint_t c1, const wxUniChar& c2) { return c2 <= c1; }
#endif

inline bool operator<=(char c1, const wxUniChar& c2) { return c2 >= c1; }
inline bool operator<=(wchar_t c1, const wxUniChar& c2) { return c2 >= c1; }
#ifndef wxWINT_T_IS_TYPEDEF
inline bool operator<=(wint_t c1, const wxUniChar& c2) { return c2 >= c1; }
#endif


inline bool operator==(char c1, const wxUniCharRef& c2) { return c2 == c1; }
inline bool operator==(wchar_t c1, const wxUniCharRef& c2) { return c2 == c1; }
#ifndef wxWINT_T_IS_TYPEDEF
inline bool operator==(wint_t c1, const wxUniCharRef& c2) { return c2 == c1; }
#endif
inline bool operator==(const wxUniChar& c1, const wxUniCharRef& c2) { return c2 == c1; }

inline bool operator!=(char c1, const wxUniCharRef& c2) { return c2 != c1; }
inline bool operator!=(wchar_t c1, const wxUniCharRef& c2) { return c2 != c1; }
#ifndef wxWINT_T_IS_TYPEDEF
inline bool operator!=(wint_t c1, const wxUniCharRef& c2) { return c2 != c1; }
#endif
inline bool operator!=(const wxUniChar& c1, const wxUniCharRef& c2) { return c2 != c1; }

inline bool operator>(char c1, const wxUniCharRef& c2) { return c2 < c1; }
inline bool operator>(wchar_t c1, const wxUniCharRef& c2) { return c2 < c1; }
#ifndef wxWINT_T_IS_TYPEDEF
inline bool operator>(wint_t c1, const wxUniCharRef& c2) { return c2 < c1; }
#endif
inline bool operator>(const wxUniChar& c1, const wxUniCharRef& c2) { return c2 < c1; }

inline bool operator<(char c1, const wxUniCharRef& c2) { return c2 > c1; }
inline bool operator<(wchar_t c1, const wxUniCharRef& c2) { return c2 > c1; }
#ifndef wxWINT_T_IS_TYPEDEF
inline bool operator<(wint_t c1, const wxUniCharRef& c2) { return c2 > c1; }
#endif
inline bool operator<(const wxUniChar& c1, const wxUniCharRef& c2) { return c2 > c1; }

inline bool operator>=(char c1, const wxUniCharRef& c2) { return c2 <= c1; }
inline bool operator>=(wchar_t c1, const wxUniCharRef& c2) { return c2 <= c1; }
#ifndef wxWINT_T_IS_TYPEDEF
inline bool operator>=(wint_t c1, const wxUniCharRef& c2) { return c2 <= c1; }
#endif
inline bool operator>=(const wxUniChar& c1, const wxUniCharRef& c2) { return c2 <= c1; }

inline bool operator<=(char c1, const wxUniCharRef& c2) { return c2 >= c1; }
inline bool operator<=(wchar_t c1, const wxUniCharRef& c2) { return c2 >= c1; }
#ifndef wxWINT_T_IS_TYPEDEF
inline bool operator<=(wint_t c1, const wxUniCharRef& c2) { return c2 >= c1; }
#endif
inline bool operator<=(const wxUniChar& c1, const wxUniCharRef& c2) { return c2 >= c1; }

// 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); }
#ifndef wxWINT_T_IS_TYPEDEF
inline int operator-(wint_t c1, const wxUniCharRef& c2) { return -(c2 - c1); }
#endif
inline int operator-(const wxUniChar& c1, const wxUniCharRef& c2) { return -(c2 - c1); }

#endif /* _WX_UNICHAR_H_ */