intl/unicharutil/nsIUnicodeNormalizer.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8 %{C++
   9 #define NS_UNICODE_NORMALIZER_CID { 0xa665e49a, 0xf3e6, 0x4fed, { 0x9f, 0x31, 0xf7, 0xc5, 0x68, 0xa2, 0x98, 0x99 } }
  10 #define NS_UNICODE_NORMALIZER_CONTRACTID "@mozilla.org/intl/unicodenormalizer;1"
  11 %}
  12
  13 [scriptable, uuid(B43A461F-1BCF-4329-820B-66E48C979E14)]
  14 interface nsIUnicodeNormalizer : nsISupports
  15 {
  16  /**
  17  * Normalize Unicode (NFD, NFC, NFKD, NFKC).
  18  *
  19  * NFD: Canonical Decomposition
  20  * NFC: Canonical Decomposition, followed by Canonical Composition
  21  * NFKD: Compatibility Decomposition
  22  * NFKC: Compatibility Decomposition, followed by Canonical Composition
  23  * Reference: Unicode Standard, TR15, Unicode Normalization Forms
  24  *
  25  * @param aSrc         [IN]  nsAString which contains an input UTF-16 string.
  26  * @param aDest        [OUT] A pointer to an output buffer provided by a callee.
  27  * @return             NS_OK for success,
  28  */
  29   void NormalizeUnicodeNFD(in AString aSrc, out AString aDest);
  30   void NormalizeUnicodeNFC(in AString aSrc, out AString aDest);
  31   void NormalizeUnicodeNFKD(in AString aSrc, out AString aDest);
  32   void NormalizeUnicodeNFKC(in AString aSrc, out AString aDest);
  33 };