blob: f463957fd4f2d861db2f7758950e2853b6a93f49 [file] [log] [blame]
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use:
* Copyright (C) 1998-2014, International Business Machines
* Corporation and others. All Rights Reserved.
* Private implementation header for C collation
* file name: ucol_imp.h
* encoding: UTF-8
* tab size: 8 (not used)
* indentation:4
* created on: 2000dec11
* created by: Vladimir Weinstein
* Modification history
* Date Name Comments
* 02/16/2001 synwee Added UCOL_GETPREVCE for the use in ucoleitr
* 02/27/2001 synwee Added getMaxExpansion data structure in UCollator
* 03/02/2001 synwee Added UCOL_IMPLICIT_CE
* 03/12/2001 synwee Added pointer start to collIterate.
#ifndef UCOL_IMP_H
#define UCOL_IMP_H
#include "unicode/utypes.h"
// This part needs to compile as plain C code, for cintltst.
#include "unicode/ucol.h"
/** Check whether two collators are equal. Collators are considered equal if they
* will sort strings the same. This means that both the current attributes and the
* rules must be equivalent.
* @param source first collator
* @param target second collator
* @return true or false
* @internal ICU 3.0
ucol_equals(const UCollator *source, const UCollator *target);
* Convenience string denoting the Collation data tree
#ifdef __cplusplus
#include "unicode/locid.h"
#include "unicode/ures.h"
struct CollationCacheEntry;
class Locale;
class UnicodeString;
class UnifiedCache;
/** Implemented in ucol_res.cpp. */
class CollationLoader {
static void appendRootRules(UnicodeString &s);
static void loadRules(const char *localeID, const char *collationType,
UnicodeString &rules, UErrorCode &errorCode);
// Adds a reference to returned value.
static const CollationCacheEntry *loadTailoring(const Locale &locale, UErrorCode &errorCode);
// Cache callback. Adds a reference to returned value.
const CollationCacheEntry *createCacheEntry(UErrorCode &errorCode);
static void U_CALLCONV loadRootRules(UErrorCode &errorCode);
// The following members are used by loadTailoring()
// and the cache callback.
static const uint32_t TRIED_SEARCH = 1;
static const uint32_t TRIED_DEFAULT = 2;
static const uint32_t TRIED_STANDARD = 4;
CollationLoader(const CollationCacheEntry *re, const Locale &requested, UErrorCode &errorCode);
// All loadFromXXX methods add a reference to the returned value.
const CollationCacheEntry *loadFromLocale(UErrorCode &errorCode);
const CollationCacheEntry *loadFromBundle(UErrorCode &errorCode);
const CollationCacheEntry *loadFromCollations(UErrorCode &errorCode);
const CollationCacheEntry *loadFromData(UErrorCode &errorCode);
// Adds a reference to returned value.
const CollationCacheEntry *getCacheEntry(UErrorCode &errorCode);
* Returns the rootEntry (with one addRef()) if loc==root,
* or else returns a new cache entry with ref count 1 for the loc and
* the root tailoring.
const CollationCacheEntry *makeCacheEntryFromRoot(
const Locale &loc, UErrorCode &errorCode) const;
* Returns the entryFromCache as is if loc==validLocale,
* or else returns a new cache entry with ref count 1 for the loc and
* the same tailoring. In the latter case, a ref count is removed from
* entryFromCache.
static const CollationCacheEntry *makeCacheEntry(
const Locale &loc,
const CollationCacheEntry *entryFromCache,
UErrorCode &errorCode);
const UnifiedCache *cache;
const CollationCacheEntry *rootEntry;
Locale validLocale;
Locale locale;
char type[16];
char defaultType[16];
uint32_t typesTried;
UBool typeFallback;
UResourceBundle *bundle;
UResourceBundle *collations;
UResourceBundle *data;
#endif /* __cplusplus */
#endif /* #if !UCONFIG_NO_COLLATION */