ICU 57.1  57.1
upluralrules.h
Go to the documentation of this file.
1 /*
2 *****************************************************************************************
3 * Copyright (C) 2010-2013, 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 
44 enum UPluralType {
49  UPLURAL_TYPE_CARDINAL,
54  UPLURAL_TYPE_ORDINAL,
59  UPLURAL_TYPE_COUNT
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 
108 U_NAMESPACE_BEGIN
109 
119 U_DEFINE_LOCAL_OPEN_POINTER(LocalUPluralRulesPointer, UPluralRules, uplrules_close);
120 
121 U_NAMESPACE_END
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
LocalUPluralRulesPointer
"Smart pointer" class, closes a UPluralRules via uplrules_close().
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
U_DEFINE_LOCAL_OPEN_POINTER
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:539
U_DRAFT
#define U_DRAFT
This is used to declare a function as a draft public ICU C API
Definition: umachine.h:111
UChar
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:312
U_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:109
uplrules_openForType
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...
uplrules_open
UPluralRules * uplrules_open(const char *locale, UErrorCode *status)
Opens a new UPluralRules object using the predefined cardinal-number plural rules for a given locale.
uplrules_close
void uplrules_close(UPluralRules *uplrules)
Closes a UPluralRules object.
UPluralRules
struct UPluralRules UPluralRules
C typedef for struct UPluralRules.
Definition: upluralrules.h:71
uplrules_select
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...
UPluralType
UPluralType
Type of plurals and PluralRules.
Definition: upluralrules.h:44
UPLURAL_TYPE_ORDINAL
@ UPLURAL_TYPE_ORDINAL
Plural rules for ordinal numbers: 1st file, 2nd file, 3rd file, 4th file, etc.
Definition: upluralrules.h:54
UPLURAL_TYPE_CARDINAL
@ UPLURAL_TYPE_CARDINAL
Plural rules for cardinal numbers: 1 file vs.
Definition: upluralrules.h:49
UPLURAL_TYPE_COUNT
@ UPLURAL_TYPE_COUNT
Number of Plural rules types.
Definition: upluralrules.h:59
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition: utypes.h:476
U_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129
Generated by doxygen 1.9.1