1 // Copyright (C) 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 *******************************************************************************
5 * Copyright (C) 2007-2013, International Business Machines Corporation and    *
6 * others. All Rights Reserved.                                                *
7 *******************************************************************************
8 */
9 #ifndef ZONEMETA_H
10 #define ZONEMETA_H
11 
12 #include "unicode/utypes.h"
13 
14 #if !UCONFIG_NO_FORMATTING
15 
16 #include "unicode/unistr.h"
17 #include "hash.h"
18 
19 U_NAMESPACE_BEGIN
20 
21 typedef struct OlsonToMetaMappingEntry {
22     const UChar *mzid; // const because it's a reference to a resource bundle string.
23     UDate from;
24     UDate to;
25 } OlsonToMetaMappingEntry;
26 
27 class UVector;
28 class TimeZone;
29 
30 class U_I18N_API ZoneMeta {
31 public:
32     /**
33      * Return the canonical id for this tzid defined by CLDR, which might be the id itself.
34      * If the given system tzid is not known, U_ILLEGAL_ARGUMENT_ERROR is set in the status.
35      *
36      * Note: this internal API supports all known system IDs and "Etc/Unknown" (which is
37      * NOT a system ID).
38      */
39     static UnicodeString& U_EXPORT2 getCanonicalCLDRID(const UnicodeString &tzid, UnicodeString &systemID, UErrorCode& status);
40 
41     /**
42      * Return the canonical id for this tzid defined by CLDR, which might be the id itself.
43      * This overload method returns a persistent const UChar*, which is guranteed to persist
44      * (a pointer to a resource).
45      */
46     static const UChar* U_EXPORT2 getCanonicalCLDRID(const UnicodeString &tzid, UErrorCode& status);
47 
48     /*
49      * Conveninent method returning CLDR canonical ID for the given time zone
50      */
51     static const UChar* U_EXPORT2 getCanonicalCLDRID(const TimeZone& tz);
52 
53     /**
54      * Return the canonical country code for this tzid.  If we have none, or if the time zone
55      * is not associated with a country, return bogus string.
56      * @param tzid Zone ID
57      * @param country [output] Country code
58      * @param isPrimary [output] TRUE if the zone is the primary zone for the country
59      * @return A reference to the result country
60      */
61     static UnicodeString& U_EXPORT2 getCanonicalCountry(const UnicodeString &tzid, UnicodeString &country, UBool *isPrimary = NULL);
62 
63     /**
64      * Returns a CLDR metazone ID for the given Olson tzid and time.
65      */
66     static UnicodeString& U_EXPORT2 getMetazoneID(const UnicodeString &tzid, UDate date, UnicodeString &result);
67     /**
68      * Returns an Olson ID for the ginve metazone and region
69      */
70     static UnicodeString& U_EXPORT2 getZoneIdByMetazone(const UnicodeString &mzid, const UnicodeString &region, UnicodeString &result);
71 
72     static const UVector* U_EXPORT2 getMetazoneMappings(const UnicodeString &tzid);
73 
74     static const UVector* U_EXPORT2 getAvailableMetazoneIDs();
75 
76     /**
77      * Returns the pointer to the persistent time zone ID string, or NULL if the given tzid is not in the
78      * tz database. This method is useful when you maintain persistent zone IDs without duplication.
79      */
80     static const UChar* U_EXPORT2 findTimeZoneID(const UnicodeString& tzid);
81 
82     /**
83      * Returns the pointer to the persistent meta zone ID string, or NULL if the given mzid is not available.
84      * This method is useful when you maintain persistent meta zone IDs without duplication.
85      */
86     static const UChar* U_EXPORT2 findMetaZoneID(const UnicodeString& mzid);
87 
88     /**
89      * Creates a custom zone for the offset
90      * @param offset GMT offset in milliseconds
91      * @return A custom TimeZone for the offset with normalized time zone id
92      */
93     static TimeZone* createCustomTimeZone(int32_t offset);
94 
95     /**
96      * Returns the time zone's short ID (null terminated) for the zone.
97      * For example, "uslax" for zone "America/Los_Angeles".
98      * @param tz the time zone
99      * @return the short ID of the time zone, or null if the short ID is not available.
100      */
101     static const UChar* U_EXPORT2 getShortID(const TimeZone& tz);
102 
103     /**
104      * Returns the time zone's short ID (null terminated) for the zone ID.
105      * For example, "uslax" for zone ID "America/Los_Angeles".
106      * @param tz the time zone ID
107      * @return the short ID of the time zone ID, or null if the short ID is not available.
108      */
109     static const UChar* U_EXPORT2 getShortID(const UnicodeString& id);
110 
111 private:
112     ZoneMeta(); // Prevent construction.
113     static UVector* createMetazoneMappings(const UnicodeString &tzid);
114     static UnicodeString& formatCustomID(uint8_t hour, uint8_t min, uint8_t sec, UBool negative, UnicodeString& id);
115     static const UChar* getShortIDFromCanonical(const UChar* canonicalID);
116 };
117 
118 U_NAMESPACE_END
119 
120 #endif /* #if !UCONFIG_NO_FORMATTING */
121 #endif // ZONEMETA_H
122