ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / include / unicode

/*
*****************************************************************************************
* Copyright (C) 2010-2012, International Business Machines
* Corporation and others. All Rights Reserved.
*****************************************************************************************
*/

#ifndef UPLURALRULES_H
#define UPLURALRULES_H

#include "unicode/utypes.h"

#if !UCONFIG_NO_FORMATTING

#include "unicode/localpointer.h"

/**
 * \file
 * \brief C API: Plural rules, select plural keywords for numeric values.
 *
 * A UPluralRules object 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 uplrules_select function examines each condition in order and
 * returns the keyword for the first condition that matches the number.
 * If none match, the default rule(other) is returned.
 *
 * For more information, see the LDML spec, C.11 Language Plural Rules:
 * http://www.unicode.org/reports/tr35/#Language_Plural_Rules
 *
 * Keywords: ICU locale data has 6 predefined values -
 * 'zero', 'one', 'two', 'few', 'many' and 'other'. Callers need to check
 * the value of keyword returned by the uplrules_select function.
 *
 * These are based on CLDR <i>Language Plural Rules</i>. For these
 * predefined rules, see the CLDR page at
 * http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html
 */

/**
 * Type of plurals and PluralRules.
 * @draft ICU 50
 */
enum UPluralType {
    /**
     * Plural rules for cardinal numbers: 1 file vs. 2 files.
     * @draft ICU 50
     */
    UPLURAL_TYPE_CARDINAL,
    /**
     * Plural rules for ordinal numbers: 1st file, 2nd file, 3rd file, 4th file, etc.
     * @draft ICU 50
     */
    UPLURAL_TYPE_ORDINAL,
    /**
     * Number of Plural rules types.
     * @draft ICU 50
     */
    UPLURAL_TYPE_COUNT
};
/**
 * @draft ICU 50
 */
typedef enum UPluralType UPluralType;

/**
 * Opaque UPluralRules object for use in C programs.
 * @stable ICU 4.8
 */
struct UPluralRules;
typedef struct UPluralRules UPluralRules;  /**< C typedef for struct UPluralRules. @stable ICU 4.8 */

/**
 * Opens a new UPluralRules object using the predefined cardinal-number plural rules for a
 * given locale.
 * Same as uplrules_openForType(locale, UPLURAL_TYPE_CARDINAL, status).
 * @param locale The locale for which the rules are desired.
 * @param status A pointer to a UErrorCode to receive any errors.
 * @return A UPluralRules for the specified locale, or NULL if an error occurred.
 * @stable ICU 4.8
 */
U_STABLE UPluralRules* U_EXPORT2
uplrules_open(const char *locale, UErrorCode *status);

/**
 * Opens a new UPluralRules object using the predefined plural rules for a
 * given locale and the plural type.
 * @param locale The locale for which the rules are desired.
 * @param type The plural type (e.g., cardinal or ordinal).
 * @param status A pointer to a UErrorCode to receive any errors.
 * @return A UPluralRules for the specified locale, or NULL if an error occurred.
 * @draft ICU 50
 */
U_DRAFT UPluralRules* U_EXPORT2
uplrules_openForType(const char *locale, UPluralType type, UErrorCode *status);

/**
 * Closes a UPluralRules object. Once closed it may no longer be used.
 * @param uplrules The UPluralRules object to close.
 * @stable ICU 4.8
 */
U_STABLE void U_EXPORT2
uplrules_close(UPluralRules *uplrules);

#if U_SHOW_CPLUSPLUS_API

U_NAMESPACE_BEGIN

/**
 * \class LocalUPluralRulesPointer
 * "Smart pointer" class, closes a UPluralRules via uplrules_close().
 * For most methods see the LocalPointerBase base class.
 *
 * @see LocalPointerBase
 * @see LocalPointer
 * @stable ICU 4.8
 */
U_DEFINE_LOCAL_OPEN_POINTER(LocalUPluralRulesPointer, UPluralRules, uplrules_close);

U_NAMESPACE_END

#endif

/**
 * Given a number, returns the keyword of the first rule that
 * applies to the number, according to the supplied UPluralRules object.
 * @param uplrules The UPluralRules object specifying the rules.
 * @param number The number for which the rule has to be determined.
 * @param keyword The keyword of the rule that applies to number.
 * @param capacity The capacity of keyword.
 * @param status A pointer to a UErrorCode to receive any errors.
 * @return The length of keyword.
 * @stable ICU 4.8
 */
U_STABLE int32_t U_EXPORT2
uplrules_select(const UPluralRules *uplrules,
               double number,
               UChar *keyword, int32_t capacity,
               UErrorCode *status);

#endif /* #if !UCONFIG_NO_FORMATTING */

#endif

[-] tzrule.h [edit]
[-] utrans.h [edit]
[-] ucnv.h [edit]
[-] dtrule.h [edit]
[-] format.h [edit]
[-] uvernum.h [edit]
[-] utf32.h [edit]
[-] ubidi.h [edit]
[-] enumset.h [edit]
[-] normlzr.h [edit]
[-] measfmt.h [edit]
[-] ubrk.h [edit]
[-] upluralrules.h [edit]
[-] sortkey.h [edit]
[-] bytestrie.h [edit]
[-] fpositer.h [edit]
[-] utf_old.h [edit]
[-] tmutamt.h [edit]
[-] uconfig.h [edit]
[-] alphaindex.h [edit]
[-] vtzone.h [edit]
[-] locdspnm.h [edit]
[-] numsys.h [edit]
[-] simpletz.h [edit]
[-] tznames.h [edit]
[-] stringpiece.h [edit]
[-] parseerr.h [edit]
[-] ucsdet.h [edit]
[-] appendable.h [edit]
[+] ..
[-] dtptngen.h [edit]
[-] dtintrv.h [edit]
[-] resbund.h [edit]
[-] ptypes.h [edit]
[-] ustdio.h [edit]
[-] symtable.h [edit]
[-] ucnv_err.h [edit]
[-] utypes.h [edit]
[-] bytestream.h [edit]
[-] dtfmtsym.h [edit]
[-] unorm2.h [edit]
[-] udateintervalformat.h [edit]
[-] ucat.h [edit]
[-] usearch.h [edit]
[-] platform.h [edit]
[-] unum.h [edit]
[-] locid.h [edit]
[-] uversion.h [edit]
[-] regex.h [edit]
[-] strenum.h [edit]
[-] ucasemap.h [edit]
[-] utmscale.h [edit]
[-] decimfmt.h [edit]
[-] messagepattern.h [edit]
[-] brkiter.h [edit]
[-] ucurr.h [edit]
[-] uset.h [edit]
[-] tztrans.h [edit]
[-] udata.h [edit]
[-] currpinf.h [edit]
[-] datefmt.h [edit]
[-] rbbi.h [edit]
[-] parsepos.h [edit]
[-] rbtz.h [edit]
[-] ucnv_cb.h [edit]
[-] ucoleitr.h [edit]
[-] udat.h [edit]
[-] putil.h [edit]
[-] coll.h [edit]
[-] gender.h [edit]
[-] ucharstriebuilder.h [edit]
[-] unimatch.h [edit]
[-] currunit.h [edit]
[-] ugender.h [edit]
[-] colldata.h [edit]
[-] uchriter.h [edit]
[-] tmunit.h [edit]
[-] ulocdata.h [edit]
[-] timezone.h [edit]
[-] unirepl.h [edit]
[-] umisc.h [edit]
[-] tmutfmt.h [edit]
[-] ushape.h [edit]
[-] dtitvinf.h [edit]
[-] usetiter.h [edit]
[-] uniset.h [edit]
[-] listformatter.h [edit]
[-] umsg.h [edit]
[-] ustream.h [edit]
[-] ustringtrie.h [edit]
[-] icudataver.h [edit]
[-] bytestriebuilder.h [edit]
[-] bms.h [edit]
[-] uldnames.h [edit]
[-] uregex.h [edit]
[-] schriter.h [edit]
[-] uenum.h [edit]
[-] uclean.h [edit]
[-] bmsearch.h [edit]
[-] utf16.h [edit]
[-] normalizer2.h [edit]
[-] calendar.h [edit]
[-] udatpg.h [edit]
[-] unifunct.h [edit]
[-] dbbi.h [edit]
[-] utext.h [edit]
[-] uchar.h [edit]
[-] tzfmt.h [edit]
[-] urep.h [edit]
[-] uscript.h [edit]
[-] urename.h [edit]
[-] std_string.h [edit]
[-] choicfmt.h [edit]
[-] rep.h [edit]
[-] idna.h [edit]
[-] unorm.h [edit]
[-] dtitvfmt.h [edit]
[-] utrace.h [edit]
[-] uidna.h [edit]
[-] search.h [edit]
[-] uobject.h [edit]
[-] basictz.h [edit]
[-] dcfmtsym.h [edit]
[-] coleitr.h [edit]
[-] translit.h [edit]
[-] ures.h [edit]
[-] unistr.h [edit]
[-] udisplaycontext.h [edit]
[-] fmtable.h [edit]
[-] rbnf.h [edit]
[-] gregocal.h [edit]
[-] uiter.h [edit]
[-] umachine.h [edit]
[-] plurrule.h [edit]
[-] plurfmt.h [edit]
[-] ucnvsel.h [edit]
[-] curramt.h [edit]
[-] ucal.h [edit]
[-] measure.h [edit]
[-] utf8.h [edit]
[-] uspoof.h [edit]
[-] icuplug.h [edit]
[-] chariter.h [edit]
[-] stringtriebuilder.h [edit]
[-] caniter.h [edit]
[-] utf.h [edit]
[-] fieldpos.h [edit]
[-] ucharstrie.h [edit]
[-] tblcoll.h [edit]
[-] ustring.h [edit]
[-] errorcode.h [edit]
[-] stsearch.h [edit]
[-] localpointer.h [edit]
[-] usprep.h [edit]
[-] docmain.h [edit]
[-] msgfmt.h [edit]
[-] selfmt.h [edit]
[-] unifilt.h [edit]
[-] uloc.h [edit]
[-] measunit.h [edit]
[-] ucol.h [edit]
[-] numfmt.h [edit]
[-] smpdtfmt.h [edit]