ICU-64243.0.1.tar.gz

[apple/icu.git] / icuSources / i18n / unicode / smpdtfmt.h

diff --git a/icuSources/i18n/unicode/smpdtfmt.h b/icuSources/i18n/unicode/smpdtfmt.h
index b7fa42054dc9a38a41725bca51a8aa5159037238..6aa58eef6be8198caba8b4d79b6dbf0500a36017 100644 (file)
--- a/icuSources/i18n/unicode/smpdtfmt.h
+++ b/icuSources/i18n/unicode/smpdtfmt.h
@@ -1,3 +1,5 @@
+// © 2016 and later: Unicode, Inc. and others.
+// License & terms of use: http://www.unicode.org/copyright.html

 /*
 * Copyright (C) 1997-2016, International Business Machines Corporation and
 * others. All Rights Reserved.
 /*
 * Copyright (C) 1997-2016, International Business Machines Corporation and
 * others. All Rights Reserved.


@@ -38,6 +40,7 @@
 #include "unicode/tzfmt.h"  /* for UTimeZoneFormatTimeType */
 #include "unicode/brkiter.h"
 
 #include "unicode/tzfmt.h"  /* for UTimeZoneFormatTimeType */
 #include "unicode/brkiter.h"
 

+#if U_SHOW_CPLUSPLUS_API

 U_NAMESPACE_BEGIN
 
 class DateFormatSymbols;
 U_NAMESPACE_BEGIN
 
 class DateFormatSymbols;


@@ -47,6 +50,11 @@ class FieldPositionHandler;
 class TimeZoneFormat;
 class SharedNumberFormat;
 class SimpleDateFormatMutableNFs;
 class TimeZoneFormat;
 class SharedNumberFormat;
 class SimpleDateFormatMutableNFs;

+class DateIntervalFormat;
+
+namespace number {
+class LocalizedNumberFormatter;
+}

 
 /**
  *
 
 /**
  *


@@ -651,7 +659,7 @@ class SimpleDateFormatMutableNFs;
  *         = new SimpleDateFormat ("yyyy.MM.dd G 'at' hh:mm:ss a zzz", success );
  *     GregorianCalendar cal(success);
  *     UDate currentTime_1 = cal.getTime(success);
  *         = new SimpleDateFormat ("yyyy.MM.dd G 'at' hh:mm:ss a zzz", success );
  *     GregorianCalendar cal(success);
  *     UDate currentTime_1 = cal.getTime(success);

- *     FieldPosition fp(0);
+ *     FieldPosition fp(FieldPosition::DONT_CARE);

  *     UnicodeString dateString;
  *     formatter->format( currentTime_1, dateString, fp );
  *     cout << "result: " << dateString << endl;
  *     UnicodeString dateString;
  *     formatter->format( currentTime_1, dateString, fp );
  *     cout << "result: " << dateString << endl;


@@ -999,6 +1007,12 @@ public:
      * (Presumably, letters that would be more mnemonic in that locale's
      * language.)  This function would produce a pattern using those
      * letters.
      * (Presumably, letters that would be more mnemonic in that locale's
      * language.)  This function would produce a pattern using those
      * letters.

+     * <p>
+     * <b>Note:</b> This implementation depends on DateFormatSymbols::getLocalPatternChars()
+     * to get localized format pattern characters. ICU does not include
+     * localized pattern character data, therefore, unless user sets localized
+     * pattern characters manually, this method returns the same result as
+     * toPattern().

      *
      * @param result    Receives the localized pattern.
      * @param status    Output param set to success/failure code on
      *
      * @param result    Receives the localized pattern.
      * @param status    Output param set to success/failure code on


@@ -1135,7 +1149,7 @@ public:
      * Overrides base class method and
      * This method clears per field NumberFormat instances
      * previously set by {@see adoptNumberFormat(const UnicodeString&, NumberFormat*, UErrorCode)}
      * 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
+     * @param formatToAdopt the NumbeferFormat used

      * @stable ICU 54
      */
     void adoptNumberFormat(NumberFormat *formatToAdopt);
      * @stable ICU 54
      */
     void adoptNumberFormat(NumberFormat *formatToAdopt);


@@ -1150,7 +1164,7 @@ public:
      * Per field NumberFormat can also be cleared in {@see DateFormat::setNumberFormat(const NumberFormat& newNumberFormat)}
      *
      * @param fields  the fields to override(like y)
      * 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 formatToAdopt the NumbeferFormat used

      * @param status  Receives a status code, which will be U_ZERO_ERROR
      *                if the operation succeeds.
      * @stable ICU 54
      * @param status  Receives a status code, which will be U_ZERO_ERROR
      *                if the operation succeeds.
      * @stable ICU 54


@@ -1162,7 +1176,7 @@ public:
      * @param field The UDateFormatField to get
      * @stable ICU 54
      */
      * @param field The UDateFormatField to get
      * @stable ICU 54
      */

-    const NumberFormat * getNumberFormatForField(UChar field) const;
+    const NumberFormat * getNumberFormatForField(char16_t field) const;

 
 #ifndef U_HIDE_INTERNAL_API
     /**
 
 #ifndef U_HIDE_INTERNAL_API
     /**


@@ -1201,10 +1215,23 @@ public:
      * @internal ICU 4.0
      */
     const Locale& getSmpFmtLocale(void) const;
      * @internal ICU 4.0
      */
     const Locale& getSmpFmtLocale(void) const;

+
+    /**
+     * Apple addition
+     * This is for ICU internal use only. Please do not use.
+     * Get the capitalization break iterator of this simple date formatter.
+     * Should be cloned before using it.
+     * It is used in udat.
+     *
+     * @return   capitalization break iterator
+     * @internal
+     */
+    BreakIterator* getCapitalizationBrkIter(void) const;

 #endif  /* U_HIDE_INTERNAL_API */
 
 private:
     friend class DateFormat;
 #endif  /* U_HIDE_INTERNAL_API */
 
 private:
     friend class DateFormat;

+    friend class DateIntervalFormat;

 
     void initializeDefaultCentury(void);
 
 
     void initializeDefaultCentury(void);
 


@@ -1254,13 +1281,12 @@ private:
      *                  succeeds.
      */
     void subFormat(UnicodeString &appendTo,
      *                  succeeds.
      */
     void subFormat(UnicodeString &appendTo,

-                   UChar ch,
+                   char16_t ch,

                    int32_t count,
                    UDisplayContext capitalizationContext,
                    int32_t fieldNum,
                    FieldPositionHandler& handler,
                    Calendar& cal,
                    int32_t count,
                    UDisplayContext capitalizationContext,
                    int32_t fieldNum,
                    FieldPositionHandler& handler,
                    Calendar& cal,

-                   SimpleDateFormatMutableNFs &mutableNFs,

                    UErrorCode& status) const; // in case of illegal argument
 
     /**
                    UErrorCode& status) const; // in case of illegal argument
 
     /**


@@ -1276,7 +1302,7 @@ private:
      * @param minDigits Minimum number of digits the result should have
      * @param maxDigits Maximum number of digits the result should have
      */
      * @param minDigits Minimum number of digits the result should have
      * @param maxDigits Maximum number of digits the result should have
      */

-    void zeroPaddingNumber(NumberFormat *currentNumberFormat,
+    void zeroPaddingNumber(const NumberFormat *currentNumberFormat,

                            UnicodeString &appendTo,
                            int32_t value,
                            int32_t minDigits,
                            UnicodeString &appendTo,
                            int32_t value,
                            int32_t minDigits,


@@ -1286,7 +1312,7 @@ private:
      * Return true if the given format character, occuring count
      * times, represents a numeric field.
      */
      * Return true if the given format character, occuring count
      * times, represents a numeric field.
      */

-    static UBool isNumeric(UChar formatChar, int32_t count);
+    static UBool isNumeric(char16_t formatChar, int32_t count);

 
     /**
      * Returns TRUE if the patternOffset is at the start of a numeric field.
 
     /**
      * Returns TRUE if the patternOffset is at the start of a numeric field.


@@ -1404,27 +1430,37 @@ private:
      * @return the new start position if matching succeeded; a negative number
      * indicating matching failure, otherwise.
      */
      * @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,
+    int32_t subParse(const UnicodeString& text, int32_t& start, char16_t ch, int32_t count,

                      UBool obeyCount, UBool allowNegative, UBool ambiguousYear[], int32_t& saveHebrewMonth, Calendar& cal,
                      UBool obeyCount, UBool allowNegative, UBool ambiguousYear[], int32_t& saveHebrewMonth, Calendar& cal,

-                     int32_t patLoc, MessageFormat * numericLeapMonthFormatter, UTimeZoneFormatTimeType *tzTimeType, SimpleDateFormatMutableNFs &mutableNFs,
+                     int32_t patLoc, MessageFormat * numericLeapMonthFormatter, UTimeZoneFormatTimeType *tzTimeType,

                      int32_t *dayPeriod=NULL) const;
 
     void parseInt(const UnicodeString& text,
                   Formattable& number,
                   ParsePosition& pos,
                   UBool allowNegative,
                      int32_t *dayPeriod=NULL) const;
 
     void parseInt(const UnicodeString& text,
                   Formattable& number,
                   ParsePosition& pos,
                   UBool allowNegative,

-                  NumberFormat *fmt) const;
+                  const NumberFormat *fmt) const;

 
     void parseInt(const UnicodeString& text,
                   Formattable& number,
                   int32_t maxDigits,
                   ParsePosition& pos,
                   UBool allowNegative,
 
     void parseInt(const UnicodeString& text,
                   Formattable& number,
                   int32_t maxDigits,
                   ParsePosition& pos,
                   UBool allowNegative,

-                  NumberFormat *fmt) const;
+                  const NumberFormat *fmt) const;

 
     int32_t checkIntSuffix(const UnicodeString& text, int32_t start,
                            int32_t patLoc, UBool isNegative) const;
 
 
     int32_t checkIntSuffix(const UnicodeString& text, int32_t start,
                            int32_t patLoc, UBool isNegative) const;
 

+    /**
+     * Counts number of digit code points in the specified text.
+     *
+     * @param text  input text
+     * @param start start index, inclusive
+     * @param end   end index, exclusive
+     * @return  number of digits found in the text in the specified range.
+    */
+    int32_t countDigits(const UnicodeString& text, int32_t start, int32_t end) const;
+

     /**
      * Translate a pattern, mapping each character in the from string to the
      * corresponding character in the to string. Return an error if the original
     /**
      * Translate a pattern, mapping each character in the from string to the
      * corresponding character in the to string. Return an error if the original


@@ -1477,6 +1513,16 @@ private:
      */
     int32_t skipUWhiteSpace(const UnicodeString& text, int32_t pos) const;
 
      */
     int32_t skipUWhiteSpace(const UnicodeString& text, int32_t pos) const;
 

+    /**
+     * Initialize LocalizedNumberFormatter instances used for speedup.
+     */
+    void initFastNumberFormatters(UErrorCode& status);
+
+    /**
+     * Delete the LocalizedNumberFormatter instances used for speedup.
+     */
+    void freeFastNumberFormatters();
+

     /**
      * Initialize NumberFormat instances used for numbering system overrides.
      */
     /**
      * Initialize NumberFormat instances used for numbering system overrides.
      */


@@ -1500,7 +1546,7 @@ private:
     /**
      * Lazy TimeZoneFormat instantiation, semantically const
      */
     /**
      * Lazy TimeZoneFormat instantiation, semantically const
      */

-    TimeZoneFormat *tzFormat() const;
+    TimeZoneFormat *tzFormat(UErrorCode &status) const;

 
     const NumberFormat* getNumberFormatByIndex(UDateFormatField index) const;
 
 
     const NumberFormat* getNumberFormatByIndex(UDateFormatField index) const;
 


@@ -1515,12 +1561,12 @@ private:
     /**
      * Map calendar field letter into calendar field level.
      */
     /**
      * Map calendar field letter into calendar field level.
      */

-    static int32_t getLevelFromChar(UChar ch);
+    static int32_t getLevelFromChar(char16_t ch);

 
     /**
      * Tell if a character can be used to define a field in a format string.
      */
 
     /**
      * Tell if a character can be used to define a field in a format string.
      */

-    static UBool isSyntaxChar(UChar ch);
+    static UBool isSyntaxChar(char16_t ch);

 
     /**
      * The formatting pattern for this formatter.
 
     /**
      * The formatting pattern for this formatter.


@@ -1566,6 +1612,7 @@ private:
 
     UBool                fHasMinute;
     UBool                fHasSecond;
 
     UBool                fHasMinute;
     UBool                fHasSecond;

+    UBool                fHasHanYearChar; // pattern contains the Han year character \u5E74

 
     /**
      * Sets fHasMinutes and fHasSeconds.
 
     /**
      * Sets fHasMinutes and fHasSeconds.


@@ -1593,6 +1640,20 @@ private:
      */
     const SharedNumberFormat    **fSharedNumberFormatters;
 
      */
     const SharedNumberFormat    **fSharedNumberFormatters;
 

+    enum NumberFormatterKey {
+        SMPDTFMT_NF_1x10,
+        SMPDTFMT_NF_2x10,
+        SMPDTFMT_NF_3x10,
+        SMPDTFMT_NF_4x10,
+        SMPDTFMT_NF_2x2,
+        SMPDTFMT_NF_COUNT
+    };
+
+    /**
+     * Number formatters pre-allocated for fast performance on the most common integer lengths.
+     */
+    const number::LocalizedNumberFormatter* fFastNumberFormatters[SMPDTFMT_NF_COUNT] = {};
+

     UBool fHaveDefaultCentury;
 
     BreakIterator* fCapitalizationBrkIter;
     UBool fHaveDefaultCentury;
 
     BreakIterator* fCapitalizationBrkIter;


@@ -1604,7 +1665,14 @@ SimpleDateFormat::get2DigitYearStart(UErrorCode& /*status*/) const
     return fDefaultCenturyStart;
 }
 
     return fDefaultCenturyStart;
 }
 

+inline BreakIterator*
+SimpleDateFormat::getCapitalizationBrkIter() const
+{
+    return fCapitalizationBrkIter;
+}
+

 U_NAMESPACE_END
 U_NAMESPACE_END

+#endif // U_SHOW_CPLUSPLUS_API

 
 #endif /* #if !UCONFIG_NO_FORMATTING */
 
 
 #endif /* #if !UCONFIG_NO_FORMATTING */