golden hour

/opt/alt/libicu/usr/include/unicode

File/Folder	Size	Actions
alphaindex.h	26.42 KB
appendable.h	8.43 KB
basictz.h	8.84 KB
brkiter.h	27.53 KB
bytestream.h	9.54 KB
bytestrie.h	19.26 KB
bytestriebuilder.h	7.02 KB
calendar.h	105.06 KB
caniter.h	7.37 KB
casemap.h	25.26 KB
char16ptr.h	7.16 KB
chariter.h	24 KB
choicfmt.h	23.85 KB
coleitr.h	13.7 KB
coll.h	55.59 KB
compactdecimalformat.h	6.81 KB
curramt.h	3.69 KB
currpinf.h	7.24 KB
currunit.h	3.52 KB
datefmt.h	40.37 KB
dbbi.h	1.11 KB
dcfmtsym.h	20.1 KB
decimfmt.h	86.4 KB
docmain.h	6.72 KB
dtfmtsym.h	37.64 KB
dtintrv.h	3.76 KB
dtitvfmt.h	42.87 KB
dtitvinf.h	18.46 KB
dtptngen.h	25.03 KB
dtrule.h	8.62 KB
edits.h	20.67 KB
enumset.h	2.08 KB
errorcode.h	4.78 KB
fieldpos.h	8.63 KB
filteredbrk.h	5.24 KB
fmtable.h	24.36 KB
format.h	12.44 KB
fpositer.h	2.98 KB
gender.h	3.27 KB
gregocal.h	31.57 KB
icudataver.h	1.03 KB
icuplug.h	11.88 KB
idna.h	12.63 KB
listformatter.h	6.18 KB
localpointer.h	16.88 KB
locdspnm.h	7.05 KB
locid.h	44.92 KB
measfmt.h	12.01 KB
measunit.h	38.5 KB
measure.h	4.26 KB
messagepattern.h	33.65 KB
msgfmt.h	43.36 KB
normalizer2.h	33.97 KB
normlzr.h	30.74 KB
nounit.h	2.63 KB
numberformatter.h	87.07 KB
numberrangeformatter.h	28.74 KB
numfmt.h	49.14 KB
numsys.h	6.73 KB
parseerr.h	3.08 KB
parsepos.h	5.45 KB
platform.h	27.1 KB
plurfmt.h	25.18 KB
plurrule.h	17.42 KB
ptypes.h	3.49 KB
putil.h	6.33 KB
rbbi.h	26.41 KB
rbnf.h	49.79 KB
rbtz.h	15.47 KB
regex.h	84.91 KB
region.h	9.12 KB
reldatefmt.h	14.46 KB
rep.h	9.5 KB
resbund.h	18.01 KB
schriter.h	6.26 KB
scientificnumberformatter.h	6.32 KB
search.h	22.21 KB
selfmt.h	14.24 KB
simpleformatter.h	11.43 KB
simpletz.h	45.3 KB
smpdtfmt.h	70.74 KB
sortkey.h	11.12 KB
std_string.h	1015 B
strenum.h	10.04 KB
stringoptions.h	5.79 KB
stringpiece.h	6.46 KB
stringtriebuilder.h	15.27 KB
stsearch.h	21.29 KB
symtable.h	4.21 KB
tblcoll.h	36.4 KB
timezone.h	40.88 KB
tmunit.h	3.29 KB
tmutamt.h	4.8 KB
tmutfmt.h	7.79 KB
translit.h	65.76 KB
tzfmt.h	42.82 KB
tznames.h	16.79 KB
tzrule.h	35.32 KB
tztrans.h	6.07 KB
ubidi.h	89.56 KB
ubiditransform.h	12.65 KB
ubrk.h	23.97 KB
ucal.h	55.2 KB
ucasemap.h	15.18 KB
ucat.h	5.36 KB
uchar.h	139.96 KB
ucharstrie.h	21.06 KB
ucharstriebuilder.h	7.14 KB
uchriter.h	13.14 KB
uclean.h	11.21 KB
ucnv.h	83.09 KB
ucnv_cb.h	6.59 KB
ucnv_err.h	20.99 KB
ucnvsel.h	6.14 KB
ucol.h	61.39 KB
ucoleitr.h	9.46 KB
uconfig.h	11.67 KB
ucpmap.h	5.58 KB
ucptrie.h	22.29 KB
ucsdet.h	14.67 KB
ucurr.h	15.57 KB
udat.h	60.13 KB
udata.h	15.53 KB
udateintervalformat.h	6.79 KB
udatpg.h	26.04 KB
udisplaycontext.h	5.89 KB
uenum.h	7.78 KB
ufieldpositer.h	4.36 KB
uformattable.h	10.94 KB
ugender.h	2 KB
uidna.h	33.37 KB
uiter.h	22.77 KB
uldnames.h	10.45 KB
ulistformatter.h	5.03 KB
uloc.h	50.75 KB
ulocdata.h	11.26 KB
umachine.h	13.19 KB
umisc.h	1.33 KB
umsg.h	24.23 KB
umutablecptrie.h	8.28 KB
unifilt.h	3.63 KB
unifunct.h	3.98 KB
unimatch.h	6.04 KB
unirepl.h	3.32 KB
uniset.h	64.25 KB
unistr.h	174.4 KB
unorm.h	20.45 KB
unorm2.h	24.66 KB
unum.h	53.38 KB
unumberformatter.h	23.76 KB
unumsys.h	7.14 KB
uobject.h	10.7 KB
upluralrules.h	6.72 KB
uregex.h	72.05 KB
uregion.h	9.84 KB
ureldatefmt.h	12.22 KB
urename.h	127.73 KB
urep.h	5.38 KB
ures.h	36.53 KB
uscript.h	26.52 KB
usearch.h	38.12 KB
uset.h	40 KB
usetiter.h	9.49 KB
ushape.h	18 KB
uspoof.h	66.03 KB
usprep.h	8.14 KB
ustdio.h	38.54 KB
ustream.h	1.8 KB
ustring.h	72.47 KB
ustringtrie.h	3.15 KB
utext.h	58.11 KB
utf.h	7.86 KB
utf16.h	22.33 KB
utf32.h	763 B
utf8.h	30.01 KB
utf_old.h	43.78 KB
utmscale.h	13.78 KB
utrace.h	13.89 KB
utrans.h	25.54 KB
utypes.h	30.48 KB
uvernum.h	6.06 KB
uversion.h	6.7 KB
vtzone.h	20.17 KB

Edit: plurrule.h

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
* Copyright (C) 2008-2015, International Business Machines Corporation and
* others. All Rights Reserved.
*******************************************************************************
*
*
* File PLURRULE.H
*
* Modification History:*
*   Date        Name        Description
*
********************************************************************************
*/

#ifndef PLURRULE
#define PLURRULE

#include "unicode/utypes.h"

/**
 * \file
 * \brief C++ API: PluralRules object
 */

#if !UCONFIG_NO_FORMATTING

#include "unicode/format.h"
#include "unicode/upluralrules.h"
#ifndef U_HIDE_INTERNAL_API
#include "unicode/numfmt.h"
#endif  /* U_HIDE_INTERNAL_API */

/**
 * Value returned by PluralRules::getUniqueKeywordValue() when there is no
 * unique value to return.
 * @stable ICU 4.8
 */
#define UPLRULES_NO_UNIQUE_VALUE ((double)-0.00123456777)

U_NAMESPACE_BEGIN

class Hashtable;
class IFixedDecimal;
class RuleChain;
class PluralRuleParser;
class PluralKeywordEnumeration;
class AndConstraint;
class SharedPluralRules;

/**
 * Defines rules for mapping non-negative numeric values onto a small set of
 * keywords. Rules are constructed from a text description, consisting
 * of a series of keywords and conditions. The {@link #select} method
 * examines each condition in order and returns the keyword for the
 * first condition that matches the number. If none match,
 * default rule(other) is returned.
 *
 * For more information, details, and tips for writing rules, see the
 * LDML spec, C.11 Language Plural Rules:
 * http://www.unicode.org/draft/reports/tr35/tr35.html#Language_Plural_Rules
 *
 * Examples:<pre>
 * "one: n is 1; few: n in 2..4"</pre>
 * This defines two rules, for 'one' and 'few'. The condition for
 * 'one' is "n is 1" which means that the number must be equal to
 * 1 for this condition to pass. The condition for 'few' is
 * "n in 2..4" which means that the number must be between 2 and
 * 4 inclusive for this condition to pass. All other numbers
 * are assigned the keyword "other" by the default rule.
 * <pre>
 * "zero: n is 0; one: n is 1; zero: n mod 100 in 1..19"</pre>
 * This illustrates that the same keyword can be defined multiple times.
 * Each rule is examined in order, and the first keyword whose condition
 * passes is the one returned. Also notes that a modulus is applied
 * to n in the last rule. Thus its condition holds for 119, 219, 319...
 * <pre>
 * "one: n is 1; few: n mod 10 in 2..4 and n mod 100 not in 12..14"</pre>
 * This illustrates conjunction and negation. The condition for 'few'
 * has two parts, both of which must be met: "n mod 10 in 2..4" and
 * "n mod 100 not in 12..14". The first part applies a modulus to n
 * before the test as in the previous example. The second part applies
 * a different modulus and also uses negation, thus it matches all
 * numbers _not_ in 12, 13, 14, 112, 113, 114, 212, 213, 214...
 * 
 * 
 * Syntax:<pre>
 * \code
 * rules = rule (';' rule)*
 * rule = keyword ':' condition
 * keyword = <identifier>
 * condition = and_condition ('or' and_condition)*
 * and_condition = relation ('and' relation)*
 * relation = is_relation | in_relation | within_relation | 'n' <EOL>
 * is_relation = expr 'is' ('not')? value
 * in_relation = expr ('not')? 'in' range_list
 * within_relation = expr ('not')? 'within' range
 * expr = ('n' | 'i' | 'f' | 'v' | 'j') ('mod' value)?
 * range_list = (range | value) (',' range_list)*
 * value = digit+ ('.' digit+)?
 * digit = 0|1|2|3|4|5|6|7|8|9
 * range = value'..'value
 * \endcode
 * </pre>
 * 
 * 
 * The i, f, and v values are defined as follows:
 * 
 * <ul>
 * <li>i to be the integer digits.</li>
 * <li>f to be the visible fractional digits, as an integer.</li>
 * <li>v to be the number of visible fraction digits.</li>
 * <li>j is defined to only match integers. That is j is 3 fails if v != 0 (eg for 3.1 or 3.0).</li>
 * </ul>
 * 
 * Examples are in the following table:
 * 
 * <table border='1' style="border-collapse:collapse">
 * <tr>
 * <th>n</th>
 * <th>i</th>
 * <th>f</th>
 * <th>v</th>
 * </tr>
 * <tr>
 * <td>1.0</td>
 * <td>1</td>
 * <td align="right">0</td>
 * <td>1</td>
 * </tr>
 * <tr>
 * <td>1.00</td>
 * <td>1</td>
 * <td align="right">0</td>
 * <td>2</td>
 * </tr>
 * <tr>
 * <td>1.3</td>
 * <td>1</td>
 * <td align="right">3</td>
 * <td>1</td>
 * </tr>
 * <tr>
 * <td>1.03</td>
 * <td>1</td>
 * <td align="right">3</td>
 * <td>2</td>
 * </tr>
 * <tr>
 * <td>1.23</td>
 * <td>1</td>
 * <td align="right">23</td>
 * <td>2</td>
 * </tr>
 * </table>
 * 
 * The difference between 'in' and 'within' is that 'in' only includes integers in the specified range, while 'within'
 * includes all values. Using 'within' with a range_list consisting entirely of values is the same as using 'in' (it's
 * not an error).
 *

* An "identifier" is a sequence of characters that do not have the
 * Unicode Pattern_Syntax or Pattern_White_Space properties.
 * 
 * The difference between 'in' and 'within' is that 'in' only includes
 * integers in the specified range, while 'within' includes all values.
 * Using 'within' with a range_list consisting entirely of values is the
 * same as using 'in' (it's not an error).
 *
 * 
 * Keywords
 * could be defined by users or from ICU locale data. There are 6
 * predefined values in ICU - 'zero', 'one', 'two', 'few', 'many' and
 * 'other'. Callers need to check the value of keyword returned by
 * {@link #select} method.
 * 
 *
 * Examples:<pre>
 * UnicodeString keyword = pl->select(number);
 * if (keyword== UnicodeString("one") {
 * ...
 * }
 * else if ( ... )
 * </pre>
 * Note: 
 * 
 * ICU defines plural rules for many locales based on CLDR Language Plural Rules.
 * For these predefined rules, see CLDR page at
 * http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html
 * 
 */
class U_I18N_API PluralRules : public UObject {
public:

/**
     * Constructor.
     * @param status  Output param set to success/failure code on exit, which
     *                must not indicate a failure before the function call.
     *
     * @stable ICU 4.0
     */
    PluralRules(UErrorCode& status);

/**
     * Copy constructor.
     * @stable ICU 4.0
     */
    PluralRules(const PluralRules& other);

/**
     * Destructor.
     * @stable ICU 4.0
     */
    virtual ~PluralRules();

/**
     * Clone
     * @stable ICU 4.0
     */
    PluralRules* clone() const;

/**
      * Assignment operator.
      * @stable ICU 4.0
      */
    PluralRules& operator=(const PluralRules&);

/**
     * Creates a PluralRules from a description if it is parsable, otherwise
     * returns NULL.
     *
     * @param description rule description
     * @param status      Output param set to success/failure code on exit, which
     *                    must not indicate a failure before the function call.
     * @return            new PluralRules pointer. NULL if there is an error.
     * @stable ICU 4.0
     */
    static PluralRules* U_EXPORT2 createRules(const UnicodeString& description,
                                              UErrorCode& status);

/**
     * The default rules that accept any number.
     *
     * @param status  Output param set to success/failure code on exit, which
     *                must not indicate a failure before the function call.
     * @return        new PluralRules pointer. NULL if there is an error.
     * @stable ICU 4.0
     */
    static PluralRules* U_EXPORT2 createDefaultRules(UErrorCode& status);

/**
 * Provides access to the predefined cardinal-number <code>PluralRules</code> for a given
 * locale.
 * Same as forLocale(locale, UPLURAL_TYPE_CARDINAL, status).
 *
 * @param locale The locale for which a <code>PluralRules</code> object is
 * returned.
 * @param status Output param set to success/failure code on exit, which
 * must not indicate a failure before the function call.
 * @return The predefined <code>PluralRules</code> object pointer for
 * this locale. If there's no predefined rules for this locale,
 * the rules for the closest parent in the locale hierarchy
 * that has one will be returned. The final fallback always
 * returns the default 'other' rules.
 * @stable ICU 4.0
 */
 static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UErrorCode& status);

/**
 * Provides access to the predefined <code>PluralRules</code> for a given
 * locale and the plural type.
 *
 * @param locale The locale for which a <code>PluralRules</code> object is
 * returned.
 * @param type The plural type (e.g., cardinal or ordinal).
 * @param status Output param set to success/failure code on exit, which
 * must not indicate a failure before the function call.
 * @return The predefined <code>PluralRules</code> object pointer for
 * this locale. If there's no predefined rules for this locale,
 * the rules for the closest parent in the locale hierarchy
 * that has one will be returned. The final fallback always
 * returns the default 'other' rules.
 * @stable ICU 50
 */
 static PluralRules* U_EXPORT2 forLocale(const Locale& locale, UPluralType type, UErrorCode& status);

#ifndef U_HIDE_INTERNAL_API
    /**
     * Return a StringEnumeration over the locales for which there is plurals data.
     * @return a StringEnumeration over the locales available.
     * @internal
     */
    static StringEnumeration* U_EXPORT2 getAvailableLocales(UErrorCode &status);

/**
     * Returns whether or not there are overrides.
     * @param locale       the locale to check.
     * @return
     * @internal
     */
    static UBool hasOverride(const Locale &locale);

/**
     * For ICU use only.
     * creates a  SharedPluralRules object
     * @internal
     */
    static PluralRules* U_EXPORT2 internalForLocale(const Locale& locale, UPluralType type, UErrorCode& status);

/**
     * For ICU use only.
     * Returns handle to the shared, cached PluralRules instance.
     * Caller must call removeRef() on returned value once it is done with
     * the shared instance.
     * @internal
     */
    static const SharedPluralRules* U_EXPORT2 createSharedInstance(
            const Locale& locale, UPluralType type, UErrorCode& status);

#endif  /* U_HIDE_INTERNAL_API */

/**
     * Given a number, returns the keyword of the first rule that applies to
     * the number.  This function can be used with isKeyword* functions to
     * determine the keyword for default plural rules.
     *
     * @param number  The number for which the rule has to be determined.
     * @return        The keyword of the selected rule.
     * @stable ICU 4.0
     */
    UnicodeString select(int32_t number) const;

#ifndef U_HIDE_INTERNAL_API
    /**
      * @internal
      */
    UnicodeString select(const IFixedDecimal &number) const;
#endif  /* U_HIDE_INTERNAL_API */

/**
 * Returns a list of all rule keywords used in this <code>PluralRules</code>
 * object. The rule 'other' is always present by default.
 *
 * @param status Output param set to success/failure code on exit, which
 * must not indicate a failure before the function call.
 * @return StringEnumeration with the keywords.
 * The caller must delete the object.
 * @stable ICU 4.0
 */
 StringEnumeration* getKeywords(UErrorCode& status) const;

#ifndef U_HIDE_DEPRECATED_API
    /**
     * Deprecated Function, does not return useful results.
     *
     * Originally intended to return a unique value for this keyword if it exists,
     * else the constant UPLRULES_NO_UNIQUE_VALUE.
     *
     * @param keyword The keyword.
     * @return        Stub deprecated function returns UPLRULES_NO_UNIQUE_VALUE always.
     * @deprecated ICU 55
     */
    double getUniqueKeywordValue(const UnicodeString& keyword);

/**
     * Deprecated Function, does not produce useful results.
     *
     * Originally intended to return all the values for which select() would return the keyword.
     * If the keyword is unknown, returns no values, but this is not an error.  If
     * the number of values is unlimited, returns no values and -1 as the
     * count.
     *
     * The number of returned values is typically small.
     *
     * @param keyword      The keyword.
     * @param dest         Array into which to put the returned values.  May
     *                     be NULL if destCapacity is 0.
     * @param destCapacity The capacity of the array, must be at least 0.
     * @param status       The error code. Deprecated function, always sets U_UNSUPPORTED_ERROR.
     * @return             The count of values available, or -1.  This count
     *                     can be larger than destCapacity, but no more than
     *                     destCapacity values will be written.
     * @deprecated ICU 55
     */
    int32_t getAllKeywordValues(const UnicodeString &keyword,
                                double *dest, int32_t destCapacity,
                                UErrorCode& status);
#endif  /* U_HIDE_DEPRECATED_API */

/**
     * Returns sample values for which select() would return the keyword.  If
     * the keyword is unknown, returns no values, but this is not an error.
     *
     * The number of returned values is typically small.
     *
     * @param keyword      The keyword.
     * @param dest         Array into which to put the returned values.  May
     *                     be NULL if destCapacity is 0.
     * @param destCapacity The capacity of the array, must be at least 0.
     * @param status       The error code.
     * @return             The count of values written.
     *                     If more than destCapacity samples are available, then
     *                     only destCapacity are written, and destCapacity is returned as the count,
     *                     rather than setting a U_BUFFER_OVERFLOW_ERROR.
     *                     (The actual number of keyword values could be unlimited.)
     * @stable ICU 4.8
     */
    int32_t getSamples(const UnicodeString &keyword,
                       double *dest, int32_t destCapacity,
                       UErrorCode& status);

/**
 * Returns TRUE if the given keyword is defined in this
 * <code>PluralRules</code> object.
 *
 * @param keyword the input keyword.
 * @return TRUE if the input keyword is defined.
 * Otherwise, return FALSE.
 * @stable ICU 4.0
 */
 UBool isKeyword(const UnicodeString& keyword) const;

/**
     * Returns keyword for default plural form.
     *
     * @return         keyword for default plural form.
     * @stable ICU 4.0
     */
    UnicodeString getKeywordOther() const;

#ifndef U_HIDE_INTERNAL_API
    /**
     *
     * @internal
     */
     UnicodeString getRules() const;
#endif  /* U_HIDE_INTERNAL_API */

/**
     * Compares the equality of two PluralRules objects.
     *
     * @param other The other PluralRules object to be compared with.
     * @return      True if the given PluralRules is the same as this
     *              PluralRules; false otherwise.
     * @stable ICU 4.0
     */
    virtual UBool operator==(const PluralRules& other) const;

/**
     * Compares the inequality of two PluralRules objects.
     *
     * @param other The PluralRules object to be compared with.
     * @return      True if the given PluralRules is not the same as this
     *              PluralRules; false otherwise.
     * @stable ICU 4.0
     */
    UBool operator!=(const PluralRules& other) const  {return !operator==(other);}

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

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

private:
    RuleChain  *mRules;

PluralRules();   // default constructor not implemented
    void            parseDescription(const UnicodeString& ruleData, UErrorCode &status);
    int32_t         getNumberValue(const UnicodeString& token) const;
    UnicodeString   getRuleFromResource(const Locale& locale, UPluralType type, UErrorCode& status);
    RuleChain      *rulesForKeyword(const UnicodeString &keyword) const;

/**
    * An internal status variable used to indicate that the object is in an 'invalid' state.
    * Used by copy constructor, the assignment operator and the clone method.
    */
    UErrorCode mInternalStatus;

friend class PluralRuleParser;
};

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_FORMATTING */

#endif // _PLURRULE
//eof