ICU 60.2 60.2

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

- File List
- Globals

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
272 const UnicodeString& getAppendItemName(UDateTimePatternField field) const;
273
295 void setDateTimeFormat(const UnicodeString& dateTimeFormat);
296
302 const UnicodeString& getDateTimeFormat() const;
303
322 UnicodeString getBestPattern(const UnicodeString& skeleton, UErrorCode& status);
323
324
344 UnicodeString getBestPattern(const UnicodeString& skeleton,
345 UDateTimePatternMatchOptions options,
346 UErrorCode& status);
347
348
370 UnicodeString replaceFieldTypes(const UnicodeString& pattern,
371 const UnicodeString& skeleton,
372 UErrorCode& status);
373
396 UnicodeString replaceFieldTypes(const UnicodeString& pattern,
397 const UnicodeString& skeleton,
398 UDateTimePatternMatchOptions options,
399 UErrorCode& status);
400
412 StringEnumeration* getSkeletons(UErrorCode& status) const;
413
420 const UnicodeString& getPatternForSkeleton(const UnicodeString& skeleton) const;
421
431 StringEnumeration* getBaseSkeletons(UErrorCode& status) const;
432
433 #ifndef U_HIDE_INTERNAL_API
434
446 StringEnumeration* getRedundants(UErrorCode& status);
447 #endif /* U_HIDE_INTERNAL_API */
448
460 void setDecimal(const UnicodeString& decimal);
461
467 const UnicodeString& getDecimal() const;
468
474 virtual UClassID getDynamicClassID() const;
475
481 static UClassID U_EXPORT2 getStaticClassID(void);
482
483 private:
488 DateTimePatternGenerator(UErrorCode & status);
489
494 DateTimePatternGenerator(const Locale& locale, UErrorCode & status);
495
501 DateTimePatternGenerator(const DateTimePatternGenerator& other);
502
508 DateTimePatternGenerator& operator=(const DateTimePatternGenerator& other);
509
510 Locale pLocale; // pattern locale
511 FormatParser *fp;
512 DateTimeMatcher* dtMatcher;
513 DistanceInfo *distanceInfo;
514 PatternMap *patternMap;
515 UnicodeString appendItemFormats[UDATPG_FIELD_COUNT];
516 UnicodeString appendItemNames[UDATPG_FIELD_COUNT];
517 UnicodeString dateTimeFormat;
518 UnicodeString decimal;
519 DateTimeMatcher *skipMatcher;
520 Hashtable *fAvailableFormatKeyHash;
521 UnicodeString emptyString;
522 char16_t fDefaultHourFormatChar;
523
524 int32_t fAllowedHourFormats[7]; // Actually an array of AllowedHourFormat enum type, ending with UNKNOWN.
525
526 /* internal flags masks for adjustFieldTypes etc. */
527 enum {
528 kDTPGNoFlags = 0,
529 kDTPGFixFractionalSeconds = 1,
530 kDTPGSkeletonUsesCapJ = 2
531 // with #13183, no longer need flags for b, B
532 };
533
534 void initData(const Locale &locale, UErrorCode &status);
535 void addCanonicalItems(UErrorCode &status);
536 void addICUPatterns(const Locale& locale, UErrorCode& status);
537 void hackTimes(const UnicodeString& hackPattern, UErrorCode& status);
538 void getCalendarTypeToUse(const Locale& locale, CharString& destination, UErrorCode& err);
539 void consumeShortTimePattern(const UnicodeString& shortTimePattern, UErrorCode& status);
540 void addCLDRData(const Locale& locale, UErrorCode& status);
541 UDateTimePatternConflict addPatternWithSkeleton(const UnicodeString& pattern, const UnicodeString * skeletonToUse, UBool override, UnicodeString& conflictingPattern, UErrorCode& status);
542 void initHashtable(UErrorCode& status);
543 void setDateTimeFromCalendar(const Locale& locale, UErrorCode& status);
544 void setDecimalSymbols(const Locale& locale, UErrorCode& status);
545 UDateTimePatternField getAppendFormatNumber(const char* field) const;
546 UDateTimePatternField getAppendNameNumber(const char* field) const;
547 UnicodeString& getMutableAppendItemName(UDateTimePatternField field);
548 void getAppendName(UDateTimePatternField field, UnicodeString& value);
549 UnicodeString mapSkeletonMetacharacters(const UnicodeString& patternForm, int32_t* flags, UErrorCode& status);
550 int32_t getCanonicalIndex(const UnicodeString& field);
551 const UnicodeString* getBestRaw(DateTimeMatcher& source, int32_t includeMask, DistanceInfo* missingFields, const PtnSkeleton** specifiedSkeletonPtr = 0);
552 UnicodeString adjustFieldTypes(const UnicodeString& pattern, const PtnSkeleton* specifiedSkeleton, int32_t flags, UDateTimePatternMatchOptions options = UDATPG_MATCH_NO_OPTIONS);
553 UnicodeString getBestAppending(int32_t missingFields, int32_t flags, UDateTimePatternMatchOptions options = UDATPG_MATCH_NO_OPTIONS);
554 int32_t getTopBitNumber(int32_t foundMask);
555 void setAvailableFormat(const UnicodeString &key, UErrorCode& status);
556 UBool isAvailableFormatSet(const UnicodeString &key) const;
557 void copyHashtable(Hashtable *other, UErrorCode &status);
558 UBool isCanonicalItem(const UnicodeString& item) const;
559 static void U_CALLCONV loadAllowedHourFormatsData(UErrorCode &status);
560 void getAllowedHourFormats(const Locale &locale, UErrorCode &status);
561
562 struct AppendItemFormatsSink;
563 struct AppendItemNamesSink;
564 struct AvailableFormatsSink;
565 } ;// end class DateTimePatternGenerator
566
567 U_NAMESPACE_END
568
569 #endif
icu::UObject::getDynamicClassID
virtual UClassID getDynamicClassID() const
ICU4C "poor man&#39;s RTTI", returns a UClassID for the actual ICU class.
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:848
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler&#39;s RTTI.
Definition: uobject.h:93
icu::StringEnumeration
Base class for &#39;pure&#39; 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:360
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.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.
UDATPG_MATCH_NO_OPTIONS
Definition: udatpg.h:107
UDateTimePatternConflict
UDateTimePatternConflict
Status return values from udatpg_addPattern().
Definition: udatpg.h:124
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:132
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:396
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:286
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:105
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:236
icu::Locale
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:188