Gecko [ dallasfobana2023.variationbd.com ]

Name	Size	Permission
alphaindex.h	26.42 KB	-rw-r--r--
appendable.h	8.43 KB	-rw-r--r--
basictz.h	8.84 KB	-rw-r--r--
brkiter.h	27.64 KB	-rw-r--r--
bytestream.h	9.54 KB	-rw-r--r--
bytestrie.h	19.26 KB	-rw-r--r--
bytestriebuilder.h	7.02 KB	-rw-r--r--
calendar.h	105.06 KB	-rw-r--r--
caniter.h	7.37 KB	-rw-r--r--
casemap.h	25.26 KB	-rw-r--r--
char16ptr.h	7.16 KB	-rw-r--r--
chariter.h	24 KB	-rw-r--r--
choicfmt.h	23.85 KB	-rw-r--r--
coleitr.h	13.7 KB	-rw-r--r--
coll.h	55.59 KB	-rw-r--r--
compactdecimalformat.h	6.81 KB	-rw-r--r--
curramt.h	3.69 KB	-rw-r--r--
currpinf.h	7.24 KB	-rw-r--r--
currunit.h	3.99 KB	-rw-r--r--
datefmt.h	40.37 KB	-rw-r--r--
dbbi.h	1.11 KB	-rw-r--r--
dcfmtsym.h	20.1 KB	-rw-r--r--
decimfmt.h	87.82 KB	-rw-r--r--
docmain.h	6.96 KB	-rw-r--r--
dtfmtsym.h	37.64 KB	-rw-r--r--
dtintrv.h	3.78 KB	-rw-r--r--
dtitvfmt.h	46.56 KB	-rw-r--r--
dtitvinf.h	18.46 KB	-rw-r--r--
dtptngen.h	25.08 KB	-rw-r--r--
dtrule.h	8.62 KB	-rw-r--r--
edits.h	20.67 KB	-rw-r--r--
enumset.h	2.08 KB	-rw-r--r--
errorcode.h	4.78 KB	-rw-r--r--
fieldpos.h	8.63 KB	-rw-r--r--
filteredbrk.h	5.24 KB	-rw-r--r--
fmtable.h	24.36 KB	-rw-r--r--
format.h	12.44 KB	-rw-r--r--
formattedvalue.h	9.73 KB	-rw-r--r--
fpositer.h	2.98 KB	-rw-r--r--
gender.h	3.27 KB	-rw-r--r--
gregocal.h	31.57 KB	-rw-r--r--
icudataver.h	1.03 KB	-rw-r--r--
icuplug.h	11.88 KB	-rw-r--r--
idna.h	12.63 KB	-rw-r--r--
listformatter.h	9.42 KB	-rw-r--r--
localebuilder.h	10.54 KB	-rw-r--r--
localpointer.h	19.69 KB	-rw-r--r--
locdspnm.h	7.06 KB	-rw-r--r--
locid.h	44.94 KB	-rw-r--r--
measfmt.h	11.44 KB	-rw-r--r--
measunit.h	88.17 KB	-rw-r--r--
measure.h	4.26 KB	-rw-r--r--
messagepattern.h	33.65 KB	-rw-r--r--
msgfmt.h	44.04 KB	-rw-r--r--
normalizer2.h	33.97 KB	-rw-r--r--
normlzr.h	30.74 KB	-rw-r--r--
nounit.h	2.63 KB	-rw-r--r--
numberformatter.h	84.62 KB	-rw-r--r--
numberrangeformatter.h	29.93 KB	-rw-r--r--
numfmt.h	49.35 KB	-rw-r--r--
numsys.h	7.13 KB	-rw-r--r--
parseerr.h	3.08 KB	-rw-r--r--
parsepos.h	5.5 KB	-rw-r--r--
platform.h	27.1 KB	-rw-r--r--
plurfmt.h	25.18 KB	-rw-r--r--
plurrule.h	18.33 KB	-rw-r--r--
ptypes.h	3.49 KB	-rw-r--r--
putil.h	6.33 KB	-rw-r--r--
rbbi.h	26.42 KB	-rw-r--r--
rbnf.h	49.79 KB	-rw-r--r--
rbtz.h	15.47 KB	-rw-r--r--
regex.h	84.3 KB	-rw-r--r--
region.h	9.12 KB	-rw-r--r--
reldatefmt.h	22.37 KB	-rw-r--r--
rep.h	9.5 KB	-rw-r--r--
resbund.h	18.01 KB	-rw-r--r--
schriter.h	6.26 KB	-rw-r--r--
scientificnumberformatter.h	6.32 KB	-rw-r--r--
search.h	22.21 KB	-rw-r--r--
selfmt.h	14.24 KB	-rw-r--r--
simpleformatter.h	12.53 KB	-rw-r--r--
simpletz.h	45.3 KB	-rw-r--r--
smpdtfmt.h	70.9 KB	-rw-r--r--
sortkey.h	11.12 KB	-rw-r--r--
std_string.h	1015 B	-rw-r--r--
strenum.h	10.04 KB	-rw-r--r--
stringoptions.h	5.79 KB	-rw-r--r--
stringpiece.h	6.46 KB	-rw-r--r--
stringtriebuilder.h	15.27 KB	-rw-r--r--
stsearch.h	21.29 KB	-rw-r--r--
symtable.h	4.21 KB	-rw-r--r--
tblcoll.h	36.4 KB	-rw-r--r--
timezone.h	41.2 KB	-rw-r--r--
tmunit.h	3.29 KB	-rw-r--r--
tmutamt.h	4.8 KB	-rw-r--r--
tmutfmt.h	7.79 KB	-rw-r--r--
translit.h	65.76 KB	-rw-r--r--
tzfmt.h	42.82 KB	-rw-r--r--
tznames.h	16.79 KB	-rw-r--r--
tzrule.h	35.32 KB	-rw-r--r--
tztrans.h	6.07 KB	-rw-r--r--
ubidi.h	89.56 KB	-rw-r--r--
ubiditransform.h	12.65 KB	-rw-r--r--
ubrk.h	23.97 KB	-rw-r--r--
ucal.h	55.54 KB	-rw-r--r--
ucasemap.h	15.18 KB	-rw-r--r--
ucat.h	5.36 KB	-rw-r--r--
uchar.h	140.66 KB	-rw-r--r--
ucharstrie.h	21.06 KB	-rw-r--r--
ucharstriebuilder.h	7.14 KB	-rw-r--r--
uchriter.h	13.14 KB	-rw-r--r--
uclean.h	11.21 KB	-rw-r--r--
ucnv.h	83.09 KB	-rw-r--r--
ucnv_cb.h	6.59 KB	-rw-r--r--
ucnv_err.h	20.99 KB	-rw-r--r--
ucnvsel.h	6.14 KB	-rw-r--r--
ucol.h	61.39 KB	-rw-r--r--
ucoleitr.h	9.46 KB	-rw-r--r--
uconfig.h	12.05 KB	-rw-r--r--
ucpmap.h	5.58 KB	-rw-r--r--
ucptrie.h	22.29 KB	-rw-r--r--
ucsdet.h	14.67 KB	-rw-r--r--
ucurr.h	16.15 KB	-rw-r--r--
udat.h	60.81 KB	-rw-r--r--
udata.h	15.53 KB	-rw-r--r--
udateintervalformat.h	10.03 KB	-rw-r--r--
udatpg.h	25.94 KB	-rw-r--r--
udisplaycontext.h	5.89 KB	-rw-r--r--
uenum.h	7.78 KB	-rw-r--r--
ufieldpositer.h	4.36 KB	-rw-r--r--
uformattable.h	10.94 KB	-rw-r--r--
uformattedvalue.h	12.14 KB	-rw-r--r--
ugender.h	2 KB	-rw-r--r--
uidna.h	33.37 KB	-rw-r--r--
uiter.h	22.77 KB	-rw-r--r--
uldnames.h	10.45 KB	-rw-r--r--
ulistformatter.h	8.83 KB	-rw-r--r--
uloc.h	50.75 KB	-rw-r--r--
ulocdata.h	11.26 KB	-rw-r--r--
umachine.h	13.19 KB	-rw-r--r--
umisc.h	1.33 KB	-rw-r--r--
umsg.h	24.23 KB	-rw-r--r--
umutablecptrie.h	8.28 KB	-rw-r--r--
unifilt.h	3.63 KB	-rw-r--r--
unifunct.h	3.98 KB	-rw-r--r--
unimatch.h	6.04 KB	-rw-r--r--
unirepl.h	3.32 KB	-rw-r--r--
uniset.h	64.88 KB	-rw-r--r--
unistr.h	170.39 KB	-rw-r--r--
unorm.h	20.45 KB	-rw-r--r--
unorm2.h	24.66 KB	-rw-r--r--
unum.h	53.55 KB	-rw-r--r--
unumberformatter.h	25.19 KB	-rw-r--r--
unumsys.h	7.21 KB	-rw-r--r--
uobject.h	10.85 KB	-rw-r--r--
upluralrules.h	7.88 KB	-rw-r--r--
uregex.h	72.05 KB	-rw-r--r--
uregion.h	9.84 KB	-rw-r--r--
ureldatefmt.h	17.26 KB	-rw-r--r--
urename.h	131.4 KB	-rw-r--r--
urep.h	5.38 KB	-rw-r--r--
ures.h	36.54 KB	-rw-r--r--
uscript.h	26.87 KB	-rw-r--r--
usearch.h	38.12 KB	-rw-r--r--
uset.h	40 KB	-rw-r--r--
usetiter.h	9.49 KB	-rw-r--r--
ushape.h	18 KB	-rw-r--r--
uspoof.h	66.03 KB	-rw-r--r--
usprep.h	8.14 KB	-rw-r--r--
ustdio.h	38.54 KB	-rw-r--r--
ustream.h	1.8 KB	-rw-r--r--
ustring.h	72.47 KB	-rw-r--r--
ustringtrie.h	3.15 KB	-rw-r--r--
utext.h	58.11 KB	-rw-r--r--
utf.h	7.86 KB	-rw-r--r--
utf16.h	22.33 KB	-rw-r--r--
utf32.h	763 B	-rw-r--r--
utf8.h	29.96 KB	-rw-r--r--
utf_old.h	43.78 KB	-rw-r--r--
utmscale.h	13.78 KB	-rw-r--r--
utrace.h	13.89 KB	-rw-r--r--
utrans.h	25.54 KB	-rw-r--r--
utypes.h	30.38 KB	-rw-r--r--
uvernum.h	6.67 KB	-rw-r--r--
uversion.h	6.7 KB	-rw-r--r--
vtzone.h	20.17 KB	-rw-r--r--

Code Editor : sortkey.h

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
 *****************************************************************************
 * Copyright (C) 1996-2014, International Business Machines Corporation and others.
 * All Rights Reserved.
 *****************************************************************************
 *
 * File sortkey.h
 *
 * Created by: Helena Shih
 *
 * Modification History:
 *
 *  Date         Name          Description
 *
 *  6/20/97     helena      Java class name change.
 *  8/18/97     helena      Added internal API documentation.
 *  6/26/98     erm         Changed to use byte arrays and memcmp.
 *****************************************************************************
 */

#ifndef SORTKEY_H
#define SORTKEY_H

#include "unicode/utypes.h"

/**
 * \file 
 * \brief C++ API: Keys for comparing strings multiple times. 
 */
 
#if !UCONFIG_NO_COLLATION

#include "unicode/uobject.h"
#include "unicode/unistr.h"
#include "unicode/coll.h"

U_NAMESPACE_BEGIN

/* forward declaration */
class RuleBasedCollator;
class CollationKeyByteSink;

/**
 *
 * Collation keys are generated by the Collator class. Use the CollationKey objects
 * instead of Collator to compare strings multiple times. A CollationKey
 * preprocesses the comparison information from the Collator object to
 * make the comparison faster. If you are not going to comparing strings
 * multiple times, then using the Collator object is generally faster,
 * since it only processes as much of the string as needed to make a
 * comparison.
 * For example (with strength == tertiary)
 * When comparing "Abernathy" to "Baggins-Smythworthy", Collator
 * only needs to process a couple of characters, while a comparison
 * with CollationKeys will process all of the characters. On the other hand,
 * if you are doing a sort of a number of fields, it is much faster to use
 * CollationKeys, since you will be comparing strings multiple times.
 * Typical use of CollationKeys are in databases, where you store a CollationKey
 * in a hidden field, and use it for sorting or indexing.
 *
 * Example of use:
 * <pre>
 * \code
 * UErrorCode success = U_ZERO_ERROR;
 * Collator* myCollator = Collator::createInstance(success);
 * CollationKey* keys = new CollationKey [3];
 * myCollator->getCollationKey("Tom", keys[0], success );
 * myCollator->getCollationKey("Dick", keys[1], success );
 * myCollator->getCollationKey("Harry", keys[2], success );
 *
 * // Inside body of sort routine, compare keys this way:
 * CollationKey tmp;
 * if(keys[0].compareTo( keys[1] ) > 0 ) {
 * tmp = keys[0]; keys[0] = keys[1]; keys[1] = tmp;
 * }
 * //...
 * \endcode
 * </pre>
 * Because Collator::compare()'s algorithm is complex, it is faster to sort
 * long lists of words by retrieving collation keys with Collator::getCollationKey().
 * You can then cache the collation keys and compare them using CollationKey::compareTo().
 * 
 * Note: <code>Collator</code>s with different Locale,
 * CollationStrength and DecompositionMode settings will return different
 * CollationKeys for the same set of strings. Locales have specific
 * collation rules, and the way in which secondary and tertiary differences
 * are taken into account, for example, will result in different CollationKeys
 * for same strings.
 *

* @see          Collator
 * @see          RuleBasedCollator
 * @version      1.3 12/18/96
 * @author       Helena Shih
 * @stable ICU 2.0
 */
class U_I18N_API CollationKey : public UObject {
public:
    /**
    * This creates an empty collation key based on the null string.  An empty
    * collation key contains no sorting information.  When comparing two empty
    * collation keys, the result is Collator::EQUAL.  Comparing empty collation key
    * with non-empty collation key is always Collator::LESS.
    * @stable ICU 2.0
    */
    CollationKey();

/**
    * Creates a collation key based on the collation key values.
    * @param values the collation key values
    * @param count number of collation key values, including trailing nulls.
    * @stable ICU 2.0
    */
    CollationKey(const  uint8_t*    values,
                int32_t     count);

/**
    * Copy constructor.
    * @param other    the object to be copied.
    * @stable ICU 2.0
    */
    CollationKey(const CollationKey& other);

/**
    * Sort key destructor.
    * @stable ICU 2.0
    */
    virtual ~CollationKey();

/**
    * Assignment operator
    * @param other    the object to be copied.
    * @stable ICU 2.0
    */
    const   CollationKey&   operator=(const CollationKey& other);

/**
    * Compare if two collation keys are the same.
    * @param source the collation key to compare to.
    * @return Returns true if two collation keys are equal, false otherwise.
    * @stable ICU 2.0
    */
    UBool                   operator==(const CollationKey& source) const;

/**
    * Compare if two collation keys are not the same.
    * @param source the collation key to compare to.
    * @return Returns TRUE if two collation keys are different, FALSE otherwise.
    * @stable ICU 2.0
    */
    UBool                   operator!=(const CollationKey& source) const;

/**
    * Test to see if the key is in an invalid state. The key will be in an
    * invalid state if it couldn't allocate memory for some operation.
    * @return Returns TRUE if the key is in an invalid, FALSE otherwise.
    * @stable ICU 2.0
    */
    UBool                   isBogus(void) const;

/**
    * Returns a pointer to the collation key values. The storage is owned
    * by the collation key and the pointer will become invalid if the key
    * is deleted.
    * @param count the output parameter of number of collation key values,
    * including any trailing nulls.
    * @return a pointer to the collation key values.
    * @stable ICU 2.0
    */
    const    uint8_t*       getByteArray(int32_t& count) const;

#ifdef U_USE_COLLATION_KEY_DEPRECATES
    /**
    * Extracts the collation key values into a new array. The caller owns
    * this storage and should free it.
    * @param count the output parameter of number of collation key values,
    * including any trailing nulls.
    * @obsolete ICU 2.6. Use getByteArray instead since this API will be removed in that release.
    */
    uint8_t*                toByteArray(int32_t& count) const;
#endif

#ifndef U_HIDE_DEPRECATED_API 
    /**
    * Convenience method which does a string(bit-wise) comparison of the
    * two collation keys.
    * @param target target collation key to be compared with
    * @return Returns Collator::LESS if sourceKey &lt; targetKey,
    * Collator::GREATER if sourceKey > targetKey and Collator::EQUAL
    * otherwise.
    * @deprecated ICU 2.6 use the overload with error code
    */
    Collator::EComparisonResult compareTo(const CollationKey& target) const;
#endif  /* U_HIDE_DEPRECATED_API */

/**
    * Convenience method which does a string(bit-wise) comparison of the
    * two collation keys.
    * @param target target collation key to be compared with
    * @param status error code
    * @return Returns UCOL_LESS if sourceKey &lt; targetKey,
    * UCOL_GREATER if sourceKey > targetKey and UCOL_EQUAL
    * otherwise.
    * @stable ICU 2.6
    */
    UCollationResult compareTo(const CollationKey& target, UErrorCode &status) const;

/**
 * Creates an integer that is unique to the collation key. NOTE: this
 * is not the same as String.hashCode.
 * Example of use:
 * <pre>
 * . UErrorCode status = U_ZERO_ERROR;
 * . Collator *myCollation = Collator::createInstance(Locale::US, status);
 * . if (U_FAILURE(status)) return;
 * . CollationKey key1, key2;
 * . UErrorCode status1 = U_ZERO_ERROR, status2 = U_ZERO_ERROR;
 * . myCollation->getCollationKey("abc", key1, status1);
 * . if (U_FAILURE(status1)) { delete myCollation; return; }
 * . myCollation->getCollationKey("ABC", key2, status2);
 * . if (U_FAILURE(status2)) { delete myCollation; return; }
 * . // key1.hashCode() != key2.hashCode()
 * </pre>
 * @return the hash value based on the string's collation order.
 * @see UnicodeString#hashCode
 * @stable ICU 2.0
 */
 int32_t hashCode(void) const;

/**
     * ICU "poor man's RTTI", returns a UClassID for the actual class.
     * @stable ICU 2.2
     */
    virtual UClassID getDynamicClassID() const;

/**
     * ICU "poor man's RTTI", returns a UClassID for this class.
     * @stable ICU 2.2
     */
    static UClassID U_EXPORT2 getStaticClassID();

private:
    /**
     * Replaces the current bytes buffer with a new one of newCapacity
     * and copies length bytes from the old buffer to the new one.
     * @return the new buffer, or NULL if the allocation failed
     */
    uint8_t *reallocate(int32_t newCapacity, int32_t length);
    /**
     * Set a new length for a new sort key in the existing fBytes.
     */
    void setLength(int32_t newLength);

uint8_t *getBytes() {
        return (fFlagAndLength >= 0) ? fUnion.fStackBuffer : fUnion.fFields.fBytes;
    }
    const uint8_t *getBytes() const {
        return (fFlagAndLength >= 0) ? fUnion.fStackBuffer : fUnion.fFields.fBytes;
    }
    int32_t getCapacity() const {
        return (fFlagAndLength >= 0) ? (int32_t)sizeof(fUnion) : fUnion.fFields.fCapacity;
    }
    int32_t getLength() const { return fFlagAndLength & 0x7fffffff; }

/**
    * Set the CollationKey to a "bogus" or invalid state
    * @return this CollationKey
    */
    CollationKey&           setToBogus(void);
    /**
    * Resets this CollationKey to an empty state
    * @return this CollationKey
    */
    CollationKey&           reset(void);

/**
    * Allow private access to RuleBasedCollator
    */
    friend  class           RuleBasedCollator;
    friend  class           CollationKeyByteSink;

// Class fields. sizeof(CollationKey) is intended to be 48 bytes
    // on a machine with 64-bit pointers.
    // We use a union to maximize the size of the internal buffer,
    // similar to UnicodeString but not as tight and complex.

// (implicit) *vtable;
    /**
     * Sort key length and flag.
     * Bit 31 is set if the buffer is heap-allocated.
     * Bits 30..0 contain the sort key length.
     */
    int32_t fFlagAndLength;
    /**
    * Unique hash value of this CollationKey.
    * Special value 2 if the key is bogus.
    */
    mutable int32_t fHashCode;
    /**
     * fUnion provides 32 bytes for the internal buffer or for
     * pointer+capacity.
     */
    union StackBufferOrFields {
        /** fStackBuffer is used iff fFlagAndLength>=0, else fFields is used */
        uint8_t fStackBuffer[32];
        struct {
            uint8_t *fBytes;
            int32_t fCapacity;
        } fFields;
    } fUnion;
};

inline UBool
CollationKey::operator!=(const CollationKey& other) const
{
    return !(*this == other);
}

inline UBool
CollationKey::isBogus() const
{
    return fHashCode == 2;  // kBogusHashCode
}

inline const uint8_t*
CollationKey::getByteArray(int32_t &count) const
{
    count = getLength();
    return getBytes();
}

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_COLLATION */

#endif

${this.title}

Code Editor : sortkey.h