Update ICU to 58.1

source/i18n/unicode/dtitvinf.h

Index: source/i18n/unicode/dtitvinf.h
diff --git a/source/i18n/unicode/dtitvinf.h b/source/i18n/unicode/dtitvinf.h
index 444356d3f830427efdc72b36ad94624364ee350a..325eca66d6b66621d68e14d44d2faec8c5d071b1 100644
--- a/source/i18n/unicode/dtitvinf.h
+++ b/source/i18n/unicode/dtitvinf.h
@@ -1,6 +1,8 @@
+// Copyright (C) 2016 and later: Unicode, Inc. and others.
+// License & terms of use: http://www.unicode.org/copyright.html
 /*
  *******************************************************************************
- * Copyright (C) 2008-2015, International Business Machines Corporation and
+ * Copyright (C) 2008-2016, International Business Machines Corporation and
  * others. All Rights Reserved.
  *******************************************************************************
  *
@@ -49,22 +51,22 @@ U_NAMESPACE_BEGIN
  * to (date_interval_pattern).
  *
  * <P>
- * A skeleton 
+ * A skeleton
  * <ol>
  * <li>
- * only keeps the field pattern letter and ignores all other parts 
+ * only keeps the field pattern letter and ignores all other parts
  * in a pattern, such as space, punctuations, and string literals.
  * <li>
- * hides the order of fields. 
+ * hides the order of fields.
  * <li>
  * might hide a field's pattern letter length.
  *
- * For those non-digit calendar fields, the pattern letter length is 
- * important, such as MMM, MMMM, and MMMMM; EEE and EEEE, 
+ * For those non-digit calendar fields, the pattern letter length is
+ * important, such as MMM, MMMM, and MMMMM; EEE and EEEE,
  * and the field's pattern letter length is honored.
- *    
- * For the digit calendar fields,  such as M or MM, d or dd, yy or yyyy, 
- * the field pattern length is ignored and the best match, which is defined 
+ *
+ * For the digit calendar fields,  such as M or MM, d or dd, yy or yyyy,
+ * the field pattern length is ignored and the best match, which is defined
  * in date time patterns, will be returned without honor the field pattern
  * letter length in skeleton.
  * </ol>
@@ -73,21 +75,21 @@ U_NAMESPACE_BEGIN
  * The calendar fields we support for interval formatting are:
  * year, month, date, day-of-week, am-pm, hour, hour-of-day, and minute.
  * Those calendar fields can be defined in the following order:
- * year >  month > date > am-pm > hour >  minute 
- *  
+ * year >  month > date > am-pm > hour >  minute
+ *
  * The largest different calendar fields between 2 calendars is the
  * first different calendar field in above order.
  *
- * For example: the largest different calendar fields between &quot;Jan 10, 2007&quot; 
+ * For example: the largest different calendar fields between &quot;Jan 10, 2007&quot;
  * and &quot;Feb 20, 2008&quot; is year.
- *   
+ *
  * <P>
  * There is a set of pre-defined static skeleton strings.
  * There are pre-defined interval patterns for those pre-defined skeletons
  * in locales' resource files.
  * For example, for a skeleton UDAT_YEAR_ABBR_MONTH_DAY, which is  &quot;yMMMd&quot;,
- * in  en_US, if the largest different calendar field between date1 and date2 
- * is &quot;year&quot;, the date interval pattern  is &quot;MMM d, yyyy - MMM d, yyyy&quot;, 
+ * in  en_US, if the largest different calendar field between date1 and date2
+ * is &quot;year&quot;, the date interval pattern  is &quot;MMM d, yyyy - MMM d, yyyy&quot;,
  * such as &quot;Jan 10, 2007 - Jan 10, 2008&quot;.
  * If the largest different calendar field between date1 and date2 is &quot;month&quot;,
  * the date interval pattern is &quot;MMM d - MMM d, yyyy&quot;,
@@ -95,7 +97,7 @@ U_NAMESPACE_BEGIN
  * If the largest different calendar field between date1 and date2 is &quot;day&quot;,
  * the date interval pattern is &quot;MMM d-d, yyyy&quot;, such as &quot;Jan 10-20, 2007&quot;.
  *
- * For date skeleton, the interval patterns when year, or month, or date is 
+ * For date skeleton, the interval patterns when year, or month, or date is
  * different are defined in resource files.
  * For time skeleton, the interval patterns when am/pm, or hour, or minute is
  * different are defined in resource files.
@@ -108,56 +110,57 @@ U_NAMESPACE_BEGIN
  * We use fallback format for the default order for the locale.
  * For example, if the fallback format is &quot;{0} - {1}&quot;, it means
  * the first date in the interval pattern for this locale is earlier date.
- * If the fallback format is &quot;{1} - {0}&quot;, it means the first date is the 
+ * If the fallback format is &quot;{1} - {0}&quot;, it means the first date is the
  * later date.
  * For a particular interval pattern, the default order can be overriden
  * by prefixing &quot;latestFirst:&quot; or &quot;earliestFirst:&quot; to the interval pattern.
  * For example, if the fallback format is &quot;{0}-{1}&quot;,
- * but for skeleton &quot;yMMMd&quot;, the interval pattern when day is different is 
+ * but for skeleton &quot;yMMMd&quot;, the interval pattern when day is different is
  * &quot;latestFirst:d-d MMM yy&quot;, it means by default, the first date in interval
  * pattern is the earlier date. But for skeleton &quot;yMMMd&quot;, when day is different,
  * the first date in &quot;d-d MMM yy&quot; is the later date.
- * 
+ *
  * <P>
- * The recommended way to create a DateIntervalFormat object is to pass in 
- * the locale. 
- * By using a Locale parameter, the DateIntervalFormat object is 
- * initialized with the pre-defined interval patterns for a given or 
+ * The recommended way to create a DateIntervalFormat object is to pass in
+ * the locale.
+ * By using a Locale parameter, the DateIntervalFormat object is
+ * initialized with the pre-defined interval patterns for a given or
  * default locale.
  * <P>
- * Users can also create DateIntervalFormat object 
+ * Users can also create DateIntervalFormat object
  * by supplying their own interval patterns.
  * It provides flexibility for power users.
  *
  * <P>
  * After a DateIntervalInfo object is created, clients may modify
  * the interval patterns using setIntervalPattern function as so desired.
- * Currently, users can only set interval patterns when the following 
- * calendar fields are different: ERA, YEAR, MONTH, DATE,  DAY_OF_MONTH, 
+ * Currently, users can only set interval patterns when the following
+ * calendar fields are different: ERA, YEAR, MONTH, DATE,  DAY_OF_MONTH,
  * DAY_OF_WEEK, AM_PM,  HOUR, HOUR_OF_DAY, and MINUTE.
  * Interval patterns when other calendar fields are different is not supported.
  * <P>
- * DateIntervalInfo objects are cloneable. 
- * When clients obtain a DateIntervalInfo object, 
+ * DateIntervalInfo objects are cloneable.
+ * When clients obtain a DateIntervalInfo object,
  * they can feel free to modify it as necessary.
  * <P>
- * DateIntervalInfo are not expected to be subclassed. 
- * Data for a calendar is loaded out of resource bundles. 
+ * DateIntervalInfo are not expected to be subclassed.
+ * Data for a calendar is loaded out of resource bundles.
  * Through ICU 4.4, date interval patterns are only supported in the Gregorian
- * calendar; non-Gregorian calendars are supported from ICU 4.4.1. 
+ * calendar; non-Gregorian calendars are supported from ICU 4.4.1.
  * @stable ICU 4.0
 **/
 
 class U_I18N_API DateIntervalInfo U_FINAL : public UObject {
 public:
-#ifndef U_HIDE_INTERNAL_API
+    // Do not enclose the protected default constructor with #ifndef U_HIDE_INTERNAL_API
+    // or else the compiler will create a public default constructor.
     /**
      * Default constructor.
      * It does not initialize any interval patterns except
      * that it initialize default fall-back pattern as "{0} - {1}",
      * which can be reset by setFallbackIntervalPattern().
-     * It should be followed by setFallbackIntervalPattern() and 
-     * setIntervalPattern(), 
+     * It should be followed by setFallbackIntervalPattern() and
+     * setIntervalPattern(),
      * and is recommended to be used only for power users who
      * wants to create their own interval patterns and use them to create
      * date interval formatter.
@@ -165,10 +168,9 @@ public:
      * @internal ICU 4.0
      */
     DateIntervalInfo(UErrorCode& status);
-#endif  /* U_HIDE_INTERNAL_API */
 
 
-    /** 
+    /**
      * Construct DateIntervalInfo for the given locale,
      * @param locale  the interval patterns are loaded from the appropriate calendar
      *                data (specified calendar or default calendar) in this locale.
@@ -226,7 +228,7 @@ public:
 
 
 
-    /** 
+    /**
      * Provides a way for client to build interval patterns.
      * User could construct DateIntervalInfo by providing a list of skeletons
      * and their patterns.
@@ -236,53 +238,53 @@ public:
      * UErrorCode status = U_ZERO_ERROR;
      * DateIntervalInfo dIntervalInfo = new DateIntervalInfo();
      * dIntervalInfo->setFallbackIntervalPattern("{0} ~ {1}");
-     * dIntervalInfo->setIntervalPattern("yMd", UCAL_YEAR, "'from' yyyy-M-d 'to' yyyy-M-d", status); 
+     * dIntervalInfo->setIntervalPattern("yMd", UCAL_YEAR, "'from' yyyy-M-d 'to' yyyy-M-d", status);
      * dIntervalInfo->setIntervalPattern("yMMMd", UCAL_MONTH, "'from' yyyy MMM d 'to' MMM d", status);
      * dIntervalInfo->setIntervalPattern("yMMMd", UCAL_DAY, "yyyy MMM d-d", status, status);
      * </pre>
      *
-     * Restriction: 
-     * Currently, users can only set interval patterns when the following 
-     * calendar fields are different: ERA, YEAR, MONTH, DATE,  DAY_OF_MONTH, 
+     * Restriction:
+     * Currently, users can only set interval patterns when the following
+     * calendar fields are different: ERA, YEAR, MONTH, DATE,  DAY_OF_MONTH,
      * DAY_OF_WEEK, AM_PM,  HOUR, HOUR_OF_DAY, and MINUTE.
-     * Interval patterns when other calendar fields are different are 
+     * Interval patterns when other calendar fields are different are
      * not supported.
      *
      * @param skeleton         the skeleton on which interval pattern based
      * @param lrgDiffCalUnit   the largest different calendar unit.
      * @param intervalPattern  the interval pattern on the largest different
      *                         calendar unit.
-     *                         For example, if lrgDiffCalUnit is 
+     *                         For example, if lrgDiffCalUnit is
      *                         "year", the interval pattern for en_US when year
      *                         is different could be "'from' yyyy 'to' yyyy".
      * @param status           output param set to success/failure code on exit
      * @stable ICU 4.0
      */
-    void setIntervalPattern(const UnicodeString& skeleton, 
-                            UCalendarDateFields lrgDiffCalUnit, 
+    void setIntervalPattern(const UnicodeString& skeleton,
+                            UCalendarDateFields lrgDiffCalUnit,
                             const UnicodeString& intervalPattern,
                             UErrorCode& status);
 
     /**
-     * Get the interval pattern given skeleton and 
+     * Get the interval pattern given skeleton and
      * the largest different calendar field.
      * @param skeleton   the skeleton
      * @param field      the largest different calendar field
      * @param result     output param to receive the pattern
      * @param status     output param set to success/failure code on exit
      * @return a reference to 'result'
-     * @stable ICU 4.0 
+     * @stable ICU 4.0
      */
     UnicodeString& getIntervalPattern(const UnicodeString& skeleton,
                                       UCalendarDateFields field,
                                       UnicodeString& result,
-                                      UErrorCode& status) const; 
+                                      UErrorCode& status) const;
 
     /**
      * Get the fallback interval pattern.
      * @param  result   output param to receive the pattern
      * @return a reference to 'result'
-     * @stable ICU 4.0 
+     * @stable ICU 4.0
      */
     UnicodeString& getFallbackIntervalPattern(UnicodeString& result) const;
 
@@ -298,7 +300,7 @@ public:
      *
      * @param fallbackPattern  fall-back interval pattern.
      * @param status           output param set to success/failure code on exit
-     * @stable ICU 4.0 
+     * @stable ICU 4.0
      */
     void setFallbackIntervalPattern(const UnicodeString& fallbackPattern,
                                     UErrorCode& status);
@@ -308,7 +310,7 @@ public:
                              or not.
      * return default date ordering in interval pattern. TRUE if the first date
      *        in pattern is later date, FALSE otherwise.
-     * @stable ICU 4.0 
+     * @stable ICU 4.0
      */
     UBool getDefaultOrder() const;
 
@@ -340,6 +342,11 @@ private:
     friend class DateIntervalFormat;
 
     /**
+     * Internal struct used to load resource bundle data.
+     */
+    struct DateIntervalSink;
+
+    /**
      * Following is for saving the interval patterns.
      * We only support interval patterns on
      * ERA, YEAR, MONTH, DAY, AM_PM, HOUR, and MINUTE
@@ -360,7 +367,7 @@ public:
 #ifndef U_HIDE_INTERNAL_API
     /**
      * Max index for stored interval patterns
-     * @internal ICU 4.4 
+     * @internal ICU 4.4
      */
      enum {
          kMaxIntervalPatternIndex = kIPI_MAX_INDEX
@@ -369,7 +376,7 @@ public:
 private:
 
 
-    /** 
+    /**
      * Initialize the DateIntervalInfo from locale
      * @param locale   the given locale.
      * @param status   output param set to success/failure code on exit
@@ -390,10 +397,10 @@ private:
     void setIntervalPatternInternally(const UnicodeString& skeleton,
                                       UCalendarDateFields lrgDiffCalUnit,
                                       const UnicodeString& intervalPattern,
-                                      UErrorCode& status); 
+                                      UErrorCode& status);
 
 
-    /**given an input skeleton, get the best match skeleton 
+    /**given an input skeleton, get the best match skeleton
      * which has pre-defined interval pattern in resource file.
      * Also return the difference between the input skeleton
      * and the best match skeleton.
@@ -404,7 +411,7 @@ private:
      * @param  bestMatchDistanceInfo  the difference between input skeleton
      *                                and best match skeleton.
      *         0, if there is exact match for input skeleton
-     *         1, if there is only field width difference between 
+     *         1, if there is only field width difference between
      *            the best match and the input skeleton
      *         2, the only field difference is 'v' and 'z'
      *        -1, if there is calendar field difference between
@@ -422,7 +429,7 @@ private:
      * @param skeleton            skeleton to be parsed
      * @param skeletonFieldWidth  parsed skeleton field width
      */
-    static void U_EXPORT2 parseSkeleton(const UnicodeString& skeleton, 
+    static void U_EXPORT2 parseSkeleton(const UnicodeString& skeleton,
                                         int32_t* skeletonFieldWidth);
 
 
@@ -442,12 +449,12 @@ private:
                                          char patternLetter);
 
 
-    /** 
-     * Convert calendar field to the interval pattern index in 
+    /**
+     * Convert calendar field to the interval pattern index in
      * hash table.
      *
-     * Since we only support the following calendar fields: 
-     * ERA, YEAR, MONTH, DATE,  DAY_OF_MONTH, DAY_OF_WEEK, 
+     * Since we only support the following calendar fields:
+     * ERA, YEAR, MONTH, DATE,  DAY_OF_MONTH, DAY_OF_WEEK,
      * AM_PM,  HOUR, HOUR_OF_DAY, and MINUTE,
      * We reserve only 4 interval patterns for a skeleton.
      *
@@ -489,7 +496,7 @@ private:
 
 
     // data members
-    // fallback interval pattern 
+    // fallback interval pattern
     UnicodeString fFallbackIntervalPattern;
     // default order
     UBool fFirstDateInPtnIsLaterDate;