ICU 59.1  59.1
udatpg.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 *
6 * Copyright (C) 2007-2015, International Business Machines
7 * Corporation and others. All Rights Reserved.
8 *
9 *******************************************************************************
10 * file name: udatpg.h
11 * encoding: UTF-8
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 
48 
55 typedef enum UDateTimePatternField {
88 
89  /* Do not conditionalize the following with #ifndef U_HIDE_DEPRECATED_API,
90  * it is needed for layout of DateTimePatternGenerator object. */
97 
110 #ifndef U_HIDE_INTERNAL_API
111 
115 #endif /* U_HIDE_INTERNAL_API */
116 
119 
131 #ifndef U_HIDE_DEPRECATED_API
132 
137 #endif // U_HIDE_DEPRECATED_API
139 
149 udatpg_open(const char *locale, UErrorCode *pErrorCode);
150 
159 udatpg_openEmpty(UErrorCode *pErrorCode);
160 
166 U_STABLE void U_EXPORT2
168 
169 #if U_SHOW_CPLUSPLUS_API
170 
172 
183 
185 
186 #endif
187 
197 udatpg_clone(const UDateTimePatternGenerator *dtpg, UErrorCode *pErrorCode);
198 
222 U_STABLE int32_t U_EXPORT2
224  const UChar *skeleton, int32_t length,
225  UChar *bestPattern, int32_t capacity,
226  UErrorCode *pErrorCode);
227 
258 U_STABLE int32_t U_EXPORT2
260  const UChar *skeleton, int32_t length,
262  UChar *bestPattern, int32_t capacity,
263  UErrorCode *pErrorCode);
264 
286 U_STABLE int32_t U_EXPORT2
288  const UChar *pattern, int32_t length,
289  UChar *skeleton, int32_t capacity,
290  UErrorCode *pErrorCode);
291 
316 U_STABLE int32_t U_EXPORT2
318  const UChar *pattern, int32_t length,
319  UChar *baseSkeleton, int32_t capacity,
320  UErrorCode *pErrorCode);
321 
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
375  UDateTimePatternField field,
376  const UChar *value, int32_t length);
377 
388 U_STABLE const UChar * U_EXPORT2
390  UDateTimePatternField field,
391  int32_t *pLength);
392 
406 U_STABLE void U_EXPORT2
408  UDateTimePatternField field,
409  const UChar *value, int32_t length);
410 
421 U_STABLE const UChar * U_EXPORT2
423  UDateTimePatternField field,
424  int32_t *pLength);
425 
449 U_STABLE void U_EXPORT2
451  const UChar *dtFormat, int32_t length);
452 
460 U_STABLE const UChar * U_EXPORT2
462  int32_t *pLength);
463 
477 U_STABLE void U_EXPORT2
479  const UChar *decimal, int32_t length);
480 
489 U_STABLE const UChar * U_EXPORT2
491  int32_t *pLength);
492 
518 U_STABLE int32_t U_EXPORT2
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
557  const UChar *pattern, int32_t patternLength,
558  const UChar *skeleton, int32_t skeletonLength,
560  UChar *dest, int32_t destCapacity,
561  UErrorCode *pErrorCode);
562 
574 U_STABLE UEnumeration * U_EXPORT2
576 
587 U_STABLE UEnumeration * U_EXPORT2
589 
600 U_STABLE const UChar * U_EXPORT2
602  const UChar *skeleton, int32_t skeletonLength,
603  int32_t *pLength);
604 
605 #endif
const UChar * udatpg_getAppendItemFormat(const UDateTimePatternGenerator *dtpg, UDateTimePatternField field, int32_t *pLength)
Getter corresponding to setAppendItemFormat.
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.
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.
const UChar * udatpg_getAppendItemName(const UDateTimePatternGenerator *dtpg, UDateTimePatternField field, int32_t *pLength)
Getter corresponding to setAppendItemNames.
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.
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition: uenum.h:43
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.
"Smart pointer" class, closes a UDateTimePatternGenerator via udatpg_close().
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.
One more than the highest normal UDateTimePatternConflict value.
Definition: udatpg.h:136
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.
void udatpg_setAppendItemName(UDateTimePatternGenerator *dtpg, UDateTimePatternField field, const UChar *value, int32_t length)
Set the name of field, eg "era" in English for ERA.
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:131
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.
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:496
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
UDateTimePatternGenerator * udatpg_open(const char *locale, UErrorCode *pErrorCode)
Open a generator according to a given locale.
UDateTimePatternConflict
Status return values from udatpg_addPattern().
Definition: udatpg.h:124
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.
UEnumeration * udatpg_openSkeletons(const UDateTimePatternGenerator *dtpg, UErrorCode *pErrorCode)
Return a UEnumeration list of all the skeletons in canonical form.
UDateTimePatternGenerator * udatpg_clone(const UDateTimePatternGenerator *dtpg, UErrorCode *pErrorCode)
Create a copy pf a generator.
One more than the highest normal UDateTimePatternField value.
Definition: udatpg.h:95
uint16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:349
void udatpg_close(UDateTimePatternGenerator *dtpg)
Close a generator.
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:132
UDateTimePatternField
Field number constants for udatpg_getAppendItemFormats() and similar functions.
Definition: udatpg.h:55
void * UDateTimePatternGenerator
Opaque type for a date/time pattern generator object.
Definition: udatpg.h:47
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:396
UEnumeration * udatpg_openBaseSkeletons(const UDateTimePatternGenerator *dtpg, UErrorCode *pErrorCode)
Return a UEnumeration list of all the base skeletons in canonical form.
UDateTimePatternGenerator * udatpg_openEmpty(UErrorCode *pErrorCode)
Open an empty generator, to be constructed with udatpg_addPattern(...) etc.
C API: String Enumeration.
void udatpg_setDecimal(UDateTimePatternGenerator *dtpg, const UChar *decimal, int32_t length)
The decimal value is used in formatting fractions of seconds.
const UChar * udatpg_getDecimal(const UDateTimePatternGenerator *dtpg, int32_t *pLength)
Getter corresponding to setDecimal.
Basic definitions for ICU, for both C and C++ APIs.
const UChar * udatpg_getDateTimeFormat(const UDateTimePatternGenerator *dtpg, int32_t *pLength)
Getter corresponding to setDateTimeFormat.
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
Masks to control forcing the length of specified fields in the returned pattern to match those in the...
Definition: udatpg.h:105
const UChar * udatpg_getPatternForSkeleton(const UDateTimePatternGenerator *dtpg, const UChar *skeleton, int32_t skeletonLength, int32_t *pLength)
Get the pattern corresponding to a given skeleton.
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:111
int8_t UBool
The ICU boolean type.
Definition: umachine.h:236