ICU 68.1  68.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 
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 {
64 
65 #ifndef U_HIDE_DRAFT_API
66 
71 typedef enum UListFormatterType {
78 
86 
94 
100 typedef enum UListFormatterWidth {
107 
113 
120 #endif /* U_HIDE_DRAFT_API */
121 
140 U_CAPI UListFormatter* U_EXPORT2
141 ulistfmt_open(const char* locale,
142  UErrorCode* status);
143 
144 #ifndef U_HIDE_DRAFT_API
145 
167 U_CAPI UListFormatter* U_EXPORT2
168 ulistfmt_openForType(const char* locale, UListFormatterType type,
169  UListFormatterWidth width, UErrorCode* status);
170 #endif /* U_HIDE_DRAFT_API */
171 
178 U_CAPI void U_EXPORT2
180 
190 U_CAPI UFormattedList* U_EXPORT2
192 
214 U_CAPI const UFormattedValue* U_EXPORT2
216 
223 U_CAPI void U_EXPORT2
225 
226 
227 #if U_SHOW_CPLUSPLUS_API
228 
229 U_NAMESPACE_BEGIN
230 
241 
252 
253 U_NAMESPACE_END
254 
255 #endif
256 
291 U_CAPI int32_t U_EXPORT2
293  const UChar* const strings[],
294  const int32_t * stringLengths,
295  int32_t stringCount,
296  UChar* result,
297  int32_t resultCapacity,
298  UErrorCode* status);
299 
326 U_CAPI void U_EXPORT2
328  const UListFormatter* listfmt,
329  const UChar* const strings[],
330  const int32_t * stringLengths,
331  int32_t stringCount,
332  UFormattedList* uresult,
333  UErrorCode* status);
334 
335 #endif /* #if !UCONFIG_NO_FORMATTING */
336 
337 #endif
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.
ULISTFMT_WIDTH_NARROW
@ ULISTFMT_WIDTH_NARROW
Use list formatting of the shortest possible length.
Definition: ulistformatter.h:118
ULISTFMT_TYPE_OR
@ ULISTFMT_TYPE_OR
Disjunction (or alternative, or simply one of) formatting, e.g.
Definition: ulistformatter.h:85
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
ULISTFMT_WIDTH_WIDE
@ ULISTFMT_WIDTH_WIDE
Use list formatting with full words (no abbreviations) when possible.
Definition: ulistformatter.h:106
ULISTFMT_TYPE_AND
@ ULISTFMT_TYPE_AND
Conjunction formatting, e.g.
Definition: ulistformatter.h:77
uformattedvalue.h
C API: Abstract operations for localized strings.
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_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.
UListFormatterType
UListFormatterType
Type of meaning expressed by the list.
Definition: ulistformatter.h:71
UListFormatterWidth
UListFormatterWidth
Verbosity level of the list patterns.
Definition: ulistformatter.h:100
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
UFormattedValue
struct UFormattedValue UFormattedValue
An abstract formatted value: a string with associated field attributes.
Definition: uformattedvalue.h:361
ulistfmt_close
U_CAPI void ulistfmt_close(UListFormatter *listfmt)
Close a UListFormatter object.
UFormattedList
struct UFormattedList UFormattedList
Opaque struct to contain the results of a UListFormatter operation.
Definition: ulistformatter.h:45
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...
UListFormatter
struct UListFormatter UListFormatter
C typedef for struct UListFormatter.
Definition: ulistformatter.h:38
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
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
ulistfmt_openResult
U_CAPI UFormattedList * ulistfmt_openResult(UErrorCode *ec)
Creates an object to hold the result of a UListFormatter operation.
ULISTFMT_ELEMENT_FIELD
@ ULISTFMT_ELEMENT_FIELD
The element text in the result which came from the input strings.
Definition: ulistformatter.h:62
ULISTFMT_WIDTH_SHORT
@ ULISTFMT_WIDTH_SHORT
Use list formatting of typical length.
Definition: ulistformatter.h:112
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_TYPE_UNITS
@ ULISTFMT_TYPE_UNITS
Formatting of a list of values with units, e.g.
Definition: ulistformatter.h:92
LocalUListFormatterPointer
"Smart pointer" class, closes a UListFormatter via ulistfmt_close().
UChar
char16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:418
UListFormatterField
UListFormatterField
FieldPosition and UFieldPosition selectors for format fields defined by ListFormatter.
Definition: ulistformatter.h:52
U_CAPI
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110
ulistfmt_closeResult
U_CAPI void ulistfmt_closeResult(UFormattedList *uresult)
Releases the UFormattedList created by ulistfmt_openResult().
LocalUFormattedListPointer
"Smart pointer" class, closes a UFormattedList via ulistfmt_closeResult().
Definition: ulistformatter.h:240