1 // Copyright 2006-2016 Nemanja Trifunovic
4 Permission is hereby granted, free of charge, to any person or organization
5 obtaining a copy of the software and accompanying documentation covered by
6 this license (the "Software") to use, reproduce, display, distribute,
7 execute, and transmit the Software, and to prepare derivative works of the
8 Software, and to permit third-parties to whom the Software is furnished to
9 do so, all subject to the following:
11 The copyright notices in the Software and this entire statement, including
12 the above license grant, this restriction and the following disclaimer,
13 must be included in all copies of the Software, in whole or in part, and
14 all derivative works of the Software, unless such copies or derivative
15 works are solely in the form of machine-executable object code generated by
16 a source language processor.
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
21 SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
22 FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
23 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 DEALINGS IN THE SOFTWARE.
28 #ifndef UTF8_FOR_CPP_CHECKED_H_2675DCD0_9480_4c0c_B92A_CC14C027B731
29 #define UTF8_FOR_CPP_CHECKED_H_2675DCD0_9480_4c0c_B92A_CC14C027B731
36 // Base for the exceptions that may be thrown from the library
37 class exception : public ::std::exception {
40 // Exceptions that may be thrown from the library functions.
41 class invalid_code_point : public exception {
44 invalid_code_point(uint32_t codepoint) : cp(codepoint) {}
45 virtual const char* what() const throw() { return "Invalid code point"; }
46 uint32_t code_point() const {return cp;}
49 class invalid_utf8 : public exception {
52 invalid_utf8 (uint8_t u) : u8(u) {}
53 virtual const char* what() const throw() { return "Invalid UTF-8"; }
54 uint8_t utf8_octet() const {return u8;}
57 class invalid_utf16 : public exception {
60 invalid_utf16 (uint16_t u) : u16(u) {}
61 virtual const char* what() const throw() { return "Invalid UTF-16"; }
62 uint16_t utf16_word() const {return u16;}
65 class not_enough_room : public exception {
67 virtual const char* what() const throw() { return "Not enough space"; }
70 /// The library API - functions intended to be called by the users
72 template <typename octet_iterator>
73 octet_iterator append(uint32_t cp, octet_iterator result)
75 if (!utf8::internal::is_code_point_valid(cp))
76 throw invalid_code_point(cp);
78 if (cp < 0x80) // one octet
79 *(result++) = static_cast<uint8_t>(cp);
80 else if (cp < 0x800) { // two octets
81 *(result++) = static_cast<uint8_t>((cp >> 6) | 0xc0);
82 *(result++) = static_cast<uint8_t>((cp & 0x3f) | 0x80);
84 else if (cp < 0x10000) { // three octets
85 *(result++) = static_cast<uint8_t>((cp >> 12) | 0xe0);
86 *(result++) = static_cast<uint8_t>(((cp >> 6) & 0x3f) | 0x80);
87 *(result++) = static_cast<uint8_t>((cp & 0x3f) | 0x80);
90 *(result++) = static_cast<uint8_t>((cp >> 18) | 0xf0);
91 *(result++) = static_cast<uint8_t>(((cp >> 12) & 0x3f) | 0x80);
92 *(result++) = static_cast<uint8_t>(((cp >> 6) & 0x3f) | 0x80);
93 *(result++) = static_cast<uint8_t>((cp & 0x3f) | 0x80);
98 template <typename octet_iterator, typename output_iterator>
99 output_iterator replace_invalid(octet_iterator start, octet_iterator end, output_iterator out, uint32_t replacement)
101 while (start != end) {
102 octet_iterator sequence_start = start;
103 internal::utf_error err_code = utf8::internal::validate_next(start, end);
105 case internal::UTF8_OK :
106 for (octet_iterator it = sequence_start; it != start; ++it)
109 case internal::NOT_ENOUGH_ROOM:
110 out = utf8::append (replacement, out);
113 case internal::INVALID_LEAD:
114 out = utf8::append (replacement, out);
117 case internal::INCOMPLETE_SEQUENCE:
118 case internal::OVERLONG_SEQUENCE:
119 case internal::INVALID_CODE_POINT:
120 out = utf8::append (replacement, out);
122 // just one replacement mark for the sequence
123 while (start != end && utf8::internal::is_trail(*start))
131 template <typename octet_iterator, typename output_iterator>
132 inline output_iterator replace_invalid(octet_iterator start, octet_iterator end, output_iterator out)
134 static const uint32_t replacement_marker = utf8::internal::mask16(0xfffd);
135 return utf8::replace_invalid(start, end, out, replacement_marker);
138 template <typename octet_iterator>
139 uint32_t next(octet_iterator& it, octet_iterator end)
142 internal::utf_error err_code = utf8::internal::validate_next(it, end, cp);
144 case internal::UTF8_OK :
146 case internal::NOT_ENOUGH_ROOM :
147 throw not_enough_room();
148 case internal::INVALID_LEAD :
149 case internal::INCOMPLETE_SEQUENCE :
150 case internal::OVERLONG_SEQUENCE :
151 throw invalid_utf8(*it);
152 case internal::INVALID_CODE_POINT :
153 throw invalid_code_point(cp);
158 template <typename octet_iterator>
159 uint32_t peek_next(octet_iterator it, octet_iterator end)
161 return utf8::next(it, end);
164 template <typename octet_iterator>
165 uint32_t prior(octet_iterator& it, octet_iterator start)
167 // can't do much if it == start
169 throw not_enough_room();
171 octet_iterator end = it;
172 // Go back until we hit either a lead octet or start
173 while (utf8::internal::is_trail(*(--it)))
175 throw invalid_utf8(*it); // error - no lead byte in the sequence
176 return utf8::peek_next(it, end);
179 template <typename octet_iterator, typename distance_type>
180 void advance (octet_iterator& it, distance_type n, octet_iterator end)
182 const distance_type zero(0);
185 for (distance_type i = n; i < zero; ++i)
186 utf8::prior(it, end);
189 for (distance_type i = zero; i < n; ++i)
194 template <typename octet_iterator>
195 typename std::iterator_traits<octet_iterator>::difference_type
196 distance (octet_iterator first, octet_iterator last)
198 typename std::iterator_traits<octet_iterator>::difference_type dist;
199 for (dist = 0; first < last; ++dist)
200 utf8::next(first, last);
204 template <typename u16bit_iterator, typename octet_iterator>
205 octet_iterator utf16to8 (u16bit_iterator start, u16bit_iterator end, octet_iterator result)
207 while (start != end) {
208 uint32_t cp = utf8::internal::mask16(*start++);
209 // Take care of surrogate pairs first
210 if (utf8::internal::is_lead_surrogate(cp)) {
212 uint32_t trail_surrogate = utf8::internal::mask16(*start++);
213 if (utf8::internal::is_trail_surrogate(trail_surrogate))
214 cp = (cp << 10) + trail_surrogate + internal::SURROGATE_OFFSET;
216 throw invalid_utf16(static_cast<uint16_t>(trail_surrogate));
219 throw invalid_utf16(static_cast<uint16_t>(cp));
222 // Lone trail surrogate
223 else if (utf8::internal::is_trail_surrogate(cp))
224 throw invalid_utf16(static_cast<uint16_t>(cp));
226 result = utf8::append(cp, result);
231 template <typename u16bit_iterator, typename octet_iterator>
232 u16bit_iterator utf8to16 (octet_iterator start, octet_iterator end, u16bit_iterator result)
234 while (start < end) {
235 uint32_t cp = utf8::next(start, end);
236 if (cp > 0xffff) { //make a surrogate pair
237 *result++ = static_cast<uint16_t>((cp >> 10) + internal::LEAD_OFFSET);
238 *result++ = static_cast<uint16_t>((cp & 0x3ff) + internal::TRAIL_SURROGATE_MIN);
241 *result++ = static_cast<uint16_t>(cp);
246 template <typename octet_iterator, typename u32bit_iterator>
247 octet_iterator utf32to8 (u32bit_iterator start, u32bit_iterator end, octet_iterator result)
250 result = utf8::append(*(start++), result);
255 template <typename octet_iterator, typename u32bit_iterator>
256 u32bit_iterator utf8to32 (octet_iterator start, octet_iterator end, u32bit_iterator result)
259 (*result++) = utf8::next(start, end);
264 // The iterator class
265 template <typename octet_iterator>
266 class iterator : public std::iterator <std::bidirectional_iterator_tag, uint32_t> {
268 octet_iterator range_start;
269 octet_iterator range_end;
272 explicit iterator (const octet_iterator& octet_it,
273 const octet_iterator& rangestart,
274 const octet_iterator& rangeend) :
275 it(octet_it), range_start(rangestart), range_end(rangeend)
277 if (it < range_start || it > range_end)
278 throw std::out_of_range("Invalid utf-8 iterator position");
280 // the default "big three" are OK
281 octet_iterator base () const { return it; }
282 uint32_t operator * () const
284 octet_iterator temp = it;
285 return utf8::next(temp, range_end);
287 bool operator == (const iterator& rhs) const
289 if (range_start != rhs.range_start || range_end != rhs.range_end)
290 throw std::logic_error("Comparing utf-8 iterators defined with different ranges");
291 return (it == rhs.it);
293 bool operator != (const iterator& rhs) const
295 return !(operator == (rhs));
297 iterator& operator ++ ()
299 utf8::next(it, range_end);
302 iterator operator ++ (int)
304 iterator temp = *this;
305 utf8::next(it, range_end);
308 iterator& operator -- ()
310 utf8::prior(it, range_start);
313 iterator operator -- (int)
315 iterator temp = *this;
316 utf8::prior(it, range_start);
323 #endif //header guard