ICU 64.2 64.2

dtptngen.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) 2007-2016, International Business Machines Corporation and
6 * others. All Rights Reserved.
7 *******************************************************************************
8 *
9 * File DTPTNGEN.H
10 *
11 *******************************************************************************
12 */
13
14 #ifndef __DTPTNGEN_H__
15 #define __DTPTNGEN_H__
16
17 #include "unicode/datefmt.h"
18 #include "unicode/locid.h"
19 #include "unicode/udat.h"
20 #include "unicode/udatpg.h"
21 #include "unicode/unistr.h"
22
23 U_NAMESPACE_BEGIN
24
31 class CharString;
32 class Hashtable;
33 class FormatParser;
34 class DateTimeMatcher;
35 class DistanceInfo;
36 class PatternMap;
37 class PtnSkeleton;
38 class SharedDateTimePatternGenerator;
39
54 class U_I18N_API DateTimePatternGenerator : public UObject {
55 public:
62 static DateTimePatternGenerator* U_EXPORT2 createInstance(UErrorCode& status);
63
71 static DateTimePatternGenerator* U_EXPORT2 createInstance(const Locale& uLocale, UErrorCode& status);
72
73 #ifndef U_HIDE_INTERNAL_API
74
80 static DateTimePatternGenerator* U_EXPORT2 internalMakeInstance(const Locale& uLocale, UErrorCode& status);
81
82 #endif /* U_HIDE_INTERNAL_API */
83
90 static DateTimePatternGenerator* U_EXPORT2 createEmptyInstance(UErrorCode& status);
91
96 virtual ~DateTimePatternGenerator();
97
103 DateTimePatternGenerator* clone() const;
104
112 UBool operator==(const DateTimePatternGenerator& other) const;
113
121 UBool operator!=(const DateTimePatternGenerator& other) const;
122
133 static UnicodeString staticGetSkeleton(const UnicodeString& pattern, UErrorCode& status);
134
147 UnicodeString getSkeleton(const UnicodeString& pattern, UErrorCode& status); /* {
148 The function is commented out because it is a stable API calling a draft API.
149 After staticGetSkeleton becomes stable, staticGetSkeleton can be used and
150 these comments and the definition of getSkeleton in dtptngen.cpp should be removed.
151 return staticGetSkeleton(pattern, status);
152 }*/
153
167 static UnicodeString staticGetBaseSkeleton(const UnicodeString& pattern, UErrorCode& status);
168
184 UnicodeString getBaseSkeleton(const UnicodeString& pattern, UErrorCode& status); /* {
185 The function is commented out because it is a stable API calling a draft API.
186 After staticGetBaseSkeleton becomes stable, staticGetBaseSkeleton can be used and
187 these comments and the definition of getBaseSkeleton in dtptngen.cpp should be removed.
188 return staticGetBaseSkeleton(pattern, status);
189 }*/
190
216 UDateTimePatternConflict addPattern(const UnicodeString& pattern,
217 UBool override,
218 UnicodeString& conflictingPattern,
219 UErrorCode& status);
220
239 void setAppendItemFormat(UDateTimePatternField field, const UnicodeString& value);
240
249 const UnicodeString& getAppendItemFormat(UDateTimePatternField field) const;
250
262 void setAppendItemName(UDateTimePatternField field, const UnicodeString& value);
263
274 const UnicodeString& getAppendItemName(UDateTimePatternField field) const;
275
285 UnicodeString getFieldDisplayName(UDateTimePatternField field, UDateTimePGDisplayWidth width) const;
286
308 void setDateTimeFormat(const UnicodeString& dateTimeFormat);
309
315 const UnicodeString& getDateTimeFormat() const;
316
335 UnicodeString getBestPattern(const UnicodeString& skeleton, UErrorCode& status);
336
337
357 UnicodeString getBestPattern(const UnicodeString& skeleton,
358 UDateTimePatternMatchOptions options,
359 UErrorCode& status);
360
361
383 UnicodeString replaceFieldTypes(const UnicodeString& pattern,
384 const UnicodeString& skeleton,
385 UErrorCode& status);
386
409 UnicodeString replaceFieldTypes(const UnicodeString& pattern,
410 const UnicodeString& skeleton,
411 UDateTimePatternMatchOptions options,
412 UErrorCode& status);
413
425 StringEnumeration* getSkeletons(UErrorCode& status) const;
426
433 const UnicodeString& getPatternForSkeleton(const UnicodeString& skeleton) const;
434
444 StringEnumeration* getBaseSkeletons(UErrorCode& status) const;
445
446 #ifndef U_HIDE_INTERNAL_API
447
459 StringEnumeration* getRedundants(UErrorCode& status);
460 #endif /* U_HIDE_INTERNAL_API */
461
473 void setDecimal(const UnicodeString& decimal);
474
480 const UnicodeString& getDecimal() const;
481
487 virtual UClassID getDynamicClassID() const;
488
494 static UClassID U_EXPORT2 getStaticClassID(void);
495
496 private:
500 DateTimePatternGenerator(UErrorCode & status);
501
505 DateTimePatternGenerator(const Locale& locale, UErrorCode & status);
506
511 DateTimePatternGenerator(const DateTimePatternGenerator& other);
512
517 DateTimePatternGenerator& operator=(const DateTimePatternGenerator& other);
518
519 // TODO(ticket:13619): re-enable when UDATPG_NARROW no longer in draft mode.
520 // static const int32_t UDATPG_WIDTH_COUNT = UDATPG_NARROW + 1;
521
522 Locale pLocale; // pattern locale
523 FormatParser *fp;
524 DateTimeMatcher* dtMatcher;
525 DistanceInfo *distanceInfo;
526 PatternMap *patternMap;
527 UnicodeString appendItemFormats[UDATPG_FIELD_COUNT];
528 // TODO(ticket:13619): [3] -> UDATPG_WIDTH_COUNT
529 UnicodeString fieldDisplayNames[UDATPG_FIELD_COUNT][3];
530 UnicodeString dateTimeFormat;
531 UnicodeString decimal;
532 DateTimeMatcher *skipMatcher;
533 Hashtable *fAvailableFormatKeyHash;
534 UnicodeString emptyString;
535 char16_t fDefaultHourFormatChar;
536
537 int32_t fAllowedHourFormats[7]; // Actually an array of AllowedHourFormat enum type, ending with UNKNOWN.
538
539 // Internal error code used for recording/reporting errors that occur during methods that do not
540 // have a UErrorCode parameter. For example: the Copy Constructor, or the ::clone() method.
541 // When this is set to an error the object is in an invalid state.
542 UErrorCode internalErrorCode;
543
544 /* internal flags masks for adjustFieldTypes etc. */
545 enum {
546 kDTPGNoFlags = 0,
547 kDTPGFixFractionalSeconds = 1,
548 kDTPGSkeletonUsesCapJ = 2
549 // with #13183, no longer need flags for b, B
550 };
551
552 void initData(const Locale &locale, UErrorCode &status);
553 void addCanonicalItems(UErrorCode &status);
554 void addICUPatterns(const Locale& locale, UErrorCode& status);
555 void hackTimes(const UnicodeString& hackPattern, UErrorCode& status);
556 void getCalendarTypeToUse(const Locale& locale, CharString& destination, UErrorCode& err);
557 void consumeShortTimePattern(const UnicodeString& shortTimePattern, UErrorCode& status);
558 void addCLDRData(const Locale& locale, UErrorCode& status);
559 UDateTimePatternConflict addPatternWithSkeleton(const UnicodeString& pattern, const UnicodeString * skeletonToUse, UBool override, UnicodeString& conflictingPattern, UErrorCode& status);
560 void initHashtable(UErrorCode& status);
561 void setDateTimeFromCalendar(const Locale& locale, UErrorCode& status);
562 void setDecimalSymbols(const Locale& locale, UErrorCode& status);
563 UDateTimePatternField getAppendFormatNumber(const char* field) const;
564 #ifndef U_HIDE_DRAFT_API
565 // The following three have to be U_HIDE_DRAFT_API (though private) because UDateTimePGDisplayWidth is
566 UDateTimePatternField getFieldAndWidthIndices(const char* key, UDateTimePGDisplayWidth* widthP) const;
567 void setFieldDisplayName(UDateTimePatternField field, UDateTimePGDisplayWidth width, const UnicodeString& value);
568 UnicodeString& getMutableFieldDisplayName(UDateTimePatternField field, UDateTimePGDisplayWidth width);
569 #endif // U_HIDE_DRAFT_API
570 void getAppendName(UDateTimePatternField field, UnicodeString& value);
571 UnicodeString mapSkeletonMetacharacters(const UnicodeString& patternForm, int32_t* flags, UErrorCode& status);
572 const UnicodeString* getBestRaw(DateTimeMatcher& source, int32_t includeMask, DistanceInfo* missingFields, UErrorCode& status, const PtnSkeleton** specifiedSkeletonPtr = 0);
573 UnicodeString adjustFieldTypes(const UnicodeString& pattern, const PtnSkeleton* specifiedSkeleton, int32_t flags, UDateTimePatternMatchOptions options = UDATPG_MATCH_NO_OPTIONS);
574 UnicodeString getBestAppending(int32_t missingFields, int32_t flags, UErrorCode& status, UDateTimePatternMatchOptions options = UDATPG_MATCH_NO_OPTIONS);
575 int32_t getTopBitNumber(int32_t foundMask) const;
576 void setAvailableFormat(const UnicodeString &key, UErrorCode& status);
577 UBool isAvailableFormatSet(const UnicodeString &key) const;
578 void copyHashtable(Hashtable *other, UErrorCode &status);
579 UBool isCanonicalItem(const UnicodeString& item) const;
580 static void U_CALLCONV loadAllowedHourFormatsData(UErrorCode &status);
581 void getAllowedHourFormats(const Locale &locale, UErrorCode &status);
582
583 struct AppendItemFormatsSink;
584 struct AppendItemNamesSink;
585 struct AvailableFormatsSink;
586 } ;// end class DateTimePatternGenerator
587
588 U_NAMESPACE_END
589
590 #endif
icu::DateTimePatternGenerator
This class provides flexible generation of date format patterns, like "yy-MM-dd".
Definition: dtptngen.h:54
unistr.h
C++ API: Unicode String.
icu::operator==
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
U_CALLCONV
#define U_CALLCONV
Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...
Definition: platform.h:840
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:93
icu::StringEnumeration
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:57
U_I18N_API
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition: utypes.h:301
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:137
udatpg.h
C API: Wrapper for icu::DateTimePatternGenerator (unicode/dtptngen.h).
icu::operator!=
UBool operator!=(const StringPiece &x, const StringPiece &y)
Global operator != for StringPiece.
Definition: stringpiece.h:218
udat.h
C API: DateFormat.
icu::UObject::getDynamicClassID
virtual UClassID getDynamicClassID() const
ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class.
UDATPG_MATCH_NO_OPTIONS
Definition: udatpg.h:120
UDateTimePatternConflict
UDateTimePatternConflict
Status return values from udatpg_addPattern().
Definition: udatpg.h:137
UDATPG_FIELD_COUNT
One more than the highest normal UDateTimePatternField value.
Definition: udatpg.h:95
U_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:138
UDateTimePatternField
UDateTimePatternField
Field number constants for udatpg_getAppendItemFormats() and similar functions.
Definition: udatpg.h:55
UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition: utypes.h:401
UDateTimePGDisplayWidth
UDateTimePGDisplayWidth
Field display name width constants for udatpg_getFieldDisplayName().
Definition: udatpg.h:102
datefmt.h
C++ API: Abstract class for converting dates.
locid.h
C++ API: Locale ID object.
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:289
icu::UObject
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
UDateTimePatternMatchOptions
UDateTimePatternMatchOptions
Masks to control forcing the length of specified fields in the returned pattern to match those in the...
Definition: udatpg.h:118
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:225
icu::Locale
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:192