1 // Copyright 2006-2016 Nemanja Trifunovic 2 3 /* 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: 10 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. 17 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. 25 */ 26 27 28 #ifndef UTF8_FOR_CPP_CHECKED_H_2675DCD0_9480_4c0c_B92A_CC14C027B731 29 #define UTF8_FOR_CPP_CHECKED_H_2675DCD0_9480_4c0c_B92A_CC14C027B731 30 31 #include "core.h" 32 #include <stdexcept> 33 34 namespace utf8 35 { 36 // Base for the exceptions that may be thrown from the library 37 class exception : public ::std::exception { 38 }; 39 40 // Exceptions that may be thrown from the library functions. 41 class invalid_code_point : public exception { 42 uint32_t cp; 43 public: invalid_code_point(uint32_t codepoint)44 invalid_code_point(uint32_t codepoint) : cp(codepoint) {} what()45 virtual const char* what() const throw() { return "Invalid code point"; } code_point()46 uint32_t code_point() const {return cp;} 47 }; 48 49 class invalid_utf8 : public exception { 50 uint8_t u8; 51 public: invalid_utf8(uint8_t u)52 invalid_utf8 (uint8_t u) : u8(u) {} what()53 virtual const char* what() const throw() { return "Invalid UTF-8"; } utf8_octet()54 uint8_t utf8_octet() const {return u8;} 55 }; 56 57 class invalid_utf16 : public exception { 58 uint16_t u16; 59 public: invalid_utf16(uint16_t u)60 invalid_utf16 (uint16_t u) : u16(u) {} what()61 virtual const char* what() const throw() { return "Invalid UTF-16"; } utf16_word()62 uint16_t utf16_word() const {return u16;} 63 }; 64 65 class not_enough_room : public exception { 66 public: what()67 virtual const char* what() const throw() { return "Not enough space"; } 68 }; 69 70 /// The library API - functions intended to be called by the users 71 72 template <typename octet_iterator> append(uint32_t cp,octet_iterator result)73 octet_iterator append(uint32_t cp, octet_iterator result) 74 { 75 if (!utf8::internal::is_code_point_valid(cp)) 76 throw invalid_code_point(cp); 77 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); 83 } 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); 88 } 89 else { // four octets 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); 94 } 95 return result; 96 } 97 98 template <typename octet_iterator, typename output_iterator> replace_invalid(octet_iterator start,octet_iterator end,output_iterator out,uint32_t replacement)99 output_iterator replace_invalid(octet_iterator start, octet_iterator end, output_iterator out, uint32_t replacement) 100 { 101 while (start != end) { 102 octet_iterator sequence_start = start; 103 internal::utf_error err_code = utf8::internal::validate_next(start, end); 104 switch (err_code) { 105 case internal::UTF8_OK : 106 for (octet_iterator it = sequence_start; it != start; ++it) 107 *out++ = *it; 108 break; 109 case internal::NOT_ENOUGH_ROOM: 110 out = utf8::append (replacement, out); 111 start = end; 112 break; 113 case internal::INVALID_LEAD: 114 out = utf8::append (replacement, out); 115 ++start; 116 break; 117 case internal::INCOMPLETE_SEQUENCE: 118 case internal::OVERLONG_SEQUENCE: 119 case internal::INVALID_CODE_POINT: 120 out = utf8::append (replacement, out); 121 ++start; 122 // just one replacement mark for the sequence 123 while (start != end && utf8::internal::is_trail(*start)) 124 ++start; 125 break; 126 } 127 } 128 return out; 129 } 130 131 template <typename octet_iterator, typename output_iterator> replace_invalid(octet_iterator start,octet_iterator end,output_iterator out)132 inline output_iterator replace_invalid(octet_iterator start, octet_iterator end, output_iterator out) 133 { 134 static const uint32_t replacement_marker = utf8::internal::mask16(0xfffd); 135 return utf8::replace_invalid(start, end, out, replacement_marker); 136 } 137 138 template <typename octet_iterator> next(octet_iterator & it,octet_iterator end)139 uint32_t next(octet_iterator& it, octet_iterator end) 140 { 141 uint32_t cp = 0; 142 internal::utf_error err_code = utf8::internal::validate_next(it, end, cp); 143 switch (err_code) { 144 case internal::UTF8_OK : 145 break; 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); 154 } 155 return cp; 156 } 157 158 template <typename octet_iterator> peek_next(octet_iterator it,octet_iterator end)159 uint32_t peek_next(octet_iterator it, octet_iterator end) 160 { 161 return utf8::next(it, end); 162 } 163 164 template <typename octet_iterator> prior(octet_iterator & it,octet_iterator start)165 uint32_t prior(octet_iterator& it, octet_iterator start) 166 { 167 // can't do much if it == start 168 if (it == start) 169 throw not_enough_room(); 170 171 octet_iterator end = it; 172 // Go back until we hit either a lead octet or start 173 while (utf8::internal::is_trail(*(--it))) 174 if (it == start) 175 throw invalid_utf8(*it); // error - no lead byte in the sequence 176 return utf8::peek_next(it, end); 177 } 178 179 /// Deprecated in versions that include "prior" 180 template <typename octet_iterator> previous(octet_iterator & it,octet_iterator pass_start)181 uint32_t previous(octet_iterator& it, octet_iterator pass_start) 182 { 183 octet_iterator end = it; 184 while (utf8::internal::is_trail(*(--it))) 185 if (it == pass_start) 186 throw invalid_utf8(*it); // error - no lead byte in the sequence 187 octet_iterator temp = it; 188 return utf8::next(temp, end); 189 } 190 191 template <typename octet_iterator, typename distance_type> advance(octet_iterator & it,distance_type n,octet_iterator end)192 void advance (octet_iterator& it, distance_type n, octet_iterator end) 193 { 194 for (distance_type i = 0; i < n; ++i) 195 utf8::next(it, end); 196 } 197 198 template <typename octet_iterator, typename distance_type> retreat(octet_iterator & it,distance_type n,octet_iterator end)199 void retreat (octet_iterator& it, distance_type n, octet_iterator end) 200 { 201 for (distance_type i = 0; i < n; ++i) 202 utf8::prior(it, end); 203 } 204 205 template <typename octet_iterator> 206 typename std::iterator_traits<octet_iterator>::difference_type distance(octet_iterator first,octet_iterator last)207 distance (octet_iterator first, octet_iterator last) 208 { 209 typename std::iterator_traits<octet_iterator>::difference_type dist; 210 for (dist = 0; first < last; ++dist) 211 utf8::next(first, last); 212 return dist; 213 } 214 215 template <typename u16bit_iterator, typename octet_iterator> utf16to8(u16bit_iterator start,u16bit_iterator end,octet_iterator result)216 octet_iterator utf16to8 (u16bit_iterator start, u16bit_iterator end, octet_iterator result) 217 { 218 while (start != end) { 219 uint32_t cp = utf8::internal::mask16(*start++); 220 // Take care of surrogate pairs first 221 if (utf8::internal::is_lead_surrogate(cp)) { 222 if (start != end) { 223 uint32_t trail_surrogate = utf8::internal::mask16(*start++); 224 if (utf8::internal::is_trail_surrogate(trail_surrogate)) 225 cp = (cp << 10) + trail_surrogate + internal::SURROGATE_OFFSET; 226 else 227 throw invalid_utf16(static_cast<uint16_t>(trail_surrogate)); 228 } 229 else 230 throw invalid_utf16(static_cast<uint16_t>(cp)); 231 232 } 233 // Lone trail surrogate 234 else if (utf8::internal::is_trail_surrogate(cp)) 235 throw invalid_utf16(static_cast<uint16_t>(cp)); 236 237 result = utf8::append(cp, result); 238 } 239 return result; 240 } 241 242 template <typename u16bit_iterator, typename octet_iterator> utf8to16(octet_iterator start,octet_iterator end,u16bit_iterator result)243 u16bit_iterator utf8to16 (octet_iterator start, octet_iterator end, u16bit_iterator result) 244 { 245 while (start < end) { 246 uint32_t cp = utf8::next(start, end); 247 if (cp > 0xffff) { //make a surrogate pair 248 *result++ = static_cast<uint16_t>((cp >> 10) + internal::LEAD_OFFSET); 249 *result++ = static_cast<uint16_t>((cp & 0x3ff) + internal::TRAIL_SURROGATE_MIN); 250 } 251 else 252 *result++ = static_cast<uint16_t>(cp); 253 } 254 return result; 255 } 256 257 template <typename octet_iterator, typename u32bit_iterator> utf32to8(u32bit_iterator start,u32bit_iterator end,octet_iterator result)258 octet_iterator utf32to8 (u32bit_iterator start, u32bit_iterator end, octet_iterator result) 259 { 260 while (start != end) 261 result = utf8::append(*(start++), result); 262 263 return result; 264 } 265 266 template <typename octet_iterator, typename u32bit_iterator> utf8to32(octet_iterator start,octet_iterator end,u32bit_iterator result)267 u32bit_iterator utf8to32 (octet_iterator start, octet_iterator end, u32bit_iterator result) 268 { 269 while (start < end) 270 (*result++) = utf8::next(start, end); 271 272 return result; 273 } 274 275 // The iterator class 276 template <typename octet_iterator> 277 class iterator : public std::iterator <std::bidirectional_iterator_tag, uint32_t> { 278 octet_iterator it; 279 octet_iterator range_start; 280 octet_iterator range_end; 281 public: iterator()282 iterator () {} iterator(const octet_iterator & octet_it,const octet_iterator & rangestart,const octet_iterator & rangeend)283 explicit iterator (const octet_iterator& octet_it, 284 const octet_iterator& rangestart, 285 const octet_iterator& rangeend) : 286 it(octet_it), range_start(rangestart), range_end(rangeend) 287 { 288 if (it < range_start || it > range_end) 289 throw std::out_of_range("Invalid utf-8 iterator position"); 290 } 291 // the default "big three" are OK base()292 octet_iterator base () const { return it; } 293 uint32_t operator * () const 294 { 295 octet_iterator temp = it; 296 return utf8::next(temp, range_end); 297 } 298 bool operator == (const iterator& rhs) const 299 { 300 if (range_start != rhs.range_start || range_end != rhs.range_end) 301 throw std::logic_error("Comparing utf-8 iterators defined with different ranges"); 302 return (it == rhs.it); 303 } 304 bool operator != (const iterator& rhs) const 305 { 306 return !(operator == (rhs)); 307 } 308 iterator& operator ++ () 309 { 310 utf8::next(it, range_end); 311 return *this; 312 } 313 iterator operator ++ (int) 314 { 315 iterator temp = *this; 316 utf8::next(it, range_end); 317 return temp; 318 } 319 iterator& operator -- () 320 { 321 utf8::prior(it, range_start); 322 return *this; 323 } 324 iterator operator -- (int) 325 { 326 iterator temp = *this; 327 utf8::prior(it, range_start); 328 return temp; 329 } 330 }; // class iterator 331 332 } // namespace utf8 333 334 #endif //header guard 335 336 337