intl/unicharutil/idl/nsIUnicodeNormalizer.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 %{C++
  41 #define NS_UNICODE_NORMALIZER_CID { 0xa665e49a, 0xf3e6, 0x4fed, { 0x9f, 0x31, 0xf7, 0xc5, 0x68, 0xa2, 0x98, 0x99 } }
  42 #define NS_UNICODE_NORMALIZER_CONTRACTID "@mozilla.org/intl/unicodenormalizer;1"
  43 %}
  44
  45 [scriptable, uuid(B43A461F-1BCF-4329-820B-66E48C979E14)]
  46 interface nsIUnicodeNormalizer : nsISupports
  47 {
  48  /**
  49  * Normalize Unicode (NFD, NFC, NFKD, NFKC).
  50  *
  51  * NFD: Canonical Decomposition
  52  * NFC: Canonical Decomposition, followed by Canonical Composition
  53  * NFKD: Compatibility Decomposition
  54  * NFKC: Compatibility Decomposition, followed by Canonical Composition
  55  * Reference: Unicode Standard, TR15, Unicode Normalization Forms
  56  *
  57  * @param aSrc         [IN]  nsAString which contains an input UTF-16 string.
  58  * @param aDest        [OUT] A pointer to an output buffer provided by a callee.
  59  * @return             NS_OK for success,
  60  */
  61   void NormalizeUnicodeNFD(in AString aSrc, out AString aDest);
  62   void NormalizeUnicodeNFC(in AString aSrc, out AString aDest);
  63   void NormalizeUnicodeNFKD(in AString aSrc, out AString aDest);
  64   void NormalizeUnicodeNFKC(in AString aSrc, out AString aDest);
  65 };