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

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

#ifndef UDATEINTERVALFORMAT_H
#define UDATEINTERVALFORMAT_H

#include "unicode/utypes.h"

#if !UCONFIG_NO_FORMATTING

#include "unicode/umisc.h"
#include "unicode/localpointer.h"

/**
 * \file
 * \brief C API: Format a date interval.
 *
 * A UDateIntervalFormat is used to format the range between two UDate values
 * in a locale-sensitive way, using a skeleton that specifies the precision and
 * completeness of the information to show. If the range smaller than the resolution
 * specified by the skeleton, a single date format will be produced. If the range
 * is larger than the format specified by the skeleton, a locale-specific fallback
 * will be used to format the items missing from the skeleton.
 *
 * For example, if the range is 2010-03-04 07:56 - 2010-03-04 19:56 (12 hours)
 * - The skeleton jm will produce
 *   for en_US, "7:56 AM - 7:56 PM"
 *   for en_GB, "7:56 - 19:56"
 * - The skeleton MMMd will produce
 *   for en_US, "Mar 4"
 *   for en_GB, "4 Mar"
 * If the range is 2010-03-04 07:56 - 2010-03-08 16:11 (4 days, 8 hours, 15 minutes)
 * - The skeleton jm will produce
 *   for en_US, "3/4/2010 7:56 AM - 3/8/2010 4:11 PM"
 *   for en_GB, "4/3/2010 7:56 - 8/3/2010 16:11"
 * - The skeleton MMMd will produce
 *   for en_US, "Mar 4-8"
 *   for en_GB, "4-8 Mar"
 * 
 * Note:  the "-" characters in the above sample output will actually be
 * Unicode 2013, EN_DASH, in all but the last example.
 *
 * Note, in ICU 4.4 the standard skeletons for which date interval format data
 * is usually available are as follows; best results will be obtained by using
 * skeletons from this set, or those formed by combining these standard skeletons
 * (note that for these skeletons, the length of digit field such as d, y, or
 * M vs MM is irrelevant (but for non-digit fields such as MMM vs MMMM it is
 * relevant). Note that a skeleton involving h or H generally explicitly requests
 * that time style (12- or 24-hour time respectively). For a skeleton that
 * requests the locale's default time style (h or H), use 'j' instead of h or H.
 *   h, H, hm, Hm,
 *   hv, Hv, hmv, Hmv,
 *   d,
 *   M, MMM, MMMM,
 *   Md, MMMd,
 *   MEd, MMMEd,
 *   y,
 *   yM, yMMM, yMMMM,
 *   yMd, yMMMd,
 *   yMEd, yMMMEd
 *
 * Locales for which ICU 4.4 seems to have a reasonable amount of this data
 * include:
 *   af, am, ar, be, bg, bn, ca, cs, da, de (_AT), el, en (_AU,_CA,_GB,_IE,_IN...),
 *   eo, es (_AR,_CL,_CO,...,_US) et, fa, fi, fo, fr (_BE,_CH,_CA), fur, gsw, he,
 *   hr, hu, hy, is, it (_CH), ja, kk, km, ko, lt, lv, mk, ml, mt, nb, nl )_BE),
 *   nn, pl, pt (_PT), rm, ro, ru (_UA), sk, sl, so, sq, sr, sr_Latn, sv, th, to,
 *   tr, uk, ur, vi, zh (_SG), zh_Hant (_HK,_MO)
 */

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

/**
 * Open a new UDateIntervalFormat object using the predefined rules for a
 * given locale plus a specified skeleton.
 * @param locale
 *            The locale for whose rules should be used; may be NULL for
 *            default locale.
 * @param skeleton
 *            A pattern containing only the fields desired for the interval
 *            format, for example "Hm", "yMMMd", or "yMMMEdHm".
 * @param skeletonLength
 *            The length of skeleton; may be -1 if the skeleton is zero-terminated.
 * @param tzID
 *            A timezone ID specifying the timezone to use. If 0, use the default
 *            timezone.
 * @param tzIDLength
 *            The length of tzID, or -1 if null-terminated. If 0, use the default
 *            timezone.
 * @param status
 *            A pointer to a UErrorCode to receive any errors.
 * @return
 *            A pointer to a UDateIntervalFormat object for the specified locale,
 *            or NULL if an error occurred.
 * @stable ICU 4.8
 */
U_STABLE UDateIntervalFormat* U_EXPORT2
udtitvfmt_open(const char*  locale,
              const UChar* skeleton,
              int32_t      skeletonLength,
              const UChar* tzID,
              int32_t      tzIDLength,
              UErrorCode*  status);

/**
 * Close a UDateIntervalFormat object. Once closed it may no longer be used.
 * @param formatter
 *            The UDateIntervalFormat object to close.
 * @stable ICU 4.8
 */
U_STABLE void U_EXPORT2
udtitvfmt_close(UDateIntervalFormat *formatter);


#if U_SHOW_CPLUSPLUS_API

U_NAMESPACE_BEGIN

/**
 * \class LocalUDateIntervalFormatPointer
 * "Smart pointer" class, closes a UDateIntervalFormat via udtitvfmt_close().
 * For most methods see the LocalPointerBase base class.
 *
 * @see LocalPointerBase
 * @see LocalPointer
 * @stable ICU 4.8
 */
U_DEFINE_LOCAL_OPEN_POINTER(LocalUDateIntervalFormatPointer, UDateIntervalFormat, udtitvfmt_close);

U_NAMESPACE_END

#endif


/**
 * Formats a date/time range using the conventions established for the
 * UDateIntervalFormat object.
 * @param formatter
 *            The UDateIntervalFormat object specifying the format conventions.
 * @param fromDate
 *            The starting point of the range.
 * @param toDate
 *            The ending point of the range.
 * @param result
 *            A pointer to a buffer to receive the formatted range.
 * @param resultCapacity
 *            The maximum size of result.
 * @param position
 *            A pointer to a UFieldPosition. On input, position->field is read.
 *            On output, position->beginIndex and position->endIndex indicate
 *            the beginning and ending indices of field number position->field,
 *            if such a field exists. This parameter may be NULL, in which case
 *            no field position data is returned.
 *            There may be multiple instances of a given field type in an
 *            interval format; in this case the position indices refer to the
 *            first instance.
 * @param status
 *            A pointer to a UErrorCode to receive any errors.
 * @return
 *            The total buffer size needed; if greater than resultLength, the
 *            output was truncated.
 * @stable ICU 4.8
 */
U_STABLE int32_t U_EXPORT2
udtitvfmt_format(const UDateIntervalFormat* formatter,
                UDate           fromDate,
                UDate           toDate,
                UChar*          result,
                int32_t         resultCapacity,
                UFieldPosition* position,
                UErrorCode*     status);

#ifndef U_HIDE_DRAFT_API
/**
 * Attributes and values to control the behavior of udtitvfmt_format.
 * @internal
 */
typedef enum UDateIntervalFormatAttribute {
    /**
     * @internal
     */
    UDTITVFMT_MINIMIZE_TYPE
} UDateIntervalFormatAttribute;

typedef enum UDateIntervalFormatAttributeValue {
    /**
     * Standard behavior, no additional minimization.
     * @internal
     */
    UDTITVFMT_MINIMIZE_NONE = 0,
    /**
     * For intervals of less than 1 month that cross month boundaries,
     * only show one month (use format for greatestDifference=d).
     * @internal
     */
    UDTITVFMT_MINIMIZE_ADJACENT_MONTHS,
    /**
     * For intervals of less than 12 hours that cross day boundaries,
     * only show one day (use format for greatestDifference=h).
     * @internal
     */
    UDTITVFMT_MINIMIZE_ADJACENT_DAYS
} UDateIntervalFormatAttributeValue;

/**
 * Change attributes for the UDateIntervalFormat object.
 * @param formatter
 *            The UDateIntervalFormat object whose attributes are to be changed.
 * @param attr
 *            The attribute to change.
 * @param value
 *            The new value for the attribute.
 * @param status
 *            A pointer to a UErrorCode to receive any errors.
 * @internal
 */
U_INTERNAL void U_EXPORT2 
udtitvfmt_setAttribute(UDateIntervalFormat*             formatter,
                      UDateIntervalFormatAttribute      attr,
                      UDateIntervalFormatAttributeValue value,
                      UErrorCode*                       status);

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

#endif
Commit	Line	Data
4388f060 A	1	/*
4388f060 A	2	*****************************************************************************************
2ca993e8	3	* Copyright (C) 2010-2012,2015-2016 International Business Machines
4388f060 A	4	* Corporation and others. All Rights Reserved.
	5	*****************************************************************************************
	6	*/
	7
	8	#ifndef UDATEINTERVALFORMAT_H
	9	#define UDATEINTERVALFORMAT_H
	10
	11	#include "unicode/utypes.h"
	12
	13	#if !UCONFIG_NO_FORMATTING
	14
	15	#include "unicode/umisc.h"
	16	#include "unicode/localpointer.h"
	17
	18	/**
	19	* \file
	20	* \brief C API: Format a date interval.
	21	*
	22	* A UDateIntervalFormat is used to format the range between two UDate values
	23	* in a locale-sensitive way, using a skeleton that specifies the precision and
	24	* completeness of the information to show. If the range smaller than the resolution
	25	* specified by the skeleton, a single date format will be produced. If the range
	26	* is larger than the format specified by the skeleton, a locale-specific fallback
	27	* will be used to format the items missing from the skeleton.
	28	*
	29	* For example, if the range is 2010-03-04 07:56 - 2010-03-04 19:56 (12 hours)
	30	* - The skeleton jm will produce
	31	* for en_US, "7:56 AM - 7:56 PM"
	32	* for en_GB, "7:56 - 19:56"
	33	* - The skeleton MMMd will produce
	34	* for en_US, "Mar 4"
	35	* for en_GB, "4 Mar"
	36	* If the range is 2010-03-04 07:56 - 2010-03-08 16:11 (4 days, 8 hours, 15 minutes)
	37	* - The skeleton jm will produce
	38	* for en_US, "3/4/2010 7:56 AM - 3/8/2010 4:11 PM"
	39	* for en_GB, "4/3/2010 7:56 - 8/3/2010 16:11"
	40	* - The skeleton MMMd will produce
	41	* for en_US, "Mar 4-8"
	42	* for en_GB, "4-8 Mar"
	43	*
	44	* Note: the "-" characters in the above sample output will actually be
	45	* Unicode 2013, EN_DASH, in all but the last example.
	46	*
	47	* Note, in ICU 4.4 the standard skeletons for which date interval format data
	48	* is usually available are as follows; best results will be obtained by using
	49	* skeletons from this set, or those formed by combining these standard skeletons
	50	* (note that for these skeletons, the length of digit field such as d, y, or
	51	* M vs MM is irrelevant (but for non-digit fields such as MMM vs MMMM it is
	52	* relevant). Note that a skeleton involving h or H generally explicitly requests
	53	* that time style (12- or 24-hour time respectively). For a skeleton that
	54	* requests the locale's default time style (h or H), use 'j' instead of h or H.
	55	* h, H, hm, Hm,
	56	* hv, Hv, hmv, Hmv,
	57	* d,
	58	* M, MMM, MMMM,
	59	* Md, MMMd,
	60	* MEd, MMMEd,
	61	* y,
	62	* yM, yMMM, yMMMM,
	63	* yMd, yMMMd,
	64	* yMEd, yMMMEd
	65	*
	66	* Locales for which ICU 4.4 seems to have a reasonable amount of this data
	67	* include:
68	* af, am, ar, be, bg, bn, ca, cs, da, de (_AT), el, en (_AU,_CA,_GB,_IE,_IN...),
69	* eo, es (_AR,_CL,_CO,...,_US) et, fa, fi, fo, fr (_BE,_CH,_CA), fur, gsw, he,
70	* hr, hu, hy, is, it (_CH), ja, kk, km, ko, lt, lv, mk, ml, mt, nb, nl )_BE),
71	* nn, pl, pt (_PT), rm, ro, ru (_UA), sk, sl, so, sq, sr, sr_Latn, sv, th, to,
72	* tr, uk, ur, vi, zh (_SG), zh_Hant (_HK,_MO)
73	*/
74
75	/**
76	* Opaque UDateIntervalFormat object for use in C programs.
77	* @stable ICU 4.8
78	*/
79	struct UDateIntervalFormat;
80	typedef struct UDateIntervalFormat UDateIntervalFormat; /*< C typedef for struct UDateIntervalFormat. @stable ICU 4.8 /
81
82	/**
83	* Open a new UDateIntervalFormat object using the predefined rules for a
84	* given locale plus a specified skeleton.
85	* @param locale
86	* The locale for whose rules should be used; may be NULL for
87	* default locale.
88	* @param skeleton
89	* A pattern containing only the fields desired for the interval
90	* format, for example "Hm", "yMMMd", or "yMMMEdHm".
91	* @param skeletonLength
92	* The length of skeleton; may be -1 if the skeleton is zero-terminated.
93	* @param tzID
94	* A timezone ID specifying the timezone to use. If 0, use the default
95	* timezone.
96	* @param tzIDLength
97	* The length of tzID, or -1 if null-terminated. If 0, use the default
98	* timezone.
99	* @param status
100	* A pointer to a UErrorCode to receive any errors.
101	* @return
102	* A pointer to a UDateIntervalFormat object for the specified locale,
103	* or NULL if an error occurred.
104	* @stable ICU 4.8
105	*/
51004dcb	106	U_STABLE UDateIntervalFormat* U_EXPORT2
4388f060 A	107	udtitvfmt_open(const char* locale,
	108	const UChar* skeleton,
	109	int32_t skeletonLength,
	110	const UChar* tzID,
	111	int32_t tzIDLength,
	112	UErrorCode* status);
	113
	114	/**
	115	* Close a UDateIntervalFormat object. Once closed it may no longer be used.
	116	* @param formatter
	117	* The UDateIntervalFormat object to close.
	118	* @stable ICU 4.8
	119	*/
51004dcb	120	U_STABLE void U_EXPORT2
4388f060 A	121	udtitvfmt_close(UDateIntervalFormat *formatter);
	122
	123
	124	#if U_SHOW_CPLUSPLUS_API
	125
	126	U_NAMESPACE_BEGIN
	127
	128	/**
	129	* \class LocalUDateIntervalFormatPointer
	130	* "Smart pointer" class, closes a UDateIntervalFormat via udtitvfmt_close().
	131	* For most methods see the LocalPointerBase base class.
	132	*
	133	* @see LocalPointerBase
	134	* @see LocalPointer
	135	* @stable ICU 4.8
	136	*/
	137	U_DEFINE_LOCAL_OPEN_POINTER(LocalUDateIntervalFormatPointer, UDateIntervalFormat, udtitvfmt_close);
	138
	139	U_NAMESPACE_END
	140
	141	#endif
	142
	143
	144	/**
	145	* Formats a date/time range using the conventions established for the
	146	* UDateIntervalFormat object.
	147	* @param formatter
	148	* The UDateIntervalFormat object specifying the format conventions.
	149	* @param fromDate
	150	* The starting point of the range.
	151	* @param toDate
	152	* The ending point of the range.
	153	* @param result
	154	* A pointer to a buffer to receive the formatted range.
	155	* @param resultCapacity
	156	* The maximum size of result.
	157	* @param position
	158	* A pointer to a UFieldPosition. On input, position->field is read.
	159	* On output, position->beginIndex and position->endIndex indicate
	160	* the beginning and ending indices of field number position->field,
	161	* if such a field exists. This parameter may be NULL, in which case
	162	* no field position data is returned.
2ca993e8 A	163	* There may be multiple instances of a given field type in an
	164	* interval format; in this case the position indices refer to the
	165	* first instance.
4388f060 A	166	* @param status
	167	* A pointer to a UErrorCode to receive any errors.
	168	* @return
	169	* The total buffer size needed; if greater than resultLength, the
	170	* output was truncated.
	171	* @stable ICU 4.8
	172	*/
51004dcb	173	U_STABLE int32_t U_EXPORT2
4388f060 A	174	udtitvfmt_format(const UDateIntervalFormat* formatter,
	175	UDate fromDate,
	176	UDate toDate,
	177	UChar* result,
	178	int32_t resultCapacity,
	179	UFieldPosition* position,
	180	UErrorCode* status);
	181
	182	#ifndef U_HIDE_DRAFT_API
	183	/**
	184	* Attributes and values to control the behavior of udtitvfmt_format.
	185	* @internal
	186	*/
	187	typedef enum UDateIntervalFormatAttribute {
	188	/**
	189	* @internal
	190	*/
	191	UDTITVFMT_MINIMIZE_TYPE
	192	} UDateIntervalFormatAttribute;
	193
	194	typedef enum UDateIntervalFormatAttributeValue {
	195	/**
	196	* Standard behavior, no additional minimization.
	197	* @internal
	198	*/
	199	UDTITVFMT_MINIMIZE_NONE = 0,
	200	/**
	201	* For intervals of less than 1 month that cross month boundaries,
	202	* only show one month (use format for greatestDifference=d).
	203	* @internal
	204	*/
2ca993e8 A	205	UDTITVFMT_MINIMIZE_ADJACENT_MONTHS,
	206	/**
	207	* For intervals of less than 12 hours that cross day boundaries,
	208	* only show one day (use format for greatestDifference=h).
	209	* @internal
	210	*/
	211	UDTITVFMT_MINIMIZE_ADJACENT_DAYS
4388f060 A	212	} UDateIntervalFormatAttributeValue;
	213
	214	/**
	215	* Change attributes for the UDateIntervalFormat object.
	216	* @param formatter
	217	* The UDateIntervalFormat object whose attributes are to be changed.
	218	* @param attr
	219	* The attribute to change.
	220	* @param value
	221	* The new value for the attribute.
	222	* @param status
	223	* A pointer to a UErrorCode to receive any errors.
	224	* @internal
	225	*/
	226	U_INTERNAL void U_EXPORT2
	227	udtitvfmt_setAttribute(UDateIntervalFormat* formatter,
	228	UDateIntervalFormatAttribute attr,
	229	UDateIntervalFormatAttributeValue value,
	230	UErrorCode* status);
	231
	232	#endif /* U_HIDE_DRAFT_API */
	233	#endif /* #if !UCONFIG_NO_FORMATTING */
	234
	235	#endif