ICU-66108.tar.gz

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

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

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


@@ -19,6 +21,8 @@
 
 #include "unicode/utypes.h"
 
 
 #include "unicode/utypes.h"
 

+#if U_SHOW_CPLUSPLUS_API
+

 /**
  * \file
  * \brief C++ API: Formats messages in a language-neutral way.
 /**
  * \file
  * \brief C++ API: Formats messages in a language-neutral way.


@@ -67,9 +71,8 @@ class NumberFormat;
  * if the pattern has named arguments (see {@link #usesNamedArguments()}).
  *
  * <p>An argument might not specify any format type. In this case,
  * if the pattern has named arguments (see {@link #usesNamedArguments()}).
  *
  * <p>An argument might not specify any format type. In this case,

- * a Number value is formatted with a default (for the locale) NumberFormat,
- * a Date value is formatted with a default (for the locale) DateFormat,
- * and for any other value its toString() value is used.
+ * a numeric value is formatted with a default (for the locale) NumberFormat,
+ * and a date/time value is formatted with a default (for the locale) DateFormat.

  *
  * <p>An argument might specify a "simple" type for which the specified
  * Format object is created, cached and used.
  *
  * <p>An argument might specify a "simple" type for which the specified
  * Format object is created, cached and used.


@@ -122,7 +125,7 @@ class NumberFormat;
  * argNumber = '0' | ('1'..'9' ('0'..'9')*)
  *
  * argType = "number" | "date" | "time" | "spellout" | "ordinal" | "duration"
  * argNumber = '0' | ('1'..'9' ('0'..'9')*)
  *
  * argType = "number" | "date" | "time" | "spellout" | "ordinal" | "duration"

- * argStyle = "short" | "medium" | "long" | "full" | "integer" | "currency" | "percent" | argStyleText
+ * argStyle = "short" | "medium" | "long" | "full" | "integer" | "currency" | "percent" | argStyleText | "::" argSkeletonText

  * </pre>
  *
  * <ul>
  * </pre>
  *
  * <ul>


@@ -164,7 +167,7 @@ class NumberFormat;
  *       <td colspan=2><i>(none)</i>
  *       <td><code>null</code>
  *    <tr>
  *       <td colspan=2><i>(none)</i>
  *       <td><code>null</code>
  *    <tr>

- *       <td rowspan=5><code>number</code>
+ *       <td rowspan=6><code>number</code>

  *       <td><i>(none)</i>
  *       <td><code>NumberFormat.createInstance(getLocale(), status)</code>
  *    <tr>
  *       <td><i>(none)</i>
  *       <td><code>NumberFormat.createInstance(getLocale(), status)</code>
  *    <tr>


@@ -180,7 +183,10 @@ class NumberFormat;
  *       <td><i>argStyleText</i>
  *       <td><code>new DecimalFormat(argStyleText, new DecimalFormatSymbols(getLocale(), status), status)</code>
  *    <tr>
  *       <td><i>argStyleText</i>
  *       <td><code>new DecimalFormat(argStyleText, new DecimalFormatSymbols(getLocale(), status), status)</code>
  *    <tr>

- *       <td rowspan=6><code>date</code>
+ *       <td><i>argSkeletonText</i>
+ *       <td><code>NumberFormatter::forSkeleton(argSkeletonText, status).locale(getLocale()).toFormat(status)</code>
+ *    <tr>
+ *       <td rowspan=7><code>date</code>

  *       <td><i>(none)</i>
  *       <td><code>DateFormat.createDateInstance(kDefault, getLocale(), status)</code>
  *    <tr>
  *       <td><i>(none)</i>
  *       <td><code>DateFormat.createDateInstance(kDefault, getLocale(), status)</code>
  *    <tr>


@@ -197,7 +203,10 @@ class NumberFormat;
  *       <td><code>DateFormat.createDateInstance(kFull, getLocale(), status)</code>
  *    <tr>
  *       <td><i>argStyleText</i>
  *       <td><code>DateFormat.createDateInstance(kFull, getLocale(), status)</code>
  *    <tr>
  *       <td><i>argStyleText</i>

- *       <td><code>new SimpleDateFormat(argStyleText, getLocale(), status)
+ *       <td><code>new SimpleDateFormat(argStyleText, getLocale(), status)</code>
+ *    <tr>
+ *       <td><i>argSkeletonText</i>
+ *       <td><code>DateFormat::createInstanceForSkeleton(argSkeletonText, getLocale(), status)</code>

  *    <tr>
  *       <td rowspan=6><code>time</code>
  *       <td><i>(none)</i>
  *    <tr>
  *       <td rowspan=6><code>time</code>
  *       <td><i>(none)</i>


@@ -216,7 +225,7 @@ class NumberFormat;
  *       <td><code>DateFormat.createTimeInstance(kFull, getLocale(), status)</code>
  *    <tr>
  *       <td><i>argStyleText</i>
  *       <td><code>DateFormat.createTimeInstance(kFull, getLocale(), status)</code>
  *    <tr>
  *       <td><i>argStyleText</i>

- *       <td><code>new SimpleDateFormat(argStyleText, getLocale(), status)
+ *       <td><code>new SimpleDateFormat(argStyleText, getLocale(), status)</code>

  *    <tr>
  *       <td><code>spellout</code>
  *       <td><i>argStyleText (optional)</i>
  *    <tr>
  *       <td><code>spellout</code>
  *       <td><i>argStyleText (optional)</i>


@@ -235,6 +244,19 @@ class NumberFormat;
  * </table>
  * <p>
  *
  * </table>
  * <p>
  *

+ * <h4>Argument formatting</h4>
+ *
+ * <p>Arguments are formatted according to their type, using the default
+ * ICU formatters for those types, unless otherwise specified.</p>
+ *
+ * <p>There are also several ways to control the formatting.</p>
+ *
+ * <p>We recommend you use default styles, predefined style values, skeletons,
+ * or preformatted values, but not pattern strings or custom format objects.</p>
+ *
+ * <p>For more details, see the
+ * <a href="http://userguide.icu-project.org/formatparse/messages">ICU User Guide</a>.</p>
+ *

  * <h4>Usage Information</h4>
  *
  * <p>Here are some examples of usage:
  * <h4>Usage Information</h4>
  *
  * <p>Here are some examples of usage:


@@ -252,11 +274,11 @@ class NumberFormat;
  *
  *     UnicodeString result;
  *     MessageFormat::format(
  *
  *     UnicodeString result;
  *     MessageFormat::format(

- *          "At {1,time} on {1,date}, there was {2} on planet {0,number}.",
+ *          "At {1,time,::jmm} on {1,date,::dMMMM}, there was {2} on planet {0,number}.",

  *          arguments, 3, result, success );
  *
  *     cout << "result: " << result << endl;
  *          arguments, 3, result, success );
  *
  *     cout << "result: " << result << endl;

- *     //<output>: At 4:34:20 PM on 23-Mar-98, there was a disturbance
+ *     //<output>: At 4:34 PM on March 23, there was a disturbance

  *     //             in the Force on planet 7.
  * \endcode
  * </pre>
  *     //             in the Force on planet 7.
  * \endcode
  * </pre>


@@ -398,7 +420,7 @@ public:
      * result and should delete it when done.
      * @stable ICU 2.0
      */
      * result and should delete it when done.
      * @stable ICU 2.0
      */

-    virtual Format* clone(void) const;
+    virtual MessageFormat* clone() const;

 
     /**
      * Returns true if the given Format objects are semantically equal.
 
     /**
      * Returns true if the given Format objects are semantically equal.


@@ -937,7 +959,7 @@ private:
      * @return the index of the list which matches the keyword s.
      */
     static int32_t findKeyword( const UnicodeString& s,
      * @return the index of the list which matches the keyword s.
      */
     static int32_t findKeyword( const UnicodeString& s,

-                                const UChar * const *list);
+                                const char16_t * const *list);

 
     /**
      * Thin wrapper around the format(... AppendableWrapper ...) variant.
 
     /**
      * Thin wrapper around the format(... AppendableWrapper ...) variant.


@@ -989,6 +1011,8 @@ private:
 
     void cacheExplicitFormats(UErrorCode& status);
 
 
     void cacheExplicitFormats(UErrorCode& status);
 

+    int32_t skipLeadingSpaces(UnicodeString& style);
+

     Format* createAppropriateFormat(UnicodeString& type,
                                     UnicodeString& style,
                                     Formattable::Type& formattableType,
     Format* createAppropriateFormat(UnicodeString& type,
                                     UnicodeString& style,
                                     Formattable::Type& formattableType,


@@ -1065,7 +1089,7 @@ private:
     class U_I18N_API DummyFormat : public Format {
     public:
         virtual UBool operator==(const Format&) const;
     class U_I18N_API DummyFormat : public Format {
     public:
         virtual UBool operator==(const Format&) const;

-        virtual Format* clone() const;
+        virtual DummyFormat* clone() const;

         virtual UnicodeString& format(const Formattable& obj,
                               UnicodeString& appendTo,
                               UErrorCode& status) const;
         virtual UnicodeString& format(const Formattable& obj,
                               UnicodeString& appendTo,
                               UErrorCode& status) const;


@@ -1089,5 +1113,7 @@ U_NAMESPACE_END
 
 #endif /* #if !UCONFIG_NO_FORMATTING */
 
 
 #endif /* #if !UCONFIG_NO_FORMATTING */
 

+#endif /* U_SHOW_CPLUSPLUS_API */
+

 #endif // _MSGFMT
 //eof
 #endif // _MSGFMT
 //eof