1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/* $Id: unicode.h,v 1.12 2001/10/31 08:51:28 m-kasahr Exp $ */
/*
* Copyright (c) 2000,2001 Japan Network Information Center.
* All rights reserved.
*
* By using this file, you agree to the terms and conditions set forth bellow.
*
* LICENSE TERMS AND CONDITIONS
*
* The following License Terms and Conditions apply, unless a different
* license is obtained from Japan Network Information Center ("JPNIC"),
* a Japanese association, Kokusai-Kougyou-Kanda Bldg 6F, 2-3-4 Uchi-Kanda,
* Chiyoda-ku, Tokyo 101-0047, Japan.
*
* 1. Use, Modification and Redistribution (including distribution of any
* modified or derived work) in source and/or binary forms is permitted
* under this License Terms and Conditions.
*
* 2. Redistribution of source code must retain the copyright notices as they
* appear in each source code file, this License Terms and Conditions.
*
* 3. Redistribution in binary form must reproduce the Copyright Notice,
* this License Terms and Conditions, in the documentation and/or other
* materials provided with the distribution. For the purposes of binary
* distribution the "Copyright Notice" refers to the following language:
* "Copyright (c) Japan Network Information Center. All rights reserved."
*
* 4. Neither the name of JPNIC may be used to endorse or promote products
* derived from this Software without specific prior written approval of
* JPNIC.
*
* 5. Disclaimer/Limitation of Liability: THIS SOFTWARE IS PROVIDED BY JPNIC
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JPNIC BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
*
* 6. Indemnification by Licensee
* Any person or entities using and/or redistributing this Software under
* this License Terms and Conditions shall defend indemnify and hold
* harmless JPNIC from and against any and all judgements damages,
* expenses, settlement liabilities, cost and other liabilities of any
* kind as a result of use and redistribution of this Software or any
* claim, suite, action, litigation or proceeding by any third party
* arising out of or relates to this License Terms and Conditions.
*
* 7. Governing Law, Jurisdiction and Venue
* This License Terms and Conditions shall be governed by and and
* construed in accordance with the law of Japan. Any person or entities
* using and/or redistributing this Software under this License Terms and
* Conditions hereby agrees and consent to the personal and exclusive
* jurisdiction and venue of Tokyo District Court of Japan.
*/
#ifndef MDN_UNICODE_H
#define MDN_UNICODE_H 1
/*
* Unicode attributes retriever.
*
* All the information this module provides is based on UnicodeData.txt,
* CompositionExclusions-1.txt and SpecialCasing.txt, all of which can be
* obtained from unicode.org.
*
* Unicode characters are represented as 'unsigned long'.
*/
#include <mdn/result.h>
/*
* A Handle for Unicode versions.
*/
typedef struct mdn__unicode_ops *mdn__unicode_version_t;
/*
* Context information for case conversion.
*/
typedef enum {
mdn__unicode_context_unknown,
mdn__unicode_context_final,
mdn__unicode_context_nonfinal
} mdn__unicode_context_t;
/*
* Create a handle for a specific Unicode version.
* The version number (such as "3.0.1") is specified by 'version' parameter.
* If it is NULL, the latest version is used.
* The handle is stored in '*versionp', which is used various functions
* in this and unormalize modules.
*
* Returns:
* mdn_success -- ok.
* mdn_notfound -- specified version not found.
*/
extern mdn_result_t
mdn__unicode_create(const char *version, mdn__unicode_version_t *versionp);
/*
* Close a handle which was created by 'mdn__unicode_create'.
*/
extern void
mdn__unicode_destroy(mdn__unicode_version_t version);
/*
* Get canonical class.
*
* For characters out of unicode range (i.e. above 0xffff), 0 will
* be returned.
*/
extern int
mdn__unicode_canonicalclass(mdn__unicode_version_t version, unsigned long c);
/*
* Decompose a character.
*
* Decompose character given by 'c', and put the result into 'v',
* which can hold 'vlen' characters. The number of decomposed characters
* will be stored in '*decomp_lenp'.
*
* If 'compat' is true, compatibility decomposition is performed.
* Otherwise canonical decomposition is done.
*
* Since decomposition is done recursively, no further decomposition
* will be needed.
*
* Returns:
* mdn_success -- ok, decomposed.
* mdn_notfound -- no decomposition possible.
* mdn_buffer_overflow -- 'vlen' is too small.
*/
extern mdn_result_t
mdn__unicode_decompose(mdn__unicode_version_t version,
int compat, unsigned long *v, size_t vlen,
unsigned long c, int *decomp_lenp);
/*
* Perform canonical composition.
*
* Do canonical composition to the character sequence 'c1' and 'c2', put the
* result into '*compp'.
*
* Since Unicode Nomalization Froms requires only canonical composition,
* compatibility composition is not supported.
*
* Returns:
* mdn_success -- ok, composed.
* mdn_notfound -- no composition possible.
*/
extern mdn_result_t
mdn__unicode_compose(mdn__unicode_version_t version,
unsigned long c1, unsigned long c2, unsigned long *compp);
/*
* Returns if there may be a canonical composition sequence which starts
* with the given character.
*
* Returns:
* 1 -- there may be a composition sequence
* (maybe not).
* 0 -- no, there is definitely no such sequences.
*/
extern int
mdn__unicode_iscompositecandidate(mdn__unicode_version_t version,
unsigned long c);
/*
* Translate lowercase character to uppercase, and vice versa, according
* to Unicode Technical Report #21 "Case Mappings".
*
* Both functions perform conversion on the given unicode character 'c',
* put the result into 'v', whose size is specified by 'vlen'. The actual
* number of characters stored in 'v' are returned as '*convlenp'.
* In case 'c' has no mapping, 'v[0]' will contain 'c', and '*convlenp'
* will be 1.
*
* Note that these functions perform locale-independent case conversion.
*
* There are some characters whose case mapping depends on the context.
* 'ctx' specifies the context, which can be obtained by
* 'mdn__unicode_getcontext'. Most of the time you can just specify
* 'mdn__unicode_context_unknown' as 'ctx', and if those functions
* return 'mdn_context_required', you can get the context using
* 'mdn__unicode_getcontext' and try again.
*
* Returns:
* mdn_success -- successfully converted.
* mdn_context_required -- context information is needed to
* perform case conversion on 'c'.
* mdn_buffer_overflow -- 'vlen' is too small.
*/
extern mdn_result_t
mdn__unicode_toupper(mdn__unicode_version_t version,
unsigned long c, mdn__unicode_context_t ctx,
unsigned long *v, size_t vlen, int *convlenp);
extern mdn_result_t
mdn__unicode_tolower(mdn__unicode_version_t version,
unsigned long c, mdn__unicode_context_t ctx,
unsigned long *v, size_t vlen, int *convlenp);
/*
* Determine the context needed by the case conversion functions.
*
* Case conversion functions above needs context information for some
* characters. To get the context, you should call this function with
* the next character as the parameter. If you get final or nonfinal,
* you're done. If you get unknown, move on to the next character until
* you get final or nonfinal.
*
* Returns:
* mdn__unicode_context_final -- context is 'FINAL'.
* mdn__unicode_context_nonfinal -- context is 'NON_FINAL'.
* mdn__unicode_context_unknown -- context cannot be determined,
* try the next character.
*/
extern mdn__unicode_context_t
mdn__unicode_getcontext(mdn__unicode_version_t version, unsigned long c);
/*
* Perform case-folding for caseless matching, defined by Unicode
* Technical Report #21 "Case Mappings".
*
* Performs case-folding on the given unicode character 'c' and put
* the result into 'v', whose size is specified by 'vlen'. The actual
* number of characters stored in 'v' are returned as '*foldlenp'. In
* case 'c' has no mapping, 'v[0]' will contain 'c', and '*foldlenp'
* will be 1.
*
* Returns:
* mdn_success -- successfully converted.
* mdn_buffer_overflow -- 'vlen' is too small.
*/
extern mdn_result_t
mdn__unicode_casefold(mdn__unicode_version_t version,
unsigned long c, unsigned long *v, size_t vlen,
int *foldlenp);
#endif /* MDN_UNICODE_H */
|
