ICU 77.1: i18n/unicode/ulistformatter.h Source File

ICU 77.1 77.1

ulistformatter.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 *****************************************************************************************
5 * Copyright (C) 2015-2016, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 *****************************************************************************************
8 */
9
10 #ifndef ULISTFORMATTER_H
11 #define ULISTFORMATTER_H
12
13 #include "unicode/utypes.h"
14
15 #if !UCONFIG_NO_FORMATTING
16
17 #include "unicode/uformattedvalue.h"
18
19 #if U_SHOW_CPLUSPLUS_API
20 #include "unicode/localpointer.h"
21 #endif // U_SHOW_CPLUSPLUS_API
22
37 struct UListFormatter;
38 typedef struct UListFormatter UListFormatter;
40 struct UFormattedList;
45 typedef struct UFormattedList UFormattedList;
46
52 typedef enum UListFormatterField {
57 ULISTFMT_LITERAL_FIELD,
62 ULISTFMT_ELEMENT_FIELD
63 } UListFormatterField;
64
70 typedef enum UListFormatterType {
76 ULISTFMT_TYPE_AND,
77
84 ULISTFMT_TYPE_OR,
85
91 ULISTFMT_TYPE_UNITS
92 } UListFormatterType;
93
99 typedef enum UListFormatterWidth {
105 ULISTFMT_WIDTH_WIDE,
106
111 ULISTFMT_WIDTH_SHORT,
112
117 ULISTFMT_WIDTH_NARROW,
118 } UListFormatterWidth;
119
138 U_CAPI UListFormatter* U_EXPORT2
139 ulistfmt_open(const char* locale,
140 UErrorCode* status);
141
164 U_CAPI UListFormatter* U_EXPORT2
165 ulistfmt_openForType(const char* locale, UListFormatterType type,
166 UListFormatterWidth width, UErrorCode* status);
167
174 U_CAPI void U_EXPORT2
175 ulistfmt_close(UListFormatter *listfmt);
176
186 U_CAPI UFormattedList* U_EXPORT2
187 ulistfmt_openResult(UErrorCode* ec);
188
210 U_CAPI const UFormattedValue* U_EXPORT2
211 ulistfmt_resultAsValue(const UFormattedList* uresult, UErrorCode* ec);
212
219 U_CAPI void U_EXPORT2
220 ulistfmt_closeResult(UFormattedList* uresult);
221
222
223 #if U_SHOW_CPLUSPLUS_API
224
225 U_NAMESPACE_BEGIN
226
236 U_DEFINE_LOCAL_OPEN_POINTER(LocalUListFormatterPointer, UListFormatter, ulistfmt_close);
237
247 U_DEFINE_LOCAL_OPEN_POINTER(LocalUFormattedListPointer, UFormattedList, ulistfmt_closeResult);
248
249 U_NAMESPACE_END
250
251 #endif
252
287 U_CAPI int32_t U_EXPORT2
288 ulistfmt_format(const UListFormatter* listfmt,
289 const UChar* const strings[],
290 const int32_t * stringLengths,
291 int32_t stringCount,
292 UChar* result,
293 int32_t resultCapacity,
294 UErrorCode* status);
295
322 U_CAPI void U_EXPORT2
323 ulistfmt_formatStringsToResult(
324 const UListFormatter* listfmt,
325 const UChar* const strings[],
326 const int32_t * stringLengths,
327 int32_t stringCount,
328 UFormattedList* uresult,
329 UErrorCode* status);
330
331 #endif /* #if !UCONFIG_NO_FORMATTING */
332
333 #endif
LocalUFormattedListPointer
"Smart pointer" class, closes a UFormattedList via ulistfmt_closeResult().
Definition: ulistformatter.h:236
LocalUListFormatterPointer
"Smart pointer" class, closes a UListFormatter via ulistfmt_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:550
uformattedvalue.h
C API: Abstract operations for localized strings.
UFormattedValue
struct UFormattedValue UFormattedValue
An abstract formatted value: a string with associated field attributes.
Definition: uformattedvalue.h:368
ulistfmt_resultAsValue
U_CAPI const UFormattedValue * ulistfmt_resultAsValue(const UFormattedList *uresult, UErrorCode *ec)
Returns a representation of a UFormattedList as a UFormattedValue, which can be subsequently passed t...
ulistfmt_openForType
U_CAPI UListFormatter * ulistfmt_openForType(const char *locale, UListFormatterType type, UListFormatterWidth width, UErrorCode *status)
Open a new UListFormatter object appropriate for the given locale, list type, and style.
ulistfmt_closeResult
U_CAPI void ulistfmt_closeResult(UFormattedList *uresult)
Releases the UFormattedList created by ulistfmt_openResult().
ulistfmt_openResult
U_CAPI UFormattedList * ulistfmt_openResult(UErrorCode *ec)
Creates an object to hold the result of a UListFormatter operation.
UListFormatter
struct UListFormatter UListFormatter
C typedef for struct UListFormatter.
Definition: ulistformatter.h:38
ulistfmt_open
U_CAPI UListFormatter * ulistfmt_open(const char *locale, UErrorCode *status)
Open a new UListFormatter object using the rules for a given locale.
ulistfmt_formatStringsToResult
U_CAPI void ulistfmt_formatStringsToResult(const UListFormatter *listfmt, const UChar *const strings[], const int32_t *stringLengths, int32_t stringCount, UFormattedList *uresult, UErrorCode *status)
Formats a list of strings to a UFormattedList, which exposes more information than the string exporte...
UFormattedList
struct UFormattedList UFormattedList
Opaque struct to contain the results of a UListFormatter operation.
Definition: ulistformatter.h:45
UListFormatterWidth
UListFormatterWidth
Verbosity level of the list patterns.
Definition: ulistformatter.h:99
ULISTFMT_WIDTH_NARROW
@ ULISTFMT_WIDTH_NARROW
Use list formatting of the shortest possible length.
Definition: ulistformatter.h:117
ULISTFMT_WIDTH_WIDE
@ ULISTFMT_WIDTH_WIDE
Use list formatting with full words (no abbreviations) when possible.
Definition: ulistformatter.h:105
ULISTFMT_WIDTH_SHORT
@ ULISTFMT_WIDTH_SHORT
Use list formatting of typical length.
Definition: ulistformatter.h:111
UListFormatterField
UListFormatterField
FieldPosition and UFieldPosition selectors for format fields defined by ListFormatter.
Definition: ulistformatter.h:52
ULISTFMT_ELEMENT_FIELD
@ ULISTFMT_ELEMENT_FIELD
The element text in the result which came from the input strings.
Definition: ulistformatter.h:62
ULISTFMT_LITERAL_FIELD
@ ULISTFMT_LITERAL_FIELD
The literal text in the result which came from the resources.
Definition: ulistformatter.h:57
ulistfmt_format
U_CAPI int32_t ulistfmt_format(const UListFormatter *listfmt, const UChar *const strings[], const int32_t *stringLengths, int32_t stringCount, UChar *result, int32_t resultCapacity, UErrorCode *status)
Formats a list of strings using the conventions established for the UListFormatter object.
UListFormatterType
UListFormatterType
Type of meaning expressed by the list.
Definition: ulistformatter.h:70
ULISTFMT_TYPE_OR
@ ULISTFMT_TYPE_OR
Disjunction (or alternative, or simply one of) formatting, e.g.
Definition: ulistformatter.h:84
ULISTFMT_TYPE_AND
@ ULISTFMT_TYPE_AND
Conjunction formatting, e.g.
Definition: ulistformatter.h:76
ULISTFMT_TYPE_UNITS
@ ULISTFMT_TYPE_UNITS
Formatting of a list of values with units, e.g.
Definition: ulistformatter.h:91
ulistfmt_close
U_CAPI void ulistfmt_close(UListFormatter *listfmt)
Close a UListFormatter object.
U_CAPI
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110
UChar
char16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:378
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:430