ICU 70.1  70.1
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 
91  static DateTimePatternGenerator* U_EXPORT2 internalMakeInstance(const Locale& uLocale, UErrorCode& status);
92 
93 #endif /* U_HIDE_INTERNAL_API */
94 
102 
108 
115 
123  bool operator==(const DateTimePatternGenerator& other) const;
124 
132  bool operator!=(const DateTimePatternGenerator& other) const;
133 
144  static UnicodeString staticGetSkeleton(const UnicodeString& pattern, UErrorCode& status);
145 
158  UnicodeString getSkeleton(const UnicodeString& pattern, UErrorCode& status); /* {
159  The function is commented out because it is a stable API calling a draft API.
160  After staticGetSkeleton becomes stable, staticGetSkeleton can be used and
161  these comments and the definition of getSkeleton in dtptngen.cpp should be removed.
162  return staticGetSkeleton(pattern, status);
163  }*/
164 
179 
195  UnicodeString getBaseSkeleton(const UnicodeString& pattern, UErrorCode& status); /* {
196  The function is commented out because it is a stable API calling a draft API.
197  After staticGetBaseSkeleton becomes stable, staticGetBaseSkeleton can be used and
198  these comments and the definition of getBaseSkeleton in dtptngen.cpp should be removed.
199  return staticGetBaseSkeleton(pattern, status);
200  }*/
201 
228  UBool override,
229  UnicodeString& conflictingPattern,
230  UErrorCode& status);
231 
251 
261 
274 
286 
297 
319  void setDateTimeFormat(const UnicodeString& dateTimeFormat);
320 
327 
347 
348 
370  UErrorCode& status);
371 
372 
395  const UnicodeString& skeleton,
396  UErrorCode& status);
397 
421  const UnicodeString& skeleton,
423  UErrorCode& status);
424 
437 
444  const UnicodeString& getPatternForSkeleton(const UnicodeString& skeleton) const;
445 
456 
457 #ifndef U_HIDE_INTERNAL_API
471 #endif /* U_HIDE_INTERNAL_API */
472 
484  void setDecimal(const UnicodeString& decimal);
485 
491  const UnicodeString& getDecimal() const;
492 
493 #if !UCONFIG_NO_FORMATTING
494 
508 
509 #endif /* #if !UCONFIG_NO_FORMATTING */
510 
516  virtual UClassID getDynamicClassID() const override;
517 
523  static UClassID U_EXPORT2 getStaticClassID(void);
524 
525 private:
530 
534  DateTimePatternGenerator(const Locale& locale, UErrorCode & status, UBool skipStdPatterns = false);
535 
541 
546  DateTimePatternGenerator& operator=(const DateTimePatternGenerator& other);
547 
548  // TODO(ticket:13619): re-enable when UDATPG_NARROW no longer in draft mode.
549  // static const int32_t UDATPG_WIDTH_COUNT = UDATPG_NARROW + 1;
550 
551  Locale pLocale; // pattern locale
552  FormatParser *fp;
553  DateTimeMatcher* dtMatcher;
554  DistanceInfo *distanceInfo;
555  PatternMap *patternMap;
556  UnicodeString appendItemFormats[UDATPG_FIELD_COUNT];
557  // TODO(ticket:13619): [3] -> UDATPG_WIDTH_COUNT
558  UnicodeString fieldDisplayNames[UDATPG_FIELD_COUNT][3];
559  UnicodeString dateTimeFormat;
560  UnicodeString decimal;
561  DateTimeMatcher *skipMatcher;
562  Hashtable *fAvailableFormatKeyHash;
563  UnicodeString emptyString;
564  char16_t fDefaultHourFormatChar;
565 
566  int32_t fAllowedHourFormats[7]; // Actually an array of AllowedHourFormat enum type, ending with UNKNOWN.
567 
568  // Internal error code used for recording/reporting errors that occur during methods that do not
569  // have a UErrorCode parameter. For example: the Copy Constructor, or the ::clone() method.
570  // When this is set to an error the object is in an invalid state.
571  UErrorCode internalErrorCode;
572 
573  /* internal flags masks for adjustFieldTypes etc. */
574  enum {
575  kDTPGNoFlags = 0,
576  kDTPGFixFractionalSeconds = 1,
577  kDTPGSkeletonUsesCapJ = 2
578  // with #13183, no longer need flags for b, B
579  };
580 
581  void initData(const Locale &locale, UErrorCode &status, UBool skipStdPatterns = false);
582  void addCanonicalItems(UErrorCode &status);
583  void addICUPatterns(const Locale& locale, UErrorCode& status);
584  void hackTimes(const UnicodeString& hackPattern, UErrorCode& status);
585  void getCalendarTypeToUse(const Locale& locale, CharString& destination, UErrorCode& err);
586  void consumeShortTimePattern(const UnicodeString& shortTimePattern, UErrorCode& status);
587  void addCLDRData(const Locale& locale, UErrorCode& status);
588  UDateTimePatternConflict addPatternWithSkeleton(const UnicodeString& pattern, const UnicodeString * skeletonToUse, UBool override, UnicodeString& conflictingPattern, UErrorCode& status);
589  void initHashtable(UErrorCode& status);
590  void setDateTimeFromCalendar(const Locale& locale, UErrorCode& status);
591  void setDecimalSymbols(const Locale& locale, UErrorCode& status);
592  UDateTimePatternField getAppendFormatNumber(const char* field) const;
593  // Note for the next 3: UDateTimePGDisplayWidth is now stable ICU 61
594  UDateTimePatternField getFieldAndWidthIndices(const char* key, UDateTimePGDisplayWidth* widthP) const;
595  void setFieldDisplayName(UDateTimePatternField field, UDateTimePGDisplayWidth width, const UnicodeString& value);
596  UnicodeString& getMutableFieldDisplayName(UDateTimePatternField field, UDateTimePGDisplayWidth width);
597  void getAppendName(UDateTimePatternField field, UnicodeString& value);
598  UnicodeString mapSkeletonMetacharacters(const UnicodeString& patternForm, int32_t* flags, UErrorCode& status);
599  const UnicodeString* getBestRaw(DateTimeMatcher& source, int32_t includeMask, DistanceInfo* missingFields, UErrorCode& status, const PtnSkeleton** specifiedSkeletonPtr = 0);
600  UnicodeString adjustFieldTypes(const UnicodeString& pattern, const PtnSkeleton* specifiedSkeleton, int32_t flags, UDateTimePatternMatchOptions options = UDATPG_MATCH_NO_OPTIONS);
601  UnicodeString getBestAppending(int32_t missingFields, int32_t flags, UErrorCode& status, UDateTimePatternMatchOptions options = UDATPG_MATCH_NO_OPTIONS);
602  int32_t getTopBitNumber(int32_t foundMask) const;
603  void setAvailableFormat(const UnicodeString &key, UErrorCode& status);
604  UBool isAvailableFormatSet(const UnicodeString &key) const;
605  void copyHashtable(Hashtable *other, UErrorCode &status);
606  UBool isCanonicalItem(const UnicodeString& item) const;
607  static void U_CALLCONV loadAllowedHourFormatsData(UErrorCode &status);
608  void getAllowedHourFormats(const Locale &locale, UErrorCode &status);
609 
610  struct AppendItemFormatsSink;
611  struct AppendItemNamesSink;
612  struct AvailableFormatsSink;
613 } ;// end class DateTimePatternGenerator
614 
615 U_NAMESPACE_END
616 
617 #endif /* U_SHOW_CPLUSPLUS_API */
618 
619 #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.
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.
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...
static DateTimePatternGenerator * internalMakeInstance(const Locale &uLocale, UErrorCode &status)
For ICU use only.
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:870
C API: DateFormat.
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
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:269
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