text: /*
  *******************************************************************************
  *
  *   Copyright (C) 2009-2010, International Business Machines
  *   Corporation and others.  All Rights Reserved.
  *
  *******************************************************************************
  *   file name:  unorm2.h
  *   encoding:   US-ASCII
  *   tab size:   8 (not used)
  *   indentation:4
  *
  *   created on: 2009dec15
  *   created by: Markus W. Scherer
  */
  
  #ifndef __UNORM2_H__
  #define __UNORM2_H__
  
  /**
   * \file
   * \brief C API: New API for Unicode Normalization.
   *
   * Unicode normalization functionality for standard Unicode normalization or
   * for using custom mapping tables.
   * All instances of UNormalizer2 are unmodifiable/immutable.
   * Instances returned by unorm2_getInstance() are singletons that must not be deleted by the caller.
   * For more details see the Normalizer2 C++ class.
   */
  
  #include "unicode/utypes.h"
  #include "unicode/localpointer.h"
  #include "unicode/uset.h"
  
  /**
   * Constants for normalization modes.
   * For details about standard Unicode normalization forms
   * and about the algorithms which are also used with custom mapping tables
   * see http://www.unicode.org/unicode/reports/tr15/
   * @draft ICU 4.4
   */
  typedef enum {
      /**
       * Decomposition followed by composition.
       * Same as standard NFC when using an "nfc" instance.
       * Same as standard NFKC when using an "nfkc" instance.
       * For details about standard Unicode normalization forms
       * see http://www.unicode.org/unicode/reports/tr15/
       * @draft ICU 4.4
       */
      UNORM2_COMPOSE,
      /**
       * Map, and reorder canonically.
       * Same as standard NFD when using an "nfc" instance.
       * Same as standard NFKD when using an "nfkc" instance.
       * For details about standard Unicode normalization forms
       * see http://www.unicode.org/unicode/reports/tr15/
       * @draft ICU 4.4
       */
      UNORM2_DECOMPOSE,
      /**
       * "Fast C or D" form.
       * If a string is in this form, then further decomposition <i>without reordering</i>
       * would yield the same form as DECOMPOSE.
       * Text in "Fast C or D" form can be processed efficiently with data tables
       * that are "canonically closed", that is, that provide equivalent data for
       * equivalent text, without having to be fully normalized.
       * Not a standard Unicode normalization form.
       * Not a unique form: Different FCD strings can be canonically equivalent.
       * For details see http://www.unicode.org/notes/tn5/#FCD
       * @draft ICU 4.4
       */
      UNORM2_FCD,
      /**
       * Compose only contiguously.
       * Also known as "FCC" or "Fast C Contiguous".
       * The result will often but not always be in NFC.
       * The result will conform to FCD which is useful for processing.
       * Not a standard Unicode normalization form.
       * For details see http://www.unicode.org/notes/tn5/#FCC
       * @draft ICU 4.4
       */
      UNORM2_COMPOSE_CONTIGUOUS
  } UNormalization2Mode;
  
  /**
   * Result values for normalization quick check functions.
   * For details see http://www.unicode.org/reports/tr15/#Detecting_Normalization_Forms
   * @stable ICU 2.0
   */
  typedef enum UNormalizationCheckResult {
    /** 
     * The input string is not in the normalization form.
     * @stable ICU 2.0
     */
    UNORM_NO,
    /** 
     * The input string is in the normalization form.
     * @stable ICU 2.0
     */
    UNORM_YES,
    /** 
     * The input string may or may not be in the normalization form.
     * This value is only returned for composition forms like NFC and FCC,
     * when a backward-combining character is found for which the surrounding text
     * would have to be analyzed further.
     * @stable ICU 2.0
     */
    UNORM_MAYBE
  } UNormalizationCheckResult;
  
  /**
   * Opaque C service object type for the new normalization API.
   * @draft ICU 4.4
   */
  struct UNormalizer2;
  typedef struct UNormalizer2 UNormalizer2;  /**< C typedef for struct UNormalizer2. @draft ICU 4.4 */
  
  #if !UCONFIG_NO_NORMALIZATION
  
  /**
   * Returns a UNormalizer2 instance which uses the specified data file
   * (packageName/name similar to ucnv_openPackage() and ures_open()/ResourceBundle)
   * and which composes or decomposes text according to the specified mode.
   * Returns an unmodifiable singleton instance. Do not delete it.
   *
   * Use packageName=NULL for data files that are part of ICU's own data.
   * Use name="nfc" and UNORM2_COMPOSE/UNORM2_DECOMPOSE for Unicode standard NFC/NFD.
   * Use name="nfkc" and UNORM2_COMPOSE/UNORM2_DECOMPOSE for Unicode standard NFKC/NFKD.
   * Use name="nfkc_cf" and UNORM2_COMPOSE for Unicode standard NFKC_CF=NFKC_Casefold.
   *
   * @param packageName NULL for ICU built-in data, otherwise application data package name
   * @param name "nfc" or "nfkc" or "nfkc_cf" or name of custom data file
   * @param mode normalization mode (compose or decompose etc.)
   * @param pErrorCode Standard ICU error code. Its input value must
   *                  pass the U_SUCCESS() test, or else the function returns
   *                  immediately. Check for U_FAILURE() on output or use with
   *                  function chaining. (See User Guide for details.)
   * @return the requested UNormalizer2, if successful
   * @draft ICU 4.4
   */
  U_DRAFT const UNormalizer2 * U_EXPORT2
  unorm2_getInstance(const char *packageName,
                     const char *name,
                     UNormalization2Mode mode,
                     UErrorCode *pErrorCode);
  
  /**
   * Constructs a filtered normalizer wrapping any UNormalizer2 instance
   * and a filter set.
   * Both are aliased and must not be modified or deleted while this object
   * is used.
   * The filter set should be frozen; otherwise the performance will suffer greatly.
   * @param norm2 wrapped Normalizer2 instance
   * @param filterSet USet which determines the characters to be normalized
   * @param pErrorCode Standard ICU error code. Its input value must
   *                   pass the U_SUCCESS() test, or else the function returns
   *                   immediately. Check for U_FAILURE() on output or use with
   *                   function chaining. (See User Guide for details.)
   * @return the requested UNormalizer2, if successful
   * @draft ICU 4.4
   */
  U_DRAFT UNormalizer2 * U_EXPORT2
  unorm2_openFiltered(const UNormalizer2 *norm2, const USet *filterSet, UErrorCode *pErrorCode);
  
  /**
   * Closes a UNormalizer2 instance from unorm2_openFiltered().
   * Do not close instances from unorm2_getInstance()!
   * @param norm2 UNormalizer2 instance to be closed
   * @draft ICU 4.4
   */
  U_DRAFT void U_EXPORT2
  unorm2_close(UNormalizer2 *norm2);
  
  #if U_SHOW_CPLUSPLUS_API
  
  U_NAMESPACE_BEGIN
  
  /**
   * \class LocalUNormalizer2Pointer
   * "Smart pointer" class, closes a UNormalizer2 via unorm2_close().
   * For most methods see the LocalPointerBase base class.
   *
   * @see LocalPointerBase
   * @see LocalPointer
   * @draft ICU 4.4
   */
  U_DEFINE_LOCAL_OPEN_POINTER(LocalUNormalizer2Pointer, UNormalizer2, unorm2_close);
  
  U_NAMESPACE_END
  
  #endif
  
  /**
   * Writes the normalized form of the source string to the destination string
   * (replacing its contents) and returns the length of the destination string.
   * The source and destination strings must be different buffers.
   * @param norm2 UNormalizer2 instance
   * @param src source string
   * @param length length of the source string, or -1 if NUL-terminated
   * @param dest destination string; its contents is replaced with normalized src
   * @param capacity number of UChars that can be written to dest
   * @param pErrorCode Standard ICU error code. Its input value must
   *                   pass the U_SUCCESS() test, or else the function returns
   *                   immediately. Check for U_FAILURE() on output or use with
   *                   function chaining. (See User Guide for details.)
   * @return dest
   * @draft ICU 4.4
   */
  U_DRAFT int32_t U_EXPORT2
  unorm2_normalize(const UNormalizer2 *norm2,
                   const UChar *src, int32_t length,
                   UChar *dest, int32_t capacity,
                   UErrorCode *pErrorCode);
  /**
   * Appends the normalized form of the second string to the first string
   * (merging them at the boundary) and returns the length of the first string.
   * The result is normalized if the first string was normalized.
   * The first and second strings must be different buffers.
   * @param norm2 UNormalizer2 instance
   * @param first string, should be normalized
   * @param firstLength length of the first string, or -1 if NUL-terminated
   * @param firstCapacity number of UChars that can be written to first
   * @param second string, will be normalized
   * @param secondLength length of the source string, or -1 if NUL-terminated
   * @param pErrorCode Standard ICU error code. Its input value must
   *                   pass the U_SUCCESS() test, or else the function returns
   *                   immediately. Check for U_FAILURE() on output or use with
   *                   function chaining. (See User Guide for details.)
   * @return first
   * @draft ICU 4.4
   */
  U_DRAFT int32_t U_EXPORT2
  unorm2_normalizeSecondAndAppend(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 of the first string.
   * The result is normalized if both the strings were normalized.
   * The first and second strings must be different buffers.
   * @param norm2 UNormalizer2 instance
   * @param first string, should be normalized
   * @param firstLength length of the first string, or -1 if NUL-terminated
   * @param firstCapacity number of UChars that can be written to first
   * @param second string, should be normalized
   * @param secondLength length of the source string, or -1 if NUL-terminated
   * @param pErrorCode Standard ICU error code. Its input value must
   *                   pass the U_SUCCESS() test, or else the function returns
   *                   immediately. Check for U_FAILURE() on output or use with
   *                   function chaining. (See User Guide for details.)
   * @return first
   * @draft ICU 4.4
   */
  U_DRAFT int32_t U_EXPORT2
  unorm2_append(const UNormalizer2 *norm2,
                UChar *first, int32_t firstLength, int32_t firstCapacity,
                const UChar *second, int32_t secondLength,
                UErrorCode *pErrorCode);
  
  /**
   * Tests if the string is normalized.
   * Internally, in cases where the quickCheck() method would return "maybe"
   * (which is only possible for the two COMPOSE modes) this method
   * resolves to "yes" or "no" to provide a definitive result,
   * at the cost of doing more work in those cases.
   * @param norm2 UNormalizer2 instance
   * @param s input string
   * @param length length of the string, or -1 if NUL-terminated
   * @param pErrorCode Standard ICU error code. Its input value must
   *                   pass the U_SUCCESS() test, or else the function returns
   *                   immediately. Check for U_FAILURE() on output or use with
   *                   function chaining. (See User Guide for details.)
   * @return TRUE if s is normalized
   * @draft ICU 4.4
   */
  U_DRAFT UBool U_EXPORT2
  unorm2_isNormalized(const UNormalizer2 *norm2,
                      const UChar *s, int32_t length,
                      UErrorCode *pErrorCode);
  
  /**
   * Tests if the string is normalized.
   * For the two COMPOSE modes, the result could be "maybe" in cases that
   * would take a little more work to resolve definitively.
   * Use spanQuickCheckYes() and normalizeSecondAndAppend() for a faster
   * combination of quick check + normalization, to avoid
   * re-checking the "yes" prefix.
   * @param norm2 UNormalizer2 instance
   * @param s input string
   * @param length length of the string, or -1 if NUL-terminated
   * @param pErrorCode Standard ICU error code. Its input value must
   *                   pass the U_SUCCESS() test, or else the function returns
   *                   immediately. Check for U_FAILURE() on output or use with
   *                   function chaining. (See User Guide for details.)
   * @return UNormalizationCheckResult
   * @draft ICU 4.4
   */
  U_DRAFT UNormalizationCheckResult U_EXPORT2
  unorm2_quickCheck(const UNormalizer2 *norm2,
                    const UChar *s, int32_t length,
                    UErrorCode *pErrorCode);
  
  /**
   * Returns the end of the normalized substring of the input string.
   * In other words, with <code>end=spanQuickCheckYes(s, ec);</code>
   * the substring <code>UnicodeString(s, 0, end)</code>
   * will pass the quick check with a "yes" result.
   *
   * The returned end index is usually one or more characters before the
   * "no" or "maybe" character: The end index is at a normalization boundary.
   * (See the class documentation for more about normalization boundaries.)
   *
   * When the goal is a normalized string and most input strings are expected
   * to be normalized already, then call this method,
   * and if it returns a prefix shorter than the input string,
   * copy that prefix and use normalizeSecondAndAppend() for the remainder.
   * @param norm2 UNormalizer2 instance
   * @param s input string
   * @param length length of the string, or -1 if NUL-terminated
   * @param pErrorCode Standard ICU error code. Its input value must
   *                   pass the U_SUCCESS() test, or else the function returns
   *                   immediately. Check for U_FAILURE() on output or use with
   *                   function chaining. (See User Guide for details.)
   * @return "yes" span end index
   * @draft ICU 4.4
   */
  U_DRAFT int32_t U_EXPORT2
  unorm2_spanQuickCheckYes(const UNormalizer2 *norm2,
                           const UChar *s, int32_t length,
                           UErrorCode *pErrorCode);
  
  /**
   * Tests if the character always has a normalization boundary before it,
   * regardless of context.
   * For details see the Normalizer2 base class documentation.
   * @param norm2 UNormalizer2 instance
   * @param c character to test
   * @return TRUE if c has a normalization boundary before it
   * @draft ICU 4.4
   */
  U_DRAFT UBool U_EXPORT2
  unorm2_hasBoundaryBefore(const UNormalizer2 *norm2, UChar32 c);
  
  /**
   * Tests if the character always has a normalization boundary after it,
   * regardless of context.
   * For details see the Normalizer2 base class documentation.
   * @param norm2 UNormalizer2 instance
   * @param c character to test
   * @return TRUE if c has a normalization boundary after it
   * @draft ICU 4.4
   */
  U_DRAFT UBool U_EXPORT2
  unorm2_hasBoundaryAfter(const UNormalizer2 *norm2, UChar32 c);
  
  /**
   * Tests if the character is normalization-inert.
   * For details see the Normalizer2 base class documentation.
   * @param norm2 UNormalizer2 instance
   * @param c character to test
   * @return TRUE if c is normalization-inert
   * @draft ICU 4.4
   */
  U_DRAFT UBool U_EXPORT2
  unorm2_isInert(const UNormalizer2 *norm2, UChar32 c);
  
  #endif  /* !UCONFIG_NO_NORMALIZATION */
  #endif  /* __UNORM2_H__ */
  