ICU 65.1 65.1

uformattedvalue.h
Go to the documentation of this file.
1 // © 2018 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3
4 #ifndef __UFORMATTEDVALUE_H__
5 #define __UFORMATTEDVALUE_H__
6
7 #include "unicode/utypes.h"
8
9 #if !UCONFIG_NO_FORMATTING
10
11 #include "unicode/ufieldpositer.h"
12
13 #ifndef U_HIDE_DRAFT_API
14
36 typedef enum UFieldCategory {
42 UFIELD_CATEGORY_UNDEFINED = 0,
43
49 UFIELD_CATEGORY_DATE,
50
56 UFIELD_CATEGORY_NUMBER,
57
63 UFIELD_CATEGORY_LIST,
64
70 UFIELD_CATEGORY_RELATIVE_DATETIME,
71
77 UFIELD_CATEGORY_DATE_INTERVAL,
78
79 #ifndef U_HIDE_INTERNAL_API
80
81 UFIELD_CATEGORY_COUNT,
82 #endif /* U_HIDE_INTERNAL_API */
83
89 UFIELD_CATEGORY_LIST_SPAN = 0x1000 + UFIELD_CATEGORY_LIST,
90
96 UFIELD_CATEGORY_DATE_INTERVAL_SPAN = 0x1000 + UFIELD_CATEGORY_DATE_INTERVAL,
97
98 } UFieldCategory;
99
100
101 struct UConstrainedFieldPosition;
113 typedef struct UConstrainedFieldPosition UConstrainedFieldPosition;
114
115
125 U_DRAFT UConstrainedFieldPosition* U_EXPORT2
126 ucfpos_open(UErrorCode* ec);
127
128
138 U_DRAFT void U_EXPORT2
139 ucfpos_reset(
140 UConstrainedFieldPosition* ucfpos,
141 UErrorCode* ec);
142
143
150 U_DRAFT void U_EXPORT2
151 ucfpos_close(UConstrainedFieldPosition* ucfpos);
152
153
179 U_DRAFT void U_EXPORT2
180 ucfpos_constrainCategory(
181 UConstrainedFieldPosition* ucfpos,
182 int32_t category,
183 UErrorCode* ec);
184
185
212 U_DRAFT void U_EXPORT2
213 ucfpos_constrainField(
214 UConstrainedFieldPosition* ucfpos,
215 int32_t category,
216 int32_t field,
217 UErrorCode* ec);
218
219
232 U_DRAFT int32_t U_EXPORT2
233 ucfpos_getCategory(
234 const UConstrainedFieldPosition* ucfpos,
235 UErrorCode* ec);
236
237
250 U_DRAFT int32_t U_EXPORT2
251 ucfpos_getField(
252 const UConstrainedFieldPosition* ucfpos,
253 UErrorCode* ec);
254
255
267 U_DRAFT void U_EXPORT2
268 ucfpos_getIndexes(
269 const UConstrainedFieldPosition* ucfpos,
270 int32_t* pStart,
271 int32_t* pLimit,
272 UErrorCode* ec);
273
274
287 U_DRAFT int64_t U_EXPORT2
288 ucfpos_getInt64IterationContext(
289 const UConstrainedFieldPosition* ucfpos,
290 UErrorCode* ec);
291
292
303 U_DRAFT void U_EXPORT2
304 ucfpos_setInt64IterationContext(
305 UConstrainedFieldPosition* ucfpos,
306 int64_t context,
307 UErrorCode* ec);
308
309
322 U_DRAFT UBool U_EXPORT2
323 ucfpos_matchesField(
324 const UConstrainedFieldPosition* ucfpos,
325 int32_t category,
326 int32_t field,
327 UErrorCode* ec);
328
329
346 U_DRAFT void U_EXPORT2
347 ucfpos_setState(
348 UConstrainedFieldPosition* ucfpos,
349 int32_t category,
350 int32_t field,
351 int32_t start,
352 int32_t limit,
353 UErrorCode* ec);
354
355
356 struct UFormattedValue;
363 typedef struct UFormattedValue UFormattedValue;
364
365
379 U_DRAFT const UChar* U_EXPORT2
380 ufmtval_getString(
381 const UFormattedValue* ufmtval,
382 int32_t* pLength,
383 UErrorCode* ec);
384
385
409 U_DRAFT UBool U_EXPORT2
410 ufmtval_nextPosition(
411 const UFormattedValue* ufmtval,
412 UConstrainedFieldPosition* ucfpos,
413 UErrorCode* ec);
414
415
416 #if U_SHOW_CPLUSPLUS_API
417 U_NAMESPACE_BEGIN
418
431 U_DEFINE_LOCAL_OPEN_POINTER(LocalUConstrainedFieldPositionPointer,
432 UConstrainedFieldPosition,
433 ucfpos_close);
434
435 U_NAMESPACE_END
436 #endif // U_SHOW_CPLUSPLUS_API
437
438
439 #endif /* U_HIDE_DRAFT_API */
440 #endif /* #if !UCONFIG_NO_FORMATTING */
441 #endif // __UFORMATTEDVALUE_H__
LocalUConstrainedFieldPositionPointer
"Smart pointer" class; closes a UConstrainedFieldPosition via ucfpos_close().
ucfpos_setInt64IterationContext
void ucfpos_setInt64IterationContext(UConstrainedFieldPosition *ucfpos, int64_t context, UErrorCode *ec)
Sets an int64 that FormattedValue implementations may use for storage.
UFIELD_CATEGORY_DATE
For fields in UDateFormatField (udat.h), from ICU 3.0.
Definition: uformattedvalue.h:49
UFIELD_CATEGORY_DATE_INTERVAL_SPAN
Category for spans in a date interval.
Definition: uformattedvalue.h:96
ufmtval_nextPosition
UBool ufmtval_nextPosition(const UFormattedValue *ufmtval, UConstrainedFieldPosition *ucfpos, UErrorCode *ec)
Iterates over field positions in the UFormattedValue.
UFIELD_CATEGORY_COUNT
Definition: uformattedvalue.h:81
UFIELD_CATEGORY_LIST
For fields in UListFormatterField (ulistformatter.h), from ICU 63.
Definition: uformattedvalue.h:63
ucfpos_getField
int32_t ucfpos_getField(const UConstrainedFieldPosition *ucfpos, UErrorCode *ec)
Gets the field for the current position.
UFIELD_CATEGORY_UNDEFINED
For an undefined field category.
Definition: uformattedvalue.h:42
ucfpos_getCategory
int32_t ucfpos_getCategory(const UConstrainedFieldPosition *ucfpos, UErrorCode *ec)
Gets the field category for the current position.
UFieldCategory
UFieldCategory
All possible field categories in ICU.
Definition: uformattedvalue.h:36
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:562
ucfpos_close
void ucfpos_close(UConstrainedFieldPosition *ucfpos)
Destroys a UConstrainedFieldPosition and releases its memory.
ucfpos_reset
void ucfpos_reset(UConstrainedFieldPosition *ucfpos, UErrorCode *ec)
Resets a UConstrainedFieldPosition to its initial state, as if it were newly created.
UFIELD_CATEGORY_LIST_SPAN
Category for spans in a list.
Definition: uformattedvalue.h:89
UChar
uint16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:378
ucfpos_constrainCategory
void ucfpos_constrainCategory(UConstrainedFieldPosition *ucfpos, int32_t category, UErrorCode *ec)
Sets a constraint on the field category.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
ucfpos_constrainField
void ucfpos_constrainField(UConstrainedFieldPosition *ucfpos, int32_t category, int32_t field, UErrorCode *ec)
Sets a constraint on the category and field.
ufieldpositer.h
C API: UFieldPositionIterator for use with format APIs.
ucfpos_matchesField
UBool ucfpos_matchesField(const UConstrainedFieldPosition *ucfpos, int32_t category, int32_t field, UErrorCode *ec)
Determines whether a given field should be included given the constraints.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
ucfpos_getIndexes
void ucfpos_getIndexes(const UConstrainedFieldPosition *ucfpos, int32_t *pStart, int32_t *pLimit, UErrorCode *ec)
Gets the INCLUSIVE start and EXCLUSIVE end index stored for the current position. ...
ucfpos_setState
void ucfpos_setState(UConstrainedFieldPosition *ucfpos, int32_t category, int32_t field, int32_t start, int32_t limit, UErrorCode *ec)
Sets new values for the primary public getters.
ucfpos_open
UConstrainedFieldPosition * ucfpos_open(UErrorCode *ec)
Creates a new UConstrainedFieldPosition.
UConstrainedFieldPosition
struct UConstrainedFieldPosition UConstrainedFieldPosition
Represents a span of a string containing a given field.
Definition: uformattedvalue.h:113
UFormattedValue
struct UFormattedValue UFormattedValue
An abstract formatted value: a string with associated field attributes.
Definition: uformattedvalue.h:363
ufmtval_getString
const UChar * ufmtval_getString(const UFormattedValue *ufmtval, int32_t *pLength, UErrorCode *ec)
Returns a pointer to the formatted string.
U_DRAFT
#define U_DRAFT
This is used to declare a function as a draft public ICU C API.
Definition: umachine.h:113
ucfpos_getInt64IterationContext
int64_t ucfpos_getInt64IterationContext(const UConstrainedFieldPosition *ucfpos, UErrorCode *ec)
Gets an int64 that FormattedValue implementations may use for storage.
UFIELD_CATEGORY_NUMBER
For fields in UNumberFormatFields (unum.h), from ICU 49.
Definition: uformattedvalue.h:56
UFIELD_CATEGORY_RELATIVE_DATETIME
For fields in URelativeDateTimeFormatterField (ureldatefmt.h), from ICU 64.
Definition: uformattedvalue.h:70
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:261
UFIELD_CATEGORY_DATE_INTERVAL
Reserved for possible future fields in UDateIntervalFormatField.
Definition: uformattedvalue.h:77