ICU 59.1  59.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/unum.h"
38 #include "unicode/unistr.h"
39 
47 
88 public:
174  kFormatSymbolCount = kNineDigitSymbol + 2
175  };
176 
185  DecimalFormatSymbols(const Locale& locale, UErrorCode& status);
186 
198 
214  static DecimalFormatSymbols* createWithLastResortData(UErrorCode& status);
215 
221 
226  DecimalFormatSymbols& operator=(const DecimalFormatSymbols&);
227 
232  virtual ~DecimalFormatSymbols();
233 
241  UBool operator==(const DecimalFormatSymbols& other) const;
242 
250  UBool operator!=(const DecimalFormatSymbols& other) const { return !operator==(other); }
251 
261  inline UnicodeString getSymbol(ENumberFormatSymbol symbol) const;
262 
275  void setSymbol(ENumberFormatSymbol symbol, const UnicodeString &value, const UBool propogateDigits);
276 
281  inline Locale getLocale() const;
282 
288  Locale getLocale(ULocDataLocaleType type, UErrorCode& status) const;
289 
306  const UnicodeString& getPatternForCurrencySpacing(UCurrencySpacing type,
307  UBool beforeCurrency,
308  UErrorCode& status) const;
319  void setPatternForCurrencySpacing(UCurrencySpacing type,
320  UBool beforeCurrency,
321  const UnicodeString& pattern);
322 
328  virtual UClassID getDynamicClassID() const;
329 
335  static UClassID U_EXPORT2 getStaticClassID();
336 
337 private:
339 
350  void initialize(const Locale& locale, UErrorCode& success, UBool useLastResortData = FALSE);
351 
355  void initialize();
356 
357  void setCurrencyForSymbols();
358 
359 public:
360 
361 #ifndef U_HIDE_INTERNAL_API
362 
365  inline UBool isCustomCurrencySymbol() const {
366  return fIsCustomCurrencySymbol;
367  }
368 
373  return fIsCustomIntlCurrencySymbol;
374  }
375 #endif /* U_HIDE_INTERNAL_API */
376 
389  inline const UnicodeString &getConstSymbol(ENumberFormatSymbol symbol) const;
390 
391 #ifndef U_HIDE_INTERNAL_API
392 
396  inline const char16_t* getCurrencyPattern(void) const;
397 #endif /* U_HIDE_INTERNAL_API */
398 
399 private:
415  UnicodeString fSymbols[kFormatSymbolCount];
416 
421  UnicodeString fNoSymbol;
422 
423  Locale locale;
424 
425  char actualLocale[ULOC_FULLNAME_CAPACITY];
426  char validLocale[ULOC_FULLNAME_CAPACITY];
427  const char16_t* currPattern;
428 
429  UnicodeString currencySpcBeforeSym[UNUM_CURRENCY_SPACING_COUNT];
430  UnicodeString currencySpcAfterSym[UNUM_CURRENCY_SPACING_COUNT];
431  UBool fIsCustomCurrencySymbol;
432  UBool fIsCustomIntlCurrencySymbol;
433 };
434 
435 // -------------------------------------
436 
437 inline UnicodeString
439  const UnicodeString *strPtr;
440  if(symbol < kFormatSymbolCount) {
441  strPtr = &fSymbols[symbol];
442  } else {
443  strPtr = &fNoSymbol;
444  }
445  return *strPtr;
446 }
447 
448 // See comments above for this function. Not hidden with #ifndef U_HIDE_INTERNAL_API
449 inline const UnicodeString &
451  const UnicodeString *strPtr;
452  if(symbol < kFormatSymbolCount) {
453  strPtr = &fSymbols[symbol];
454  } else {
455  strPtr = &fNoSymbol;
456  }
457  return *strPtr;
458 }
459 
460 // -------------------------------------
461 
462 inline void
463 DecimalFormatSymbols::setSymbol(ENumberFormatSymbol symbol, const UnicodeString &value, const UBool propogateDigits = TRUE) {
464  if (symbol == kCurrencySymbol) {
465  fIsCustomCurrencySymbol = TRUE;
466  }
467  else if (symbol == kIntlCurrencySymbol) {
468  fIsCustomIntlCurrencySymbol = TRUE;
469  }
470  if(symbol<kFormatSymbolCount) {
471  fSymbols[symbol]=value;
472  }
473 
474  // If the zero digit is being set to a known zero digit according to Unicode,
475  // then we automatically set the corresponding 1-9 digits
476  if ( propogateDigits && symbol == kZeroDigitSymbol && value.countChar32() == 1 ) {
477  UChar32 sym = value.char32At(0);
478  if ( u_charDigitValue(sym) == 0 ) {
479  for ( int8_t i = 1 ; i<= 9 ; i++ ) {
480  sym++;
481  fSymbols[(int)kOneDigitSymbol+i-1] = UnicodeString(sym);
482  }
483  }
484  }
485 }
486 
487 // -------------------------------------
488 
489 inline Locale
491  return locale;
492 }
493 
494 #ifndef U_HIDE_INTERNAL_API
495 inline const char16_t*
497  return currPattern;
498 }
499 #endif /* U_HIDE_INTERNAL_API */
500 
502 
503 #endif /* #if !UCONFIG_NO_FORMATTING */
504 
505 #endif // _DCFMTSYM
506 //eof
UBool isCustomCurrencySymbol() const
Definition: dcfmtsym.h:365
This class represents the set of symbols needed by DecimalFormat to format numbers.
Definition: dcfmtsym.h:87
Escape padding character.
Definition: dcfmtsym.h:121
The international currency symbol.
Definition: dcfmtsym.h:113
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:490
const char16_t * getCurrencyPattern(void) const
Returns that pattern stored in currecy info.
Definition: dcfmtsym.h:496
UCurrencySpacing
Constants for specifying currency spacing.
Definition: unum.h:322
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:463
ENumberFormatSymbol
Constants for specifying a number format symbol.
Definition: dcfmtsym.h:93
#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:438
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:131
int32_t UChar32
Define UChar32 as a type for single Unicode code points.
Definition: umachine.h:396
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: Unicode Properties.
C++ API: Common ICU base class UObject.
UBool isCustomIntlCurrencySymbol() const
Definition: dcfmtsym.h:372
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:132
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:105
#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:296
Per mill symbol - replaces kPermillSymbol.
Definition: dcfmtsym.h:119
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
One more than the highest normal UCurrencySpacing value.
Definition: unum.h:336
UBool operator!=(const DecimalFormatSymbols &other) const
Return true if another object is semantically unequal to this one.
Definition: dcfmtsym.h:250
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:450
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: NumberFormat.
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:188