Update ICU to 54.1 step 1

source/i18n/unicode/tzfmt.h

 /*
 *******************************************************************************
-* Copyright (C) 2011-2013, International Business Machines Corporation and    *
-* others. All Rights Reserved.                                                *
+* Copyright (C) 2011-2014, International Business Machines Corporation and
+* others. All Rights Reserved.
 *******************************************************************************
 */
 #ifndef __TZFMT_H
 #define __TZFMT_H
 
 /**
  * \file
  * \brief C++ API: TimeZoneFormat
  */
 
@@ skipping 35 matching lines @@
     /**
      * Specific short format, such as "EST", "PDT".
      * @stable ICU 50
      */
     UTZFMT_STYLE_SPECIFIC_SHORT,
     /**
      * Localized GMT offset format, such as "GMT-05:00", "UTC+0100"
      * @stable ICU 50
      */
     UTZFMT_STYLE_LOCALIZED_GMT,
-#ifndef U_HIDE_DRAFT_API
     /**
      * Short localized GMT offset format, such as "GMT-5", "UTC+1:30"
      * This style is equivalent to the LDML date format pattern "O".
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_STYLE_LOCALIZED_GMT_SHORT,
     /**
      * Short ISO 8601 local time difference (basic format) or the UTC indicator.
      * For example, "-05", "+0530", and "Z"(UTC).
      * This style is equivalent to the LDML date format pattern "X".
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_STYLE_ISO_BASIC_SHORT,
     /**
      * Short ISO 8601 locale time difference (basic format).
      * For example, "-05" and "+0530".
      * This style is equivalent to the LDML date format pattern "x".
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_STYLE_ISO_BASIC_LOCAL_SHORT,
     /**
      * Fixed width ISO 8601 local time difference (basic format) or the UTC indicator.
      * For example, "-0500", "+0530", and "Z"(UTC).
      * This style is equivalent to the LDML date format pattern "XX".
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_STYLE_ISO_BASIC_FIXED,
     /**
      * Fixed width ISO 8601 local time difference (basic format).
      * For example, "-0500" and "+0530".
      * This style is equivalent to the LDML date format pattern "xx".
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_STYLE_ISO_BASIC_LOCAL_FIXED,
     /**
      * ISO 8601 local time difference (basic format) with optional seconds field, or the UTC indicator.
      * For example, "-0500", "+052538", and "Z"(UTC).
      * This style is equivalent to the LDML date format pattern "XXXX".
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_STYLE_ISO_BASIC_FULL,
     /**
      * ISO 8601 local time difference (basic format) with optional seconds field.
      * For example, "-0500" and "+052538".
      * This style is equivalent to the LDML date format pattern "xxxx".
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_STYLE_ISO_BASIC_LOCAL_FULL,
     /**
      * Fixed width ISO 8601 local time difference (extended format) or the UTC indicator.
      * For example, "-05:00", "+05:30", and "Z"(UTC).
      * This style is equivalent to the LDML date format pattern "XXX".
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_STYLE_ISO_EXTENDED_FIXED,
     /**
      * Fixed width ISO 8601 local time difference (extended format).
      * For example, "-05:00" and "+05:30".
      * This style is equivalent to the LDML date format pattern "xxx" and "ZZZZZ".
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_STYLE_ISO_EXTENDED_LOCAL_FIXED,
     /**
      * ISO 8601 local time difference (extended format) with optional seconds field, or the UTC indicator.
      * For example, "-05:00", "+05:25:38", and "Z"(UTC).
      * This style is equivalent to the LDML date format pattern "XXXXX".
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_STYLE_ISO_EXTENDED_FULL,
     /**
      * ISO 8601 local time difference (extended format) with optional seconds field.
      * For example, "-05:00" and "+05:25:38".
      * This style is equivalent to the LDML date format pattern "xxxxx".
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_STYLE_ISO_EXTENDED_LOCAL_FULL,
     /**
      * Time Zone ID, such as "America/Los_Angeles".
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_STYLE_ZONE_ID,
     /**
      * Short Time Zone ID (BCP 47 Unicode location extension, time zone type value), such as "uslax".
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_STYLE_ZONE_ID_SHORT,
     /**
      * Exemplar location, such as "Los Angeles" and "Paris".
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_STYLE_EXEMPLAR_LOCATION
-#endif /* U_HIDE_DRAFT_API */
 } UTimeZoneFormatStyle;
 
 /**
  * Constants for GMT offset pattern types.
  * @stable ICU 50
  */
 typedef enum UTimeZoneFormatGMTOffsetPatternType {
     /**
      * Positive offset with hours and minutes fields
      * @stable ICU 50
      */
     UTZFMT_PAT_POSITIVE_HM,
     /**
      * Positive offset with hours, minutes and seconds fields
      * @stable ICU 50
      */
     UTZFMT_PAT_POSITIVE_HMS,
     /**
      * Negative offset with hours and minutes fields
      * @stable ICU 50
      */
     UTZFMT_PAT_NEGATIVE_HM,
     /**
      * Negative offset with hours, minutes and seconds fields
      * @stable ICU 50
      */
     UTZFMT_PAT_NEGATIVE_HMS,
-#ifndef U_HIDE_DRAFT_API
     /**
      * Positive offset with hours field
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_PAT_POSITIVE_H,
     /**
      * Negative offset with hours field
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UTZFMT_PAT_NEGATIVE_H,
-#endif /* U_HIDE_DRAFT_API */
 
+    /* The following cannot be #ifndef U_HIDE_INTERNAL_API, needed for other .h declarations */
     /**
      * Number of UTimeZoneFormatGMTOffsetPatternType types.
      * @internal
      */
     UTZFMT_PAT_COUNT = 6
 } UTimeZoneFormatGMTOffsetPatternType;
 
 /**
  * Constants for time types used by TimeZoneFormat APIs for
  * receiving time type (standard time, daylight time or unknown).
@@ skipping 27 matching lines @@
      * @stable ICU 50
      */
     UTZFMT_PARSE_OPTION_NONE        = 0x00,
     /**
      * When a time zone display name is not found within a set of display names
      * used for the specified style, look for the name from display names used
      * by other styles.
      * @stable ICU 50
      */
     UTZFMT_PARSE_OPTION_ALL_STYLES  = 0x01
+#ifndef U_HIDE_DRAFT_API
+    ,
+     /**
+      * When parsing a time zone display name in UTZFMT_STYLE_SPECIFIC_SHORT,
+      * look for the IANA tz database compatible zone abbreviations in addition
+      * to the localized names coming from the {@link TimeZoneNames} currently
+      * used by the {@link TimeZoneFormat}. 
+      * @draft ICU 54
+      */
+    UTZFMT_PARSE_OPTION_TZ_DATABASE_ABBREVIATIONS = 0x02
+#endif  /* U_HIDE_DRAFT_API */
 } UTimeZoneFormatParseOption;
 
 U_CDECL_END
 
 U_NAMESPACE_BEGIN
 
 class TimeZoneGenericNames;
+class TZDBTimeZoneNames;
 class UVector;
 
 /**
  * <code>TimeZoneFormat</code> supports time zone display name formatting and parsing.
  * An instance of TimeZoneFormat works as a subformatter of {@link SimpleDateFormat},
  * but you can also directly get a new instance of <code>TimeZoneFormat</code> and
  * formatting/parsing time zone display names.
  * <p>
  * ICU implements the time zone display names defined by <a href="http://www.unicode.org/reports/tr35/">UTS#35
  * Unicode Locale Data Markup Language (LDML)</a>. {@link TimeZoneNames} represents the
@@ skipping 38 matching lines @@
      * Clone this object polymorphically. The caller is responsible
      * for deleting the result when done.
      * @return A copy of the object
      * @stable ICU 50
      */
     virtual Format* clone() const;
 
     /**
      * Creates an instance of <code>TimeZoneFormat</code> for the given locale.
      * @param locale The locale.
-     * @param status Recevies the status.
+     * @param status Receives the status.
      * @return An instance of <code>TimeZoneFormat</code> for the given locale,
      *          owned by the caller.
      * @stable ICU 50
      */
     static TimeZoneFormat* U_EXPORT2 createInstance(const Locale& locale, UErrorCode& status);
 
     /**
      * Returns the time zone display name data used by this instance.
      * @return The time zone display name data.
      * @stable ICU 50
@@ skipping 110 matching lines @@
     /**
      * Sets the default parse options.
      * <p><b>Note</b>: By default, an instance of <code>TimeZoneFormat</code>
      * created by {@link #createInstance} has no parse options set (UTZFMT_PARSE_OPTION_NONE).
      * To specify multipe options, use bitwise flags of UTimeZoneFormatParseOption.
      * @see #UTimeZoneFormatParseOption
      * @stable ICU 50
      */
     void setDefaultParseOptions(uint32_t flags);
 
-#ifndef U_HIDE_DRAFT_API
     /**
      * Returns the ISO 8601 basic time zone string for the given offset.
      * For example, "-08", "-0830" and "Z"
      *
      * @param offset the offset from GMT(UTC) in milliseconds.
      * @param useUtcIndicator true if ISO 8601 UTC indicator "Z" is used when the offset is 0.
      * @param isShort true if shortest form is used.
      * @param ignoreSeconds true if non-zero offset seconds is appended.
      * @param result Receives the ISO format string.
      * @param status Receives the status
      * @return the ISO 8601 basic format.
      * @see #formatOffsetISO8601Extended
      * @see #parseOffsetISO8601
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UnicodeString& formatOffsetISO8601Basic(int32_t offset, UBool useUtcIndicator, UBool isShort, UBool ignoreSeconds,
         UnicodeString& result, UErrorCode& status) const;
 
     /**
      * Returns the ISO 8601 extended time zone string for the given offset.
      * For example, "-08:00", "-08:30" and "Z"
      *
      * @param offset the offset from GMT(UTC) in milliseconds.
      * @param useUtcIndicator true if ISO 8601 UTC indicator "Z" is used when the offset is 0.
      * @param isShort true if shortest form is used.
      * @param ignoreSeconds true if non-zero offset seconds is appended.
      * @param result Receives the ISO format string.
      * @param status Receives the status
      * @return the ISO 8601 basic format.
      * @see #formatOffsetISO8601Extended
      * @see #parseOffsetISO8601
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UnicodeString& formatOffsetISO8601Extended(int32_t offset, UBool useUtcIndicator, UBool isShort, UBool ignoreSeconds,
         UnicodeString& result, UErrorCode& status) const;
-#endif /* U_HIDE_DRAFT_API */
 
     /**
      * Returns the localized GMT(UTC) offset format for the given offset.
      * The localized GMT offset is defined by;
      * <ul>
      * <li>GMT format pattern (e.g. "GMT {0}" - see {@link #getGMTPattern})
      * <li>Offset time pattern (e.g. "+HH:mm" - see {@link #getGMTOffsetPattern})
      * <li>Offset digits (e.g. "0123456789" - see {@link #getGMTOffsetDigits})
      * <li>GMT zero format (e.g. "GMT" - see {@link #getGMTZeroFormat})
      * </ul>
      * This format always uses 2 digit hours and minutes. When the given offset has non-zero
      * seconds, 2 digit seconds field will be appended. For example,
      * GMT+05:00 and GMT+05:28:06.
      * @param offset the offset from GMT(UTC) in milliseconds.
      * @param status Receives the status
      * @param result Receives the localized GMT format string.
      * @return A reference to the result.
      * @see #parseOffsetLocalizedGMT
      * @stable ICU 50
      */
     UnicodeString& formatOffsetLocalizedGMT(int32_t offset, UnicodeString& result, UErrorCode& status) const;
 
-#ifndef U_HIDE_DRAFT_API
     /**
      * Returns the short localized GMT(UTC) offset format for the given offset.
      * The short localized GMT offset is defined by;
      * <ul>
      * <li>GMT format pattern (e.g. "GMT {0}" - see {@link #getGMTPattern})
      * <li>Offset time pattern (e.g. "+HH:mm" - see {@link #getGMTOffsetPattern})
      * <li>Offset digits (e.g. "0123456789" - see {@link #getGMTOffsetDigits})
      * <li>GMT zero format (e.g. "GMT" - see {@link #getGMTZeroFormat})
      * </ul>
      * This format uses the shortest representation of offset. The hours field does not
      * have leading zero and lower fields with zero will be truncated. For example,
      * GMT+5 and GMT+530.
      * @param offset the offset from GMT(UTC) in milliseconds.
      * @param status Receives the status
      * @param result Receives the short localized GMT format string.
      * @return A reference to the result.
      * @see #parseOffsetShortLocalizedGMT
-     * @draft ICU 51
+     * @stable ICU 51
      */
     UnicodeString& formatOffsetShortLocalizedGMT(int32_t offset, UnicodeString& result, UErrorCode& status) const;
-#endif /* U_HIDE_DRAFT_API */
 
     using Format::format;
 
     /**
      * Returns the display name of the time zone at the given date for the style.
      * @param style The style (e.g. <code>UTZFMT_STYLE_GENERIC_LONG</code>, <code>UTZFMT_STYLE_LOCALIZED_GMT</code>...)
      * @param tz The time zone.
      * @param date The date.
      * @param name Receives the display name.
      * @param timeType the output argument for receiving the time type (standard/daylight/unknown)
@@ skipping 29 matching lines @@
      * and returns 0.
      * @param text The text contains a localized GMT offset string at the position.
      * @param pos The ParsePosition object.
      * @return The offset from GMT(UTC) in milliseconds for the given localized GMT
      *          offset format string.
      * @see #formatOffsetLocalizedGMT
      * @stable ICU 50
      */
     int32_t parseOffsetLocalizedGMT(const UnicodeString& text, ParsePosition& pos) const;
 
-#ifndef U_HIDE_DRAFT_API
     /**
      * Returns offset from GMT(UTC) in milliseconds for the given short localized GMT
      * offset format string. When the given string cannot be parsed, this method
      * sets the current position as the error index to <code>ParsePosition pos</code>
      * and returns 0.
      * @param text The text contains a short localized GMT offset string at the position.
      * @param pos The ParsePosition object.
      * @return The offset from GMT(UTC) in milliseconds for the given short localized GMT
      *          offset format string.
      * @see #formatOffsetShortLocalizedGMT
-     * @draft ICU 51
+     * @stable ICU 51
      */
     int32_t parseOffsetShortLocalizedGMT(const UnicodeString& text, ParsePosition& pos) const;
-#endif /* U_HIDE_DRAFT_API */
 
     /**
      * Returns a <code>TimeZone</code> by parsing the time zone string according to
      * the given parse position, the specified format style and parse options.
      *
      * @param text The text contains a time zone string at the position.
      * @param style The format style
      * @param pos The position.
      * @param parseOptions The parse options repesented by bitwise flags of UTimeZoneFormatParseOption.
      * @param timeType The output argument for receiving the time type (standard/daylight/unknown),
@@ skipping 108 matching lines @@
 
     /* Constant parts of GMT format pattern, populated from localized GMT format pattern*/
     UnicodeString fGMTPatternPrefix;    /* Substring before {0} */
     UnicodeString fGMTPatternSuffix;    /* Substring after {0} */
 
     /* Compiled offset patterns generated from fGMTOffsetPatterns[] */
     UVector* fGMTOffsetPatternItems[UTZFMT_PAT_COUNT];
 
     UBool fAbuttingOffsetHoursAndMinutes;
 
+    /* TZDBTimeZoneNames object used for parsing */
+    TZDBTimeZoneNames* fTZDBTimeZoneNames;
+
     /**
      * Returns the time zone's specific format string.
      * @param tz the time zone
      * @param stdType the name type used for standard time
      * @param dstType the name type used for daylight time
      * @param date the date
      * @param name receives the time zone's specific format name string
      * @param timeType when null, actual time type is set
      * @return a reference to name.
      */
@@ skipping 11 matching lines @@
     UnicodeString& formatGeneric(const TimeZone& tz, int32_t genType, UDate date, UnicodeString& name) const;
 
     /**
      * Lazily create a TimeZoneGenericNames instance
      * @param status receives the status
      * @return the cached TimeZoneGenericNames.
      */
     const TimeZoneGenericNames* getTimeZoneGenericNames(UErrorCode& status) const;
 
     /**
+     * Lazily create a TZDBTimeZoneNames instance
+     * @param status receives the status
+     * @return the cached TZDBTimeZoneNames.
+     */
+    const TZDBTimeZoneNames* getTZDBTimeZoneNames(UErrorCode& status) const;
+
+    /**
      * Private method returning the time zone's exemplar location string.
      * This method will never return empty.
      * @param tz the time zone
      * @param name receives the time zone's exemplar location name
      * @return a reference to name.
      */
     UnicodeString& formatExemplarLocation(const TimeZone& tz, UnicodeString& name) const;
 
     /**
      * Private enum specifying a combination of offset fields
@@ skipping 326 matching lines @@
      * @param tzID receives the time zone ID
      * @return a reference to tzID
      */
     UnicodeString& parseExemplarLocation(const UnicodeString& text, ParsePosition& pos, UnicodeString& tzID) const;
 };
 
 U_NAMESPACE_END
 
 #endif /* !UCONFIG_NO_FORMATTING */
 #endif