Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/unicode/unumsys.h @ 69:33d812a61356

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
comparison
equal deleted inserted replaced
67:0e9998148a16 69:33d812a61356
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 *****************************************************************************************
5 * Copyright (C) 2013-2014, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 *****************************************************************************************
8 */
9
10 #ifndef UNUMSYS_H
11 #define UNUMSYS_H
12
13 #include "unicode/utypes.h"
14
15 #if !UCONFIG_NO_FORMATTING
16
17 #include "unicode/uenum.h"
18 #include "unicode/localpointer.h"
19
20 /**
21 * \file
22 * \brief C API: UNumberingSystem, information about numbering systems
23 *
24 * Defines numbering systems. A numbering system describes the scheme by which
25 * numbers are to be presented to the end user. In its simplest form, a numbering
26 * system describes the set of digit characters that are to be used to display
27 * numbers, such as Western digits, Thai digits, Arabic-Indic digits, etc., in a
28 * positional numbering system with a specified radix (typically 10).
29 * More complicated numbering systems are algorithmic in nature, and require use
30 * of an RBNF formatter (rule based number formatter), in order to calculate
31 * the characters to be displayed for a given number. Examples of algorithmic
32 * numbering systems include Roman numerals, Chinese numerals, and Hebrew numerals.
33 * Formatting rules for many commonly used numbering systems are included in
34 * the ICU package, based on the numbering system rules defined in CLDR.
35 * Alternate numbering systems can be specified to a locale by using the
36 * numbers locale keyword.
37 */
38
39 /**
40 * Opaque UNumberingSystem object for use in C programs.
41 * @stable ICU 52
42 */
43 struct UNumberingSystem;
44 typedef struct UNumberingSystem UNumberingSystem; /**< C typedef for struct UNumberingSystem. @stable ICU 52 */
45
46 /**
47 * Opens a UNumberingSystem object using the default numbering system for the specified
48 * locale.
49 * @param locale The locale for which the default numbering system should be opened.
50 * @param status A pointer to a UErrorCode to receive any errors. For example, this
51 * may be U_UNSUPPORTED_ERROR for a locale such as "en@numbers=xyz" that
52 * specifies a numbering system unknown to ICU.
53 * @return A UNumberingSystem for the specified locale, or NULL if an error
54 * occurred.
55 * @stable ICU 52
56 */
57 U_STABLE UNumberingSystem * U_EXPORT2
58 unumsys_open(const char *locale, UErrorCode *status);
59
60 /**
61 * Opens a UNumberingSystem object using the name of one of the predefined numbering
62 * systems specified by CLDR and known to ICU, such as "latn", "arabext", or "hanidec";
63 * the full list is returned by unumsys_openAvailableNames. Note that some of the names
64 * listed at http://unicode.org/repos/cldr/tags/latest/common/bcp47/number.xml - e.g.
65 * default, native, traditional, finance - do not identify specific numbering systems,
66 * but rather key values that may only be used as part of a locale, which in turn
67 * defines how they are mapped to a specific numbering system such as "latn" or "hant".
68 *
69 * @param name The name of the numbering system for which a UNumberingSystem object
70 * should be opened.
71 * @param status A pointer to a UErrorCode to receive any errors. For example, this
72 * may be U_UNSUPPORTED_ERROR for a numbering system such as "xyz" that
73 * is unknown to ICU.
74 * @return A UNumberingSystem for the specified name, or NULL if an error
75 * occurred.
76 * @stable ICU 52
77 */
78 U_STABLE UNumberingSystem * U_EXPORT2
79 unumsys_openByName(const char *name, UErrorCode *status);
80
81 /**
82 * Close a UNumberingSystem object. Once closed it may no longer be used.
83 * @param unumsys The UNumberingSystem object to close.
84 * @stable ICU 52
85 */
86 U_STABLE void U_EXPORT2
87 unumsys_close(UNumberingSystem *unumsys);
88
89 #if U_SHOW_CPLUSPLUS_API
90 U_NAMESPACE_BEGIN
91
92 /**
93 * \class LocalUNumberingSystemPointer
94 * "Smart pointer" class, closes a UNumberingSystem via unumsys_close().
95 * For most methods see the LocalPointerBase base class.
96 * @see LocalPointerBase
97 * @see LocalPointer
98 * @stable ICU 52
99 */
100 U_DEFINE_LOCAL_OPEN_POINTER(LocalUNumberingSystemPointer, UNumberingSystem, unumsys_close);
101
102 U_NAMESPACE_END
103 #endif
104
105 /**
106 * Returns an enumeration over the names of all of the predefined numbering systems known
107 * to ICU.
108 * The numbering system names will be in alphabetical (invariant) order.
109 * @param status A pointer to a UErrorCode to receive any errors.
110 * @return A pointer to a UEnumeration that must be closed with uenum_close(),
111 * or NULL if an error occurred.
112 * @stable ICU 52
113 */
114 U_STABLE UEnumeration * U_EXPORT2
115 unumsys_openAvailableNames(UErrorCode *status);
116
117 /**
118 * Returns the name of the specified UNumberingSystem object (if it is one of the
119 * predefined names known to ICU).
120 * @param unumsys The UNumberingSystem whose name is desired.
121 * @return A pointer to the name of the specified UNumberingSystem object, or
122 * NULL if the name is not one of the ICU predefined names. The pointer
123 * is only valid for the lifetime of the UNumberingSystem object.
124 * @stable ICU 52
125 */
126 U_STABLE const char * U_EXPORT2
127 unumsys_getName(const UNumberingSystem *unumsys);
128
129 /**
130 * Returns whether the given UNumberingSystem object is for an algorithmic (not purely
131 * positional) system.
132 * @param unumsys The UNumberingSystem whose algorithmic status is desired.
133 * @return TRUE if the specified UNumberingSystem object is for an algorithmic
134 * system.
135 * @stable ICU 52
136 */
137 U_STABLE UBool U_EXPORT2
138 unumsys_isAlgorithmic(const UNumberingSystem *unumsys);
139
140 /**
141 * Returns the radix of the specified UNumberingSystem object. Simple positional
142 * numbering systems typically have radix 10, but might have a radix of e.g. 16 for
143 * hexadecimal. The radix is less well-defined for non-positional algorithmic systems.
144 * @param unumsys The UNumberingSystem whose radix is desired.
145 * @return The radix of the specified UNumberingSystem object.
146 * @stable ICU 52
147 */
148 U_STABLE int32_t U_EXPORT2
149 unumsys_getRadix(const UNumberingSystem *unumsys);
150
151 /**
152 * Get the description string of the specified UNumberingSystem object. For simple
153 * positional systems this is the ordered string of digits (with length matching
154 * the radix), e.g. "\u3007\u4E00\u4E8C\u4E09\u56DB\u4E94\u516D\u4E03\u516B\u4E5D"
155 * for "hanidec"; it would be "0123456789ABCDEF" for hexadecimal. For
156 * algorithmic systems this is the name of the RBNF ruleset used for formatting,
157 * e.g. "zh/SpelloutRules/%spellout-cardinal" for "hans" or "%greek-upper" for
158 * "grek".
159 * @param unumsys The UNumberingSystem whose description string is desired.
160 * @param result A pointer to a buffer to receive the description string.
161 * @param resultLength The maximum size of result.
162 * @param status A pointer to a UErrorCode to receive any errors.
163 * @return The total buffer size needed; if greater than resultLength, the
164 * output was truncated.
165 * @stable ICU 52
166 */
167 U_STABLE int32_t U_EXPORT2
168 unumsys_getDescription(const UNumberingSystem *unumsys, UChar *result,
169 int32_t resultLength, UErrorCode *status);
170
171 #endif /* #if !UCONFIG_NO_FORMATTING */
172
173 #endif