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
43 /**
44 * \file
45 * \brief C++ API: Symbols for formatting numbers.
46 */
47
48
49 U_NAMESPACE_BEGIN
50
51 /**
52 * This class represents the set of symbols needed by DecimalFormat
53 * to format numbers. DecimalFormat creates for itself an instance of
54 * DecimalFormatSymbols from its locale data. If you need to change any
55 * of these symbols, you can get the DecimalFormatSymbols object from
56 * your DecimalFormat and modify it.
57 * <P>
58 * Here are the special characters used in the parts of the
59 * subpattern, with notes on their usage.
60 * <pre>
61 * \code
62 * Symbol Meaning
63 * 0 a digit
64 * # a digit, zero shows as absent
65 * . placeholder for decimal separator
66 * , placeholder for grouping separator.
67 * ; separates formats.
68 * - default negative prefix.
69 * % divide by 100 and show as percentage
70 * X any other characters can be used in the prefix or suffix
71 * ' used to quote special characters in a prefix or suffix.
72 * \endcode
73 * </pre>
74 * [Notes]
75 * <P>
76 * If there is no explicit negative subpattern, - is prefixed to the
77 * positive form. That is, "0.00" alone is equivalent to "0.00;-0.00".
78 * <P>
79 * The grouping separator is commonly used for thousands, but in some
80 * countries for ten-thousands. The interval is a constant number of
81 * digits between the grouping characters, such as 100,000,000 or 1,0000,0000.
82 * If you supply a pattern with multiple grouping characters, the interval
83 * between the last one and the end of the integer is the one that is
84 * used. So "#,##,###,####" == "######,####" == "##,####,####".
85 */
86 class U_I18N_API DecimalFormatSymbols : public UObject {
87 public:
88 /**
89 * Constants for specifying a number format symbol.
90 * @stable ICU 2.0
91 */
92 enum ENumberFormatSymbol {
93 /** The decimal separator */
94 kDecimalSeparatorSymbol,
95 /** The grouping separator */
96 kGroupingSeparatorSymbol,
97 /** The pattern separator */
98 kPatternSeparatorSymbol,
99 /** The percent sign */
100 kPercentSymbol,
101 /** Zero*/
102 kZeroDigitSymbol,
103 /** Character representing a digit in the pattern */
104 kDigitSymbol,
105 /** The minus sign */
106 kMinusSignSymbol,
107 /** The plus sign */
108 kPlusSignSymbol,
109 /** The currency symbol */
110 kCurrencySymbol,
111 /** The international currency symbol */
112 kIntlCurrencySymbol,
113 /** The monetary separator */
114 kMonetarySeparatorSymbol,
115 /** The exponential symbol */
116 kExponentialSymbol,
117 /** Per mill symbol - replaces kPermillSymbol */
118 kPerMillSymbol,
119 /** Escape padding character */
120 kPadEscapeSymbol,
121 /** Infinity symbol */
122 kInfinitySymbol,
123 /** Nan symbol */
124 kNaNSymbol,
125 /** Significant digit symbol
126 * @stable ICU 3.0 */
127 kSignificantDigitSymbol,
128 /** The monetary grouping separator
129 * @stable ICU 3.6
130 */
131 kMonetaryGroupingSeparatorSymbol,
132 /** One
133 * @stable ICU 4.6
134 */
135 kOneDigitSymbol,
136 /** Two
137 * @stable ICU 4.6
138 */
139 kTwoDigitSymbol,
140 /** Three
141 * @stable ICU 4.6
142 */
143 kThreeDigitSymbol,
144 /** Four
145 * @stable ICU 4.6
146 */
147 kFourDigitSymbol,
148 /** Five
149 * @stable ICU 4.6
150 */
151 kFiveDigitSymbol,
152 /** Six
153 * @stable ICU 4.6
154 */
155 kSixDigitSymbol,
156 /** Seven
157 * @stable ICU 4.6
158 */
159 kSevenDigitSymbol,
160 /** Eight
161 * @stable ICU 4.6
162 */
163 kEightDigitSymbol,
164 /** Nine
165 * @stable ICU 4.6
166 */
167 kNineDigitSymbol,
168 /** Multiplication sign.
169 * @stable ICU 54
170 */
171 kExponentMultiplicationSymbol,
172 #ifndef U_HIDE_INTERNAL_API
173 /** Approximately sign.
174 * @internal
175 */
176 kApproximatelySignSymbol,
177 #endif /* U_HIDE_INTERNAL_API */
178 /** count symbol constants */
179 kFormatSymbolCount = kExponentMultiplicationSymbol + 2
180 };
181
182 /**
183 * Create a DecimalFormatSymbols object for the given locale.
184 *
185 * @param locale The locale to get symbols for.
186 * @param status Input/output parameter, set to success or
187 * failure code upon return.
188 * @stable ICU 2.0
189 */
190 DecimalFormatSymbols(const Locale& locale, UErrorCode& status);
191
192 /**
193 * Creates a DecimalFormatSymbols instance for the given locale with digits and symbols
194 * corresponding to the given NumberingSystem.
195 *
196 * This constructor behaves equivalently to the normal constructor called with a locale having a
197 * "numbers=xxxx" keyword specifying the numbering system by name.
198 *
199 * In this constructor, the NumberingSystem argument will be used even if the locale has its own
200 * "numbers=xxxx" keyword.
201 *
202 * @param locale The locale to get symbols for.
203 * @param ns The numbering system.
204 * @param status Input/output parameter, set to success or
205 * failure code upon return.
206 * @stable ICU 60
207 */
208 DecimalFormatSymbols(const Locale& locale, const NumberingSystem& ns, UErrorCode& status);
209
210 /**
211 * Create a DecimalFormatSymbols object for the default locale.
212 * This constructor will not fail. If the resource file data is
213 * not available, it will use hard-coded last-resort data and
214 * set status to U_USING_FALLBACK_ERROR.
215 *
216 * @param status Input/output parameter, set to success or
217 * failure code upon return.
218 * @stable ICU 2.0
219 */
220 DecimalFormatSymbols(UErrorCode& status);
221
222 /**
223 * Creates a DecimalFormatSymbols object with last-resort data.
224 * Intended for callers who cache the symbols data and
225 * set all symbols on the resulting object.
226 *
227 * The last-resort symbols are similar to those for the root data,
228 * except that the grouping separators are empty,
229 * the NaN symbol is U+FFFD rather than "NaN",
230 * and the CurrencySpacing patterns are empty.
231 *
232 * @param status Input/output parameter, set to success or
233 * failure code upon return.
234 * @return last-resort symbols
235 * @stable ICU 52
236 */
237 static DecimalFormatSymbols* createWithLastResortData(UErrorCode& status);
238
239 /**
240 * Copy constructor.
241 * @stable ICU 2.0
242 */
243 DecimalFormatSymbols(const DecimalFormatSymbols&);
244
245 /**
246 * Assignment operator.
247 * @stable ICU 2.0
248 */
249 DecimalFormatSymbols& operator=(const DecimalFormatSymbols&);
250
251 /**
252 * Destructor.
253 * @stable ICU 2.0
254 */
255 virtual ~DecimalFormatSymbols();
256
257 /**
258 * Return true if another object is semantically equal to this one.
259 *
260 * @param other the object to be compared with.
261 * @return true if another object is semantically equal to this one.
262 * @stable ICU 2.0
263 */
264 bool operator==(const DecimalFormatSymbols& other) const;
265
266 /**
267 * Return true if another object is semantically unequal to this one.
268 *
269 * @param other the object to be compared with.
270 * @return true if another object is semantically unequal to this one.
271 * @stable ICU 2.0
272 */
273 bool operator!=(const DecimalFormatSymbols& other) const { return !operator==(other); }
274
275 /**
276 * Get one of the format symbols by its enum constant.
277 * Each symbol is stored as a string so that graphemes
278 * (characters with modifier letters) can be used.
279 *
280 * @param symbol Constant to indicate a number format symbol.
281 * @return the format symbols by the param 'symbol'
282 * @stable ICU 2.0
283 */
284 inline UnicodeString getSymbol(ENumberFormatSymbol symbol) const;
285
286 /**
287 * Set one of the format symbols by its enum constant.
288 * Each symbol is stored as a string so that graphemes
289 * (characters with modifier letters) can be used.
290 *
291 * @param symbol Constant to indicate a number format symbol.
292 * @param value value of the format symbol
293 * @param propagateDigits If false, setting the zero digit will not automatically set 1-9.
294 * The default behavior is to automatically set 1-9 if zero is being set and the value
295 * it is being set to corresponds to a known Unicode zero digit.
296 * @stable ICU 2.0
297 */
298 void setSymbol(ENumberFormatSymbol symbol, const UnicodeString &value, const UBool propagateDigits);
299
300 #ifndef U_HIDE_INTERNAL_API
301 /**
302 * Loads symbols for the specified currency into this instance.
303 *
304 * This method is internal. If you think it should be public, file a ticket.
305 *
306 * @internal
307 */
308 void setCurrency(const UChar* currency, UErrorCode& status);
309 #endif // U_HIDE_INTERNAL_API
310
311 /**
312 * Returns the locale for which this object was constructed.
313 * @stable ICU 2.6
314 */
315 inline Locale getLocale() const;
316
317 /**
318 * Returns the locale for this object. Two flavors are available:
319 * valid and actual locale.
320 * @stable ICU 2.8
321 */
322 Locale getLocale(ULocDataLocaleType type, UErrorCode& status) const;
323
324 /**
325 * Get pattern string for 'CurrencySpacing' that can be applied to
326 * currency format.
327 * This API gets the CurrencySpacing data from ResourceBundle. The pattern can
328 * be empty if there is no data from current locale and its parent locales.
329 *
330 * @param type : UNUM_CURRENCY_MATCH, UNUM_CURRENCY_SURROUNDING_MATCH or UNUM_CURRENCY_INSERT.
331 * @param beforeCurrency : true if the pattern is for before currency symbol.
332 * false if the pattern is for after currency symbol.
333 * @param status: Input/output parameter, set to success or
334 * failure code upon return.
335 * @return pattern string for currencyMatch, surroundingMatch or spaceInsert.
336 * Return empty string if there is no data for this locale and its parent
337 * locales.
338 * @stable ICU 4.8
339 */
340 const UnicodeString& getPatternForCurrencySpacing(UCurrencySpacing type,
341 UBool beforeCurrency,
342 UErrorCode& status) const;
343 /**
344 * Set pattern string for 'CurrencySpacing' that can be applied to
345 * currency format.
346 *
347 * @param type : UNUM_CURRENCY_MATCH, UNUM_CURRENCY_SURROUNDING_MATCH or UNUM_CURRENCY_INSERT.
348 * @param beforeCurrency : true if the pattern is for before currency symbol.
349 * false if the pattern is for after currency symbol.
350 * @param pattern : pattern string to override current setting.
351 * @stable ICU 4.8
352 */
353 void setPatternForCurrencySpacing(UCurrencySpacing type,
354 UBool beforeCurrency,
355 const UnicodeString& pattern);
356
357 /**
358 * ICU "poor man's RTTI", returns a UClassID for the actual class.
359 *
360 * @stable ICU 2.2
361 */
362 virtual UClassID getDynamicClassID() const override;
363
364 /**
365 * ICU "poor man's RTTI", returns a UClassID for this class.
366 *
367 * @stable ICU 2.2
368 */
369 static UClassID U_EXPORT2 getStaticClassID();
370
371 private:
372 DecimalFormatSymbols();
373
374 /**
375 * Initializes the symbols from the LocaleElements resource bundle.
376 * Note: The organization of LocaleElements badly needs to be
377 * cleaned up.
378 *
379 * @param locale The locale to get symbols for.
380 * @param success Input/output parameter, set to success or
381 * failure code upon return.
382 * @param useLastResortData determine if use last resort data
383 * @param ns The NumberingSystem to use; otherwise, fall
384 * back to the locale.
385 */
386 void initialize(const Locale& locale, UErrorCode& success,
387 UBool useLastResortData = false, const NumberingSystem* ns = nullptr);
388
389 /**
390 * Initialize the symbols with default values.
391 */
392 void initialize();
393
394 public:
395
396 #ifndef U_HIDE_INTERNAL_API
397 /**
398 * @internal For ICU use only
399 */
isCustomCurrencySymbol()400 inline UBool isCustomCurrencySymbol() const {
401 return fIsCustomCurrencySymbol;
402 }
403
404 /**
405 * @internal For ICU use only
406 */
isCustomIntlCurrencySymbol()407 inline UBool isCustomIntlCurrencySymbol() const {
408 return fIsCustomIntlCurrencySymbol;
409 }
410
411 /**
412 * @internal For ICU use only
413 */
getCodePointZero()414 inline UChar32 getCodePointZero() const {
415 return fCodePointZero;
416 }
417 #endif /* U_HIDE_INTERNAL_API */
418
419 /**
420 * _Internal_ function - more efficient version of getSymbol,
421 * returning a const reference to one of the symbol strings.
422 * The returned reference becomes invalid when the symbol is changed
423 * or when the DecimalFormatSymbols are destroyed.
424 * Note: moved \#ifndef U_HIDE_INTERNAL_API after this, since this is needed for inline in DecimalFormat
425 *
426 * This is not currently stable API, but if you think it should be stable,
427 * post a comment on the following ticket and the ICU team will take a look:
428 * https://unicode-org.atlassian.net/browse/ICU-13580
429 *
430 * @param symbol Constant to indicate a number format symbol.
431 * @return the format symbol by the param 'symbol'
432 * @internal
433 */
434 inline const UnicodeString& getConstSymbol(ENumberFormatSymbol symbol) const;
435
436 #ifndef U_HIDE_INTERNAL_API
437 /**
438 * Returns the const UnicodeString reference, like getConstSymbol,
439 * corresponding to the digit with the given value. This is equivalent
440 * to accessing the symbol from getConstSymbol with the corresponding
441 * key, such as kZeroDigitSymbol or kOneDigitSymbol.
442 *
443 * This is not currently stable API, but if you think it should be stable,
444 * post a comment on the following ticket and the ICU team will take a look:
445 * https://unicode-org.atlassian.net/browse/ICU-13580
446 *
447 * @param digit The digit, an integer between 0 and 9 inclusive.
448 * If outside the range 0 to 9, the zero digit is returned.
449 * @return the format symbol for the given digit.
450 * @internal This API is currently for ICU use only.
451 */
452 inline const UnicodeString& getConstDigitSymbol(int32_t digit) const;
453
454 /**
455 * Returns that pattern stored in currency info. Internal API for use by NumberFormat API.
456 * @internal
457 */
458 inline const char16_t* getCurrencyPattern(void) const;
459 #endif /* U_HIDE_INTERNAL_API */
460
461 private:
462 /**
463 * Private symbol strings.
464 * They are either loaded from a resource bundle or otherwise owned.
465 * setSymbol() clones the symbol string.
466 * Readonly aliases can only come from a resource bundle, so that we can always
467 * use fastCopyFrom() with them.
468 *
469 * If DecimalFormatSymbols becomes subclassable and the status of fSymbols changes
470 * from private to protected,
471 * or when fSymbols can be set any other way that allows them to be readonly aliases
472 * to non-resource bundle strings,
473 * then regular UnicodeString copies must be used instead of fastCopyFrom().
474 *
475 */
476 UnicodeString fSymbols[kFormatSymbolCount];
477
478 /**
479 * Non-symbol variable for getConstSymbol(). Always empty.
480 */
481 UnicodeString fNoSymbol;
482
483 /**
484 * Dealing with code points is faster than dealing with strings when formatting. Because of
485 * this, we maintain a value containing the zero code point that is used whenever digitStrings
486 * represents a sequence of ten code points in order.
487 *
488 * <p>If the value stored here is positive, it means that the code point stored in this value
489 * corresponds to the digitStrings array, and codePointZero can be used instead of the
490 * digitStrings array for the purposes of efficient formatting; if -1, then digitStrings does
491 * *not* contain a sequence of code points, and it must be used directly.
492 *
493 * <p>It is assumed that codePointZero always shadows the value in digitStrings. codePointZero
494 * should never be set directly; rather, it should be updated only when digitStrings mutates.
495 * That is, the flow of information is digitStrings -> codePointZero, not the other way.
496 */
497 UChar32 fCodePointZero;
498
499 Locale locale;
500
501 char actualLocale[ULOC_FULLNAME_CAPACITY];
502 char validLocale[ULOC_FULLNAME_CAPACITY];
503 const char16_t* currPattern;
504
505 UnicodeString currencySpcBeforeSym[UNUM_CURRENCY_SPACING_COUNT];
506 UnicodeString currencySpcAfterSym[UNUM_CURRENCY_SPACING_COUNT];
507 UBool fIsCustomCurrencySymbol;
508 UBool fIsCustomIntlCurrencySymbol;
509 };
510
511 // -------------------------------------
512
513 inline UnicodeString
getSymbol(ENumberFormatSymbol symbol)514 DecimalFormatSymbols::getSymbol(ENumberFormatSymbol symbol) const {
515 const UnicodeString *strPtr;
516 if(symbol < kFormatSymbolCount) {
517 strPtr = &fSymbols[symbol];
518 } else {
519 strPtr = &fNoSymbol;
520 }
521 return *strPtr;
522 }
523
524 // See comments above for this function. Not hidden with #ifdef U_HIDE_INTERNAL_API
525 inline const UnicodeString &
getConstSymbol(ENumberFormatSymbol symbol)526 DecimalFormatSymbols::getConstSymbol(ENumberFormatSymbol symbol) const {
527 const UnicodeString *strPtr;
528 if(symbol < kFormatSymbolCount) {
529 strPtr = &fSymbols[symbol];
530 } else {
531 strPtr = &fNoSymbol;
532 }
533 return *strPtr;
534 }
535
536 #ifndef U_HIDE_INTERNAL_API
getConstDigitSymbol(int32_t digit)537 inline const UnicodeString& DecimalFormatSymbols::getConstDigitSymbol(int32_t digit) const {
538 if (digit < 0 || digit > 9) {
539 digit = 0;
540 }
541 if (digit == 0) {
542 return fSymbols[kZeroDigitSymbol];
543 }
544 ENumberFormatSymbol key = static_cast<ENumberFormatSymbol>(kOneDigitSymbol + digit - 1);
545 return fSymbols[key];
546 }
547 #endif /* U_HIDE_INTERNAL_API */
548
549 // -------------------------------------
550
551 inline void
552 DecimalFormatSymbols::setSymbol(ENumberFormatSymbol symbol, const UnicodeString &value, const UBool propagateDigits = true) {
553 if (symbol == kCurrencySymbol) {
554 fIsCustomCurrencySymbol = true;
555 }
556 else if (symbol == kIntlCurrencySymbol) {
557 fIsCustomIntlCurrencySymbol = true;
558 }
559 if(symbol<kFormatSymbolCount) {
560 fSymbols[symbol]=value;
561 }
562
563 // If the zero digit is being set to a known zero digit according to Unicode,
564 // then we automatically set the corresponding 1-9 digits
565 // Also record updates to fCodePointZero. Be conservative if in doubt.
566 if (symbol == kZeroDigitSymbol) {
567 UChar32 sym = value.char32At(0);
568 if ( propagateDigits && u_charDigitValue(sym) == 0 && value.countChar32() == 1 ) {
569 fCodePointZero = sym;
570 for ( int8_t i = 1 ; i<= 9 ; i++ ) {
571 sym++;
572 fSymbols[(int)kOneDigitSymbol+i-1] = UnicodeString(sym);
573 }
574 } else {
575 fCodePointZero = -1;
576 }
577 } else if (symbol >= kOneDigitSymbol && symbol <= kNineDigitSymbol) {
578 fCodePointZero = -1;
579 }
580 }
581
582 // -------------------------------------
583
584 inline Locale
getLocale()585 DecimalFormatSymbols::getLocale() const {
586 return locale;
587 }
588
589 #ifndef U_HIDE_INTERNAL_API
590 inline const char16_t*
getCurrencyPattern()591 DecimalFormatSymbols::getCurrencyPattern() const {
592 return currPattern;
593 }
594 #endif /* U_HIDE_INTERNAL_API */
595
596 U_NAMESPACE_END
597
598 #endif /* #if !UCONFIG_NO_FORMATTING */
599
600 #endif /* U_SHOW_CPLUSPLUS_API */
601
602 #endif // _DCFMTSYM
603 //eof
604