1/*
2 *  Copyright (c) 2006-2007 Jan Behrens, FlexiGuided GmbH, Berlin
3 *
4 *  Permission is hereby granted, free of charge, to any person obtaining a
5 *  copy of this software and associated documentation files (the "Software"),
6 *  to deal in the Software without restriction, including without limitation
7 *  the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 *  and/or sell copies of the Software, and to permit persons to whom the
9 *  Software is furnished to do so, subject to the following conditions:
10 *
11 *  The above copyright notice and this permission notice shall be included in
12 *  all copies or substantial portions of the Software.
13 *
14 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19 *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20 *  DEALINGS IN THE SOFTWARE.
21 */
22
23
24/*
25 *  File name:    utf8proc.h
26 *  Version:      1.1.1
27 *  Last changed: 2007-07-22
28 *  Changed 2008-05-16 by rkr to add config.h and replacement for stdbool.h
29 *                            for pre-C99 compilers that don't support bool.
30 *  Changed 2008-06-05 by rkr to add utf8proc_check(str, options) function for
31 *                            for just checking UTF-8 validity
32 *  Description:
33 *  Header files for libutf8proc, which is a mapping tool for UTF-8 strings
34 *  with following features:
35 *  - decomposing and composing of strings
36 *  - replacing compatibility characters with their equivalents
37 *  - stripping of "default ignorable characters"
38 *    like SOFT-HYPHEN or ZERO-WIDTH-SPACE
39 *  - folding of certain characters for string comparison
40 *    (e.g. HYPHEN U+2010 and MINUS U+2212 to ASCII "-")
41 *    (see "LUMP" option)
42 *  - optional rejection of strings containing non-assigned code points
43 *  - stripping of control characters
44 *  - stripping of character marks (accents, etc.)
45 *  - transformation of LF, CRLF, CR and NEL to line-feed (LF)
46 *    or to the unicode chararacters for paragraph separation (PS)
47 *    or line separation (LS).
48 *  - unicode case folding (for case insensitive string comparisons)
49 *  - rejection of illegal UTF-8 data
50 *    (i.e. UTF-8 encoded UTF-16 surrogates)
51 *  - support for korean hangul characters
52 *  Unicode Version 5.0.0 is supported.
53 */
54
55
56#ifndef UTF8PROC_H
57#define UTF8PROC_H
58
59
60#include "config.h"
61
62#include <stdlib.h>
63#ifdef HAVE_STDBOOL_H
64#include <stdbool.h>
65#else
66# if ! HAVE__BOOL
67#  ifdef __cplusplus
68typedef bool _Bool;
69#  else
70typedef unsigned char _Bool;
71#  endif
72# endif
73#ifndef _Bool
74# define bool _Bool
75#endif
76# define false 0
77# define true 1
78# define __bool_true_false_are_defined 1
79#endif
80#include <sys/types.h>
81#ifdef HAVE_INTTYPES_H
82#include <inttypes.h>
83#elif defined(_MSC_VER) && defined(HAVE_STDINT_H)
84#include <stdint.h>
85#else /* HAVE_INTTYPES_H */
86#include <pstdint.h>
87#endif /* HAVE_INTTYPES_H */
88#include <limits.h>
89
90#ifndef HAVE_SSIZE_T
91#define ssize_t int
92#endif
93
94#ifndef SSIZE_MAX
95#define SSIZE_MAX (SIZE_MAX/2)
96#endif
97
98#define UTF8PROC_NULLTERM  (1<<0)
99#define UTF8PROC_STABLE    (1<<1)
100#define UTF8PROC_COMPAT    (1<<2)
101#define UTF8PROC_COMPOSE   (1<<3)
102#define UTF8PROC_DECOMPOSE (1<<4)
103#define UTF8PROC_IGNORE    (1<<5)
104#define UTF8PROC_REJECTNA  (1<<6)
105#define UTF8PROC_NLF2LS    (1<<7)
106#define UTF8PROC_NLF2PS    (1<<8)
107#define UTF8PROC_NLF2LF    (UTF8PROC_NLF2LS | UTF8PROC_NLF2PS)
108#define UTF8PROC_STRIPCC   (1<<9)
109#define UTF8PROC_CASEFOLD  (1<<10)
110#define UTF8PROC_CHARBOUND (1<<11)
111#define UTF8PROC_LUMP      (1<<12)
112#define UTF8PROC_STRIPMARK (1<<13)
113/*
114 *  Flags being regarded by several functions in the library:
115 *  NULLTERM:  The given UTF-8 input is NULL terminated.
116 *  STABLE:    Unicode Versioning Stability has to be respected.
117 *  COMPAT:    Compatibility decomposition
118 *             (i.e. formatting information is lost)
119 *  COMPOSE:   Return a result with composed characters.
120 *  DECOMPOSE: Return a result with decomposed characters.
121 *  IGNORE:    Strip "default ignorable characters"
122 *  REJECTNA:  Return an error, if the input contains unassigned
123 *             code points.
124 *  NLF2LS:    Indicating that NLF-sequences (LF, CRLF, CR, NEL) are
125 *             representing a line break, and should be converted to the
126 *             unicode character for line separation (LS).
127 *  NLF2PS:    Indicating that NLF-sequences are representing a paragraph
128 *             break, and should be converted to the unicode character for
129 *             paragraph separation (PS).
130 *  NLF2LF:    Indicating that the meaning of NLF-sequences is unknown.
131 *  STRIPCC:   Strips and/or convers control characters.
132 *             NLF-sequences are transformed into space, except if one of
133 *             the NLF2LS/PS/LF options is given.
134 *             HorizontalTab (HT) and FormFeed (FF) are treated as a
135 *             NLF-sequence in this case.
136 *             All other control characters are simply removed.
137 *  CASEFOLD:  Performs unicode case folding, to be able to do a
138 *             case-insensitive string comparison.
139 *  CHARBOUND: Inserts 0xFF bytes at the beginning of each sequence which
140 *             is representing a single grapheme cluster (see UAX#29).
141 *  LUMP:      Lumps certain characters together
142 *             (e.g. HYPHEN U+2010 and MINUS U+2212 to ASCII "-").
143 *             (See lump.txt for details.)
144 *             If NLF2LF is set, this includes a transformation of
145 *             paragraph and line separators to ASCII line-feed (LF).
146 *  STRIPMARK: Strips all character markings
147 *             (non-spacing, spacing and enclosing) (i.e. accents)
148 *             NOTE: this option works only with COMPOSE or DECOMPOSE
149 */
150
151#define UTF8PROC_ERROR_NOMEM -1
152#define UTF8PROC_ERROR_OVERFLOW -2
153#define UTF8PROC_ERROR_INVALIDUTF8 -3
154#define UTF8PROC_ERROR_NOTASSIGNED -4
155#define UTF8PROC_ERROR_INVALIDOPTS -5
156/*
157 *  Error codes being returned by almost all functions:
158 *  ERROR_NOMEM:       Memory could not be allocated.
159 *  ERROR_OVERFLOW:    The given string is too long to be processed.
160 *  ERROR_INVALIDUTF8: The given string is not a legal UTF-8 string.
161 *  ERROR_NOTASSIGNED: The REJECTNA flag was set,
162 *                     and an unassigned code point was found.
163 *  ERROR_INVALIDOPTS: Invalid options have been used.
164 */
165
166typedef int16_t utf8proc_propval_t;
167typedef struct utf8proc_property_struct {
168  utf8proc_propval_t category;
169  utf8proc_propval_t combining_class;
170  utf8proc_propval_t bidi_class;
171  utf8proc_propval_t decomp_type;
172  const int32_t *decomp_mapping;
173  unsigned bidi_mirrored:1;
174  int32_t uppercase_mapping;
175  int32_t lowercase_mapping;
176  int32_t titlecase_mapping;
177  int32_t comb1st_index;
178  int32_t comb2nd_index;
179  unsigned comp_exclusion:1;
180  unsigned ignorable:1;
181  unsigned control_boundary:1;
182  unsigned extend:1;
183  const int32_t *casefold_mapping;
184utf8proc_property_t;
185
186#define UTF8PROC_CATEGORY_LU  1
187#define UTF8PROC_CATEGORY_LL  2
188#define UTF8PROC_CATEGORY_LT  3
189#define UTF8PROC_CATEGORY_LM  4
190#define UTF8PROC_CATEGORY_LO  5
191#define UTF8PROC_CATEGORY_MN  6
192#define UTF8PROC_CATEGORY_MC  7
193#define UTF8PROC_CATEGORY_ME  8
194#define UTF8PROC_CATEGORY_ND  9
195#define UTF8PROC_CATEGORY_NL 10
196#define UTF8PROC_CATEGORY_NO 11
197#define UTF8PROC_CATEGORY_PC 12
198#define UTF8PROC_CATEGORY_PD 13
199#define UTF8PROC_CATEGORY_PS 14
200#define UTF8PROC_CATEGORY_PE 15
201#define UTF8PROC_CATEGORY_PI 16
202#define UTF8PROC_CATEGORY_PF 17
203#define UTF8PROC_CATEGORY_PO 18
204#define UTF8PROC_CATEGORY_SM 19
205#define UTF8PROC_CATEGORY_SC 20
206#define UTF8PROC_CATEGORY_SK 21
207#define UTF8PROC_CATEGORY_SO 22
208#define UTF8PROC_CATEGORY_ZS 23
209#define UTF8PROC_CATEGORY_ZL 24
210#define UTF8PROC_CATEGORY_ZP 25
211#define UTF8PROC_CATEGORY_CC 26
212#define UTF8PROC_CATEGORY_CF 27
213#define UTF8PROC_CATEGORY_CS 28
214#define UTF8PROC_CATEGORY_CO 29
215#define UTF8PROC_CATEGORY_CN 30
216#define UTF8PROC_BIDI_CLASS_L    1
217#define UTF8PROC_BIDI_CLASS_LRE  2
218#define UTF8PROC_BIDI_CLASS_LRO  3
219#define UTF8PROC_BIDI_CLASS_R    4
220#define UTF8PROC_BIDI_CLASS_AL   5
221#define UTF8PROC_BIDI_CLASS_RLE  6
222#define UTF8PROC_BIDI_CLASS_RLO  7
223#define UTF8PROC_BIDI_CLASS_PDF  8
224#define UTF8PROC_BIDI_CLASS_EN   9
225#define UTF8PROC_BIDI_CLASS_ES  10
226#define UTF8PROC_BIDI_CLASS_ET  11
227#define UTF8PROC_BIDI_CLASS_AN  12
228#define UTF8PROC_BIDI_CLASS_CS  13
229#define UTF8PROC_BIDI_CLASS_NSM 14
230#define UTF8PROC_BIDI_CLASS_BN  15
231#define UTF8PROC_BIDI_CLASS_B   16
232#define UTF8PROC_BIDI_CLASS_S   17
233#define UTF8PROC_BIDI_CLASS_WS  18
234#define UTF8PROC_BIDI_CLASS_ON  19
235#define UTF8PROC_DECOMP_TYPE_FONT      1
236#define UTF8PROC_DECOMP_TYPE_NOBREAK   2
237#define UTF8PROC_DECOMP_TYPE_INITIAL   3
238#define UTF8PROC_DECOMP_TYPE_MEDIAL    4
239#define UTF8PROC_DECOMP_TYPE_FINAL     5
240#define UTF8PROC_DECOMP_TYPE_ISOLATED  6
241#define UTF8PROC_DECOMP_TYPE_CIRCLE    7
242#define UTF8PROC_DECOMP_TYPE_SUPER     8
243#define UTF8PROC_DECOMP_TYPE_SUB       9
244#define UTF8PROC_DECOMP_TYPE_VERTICAL 10
245#define UTF8PROC_DECOMP_TYPE_WIDE     11
246#define UTF8PROC_DECOMP_TYPE_NARROW   12
247#define UTF8PROC_DECOMP_TYPE_SMALL    13
248#define UTF8PROC_DECOMP_TYPE_SQUARE   14
249#define UTF8PROC_DECOMP_TYPE_FRACTION 15
250#define UTF8PROC_DECOMP_TYPE_COMPAT   16
251
252extern const int8_t utf8proc_utf8class[256];
253
254const char *utf8proc_errmsg(ssize_t errcode);
255/*
256 *  Returns a static error string for the given error code.
257 */
258
259ssize_t utf8proc_iterate(const uint8_t *strssize_t strlen, int32_t *dst);
260/*
261 *  Reads a single char from the UTF-8 sequence being pointed to by 'str'.
262 *  The maximum number of bytes read is 'strlen', unless 'strlen' is
263 *  negative.
264 *  If a valid unicode char could be read, it is stored in the variable
265 *  being pointed to by 'dst', otherwise that variable will be set to -1.
266 *  In case of success the number of bytes read is returned, otherwise a
267 *  negative error code is returned.
268 */
269
270bool utf8proc_codepoint_valid(int32_t uc);
271/*
272 *  Returns 1, if the given unicode code-point is valid, otherwise 0.
273 */
274
275ssize_t utf8proc_encode_char(int32_t ucuint8_t *dst);
276/*
277 *  Encodes the unicode char with the code point 'uc' as an UTF-8 string in
278 *  the byte array being pointed to by 'dst'. This array has to be at least
279 *  4 bytes long.
280 *  In case of success the number of bytes written is returned,
281 *  otherwise 0.
282 *  This function does not check if 'uc' is a valid unicode code point.
283 */
284
285const utf8proc_property_t *utf8proc_get_property(int32_t uc);
286/*
287 *  Returns a pointer to a (constant) struct containing information about
288 *  the unicode char with the given code point 'uc'.
289 *  If the character is not existent a pointer to a special struct is
290 *  returned, where 'category' is a NULL pointer.
291 *  WARNING: The parameter 'uc' has to be in the range of 0x0000 to
292 *           0x10FFFF, otherwise the program might crash!
293 */
294
295ssize_t utf8proc_decompose_char(
296  int32_t ucint32_t *dstssize_t bufsize,
297  int options, int *last_boundclass
298);
299/*
300 *  Writes a decomposition of the unicode char 'uc' into the array being
301 *  pointed to by 'dst'.
302 *  Following flags in the 'options' field are regarded:
303 *  REJECTNA:  an unassigned unicode code point leads to an error
304 *  IGNORE:    "default ignorable" chars are stripped
305 *  CASEFOLD:  unicode casefolding is applied
306 *  COMPAT:    replace certain characters with their
307 *             compatibility decomposition
308 *  CHARBOUND: Inserts 0xFF bytes before each grapheme cluster
309 *  LUMP:      lumps certain different characters together
310 *  STRIPMARK: removes all character marks
311 *  The pointer 'last_boundclass' has to point to an integer variable which
312 *  is storing the last character boundary class, if the CHARBOUND option
313 *  is used.
314 *  In case of success the number of chars written is returned,
315 *  in case of an error, a negative error code is returned.
316 *  If the number of written chars would be bigger than 'bufsize',
317 *  the buffer (up to 'bufsize') has inpredictable data, and the needed
318 *  buffer size is returned.
319 *  WARNING: The parameter 'uc' has to be in the range of 0x0000 to
320 *           0x10FFFF, otherwise the program might crash!
321 */
322
323ssize_t utf8proc_decompose(
324  const uint8_t *strssize_t strlen,
325  int32_t *bufferssize_t bufsize, int options
326);
327/*
328 *  Does the same as 'utf8proc_decompose_char', but acts on a whole UTF-8
329 *  string, and orders the decomposed sequences correctly.
330 *  If the NULLTERM flag in 'options' is set, processing will be stopped,
331 *  when a NULL byte is encounted, otherwise 'strlen' bytes are processed.
332 *  The result in form of unicode code points is written into the buffer
333 *  being pointed to by 'buffer', having the length of 'bufsize' entries.
334 *  In case of success the number of chars written is returned,
335 *  in case of an error, a negative error code is returned.
336 *  If the number of written chars would be bigger than 'bufsize',
337 *  the buffer (up to 'bufsize') has inpredictable data, and the needed
338 *  buffer size is returned.
339 */
340
341ssize_t utf8proc_reencode(int32_t *bufferssize_t length, int options);
342/*
343 *  Reencodes the sequence of unicode characters given by the pointer
344 *  'buffer' and 'length' as UTF-8.
345 *  The result is stored in the same memory area where the data is read.
346 *  Following flags in the 'options' field are regarded:
347 *  NLF2LS:  converts LF, CRLF, CR and NEL into LS
348 *  NLF2PS:  converts LF, CRLF, CR and NEL into PS
349 *  NLF2LF:  converts LF, CRLF, CR and NEL into LF
350 *  STRIPCC: strips or converts all non-affected control characters
351 *  COMPOSE: tries to combine decomposed characters into composite
352 *           characters
353 *  STABLE:  prohibits combining characters which would violate
354 *           the unicode versioning stability
355 *  In case of success the length of the resulting UTF-8 string is
356 *  returned, otherwise a negative error code is returned.
357 *  WARNING: The amount of free space being pointed to by 'buffer', has to
358 *           exceed the amount of the input data by one byte, and the
359 *           entries of the array pointed to by 'str' have to be in the
360 *           range of 0x0000 to 0x10FFFF, otherwise the program might
361 *           crash!
362 */
363
364ssize_t utf8proc_map(
365  const uint8_t *strssize_t strlen, uint8_t **dstptr, int options
366);
367/*
368 *  Maps the given UTF-8 string being pointed to by 'str' to a new UTF-8
369 *  string, which is allocated dynamically, and afterwards pointed to by
370 *  the pointer being pointed to by 'dstptr'.
371 *  If the NULLTERM flag in the 'options' field is set, the length is
372 *  determined by a NULL terminator, otherwise the parameter 'strlen' is
373 *  evaluated to determine the string length, but in any case the result
374 *  will be NULL terminated (though it might contain NULL characters
375 *  before). Other flags in the 'options' field are passed to the functions
376 *  defined above, and regarded as described.
377 *  In case of success the length of the new string is returned,
378 *  otherwise a negative error code is returned.
379 *  NOTICE: The memory of the new UTF-8 string will have been allocated with
380 *          'malloc', and has theirfore to be freed with 'free'.
381 */
382
383uint8_t *utf8proc_NFD(const uint8_t *str);
384uint8_t *utf8proc_NFC(const uint8_t *str);
385uint8_t *utf8proc_NFKD(const uint8_t *str);
386uint8_t *utf8proc_NFKC(const uint8_t *str);
387/*
388 *  Returns a pointer to newly allocated memory of a NFD, NFC, NFKD or NFKC
389 *  normalized version of the null-terminated string 'str'.
390 */
391
392ssize_t utf8proc_check(const uint8_t *str);
393/*
394 * Just checks UTF-8 string for validity, returns 0 if valid or one of
395 * the negative UTF8PROC_ERROR_* codes if invalid or memory exhausted
396 * checking.  Assumes null-terminated string str and UTF8PROC_STABLE
397 * option.
398 */
399
400#endif
401


HyperKWIC - Version 7.20DA executed at 11:37 on 27 Oct 2017 | Polyhedron Solutions - INTERNAL USE | COMMERCIAL (Any O/S) SN 4AKIed