ICU 58.2 58.2

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

udatpg.h
Go to the documentation of this file.
1 // Copyright (C) 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 *******************************************************************************
5 *
6 * Copyright (C) 2007-2015, International Business Machines
7 * Corporation and others. All Rights Reserved.
8 *
9 *******************************************************************************
10 * file name: udatpg.h
11 * encoding: US-ASCII
12 * tab size: 8 (not used)
13 * indentation:4
14 *
15 * created on: 2007jul30
16 * created by: Markus W. Scherer
17 */
18
19 #ifndef __UDATPG_H__
20 #define __UDATPG_H__
21
22 #include "unicode/utypes.h"
23 #include "unicode/uenum.h"
24 #include "unicode/localpointer.h"
25
47 typedef void *UDateTimePatternGenerator;
48
55 typedef enum UDateTimePatternField {
57 UDATPG_ERA_FIELD,
59 UDATPG_YEAR_FIELD,
61 UDATPG_QUARTER_FIELD,
63 UDATPG_MONTH_FIELD,
65 UDATPG_WEEK_OF_YEAR_FIELD,
67 UDATPG_WEEK_OF_MONTH_FIELD,
69 UDATPG_WEEKDAY_FIELD,
71 UDATPG_DAY_OF_YEAR_FIELD,
73 UDATPG_DAY_OF_WEEK_IN_MONTH_FIELD,
75 UDATPG_DAY_FIELD,
77 UDATPG_DAYPERIOD_FIELD,
79 UDATPG_HOUR_FIELD,
81 UDATPG_MINUTE_FIELD,
83 UDATPG_SECOND_FIELD,
85 UDATPG_FRACTIONAL_SECOND_FIELD,
87 UDATPG_ZONE_FIELD,
88
89 // Do not conditionalize the following with #ifndef U_HIDE_DEPRECATED_API,
90 // it is needed for layout of DateTimePatternGenerator object.
95 UDATPG_FIELD_COUNT
96 } UDateTimePatternField;
97
105 typedef enum UDateTimePatternMatchOptions {
107 UDATPG_MATCH_NO_OPTIONS = 0,
109 UDATPG_MATCH_HOUR_FIELD_LENGTH = 1 << UDATPG_HOUR_FIELD,
110 #ifndef U_HIDE_INTERNAL_API
111
112 UDATPG_MATCH_MINUTE_FIELD_LENGTH = 1 << UDATPG_MINUTE_FIELD,
114 UDATPG_MATCH_SECOND_FIELD_LENGTH = 1 << UDATPG_SECOND_FIELD,
115 #endif /* U_HIDE_INTERNAL_API */
116
117 UDATPG_MATCH_ALL_FIELDS_LENGTH = (1 << UDATPG_FIELD_COUNT) - 1
118 } UDateTimePatternMatchOptions;
119
124 typedef enum UDateTimePatternConflict {
126 UDATPG_NO_CONFLICT,
128 UDATPG_BASE_CONFLICT,
130 UDATPG_CONFLICT,
131 #ifndef U_HIDE_DEPRECATED_API
132
136 UDATPG_CONFLICT_COUNT
137 #endif // U_HIDE_DEPRECATED_API
138 } UDateTimePatternConflict;
139
148 U_STABLE UDateTimePatternGenerator * U_EXPORT2
149 udatpg_open(const char *locale, UErrorCode *pErrorCode);
150
158 U_STABLE UDateTimePatternGenerator * U_EXPORT2
159 udatpg_openEmpty(UErrorCode *pErrorCode);
160
166 U_STABLE void U_EXPORT2
167 udatpg_close(UDateTimePatternGenerator *dtpg);
168
169 #if U_SHOW_CPLUSPLUS_API
170
171 U_NAMESPACE_BEGIN
172
182 U_DEFINE_LOCAL_OPEN_POINTER(LocalUDateTimePatternGeneratorPointer, UDateTimePatternGenerator, udatpg_close);
183
184 U_NAMESPACE_END
185
186 #endif
187
196 U_STABLE UDateTimePatternGenerator * U_EXPORT2
197 udatpg_clone(const UDateTimePatternGenerator *dtpg, UErrorCode *pErrorCode);
198
222 U_STABLE int32_t U_EXPORT2
223 udatpg_getBestPattern(UDateTimePatternGenerator *dtpg,
224 const UChar *skeleton, int32_t length,
225 UChar *bestPattern, int32_t capacity,
226 UErrorCode *pErrorCode);
227
258 U_STABLE int32_t U_EXPORT2
259 udatpg_getBestPatternWithOptions(UDateTimePatternGenerator *dtpg,
260 const UChar *skeleton, int32_t length,
261 UDateTimePatternMatchOptions options,
262 UChar *bestPattern, int32_t capacity,
263 UErrorCode *pErrorCode);
264
286 U_STABLE int32_t U_EXPORT2
287 udatpg_getSkeleton(UDateTimePatternGenerator *unusedDtpg,
288 const UChar *pattern, int32_t length,
289 UChar *skeleton, int32_t capacity,
290 UErrorCode *pErrorCode);
291
316 U_STABLE int32_t U_EXPORT2
317 udatpg_getBaseSkeleton(UDateTimePatternGenerator *unusedDtpg,
318 const UChar *pattern, int32_t length,
319 UChar *baseSkeleton, int32_t capacity,
320 UErrorCode *pErrorCode);
321
346 U_STABLE UDateTimePatternConflict U_EXPORT2
347 udatpg_addPattern(UDateTimePatternGenerator *dtpg,
348 const UChar *pattern, int32_t patternLength,
349 UBool override,
350 UChar *conflictingPattern, int32_t capacity, int32_t *pLength,
351 UErrorCode *pErrorCode);
352
373 U_STABLE void U_EXPORT2
374 udatpg_setAppendItemFormat(UDateTimePatternGenerator *dtpg,
375 UDateTimePatternField field,
376 const UChar *value, int32_t length);
377
388 U_STABLE const UChar * U_EXPORT2
389 udatpg_getAppendItemFormat(const UDateTimePatternGenerator *dtpg,
390 UDateTimePatternField field,
391 int32_t *pLength);
392
406 U_STABLE void U_EXPORT2
407 udatpg_setAppendItemName(UDateTimePatternGenerator *dtpg,
408 UDateTimePatternField field,
409 const UChar *value, int32_t length);
410
421 U_STABLE const UChar * U_EXPORT2
422 udatpg_getAppendItemName(const UDateTimePatternGenerator *dtpg,
423 UDateTimePatternField field,
424 int32_t *pLength);
425
449 U_STABLE void U_EXPORT2
450 udatpg_setDateTimeFormat(const UDateTimePatternGenerator *dtpg,
451 const UChar *dtFormat, int32_t length);
452
460 U_STABLE const UChar * U_EXPORT2
461 udatpg_getDateTimeFormat(const UDateTimePatternGenerator *dtpg,
462 int32_t *pLength);
463
477 U_STABLE void U_EXPORT2
478 udatpg_setDecimal(UDateTimePatternGenerator *dtpg,
479 const UChar *decimal, int32_t length);
480
489 U_STABLE const UChar * U_EXPORT2
490 udatpg_getDecimal(const UDateTimePatternGenerator *dtpg,
491 int32_t *pLength);
492
518 U_STABLE int32_t U_EXPORT2
519 udatpg_replaceFieldTypes(UDateTimePatternGenerator *dtpg,
520 const UChar *pattern, int32_t patternLength,
521 const UChar *skeleton, int32_t skeletonLength,
522 UChar *dest, int32_t destCapacity,
523 UErrorCode *pErrorCode);
524
555 U_STABLE int32_t U_EXPORT2
556 udatpg_replaceFieldTypesWithOptions(UDateTimePatternGenerator *dtpg,
557 const UChar *pattern, int32_t patternLength,
558 const UChar *skeleton, int32_t skeletonLength,
559 UDateTimePatternMatchOptions options,
560 UChar *dest, int32_t destCapacity,
561 UErrorCode *pErrorCode);
562
574 U_STABLE UEnumeration * U_EXPORT2
575 udatpg_openSkeletons(const UDateTimePatternGenerator *dtpg, UErrorCode *pErrorCode);
576
587 U_STABLE UEnumeration * U_EXPORT2
588 udatpg_openBaseSkeletons(const UDateTimePatternGenerator *dtpg, UErrorCode *pErrorCode);
589
600 U_STABLE const UChar * U_EXPORT2
601 udatpg_getPatternForSkeleton(const UDateTimePatternGenerator *dtpg,
602 const UChar *skeleton, int32_t skeletonLength,
603 int32_t *pLength);
604
605 #endif
udatpg_getAppendItemFormat
const UChar * udatpg_getAppendItemFormat(const UDateTimePatternGenerator *dtpg, UDateTimePatternField field, int32_t *pLength)
Getter corresponding to setAppendItemFormat.
udatpg_getBestPatternWithOptions
int32_t udatpg_getBestPatternWithOptions(UDateTimePatternGenerator *dtpg, const UChar *skeleton, int32_t length, UDateTimePatternMatchOptions options, UChar *bestPattern, int32_t capacity, UErrorCode *pErrorCode)
Get the best pattern matching the input skeleton.
UDATPG_MATCH_SECOND_FIELD_LENGTH
Definition: udatpg.h:114
UDATPG_HOUR_FIELD
Definition: udatpg.h:79
udatpg_getSkeleton
int32_t udatpg_getSkeleton(UDateTimePatternGenerator *unusedDtpg, const UChar *pattern, int32_t length, UChar *skeleton, int32_t capacity, UErrorCode *pErrorCode)
Get a unique skeleton from a given pattern.
UDATPG_ERA_FIELD
Definition: udatpg.h:57
UDATPG_NO_CONFLICT
Definition: udatpg.h:126
udatpg_getAppendItemName
const UChar * udatpg_getAppendItemName(const UDateTimePatternGenerator *dtpg, UDateTimePatternField field, int32_t *pLength)
Getter corresponding to setAppendItemNames.
udatpg_replaceFieldTypes
int32_t udatpg_replaceFieldTypes(UDateTimePatternGenerator *dtpg, const UChar *pattern, int32_t patternLength, const UChar *skeleton, int32_t skeletonLength, UChar *dest, int32_t destCapacity, UErrorCode *pErrorCode)
Adjusts the field types (width and subtype) of a pattern to match what is in a skeleton.
UEnumeration
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition: uenum.h:41
UDATPG_MONTH_FIELD
Definition: udatpg.h:63
udatpg_setDateTimeFormat
void udatpg_setDateTimeFormat(const UDateTimePatternGenerator *dtpg, const UChar *dtFormat, int32_t length)
The DateTimeFormat is a message format pattern used to compose date and time patterns.
UDATPG_WEEKDAY_FIELD
Definition: udatpg.h:69
UDATPG_SECOND_FIELD
Definition: udatpg.h:83
LocalUDateTimePatternGeneratorPointer
"Smart pointer" class, closes a UDateTimePatternGenerator via udatpg_close().
UDATPG_CONFLICT
Definition: udatpg.h:130
udatpg_getBestPattern
int32_t udatpg_getBestPattern(UDateTimePatternGenerator *dtpg, const UChar *skeleton, int32_t length, UChar *bestPattern, int32_t capacity, UErrorCode *pErrorCode)
Get the best pattern matching the input skeleton.
UDATPG_MINUTE_FIELD
Definition: udatpg.h:81
UDATPG_WEEK_OF_YEAR_FIELD
Definition: udatpg.h:65
UDATPG_CONFLICT_COUNT
One more than the highest normal UDateTimePatternConflict value.
Definition: udatpg.h:136
udatpg_setAppendItemFormat
void udatpg_setAppendItemFormat(UDateTimePatternGenerator *dtpg, UDateTimePatternField field, const UChar *value, int32_t length)
An AppendItem format is a pattern used to append a field if there is no good match.
UDATPG_DAYPERIOD_FIELD
Definition: udatpg.h:77
udatpg_setAppendItemName
void udatpg_setAppendItemName(UDateTimePatternGenerator *dtpg, UDateTimePatternField field, const UChar *value, int32_t length)
Set the name of field, eg "era" in English for ERA.
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:131
udatpg_addPattern
UDateTimePatternConflict udatpg_addPattern(UDateTimePatternGenerator *dtpg, const UChar *pattern, int32_t patternLength, UBool override, UChar *conflictingPattern, int32_t capacity, int32_t *pLength, UErrorCode *pErrorCode)
Adds a pattern to the generator.
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:530
UDATPG_MATCH_MINUTE_FIELD_LENGTH
Definition: udatpg.h:112
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
udatpg_open
UDateTimePatternGenerator * udatpg_open(const char *locale, UErrorCode *pErrorCode)
Open a generator according to a given locale.
UDATPG_DAY_OF_YEAR_FIELD
Definition: udatpg.h:71
UDATPG_MATCH_NO_OPTIONS
Definition: udatpg.h:107
UDATPG_DAY_FIELD
Definition: udatpg.h:75
UDateTimePatternConflict
UDateTimePatternConflict
Status return values from udatpg_addPattern().
Definition: udatpg.h:124
UDATPG_YEAR_FIELD
Definition: udatpg.h:59
udatpg_getBaseSkeleton
int32_t udatpg_getBaseSkeleton(UDateTimePatternGenerator *unusedDtpg, const UChar *pattern, int32_t length, UChar *baseSkeleton, int32_t capacity, UErrorCode *pErrorCode)
Get a unique base skeleton from a given pattern.
udatpg_openSkeletons
UEnumeration * udatpg_openSkeletons(const UDateTimePatternGenerator *dtpg, UErrorCode *pErrorCode)
Return a UEnumeration list of all the skeletons in canonical form.
udatpg_clone
UDateTimePatternGenerator * udatpg_clone(const UDateTimePatternGenerator *dtpg, UErrorCode *pErrorCode)
Create a copy pf a generator.
UDATPG_FIELD_COUNT
One more than the highest normal UDateTimePatternField value.
Definition: udatpg.h:95
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:337
udatpg_close
void udatpg_close(UDateTimePatternGenerator *dtpg)
Close a generator.
UDATPG_WEEK_OF_MONTH_FIELD
Definition: udatpg.h:67
U_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:132
UDateTimePatternField
UDateTimePatternField
Field number constants for udatpg_getAppendItemFormats() and similar functions.
Definition: udatpg.h:55
UDATPG_MATCH_ALL_FIELDS_LENGTH
Definition: udatpg.h:117
UDateTimePatternGenerator
void * UDateTimePatternGenerator
Opaque type for a date/time pattern generator object.
Definition: udatpg.h:47
UDATPG_ZONE_FIELD
Definition: udatpg.h:87
UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:396
udatpg_openBaseSkeletons
UEnumeration * udatpg_openBaseSkeletons(const UDateTimePatternGenerator *dtpg, UErrorCode *pErrorCode)
Return a UEnumeration list of all the base skeletons in canonical form.
udatpg_openEmpty
UDateTimePatternGenerator * udatpg_openEmpty(UErrorCode *pErrorCode)
Open an empty generator, to be constructed with udatpg_addPattern(...) etc.
UDATPG_DAY_OF_WEEK_IN_MONTH_FIELD
Definition: udatpg.h:73
UDATPG_MATCH_HOUR_FIELD_LENGTH
Definition: udatpg.h:109
uenum.h
C API: String Enumeration.
udatpg_setDecimal
void udatpg_setDecimal(UDateTimePatternGenerator *dtpg, const UChar *decimal, int32_t length)
The decimal value is used in formatting fractions of seconds.
udatpg_getDecimal
const UChar * udatpg_getDecimal(const UDateTimePatternGenerator *dtpg, int32_t *pLength)
Getter corresponding to setDecimal.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
udatpg_getDateTimeFormat
const UChar * udatpg_getDateTimeFormat(const UDateTimePatternGenerator *dtpg, int32_t *pLength)
Getter corresponding to setDateTimeFormat.
udatpg_replaceFieldTypesWithOptions
int32_t udatpg_replaceFieldTypesWithOptions(UDateTimePatternGenerator *dtpg, const UChar *pattern, int32_t patternLength, const UChar *skeleton, int32_t skeletonLength, UDateTimePatternMatchOptions options, UChar *dest, int32_t destCapacity, UErrorCode *pErrorCode)
Adjusts the field types (width and subtype) of a pattern to match what is in a skeleton.
UDateTimePatternMatchOptions
UDateTimePatternMatchOptions
Masks to control forcing the length of specified fields in the returned pattern to match those in the...
Definition: udatpg.h:105
UDATPG_QUARTER_FIELD
Definition: udatpg.h:61
udatpg_getPatternForSkeleton
const UChar * udatpg_getPatternForSkeleton(const UDateTimePatternGenerator *dtpg, const UChar *skeleton, int32_t skeletonLength, int32_t *pLength)
Get the pattern corresponding to a given skeleton.
U_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:134
UDATPG_FRACTIONAL_SECOND_FIELD
Definition: udatpg.h:85
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:259
UDATPG_BASE_CONFLICT
Definition: udatpg.h:128