ICU 69.1 69.1
dcfmtsym.h
Go to the documentation of this file.
1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4********************************************************************************
5* Copyright (C) 1997-2016, International Business Machines
6* Corporation and others. All Rights Reserved.
7********************************************************************************
8*
9* File DCFMTSYM.H
10*
11* Modification History:
12*
13* Date Name Description
14* 02/19/97 aliu Converted from java.
15* 03/18/97 clhuang Updated per C++ implementation.
16* 03/27/97 helena Updated to pass the simple test after code review.
17* 08/26/97 aliu Added currency/intl currency symbol support.
18* 07/22/98 stephen Changed to match C++ style
19* currencySymbol -> fCurrencySymbol
20* Constants changed from CAPS to kCaps
21* 06/24/99 helena Integrated Alan's NF enhancements and Java2 bug fixes
22* 09/22/00 grhoten Marked deprecation tags with a pointer to replacement
23* functions.
24********************************************************************************
25*/
26
27#ifndef DCFMTSYM_H
28#define DCFMTSYM_H
29
30#include "unicode/utypes.h"
31
32#if U_SHOW_CPLUSPLUS_API
33
34#if !UCONFIG_NO_FORMATTING
35
36#include "unicode/uchar.h"
37#include "unicode/uobject.h"
38#include "unicode/locid.h"
39#include "unicode/numsys.h"
40#include "unicode/unum.h"
41#include "unicode/unistr.h"
42
49U_NAMESPACE_BEGIN
50
87public:
175
185
203
215
232
238
244
250
259
268
278 inline UnicodeString getSymbol(ENumberFormatSymbol symbol) const;
279
292 void setSymbol(ENumberFormatSymbol symbol, const UnicodeString &value, const UBool propogateDigits);
293
294#ifndef U_HIDE_INTERNAL_API
302 void setCurrency(const UChar* currency, UErrorCode& status);
303#endif // U_HIDE_INTERNAL_API
304
309 inline Locale getLocale() const;
310
317
336 UErrorCode& status) const;
349 const UnicodeString& pattern);
350
357
364
365private:
367
380 void initialize(const Locale& locale, UErrorCode& success,
381 UBool useLastResortData = false, const NumberingSystem* ns = nullptr);
382
386 void initialize();
387
388public:
389
390#ifndef U_HIDE_INTERNAL_API
395 return fIsCustomCurrencySymbol;
396 }
397
402 return fIsCustomIntlCurrencySymbol;
403 }
404
408 inline UChar32 getCodePointZero() const {
409 return fCodePointZero;
410 }
411#endif /* U_HIDE_INTERNAL_API */
412
428 inline const UnicodeString& getConstSymbol(ENumberFormatSymbol symbol) const;
429
430#ifndef U_HIDE_INTERNAL_API
446 inline const UnicodeString& getConstDigitSymbol(int32_t digit) const;
447
452 inline const char16_t* getCurrencyPattern(void) const;
453#endif /* U_HIDE_INTERNAL_API */
454
455private:
470 UnicodeString fSymbols[kFormatSymbolCount];
471
475 UnicodeString fNoSymbol;
476
491 UChar32 fCodePointZero;
492
493 Locale locale;
494
495 char actualLocale[ULOC_FULLNAME_CAPACITY];
496 char validLocale[ULOC_FULLNAME_CAPACITY];
497 const char16_t* currPattern;
498
499 UnicodeString currencySpcBeforeSym[UNUM_CURRENCY_SPACING_COUNT];
500 UnicodeString currencySpcAfterSym[UNUM_CURRENCY_SPACING_COUNT];
501 UBool fIsCustomCurrencySymbol;
502 UBool fIsCustomIntlCurrencySymbol;
503};
504
505// -------------------------------------
506
507inline UnicodeString
508DecimalFormatSymbols::getSymbol(ENumberFormatSymbol symbol) const {
509 const UnicodeString *strPtr;
510 if(symbol < kFormatSymbolCount) {
511 strPtr = &fSymbols[symbol];
512 } else {
513 strPtr = &fNoSymbol;
514 }
515 return *strPtr;
516}
517
518// See comments above for this function. Not hidden with #ifdef U_HIDE_INTERNAL_API
519inline const UnicodeString &
520DecimalFormatSymbols::getConstSymbol(ENumberFormatSymbol symbol) const {
521 const UnicodeString *strPtr;
522 if(symbol < kFormatSymbolCount) {
523 strPtr = &fSymbols[symbol];
524 } else {
525 strPtr = &fNoSymbol;
526 }
527 return *strPtr;
528}
529
530#ifndef U_HIDE_INTERNAL_API
531inline const UnicodeString& DecimalFormatSymbols::getConstDigitSymbol(int32_t digit) const {
532 if (digit < 0 || digit > 9) {
533 digit = 0;
534 }
535 if (digit == 0) {
536 return fSymbols[kZeroDigitSymbol];
537 }
538 ENumberFormatSymbol key = static_cast<ENumberFormatSymbol>(kOneDigitSymbol + digit - 1);
539 return fSymbols[key];
540}
541#endif /* U_HIDE_INTERNAL_API */
542
543// -------------------------------------
544
545inline void
546DecimalFormatSymbols::setSymbol(ENumberFormatSymbol symbol, const UnicodeString &value, const UBool propagateDigits = true) {
547 if (symbol == kCurrencySymbol) {
548 fIsCustomCurrencySymbol = true;
549 }
550 else if (symbol == kIntlCurrencySymbol) {
551 fIsCustomIntlCurrencySymbol = true;
552 }
553 if(symbol<kFormatSymbolCount) {
554 fSymbols[symbol]=value;
555 }
556
557 // If the zero digit is being set to a known zero digit according to Unicode,
558 // then we automatically set the corresponding 1-9 digits
559 // Also record updates to fCodePointZero. Be conservative if in doubt.
560 if (symbol == kZeroDigitSymbol) {
561 UChar32 sym = value.char32At(0);
562 if ( propagateDigits && u_charDigitValue(sym) == 0 && value.countChar32() == 1 ) {
563 fCodePointZero = sym;
564 for ( int8_t i = 1 ; i<= 9 ; i++ ) {
565 sym++;
566 fSymbols[(int)kOneDigitSymbol+i-1] = UnicodeString(sym);
567 }
568 } else {
569 fCodePointZero = -1;
570 }
571 } else if (symbol >= kOneDigitSymbol && symbol <= kNineDigitSymbol) {
572 fCodePointZero = -1;
573 }
574}
575
576// -------------------------------------
577
578inline Locale
579DecimalFormatSymbols::getLocale() const {
580 return locale;
581}
582
583#ifndef U_HIDE_INTERNAL_API
584inline const char16_t*
585DecimalFormatSymbols::getCurrencyPattern() const {
586 return currPattern;
587}
588#endif /* U_HIDE_INTERNAL_API */
589
591
592#endif /* #if !UCONFIG_NO_FORMATTING */
593
594#endif /* U_SHOW_CPLUSPLUS_API */
595
596#endif // _DCFMTSYM
597//eof
This class represents the set of symbols needed by DecimalFormat to format numbers.
Definition dcfmtsym.h:86
void setPatternForCurrencySpacing(UCurrencySpacing type, UBool beforeCurrency, const UnicodeString &pattern)
Set pattern string for 'CurrencySpacing' that can be applied to currency format.
UBool isCustomCurrencySymbol() const
Definition dcfmtsym.h:394
virtual ~DecimalFormatSymbols()
Destructor.
virtual UClassID getDynamicClassID() const
ICU "poor man's RTTI", returns a UClassID for the actual class.
ENumberFormatSymbol
Constants for specifying a number format symbol.
Definition dcfmtsym.h:92
@ kDecimalSeparatorSymbol
The decimal separator.
Definition dcfmtsym.h:94
@ kPlusSignSymbol
The plus sign.
Definition dcfmtsym.h:108
@ kMinusSignSymbol
The minus sign.
Definition dcfmtsym.h:106
@ kExponentMultiplicationSymbol
Multiplication sign.
Definition dcfmtsym.h:171
@ kInfinitySymbol
Infinity symbol.
Definition dcfmtsym.h:122
@ kExponentialSymbol
The exponential symbol.
Definition dcfmtsym.h:116
@ kPerMillSymbol
Per mill symbol - replaces kPermillSymbol.
Definition dcfmtsym.h:118
@ kPatternSeparatorSymbol
The pattern separator.
Definition dcfmtsym.h:98
@ kCurrencySymbol
The currency symbol.
Definition dcfmtsym.h:110
@ kSignificantDigitSymbol
Significant digit symbol.
Definition dcfmtsym.h:127
@ kIntlCurrencySymbol
The international currency symbol.
Definition dcfmtsym.h:112
@ kMonetaryGroupingSeparatorSymbol
The monetary grouping separator.
Definition dcfmtsym.h:131
@ kPadEscapeSymbol
Escape padding character.
Definition dcfmtsym.h:120
@ kPercentSymbol
The percent sign.
Definition dcfmtsym.h:100
@ kNaNSymbol
Nan symbol.
Definition dcfmtsym.h:124
@ kDigitSymbol
Character representing a digit in the pattern.
Definition dcfmtsym.h:104
@ kMonetarySeparatorSymbol
The monetary separator.
Definition dcfmtsym.h:114
@ kGroupingSeparatorSymbol
The grouping separator.
Definition dcfmtsym.h:96
UBool operator!=(const DecimalFormatSymbols &other) const
Return true if another object is semantically unequal to this one.
Definition dcfmtsym.h:267
Locale getLocale(ULocDataLocaleType type, UErrorCode &status) const
Returns the locale for this object.
static UClassID getStaticClassID()
ICU "poor man's RTTI", returns a UClassID for this class.
DecimalFormatSymbols(UErrorCode &status)
Create a DecimalFormatSymbols object for the default locale.
const UnicodeString & getPatternForCurrencySpacing(UCurrencySpacing type, UBool beforeCurrency, UErrorCode &status) const
Get pattern string for 'CurrencySpacing' that can be applied to currency format.
DecimalFormatSymbols(const Locale &locale, UErrorCode &status)
Create a DecimalFormatSymbols object for the given locale.
DecimalFormatSymbols(const DecimalFormatSymbols &)
Copy constructor.
UChar32 getCodePointZero() const
Definition dcfmtsym.h:408
UBool operator==(const DecimalFormatSymbols &other) const
Return true if another object is semantically equal to this one.
DecimalFormatSymbols & operator=(const DecimalFormatSymbols &)
Assignment operator.
static DecimalFormatSymbols * createWithLastResortData(UErrorCode &status)
Creates a DecimalFormatSymbols object with last-resort data.
DecimalFormatSymbols(const Locale &locale, const NumberingSystem &ns, UErrorCode &status)
Creates a DecimalFormatSymbols instance for the given locale with digits and symbols corresponding to...
UBool isCustomIntlCurrencySymbol() const
Definition dcfmtsym.h:401
void setCurrency(const UChar *currency, UErrorCode &status)
Loads symbols for the specified currency into this instance.
"Smart pointer" base class; do not use directly: use LocalPointer etc.
A Locale object represents a specific geographical, political, or cultural region.
Definition locid.h:195
Defines numbering systems.
Definition numsys.h:60
UObject is the common ICU "boilerplate" class.
Definition uobject.h:223
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition unistr.h:296
UChar32 char32At(int32_t offset) const
Return the code point that contains the code unit at offset offset.
int32_t countChar32(int32_t start=0, int32_t length=INT32_MAX) const
Count Unicode code points in the length char16_t code units of the string.
C++ API: Locale ID object.
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
C++ API: NumberingSystem object.
C API: Unicode Properties.
U_CAPI int32_t u_charDigitValue(UChar32 c)
Returns the decimal digit value of a decimal digit character.
#define ULOC_FULLNAME_CAPACITY
Useful constant for the maximum size of the whole locale ID (including the terminating NULL and all k...
Definition uloc.h:264
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested,...
Definition uloc.h:338
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition umachine.h:467
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition umachine.h:269
char16_t UChar
The base type for UTF-16 code units and pointers.
Definition umachine.h:418
C++ API: Unicode String.
C API: Compatibility APIs for number formatting.
UCurrencySpacing
Constants for specifying currency spacing.
Definition unum.h:351
@ UNUM_CURRENCY_SPACING_COUNT
One more than the highest normal UCurrencySpacing value.
Definition unum.h:366
C++ API: Common ICU base class UObject.
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition uobject.h:96
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition utypes.h:415
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition utypes.h:301