ICU 62.1  62.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 #include "unicode/uchar.h"
32 
33 #if !UCONFIG_NO_FORMATTING
34 
35 #include "unicode/uobject.h"
36 #include "unicode/locid.h"
37 #include "unicode/numsys.h"
38 #include "unicode/unum.h"
39 #include "unicode/unistr.h"
40 
48 
85 public:
171  kFormatSymbolCount = kNineDigitSymbol + 2
172  };
173 
182  DecimalFormatSymbols(const Locale& locale, UErrorCode& status);
183 
184 #ifndef U_HIDE_DRAFT_API
185 
201  DecimalFormatSymbols(const Locale& locale, const NumberingSystem& ns, UErrorCode& status);
202 #endif /* U_HIDE_DRAFT_API */
203 
215 
231  static DecimalFormatSymbols* createWithLastResortData(UErrorCode& status);
232 
238 
243  DecimalFormatSymbols& operator=(const DecimalFormatSymbols&);
244 
249  virtual ~DecimalFormatSymbols();
250 
258  UBool operator==(const DecimalFormatSymbols& other) const;
259 
267  UBool operator!=(const DecimalFormatSymbols& other) const { return !operator==(other); }
268 
278  inline UnicodeString getSymbol(ENumberFormatSymbol symbol) const;
279 
292  void setSymbol(ENumberFormatSymbol symbol, const UnicodeString &value, const UBool propogateDigits);
293 
298  inline Locale getLocale() const;
299 
305  Locale getLocale(ULocDataLocaleType type, UErrorCode& status) const;
306 
323  const UnicodeString& getPatternForCurrencySpacing(UCurrencySpacing type,
324  UBool beforeCurrency,
325  UErrorCode& status) const;
336  void setPatternForCurrencySpacing(UCurrencySpacing type,
337  UBool beforeCurrency,
338  const UnicodeString& pattern);
339 
345  virtual UClassID getDynamicClassID() const;
346 
352  static UClassID U_EXPORT2 getStaticClassID();
353 
354 private:
356 
369  void initialize(const Locale& locale, UErrorCode& success,
370  UBool useLastResortData = FALSE, const NumberingSystem* ns = nullptr);
371 
375  void initialize();
376 
377  void setCurrencyForSymbols();
378 
379 public:
380 
381 #ifndef U_HIDE_INTERNAL_API
382 
385  inline UBool isCustomCurrencySymbol() const {
386  return fIsCustomCurrencySymbol;
387  }
388 
393  return fIsCustomIntlCurrencySymbol;
394  }
395 
399  inline UChar32 getCodePointZero() const {
400  return fCodePointZero;
401  }
402 #endif /* U_HIDE_INTERNAL_API */
403 
419  inline const UnicodeString& getConstSymbol(ENumberFormatSymbol symbol) const;
420 
421 #ifndef U_HIDE_INTERNAL_API
422 
437  inline const UnicodeString& getConstDigitSymbol(int32_t digit) const;
438 
443  inline const char16_t* getCurrencyPattern(void) const;
444 #endif /* U_HIDE_INTERNAL_API */
445 
446 private:
462  UnicodeString fSymbols[kFormatSymbolCount];
463 
468  UnicodeString fNoSymbol;
469 
484  UChar32 fCodePointZero;
485 
486  Locale locale;
487 
488  char actualLocale[ULOC_FULLNAME_CAPACITY];
489  char validLocale[ULOC_FULLNAME_CAPACITY];
490  const char16_t* currPattern;
491 
492  UnicodeString currencySpcBeforeSym[UNUM_CURRENCY_SPACING_COUNT];
493  UnicodeString currencySpcAfterSym[UNUM_CURRENCY_SPACING_COUNT];
494  UBool fIsCustomCurrencySymbol;
495  UBool fIsCustomIntlCurrencySymbol;
496 };
497 
498 // -------------------------------------
499 
500 inline UnicodeString
502  const UnicodeString *strPtr;
503  if(symbol < kFormatSymbolCount) {
504  strPtr = &fSymbols[symbol];
505  } else {
506  strPtr = &fNoSymbol;
507  }
508  return *strPtr;
509 }
510 
511 // See comments above for this function. Not hidden with #ifdef U_HIDE_INTERNAL_API
512 inline const UnicodeString &
514  const UnicodeString *strPtr;
515  if(symbol < kFormatSymbolCount) {
516  strPtr = &fSymbols[symbol];
517  } else {
518  strPtr = &fNoSymbol;
519  }
520  return *strPtr;
521 }
522 
523 #ifndef U_HIDE_INTERNAL_API
524 inline const UnicodeString& DecimalFormatSymbols::getConstDigitSymbol(int32_t digit) const {
525  if (digit < 0 || digit > 9) {
526  digit = 0;
527  }
528  if (digit == 0) {
529  return fSymbols[kZeroDigitSymbol];
530  }
531  ENumberFormatSymbol key = static_cast<ENumberFormatSymbol>(kOneDigitSymbol + digit - 1);
532  return fSymbols[key];
533 }
534 #endif
535 
536 // -------------------------------------
537 
538 inline void
539 DecimalFormatSymbols::setSymbol(ENumberFormatSymbol symbol, const UnicodeString &value, const UBool propogateDigits = TRUE) {
540  if (symbol == kCurrencySymbol) {
541  fIsCustomCurrencySymbol = TRUE;
542  }
543  else if (symbol == kIntlCurrencySymbol) {
544  fIsCustomIntlCurrencySymbol = TRUE;
545  }
546  if(symbol<kFormatSymbolCount) {
547  fSymbols[symbol]=value;
548  }
549 
550  // If the zero digit is being set to a known zero digit according to Unicode,
551  // then we automatically set the corresponding 1-9 digits
552  // Also record updates to fCodePointZero. Be conservative if in doubt.
553  if (symbol == kZeroDigitSymbol) {
554  UChar32 sym = value.char32At(0);
555  if ( propogateDigits && u_charDigitValue(sym) == 0 && value.countChar32() == 1 ) {
556  fCodePointZero = sym;
557  for ( int8_t i = 1 ; i<= 9 ; i++ ) {
558  sym++;
559  fSymbols[(int)kOneDigitSymbol+i-1] = UnicodeString(sym);
560  }
561  } else {
562  fCodePointZero = -1;
563  }
564  } else if (symbol >= kOneDigitSymbol && symbol <= kNineDigitSymbol) {
565  fCodePointZero = -1;
566  }
567 }
568 
569 // -------------------------------------
570 
571 inline Locale
573  return locale;
574 }
575 
576 #ifndef U_HIDE_INTERNAL_API
577 inline const char16_t*
579  return currPattern;
580 }
581 #endif /* U_HIDE_INTERNAL_API */
582 
584 
585 #endif /* #if !UCONFIG_NO_FORMATTING */
586 
587 #endif // _DCFMTSYM
588 //eof
UBool isCustomCurrencySymbol() const
Definition: dcfmtsym.h:385
This class represents the set of symbols needed by DecimalFormat to format numbers.
Definition: dcfmtsym.h:84
Escape padding character.
Definition: dcfmtsym.h:118
The international currency symbol.
Definition: dcfmtsym.h:110
C++ API: Unicode String.
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
Locale getLocale() const
Returns the locale for which this object was constructed.
Definition: dcfmtsym.h:572
const char16_t * getCurrencyPattern(void) const
Returns that pattern stored in currecy info.
Definition: dcfmtsym.h:578
Defines numbering systems.
Definition: numsys.h:60
UCurrencySpacing
Constants for specifying currency spacing.
Definition: unum.h:331
void * UClassID
UClassID is used to identify classes without using the compiler&#39;s RTTI.
Definition: uobject.h:93
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
void setSymbol(ENumberFormatSymbol symbol, const UnicodeString &value, const UBool propogateDigits)
Set one of the format symbols by its enum constant.
Definition: dcfmtsym.h:539
UChar32 getCodePointZero() const
Definition: dcfmtsym.h:399
ENumberFormatSymbol
Constants for specifying a number format symbol.
Definition: dcfmtsym.h:90
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:360
UnicodeString getSymbol(ENumberFormatSymbol symbol) const
Get one of the format symbols by its enum constant.
Definition: dcfmtsym.h:501
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:137
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition: umachine.h:400
virtual UClassID getDynamicClassID() const
ICU4C "poor man&#39;s RTTI", returns a UClassID for the actual ICU class.
#define TRUE
The TRUE value of a UBool.
Definition: umachine.h:240
C++ API: NumberingSystem object.
C API: Unicode Properties.
C++ API: Common ICU base class UObject.
UBool isCustomIntlCurrencySymbol() const
Definition: dcfmtsym.h:392
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:138
const UnicodeString & getConstDigitSymbol(int32_t digit) const
Returns the const UnicodeString reference, like getConstSymbol, corresponding to the digit with the g...
Definition: dcfmtsym.h:524
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:396
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested...
Definition: uloc.h:338
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.
Basic definitions for ICU, for both C and C++ APIs.
Character representing a digit in the pattern.
Definition: dcfmtsym.h:102
#define FALSE
The FALSE value of a UBool.
Definition: umachine.h:244
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:286
Per mill symbol - replaces kPermillSymbol.
Definition: dcfmtsym.h:116
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
One more than the highest normal UCurrencySpacing value.
Definition: unum.h:345
UBool operator!=(const DecimalFormatSymbols &other) const
Return true if another object is semantically unequal to this one.
Definition: dcfmtsym.h:267
const UnicodeString & getConstSymbol(ENumberFormatSymbol symbol) const
Internal function - more efficient version of getSymbol, returning a const reference to one of the sy...
Definition: dcfmtsym.h:513
UChar32 char32At(int32_t offset) const
Return the code point that contains the code unit at offset offset.
int8_t UBool
The ICU boolean type.
Definition: umachine.h:236
C API: Compatibility APIs for number formatting.
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:188