intl/locale/idl/nsICollation.idl

   1 /* -*- Mode: idl; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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  *   mozilla.org
  19  * Portions created by the Initial Developer are Copyright (C) 2004
  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 the GNU General Public License Version 2 or later (the "GPL"), or
  26  * 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 "nsILocale.idl"
  39
  40 interface nsICollation;
  41
  42 [scriptable, uuid(04971e14-d6b3-4ada-8cbb-c3a13842b349)]
  43 interface nsICollationFactory : nsISupports {
  44   nsICollation CreateCollation(in nsILocale locale);
  45 };
  46
  47 [scriptable, uuid(b0132cc0-3786-4557-9874-910d7def5f93)]
  48 interface nsICollation : nsISupports {
  49
  50   // use the primary comparison for the given local - no flags
  51   const long kCollationStrengthDefault = 0;
  52
  53   // do not consider case differences when doing the comparison i.e. A=a)
  54   const long kCollationCaseInsensitiveAscii = 1;
  55
  56   // do not consider accent differences when doing the comparison a=á)
  57   const long kCollationAccentInsenstive = 2;
  58
  59   // case sensitive collation (default)
  60   const long kCollationCaseSensitive = kCollationStrengthDefault;
  61
  62   // case insensitive collation
  63   const long kCollationCaseInSensitive = (kCollationCaseInsensitiveAscii | kCollationAccentInsenstive);
  64
  65   // init this interface to a specified locale (should only be called by collation factory)
  66   void initialize(in nsILocale locale);
  67
  68   // compare two strings
  69   // result is same as strcmp
  70   long compareString(in long strength, in AString string1, in AString string2);
  71
  72   // allocate sort key from input string
  73   // returns newly allocated key, and its band its byte length
  74   [noscript] void allocateRawSortKey(in long strength,
  75                                      in AString stringIn,
  76                                      [array,size_is(outLen)] out octet key,
  77                                      out unsigned long outLen);
  78
  79   // compare two sort keys
  80   // length is a byte length, result is same as strcmp
  81   [noscript] long compareRawSortKey([const,array,size_is(len1)] in octet key1, in unsigned long len1,
  82                                     [const,array,size_is(len2)] in octet key2, in unsigned long len2);
  83
  84 };