ICU 73.2  73.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/utypes.h"
18 
19 #if U_SHOW_CPLUSPLUS_API
20 
21 #include "unicode/datefmt.h"
22 #include "unicode/locid.h"
23 #include "unicode/udat.h"
24 #include "unicode/udatpg.h"
25 #include "unicode/unistr.h"
26 
27 U_NAMESPACE_BEGIN
28 
35 class CharString;
36 class Hashtable;
37 class FormatParser;
38 class DateTimeMatcher;
39 class DistanceInfo;
40 class PatternMap;
41 class PtnSkeleton;
42 class SharedDateTimePatternGenerator;
43 
59 public:
67 
75  static DateTimePatternGenerator* U_EXPORT2 createInstance(const Locale& uLocale, UErrorCode& status);
76 
77 #ifndef U_HIDE_INTERNAL_API
78 
84  static DateTimePatternGenerator* U_EXPORT2 createInstanceNoStdPat(const Locale& uLocale, UErrorCode& status);
85 
86 #endif /* U_HIDE_INTERNAL_API */
87 
95 
101 
108 
116  bool operator==(const DateTimePatternGenerator& other) const;
117 
125  bool operator!=(const DateTimePatternGenerator& other) const;
126 
137  static UnicodeString staticGetSkeleton(const UnicodeString& pattern, UErrorCode& status);
138 
151  UnicodeString getSkeleton(const UnicodeString& pattern, UErrorCode& status); /* {
152  The function is commented out because it is a stable API calling a draft API.
153  After staticGetSkeleton becomes stable, staticGetSkeleton can be used and
154  these comments and the definition of getSkeleton in dtptngen.cpp should be removed.
155  return staticGetSkeleton(pattern, status);
156  }*/
157 
172 
188  UnicodeString getBaseSkeleton(const UnicodeString& pattern, UErrorCode& status); /* {
189  The function is commented out because it is a stable API calling a draft API.
190  After staticGetBaseSkeleton becomes stable, staticGetBaseSkeleton can be used and
191  these comments and the definition of getBaseSkeleton in dtptngen.cpp should be removed.
192  return staticGetBaseSkeleton(pattern, status);
193  }*/
194 
221  UBool override,
222  UnicodeString& conflictingPattern,
223  UErrorCode& status);
224 
244 
254 
267 
279 
290 
317  void setDateTimeFormat(const UnicodeString& dateTimeFormat);
318 
331 
332 #if !UCONFIG_NO_FORMATTING
355  void setDateTimeFormat(UDateFormatStyle style, const UnicodeString& dateTimeFormat,
356  UErrorCode& status);
357 
376  UErrorCode& status) const;
377 #endif /* #if !UCONFIG_NO_FORMATTING */
378 
398 
399 
421  UErrorCode& status);
422 
423 
446  const UnicodeString& skeleton,
447  UErrorCode& status);
448 
472  const UnicodeString& skeleton,
474  UErrorCode& status);
475 
488 
495  const UnicodeString& getPatternForSkeleton(const UnicodeString& skeleton) const;
496 
507 
508 #ifndef U_HIDE_INTERNAL_API
522 #endif /* U_HIDE_INTERNAL_API */
523 
535  void setDecimal(const UnicodeString& decimal);
536 
542  const UnicodeString& getDecimal() const;
543 
544 #if !UCONFIG_NO_FORMATTING
545 
559 
560 #endif /* #if !UCONFIG_NO_FORMATTING */
561 
567  virtual UClassID getDynamicClassID() const override;
568 
574  static UClassID U_EXPORT2 getStaticClassID(void);
575 
576 private:
581 
585  DateTimePatternGenerator(const Locale& locale, UErrorCode & status, UBool skipStdPatterns = false);
586 
592 
597  DateTimePatternGenerator& operator=(const DateTimePatternGenerator& other);
598 
599  static const int32_t UDATPG_WIDTH_COUNT = UDATPG_NARROW + 1;
600 
601  Locale pLocale; // pattern locale
602  FormatParser *fp;
603  DateTimeMatcher* dtMatcher;
604  DistanceInfo *distanceInfo;
605  PatternMap *patternMap;
606  UnicodeString appendItemFormats[UDATPG_FIELD_COUNT];
607  UnicodeString fieldDisplayNames[UDATPG_FIELD_COUNT][UDATPG_WIDTH_COUNT];
608  UnicodeString dateTimeFormat[4];
609  UnicodeString decimal;
610  DateTimeMatcher *skipMatcher;
611  Hashtable *fAvailableFormatKeyHash;
612  UnicodeString emptyString;
613  char16_t fDefaultHourFormatChar;
614 
615  int32_t fAllowedHourFormats[7]; // Actually an array of AllowedHourFormat enum type, ending with UNKNOWN.
616 
617  // Internal error code used for recording/reporting errors that occur during methods that do not
618  // have a UErrorCode parameter. For example: the Copy Constructor, or the ::clone() method.
619  // When this is set to an error the object is in an invalid state.
620  UErrorCode internalErrorCode;
621 
622  /* internal flags masks for adjustFieldTypes etc. */
623  enum {
624  kDTPGNoFlags = 0,
625  kDTPGFixFractionalSeconds = 1,
626  kDTPGSkeletonUsesCapJ = 2
627  // with #13183, no longer need flags for b, B
628  };
629 
630  void initData(const Locale &locale, UErrorCode &status, UBool skipStdPatterns = false);
631  void addCanonicalItems(UErrorCode &status);
632  void addICUPatterns(const Locale& locale, UErrorCode& status);
633  void hackTimes(const UnicodeString& hackPattern, UErrorCode& status);
634  void getCalendarTypeToUse(const Locale& locale, CharString& destination, UErrorCode& err);
635  void consumeShortTimePattern(const UnicodeString& shortTimePattern, UErrorCode& status);
636  void addCLDRData(const Locale& locale, UErrorCode& status);
637  UDateTimePatternConflict addPatternWithSkeleton(const UnicodeString& pattern, const UnicodeString * skeletonToUse, UBool override, UnicodeString& conflictingPattern, UErrorCode& status);
638  void initHashtable(UErrorCode& status);
639  void setDateTimeFromCalendar(const Locale& locale, UErrorCode& status);
640  void setDecimalSymbols(const Locale& locale, UErrorCode& status);
641  UDateTimePatternField getAppendFormatNumber(const char* field) const;
642  // Note for the next 3: UDateTimePGDisplayWidth is now stable ICU 61
643  UDateTimePatternField getFieldAndWidthIndices(const char* key, UDateTimePGDisplayWidth* widthP) const;
644  void setFieldDisplayName(UDateTimePatternField field, UDateTimePGDisplayWidth width, const UnicodeString& value);
645  UnicodeString& getMutableFieldDisplayName(UDateTimePatternField field, UDateTimePGDisplayWidth width);
646  void getAppendName(UDateTimePatternField field, UnicodeString& value);
647  UnicodeString mapSkeletonMetacharacters(const UnicodeString& patternForm, int32_t* flags, UErrorCode& status);
648  const UnicodeString* getBestRaw(DateTimeMatcher& source, int32_t includeMask, DistanceInfo* missingFields, UErrorCode& status, const PtnSkeleton** specifiedSkeletonPtr = 0);
649  UnicodeString adjustFieldTypes(const UnicodeString& pattern, const PtnSkeleton* specifiedSkeleton, int32_t flags, UDateTimePatternMatchOptions options = UDATPG_MATCH_NO_OPTIONS);
650  UnicodeString getBestAppending(int32_t missingFields, int32_t flags, UErrorCode& status, UDateTimePatternMatchOptions options = UDATPG_MATCH_NO_OPTIONS);
651  int32_t getTopBitNumber(int32_t foundMask) const;
652  void setAvailableFormat(const UnicodeString &key, UErrorCode& status);
653  UBool isAvailableFormatSet(const UnicodeString &key) const;
654  void copyHashtable(Hashtable *other, UErrorCode &status);
655  UBool isCanonicalItem(const UnicodeString& item) const;
656  static void U_CALLCONV loadAllowedHourFormatsData(UErrorCode &status);
657  void getAllowedHourFormats(const Locale &locale, UErrorCode &status);
658 
659  struct U_HIDDEN AppendItemFormatsSink;
660  struct U_HIDDEN AppendItemNamesSink;
661  struct U_HIDDEN AvailableFormatsSink;
662 } ;// end class DateTimePatternGenerator
663 
664 U_NAMESPACE_END
665 
666 #endif /* U_SHOW_CPLUSPLUS_API */
667 
668 #endif
This class provides flexible generation of date format patterns, like "yy-MM-dd".
Definition: dtptngen.h:58
UnicodeString getBestPattern(const UnicodeString &skeleton, UDateTimePatternMatchOptions options, UErrorCode &status)
Return the best pattern matching the input skeleton.
const UnicodeString & getDateTimeFormat(UDateFormatStyle style, UErrorCode &status) const
Getter corresponding to setDateTimeFormat.
virtual UClassID getDynamicClassID() const override
ICU "poor man's RTTI", returns a UClassID for the actual class.
void setDecimal(const UnicodeString &decimal)
The decimal value is used in formatting fractions of seconds.
bool operator!=(const DateTimePatternGenerator &other) const
Return true if another object is semantically unequal to this one.
const UnicodeString & getDecimal() const
Getter corresponding to setDecimal.
DateTimePatternGenerator * clone() const
Clone DateTimePatternGenerator object.
bool operator==(const DateTimePatternGenerator &other) const
Return true if another object is semantically equal to this one.
const UnicodeString & getPatternForSkeleton(const UnicodeString &skeleton) const
Get the pattern corresponding to a given skeleton.
const UnicodeString & getDateTimeFormat() const
Getter corresponding to setDateTimeFormat.
void setAppendItemFormat(UDateTimePatternField field, const UnicodeString &value)
An AppendItem format is a pattern used to append a field if there is no good match.
UnicodeString getBestPattern(const UnicodeString &skeleton, UErrorCode &status)
Return the best pattern matching the input skeleton.
void setDateTimeFormat(UDateFormatStyle style, const UnicodeString &dateTimeFormat, UErrorCode &status)
dateTimeFormats are message patterns used to compose combinations of date and time patterns.
static DateTimePatternGenerator * createEmptyInstance(UErrorCode &status)
Create an empty generator, to be constructed with addPattern(...) etc.
const UnicodeString & getAppendItemFormat(UDateTimePatternField field) const
Getter corresponding to setAppendItemFormat.
UnicodeString getFieldDisplayName(UDateTimePatternField field, UDateTimePGDisplayWidth width) const
The general interface to get a display name for a particular date/time field, in one of several possi...
static DateTimePatternGenerator * createInstance(const Locale &uLocale, UErrorCode &status)
Construct a flexible generator according to data for a given locale.
static UClassID getStaticClassID(void)
ICU "poor man's RTTI", returns a UClassID for this class.
void setAppendItemName(UDateTimePatternField field, const UnicodeString &value)
Sets the names of field, eg "era" in English for ERA.
static UnicodeString staticGetBaseSkeleton(const UnicodeString &pattern, UErrorCode &status)
Utility to return a unique base skeleton from a given pattern.
StringEnumeration * getBaseSkeletons(UErrorCode &status) const
Return a list of all the base skeletons (in canonical form) from this class.
void setDateTimeFormat(const UnicodeString &dateTimeFormat)
The DateTimeFormat is a message format pattern used to compose date and time patterns.
StringEnumeration * getSkeletons(UErrorCode &status) const
Return a list of all the skeletons (in canonical form) from this class.
const UnicodeString & getAppendItemName(UDateTimePatternField field) const
Getter corresponding to setAppendItemNames.
static DateTimePatternGenerator * createInstance(UErrorCode &status)
Construct a flexible generator according to default locale.
UDateFormatHourCycle getDefaultHourCycle(UErrorCode &status) const
Get the default hour cycle for a locale.
UnicodeString replaceFieldTypes(const UnicodeString &pattern, const UnicodeString &skeleton, UErrorCode &status)
Adjusts the field types (width and subtype) of a pattern to match what is in a skeleton.
static DateTimePatternGenerator * createInstanceNoStdPat(const Locale &uLocale, UErrorCode &status)
For ICU use only.
static UnicodeString staticGetSkeleton(const UnicodeString &pattern, UErrorCode &status)
Utility to return a unique skeleton from a given pattern.
UnicodeString replaceFieldTypes(const UnicodeString &pattern, const UnicodeString &skeleton, UDateTimePatternMatchOptions options, UErrorCode &status)
Adjusts the field types (width and subtype) of a pattern to match what is in a skeleton.
UnicodeString getBaseSkeleton(const UnicodeString &pattern, UErrorCode &status)
Utility to return a unique base skeleton from a given pattern.
StringEnumeration * getRedundants(UErrorCode &status)
Return a list of redundant patterns are those which if removed, make no difference in the resulting g...
UnicodeString getSkeleton(const UnicodeString &pattern, UErrorCode &status)
Utility to return a unique skeleton from a given pattern.
virtual ~DateTimePatternGenerator()
Destructor.
UDateTimePatternConflict addPattern(const UnicodeString &pattern, UBool override, UnicodeString &conflictingPattern, UErrorCode &status)
Adds a pattern to the generator.
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:195
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:61
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:296
C++ API: Abstract class for converting dates.
C++ API: Locale ID object.
#define U_CALLCONV
Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...
Definition: platform.h:866
#define U_HIDDEN
This is used to mark internal structs declared within external classes, to prevent the internal struc...
Definition: platform.h:843
C API: DateFormat.
UDateFormatStyle
The possible date/time format styles.
Definition: udat.h:162
UDateFormatHourCycle
Hour Cycle.
Definition: udat.h:983
C API: Wrapper for icu::DateTimePatternGenerator (unicode/dtptngen.h).
UDateTimePGDisplayWidth
Field display name width constants for udatpg_getFieldDisplayName().
Definition: udatpg.h:108
@ UDATPG_NARROW
Definition: udatpg.h:114
UDateTimePatternConflict
Status return values from udatpg_addPattern().
Definition: udatpg.h:143
UDateTimePatternMatchOptions
Masks to control forcing the length of specified fields in the returned pattern to match those in the...
Definition: udatpg.h:124
@ UDATPG_MATCH_NO_OPTIONS
Definition: udatpg.h:126
UDateTimePatternField
Field number constants for udatpg_getAppendItemFormats() and similar functions.
Definition: udatpg.h:59
@ UDATPG_FIELD_COUNT
One more than the highest normal UDateTimePatternField value.
Definition: udatpg.h:100
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:247
C++ API: Unicode String.
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition: utypes.h:301