smpdtfmt.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 SMPDTFMT.H
*
* Modification History:
*
*   Date        Name        Description
*   02/19/97    aliu        Converted from java.
*   07/09/97    helena      Make ParsePosition into a class.
*   07/21/98    stephen     Added GMT_PLUS, GMT_MINUS
*                            Changed setTwoDigitStartDate to set2DigitYearStart
*                            Changed getTwoDigitStartDate to get2DigitYearStart
*                            Removed subParseLong
*                            Removed getZoneIndex (added in DateFormatSymbols)
*   06/14/99    stephen     Removed fgTimeZoneDataSuffix
*   10/14/99    aliu        Updated class doc to describe 2-digit year parsing
*                           {j28 4182066}.
*******************************************************************************
*/

#ifndef SMPDTFMT_H
#define SMPDTFMT_H

#include "unicode/utypes.h"

#if U_SHOW_CPLUSPLUS_API

#if !UCONFIG_NO_FORMATTING

#include "unicode/datefmt.h"
#include "unicode/udisplaycontext.h"
#include "unicode/tzfmt.h"  /* for UTimeZoneFormatTimeType */
#include "unicode/brkiter.h"

U_NAMESPACE_BEGIN

class DateFormatSymbols;
class DateFormat;
class MessageFormat;
class FieldPositionHandler;
class TimeZoneFormat;
class SharedNumberFormat;
class SimpleDateFormatMutableNFs;
class DateIntervalFormat;

namespace number {
class LocalizedNumberFormatter;
class SimpleNumberFormatter;
}

class U_I18N_API_CLASS SimpleDateFormat: public DateFormat {
public:
    U_I18N_API SimpleDateFormat(UErrorCode& status);

    U_I18N_API SimpleDateFormat(const UnicodeString& pattern,
                     UErrorCode& status);

    U_I18N_API SimpleDateFormat(const UnicodeString& pattern,
                                const UnicodeString& override,
                                UErrorCode& status);

    U_I18N_API SimpleDateFormat(const UnicodeString& pattern, const Locale& locale, UErrorCode& status);

    U_I18N_API SimpleDateFormat(const UnicodeString& pattern,
                                const UnicodeString& override,
                                const Locale& locale,
                                UErrorCode& status);

    U_I18N_API SimpleDateFormat(const UnicodeString& pattern,
                                DateFormatSymbols* formatDataToAdopt,
                                UErrorCode& status);

    U_I18N_API SimpleDateFormat(const UnicodeString& pattern,
                                const DateFormatSymbols& formatData,
                                UErrorCode& status);

    U_I18N_API SimpleDateFormat(const SimpleDateFormat&);

    U_I18N_API SimpleDateFormat& operator=(const SimpleDateFormat&);

    U_I18N_API virtual ~SimpleDateFormat();

    U_I18N_API virtual SimpleDateFormat* clone() const override;

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

    using DateFormat::format;

    U_I18N_API virtual UnicodeString& format(Calendar& cal,
                                             UnicodeString& appendTo,
                                             FieldPosition& pos) const override;

    U_I18N_API virtual UnicodeString& format(Calendar& cal,
                                             UnicodeString& appendTo,
                                             FieldPositionIterator* posIter,
                                             UErrorCode& status) const override;

    using DateFormat::parse;

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

    U_I18N_API virtual void set2DigitYearStart(UDate d, UErrorCode& status);

    U_I18N_API UDate get2DigitYearStart(UErrorCode& status) const;

    U_I18N_API virtual UnicodeString& toPattern(UnicodeString& result) const;

    U_I18N_API virtual UnicodeString& toLocalizedPattern(UnicodeString& result,
                                                         UErrorCode& status) const;

    U_I18N_API virtual void applyPattern(const UnicodeString& pattern);

    U_I18N_API virtual void applyLocalizedPattern(const UnicodeString& pattern, UErrorCode& status);

    U_I18N_API virtual const DateFormatSymbols* getDateFormatSymbols() const;

    U_I18N_API virtual void adoptDateFormatSymbols(DateFormatSymbols* newFormatSymbols);

    U_I18N_API virtual void setDateFormatSymbols(const DateFormatSymbols& newFormatSymbols);

    U_I18N_API static UClassID getStaticClassID();

    U_I18N_API virtual UClassID getDynamicClassID() const override;

    U_I18N_API virtual void adoptCalendar(Calendar* calendarToAdopt) override;

    /* Cannot use #ifndef U_HIDE_INTERNAL_API for the following methods since they are virtual */
    U_I18N_API virtual void adoptTimeZoneFormat(TimeZoneFormat* timeZoneFormatToAdopt);

    U_I18N_API virtual void setTimeZoneFormat(const TimeZoneFormat& newTimeZoneFormat);

    U_I18N_API virtual const TimeZoneFormat* getTimeZoneFormat() const;

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

    U_I18N_API void adoptNumberFormat(NumberFormat* formatToAdopt) override;

    U_I18N_API void adoptNumberFormat(const UnicodeString& fields,
                                      NumberFormat* formatToAdopt,
                                      UErrorCode& status);

    U_I18N_API const NumberFormat* getNumberFormatForField(char16_t field) const;

#ifndef U_HIDE_INTERNAL_API

    U_I18N_API UBool isFieldUnitIgnored(UCalendarDateFields field) const;

    U_I18N_API static UBool isFieldUnitIgnored(const UnicodeString& pattern, UCalendarDateFields field);

    U_I18N_API const Locale& getSmpFmtLocale() const;
#endif  /* U_HIDE_INTERNAL_API */

private:
    friend class DateFormat;
    friend class DateIntervalFormat;

    void initializeDefaultCentury();

    void initializeBooleanAttributes();

    SimpleDateFormat() = delete; // default constructor not implemented

    SimpleDateFormat(EStyle timeStyle, EStyle dateStyle, const Locale& locale, UErrorCode& status);

    SimpleDateFormat(const Locale& locale, UErrorCode& status); // Use default pattern

    UnicodeString& _format(Calendar& cal, UnicodeString& appendTo, FieldPositionHandler& handler, UErrorCode& status) const;

    void subFormat(UnicodeString &appendTo,
                   char16_t ch,
                   int32_t count,
                   UDisplayContext capitalizationContext,
                   int32_t fieldNum,
                   char16_t fieldToOutput,
                   FieldPositionHandler& handler,
                   Calendar& cal,
                   UErrorCode& status) const; // in case of illegal argument

    void zeroPaddingNumber(const NumberFormat *currentNumberFormat,
                           UnicodeString &appendTo,
                           int32_t value,
                           int32_t minDigits,
                           int32_t maxDigits) const;

    static UBool isNumeric(char16_t formatChar, int32_t count);

    static UBool isAtNumericField(const UnicodeString &pattern, int32_t patternOffset);

    static UBool isAfterNonNumericField(const UnicodeString &pattern, int32_t patternOffset);

    Calendar *initializeCalendar(TimeZone* adoptZone, const Locale& locale, UErrorCode& status);

    void construct(EStyle timeStyle, EStyle dateStyle, const Locale& locale, UErrorCode& status);

    void initialize(const Locale& locale, UErrorCode& status);

    int32_t matchString(const UnicodeString& text, int32_t start, UCalendarDateFields field,
                        const UnicodeString* stringArray, int32_t stringArrayCount,
                        const UnicodeString* monthPattern, Calendar& cal) const;

    int32_t matchAlphaMonthStrings(const UnicodeString& text, int32_t start,
                        const UnicodeString* wideStringArray, const UnicodeString* shortStringArray,
                        int32_t stringArrayCount, Calendar& cal) const;

    int32_t matchQuarterString(const UnicodeString& text, int32_t start, UCalendarDateFields field,
                               const UnicodeString* stringArray, int32_t stringArrayCount, Calendar& cal) const;

    int32_t matchDayPeriodStrings(const UnicodeString& text, int32_t start,
                                  const UnicodeString* stringArray, int32_t stringArrayCount,
                                  int32_t &dayPeriod) const;

    static UBool matchLiterals(const UnicodeString &pattern, int32_t &patternOffset,
                               const UnicodeString &text, int32_t &textOffset,
                               UBool whitespaceLenient, UBool partialMatchLenient, UBool oldLeniency);

    int32_t subParse(const UnicodeString& text, int32_t& start, char16_t ch, int32_t count,
                     UBool obeyCount, UBool allowNegative, UBool ambiguousYear[], int32_t& saveHebrewMonth, Calendar& cal,
                     int32_t patLoc, MessageFormat * numericLeapMonthFormatter, UTimeZoneFormatTimeType *tzTimeType,
                     int32_t *dayPeriod=nullptr) const;

    void parseInt(const UnicodeString& text,
                  Formattable& number,
                  ParsePosition& pos,
                  UBool allowNegative,
                  const NumberFormat *fmt) const;

    void parseInt(const UnicodeString& text,
                  Formattable& number,
                  int32_t maxDigits,
                  ParsePosition& pos,
                  UBool allowNegative,
                  const NumberFormat *fmt) const;

    int32_t checkIntSuffix(const UnicodeString& text, int32_t start,
                           int32_t patLoc, UBool isNegative) const;

    int32_t countDigits(const UnicodeString& text, int32_t start, int32_t end) const;

    static void translatePattern(const UnicodeString& originalPattern,
                                UnicodeString& translatedPattern,
                                const UnicodeString& from,
                                const UnicodeString& to,
                                UErrorCode& status);

    void         parseAmbiguousDatesAsAfter(UDate startDate, UErrorCode& status);

    int32_t compareSimpleAffix(const UnicodeString& affix,
                   const UnicodeString& input,
                   int32_t pos) const;

    int32_t skipPatternWhiteSpace(const UnicodeString& text, int32_t pos) const;

    int32_t skipUWhiteSpace(const UnicodeString& text, int32_t pos) const;

    void initSimpleNumberFormatter(UErrorCode &status);

    void initNumberFormatters(const Locale &locale,UErrorCode &status);

    void processOverrideString(const Locale &locale, const UnicodeString &str, int8_t type, UErrorCode &status);

    static const UCalendarDateFields fgPatternIndexToCalendarField[];

    static const UDateFormatField fgPatternIndexToDateFormatField[];

    TimeZoneFormat *tzFormat(UErrorCode &status) const;

    const NumberFormat* getNumberFormatByIndex(UDateFormatField index) const;

    static const int32_t fgCalendarFieldToLevel[];

    static int32_t getLevelFromChar(char16_t ch);

    static UBool isSyntaxChar(char16_t ch);

    UnicodeString       fPattern;

    UnicodeString       fDateOverride;

    UnicodeString       fTimeOverride;


    Locale              fLocale;

    DateFormatSymbols*  fSymbols = nullptr;   // Owned

    TimeZoneFormat* fTimeZoneFormat = nullptr;

    UDate                fDefaultCenturyStart;

    UBool                fHasMinute;
    UBool                fHasSecond;
    UBool                fHasHanYearChar; // pattern contains the Han year character \u5E74

    void                 parsePattern();

    /*transient*/ int32_t   fDefaultCenturyStartYear;

    struct NSOverride : public UMemory {
        const SharedNumberFormat *snf;
        int32_t hash;
        NSOverride *next;
        void free();
        NSOverride() : snf(nullptr), hash(0), next(nullptr) {
        }
        ~NSOverride();
    };

    const SharedNumberFormat    **fSharedNumberFormatters = nullptr;

    const number::SimpleNumberFormatter* fSimpleNumberFormatter = nullptr;

    UBool fHaveDefaultCentury;

    const BreakIterator* fCapitalizationBrkIter = nullptr;
};

inline UDate
SimpleDateFormat::get2DigitYearStart(UErrorCode& /*status*/) const
{
    return fDefaultCenturyStart;
}

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_FORMATTING */

#endif /* U_SHOW_CPLUSPLUS_API */

#endif // _SMPDTFMT
//eof