dcfmtsym.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 DCFMTSYM.H
*
* Modification History:
*
*   Date        Name        Description
*   02/19/97    aliu        Converted from java.
*   03/18/97    clhuang     Updated per C++ implementation.
*   03/27/97    helena      Updated to pass the simple test after code review.
*   08/26/97    aliu        Added currency/intl currency symbol support.
*   07/22/98    stephen     Changed to match C++ style
*                            currencySymbol -> fCurrencySymbol
*                            Constants changed from CAPS to kCaps
*   06/24/99    helena      Integrated Alan's NF enhancements and Java2 bug fixes
*   09/22/00    grhoten     Marked deprecation tags with a pointer to replacement
*                            functions.
********************************************************************************
*/

#ifndef DCFMTSYM_H
#define DCFMTSYM_H

#include "unicode/utypes.h"

#if U_SHOW_CPLUSPLUS_API

#if !UCONFIG_NO_FORMATTING

#include "unicode/uchar.h"
#include "unicode/uobject.h"
#include "unicode/locid.h"
#include "unicode/numsys.h"
#include "unicode/unum.h"
#include "unicode/unistr.h"

U_NAMESPACE_BEGIN

class U_I18N_API DecimalFormatSymbols : public UObject {
public:
    enum ENumberFormatSymbol {
        kDecimalSeparatorSymbol,
        kGroupingSeparatorSymbol,
        kPatternSeparatorSymbol,
        kPercentSymbol,
        kZeroDigitSymbol,
        kDigitSymbol,
        kMinusSignSymbol,
        kPlusSignSymbol,
        kCurrencySymbol,
        kIntlCurrencySymbol,
        kMonetarySeparatorSymbol,
        kExponentialSymbol,
        kPerMillSymbol,
        kPadEscapeSymbol,
        kInfinitySymbol,
        kNaNSymbol,
        kSignificantDigitSymbol,
        kMonetaryGroupingSeparatorSymbol,
        kOneDigitSymbol,
        kTwoDigitSymbol,
        kThreeDigitSymbol,
        kFourDigitSymbol,
        kFiveDigitSymbol,
        kSixDigitSymbol,
        kSevenDigitSymbol,
        kEightDigitSymbol,
        kNineDigitSymbol,
        kExponentMultiplicationSymbol,
        kFormatSymbolCount = kNineDigitSymbol + 2
    };

    DecimalFormatSymbols(const Locale& locale, UErrorCode& status);

    DecimalFormatSymbols(const Locale& locale, const NumberingSystem& ns, UErrorCode& status);

    DecimalFormatSymbols(UErrorCode& status);

    static DecimalFormatSymbols* createWithLastResortData(UErrorCode& status);

    DecimalFormatSymbols(const DecimalFormatSymbols&);

    DecimalFormatSymbols& operator=(const DecimalFormatSymbols&);

    virtual ~DecimalFormatSymbols();

    UBool operator==(const DecimalFormatSymbols& other) const;

    UBool operator!=(const DecimalFormatSymbols& other) const { return !operator==(other); }

    inline UnicodeString getSymbol(ENumberFormatSymbol symbol) const;

    void setSymbol(ENumberFormatSymbol symbol, const UnicodeString &value, const UBool propogateDigits);

    inline Locale getLocale() const;

    Locale getLocale(ULocDataLocaleType type, UErrorCode& status) const;

     const UnicodeString& getPatternForCurrencySpacing(UCurrencySpacing type,
                                                 UBool beforeCurrency,
                                                 UErrorCode& status) const;
     void setPatternForCurrencySpacing(UCurrencySpacing type,
                                       UBool beforeCurrency,
                                       const UnicodeString& pattern);

    virtual UClassID getDynamicClassID() const;

    static UClassID U_EXPORT2 getStaticClassID();

private:
    DecimalFormatSymbols();

    void initialize(const Locale& locale, UErrorCode& success,
        UBool useLastResortData = FALSE, const NumberingSystem* ns = nullptr);

    void initialize();

    void setCurrencyForSymbols();

public:

#ifndef U_HIDE_INTERNAL_API

    inline UBool isCustomCurrencySymbol() const {
        return fIsCustomCurrencySymbol;
    }

    inline UBool isCustomIntlCurrencySymbol() const {
        return fIsCustomIntlCurrencySymbol;
    }

    inline UChar32 getCodePointZero() const {
        return fCodePointZero;
    }
#endif  /* U_HIDE_INTERNAL_API */

    inline const UnicodeString& getConstSymbol(ENumberFormatSymbol symbol) const;

#ifndef U_HIDE_INTERNAL_API

    inline const UnicodeString& getConstDigitSymbol(int32_t digit) const;

    inline const char16_t* getCurrencyPattern(void) const;
#endif  /* U_HIDE_INTERNAL_API */

private:
    UnicodeString fSymbols[kFormatSymbolCount];

    UnicodeString fNoSymbol;

    UChar32 fCodePointZero;

    Locale locale;

    char actualLocale[ULOC_FULLNAME_CAPACITY];
    char validLocale[ULOC_FULLNAME_CAPACITY];
    const char16_t* currPattern;

    UnicodeString currencySpcBeforeSym[UNUM_CURRENCY_SPACING_COUNT];
    UnicodeString currencySpcAfterSym[UNUM_CURRENCY_SPACING_COUNT];
    UBool fIsCustomCurrencySymbol;
    UBool fIsCustomIntlCurrencySymbol;
};

// -------------------------------------

inline UnicodeString
DecimalFormatSymbols::getSymbol(ENumberFormatSymbol symbol) const {
    const UnicodeString *strPtr;
    if(symbol < kFormatSymbolCount) {
        strPtr = &fSymbols[symbol];
    } else {
        strPtr = &fNoSymbol;
    }
    return *strPtr;
}

// See comments above for this function. Not hidden with #ifdef U_HIDE_INTERNAL_API
inline const UnicodeString &
DecimalFormatSymbols::getConstSymbol(ENumberFormatSymbol symbol) const {
    const UnicodeString *strPtr;
    if(symbol < kFormatSymbolCount) {
        strPtr = &fSymbols[symbol];
    } else {
        strPtr = &fNoSymbol;
    }
    return *strPtr;
}

#ifndef U_HIDE_INTERNAL_API
inline const UnicodeString& DecimalFormatSymbols::getConstDigitSymbol(int32_t digit) const {
    if (digit < 0 || digit > 9) {
        digit = 0;
    }
    if (digit == 0) {
        return fSymbols[kZeroDigitSymbol];
    }
    ENumberFormatSymbol key = static_cast<ENumberFormatSymbol>(kOneDigitSymbol + digit - 1);
    return fSymbols[key];
}
#endif /* U_HIDE_INTERNAL_API */

// -------------------------------------

inline void
DecimalFormatSymbols::setSymbol(ENumberFormatSymbol symbol, const UnicodeString &value, const UBool propogateDigits = TRUE) {
    if (symbol == kCurrencySymbol) {
        fIsCustomCurrencySymbol = TRUE;
    }
    else if (symbol == kIntlCurrencySymbol) {
        fIsCustomIntlCurrencySymbol = TRUE;
    }
    if(symbol<kFormatSymbolCount) {
        fSymbols[symbol]=value;
    }

    // If the zero digit is being set to a known zero digit according to Unicode,
    // then we automatically set the corresponding 1-9 digits
    // Also record updates to fCodePointZero. Be conservative if in doubt.
    if (symbol == kZeroDigitSymbol) {
        UChar32 sym = value.char32At(0);
        if ( propogateDigits && u_charDigitValue(sym) == 0 && value.countChar32() == 1 ) {
            fCodePointZero = sym;
            for ( int8_t i = 1 ; i<= 9 ; i++ ) {
                sym++;
                fSymbols[(int)kOneDigitSymbol+i-1] = UnicodeString(sym);
            }
        } else {
            fCodePointZero = -1;
        }
    } else if (symbol >= kOneDigitSymbol && symbol <= kNineDigitSymbol) {
        fCodePointZero = -1;
    }
}

// -------------------------------------

inline Locale
DecimalFormatSymbols::getLocale() const {
    return locale;
}

#ifndef U_HIDE_INTERNAL_API
inline const char16_t*
DecimalFormatSymbols::getCurrencyPattern() const {
    return currPattern;
}
#endif /* U_HIDE_INTERNAL_API */

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_FORMATTING */

#endif /* U_SHOW_CPLUSPLUS_API */

#endif // _DCFMTSYM
//eof