/*
*******************************************************************************
*
* Copyright (C) 2011 International Business Machines
* Corporation and others. All Rights Reserved.
*
*******************************************************************************
*/
#ifndef INDEXCHARS_H
#define INDEXCHARS_H
#include "unicode/utypes.h"
#include "unicode/uobject.h"
#include "unicode/locid.h"
/**
* \file
* \brief C++ API: Index Characters
*/
U_CDECL_BEGIN
/**
* Constants for Alphabetic Index Label Types.
* The form of these enum constants anticipates having a plain C API
* for Alphabetic Indexes that will also use them.
* @draft ICU 4.8
*/
typedef enum UAlphabeticIndexLabelType {
/**
* Normal Label, typically the starting letter of the names
* in the bucket with this label.
* @draft ICU 4.8
*/
U_ALPHAINDEX_NORMAL = 0,
/**
* Undeflow Label. The bucket with this label contains names
* in scripts that sort before any of the bucket labels in this index.
* @draft ICU 4.8
*/
U_ALPHAINDEX_UNDERFLOW = 1,
/**
* Inflow Label. The bucket with this label contains names
* in scripts that sort between two of the bucket labels in this index.
* Inflow labels are created when an index contains normal labels for
* multiple scripts, and skips other scripts that sort between some of the
* included scripts.
* @draft ICU 4.8
*/
U_ALPHAINDEX_INFLOW = 2,
/**
* Overflow Label. Te bucket with this label contains names in scripts
* that sort after all of the bucket labels in this index.
* @draft ICU 4.8
*/
U_ALPHAINDEX_OVERFLOW = 3
} UAlphabeticIndexLabelType;
struct UHashtable;
U_CDECL_END
U_NAMESPACE_BEGIN
// Forward Declarations
class Collator;
class RuleBasedCollator;
class StringEnumeration;
class UnicodeSet;
class UVector;
/**
* class AlphabeticIndex supports the creation of a UI index appropriate for a given language, such as:
*
*
* ... A B C D E F G H I J K L M N O P Q R S T U V W X Y Z \u00C6 \u00D8 \u00C5 ...
*
* A
* Addison
* Albertson
* Azensky
* B
* Baker
* ...
*
*
* The class can generate a list of labels for use as a UI "index", that is, a list of
* clickable characters (or character sequences) that allow the user to see a segment
* (bucket) of a larger "target" list. That is, each label corresponds to a bucket in
* the target list, where everything in the bucket is greater than or equal to the character
* (according to the locale's collation). Strings can be added to the index;
* they will be in sorted order in the right bucket.
*
* The class also supports having buckets for strings before the first (underflow),
* after the last (overflow), and between scripts (inflow). For example, if the index
* is constructed with labels for Russian and English, Greek characters would fall
* into an inflow bucket between the other two scripts.
*
* The AlphabeticIndex class is not intended for public subclassing.
*
* Example
*
* The "show..." methods below are just to illustrate usage.
*
*
* // Create a simple index. "Item" is assumed to be an application
* // defined type that the application's UI and other processing knows about,
* // and that has a name.
*
* UErrorCode status = U_ZERO_ERROR;
* AlphabeticIndex index = new AlphabeticIndex(desiredLocale, status);
* index->addLabels(additionalLocale, status);
* for (Item *item in some source of Items ) {
* index->addRecord(item->name(), item, status);
* }
* ...
* // Show index at top. We could skip or gray out empty buckets
*
* while (index->nextBucket(status)) {
* if (showAll || index->getBucketRecordCount() != 0) {
* showLabelAtTop(UI, index->getBucketLabel());
* }
* }
* ...
* // Show the buckets with their contents, skipping empty buckets
*
* index->resetBucketIterator(status);
* while (index->nextBucket(status)) {
* if (index->getBucketRecordCount() != 0) {
* showLabelInList(UI, index->getBucketLabel());
* while (index->nextRecord(status)) {
* showIndexedItem(UI, static_cast- (index->getRecordData()))
*
*
* The caller can build different UIs using this class.
* For example, an index character could be omitted or grayed-out
* if its bucket is empty. Small buckets could also be combined based on size, such as:
*
*
* ... A-F G-N O-Z ...
*
*
*
* Notes:
*
* - Additional collation parameters can be passed in as part of the locale name.
* For example, German plus numeric
* sorting would be "de@kn-true".
*
* @draft ICU 4.8
* @provisional This API might change or be removed in a future release.
*/
class U_I18N_API AlphabeticIndex: public UObject {
public:
/**
* Construct an AlphabeticIndex object for the specified locale. If the locale's
* data does not include index characters, a set of them will be
* synthesized based on the locale's exemplar characters. The locale
* determines the sorting order for both the index characters and the
* user item names appearing under each Index character.
*
* @param locale the desired locale.
* @param status Error code, will be set with the reason if the construction
* of the AlphabeticIndex object fails.
* @draft ICU 4.8
*/
AlphabeticIndex(const Locale &locale, UErrorCode &status);
/**
* Add Labels to this Index. The labels are additions to those
* that are already in the index; they do not replace the existing
* ones.
* @param additions The additional characters to add to the index, such as A-Z.
* @param status Error code, will be set with the reason if the
* operation fails.
* @return this, for chaining
* @draft ICU 4.8
*/
virtual AlphabeticIndex &addLabels(const UnicodeSet &additions, UErrorCode &status);
/**
* Add the index characters from a Locale to the index. The labels
* are added to those that are already in the index; they do not replace the
* existing index characters. The collation order for this index is not
* changed; it remains that of the locale that was originally specified
* when creating this Index.
*
* @param locale The locale whose index characters are to be added.
* @param status Error code, will be set with the reason if the
* operation fails.
* @return this, for chaining
* @draft ICU 4.8
*/
virtual AlphabeticIndex &addLabels(const Locale &locale, UErrorCode &status);
/**
* Destructor
*/
virtual ~AlphabeticIndex();
/**
* Get the Collator that establishes the ordering of the items in this index.
* Ownership of the collator remains with the AlphabeticIndex instance.
*
* The returned collator is a reference to the internal collator used by this
* index. It may be safely used to compare the names of items or to get
* sort keys for names. However if any settings need to be changed,
* or other non-const methods called, a cloned copy must be made first.
*
* @return The collator
* @draft ICU 4.8
*/
virtual const RuleBasedCollator &getCollator() const;
/**
* Get the default label used for abbreviated buckets between other index characters.
* For example, consider the labels when Latin and Greek are used:
* X Y Z ... Α Β Γ.
*
* @return inflow label
* @draft ICU 4.8
*/
virtual const UnicodeString &getInflowLabel() const;
/**
* Set the default label used for abbreviated buckets between other index characters.
* An inflow label will be automatically inserted if two otherwise-adjacent label characters
* are from different scripts, e.g. Latin and Cyrillic, and a third script, e.g. Greek,
* sorts between the two. The default inflow character is an ellipsis (...)
*
* @param inflowLabel the new Inflow label.
* @param status Error code, will be set with the reason if the operation fails.
* @return this
* @draft ICU 4.8
*/
virtual AlphabeticIndex &setInflowLabel(const UnicodeString &inflowLabel, UErrorCode &status);
/**
* Get the special label used for items that sort after the last normal label,
* and that would not otherwise have an appropriate label.
*
* @return the overflow label
* @draft ICU 4.8
*/
virtual const UnicodeString &getOverflowLabel() const;
/**
* Set the label used for items that sort after the last normal label,
* and that would not otherwise have an appropriate label.
*
* @param overflowLabel the new overflow label.
* @param status Error code, will be set with the reason if the operation fails.
* @return this
* @draft ICU 4.8
*/
virtual AlphabeticIndex &setOverflowLabel(const UnicodeString &overflowLabel, UErrorCode &status);
/**
* Get the special label used for items that sort before the first normal label,
* and that would not otherwise have an appropriate label.
*
* @return underflow label
* @draft ICU 4.8
*/
virtual const UnicodeString &getUnderflowLabel() const;
/**
* Set the label used for items that sort before the first normal label,
* and that would not otherwise have an appropriate label.
*
* @param underflowLabel the new underflow label.
* @param status Error code, will be set with the reason if the operation fails.
* @return this
* @draft ICU 4.8
*/
virtual AlphabeticIndex &setUnderflowLabel(const UnicodeString &underflowLabel, UErrorCode &status);
/**
* Get the limit on the number of labels permitted in the index.
* The number does not include over, under and inflow labels.
*
* @return maxLabelCount maximum number of labels.
* @draft ICU 4.8
*/
virtual int32_t getMaxLabelCount() const;
/**
* Set a limit on the number of labels permitted in the index.
* The number does not include over, under and inflow labels.
* Currently, if the number is exceeded, then every
* nth item is removed to bring the count down.
* A more sophisticated mechanism may be available in the future.
*
* @param maxLabelCount the maximum number of labels.
* @return This, for chaining
* @draft ICU 4.8
*/
virtual AlphabeticIndex &setMaxLabelCount(int32_t maxLabelCount, UErrorCode &status);
/**
* Get the Unicode character (or tailored string) that defines an overflow bucket;
* that is anything greater than or equal to that string should go in that bucket,
* instead of with the last character. Normally that is the first character of the script
* after lowerLimit. Thus in X Y Z ... Devanagari-ka, the overflow character for Z
* would be the Greek-alpha.
*
* @param lowerLimit The character below the overflow (or inflow) bucket
* @return string that defines top of the overflow buck for lowerLimit, or an empty string if there is none
* @internal
*/
virtual const UnicodeString &getOverflowComparisonString(const UnicodeString &lowerLimit,
UErrorCode &status);
/**
* Add a record to the index. Each record will be associated with an index Bucket
* based on the record's name. The list of records for each bucket will be sorted
* based on the collation ordering of the names in the index's locale.
* Records with duplicate names are permitted; they will be kept in the order
* that they were added.
*
* @param name The display name for the Record. The Record will be placed in
* a bucket based on this name.
* @param data An optional pointer to user data associated with this
* item. When iterating the contents of a bucket, both the
* data pointer the name will be available for each Record.
* @param status Error code, will be set with the reason if the operation fails.
* @return This, for chaining.
* @draft ICU 4.8
*/
virtual AlphabeticIndex &addRecord(const UnicodeString &name, const void *data, UErrorCode &status);
/**
* Remove all Records from the Index. The set of Buckets, which define the headings under
* which records are classified, is not altered.
*
* @param status Error code, will be set with the reason if the operation fails.
* @return This, for chaining.
* @draft ICU 4.8
*/
virtual AlphabeticIndex &clearRecords(UErrorCode &status);
/** Get the number of labels in this index.
* Note: may trigger lazy index construction.
*
* @param status Error code, will be set with the reason if the operation fails.
* @return The number of labels in this index, including any under, over or
* in-flow labels.
* @draft ICU 4.8
*/
virtual int32_t getBucketCount(UErrorCode &status);
/** Get the total number of Records in this index, that is, the number
* of pairs added.
*
* @param status Error code, will be set with the reason if the operation fails.
* @return The number of records in this index, that is, the total number
* of (name, data) items added with addRecord().
* @draft ICU 4.8
*/
virtual int32_t getRecordCount(UErrorCode &status);
/**
* Given the name of a record, return the zero-based index of the Bucket
* in which the item should appear. The name need not be in the index.
* A Record will not be added to the index by this function.
* Bucket numbers are zero-based, in Bucket iteration order.
*
* @param name The name whose bucket position in the index is to be determined.
* @param status Error code, will be set with the reason if the operation fails.
* @return The bucket number for this name.
* @draft ICU 4.8
*
*/
virtual int32_t getBucketIndex(const UnicodeString &itemName, UErrorCode &status);
/**
* Get the zero based index of the current Bucket from an iteration
* over the Buckets of this index. Return -1 if no iteration is in process.
* @return the index of the current Bucket
* @draft ICU 4.8
*/
virtual int32_t getBucketIndex() const;
/**
* Advance the iteration over the Buckets of this index. Return FALSE if
* there are no more Buckets.
*
* @param status Error code, will be set with the reason if the operation fails.
* U_ENUM_OUT_OF_SYNC_ERROR will be reported if the index is modified while
* an enumeration of its contents are in process.
*
* @return TRUE if success, FALSE if at end of iteration
* @draft ICU 4.8
*/
virtual UBool nextBucket(UErrorCode &status);
/**
* Return the name of the Label of the current bucket from an iteration over the buckets.
* If the iteration is before the first Bucket (nextBucket() has not been called),
* or after the last, return an empty string.
*
* @return the bucket label.
* @draft ICU 4.8
*/
virtual const UnicodeString &getBucketLabel() const;
/**
* Return the type of the label for the current Bucket (selected by the
* iteration over Buckets.)
*
* @return the label type.
* @draft ICU 4.8
*/
virtual UAlphabeticIndexLabelType getBucketLabelType() const;
/**
* Get the number of Records in the current Bucket.
* If the current bucket iteration position is before the first label or after the
* last, return 0.
*
* @return the number of Records.
* @draft ICU 4.8
*/
virtual int32_t getBucketRecordCount() const;
/**
* Reset the Bucket iteration for this index. The next call to nextBucket()
* will restart the iteration at the first label.
*
* @param status Error code, will be set with the reason if the operation fails.
* @return this, for chaining.
* @draft ICU 4.8
*/
virtual AlphabeticIndex &resetBucketIterator(UErrorCode &status);
/**
* Advance to the next record in the current Bucket.
* When nextBucket() is called, Record iteration is reset to just before the
* first Record in the new Bucket.
*
* @param status Error code, will be set with the reason if the operation fails.
* U_ENUM_OUT_OF_SYNC_ERROR will be reported if the index is modified while
* an enumeration of its contents are in process.
* @return TRUE if successful, FALSE when the iteration advances past the last item.
* @draft ICU 4.8
*/
virtual UBool nextRecord(UErrorCode &status);
/**
* Get the name of the current Record.
* Return an empty string if the Record iteration position is before first
* or after the last.
*
* @return The name of the current index item.
* @draft ICU 4.8
*/
virtual const UnicodeString &getRecordName() const;
/**
* Return the data pointer of the Record currently being iterated over.
* Return NULL if the current iteration position before the first item in this Bucket,
* or after the last.
*
* @return The current Record's data pointer.
* @draft ICU 4.8
*/
virtual const void *getRecordData() const;
/**
* Reset the Record iterator position to before the first Record in the current Bucket.
*
* @return This, for chaining.
* @draft ICU 4.8
*/
virtual AlphabeticIndex &resetRecordIterator();
private:
// No ICU "poor man's RTTI" for this class nor its subclasses.
virtual UClassID getDynamicClassID() const;
/**
* No Copy constructor.
* @internal
*/
AlphabeticIndex(const AlphabeticIndex &other);
/**
* No assignment.
*/
AlphabeticIndex &operator =(const AlphabeticIndex & /*other*/) { return *this;};
/**
* No Equality operators.
* @internal
*/
virtual UBool operator==(const AlphabeticIndex& other) const;
/**
* Inequality operator.
* @internal
*/
virtual UBool operator!=(const AlphabeticIndex& other) const;
// Common initialization, for use from all constructors.
void init(UErrorCode &status);
// Initialize & destruct static constants used by this class.
static void staticInit(UErrorCode &status);
// Pinyin stuff. If the input name is Chinese, add the Pinyin prefix to the dest string.
void hackName(UnicodeString &dest, const UnicodeString &name, const Collator *coll);
void initPinyinBounds(const Collator *coll, UErrorCode &status);
public:
/**
* Delete all shared (static) data associated with an AlphabeticIndex.
* Internal function, not intended for direct use.
* @internal.
*/
static void staticCleanup();
private:
// Add index characters from the specified locale to the dest set.
// Does not remove any previous contents from dest.
static void getIndexExemplars(UnicodeSet &dest, const Locale &locale, UErrorCode &status);
UVector *firstStringsInScript(UErrorCode &status);
static UnicodeString separated(const UnicodeString &item);
static UnicodeSet *getScriptSet(UnicodeSet &dest, const UnicodeString &codePoint, UErrorCode &status);
void buildIndex(UErrorCode &status);
void buildBucketList(UErrorCode &status);
void bucketRecords(UErrorCode &status);
public:
// The following internal items are declared public only to allow access from
// implementation code written in plain C. They are not intended for
// public use.
/**
* A record, or item, in the index.
* @internal
*/
struct Record: public UMemory {
AlphabeticIndex *alphaIndex_;
const UnicodeString name_;
UnicodeString sortingName_; // Usually the same as name_; different for Pinyin.
const void *data_;
int32_t serialNumber_; // Defines sorting order for names that compare equal.
Record(AlphabeticIndex *alphaIndex, const UnicodeString &name, const void *data);
~Record();
};
/**
* Holds all user records before they are distributed into buckets.
* Type of contents is (Record *)
* @internal
*/
UVector *inputRecords_;
/**
* A Bucket holds an index label and references to everything belonging to that label.
* For implementation use only. Declared public because pure C implementation code needs access.
* @internal
*/
struct Bucket: public UMemory {
UnicodeString label_;
UnicodeString lowerBoundary_;
UAlphabeticIndexLabelType labelType_;
UVector *records_; // Records are owned by inputRecords_ vector.
Bucket(const UnicodeString &label, // Parameter strings are copied.
const UnicodeString &lowerBoundary,
UAlphabeticIndexLabelType type, UErrorCode &status);
~Bucket();
};
public:
/**
* Language Types. For internal ICU use only.
* @internal
*/
enum ELangType {
/** @internal */
kNormal,
/** @internal */
kSimplified,
/** @internal */
kTraditional
};
/**
* Get the Language Type for this Index. Based on the locale.
* @internal
*/
static ELangType langTypeFromLocale(const Locale &loc);
private:
// Holds the contents of this index, buckets of user items.
// UVector elements are of type (Bucket *)
UVector *bucketList_;
int32_t labelsIterIndex_; // Index of next item to return.
int32_t itemsIterIndex_;
Bucket *currentBucket_; // While an iteration of the index in underway,
// point to the bucket for the current label.
// NULL when no iteration underway.
UBool indexBuildRequired_; // Caller has made changes to the index that
// require rebuilding & bucketing before the
// contents can be iterated.
int32_t maxLabelCount_; // Limit on # of labels permitted in the index.
UHashtable *alreadyIn_; // Key=UnicodeString, value=UnicodeSet
UnicodeSet *initialLabels_; // Initial (unprocessed) set of Labels. Union
// of those explicitly set by the user plus
// those from locales. Raw values, before
// crunching into bucket labels.
UVector *labels_; // List of Labels, after processing, sorting.
// Contents are (UnicodeString *)
UnicodeSet *noDistinctSorting_; // As the set of labels is built, strings may
// be discarded from the exemplars. This contains
// some of the discards, and is
// intended for debugging.
UnicodeSet *notAlphabetic_; // As the set of labels is built, strings may
// be discarded from the exemplars. This contains
// some of the discards, and is
// intended for debugging.
UVector *firstScriptCharacters_; // The first character from each script,
// in collation order.
Locale locale_;
Collator *collator_;
Collator *collatorPrimaryOnly_;
UnicodeString inflowLabel_;
UnicodeString overflowLabel_;
UnicodeString underflowLabel_;
UnicodeString overflowComparisonString_;
ELangType langType_; // The language type, simplified Chinese, Traditional Chinese,
// or not Chinese (Normal). Part of the Pinyin support
typedef const UChar PinyinLookup[24][3];
static PinyinLookup HACK_PINYIN_LOOKUP_SHORT;
static PinyinLookup HACK_PINYIN_LOOKUP_LONG;
// These will be lazily set to the short or long tables based on which
// Chinese collation has been configured into the ICU library.
static PinyinLookup *HACK_PINYIN_LOOKUP;
static const UChar *PINYIN_LOWER_BOUNDS;
int32_t recordCounter_; // Counts Records created. For minting record serial numbers.
// Constants. Lazily initialized the first time an AlphabeticIndex object is created.
static UnicodeSet *ALPHABETIC;
static UnicodeSet *CORE_LATIN;
static UnicodeSet *ETHIOPIC;
static UnicodeSet *HANGUL;
static UnicodeSet *IGNORE_SCRIPTS;
static UnicodeSet *TO_TRY;
static UnicodeSet *UNIHAN;
static const UnicodeString *EMPTY_STRING;
};
U_NAMESPACE_END
#endif