Logo Search packages:      
Sourcecode: icu version File versions  Download package

udat.h File Reference

C API: DateFormat. More...

#include "unicode/utypes.h"
#include "unicode/localpointer.h"
#include "unicode/ucal.h"
#include "unicode/unum.h"
Include dependency graph for udat.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define UDAT_MINUTE_SECOND   "ms"
#define UDAT_HOUR24_MINUTE   "Hm"
#define UDAT_HOUR24_MINUTE_SECOND   "Hms"
#define UDAT_HOUR_MINUTE_SECOND   "hms"
#define UDAT_STANDALONE_MONTH   "LLLL"
#define UDAT_ABBR_STANDALONE_MONTH   "LLL"
#define UDAT_YEAR_QUARTER   "yQQQ"
#define UDAT_YEAR_ABBR_QUARTER   "yQ"
#define UDAT_HOUR_MINUTE   "hm"
#define UDAT_YEAR   "y"
#define UDAT_DAY   "d"
#define UDAT_NUM_MONTH_WEEKDAY_DAY   "MEd"
#define UDAT_YEAR_NUM_MONTH   "yM"
#define UDAT_NUM_MONTH_DAY   "Md"
#define UDAT_YEAR_NUM_MONTH_WEEKDAY_DAY   "yMEd"
#define UDAT_ABBR_MONTH_WEEKDAY_DAY   "MMMEd"
#define UDAT_YEAR_MONTH   "yMMMM"
#define UDAT_YEAR_ABBR_MONTH   "yMMM"
#define UDAT_MONTH_DAY   "MMMMd"
#define UDAT_ABBR_MONTH_DAY   "MMMd"
#define UDAT_MONTH_WEEKDAY_DAY   "MMMMEEEEd"
#define UDAT_YEAR_ABBR_MONTH_WEEKDAY_DAY   "yMMMEd"
#define UDAT_YEAR_MONTH_WEEKDAY_DAY   "yMMMMEEEEd"
#define UDAT_YEAR_MONTH_DAY   "yMMMMd"
#define UDAT_YEAR_ABBR_MONTH_DAY   "yMMMd"
#define UDAT_YEAR_NUM_MONTH_DAY   "yMd"
#define UDAT_NUM_MONTH   "M"
#define UDAT_ABBR_MONTH   "MMM"
#define UDAT_MONTH   "MMMM"
#define UDAT_HOUR_MINUTE_GENERIC_TZ   "hmv"
#define UDAT_HOUR_MINUTE_TZ   "hmz"
#define UDAT_HOUR   "h"
#define UDAT_HOUR_GENERIC_TZ   "hv"
#define UDAT_HOUR_TZ   "hz"

Typedefs

typedef voidUDateFormat
typedef enum UDateFormatField UDateFormatField
typedef enum UDateFormatStyle UDateFormatStyle
typedef struct UDateFormatSymbols UDateFormatSymbols
typedef enum UDateFormatSymbolType UDateFormatSymbolType

Enumerations

enum  UDateFormatField {
  UDAT_ERA_FIELD = 0, UDAT_YEAR_FIELD = 1, UDAT_MONTH_FIELD = 2, UDAT_DATE_FIELD = 3,
  UDAT_HOUR_OF_DAY1_FIELD = 4, UDAT_HOUR_OF_DAY0_FIELD = 5, UDAT_MINUTE_FIELD = 6, UDAT_SECOND_FIELD = 7,
  UDAT_FRACTIONAL_SECOND_FIELD = 8, UDAT_DAY_OF_WEEK_FIELD = 9, UDAT_DAY_OF_YEAR_FIELD = 10, UDAT_DAY_OF_WEEK_IN_MONTH_FIELD = 11,
  UDAT_WEEK_OF_YEAR_FIELD = 12, UDAT_WEEK_OF_MONTH_FIELD = 13, UDAT_AM_PM_FIELD = 14, UDAT_HOUR1_FIELD = 15,
  UDAT_HOUR0_FIELD = 16, UDAT_TIMEZONE_FIELD = 17, UDAT_YEAR_WOY_FIELD = 18, UDAT_DOW_LOCAL_FIELD = 19,
  UDAT_EXTENDED_YEAR_FIELD = 20, UDAT_JULIAN_DAY_FIELD = 21, UDAT_MILLISECONDS_IN_DAY_FIELD = 22, UDAT_TIMEZONE_RFC_FIELD = 23,
  UDAT_TIMEZONE_GENERIC_FIELD = 24, UDAT_STANDALONE_DAY_FIELD = 25, UDAT_STANDALONE_MONTH_FIELD = 26, UDAT_QUARTER_FIELD = 27,
  UDAT_STANDALONE_QUARTER_FIELD = 28, UDAT_TIMEZONE_SPECIAL_FIELD = 29, UDAT_FIELD_COUNT = 30
}
enum  UDateFormatStyle {
  UDAT_FULL, UDAT_LONG, UDAT_MEDIUM, UDAT_SHORT,
  UDAT_DEFAULT = UDAT_MEDIUM, UDAT_RELATIVE = (1 << 7), UDAT_FULL_RELATIVE = UDAT_FULL | UDAT_RELATIVE, UDAT_LONG_RELATIVE = UDAT_LONG | UDAT_RELATIVE,
  UDAT_MEDIUM_RELATIVE = UDAT_MEDIUM | UDAT_RELATIVE, UDAT_SHORT_RELATIVE = UDAT_SHORT | UDAT_RELATIVE, UDAT_NONE = -1, UDAT_IGNORE = -2
}
enum  UDateFormatSymbolType {
  UDAT_ERAS, UDAT_MONTHS, UDAT_SHORT_MONTHS, UDAT_WEEKDAYS,
  UDAT_SHORT_WEEKDAYS, UDAT_AM_PMS, UDAT_LOCALIZED_CHARS, UDAT_ERA_NAMES,
  UDAT_NARROW_MONTHS, UDAT_NARROW_WEEKDAYS, UDAT_STANDALONE_MONTHS, UDAT_STANDALONE_SHORT_MONTHS,
  UDAT_STANDALONE_NARROW_MONTHS, UDAT_STANDALONE_WEEKDAYS, UDAT_STANDALONE_SHORT_WEEKDAYS, UDAT_STANDALONE_NARROW_WEEKDAYS,
  UDAT_QUARTERS, UDAT_SHORT_QUARTERS, UDAT_STANDALONE_QUARTERS, UDAT_STANDALONE_SHORT_QUARTERS
}

Functions

U_STABLE void U_EXPORT2 udat_applyPattern (UDateFormat *format, UBool localized, const UChar *pattern, int32_t patternLength)
U_INTERNAL void U_EXPORT2 udat_applyPatternRelative (UDateFormat *format, const UChar *datePattern, int32_t datePatternLength, const UChar *timePattern, int32_t timePatternLength, UErrorCode *status)
U_STABLE UDateFormat *U_EXPORT2 udat_clone (const UDateFormat *fmt, UErrorCode *status)
U_STABLE void U_EXPORT2 udat_close (UDateFormat *format)
U_STABLE int32_t U_EXPORT2 udat_countAvailable (void)
U_STABLE int32_t U_EXPORT2 udat_countSymbols (const UDateFormat *fmt, UDateFormatSymbolType type)
U_STABLE int32_t U_EXPORT2 udat_format (const UDateFormat *format, UDate dateToFormat, UChar *result, int32_t resultLength, UFieldPosition *position, UErrorCode *status)
U_STABLE UDate U_EXPORT2 udat_get2DigitYearStart (const UDateFormat *fmt, UErrorCode *status)
U_STABLE const char *U_EXPORT2 udat_getAvailable (int32_t localeIndex)
U_STABLE const UCalendar *U_EXPORT2 udat_getCalendar (const UDateFormat *fmt)
U_STABLE const char *U_EXPORT2 udat_getLocaleByType (const UDateFormat *fmt, ULocDataLocaleType type, UErrorCode *status)
U_STABLE const UNumberFormat
*U_EXPORT2 
udat_getNumberFormat (const UDateFormat *fmt)
U_STABLE int32_t U_EXPORT2 udat_getSymbols (const UDateFormat *fmt, UDateFormatSymbolType type, int32_t symbolIndex, UChar *result, int32_t resultLength, UErrorCode *status)
U_STABLE UBool U_EXPORT2 udat_isLenient (const UDateFormat *fmt)
U_STABLE UDateFormat *U_EXPORT2 udat_open (UDateFormatStyle timeStyle, UDateFormatStyle dateStyle, const char *locale, const UChar *tzID, int32_t tzIDLength, const UChar *pattern, int32_t patternLength, UErrorCode *status)
U_STABLE UDate U_EXPORT2 udat_parse (const UDateFormat *format, const UChar *text, int32_t textLength, int32_t *parsePos, UErrorCode *status)
U_STABLE void U_EXPORT2 udat_parseCalendar (const UDateFormat *format, UCalendar *calendar, const UChar *text, int32_t textLength, int32_t *parsePos, UErrorCode *status)
U_STABLE void U_EXPORT2 udat_set2DigitYearStart (UDateFormat *fmt, UDate d, UErrorCode *status)
U_STABLE void U_EXPORT2 udat_setCalendar (UDateFormat *fmt, const UCalendar *calendarToSet)
U_STABLE void U_EXPORT2 udat_setLenient (UDateFormat *fmt, UBool isLenient)
U_STABLE void U_EXPORT2 udat_setNumberFormat (UDateFormat *fmt, const UNumberFormat *numberFormatToSet)
U_STABLE void U_EXPORT2 udat_setSymbols (UDateFormat *format, UDateFormatSymbolType type, int32_t symbolIndex, UChar *value, int32_t valueLength, UErrorCode *status)
U_STABLE UCalendarDateFields
U_EXPORT2 
udat_toCalendarDateField (UDateFormatField field)
U_STABLE int32_t U_EXPORT2 udat_toPattern (const UDateFormat *fmt, UBool localized, UChar *result, int32_t resultLength, UErrorCode *status)
U_INTERNAL int32_t U_EXPORT2 udat_toPatternRelativeDate (const UDateFormat *fmt, UChar *result, int32_t resultLength, UErrorCode *status)
U_INTERNAL int32_t U_EXPORT2 udat_toPatternRelativeTime (const UDateFormat *fmt, UChar *result, int32_t resultLength, UErrorCode *status)

Detailed Description

C API: DateFormat.

Date Format C API

Date Format C API consists of functions that convert dates and times from their internal representations to textual form and back again in a language-independent manner. Converting from the internal representation (milliseconds since midnight, January 1, 1970) to text is known as "formatting," and converting from text to millis is known as "parsing." We currently define only one concrete structure UDateFormat, which can handle pretty much all normal date formatting and parsing actions.

Date Format helps you to format and parse dates for any locale. Your code can be completely independent of the locale conventions for months, days of the week, or even the calendar format: lunar vs. solar.

To format a date for the current Locale with default time and date style, use one of the static factory methods:

 
  UErrorCode status = U_ZERO_ERROR;
  UChar *myString;
  int32_t myStrlen = 0;
  UDateFormat* dfmt = udat_open(UDAT_DEFAULT, UDAT_DEFAULT, NULL, NULL, -1, NULL, -1, &status);
  myStrlen = udat_format(dfmt, myDate, NULL, myStrlen, NULL, &status);
  if (status==U_BUFFER_OVERFLOW_ERROR){
      status=U_ZERO_ERROR;
      myString=(UChar*)malloc(sizeof(UChar) * (myStrlen+1) );
      udat_format(dfmt, myDate, myString, myStrlen+1, NULL, &status);
  }

If you are formatting multiple numbers, it is more efficient to get the format and use it multiple times so that the system doesn't have to fetch the information about the local language and country conventions multiple times.

 
  UErrorCode status = U_ZERO_ERROR;
  int32_t i, myStrlen = 0;
  UChar* myString;
  char buffer[1024];
  UDate myDateArr[] = { 0.0, 100000000.0, 2000000000.0 }; // test values
  UDateFormat* df = udat_open(UDAT_DEFAULT, UDAT_DEFAULT, NULL, NULL, -1, NULL, 0, &status);
  for (i = 0; i < 3; i++) {
      myStrlen = udat_format(df, myDateArr[i], NULL, myStrlen, NULL, &status);
      if(status == U_BUFFER_OVERFLOW_ERROR){
          status = U_ZERO_ERROR;
          myString = (UChar*)malloc(sizeof(UChar) * (myStrlen+1) );
          udat_format(df, myDateArr[i], myString, myStrlen+1, NULL, &status);
          printf("%s\n", u_austrcpy(buffer, myString) );
          free(myString);
      }
  }

To get specific fields of a date, you can use UFieldPosition to get specific fields.

 
  UErrorCode status = U_ZERO_ERROR;
  UFieldPosition pos;
  UChar *myString;
  int32_t myStrlen = 0;
  char buffer[1024];

  pos.field = 1;  // Same as the DateFormat::EField enum
  UDateFormat* dfmt = udat_open(UDAT_DEFAULT, UDAT_DEFAULT, NULL, -1, NULL, 0, &status);
  myStrlen = udat_format(dfmt, myDate, NULL, myStrlen, &pos, &status);
  if (status==U_BUFFER_OVERFLOW_ERROR){
      status=U_ZERO_ERROR;
      myString=(UChar*)malloc(sizeof(UChar) * (myStrlen+1) );
      udat_format(dfmt, myDate, myString, myStrlen+1, &pos, &status);
  }
  printf("date format: %s\n", u_austrcpy(buffer, myString));
  buffer[pos.endIndex] = 0;   // NULL terminate the string.
  printf("UFieldPosition position equals %s\n", &buffer[pos.beginIndex]);

To format a date for a different Locale, specify it in the call to udat_open()

 
        UDateFormat* df = udat_open(UDAT_SHORT, UDAT_SHORT, "fr_FR", NULL, -1, NULL, 0, &status);

You can use a DateFormat API udat_parse() to parse.

 
  UErrorCode status = U_ZERO_ERROR;
  int32_t parsepos=0;
  UDate myDate = udat_parse(df, myString, u_strlen(myString), &parsepos, &status);

You can pass in different options for the arguments for date and time style to control the length of the result; from SHORT to MEDIUM to LONG to FULL. The exact result depends on the locale, but generally: see UDateFormatStyle for more details

  • UDAT_SHORT is completely numeric, such as 12/13/52 or 3:30pm
  • UDAT_MEDIUM is longer, such as Jan 12, 1952
  • UDAT_LONG is longer, such as January 12, 1952 or 3:30:32pm
  • UDAT_FULL is pretty completely specified, such as Tuesday, April 12, 1952 AD or 3:30:42pm PST.

You can also set the time zone on the format if you wish.

You can also use forms of the parse and format methods with Parse Position and UFieldPosition to allow you to

  • Progressively parse through pieces of a string.
  • Align any particular field, or find out where it is for selection on the screen.

Definition in file udat.h.


Generated by  Doxygen 1.6.0   Back to index