1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
6 @brief Provides a simple UTF-8 encoded string
13 # ifdef HAVE_SYS_TYPES_H
14 # include <sys/types.h>
24 typedef uint32_t unichar;
26 typedef u_int32_t unichar;
29 #ifndef DOXYGEN_IGNORE
31 //! The number of bytes to skip to find the next character in the string
32 const char g_utf8_skip[256] = {
33 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
34 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
35 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
36 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
37 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
38 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
39 2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
40 3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,3,4,4,4,4,4,4,4,4,5,5,5,5,6,6,1,1
43 //! The iterator type for ustring
45 Note this is not a random access iterator but a bidirectional one, since all
46 index operations need to iterate over the UTF-8 data. Use std::advance() to
47 move to a certain position.
49 A writeable iterator isn't provided because: The number of bytes of the old
50 UTF-8 character and the new one to write could be different. Therefore, any
51 write operation would invalidate all other iterators pointing into the same
55 class ustring_Iterator
58 typedef std::bidirectional_iterator_tag iterator_category;
59 typedef unichar value_type;
60 typedef std::string::difference_type difference_type;
61 typedef value_type reference;
64 inline ustring_Iterator() {}
65 inline ustring_Iterator(const ustring_Iterator<std::string::iterator>&
66 other) : _pos(other.base()) {}
68 inline value_type operator*() const {
69 // get a unicode character from the iterator's position
71 // get an iterator to the internal string
72 std::string::const_iterator pos = _pos;
74 unichar result = static_cast<unsigned char>(*pos);
76 // if its not a 7-bit ascii character
77 if((result & 0x80) != 0) {
78 // len is the number of bytes this character takes up in the string
79 unsigned char len = g_utf8_skip[result];
80 result &= 0x7F >> len;
84 result |= static_cast<unsigned char>(*++pos) & 0x3F;
91 inline ustring_Iterator<T> & operator++() {
92 pos_ += g_utf8_skip[static_cast<unsigned char>(*pos_)];
95 inline ustring_Iterator<T> & operator--() {
96 do { --_pos; } while((*_pos & '\xC0') == '\x80');
100 explicit inline ustring_Iterator(T pos) : _pos(pos) {}
101 inline T base() const { return _pos; }
107 #endif // DOXYGEN_IGNORE
109 //! This class provides a simple wrapper to a std::string that can be encoded
110 //! as UTF-8. The ustring::utf() member specifies if the given string is UTF-8
111 //! encoded. ustrings default to specifying UTF-8 encoding.
113 This class does <b>not</b> handle extended 8-bit ASCII charsets like
116 More info on Unicode and UTF-8 can be found here:
117 http://www.cl.cam.ac.uk/~mgk25/unicode.html
119 This does not subclass std::string, because std::string was intended to be a
120 final class. For instance, it does not have a virtual destructor.
127 typedef std::string::size_type size_type;
128 typedef std::string::difference_type difference_type;
130 typedef unichar value_type;
131 typedef unichar & reference;
132 typedef const unichar & const_reference;
134 typedef ustring_Iterator<std::string::iterator> iterator;
135 typedef ustring_Iterator<std::string::const_iterator> const_iterator;
137 static const size_type npos = std::string::npos;
144 ustring(const ustring& other);
145 ustring& operator=(const ustring& other);
146 ustring(const std::string& src);
147 ustring::ustring(const char* src);
149 // append to the string
151 ustring& operator+=(const ustring& src);
152 ustring& operator+=(const char* src);
153 ustring& operator+=(char c);
157 ustring::size_type size() const;
158 ustring::size_type bytes() const;
159 ustring::size_type capacity() const;
160 ustring::size_type max_size() const;
164 const char* data() const;
165 const char* c_str() const;
170 void setUtf8(bool utf8);
175 #endif // __ustring_hh