ICU 55.1  55.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
udat.h
Go to the documentation of this file.
1 /*
2  *******************************************************************************
3  * Copyright (C) 1996-2015, International Business Machines
4  * Corporation and others. All Rights Reserved.
5  *******************************************************************************
6 */
7 
8 #ifndef UDAT_H
9 #define UDAT_H
10 
11 #include "unicode/utypes.h"
12 
13 #if !UCONFIG_NO_FORMATTING
14 
15 #include "unicode/localpointer.h"
16 #include "unicode/ucal.h"
17 #include "unicode/unum.h"
19 #include "unicode/ufieldpositer.h"
151 typedef void* UDateFormat;
152 
156 typedef enum UDateFormatStyle {
167 
169  UDAT_RELATIVE = (1 << 7),
170 
171  UDAT_FULL_RELATIVE = UDAT_FULL | UDAT_RELATIVE,
172 
173  UDAT_LONG_RELATIVE = UDAT_LONG | UDAT_RELATIVE,
174 
175  UDAT_MEDIUM_RELATIVE = UDAT_MEDIUM | UDAT_RELATIVE,
176 
177  UDAT_SHORT_RELATIVE = UDAT_SHORT | UDAT_RELATIVE,
178 
179 
181  UDAT_NONE = -1,
182 
189 
190 #ifndef U_HIDE_INTERNAL_API
193 #endif /* U_HIDE_INTERNAL_API */
195 
196 /* Skeletons for dates. */
197 
202 #define UDAT_YEAR "y"
203 
207 #define UDAT_QUARTER "QQQQ"
208 
212 #define UDAT_ABBR_QUARTER "QQQ"
213 
217 #define UDAT_YEAR_QUARTER "yQQQQ"
218 
222 #define UDAT_YEAR_ABBR_QUARTER "yQQQ"
223 
227 #define UDAT_MONTH "MMMM"
228 
232 #define UDAT_ABBR_MONTH "MMM"
233 
237 #define UDAT_NUM_MONTH "M"
238 
242 #define UDAT_YEAR_MONTH "yMMMM"
243 
247 #define UDAT_YEAR_ABBR_MONTH "yMMM"
248 
252 #define UDAT_YEAR_NUM_MONTH "yM"
253 
257 #define UDAT_DAY "d"
258 
263 #define UDAT_YEAR_MONTH_DAY "yMMMMd"
264 
269 #define UDAT_YEAR_ABBR_MONTH_DAY "yMMMd"
270 
275 #define UDAT_YEAR_NUM_MONTH_DAY "yMd"
276 
280 #define UDAT_WEEKDAY "EEEE"
281 
285 #define UDAT_ABBR_WEEKDAY "E"
286 
291 #define UDAT_YEAR_MONTH_WEEKDAY_DAY "yMMMMEEEEd"
292 
297 #define UDAT_YEAR_ABBR_MONTH_WEEKDAY_DAY "yMMMEd"
298 
303 #define UDAT_YEAR_NUM_MONTH_WEEKDAY_DAY "yMEd"
304 
309 #define UDAT_MONTH_DAY "MMMMd"
310 
315 #define UDAT_ABBR_MONTH_DAY "MMMd"
316 
321 #define UDAT_NUM_MONTH_DAY "Md"
322 
327 #define UDAT_MONTH_WEEKDAY_DAY "MMMMEEEEd"
328 
333 #define UDAT_ABBR_MONTH_WEEKDAY_DAY "MMMEd"
334 
339 #define UDAT_NUM_MONTH_WEEKDAY_DAY "MEd"
340 
341 /* Skeletons for times. */
342 
347 #define UDAT_HOUR "j"
348 
352 #define UDAT_HOUR24 "H"
353 
357 #define UDAT_MINUTE "m"
358 
363 #define UDAT_HOUR_MINUTE "jm"
364 
369 #define UDAT_HOUR24_MINUTE "Hm"
370 
374 #define UDAT_SECOND "s"
375 
381 #define UDAT_HOUR_MINUTE_SECOND "jms"
382 
388 #define UDAT_HOUR24_MINUTE_SECOND "Hms"
389 
394 #define UDAT_MINUTE_SECOND "ms"
395 
396 /* Skeletons for time zones. */
397 
405 #define UDAT_LOCATION_TZ "VVVV"
406 
413 #define UDAT_GENERIC_TZ "vvvv"
414 
421 #define UDAT_ABBR_GENERIC_TZ "v"
422 
429 #define UDAT_SPECIFIC_TZ "zzzz"
430 
437 #define UDAT_ABBR_SPECIFIC_TZ "z"
438 
445 #define UDAT_ABBR_UTC_TZ "ZZZZ"
446 
447 /* deprecated skeleton constants */
448 
449 #ifndef U_HIDE_DEPRECATED_API
450 
454 #define UDAT_STANDALONE_MONTH "LLLL"
455 
459 #define UDAT_ABBR_STANDALONE_MONTH "LLL"
460 
465 #define UDAT_HOUR_MINUTE_GENERIC_TZ "jmv"
466 
470 #define UDAT_HOUR_MINUTE_TZ "jmz"
471 
475 #define UDAT_HOUR_GENERIC_TZ "jv"
476 
480 #define UDAT_HOUR_TZ "jz"
481 #endif /* U_HIDE_DEPRECATED_API */
482 
488 typedef enum UDateFormatField {
495 
502 
509 
516 
525 
534 
541 
548 
563 
570 
577 
584 
591 
598 
605 
614 
623 
631 
638 
645 
652 
659 
666 
674 
688 
696 
705 
714 
721 
730 
738 
746 
754 
755 #ifndef U_HIDE_INTERNAL_API
756 
762 #endif /* U_HIDE_INTERNAL_API */
763 
764 #ifndef U_HIDE_DRAFT_API
765 
771 #endif /* U_HIDE_DRAFT_API */
772 
782 
784 
785 
796 
797 
826 U_STABLE UDateFormat* U_EXPORT2
827 udat_open(UDateFormatStyle timeStyle,
828  UDateFormatStyle dateStyle,
829  const char *locale,
830  const UChar *tzID,
831  int32_t tzIDLength,
832  const UChar *pattern,
833  int32_t patternLength,
834  UErrorCode *status);
835 
836 
843 U_STABLE void U_EXPORT2
844 udat_close(UDateFormat* format);
845 
846 
864 #ifndef U_HIDE_DRAFT_API
865 
876 #endif /* U_HIDE_DRAFT_API */
877 
883 
894 U_STABLE UBool U_EXPORT2
896 
907 U_STABLE void U_EXPORT2
909 
910 
911 
912 #if U_SHOW_CPLUSPLUS_API
913 
915 
926 
928 
929 #endif
930 
939 U_STABLE UDateFormat* U_EXPORT2
940 udat_clone(const UDateFormat *fmt,
941  UErrorCode *status);
942 
961 U_STABLE int32_t U_EXPORT2
962 udat_format( const UDateFormat* format,
963  UDate dateToFormat,
964  UChar* result,
965  int32_t resultLength,
966  UFieldPosition* position,
967  UErrorCode* status);
968 
969 #ifndef U_HIDE_DRAFT_API
970 
992 U_DRAFT int32_t U_EXPORT2
993 udat_formatCalendar( const UDateFormat* format,
994  UCalendar* calendar,
995  UChar* result,
996  int32_t capacity,
997  UFieldPosition* position,
998  UErrorCode* status);
999 
1027 U_DRAFT int32_t U_EXPORT2
1028 udat_formatForFields( const UDateFormat* format,
1029  UDate dateToFormat,
1030  UChar* result,
1031  int32_t resultLength,
1032  UFieldPositionIterator* fpositer,
1033  UErrorCode* status);
1034 
1065 U_DRAFT int32_t U_EXPORT2
1067  UCalendar* calendar,
1068  UChar* result,
1069  int32_t capacity,
1070  UFieldPositionIterator* fpositer,
1071  UErrorCode* status);
1072 
1073 #endif /* U_HIDE_DRAFT_API */
1074 
1100 U_STABLE UDate U_EXPORT2
1101 udat_parse(const UDateFormat* format,
1102  const UChar* text,
1103  int32_t textLength,
1104  int32_t *parsePos,
1105  UErrorCode *status);
1106 
1128 U_STABLE void U_EXPORT2
1129 udat_parseCalendar(const UDateFormat* format,
1130  UCalendar* calendar,
1131  const UChar* text,
1132  int32_t textLength,
1133  int32_t *parsePos,
1134  UErrorCode *status);
1135 
1145 U_STABLE UBool U_EXPORT2
1146 udat_isLenient(const UDateFormat* fmt);
1147 
1157 U_STABLE void U_EXPORT2
1159  UBool isLenient);
1160 
1170 U_STABLE const UCalendar* U_EXPORT2
1171 udat_getCalendar(const UDateFormat* fmt);
1172 
1182 U_STABLE void U_EXPORT2
1184  const UCalendar* calendarToSet);
1185 
1195 U_STABLE const UNumberFormat* U_EXPORT2
1196 udat_getNumberFormat(const UDateFormat* fmt);
1197 
1198 #ifndef U_HIDE_DRAFT_API
1199 
1208 U_DRAFT const UNumberFormat* U_EXPORT2
1210 
1226 U_DRAFT void U_EXPORT2
1228  const UChar* fields,
1229  UNumberFormat* numberFormatToSet,
1230  UErrorCode* status);
1231 #endif /* U_HIDE_DRAFT_API */
1232 
1245 U_STABLE void U_EXPORT2
1247  const UNumberFormat* numberFormatToSet);
1248 
1249 #ifndef U_HIDE_DRAFT_API
1250 
1259 U_DRAFT void U_EXPORT2
1261  UNumberFormat* numberFormatToAdopt);
1262 #endif /* U_HIDE_DRAFT_API */
1263 
1273 U_STABLE const char* U_EXPORT2
1274 udat_getAvailable(int32_t localeIndex);
1275 
1284 U_STABLE int32_t U_EXPORT2
1285 udat_countAvailable(void);
1286 
1297 U_STABLE UDate U_EXPORT2
1299  UErrorCode *status);
1300 
1311 U_STABLE void U_EXPORT2
1313  UDate d,
1314  UErrorCode *status);
1315 
1328 U_STABLE int32_t U_EXPORT2
1329 udat_toPattern( const UDateFormat *fmt,
1330  UBool localized,
1331  UChar *result,
1332  int32_t resultLength,
1333  UErrorCode *status);
1334 
1345 U_STABLE void U_EXPORT2
1347  UBool localized,
1348  const UChar *pattern,
1349  int32_t patternLength);
1350 
1381  UDAT_STANDALONE_SHORT_MONTHS,
1382  UDAT_STANDALONE_NARROW_MONTHS,
1398  UDAT_STANDALONE_SHORT_QUARTERS,
1412 #ifndef U_HIDE_DRAFT_API
1413  ,
1448 #endif /* U_HIDE_DRAFT_API */
1450 
1451 struct UDateFormatSymbols;
1457 
1474 U_STABLE int32_t U_EXPORT2
1475 udat_getSymbols(const UDateFormat *fmt,
1476  UDateFormatSymbolType type,
1477  int32_t symbolIndex,
1478  UChar *result,
1479  int32_t resultLength,
1480  UErrorCode *status);
1481 
1494 U_STABLE int32_t U_EXPORT2
1495 udat_countSymbols( const UDateFormat *fmt,
1496  UDateFormatSymbolType type);
1497 
1513 U_STABLE void U_EXPORT2
1514 udat_setSymbols( UDateFormat *format,
1515  UDateFormatSymbolType type,
1516  int32_t symbolIndex,
1517  UChar *value,
1518  int32_t valueLength,
1519  UErrorCode *status);
1520 
1530 U_STABLE const char* U_EXPORT2
1532  ULocDataLocaleType type,
1533  UErrorCode* status);
1534 
1543 U_DRAFT void U_EXPORT2
1545 
1555 U_STABLE UDisplayContext U_EXPORT2
1556 udat_getContext(const UDateFormat* fmt, UDisplayContextType type, UErrorCode* status);
1557 
1558 #ifndef U_HIDE_INTERNAL_API
1559 
1570 U_INTERNAL int32_t U_EXPORT2
1572  UChar *result,
1573  int32_t resultLength,
1574  UErrorCode *status);
1575 
1587 U_INTERNAL int32_t U_EXPORT2
1589  UChar *result,
1590  int32_t resultLength,
1591  UErrorCode *status);
1592 
1605 U_INTERNAL void U_EXPORT2
1607  const UChar *datePattern,
1608  int32_t datePatternLength,
1609  const UChar *timePattern,
1610  int32_t timePatternLength,
1611  UErrorCode *status);
1612 
1617 typedef UDateFormat* (U_EXPORT2 *UDateFormatOpener) (UDateFormatStyle timeStyle,
1618  UDateFormatStyle dateStyle,
1619  const char *locale,
1620  const UChar *tzID,
1621  int32_t tzIDLength,
1622  const UChar *pattern,
1623  int32_t patternLength,
1624  UErrorCode *status);
1625 
1630 U_INTERNAL void U_EXPORT2
1632 
1637 U_INTERNAL UDateFormatOpener U_EXPORT2
1639 #endif /* U_HIDE_INTERNAL_API */
1640 
1641 
1642 #endif /* #if !UCONFIG_NO_FORMATTING */
1643 
1644 #endif