2 * This file is part of DisOrde
3 * Copyright (C) 2007, 2008, 2013 Richard Kettlewell
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 /** @file lib/unicode.h
19 * @brief Unicode support functions
25 /** @brief Smart pointer into a string
27 * Iterators can be efficiently moved either forwards or back to the start of
28 * the string. They cannot (currently) efficiently be moved backwards. Their
29 * advantage is that they remember internal state to speed up boundary
32 * Iterators can point to any code point of the string, or to a hypothetical
33 * post-final code point of value 0, but not outside the string.
35 typedef struct utf32_iterator_data
*utf32_iterator
;
37 /** @brief Property tailor function
39 * @return Tailored property or -1 to use standard value
41 * See also utf32_iterator_tailor_word_break().
43 typedef int unicode_property_tailor(uint32_t c
);
45 char *utf32_to_utf8(const uint32_t *s
, size_t ns
, size_t *nd
);
46 uint32_t *utf8_to_utf32(const char *s
, size_t ns
, size_t *nd
);
47 char *utf16_to_utf8(const uint16_t *s
, size_t ns
, size_t *nd
);
48 uint16_t *utf8_to_utf16(const char *s
, size_t ns
, size_t *nd
);
49 int utf8_valid(const char *s
, size_t ns
);
51 int utf32_combining_class(uint32_t c
);
53 size_t utf32_len(const uint32_t *s
);
54 size_t utf16_len(const uint16_t *s
);
55 int utf32_cmp(const uint32_t *a
, const uint32_t *b
);
57 uint32_t *utf32_decompose_canon(const uint32_t *s
, size_t ns
, size_t *ndp
);
58 char *utf8_decompose_canon(const char *s
, size_t ns
, size_t *ndp
);
60 uint32_t *utf32_decompose_compat(const uint32_t *s
, size_t ns
, size_t *ndp
);
61 char *utf8_decompose_compat(const char *s
, size_t ns
, size_t *ndp
);
63 uint32_t *utf32_compose_canon(const uint32_t *s
, size_t ns
, size_t *ndp
);
64 char *utf8_compose_canon(const char *s
, size_t ns
, size_t *ndp
);
66 uint32_t *utf32_compose_compat(const uint32_t *s
, size_t ns
, size_t *ndp
);
67 char *utf8_compose_compat(const char *s
, size_t ns
, size_t *ndp
);
69 uint32_t *utf32_casefold_canon(const uint32_t *s
, size_t ns
, size_t *ndp
);
70 char *utf8_casefold_canon(const char *s
, size_t ns
, size_t *ndp
);
72 uint32_t *utf32_casefold_compat(const uint32_t *s
, size_t ns
, size_t *ndp
);
73 char *utf8_casefold_compat(const char *s
, size_t ns
, size_t *ndp
);
75 int utf32_is_grapheme_boundary(const uint32_t *s
, size_t ns
, size_t n
);
76 int utf32_is_word_boundary(const uint32_t *s
, size_t ns
, size_t n
);
78 utf32_iterator
utf32_iterator_new(const uint32_t *s
, size_t ns
);
79 void utf32_iterator_destroy(utf32_iterator it
);
81 size_t utf32_iterator_where(utf32_iterator it
);
82 int utf32_iterator_set(utf32_iterator it
, size_t n
);
83 int utf32_iterator_advance(utf32_iterator it
, size_t n
);
84 uint32_t utf32_iterator_code(utf32_iterator it
);
85 int utf32_iterator_grapheme_boundary(utf32_iterator it
);
86 int utf32_iterator_word_boundary(utf32_iterator it
);
87 void utf32_iterator_tailor_word_break(utf32_iterator it
,
88 unicode_property_tailor
*pt
);
90 uint32_t **utf32_word_split(const uint32_t *s
, size_t ns
, size_t *nwp
,
91 unicode_property_tailor
*wbreak
);
92 char **utf8_word_split(const char *s
, size_t ns
, size_t *nwp
,
93 unicode_property_tailor
*wbreak
);
95 /** @brief Convert 0-terminated UTF-32 to UTF-8
96 * @param s 0-terminated UTF-32 string
97 * @return 0-terminated UTF-8 string or 0 on error
99 * See utf32_to_utf8() for possible causes of errors.
101 static inline char *utf32nt_to_utf8(const uint32_t *s
) {
102 return utf32_to_utf8(s
, utf32_len(s
), 0);
105 /** @brief Convert 0-terminated UTF-16 to UTF-8
106 * @param s 0-terminated UTF-16 string
107 * @return 0-terminated UTF-8 string or 0 on error
109 * See utf16_to_utf8() for possible causes of errors.
111 static inline char *utf16nt_to_utf8(const uint16_t *s
) {
112 return utf16_to_utf8(s
, utf16_len(s
), 0);
115 /** @brief Convert 0-terminated UTF-8 to UTF-32
116 * @param s 0-terminated UTF-8 string
117 * @return 0-terminated UTF-32 string or 0 on error
119 * See utf8_to_utf32() for possible causes of errors.
121 static inline uint32_t *utf8nt_to_utf32(const char *s
) {
122 return utf8_to_utf32(s
, strlen(s
), 0);
125 /** @brief Convert 0-terminated UTF-8 to UTF-16
126 * @param s 0-terminated UTF-8 string
127 * @return 0-terminated UTF-16 string or 0 on error
129 * See utf8_to_utf16() for possible causes of errors.
131 static inline uint16_t *utf8nt_to_utf16(const char *s
) {
132 return utf8_to_utf16(s
, strlen(s
), 0);
136 static inline wchar_t *utf8nt_to_wchar(const char *s
) {
137 return (wchar_t *)utf8nt_to_utf16(s
);
140 static inline char *wcharnt_to_utf8(const wchar_t *s
) {
141 return utf16nt_to_utf8((const uint16_t *)s
);
144 static inline wchar_t *utf8nt_to_wchar(const char *s
) {
145 return (wchar_t *)utf8nt_to_utf32(s
);
148 static inline char *wcharnt_to_utf8(const wchar_t *s
) {
149 return utf32nt_to_utf8((const uint32_t *)s
);
153 #endif /* UNICODE_H */