1 // Copyright (C) 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
4 *******************************************************************************
5 * Copyright (C) 2007-2013, International Business Machines Corporation and *
6 * others. All Rights Reserved. *
7 *******************************************************************************
12 #include "unicode/utypes.h"
14 #if !UCONFIG_NO_FORMATTING
16 #include "unicode/unistr.h"
21 typedef struct OlsonToMetaMappingEntry {
22 const UChar *mzid; // const because it's a reference to a resource bundle string.
25 } OlsonToMetaMappingEntry;
30 class U_I18N_API ZoneMeta {
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.
36 * Note: this internal API supports all known system IDs and "Etc/Unknown" (which is
39 static UnicodeString& U_EXPORT2 getCanonicalCLDRID(const UnicodeString &tzid, UnicodeString &systemID, UErrorCode& status);
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).
46 static const UChar* U_EXPORT2 getCanonicalCLDRID(const UnicodeString &tzid, UErrorCode& status);
49 * Conveninent method returning CLDR canonical ID for the given time zone
51 static const UChar* U_EXPORT2 getCanonicalCLDRID(const TimeZone& tz);
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.
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
61 static UnicodeString& U_EXPORT2 getCanonicalCountry(const UnicodeString &tzid, UnicodeString &country, UBool *isPrimary = NULL);
64 * Returns a CLDR metazone ID for the given Olson tzid and time.
66 static UnicodeString& U_EXPORT2 getMetazoneID(const UnicodeString &tzid, UDate date, UnicodeString &result);
68 * Returns an Olson ID for the ginve metazone and region
70 static UnicodeString& U_EXPORT2 getZoneIdByMetazone(const UnicodeString &mzid, const UnicodeString ®ion, UnicodeString &result);
72 static const UVector* U_EXPORT2 getMetazoneMappings(const UnicodeString &tzid);
74 static const UVector* U_EXPORT2 getAvailableMetazoneIDs();
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.
80 static const UChar* U_EXPORT2 findTimeZoneID(const UnicodeString& tzid);
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.
86 static const UChar* U_EXPORT2 findMetaZoneID(const UnicodeString& mzid);
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
93 static TimeZone* createCustomTimeZone(int32_t offset);
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.
101 static const UChar* U_EXPORT2 getShortID(const TimeZone& tz);
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.
109 static const UChar* U_EXPORT2 getShortID(const UnicodeString& id);
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);
120 #endif /* #if !UCONFIG_NO_FORMATTING */