ICU 61.1  61.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/datefmt.h"
18 #include "unicode/locid.h"
19 #include "unicode/udat.h"
20 #include "unicode/udatpg.h"
21 #include "unicode/unistr.h"
22 
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 
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 
276 #ifndef U_HIDE_DRAFT_API
277 
286  UnicodeString getFieldDisplayName(UDateTimePatternField field, UDateTimePGDisplayWidth width) const;
287 #endif // U_HIDE_DRAFT_API
288 
310  void setDateTimeFormat(const UnicodeString& dateTimeFormat);
311 
317  const UnicodeString& getDateTimeFormat() const;
318 
337  UnicodeString getBestPattern(const UnicodeString& skeleton, UErrorCode& status);
338 
339 
359  UnicodeString getBestPattern(const UnicodeString& skeleton,
361  UErrorCode& status);
362 
363 
385  UnicodeString replaceFieldTypes(const UnicodeString& pattern,
386  const UnicodeString& skeleton,
387  UErrorCode& status);
388 
411  UnicodeString replaceFieldTypes(const UnicodeString& pattern,
412  const UnicodeString& skeleton,
414  UErrorCode& status);
415 
427  StringEnumeration* getSkeletons(UErrorCode& status) const;
428 
435  const UnicodeString& getPatternForSkeleton(const UnicodeString& skeleton) const;
436 
446  StringEnumeration* getBaseSkeletons(UErrorCode& status) const;
447 
448 #ifndef U_HIDE_INTERNAL_API
449 
461  StringEnumeration* getRedundants(UErrorCode& status);
462 #endif /* U_HIDE_INTERNAL_API */
463 
475  void setDecimal(const UnicodeString& decimal);
476 
482  const UnicodeString& getDecimal() const;
483 
489  virtual UClassID getDynamicClassID() const;
490 
496  static UClassID U_EXPORT2 getStaticClassID(void);
497 
498 private:
504 
509  DateTimePatternGenerator(const Locale& locale, UErrorCode & status);
510 
517 
523  DateTimePatternGenerator& operator=(const DateTimePatternGenerator& other);
524 
525  // TODO(ticket:13619): re-enable when UDATPG_NARROW no longer in draft mode.
526  // static const int32_t UDATPG_WIDTH_COUNT = UDATPG_NARROW + 1;
527 
528  Locale pLocale; // pattern locale
529  FormatParser *fp;
530  DateTimeMatcher* dtMatcher;
531  DistanceInfo *distanceInfo;
532  PatternMap *patternMap;
533  UnicodeString appendItemFormats[UDATPG_FIELD_COUNT];
534  // TODO(ticket:13619): [3] -> UDATPG_WIDTH_COUNT
535  UnicodeString fieldDisplayNames[UDATPG_FIELD_COUNT][3];
536  UnicodeString dateTimeFormat;
537  UnicodeString decimal;
538  DateTimeMatcher *skipMatcher;
539  Hashtable *fAvailableFormatKeyHash;
540  UnicodeString emptyString;
541  char16_t fDefaultHourFormatChar;
542 
543  int32_t fAllowedHourFormats[7]; // Actually an array of AllowedHourFormat enum type, ending with UNKNOWN.
544 
545  /* internal flags masks for adjustFieldTypes etc. */
546  enum {
547  kDTPGNoFlags = 0,
548  kDTPGFixFractionalSeconds = 1,
549  kDTPGSkeletonUsesCapJ = 2
550  // with #13183, no longer need flags for b, B
551  };
552 
553  void initData(const Locale &locale, UErrorCode &status);
554  void addCanonicalItems(UErrorCode &status);
555  void addICUPatterns(const Locale& locale, UErrorCode& status);
556  void hackTimes(const UnicodeString& hackPattern, UErrorCode& status);
557  void getCalendarTypeToUse(const Locale& locale, CharString& destination, UErrorCode& err);
558  void consumeShortTimePattern(const UnicodeString& shortTimePattern, UErrorCode& status);
559  void addCLDRData(const Locale& locale, UErrorCode& status);
560  UDateTimePatternConflict addPatternWithSkeleton(const UnicodeString& pattern, const UnicodeString * skeletonToUse, UBool override, UnicodeString& conflictingPattern, UErrorCode& status);
561  void initHashtable(UErrorCode& status);
562  void setDateTimeFromCalendar(const Locale& locale, UErrorCode& status);
563  void setDecimalSymbols(const Locale& locale, UErrorCode& status);
564  UDateTimePatternField getAppendFormatNumber(const char* field) const;
565 #ifndef U_HIDE_DRAFT_API
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  int32_t getCanonicalIndex(const UnicodeString& field);
573  const UnicodeString* getBestRaw(DateTimeMatcher& source, int32_t includeMask, DistanceInfo* missingFields, const PtnSkeleton** specifiedSkeletonPtr = 0);
574  UnicodeString adjustFieldTypes(const UnicodeString& pattern, const PtnSkeleton* specifiedSkeleton, int32_t flags, UDateTimePatternMatchOptions options = UDATPG_MATCH_NO_OPTIONS);
575  UnicodeString getBestAppending(int32_t missingFields, int32_t flags, UDateTimePatternMatchOptions options = UDATPG_MATCH_NO_OPTIONS);
576  int32_t getTopBitNumber(int32_t foundMask);
577  void setAvailableFormat(const UnicodeString &key, UErrorCode& status);
578  UBool isAvailableFormatSet(const UnicodeString &key) const;
579  void copyHashtable(Hashtable *other, UErrorCode &status);
580  UBool isCanonicalItem(const UnicodeString& item) const;
581  static void U_CALLCONV loadAllowedHourFormatsData(UErrorCode &status);
582  void getAllowedHourFormats(const Locale &locale, UErrorCode &status);
583 
584  struct AppendItemFormatsSink;
585  struct AppendItemNamesSink;
586  struct AvailableFormatsSink;
587 } ;// end class DateTimePatternGenerator
588 
590 
591 #endif
virtual UClassID getDynamicClassID() const
ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class.
This class provides flexible generation of date format patterns, like "yy-MM-dd". ...
Definition: dtptngen.h:54
C++ API: Unicode String.
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
#define U_CALLCONV
Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...
Definition: platform.h:850
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:93
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:57
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:360
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:137
C API: Wrapper for icu::DateTimePatternGenerator (unicode/dtptngen.h).
UBool operator!=(const StringPiece &x, const StringPiece &y)
Global operator != for StringPiece.
Definition: stringpiece.h:218
C API: DateFormat.
UDateTimePatternConflict
Status return values from udatpg_addPattern().
Definition: udatpg.h:139
One more than the highest normal UDateTimePatternField value.
Definition: udatpg.h:95
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:138
UDateTimePatternField
Field number constants for udatpg_getAppendItemFormats() and similar functions.
Definition: udatpg.h:55
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:396
UDateTimePGDisplayWidth
Field display name width constants for udatpg_getFieldDisplayName().
Definition: udatpg.h:103
C++ API: Abstract class for converting dates.
C++ API: Locale ID object.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:286
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
UDateTimePatternMatchOptions
Masks to control forcing the length of specified fields in the returned pattern to match those in the...
Definition: udatpg.h:120
int8_t UBool
The ICU boolean type.
Definition: umachine.h:236
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:188