1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4 *******************************************************************************
5 * Copyright (C) 1996-2016, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 *******************************************************************************
8*/
9
10#ifndef UDAT_H
11#define UDAT_H
12
13#include "unicode/utypes.h"
14
15#if !UCONFIG_NO_FORMATTING
16
17#include "unicode/localpointer.h"
18#include "unicode/ucal.h"
19#include "unicode/unum.h"
20#include "unicode/udisplaycontext.h"
21#include "unicode/ufieldpositer.h"
22/**
23 * \file
24 * \brief C API: DateFormat
25 *
26 * <h2> Date Format C API</h2>
27 *
28 * Date Format C API consists of functions that convert dates and
29 * times from their internal representations to textual form and back again in a
30 * language-independent manner. Converting from the internal representation (milliseconds
31 * since midnight, January 1, 1970) to text is known as "formatting," and converting
32 * from text to millis is known as "parsing." We currently define only one concrete
33 * structure UDateFormat, which can handle pretty much all normal
34 * date formatting and parsing actions.
35 * <P>
36 * Date Format helps you to format and parse dates for any locale. Your code can
37 * be completely independent of the locale conventions for months, days of the
38 * week, or even the calendar format: lunar vs. solar.
39 * <P>
40 * To format a date for the current Locale with default time and date style,
41 * use one of the static factory methods:
42 * <pre>
43 * \code
44 * UErrorCode status = U_ZERO_ERROR;
45 * UChar *myString;
46 * int32_t myStrlen = 0;
47 * UDateFormat* dfmt = udat_open(UDAT_DEFAULT, UDAT_DEFAULT, NULL, NULL, -1, NULL, -1, &status);
48 * myStrlen = udat_format(dfmt, myDate, NULL, myStrlen, NULL, &status);
49 * if (status==U_BUFFER_OVERFLOW_ERROR){
50 * status=U_ZERO_ERROR;
51 * myString=(UChar*)malloc(sizeof(UChar) * (myStrlen+1) );
52 * udat_format(dfmt, myDate, myString, myStrlen+1, NULL, &status);
53 * }
54 * \endcode
55 * </pre>
56 * If you are formatting multiple numbers, it is more efficient to get the
57 * format and use it multiple times so that the system doesn't have to fetch the
58 * information about the local language and country conventions multiple times.
59 * <pre>
60 * \code
61 * UErrorCode status = U_ZERO_ERROR;
62 * int32_t i, myStrlen = 0;
63 * UChar* myString;
64 * char buffer[1024];
65 * UDate myDateArr[] = { 0.0, 100000000.0, 2000000000.0 }; // test values
66 * UDateFormat* df = udat_open(UDAT_DEFAULT, UDAT_DEFAULT, NULL, NULL, -1, NULL, 0, &status);
67 * for (i = 0; i < 3; i++) {
68 * myStrlen = udat_format(df, myDateArr[i], NULL, myStrlen, NULL, &status);
69 * if(status == U_BUFFER_OVERFLOW_ERROR){
70 * status = U_ZERO_ERROR;
71 * myString = (UChar*)malloc(sizeof(UChar) * (myStrlen+1) );
72 * udat_format(df, myDateArr[i], myString, myStrlen+1, NULL, &status);
73 * printf("%s\n", u_austrcpy(buffer, myString) );
74 * free(myString);
75 * }
76 * }
77 * \endcode
78 * </pre>
79 * To get specific fields of a date, you can use UFieldPosition to
80 * get specific fields.
81 * <pre>
82 * \code
83 * UErrorCode status = U_ZERO_ERROR;
84 * UFieldPosition pos;
85 * UChar *myString;
86 * int32_t myStrlen = 0;
87 * char buffer[1024];
88 *
89 * pos.field = 1; // Same as the DateFormat::EField enum
90 * UDateFormat* dfmt = udat_open(UDAT_DEFAULT, UDAT_DEFAULT, NULL, -1, NULL, 0, &status);
91 * myStrlen = udat_format(dfmt, myDate, NULL, myStrlen, &pos, &status);
92 * if (status==U_BUFFER_OVERFLOW_ERROR){
93 * status=U_ZERO_ERROR;
94 * myString=(UChar*)malloc(sizeof(UChar) * (myStrlen+1) );
95 * udat_format(dfmt, myDate, myString, myStrlen+1, &pos, &status);
96 * }
97 * printf("date format: %s\n", u_austrcpy(buffer, myString));
98 * buffer[pos.endIndex] = 0; // NULL terminate the string.
99 * printf("UFieldPosition position equals %s\n", &buffer[pos.beginIndex]);
100 * \endcode
101 * </pre>
102 * To format a date for a different Locale, specify it in the call to
103 * udat_open()
104 * <pre>
105 * \code
106 * UDateFormat* df = udat_open(UDAT_SHORT, UDAT_SHORT, "fr_FR", NULL, -1, NULL, 0, &status);
107 * \endcode
108 * </pre>
109 * You can use a DateFormat API udat_parse() to parse.
110 * <pre>
111 * \code
112 * UErrorCode status = U_ZERO_ERROR;
113 * int32_t parsepos=0;
114 * UDate myDate = udat_parse(df, myString, u_strlen(myString), &parsepos, &status);
115 * \endcode
116 * </pre>
117 * You can pass in different options for the arguments for date and time style
118 * to control the length of the result; from SHORT to MEDIUM to LONG to FULL.
119 * The exact result depends on the locale, but generally:
120 * see UDateFormatStyle for more details
121 * <ul type=round>
122 * <li> UDAT_SHORT is completely numeric, such as 12/13/52 or 3:30pm
123 * <li> UDAT_MEDIUM is longer, such as Jan 12, 1952
124 * <li> UDAT_LONG is longer, such as January 12, 1952 or 3:30:32pm
125 * <li> UDAT_FULL is pretty completely specified, such as
126 * Tuesday, April 12, 1952 AD or 3:30:42pm PST.
127 * </ul>
128 * You can also set the time zone on the format if you wish.
129 * <P>
130 * You can also use forms of the parse and format methods with Parse Position and
131 * UFieldPosition to allow you to
132 * <ul type=round>
133 * <li> Progressively parse through pieces of a string.
134 * <li> Align any particular field, or find out where it is for selection
135 * on the screen.
136 * </ul>
137 * <p><strong>Date and Time Patterns:</strong></p>
138 *
139 * <p>Date and time formats are specified by <em>date and time pattern</em> strings.
140 * Within date and time pattern strings, all unquoted ASCII letters [A-Za-z] are reserved
141 * as pattern letters representing calendar fields. <code>UDateFormat</code> supports
142 * the date and time formatting algorithm and pattern letters defined by
143 * <a href="http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table">UTS#35
144 * Unicode Locale Data Markup Language (LDML)</a> and further documented for ICU in the
145 * <a href="https://sites.google.com/site/icuprojectuserguide/formatparse/datetime?pli=1#TOC-Date-Field-Symbol-Table">ICU
146 * User Guide</a>.</p>
147 */
148
149/** A date formatter.
150 * For usage in C programs.
151 * @stable ICU 2.6
152 */
153typedef void* UDateFormat;
154
155/** The possible date/time format styles
156 * @stable ICU 2.6
157 */
158typedef enum UDateFormatStyle {
159 /** Full style */
160 UDAT_FULL,
161 /** Long style */
162 UDAT_LONG,
163 /** Medium style */
164 UDAT_MEDIUM,
165 /** Short style */
166 UDAT_SHORT,
167 /** Default style */
168 UDAT_DEFAULT = UDAT_MEDIUM,
169
170 /** Bitfield for relative date */
171 UDAT_RELATIVE = (1 << 7),
172
173 UDAT_FULL_RELATIVE = UDAT_FULL | UDAT_RELATIVE,
174
175 UDAT_LONG_RELATIVE = UDAT_LONG | UDAT_RELATIVE,
176
177 UDAT_MEDIUM_RELATIVE = UDAT_MEDIUM | UDAT_RELATIVE,
178
179 UDAT_SHORT_RELATIVE = UDAT_SHORT | UDAT_RELATIVE,
180
181
182 /** No style */
183 UDAT_NONE = -1,
184
185 /**
186 * Use the pattern given in the parameter to udat_open
187 * @see udat_open
188 * @stable ICU 50
189 */
190 UDAT_PATTERN = -2,
191
192#ifndef U_HIDE_INTERNAL_API
193 /** @internal alias to UDAT_PATTERN */
194 UDAT_IGNORE = UDAT_PATTERN
195#endif /* U_HIDE_INTERNAL_API */
196} UDateFormatStyle;
197
198/* Skeletons for dates. */
199
200/**
201 * Constant for date skeleton with year.
202 * @stable ICU 4.0
203 */
204#define UDAT_YEAR "y"
205/**
206 * Constant for date skeleton with quarter.
207 * @stable ICU 51
208 */
209#define UDAT_QUARTER "QQQQ"
210/**
211 * Constant for date skeleton with abbreviated quarter.
212 * @stable ICU 51
213 */
214#define UDAT_ABBR_QUARTER "QQQ"
215/**
216 * Constant for date skeleton with year and quarter.
217 * @stable ICU 4.0
218 */
219#define UDAT_YEAR_QUARTER "yQQQQ"
220/**
221 * Constant for date skeleton with year and abbreviated quarter.
222 * @stable ICU 4.0
223 */
224#define UDAT_YEAR_ABBR_QUARTER "yQQQ"
225/**
226 * Constant for date skeleton with month.
227 * @stable ICU 4.0
228 */
229#define UDAT_MONTH "MMMM"
230/**
231 * Constant for date skeleton with abbreviated month.
232 * @stable ICU 4.0
233 */
234#define UDAT_ABBR_MONTH "MMM"
235/**
236 * Constant for date skeleton with numeric month.
237 * @stable ICU 4.0
238 */
239#define UDAT_NUM_MONTH "M"
240/**
241 * Constant for date skeleton with year and month.
242 * @stable ICU 4.0
243 */
244#define UDAT_YEAR_MONTH "yMMMM"
245/**
246 * Constant for date skeleton with year and abbreviated month.
247 * @stable ICU 4.0
248 */
249#define UDAT_YEAR_ABBR_MONTH "yMMM"
250/**
251 * Constant for date skeleton with year and numeric month.
252 * @stable ICU 4.0
253 */
254#define UDAT_YEAR_NUM_MONTH "yM"
255/**
256 * Constant for date skeleton with day.
257 * @stable ICU 4.0
258 */
259#define UDAT_DAY "d"
260/**
261 * Constant for date skeleton with year, month, and day.
262 * Used in combinations date + time, date + time + zone, or time + zone.
263 * @stable ICU 4.0
264 */
265#define UDAT_YEAR_MONTH_DAY "yMMMMd"
266/**
267 * Constant for date skeleton with year, abbreviated month, and day.
268 * Used in combinations date + time, date + time + zone, or time + zone.
269 * @stable ICU 4.0
270 */
271#define UDAT_YEAR_ABBR_MONTH_DAY "yMMMd"
272/**
273 * Constant for date skeleton with year, numeric month, and day.
274 * Used in combinations date + time, date + time + zone, or time + zone.
275 * @stable ICU 4.0
276 */
277#define UDAT_YEAR_NUM_MONTH_DAY "yMd"
278/**
279 * Constant for date skeleton with weekday.
280 * @stable ICU 51
281 */
282#define UDAT_WEEKDAY "EEEE"
283/**
284 * Constant for date skeleton with abbreviated weekday.
285 * @stable ICU 51
286 */
287#define UDAT_ABBR_WEEKDAY "E"
288/**
289 * Constant for date skeleton with year, month, weekday, and day.
290 * Used in combinations date + time, date + time + zone, or time + zone.
291 * @stable ICU 4.0
292 */
293#define UDAT_YEAR_MONTH_WEEKDAY_DAY "yMMMMEEEEd"
294/**
295 * Constant for date skeleton with year, abbreviated month, weekday, and day.
296 * Used in combinations date + time, date + time + zone, or time + zone.
297 * @stable ICU 4.0
298 */
299#define UDAT_YEAR_ABBR_MONTH_WEEKDAY_DAY "yMMMEd"
300/**
301 * Constant for date skeleton with year, numeric month, weekday, and day.
302 * Used in combinations date + time, date + time + zone, or time + zone.
303 * @stable ICU 4.0
304 */
305#define UDAT_YEAR_NUM_MONTH_WEEKDAY_DAY "yMEd"
306/**
307 * Constant for date skeleton with long month and day.
308 * Used in combinations date + time, date + time + zone, or time + zone.
309 * @stable ICU 4.0
310 */
311#define UDAT_MONTH_DAY "MMMMd"
312/**
313 * Constant for date skeleton with abbreviated month and day.
314 * Used in combinations date + time, date + time + zone, or time + zone.
315 * @stable ICU 4.0
316 */
317#define UDAT_ABBR_MONTH_DAY "MMMd"
318/**
319 * Constant for date skeleton with numeric month and day.
320 * Used in combinations date + time, date + time + zone, or time + zone.
321 * @stable ICU 4.0
322 */
323#define UDAT_NUM_MONTH_DAY "Md"
324/**
325 * Constant for date skeleton with month, weekday, and day.
326 * Used in combinations date + time, date + time + zone, or time + zone.
327 * @stable ICU 4.0
328 */
329#define UDAT_MONTH_WEEKDAY_DAY "MMMMEEEEd"
330/**
331 * Constant for date skeleton with abbreviated month, weekday, and day.
332 * Used in combinations date + time, date + time + zone, or time + zone.
333 * @stable ICU 4.0
334 */
335#define UDAT_ABBR_MONTH_WEEKDAY_DAY "MMMEd"
336/**
337 * Constant for date skeleton with numeric month, weekday, and day.
338 * Used in combinations date + time, date + time + zone, or time + zone.
339 * @stable ICU 4.0
340 */
341#define UDAT_NUM_MONTH_WEEKDAY_DAY "MEd"
342
343/* Skeletons for times. */
344
345/**
346 * Constant for date skeleton with hour, with the locale's preferred hour format (12 or 24).
347 * @stable ICU 4.0
348 */
349#define UDAT_HOUR "j"
350/**
351 * Constant for date skeleton with hour in 24-hour presentation.
352 * @stable ICU 51
353 */
354#define UDAT_HOUR24 "H"
355/**
356 * Constant for date skeleton with minute.
357 * @stable ICU 51
358 */
359#define UDAT_MINUTE "m"
360/**
361 * Constant for date skeleton with hour and minute, with the locale's preferred hour format (12 or 24).
362 * Used in combinations date + time, date + time + zone, or time + zone.
363 * @stable ICU 4.0
364 */
365#define UDAT_HOUR_MINUTE "jm"
366/**
367 * Constant for date skeleton with hour and minute in 24-hour presentation.
368 * Used in combinations date + time, date + time + zone, or time + zone.
369 * @stable ICU 4.0
370 */
371#define UDAT_HOUR24_MINUTE "Hm"
372/**
373 * Constant for date skeleton with second.
374 * @stable ICU 51
375 */
376#define UDAT_SECOND "s"
377/**
378 * Constant for date skeleton with hour, minute, and second,
379 * with the locale's preferred hour format (12 or 24).
380 * Used in combinations date + time, date + time + zone, or time + zone.
381 * @stable ICU 4.0
382 */
383#define UDAT_HOUR_MINUTE_SECOND "jms"
384/**
385 * Constant for date skeleton with hour, minute, and second in
386 * 24-hour presentation.
387 * Used in combinations date + time, date + time + zone, or time + zone.
388 * @stable ICU 4.0
389 */
390#define UDAT_HOUR24_MINUTE_SECOND "Hms"
391/**
392 * Constant for date skeleton with minute and second.
393 * Used in combinations date + time, date + time + zone, or time + zone.
394 * @stable ICU 4.0
395 */
396#define UDAT_MINUTE_SECOND "ms"
397
398/* Skeletons for time zones. */
399
400/**
401 * Constant for <i>generic location format</i>, such as Los Angeles Time;
402 * used in combinations date + time + zone, or time + zone.
403 * @see <a href="http://unicode.org/reports/tr35/#Date_Format_Patterns">LDML Date Format Patterns</a>
404 * @see <a href="http://unicode.org/reports/tr35/#Time_Zone_Fallback">LDML Time Zone Fallback</a>
405 * @stable ICU 51
406 */
407#define UDAT_LOCATION_TZ "VVVV"
408/**
409 * Constant for <i>generic non-location format</i>, such as Pacific Time;
410 * used in combinations date + time + zone, or time + zone.
411 * @see <a href="http://unicode.org/reports/tr35/#Date_Format_Patterns">LDML Date Format Patterns</a>
412 * @see <a href="http://unicode.org/reports/tr35/#Time_Zone_Fallback">LDML Time Zone Fallback</a>
413 * @stable ICU 51
414 */
415#define UDAT_GENERIC_TZ "vvvv"
416/**
417 * Constant for <i>generic non-location format</i>, abbreviated if possible, such as PT;
418 * used in combinations date + time + zone, or time + zone.
419 * @see <a href="http://unicode.org/reports/tr35/#Date_Format_Patterns">LDML Date Format Patterns</a>
420 * @see <a href="http://unicode.org/reports/tr35/#Time_Zone_Fallback">LDML Time Zone Fallback</a>
421 * @stable ICU 51
422 */
423#define UDAT_ABBR_GENERIC_TZ "v"
424/**
425 * Constant for <i>specific non-location format</i>, such as Pacific Daylight Time;
426 * used in combinations date + time + zone, or time + zone.
427 * @see <a href="http://unicode.org/reports/tr35/#Date_Format_Patterns">LDML Date Format Patterns</a>
428 * @see <a href="http://unicode.org/reports/tr35/#Time_Zone_Fallback">LDML Time Zone Fallback</a>
429 * @stable ICU 51
430 */
431#define UDAT_SPECIFIC_TZ "zzzz"
432/**
433 * Constant for <i>specific non-location format</i>, abbreviated if possible, such as PDT;
434 * used in combinations date + time + zone, or time + zone.
435 * @see <a href="http://unicode.org/reports/tr35/#Date_Format_Patterns">LDML Date Format Patterns</a>
436 * @see <a href="http://unicode.org/reports/tr35/#Time_Zone_Fallback">LDML Time Zone Fallback</a>
437 * @stable ICU 51
438 */
439#define UDAT_ABBR_SPECIFIC_TZ "z"
440/**
441 * Constant for <i>localized GMT/UTC format</i>, such as GMT+8:00 or HPG-8:00;
442 * used in combinations date + time + zone, or time + zone.
443 * @see <a href="http://unicode.org/reports/tr35/#Date_Format_Patterns">LDML Date Format Patterns</a>
444 * @see <a href="http://unicode.org/reports/tr35/#Time_Zone_Fallback">LDML Time Zone Fallback</a>
445 * @stable ICU 51
446 */
447#define UDAT_ABBR_UTC_TZ "ZZZZ"
448
449/* deprecated skeleton constants */
450
451#ifndef U_HIDE_DEPRECATED_API
452/**
453 * Constant for date skeleton with standalone month.
454 * @deprecated ICU 50 Use UDAT_MONTH instead.
455 */
456#define UDAT_STANDALONE_MONTH "LLLL"
457/**
458 * Constant for date skeleton with standalone abbreviated month.
459 * @deprecated ICU 50 Use UDAT_ABBR_MONTH instead.
460 */
461#define UDAT_ABBR_STANDALONE_MONTH "LLL"
462
463/**
464 * Constant for date skeleton with hour, minute, and generic timezone.
465 * @deprecated ICU 50 Use instead UDAT_HOUR_MINUTE UDAT_ABBR_GENERIC_TZ or some other timezone presentation.
466 */
467#define UDAT_HOUR_MINUTE_GENERIC_TZ "jmv"
468/**
469 * Constant for date skeleton with hour, minute, and timezone.
470 * @deprecated ICU 50 Use instead UDAT_HOUR_MINUTE UDAT_ABBR_SPECIFIC_TZ or some other timezone presentation.
471 */
472#define UDAT_HOUR_MINUTE_TZ "jmz"
473/**
474 * Constant for date skeleton with hour and generic timezone.
475 * @deprecated ICU 50 Use instead UDAT_HOUR UDAT_ABBR_GENERIC_TZ or some other timezone presentation.
476 */
477#define UDAT_HOUR_GENERIC_TZ "jv"
478/**
479 * Constant for date skeleton with hour and timezone.
480 * @deprecated ICU 50 Use instead UDAT_HOUR UDAT_ABBR_SPECIFIC_TZ or some other timezone presentation.
481 */
482#define UDAT_HOUR_TZ "jz"
483#endif /* U_HIDE_DEPRECATED_API */
484
485#ifndef U_HIDE_INTERNAL_API
486/**
487 * Constant for Unicode string name of new (in 2019) Japanese calendar era,
488 * root/English abbreviated version (ASCII-range characters).
489 * @internal
490 */
491#define JP_ERA_2019_ROOT "Reiwa"
492/**
493 * Constant for Unicode string name of new (in 2019) Japanese calendar era,
494 * Japanese abbreviated version (Han, or fullwidth Latin for testing).
495 * @internal
496 */
497#define JP_ERA_2019_JA "\\u4EE4\\u548C"
498/**
499 * Constant for Unicode string name of new (in 2019) Japanese calendar era,
500 * root and Japanese narrow version (ASCII-range characters).
501 * @internal
502 */
503#define JP_ERA_2019_NARROW "R"
504#endif // U_HIDE_INTERNAL_API
505
506/**
507 * FieldPosition and UFieldPosition selectors for format fields
508 * defined by DateFormat and UDateFormat.
509 * @stable ICU 3.0
510 */
511typedef enum UDateFormatField {
512 /**
513 * FieldPosition and UFieldPosition selector for 'G' field alignment,
514 * corresponding to the UCAL_ERA field.
515 * @stable ICU 3.0
516 */
517 UDAT_ERA_FIELD = 0,
518
519 /**
520 * FieldPosition and UFieldPosition selector for 'y' field alignment,
521 * corresponding to the UCAL_YEAR field.
522 * @stable ICU 3.0
523 */
524 UDAT_YEAR_FIELD = 1,
525
526 /**
527 * FieldPosition and UFieldPosition selector for 'M' field alignment,
528 * corresponding to the UCAL_MONTH field.
529 * @stable ICU 3.0
530 */
531 UDAT_MONTH_FIELD = 2,
532
533 /**
534 * FieldPosition and UFieldPosition selector for 'd' field alignment,
535 * corresponding to the UCAL_DATE field.
536 * @stable ICU 3.0
537 */
538 UDAT_DATE_FIELD = 3,
539
540 /**
541 * FieldPosition and UFieldPosition selector for 'k' field alignment,
542 * corresponding to the UCAL_HOUR_OF_DAY field.
543 * UDAT_HOUR_OF_DAY1_FIELD is used for the one-based 24-hour clock.
544 * For example, 23:59 + 01:00 results in 24:59.
545 * @stable ICU 3.0
546 */
547 UDAT_HOUR_OF_DAY1_FIELD = 4,
548
549 /**
550 * FieldPosition and UFieldPosition selector for 'H' field alignment,
551 * corresponding to the UCAL_HOUR_OF_DAY field.
552 * UDAT_HOUR_OF_DAY0_FIELD is used for the zero-based 24-hour clock.
553 * For example, 23:59 + 01:00 results in 00:59.
554 * @stable ICU 3.0
555 */
556 UDAT_HOUR_OF_DAY0_FIELD = 5,
557
558 /**
559 * FieldPosition and UFieldPosition selector for 'm' field alignment,
560 * corresponding to the UCAL_MINUTE field.
561 * @stable ICU 3.0
562 */
563 UDAT_MINUTE_FIELD = 6,
564
565 /**
566 * FieldPosition and UFieldPosition selector for 's' field alignment,
567 * corresponding to the UCAL_SECOND field.
568 * @stable ICU 3.0
569 */
570 UDAT_SECOND_FIELD = 7,
571
572 /**
573 * FieldPosition and UFieldPosition selector for 'S' field alignment,
574 * corresponding to the UCAL_MILLISECOND field.
575 *
576 * Note: Time formats that use 'S' can display a maximum of three
577 * significant digits for fractional seconds, corresponding to millisecond
578 * resolution and a fractional seconds sub-pattern of SSS. If the
579 * sub-pattern is S or SS, the fractional seconds value will be truncated
580 * (not rounded) to the number of display places specified. If the
581 * fractional seconds sub-pattern is longer than SSS, the additional
582 * display places will be filled with zeros.
583 * @stable ICU 3.0
584 */
585 UDAT_FRACTIONAL_SECOND_FIELD = 8,
586
587 /**
588 * FieldPosition and UFieldPosition selector for 'E' field alignment,
589 * corresponding to the UCAL_DAY_OF_WEEK field.
590 * @stable ICU 3.0
591 */
592 UDAT_DAY_OF_WEEK_FIELD = 9,
593
594 /**
595 * FieldPosition and UFieldPosition selector for 'D' field alignment,
596 * corresponding to the UCAL_DAY_OF_YEAR field.
597 * @stable ICU 3.0
598 */
599 UDAT_DAY_OF_YEAR_FIELD = 10,
600
601 /**
602 * FieldPosition and UFieldPosition selector for 'F' field alignment,
603 * corresponding to the UCAL_DAY_OF_WEEK_IN_MONTH field.
604 * @stable ICU 3.0
605 */
606 UDAT_DAY_OF_WEEK_IN_MONTH_FIELD = 11,
607
608 /**
609 * FieldPosition and UFieldPosition selector for 'w' field alignment,
610 * corresponding to the UCAL_WEEK_OF_YEAR field.
611 * @stable ICU 3.0
612 */
613 UDAT_WEEK_OF_YEAR_FIELD = 12,
614
615 /**
616 * FieldPosition and UFieldPosition selector for 'W' field alignment,
617 * corresponding to the UCAL_WEEK_OF_MONTH field.
618 * @stable ICU 3.0
619 */
620 UDAT_WEEK_OF_MONTH_FIELD = 13,
621
622 /**
623 * FieldPosition and UFieldPosition selector for 'a' field alignment,
624 * corresponding to the UCAL_AM_PM field.
625 * @stable ICU 3.0
626 */
627 UDAT_AM_PM_FIELD = 14,
628
629 /**
630 * FieldPosition and UFieldPosition selector for 'h' field alignment,
631 * corresponding to the UCAL_HOUR field.
632 * UDAT_HOUR1_FIELD is used for the one-based 12-hour clock.
633 * For example, 11:30 PM + 1 hour results in 12:30 AM.
634 * @stable ICU 3.0
635 */
636 UDAT_HOUR1_FIELD = 15,
637
638 /**
639 * FieldPosition and UFieldPosition selector for 'K' field alignment,
640 * corresponding to the UCAL_HOUR field.
641 * UDAT_HOUR0_FIELD is used for the zero-based 12-hour clock.
642 * For example, 11:30 PM + 1 hour results in 00:30 AM.
643 * @stable ICU 3.0
644 */
645 UDAT_HOUR0_FIELD = 16,
646
647 /**
648 * FieldPosition and UFieldPosition selector for 'z' field alignment,
649 * corresponding to the UCAL_ZONE_OFFSET and
650 * UCAL_DST_OFFSET fields.
651 * @stable ICU 3.0
652 */
653 UDAT_TIMEZONE_FIELD = 17,
654
655 /**
656 * FieldPosition and UFieldPosition selector for 'Y' field alignment,
657 * corresponding to the UCAL_YEAR_WOY field.
658 * @stable ICU 3.0
659 */
660 UDAT_YEAR_WOY_FIELD = 18,
661
662 /**
663 * FieldPosition and UFieldPosition selector for 'e' field alignment,
664 * corresponding to the UCAL_DOW_LOCAL field.
665 * @stable ICU 3.0
666 */
667 UDAT_DOW_LOCAL_FIELD = 19,
668
669 /**
670 * FieldPosition and UFieldPosition selector for 'u' field alignment,
671 * corresponding to the UCAL_EXTENDED_YEAR field.
672 * @stable ICU 3.0
673 */
674 UDAT_EXTENDED_YEAR_FIELD = 20,
675
676 /**
677 * FieldPosition and UFieldPosition selector for 'g' field alignment,
678 * corresponding to the UCAL_JULIAN_DAY field.
679 * @stable ICU 3.0
680 */
681 UDAT_JULIAN_DAY_FIELD = 21,
682
683 /**
684 * FieldPosition and UFieldPosition selector for 'A' field alignment,
685 * corresponding to the UCAL_MILLISECONDS_IN_DAY field.
686 * @stable ICU 3.0
687 */
688 UDAT_MILLISECONDS_IN_DAY_FIELD = 22,
689
690 /**
691 * FieldPosition and UFieldPosition selector for 'Z' field alignment,
692 * corresponding to the UCAL_ZONE_OFFSET and
693 * UCAL_DST_OFFSET fields.
694 * @stable ICU 3.0
695 */
696 UDAT_TIMEZONE_RFC_FIELD = 23,
697
698 /**
699 * FieldPosition and UFieldPosition selector for 'v' field alignment,
700 * corresponding to the UCAL_ZONE_OFFSET field.
701 * @stable ICU 3.4
702 */
703 UDAT_TIMEZONE_GENERIC_FIELD = 24,
704 /**
705 * FieldPosition selector for 'c' field alignment,
706 * corresponding to the {@link #UCAL_DOW_LOCAL} field.
707 * This displays the stand alone day name, if available.
708 * @stable ICU 3.4
709 */
710 UDAT_STANDALONE_DAY_FIELD = 25,
711
712 /**
713 * FieldPosition selector for 'L' field alignment,
714 * corresponding to the {@link #UCAL_MONTH} field.
715 * This displays the stand alone month name, if available.
716 * @stable ICU 3.4
717 */
718 UDAT_STANDALONE_MONTH_FIELD = 26,
719
720 /**
721 * FieldPosition selector for "Q" field alignment,
722 * corresponding to quarters. This is implemented
723 * using the {@link #UCAL_MONTH} field. This
724 * displays the quarter.
725 * @stable ICU 3.6
726 */
727 UDAT_QUARTER_FIELD = 27,
728
729 /**
730 * FieldPosition selector for the "q" field alignment,
731 * corresponding to stand-alone quarters. This is
732 * implemented using the {@link #UCAL_MONTH} field.
733 * This displays the stand-alone quarter.
734 * @stable ICU 3.6
735 */
736 UDAT_STANDALONE_QUARTER_FIELD = 28,
737
738 /**
739 * FieldPosition and UFieldPosition selector for 'V' field alignment,
740 * corresponding to the UCAL_ZONE_OFFSET field.
741 * @stable ICU 3.8
742 */
743 UDAT_TIMEZONE_SPECIAL_FIELD = 29,
744
745 /**
746 * FieldPosition selector for "U" field alignment,
747 * corresponding to cyclic year names. This is implemented
748 * using the {@link #UCAL_YEAR} field. This displays
749 * the cyclic year name, if available.
750 * @stable ICU 49
751 */
752 UDAT_YEAR_NAME_FIELD = 30,
753
754 /**
755 * FieldPosition selector for 'O' field alignment,
756 * corresponding to the UCAL_ZONE_OFFSET and UCAL_DST_OFFSETfields.
757 * This displays the localized GMT format.
758 * @stable ICU 51
759 */
760 UDAT_TIMEZONE_LOCALIZED_GMT_OFFSET_FIELD = 31,
761
762 /**
763 * FieldPosition selector for 'X' field alignment,
764 * corresponding to the UCAL_ZONE_OFFSET and UCAL_DST_OFFSETfields.
765 * This displays the ISO 8601 local time offset format or UTC indicator ("Z").
766 * @stable ICU 51
767 */
768 UDAT_TIMEZONE_ISO_FIELD = 32,
769
770 /**
771 * FieldPosition selector for 'x' field alignment,
772 * corresponding to the UCAL_ZONE_OFFSET and UCAL_DST_OFFSET fields.
773 * This displays the ISO 8601 local time offset format.
774 * @stable ICU 51
775 */
776 UDAT_TIMEZONE_ISO_LOCAL_FIELD = 33,
777
778#ifndef U_HIDE_INTERNAL_API
779 /**
780 * FieldPosition and UFieldPosition selector for 'r' field alignment,
781 * no directly corresponding UCAL_ field.
782 * @internal ICU 53
783 */
784 UDAT_RELATED_YEAR_FIELD = 34,
785#endif /* U_HIDE_INTERNAL_API */
786
787 /**
788 * FieldPosition selector for 'b' field alignment.
789 * Displays midnight and noon for 12am and 12pm, respectively, if available;
790 * otherwise fall back to AM / PM.
791 * @stable ICU 57
792 */
793 UDAT_AM_PM_MIDNIGHT_NOON_FIELD = 35,
794
795 /* FieldPosition selector for 'B' field alignment.
796 * Displays flexible day periods, such as "in the morning", if available.
797 * @stable ICU 57
798 */
799 UDAT_FLEXIBLE_DAY_PERIOD_FIELD = 36,
800
801#ifndef U_HIDE_INTERNAL_API
802 /**
803 * FieldPosition and UFieldPosition selector for time separator,
804 * no corresponding UCAL_ field. No pattern character is currently
805 * defined for this.
806 * @internal
807 */
808 UDAT_TIME_SEPARATOR_FIELD = 37,
809#endif /* U_HIDE_INTERNAL_API */
810
811#ifndef U_HIDE_DEPRECATED_API
812 /**
813 * Number of FieldPosition and UFieldPosition selectors for
814 * DateFormat and UDateFormat.
815 * Valid selectors range from 0 to UDAT_FIELD_COUNT-1.
816 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
817 */
818 UDAT_FIELD_COUNT = 38
819#endif /* U_HIDE_DEPRECATED_API */
820} UDateFormatField;
821
822
823#ifndef U_HIDE_INTERNAL_API
824/**
825 * Is a pattern character defined for UDAT_TIME_SEPARATOR_FIELD?
826 * In ICU 55 it was COLON, but that was withdrawn in ICU 56.
827 * @internal ICU 56
828 */
829#define UDAT_HAS_PATTERN_CHAR_FOR_TIME_SEPARATOR 0
830#endif /* U_HIDE_INTERNAL_API */
831
832
833/**
834 * Maps from a UDateFormatField to the corresponding UCalendarDateFields.
835 * Note: since the mapping is many-to-one, there is no inverse mapping.
836 * @param field the UDateFormatField.
837 * @return the UCalendarDateField. This will be UCAL_FIELD_COUNT in case
838 * of error (e.g., the input field is UDAT_FIELD_COUNT).
839 * @stable ICU 4.4
840 */
841U_CAPI UCalendarDateFields U_EXPORT2
842udat_toCalendarDateField(UDateFormatField field);
843
844
845/**
846 * Open a new UDateFormat for formatting and parsing dates and times.
847 * A UDateFormat may be used to format dates in calls to {@link #udat_format },
848 * and to parse dates in calls to {@link #udat_parse }.
849 * @param timeStyle The style used to format times; one of UDAT_FULL, UDAT_LONG,
850 * UDAT_MEDIUM, UDAT_SHORT, UDAT_DEFAULT, or UDAT_NONE (relative time styles
851 * are not currently supported).
852 * When the pattern parameter is used, pass in UDAT_PATTERN for both timeStyle and dateStyle.
853 * @param dateStyle The style used to format dates; one of UDAT_FULL, UDAT_LONG,
854 * UDAT_MEDIUM, UDAT_SHORT, UDAT_DEFAULT, UDAT_FULL_RELATIVE, UDAT_LONG_RELATIVE,
855 * UDAT_MEDIUM_RELATIVE, UDAT_SHORT_RELATIVE, or UDAT_NONE.
856 * When the pattern parameter is used, pass in UDAT_PATTERN for both timeStyle and dateStyle.
857 * As currently implemented,
858 * relative date formatting only affects a limited range of calendar days before or
859 * after the current date, based on the CLDR &lt;field type="day"&gt;/&lt;relative&gt; data: For
860 * example, in English, "Yesterday", "Today", and "Tomorrow". Outside of this range,
861 * dates are formatted using the corresponding non-relative style.
862 * @param locale The locale specifying the formatting conventions
863 * @param tzID A timezone ID specifying the timezone to use. If 0, use
864 * the default timezone.
865 * @param tzIDLength The length of tzID, or -1 if null-terminated.
866 * @param pattern A pattern specifying the format to use.
867 * @param patternLength The number of characters in the pattern, or -1 if null-terminated.
868 * @param status A pointer to an UErrorCode to receive any errors
869 * @return A pointer to a UDateFormat to use for formatting dates and times, or 0 if
870 * an error occurred.
871 * @stable ICU 2.0
872 */
873U_CAPI UDateFormat* U_EXPORT2
874udat_open(UDateFormatStyle timeStyle,
875 UDateFormatStyle dateStyle,
876 const char *locale,
877 const UChar *tzID,
878 int32_t tzIDLength,
879 const UChar *pattern,
880 int32_t patternLength,
881 UErrorCode *status);
882
883
884/**
885* Close a UDateFormat.
886* Once closed, a UDateFormat may no longer be used.
887* @param format The formatter to close.
888* @stable ICU 2.0
889*/
890U_CAPI void U_EXPORT2
891udat_close(UDateFormat* format);
892
893
894/**
895 * DateFormat boolean attributes
896 *
897 * @stable ICU 53
898 */
899typedef enum UDateFormatBooleanAttribute {
900 /**
901 * indicates whether whitespace is allowed. Includes trailing dot tolerance.
902 * @stable ICU 53
903 */
904 UDAT_PARSE_ALLOW_WHITESPACE = 0,
905 /**
906 * indicates tolerance of numeric data when String data may be assumed. eg: UDAT_YEAR_NAME_FIELD,
907 * UDAT_STANDALONE_MONTH_FIELD, UDAT_DAY_OF_WEEK_FIELD
908 * @stable ICU 53
909 */
910 UDAT_PARSE_ALLOW_NUMERIC = 1,
911 /**
912 * indicates tolerance of a partial literal match
913 * e.g. accepting "--mon-02-march-2011" for a pattern of "'--: 'EEE-WW-MMMM-yyyy"
914 * @stable ICU 56
915 */
916 UDAT_PARSE_PARTIAL_LITERAL_MATCH = 2,
917 /**
918 * indicates tolerance of pattern mismatch between input data and specified format pattern.
919 * e.g. accepting "September" for a month pattern of MMM ("Sep")
920 * @stable ICU 56
921 */
922 UDAT_PARSE_MULTIPLE_PATTERNS_FOR_MATCH = 3,
923
924 /* Do not conditionalize the following with #ifndef U_HIDE_DEPRECATED_API,
925 * it is needed for layout of DateFormat object. */
926#ifndef U_FORCE_HIDE_DEPRECATED_API
927 /**
928 * One more than the highest normal UDateFormatBooleanAttribute value.
929 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
930 */
931 UDAT_BOOLEAN_ATTRIBUTE_COUNT = 4
932#endif // U_FORCE_HIDE_DEPRECATED_API
933} UDateFormatBooleanAttribute;
934
935/**
936 * Get a boolean attribute associated with a UDateFormat.
937 * An example would be a true value for a key of UDAT_PARSE_ALLOW_WHITESPACE indicating allowing whitespace leniency.
938 * If the formatter does not understand the attribute, -1 is returned.
939 * @param fmt The formatter to query.
940 * @param attr The attribute to query; e.g. UDAT_PARSE_ALLOW_WHITESPACE.
941 * @param status A pointer to an UErrorCode to receive any errors
942 * @return The value of attr.
943 * @stable ICU 53
944 */
945U_CAPI UBool U_EXPORT2
946udat_getBooleanAttribute(const UDateFormat* fmt, UDateFormatBooleanAttribute attr, UErrorCode* status);
947
948/**
949 * Set a boolean attribute associated with a UDateFormat.
950 * An example of a boolean attribute is parse leniency control. If the formatter does not understand
951 * the attribute, the call is ignored.
952 * @param fmt The formatter to set.
953 * @param attr The attribute to set; one of UDAT_PARSE_ALLOW_WHITESPACE or UDAT_PARSE_ALLOW_NUMERIC
954 * @param newValue The new value of attr.
955 * @param status A pointer to an UErrorCode to receive any errors
956 * @stable ICU 53
957 */
958U_CAPI void U_EXPORT2
959udat_setBooleanAttribute(UDateFormat *fmt, UDateFormatBooleanAttribute attr, UBool newValue, UErrorCode* status);
960
961
962
963#if U_SHOW_CPLUSPLUS_API
964
965U_NAMESPACE_BEGIN
966
967/**
968 * \class LocalUDateFormatPointer
969 * "Smart pointer" class, closes a UDateFormat via udat_close().
970 * For most methods see the LocalPointerBase base class.
971 *
972 * @see LocalPointerBase
973 * @see LocalPointer
974 * @stable ICU 4.4
975 */
976U_DEFINE_LOCAL_OPEN_POINTER(LocalUDateFormatPointer, UDateFormat, udat_close);
977
978U_NAMESPACE_END
979
980#endif
981
982/**
983 * Open a copy of a UDateFormat.
984 * This function performs a deep copy.
985 * @param fmt The format to copy
986 * @param status A pointer to an UErrorCode to receive any errors.
987 * @return A pointer to a UDateFormat identical to fmt.
988 * @stable ICU 2.0
989 */
990U_CAPI UDateFormat* U_EXPORT2
991udat_clone(const UDateFormat *fmt,
992 UErrorCode *status);
993
994/**
995* Format a date using a UDateFormat.
996* The date will be formatted using the conventions specified in {@link #udat_open }
997* @param format The formatter to use
998* @param dateToFormat The date to format
999* @param result A pointer to a buffer to receive the formatted number.
1000* @param resultLength The maximum size of result.
1001* @param position A pointer to a UFieldPosition. On input, position->field
1002* is read. On output, position->beginIndex and position->endIndex indicate
1003* the beginning and ending indices of field number position->field, if such
1004* a field exists. This parameter may be NULL, in which case no field
1005* position data is returned.
1006* @param status A pointer to an UErrorCode to receive any errors
1007* @return The total buffer size needed; if greater than resultLength, the output was truncated.
1008* @see udat_parse
1009* @see UFieldPosition
1010* @stable ICU 2.0
1011*/
1012U_CAPI int32_t U_EXPORT2
1013udat_format( const UDateFormat* format,
1014 UDate dateToFormat,
1015 UChar* result,
1016 int32_t resultLength,
1017 UFieldPosition* position,
1018 UErrorCode* status);
1019
1020/**
1021* Format a date using an UDateFormat.
1022* The date will be formatted using the conventions specified in {@link #udat_open }
1023* @param format The formatter to use
1024* @param calendar The calendar to format. The calendar instance might be
1025* mutated if fields are not yet fully calculated, though
1026* the function won't change the logical date and time held
1027* by the instance.
1028* @param result A pointer to a buffer to receive the formatted number.
1029* @param capacity The maximum size of result.
1030* @param position A pointer to a UFieldPosition. On input, position->field
1031* is read. On output, position->beginIndex and position->endIndex indicate
1032* the beginning and ending indices of field number position->field, if such
1033* a field exists. This parameter may be NULL, in which case no field
1034* position data is returned.
1035* @param status A pointer to an UErrorCode to receive any errors
1036* @return The total buffer size needed; if greater than resultLength, the output was truncated.
1037* @see udat_format
1038* @see udat_parseCalendar
1039* @see UFieldPosition
1040* @stable ICU 55
1041*/
1042U_CAPI int32_t U_EXPORT2
1043udat_formatCalendar( const UDateFormat* format,
1044 UCalendar* calendar,
1045 UChar* result,
1046 int32_t capacity,
1047 UFieldPosition* position,
1048 UErrorCode* status);
1049
1050/**
1051* Format a date using a UDateFormat.
1052* The date will be formatted using the conventions specified in {@link #udat_open}
1053* @param format
1054* The formatter to use
1055* @param dateToFormat
1056* The date to format
1057* @param result
1058* A pointer to a buffer to receive the formatted number.
1059* @param resultLength
1060* The maximum size of result.
1061* @param fpositer
1062* A pointer to a UFieldPositionIterator created by {@link #ufieldpositer_open}
1063* (may be NULL if field position information is not needed). Any
1064* iteration information already present in the UFieldPositionIterator
1065* will be deleted, and the iterator will be reset to apply to the
1066* fields in the formatted string created by this function call; the
1067* field values provided by {@link #ufieldpositer_next} will be from the
1068* UDateFormatField enum.
1069* @param status
1070* A pointer to a UErrorCode to receive any errors
1071* @return
1072* The total buffer size needed; if greater than resultLength, the output was truncated.
1073* @see udat_parse
1074* @see UFieldPositionIterator
1075* @stable ICU 55
1076*/
1077U_CAPI int32_t U_EXPORT2
1078udat_formatForFields( const UDateFormat* format,
1079 UDate dateToFormat,
1080 UChar* result,
1081 int32_t resultLength,
1082 UFieldPositionIterator* fpositer,
1083 UErrorCode* status);
1084
1085/**
1086* Format a date using a UDateFormat.
1087* The date will be formatted using the conventions specified in {@link #udat_open }
1088* @param format
1089* The formatter to use
1090* @param calendar
1091* The calendar to format. The calendar instance might be mutated if fields
1092* are not yet fully calculated, though the function won't change the logical
1093* date and time held by the instance.
1094* @param result
1095* A pointer to a buffer to receive the formatted number.
1096* @param capacity
1097* The maximum size of result.
1098* @param fpositer
1099* A pointer to a UFieldPositionIterator created by {@link #ufieldpositer_open}
1100* (may be NULL if field position information is not needed). Any
1101* iteration information already present in the UFieldPositionIterator
1102* will be deleted, and the iterator will be reset to apply to the
1103* fields in the formatted string created by this function call; the
1104* field values provided by {@link #ufieldpositer_next} will be from the
1105* UDateFormatField enum.
1106* @param status
1107* A pointer to a UErrorCode to receive any errors
1108* @return
1109* The total buffer size needed; if greater than resultLength, the output was truncated.
1110* @see udat_format
1111* @see udat_parseCalendar
1112* @see UFieldPositionIterator
1113* @stable ICU 55
1114*/
1115U_CAPI int32_t U_EXPORT2
1116udat_formatCalendarForFields( const UDateFormat* format,
1117 UCalendar* calendar,
1118 UChar* result,
1119 int32_t capacity,
1120 UFieldPositionIterator* fpositer,
1121 UErrorCode* status);
1122
1123
1124/**
1125* Parse a string into an date/time using a UDateFormat.
1126* The date will be parsed using the conventions specified in {@link #udat_open }.
1127* <P>
1128* Note that the normal date formats associated with some calendars - such
1129* as the Chinese lunar calendar - do not specify enough fields to enable
1130* dates to be parsed unambiguously. In the case of the Chinese lunar
1131* calendar, while the year within the current 60-year cycle is specified,
1132* the number of such cycles since the start date of the calendar (in the
1133* UCAL_ERA field of the UCalendar object) is not normally part of the format,
1134* and parsing may assume the wrong era. For cases such as this it is
1135* recommended that clients parse using udat_parseCalendar with the UCalendar
1136* passed in set to the current date, or to a date within the era/cycle that
1137* should be assumed if absent in the format.
1138*
1139* @param format The formatter to use.
1140* @param text The text to parse.
1141* @param textLength The length of text, or -1 if null-terminated.
1142* @param parsePos If not 0, on input a pointer to an integer specifying the offset at which
1143* to begin parsing. If not 0, on output the offset at which parsing ended.
1144* @param status A pointer to an UErrorCode to receive any errors
1145* @return The value of the parsed date/time
1146* @see udat_format
1147* @stable ICU 2.0
1148*/
1149U_CAPI UDate U_EXPORT2
1150udat_parse(const UDateFormat* format,
1151 const UChar* text,
1152 int32_t textLength,
1153 int32_t *parsePos,
1154 UErrorCode *status);
1155
1156/**
1157* Parse a string into an date/time using a UDateFormat.
1158* The date will be parsed using the conventions specified in {@link #udat_open }.
1159* @param format The formatter to use.
1160* @param calendar A calendar set on input to the date and time to be used for
1161* missing values in the date/time string being parsed, and set
1162* on output to the parsed date/time. When the calendar type is
1163* different from the internal calendar held by the UDateFormat
1164* instance, the internal calendar will be cloned to a work
1165* calendar set to the same milliseconds and time zone as this
1166* calendar parameter, field values will be parsed based on the
1167* work calendar, then the result (milliseconds and time zone)
1168* will be set in this calendar.
1169* @param text The text to parse.
1170* @param textLength The length of text, or -1 if null-terminated.
1171* @param parsePos If not 0, on input a pointer to an integer specifying the offset at which
1172* to begin parsing. If not 0, on output the offset at which parsing ended.
1173* @param status A pointer to an UErrorCode to receive any errors
1174* @see udat_format
1175* @stable ICU 2.0
1176*/
1177U_CAPI void U_EXPORT2
1178udat_parseCalendar(const UDateFormat* format,
1179 UCalendar* calendar,
1180 const UChar* text,
1181 int32_t textLength,
1182 int32_t *parsePos,
1183 UErrorCode *status);
1184
1185/**
1186* Determine if an UDateFormat will perform lenient parsing.
1187* With lenient parsing, the parser may use heuristics to interpret inputs that do not
1188* precisely match the pattern. With strict parsing, inputs must match the pattern.
1189* @param fmt The formatter to query
1190* @return TRUE if fmt is set to perform lenient parsing, FALSE otherwise.
1191* @see udat_setLenient
1192* @stable ICU 2.0
1193*/
1194U_CAPI UBool U_EXPORT2
1195udat_isLenient(const UDateFormat* fmt);
1196
1197/**
1198* Specify whether an UDateFormat will perform lenient parsing.
1199* With lenient parsing, the parser may use heuristics to interpret inputs that do not
1200* precisely match the pattern. With strict parsing, inputs must match the pattern.
1201* @param fmt The formatter to set
1202* @param isLenient TRUE if fmt should perform lenient parsing, FALSE otherwise.
1203* @see dat_isLenient
1204* @stable ICU 2.0
1205*/
1206U_CAPI void U_EXPORT2
1207udat_setLenient( UDateFormat* fmt,
1208 UBool isLenient);
1209
1210/**
1211* Get the UCalendar associated with an UDateFormat.
1212* A UDateFormat uses a UCalendar to convert a raw value to, for example,
1213* the day of the week.
1214* @param fmt The formatter to query.
1215* @return A pointer to the UCalendar used by fmt.
1216* @see udat_setCalendar
1217* @stable ICU 2.0
1218*/
1219U_CAPI const UCalendar* U_EXPORT2
1220udat_getCalendar(const UDateFormat* fmt);
1221
1222/**
1223* Set the UCalendar associated with an UDateFormat.
1224* A UDateFormat uses a UCalendar to convert a raw value to, for example,
1225* the day of the week.
1226* @param fmt The formatter to set.
1227* @param calendarToSet A pointer to an UCalendar to be used by fmt.
1228* @see udat_setCalendar
1229* @stable ICU 2.0
1230*/
1231U_CAPI void U_EXPORT2
1232udat_setCalendar( UDateFormat* fmt,
1233 const UCalendar* calendarToSet);
1234
1235/**
1236* Get the UNumberFormat associated with an UDateFormat.
1237* A UDateFormat uses a UNumberFormat to format numbers within a date,
1238* for example the day number.
1239* @param fmt The formatter to query.
1240* @return A pointer to the UNumberFormat used by fmt to format numbers.
1241* @see udat_setNumberFormat
1242* @stable ICU 2.0
1243*/
1244U_CAPI const UNumberFormat* U_EXPORT2
1245udat_getNumberFormat(const UDateFormat* fmt);
1246
1247/**
1248* Get the UNumberFormat for specific field associated with an UDateFormat.
1249* For example: 'y' for year and 'M' for month
1250* @param fmt The formatter to query.
1251* @param field the field to query
1252* @return A pointer to the UNumberFormat used by fmt to format field numbers.
1253* @see udat_setNumberFormatForField
1254* @stable ICU 54
1255*/
1256U_CAPI const UNumberFormat* U_EXPORT2
1257udat_getNumberFormatForField(const UDateFormat* fmt, UChar field);
1258
1259/**
1260* Set the UNumberFormat for specific field associated with an UDateFormat.
1261* It can be a single field like: "y"(year) or "M"(month)
1262* It can be several field combined together: "yM"(year and month)
1263* Note:
1264* 1 symbol field is enough for multiple symbol field (so "y" will override "yy", "yyy")
1265* If the field is not numeric, then override has no effect (like "MMM" will use abbreviation, not numerical field)
1266*
1267* @param fields the fields to set
1268* @param fmt The formatter to set.
1269* @param numberFormatToSet A pointer to the UNumberFormat to be used by fmt to format numbers.
1270* @param status error code passed around (memory allocation or invalid fields)
1271* @see udat_getNumberFormatForField
1272* @stable ICU 54
1273*/
1274U_CAPI void U_EXPORT2
1275udat_adoptNumberFormatForFields( UDateFormat* fmt,
1276 const UChar* fields,
1277 UNumberFormat* numberFormatToSet,
1278 UErrorCode* status);
1279/**
1280* Set the UNumberFormat associated with an UDateFormat.
1281* A UDateFormat uses a UNumberFormat to format numbers within a date,
1282* for example the day number.
1283* This method also clears per field NumberFormat instances previously
1284* set by {@see udat_setNumberFormatForField}
1285* @param fmt The formatter to set.
1286* @param numberFormatToSet A pointer to the UNumberFormat to be used by fmt to format numbers.
1287* @see udat_getNumberFormat
1288* @see udat_setNumberFormatForField
1289* @stable ICU 2.0
1290*/
1291U_CAPI void U_EXPORT2
1292udat_setNumberFormat( UDateFormat* fmt,
1293 const UNumberFormat* numberFormatToSet);
1294/**
1295* Adopt the UNumberFormat associated with an UDateFormat.
1296* A UDateFormat uses a UNumberFormat to format numbers within a date,
1297* for example the day number.
1298* @param fmt The formatter to set.
1299* @param numberFormatToAdopt A pointer to the UNumberFormat to be used by fmt to format numbers.
1300* @see udat_getNumberFormat
1301* @stable ICU 54
1302*/
1303U_CAPI void U_EXPORT2
1304udat_adoptNumberFormat( UDateFormat* fmt,
1305 UNumberFormat* numberFormatToAdopt);
1306/**
1307* Get a locale for which date/time formatting patterns are available.
1308* A UDateFormat in a locale returned by this function will perform the correct
1309* formatting and parsing for the locale.
1310* @param localeIndex The index of the desired locale.
1311* @return A locale for which date/time formatting patterns are available, or 0 if none.
1312* @see udat_countAvailable
1313* @stable ICU 2.0
1314*/
1315U_CAPI const char* U_EXPORT2
1316udat_getAvailable(int32_t localeIndex);
1317
1318/**
1319* Determine how many locales have date/time formatting patterns available.
1320* This function is most useful as determining the loop ending condition for
1321* calls to {@link #udat_getAvailable }.
1322* @return The number of locales for which date/time formatting patterns are available.
1323* @see udat_getAvailable
1324* @stable ICU 2.0
1325*/
1326U_CAPI int32_t U_EXPORT2
1327udat_countAvailable(void);
1328
1329/**
1330* Get the year relative to which all 2-digit years are interpreted.
1331* For example, if the 2-digit start year is 2100, the year 99 will be
1332* interpreted as 2199.
1333* @param fmt The formatter to query.
1334* @param status A pointer to an UErrorCode to receive any errors
1335* @return The year relative to which all 2-digit years are interpreted.
1336* @see udat_Set2DigitYearStart
1337* @stable ICU 2.0
1338*/
1339U_CAPI UDate U_EXPORT2
1340udat_get2DigitYearStart( const UDateFormat *fmt,
1341 UErrorCode *status);
1342
1343/**
1344* Set the year relative to which all 2-digit years will be interpreted.
1345* For example, if the 2-digit start year is 2100, the year 99 will be
1346* interpreted as 2199.
1347* @param fmt The formatter to set.
1348* @param d The year relative to which all 2-digit years will be interpreted.
1349* @param status A pointer to an UErrorCode to receive any errors
1350* @see udat_Set2DigitYearStart
1351* @stable ICU 2.0
1352*/
1353U_CAPI void U_EXPORT2
1354udat_set2DigitYearStart( UDateFormat *fmt,
1355 UDate d,
1356 UErrorCode *status);
1357
1358/**
1359* Extract the pattern from a UDateFormat.
1360* The pattern will follow the pattern syntax rules.
1361* @param fmt The formatter to query.
1362* @param localized TRUE if the pattern should be localized, FALSE otherwise.
1363* @param result A pointer to a buffer to receive the pattern.
1364* @param resultLength The maximum size of result.
1365* @param status A pointer to an UErrorCode to receive any errors
1366* @return The total buffer size needed; if greater than resultLength, the output was truncated.
1367* @see udat_applyPattern
1368* @stable ICU 2.0
1369*/
1370U_CAPI int32_t U_EXPORT2
1371udat_toPattern( const UDateFormat *fmt,
1372 UBool localized,
1373 UChar *result,
1374 int32_t resultLength,
1375 UErrorCode *status);
1376
1377/**
1378* Set the pattern used by an UDateFormat.
1379* The pattern should follow the pattern syntax rules.
1380* @param format The formatter to set.
1381* @param localized TRUE if the pattern is localized, FALSE otherwise.
1382* @param pattern The new pattern
1383* @param patternLength The length of pattern, or -1 if null-terminated.
1384* @see udat_toPattern
1385* @stable ICU 2.0
1386*/
1387U_CAPI void U_EXPORT2
1388udat_applyPattern( UDateFormat *format,
1389 UBool localized,
1390 const UChar *pattern,
1391 int32_t patternLength);
1392
1393/**
1394 * The possible types of date format symbols
1395 * @stable ICU 2.6
1396 */
1397typedef enum UDateFormatSymbolType {
1398 /** The era names, for example AD */
1399 UDAT_ERAS,
1400 /** The month names, for example February */
1401 UDAT_MONTHS,
1402 /** The short month names, for example Feb. */
1403 UDAT_SHORT_MONTHS,
1404 /** The CLDR-style format "wide" weekday names, for example Monday */
1405 UDAT_WEEKDAYS,
1406 /**
1407 * The CLDR-style format "abbreviated" (not "short") weekday names, for example "Mon."
1408 * For the CLDR-style format "short" weekday names, use UDAT_SHORTER_WEEKDAYS.
1409 */
1410 UDAT_SHORT_WEEKDAYS,
1411 /** The AM/PM names, for example AM */
1412 UDAT_AM_PMS,
1413 /** The localized characters */
1414 UDAT_LOCALIZED_CHARS,
1415 /** The long era names, for example Anno Domini */
1416 UDAT_ERA_NAMES,
1417 /** The narrow month names, for example F */
1418 UDAT_NARROW_MONTHS,
1419 /** The CLDR-style format "narrow" weekday names, for example "M" */
1420 UDAT_NARROW_WEEKDAYS,
1421 /** Standalone context versions of months */
1422 UDAT_STANDALONE_MONTHS,
1423 UDAT_STANDALONE_SHORT_MONTHS,
1424 UDAT_STANDALONE_NARROW_MONTHS,
1425 /** The CLDR-style stand-alone "wide" weekday names */
1426 UDAT_STANDALONE_WEEKDAYS,
1427 /**
1428 * The CLDR-style stand-alone "abbreviated" (not "short") weekday names.
1429 * For the CLDR-style stand-alone "short" weekday names, use UDAT_STANDALONE_SHORTER_WEEKDAYS.
1430 */
1431 UDAT_STANDALONE_SHORT_WEEKDAYS,
1432 /** The CLDR-style stand-alone "narrow" weekday names */
1433 UDAT_STANDALONE_NARROW_WEEKDAYS,
1434 /** The quarters, for example 1st Quarter */
1435 UDAT_QUARTERS,
1436 /** The short quarter names, for example Q1 */
1437 UDAT_SHORT_QUARTERS,
1438 /** Standalone context versions of quarters */
1439 UDAT_STANDALONE_QUARTERS,
1440 UDAT_STANDALONE_SHORT_QUARTERS,
1441 /**
1442 * The CLDR-style short weekday names, e.g. "Su", Mo", etc.
1443 * These are named "SHORTER" to contrast with the constants using _SHORT_
1444 * above, which actually get the CLDR-style *abbreviated* versions of the
1445 * corresponding names.
1446 * @stable ICU 51
1447 */
1448 UDAT_SHORTER_WEEKDAYS,
1449 /**
1450 * Standalone version of UDAT_SHORTER_WEEKDAYS.
1451 * @stable ICU 51
1452 */
1453 UDAT_STANDALONE_SHORTER_WEEKDAYS,
1454 /**
1455 * Cyclic year names (only supported for some calendars, and only for FORMAT usage;
1456 * udat_setSymbols not supported for UDAT_CYCLIC_YEARS_WIDE)
1457 * @stable ICU 54
1458 */
1459 UDAT_CYCLIC_YEARS_WIDE,
1460 /**
1461 * Cyclic year names (only supported for some calendars, and only for FORMAT usage)
1462 * @stable ICU 54
1463 */
1464 UDAT_CYCLIC_YEARS_ABBREVIATED,
1465 /**
1466 * Cyclic year names (only supported for some calendars, and only for FORMAT usage;
1467 * udat_setSymbols not supported for UDAT_CYCLIC_YEARS_NARROW)
1468 * @stable ICU 54
1469 */
1470 UDAT_CYCLIC_YEARS_NARROW,
1471 /**
1472 * Calendar zodiac names (only supported for some calendars, and only for FORMAT usage;
1473 * udat_setSymbols not supported for UDAT_ZODIAC_NAMES_WIDE)
1474 * @stable ICU 54
1475 */
1476 UDAT_ZODIAC_NAMES_WIDE,
1477 /**
1478 * Calendar zodiac names (only supported for some calendars, and only for FORMAT usage)
1479 * @stable ICU 54
1480 */
1481 UDAT_ZODIAC_NAMES_ABBREVIATED,
1482 /**
1483 * Calendar zodiac names (only supported for some calendars, and only for FORMAT usage;
1484 * udat_setSymbols not supported for UDAT_ZODIAC_NAMES_NARROW)
1485 * @stable ICU 54
1486 */
1487 UDAT_ZODIAC_NAMES_NARROW
1488} UDateFormatSymbolType;
1489
1490struct UDateFormatSymbols;
1491/** Date format symbols.
1492 * For usage in C programs.
1493 * @stable ICU 2.6
1494 */
1495typedef struct UDateFormatSymbols UDateFormatSymbols;
1496
1497/**
1498* Get the symbols associated with an UDateFormat.
1499* The symbols are what a UDateFormat uses to represent locale-specific data,
1500* for example month or day names.
1501* @param fmt The formatter to query.
1502* @param type The type of symbols to get. One of UDAT_ERAS, UDAT_MONTHS, UDAT_SHORT_MONTHS,
1503* UDAT_WEEKDAYS, UDAT_SHORT_WEEKDAYS, UDAT_AM_PMS, or UDAT_LOCALIZED_CHARS
1504* @param symbolIndex The desired symbol of type type.
1505* @param result A pointer to a buffer to receive the pattern.
1506* @param resultLength The maximum size of result.
1507* @param status A pointer to an UErrorCode to receive any errors
1508* @return The total buffer size needed; if greater than resultLength, the output was truncated.
1509* @see udat_countSymbols
1510* @see udat_setSymbols
1511* @stable ICU 2.0
1512*/
1513U_CAPI int32_t U_EXPORT2
1514udat_getSymbols(const UDateFormat *fmt,
1515 UDateFormatSymbolType type,
1516 int32_t symbolIndex,
1517 UChar *result,
1518 int32_t resultLength,
1519 UErrorCode *status);
1520
1521/**
1522* Count the number of particular symbols for an UDateFormat.
1523* This function is most useful as for detemining the loop termination condition
1524* for calls to {@link #udat_getSymbols }.
1525* @param fmt The formatter to query.
1526* @param type The type of symbols to count. One of UDAT_ERAS, UDAT_MONTHS, UDAT_SHORT_MONTHS,
1527* UDAT_WEEKDAYS, UDAT_SHORT_WEEKDAYS, UDAT_AM_PMS, or UDAT_LOCALIZED_CHARS
1528* @return The number of symbols of type type.
1529* @see udat_getSymbols
1530* @see udat_setSymbols
1531* @stable ICU 2.0
1532*/
1533U_CAPI int32_t U_EXPORT2
1534udat_countSymbols( const UDateFormat *fmt,
1535 UDateFormatSymbolType type);
1536
1537/**
1538* Set the symbols associated with an UDateFormat.
1539* The symbols are what a UDateFormat uses to represent locale-specific data,
1540* for example month or day names.
1541* @param format The formatter to set
1542* @param type The type of symbols to set. One of UDAT_ERAS, UDAT_MONTHS, UDAT_SHORT_MONTHS,
1543* UDAT_WEEKDAYS, UDAT_SHORT_WEEKDAYS, UDAT_AM_PMS, or UDAT_LOCALIZED_CHARS
1544* @param symbolIndex The index of the symbol to set of type type.
1545* @param value The new value
1546* @param valueLength The length of value, or -1 if null-terminated
1547* @param status A pointer to an UErrorCode to receive any errors
1548* @see udat_getSymbols
1549* @see udat_countSymbols
1550* @stable ICU 2.0
1551*/
1552U_CAPI void U_EXPORT2
1553udat_setSymbols( UDateFormat *format,
1554 UDateFormatSymbolType type,
1555 int32_t symbolIndex,
1556 UChar *value,
1557 int32_t valueLength,
1558 UErrorCode *status);
1559
1560/**
1561 * Get the locale for this date format object.
1562 * You can choose between valid and actual locale.
1563 * @param fmt The formatter to get the locale from
1564 * @param type type of the locale we're looking for (valid or actual)
1565 * @param status error code for the operation
1566 * @return the locale name
1567 * @stable ICU 2.8
1568 */
1569U_CAPI const char* U_EXPORT2
1570udat_getLocaleByType(const UDateFormat *fmt,
1571 ULocDataLocaleType type,
1572 UErrorCode* status);
1573
1574/**
1575 * Set a particular UDisplayContext value in the formatter, such as
1576 * UDISPCTX_CAPITALIZATION_FOR_STANDALONE.
1577 * @param fmt The formatter for which to set a UDisplayContext value.
1578 * @param value The UDisplayContext value to set.
1579 * @param status A pointer to an UErrorCode to receive any errors
1580 * @stable ICU 51
1581 */
1582U_CAPI void U_EXPORT2
1583udat_setContext(UDateFormat* fmt, UDisplayContext value, UErrorCode* status);
1584
1585/**
1586 * Get the formatter's UDisplayContext value for the specified UDisplayContextType,
1587 * such as UDISPCTX_TYPE_CAPITALIZATION.
1588 * @param fmt The formatter to query.
1589 * @param type The UDisplayContextType whose value to return
1590 * @param status A pointer to an UErrorCode to receive any errors
1591 * @return The UDisplayContextValue for the specified type.
1592 * @stable ICU 53
1593 */
1594U_CAPI UDisplayContext U_EXPORT2
1595udat_getContext(const UDateFormat* fmt, UDisplayContextType type, UErrorCode* status);
1596
1597#ifndef U_HIDE_INTERNAL_API
1598/**
1599* Extract the date pattern from a UDateFormat set for relative date formatting.
1600* The pattern will follow the pattern syntax rules.
1601* @param fmt The formatter to query.
1602* @param result A pointer to a buffer to receive the pattern.
1603* @param resultLength The maximum size of result.
1604* @param status A pointer to a UErrorCode to receive any errors
1605* @return The total buffer size needed; if greater than resultLength, the output was truncated.
1606* @see udat_applyPatternRelative
1607* @internal ICU 4.2 technology preview
1608*/
1609U_INTERNAL int32_t U_EXPORT2
1610udat_toPatternRelativeDate(const UDateFormat *fmt,
1611 UChar *result,
1612 int32_t resultLength,
1613 UErrorCode *status);
1614
1615/**
1616* Extract the time pattern from a UDateFormat set for relative date formatting.
1617* The pattern will follow the pattern syntax rules.
1618* @param fmt The formatter to query.
1619* @param result A pointer to a buffer to receive the pattern.
1620* @param resultLength The maximum size of result.
1621* @param status A pointer to a UErrorCode to receive any errors
1622* @return The total buffer size needed; if greater than resultLength, the output was truncated.
1623* @see udat_applyPatternRelative
1624* @internal ICU 4.2 technology preview
1625*/
1626U_INTERNAL int32_t U_EXPORT2
1627udat_toPatternRelativeTime(const UDateFormat *fmt,
1628 UChar *result,
1629 int32_t resultLength,
1630 UErrorCode *status);
1631
1632/**
1633* Set the date & time patterns used by a UDateFormat set for relative date formatting.
1634* The patterns should follow the pattern syntax rules.
1635* @param format The formatter to set.
1636* @param datePattern The new date pattern
1637* @param datePatternLength The length of datePattern, or -1 if null-terminated.
1638* @param timePattern The new time pattern
1639* @param timePatternLength The length of timePattern, or -1 if null-terminated.
1640* @param status A pointer to a UErrorCode to receive any errors
1641* @see udat_toPatternRelativeDate, udat_toPatternRelativeTime
1642* @internal ICU 4.2 technology preview
1643*/
1644U_INTERNAL void U_EXPORT2
1645udat_applyPatternRelative(UDateFormat *format,
1646 const UChar *datePattern,
1647 int32_t datePatternLength,
1648 const UChar *timePattern,
1649 int32_t timePatternLength,
1650 UErrorCode *status);
1651
1652/**
1653 * @internal
1654 * @see udat_open
1655 */
1656typedef UDateFormat* (U_EXPORT2 *UDateFormatOpener) (UDateFormatStyle timeStyle,
1657 UDateFormatStyle dateStyle,
1658 const char *locale,
1659 const UChar *tzID,
1660 int32_t tzIDLength,
1661 const UChar *pattern,
1662 int32_t patternLength,
1663 UErrorCode *status);
1664
1665/**
1666 * Register a provider factory
1667 * @internal ICU 49
1668 */
1669U_INTERNAL void U_EXPORT2
1670udat_registerOpener(UDateFormatOpener opener, UErrorCode *status);
1671
1672/**
1673 * Un-Register a provider factory
1674 * @internal ICU 49
1675 */
1676U_INTERNAL UDateFormatOpener U_EXPORT2
1677udat_unregisterOpener(UDateFormatOpener opener, UErrorCode *status);
1678#endif /* U_HIDE_INTERNAL_API */
1679
1680
1681#endif /* #if !UCONFIG_NO_FORMATTING */
1682
1683#endif
1684