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

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*****************************************************************************************
* Copyright (C) 2016, International Business Machines
* Corporation and others. All Rights Reserved.
*****************************************************************************************
*/

#ifndef URELDATEFMT_H
#define URELDATEFMT_H

#include "unicode/utypes.h"

#if !UCONFIG_NO_FORMATTING && !UCONFIG_NO_BREAK_ITERATION

#include "unicode/unum.h"
#include "unicode/udisplaycontext.h"
#include "unicode/localpointer.h"
#include "unicode/uformattedvalue.h"

/**
 * \file
 * \brief C API: URelativeDateTimeFormatter, relative date formatting of unit + numeric offset.
 *
 * Provides simple formatting of relative dates, in two ways
 * <ul>
 *   <li>relative dates with a quantity e.g "in 5 days"</li>
 *   <li>relative dates without a quantity e.g "next Tuesday"</li>
 * </ul>
 * <p>
 * This does not provide compound formatting for multiple units,
 * other than the ability to combine a time string with a relative date,
 * as in "next Tuesday at 3:45 PM". It also does not provide support
 * for determining which unit to use, such as deciding between "in 7 days"
 * and "in 1 week".
 *
 * @stable ICU 57
 */

/**
 * The formatting style
 * @stable ICU 54
 */
typedef enum UDateRelativeDateTimeFormatterStyle {
  /**
   * Everything spelled out.
   * @stable ICU 54
   */
  UDAT_STYLE_LONG,

  /**
   * Abbreviations used when possible.
   * @stable ICU 54
   */
  UDAT_STYLE_SHORT,

  /**
   * Use the shortest possible form.
   * @stable ICU 54
   */
  UDAT_STYLE_NARROW,

#ifndef U_HIDE_DEPRECATED_API
    /**
     * One more than the highest normal UDateRelativeDateTimeFormatterStyle value.
     * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
     */
    UDAT_STYLE_COUNT
#endif  /* U_HIDE_DEPRECATED_API */
} UDateRelativeDateTimeFormatterStyle;

/**
 * Represents the unit for formatting a relative date. e.g "in 5 days"
 * or "next year"
 * @stable ICU 57
 */
typedef enum URelativeDateTimeUnit {
    /**
     * Specifies that relative unit is year, e.g. "last year",
     * "in 5 years". 
     * @stable ICU 57
     */
    UDAT_REL_UNIT_YEAR,
    /**
     * Specifies that relative unit is quarter, e.g. "last quarter",
     * "in 5 quarters".
     * @stable ICU 57
     */
    UDAT_REL_UNIT_QUARTER,
    /**
     * Specifies that relative unit is month, e.g. "last month",
     * "in 5 months".
     * @stable ICU 57
     */
    UDAT_REL_UNIT_MONTH,
    /**
     * Specifies that relative unit is week, e.g. "last week",
     * "in 5 weeks".
     * @stable ICU 57
     */
    UDAT_REL_UNIT_WEEK,
    /**
     * Specifies that relative unit is day, e.g. "yesterday",
     * "in 5 days".
     * @stable ICU 57
     */
    UDAT_REL_UNIT_DAY,
    /**
     * Specifies that relative unit is hour, e.g. "1 hour ago",
     * "in 5 hours".
     * @stable ICU 57
     */
    UDAT_REL_UNIT_HOUR,
    /**
     * Specifies that relative unit is minute, e.g. "1 minute ago",
     * "in 5 minutes".
     * @stable ICU 57
     */
    UDAT_REL_UNIT_MINUTE,
    /**
     * Specifies that relative unit is second, e.g. "1 second ago",
     * "in 5 seconds".
     * @stable ICU 57
     */
    UDAT_REL_UNIT_SECOND,
    /**
     * Specifies that relative unit is Sunday, e.g. "last Sunday",
     * "this Sunday", "next Sunday", "in 5 Sundays".
     * @stable ICU 57
     */
    UDAT_REL_UNIT_SUNDAY,
    /**
     * Specifies that relative unit is Monday, e.g. "last Monday",
     * "this Monday", "next Monday", "in 5 Mondays".
     * @stable ICU 57
     */
    UDAT_REL_UNIT_MONDAY,
    /**
     * Specifies that relative unit is Tuesday, e.g. "last Tuesday",
     * "this Tuesday", "next Tuesday", "in 5 Tuesdays".
     * @stable ICU 57
     */
    UDAT_REL_UNIT_TUESDAY,
    /**
     * Specifies that relative unit is Wednesday, e.g. "last Wednesday",
     * "this Wednesday", "next Wednesday", "in 5 Wednesdays".
     * @stable ICU 57
     */
    UDAT_REL_UNIT_WEDNESDAY,
    /**
     * Specifies that relative unit is Thursday, e.g. "last Thursday",
     * "this Thursday", "next Thursday", "in 5 Thursdays". 
     * @stable ICU 57
     */
    UDAT_REL_UNIT_THURSDAY,
    /**
     * Specifies that relative unit is Friday, e.g. "last Friday",
     * "this Friday", "next Friday", "in 5 Fridays".
     * @stable ICU 57
     */
    UDAT_REL_UNIT_FRIDAY,
    /**
     * Specifies that relative unit is Saturday, e.g. "last Saturday",
     * "this Saturday", "next Saturday", "in 5 Saturdays".
     * @stable ICU 57
     */
    UDAT_REL_UNIT_SATURDAY,
#ifndef U_HIDE_DEPRECATED_API
    /**
     * One more than the highest normal URelativeDateTimeUnit value.
     * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
     */
    UDAT_REL_UNIT_COUNT
#endif  /* U_HIDE_DEPRECATED_API */
} URelativeDateTimeUnit;

#ifndef U_HIDE_DRAFT_API
/**
 * FieldPosition and UFieldPosition selectors for format fields
 * defined by RelativeDateTimeFormatter.
 * @draft ICU 64
 */
typedef enum URelativeDateTimeFormatterField {
    /**
     * Represents a literal text string, like "tomorrow" or "days ago".
     * @draft ICU 64
     */
    UDAT_REL_LITERAL_FIELD,
    /**
     * Represents a number quantity, like "3" in "3 days ago".
     * @draft ICU 64
     */
    UDAT_REL_NUMERIC_FIELD,
} URelativeDateTimeFormatterField;
#endif // U_HIDE_DRAFT_API


/**
 * Opaque URelativeDateTimeFormatter object for use in C programs.
 * @stable ICU 57
 */
struct URelativeDateTimeFormatter;
typedef struct URelativeDateTimeFormatter URelativeDateTimeFormatter;  /**< C typedef for struct URelativeDateTimeFormatter. @stable ICU 57 */


/**
 * Open a new URelativeDateTimeFormatter object for a given locale using the
 * specified width and capitalizationContext, along with a number formatter
 * (if desired) to override the default formatter that would be used for
 * display of numeric field offsets. The default formatter typically rounds
 * toward 0 and has a minimum of 0 fraction digits and a maximum of 3
 * fraction digits (i.e. it will show as many decimal places as necessary
 * up to 3, without showing trailing 0s).
 *
 * @param locale
 *          The locale
 * @param nfToAdopt
 *          A number formatter to set for this URelativeDateTimeFormatter
 *          object (instead of the default decimal formatter). Ownership of
 *          this UNumberFormat object will pass to the URelativeDateTimeFormatter
 *          object (the URelativeDateTimeFormatter adopts the UNumberFormat),
 *          which becomes responsible for closing it. If the caller wishes to
 *          retain ownership of the UNumberFormat object, the caller must clone
 *          it (with unum_clone) and pass the clone to ureldatefmt_open. May be
 *          NULL to use the default decimal formatter.
 * @param width
 *          The width - wide, short, narrow, etc.
 * @param capitalizationContext
 *          A value from UDisplayContext that pertains to capitalization, e.g.
 *          UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE.
 * @param status
 *          A pointer to a UErrorCode to receive any errors.
 * @return
 *          A pointer to a URelativeDateTimeFormatter object for the specified locale,
 *          or NULL if an error occurred.
 * @stable ICU 57
 */
U_STABLE URelativeDateTimeFormatter* U_EXPORT2
ureldatefmt_open( const char*          locale,
                  UNumberFormat*       nfToAdopt,
                  UDateRelativeDateTimeFormatterStyle width,
                  UDisplayContext      capitalizationContext,
                  UErrorCode*          status );

/**
 * Close a URelativeDateTimeFormatter object. Once closed it may no longer be used.
 * @param reldatefmt
 *            The URelativeDateTimeFormatter object to close.
 * @stable ICU 57
 */
U_STABLE void U_EXPORT2
ureldatefmt_close(URelativeDateTimeFormatter *reldatefmt);

#ifndef U_HIDE_DRAFT_API
struct UFormattedRelativeDateTime;
/**
 * Opaque struct to contain the results of a URelativeDateTimeFormatter operation.
 * @draft ICU 64
 */
typedef struct UFormattedRelativeDateTime UFormattedRelativeDateTime;

/**
 * Creates an object to hold the result of a URelativeDateTimeFormatter
 * operation. The object can be used repeatedly; it is cleared whenever
 * passed to a format function.
 *
 * @param ec Set if an error occurs.
 * @return A pointer needing ownership.
 * @draft ICU 64
 */
U_DRAFT UFormattedRelativeDateTime* U_EXPORT2
ureldatefmt_openResult(UErrorCode* ec);

/**
 * Returns a representation of a UFormattedRelativeDateTime as a UFormattedValue,
 * which can be subsequently passed to any API requiring that type.
 *
 * The returned object is owned by the UFormattedRelativeDateTime and is valid
 * only as long as the UFormattedRelativeDateTime is present and unchanged in memory.
 *
 * You can think of this method as a cast between types.
 *
 * @param ufrdt The object containing the formatted string.
 * @param ec Set if an error occurs.
 * @return A UFormattedValue owned by the input object.
 * @draft ICU 64
 */
U_DRAFT const UFormattedValue* U_EXPORT2
ureldatefmt_resultAsValue(const UFormattedRelativeDateTime* ufrdt, UErrorCode* ec);

/**
 * Releases the UFormattedRelativeDateTime created by ureldatefmt_openResult.
 *
 * @param ufrdt The object to release.
 * @draft ICU 64
 */
U_DRAFT void U_EXPORT2
ureldatefmt_closeResult(UFormattedRelativeDateTime* ufrdt);
#endif  /* U_HIDE_DRAFT_API */


#if U_SHOW_CPLUSPLUS_API

U_NAMESPACE_BEGIN

/**
 * \class LocalURelativeDateTimeFormatterPointer
 * "Smart pointer" class, closes a URelativeDateTimeFormatter via ureldatefmt_close().
 * For most methods see the LocalPointerBase base class.
 *
 * @see LocalPointerBase
 * @see LocalPointer
 * @stable ICU 57
 */
U_DEFINE_LOCAL_OPEN_POINTER(LocalURelativeDateTimeFormatterPointer, URelativeDateTimeFormatter, ureldatefmt_close);

#ifndef U_HIDE_DRAFT_API
/**
 * \class LocalUFormattedRelativeDateTimePointer
 * "Smart pointer" class, closes a UFormattedRelativeDateTime via ureldatefmt_closeResult().
 * For most methods see the LocalPointerBase base class.
 *
 * @see LocalPointerBase
 * @see LocalPointer
 * @draft ICU 64
 */
U_DEFINE_LOCAL_OPEN_POINTER(LocalUFormattedRelativeDateTimePointer, UFormattedRelativeDateTime, ureldatefmt_closeResult);
#endif  /* U_HIDE_DRAFT_API */

U_NAMESPACE_END

#endif // U_SHOW_CPLUSPLUS_API

/**
 * Format a combination of URelativeDateTimeUnit and numeric
 * offset using a numeric style, e.g. "1 week ago", "in 1 week",
 * "5 weeks ago", "in 5 weeks".
 *
 * @param reldatefmt
 *          The URelativeDateTimeFormatter object specifying the
 *          format conventions.
 * @param offset
 *          The signed offset for the specified unit. This will
 *          be formatted according to this object's UNumberFormat
 *          object.
 * @param unit
 *          The unit to use when formatting the relative
 *          date, e.g. UDAT_REL_UNIT_WEEK, UDAT_REL_UNIT_FRIDAY.
 * @param result
 *          A pointer to a buffer to receive the formatted result.
 * @param resultCapacity
 *          The maximum size of result.
 * @param status
 *          A pointer to a UErrorCode to receive any errors. In
 *          case of error status, the contents of result are
 *          undefined.
 * @return
 *          The length of the formatted result; may be greater
 *          than resultCapacity, in which case an error is returned.
 * @stable ICU 57
 */
U_STABLE int32_t U_EXPORT2
ureldatefmt_formatNumeric( const URelativeDateTimeFormatter* reldatefmt,
                    double                offset,
                    URelativeDateTimeUnit unit,
                    UChar*                result,
                    int32_t               resultCapacity,
                    UErrorCode*           status);

#ifndef U_HIDE_DRAFT_API
/**
 * Format a combination of URelativeDateTimeUnit and numeric
 * offset using a numeric style, e.g. "1 week ago", "in 1 week",
 * "5 weeks ago", "in 5 weeks".
 *
 * @param reldatefmt
 *          The URelativeDateTimeFormatter object specifying the
 *          format conventions.
 * @param offset
 *          The signed offset for the specified unit. This will
 *          be formatted according to this object's UNumberFormat
 *          object.
 * @param unit
 *          The unit to use when formatting the relative
 *          date, e.g. UDAT_REL_UNIT_WEEK, UDAT_REL_UNIT_FRIDAY.
 * @param result
 *          A pointer to a UFormattedRelativeDateTime to populate.
 * @param status
 *          A pointer to a UErrorCode to receive any errors. In
 *          case of error status, the contents of result are
 *          undefined.
 * @draft ICU 64
 */
U_DRAFT void U_EXPORT2
ureldatefmt_formatNumericToResult(
    const URelativeDateTimeFormatter* reldatefmt,
    double                            offset,
    URelativeDateTimeUnit             unit,
    UFormattedRelativeDateTime*       result,
    UErrorCode*                       status);
#endif  /* U_HIDE_DRAFT_API */

/**
 * Format a combination of URelativeDateTimeUnit and numeric offset
 * using a text style if possible, e.g. "last week", "this week",
 * "next week", "yesterday", "tomorrow". Falls back to numeric
 * style if no appropriate text term is available for the specified
 * offset in the object's locale.
 *
 * @param reldatefmt
 *          The URelativeDateTimeFormatter object specifying the
 *          format conventions.
 * @param offset
 *          The signed offset for the specified unit.
 * @param unit
 *          The unit to use when formatting the relative
 *          date, e.g. UDAT_REL_UNIT_WEEK, UDAT_REL_UNIT_FRIDAY.
 * @param result
 *          A pointer to a buffer to receive the formatted result.
 * @param resultCapacity
 *          The maximum size of result.
 * @param status
 *          A pointer to a UErrorCode to receive any errors. In
 *          case of error status, the contents of result are
 *          undefined.
 * @return
 *          The length of the formatted result; may be greater
 *          than resultCapacity, in which case an error is returned.
 * @stable ICU 57
 */
U_STABLE int32_t U_EXPORT2
ureldatefmt_format( const URelativeDateTimeFormatter* reldatefmt,
                    double                offset,
                    URelativeDateTimeUnit unit,
                    UChar*                result,
                    int32_t               resultCapacity,
                    UErrorCode*           status);

#ifndef U_HIDE_DRAFT_API
/**
 * Format a combination of URelativeDateTimeUnit and numeric offset
 * using a text style if possible, e.g. "last week", "this week",
 * "next week", "yesterday", "tomorrow". Falls back to numeric
 * style if no appropriate text term is available for the specified
 * offset in the object's locale.
 *
 * This method populates a UFormattedRelativeDateTime, which exposes more
 * information than the string populated by format().
 *
 * @param reldatefmt
 *          The URelativeDateTimeFormatter object specifying the
 *          format conventions.
 * @param offset
 *          The signed offset for the specified unit.
 * @param unit
 *          The unit to use when formatting the relative
 *          date, e.g. UDAT_REL_UNIT_WEEK, UDAT_REL_UNIT_FRIDAY.
 * @param result
 *          A pointer to a UFormattedRelativeDateTime to populate.
 * @param status
 *          A pointer to a UErrorCode to receive any errors. In
 *          case of error status, the contents of result are
 *          undefined.
 * @draft ICU 64
 */
U_DRAFT void U_EXPORT2
ureldatefmt_formatToResult(
    const URelativeDateTimeFormatter* reldatefmt,
    double                            offset,
    URelativeDateTimeUnit             unit,
    UFormattedRelativeDateTime*       result,
    UErrorCode*                       status);
#endif  /* U_HIDE_DRAFT_API */

/**
 * Combines a relative date string and a time string in this object's
 * locale. This is done with the same date-time separator used for the
 * default calendar in this locale to produce a result such as
 * "yesterday at 3:45 PM".
 *
 * @param reldatefmt
 *          The URelativeDateTimeFormatter object specifying the format conventions.
 * @param relativeDateString
 *          The relative date string.
 * @param relativeDateStringLen
 *          The length of relativeDateString; may be -1 if relativeDateString
 *          is zero-terminated.
 * @param timeString
 *          The time string.
 * @param timeStringLen
 *          The length of timeString; may be -1 if timeString is zero-terminated.
 * @param result
 *          A pointer to a buffer to receive the formatted result.
 * @param resultCapacity
 *          The maximum size of result.
 * @param status
 *          A pointer to a UErrorCode to receive any errors. In case of error status,
 *          the contents of result are undefined.
 * @return
 *          The length of the formatted result; may be greater than resultCapacity,
 *          in which case an error is returned.
 * @stable ICU 57
 */
U_STABLE int32_t U_EXPORT2
ureldatefmt_combineDateAndTime( const URelativeDateTimeFormatter* reldatefmt,
                    const UChar *     relativeDateString,
                    int32_t           relativeDateStringLen,
                    const UChar *     timeString,
                    int32_t           timeStringLen,
                    UChar*            result,
                    int32_t           resultCapacity,
                    UErrorCode*       status );

#endif /* !UCONFIG_NO_FORMATTING && !UCONFIG_NO_BREAK_ITERATION */

#endif
Commit	Line	Data
f3c0d7a5 A	1	// © 2016 and later: Unicode, Inc. and others.
f3c0d7a5 A	2	// License & terms of use: http://www.unicode.org/copyright.html
2ca993e8 A	3	/*
	4	*****************************************************************************************
	5	* Copyright (C) 2016, International Business Machines
	6	* Corporation and others. All Rights Reserved.
	7	*****************************************************************************************
	8	*/
	9
	10	#ifndef URELDATEFMT_H
	11	#define URELDATEFMT_H
	12
	13	#include "unicode/utypes.h"
	14
	15	#if !UCONFIG_NO_FORMATTING && !UCONFIG_NO_BREAK_ITERATION
	16
	17	#include "unicode/unum.h"
	18	#include "unicode/udisplaycontext.h"
	19	#include "unicode/localpointer.h"
3d1f044b	20	#include "unicode/uformattedvalue.h"
2ca993e8 A	21
	22	/**
	23	* \file
	24	* \brief C API: URelativeDateTimeFormatter, relative date formatting of unit + numeric offset.
	25	*
	26	* Provides simple formatting of relative dates, in two ways
	27	* <ul>
	28	* <li>relative dates with a quantity e.g "in 5 days"</li>
	29	* <li>relative dates without a quantity e.g "next Tuesday"</li>
	30	* </ul>
	31	* <p>
	32	* This does not provide compound formatting for multiple units,
	33	* other than the ability to combine a time string with a relative date,
	34	* as in "next Tuesday at 3:45 PM". It also does not provide support
	35	* for determining which unit to use, such as deciding between "in 7 days"
	36	* and "in 1 week".
	37	*
f3c0d7a5	38	* @stable ICU 57
2ca993e8 A	39	*/
	40
	41	/**
	42	* The formatting style
	43	* @stable ICU 54
	44	*/
	45	typedef enum UDateRelativeDateTimeFormatterStyle {
	46	/**
	47	* Everything spelled out.
	48	* @stable ICU 54
	49	*/
	50	UDAT_STYLE_LONG,
	51
	52	/**
	53	* Abbreviations used when possible.
	54	* @stable ICU 54
	55	*/
	56	UDAT_STYLE_SHORT,
	57
	58	/**
	59	* Use the shortest possible form.
	60	* @stable ICU 54
	61	*/
	62	UDAT_STYLE_NARROW,
	63
f3c0d7a5 A	64	#ifndef U_HIDE_DEPRECATED_API
	65	/**
	66	* One more than the highest normal UDateRelativeDateTimeFormatterStyle value.
	67	* @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
	68	*/
	69	UDAT_STYLE_COUNT
	70	#endif /* U_HIDE_DEPRECATED_API */
2ca993e8 A	71	} UDateRelativeDateTimeFormatterStyle;
2ca993e8 A	72
2ca993e8 A	73	/**
	74	* Represents the unit for formatting a relative date. e.g "in 5 days"
	75	* or "next year"
f3c0d7a5	76	* @stable ICU 57
2ca993e8 A	77	*/
	78	typedef enum URelativeDateTimeUnit {
	79	/**
	80	* Specifies that relative unit is year, e.g. "last year",
	81	* "in 5 years".
f3c0d7a5	82	* @stable ICU 57
2ca993e8 A	83	*/
	84	UDAT_REL_UNIT_YEAR,
	85	/**
	86	* Specifies that relative unit is quarter, e.g. "last quarter",
	87	* "in 5 quarters".
f3c0d7a5	88	* @stable ICU 57
2ca993e8 A	89	*/
	90	UDAT_REL_UNIT_QUARTER,
	91	/**
	92	* Specifies that relative unit is month, e.g. "last month",
	93	* "in 5 months".
f3c0d7a5	94	* @stable ICU 57
2ca993e8 A	95	*/
	96	UDAT_REL_UNIT_MONTH,
	97	/**
	98	* Specifies that relative unit is week, e.g. "last week",
	99	* "in 5 weeks".
f3c0d7a5	100	* @stable ICU 57
2ca993e8 A	101	*/
	102	UDAT_REL_UNIT_WEEK,
	103	/**
	104	* Specifies that relative unit is day, e.g. "yesterday",
	105	* "in 5 days".
f3c0d7a5	106	* @stable ICU 57
2ca993e8 A	107	*/
	108	UDAT_REL_UNIT_DAY,
	109	/**
	110	* Specifies that relative unit is hour, e.g. "1 hour ago",
	111	* "in 5 hours".
f3c0d7a5	112	* @stable ICU 57
2ca993e8 A	113	*/
	114	UDAT_REL_UNIT_HOUR,
	115	/**
	116	* Specifies that relative unit is minute, e.g. "1 minute ago",
	117	* "in 5 minutes".
f3c0d7a5	118	* @stable ICU 57
2ca993e8 A	119	*/
	120	UDAT_REL_UNIT_MINUTE,
	121	/**
	122	* Specifies that relative unit is second, e.g. "1 second ago",
	123	* "in 5 seconds".
f3c0d7a5	124	* @stable ICU 57
2ca993e8 A	125	*/
	126	UDAT_REL_UNIT_SECOND,
	127	/**
	128	* Specifies that relative unit is Sunday, e.g. "last Sunday",
	129	* "this Sunday", "next Sunday", "in 5 Sundays".
f3c0d7a5	130	* @stable ICU 57
2ca993e8 A	131	*/
	132	UDAT_REL_UNIT_SUNDAY,
	133	/**
	134	* Specifies that relative unit is Monday, e.g. "last Monday",
	135	* "this Monday", "next Monday", "in 5 Mondays".
f3c0d7a5	136	* @stable ICU 57
2ca993e8 A	137	*/
	138	UDAT_REL_UNIT_MONDAY,
	139	/**
	140	* Specifies that relative unit is Tuesday, e.g. "last Tuesday",
	141	* "this Tuesday", "next Tuesday", "in 5 Tuesdays".
f3c0d7a5	142	* @stable ICU 57
2ca993e8 A	143	*/
	144	UDAT_REL_UNIT_TUESDAY,
	145	/**
	146	* Specifies that relative unit is Wednesday, e.g. "last Wednesday",
	147	* "this Wednesday", "next Wednesday", "in 5 Wednesdays".
f3c0d7a5	148	* @stable ICU 57
2ca993e8 A	149	*/
	150	UDAT_REL_UNIT_WEDNESDAY,
	151	/**
	152	* Specifies that relative unit is Thursday, e.g. "last Thursday",
	153	* "this Thursday", "next Thursday", "in 5 Thursdays".
f3c0d7a5	154	* @stable ICU 57
2ca993e8 A	155	*/
	156	UDAT_REL_UNIT_THURSDAY,
	157	/**
	158	* Specifies that relative unit is Friday, e.g. "last Friday",
	159	* "this Friday", "next Friday", "in 5 Fridays".
f3c0d7a5	160	* @stable ICU 57
2ca993e8 A	161	*/
	162	UDAT_REL_UNIT_FRIDAY,
	163	/**
	164	* Specifies that relative unit is Saturday, e.g. "last Saturday",
	165	* "this Saturday", "next Saturday", "in 5 Saturdays".
f3c0d7a5	166	* @stable ICU 57
2ca993e8 A	167	*/
2ca993e8 A	168	UDAT_REL_UNIT_SATURDAY,
f3c0d7a5	169	#ifndef U_HIDE_DEPRECATED_API
2ca993e8	170	/**
f3c0d7a5 A	171	* One more than the highest normal URelativeDateTimeUnit value.
f3c0d7a5 A	172	* @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
2ca993e8 A	173	*/
2ca993e8 A	174	UDAT_REL_UNIT_COUNT
f3c0d7a5	175	#endif /* U_HIDE_DEPRECATED_API */
2ca993e8	176	} URelativeDateTimeUnit;
2ca993e8	177
3d1f044b A	178	#ifndef U_HIDE_DRAFT_API
	179	/**
	180	* FieldPosition and UFieldPosition selectors for format fields
	181	* defined by RelativeDateTimeFormatter.
	182	* @draft ICU 64
	183	*/
	184	typedef enum URelativeDateTimeFormatterField {
	185	/**
	186	* Represents a literal text string, like "tomorrow" or "days ago".
	187	* @draft ICU 64
	188	*/
	189	UDAT_REL_LITERAL_FIELD,
	190	/**
	191	* Represents a number quantity, like "3" in "3 days ago".
	192	* @draft ICU 64
	193	*/
	194	UDAT_REL_NUMERIC_FIELD,
	195	} URelativeDateTimeFormatterField;
	196	#endif // U_HIDE_DRAFT_API
	197
	198
2ca993e8 A	199	/**
2ca993e8 A	200	* Opaque URelativeDateTimeFormatter object for use in C programs.
f3c0d7a5	201	* @stable ICU 57
2ca993e8 A	202	*/
2ca993e8 A	203	struct URelativeDateTimeFormatter;
f3c0d7a5	204	typedef struct URelativeDateTimeFormatter URelativeDateTimeFormatter; /*< C typedef for struct URelativeDateTimeFormatter. @stable ICU 57 /
2ca993e8 A	205
	206
	207	/**
	208	* Open a new URelativeDateTimeFormatter object for a given locale using the
	209	* specified width and capitalizationContext, along with a number formatter
	210	* (if desired) to override the default formatter that would be used for
	211	* display of numeric field offsets. The default formatter typically rounds
	212	* toward 0 and has a minimum of 0 fraction digits and a maximum of 3
	213	* fraction digits (i.e. it will show as many decimal places as necessary
	214	* up to 3, without showing trailing 0s).
	215	*
	216	* @param locale
	217	* The locale
	218	* @param nfToAdopt
	219	* A number formatter to set for this URelativeDateTimeFormatter
	220	* object (instead of the default decimal formatter). Ownership of
	221	* this UNumberFormat object will pass to the URelativeDateTimeFormatter
	222	* object (the URelativeDateTimeFormatter adopts the UNumberFormat),
	223	* which becomes responsible for closing it. If the caller wishes to
	224	* retain ownership of the UNumberFormat object, the caller must clone
	225	* it (with unum_clone) and pass the clone to ureldatefmt_open. May be
	226	* NULL to use the default decimal formatter.
	227	* @param width
	228	* The width - wide, short, narrow, etc.
	229	* @param capitalizationContext
	230	* A value from UDisplayContext that pertains to capitalization, e.g.
	231	* UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE.
	232	* @param status
	233	* A pointer to a UErrorCode to receive any errors.
	234	* @return
	235	* A pointer to a URelativeDateTimeFormatter object for the specified locale,
	236	* or NULL if an error occurred.
f3c0d7a5	237	* @stable ICU 57
2ca993e8	238	*/
f3c0d7a5	239	U_STABLE URelativeDateTimeFormatter* U_EXPORT2
2ca993e8 A	240	ureldatefmt_open( const char* locale,
	241	UNumberFormat* nfToAdopt,
	242	UDateRelativeDateTimeFormatterStyle width,
	243	UDisplayContext capitalizationContext,
	244	UErrorCode* status );
	245
	246	/**
	247	* Close a URelativeDateTimeFormatter object. Once closed it may no longer be used.
	248	* @param reldatefmt
	249	* The URelativeDateTimeFormatter object to close.
f3c0d7a5	250	* @stable ICU 57
2ca993e8	251	*/
f3c0d7a5	252	U_STABLE void U_EXPORT2
2ca993e8 A	253	ureldatefmt_close(URelativeDateTimeFormatter *reldatefmt);
2ca993e8 A	254
3d1f044b A	255	#ifndef U_HIDE_DRAFT_API
	256	struct UFormattedRelativeDateTime;
	257	/**
	258	* Opaque struct to contain the results of a URelativeDateTimeFormatter operation.
	259	* @draft ICU 64
	260	*/
	261	typedef struct UFormattedRelativeDateTime UFormattedRelativeDateTime;
	262
	263	/**
	264	* Creates an object to hold the result of a URelativeDateTimeFormatter
	265	* operation. The object can be used repeatedly; it is cleared whenever
	266	* passed to a format function.
	267	*
	268	* @param ec Set if an error occurs.
	269	* @return A pointer needing ownership.
	270	* @draft ICU 64
	271	*/
	272	U_DRAFT UFormattedRelativeDateTime* U_EXPORT2
	273	ureldatefmt_openResult(UErrorCode* ec);
	274
	275	/**
	276	* Returns a representation of a UFormattedRelativeDateTime as a UFormattedValue,
	277	* which can be subsequently passed to any API requiring that type.
	278	*
	279	* The returned object is owned by the UFormattedRelativeDateTime and is valid
	280	* only as long as the UFormattedRelativeDateTime is present and unchanged in memory.
	281	*
	282	* You can think of this method as a cast between types.
	283	*
	284	* @param ufrdt The object containing the formatted string.
	285	* @param ec Set if an error occurs.
	286	* @return A UFormattedValue owned by the input object.
	287	* @draft ICU 64
	288	*/
	289	U_DRAFT const UFormattedValue* U_EXPORT2
	290	ureldatefmt_resultAsValue(const UFormattedRelativeDateTime* ufrdt, UErrorCode* ec);
	291
	292	/**
	293	* Releases the UFormattedRelativeDateTime created by ureldatefmt_openResult.
	294	*
	295	* @param ufrdt The object to release.
	296	* @draft ICU 64
	297	*/
	298	U_DRAFT void U_EXPORT2
	299	ureldatefmt_closeResult(UFormattedRelativeDateTime* ufrdt);
	300	#endif /* U_HIDE_DRAFT_API */
	301
	302
2ca993e8 A	303	#if U_SHOW_CPLUSPLUS_API
	304
	305	U_NAMESPACE_BEGIN
	306
	307	/**
	308	* \class LocalURelativeDateTimeFormatterPointer
	309	* "Smart pointer" class, closes a URelativeDateTimeFormatter via ureldatefmt_close().
	310	* For most methods see the LocalPointerBase base class.
	311	*
	312	* @see LocalPointerBase
	313	* @see LocalPointer
f3c0d7a5	314	* @stable ICU 57
2ca993e8 A	315	*/
	316	U_DEFINE_LOCAL_OPEN_POINTER(LocalURelativeDateTimeFormatterPointer, URelativeDateTimeFormatter, ureldatefmt_close);
	317
3d1f044b A	318	#ifndef U_HIDE_DRAFT_API
	319	/**
	320	* \class LocalUFormattedRelativeDateTimePointer
	321	* "Smart pointer" class, closes a UFormattedRelativeDateTime via ureldatefmt_closeResult().
	322	* For most methods see the LocalPointerBase base class.
	323	*
	324	* @see LocalPointerBase
	325	* @see LocalPointer
	326	* @draft ICU 64
	327	*/
	328	U_DEFINE_LOCAL_OPEN_POINTER(LocalUFormattedRelativeDateTimePointer, UFormattedRelativeDateTime, ureldatefmt_closeResult);
	329	#endif /* U_HIDE_DRAFT_API */
	330
2ca993e8 A	331	U_NAMESPACE_END
2ca993e8 A	332
f3c0d7a5	333	#endif // U_SHOW_CPLUSPLUS_API
2ca993e8 A	334
	335	/**
	336	* Format a combination of URelativeDateTimeUnit and numeric
	337	* offset using a numeric style, e.g. "1 week ago", "in 1 week",
	338	* "5 weeks ago", "in 5 weeks".
	339	*
	340	* @param reldatefmt
	341	* The URelativeDateTimeFormatter object specifying the
	342	* format conventions.
	343	* @param offset
	344	* The signed offset for the specified unit. This will
	345	* be formatted according to this object's UNumberFormat
	346	* object.
	347	* @param unit
	348	* The unit to use when formatting the relative
	349	* date, e.g. UDAT_REL_UNIT_WEEK, UDAT_REL_UNIT_FRIDAY.
	350	* @param result
	351	* A pointer to a buffer to receive the formatted result.
	352	* @param resultCapacity
	353	* The maximum size of result.
	354	* @param status
	355	* A pointer to a UErrorCode to receive any errors. In
	356	* case of error status, the contents of result are
	357	* undefined.
	358	* @return
	359	* The length of the formatted result; may be greater
	360	* than resultCapacity, in which case an error is returned.
f3c0d7a5	361	* @stable ICU 57
2ca993e8	362	*/
f3c0d7a5	363	U_STABLE int32_t U_EXPORT2
2ca993e8 A	364	ureldatefmt_formatNumeric( const URelativeDateTimeFormatter* reldatefmt,
	365	double offset,
	366	URelativeDateTimeUnit unit,
	367	UChar* result,
	368	int32_t resultCapacity,
	369	UErrorCode* status);
	370
3d1f044b A	371	#ifndef U_HIDE_DRAFT_API
	372	/**
	373	* Format a combination of URelativeDateTimeUnit and numeric
	374	* offset using a numeric style, e.g. "1 week ago", "in 1 week",
	375	* "5 weeks ago", "in 5 weeks".
	376	*
	377	* @param reldatefmt
	378	* The URelativeDateTimeFormatter object specifying the
	379	* format conventions.
	380	* @param offset
	381	* The signed offset for the specified unit. This will
	382	* be formatted according to this object's UNumberFormat
	383	* object.
	384	* @param unit
	385	* The unit to use when formatting the relative
	386	* date, e.g. UDAT_REL_UNIT_WEEK, UDAT_REL_UNIT_FRIDAY.
	387	* @param result
	388	* A pointer to a UFormattedRelativeDateTime to populate.
	389	* @param status
	390	* A pointer to a UErrorCode to receive any errors. In
	391	* case of error status, the contents of result are
	392	* undefined.
	393	* @draft ICU 64
	394	*/
	395	U_DRAFT void U_EXPORT2
	396	ureldatefmt_formatNumericToResult(
	397	const URelativeDateTimeFormatter* reldatefmt,
	398	double offset,
	399	URelativeDateTimeUnit unit,
	400	UFormattedRelativeDateTime* result,
	401	UErrorCode* status);
	402	#endif /* U_HIDE_DRAFT_API */
	403
2ca993e8 A	404	/**
	405	* Format a combination of URelativeDateTimeUnit and numeric offset
	406	* using a text style if possible, e.g. "last week", "this week",
	407	* "next week", "yesterday", "tomorrow". Falls back to numeric
	408	* style if no appropriate text term is available for the specified
	409	* offset in the object's locale.
	410	*
	411	* @param reldatefmt
	412	* The URelativeDateTimeFormatter object specifying the
	413	* format conventions.
	414	* @param offset
	415	* The signed offset for the specified unit.
	416	* @param unit
	417	* The unit to use when formatting the relative
	418	* date, e.g. UDAT_REL_UNIT_WEEK, UDAT_REL_UNIT_FRIDAY.
	419	* @param result
	420	* A pointer to a buffer to receive the formatted result.
	421	* @param resultCapacity
	422	* The maximum size of result.
	423	* @param status
	424	* A pointer to a UErrorCode to receive any errors. In
	425	* case of error status, the contents of result are
	426	* undefined.
	427	* @return
	428	* The length of the formatted result; may be greater
	429	* than resultCapacity, in which case an error is returned.
f3c0d7a5	430	* @stable ICU 57
2ca993e8	431	*/
f3c0d7a5	432	U_STABLE int32_t U_EXPORT2
2ca993e8 A	433	ureldatefmt_format( const URelativeDateTimeFormatter* reldatefmt,
	434	double offset,
	435	URelativeDateTimeUnit unit,
	436	UChar* result,
	437	int32_t resultCapacity,
	438	UErrorCode* status);
	439
3d1f044b A	440	#ifndef U_HIDE_DRAFT_API
	441	/**
	442	* Format a combination of URelativeDateTimeUnit and numeric offset
	443	* using a text style if possible, e.g. "last week", "this week",
	444	* "next week", "yesterday", "tomorrow". Falls back to numeric
	445	* style if no appropriate text term is available for the specified
	446	* offset in the object's locale.
	447	*
	448	* This method populates a UFormattedRelativeDateTime, which exposes more
	449	* information than the string populated by format().
	450	*
	451	* @param reldatefmt
	452	* The URelativeDateTimeFormatter object specifying the
	453	* format conventions.
	454	* @param offset
	455	* The signed offset for the specified unit.
	456	* @param unit
	457	* The unit to use when formatting the relative
	458	* date, e.g. UDAT_REL_UNIT_WEEK, UDAT_REL_UNIT_FRIDAY.
	459	* @param result
	460	* A pointer to a UFormattedRelativeDateTime to populate.
	461	* @param status
	462	* A pointer to a UErrorCode to receive any errors. In
	463	* case of error status, the contents of result are
	464	* undefined.
	465	* @draft ICU 64
	466	*/
	467	U_DRAFT void U_EXPORT2
	468	ureldatefmt_formatToResult(
	469	const URelativeDateTimeFormatter* reldatefmt,
	470	double offset,
	471	URelativeDateTimeUnit unit,
	472	UFormattedRelativeDateTime* result,
	473	UErrorCode* status);
	474	#endif /* U_HIDE_DRAFT_API */
	475
2ca993e8 A	476	/**
	477	* Combines a relative date string and a time string in this object's
	478	* locale. This is done with the same date-time separator used for the
	479	* default calendar in this locale to produce a result such as
	480	* "yesterday at 3:45 PM".
	481	*
	482	* @param reldatefmt
	483	* The URelativeDateTimeFormatter object specifying the format conventions.
	484	* @param relativeDateString
	485	* The relative date string.
	486	* @param relativeDateStringLen
	487	* The length of relativeDateString; may be -1 if relativeDateString
	488	* is zero-terminated.
	489	* @param timeString
	490	* The time string.
	491	* @param timeStringLen
	492	* The length of timeString; may be -1 if timeString is zero-terminated.
	493	* @param result
	494	* A pointer to a buffer to receive the formatted result.
	495	* @param resultCapacity
	496	* The maximum size of result.
	497	* @param status
	498	* A pointer to a UErrorCode to receive any errors. In case of error status,
	499	* the contents of result are undefined.
	500	* @return
	501	* The length of the formatted result; may be greater than resultCapacity,
	502	* in which case an error is returned.
f3c0d7a5	503	* @stable ICU 57
2ca993e8	504	*/
f3c0d7a5	505	U_STABLE int32_t U_EXPORT2
2ca993e8 A	506	ureldatefmt_combineDateAndTime( const URelativeDateTimeFormatter* reldatefmt,
	507	const UChar * relativeDateString,
	508	int32_t relativeDateStringLen,
	509	const UChar * timeString,
	510	int32_t timeStringLen,
	511	UChar* result,
	512	int32_t resultCapacity,
	513	UErrorCode* status );
	514
2ca993e8 A	515	#endif /* !UCONFIG_NO_FORMATTING && !UCONFIG_NO_BREAK_ITERATION */
	516
	517	#endif