1251881Speter/* 2251881Speter * This is an implementation of wcwidth() and wcswidth() (defined in 3251881Speter * IEEE Std 1002.1-2001) for Unicode. 4251881Speter * 5251881Speter * http://www.opengroup.org/onlinepubs/007904975/functions/wcwidth.html 6251881Speter * http://www.opengroup.org/onlinepubs/007904975/functions/wcswidth.html 7251881Speter * 8251881Speter * In fixed-width output devices, Latin characters all occupy a single 9251881Speter * "cell" position of equal width, whereas ideographic CJK characters 10251881Speter * occupy two such cells. Interoperability between terminal-line 11251881Speter * applications and (teletype-style) character terminals using the 12251881Speter * UTF-8 encoding requires agreement on which character should advance 13251881Speter * the cursor by how many cell positions. No established formal 14251881Speter * standards exist at present on which Unicode character shall occupy 15251881Speter * how many cell positions on character terminals. These routines are 16251881Speter * a first attempt of defining such behavior based on simple rules 17251881Speter * applied to data provided by the Unicode Consortium. 18251881Speter * 19251881Speter * For some graphical characters, the Unicode standard explicitly 20251881Speter * defines a character-cell width via the definition of the East Asian 21251881Speter * FullWidth (F), Wide (W), Half-width (H), and Narrow (Na) classes. 22251881Speter * In all these cases, there is no ambiguity about which width a 23251881Speter * terminal shall use. For characters in the East Asian Ambiguous (A) 24251881Speter * class, the width choice depends purely on a preference of backward 25251881Speter * compatibility with either historic CJK or Western practice. 26251881Speter * Choosing single-width for these characters is easy to justify as 27251881Speter * the appropriate long-term solution, as the CJK practice of 28251881Speter * displaying these characters as double-width comes from historic 29251881Speter * implementation simplicity (8-bit encoded characters were displayed 30251881Speter * single-width and 16-bit ones double-width, even for Greek, 31251881Speter * Cyrillic, etc.) and not any typographic considerations. 32251881Speter * 33251881Speter * Much less clear is the choice of width for the Not East Asian 34251881Speter * (Neutral) class. Existing practice does not dictate a width for any 35251881Speter * of these characters. It would nevertheless make sense 36251881Speter * typographically to allocate two character cells to characters such 37251881Speter * as for instance EM SPACE or VOLUME INTEGRAL, which cannot be 38251881Speter * represented adequately with a single-width glyph. The following 39251881Speter * routines at present merely assign a single-cell width to all 40251881Speter * neutral characters, in the interest of simplicity. This is not 41251881Speter * entirely satisfactory and should be reconsidered before 42251881Speter * establishing a formal standard in this area. At the moment, the 43251881Speter * decision which Not East Asian (Neutral) characters should be 44251881Speter * represented by double-width glyphs cannot yet be answered by 45251881Speter * applying a simple rule from the Unicode database content. Setting 46251881Speter * up a proper standard for the behavior of UTF-8 character terminals 47251881Speter * will require a careful analysis not only of each Unicode character, 48251881Speter * but also of each presentation form, something the author of these 49251881Speter * routines has avoided to do so far. 50251881Speter * 51251881Speter * http://www.unicode.org/unicode/reports/tr11/ 52251881Speter * 53251881Speter * Markus Kuhn -- 2007-05-26 (Unicode 5.0) 54251881Speter * 55251881Speter * Permission to use, copy, modify, and distribute this software 56251881Speter * for any purpose and without fee is hereby granted. The author 57251881Speter * disclaims all warranties with regard to this software. 58251881Speter * 59251881Speter * Latest version: http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c 60251881Speter */ 61251881Speter 62251881Speter#include <apr_lib.h> 63251881Speter 64251881Speter#include "svn_utf.h" 65251881Speter#include "private/svn_utf_private.h" 66251881Speter 67251881Speter#include "svn_private_config.h" 68251881Speter 69251881Speterstruct interval { 70251881Speter apr_uint32_t first; 71251881Speter apr_uint32_t last; 72251881Speter}; 73251881Speter 74251881Speter/* auxiliary function for binary search in interval table */ 75251881Speterstatic int 76251881Speterbisearch(apr_uint32_t ucs, const struct interval *table, apr_uint32_t max) 77251881Speter{ 78251881Speter apr_uint32_t min = 0; 79251881Speter apr_uint32_t mid; 80251881Speter 81251881Speter if (ucs < table[0].first || ucs > table[max].last) 82251881Speter return 0; 83251881Speter while (max >= min) { 84251881Speter mid = (min + max) / 2; 85251881Speter if (ucs > table[mid].last) 86251881Speter min = mid + 1; 87251881Speter else if (ucs < table[mid].first) 88251881Speter max = mid - 1; /* this is safe because ucs >= table[0].first */ 89251881Speter else 90251881Speter return 1; 91251881Speter } 92251881Speter 93251881Speter return 0; 94251881Speter} 95251881Speter 96251881Speter 97251881Speter/* The following two functions define the column width of an ISO 10646 98251881Speter * character as follows: 99251881Speter * 100251881Speter * - The null character (U+0000) has a column width of 0. 101251881Speter * 102251881Speter * - Other C0/C1 control characters and DEL will lead to a return 103251881Speter * value of -1. 104251881Speter * 105251881Speter * - Non-spacing and enclosing combining characters (general 106251881Speter * category code Mn or Me in the Unicode database) have a 107251881Speter * column width of 0. 108251881Speter * 109251881Speter * - SOFT HYPHEN (U+00AD) has a column width of 1. 110251881Speter * 111251881Speter * - Other format characters (general category code Cf in the Unicode 112251881Speter * database) and ZERO WIDTH SPACE (U+200B) have a column width of 0. 113251881Speter * 114251881Speter * - Hangul Jamo medial vowels and final consonants (U+1160-U+11FF) 115251881Speter * have a column width of 0. 116251881Speter * 117251881Speter * - Spacing characters in the East Asian Wide (W) or East Asian 118251881Speter * Full-width (F) category as defined in Unicode Technical 119251881Speter * Report #11 have a column width of 2. 120251881Speter * 121251881Speter * - All remaining characters (including all printable 122251881Speter * ISO 8859-1 and WGL4 characters, Unicode control characters, 123251881Speter * etc.) have a column width of 1. 124251881Speter * 125251881Speter * This implementation assumes that wchar_t characters are encoded 126251881Speter * in ISO 10646. 127251881Speter */ 128251881Speter 129251881Speterstatic int 130251881Spetermk_wcwidth(apr_uint32_t ucs) 131251881Speter{ 132251881Speter /* sorted list of non-overlapping intervals of non-spacing characters */ 133251881Speter /* generated by "uniset +cat=Me +cat=Mn +cat=Cf -00AD +1160-11FF +200B c" */ 134251881Speter static const struct interval combining[] = { 135251881Speter { 0x0300, 0x036F }, { 0x0483, 0x0486 }, { 0x0488, 0x0489 }, 136251881Speter { 0x0591, 0x05BD }, { 0x05BF, 0x05BF }, { 0x05C1, 0x05C2 }, 137251881Speter { 0x05C4, 0x05C5 }, { 0x05C7, 0x05C7 }, { 0x0600, 0x0603 }, 138251881Speter { 0x0610, 0x0615 }, { 0x064B, 0x065E }, { 0x0670, 0x0670 }, 139251881Speter { 0x06D6, 0x06E4 }, { 0x06E7, 0x06E8 }, { 0x06EA, 0x06ED }, 140251881Speter { 0x070F, 0x070F }, { 0x0711, 0x0711 }, { 0x0730, 0x074A }, 141251881Speter { 0x07A6, 0x07B0 }, { 0x07EB, 0x07F3 }, { 0x0901, 0x0902 }, 142251881Speter { 0x093C, 0x093C }, { 0x0941, 0x0948 }, { 0x094D, 0x094D }, 143251881Speter { 0x0951, 0x0954 }, { 0x0962, 0x0963 }, { 0x0981, 0x0981 }, 144251881Speter { 0x09BC, 0x09BC }, { 0x09C1, 0x09C4 }, { 0x09CD, 0x09CD }, 145251881Speter { 0x09E2, 0x09E3 }, { 0x0A01, 0x0A02 }, { 0x0A3C, 0x0A3C }, 146251881Speter { 0x0A41, 0x0A42 }, { 0x0A47, 0x0A48 }, { 0x0A4B, 0x0A4D }, 147251881Speter { 0x0A70, 0x0A71 }, { 0x0A81, 0x0A82 }, { 0x0ABC, 0x0ABC }, 148251881Speter { 0x0AC1, 0x0AC5 }, { 0x0AC7, 0x0AC8 }, { 0x0ACD, 0x0ACD }, 149251881Speter { 0x0AE2, 0x0AE3 }, { 0x0B01, 0x0B01 }, { 0x0B3C, 0x0B3C }, 150251881Speter { 0x0B3F, 0x0B3F }, { 0x0B41, 0x0B43 }, { 0x0B4D, 0x0B4D }, 151251881Speter { 0x0B56, 0x0B56 }, { 0x0B82, 0x0B82 }, { 0x0BC0, 0x0BC0 }, 152251881Speter { 0x0BCD, 0x0BCD }, { 0x0C3E, 0x0C40 }, { 0x0C46, 0x0C48 }, 153251881Speter { 0x0C4A, 0x0C4D }, { 0x0C55, 0x0C56 }, { 0x0CBC, 0x0CBC }, 154251881Speter { 0x0CBF, 0x0CBF }, { 0x0CC6, 0x0CC6 }, { 0x0CCC, 0x0CCD }, 155251881Speter { 0x0CE2, 0x0CE3 }, { 0x0D41, 0x0D43 }, { 0x0D4D, 0x0D4D }, 156251881Speter { 0x0DCA, 0x0DCA }, { 0x0DD2, 0x0DD4 }, { 0x0DD6, 0x0DD6 }, 157251881Speter { 0x0E31, 0x0E31 }, { 0x0E34, 0x0E3A }, { 0x0E47, 0x0E4E }, 158251881Speter { 0x0EB1, 0x0EB1 }, { 0x0EB4, 0x0EB9 }, { 0x0EBB, 0x0EBC }, 159251881Speter { 0x0EC8, 0x0ECD }, { 0x0F18, 0x0F19 }, { 0x0F35, 0x0F35 }, 160251881Speter { 0x0F37, 0x0F37 }, { 0x0F39, 0x0F39 }, { 0x0F71, 0x0F7E }, 161251881Speter { 0x0F80, 0x0F84 }, { 0x0F86, 0x0F87 }, { 0x0F90, 0x0F97 }, 162251881Speter { 0x0F99, 0x0FBC }, { 0x0FC6, 0x0FC6 }, { 0x102D, 0x1030 }, 163251881Speter { 0x1032, 0x1032 }, { 0x1036, 0x1037 }, { 0x1039, 0x1039 }, 164251881Speter { 0x1058, 0x1059 }, { 0x1160, 0x11FF }, { 0x135F, 0x135F }, 165251881Speter { 0x1712, 0x1714 }, { 0x1732, 0x1734 }, { 0x1752, 0x1753 }, 166251881Speter { 0x1772, 0x1773 }, { 0x17B4, 0x17B5 }, { 0x17B7, 0x17BD }, 167251881Speter { 0x17C6, 0x17C6 }, { 0x17C9, 0x17D3 }, { 0x17DD, 0x17DD }, 168251881Speter { 0x180B, 0x180D }, { 0x18A9, 0x18A9 }, { 0x1920, 0x1922 }, 169251881Speter { 0x1927, 0x1928 }, { 0x1932, 0x1932 }, { 0x1939, 0x193B }, 170251881Speter { 0x1A17, 0x1A18 }, { 0x1B00, 0x1B03 }, { 0x1B34, 0x1B34 }, 171251881Speter { 0x1B36, 0x1B3A }, { 0x1B3C, 0x1B3C }, { 0x1B42, 0x1B42 }, 172251881Speter { 0x1B6B, 0x1B73 }, { 0x1DC0, 0x1DCA }, { 0x1DFE, 0x1DFF }, 173251881Speter { 0x200B, 0x200F }, { 0x202A, 0x202E }, { 0x2060, 0x2063 }, 174251881Speter { 0x206A, 0x206F }, { 0x20D0, 0x20EF }, { 0x302A, 0x302F }, 175251881Speter { 0x3099, 0x309A }, { 0xA806, 0xA806 }, { 0xA80B, 0xA80B }, 176251881Speter { 0xA825, 0xA826 }, { 0xFB1E, 0xFB1E }, { 0xFE00, 0xFE0F }, 177251881Speter { 0xFE20, 0xFE23 }, { 0xFEFF, 0xFEFF }, { 0xFFF9, 0xFFFB }, 178251881Speter { 0x10A01, 0x10A03 }, { 0x10A05, 0x10A06 }, { 0x10A0C, 0x10A0F }, 179251881Speter { 0x10A38, 0x10A3A }, { 0x10A3F, 0x10A3F }, { 0x1D167, 0x1D169 }, 180251881Speter { 0x1D173, 0x1D182 }, { 0x1D185, 0x1D18B }, { 0x1D1AA, 0x1D1AD }, 181251881Speter { 0x1D242, 0x1D244 }, { 0xE0001, 0xE0001 }, { 0xE0020, 0xE007F }, 182251881Speter { 0xE0100, 0xE01EF } 183251881Speter }; 184251881Speter 185251881Speter /* test for 8-bit control characters */ 186251881Speter if (ucs == 0) 187251881Speter return 0; 188251881Speter if (ucs < 32 || (ucs >= 0x7f && ucs < 0xa0)) 189251881Speter return -1; 190251881Speter 191251881Speter /* binary search in table of non-spacing characters */ 192251881Speter if (bisearch(ucs, combining, 193289180Speter sizeof(combining) / sizeof(struct interval) - 1)) 194251881Speter return 0; 195251881Speter 196251881Speter /* if we arrive here, ucs is not a combining or C0/C1 control character */ 197251881Speter 198251881Speter return 1 + 199251881Speter (ucs >= 0x1100 && 200251881Speter (ucs <= 0x115f || /* Hangul Jamo init. consonants */ 201251881Speter ucs == 0x2329 || ucs == 0x232a || 202251881Speter (ucs >= 0x2e80 && ucs <= 0xa4cf && 203251881Speter ucs != 0x303f) || /* CJK ... Yi */ 204251881Speter (ucs >= 0xac00 && ucs <= 0xd7a3) || /* Hangul Syllables */ 205251881Speter (ucs >= 0xf900 && ucs <= 0xfaff) || /* CJK Compatibility Ideographs */ 206251881Speter (ucs >= 0xfe10 && ucs <= 0xfe19) || /* Vertical forms */ 207251881Speter (ucs >= 0xfe30 && ucs <= 0xfe6f) || /* CJK Compatibility Forms */ 208251881Speter (ucs >= 0xff00 && ucs <= 0xff60) || /* Fullwidth Forms */ 209251881Speter (ucs >= 0xffe0 && ucs <= 0xffe6) || 210251881Speter (ucs >= 0x20000 && ucs <= 0x2fffd) || 211251881Speter (ucs >= 0x30000 && ucs <= 0x3fffd))); 212251881Speter} 213251881Speter 214251881Speterint 215251881Spetersvn_utf_cstring_utf8_width(const char *cstr) 216251881Speter{ 217251881Speter int width = 0; 218251881Speter 219251881Speter if (*cstr == '\0') 220251881Speter return 0; 221251881Speter 222251881Speter /* Ensure the conversion below doesn't fail because of encoding errors. */ 223251881Speter if (!svn_utf__cstring_is_valid(cstr)) 224251881Speter return -1; 225251881Speter 226251881Speter /* Convert the UTF-8 string to UTF-32 (UCS4) which is the format 227251881Speter * mk_wcwidth() expects, and get the width of each character. 228251881Speter * We don't need much error checking since the input is valid UTF-8. */ 229251881Speter while (*cstr) 230251881Speter { 231251881Speter apr_uint32_t ucs; 232251881Speter int nbytes; 233251881Speter int lead_mask; 234251881Speter int w; 235251881Speter int i; 236251881Speter 237251881Speter if ((*cstr & 0x80) == 0) 238251881Speter { 239251881Speter nbytes = 1; 240251881Speter lead_mask = 0x7f; 241251881Speter } 242251881Speter else if ((*cstr & 0xe0) == 0xc0) 243251881Speter { 244251881Speter nbytes = 2; 245251881Speter lead_mask = 0x1f; 246251881Speter } 247251881Speter else if ((*cstr & 0xf0) == 0xe0) 248251881Speter { 249251881Speter nbytes = 3; 250251881Speter lead_mask = 0x0f; 251251881Speter } 252251881Speter else if ((*cstr & 0xf8) == 0xf0) 253251881Speter { 254251881Speter nbytes = 4; 255251881Speter lead_mask = 0x07; 256251881Speter } 257251881Speter else 258251881Speter { 259251881Speter /* RFC 3629 restricts UTF-8 to max 4 bytes per character. */ 260251881Speter return -1; 261251881Speter } 262251881Speter 263251881Speter /* Parse character data from leading byte. */ 264251881Speter ucs = (apr_uint32_t)(*cstr & lead_mask); 265251881Speter 266251881Speter /* Parse character data from continuation bytes. */ 267251881Speter for (i = 1; i < nbytes; i++) 268251881Speter { 269251881Speter ucs <<= 6; 270251881Speter ucs |= (cstr[i] & 0x3f); 271251881Speter } 272251881Speter 273251881Speter cstr += nbytes; 274251881Speter 275251881Speter /* Determine the width of this character and add it to the total. */ 276251881Speter w = mk_wcwidth(ucs); 277251881Speter if (w == -1) 278251881Speter return -1; 279251881Speter width += w; 280251881Speter } 281251881Speter 282251881Speter return width; 283251881Speter} 284