ICU 65.1: dtptngen.h Source File

00001 // © 2016 and later: Unicode, Inc. and others.
00002 // License & terms of use: http://www.unicode.org/copyright.html
00003 /*
00004 *******************************************************************************
00005 * Copyright (C) 2007-2016, International Business Machines Corporation and
00006 * others. All Rights Reserved.
00007 *******************************************************************************
00008 *
00009 * File DTPTNGEN.H
00010 *
00011 *******************************************************************************
00012 */
00013 
00014 #ifndef __DTPTNGEN_H__
00015 #define __DTPTNGEN_H__
00016 
00017 #include "unicode/utypes.h"
00018 
00019 #if U_SHOW_CPLUSPLUS_API
00020 
00021 #include "unicode/datefmt.h"
00022 #include "unicode/locid.h"
00023 #include "unicode/udat.h"
00024 #include "unicode/udatpg.h"
00025 #include "unicode/unistr.h"
00026 
00027 U_NAMESPACE_BEGIN
00028 
00035 class CharString;
00036 class Hashtable;
00037 class FormatParser;
00038 class DateTimeMatcher;
00039 class DistanceInfo;
00040 class PatternMap;
00041 class PtnSkeleton;
00042 class SharedDateTimePatternGenerator;
00043 
00058 class U_I18N_API DateTimePatternGenerator : public UObject {
00059 public:
00066     static DateTimePatternGenerator* U_EXPORT2 createInstance(UErrorCode& status);
00067 
00075     static DateTimePatternGenerator* U_EXPORT2 createInstance(const Locale& uLocale, UErrorCode& status);
00076 
00077 #ifndef U_HIDE_INTERNAL_API
00078 
00084     static DateTimePatternGenerator* U_EXPORT2 internalMakeInstance(const Locale& uLocale, UErrorCode& status);
00085 
00086 #endif /* U_HIDE_INTERNAL_API */
00087 
00094      static DateTimePatternGenerator* U_EXPORT2 createEmptyInstance(UErrorCode& status);
00095 
00100     virtual ~DateTimePatternGenerator();
00101 
00107     DateTimePatternGenerator* clone() const;
00108 
00116     UBool operator==(const DateTimePatternGenerator& other) const;
00117 
00125     UBool operator!=(const DateTimePatternGenerator& other) const;
00126 
00137     static UnicodeString staticGetSkeleton(const UnicodeString& pattern, UErrorCode& status);
00138 
00151     UnicodeString getSkeleton(const UnicodeString& pattern, UErrorCode& status); /* {
00152         The function is commented out because it is a stable API calling a draft API.
00153         After staticGetSkeleton becomes stable, staticGetSkeleton can be used and
00154         these comments and the definition of getSkeleton in dtptngen.cpp should be removed.
00155         return staticGetSkeleton(pattern, status);
00156     }*/
00157 
00171     static UnicodeString staticGetBaseSkeleton(const UnicodeString& pattern, UErrorCode& status);
00172 
00188     UnicodeString getBaseSkeleton(const UnicodeString& pattern, UErrorCode& status); /* {
00189         The function is commented out because it is a stable API calling a draft API.
00190         After staticGetBaseSkeleton becomes stable, staticGetBaseSkeleton can be used and
00191         these comments and the definition of getBaseSkeleton in dtptngen.cpp should be removed.
00192         return staticGetBaseSkeleton(pattern, status);
00193     }*/
00194 
00220     UDateTimePatternConflict addPattern(const UnicodeString& pattern,
00221                                         UBool override,
00222                                         UnicodeString& conflictingPattern,
00223                                         UErrorCode& status);
00224 
00243     void setAppendItemFormat(UDateTimePatternField field, const UnicodeString& value);
00244 
00253     const UnicodeString& getAppendItemFormat(UDateTimePatternField field) const;
00254 
00266     void setAppendItemName(UDateTimePatternField field, const UnicodeString& value);
00267 
00278     const UnicodeString& getAppendItemName(UDateTimePatternField field) const;
00279 
00289     UnicodeString getFieldDisplayName(UDateTimePatternField field, UDateTimePGDisplayWidth width) const;
00290 
00312     void setDateTimeFormat(const UnicodeString& dateTimeFormat);
00313 
00319     const UnicodeString& getDateTimeFormat() const;
00320 
00339      UnicodeString getBestPattern(const UnicodeString& skeleton, UErrorCode& status);
00340 
00341 
00361      UnicodeString getBestPattern(const UnicodeString& skeleton,
00362                                   UDateTimePatternMatchOptions options,
00363                                   UErrorCode& status);
00364 
00365 
00387      UnicodeString replaceFieldTypes(const UnicodeString& pattern,
00388                                      const UnicodeString& skeleton,
00389                                      UErrorCode& status);
00390 
00413      UnicodeString replaceFieldTypes(const UnicodeString& pattern,
00414                                      const UnicodeString& skeleton,
00415                                      UDateTimePatternMatchOptions options,
00416                                      UErrorCode& status);
00417 
00429      StringEnumeration* getSkeletons(UErrorCode& status) const;
00430 
00437      const UnicodeString& getPatternForSkeleton(const UnicodeString& skeleton) const;
00438 
00448      StringEnumeration* getBaseSkeletons(UErrorCode& status) const;
00449 
00450 #ifndef U_HIDE_INTERNAL_API
00451 
00463      StringEnumeration* getRedundants(UErrorCode& status);
00464 #endif  /* U_HIDE_INTERNAL_API */
00465 
00477     void setDecimal(const UnicodeString& decimal);
00478 
00484     const UnicodeString& getDecimal() const;
00485 
00491     virtual UClassID getDynamicClassID() const;
00492 
00498     static UClassID U_EXPORT2 getStaticClassID(void);
00499 
00500 private:
00504     DateTimePatternGenerator(UErrorCode & status);
00505 
00509     DateTimePatternGenerator(const Locale& locale, UErrorCode & status);
00510 
00515     DateTimePatternGenerator(const DateTimePatternGenerator& other);
00516 
00521     DateTimePatternGenerator& operator=(const DateTimePatternGenerator& other);
00522 
00523     // TODO(ticket:13619): re-enable when UDATPG_NARROW no longer in  draft mode.
00524     // static const int32_t UDATPG_WIDTH_COUNT = UDATPG_NARROW + 1;
00525 
00526     Locale pLocale;  // pattern locale
00527     FormatParser *fp;
00528     DateTimeMatcher* dtMatcher;
00529     DistanceInfo *distanceInfo;
00530     PatternMap *patternMap;
00531     UnicodeString appendItemFormats[UDATPG_FIELD_COUNT];
00532     // TODO(ticket:13619): [3] -> UDATPG_WIDTH_COUNT
00533     UnicodeString fieldDisplayNames[UDATPG_FIELD_COUNT][3];
00534     UnicodeString dateTimeFormat;
00535     UnicodeString decimal;
00536     DateTimeMatcher *skipMatcher;
00537     Hashtable *fAvailableFormatKeyHash;
00538     UnicodeString emptyString;
00539     char16_t fDefaultHourFormatChar;
00540 
00541     int32_t fAllowedHourFormats[7];  // Actually an array of AllowedHourFormat enum type, ending with UNKNOWN.
00542 
00543     // Internal error code used for recording/reporting errors that occur during methods that do not
00544     // have a UErrorCode parameter. For example: the Copy Constructor, or the ::clone() method.
00545     // When this is set to an error the object is in an invalid state.
00546     UErrorCode internalErrorCode;
00547 
00548     /* internal flags masks for adjustFieldTypes etc. */
00549     enum {
00550         kDTPGNoFlags = 0,
00551         kDTPGFixFractionalSeconds = 1,
00552         kDTPGSkeletonUsesCapJ = 2
00553         // with #13183, no longer need flags for b, B
00554     };
00555 
00556     void initData(const Locale &locale, UErrorCode &status);
00557     void addCanonicalItems(UErrorCode &status);
00558     void addICUPatterns(const Locale& locale, UErrorCode& status);
00559     void hackTimes(const UnicodeString& hackPattern, UErrorCode& status);
00560     void getCalendarTypeToUse(const Locale& locale, CharString& destination, UErrorCode& err);
00561     void consumeShortTimePattern(const UnicodeString& shortTimePattern, UErrorCode& status);
00562     void addCLDRData(const Locale& locale, UErrorCode& status);
00563     UDateTimePatternConflict addPatternWithSkeleton(const UnicodeString& pattern, const UnicodeString * skeletonToUse, UBool override, UnicodeString& conflictingPattern, UErrorCode& status);
00564     void initHashtable(UErrorCode& status);
00565     void setDateTimeFromCalendar(const Locale& locale, UErrorCode& status);
00566     void setDecimalSymbols(const Locale& locale, UErrorCode& status);
00567     UDateTimePatternField getAppendFormatNumber(const char* field) const;
00568     // Note for the next 3: UDateTimePGDisplayWidth is now stable ICU 61
00569     UDateTimePatternField getFieldAndWidthIndices(const char* key, UDateTimePGDisplayWidth* widthP) const;
00570     void setFieldDisplayName(UDateTimePatternField field, UDateTimePGDisplayWidth width, const UnicodeString& value);
00571     UnicodeString& getMutableFieldDisplayName(UDateTimePatternField field, UDateTimePGDisplayWidth width);
00572     void getAppendName(UDateTimePatternField field, UnicodeString& value);
00573     UnicodeString mapSkeletonMetacharacters(const UnicodeString& patternForm, int32_t* flags, UErrorCode& status);
00574     const UnicodeString* getBestRaw(DateTimeMatcher& source, int32_t includeMask, DistanceInfo* missingFields, UErrorCode& status, const PtnSkeleton** specifiedSkeletonPtr = 0);
00575     UnicodeString adjustFieldTypes(const UnicodeString& pattern, const PtnSkeleton* specifiedSkeleton, int32_t flags, UDateTimePatternMatchOptions options = UDATPG_MATCH_NO_OPTIONS);
00576     UnicodeString getBestAppending(int32_t missingFields, int32_t flags, UErrorCode& status, UDateTimePatternMatchOptions options = UDATPG_MATCH_NO_OPTIONS);
00577     int32_t getTopBitNumber(int32_t foundMask) const;
00578     void setAvailableFormat(const UnicodeString &key, UErrorCode& status);
00579     UBool isAvailableFormatSet(const UnicodeString &key) const;
00580     void copyHashtable(Hashtable *other, UErrorCode &status);
00581     UBool isCanonicalItem(const UnicodeString& item) const;
00582     static void U_CALLCONV loadAllowedHourFormatsData(UErrorCode &status);
00583     void getAllowedHourFormats(const Locale &locale, UErrorCode &status);
00584 
00585     struct AppendItemFormatsSink;
00586     struct AppendItemNamesSink;
00587     struct AvailableFormatsSink;
00588 } ;// end class DateTimePatternGenerator
00589 
00590 U_NAMESPACE_END
00591 
00592 #endif /* U_SHOW_CPLUSPLUS_API */
00593 
00594 #endif