Update ICU to 54.1 step 1

source/i18n/unicode/smpdtfmt.h

 /*
-* Copyright (C) 1997-2013, International Business Machines Corporation and
+* Copyright (C) 1997-2014, International Business Machines Corporation and
 * others. All Rights Reserved.
 *******************************************************************************
 *
 * File SMPDTFMT.H
 *
 * Modification History:
 *
 *   Date        Name        Description
 *   02/19/97    aliu        Converted from java.
 *   07/09/97    helena      Make ParsePosition into a class.
@@ skipping 15 matching lines @@
 
 /**
  * \file
  * \brief C++ API: Format and parse dates in a language-independent manner.
  */
 
 #if !UCONFIG_NO_FORMATTING
 
 #include "unicode/datefmt.h"
 #include "unicode/udisplaycontext.h"
+#include "unicode/tzfmt.h"  /* for UTimeZoneFormatTimeType */
+#include "unicode/brkiter.h"
 
 U_NAMESPACE_BEGIN
 
 class DateFormatSymbols;
 class DateFormat;
 class MessageFormat;
 class FieldPositionHandler;
 class TimeZoneFormat;
 
 /**
@@ skipping 14 matching lines @@
  *
  * <p><strong>Date and Time Patterns:</strong></p>
  *
  * <p>Date and time formats are specified by <em>date and time pattern</em> strings.
  * Within date and time pattern strings, all unquoted ASCII letters [A-Za-z] are reserved
  * as pattern letters representing calendar fields. <code>SimpleDateFormat</code> supports
  * the date and time formatting algorithm and pattern letters defined by
  * <a href="http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table">UTS#35
  * Unicode Locale Data Markup Language (LDML)</a> and further documented for ICU in the
  * <a href="https://sites.google.com/site/icuprojectuserguide/formatparse/datetime?pli=1#TOC-Date-Field-Symbol-Table">ICU
- * User Guide</a>. The following pattern letters are currently available:</p>
+ * User Guide</a>. The following pattern letters are currently available (note that the actual
+ * values depend on CLDR and may change from the examples shown here):</p>
  *
  * <table border="1">
  *     <tr>
  *         <th>Field</th>
  *         <th style="text-align: center">Sym.</th>
  *         <th style="text-align: center">No.</th>
  *         <th>Example</th>
  *         <th>Description</th>
  *     </tr>
  *     <tr>
  *         <th rowspan="3">era</th>
  *         <td style="text-align: center" rowspan="3">G</td>
  *         <td style="text-align: center">1..3</td>
  *         <td>AD</td>
  *         <td rowspan="3">Era - Replaced with the Era string for the current date. One to three letters for the 
- *         abbreviated form, four letters for the long form, five for the narrow form.</td>
+ *         abbreviated form, four letters for the long (wide) form, five for the narrow form.</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">4</td>
  *         <td>Anno Domini</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">5</td>
  *         <td>A</td>
  *     </tr>
  *     <tr>
@@ skipping 74 matching lines @@
  *         all supra-year fields. For example, for the Julian calendar system, year numbers are positive, with an
  *         era of BCE or CE. An extended year value for the Julian calendar system assigns positive values to CE
  *         years and negative values to BCE years, with 1 BCE being year 0.</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center" rowspan="3">U</td>
  *         <td style="text-align: center">1..3</td>
  *         <td>&#30002;&#23376;</td>
  *         <td rowspan="3">Cyclic year name. Calendars such as the Chinese lunar calendar (and related calendars)
  *         and the Hindu calendars use 60-year cycles of year names. Use one through three letters for the abbreviated
- *         name, four for the full name, or five for the narrow name (currently the data only provides abbreviated names,
+ *         name, four for the full (wide) name, or five for the narrow name (currently the data only provides abbreviated names,
  *         which will be used for all requested name widths). If the calendar does not provide cyclic year name data,
  *         or if the year value to be formatted is out of the range of years for which cyclic name data is provided,
  *         then numeric formatting is used (behaves like 'y').</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">4</td>
  *         <td>(currently also &#30002;&#23376;)</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">5</td>
  *         <td>(currently also &#30002;&#23376;)</td>
  *     </tr>
  *     <tr>
  *         <th rowspan="6">quarter</th>
  *         <td rowspan="3" style="text-align: center">Q</td>
  *         <td style="text-align: center">1..2</td>
  *         <td>02</td>
- *         <td rowspan="3">Quarter - Use one or two for the numerical quarter, three for the abbreviation, or four 
- *         for the full name.</td>
+ *         <td rowspan="3">Quarter - Use one or two for the numerical quarter, three for the abbreviation, or four for the
+ *         full (wide) name (five for the narrow name is not yet supported).</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">3</td>
  *         <td>Q2</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">4</td>
  *         <td>2nd quarter</td>
  *     </tr>
  *     <tr>
  *         <td rowspan="3" style="text-align: center">q</td>
  *         <td style="text-align: center">1..2</td>
  *         <td>02</td>
  *         <td rowspan="3"><b>Stand-Alone</b> Quarter - Use one or two for the numerical quarter, three for the abbreviation, 
- *         or four for the full name.</td>
+ *         or four for the full name (five for the narrow name is not yet supported).</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">3</td>
  *         <td>Q2</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">4</td>
  *         <td>2nd quarter</td>
  *     </tr>
  *     <tr>
  *         <th rowspan="8">month</th>
  *         <td rowspan="4" style="text-align: center">M</td>
  *         <td style="text-align: center">1..2</td>
  *         <td>09</td>
  *         <td rowspan="4">Month - Use one or two for the numerical month, three for the abbreviation, four for
- *         the full name, or five for the narrow name.</td>
+ *         the full (wide) name, or five for the narrow name. With two ("MM"), the month number is zero-padded
+ *         if necessary (e.g. "08")</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">3</td>
- *         <td>Sept</td>
+ *         <td>Sep</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">4</td>
  *         <td>September</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">5</td>
  *         <td>S</td>
  *     </tr>
  *     <tr>
  *         <td rowspan="4" style="text-align: center">L</td>
  *         <td style="text-align: center">1..2</td>
  *         <td>09</td>
  *         <td rowspan="4"><b>Stand-Alone</b> Month - Use one or two for the numerical month, three for the abbreviation, 
- *         or four for the full name, or 5 for the narrow name.</td>
+ *         four for the full (wide) name, or 5 for the narrow name. With two ("LL"), the month number is zero-padded if
+ *         necessary (e.g. "08")</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">3</td>
- *         <td>Sept</td>
+ *         <td>Sep</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">4</td>
  *         <td>September</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">5</td>
  *         <td>S</td>
  *     </tr>
  *     <tr>
  *         <th rowspan="2">week</th>
  *         <td style="text-align: center">w</td>
  *         <td style="text-align: center">1..2</td>
  *         <td>27</td>
- *         <td>Week of Year.</td>
+ *         <td>Week of Year. Use "w" to show the minimum number of digits, or "ww" to always show two digits
+ *         (zero-padding if necessary, e.g. "08").</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">W</td>
  *         <td style="text-align: center">1</td>
  *         <td>3</td>
  *         <td>Week of Month</td>
  *     </tr>
  *     <tr>
  *         <th rowspan="4">day</th>
  *         <td style="text-align: center">d</td>
  *         <td style="text-align: center">1..2</td>
  *         <td>1</td>
- *         <td>Date - Day of the month</td>
+ *         <td>Date - Day of the month. Use "d" to show the minimum number of digits, or "dd" to always show
+ *         two digits (zero-padding if necessary, e.g. "08").</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">D</td>
  *         <td style="text-align: center">1..3</td>
  *         <td>345</td>
  *         <td>Day of year</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">F</td>
  *         <td style="text-align: center">1</td>
  *         <td>2</td>
  *         <td>Day of Week in Month. The example is for the 2nd Wed in July</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">g</td>
  *         <td style="text-align: center">1..n</td>
  *         <td>2451334</td>
  *         <td>Modified Julian day. This is different from the conventional Julian day number in two regards.
  *         First, it demarcates days at local zone midnight, rather than noon GMT. Second, it is a local number;
  *         that is, it depends on the local time zone. It can be thought of as a single number that encompasses 
  *         all the date-related fields.</td>
  *     </tr>
  *     <tr>
  *         <th rowspan="14">week<br>
  *         day</th>
  *         <td rowspan="4" style="text-align: center">E</td>
  *         <td style="text-align: center">1..3</td>
- *         <td>Tues</td>
- *         <td rowspan="4">Day of week - Use one through three letters for the short day, or four for the full name, 
+ *         <td>Tue</td>
+ *         <td rowspan="4">Day of week - Use one through three letters for the short day, four for the full (wide) name, 
  *         five for the narrow name, or six for the short name.</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">4</td>
  *         <td>Tuesday</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">5</td>
  *         <td>T</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">6</td>
  *         <td>Tu</td>
  *     </tr>
  *     <tr>
  *         <td rowspan="5" style="text-align: center">e</td>
  *         <td style="text-align: center">1..2</td>
  *         <td>2</td>
  *         <td rowspan="5">Local day of week. Same as E except adds a numeric value that will depend on the local
  *         starting day of the week, using one or two letters. For this example, Monday is the first day of the week.</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">3</td>
- *         <td>Tues</td>
+ *         <td>Tue</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">4</td>
  *         <td>Tuesday</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">5</td>
  *         <td>T</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">6</td>
  *         <td>Tu</td>
  *     </tr>
  *     <tr>
  *         <td rowspan="5" style="text-align: center">c</td>
  *         <td style="text-align: center">1</td>
  *         <td>2</td>
  *         <td rowspan="5"><b>Stand-Alone</b> local day of week - Use one letter for the local numeric value (same
- *         as 'e'), three for the short day, four for the full name, five for the narrow name, or six for
+ *         as 'e'), three for the short day, four for the full (wide) name, five for the narrow name, or six for
  *         the short name.</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">3</td>
- *         <td>Tues</td>
+ *         <td>Tue</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">4</td>
  *         <td>Tuesday</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">5</td>
  *         <td>T</td>
  *     </tr>
  *     <tr>
@@ skipping 34 matching lines @@
  *         <td style="text-align: center">k</td>
  *         <td style="text-align: center">1..2</td>
  *         <td>24</td>
  *         <td>Hour [1-24]. When used in a skeleton, only matches k or H, see above. Use kk for zero padding.</td>
  *     </tr>
  *     <tr>
  *         <th>minute</th>
  *         <td style="text-align: center">m</td>
  *         <td style="text-align: center">1..2</td>
  *         <td>59</td>
- *         <td>Minute. Use one or two for zero padding.</td>
+ *         <td>Minute. Use "m" to show the minimum number of digits, or "mm" to always show two digits
+ *         (zero-padding if necessary, e.g. "08").</td>
  *     </tr>
  *     <tr>
  *         <th rowspan="3">second</th>
  *         <td style="text-align: center">s</td>
  *         <td style="text-align: center">1..2</td>
  *         <td>12</td>
- *         <td>Second. Use one or two for zero padding.</td>
+ *         <td>Second. Use "s" to show the minimum number of digits, or "ss" to always show two digits
+ *         (zero-padding if necessary, e.g. "08").</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">S</td>
  *         <td style="text-align: center">1..n</td>
- *         <td>3456</td>
- *         <td>Fractional Second - truncates (like other time fields) to the count of letters.
+ *         <td>3450</td>
+ *         <td>Fractional Second - truncates (like other time fields) to the count of letters when formatting.
+ *         Appends zeros if more than 3 letters specified. Truncates at three significant digits when parsing.
  *         (example shows display using pattern SSSS for seconds value 12.34567)</td>
  *     </tr>
  *     <tr>
  *         <td style="text-align: center">A</td>
  *         <td style="text-align: center">1..n</td>
  *         <td>69540000</td>
  *         <td>Milliseconds in day. This field behaves <i>exactly</i> like a composite of all time-related fields,
  *         not including the zone fields. As such, it also reflects discontinuities of those fields on DST transition
  *         days. On a day of DST onset, it will jump forward. On a day of DST cessation, it will jump backward. This
  *         reflects the fact that is must be combined with the offset field to obtain a unique local time value.</td>
@@ skipping 636 matching lines @@
      * Set the calendar to be used by this date format. Initially, the default
      * calendar for the specified or default locale is used.  The caller should
      * not delete the Calendar object after it is adopted by this call.
      * Adopting a new calendar will change to the default symbols.
      *
      * @param calendarToAdopt    Calendar object to be adopted.
      * @stable ICU 2.0
      */
     virtual void adoptCalendar(Calendar* calendarToAdopt);
 
-    /* Cannot use #ifndef U_HIDE_DRAFT_API for the following draft method since it is virtual */
-    /**
-     * Set a particular UDisplayContext value in the formatter, such as
-     * UDISPCTX_CAPITALIZATION_FOR_STANDALONE.
-     * @param value The UDisplayContext value to set.
-     * @param status Input/output status. If at entry this indicates a failure
-     *               status, the function will do nothing; otherwise this will be
-     *               updated with any new status from the function. 
-     * @draft ICU 51
-     */
-    virtual void setContext(UDisplayContext value, UErrorCode& status);
-
-    /* Cannot use #ifndef U_HIDE_DRAFT_API for the following draft method since it is virtual */
-    /**
-     * Get the formatter's UDisplayContext value for the specified UDisplayContextType,
-     * such as UDISPCTX_TYPE_CAPITALIZATION.
-     * @param type The UDisplayContextType whose value to return
-     * @param status Input/output status. If at entry this indicates a failure
-     *               status, the function will do nothing; otherwise this will be
-     *               updated with any new status from the function. 
-     * @return The UDisplayContextValue for the specified type.
-     * @draft ICU 51
-     */
-    virtual UDisplayContext getContext(UDisplayContextType type, UErrorCode& status) const;
-
     /* Cannot use #ifndef U_HIDE_INTERNAL_API for the following methods since they are virtual */
     /**
      * Sets the TimeZoneFormat to be used by this date/time formatter.
      * The caller should not delete the TimeZoneFormat object after
      * it is adopted by this call.
      * @param timeZoneFormatToAdopt The TimeZoneFormat object to be adopted.
      * @internal ICU 49 technology preview
      */
     virtual void adoptTimeZoneFormat(TimeZoneFormat* timeZoneFormatToAdopt);
 
     /**
      * Sets the TimeZoneFormat to be used by this date/time formatter.
      * @param newTimeZoneFormat The TimeZoneFormat object to copy.
      * @internal ICU 49 technology preview
      */
     virtual void setTimeZoneFormat(const TimeZoneFormat& newTimeZoneFormat);
 
     /**
      * Gets the time zone format object associated with this date/time formatter.
      * @return the time zone format associated with this date/time formatter.
      * @internal ICU 49 technology preview
      */
     virtual const TimeZoneFormat* getTimeZoneFormat(void) const;
 
+    /* Cannot use #ifndef U_HIDE_DRAFT_API for the following draft method since it is virtual */
+    /**
+     * Set a particular UDisplayContext value in the formatter, such as
+     * UDISPCTX_CAPITALIZATION_FOR_STANDALONE. Note: For getContext, see
+     * DateFormat.
+     * @param value The UDisplayContext value to set.
+     * @param status Input/output status. If at entry this indicates a failure
+     *               status, the function will do nothing; otherwise this will be
+     *               updated with any new status from the function. 
+     * @draft ICU 53
+     */
+    virtual void setContext(UDisplayContext value, UErrorCode& status);
+    
+#ifndef U_HIDE_DRAFT_API
+    /**
+     * Overrides base class method and
+     * This method clears per field NumberFormat instances 
+     * previously set by {@see adoptNumberFormat(const UnicodeString&, NumberFormat*, UErrorCode)} 
+     * @param adoptNF the NumbeferFormat used
+     * @draft ICU 54
+     */
+    void adoptNumberFormat(NumberFormat *formatToAdopt);
+
+    /**
+     * Allow the user to set the NumberFormat for several fields
+     * It can be a single field like: "y"(year) or "M"(month)
+     * It can be several field combined together: "yM"(year and month)
+     * Note: 
+     * 1 symbol field is enough for multiple symbol field (so "y" will override "yy", "yyy")
+     * If the field is not numeric, then override has no effect (like "MMM" will use abbreviation, not numerical field)
+     * Per field NumberFormat can also be cleared in {@see DateFormat::setNumberFormat(const NumberFormat& newNumberFormat)}
+     *
+     * @param fields  the fields to override(like y)
+     * @param adoptNF the NumbeferFormat used
+     * @param status  Receives a status code, which will be U_ZERO_ERROR
+     *                if the operation succeeds.
+     * @draft ICU 54
+     */
+    void adoptNumberFormat(const UnicodeString& fields, NumberFormat *formatToAdopt, UErrorCode &status);
+
+    /**
+     * Get the numbering system to be used for a particular field.
+     * @param field The UDateFormatField to get
+     * @draft ICU 54
+     */
+    const NumberFormat * getNumberFormatForField(UChar field) const;
+#endif  /* U_HIDE_DRAFT_API */
+
 #ifndef U_HIDE_INTERNAL_API
     /**
      * This is for ICU internal use only. Please do not use.
      * Check whether the 'field' is smaller than all the fields covered in
      * pattern, return TRUE if it is. The sequence of calendar field,
      * from large to small is: ERA, YEAR, MONTH, DATE, AM_PM, HOUR, MINUTE,...
      * @param field    the calendar field need to check against
      * @return         TRUE if the 'field' is smaller than all the fields
      *                 covered in pattern. FALSE otherwise.
      * @internal ICU 4.0
@@ skipping 24 matching lines @@
      * @internal ICU 4.0
      */
     const Locale& getSmpFmtLocale(void) const;
 #endif  /* U_HIDE_INTERNAL_API */
 
 private:
     friend class DateFormat;
 
     void initializeDefaultCentury(void);
 
+    void initializeBooleanAttributes(void);
+
     SimpleDateFormat(); // default constructor not implemented
 
     /**
      * Used by the DateFormat factory methods to construct a SimpleDateFormat.
      * @param timeStyle the time style.
      * @param dateStyle the date style.
      * @param locale    the given locale.
      * @param status    Output param set to success/failure code on
      *                  exit.
      */
@@ skipping 144 matching lines @@
     
     /**
      * Private function used by subParse to match literal pattern text.
      *
      * @param pattern the pattern string
      * @param patternOffset the starting offset into the pattern text. On
      *        outupt will be set the offset of the first non-literal character in the pattern
      * @param text the text being parsed
      * @param textOffset the starting offset into the text. On output
      *                   will be set to the offset of the character after the match
-     * @param lenient <code>TRUE</code> if the parse is lenient, <code>FALSE</code> otherwise.
+     * @param whitespaceLenient <code>TRUE</code> if whitespace parse is lenient, <code>FALSE</code> otherwise.
+     * @param partialMatchLenient <code>TRUE</code> if partial match parse is lenient, <code>FALSE</code> otherwise.
+     * @param oldLeniency <code>TRUE</code> if old leniency control is lenient, <code>FALSE</code> otherwise.
      *
      * @return <code>TRUE</code> if the literal text could be matched, <code>FALSE</code> otherwise.
      */
     static UBool matchLiterals(const UnicodeString &pattern, int32_t &patternOffset,
-                               const UnicodeString &text, int32_t &textOffset, UBool lenient);
+                               const UnicodeString &text, int32_t &textOffset, 
+                               UBool whitespaceLenient, UBool partialMatchLenient, UBool oldLeniency);
     
     /**
      * Private member function that converts the parsed date strings into
      * timeFields. Returns -start (for ParsePosition) if failed.
      * @param text the time text to be parsed.
      * @param start where to start parsing.
      * @param ch the pattern character for the date field text to be parsed.
      * @param count the count of a pattern character.
      * @param obeyCount if true then the count is strictly obeyed.
      * @param allowNegative
      * @param ambiguousYear If true then the two-digit year == the default start year.
      * @param saveHebrewMonth Used to hang onto month until year is known.
      * @param cal a Calendar set to the date and time to be formatted
      *            into a date/time string.
      * @param patLoc
      * @param numericLeapMonthFormatter If non-null, used to parse numeric leap months.
+     * @param tzTimeType the type of parsed time zone - standard, daylight or unknown (output).
+     *      This parameter can be NULL if caller does not need the information.
      * @return the new start position if matching succeeded; a negative number
      * indicating matching failure, otherwise.
      */
     int32_t subParse(const UnicodeString& text, int32_t& start, UChar ch, int32_t count,
                      UBool obeyCount, UBool allowNegative, UBool ambiguousYear[], int32_t& saveHebrewMonth, Calendar& cal,
-                     int32_t patLoc, MessageFormat * numericLeapMonthFormatter) const;
+                     int32_t patLoc, MessageFormat * numericLeapMonthFormatter, UTimeZoneFormatTimeType *tzTimeType) const;
 
     void parseInt(const UnicodeString& text,
                   Formattable& number,
                   ParsePosition& pos,
                   UBool allowNegative,
                   NumberFormat *fmt) const;
 
     void parseInt(const UnicodeString& text,
                   Formattable& number,
                   int32_t maxDigits,
@@ skipping 135 matching lines @@
      * defaultCenturyStartYear are only used if explicitly set by the user
      * through the API method parseAmbiguousDatesAsAfter().
      */
     UDate                fDefaultCenturyStart;
 
     /**
      * See documentation for defaultCenturyStart.
      */
     /*transient*/ int32_t   fDefaultCenturyStartYear;
 
-    int32_t tztype; // here to avoid api change
-
     typedef struct NSOverride {
         NumberFormat *nf;
         int32_t hash;
         NSOverride *next;
     } NSOverride;
 
     NumberFormat    **fNumberFormatters;
 
     NSOverride      *fOverrideList;
 
     UBool fHaveDefaultCentury;
 
-    UDisplayContext fCapitalizationContext;
+    BreakIterator* fCapitalizationBrkIter;
 };
 
 inline UDate
 SimpleDateFormat::get2DigitYearStart(UErrorCode& /*status*/) const
 {
     return fDefaultCenturyStart;
 }
 
 U_NAMESPACE_END
 
 #endif /* #if !UCONFIG_NO_FORMATTING */
 
 #endif // _SMPDTFMT
 //eof