datefmt.h

Go to the documentation of this file.

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
 ********************************************************************************
 *   Copyright (C) 1997-2016, International Business Machines
 *   Corporation and others.  All Rights Reserved.
 ********************************************************************************
 *
 * File DATEFMT.H
 *
 * Modification History:
 *
 *   Date        Name        Description
 *   02/19/97    aliu        Converted from java.
 *   04/01/97    aliu        Added support for centuries.
 *   07/23/98    stephen     JDK 1.2 sync
 *   11/15/99    weiv        Added support for week of year/day of week formatting
 ********************************************************************************
 */

#ifndef DATEFMT_H
#define DATEFMT_H

#include "unicode/utypes.h"

#if U_SHOW_CPLUSPLUS_API

#if !UCONFIG_NO_FORMATTING

#include "unicode/udat.h"
#include "unicode/calendar.h"
#include "unicode/numfmt.h"
#include "unicode/format.h"
#include "unicode/locid.h"
#include "unicode/enumset.h"
#include "unicode/udisplaycontext.h"

U_NAMESPACE_BEGIN

class TimeZone;
class DateTimePatternGenerator;

class U_I18N_API_CLASS DateFormat : public Format {
public:

    enum EStyle
    {
        kNone   = -1,

        kFull   = 0,
        kLong   = 1,
        kMedium = 2,
        kShort  = 3,

        kDateOffset   = kShort + 1,
     // kFull   + kDateOffset = 4
     // kLong   + kDateOffset = 5
     // kMedium + kDateOffset = 6
     // kShort  + kDateOffset = 7

        kDateTime             = 8,
     // Default DateTime

        kDateTimeOffset = kDateTime + 1,
     // kFull   + kDateTimeOffset = 9
     // kLong   + kDateTimeOffset = 10
     // kMedium + kDateTimeOffset = 11
     // kShort  + kDateTimeOffset = 12

        // relative dates
        kRelative = (1 << 7),

        kFullRelative = (kFull | kRelative),

        kLongRelative = kLong | kRelative,

        kMediumRelative = kMedium | kRelative,

        kShortRelative = kShort | kRelative,


        kDefault      = kMedium,



        FULL        = kFull,
        LONG        = kLong,
        MEDIUM        = kMedium,
        SHORT        = kShort,
        DEFAULT        = kDefault,
        DATE_OFFSET    = kDateOffset,
        NONE        = kNone,
        DATE_TIME    = kDateTime
    };

    U_I18N_API virtual ~DateFormat();

    U_I18N_API virtual DateFormat* clone() const override = 0;

    U_I18N_API virtual bool operator==(const Format&) const override;


    using Format::format;

    U_I18N_API virtual UnicodeString& format(const Formattable& obj,
                                             UnicodeString& appendTo,
                                             FieldPosition& pos,
                                             UErrorCode& status) const override;

    U_I18N_API virtual UnicodeString& format(const Formattable& obj,
                                             UnicodeString& appendTo,
                                             FieldPositionIterator* posIter,
                                             UErrorCode& status) const override;
    U_I18N_API virtual UnicodeString& format(Calendar& cal,
                                             UnicodeString& appendTo,
                                             FieldPosition& fieldPosition) const = 0;

    U_I18N_API virtual UnicodeString& format(Calendar& cal,
                                             UnicodeString& appendTo,
                                             FieldPositionIterator* posIter,
                                             UErrorCode& status) const;
    U_I18N_API UnicodeString& format(UDate date,
                                     UnicodeString& appendTo,
                                     FieldPosition& fieldPosition) const;

    U_I18N_API UnicodeString& format(UDate date,
                                     UnicodeString& appendTo,
                                     FieldPositionIterator* posIter,
                                     UErrorCode& status) const;
    U_I18N_API UnicodeString& format(UDate date, UnicodeString& appendTo) const;

    U_I18N_API virtual UDate parse(const UnicodeString& text, UErrorCode& status) const;

    U_I18N_API virtual void parse(const UnicodeString& text,
                                  Calendar& cal,
                                  ParsePosition& pos) const = 0;

    U_I18N_API UDate parse(const UnicodeString& text, ParsePosition& pos) const;

    U_I18N_API virtual void parseObject(const UnicodeString& source,
                                        Formattable& result,
                                        ParsePosition& parse_pos) const override;

    U_I18N_API static DateFormat* U_EXPORT2 createInstance();

    U_I18N_API static DateFormat* U_EXPORT2
    createTimeInstance(EStyle style = kDefault, const Locale& aLocale = Locale::getDefault());

    U_I18N_API static DateFormat* U_EXPORT2
    createDateInstance(EStyle style = kDefault, const Locale& aLocale = Locale::getDefault());

    U_I18N_API static DateFormat* U_EXPORT2
    createDateTimeInstance(EStyle dateStyle = kDefault,
                           EStyle timeStyle = kDefault,
                           const Locale& aLocale = Locale::getDefault());

#ifndef U_HIDE_INTERNAL_API

    U_I18N_API static UnicodeString getBestPattern(const Locale& locale,
                                                   const UnicodeString& skeleton,
                                                   UErrorCode& status);
#endif  /* U_HIDE_INTERNAL_API */

    U_I18N_API static DateFormat* U_EXPORT2 createInstanceForSkeleton(const UnicodeString& skeleton,
                                                                      UErrorCode& status);

    U_I18N_API static DateFormat* U_EXPORT2 createInstanceForSkeleton(const UnicodeString& skeleton,
                                                                      const Locale& locale,
                                                                      UErrorCode& status);

    U_I18N_API static DateFormat* U_EXPORT2 createInstanceForSkeleton(Calendar* calendarToAdopt,
                                                                      const UnicodeString& skeleton,
                                                                      const Locale& locale,
                                                                      UErrorCode& status);

    U_I18N_API static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count);

    U_I18N_API virtual UBool isLenient() const;

    U_I18N_API virtual void setLenient(UBool lenient);


    U_I18N_API virtual UBool isCalendarLenient() const;

    U_I18N_API virtual void setCalendarLenient(UBool lenient);


    U_I18N_API virtual const Calendar* getCalendar() const;

    U_I18N_API virtual void adoptCalendar(Calendar* calendarToAdopt);

    U_I18N_API virtual void setCalendar(const Calendar& newCalendar);

    U_I18N_API virtual const NumberFormat* getNumberFormat() const;

    U_I18N_API virtual void adoptNumberFormat(NumberFormat* formatToAdopt);

    U_I18N_API virtual void setNumberFormat(const NumberFormat& newNumberFormat);

    U_I18N_API virtual const TimeZone& getTimeZone() const;

    U_I18N_API virtual void adoptTimeZone(TimeZone* zoneToAdopt);

    U_I18N_API virtual void setTimeZone(const TimeZone& zone);

    U_I18N_API virtual void setContext(UDisplayContext value, UErrorCode& status);

    U_I18N_API virtual UDisplayContext getContext(UDisplayContextType type, UErrorCode& status) const;

    U_I18N_API virtual DateFormat& U_EXPORT2 setBooleanAttribute(UDateFormatBooleanAttribute attr,
                                                                 UBool newvalue, UErrorCode& status);

    U_I18N_API virtual UBool U_EXPORT2 getBooleanAttribute(UDateFormatBooleanAttribute attr,
                                                           UErrorCode& status) const;

protected:
    U_I18N_API DateFormat();

    U_I18N_API DateFormat(const DateFormat&);

    U_I18N_API DateFormat& operator=(const DateFormat&);

    Calendar* fCalendar;

    NumberFormat* fNumberFormat;


private:

    static DateFormat* U_EXPORT2 create(EStyle timeStyle, EStyle dateStyle, const Locale& inLocale);

     
    EnumSet<UDateFormatBooleanAttribute, 0, UDAT_BOOLEAN_ATTRIBUTE_COUNT> fBoolFlags;


    UDisplayContext fCapitalizationContext;
    friend class DateFmtKeyByStyle;

public:
#ifndef U_HIDE_OBSOLETE_API

    enum EField
    {
        // Obsolete; use UDateFormatField instead
        kEraField = UDAT_ERA_FIELD,
        kYearField = UDAT_YEAR_FIELD,
        kMonthField = UDAT_MONTH_FIELD,
        kDateField = UDAT_DATE_FIELD,
        kHourOfDay1Field = UDAT_HOUR_OF_DAY1_FIELD,
        kHourOfDay0Field = UDAT_HOUR_OF_DAY0_FIELD,
        kMinuteField = UDAT_MINUTE_FIELD,
        kSecondField = UDAT_SECOND_FIELD,
        kMillisecondField = UDAT_FRACTIONAL_SECOND_FIELD,
        kDayOfWeekField = UDAT_DAY_OF_WEEK_FIELD,
        kDayOfYearField = UDAT_DAY_OF_YEAR_FIELD,
        kDayOfWeekInMonthField = UDAT_DAY_OF_WEEK_IN_MONTH_FIELD,
        kWeekOfYearField = UDAT_WEEK_OF_YEAR_FIELD,
        kWeekOfMonthField = UDAT_WEEK_OF_MONTH_FIELD,
        kAmPmField = UDAT_AM_PM_FIELD,
        kHour1Field = UDAT_HOUR1_FIELD,
        kHour0Field = UDAT_HOUR0_FIELD,
        kTimezoneField = UDAT_TIMEZONE_FIELD,
        kYearWOYField = UDAT_YEAR_WOY_FIELD,
        kDOWLocalField = UDAT_DOW_LOCAL_FIELD,
        kExtendedYearField = UDAT_EXTENDED_YEAR_FIELD,
        kJulianDayField = UDAT_JULIAN_DAY_FIELD,
        kMillisecondsInDayField = UDAT_MILLISECONDS_IN_DAY_FIELD,

        // Obsolete; use UDateFormatField instead
        ERA_FIELD = UDAT_ERA_FIELD,
        YEAR_FIELD = UDAT_YEAR_FIELD,
        MONTH_FIELD = UDAT_MONTH_FIELD,
        DATE_FIELD = UDAT_DATE_FIELD,
        HOUR_OF_DAY1_FIELD = UDAT_HOUR_OF_DAY1_FIELD,
        HOUR_OF_DAY0_FIELD = UDAT_HOUR_OF_DAY0_FIELD,
        MINUTE_FIELD = UDAT_MINUTE_FIELD,
        SECOND_FIELD = UDAT_SECOND_FIELD,
        MILLISECOND_FIELD = UDAT_FRACTIONAL_SECOND_FIELD,
        DAY_OF_WEEK_FIELD = UDAT_DAY_OF_WEEK_FIELD,
        DAY_OF_YEAR_FIELD = UDAT_DAY_OF_YEAR_FIELD,
        DAY_OF_WEEK_IN_MONTH_FIELD = UDAT_DAY_OF_WEEK_IN_MONTH_FIELD,
        WEEK_OF_YEAR_FIELD = UDAT_WEEK_OF_YEAR_FIELD,
        WEEK_OF_MONTH_FIELD = UDAT_WEEK_OF_MONTH_FIELD,
        AM_PM_FIELD = UDAT_AM_PM_FIELD,
        HOUR1_FIELD = UDAT_HOUR1_FIELD,
        HOUR0_FIELD = UDAT_HOUR0_FIELD,
        TIMEZONE_FIELD = UDAT_TIMEZONE_FIELD
    };
#endif  /* U_HIDE_OBSOLETE_API */
};

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_FORMATTING */

#endif /* U_SHOW_CPLUSPLUS_API */

#endif // _DATEFMT
//eof