16f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/* 26f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org****************************************************************************** 36f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Copyright (C) 1996-2012, International Business Machines * 46f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Corporation and others. All Rights Reserved. * 56f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org****************************************************************************** 66f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org*/ 76f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 86f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 96f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * \file 106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * \brief C++ API: Collation Service. 116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* File coll.h 156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Created by: Helena Shih 176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Modification History: 196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Date Name Description 216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 02/5/97 aliu Modified createDefault to load collation data from 226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* binary files when possible. Added related methods 236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* createCollationFromFile, chopLocale, createPathName. 246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 02/11/97 aliu Added members addToCache, findInCache, and fgCache. 256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 02/12/97 aliu Modified to create objects from RuleBasedCollator cache. 266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Moved cache out of Collation class. 276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 02/13/97 aliu Moved several methods out of this class and into 286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* RuleBasedCollator, with modifications. Modified 296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* createDefault() to call new RuleBasedCollator(Locale&) 306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* constructor. General clean up and documentation. 316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 02/20/97 helena Added clone, operator==, operator!=, operator=, copy 326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* constructor and getDynamicClassID. 336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 03/25/97 helena Updated with platform independent data types. 346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 05/06/97 helena Added memory allocation error detection. 356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 06/20/97 helena Java class name change. 366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 09/03/97 helena Added createCollationKeyValues(). 376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 02/10/98 damiba Added compare() with length as parameter. 386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 04/23/99 stephen Removed EDecompositionMode, merged with 396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Normalizer::EMode. 406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 11/02/99 helena Collator performance enhancements. Eliminates the 416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* UnicodeString construction and special case for NO_OP. 426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 11/23/99 srl More performance enhancements. Inlining of 436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* critical accessors. 446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 05/15/00 helena Added version information API. 456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 01/29/01 synwee Modified into a C++ wrapper which calls C apis 466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* (ucoll.h). 476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org*/ 486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#ifndef COLL_H 506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define COLL_H 516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "unicode/utypes.h" 536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#if !UCONFIG_NO_COLLATION 556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "unicode/uobject.h" 576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "unicode/ucol.h" 586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "unicode/normlzr.h" 596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "unicode/locid.h" 606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "unicode/uniset.h" 616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "unicode/umisc.h" 626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "unicode/uiter.h" 636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "unicode/stringpiece.h" 646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_NAMESPACE_BEGIN 666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgclass StringEnumeration; 686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#if !UCONFIG_NO_SERVICE 706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.6 726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgclass CollatorFactory; 746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#endif 756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* @stable ICU 2.0 786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org*/ 796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgclass CollationKey; 806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* The <code>Collator</code> class performs locale-sensitive string 836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* comparison.<br> 846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* You use this class to build searching and sorting routines for natural 856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* language text.<br> 866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <em>Important: </em>The ICU collation service has been reimplemented 876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* in order to achieve better performance and UCA compliance. 886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* For details, see the 896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <a href="http://source.icu-project.org/repos/icu/icuhtml/trunk/design/collation/ICU_collation_design.htm"> 906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* collation design document</a>. 916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <p> 926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <code>Collator</code> is an abstract base class. Subclasses implement 936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* specific collation strategies. One subclass, 946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <code>RuleBasedCollator</code>, is currently provided and is applicable 956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* to a wide set of languages. Other subclasses may be created to handle more 966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* specialized needs. 976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <p> 986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Like other locale-sensitive classes, you can use the static factory method, 996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <code>createInstance</code>, to obtain the appropriate 1006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <code>Collator</code> object for a given locale. You will only need to 1016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* look at the subclasses of <code>Collator</code> if you need to 1026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* understand the details of a particular collation strategy or if you need to 1036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* modify that strategy. 1046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <p> 1056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* The following example shows how to compare two strings using the 1066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <code>Collator</code> for the default locale. 1076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* \htmlonly<blockquote>\endhtmlonly 1086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <pre> 1096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* \code 1106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* // Compare two strings in the default locale 1116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* UErrorCode success = U_ZERO_ERROR; 1126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Collator* myCollator = Collator::createInstance(success); 1136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* if (myCollator->compare("abc", "ABC") < 0) 1146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* cout << "abc is less than ABC" << endl; 1156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* else 1166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* cout << "abc is greater than or equal to ABC" << endl; 1176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* \endcode 1186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* </pre> 1196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* \htmlonly</blockquote>\endhtmlonly 1206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <p> 1216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* You can set a <code>Collator</code>'s <em>strength</em> property to 1226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* determine the level of difference considered significant in comparisons. 1236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Five strengths are provided: <code>PRIMARY</code>, <code>SECONDARY</code>, 1246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <code>TERTIARY</code>, <code>QUATERNARY</code> and <code>IDENTICAL</code>. 1256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* The exact assignment of strengths to language features is locale dependant. 1266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* For example, in Czech, "e" and "f" are considered primary differences, 1276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* while "e" and "\u00EA" are secondary differences, "e" and "E" are tertiary 1286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* differences and "e" and "e" are identical. The following shows how both case 1296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* and accents could be ignored for US English. 1306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* \htmlonly<blockquote>\endhtmlonly 1316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <pre> 1326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* \code 1336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* //Get the Collator for US English and set its strength to PRIMARY 1346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* UErrorCode success = U_ZERO_ERROR; 1356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Collator* usCollator = Collator::createInstance(Locale::US, success); 1366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* usCollator->setStrength(Collator::PRIMARY); 1376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* if (usCollator->compare("abc", "ABC") == 0) 1386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* cout << "'abc' and 'ABC' strings are equivalent with strength PRIMARY" << endl; 1396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* \endcode 1406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* </pre> 1416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* \htmlonly</blockquote>\endhtmlonly 1426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <p> 1436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* For comparing strings exactly once, the <code>compare</code> method 1446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* provides the best performance. When sorting a list of strings however, it 1456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* is generally necessary to compare each string multiple times. In this case, 1466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* sort keys provide better performance. The <code>getSortKey</code> methods 1476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* convert a string to a series of bytes that can be compared bitwise against 1486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* other sort keys using <code>strcmp()</code>. Sort keys are written as 1496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* zero-terminated byte strings. They consist of several substrings, one for 1506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* each collation strength level, that are delimited by 0x01 bytes. 1516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* If the string code points are appended for UCOL_IDENTICAL, then they are 1526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* processed for correct code point order comparison and may contain 0x01 1536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* bytes but not zero bytes. 1546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* </p> 1556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <p> 1566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* An older set of APIs returns a <code>CollationKey</code> object that wraps 1576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* the sort key bytes instead of returning the bytes themselves. 1586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Its use is deprecated, but it is still available for compatibility with 1596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Java. 1606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* </p> 1616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <p> 1626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* <strong>Note:</strong> <code>Collator</code>s with different Locale, 1636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* and CollationStrength settings will return different sort 1646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* orders for the same set of strings. Locales have specific collation rules, 1656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* and the way in which secondary and tertiary differences are taken into 1666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* account, for example, will result in a different sorting order for same 1676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* strings. 1686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* </p> 1696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* @see RuleBasedCollator 1706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* @see CollationKey 1716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* @see CollationElementIterator 1726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* @see Locale 1736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* @see Normalizer 1746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* @version 2.0 11/15/01 1756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org*/ 1766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 1776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgclass U_I18N_API Collator : public UObject { 1786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgpublic: 1796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 1806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org // Collator public enums ----------------------------------------------- 1816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 1826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 1836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Base letter represents a primary difference. Set comparison level to 1846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * PRIMARY to ignore secondary and tertiary differences.<br> 1856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Use this to set the strength of a Collator object.<br> 1866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Example of primary difference, "abc" < "abd" 1876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Diacritical differences on the same base letter represent a secondary 1896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * difference. Set comparison level to SECONDARY to ignore tertiary 1906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * differences. Use this to set the strength of a Collator object.<br> 1916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Example of secondary difference, "ä" >> "a". 1926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Uppercase and lowercase versions of the same character represents a 1946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * tertiary difference. Set comparison level to TERTIARY to include all 1956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * comparison differences. Use this to set the strength of a Collator 1966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * object.<br> 1976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Example of tertiary difference, "abc" <<< "ABC". 1986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 1996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Two characters are considered "identical" when they have the same unicode 2006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * spellings.<br> 2016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * For example, "ä" == "ä". 2026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UCollationStrength is also used to determine the strength of sort keys 2046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * generated from Collator objects. 2056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 2066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 2076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org enum ECollationStrength 2086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org { 2096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org PRIMARY = UCOL_PRIMARY, // 0 2106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org SECONDARY = UCOL_SECONDARY, // 1 2116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org TERTIARY = UCOL_TERTIARY, // 2 2126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org QUATERNARY = UCOL_QUATERNARY, // 3 2136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org IDENTICAL = UCOL_IDENTICAL // 15 2146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org }; 2156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 2166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 2176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * LESS is returned if source string is compared to be less than target 2186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * string in the compare() method. 2196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * EQUAL is returned if source string is compared to be equal to target 2206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * string in the compare() method. 2216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * GREATER is returned if source string is compared to be greater than 2226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * target string in the compare() method. 2236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see Collator#compare 2246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @deprecated ICU 2.6. Use C enum UCollationResult defined in ucol.h 2256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 2266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org enum EComparisonResult 2276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org { 2286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org LESS = UCOL_LESS, // -1 2296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org EQUAL = UCOL_EQUAL, // 0 2306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org GREATER = UCOL_GREATER // 1 2316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org }; 2326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 2336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org // Collator public destructor ----------------------------------------- 2346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 2356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 2366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Destructor 2376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 2386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 2396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual ~Collator(); 2406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 2416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org // Collator public methods -------------------------------------------- 2426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 2436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 2446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Returns TRUE if "other" is the same as "this". 2456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The base class implementation returns TRUE if "other" has the same type/class as "this": 2476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <code>typeid(*this) == typeid(other)</code>. 2486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Subclass implementations should do something like the following: 2506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <pre> 2516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if (this == &other) { return TRUE; } 2526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if (!Collator::operator==(other)) { return FALSE; } // not the same class 2536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * const MyCollator &o = (const MyCollator&)other; 2556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (compare this vs. o's subclass fields) 2566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </pre> 2576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param other Collator object to be compared 2586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return TRUE if other is the same as this. 2596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 2606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 2616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual UBool operator==(const Collator& other) const; 2626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 2636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 2646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Returns true if "other" is not the same as "this". 2656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Calls ! operator==(const Collator&) const which works for all subclasses. 2666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param other Collator object to be compared 2676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return TRUE if other is not the same as this. 2686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 2696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 2706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual UBool operator!=(const Collator& other) const; 2716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 2726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 2736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Makes a copy of this object. 2746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return a copy of this object, owned by the caller 2756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 2766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 2776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual Collator* clone(void) const = 0; 2786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 2796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 2806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Creates the Collator object for the current default locale. 2816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The default locale is determined by Locale::getDefault. 2826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The UErrorCode& err parameter is used to return status information to the user. 2836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * To check whether the construction succeeded or not, you should check the 2846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * value of U_SUCCESS(err). If you wish more detailed information, you can 2856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * check for informational error results which still indicate success. 2866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * U_USING_FALLBACK_ERROR indicates that a fall back locale was used. For 2876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * example, 'de_CH' was requested, but nothing was found there, so 'de' was 2886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * used. U_USING_DEFAULT_ERROR indicates that the default locale data was 2896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * used; neither the requested locale nor any of its fall back locales 2906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * could be found. 2916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The caller owns the returned object and is responsible for deleting it. 2926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 2936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param err the error code status. 2946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return the collation object of the default locale.(for example, en_US) 2956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see Locale#getDefault 2966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 2976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 2986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static Collator* U_EXPORT2 createInstance(UErrorCode& err); 2996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 3006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 3016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Gets the table-based collation object for the desired locale. The 3026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * resource of the desired locale will be loaded by ResourceLoader. 3036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Locale::ENGLISH is the base collation table and all other languages are 3046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * built on top of it with additional language-specific modifications. 3056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The UErrorCode& err parameter is used to return status information to the user. 3066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * To check whether the construction succeeded or not, you should check 3076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the value of U_SUCCESS(err). If you wish more detailed information, you 3086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * can check for informational error results which still indicate success. 3096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * U_USING_FALLBACK_ERROR indicates that a fall back locale was used. For 3106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * example, 'de_CH' was requested, but nothing was found there, so 'de' was 3116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * used. U_USING_DEFAULT_ERROR indicates that the default locale data was 3126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * used; neither the requested locale nor any of its fall back locales 3136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * could be found. 3146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The caller owns the returned object and is responsible for deleting it. 3156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param loc The locale ID for which to open a collator. 3166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param err the error code status. 3176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return the created table-based collation object based on the desired 3186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * locale. 3196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see Locale 3206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ResourceLoader 3216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.2 3226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 3236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static Collator* U_EXPORT2 createInstance(const Locale& loc, UErrorCode& err); 3246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 3256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#ifdef U_USE_COLLATION_OBSOLETE_2_6 3266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 3276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Create a Collator with a specific version. 3286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is the same as createInstance(loc, err) except that getVersion() of 3296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the returned object is guaranteed to be the same as the version 3306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * parameter. 3316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is designed to be used to open the same collator for a given 3326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * locale even when ICU is updated. 3336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The same locale and version guarantees the same sort keys and 3346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * comparison results. 3356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p> 3366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note: this API will be removed in a future release. Use 3376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <tt>createInstance(const Locale&, UErrorCode&) instead.</tt></p> 3386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 3396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param loc The locale ID for which to open a collator. 3406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param version The requested collator version. 3416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param err A reference to a UErrorCode, 3426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * must not indicate a failure before calling this function. 3436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return A pointer to a Collator, or 0 if an error occurred 3446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * or a collator with the requested version is not available. 3456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 3466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see getVersion 3476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @obsolete ICU 2.6 3486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 3496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static Collator *createInstance(const Locale &loc, UVersionInfo version, UErrorCode &err); 3506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#endif 3516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 3526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 3536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The comparison function compares the character data stored in two 3546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * different strings. Returns information about whether a string is less 3556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * than, greater than or equal to another string. 3566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source the source string to be compared with. 3576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param target the string that is to be compared with the source string. 3586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return Returns a byte value. GREATER if source is greater 3596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * than target; EQUAL if source is equal to target; LESS if source is less 3606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * than target 3616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @deprecated ICU 2.6 use the overload with UErrorCode & 3626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 3636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual EComparisonResult compare(const UnicodeString& source, 3646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const UnicodeString& target) const; 3656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 3666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 3676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The comparison function compares the character data stored in two 3686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * different strings. Returns information about whether a string is less 3696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * than, greater than or equal to another string. 3706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source the source string to be compared with. 3716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param target the string that is to be compared with the source string. 3726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status possible error code 3736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return Returns an enum value. UCOL_GREATER if source is greater 3746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * than target; UCOL_EQUAL if source is equal to target; UCOL_LESS if source is less 3756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * than target 3766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.6 3776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 3786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual UCollationResult compare(const UnicodeString& source, 3796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const UnicodeString& target, 3806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode &status) const = 0; 3816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 3826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 3836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Does the same thing as compare but limits the comparison to a specified 3846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * length 3856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source the source string to be compared with. 3866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param target the string that is to be compared with the source string. 3876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param length the length the comparison is limited to 3886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return Returns a byte value. GREATER if source (up to the specified 3896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * length) is greater than target; EQUAL if source (up to specified 3906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * length) is equal to target; LESS if source (up to the specified 3916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * length) is less than target. 3926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @deprecated ICU 2.6 use the overload with UErrorCode & 3936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 3946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual EComparisonResult compare(const UnicodeString& source, 3956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const UnicodeString& target, 3966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t length) const; 3976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 3986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 3996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Does the same thing as compare but limits the comparison to a specified 4006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * length 4016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source the source string to be compared with. 4026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param target the string that is to be compared with the source string. 4036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param length the length the comparison is limited to 4046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status possible error code 4056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return Returns an enum value. UCOL_GREATER if source (up to the specified 4066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * length) is greater than target; UCOL_EQUAL if source (up to specified 4076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * length) is equal to target; UCOL_LESS if source (up to the specified 4086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * length) is less than target. 4096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.6 4106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 4116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual UCollationResult compare(const UnicodeString& source, 4126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const UnicodeString& target, 4136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t length, 4146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode &status) const = 0; 4156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 4166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 4176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The comparison function compares the character data stored in two 4186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * different string arrays. Returns information about whether a string array 4196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is less than, greater than or equal to another string array. 4206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>Example of use: 4216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <pre> 4226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . UChar ABC[] = {0x41, 0x42, 0x43, 0}; // = "ABC" 4236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . UChar abc[] = {0x61, 0x62, 0x63, 0}; // = "abc" 4246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . UErrorCode status = U_ZERO_ERROR; 4256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . Collator *myCollation = 4266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . Collator::createInstance(Locale::US, status); 4276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . if (U_FAILURE(status)) return; 4286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . myCollation->setStrength(Collator::PRIMARY); 4296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . // result would be Collator::EQUAL ("abc" == "ABC") 4306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . // (no primary difference between "abc" and "ABC") 4316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . Collator::EComparisonResult result = 4326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . myCollation->compare(abc, 3, ABC, 3); 4336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . myCollation->setStrength(Collator::TERTIARY); 4346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . // result would be Collator::LESS ("abc" <<< "ABC") 4356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . // (with tertiary difference between "abc" and "ABC") 4366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * . result = myCollation->compare(abc, 3, ABC, 3); 4376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </pre> 4386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source the source string array to be compared with. 4396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param sourceLength the length of the source string array. If this value 4406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is equal to -1, the string array is null-terminated. 4416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param target the string that is to be compared with the source string. 4426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param targetLength the length of the target string array. If this value 4436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is equal to -1, the string array is null-terminated. 4446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return Returns a byte value. GREATER if source is greater than target; 4456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * EQUAL if source is equal to target; LESS if source is less than 4466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * target 4476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @deprecated ICU 2.6 use the overload with UErrorCode & 4486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 4496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual EComparisonResult compare(const UChar* source, int32_t sourceLength, 4506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const UChar* target, int32_t targetLength) 4516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const; 4526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 4536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 4546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The comparison function compares the character data stored in two 4556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * different string arrays. Returns information about whether a string array 4566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is less than, greater than or equal to another string array. 4576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source the source string array to be compared with. 4586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param sourceLength the length of the source string array. If this value 4596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is equal to -1, the string array is null-terminated. 4606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param target the string that is to be compared with the source string. 4616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param targetLength the length of the target string array. If this value 4626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is equal to -1, the string array is null-terminated. 4636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status possible error code 4646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return Returns an enum value. UCOL_GREATER if source is greater 4656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * than target; UCOL_EQUAL if source is equal to target; UCOL_LESS if source is less 4666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * than target 4676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.6 4686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 4696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual UCollationResult compare(const UChar* source, int32_t sourceLength, 4706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const UChar* target, int32_t targetLength, 4716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode &status) const = 0; 4726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 4736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 4746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Compares two strings using the Collator. 4756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Returns whether the first one compares less than/equal to/greater than 4766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the second one. 4776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This version takes UCharIterator input. 4786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param sIter the first ("source") string iterator 4796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param tIter the second ("target") string iterator 4806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status ICU status 4816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return UCOL_LESS, UCOL_EQUAL or UCOL_GREATER 4826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 4.2 4836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 4846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual UCollationResult compare(UCharIterator &sIter, 4856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UCharIterator &tIter, 4866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode &status) const; 4876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 4886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 4896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Compares two UTF-8 strings using the Collator. 4906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Returns whether the first one compares less than/equal to/greater than 4916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the second one. 4926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This version takes UTF-8 input. 4936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note that a StringPiece can be implicitly constructed 4946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * from a std::string or a NUL-terminated const char * string. 4956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source the first UTF-8 string 4966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param target the second UTF-8 string 4976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status ICU status 4986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return UCOL_LESS, UCOL_EQUAL or UCOL_GREATER 4996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 4.2 5006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 5016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual UCollationResult compareUTF8(const StringPiece &source, 5026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const StringPiece &target, 5036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode &status) const; 5046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 5056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 5066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Transforms the string into a series of characters that can be compared 5076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * with CollationKey::compareTo. It is not possible to restore the original 5086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * string from the chars in the sort key. The generated sort key handles 5096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * only a limited number of ignorable characters. 5106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>Use CollationKey::equals or CollationKey::compare to compare the 5116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * generated sort keys. 5126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If the source string is null, a null collation key will be returned. 5136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source the source string to be transformed into a sort key. 5146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param key the collation key to be filled in 5156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status the error code status. 5166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return the collation key of the string based on the collation rules. 5176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see CollationKey#compare 5186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 5196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 5206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual CollationKey& getCollationKey(const UnicodeString& source, 5216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org CollationKey& key, 5226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode& status) const = 0; 5236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 5246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 5256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Transforms the string into a series of characters that can be compared 5266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * with CollationKey::compareTo. It is not possible to restore the original 5276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * string from the chars in the sort key. The generated sort key handles 5286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * only a limited number of ignorable characters. 5296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>Use CollationKey::equals or CollationKey::compare to compare the 5306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * generated sort keys. 5316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>If the source string is null, a null collation key will be returned. 5326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source the source string to be transformed into a sort key. 5336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param sourceLength length of the collation key 5346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param key the collation key to be filled in 5356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status the error code status. 5366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return the collation key of the string based on the collation rules. 5376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see CollationKey#compare 5386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 5396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 5406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual CollationKey& getCollationKey(const UChar*source, 5416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t sourceLength, 5426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org CollationKey& key, 5436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode& status) const = 0; 5446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 5456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Generates the hash code for the collation object 5466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 5476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 5486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual int32_t hashCode(void) const = 0; 5496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 5506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 5516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Gets the locale of the Collator 5526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 5536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param type can be either requested, valid or actual locale. For more 5546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * information see the definition of ULocDataLocaleType in 5556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * uloc.h 5566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status the error code status. 5576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return locale where the collation data lives. If the collator 5586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * was instantiated from rules, locale is empty. 5596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @deprecated ICU 2.8 This API is under consideration for revision 5606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in ICU 3.0. 5616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 5626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual Locale getLocale(ULocDataLocaleType type, UErrorCode& status) const = 0; 5636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 5646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 5656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Convenience method for comparing two strings based on the collation rules. 5666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source the source string to be compared with. 5676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param target the target string to be compared with. 5686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return true if the first string is greater than the second one, 5696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * according to the collation rules. false, otherwise. 5706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see Collator#compare 5716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 5726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 5736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBool greater(const UnicodeString& source, const UnicodeString& target) 5746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const; 5756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 5766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 5776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Convenience method for comparing two strings based on the collation rules. 5786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source the source string to be compared with. 5796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param target the target string to be compared with. 5806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return true if the first string is greater than or equal to the second 5816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * one, according to the collation rules. false, otherwise. 5826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see Collator#compare 5836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 5846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 5856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBool greaterOrEqual(const UnicodeString& source, 5866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const UnicodeString& target) const; 5876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 5886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 5896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Convenience method for comparing two strings based on the collation rules. 5906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source the source string to be compared with. 5916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param target the target string to be compared with. 5926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return true if the strings are equal according to the collation rules. 5936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * false, otherwise. 5946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see Collator#compare 5956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 5966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 5976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBool equals(const UnicodeString& source, const UnicodeString& target) const; 5986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 5996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 6006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Determines the minimum strength that will be used in comparison or 6016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * transformation. 6026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>E.g. with strength == SECONDARY, the tertiary difference is ignored 6036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>E.g. with strength == PRIMARY, the secondary and tertiary difference 6046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * are ignored. 6056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return the current comparison level. 6066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see Collator#setStrength 6076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @deprecated ICU 2.6 Use getAttribute(UCOL_STRENGTH...) instead 6086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 6096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual ECollationStrength getStrength(void) const; 6106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 6116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 6126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Sets the minimum strength to be used in comparison or transformation. 6136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>Example of use: 6146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <pre> 6156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * \code 6166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * UErrorCode status = U_ZERO_ERROR; 6176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Collator*myCollation = Collator::createInstance(Locale::US, status); 6186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * if (U_FAILURE(status)) return; 6196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * myCollation->setStrength(Collator::PRIMARY); 6206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // result will be "abc" == "ABC" 6216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * // tertiary differences will be ignored 6226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Collator::ComparisonResult result = myCollation->compare("abc", "ABC"); 6236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * \endcode 6246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * </pre> 6256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see Collator#getStrength 6266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param newStrength the new comparison level. 6276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @deprecated ICU 2.6 Use setAttribute(UCOL_STRENGTH...) instead 6286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 6296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual void setStrength(ECollationStrength newStrength); 6306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 6316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 6326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Retrieves the reordering codes for this collator. 6336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param dest The array to fill with the script ordering. 6346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param destCapacity The length of dest. If it is 0, then dest may be NULL and the function 6356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * will only return the length of the result without writing any of the result string (pre-flighting). 6366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status A reference to an error code value, which must not indicate 6376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * a failure before the function call. 6386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The length of the script ordering array. 6396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ucol_setReorderCodes 6406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see Collator#getEquivalentReorderCodes 6416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see Collator#setReorderCodes 6426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UScriptCode 6436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UColReorderCode 6446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 4.8 6456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 6466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual int32_t getReorderCodes(int32_t *dest, 6476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t destCapacity, 6486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode& status) const; 6496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 6506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 6516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Sets the ordering of scripts for this collator. 6526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 6536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>The reordering codes are a combination of script codes and reorder codes. 6546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param reorderCodes An array of script codes in the new order. This can be NULL if the 6556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * length is also set to 0. An empty array will clear any reordering codes on the collator. 6566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param reorderCodesLength The length of reorderCodes. 6576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status error code 6586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see Collator#getReorderCodes 6596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see Collator#getEquivalentReorderCodes 6606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UScriptCode 6616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UColReorderCode 6626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 4.8 6636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 6646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual void setReorderCodes(const int32_t* reorderCodes, 6656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t reorderCodesLength, 6666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode& status) ; 6676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 6686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 6696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Retrieves the reorder codes that are grouped with the given reorder code. Some reorder 6706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * codes will be grouped and must reorder together. 6716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param reorderCode The reorder code to determine equivalence for. 6726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param dest The array to fill with the script equivalene reordering codes. 6736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param destCapacity The length of dest. If it is 0, then dest may be NULL and the 6746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * function will only return the length of the result without writing any of the result 6756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * string (pre-flighting). 6766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status A reference to an error code value, which must not indicate 6776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * a failure before the function call. 6786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The length of the of the reordering code equivalence array. 6796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ucol_setReorderCodes 6806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see Collator#getReorderCodes 6816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see Collator#setReorderCodes 6826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UScriptCode 6836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see UColReorderCode 6846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 4.8 6856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 6866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static int32_t U_EXPORT2 getEquivalentReorderCodes(int32_t reorderCode, 6876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t* dest, 6886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t destCapacity, 6896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode& status); 6906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 6916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 6926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get name of the object for the desired Locale, in the desired langauge 6936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param objectLocale must be from getAvailableLocales 6946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param displayLocale specifies the desired locale for output 6956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param name the fill-in parameter of the return value 6966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return display-able name of the object for the object locale in the 6976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * desired language 6986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 6996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 7006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static UnicodeString& U_EXPORT2 getDisplayName(const Locale& objectLocale, 7016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const Locale& displayLocale, 7026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UnicodeString& name); 7036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 7046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 7056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get name of the object for the desired Locale, in the langauge of the 7066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * default locale. 7076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param objectLocale must be from getAvailableLocales 7086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param name the fill-in parameter of the return value 7096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return name of the object for the desired locale in the default language 7106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 7116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 7126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static UnicodeString& U_EXPORT2 getDisplayName(const Locale& objectLocale, 7136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UnicodeString& name); 7146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 7156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 7166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the set of Locales for which Collations are installed. 7176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 7186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p>Note this does not include locales supported by registered collators. 7196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If collators might have been registered, use the overload of getAvailableLocales 7206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * that returns a StringEnumeration.</p> 7216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 7226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param count the output parameter of number of elements in the locale list 7236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return the list of available locales for which collations are installed 7246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 7256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 7266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count); 7276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 7286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 7296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Return a StringEnumeration over the locales available at the time of the call, 7306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * including registered locales. If a severe error occurs (such as out of memory 7316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * condition) this will return null. If there is no locale data, an empty enumeration 7326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * will be returned. 7336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return a StringEnumeration over the locales available at the time of the call 7346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.6 7356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 7366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static StringEnumeration* U_EXPORT2 getAvailableLocales(void); 7376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 7386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 7396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Create a string enumerator of all possible keywords that are relevant to 7406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * collation. At this point, the only recognized keyword for this 7416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * service is "collation". 7426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status input-output error code 7436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return a string enumeration over locale strings. The caller is 7446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * responsible for closing the result. 7456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.0 7466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 7476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static StringEnumeration* U_EXPORT2 getKeywords(UErrorCode& status); 7486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 7496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 7506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Given a keyword, create a string enumeration of all values 7516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for that keyword that are currently in use. 7526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param keyword a particular keyword as enumerated by 7536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ucol_getKeywords. If any other keyword is passed in, status is set 7546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to U_ILLEGAL_ARGUMENT_ERROR. 7556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status input-output error code 7566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return a string enumeration over collation keyword values, or NULL 7576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * upon error. The caller is responsible for deleting the result. 7586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.0 7596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 7606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static StringEnumeration* U_EXPORT2 getKeywordValues(const char *keyword, UErrorCode& status); 7616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 7626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 7636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Given a key and a locale, returns an array of string values in a preferred 7646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * order that would make a difference. These are all and only those values where 7656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the open (creation) of the service with the locale formed from the input locale 7666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * plus input keyword and that value has different behavior than creation with the 7676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * input locale alone. 7686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param keyword one of the keys supported by this service. For now, only 7696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * "collation" is supported. 7706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param locale the locale 7716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param commonlyUsed if set to true it will return only commonly used values 7726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * with the given locale in preferred order. Otherwise, 7736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * it will return all the available values for the locale. 7746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status ICU status 7756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return a string enumeration over keyword values for the given key and the locale. 7766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 4.2 7776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 7786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static StringEnumeration* U_EXPORT2 getKeywordValuesForLocale(const char* keyword, const Locale& locale, 7796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBool commonlyUsed, UErrorCode& status); 7806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 7816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 7826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Return the functionally equivalent locale for the given 7836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * requested locale, with respect to given keyword, for the 7846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * collation service. If two locales return the same result, then 7856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * collators instantiated for these locales will behave 7866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * equivalently. The converse is not always true; two collators 7876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * may in fact be equivalent, but return different results, due to 7886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * internal details. The return result has no other meaning than 7896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * that stated above, and implies nothing as to the relationship 7906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * between the two locales. This is intended for use by 7916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * applications who wish to cache collators, or otherwise reuse 7926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * collators when possible. The functional equivalent may change 7936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * over time. For more information, please see the <a 7946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * href="http://icu-project.org/userguide/locale.html#services"> 7956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Locales and Services</a> section of the ICU User Guide. 7966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param keyword a particular keyword as enumerated by 7976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * ucol_getKeywords. 7986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param locale the requested locale 7996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param isAvailable reference to a fillin parameter that 8006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * indicates whether the requested locale was 'available' to the 8016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * collation service. A locale is defined as 'available' if it 8026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * physically exists within the collation locale data. 8036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status reference to input-output error code 8046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return the functionally equivalent collation locale, or the root 8056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * locale upon error. 8066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.0 8076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 8086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static Locale U_EXPORT2 getFunctionalEquivalent(const char* keyword, const Locale& locale, 8096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UBool& isAvailable, UErrorCode& status); 8106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 8116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#if !UCONFIG_NO_SERVICE 8126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 8136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Register a new Collator. The collator will be adopted. 8146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param toAdopt the Collator instance to be adopted 8156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param locale the locale with which the collator will be associated 8166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status the in/out status code, no special meanings are assigned 8176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return a registry key that can be used to unregister this collator 8186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.6 8196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 8206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static URegistryKey U_EXPORT2 registerInstance(Collator* toAdopt, const Locale& locale, UErrorCode& status); 8216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 8226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 8236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Register a new CollatorFactory. The factory will be adopted. 8246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param toAdopt the CollatorFactory instance to be adopted 8256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status the in/out status code, no special meanings are assigned 8266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return a registry key that can be used to unregister this collator 8276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.6 8286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 8296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static URegistryKey U_EXPORT2 registerFactory(CollatorFactory* toAdopt, UErrorCode& status); 8306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 8316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 8326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Unregister a previously-registered Collator or CollatorFactory 8336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * using the key returned from the register call. Key becomes 8346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * invalid after a successful call and should not be used again. 8356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The object corresponding to the key will be deleted. 8366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param key the registry key returned by a previous call to registerInstance 8376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status the in/out status code, no special meanings are assigned 8386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return TRUE if the collator for the key was successfully unregistered 8396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.6 8406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 8416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static UBool U_EXPORT2 unregister(URegistryKey key, UErrorCode& status); 8426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#endif /* UCONFIG_NO_SERVICE */ 8436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 8446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 8456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Gets the version information for a Collator. 8466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param info the version # information, the result will be filled in 8476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 8486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 8496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual void getVersion(UVersionInfo info) const = 0; 8506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 8516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 8526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Returns a unique class ID POLYMORPHICALLY. Pure virtual method. 8536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This method is to implement a simple version of RTTI, since not all C++ 8546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * compilers support genuine RTTI. Polymorphic operator==() and clone() 8556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * methods call this method. 8566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The class ID for this object. All objects of a given class have 8576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * the same class ID. Objects of other classes have different class 8586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * IDs. 8596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 8606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 8616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual UClassID getDynamicClassID(void) const = 0; 8626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 8636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 8646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Universal attribute setter 8656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param attr attribute type 8666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param value attribute value 8676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status to indicate whether the operation went on smoothly or 8686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * there were errors 8696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.2 8706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 8716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual void setAttribute(UColAttribute attr, UColAttributeValue value, 8726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode &status) = 0; 8736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 8746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 8756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Universal attribute getter 8766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param attr attribute type 8776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status to indicate whether the operation went on smoothly or 8786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * there were errors 8796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return attribute value 8806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.2 8816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 8826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual UColAttributeValue getAttribute(UColAttribute attr, 8836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode &status) const = 0; 8846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 8856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 8866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Sets the variable top to a collation element value of a string supplied. 8876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param varTop one or more (if contraction) UChars to which the variable top should be set 8886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param len length of variable top string. If -1 it is considered to be zero terminated. 8896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status error code. If error code is set, the return value is undefined. Errors set by this function are: <br> 8906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * U_CE_NOT_FOUND_ERROR if more than one character was passed and there is no such a contraction<br> 8916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * U_PRIMARY_TOO_LONG_ERROR if the primary for the variable top has more than two bytes 8926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return a 32 bit value containing the value of the variable top in upper 16 bits. Lower 16 bits are undefined 8936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 8946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 8956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual uint32_t setVariableTop(const UChar *varTop, int32_t len, UErrorCode &status) = 0; 8966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 8976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 8986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Sets the variable top to a collation element value of a string supplied. 8996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param varTop an UnicodeString size 1 or more (if contraction) of UChars to which the variable top should be set 9006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status error code. If error code is set, the return value is undefined. Errors set by this function are: <br> 9016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * U_CE_NOT_FOUND_ERROR if more than one character was passed and there is no such a contraction<br> 9026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * U_PRIMARY_TOO_LONG_ERROR if the primary for the variable top has more than two bytes 9036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return a 32 bit value containing the value of the variable top in upper 16 bits. Lower 16 bits are undefined 9046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 9056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 9066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual uint32_t setVariableTop(const UnicodeString &varTop, UErrorCode &status) = 0; 9076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 9086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 9096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Sets the variable top to a collation element value supplied. Variable top is set to the upper 16 bits. 9106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Lower 16 bits are ignored. 9116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param varTop CE value, as returned by setVariableTop or ucol)getVariableTop 9126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status error code (not changed by function) 9136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 9146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 9156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual void setVariableTop(uint32_t varTop, UErrorCode &status) = 0; 9166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 9176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 9186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Gets the variable top value of a Collator. 9196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Lower 16 bits are undefined and should be ignored. 9206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status error code (not changed by function). If error code is set, the return value is undefined. 9216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 9226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 9236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual uint32_t getVariableTop(UErrorCode &status) const = 0; 9246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 9256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 9266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get an UnicodeSet that contains all the characters and sequences 9276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * tailored in this collator. 9286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status error code of the operation 9296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return a pointer to a UnicodeSet object containing all the 9306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * code points and sequences that may sort differently than 9316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in the UCA. The object must be disposed of by using delete 9326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.4 9336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 9346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual UnicodeSet *getTailoredSet(UErrorCode &status) const; 9356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 9366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 9376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Same as clone(). 9386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The base class implementation simply calls clone(). 9396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return a copy of this object, owned by the caller 9406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see clone() 9416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @deprecated ICU 50 no need to have two methods for cloning 9426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 9436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual Collator* safeClone(void) const; 9446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 9456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 9466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the sort key as an array of bytes from an UnicodeString. 9476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Sort key byte arrays are zero-terminated and can be compared using 9486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * strcmp(). 9496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source string to be processed. 9506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param result buffer to store result in. If NULL, number of bytes needed 9516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * will be returned. 9526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param resultLength length of the result buffer. If if not enough the 9536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * buffer will be filled to capacity. 9546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return Number of bytes needed for storing the sort key 9556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.2 9566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 9576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual int32_t getSortKey(const UnicodeString& source, 9586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org uint8_t* result, 9596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t resultLength) const = 0; 9606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 9616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 9626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Get the sort key as an array of bytes from an UChar buffer. 9636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Sort key byte arrays are zero-terminated and can be compared using 9646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * strcmp(). 9656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source string to be processed. 9666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param sourceLength length of string to be processed. 9676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If -1, the string is 0 terminated and length will be decided by the 9686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * function. 9696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param result buffer to store result in. If NULL, number of bytes needed 9706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * will be returned. 9716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param resultLength length of the result buffer. If if not enough the 9726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * buffer will be filled to capacity. 9736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return Number of bytes needed for storing the sort key 9746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.2 9756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 9766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual int32_t getSortKey(const UChar*source, int32_t sourceLength, 9776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org uint8_t*result, int32_t resultLength) const = 0; 9786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 9796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 9806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Produce a bound for a given sortkey and a number of levels. 9816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Return value is always the number of bytes needed, regardless of 9826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * whether the result buffer was big enough or even valid.<br> 9836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Resulting bounds can be used to produce a range of strings that are 9846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * between upper and lower bounds. For example, if bounds are produced 9856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * for a sortkey of string "smith", strings between upper and lower 9866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * bounds with one level would include "Smith", "SMITH", "sMiTh".<br> 9876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * There are two upper bounds that can be produced. If UCOL_BOUND_UPPER 9886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is produced, strings matched would be as above. However, if bound 9896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * produced using UCOL_BOUND_UPPER_LONG is used, the above example will 9906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * also match "Smithsonian" and similar.<br> 9916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * For more on usage, see example in cintltst/capitst.c in procedure 9926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * TestBounds. 9936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Sort keys may be compared using <TT>strcmp</TT>. 9946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param source The source sortkey. 9956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param sourceLength The length of source, or -1 if null-terminated. 9966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * (If an unmodified sortkey is passed, it is always null 9976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * terminated). 9986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param boundType Type of bound required. It can be UCOL_BOUND_LOWER, which 9996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * produces a lower inclusive bound, UCOL_BOUND_UPPER, that 10006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * produces upper bound that matches strings of the same length 10016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * or UCOL_BOUND_UPPER_LONG that matches strings that have the 10026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * same starting substring as the source string. 10036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param noOfLevels Number of levels required in the resulting bound (for most 10046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * uses, the recommended value is 1). See users guide for 10056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * explanation on number of levels a sortkey can have. 10066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param result A pointer to a buffer to receive the resulting sortkey. 10076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param resultLength The maximum size of result. 10086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status Used for returning error code if something went wrong. If the 10096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * number of levels requested is higher than the number of levels 10106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in the source key, a warning (U_SORT_KEY_TOO_SHORT_WARNING) is 10116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * issued. 10126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return The size needed to fully store the bound. 10136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ucol_keyHashCode 10146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.1 10156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 10166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static int32_t U_EXPORT2 getBound(const uint8_t *source, 10176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t sourceLength, 10186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UColBoundMode boundType, 10196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org uint32_t noOfLevels, 10206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org uint8_t *result, 10216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t resultLength, 10226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode &status); 10236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 10246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 10256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgprotected: 10266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 10276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org // Collator protected constructors ------------------------------------- 10286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 10296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 10306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Default constructor. 10316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Constructor is different from the old default Collator constructor. 10326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The task for determing the default collation strength and normalization 10336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * mode is left to the child class. 10346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 10356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 10366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org Collator(); 10376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 10386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#ifndef U_HIDE_DEPRECATED_API 10396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 10406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Constructor. 10416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Empty constructor, does not handle the arguments. 10426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This constructor is done for backward compatibility with 1.7 and 1.8. 10436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The task for handling the argument collation strength and normalization 10446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * mode is left to the child class. 10456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param collationStrength collation strength 10466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param decompositionMode 10476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @deprecated ICU 2.4. Subclasses should use the default constructor 10486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * instead and handle the strength and normalization mode themselves. 10496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 10506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org Collator(UCollationStrength collationStrength, 10516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UNormalizationMode decompositionMode); 10526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#endif /* U_HIDE_DEPRECATED_API */ 10536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 10546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 10556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Copy constructor. 10566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param other Collator object to be copied from 10576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.0 10586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 10596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org Collator(const Collator& other); 10606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 10616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org // Collator protected methods ----------------------------------------- 10626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 10636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 10646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 10656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Used internally by registraton to define the requested and valid locales. 10666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param requestedLocale the requested locale 10676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param validLocale the valid locale 10686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param actualLocale the actual locale 10696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @internal 10706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 10716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual void setLocales(const Locale& requestedLocale, const Locale& validLocale, const Locale& actualLocale); 10726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 10736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgpublic: 10746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#if !UCONFIG_NO_SERVICE 10756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#ifndef U_HIDE_INTERNAL_API 10766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 10776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * used only by ucol_open, not for public use 10786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @internal 10796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 10806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static UCollator* createUCollator(const char* loc, UErrorCode* status); 10816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#endif /* U_HIDE_INTERNAL_API */ 10826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#endif 10836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 10846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** Get the short definition string for a collator. This internal API harvests the collator's 10856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * locale and the attribute set and produces a string that can be used for opening 10866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * a collator with the same properties using the ucol_openFromShortString API. 10876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This string will be normalized. 10886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The structure and the syntax of the string is defined in the "Naming collators" 10896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * section of the users guide: 10906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * http://icu-project.org/userguide/Collate_Concepts.html#Naming_Collators 10916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This function supports preflighting. 10926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 10936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * This is internal, and intended to be used with delegate converters. 10946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 10956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param locale a locale that will appear as a collators locale in the resulting 10966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * short string definition. If NULL, the locale will be harvested 10976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * from the collator. 10986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param buffer space to hold the resulting string 10996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param capacity capacity of the buffer 11006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status for returning errors. All the preflighting errors are featured 11016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return length of the resulting string 11026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ucol_openFromShortString 11036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ucol_normalizeShortDefinitionString 11046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @see ucol_getShortDefinitionString 11056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @internal 11066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 11076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual int32_t internalGetShortDefinitionString(const char *locale, 11086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org char *buffer, 11096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org int32_t capacity, 11106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode &status) const; 11116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgprivate: 11126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 11136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Assignment operator. Private for now. 11146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @internal 11156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 11166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org Collator& operator=(const Collator& other); 11176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 11186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org friend class CFactory; 11196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org friend class SimpleCFactory; 11206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org friend class ICUCollatorFactory; 11216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org friend class ICUCollatorService; 11226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org static Collator* makeInstance(const Locale& desiredLocale, 11236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UErrorCode& status); 11246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 11256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org // Collator private data members --------------------------------------- 11266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 11276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /* 11286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org synwee : removed as attributes to be handled by child class 11296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UCollationStrength strength; 11306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org Normalizer::EMode decmp; 11316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 11326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /* This is useless information */ 11336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/* static const UVersionInfo fVersion;*/ 11346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org}; 11356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 11366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#if !UCONFIG_NO_SERVICE 11376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 11386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * A factory, used with registerFactory, the creates multiple collators and provides 11396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * display names for them. A factory supports some number of locales-- these are the 11406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * locales for which it can create collators. The factory can be visible, in which 11416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * case the supported locales will be enumerated by getAvailableLocales, or invisible, 11426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * in which they are not. Invisible locales are still supported, they are just not 11436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * listed by getAvailableLocales. 11446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p> 11456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If standard locale display names are sufficient, Collator instances can 11466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * be registered using registerInstance instead.</p> 11476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * <p> 11486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Note: if the collators are to be used from C APIs, they must be instances 11496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * of RuleBasedCollator.</p> 11506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 11516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.6 11526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 11536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgclass U_I18N_API CollatorFactory : public UObject { 11546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgpublic: 11556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 11566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 11576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Destructor 11586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 3.0 11596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 11606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual ~CollatorFactory(); 11616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 11626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 11636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Return true if this factory is visible. Default is true. 11646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If not visible, the locales supported by this factory will not 11656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * be listed by getAvailableLocales. 11666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return true if the factory is visible. 11676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.6 11686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 11696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual UBool visible(void) const; 11706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 11716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 11726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Return a collator for the provided locale. If the locale 11736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * is not supported, return NULL. 11746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param loc the locale identifying the collator to be created. 11756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return a new collator if the locale is supported, otherwise NULL. 11766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.6 11776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 11786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual Collator* createCollator(const Locale& loc) = 0; 11796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 11806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 11816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Return the name of the collator for the objectLocale, localized for the displayLocale. 11826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If objectLocale is not supported, or the factory is not visible, set the result string 11836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to bogus. 11846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param objectLocale the locale identifying the collator 11856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param displayLocale the locale for which the display name of the collator should be localized 11866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param result an output parameter for the display name, set to bogus if not supported. 11876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return the display name 11886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.6 11896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 11906f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual UnicodeString& getDisplayName(const Locale& objectLocale, 11916f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org const Locale& displayLocale, 11926f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UnicodeString& result); 11936f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 11946f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org /** 11956f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Return an array of all the locale names directly supported by this factory. 11966f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The number of names is returned in count. This array is owned by the factory. 11976f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Its contents must never change. 11986f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param count output parameter for the number of locales supported by the factory 11996f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param status the in/out error code 12006f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @return a pointer to an array of count UnicodeStrings. 12016f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @stable ICU 2.6 12026f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 12036f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org virtual const UnicodeString * getSupportedIDs(int32_t &count, UErrorCode& status) = 0; 12046f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org}; 12056f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#endif /* UCONFIG_NO_SERVICE */ 12066f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 12076f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org// Collator inline methods ----------------------------------------------- 12086f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 12096f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_NAMESPACE_END 12106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 12116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#endif /* #if !UCONFIG_NO_COLLATION */ 12126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 12136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#endif 1214