]> git.saurik.com Git - wxWidgets.git/blame - include/wx/unichar.h
wxUSE_STL compilation fixes for wxGenericFontDialog
[wxWidgets.git] / include / wx / unichar.h
CommitLineData
e3f6cbd9
VS
1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/unichar.h
3// Purpose: wxUniChar and wxUniCharRef classes
4// Author: Vaclav Slavik
5// Created: 2007-03-19
6// RCS-ID: $Id$
7// Copyright: (c) 2007 REA Elektronik GmbH
8// Licence: wxWindows licence
9///////////////////////////////////////////////////////////////////////////////
10
11#ifndef _WX_UNICHAR_H_
12#define _WX_UNICHAR_H_
13
dbecee02 14#include "wx/defs.h"
e3f6cbd9 15#include "wx/chartype.h"
a7ea63e2 16#include "wx/stringimpl.h"
a962cdf4 17
436bb9f5
VZ
18// wint_t is just a typedef for wchar_t for many old compilers but for modern
19// ones it's a separate type and we must provide a conversion to it to allow
20// passing wxUniChar[Ref] to functions taking wint_t such as iswalnum() &c
fddca1dc
VZ
21#if (defined(__GNUC__) && \
22 !defined(__DARWIN__) && !defined(__OS2__) && !defined(__DOS__)) || \
436bb9f5
VZ
23 (defined(__VISUALC__) && defined(_NATIVE_WCHAR_T_DEFINED))
24 #define wxWINT_T_IS_SEPARATE_TYPE
25#endif
26
27// helper macro for doing something dependent on whether wint_t is or isn't a
28// typedef inside another macro
29#ifdef wxWINT_T_IS_SEPARATE_TYPE
30 #define wxIF_WINT_T_TYPE(x) x
31#else // !wxWINT_T_IS_SEPARATE_TYPE
32 #define wxIF_WINT_T_TYPE(x)
33#endif // wxWINT_T_IS_SEPARATE_TYPE/!wxWINT_T_IS_SEPARATE_TYPE
34
153bc803
VZ
35// wchar_t seems to be defined as unsigned short by all Windows compilers but
36// unsigned int everywhere else
37#ifndef __WIN32__
38 #define wxWCHAR_T_IS_UINT
39#endif
40
e3f6cbd9 41class WXDLLIMPEXP_BASE wxUniCharRef;
b0c4d5d7 42class WXDLLIMPEXP_BASE wxStringIteratorNode;
e3f6cbd9
VS
43
44// This class represents single Unicode character. It can be converted to
45// and from char or wchar_t and implements commonly used character operations.
46class WXDLLIMPEXP_BASE wxUniChar
47{
48public:
49 // NB: this is not wchar_t on purpose, it needs to represent the entire
50 // Unicode code points range and wchar_t may be too small for that
51 // (e.g. on Win32 where wchar_t* is encoded in UTF-16)
dbecee02 52 typedef wxUint32 value_type;
e3f6cbd9
VS
53
54 wxUniChar() : m_value(0) {}
55
56 // Create the character from 8bit character value encoded in the current
57 // locale's charset.
58 wxUniChar(char c) { m_value = From8bit(c); }
9f1b1b78 59 wxUniChar(unsigned char c) { m_value = From8bit((char)c); }
e3f6cbd9
VS
60
61 // Create the character from a wchar_t character value.
62 wxUniChar(wchar_t c) { m_value = c; }
436bb9f5
VZ
63#ifdef wxWINT_T_IS_SEPARATE_TYPE
64 wxUniChar(wint_t c) { m_value = c; }
65#endif
e3f6cbd9 66
e3f6cbd9 67 wxUniChar(int c) { m_value = c; }
4e5b3a4e 68 wxUniChar(long int c) { m_value = c; }
e3f6cbd9
VS
69
70 wxUniChar(const wxUniCharRef& c);
71
72 // Returns Unicode code point value of the character
d1b7ed67 73 value_type GetValue() const { return m_value; }
e3f6cbd9 74
1fc10687
VS
75#if wxUSE_UNICODE_UTF8
76 // buffer for single UTF-8 character
77 struct Utf8CharBuffer
78 {
79 char data[5];
80 operator const char*() const { return data; }
81 };
82
83 // returns the character encoded as UTF-8
84 // (NB: implemented in stringops.cpp)
85 Utf8CharBuffer AsUTF8() const;
86#endif // wxUSE_UNICODE_UTF8
87
81727065
VS
88 // Returns true if the character is an ASCII character:
89 bool IsAscii() const { return m_value < 0x80; }
90
2a686bd3
VZ
91 // Conversions to char and wchar_t types: all of those are needed to be
92 // able to pass wxUniChars to verious standard narrow and wide character
93 // functions
e3f6cbd9
VS
94 operator char() const { return To8bit(m_value); }
95 operator wchar_t() const { return m_value; }
e3f6cbd9 96 operator int() const { return m_value; }
4e5b3a4e 97 operator long int() const { return m_value; }
153bc803
VZ
98#ifndef wxWCHAR_T_IS_UINT
99 operator unsigned int() const { return m_value; }
100#endif
2a686bd3
VZ
101
102 // More conversions needed for other standard functions: uchar is for VC++
103 // _mbxxx() ones (to which toxxx/isxxx() are mapped when _MBCS is defined)
c961c0cf
VZ
104 // and some wide character functions take wint_t which happens to be the
105 // same as wchar_t for Windows compilers but not for g++ (except for the
106 // special Apple version)
2a686bd3 107 operator unsigned char() const { return (unsigned char)To8bit(m_value); }
436bb9f5 108#ifdef wxWINT_T_IS_SEPARATE_TYPE
c961c0cf
VZ
109 operator wint_t() const { return m_value; }
110#endif
e3f6cbd9
VS
111
112 // We need this operator for the "*p" part of expressions like "for (
113 // const_iterator p = begin() + nStart; *p; ++p )". In this case,
114 // compilation would fail without it because the conversion to bool would
115 // be ambiguous (there are all these int types conversions...). (And adding
116 // operator unspecified_bool_type() would only makes the ambiguity worse.)
117 operator bool() const { return m_value != 0; }
118 bool operator!() const { return !((bool)*this); }
119#if (defined(__VISUALC__) && __VISUALC__ < 1400) || \
120 defined(__DIGITALMARS__) || defined(__BORLANDC__)
121 // We need this for VC++ < 8 or DigitalMars and expressions like
122 // "str[0] && *p":
123 bool operator&&(bool v) const { return (bool)*this && v; }
124#endif
125
126 // Assignment operators:
127 wxUniChar& operator=(const wxUniChar& c) { m_value = c.m_value; return *this; }
128 wxUniChar& operator=(char c) { m_value = From8bit(c); return *this; }
db18be57 129 wxUniChar& operator=(unsigned char c) { m_value = From8bit((char)c); return *this; }
e3f6cbd9 130 wxUniChar& operator=(wchar_t c) { m_value = c; return *this; }
171d6132 131 wxUniChar& operator=(int c) { m_value = c; return *this; }
4e5b3a4e 132 wxUniChar& operator=(long int c) { m_value = c; return *this; }
436bb9f5
VZ
133#ifdef wxWINT_T_IS_SEPARATE_TYPE
134 wxUniChar& operator=(wint_t c) { m_value = c; return *this; }
135#endif
e3f6cbd9 136
fb52c2b6 137 // Comparison operators:
e3f6cbd9 138
fb52c2b6 139 // define the given comparison operator for all the types
98c4eb39 140#define wxDEFINE_UNICHAR_OPERATOR(op) \
fb52c2b6
VZ
141 bool operator op(const wxUniChar& c) const { return m_value op c.m_value; }\
142 bool operator op(char c) const { return m_value op From8bit(c); } \
db18be57 143 bool operator op(unsigned char c) const { return m_value op From8bit((char)c); } \
436bb9f5 144 bool operator op(wchar_t c) const { return m_value op (value_type)c; } \
db18be57 145 bool operator op(int c) const { return m_value op (value_type)c; } \
4e5b3a4e 146 bool operator op(long int c) const { return m_value op (value_type)c; } \
436bb9f5 147 wxIF_WINT_T_TYPE( bool operator op(wint_t c) const { return m_value op (value_type)c; } )
e3f6cbd9 148
fb52c2b6 149 wxFOR_ALL_COMPARISONS(wxDEFINE_UNICHAR_OPERATOR)
e3f6cbd9 150
fb52c2b6 151#undef wxDEFINE_UNICHAR_OPERATOR
e3f6cbd9 152
fb52c2b6 153 // this is needed for expressions like 'Z'-c
e3f6cbd9
VS
154 int operator-(const wxUniChar& c) const { return m_value - c.m_value; }
155 int operator-(char c) const { return m_value - From8bit(c); }
db18be57 156 int operator-(unsigned char c) const { return m_value - From8bit((char)c); }
d1b7ed67 157 int operator-(wchar_t c) const { return m_value - (value_type)c; }
436bb9f5
VZ
158#ifdef wxWINT_T_IS_SEPARATE_TYPE
159 int operator-(wint_t c) const { return m_value - (value_type)c; }
160#endif
e3f6cbd9
VS
161
162private:
d1b7ed67
VS
163 static value_type From8bit(char c);
164 static char To8bit(value_type c);
e3f6cbd9
VS
165
166private:
d1b7ed67 167 value_type m_value;
e3f6cbd9
VS
168};
169
170
171// Writeable reference to a character in wxString.
172//
173// This class can be used in the same way wxChar is used, except that changing
174// its value updates the underlying string object.
175class WXDLLIMPEXP_BASE wxUniCharRef
176{
177private:
a962cdf4
VS
178 typedef wxStringImpl::iterator iterator;
179
e3f6cbd9 180 // create the reference
81727065 181#if wxUSE_UNICODE_UTF8
b0c4d5d7 182 wxUniCharRef(wxStringIteratorNode& node, iterator pos) : m_node(node), m_pos(pos) {}
81727065 183#else
a962cdf4 184 wxUniCharRef(iterator pos) : m_pos(pos) {}
81727065 185#endif
e3f6cbd9
VS
186
187public:
188 // NB: we have to make this public, because we don't have wxString
189 // declaration available here and so can't declare wxString::iterator
190 // as friend; so at least don't use a ctor but a static function
191 // that must be used explicitly (this is more than using 'explicit'
192 // keyword on ctor!):
81727065 193#if wxUSE_UNICODE_UTF8
b0c4d5d7
VS
194 static wxUniCharRef CreateForString(wxStringIteratorNode& node, iterator pos)
195 { return wxUniCharRef(node, pos); }
81727065 196#else
a962cdf4 197 static wxUniCharRef CreateForString(iterator pos)
e3f6cbd9 198 { return wxUniCharRef(pos); }
81727065 199#endif
e3f6cbd9 200
d1b7ed67 201 wxUniChar::value_type GetValue() const { return UniChar().GetValue(); }
1fc10687
VS
202
203#if wxUSE_UNICODE_UTF8
204 wxUniChar::Utf8CharBuffer AsUTF8() const { return UniChar().AsUTF8(); }
205#endif // wxUSE_UNICODE_UTF8
206
bc5443ba 207 bool IsAscii() const { return UniChar().IsAscii(); }
e3f6cbd9
VS
208
209 // Assignment operators:
81727065
VS
210#if wxUSE_UNICODE_UTF8
211 wxUniCharRef& operator=(const wxUniChar& c);
212#else
213 wxUniCharRef& operator=(const wxUniChar& c) { *m_pos = c; return *this; }
214#endif
e3f6cbd9 215
81727065
VS
216 wxUniCharRef& operator=(const wxUniCharRef& c)
217 { return *this = c.UniChar(); }
e3f6cbd9
VS
218
219 wxUniCharRef& operator=(char c) { return *this = wxUniChar(c); }
db18be57 220 wxUniCharRef& operator=(unsigned char c) { return *this = wxUniChar(c); }
e3f6cbd9 221 wxUniCharRef& operator=(wchar_t c) { return *this = wxUniChar(c); }
171d6132 222 wxUniCharRef& operator=(int c) { return *this = wxUniChar(c); }
4e5b3a4e 223 wxUniCharRef& operator=(long int c) { return *this = wxUniChar(c); }
436bb9f5
VZ
224#ifdef wxWINT_T_IS_SEPARATE_TYPE
225 wxUniCharRef& operator=(wint_t c) { return *this = wxUniChar(c); }
226#endif
e3f6cbd9 227
2a686bd3 228 // Conversions to the same types as wxUniChar is convertible too:
e3f6cbd9 229 operator char() const { return UniChar(); }
e3f6cbd9 230 operator int() const { return UniChar(); }
4e5b3a4e 231 operator long int() const { return UniChar(); }
2a686bd3 232 operator unsigned char() const { return UniChar(); }
436bb9f5
VZ
233 operator wchar_t() const { return UniChar(); }
234#ifdef wxWINT_T_IS_SEPARATE_TYPE
c961c0cf
VZ
235 operator wint_t() const { return UniChar(); }
236#endif
153bc803
VZ
237#ifndef wxWCHAR_T_IS_UINT
238 operator unsigned int() const { return UniChar(); }
239#endif
e3f6cbd9
VS
240
241 // see wxUniChar::operator bool etc. for explanation
242 operator bool() const { return (bool)UniChar(); }
243 bool operator!() const { return !UniChar(); }
244#if (defined(__VISUALC__) && __VISUALC__ < 1400) || \
245 defined(__DIGITALMARS__) || defined(__BORLANDC__)
246 bool operator&&(bool v) const { return UniChar() && v; }
247#endif
248
fb52c2b6 249 // Comparison operators:
98c4eb39 250#define wxDEFINE_UNICHARREF_OPERATOR(op) \
fb52c2b6
VZ
251 bool operator op(const wxUniCharRef& c) const { return UniChar() op c.UniChar(); }\
252 bool operator op(const wxUniChar& c) const { return UniChar() op c; } \
253 bool operator op(char c) const { return UniChar() op c; } \
db18be57 254 bool operator op(unsigned char c) const { return UniChar() op c; } \
436bb9f5 255 bool operator op(wchar_t c) const { return UniChar() op c; } \
db18be57 256 bool operator op(int c) const { return UniChar() op c; } \
4e5b3a4e 257 bool operator op(long int c) const { return UniChar() op c; } \
436bb9f5 258 wxIF_WINT_T_TYPE( bool operator op(wint_t c) const { return UniChar() op c; } )
e3f6cbd9 259
fb52c2b6 260 wxFOR_ALL_COMPARISONS(wxDEFINE_UNICHARREF_OPERATOR)
e3f6cbd9 261
fb52c2b6 262#undef wxDEFINE_UNICHARREF_OPERATOR
e3f6cbd9
VS
263
264 // for expressions like c-'A':
265 int operator-(const wxUniCharRef& c) const { return UniChar() - c.UniChar(); }
266 int operator-(const wxUniChar& c) const { return UniChar() - c; }
267 int operator-(char c) const { return UniChar() - c; }
db18be57 268 int operator-(unsigned char c) const { return UniChar() - c; }
e3f6cbd9 269 int operator-(wchar_t c) const { return UniChar() - c; }
436bb9f5
VZ
270#ifdef wxWINT_T_IS_SEPARATE_TYPE
271 int operator-(wint_t c) const { return UniChar() - c; }
272#endif
e3f6cbd9
VS
273
274private:
81727065 275#if wxUSE_UNICODE_UTF8
467175ab 276 wxUniChar UniChar() const;
81727065 277#else
467175ab 278 wxUniChar UniChar() const { return *m_pos; }
81727065
VS
279#endif
280
e3f6cbd9
VS
281 friend class WXDLLIMPEXP_BASE wxUniChar;
282
283private:
81727065
VS
284 // reference to the string and pointer to the character in string
285#if wxUSE_UNICODE_UTF8
b0c4d5d7 286 wxStringIteratorNode& m_node;
81727065 287#endif
a962cdf4 288 iterator m_pos;
e3f6cbd9
VS
289};
290
291inline wxUniChar::wxUniChar(const wxUniCharRef& c)
292{
293 m_value = c.UniChar().m_value;
294}
295
fb52c2b6
VZ
296// Comparison operators for the case when wxUniChar(Ref) is the second operand
297// implemented in terms of member comparison functions
e3f6cbd9 298
fb52c2b6 299#define wxCMP_REVERSE(c1, c2, op) c2 op c1
e3f6cbd9 300
fb52c2b6
VZ
301wxDEFINE_COMPARISONS(char, const wxUniChar&, wxCMP_REVERSE)
302wxDEFINE_COMPARISONS(char, const wxUniCharRef&, wxCMP_REVERSE)
e3f6cbd9 303
fb52c2b6
VZ
304wxDEFINE_COMPARISONS(wchar_t, const wxUniChar&, wxCMP_REVERSE)
305wxDEFINE_COMPARISONS(wchar_t, const wxUniCharRef&, wxCMP_REVERSE)
e3f6cbd9 306
436bb9f5 307#ifdef wxWINT_T_IS_SEPARATE_TYPE
2c6725e6 308wxDEFINE_COMPARISONS(wint_t, const wxUniChar&, wxCMP_REVERSE)
436bb9f5
VZ
309wxDEFINE_COMPARISONS(wint_t, const wxUniCharRef&, wxCMP_REVERSE)
310#endif
311
fb52c2b6 312wxDEFINE_COMPARISONS(const wxUniChar&, const wxUniCharRef&, wxCMP_REVERSE)
e3f6cbd9 313
fb52c2b6 314#undef wxCMP_REVERSE
e3f6cbd9
VS
315
316// for expressions like c-'A':
317inline int operator-(char c1, const wxUniCharRef& c2) { return -(c2 - c1); }
e3f6cbd9 318inline int operator-(const wxUniChar& c1, const wxUniCharRef& c2) { return -(c2 - c1); }
436bb9f5
VZ
319inline int operator-(wchar_t c1, const wxUniCharRef& c2) { return -(c2 - c1); }
320#ifdef wxWINT_T_IS_SEPARATE_TYPE
321inline int operator-(wint_t c1, const wxUniCharRef& c2) { return -(c2 - c1); }
322#endif
e3f6cbd9
VS
323
324#endif /* _WX_UNICHAR_H_ */