ICU 50.1.2  50.1.2
udatpg.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 *
4 * Copyright (C) 2007-2012, International Business Machines
5 * Corporation and others. All Rights Reserved.
6 *
7 *******************************************************************************
8 * file name: udatpg.h
9 * encoding: US-ASCII
10 * tab size: 8 (not used)
11 * indentation:4
12 *
13 * created on: 2007jul30
14 * created by: Markus W. Scherer
15 */
16 
17 #ifndef __UDATPG_H__
18 #define __UDATPG_H__
19 
20 #include "unicode/utypes.h"
21 #include "unicode/uenum.h"
22 #include "unicode/localpointer.h"
23 
46 
53 typedef enum UDateTimePatternField {
89 
102 #ifndef U_HIDE_INTERNAL_API
103 
107 #endif /* U_HIDE_INTERNAL_API */
108 
111 
126 
136 udatpg_open(const char *locale, UErrorCode *pErrorCode);
137 
146 udatpg_openEmpty(UErrorCode *pErrorCode);
147 
153 U_STABLE void U_EXPORT2
155 
156 #if U_SHOW_CPLUSPLUS_API
157 
159 
170 
172 
173 #endif
174 
184 udatpg_clone(const UDateTimePatternGenerator *dtpg, UErrorCode *pErrorCode);
185 
209 U_STABLE int32_t U_EXPORT2
211  const UChar *skeleton, int32_t length,
212  UChar *bestPattern, int32_t capacity,
213  UErrorCode *pErrorCode);
214 
245 U_STABLE int32_t U_EXPORT2
247  const UChar *skeleton, int32_t length,
249  UChar *bestPattern, int32_t capacity,
250  UErrorCode *pErrorCode);
251 
272 U_STABLE int32_t U_EXPORT2
274  const UChar *pattern, int32_t length,
275  UChar *skeleton, int32_t capacity,
276  UErrorCode *pErrorCode);
277 
301 U_STABLE int32_t U_EXPORT2
303  const UChar *pattern, int32_t length,
304  UChar *baseSkeleton, int32_t capacity,
305  UErrorCode *pErrorCode);
306 
333  const UChar *pattern, int32_t patternLength,
334  UBool override,
335  UChar *conflictingPattern, int32_t capacity, int32_t *pLength,
336  UErrorCode *pErrorCode);
337 
358 U_STABLE void U_EXPORT2
360  UDateTimePatternField field,
361  const UChar *value, int32_t length);
362 
373 U_STABLE const UChar * U_EXPORT2
375  UDateTimePatternField field,
376  int32_t *pLength);
377 
391 U_STABLE void U_EXPORT2
393  UDateTimePatternField field,
394  const UChar *value, int32_t length);
395 
406 U_STABLE const UChar * U_EXPORT2
408  UDateTimePatternField field,
409  int32_t *pLength);
410 
432 U_STABLE void U_EXPORT2
434  const UChar *dtFormat, int32_t length);
435 
443 U_STABLE const UChar * U_EXPORT2
445  int32_t *pLength);
446 
460 U_STABLE void U_EXPORT2
462  const UChar *decimal, int32_t length);
463 
472 U_STABLE const UChar * U_EXPORT2
474  int32_t *pLength);
475 
501 U_STABLE int32_t U_EXPORT2
503  const UChar *pattern, int32_t patternLength,
504  const UChar *skeleton, int32_t skeletonLength,
505  UChar *dest, int32_t destCapacity,
506  UErrorCode *pErrorCode);
507 
538 U_STABLE int32_t U_EXPORT2
540  const UChar *pattern, int32_t patternLength,
541  const UChar *skeleton, int32_t skeletonLength,
543  UChar *dest, int32_t destCapacity,
544  UErrorCode *pErrorCode);
545 
557 U_STABLE UEnumeration * U_EXPORT2
559 
570 U_STABLE UEnumeration * U_EXPORT2
572 
583 U_STABLE const UChar * U_EXPORT2
585  const UChar *skeleton, int32_t skeletonLength,
586  int32_t *pLength);
587 
588 #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 *dtpg, 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:39
void udatpg_setDateTimeFormat(const UDateTimePatternGenerator *dtpg, const UChar *dtFormat, int32_t length)
The date time format is a message format pattern used to compose date and time patterns.
"Smart pointer" class, closes a UDateTimePatternGenerator via udatpg_close().
int32_t udatpg_getBaseSkeleton(UDateTimePatternGenerator *dtpg, const UChar *pattern, int32_t length, UChar *baseSkeleton, int32_t capacity, UErrorCode *pErrorCode)
Get a unique base skeleton from a given pattern.
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.
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:129
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:290
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:116
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.
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:278
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:130
UDateTimePatternField
Field number constants for udatpg_getAppendItemFormats() and similar functions.
Definition: udatpg.h:53
void * UDateTimePatternGenerator
Opaque type for a date/time pattern generator object.
Definition: udatpg.h:45
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
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:97
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:109
int8_t UBool
The ICU boolean type.
Definition: umachine.h:200