ICU 50.1.2  50.1.2
upluralrules.h
Go to the documentation of this file.
1 /*
2 *****************************************************************************************
3 * Copyright (C) 2010-2012, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 *****************************************************************************************
6 */
7 
8 #ifndef UPLURALRULES_H
9 #define UPLURALRULES_H
10 
11 #include "unicode/utypes.h"
12 
13 #if !UCONFIG_NO_FORMATTING
14 
15 #include "unicode/localpointer.h"
16 
60 };
64 typedef enum UPluralType UPluralType;
65 
70 struct UPluralRules;
71 typedef struct UPluralRules UPluralRules;
82 U_STABLE UPluralRules* U_EXPORT2
83 uplrules_open(const char *locale, UErrorCode *status);
84 
94 U_DRAFT UPluralRules* U_EXPORT2
95 uplrules_openForType(const char *locale, UPluralType type, UErrorCode *status);
96 
102 U_STABLE void U_EXPORT2
103 uplrules_close(UPluralRules *uplrules);
104 
105 
106 #if U_SHOW_CPLUSPLUS_API
107 
109 
120 
122 
123 #endif
124 
125 
137 U_STABLE int32_t U_EXPORT2
138 uplrules_select(const UPluralRules *uplrules,
139  double number,
140  UChar *keyword, int32_t capacity,
141  UErrorCode *status);
142 
143 #endif /* #if !UCONFIG_NO_FORMATTING */
144 
145 #endif
UPluralRules * uplrules_openForType(const char *locale, UPluralType type, UErrorCode *status)
Opens a new UPluralRules object using the predefined plural rules for a given locale and the plural t...
UPluralRules * uplrules_open(const char *locale, UErrorCode *status)
Opens a new UPluralRules object using the predefined cardinal-number plural rules for a given locale...
int32_t uplrules_select(const UPluralRules *uplrules, double number, UChar *keyword, int32_t capacity, UErrorCode *status)
Given a number, returns the keyword of the first rule that applies to the number, according to the su...
void uplrules_close(UPluralRules *uplrules)
Closes a UPluralRules object.
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:290
Plural rules for ordinal numbers: 1st file, 2nd file, 3rd file, 4th file, etc.
Definition: upluralrules.h:54
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
Plural rules for cardinal numbers: 1 file vs.
Definition: upluralrules.h:49
uint16_t UChar
Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...
Definition: umachine.h:278
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130
Number of Plural rules types.
Definition: upluralrules.h:59
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
UPluralType
Type of plurals and PluralRules.
Definition: upluralrules.h:44
struct UPluralRules UPluralRules
C typedef for struct UPluralRules.
Definition: upluralrules.h:71
Basic definitions for ICU, for both C and C++ APIs.
"Smart pointer" class, closes a UPluralRules via uplrules_close().
#define U_DRAFT
This is used to declare a function as a draft public ICU C API.
Definition: umachine.h:111
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:109