ICU 62.1 62.1
unorm2.h
Go to the documentation of this file.
1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4*******************************************************************************
5*
6* Copyright (C) 2009-2015, International Business Machines
7* Corporation and others. All Rights Reserved.
8*
9*******************************************************************************
10* file name: unorm2.h
11* encoding: UTF-8
12* tab size: 8 (not used)
13* indentation:4
14*
15* created on: 2009dec15
16* created by: Markus W. Scherer
17*/
18
19#ifndef __UNORM2_H__
20#define __UNORM2_H__
21
33#include "unicode/utypes.h"
36#include "unicode/uset.h"
37
88
114
119struct UNormalizer2;
122#if !UCONFIG_NO_NORMALIZATION
123
135U_STABLE const UNormalizer2 * U_EXPORT2
137
149U_STABLE const UNormalizer2 * U_EXPORT2
151
163U_STABLE const UNormalizer2 * U_EXPORT2
165
177U_STABLE const UNormalizer2 * U_EXPORT2
179
191U_STABLE const UNormalizer2 * U_EXPORT2
193
215U_STABLE const UNormalizer2 * U_EXPORT2
216unorm2_getInstance(const char *packageName,
217 const char *name,
219 UErrorCode *pErrorCode);
220
236U_STABLE UNormalizer2 * U_EXPORT2
237unorm2_openFiltered(const UNormalizer2 *norm2, const USet *filterSet, UErrorCode *pErrorCode);
238
245U_STABLE void U_EXPORT2
247
248#if U_SHOW_CPLUSPLUS_API
249
251
262
264
265#endif
266
283U_STABLE int32_t U_EXPORT2
285 const UChar *src, int32_t length,
286 UChar *dest, int32_t capacity,
287 UErrorCode *pErrorCode);
306U_STABLE int32_t U_EXPORT2
308 UChar *first, int32_t firstLength, int32_t firstCapacity,
309 const UChar *second, int32_t secondLength,
310 UErrorCode *pErrorCode);
329U_STABLE int32_t U_EXPORT2
331 UChar *first, int32_t firstLength, int32_t firstCapacity,
332 const UChar *second, int32_t secondLength,
333 UErrorCode *pErrorCode);
334
354U_STABLE int32_t U_EXPORT2
356 UChar32 c, UChar *decomposition, int32_t capacity,
357 UErrorCode *pErrorCode);
358
388U_STABLE int32_t U_EXPORT2
390 UChar32 c, UChar *decomposition, int32_t capacity,
391 UErrorCode *pErrorCode);
392
408U_STABLE UChar32 U_EXPORT2
410
420U_STABLE uint8_t U_EXPORT2
422
439U_STABLE UBool U_EXPORT2
441 const UChar *s, int32_t length,
442 UErrorCode *pErrorCode);
443
463 const UChar *s, int32_t length,
464 UErrorCode *pErrorCode);
465
490U_STABLE int32_t U_EXPORT2
492 const UChar *s, int32_t length,
493 UErrorCode *pErrorCode);
494
504U_STABLE UBool U_EXPORT2
506
516U_STABLE UBool U_EXPORT2
518
527U_STABLE UBool U_EXPORT2
529
596U_STABLE int32_t U_EXPORT2
597unorm_compare(const UChar *s1, int32_t length1,
598 const UChar *s2, int32_t length2,
599 uint32_t options,
600 UErrorCode *pErrorCode);
601
602#endif /* !UCONFIG_NO_NORMALIZATION */
603#endif /* __UNORM2_H__ */
"Smart pointer" class, closes a UNormalizer2 via unorm2_close().
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
C API: Bit set option bit constants for various string and character processing functions.
struct USet USet
Definition ucnv.h:69
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition umachine.h:400
int8_t UBool
The ICU boolean type.
Definition umachine.h:236
uint16_t UChar
The base type for UTF-16 code units and pointers.
Definition umachine.h:353
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition umachine.h:111
const UNormalizer2 * unorm2_getNFDInstance(UErrorCode *pErrorCode)
Returns a UNormalizer2 instance for Unicode NFD normalization.
UNormalizationCheckResult
Result values for normalization quick check functions.
Definition unorm2.h:94
@ UNORM_YES
The input string is in the normalization form.
Definition unorm2.h:104
@ UNORM_MAYBE
The input string may or may not be in the normalization form.
Definition unorm2.h:112
@ UNORM_NO
The input string is not in the normalization form.
Definition unorm2.h:99
int32_t unorm2_spanQuickCheckYes(const UNormalizer2 *norm2, const UChar *s, int32_t length, UErrorCode *pErrorCode)
Returns the end of the normalized substring of the input string.
int32_t unorm2_getRawDecomposition(const UNormalizer2 *norm2, UChar32 c, UChar *decomposition, int32_t capacity, UErrorCode *pErrorCode)
Gets the raw decomposition mapping of c.
UBool unorm2_hasBoundaryAfter(const UNormalizer2 *norm2, UChar32 c)
Tests if the character always has a normalization boundary after it, regardless of context.
int32_t unorm2_normalize(const UNormalizer2 *norm2, const UChar *src, int32_t length, UChar *dest, int32_t capacity, UErrorCode *pErrorCode)
Writes the normalized form of the source string to the destination string (replacing its contents) an...
UBool unorm2_isInert(const UNormalizer2 *norm2, UChar32 c)
Tests if the character is normalization-inert.
UNormalization2Mode
Constants for normalization modes.
Definition unorm2.h:45
@ UNORM2_COMPOSE
Decomposition followed by composition.
Definition unorm2.h:54
@ UNORM2_FCD
"Fast C or D" form.
Definition unorm2.h:76
@ UNORM2_COMPOSE_CONTIGUOUS
Compose only contiguously.
Definition unorm2.h:86
@ UNORM2_DECOMPOSE
Map, and reorder canonically.
Definition unorm2.h:63
const UNormalizer2 * unorm2_getInstance(const char *packageName, const char *name, UNormalization2Mode mode, UErrorCode *pErrorCode)
Returns a UNormalizer2 instance which uses the specified data file (packageName/name similar to ucnv_...
const UNormalizer2 * unorm2_getNFKCCasefoldInstance(UErrorCode *pErrorCode)
Returns a UNormalizer2 instance for Unicode NFKC_Casefold normalization.
uint8_t unorm2_getCombiningClass(const UNormalizer2 *norm2, UChar32 c)
Gets the combining class of c.
int32_t unorm2_getDecomposition(const UNormalizer2 *norm2, UChar32 c, UChar *decomposition, int32_t capacity, UErrorCode *pErrorCode)
Gets the decomposition mapping of c.
UChar32 unorm2_composePair(const UNormalizer2 *norm2, UChar32 a, UChar32 b)
Performs pairwise composition of a & b and returns the composite if there is one.
int32_t unorm_compare(const UChar *s1, int32_t length1, const UChar *s2, int32_t length2, uint32_t options, UErrorCode *pErrorCode)
Compares two strings for canonical equivalence.
UNormalizer2 * unorm2_openFiltered(const UNormalizer2 *norm2, const USet *filterSet, UErrorCode *pErrorCode)
Constructs a filtered normalizer wrapping any UNormalizer2 instance and a filter set.
int32_t unorm2_normalizeSecondAndAppend(const UNormalizer2 *norm2, UChar *first, int32_t firstLength, int32_t firstCapacity, const UChar *second, int32_t secondLength, UErrorCode *pErrorCode)
Appends the normalized form of the second string to the first string (merging them at the boundary) a...
const UNormalizer2 * unorm2_getNFKDInstance(UErrorCode *pErrorCode)
Returns a UNormalizer2 instance for Unicode NFKD normalization.
void unorm2_close(UNormalizer2 *norm2)
Closes a UNormalizer2 instance from unorm2_openFiltered().
UBool unorm2_hasBoundaryBefore(const UNormalizer2 *norm2, UChar32 c)
Tests if the character always has a normalization boundary before it, regardless of context.
const UNormalizer2 * unorm2_getNFKCInstance(UErrorCode *pErrorCode)
Returns a UNormalizer2 instance for Unicode NFKC normalization.
UNormalizationCheckResult unorm2_quickCheck(const UNormalizer2 *norm2, const UChar *s, int32_t length, UErrorCode *pErrorCode)
Tests if the string is normalized.
const UNormalizer2 * unorm2_getNFCInstance(UErrorCode *pErrorCode)
Returns a UNormalizer2 instance for Unicode NFC normalization.
struct UNormalizer2 UNormalizer2
C typedef for struct UNormalizer2.
Definition unorm2.h:120
int32_t unorm2_append(const UNormalizer2 *norm2, UChar *first, int32_t firstLength, int32_t firstCapacity, const UChar *second, int32_t secondLength, UErrorCode *pErrorCode)
Appends the second string to the first string (merging them at the boundary) and returns the length o...
UBool unorm2_isNormalized(const UNormalizer2 *norm2, const UChar *s, int32_t length, UErrorCode *pErrorCode)
Tests if the string is normalized.
C API: Unicode Set.
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition utypes.h:396
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition uversion.h:138
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition uversion.h:137