OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	05/14/2024 03:54:45 PM	rwxr-xr-x
📄 alphaindex.h	26.52 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 appendable.h	8.53 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 basictz.h	9.86 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 brkiter.h	27.81 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 bytestream.h	10.75 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 bytestrie.h	20.77 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 bytestriebuilder.h	7.46 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 calendar.h	105.88 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 caniter.h	7.44 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 casemap.h	25.33 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 char16ptr.h	7.22 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 chariter.h	24.06 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 choicfmt.h	23.97 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 coleitr.h	13.77 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 coll.h	56.26 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 compactdecimalformat.h	6.88 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 curramt.h	3.78 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 currpinf.h	7.3 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 currunit.h	4.02 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 datefmt.h	40.71 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 dbbi.h	1.19 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 dcfmtsym.h	20.61 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 decimfmt.h	87.57 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 docmain.h	7.21 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 dtfmtsym.h	38.21 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 dtintrv.h	3.84 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 dtitvfmt.h	49.27 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 dtitvinf.h	18.63 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 dtptngen.h	28.84 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 dtrule.h	8.69 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 edits.h	20.74 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 enumset.h	2.08 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 errorcode.h	4.84 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 fieldpos.h	8.7 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 filteredbrk.h	5.37 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 fmtable.h	24.43 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 format.h	12.5 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 formattedvalue.h	9.75 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 fpositer.h	3.03 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 gender.h	3.33 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 gregocal.h	31.88 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 icudataver.h	1.02 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 icuplug.h	11.83 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 idna.h	12.7 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 listformatter.h	8.79 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 localebuilder.h	11.08 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 localematcher.h	26.84 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 localpointer.h	19.36 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 locdspnm.h	7.12 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 locid.h	47.66 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 measfmt.h	11.42 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 measunit.h	104.97 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 measure.h	4.33 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 messagepattern.h	33.71 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 msgfmt.h	44.22 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 normalizer2.h	33.66 KB	12/01/2022 11:12:32 AM	rw-r--r--
📄 normlzr.h	30.95 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 nounit.h	2.25 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 numberformatter.h	94.15 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 numberrangeformatter.h	25.19 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 numfmt.h	49.84 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 numsys.h	7.33 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 parseerr.h	3.08 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 parsepos.h	5.57 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 platform.h	28.09 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 plurfmt.h	25.24 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 plurrule.h	20.82 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ptypes.h	3.49 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 putil.h	6.32 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 rbbi.h	28.64 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 rbnf.h	48.85 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 rbtz.h	15.77 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 regex.h	84.36 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 region.h	9.18 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 reldatefmt.h	22.22 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 rep.h	9.37 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 resbund.h	18.08 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 schriter.h	6.36 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 scientificnumberformatter.h	6.43 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 search.h	22.22 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 selfmt.h	14.34 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 simpleformatter.h	12.59 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 simpletz.h	45.64 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 smpdtfmt.h	71.07 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 sortkey.h	11.18 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 std_string.h	1.05 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 strenum.h	9.92 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 stringoptions.h	5.79 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 stringpiece.h	10.05 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 stringtriebuilder.h	15.47 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 stsearch.h	21.41 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 symtable.h	4.27 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tblcoll.h	36.92 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 timezone.h	43.81 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tmunit.h	3.4 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tmutamt.h	4.91 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tmutfmt.h	7.42 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 translit.h	65.82 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tzfmt.h	42.93 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tznames.h	16.85 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tzrule.h	35.6 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 tztrans.h	6.13 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ubidi.h	89.61 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ubiditransform.h	12.7 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ubrk.h	24.43 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucal.h	60.68 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucasemap.h	15.21 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucat.h	5.35 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uchar.h	144.64 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucharstrie.h	22.53 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucharstriebuilder.h	7.47 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uchriter.h	13.42 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uclean.h	11.2 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucnv.h	83.46 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucnv_cb.h	6.58 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucnv_err.h	20.98 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucnvsel.h	6.19 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucol.h	61.95 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucoleitr.h	9.82 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uconfig.h	12.07 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucpmap.h	5.53 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucptrie.h	22.5 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucsdet.h	14.69 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ucurr.h	16.72 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 udat.h	62.4 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 udata.h	15.63 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 udateintervalformat.h	11.93 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 udatpg.h	30.18 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 udisplaycontext.h	5.94 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uenum.h	7.79 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ufieldpositer.h	4.41 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uformattable.h	10.97 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uformattedvalue.h	12.3 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ugender.h	2.06 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uidna.h	33.43 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uiter.h	22.75 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uldnames.h	10.48 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ulistformatter.h	10.78 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uloc.h	54.63 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ulocdata.h	11.3 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 umachine.h	16.05 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 umisc.h	1.33 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 umsg.h	24.25 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 umutablecptrie.h	8.29 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unifilt.h	4 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unifunct.h	4.05 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unimatch.h	6.1 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unirepl.h	3.38 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uniset.h	66.46 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unistr.h	170.53 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unorm.h	20.55 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unorm2.h	24.68 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unounclass.h	735 bytes	12/01/2022 11:12:33 AM	rw-r--r--
📄 unum.h	55.31 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unumberformatter.h	30.28 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unumberrangeformatter.h	15.37 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 unumsys.h	7.26 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uobject.h	10.68 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 upluralrules.h	8.79 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uregex.h	71.99 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uregion.h	9.81 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ureldatefmt.h	17.04 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 urename.h	135 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 urep.h	5.38 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ures.h	36.54 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uscript.h	27.63 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 usearch.h	39.21 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uset.h	44.29 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 usetiter.h	9.68 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ushape.h	18 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uspoof.h	65.84 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 usprep.h	8.19 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ustdio.h	38.56 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ustream.h	1.89 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ustring.h	72.36 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 ustringtrie.h	3.15 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utext.h	58.08 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utf.h	7.87 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utf16.h	23.35 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utf32.h	763 bytes	12/01/2022 11:12:33 AM	rw-r--r--
📄 utf8.h	30.83 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utf_old.h	45.83 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utmscale.h	13.78 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utrace.h	17.18 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utrans.h	25.54 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 utypes.h	31.06 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uvernum.h	6.68 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 uversion.h	5.99 KB	12/01/2022 11:12:33 AM	rw-r--r--
📄 vtzone.h	20.74 KB	12/01/2022 11:12:33 AM	rw-r--r--

Editing: 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"

#if U_SHOW_CPLUSPLUS_API

/**
 * \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
    */
    bool                    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
    */
    bool                    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 override;

/**
     * 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 bool
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 /* U_SHOW_CPLUSPLUS_API */

#endif