tzfmt.h

Go to the documentation of this file.

/*
*******************************************************************************
* Copyright (C) 2011-2012, International Business Machines Corporation and    *
* others. All Rights Reserved.                                                *
*******************************************************************************
*/
#ifndef __TZFMT_H
#define __TZFMT_H

 
#include "unicode/utypes.h"
 
#if !UCONFIG_NO_FORMATTING
#ifndef U_HIDE_INTERNAL_API
 
#include "unicode/format.h"
#include "unicode/timezone.h"
#include "unicode/tznames.h"
 
U_CDECL_BEGIN
typedef enum UTimeZoneFormatStyle {
    UTZFMT_STYLE_GENERIC_LOCATION,
    UTZFMT_STYLE_GENERIC_LONG,
    UTZFMT_STYLE_GENERIC_SHORT,
    UTZFMT_STYLE_SPECIFIC_LONG,
    UTZFMT_STYLE_SPECIFIC_SHORT,
    UTZFMT_STYLE_RFC822,
    UTZFMT_STYLE_LOCALIZED_GMT,
    UTZFMT_STYLE_ISO8601
} UTimeZoneFormatStyle;

typedef enum UTimeZoneFormatGMTOffsetPatternType {
    UTZFMT_PAT_POSITIVE_HM,
    UTZFMT_PAT_POSITIVE_HMS,
    UTZFMT_PAT_NEGATIVE_HM,
    UTZFMT_PAT_NEGATIVE_HMS
} UTimeZoneFormatGMTOffsetPatternType;

typedef enum UTimeZoneFormatTimeType {
    UTZFMT_TIME_TYPE_UNKNOWN,
    UTZFMT_TIME_TYPE_STANDARD,
    UTZFMT_TIME_TYPE_DAYLIGHT
} UTimeZoneFormatTimeType;

typedef enum UTimeZoneFormatParseOption {
    UTZFMT_PARSE_OPTION_NONE        = 0x00,
    UTZFMT_PARSE_OPTION_ALL_STYLES  = 0x01
} UTimeZoneFormatParseOption;
 
U_CDECL_END
 
U_NAMESPACE_BEGIN
 
class TimeZoneGenericNames;
class UVector;

class U_I18N_API TimeZoneFormat : public Format {
public:
    TimeZoneFormat(const TimeZoneFormat& other);

    virtual ~TimeZoneFormat();

    TimeZoneFormat& operator=(const TimeZoneFormat& other);

    virtual UBool operator==(const Format& other) const;

    virtual Format* clone() const;

    static TimeZoneFormat* U_EXPORT2 createInstance(const Locale& locale, UErrorCode& status);

    const TimeZoneNames* getTimeZoneNames() const;

    void adoptTimeZoneNames(TimeZoneNames *tznames);

    void setTimeZoneNames(const TimeZoneNames &tznames);

    UnicodeString& getGMTPattern(UnicodeString& pattern) const;

    void setGMTPattern(const UnicodeString& pattern, UErrorCode& status);

    UnicodeString& getGMTOffsetPattern(UTimeZoneFormatGMTOffsetPatternType type, UnicodeString& pattern) const;

    void setGMTOffsetPattern(UTimeZoneFormatGMTOffsetPatternType type, const UnicodeString& pattern, UErrorCode& status);

    UnicodeString& getGMTOffsetDigits(UnicodeString& digits) const;

    void setGMTOffsetDigits(const UnicodeString& digits, UErrorCode& status);

    UnicodeString& getGMTZeroFormat(UnicodeString& gmtZeroFormat) const;

    void setGMTZeroFormat(const UnicodeString& gmtZeroFormat, UErrorCode& status);

    uint32_t getDefaultParseOptions(void) const;

    void setDefaultParseOptions(uint32_t flags);

    UnicodeString& formatOffsetRFC822(int32_t offset, UnicodeString& result, UErrorCode& status) const;

    UnicodeString& formatOffsetISO8601(int32_t offset, UnicodeString& result, UErrorCode& status) const;

    UnicodeString& formatOffsetLocalizedGMT(int32_t offset, UnicodeString& result, UErrorCode& status) const;
 
    using Format::format;

    virtual UnicodeString& format(UTimeZoneFormatStyle style, const TimeZone& tz, UDate date,
        UnicodeString& name, UTimeZoneFormatTimeType* timeType = NULL) const;

    int32_t parseOffsetRFC822(const UnicodeString& text, ParsePosition& pos) const;

    int32_t parseOffsetISO8601(const UnicodeString& text, ParsePosition& pos) const;

    int32_t parseOffsetLocalizedGMT(const UnicodeString& text, ParsePosition& pos) const;

    virtual TimeZone* parse(UTimeZoneFormatStyle style, const UnicodeString& text, ParsePosition& pos,
        int32_t parseOptions, UTimeZoneFormatTimeType* timeType = NULL) const;

    TimeZone* parse(UTimeZoneFormatStyle style, const UnicodeString& text, ParsePosition& pos,
        UTimeZoneFormatTimeType* timeType = NULL) const;
 
    /* ----------------------------------------------
     * Format APIs
     * ---------------------------------------------- */

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

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

    static UClassID U_EXPORT2 getStaticClassID(void);

    virtual UClassID getDynamicClassID() const;
 
protected:
    TimeZoneFormat(const Locale& locale, UErrorCode& status);
 
private:
    /* Locale of this object */
    Locale fLocale;
 
    /* Stores the region (could be implicit default) */ 
    char fTargetRegion[ULOC_COUNTRY_CAPACITY];
 
    /* TimeZoneNames object used by this formatter */
    TimeZoneNames* fTimeZoneNames;
 
    /* TimeZoneGenericNames object used by this formatter - lazily instantiated */
    TimeZoneGenericNames* fTimeZoneGenericNames;
 
    /* Localized GMT format pattern - e.g. "GMT{0}" */
    UnicodeString fGMTPattern;
 
    /* Array of offset patterns used by Localized GMT format - e.g. "+HH:mm" */
    UnicodeString fGMTOffsetPatterns[UTZFMT_PAT_NEGATIVE_HMS + 1];
 
    /* Localized decimal digits used by Localized GMT format */
    UChar32 fGMTOffsetDigits[10];
 
    /* Localized GMT zero format - e.g. "GMT" */
    UnicodeString fGMTZeroFormat;
 
    /* Bit flags representing parse options */
    uint32_t fDefParseOptionFlags;
 
    /* Constant parts of GMT format pattern, populated from localized GMT format pattern*/
    UnicodeString fGMTPatternPrefix;    /* Substring before {0} */
    UnicodeString fGMTPatternSuffix;    /* Substring after {0} */
 
    /* Compiled offset patterns generated from fGMTOffsetPatterns[] */
    UVector* fGMTOffsetPatternItems[UTZFMT_PAT_NEGATIVE_HMS + 1];

    UnicodeString& formatSpecific(const TimeZone& tz, UTimeZoneNameType stdType, UTimeZoneNameType dstType,
        UDate date, UnicodeString& name, UTimeZoneFormatTimeType *timeType) const;

    UnicodeString& formatGeneric(const TimeZone& tz, int32_t genType, UDate date, UnicodeString& name) const;

    const TimeZoneGenericNames* getTimeZoneGenericNames(UErrorCode& status) const;

    enum OffsetFields {
        FIELDS_H,
        FIELDS_HM,
        FIELDS_HMS
    };

    void initGMTPattern(const UnicodeString& gmtPattern, UErrorCode& status);

    static UVector* parseOffsetPattern(const UnicodeString& pattern, OffsetFields required, UErrorCode& status);

    static UnicodeString& expandOffsetPattern(const UnicodeString& offsetHM, UnicodeString& result);

    static UBool toCodePoints(const UnicodeString& str, UChar32* codeArray, int32_t capacity);

    int32_t parseOffsetISO8601(const UnicodeString& text, ParsePosition& pos, UBool extendedOnly,
        UBool* hasDigitOffset = NULL) const;

    void appendOffsetDigits(UnicodeString& buf, int32_t n, uint8_t minDigits) const;

    int32_t parseOffsetLocalizedGMT(const UnicodeString& text, ParsePosition& pos,
        UBool* hasDigitOffset) const;

    int32_t parseOffsetFields(const UnicodeString& text, int32_t start, UBool minimumHourWidth,
        int32_t& parsedLen) const;

    int32_t parseAbuttingOffsetFields(const UnicodeString& text, int32_t start, int32_t& parsedLen) const;

    int32_t parseOffsetDefaultLocalizedGMT(const UnicodeString& text, int start, int32_t& parsedLen) const;

    int32_t parseDefaultOffsetFields(const UnicodeString& text, int32_t start, UChar separator,
        int32_t& parsedLen) const;

    int32_t parseOffsetFieldWithLocalizedDigits(const UnicodeString& text, int32_t start,
        uint8_t minDigits, uint8_t maxDigits, uint16_t minVal, uint16_t maxVal, int32_t& parsedLen) const;

    int32_t parseSingleLocalizedDigit(const UnicodeString& text, int32_t start, int32_t& len) const;

    static UnicodeString& formatOffsetWithAsciiDigits(int32_t offset, UChar sep,
        OffsetFields minFields, OffsetFields maxFields, UnicodeString& result);

    static int32_t parseAbuttingAsciiOffsetFields(const UnicodeString& text, ParsePosition& pos,
        OffsetFields minFields, OffsetFields maxFields, UBool fixedHourWidth);

    static int32_t parseAsciiOffsetFields(const UnicodeString& text, ParsePosition& pos, UChar sep,
        OffsetFields minFields, OffsetFields maxFields, UBool fixedHourWidth);

    static UnicodeString& unquote(const UnicodeString& pattern, UnicodeString& result);

    void initGMTOffsetPatterns(UErrorCode& status);

    TimeZone* createTimeZoneForOffset(int32_t offset) const;

    static UTimeZoneFormatTimeType getTimeType(UTimeZoneNameType nameType);
 
    /*
     * Returns the time zone ID of a match at the specified index within
     * the MatchInfoCollection.
     * @param matches the collection of matches
     * @param idx the index withing matches
     * @param tzID receives the resolved time zone ID
     * @return a reference to tzID.
     */
    UnicodeString& getTimeZoneID(const TimeZoneNames::MatchInfoCollection* matches, int32_t idx, UnicodeString& tzID) const;
};
 
U_NAMESPACE_END
 
#endif  /* U_HIDE_INTERNAL_API */
#endif
#endif