ICU 63.1: unorm.h Source File

00001 // © 2016 and later: Unicode, Inc. and others.
00002 // License & terms of use: http://www.unicode.org/copyright.html
00003 /*
00004 *******************************************************************************
00005 * Copyright (c) 1996-2016, International Business Machines Corporation
00006 *               and others. All Rights Reserved.
00007 *******************************************************************************
00008 * File unorm.h
00009 *
00010 * Created by: Vladimir Weinstein 12052000
00011 *
00012 * Modification history :
00013 *
00014 * Date        Name        Description
00015 * 02/01/01    synwee      Added normalization quickcheck enum and method.
00016 */
00017 #ifndef UNORM_H
00018 #define UNORM_H
00019 
00020 #include "unicode/utypes.h"
00021 
00022 #if !UCONFIG_NO_NORMALIZATION
00023 
00024 #include "unicode/uiter.h"
00025 #include "unicode/unorm2.h"
00026 
00132 // Do not conditionalize the following enum with #ifndef U_HIDE_DEPRECATED_API,
00133 // it is needed for layout of Normalizer object.
00138 typedef enum {
00140   UNORM_NONE = 1,
00142   UNORM_NFD = 2,
00144   UNORM_NFKD = 3,
00146   UNORM_NFC = 4,
00148   UNORM_DEFAULT = UNORM_NFC,
00150   UNORM_NFKC =5,
00152   UNORM_FCD = 6,
00153 
00155   UNORM_MODE_COUNT
00156 } UNormalizationMode;
00157 
00158 #ifndef U_HIDE_DEPRECATED_API
00159 
00167 enum {
00174     UNORM_UNICODE_3_2=0x20
00175 };
00176 
00192 #define UNORM_COMPARE_NORM_OPTIONS_SHIFT 20
00193 
00213 U_DEPRECATED int32_t U_EXPORT2
00214 unorm_normalize(const UChar *source, int32_t sourceLength,
00215                 UNormalizationMode mode, int32_t options,
00216                 UChar *result, int32_t resultLength,
00217                 UErrorCode *status);
00218 
00239 U_DEPRECATED UNormalizationCheckResult U_EXPORT2
00240 unorm_quickCheck(const UChar *source, int32_t sourcelength,
00241                  UNormalizationMode mode,
00242                  UErrorCode *status);
00243 
00260 U_DEPRECATED UNormalizationCheckResult U_EXPORT2
00261 unorm_quickCheckWithOptions(const UChar *src, int32_t srcLength,
00262                             UNormalizationMode mode, int32_t options,
00263                             UErrorCode *pErrorCode);
00264 
00286 U_DEPRECATED UBool U_EXPORT2
00287 unorm_isNormalized(const UChar *src, int32_t srcLength,
00288                    UNormalizationMode mode,
00289                    UErrorCode *pErrorCode);
00290 
00308 U_DEPRECATED UBool U_EXPORT2
00309 unorm_isNormalizedWithOptions(const UChar *src, int32_t srcLength,
00310                               UNormalizationMode mode, int32_t options,
00311                               UErrorCode *pErrorCode);
00312 
00386 U_DEPRECATED int32_t U_EXPORT2
00387 unorm_next(UCharIterator *src,
00388            UChar *dest, int32_t destCapacity,
00389            UNormalizationMode mode, int32_t options,
00390            UBool doNormalize, UBool *pNeededToNormalize,
00391            UErrorCode *pErrorCode);
00392 
00419 U_DEPRECATED int32_t U_EXPORT2
00420 unorm_previous(UCharIterator *src,
00421                UChar *dest, int32_t destCapacity,
00422                UNormalizationMode mode, int32_t options,
00423                UBool doNormalize, UBool *pNeededToNormalize,
00424                UErrorCode *pErrorCode);
00425 
00463 U_DEPRECATED int32_t U_EXPORT2
00464 unorm_concatenate(const UChar *left, int32_t leftLength,
00465                   const UChar *right, int32_t rightLength,
00466                   UChar *dest, int32_t destCapacity,
00467                   UNormalizationMode mode, int32_t options,
00468                   UErrorCode *pErrorCode);
00469 
00470 #endif  /* U_HIDE_DEPRECATED_API */
00471 #endif /* #if !UCONFIG_NO_NORMALIZATION */
00472 #endif