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 DECIMFMT.H 10 * 11 * Modification History: 12 * 13 * Date Name Description 14 * 02/19/97 aliu Converted from java. 15 * 03/20/97 clhuang Updated per C++ implementation. 16 * 04/03/97 aliu Rewrote parsing and formatting completely, and 17 * cleaned up and debugged. Actually works now. 18 * 04/17/97 aliu Changed DigitCount to int per code review. 19 * 07/10/97 helena Made ParsePosition a class and get rid of the function 20 * hiding problems. 21 * 09/09/97 aliu Ported over support for exponential formats. 22 * 07/20/98 stephen Changed documentation 23 * 01/30/13 emmons Added Scaling methods 24 ******************************************************************************** 25 */ 26 27 #ifndef DECIMFMT_H 28 #define DECIMFMT_H 29 30 #include "unicode/utypes.h" 31 32 #if U_SHOW_CPLUSPLUS_API 33 34 /** 35 * \file 36 * \brief C++ API: Compatibility APIs for decimal formatting. 37 */ 38 39 #if !UCONFIG_NO_FORMATTING 40 41 #include "unicode/dcfmtsym.h" 42 #include "unicode/numfmt.h" 43 #include "unicode/locid.h" 44 #include "unicode/fpositer.h" 45 #include "unicode/stringpiece.h" 46 #include "unicode/curramt.h" 47 #include "unicode/enumset.h" 48 49 U_NAMESPACE_BEGIN 50 51 class CurrencyPluralInfo; 52 class CompactDecimalFormat; 53 54 namespace number { 55 class LocalizedNumberFormatter; 56 class FormattedNumber; 57 namespace impl { 58 class DecimalQuantity; 59 struct DecimalFormatFields; 60 } 61 } 62 63 namespace numparse { 64 namespace impl { 65 class NumberParserImpl; 66 } 67 } 68 69 /** 70 * **IMPORTANT:** New users are strongly encouraged to see if 71 * numberformatter.h fits their use case. Although not deprecated, this header 72 * is provided for backwards compatibility only. 73 * 74 * DecimalFormat is a concrete subclass of NumberFormat that formats decimal 75 * numbers. It has a variety of features designed to make it possible to parse 76 * and format numbers in any locale, including support for Western, Arabic, or 77 * Indic digits. It also supports different flavors of numbers, including 78 * integers ("123"), fixed-point numbers ("123.4"), scientific notation 79 * ("1.23E4"), percentages ("12%"), and currency amounts ("$123", "USD123", 80 * "123 US dollars"). All of these flavors can be easily localized. 81 * 82 * To obtain a NumberFormat for a specific locale (including the default 83 * locale) call one of NumberFormat's factory methods such as 84 * createInstance(). Do not call the DecimalFormat constructors directly, unless 85 * you know what you are doing, since the NumberFormat factory methods may 86 * return subclasses other than DecimalFormat. 87 * 88 * **Example Usage** 89 * 90 * \code 91 * // Normally we would have a GUI with a menu for this 92 * int32_t locCount; 93 * const Locale* locales = NumberFormat::getAvailableLocales(locCount); 94 * 95 * double myNumber = -1234.56; 96 * UErrorCode success = U_ZERO_ERROR; 97 * NumberFormat* form; 98 * 99 * // Print out a number with the localized number, currency and percent 100 * // format for each locale. 101 * UnicodeString countryName; 102 * UnicodeString displayName; 103 * UnicodeString str; 104 * UnicodeString pattern; 105 * Formattable fmtable; 106 * for (int32_t j = 0; j < 3; ++j) { 107 * cout << endl << "FORMAT " << j << endl; 108 * for (int32_t i = 0; i < locCount; ++i) { 109 * if (locales[i].getCountry(countryName).size() == 0) { 110 * // skip language-only 111 * continue; 112 * } 113 * switch (j) { 114 * case 0: 115 * form = NumberFormat::createInstance(locales[i], success ); break; 116 * case 1: 117 * form = NumberFormat::createCurrencyInstance(locales[i], success ); break; 118 * default: 119 * form = NumberFormat::createPercentInstance(locales[i], success ); break; 120 * } 121 * if (form) { 122 * str.remove(); 123 * pattern = ((DecimalFormat*)form)->toPattern(pattern); 124 * cout << locales[i].getDisplayName(displayName) << ": " << pattern; 125 * cout << " -> " << form->format(myNumber,str) << endl; 126 * form->parse(form->format(myNumber,str), fmtable, success); 127 * delete form; 128 * } 129 * } 130 * } 131 * \endcode 132 * 133 * **Another example use createInstance(style)** 134 * 135 * \code 136 * // Print out a number using the localized number, currency, 137 * // percent, scientific, integer, iso currency, and plural currency 138 * // format for each locale</strong> 139 * Locale* locale = new Locale("en", "US"); 140 * double myNumber = 1234.56; 141 * UErrorCode success = U_ZERO_ERROR; 142 * UnicodeString str; 143 * Formattable fmtable; 144 * for (int j=NumberFormat::kNumberStyle; 145 * j<=NumberFormat::kPluralCurrencyStyle; 146 * ++j) { 147 * NumberFormat* form = NumberFormat::createInstance(locale, j, success); 148 * str.remove(); 149 * cout << "format result " << form->format(myNumber, str) << endl; 150 * format->parse(form->format(myNumber, str), fmtable, success); 151 * delete form; 152 * } 153 * \endcode 154 * 155 * 156 * <p><strong>Patterns</strong> 157 * 158 * <p>A DecimalFormat consists of a <em>pattern</em> and a set of 159 * <em>symbols</em>. The pattern may be set directly using 160 * applyPattern(), or indirectly using other API methods which 161 * manipulate aspects of the pattern, such as the minimum number of integer 162 * digits. The symbols are stored in a DecimalFormatSymbols 163 * object. When using the NumberFormat factory methods, the 164 * pattern and symbols are read from ICU's locale data. 165 * 166 * <p><strong>Special Pattern Characters</strong> 167 * 168 * <p>Many characters in a pattern are taken literally; they are matched during 169 * parsing and output unchanged during formatting. Special characters, on the 170 * other hand, stand for other characters, strings, or classes of characters. 171 * For example, the '#' character is replaced by a localized digit. Often the 172 * replacement character is the same as the pattern character; in the U.S. locale, 173 * the ',' grouping character is replaced by ','. However, the replacement is 174 * still happening, and if the symbols are modified, the grouping character 175 * changes. Some special characters affect the behavior of the formatter by 176 * their presence; for example, if the percent character is seen, then the 177 * value is multiplied by 100 before being displayed. 178 * 179 * <p>To insert a special character in a pattern as a literal, that is, without 180 * any special meaning, the character must be quoted. There are some exceptions to 181 * this which are noted below. 182 * 183 * <p>The characters listed here are used in non-localized patterns. Localized 184 * patterns use the corresponding characters taken from this formatter's 185 * DecimalFormatSymbols object instead, and these characters lose 186 * their special status. Two exceptions are the currency sign and quote, which 187 * are not localized. 188 * 189 * <table border=0 cellspacing=3 cellpadding=0> 190 * <tr bgcolor="#ccccff"> 191 * <td align=left><strong>Symbol</strong> 192 * <td align=left><strong>Location</strong> 193 * <td align=left><strong>Localized?</strong> 194 * <td align=left><strong>Meaning</strong> 195 * <tr valign=top> 196 * <td><code>0</code> 197 * <td>Number 198 * <td>Yes 199 * <td>Digit 200 * <tr valign=top bgcolor="#eeeeff"> 201 * <td><code>1-9</code> 202 * <td>Number 203 * <td>Yes 204 * <td>'1' through '9' indicate rounding. 205 * <tr valign=top> 206 * <td><code>\htmlonly@\endhtmlonly</code> <!--doxygen doesn't like @--> 207 * <td>Number 208 * <td>No 209 * <td>Significant digit 210 * <tr valign=top bgcolor="#eeeeff"> 211 * <td><code>#</code> 212 * <td>Number 213 * <td>Yes 214 * <td>Digit, zero shows as absent 215 * <tr valign=top> 216 * <td><code>.</code> 217 * <td>Number 218 * <td>Yes 219 * <td>Decimal separator or monetary decimal separator 220 * <tr valign=top bgcolor="#eeeeff"> 221 * <td><code>-</code> 222 * <td>Number 223 * <td>Yes 224 * <td>Minus sign 225 * <tr valign=top> 226 * <td><code>,</code> 227 * <td>Number 228 * <td>Yes 229 * <td>Grouping separator 230 * <tr valign=top bgcolor="#eeeeff"> 231 * <td><code>E</code> 232 * <td>Number 233 * <td>Yes 234 * <td>Separates mantissa and exponent in scientific notation. 235 * <em>Need not be quoted in prefix or suffix.</em> 236 * <tr valign=top> 237 * <td><code>+</code> 238 * <td>Exponent 239 * <td>Yes 240 * <td>Prefix positive exponents with localized plus sign. 241 * <em>Need not be quoted in prefix or suffix.</em> 242 * <tr valign=top bgcolor="#eeeeff"> 243 * <td><code>;</code> 244 * <td>Subpattern boundary 245 * <td>Yes 246 * <td>Separates positive and negative subpatterns 247 * <tr valign=top> 248 * <td><code>\%</code> 249 * <td>Prefix or suffix 250 * <td>Yes 251 * <td>Multiply by 100 and show as percentage 252 * <tr valign=top bgcolor="#eeeeff"> 253 * <td><code>\\u2030</code> 254 * <td>Prefix or suffix 255 * <td>Yes 256 * <td>Multiply by 1000 and show as per mille 257 * <tr valign=top> 258 * <td><code>\htmlonly¤\endhtmlonly</code> (<code>\\u00A4</code>) 259 * <td>Prefix or suffix 260 * <td>No 261 * <td>Currency sign, replaced by currency symbol. If 262 * doubled, replaced by international currency symbol. 263 * If tripled, replaced by currency plural names, for example, 264 * "US dollar" or "US dollars" for America. 265 * If present in a pattern, the monetary decimal separator 266 * is used instead of the decimal separator. 267 * <tr valign=top bgcolor="#eeeeff"> 268 * <td><code>'</code> 269 * <td>Prefix or suffix 270 * <td>No 271 * <td>Used to quote special characters in a prefix or suffix, 272 * for example, <code>"'#'#"</code> formats 123 to 273 * <code>"#123"</code>. To create a single quote 274 * itself, use two in a row: <code>"# o''clock"</code>. 275 * <tr valign=top> 276 * <td><code>*</code> 277 * <td>Prefix or suffix boundary 278 * <td>Yes 279 * <td>Pad escape, precedes pad character 280 * </table> 281 * 282 * <p>A DecimalFormat pattern contains a positive and negative 283 * subpattern, for example, "#,##0.00;(#,##0.00)". Each subpattern has a 284 * prefix, a numeric part, and a suffix. If there is no explicit negative 285 * subpattern, the negative subpattern is the localized minus sign prefixed to the 286 * positive subpattern. That is, "0.00" alone is equivalent to "0.00;-0.00". If there 287 * is an explicit negative subpattern, it serves only to specify the negative 288 * prefix and suffix; the number of digits, minimal digits, and other 289 * characteristics are ignored in the negative subpattern. That means that 290 * "#,##0.0#;(#)" has precisely the same result as "#,##0.0#;(#,##0.0#)". 291 * 292 * <p>The prefixes, suffixes, and various symbols used for infinity, digits, 293 * thousands separators, decimal separators, etc. may be set to arbitrary 294 * values, and they will appear properly during formatting. However, care must 295 * be taken that the symbols and strings do not conflict, or parsing will be 296 * unreliable. For example, either the positive and negative prefixes or the 297 * suffixes must be distinct for parse() to be able 298 * to distinguish positive from negative values. Another example is that the 299 * decimal separator and thousands separator should be distinct characters, or 300 * parsing will be impossible. 301 * 302 * <p>The <em>grouping separator</em> is a character that separates clusters of 303 * integer digits to make large numbers more legible. It commonly used for 304 * thousands, but in some locales it separates ten-thousands. The <em>grouping 305 * size</em> is the number of digits between the grouping separators, such as 3 306 * for "100,000,000" or 4 for "1 0000 0000". There are actually two different 307 * grouping sizes: One used for the least significant integer digits, the 308 * <em>primary grouping size</em>, and one used for all others, the 309 * <em>secondary grouping size</em>. In most locales these are the same, but 310 * sometimes they are different. For example, if the primary grouping interval 311 * is 3, and the secondary is 2, then this corresponds to the pattern 312 * "#,##,##0", and the number 123456789 is formatted as "12,34,56,789". If a 313 * pattern contains multiple grouping separators, the interval between the last 314 * one and the end of the integer defines the primary grouping size, and the 315 * interval between the last two defines the secondary grouping size. All others 316 * are ignored, so "#,##,###,####" == "###,###,####" == "##,#,###,####". 317 * 318 * <p>Illegal patterns, such as "#.#.#" or "#.###,###", will cause 319 * DecimalFormat to set a failing UErrorCode. 320 * 321 * <p><strong>Pattern BNF</strong> 322 * 323 * <pre> 324 * pattern := subpattern (';' subpattern)? 325 * subpattern := prefix? number exponent? suffix? 326 * number := (integer ('.' fraction)?) | sigDigits 327 * prefix := '\\u0000'..'\\uFFFD' - specialCharacters 328 * suffix := '\\u0000'..'\\uFFFD' - specialCharacters 329 * integer := '#'* '0'* '0' 330 * fraction := '0'* '#'* 331 * sigDigits := '#'* '@' '@'* '#'* 332 * exponent := 'E' '+'? '0'* '0' 333 * padSpec := '*' padChar 334 * padChar := '\\u0000'..'\\uFFFD' - quote 335 * 336 * Notation: 337 * X* 0 or more instances of X 338 * X? 0 or 1 instances of X 339 * X|Y either X or Y 340 * C..D any character from C up to D, inclusive 341 * S-T characters in S, except those in T 342 * </pre> 343 * The first subpattern is for positive numbers. The second (optional) 344 * subpattern is for negative numbers. 345 * 346 * <p>Not indicated in the BNF syntax above: 347 * 348 * <ul><li>The grouping separator ',' can occur inside the integer and 349 * sigDigits elements, between any two pattern characters of that 350 * element, as long as the integer or sigDigits element is not 351 * followed by the exponent element. 352 * 353 * <li>Two grouping intervals are recognized: That between the 354 * decimal point and the first grouping symbol, and that 355 * between the first and second grouping symbols. These 356 * intervals are identical in most locales, but in some 357 * locales they differ. For example, the pattern 358 * "#,##,###" formats the number 123456789 as 359 * "12,34,56,789".</li> 360 * 361 * <li>The pad specifier <code>padSpec</code> may appear before the prefix, 362 * after the prefix, before the suffix, after the suffix, or not at all. 363 * 364 * <li>In place of '0', the digits '1' through '9' may be used to 365 * indicate a rounding increment. 366 * </ul> 367 * 368 * <p><strong>Parsing</strong> 369 * 370 * <p>DecimalFormat parses all Unicode characters that represent 371 * decimal digits, as defined by u_charDigitValue(). In addition, 372 * DecimalFormat also recognizes as digits the ten consecutive 373 * characters starting with the localized zero digit defined in the 374 * DecimalFormatSymbols object. During formatting, the 375 * DecimalFormatSymbols-based digits are output. 376 * 377 * <p>During parsing, grouping separators are ignored if in lenient mode; 378 * otherwise, if present, they must be in appropriate positions. 379 * 380 * <p>For currency parsing, the formatter is able to parse every currency 381 * style formats no matter which style the formatter is constructed with. 382 * For example, a formatter instance gotten from 383 * NumberFormat.getInstance(ULocale, NumberFormat.CURRENCYSTYLE) can parse 384 * formats such as "USD1.00" and "3.00 US dollars". 385 * 386 * <p>If parse(UnicodeString&,Formattable&,ParsePosition&) 387 * fails to parse a string, it leaves the parse position unchanged. 388 * The convenience method parse(UnicodeString&,Formattable&,UErrorCode&) 389 * indicates parse failure by setting a failing 390 * UErrorCode. 391 * 392 * <p><strong>Formatting</strong> 393 * 394 * <p>Formatting is guided by several parameters, all of which can be 395 * specified either using a pattern or using the API. The following 396 * description applies to formats that do not use <a href="#sci">scientific 397 * notation</a> or <a href="#sigdig">significant digits</a>. 398 * 399 * <ul><li>If the number of actual integer digits exceeds the 400 * <em>maximum integer digits</em>, then only the least significant 401 * digits are shown. For example, 1997 is formatted as "97" if the 402 * maximum integer digits is set to 2. 403 * 404 * <li>If the number of actual integer digits is less than the 405 * <em>minimum integer digits</em>, then leading zeros are added. For 406 * example, 1997 is formatted as "01997" if the minimum integer digits 407 * is set to 5. 408 * 409 * <li>If the number of actual fraction digits exceeds the <em>maximum 410 * fraction digits</em>, then rounding is performed to the 411 * maximum fraction digits. For example, 0.125 is formatted as "0.12" 412 * if the maximum fraction digits is 2. This behavior can be changed 413 * by specifying a rounding increment and/or a rounding mode. 414 * 415 * <li>If the number of actual fraction digits is less than the 416 * <em>minimum fraction digits</em>, then trailing zeros are added. 417 * For example, 0.125 is formatted as "0.1250" if the minimum fraction 418 * digits is set to 4. 419 * 420 * <li>Trailing fractional zeros are not displayed if they occur 421 * <em>j</em> positions after the decimal, where <em>j</em> is less 422 * than the maximum fraction digits. For example, 0.10004 is 423 * formatted as "0.1" if the maximum fraction digits is four or less. 424 * </ul> 425 * 426 * <p><strong>Special Values</strong> 427 * 428 * <p><code>NaN</code> is represented as a single character, typically 429 * <code>\\uFFFD</code>. This character is determined by the 430 * DecimalFormatSymbols object. This is the only value for which 431 * the prefixes and suffixes are not used. 432 * 433 * <p>Infinity is represented as a single character, typically 434 * <code>\\u221E</code>, with the positive or negative prefixes and suffixes 435 * applied. The infinity character is determined by the 436 * DecimalFormatSymbols object. 437 * 438 * <a name="sci"><strong>Scientific Notation</strong></a> 439 * 440 * <p>Numbers in scientific notation are expressed as the product of a mantissa 441 * and a power of ten, for example, 1234 can be expressed as 1.234 x 10<sup>3</sup>. The 442 * mantissa is typically in the half-open interval [1.0, 10.0) or sometimes [0.0, 1.0), 443 * but it need not be. DecimalFormat supports arbitrary mantissas. 444 * DecimalFormat can be instructed to use scientific 445 * notation through the API or through the pattern. In a pattern, the exponent 446 * character immediately followed by one or more digit characters indicates 447 * scientific notation. Example: "0.###E0" formats the number 1234 as 448 * "1.234E3". 449 * 450 * <ul> 451 * <li>The number of digit characters after the exponent character gives the 452 * minimum exponent digit count. There is no maximum. Negative exponents are 453 * formatted using the localized minus sign, <em>not</em> the prefix and suffix 454 * from the pattern. This allows patterns such as "0.###E0 m/s". To prefix 455 * positive exponents with a localized plus sign, specify '+' between the 456 * exponent and the digits: "0.###E+0" will produce formats "1E+1", "1E+0", 457 * "1E-1", etc. (In localized patterns, use the localized plus sign rather than 458 * '+'.) 459 * 460 * <li>The minimum number of integer digits is achieved by adjusting the 461 * exponent. Example: 0.00123 formatted with "00.###E0" yields "12.3E-4". This 462 * only happens if there is no maximum number of integer digits. If there is a 463 * maximum, then the minimum number of integer digits is fixed at one. 464 * 465 * <li>The maximum number of integer digits, if present, specifies the exponent 466 * grouping. The most common use of this is to generate <em>engineering 467 * notation</em>, in which the exponent is a multiple of three, e.g., 468 * "##0.###E0". The number 12345 is formatted using "##0.####E0" as "12.345E3". 469 * 470 * <li>When using scientific notation, the formatter controls the 471 * digit counts using significant digits logic. The maximum number of 472 * significant digits limits the total number of integer and fraction 473 * digits that will be shown in the mantissa; it does not affect 474 * parsing. For example, 12345 formatted with "##0.##E0" is "12.3E3". 475 * See the section on significant digits for more details. 476 * 477 * <li>The number of significant digits shown is determined as 478 * follows: If areSignificantDigitsUsed() returns false, then the 479 * minimum number of significant digits shown is one, and the maximum 480 * number of significant digits shown is the sum of the <em>minimum 481 * integer</em> and <em>maximum fraction</em> digits, and is 482 * unaffected by the maximum integer digits. If this sum is zero, 483 * then all significant digits are shown. If 484 * areSignificantDigitsUsed() returns true, then the significant digit 485 * counts are specified by getMinimumSignificantDigits() and 486 * getMaximumSignificantDigits(). In this case, the number of 487 * integer digits is fixed at one, and there is no exponent grouping. 488 * 489 * <li>Exponential patterns may not contain grouping separators. 490 * </ul> 491 * 492 * <a name="sigdig"><strong>Significant Digits</strong></a> 493 * 494 * <code>DecimalFormat</code> has two ways of controlling how many 495 * digits are shows: (a) significant digits counts, or (b) integer and 496 * fraction digit counts. Integer and fraction digit counts are 497 * described above. When a formatter is using significant digits 498 * counts, the number of integer and fraction digits is not specified 499 * directly, and the formatter settings for these counts are ignored. 500 * Instead, the formatter uses however many integer and fraction 501 * digits are required to display the specified number of significant 502 * digits. Examples: 503 * 504 * <table border=0 cellspacing=3 cellpadding=0> 505 * <tr bgcolor="#ccccff"> 506 * <td align=left>Pattern 507 * <td align=left>Minimum significant digits 508 * <td align=left>Maximum significant digits 509 * <td align=left>Number 510 * <td align=left>Output of format() 511 * <tr valign=top> 512 * <td><code>\@\@\@</code> 513 * <td>3 514 * <td>3 515 * <td>12345 516 * <td><code>12300</code> 517 * <tr valign=top bgcolor="#eeeeff"> 518 * <td><code>\@\@\@</code> 519 * <td>3 520 * <td>3 521 * <td>0.12345 522 * <td><code>0.123</code> 523 * <tr valign=top> 524 * <td><code>\@\@##</code> 525 * <td>2 526 * <td>4 527 * <td>3.14159 528 * <td><code>3.142</code> 529 * <tr valign=top bgcolor="#eeeeff"> 530 * <td><code>\@\@##</code> 531 * <td>2 532 * <td>4 533 * <td>1.23004 534 * <td><code>1.23</code> 535 * </table> 536 * 537 * <ul> 538 * <li>Significant digit counts may be expressed using patterns that 539 * specify a minimum and maximum number of significant digits. These 540 * are indicated by the <code>'@'</code> and <code>'#'</code> 541 * characters. The minimum number of significant digits is the number 542 * of <code>'@'</code> characters. The maximum number of significant 543 * digits is the number of <code>'@'</code> characters plus the number 544 * of <code>'#'</code> characters following on the right. For 545 * example, the pattern <code>"@@@"</code> indicates exactly 3 546 * significant digits. The pattern <code>"@##"</code> indicates from 547 * 1 to 3 significant digits. Trailing zero digits to the right of 548 * the decimal separator are suppressed after the minimum number of 549 * significant digits have been shown. For example, the pattern 550 * <code>"@##"</code> formats the number 0.1203 as 551 * <code>"0.12"</code>. 552 * 553 * <li>If a pattern uses significant digits, it may not contain a 554 * decimal separator, nor the <code>'0'</code> pattern character. 555 * Patterns such as <code>"@00"</code> or <code>"@.###"</code> are 556 * disallowed. 557 * 558 * <li>Any number of <code>'#'</code> characters may be prepended to 559 * the left of the leftmost <code>'@'</code> character. These have no 560 * effect on the minimum and maximum significant digits counts, but 561 * may be used to position grouping separators. For example, 562 * <code>"#,#@#"</code> indicates a minimum of one significant digits, 563 * a maximum of two significant digits, and a grouping size of three. 564 * 565 * <li>In order to enable significant digits formatting, use a pattern 566 * containing the <code>'@'</code> pattern character. Alternatively, 567 * call setSignificantDigitsUsed(TRUE). 568 * 569 * <li>In order to disable significant digits formatting, use a 570 * pattern that does not contain the <code>'@'</code> pattern 571 * character. Alternatively, call setSignificantDigitsUsed(FALSE). 572 * 573 * <li>The number of significant digits has no effect on parsing. 574 * 575 * <li>Significant digits may be used together with exponential notation. Such 576 * patterns are equivalent to a normal exponential pattern with a minimum and 577 * maximum integer digit count of one, a minimum fraction digit count of 578 * <code>getMinimumSignificantDigits() - 1</code>, and a maximum fraction digit 579 * count of <code>getMaximumSignificantDigits() - 1</code>. For example, the 580 * pattern <code>"@@###E0"</code> is equivalent to <code>"0.0###E0"</code>. 581 * 582 * <li>If significant digits are in use, then the integer and fraction 583 * digit counts, as set via the API, are ignored. If significant 584 * digits are not in use, then the significant digit counts, as set via 585 * the API, are ignored. 586 * 587 * </ul> 588 * 589 * <p><strong>Padding</strong> 590 * 591 * <p>DecimalFormat supports padding the result of 592 * format() to a specific width. Padding may be specified either 593 * through the API or through the pattern syntax. In a pattern the pad escape 594 * character, followed by a single pad character, causes padding to be parsed 595 * and formatted. The pad escape character is '*' in unlocalized patterns, and 596 * can be localized using DecimalFormatSymbols::setSymbol() with a 597 * DecimalFormatSymbols::kPadEscapeSymbol 598 * selector. For example, <code>"$*x#,##0.00"</code> formats 123 to 599 * <code>"$xx123.00"</code>, and 1234 to <code>"$1,234.00"</code>. 600 * 601 * <ul> 602 * <li>When padding is in effect, the width of the positive subpattern, 603 * including prefix and suffix, determines the format width. For example, in 604 * the pattern <code>"* #0 o''clock"</code>, the format width is 10. 605 * 606 * <li>The width is counted in 16-bit code units (char16_ts). 607 * 608 * <li>Some parameters which usually do not matter have meaning when padding is 609 * used, because the pattern width is significant with padding. In the pattern 610 * "* ##,##,#,##0.##", the format width is 14. The initial characters "##,##," 611 * do not affect the grouping size or maximum integer digits, but they do affect 612 * the format width. 613 * 614 * <li>Padding may be inserted at one of four locations: before the prefix, 615 * after the prefix, before the suffix, or after the suffix. If padding is 616 * specified in any other location, applyPattern() 617 * sets a failing UErrorCode. If there is no prefix, 618 * before the prefix and after the prefix are equivalent, likewise for the 619 * suffix. 620 * 621 * <li>When specified in a pattern, the 32-bit code point immediately 622 * following the pad escape is the pad character. This may be any character, 623 * including a special pattern character. That is, the pad escape 624 * <em>escapes</em> the following character. If there is no character after 625 * the pad escape, then the pattern is illegal. 626 * 627 * </ul> 628 * 629 * <p><strong>Rounding</strong> 630 * 631 * <p>DecimalFormat supports rounding to a specific increment. For 632 * example, 1230 rounded to the nearest 50 is 1250. 1.234 rounded to the 633 * nearest 0.65 is 1.3. The rounding increment may be specified through the API 634 * or in a pattern. To specify a rounding increment in a pattern, include the 635 * increment in the pattern itself. "#,#50" specifies a rounding increment of 636 * 50. "#,##0.05" specifies a rounding increment of 0.05. 637 * 638 * <p>In the absence of an explicit rounding increment numbers are 639 * rounded to their formatted width. 640 * 641 * <ul> 642 * <li>Rounding only affects the string produced by formatting. It does 643 * not affect parsing or change any numerical values. 644 * 645 * <li>A <em>rounding mode</em> determines how values are rounded; see 646 * DecimalFormat::ERoundingMode. The default rounding mode is 647 * DecimalFormat::kRoundHalfEven. The rounding mode can only be set 648 * through the API; it can not be set with a pattern. 649 * 650 * <li>Some locales use rounding in their currency formats to reflect the 651 * smallest currency denomination. 652 * 653 * <li>In a pattern, digits '1' through '9' specify rounding, but otherwise 654 * behave identically to digit '0'. 655 * </ul> 656 * 657 * <p><strong>Synchronization</strong> 658 * 659 * <p>DecimalFormat objects are not synchronized. Multiple 660 * threads should not access one formatter concurrently. 661 * 662 * <p><strong>Subclassing</strong> 663 * 664 * <p><em>User subclasses are not supported.</em> While clients may write 665 * subclasses, such code will not necessarily work and will not be 666 * guaranteed to work stably from release to release. 667 */ 668 class U_I18N_API DecimalFormat : public NumberFormat { 669 public: 670 /** 671 * Pad position. 672 * @stable ICU 2.4 673 */ 674 enum EPadPosition { 675 kPadBeforePrefix, kPadAfterPrefix, kPadBeforeSuffix, kPadAfterSuffix 676 }; 677 678 /** 679 * Create a DecimalFormat using the default pattern and symbols 680 * for the default locale. This is a convenient way to obtain a 681 * DecimalFormat when internationalization is not the main concern. 682 * <P> 683 * To obtain standard formats for a given locale, use the factory methods 684 * on NumberFormat such as createInstance. These factories will 685 * return the most appropriate sub-class of NumberFormat for a given 686 * locale. 687 * <p> 688 * <strong>NOTE:</strong> New users are strongly encouraged to use 689 * #icu::number::NumberFormatter instead of DecimalFormat. 690 * @param status Output param set to success/failure code. If the 691 * pattern is invalid this will be set to a failure code. 692 * @stable ICU 2.0 693 */ 694 DecimalFormat(UErrorCode& status); 695 696 /** 697 * Create a DecimalFormat from the given pattern and the symbols 698 * for the default locale. This is a convenient way to obtain a 699 * DecimalFormat when internationalization is not the main concern. 700 * <P> 701 * To obtain standard formats for a given locale, use the factory methods 702 * on NumberFormat such as createInstance. These factories will 703 * return the most appropriate sub-class of NumberFormat for a given 704 * locale. 705 * <p> 706 * <strong>NOTE:</strong> New users are strongly encouraged to use 707 * #icu::number::NumberFormatter instead of DecimalFormat. 708 * @param pattern A non-localized pattern string. 709 * @param status Output param set to success/failure code. If the 710 * pattern is invalid this will be set to a failure code. 711 * @stable ICU 2.0 712 */ 713 DecimalFormat(const UnicodeString& pattern, UErrorCode& status); 714 715 /** 716 * Create a DecimalFormat from the given pattern and symbols. 717 * Use this constructor when you need to completely customize the 718 * behavior of the format. 719 * <P> 720 * To obtain standard formats for a given 721 * locale, use the factory methods on NumberFormat such as 722 * createInstance or createCurrencyInstance. If you need only minor adjustments 723 * to a standard format, you can modify the format returned by 724 * a NumberFormat factory method. 725 * <p> 726 * <strong>NOTE:</strong> New users are strongly encouraged to use 727 * #icu::number::NumberFormatter instead of DecimalFormat. 728 * 729 * @param pattern a non-localized pattern string 730 * @param symbolsToAdopt the set of symbols to be used. The caller should not 731 * delete this object after making this call. 732 * @param status Output param set to success/failure code. If the 733 * pattern is invalid this will be set to a failure code. 734 * @stable ICU 2.0 735 */ 736 DecimalFormat(const UnicodeString& pattern, DecimalFormatSymbols* symbolsToAdopt, UErrorCode& status); 737 738 #ifndef U_HIDE_INTERNAL_API 739 740 /** 741 * This API is for ICU use only. 742 * Create a DecimalFormat from the given pattern, symbols, and style. 743 * 744 * @param pattern a non-localized pattern string 745 * @param symbolsToAdopt the set of symbols to be used. The caller should not 746 * delete this object after making this call. 747 * @param style style of decimal format 748 * @param status Output param set to success/failure code. If the 749 * pattern is invalid this will be set to a failure code. 750 * @internal 751 */ 752 DecimalFormat(const UnicodeString& pattern, DecimalFormatSymbols* symbolsToAdopt, 753 UNumberFormatStyle style, UErrorCode& status); 754 755 #if UCONFIG_HAVE_PARSEALLINPUT 756 757 /** 758 * @internal 759 */ 760 void setParseAllInput(UNumberFormatAttributeValue value); 761 762 #endif 763 764 #endif /* U_HIDE_INTERNAL_API */ 765 766 private: 767 768 /** 769 * Internal constructor for DecimalFormat; sets up internal fields. All public constructors should 770 * call this constructor. 771 */ 772 DecimalFormat(const DecimalFormatSymbols* symbolsToAdopt, UErrorCode& status); 773 774 public: 775 776 /** 777 * Set an integer attribute on this DecimalFormat. 778 * May return U_UNSUPPORTED_ERROR if this instance does not support 779 * the specified attribute. 780 * @param attr the attribute to set 781 * @param newValue new value 782 * @param status the error type 783 * @return *this - for chaining (example: format.setAttribute(...).setAttribute(...) ) 784 * @stable ICU 51 785 */ 786 virtual DecimalFormat& setAttribute(UNumberFormatAttribute attr, int32_t newValue, UErrorCode& status); 787 788 /** 789 * Get an integer 790 * May return U_UNSUPPORTED_ERROR if this instance does not support 791 * the specified attribute. 792 * @param attr the attribute to set 793 * @param status the error type 794 * @return the attribute value. Undefined if there is an error. 795 * @stable ICU 51 796 */ 797 virtual int32_t getAttribute(UNumberFormatAttribute attr, UErrorCode& status) const; 798 799 800 /** 801 * Set whether or not grouping will be used in this format. 802 * @param newValue True, grouping will be used in this format. 803 * @see getGroupingUsed 804 * @stable ICU 53 805 */ 806 void setGroupingUsed(UBool newValue) U_OVERRIDE; 807 808 /** 809 * Sets whether or not numbers should be parsed as integers only. 810 * @param value set True, this format will parse numbers as integers 811 * only. 812 * @see isParseIntegerOnly 813 * @stable ICU 53 814 */ 815 void setParseIntegerOnly(UBool value) U_OVERRIDE; 816 817 /** 818 * Sets whether lenient parsing should be enabled (it is off by default). 819 * 820 * @param enable \c TRUE if lenient parsing should be used, 821 * \c FALSE otherwise. 822 * @stable ICU 4.8 823 */ 824 void setLenient(UBool enable) U_OVERRIDE; 825 826 /** 827 * Create a DecimalFormat from the given pattern and symbols. 828 * Use this constructor when you need to completely customize the 829 * behavior of the format. 830 * <P> 831 * To obtain standard formats for a given 832 * locale, use the factory methods on NumberFormat such as 833 * createInstance or createCurrencyInstance. If you need only minor adjustments 834 * to a standard format, you can modify the format returned by 835 * a NumberFormat factory method. 836 * <p> 837 * <strong>NOTE:</strong> New users are strongly encouraged to use 838 * #icu::number::NumberFormatter instead of DecimalFormat. 839 * 840 * @param pattern a non-localized pattern string 841 * @param symbolsToAdopt the set of symbols to be used. The caller should not 842 * delete this object after making this call. 843 * @param parseError Output param to receive errors occurred during parsing 844 * @param status Output param set to success/failure code. If the 845 * pattern is invalid this will be set to a failure code. 846 * @stable ICU 2.0 847 */ 848 DecimalFormat(const UnicodeString& pattern, DecimalFormatSymbols* symbolsToAdopt, 849 UParseError& parseError, UErrorCode& status); 850 851 /** 852 * Create a DecimalFormat from the given pattern and symbols. 853 * Use this constructor when you need to completely customize the 854 * behavior of the format. 855 * <P> 856 * To obtain standard formats for a given 857 * locale, use the factory methods on NumberFormat such as 858 * createInstance or createCurrencyInstance. If you need only minor adjustments 859 * to a standard format, you can modify the format returned by 860 * a NumberFormat factory method. 861 * <p> 862 * <strong>NOTE:</strong> New users are strongly encouraged to use 863 * #icu::number::NumberFormatter instead of DecimalFormat. 864 * 865 * @param pattern a non-localized pattern string 866 * @param symbols the set of symbols to be used 867 * @param status Output param set to success/failure code. If the 868 * pattern is invalid this will be set to a failure code. 869 * @stable ICU 2.0 870 */ 871 DecimalFormat(const UnicodeString& pattern, const DecimalFormatSymbols& symbols, UErrorCode& status); 872 873 /** 874 * Copy constructor. 875 * 876 * @param source the DecimalFormat object to be copied from. 877 * @stable ICU 2.0 878 */ 879 DecimalFormat(const DecimalFormat& source); 880 881 /** 882 * Assignment operator. 883 * 884 * @param rhs the DecimalFormat object to be copied. 885 * @stable ICU 2.0 886 */ 887 DecimalFormat& operator=(const DecimalFormat& rhs); 888 889 /** 890 * Destructor. 891 * @stable ICU 2.0 892 */ 893 ~DecimalFormat() U_OVERRIDE; 894 895 /** 896 * Clone this Format object polymorphically. The caller owns the 897 * result and should delete it when done. 898 * 899 * @return a polymorphic copy of this DecimalFormat. 900 * @stable ICU 2.0 901 */ 902 DecimalFormat* clone() const U_OVERRIDE; 903 904 /** 905 * Return true if the given Format objects are semantically equal. 906 * Objects of different subclasses are considered unequal. 907 * 908 * @param other the object to be compared with. 909 * @return true if the given Format objects are semantically equal. 910 * @stable ICU 2.0 911 */ 912 UBool operator==(const Format& other) const U_OVERRIDE; 913 914 915 using NumberFormat::format; 916 917 /** 918 * Format a double or long number using base-10 representation. 919 * 920 * @param number The value to be formatted. 921 * @param appendTo Output parameter to receive result. 922 * Result is appended to existing contents. 923 * @param pos On input: an alignment field, if desired. 924 * On output: the offsets of the alignment field. 925 * @return Reference to 'appendTo' parameter. 926 * @stable ICU 2.0 927 */ 928 UnicodeString& format(double number, UnicodeString& appendTo, FieldPosition& pos) const U_OVERRIDE; 929 930 #ifndef U_HIDE_INTERNAL_API 931 /** 932 * Format a double or long number using base-10 representation. 933 * 934 * @param number The value to be formatted. 935 * @param appendTo Output parameter to receive result. 936 * Result is appended to existing contents. 937 * @param pos On input: an alignment field, if desired. 938 * On output: the offsets of the alignment field. 939 * @param status 940 * @return Reference to 'appendTo' parameter. 941 * @internal 942 */ 943 UnicodeString& format(double number, UnicodeString& appendTo, FieldPosition& pos, 944 UErrorCode& status) const U_OVERRIDE; 945 #endif /* U_HIDE_INTERNAL_API */ 946 947 /** 948 * Format a double or long number using base-10 representation. 949 * 950 * @param number The value to be formatted. 951 * @param appendTo Output parameter to receive result. 952 * Result is appended to existing contents. 953 * @param posIter On return, can be used to iterate over positions 954 * of fields generated by this format call. 955 * Can be NULL. 956 * @param status Output param filled with success/failure status. 957 * @return Reference to 'appendTo' parameter. 958 * @stable ICU 4.4 959 */ 960 UnicodeString& format(double number, UnicodeString& appendTo, FieldPositionIterator* posIter, 961 UErrorCode& status) const U_OVERRIDE; 962 963 /** 964 * Format a long number using base-10 representation. 965 * 966 * @param number The value to be formatted. 967 * @param appendTo Output parameter to receive result. 968 * Result is appended to existing contents. 969 * @param pos On input: an alignment field, if desired. 970 * On output: the offsets of the alignment field. 971 * @return Reference to 'appendTo' parameter. 972 * @stable ICU 2.0 973 */ 974 UnicodeString& format(int32_t number, UnicodeString& appendTo, FieldPosition& pos) const U_OVERRIDE; 975 976 #ifndef U_HIDE_INTERNAL_API 977 /** 978 * Format a long number using base-10 representation. 979 * 980 * @param number The value to be formatted. 981 * @param appendTo Output parameter to receive result. 982 * Result is appended to existing contents. 983 * @param pos On input: an alignment field, if desired. 984 * On output: the offsets of the alignment field. 985 * @param status Output param filled with success/failure status. 986 * @return Reference to 'appendTo' parameter. 987 * @internal 988 */ 989 UnicodeString& format(int32_t number, UnicodeString& appendTo, FieldPosition& pos, 990 UErrorCode& status) const U_OVERRIDE; 991 #endif /* U_HIDE_INTERNAL_API */ 992 993 /** 994 * Format a long number using base-10 representation. 995 * 996 * @param number The value to be formatted. 997 * @param appendTo Output parameter to receive result. 998 * Result is appended to existing contents. 999 * @param posIter On return, can be used to iterate over positions 1000 * of fields generated by this format call. 1001 * Can be NULL. 1002 * @param status Output param filled with success/failure status. 1003 * @return Reference to 'appendTo' parameter. 1004 * @stable ICU 4.4 1005 */ 1006 UnicodeString& format(int32_t number, UnicodeString& appendTo, FieldPositionIterator* posIter, 1007 UErrorCode& status) const U_OVERRIDE; 1008 1009 /** 1010 * Format an int64 number using base-10 representation. 1011 * 1012 * @param number The value to be formatted. 1013 * @param appendTo Output parameter to receive result. 1014 * Result is appended to existing contents. 1015 * @param pos On input: an alignment field, if desired. 1016 * On output: the offsets of the alignment field. 1017 * @return Reference to 'appendTo' parameter. 1018 * @stable ICU 2.8 1019 */ 1020 UnicodeString& format(int64_t number, UnicodeString& appendTo, FieldPosition& pos) const U_OVERRIDE; 1021 1022 #ifndef U_HIDE_INTERNAL_API 1023 /** 1024 * Format an int64 number using base-10 representation. 1025 * 1026 * @param number The value to be formatted. 1027 * @param appendTo Output parameter to receive result. 1028 * Result is appended to existing contents. 1029 * @param pos On input: an alignment field, if desired. 1030 * On output: the offsets of the alignment field. 1031 * @param status Output param filled with success/failure status. 1032 * @return Reference to 'appendTo' parameter. 1033 * @internal 1034 */ 1035 UnicodeString& format(int64_t number, UnicodeString& appendTo, FieldPosition& pos, 1036 UErrorCode& status) const U_OVERRIDE; 1037 #endif /* U_HIDE_INTERNAL_API */ 1038 1039 /** 1040 * Format an int64 number using base-10 representation. 1041 * 1042 * @param number The value to be formatted. 1043 * @param appendTo Output parameter to receive result. 1044 * Result is appended to existing contents. 1045 * @param posIter On return, can be used to iterate over positions 1046 * of fields generated by this format call. 1047 * Can be NULL. 1048 * @param status Output param filled with success/failure status. 1049 * @return Reference to 'appendTo' parameter. 1050 * @stable ICU 4.4 1051 */ 1052 UnicodeString& format(int64_t number, UnicodeString& appendTo, FieldPositionIterator* posIter, 1053 UErrorCode& status) const U_OVERRIDE; 1054 1055 /** 1056 * Format a decimal number. 1057 * The syntax of the unformatted number is a "numeric string" 1058 * as defined in the Decimal Arithmetic Specification, available at 1059 * http://speleotrove.com/decimal 1060 * 1061 * @param number The unformatted number, as a string. 1062 * @param appendTo Output parameter to receive result. 1063 * Result is appended to existing contents. 1064 * @param posIter On return, can be used to iterate over positions 1065 * of fields generated by this format call. 1066 * Can be NULL. 1067 * @param status Output param filled with success/failure status. 1068 * @return Reference to 'appendTo' parameter. 1069 * @stable ICU 4.4 1070 */ 1071 UnicodeString& format(StringPiece number, UnicodeString& appendTo, FieldPositionIterator* posIter, 1072 UErrorCode& status) const U_OVERRIDE; 1073 1074 #ifndef U_HIDE_INTERNAL_API 1075 1076 /** 1077 * Format a decimal number. 1078 * The number is a DecimalQuantity wrapper onto a floating point decimal number. 1079 * The default implementation in NumberFormat converts the decimal number 1080 * to a double and formats that. 1081 * 1082 * @param number The number, a DecimalQuantity format Decimal Floating Point. 1083 * @param appendTo Output parameter to receive result. 1084 * Result is appended to existing contents. 1085 * @param posIter On return, can be used to iterate over positions 1086 * of fields generated by this format call. 1087 * @param status Output param filled with success/failure status. 1088 * @return Reference to 'appendTo' parameter. 1089 * @internal 1090 */ 1091 UnicodeString& format(const number::impl::DecimalQuantity& number, UnicodeString& appendTo, 1092 FieldPositionIterator* posIter, UErrorCode& status) const U_OVERRIDE; 1093 1094 /** 1095 * Format a decimal number. 1096 * The number is a DecimalQuantity wrapper onto a floating point decimal number. 1097 * The default implementation in NumberFormat converts the decimal number 1098 * to a double and formats that. 1099 * 1100 * @param number The number, a DecimalQuantity format Decimal Floating Point. 1101 * @param appendTo Output parameter to receive result. 1102 * Result is appended to existing contents. 1103 * @param pos On input: an alignment field, if desired. 1104 * On output: the offsets of the alignment field. 1105 * @param status Output param filled with success/failure status. 1106 * @return Reference to 'appendTo' parameter. 1107 * @internal 1108 */ 1109 UnicodeString& format(const number::impl::DecimalQuantity& number, UnicodeString& appendTo, 1110 FieldPosition& pos, UErrorCode& status) const U_OVERRIDE; 1111 1112 #endif // U_HIDE_INTERNAL_API 1113 1114 using NumberFormat::parse; 1115 1116 /** 1117 * Parse the given string using this object's choices. The method 1118 * does string comparisons to try to find an optimal match. 1119 * If no object can be parsed, index is unchanged, and NULL is 1120 * returned. The result is returned as the most parsimonious 1121 * type of Formattable that will accommodate all of the 1122 * necessary precision. For example, if the result is exactly 12, 1123 * it will be returned as a long. However, if it is 1.5, it will 1124 * be returned as a double. 1125 * 1126 * @param text The text to be parsed. 1127 * @param result Formattable to be set to the parse result. 1128 * If parse fails, return contents are undefined. 1129 * @param parsePosition The position to start parsing at on input. 1130 * On output, moved to after the last successfully 1131 * parse character. On parse failure, does not change. 1132 * @see Formattable 1133 * @stable ICU 2.0 1134 */ 1135 void parse(const UnicodeString& text, Formattable& result, 1136 ParsePosition& parsePosition) const U_OVERRIDE; 1137 1138 /** 1139 * Parses text from the given string as a currency amount. Unlike 1140 * the parse() method, this method will attempt to parse a generic 1141 * currency name, searching for a match of this object's locale's 1142 * currency display names, or for a 3-letter ISO currency code. 1143 * This method will fail if this format is not a currency format, 1144 * that is, if it does not contain the currency pattern symbol 1145 * (U+00A4) in its prefix or suffix. 1146 * 1147 * @param text the string to parse 1148 * @param pos input-output position; on input, the position within text 1149 * to match; must have 0 <= pos.getIndex() < text.length(); 1150 * on output, the position after the last matched character. 1151 * If the parse fails, the position in unchanged upon output. 1152 * @return if parse succeeds, a pointer to a newly-created CurrencyAmount 1153 * object (owned by the caller) containing information about 1154 * the parsed currency; if parse fails, this is NULL. 1155 * @stable ICU 49 1156 */ 1157 CurrencyAmount* parseCurrency(const UnicodeString& text, ParsePosition& pos) const U_OVERRIDE; 1158 1159 /** 1160 * Returns the decimal format symbols, which is generally not changed 1161 * by the programmer or user. 1162 * @return desired DecimalFormatSymbols 1163 * @see DecimalFormatSymbols 1164 * @stable ICU 2.0 1165 */ 1166 virtual const DecimalFormatSymbols* getDecimalFormatSymbols(void) const; 1167 1168 /** 1169 * Sets the decimal format symbols, which is generally not changed 1170 * by the programmer or user. 1171 * @param symbolsToAdopt DecimalFormatSymbols to be adopted. 1172 * @stable ICU 2.0 1173 */ 1174 virtual void adoptDecimalFormatSymbols(DecimalFormatSymbols* symbolsToAdopt); 1175 1176 /** 1177 * Sets the decimal format symbols, which is generally not changed 1178 * by the programmer or user. 1179 * @param symbols DecimalFormatSymbols. 1180 * @stable ICU 2.0 1181 */ 1182 virtual void setDecimalFormatSymbols(const DecimalFormatSymbols& symbols); 1183 1184 1185 /** 1186 * Returns the currency plural format information, 1187 * which is generally not changed by the programmer or user. 1188 * @return desired CurrencyPluralInfo 1189 * @stable ICU 4.2 1190 */ 1191 virtual const CurrencyPluralInfo* getCurrencyPluralInfo(void) const; 1192 1193 /** 1194 * Sets the currency plural format information, 1195 * which is generally not changed by the programmer or user. 1196 * @param toAdopt CurrencyPluralInfo to be adopted. 1197 * @stable ICU 4.2 1198 */ 1199 virtual void adoptCurrencyPluralInfo(CurrencyPluralInfo* toAdopt); 1200 1201 /** 1202 * Sets the currency plural format information, 1203 * which is generally not changed by the programmer or user. 1204 * @param info Currency Plural Info. 1205 * @stable ICU 4.2 1206 */ 1207 virtual void setCurrencyPluralInfo(const CurrencyPluralInfo& info); 1208 1209 1210 /** 1211 * Get the positive prefix. 1212 * 1213 * @param result Output param which will receive the positive prefix. 1214 * @return A reference to 'result'. 1215 * Examples: +123, $123, sFr123 1216 * @stable ICU 2.0 1217 */ 1218 UnicodeString& getPositivePrefix(UnicodeString& result) const; 1219 1220 /** 1221 * Set the positive prefix. 1222 * 1223 * @param newValue the new value of the the positive prefix to be set. 1224 * Examples: +123, $123, sFr123 1225 * @stable ICU 2.0 1226 */ 1227 virtual void setPositivePrefix(const UnicodeString& newValue); 1228 1229 /** 1230 * Get the negative prefix. 1231 * 1232 * @param result Output param which will receive the negative prefix. 1233 * @return A reference to 'result'. 1234 * Examples: -123, ($123) (with negative suffix), sFr-123 1235 * @stable ICU 2.0 1236 */ 1237 UnicodeString& getNegativePrefix(UnicodeString& result) const; 1238 1239 /** 1240 * Set the negative prefix. 1241 * 1242 * @param newValue the new value of the the negative prefix to be set. 1243 * Examples: -123, ($123) (with negative suffix), sFr-123 1244 * @stable ICU 2.0 1245 */ 1246 virtual void setNegativePrefix(const UnicodeString& newValue); 1247 1248 /** 1249 * Get the positive suffix. 1250 * 1251 * @param result Output param which will receive the positive suffix. 1252 * @return A reference to 'result'. 1253 * Example: 123% 1254 * @stable ICU 2.0 1255 */ 1256 UnicodeString& getPositiveSuffix(UnicodeString& result) const; 1257 1258 /** 1259 * Set the positive suffix. 1260 * 1261 * @param newValue the new value of the positive suffix to be set. 1262 * Example: 123% 1263 * @stable ICU 2.0 1264 */ 1265 virtual void setPositiveSuffix(const UnicodeString& newValue); 1266 1267 /** 1268 * Get the negative suffix. 1269 * 1270 * @param result Output param which will receive the negative suffix. 1271 * @return A reference to 'result'. 1272 * Examples: -123%, ($123) (with positive suffixes) 1273 * @stable ICU 2.0 1274 */ 1275 UnicodeString& getNegativeSuffix(UnicodeString& result) const; 1276 1277 /** 1278 * Set the negative suffix. 1279 * 1280 * @param newValue the new value of the negative suffix to be set. 1281 * Examples: 123% 1282 * @stable ICU 2.0 1283 */ 1284 virtual void setNegativeSuffix(const UnicodeString& newValue); 1285 1286 #ifndef U_HIDE_DRAFT_API 1287 /** 1288 * Whether to show the plus sign on positive (non-negative) numbers; for example, "+12" 1289 * 1290 * For more control over sign display, use NumberFormatter. 1291 * 1292 * @return Whether the sign is shown on positive numbers and zero. 1293 * @draft ICU 64 1294 */ 1295 UBool isSignAlwaysShown() const; 1296 1297 /** 1298 * Set whether to show the plus sign on positive (non-negative) numbers; for example, "+12". 1299 * 1300 * For more control over sign display, use NumberFormatter. 1301 * 1302 * @param value true to always show a sign; false to hide the sign on positive numbers and zero. 1303 * @draft ICU 64 1304 */ 1305 void setSignAlwaysShown(UBool value); 1306 #endif /* U_HIDE_DRAFT_API */ 1307 1308 /** 1309 * Get the multiplier for use in percent, permill, etc. 1310 * For a percentage, set the suffixes to have "%" and the multiplier to be 100. 1311 * (For Arabic, use arabic percent symbol). 1312 * For a permill, set the suffixes to have "\\u2031" and the multiplier to be 1000. 1313 * 1314 * The number may also be multiplied by a power of ten; see getMultiplierScale(). 1315 * 1316 * @return the multiplier for use in percent, permill, etc. 1317 * Examples: with 100, 1.23 -> "123", and "123" -> 1.23 1318 * @stable ICU 2.0 1319 */ 1320 int32_t getMultiplier(void) const; 1321 1322 /** 1323 * Set the multiplier for use in percent, permill, etc. 1324 * For a percentage, set the suffixes to have "%" and the multiplier to be 100. 1325 * (For Arabic, use arabic percent symbol). 1326 * For a permill, set the suffixes to have "\\u2031" and the multiplier to be 1000. 1327 * 1328 * This method only supports integer multipliers. To multiply by a non-integer, pair this 1329 * method with setMultiplierScale(). 1330 * 1331 * @param newValue the new value of the multiplier for use in percent, permill, etc. 1332 * Examples: with 100, 1.23 -> "123", and "123" -> 1.23 1333 * @stable ICU 2.0 1334 */ 1335 virtual void setMultiplier(int32_t newValue); 1336 1337 /** 1338 * Gets the power of ten by which number should be multiplied before formatting, which 1339 * can be combined with setMultiplier() to multiply by any arbitrary decimal value. 1340 * 1341 * A multiplier scale of 2 corresponds to multiplication by 100, and a multiplier scale 1342 * of -2 corresponds to multiplication by 0.01. 1343 * 1344 * This method is analogous to UNUM_SCALE in getAttribute. 1345 * 1346 * @return the current value of the power-of-ten multiplier. 1347 * @stable ICU 62 1348 */ 1349 int32_t getMultiplierScale(void) const; 1350 1351 /** 1352 * Sets a power of ten by which number should be multiplied before formatting, which 1353 * can be combined with setMultiplier() to multiply by any arbitrary decimal value. 1354 * 1355 * A multiplier scale of 2 corresponds to multiplication by 100, and a multiplier scale 1356 * of -2 corresponds to multiplication by 0.01. 1357 * 1358 * For example, to multiply numbers by 0.5 before formatting, you can do: 1359 * 1360 * <pre> 1361 * df.setMultiplier(5); 1362 * df.setMultiplierScale(-1); 1363 * </pre> 1364 * 1365 * This method is analogous to UNUM_SCALE in setAttribute. 1366 * 1367 * @param newValue the new value of the power-of-ten multiplier. 1368 * @stable ICU 62 1369 */ 1370 void setMultiplierScale(int32_t newValue); 1371 1372 /** 1373 * Get the rounding increment. 1374 * @return A positive rounding increment, or 0.0 if a custom rounding 1375 * increment is not in effect. 1376 * @see #setRoundingIncrement 1377 * @see #getRoundingMode 1378 * @see #setRoundingMode 1379 * @stable ICU 2.0 1380 */ 1381 virtual double getRoundingIncrement(void) const; 1382 1383 /** 1384 * Set the rounding increment. In the absence of a rounding increment, 1385 * numbers will be rounded to the number of digits displayed. 1386 * @param newValue A positive rounding increment, or 0.0 to 1387 * use the default rounding increment. 1388 * Negative increments are equivalent to 0.0. 1389 * @see #getRoundingIncrement 1390 * @see #getRoundingMode 1391 * @see #setRoundingMode 1392 * @stable ICU 2.0 1393 */ 1394 virtual void setRoundingIncrement(double newValue); 1395 1396 /** 1397 * Get the rounding mode. 1398 * @return A rounding mode 1399 * @see #setRoundingIncrement 1400 * @see #getRoundingIncrement 1401 * @see #setRoundingMode 1402 * @stable ICU 2.0 1403 */ 1404 virtual ERoundingMode getRoundingMode(void) const U_OVERRIDE; 1405 1406 /** 1407 * Set the rounding mode. 1408 * @param roundingMode A rounding mode 1409 * @see #setRoundingIncrement 1410 * @see #getRoundingIncrement 1411 * @see #getRoundingMode 1412 * @stable ICU 2.0 1413 */ 1414 virtual void setRoundingMode(ERoundingMode roundingMode) U_OVERRIDE; 1415 1416 /** 1417 * Get the width to which the output of format() is padded. 1418 * The width is counted in 16-bit code units. 1419 * @return the format width, or zero if no padding is in effect 1420 * @see #setFormatWidth 1421 * @see #getPadCharacterString 1422 * @see #setPadCharacter 1423 * @see #getPadPosition 1424 * @see #setPadPosition 1425 * @stable ICU 2.0 1426 */ 1427 virtual int32_t getFormatWidth(void) const; 1428 1429 /** 1430 * Set the width to which the output of format() is padded. 1431 * The width is counted in 16-bit code units. 1432 * This method also controls whether padding is enabled. 1433 * @param width the width to which to pad the result of 1434 * format(), or zero to disable padding. A negative 1435 * width is equivalent to 0. 1436 * @see #getFormatWidth 1437 * @see #getPadCharacterString 1438 * @see #setPadCharacter 1439 * @see #getPadPosition 1440 * @see #setPadPosition 1441 * @stable ICU 2.0 1442 */ 1443 virtual void setFormatWidth(int32_t width); 1444 1445 /** 1446 * Get the pad character used to pad to the format width. The 1447 * default is ' '. 1448 * @return a string containing the pad character. This will always 1449 * have a length of one 32-bit code point. 1450 * @see #setFormatWidth 1451 * @see #getFormatWidth 1452 * @see #setPadCharacter 1453 * @see #getPadPosition 1454 * @see #setPadPosition 1455 * @stable ICU 2.0 1456 */ 1457 virtual UnicodeString getPadCharacterString() const; 1458 1459 /** 1460 * Set the character used to pad to the format width. If padding 1461 * is not enabled, then this will take effect if padding is later 1462 * enabled. 1463 * @param padChar a string containing the pad character. If the string 1464 * has length 0, then the pad character is set to ' '. Otherwise 1465 * padChar.char32At(0) will be used as the pad character. 1466 * @see #setFormatWidth 1467 * @see #getFormatWidth 1468 * @see #getPadCharacterString 1469 * @see #getPadPosition 1470 * @see #setPadPosition 1471 * @stable ICU 2.0 1472 */ 1473 virtual void setPadCharacter(const UnicodeString& padChar); 1474 1475 /** 1476 * Get the position at which padding will take place. This is the location 1477 * at which padding will be inserted if the result of format() 1478 * is shorter than the format width. 1479 * @return the pad position, one of kPadBeforePrefix, 1480 * kPadAfterPrefix, kPadBeforeSuffix, or 1481 * kPadAfterSuffix. 1482 * @see #setFormatWidth 1483 * @see #getFormatWidth 1484 * @see #setPadCharacter 1485 * @see #getPadCharacterString 1486 * @see #setPadPosition 1487 * @see #EPadPosition 1488 * @stable ICU 2.0 1489 */ 1490 virtual EPadPosition getPadPosition(void) const; 1491 1492 /** 1493 * Set the position at which padding will take place. This is the location 1494 * at which padding will be inserted if the result of format() 1495 * is shorter than the format width. This has no effect unless padding is 1496 * enabled. 1497 * @param padPos the pad position, one of kPadBeforePrefix, 1498 * kPadAfterPrefix, kPadBeforeSuffix, or 1499 * kPadAfterSuffix. 1500 * @see #setFormatWidth 1501 * @see #getFormatWidth 1502 * @see #setPadCharacter 1503 * @see #getPadCharacterString 1504 * @see #getPadPosition 1505 * @see #EPadPosition 1506 * @stable ICU 2.0 1507 */ 1508 virtual void setPadPosition(EPadPosition padPos); 1509 1510 /** 1511 * Return whether or not scientific notation is used. 1512 * @return TRUE if this object formats and parses scientific notation 1513 * @see #setScientificNotation 1514 * @see #getMinimumExponentDigits 1515 * @see #setMinimumExponentDigits 1516 * @see #isExponentSignAlwaysShown 1517 * @see #setExponentSignAlwaysShown 1518 * @stable ICU 2.0 1519 */ 1520 virtual UBool isScientificNotation(void) const; 1521 1522 /** 1523 * Set whether or not scientific notation is used. When scientific notation 1524 * is used, the effective maximum number of integer digits is <= 8. If the 1525 * maximum number of integer digits is set to more than 8, the effective 1526 * maximum will be 1. This allows this call to generate a 'default' scientific 1527 * number format without additional changes. 1528 * @param useScientific TRUE if this object formats and parses scientific 1529 * notation 1530 * @see #isScientificNotation 1531 * @see #getMinimumExponentDigits 1532 * @see #setMinimumExponentDigits 1533 * @see #isExponentSignAlwaysShown 1534 * @see #setExponentSignAlwaysShown 1535 * @stable ICU 2.0 1536 */ 1537 virtual void setScientificNotation(UBool useScientific); 1538 1539 /** 1540 * Return the minimum exponent digits that will be shown. 1541 * @return the minimum exponent digits that will be shown 1542 * @see #setScientificNotation 1543 * @see #isScientificNotation 1544 * @see #setMinimumExponentDigits 1545 * @see #isExponentSignAlwaysShown 1546 * @see #setExponentSignAlwaysShown 1547 * @stable ICU 2.0 1548 */ 1549 virtual int8_t getMinimumExponentDigits(void) const; 1550 1551 /** 1552 * Set the minimum exponent digits that will be shown. This has no 1553 * effect unless scientific notation is in use. 1554 * @param minExpDig a value >= 1 indicating the fewest exponent digits 1555 * that will be shown. Values less than 1 will be treated as 1. 1556 * @see #setScientificNotation 1557 * @see #isScientificNotation 1558 * @see #getMinimumExponentDigits 1559 * @see #isExponentSignAlwaysShown 1560 * @see #setExponentSignAlwaysShown 1561 * @stable ICU 2.0 1562 */ 1563 virtual void setMinimumExponentDigits(int8_t minExpDig); 1564 1565 /** 1566 * Return whether the exponent sign is always shown. 1567 * @return TRUE if the exponent is always prefixed with either the 1568 * localized minus sign or the localized plus sign, false if only negative 1569 * exponents are prefixed with the localized minus sign. 1570 * @see #setScientificNotation 1571 * @see #isScientificNotation 1572 * @see #setMinimumExponentDigits 1573 * @see #getMinimumExponentDigits 1574 * @see #setExponentSignAlwaysShown 1575 * @stable ICU 2.0 1576 */ 1577 virtual UBool isExponentSignAlwaysShown(void) const; 1578 1579 /** 1580 * Set whether the exponent sign is always shown. This has no effect 1581 * unless scientific notation is in use. 1582 * @param expSignAlways TRUE if the exponent is always prefixed with either 1583 * the localized minus sign or the localized plus sign, false if only 1584 * negative exponents are prefixed with the localized minus sign. 1585 * @see #setScientificNotation 1586 * @see #isScientificNotation 1587 * @see #setMinimumExponentDigits 1588 * @see #getMinimumExponentDigits 1589 * @see #isExponentSignAlwaysShown 1590 * @stable ICU 2.0 1591 */ 1592 virtual void setExponentSignAlwaysShown(UBool expSignAlways); 1593 1594 /** 1595 * Return the grouping size. Grouping size is the number of digits between 1596 * grouping separators in the integer portion of a number. For example, 1597 * in the number "123,456.78", the grouping size is 3. 1598 * 1599 * @return the grouping size. 1600 * @see setGroupingSize 1601 * @see NumberFormat::isGroupingUsed 1602 * @see DecimalFormatSymbols::getGroupingSeparator 1603 * @stable ICU 2.0 1604 */ 1605 int32_t getGroupingSize(void) const; 1606 1607 /** 1608 * Set the grouping size. Grouping size is the number of digits between 1609 * grouping separators in the integer portion of a number. For example, 1610 * in the number "123,456.78", the grouping size is 3. 1611 * 1612 * @param newValue the new value of the grouping size. 1613 * @see getGroupingSize 1614 * @see NumberFormat::setGroupingUsed 1615 * @see DecimalFormatSymbols::setGroupingSeparator 1616 * @stable ICU 2.0 1617 */ 1618 virtual void setGroupingSize(int32_t newValue); 1619 1620 /** 1621 * Return the secondary grouping size. In some locales one 1622 * grouping interval is used for the least significant integer 1623 * digits (the primary grouping size), and another is used for all 1624 * others (the secondary grouping size). A formatter supporting a 1625 * secondary grouping size will return a positive integer unequal 1626 * to the primary grouping size returned by 1627 * getGroupingSize(). For example, if the primary 1628 * grouping size is 4, and the secondary grouping size is 2, then 1629 * the number 123456789 formats as "1,23,45,6789", and the pattern 1630 * appears as "#,##,###0". 1631 * @return the secondary grouping size, or a value less than 1632 * one if there is none 1633 * @see setSecondaryGroupingSize 1634 * @see NumberFormat::isGroupingUsed 1635 * @see DecimalFormatSymbols::getGroupingSeparator 1636 * @stable ICU 2.4 1637 */ 1638 int32_t getSecondaryGroupingSize(void) const; 1639 1640 /** 1641 * Set the secondary grouping size. If set to a value less than 1, 1642 * then secondary grouping is turned off, and the primary grouping 1643 * size is used for all intervals, not just the least significant. 1644 * 1645 * @param newValue the new value of the secondary grouping size. 1646 * @see getSecondaryGroupingSize 1647 * @see NumberFormat#setGroupingUsed 1648 * @see DecimalFormatSymbols::setGroupingSeparator 1649 * @stable ICU 2.4 1650 */ 1651 virtual void setSecondaryGroupingSize(int32_t newValue); 1652 1653 #ifndef U_HIDE_DRAFT_API 1654 /** 1655 * Returns the minimum number of grouping digits. 1656 * Grouping separators are output if there are at least this many 1657 * digits to the left of the first (rightmost) grouping separator, 1658 * that is, there are at least (minimum grouping + grouping size) integer digits. 1659 * (Subject to isGroupingUsed().) 1660 * 1661 * For example, if this value is 2, and the grouping size is 3, then 1662 * 9999 -> "9999" and 10000 -> "10,000" 1663 * 1664 * The default value for this attribute is 0. 1665 * A value of 1, 0, or lower, means that the use of grouping separators 1666 * only depends on the grouping size (and on isGroupingUsed()). 1667 * 1668 * NOTE: The CLDR data is used in NumberFormatter but not in DecimalFormat. 1669 * This is for backwards compatibility reasons. 1670 * 1671 * For more control over grouping strategies, use NumberFormatter. 1672 * 1673 * @see setMinimumGroupingDigits 1674 * @see getGroupingSize 1675 * @draft ICU 64 1676 */ 1677 int32_t getMinimumGroupingDigits() const; 1678 1679 /** 1680 * Sets the minimum grouping digits. Setting to a value less than or 1681 * equal to 1 turns off minimum grouping digits. 1682 * 1683 * For more control over grouping strategies, use NumberFormatter. 1684 * 1685 * @param newValue the new value of minimum grouping digits. 1686 * @see getMinimumGroupingDigits 1687 * @draft ICU 64 1688 */ 1689 void setMinimumGroupingDigits(int32_t newValue); 1690 #endif /* U_HIDE_DRAFT_API */ 1691 1692 1693 /** 1694 * Allows you to get the behavior of the decimal separator with integers. 1695 * (The decimal separator will always appear with decimals.) 1696 * 1697 * @return TRUE if the decimal separator always appear with decimals. 1698 * Example: Decimal ON: 12345 -> 12345.; OFF: 12345 -> 12345 1699 * @stable ICU 2.0 1700 */ 1701 UBool isDecimalSeparatorAlwaysShown(void) const; 1702 1703 /** 1704 * Allows you to set the behavior of the decimal separator with integers. 1705 * (The decimal separator will always appear with decimals.) 1706 * 1707 * @param newValue set TRUE if the decimal separator will always appear with decimals. 1708 * Example: Decimal ON: 12345 -> 12345.; OFF: 12345 -> 12345 1709 * @stable ICU 2.0 1710 */ 1711 virtual void setDecimalSeparatorAlwaysShown(UBool newValue); 1712 1713 /** 1714 * Allows you to get the parse behavior of the pattern decimal mark. 1715 * 1716 * @return TRUE if input must contain a match to decimal mark in pattern 1717 * @stable ICU 54 1718 */ 1719 UBool isDecimalPatternMatchRequired(void) const; 1720 1721 /** 1722 * Allows you to set the parse behavior of the pattern decimal mark. 1723 * 1724 * if TRUE, the input must have a decimal mark if one was specified in the pattern. When 1725 * FALSE the decimal mark may be omitted from the input. 1726 * 1727 * @param newValue set TRUE if input must contain a match to decimal mark in pattern 1728 * @stable ICU 54 1729 */ 1730 virtual void setDecimalPatternMatchRequired(UBool newValue); 1731 1732 #ifndef U_HIDE_DRAFT_API 1733 /** 1734 * Returns whether to ignore exponents when parsing. 1735 * 1736 * @return Whether to ignore exponents when parsing. 1737 * @see #setParseNoExponent 1738 * @draft ICU 64 1739 */ 1740 UBool isParseNoExponent() const; 1741 1742 /** 1743 * Specifies whether to stop parsing when an exponent separator is encountered. For 1744 * example, parses "123E4" to 123 (with parse position 3) instead of 1230000 (with parse position 1745 * 5). 1746 * 1747 * @param value true to prevent exponents from being parsed; false to allow them to be parsed. 1748 * @draft ICU 64 1749 */ 1750 void setParseNoExponent(UBool value); 1751 1752 /** 1753 * Returns whether parsing is sensitive to case (lowercase/uppercase). 1754 * 1755 * @return Whether parsing is case-sensitive. 1756 * @see #setParseCaseSensitive 1757 * @draft ICU 64 1758 */ 1759 UBool isParseCaseSensitive() const; 1760 1761 /** 1762 * Whether to pay attention to case when parsing; default is to ignore case (perform 1763 * case-folding). For example, "A" == "a" in case-insensitive but not case-sensitive mode. 1764 * 1765 * Currency symbols are never case-folded. For example, "us$1.00" will not parse in case-insensitive 1766 * mode, even though "US$1.00" parses. 1767 * 1768 * @param value true to enable case-sensitive parsing (the default); false to force 1769 * case-sensitive parsing behavior. 1770 * @draft ICU 64 1771 */ 1772 void setParseCaseSensitive(UBool value); 1773 1774 /** 1775 * Returns whether truncation of high-order integer digits should result in an error. 1776 * By default, setMaximumIntegerDigits truncates high-order digits silently. 1777 * 1778 * @return Whether an error code is set if high-order digits are truncated. 1779 * @see setFormatFailIfMoreThanMaxDigits 1780 * @draft ICU 64 1781 */ 1782 UBool isFormatFailIfMoreThanMaxDigits() const; 1783 1784 /** 1785 * Sets whether truncation of high-order integer digits should result in an error. 1786 * By default, setMaximumIntegerDigits truncates high-order digits silently. 1787 * 1788 * @param value Whether to set an error code if high-order digits are truncated. 1789 * @draft ICU 64 1790 */ 1791 void setFormatFailIfMoreThanMaxDigits(UBool value); 1792 #endif /* U_HIDE_DRAFT_API */ 1793 1794 1795 /** 1796 * Synthesizes a pattern string that represents the current state 1797 * of this Format object. 1798 * 1799 * @param result Output param which will receive the pattern. 1800 * Previous contents are deleted. 1801 * @return A reference to 'result'. 1802 * @see applyPattern 1803 * @stable ICU 2.0 1804 */ 1805 virtual UnicodeString& toPattern(UnicodeString& result) const; 1806 1807 /** 1808 * Synthesizes a localized pattern string that represents the current 1809 * state of this Format object. 1810 * 1811 * @param result Output param which will receive the localized pattern. 1812 * Previous contents are deleted. 1813 * @return A reference to 'result'. 1814 * @see applyPattern 1815 * @stable ICU 2.0 1816 */ 1817 virtual UnicodeString& toLocalizedPattern(UnicodeString& result) const; 1818 1819 /** 1820 * Apply the given pattern to this Format object. A pattern is a 1821 * short-hand specification for the various formatting properties. 1822 * These properties can also be changed individually through the 1823 * various setter methods. 1824 * <P> 1825 * There is no limit to integer digits are set 1826 * by this routine, since that is the typical end-user desire; 1827 * use setMaximumInteger if you want to set a real value. 1828 * For negative numbers, use a second pattern, separated by a semicolon 1829 * <pre> 1830 * . Example "#,#00.0#" -> 1,234.56 1831 * </pre> 1832 * This means a minimum of 2 integer digits, 1 fraction digit, and 1833 * a maximum of 2 fraction digits. 1834 * <pre> 1835 * . Example: "#,#00.0#;(#,#00.0#)" for negatives in parantheses. 1836 * </pre> 1837 * In negative patterns, the minimum and maximum counts are ignored; 1838 * these are presumed to be set in the positive pattern. 1839 * 1840 * @param pattern The pattern to be applied. 1841 * @param parseError Struct to recieve information on position 1842 * of error if an error is encountered 1843 * @param status Output param set to success/failure code on 1844 * exit. If the pattern is invalid, this will be 1845 * set to a failure result. 1846 * @stable ICU 2.0 1847 */ 1848 virtual void applyPattern(const UnicodeString& pattern, UParseError& parseError, UErrorCode& status); 1849 1850 /** 1851 * Sets the pattern. 1852 * @param pattern The pattern to be applied. 1853 * @param status Output param set to success/failure code on 1854 * exit. If the pattern is invalid, this will be 1855 * set to a failure result. 1856 * @stable ICU 2.0 1857 */ 1858 virtual void applyPattern(const UnicodeString& pattern, UErrorCode& status); 1859 1860 /** 1861 * Apply the given pattern to this Format object. The pattern 1862 * is assumed to be in a localized notation. A pattern is a 1863 * short-hand specification for the various formatting properties. 1864 * These properties can also be changed individually through the 1865 * various setter methods. 1866 * <P> 1867 * There is no limit to integer digits are set 1868 * by this routine, since that is the typical end-user desire; 1869 * use setMaximumInteger if you want to set a real value. 1870 * For negative numbers, use a second pattern, separated by a semicolon 1871 * <pre> 1872 * . Example "#,#00.0#" -> 1,234.56 1873 * </pre> 1874 * This means a minimum of 2 integer digits, 1 fraction digit, and 1875 * a maximum of 2 fraction digits. 1876 * 1877 * Example: "#,#00.0#;(#,#00.0#)" for negatives in parantheses. 1878 * 1879 * In negative patterns, the minimum and maximum counts are ignored; 1880 * these are presumed to be set in the positive pattern. 1881 * 1882 * @param pattern The localized pattern to be applied. 1883 * @param parseError Struct to recieve information on position 1884 * of error if an error is encountered 1885 * @param status Output param set to success/failure code on 1886 * exit. If the pattern is invalid, this will be 1887 * set to a failure result. 1888 * @stable ICU 2.0 1889 */ 1890 virtual void applyLocalizedPattern(const UnicodeString& pattern, UParseError& parseError, 1891 UErrorCode& status); 1892 1893 /** 1894 * Apply the given pattern to this Format object. 1895 * 1896 * @param pattern The localized pattern to be applied. 1897 * @param status Output param set to success/failure code on 1898 * exit. If the pattern is invalid, this will be 1899 * set to a failure result. 1900 * @stable ICU 2.0 1901 */ 1902 virtual void applyLocalizedPattern(const UnicodeString& pattern, UErrorCode& status); 1903 1904 1905 /** 1906 * Sets the maximum number of digits allowed in the integer portion of a 1907 * number. This override limits the integer digit count to 309. 1908 * 1909 * @param newValue the new value of the maximum number of digits 1910 * allowed in the integer portion of a number. 1911 * @see NumberFormat#setMaximumIntegerDigits 1912 * @stable ICU 2.0 1913 */ 1914 void setMaximumIntegerDigits(int32_t newValue) U_OVERRIDE; 1915 1916 /** 1917 * Sets the minimum number of digits allowed in the integer portion of a 1918 * number. This override limits the integer digit count to 309. 1919 * 1920 * @param newValue the new value of the minimum number of digits 1921 * allowed in the integer portion of a number. 1922 * @see NumberFormat#setMinimumIntegerDigits 1923 * @stable ICU 2.0 1924 */ 1925 void setMinimumIntegerDigits(int32_t newValue) U_OVERRIDE; 1926 1927 /** 1928 * Sets the maximum number of digits allowed in the fraction portion of a 1929 * number. This override limits the fraction digit count to 340. 1930 * 1931 * @param newValue the new value of the maximum number of digits 1932 * allowed in the fraction portion of a number. 1933 * @see NumberFormat#setMaximumFractionDigits 1934 * @stable ICU 2.0 1935 */ 1936 void setMaximumFractionDigits(int32_t newValue) U_OVERRIDE; 1937 1938 /** 1939 * Sets the minimum number of digits allowed in the fraction portion of a 1940 * number. This override limits the fraction digit count to 340. 1941 * 1942 * @param newValue the new value of the minimum number of digits 1943 * allowed in the fraction portion of a number. 1944 * @see NumberFormat#setMinimumFractionDigits 1945 * @stable ICU 2.0 1946 */ 1947 void setMinimumFractionDigits(int32_t newValue) U_OVERRIDE; 1948 1949 /** 1950 * Returns the minimum number of significant digits that will be 1951 * displayed. This value has no effect unless areSignificantDigitsUsed() 1952 * returns true. 1953 * @return the fewest significant digits that will be shown 1954 * @stable ICU 3.0 1955 */ 1956 int32_t getMinimumSignificantDigits() const; 1957 1958 /** 1959 * Returns the maximum number of significant digits that will be 1960 * displayed. This value has no effect unless areSignificantDigitsUsed() 1961 * returns true. 1962 * @return the most significant digits that will be shown 1963 * @stable ICU 3.0 1964 */ 1965 int32_t getMaximumSignificantDigits() const; 1966 1967 /** 1968 * Sets the minimum number of significant digits that will be 1969 * displayed. If <code>min</code> is less than one then it is set 1970 * to one. If the maximum significant digits count is less than 1971 * <code>min</code>, then it is set to <code>min</code>. 1972 * This function also enables the use of significant digits 1973 * by this formatter - areSignificantDigitsUsed() will return TRUE. 1974 * @see #areSignificantDigitsUsed 1975 * @param min the fewest significant digits to be shown 1976 * @stable ICU 3.0 1977 */ 1978 void setMinimumSignificantDigits(int32_t min); 1979 1980 /** 1981 * Sets the maximum number of significant digits that will be 1982 * displayed. If <code>max</code> is less than one then it is set 1983 * to one. If the minimum significant digits count is greater 1984 * than <code>max</code>, then it is set to <code>max</code>. 1985 * This function also enables the use of significant digits 1986 * by this formatter - areSignificantDigitsUsed() will return TRUE. 1987 * @see #areSignificantDigitsUsed 1988 * @param max the most significant digits to be shown 1989 * @stable ICU 3.0 1990 */ 1991 void setMaximumSignificantDigits(int32_t max); 1992 1993 /** 1994 * Returns true if significant digits are in use, or false if 1995 * integer and fraction digit counts are in use. 1996 * @return true if significant digits are in use 1997 * @stable ICU 3.0 1998 */ 1999 UBool areSignificantDigitsUsed() const; 2000 2001 /** 2002 * Sets whether significant digits are in use, or integer and 2003 * fraction digit counts are in use. 2004 * @param useSignificantDigits true to use significant digits, or 2005 * false to use integer and fraction digit counts 2006 * @stable ICU 3.0 2007 */ 2008 void setSignificantDigitsUsed(UBool useSignificantDigits); 2009 2010 /** 2011 * Sets the currency used to display currency 2012 * amounts. This takes effect immediately, if this format is a 2013 * currency format. If this format is not a currency format, then 2014 * the currency is used if and when this object becomes a 2015 * currency format through the application of a new pattern. 2016 * @param theCurrency a 3-letter ISO code indicating new currency 2017 * to use. It need not be null-terminated. May be the empty 2018 * string or NULL to indicate no currency. 2019 * @param ec input-output error code 2020 * @stable ICU 3.0 2021 */ 2022 void setCurrency(const char16_t* theCurrency, UErrorCode& ec) U_OVERRIDE; 2023 2024 #ifndef U_FORCE_HIDE_DEPRECATED_API 2025 /** 2026 * Sets the currency used to display currency amounts. See 2027 * setCurrency(const char16_t*, UErrorCode&). 2028 * @deprecated ICU 3.0. Use setCurrency(const char16_t*, UErrorCode&). 2029 */ 2030 virtual void setCurrency(const char16_t* theCurrency); 2031 #endif // U_FORCE_HIDE_DEPRECATED_API 2032 2033 /** 2034 * Sets the `Currency Usage` object used to display currency. 2035 * This takes effect immediately, if this format is a 2036 * currency format. 2037 * @param newUsage new currency usage object to use. 2038 * @param ec input-output error code 2039 * @stable ICU 54 2040 */ 2041 void setCurrencyUsage(UCurrencyUsage newUsage, UErrorCode* ec); 2042 2043 /** 2044 * Returns the `Currency Usage` object used to display currency 2045 * @stable ICU 54 2046 */ 2047 UCurrencyUsage getCurrencyUsage() const; 2048 2049 #ifndef U_HIDE_INTERNAL_API 2050 2051 /** 2052 * Format a number and save it into the given DecimalQuantity. 2053 * Internal, not intended for public use. 2054 * @internal 2055 */ 2056 void formatToDecimalQuantity(double number, number::impl::DecimalQuantity& output, 2057 UErrorCode& status) const; 2058 2059 /** 2060 * Get a DecimalQuantity corresponding to a formattable as it would be 2061 * formatted by this DecimalFormat. 2062 * Internal, not intended for public use. 2063 * @internal 2064 */ 2065 void formatToDecimalQuantity(const Formattable& number, number::impl::DecimalQuantity& output, 2066 UErrorCode& status) const; 2067 2068 #endif /* U_HIDE_INTERNAL_API */ 2069 2070 #ifndef U_HIDE_DRAFT_API 2071 /** 2072 * Converts this DecimalFormat to a (Localized)NumberFormatter. Starting 2073 * in ICU 60, NumberFormatter is the recommended way to format numbers. 2074 * You can use the returned LocalizedNumberFormatter to format numbers and 2075 * get a FormattedNumber, which contains a string as well as additional 2076 * annotations about the formatted value. 2077 * 2078 * If a memory allocation failure occurs, the return value of this method 2079 * might be null. If you are concerned about correct recovery from 2080 * out-of-memory situations, use this pattern: 2081 * 2082 * <pre> 2083 * FormattedNumber result; 2084 * if (auto* ptr = df->toNumberFormatter(status)) { 2085 * result = ptr->formatDouble(123, status); 2086 * } 2087 * </pre> 2088 * 2089 * If you are not concerned about out-of-memory situations, or if your 2090 * environment throws exceptions when memory allocation failure occurs, 2091 * you can chain the methods, like this: 2092 * 2093 * <pre> 2094 * FormattedNumber result = df 2095 * ->toNumberFormatter(status) 2096 * ->formatDouble(123, status); 2097 * </pre> 2098 * 2099 * NOTE: The returned LocalizedNumberFormatter is owned by this DecimalFormat. 2100 * If a non-const method is called on the DecimalFormat, or if the DecimalFormat 2101 * is deleted, the object becomes invalid. If you plan to keep the return value 2102 * beyond the lifetime of the DecimalFormat, copy it to a local variable: 2103 * 2104 * <pre> 2105 * LocalizedNumberFormatter lnf; 2106 * if (auto* ptr = df->toNumberFormatter(status)) { 2107 * lnf = *ptr; 2108 * } 2109 * </pre> 2110 * 2111 * @param status Set on failure, like U_MEMORY_ALLOCATION_ERROR. 2112 * @return A pointer to an internal object, or nullptr on failure. 2113 * Do not delete the return value! 2114 * @draft ICU 64 2115 */ 2116 const number::LocalizedNumberFormatter* toNumberFormatter(UErrorCode& status) const; 2117 #endif /* U_HIDE_DRAFT_API */ 2118 2119 /** 2120 * Return the class ID for this class. This is useful only for 2121 * comparing to a return value from getDynamicClassID(). For example: 2122 * <pre> 2123 * . Base* polymorphic_pointer = createPolymorphicObject(); 2124 * . if (polymorphic_pointer->getDynamicClassID() == 2125 * . Derived::getStaticClassID()) ... 2126 * </pre> 2127 * @return The class ID for all objects of this class. 2128 * @stable ICU 2.0 2129 */ 2130 static UClassID U_EXPORT2 getStaticClassID(void); 2131 2132 /** 2133 * Returns a unique class ID POLYMORPHICALLY. Pure virtual override. 2134 * This method is to implement a simple version of RTTI, since not all 2135 * C++ compilers support genuine RTTI. Polymorphic operator==() and 2136 * clone() methods call this method. 2137 * 2138 * @return The class ID for this object. All objects of a 2139 * given class have the same class ID. Objects of 2140 * other classes have different class IDs. 2141 * @stable ICU 2.0 2142 */ 2143 UClassID getDynamicClassID(void) const U_OVERRIDE; 2144 2145 private: 2146 2147 /** Rebuilds the formatter object from the property bag. */ 2148 void touch(UErrorCode& status); 2149 2150 /** Rebuilds the formatter object, ignoring any error code. */ 2151 void touchNoError(); 2152 2153 /** 2154 * Updates the property bag with settings from the given pattern. 2155 * 2156 * @param pattern The pattern string to parse. 2157 * @param ignoreRounding Whether to leave out rounding information (minFrac, maxFrac, and rounding 2158 * increment) when parsing the pattern. This may be desirable if a custom rounding mode, such 2159 * as CurrencyUsage, is to be used instead. One of {@link 2160 * PatternStringParser#IGNORE_ROUNDING_ALWAYS}, {@link PatternStringParser#IGNORE_ROUNDING_IF_CURRENCY}, 2161 * or {@link PatternStringParser#IGNORE_ROUNDING_NEVER}. 2162 * @see PatternAndPropertyUtils#parseToExistingProperties 2163 */ 2164 void setPropertiesFromPattern(const UnicodeString& pattern, int32_t ignoreRounding, 2165 UErrorCode& status); 2166 2167 const numparse::impl::NumberParserImpl* getParser(UErrorCode& status) const; 2168 2169 const numparse::impl::NumberParserImpl* getCurrencyParser(UErrorCode& status) const; 2170 2171 static void fieldPositionHelper(const number::FormattedNumber& formatted, FieldPosition& fieldPosition, 2172 int32_t offset, UErrorCode& status); 2173 2174 static void fieldPositionIteratorHelper(const number::FormattedNumber& formatted, 2175 FieldPositionIterator* fpi, int32_t offset, UErrorCode& status); 2176 2177 void setupFastFormat(); 2178 2179 bool fastFormatDouble(double input, UnicodeString& output) const; 2180 2181 bool fastFormatInt64(int64_t input, UnicodeString& output) const; 2182 2183 void doFastFormatInt32(int32_t input, bool isNegative, UnicodeString& output) const; 2184 2185 //=====================================================================================// 2186 // INSTANCE FIELDS // 2187 //=====================================================================================// 2188 2189 2190 // One instance field for the implementation, keep all fields inside of an implementation 2191 // class defined in number_mapper.h 2192 number::impl::DecimalFormatFields* fields = nullptr; 2193 2194 // Allow child class CompactDecimalFormat to access fProperties: 2195 friend class CompactDecimalFormat; 2196 2197 // Allow MeasureFormat to use fieldPositionHelper: 2198 friend class MeasureFormat; 2199 2200 }; 2201 2202 U_NAMESPACE_END 2203 2204 #endif /* #if !UCONFIG_NO_FORMATTING */ 2205 2206 #endif /* U_SHOW_CPLUSPLUS_API */ 2207 2208 #endif // _DECIMFMT 2209 //eof 2210