decimfmt.h

Go to the documentation of this file.

/*
********************************************************************************
*   Copyright (C) 1997-2016, International Business Machines
*   Corporation and others.  All Rights Reserved.
********************************************************************************
*
* File DECIMFMT.H
*
* Modification History:
*
*   Date        Name        Description
*   02/19/97    aliu        Converted from java.
*   03/20/97    clhuang     Updated per C++ implementation.
*   04/03/97    aliu        Rewrote parsing and formatting completely, and
*                           cleaned up and debugged.  Actually works now.
*   04/17/97    aliu        Changed DigitCount to int per code review.
*   07/10/97    helena      Made ParsePosition a class and get rid of the function
*                           hiding problems.
*   09/09/97    aliu        Ported over support for exponential formats.
*   07/20/98    stephen     Changed documentation
*   01/30/13    emmons      Added Scaling methods
********************************************************************************
*/
 
#ifndef DECIMFMT_H
#define DECIMFMT_H
 
#include "unicode/utypes.h"
#if !UCONFIG_NO_FORMATTING
 
#include "unicode/dcfmtsym.h"
#include "unicode/numfmt.h"
#include "unicode/locid.h"
#include "unicode/fpositer.h"
#include "unicode/stringpiece.h"
#include "unicode/curramt.h"
#include "unicode/enumset.h"
 
#ifndef U_HIDE_INTERNAL_API
#if UCONFIG_FORMAT_FASTPATHS_49
#define UNUM_DECIMALFORMAT_INTERNAL_SIZE 16
#endif
#endif  /* U_HIDE_INTERNAL_API */
 
U_NAMESPACE_BEGIN
 
class DigitList;
class CurrencyPluralInfo;
class Hashtable;
class UnicodeSet;
class FieldPositionHandler;
class DecimalFormatStaticSets;
class FixedDecimal;
class DecimalFormatImpl;
class PluralRules;
class VisibleDigitsWithExponent;
 
// explicit template instantiation. see digitlst.h
#if defined (_MSC_VER)
template class U_I18N_API    EnumSet<UNumberFormatAttribute,
            UNUM_MAX_NONBOOLEAN_ATTRIBUTE+1,
            UNUM_LIMIT_BOOLEAN_ATTRIBUTE>;
#endif
 
class U_I18N_API DecimalFormat: public NumberFormat {
public:
    enum ERoundingMode {
        kRoundCeiling,  
        kRoundFloor,    
        kRoundDown,     
        kRoundUp,       
        kRoundHalfEven, 
        kRoundHalfDown, 
        kRoundHalfUp,   
        kRoundUnnecessary
    };
 
    enum EPadPosition {
        kPadBeforePrefix,
        kPadAfterPrefix,
        kPadBeforeSuffix,
        kPadAfterSuffix
    };
 
    DecimalFormat(UErrorCode& status);
 
    DecimalFormat(const UnicodeString& pattern,
                  UErrorCode& status);
 
    DecimalFormat(  const UnicodeString& pattern,
                    DecimalFormatSymbols* symbolsToAdopt,
                    UErrorCode& status);
 
#ifndef U_HIDE_INTERNAL_API
    DecimalFormat(  const UnicodeString& pattern,
                    DecimalFormatSymbols* symbolsToAdopt,
                    UNumberFormatStyle style,
                    UErrorCode& status);
 
#if UCONFIG_HAVE_PARSEALLINPUT
    void setParseAllInput(UNumberFormatAttributeValue value);
#endif
 
#endif  /* U_HIDE_INTERNAL_API */
 
 
    virtual DecimalFormat& setAttribute( UNumberFormatAttribute attr,
                                       int32_t newvalue,
                                       UErrorCode &status);
 
    virtual int32_t getAttribute( UNumberFormatAttribute attr,
                                  UErrorCode &status) const;
 
 
    virtual void setGroupingUsed(UBool newValue);
 
    virtual void setParseIntegerOnly(UBool value);
 
    virtual void setContext(UDisplayContext value, UErrorCode& status);
 
    DecimalFormat(  const UnicodeString& pattern,
                    DecimalFormatSymbols* symbolsToAdopt,
                    UParseError& parseError,
                    UErrorCode& status);
    DecimalFormat(  const UnicodeString& pattern,
                    const DecimalFormatSymbols& symbols,
                    UErrorCode& status);
 
    DecimalFormat(const DecimalFormat& source);
 
    DecimalFormat& operator=(const DecimalFormat& rhs);
 
    virtual ~DecimalFormat();
 
    virtual Format* clone(void) const;
 
    virtual UBool operator==(const Format& other) const;
 
 
    using NumberFormat::format;
 
    virtual UnicodeString& format(double number,
                                  UnicodeString& appendTo,
                                  FieldPosition& pos) const;
 
 
    virtual UnicodeString& format(double number,
                                  UnicodeString& appendTo,
                                  FieldPosition& pos,
                                  UErrorCode &status) const;
 
    virtual UnicodeString& format(double number,
                                  UnicodeString& appendTo,
                                  FieldPositionIterator* posIter,
                                  UErrorCode& status) const;
 
    virtual UnicodeString& format(int32_t number,
                                  UnicodeString& appendTo,
                                  FieldPosition& pos) const;
 
    virtual UnicodeString& format(int32_t number,
                                  UnicodeString& appendTo,
                                  FieldPosition& pos,
                                  UErrorCode &status) const;
 
    virtual UnicodeString& format(int32_t number,
                                  UnicodeString& appendTo,
                                  FieldPositionIterator* posIter,
                                  UErrorCode& status) const;
 
    virtual UnicodeString& format(int64_t number,
                                  UnicodeString& appendTo,
                                  FieldPosition& pos) const;
 
    virtual UnicodeString& format(int64_t number,
                                  UnicodeString& appendTo,
                                  FieldPosition& pos,
                                  UErrorCode &status) const;
 
    virtual UnicodeString& format(int64_t number,
                                  UnicodeString& appendTo,
                                  FieldPositionIterator* posIter,
                                  UErrorCode& status) const;
 
    virtual UnicodeString& format(const StringPiece &number,
                                  UnicodeString& appendTo,
                                  FieldPositionIterator* posIter,
                                  UErrorCode& status) const;
 
 
    virtual UnicodeString& format(const DigitList &number,
                                  UnicodeString& appendTo,
                                  FieldPositionIterator* posIter,
                                  UErrorCode& status) const;
 
    virtual UnicodeString& format(
            const VisibleDigitsWithExponent &number,
            UnicodeString& appendTo,
            FieldPosition& pos,
            UErrorCode& status) const;
 
    virtual UnicodeString& format(
            const VisibleDigitsWithExponent &number,
            UnicodeString& appendTo,
            FieldPositionIterator* posIter,
            UErrorCode& status) const;
 
    virtual UnicodeString& format(const DigitList &number,
                                  UnicodeString& appendTo,
                                  FieldPosition& pos,
                                  UErrorCode& status) const;
 
   using NumberFormat::parse;
 
    virtual void parse(const UnicodeString& text,
                       Formattable& result,
                       ParsePosition& parsePosition) const;
 
    virtual CurrencyAmount* parseCurrency(const UnicodeString& text,
                                          ParsePosition& pos) const;
 
    virtual const DecimalFormatSymbols* getDecimalFormatSymbols(void) const;
 
    virtual void adoptDecimalFormatSymbols(DecimalFormatSymbols* symbolsToAdopt);
 
    virtual void setDecimalFormatSymbols(const DecimalFormatSymbols& symbols);
 
 
    virtual const CurrencyPluralInfo* getCurrencyPluralInfo(void) const;
 
    virtual void adoptCurrencyPluralInfo(CurrencyPluralInfo* toAdopt);
 
    virtual void setCurrencyPluralInfo(const CurrencyPluralInfo& info);
 
 
    UnicodeString& getPositivePrefix(UnicodeString& result) const;
 
    virtual void setPositivePrefix(const UnicodeString& newValue);
 
    UnicodeString& getNegativePrefix(UnicodeString& result) const;
 
    virtual void setNegativePrefix(const UnicodeString& newValue);
 
    UnicodeString& getPositiveSuffix(UnicodeString& result) const;
 
    virtual void setPositiveSuffix(const UnicodeString& newValue);
 
    UnicodeString& getNegativeSuffix(UnicodeString& result) const;
 
    virtual void setNegativeSuffix(const UnicodeString& newValue);
 
    int32_t getMultiplier(void) const;
 
    virtual void setMultiplier(int32_t newValue);
 
    virtual double getRoundingIncrement(void) const;
 
    virtual void setRoundingIncrement(double newValue);
 
    virtual ERoundingMode getRoundingMode(void) const;
 
    virtual void setRoundingMode(ERoundingMode roundingMode);
 
    virtual int32_t getFormatWidth(void) const;
 
    virtual void setFormatWidth(int32_t width);
 
    virtual UnicodeString getPadCharacterString() const;
 
    virtual void setPadCharacter(const UnicodeString &padChar);
 
    virtual EPadPosition getPadPosition(void) const;
 
    virtual void setPadPosition(EPadPosition padPos);
 
    virtual UBool isScientificNotation(void) const;
 
    virtual void setScientificNotation(UBool useScientific);
 
    virtual int8_t getMinimumExponentDigits(void) const;
 
    virtual void setMinimumExponentDigits(int8_t minExpDig);
 
    virtual UBool isExponentSignAlwaysShown(void) const;
 
    virtual void setExponentSignAlwaysShown(UBool expSignAlways);
 
    int32_t getGroupingSize(void) const;
 
    virtual void setGroupingSize(int32_t newValue);
 
    int32_t getSecondaryGroupingSize(void) const;
 
    virtual void setSecondaryGroupingSize(int32_t newValue);
 
#ifndef U_HIDE_INTERNAL_API
 
    int32_t getMinimumGroupingDigits() const;
 
#endif  /* U_HIDE_INTERNAL_API */
 
        /* Cannot use #ifndef U_HIDE_INTERNAL_API for the following draft method since it is virtual. */
    virtual void setMinimumGroupingDigits(int32_t newValue);
 
 
    UBool isDecimalSeparatorAlwaysShown(void) const;
 
    virtual void setDecimalSeparatorAlwaysShown(UBool newValue);
 
    UBool isDecimalPatternMatchRequired(void) const;
 
    virtual void setDecimalPatternMatchRequired(UBool newValue);
 
 
    virtual UnicodeString& toPattern(UnicodeString& result) const;
 
    virtual UnicodeString& toLocalizedPattern(UnicodeString& result) const;
 
    virtual void applyPattern(const UnicodeString& pattern,
                             UParseError& parseError,
                             UErrorCode& status);
    virtual void applyPattern(const UnicodeString& pattern,
                             UErrorCode& status);
 
    virtual void applyLocalizedPattern(const UnicodeString& pattern,
                                       UParseError& parseError,
                                       UErrorCode& status);
 
    virtual void applyLocalizedPattern(const UnicodeString& pattern,
                                       UErrorCode& status);
 
 
    virtual void setMaximumIntegerDigits(int32_t newValue);
 
    virtual void setMinimumIntegerDigits(int32_t newValue);
 
    virtual void setMaximumFractionDigits(int32_t newValue);
 
    virtual void setMinimumFractionDigits(int32_t newValue);
 
    int32_t getMinimumSignificantDigits() const;
 
    int32_t getMaximumSignificantDigits() const;
 
    void setMinimumSignificantDigits(int32_t min);
 
    void setMaximumSignificantDigits(int32_t max);
 
    UBool areSignificantDigitsUsed() const;
 
    void setSignificantDigitsUsed(UBool useSignificantDigits);
 
 public:
    virtual void setCurrency(const UChar* theCurrency, UErrorCode& ec);
 
    virtual void setCurrency(const UChar* theCurrency);
 
    void setCurrencyUsage(UCurrencyUsage newUsage, UErrorCode* ec);
 
    UCurrencyUsage getCurrencyUsage() const;
 
 
#ifndef U_HIDE_DEPRECATED_API
    static const char fgNumberPatterns[];
#endif  /* U_HIDE_DEPRECATED_API */
 
#ifndef U_HIDE_INTERNAL_API
     FixedDecimal getFixedDecimal(double number, UErrorCode &status) const;
 
     FixedDecimal getFixedDecimal(const Formattable &number, UErrorCode &status) const;
 
     FixedDecimal getFixedDecimal(DigitList &number, UErrorCode &status) const;
 
     VisibleDigitsWithExponent &initVisibleDigitsWithExponent(
             double number,
             VisibleDigitsWithExponent &digits,
             UErrorCode &status) const;
 
     VisibleDigitsWithExponent &initVisibleDigitsWithExponent(
             const Formattable &number,
             VisibleDigitsWithExponent &digits,
             UErrorCode &status) const;
 
     VisibleDigitsWithExponent &initVisibleDigitsWithExponent(
             DigitList &number,
             VisibleDigitsWithExponent &digits,
             UErrorCode &status) const;
 
#endif  /* U_HIDE_INTERNAL_API */
 
public:
 
    static UClassID U_EXPORT2 getStaticClassID(void);
 
    virtual UClassID getDynamicClassID(void) const;
 
private:
 
    DecimalFormat(); // default constructor not implemented
 
    void init();
 
    void construct(UErrorCode&              status,
                   UParseError&             parseErr,
                   const UnicodeString*     pattern = 0,
                   DecimalFormatSymbols*    symbolsToAdopt = 0
                   );
 
    void parse(const UnicodeString& text,
               Formattable& result,
               ParsePosition& pos,
               UChar* currency) const;
 
    enum {
        fgStatusInfinite,
        fgStatusLength      // Leave last in list.
    } StatusFlags;
 
    UBool subparse(const UnicodeString& text,
                   const UnicodeString* negPrefix,
                   const UnicodeString* negSuffix,
                   const UnicodeString* posPrefix,
                   const UnicodeString* posSuffix,
                   UBool complexCurrencyParsing,
                   int8_t type,
                   ParsePosition& parsePosition,
                   DigitList& digits, UBool* status,
                   UChar* currency) const;
 
    // Mixed style parsing for currency.
    // It parses against the current currency pattern
    // using complex affix comparison
    // parses against the currency plural patterns using complex affix comparison,
    // and parses against the current pattern using simple affix comparison.
    UBool parseForCurrency(const UnicodeString& text,
                           ParsePosition& parsePosition,
                           DigitList& digits,
                           UBool* status,
                           UChar* currency) const;
 
    int32_t skipPadding(const UnicodeString& text, int32_t position) const;
 
    int32_t compareAffix(const UnicodeString& input,
                         int32_t pos,
                         UBool isNegative,
                         UBool isPrefix,
                         const UnicodeString* affixPat,
                         UBool complexCurrencyParsing,
                         int8_t type,
                         UChar* currency) const;
 
    static UnicodeString& trimMarksFromAffix(const UnicodeString& affix, UnicodeString& trimmedAffix);
 
    UBool equalWithSignCompatibility(UChar32 lhs, UChar32 rhs) const;
 
    int32_t compareSimpleAffix(const UnicodeString& affix,
                                      const UnicodeString& input,
                                      int32_t pos,
                                      UBool lenient) const;
 
    static int32_t skipPatternWhiteSpace(const UnicodeString& text, int32_t pos);
 
    static int32_t skipUWhiteSpace(const UnicodeString& text, int32_t pos);
 
    static int32_t skipUWhiteSpaceAndMarks(const UnicodeString& text, int32_t pos);
 
    static int32_t skipBidiMarks(const UnicodeString& text, int32_t pos);
 
    int32_t compareComplexAffix(const UnicodeString& affixPat,
                                const UnicodeString& input,
                                int32_t pos,
                                int8_t type,
                                UChar* currency) const;
 
    static int32_t match(const UnicodeString& text, int32_t pos, UChar32 ch);
 
    static int32_t match(const UnicodeString& text, int32_t pos, const UnicodeString& str);
 
    static UBool matchSymbol(const UnicodeString &text, int32_t position, int32_t length, const UnicodeString &symbol,
                             UnicodeSet *sset, UChar32 schar);
 
    static UBool matchDecimal(UChar32 symbolChar,
                            UBool sawDecimal,  UChar32 sawDecimalChar,
                             const UnicodeSet *sset, UChar32 schar);
 
    static UBool matchGrouping(UChar32 groupingChar,
                            UBool sawGrouping, UChar32 sawGroupingChar,
                             const UnicodeSet *sset,
                             UChar32 decimalChar, const UnicodeSet *decimalSet,
                             UChar32 schar);
 
    // set up currency affix patterns for mix parsing.
    // The patterns saved here are the affix patterns of default currency
    // pattern and the unique affix patterns of the plural currency patterns.
    // Those patterns are used by parseForCurrency().
    void setupCurrencyAffixPatterns(UErrorCode& status);
 
    // get the currency rounding with respect to currency usage
    double getCurrencyRounding(const UChar* currency,
                               UErrorCode* ec) const;
 
    // get the currency fraction with respect to currency usage
    int getCurrencyFractionDigits(const UChar* currency,
                                  UErrorCode* ec) const;
 
    // hashtable operations
    Hashtable* initHashForAffixPattern(UErrorCode& status);
 
    void deleteHashForAffixPattern();
 
    void copyHashForAffixPattern(const Hashtable* source,
                                 Hashtable* target, UErrorCode& status);
 
    DecimalFormatImpl *fImpl;
 
    EnumSet<UNumberFormatAttribute,
            UNUM_MAX_NONBOOLEAN_ATTRIBUTE+1,
            UNUM_LIMIT_BOOLEAN_ATTRIBUTE>
                            fBoolFlags;
 
 
    // style is only valid when decimal formatter is constructed by
    // DecimalFormat(pattern, decimalFormatSymbol, style)
    int fStyle;
 
 
    // Affix pattern set for currency.
    // It is a set of AffixPatternsForCurrency,
    // each element of the set saves the negative prefix pattern,
    // negative suffix pattern, positive prefix pattern,
    // and positive suffix  pattern of a pattern.
    // It is used for currency mixed style parsing.
    // It is actually is a set.
    // The set contains the default currency pattern from the locale,
    // and the currency plural patterns.
    // Since it is a set, it does not contain duplicated items.
    // For example, if 2 currency plural patterns are the same, only one pattern
    // is included in the set. When parsing, we do not check whether the plural
    // count match or not.
    Hashtable* fAffixPatternsForCurrency;
 
    // Information needed for DecimalFormat to format/parse currency plural.
    CurrencyPluralInfo* fCurrencyPluralInfo;
 
#if UCONFIG_HAVE_PARSEALLINPUT
    UNumberFormatAttributeValue fParseAllInput;
#endif
 
    // Decimal Format Static Sets singleton.
    const DecimalFormatStaticSets *fStaticSets;
 
protected:
 
#ifndef U_HIDE_INTERNAL_API
    DigitList& _round(const DigitList& number, DigitList& adjustedNum, UBool& isNegative, UErrorCode& status) const;
#endif  /* U_HIDE_INTERNAL_API */
 
    virtual void getEffectiveCurrency(UChar* result, UErrorCode& ec) const;
 
    static const int32_t  kDoubleIntegerDigits;
    static const int32_t  kDoubleFractionDigits;
 
    static const int32_t  kMaxScientificIntegerDigits;
 
};
 
U_NAMESPACE_END
 
#endif /* #if !UCONFIG_NO_FORMATTING */
 
#endif // _DECIMFMT
//eof