NumberFormat.cpp 79 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881
  1. /*
  2. * Copyright (c) 2021-2023, Tim Flynn <trflynn89@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/Checked.h>
  7. #include <AK/Utf8View.h>
  8. #include <LibCrypto/BigInt/SignedBigInteger.h>
  9. #include <LibJS/Runtime/AbstractOperations.h>
  10. #include <LibJS/Runtime/Array.h>
  11. #include <LibJS/Runtime/BigInt.h>
  12. #include <LibJS/Runtime/GlobalObject.h>
  13. #include <LibJS/Runtime/Intl/NumberFormat.h>
  14. #include <LibJS/Runtime/Intl/NumberFormatFunction.h>
  15. #include <LibJS/Runtime/Intl/PluralRules.h>
  16. #include <LibUnicode/CurrencyCode.h>
  17. #include <math.h>
  18. #include <stdlib.h>
  19. namespace JS::Intl {
  20. NumberFormatBase::NumberFormatBase(Object& prototype)
  21. : Object(ConstructWithPrototypeTag::Tag, prototype)
  22. {
  23. }
  24. // 15 NumberFormat Objects, https://tc39.es/ecma402/#numberformat-objects
  25. NumberFormat::NumberFormat(Object& prototype)
  26. : NumberFormatBase(prototype)
  27. {
  28. }
  29. void NumberFormat::visit_edges(Cell::Visitor& visitor)
  30. {
  31. Base::visit_edges(visitor);
  32. if (m_bound_format)
  33. visitor.visit(m_bound_format);
  34. }
  35. void NumberFormat::set_style(StringView style)
  36. {
  37. if (style == "decimal"sv)
  38. m_style = Style::Decimal;
  39. else if (style == "percent"sv)
  40. m_style = Style::Percent;
  41. else if (style == "currency"sv)
  42. m_style = Style::Currency;
  43. else if (style == "unit"sv)
  44. m_style = Style::Unit;
  45. else
  46. VERIFY_NOT_REACHED();
  47. }
  48. StringView NumberFormat::style_string() const
  49. {
  50. switch (m_style) {
  51. case Style::Decimal:
  52. return "decimal"sv;
  53. case Style::Percent:
  54. return "percent"sv;
  55. case Style::Currency:
  56. return "currency"sv;
  57. case Style::Unit:
  58. return "unit"sv;
  59. default:
  60. VERIFY_NOT_REACHED();
  61. }
  62. }
  63. void NumberFormat::set_currency_display(StringView currency_display)
  64. {
  65. m_resolved_currency_display.clear();
  66. if (currency_display == "code"sv)
  67. m_currency_display = CurrencyDisplay::Code;
  68. else if (currency_display == "symbol"sv)
  69. m_currency_display = CurrencyDisplay::Symbol;
  70. else if (currency_display == "narrowSymbol"sv)
  71. m_currency_display = CurrencyDisplay::NarrowSymbol;
  72. else if (currency_display == "name"sv)
  73. m_currency_display = CurrencyDisplay::Name;
  74. else
  75. VERIFY_NOT_REACHED();
  76. }
  77. StringView NumberFormat::resolve_currency_display()
  78. {
  79. if (m_resolved_currency_display.has_value())
  80. return *m_resolved_currency_display;
  81. switch (currency_display()) {
  82. case NumberFormat::CurrencyDisplay::Code:
  83. m_resolved_currency_display = currency();
  84. break;
  85. case NumberFormat::CurrencyDisplay::Symbol:
  86. m_resolved_currency_display = ::Locale::get_locale_short_currency_mapping(data_locale(), currency());
  87. break;
  88. case NumberFormat::CurrencyDisplay::NarrowSymbol:
  89. m_resolved_currency_display = ::Locale::get_locale_narrow_currency_mapping(data_locale(), currency());
  90. break;
  91. case NumberFormat::CurrencyDisplay::Name:
  92. m_resolved_currency_display = ::Locale::get_locale_numeric_currency_mapping(data_locale(), currency());
  93. break;
  94. default:
  95. VERIFY_NOT_REACHED();
  96. }
  97. if (!m_resolved_currency_display.has_value())
  98. m_resolved_currency_display = currency();
  99. return *m_resolved_currency_display;
  100. }
  101. StringView NumberFormat::currency_display_string() const
  102. {
  103. VERIFY(m_currency_display.has_value());
  104. switch (*m_currency_display) {
  105. case CurrencyDisplay::Code:
  106. return "code"sv;
  107. case CurrencyDisplay::Symbol:
  108. return "symbol"sv;
  109. case CurrencyDisplay::NarrowSymbol:
  110. return "narrowSymbol"sv;
  111. case CurrencyDisplay::Name:
  112. return "name"sv;
  113. default:
  114. VERIFY_NOT_REACHED();
  115. }
  116. }
  117. void NumberFormat::set_currency_sign(StringView currency_sign)
  118. {
  119. if (currency_sign == "standard"sv)
  120. m_currency_sign = CurrencySign::Standard;
  121. else if (currency_sign == "accounting"sv)
  122. m_currency_sign = CurrencySign::Accounting;
  123. else
  124. VERIFY_NOT_REACHED();
  125. }
  126. StringView NumberFormat::currency_sign_string() const
  127. {
  128. VERIFY(m_currency_sign.has_value());
  129. switch (*m_currency_sign) {
  130. case CurrencySign::Standard:
  131. return "standard"sv;
  132. case CurrencySign::Accounting:
  133. return "accounting"sv;
  134. default:
  135. VERIFY_NOT_REACHED();
  136. }
  137. }
  138. StringView NumberFormatBase::rounding_type_string() const
  139. {
  140. switch (m_rounding_type) {
  141. case RoundingType::SignificantDigits:
  142. return "significantDigits"sv;
  143. case RoundingType::FractionDigits:
  144. return "fractionDigits"sv;
  145. case RoundingType::MorePrecision:
  146. return "morePrecision"sv;
  147. case RoundingType::LessPrecision:
  148. return "lessPrecision"sv;
  149. default:
  150. VERIFY_NOT_REACHED();
  151. }
  152. }
  153. StringView NumberFormatBase::rounding_mode_string() const
  154. {
  155. switch (m_rounding_mode) {
  156. case RoundingMode::Ceil:
  157. return "ceil"sv;
  158. case RoundingMode::Expand:
  159. return "expand"sv;
  160. case RoundingMode::Floor:
  161. return "floor"sv;
  162. case RoundingMode::HalfCeil:
  163. return "halfCeil"sv;
  164. case RoundingMode::HalfEven:
  165. return "halfEven"sv;
  166. case RoundingMode::HalfExpand:
  167. return "halfExpand"sv;
  168. case RoundingMode::HalfFloor:
  169. return "halfFloor"sv;
  170. case RoundingMode::HalfTrunc:
  171. return "halfTrunc"sv;
  172. case RoundingMode::Trunc:
  173. return "trunc"sv;
  174. default:
  175. VERIFY_NOT_REACHED();
  176. }
  177. }
  178. void NumberFormatBase::set_rounding_mode(StringView rounding_mode)
  179. {
  180. if (rounding_mode == "ceil"sv)
  181. m_rounding_mode = RoundingMode::Ceil;
  182. else if (rounding_mode == "expand"sv)
  183. m_rounding_mode = RoundingMode::Expand;
  184. else if (rounding_mode == "floor"sv)
  185. m_rounding_mode = RoundingMode::Floor;
  186. else if (rounding_mode == "halfCeil"sv)
  187. m_rounding_mode = RoundingMode::HalfCeil;
  188. else if (rounding_mode == "halfEven"sv)
  189. m_rounding_mode = RoundingMode::HalfEven;
  190. else if (rounding_mode == "halfExpand"sv)
  191. m_rounding_mode = RoundingMode::HalfExpand;
  192. else if (rounding_mode == "halfFloor"sv)
  193. m_rounding_mode = RoundingMode::HalfFloor;
  194. else if (rounding_mode == "halfTrunc"sv)
  195. m_rounding_mode = RoundingMode::HalfTrunc;
  196. else if (rounding_mode == "trunc"sv)
  197. m_rounding_mode = RoundingMode::Trunc;
  198. else
  199. VERIFY_NOT_REACHED();
  200. }
  201. StringView NumberFormatBase::trailing_zero_display_string() const
  202. {
  203. switch (m_trailing_zero_display) {
  204. case TrailingZeroDisplay::Auto:
  205. return "auto"sv;
  206. case TrailingZeroDisplay::StripIfInteger:
  207. return "stripIfInteger"sv;
  208. default:
  209. VERIFY_NOT_REACHED();
  210. }
  211. }
  212. void NumberFormatBase::set_trailing_zero_display(StringView trailing_zero_display)
  213. {
  214. if (trailing_zero_display == "auto"sv)
  215. m_trailing_zero_display = TrailingZeroDisplay::Auto;
  216. else if (trailing_zero_display == "stripIfInteger"sv)
  217. m_trailing_zero_display = TrailingZeroDisplay::StripIfInteger;
  218. else
  219. VERIFY_NOT_REACHED();
  220. }
  221. Value NumberFormat::use_grouping_to_value(VM& vm) const
  222. {
  223. switch (m_use_grouping) {
  224. case UseGrouping::Always:
  225. return PrimitiveString::create(vm, "always"sv);
  226. case UseGrouping::Auto:
  227. return PrimitiveString::create(vm, "auto"sv);
  228. case UseGrouping::Min2:
  229. return PrimitiveString::create(vm, "min2"sv);
  230. case UseGrouping::False:
  231. return Value(false);
  232. default:
  233. VERIFY_NOT_REACHED();
  234. }
  235. }
  236. void NumberFormat::set_use_grouping(StringOrBoolean const& use_grouping)
  237. {
  238. use_grouping.visit(
  239. [this](StringView grouping) {
  240. if (grouping == "always"sv)
  241. m_use_grouping = UseGrouping::Always;
  242. else if (grouping == "auto"sv)
  243. m_use_grouping = UseGrouping::Auto;
  244. else if (grouping == "min2"sv)
  245. m_use_grouping = UseGrouping::Min2;
  246. else
  247. VERIFY_NOT_REACHED();
  248. },
  249. [this](bool grouping) {
  250. VERIFY(!grouping);
  251. m_use_grouping = UseGrouping::False;
  252. });
  253. }
  254. void NumberFormat::set_notation(StringView notation)
  255. {
  256. if (notation == "standard"sv)
  257. m_notation = Notation::Standard;
  258. else if (notation == "scientific"sv)
  259. m_notation = Notation::Scientific;
  260. else if (notation == "engineering"sv)
  261. m_notation = Notation::Engineering;
  262. else if (notation == "compact"sv)
  263. m_notation = Notation::Compact;
  264. else
  265. VERIFY_NOT_REACHED();
  266. }
  267. StringView NumberFormat::notation_string() const
  268. {
  269. switch (m_notation) {
  270. case Notation::Standard:
  271. return "standard"sv;
  272. case Notation::Scientific:
  273. return "scientific"sv;
  274. case Notation::Engineering:
  275. return "engineering"sv;
  276. case Notation::Compact:
  277. return "compact"sv;
  278. default:
  279. VERIFY_NOT_REACHED();
  280. }
  281. }
  282. void NumberFormat::set_compact_display(StringView compact_display)
  283. {
  284. if (compact_display == "short"sv)
  285. m_compact_display = CompactDisplay::Short;
  286. else if (compact_display == "long"sv)
  287. m_compact_display = CompactDisplay::Long;
  288. else
  289. VERIFY_NOT_REACHED();
  290. }
  291. StringView NumberFormat::compact_display_string() const
  292. {
  293. VERIFY(m_compact_display.has_value());
  294. switch (*m_compact_display) {
  295. case CompactDisplay::Short:
  296. return "short"sv;
  297. case CompactDisplay::Long:
  298. return "long"sv;
  299. default:
  300. VERIFY_NOT_REACHED();
  301. }
  302. }
  303. void NumberFormat::set_sign_display(StringView sign_display)
  304. {
  305. if (sign_display == "auto"sv)
  306. m_sign_display = SignDisplay::Auto;
  307. else if (sign_display == "never"sv)
  308. m_sign_display = SignDisplay::Never;
  309. else if (sign_display == "always"sv)
  310. m_sign_display = SignDisplay::Always;
  311. else if (sign_display == "exceptZero"sv)
  312. m_sign_display = SignDisplay::ExceptZero;
  313. else if (sign_display == "negative"sv)
  314. m_sign_display = SignDisplay::Negative;
  315. else
  316. VERIFY_NOT_REACHED();
  317. }
  318. StringView NumberFormat::sign_display_string() const
  319. {
  320. switch (m_sign_display) {
  321. case SignDisplay::Auto:
  322. return "auto"sv;
  323. case SignDisplay::Never:
  324. return "never"sv;
  325. case SignDisplay::Always:
  326. return "always"sv;
  327. case SignDisplay::ExceptZero:
  328. return "exceptZero"sv;
  329. case SignDisplay::Negative:
  330. return "negative"sv;
  331. default:
  332. VERIFY_NOT_REACHED();
  333. }
  334. }
  335. // 15.5.1 CurrencyDigits ( currency ), https://tc39.es/ecma402/#sec-currencydigits
  336. int currency_digits(StringView currency)
  337. {
  338. // 1. If the ISO 4217 currency and funds code list contains currency as an alphabetic code, return the minor
  339. // unit value corresponding to the currency from the list; otherwise, return 2.
  340. if (auto currency_code = Unicode::get_currency_code(currency); currency_code.has_value())
  341. return currency_code->minor_unit.value_or(2);
  342. return 2;
  343. }
  344. // 15.5.3 FormatNumericToString ( intlObject, x ), https://tc39.es/ecma402/#sec-formatnumberstring
  345. // 1.5.3 FormatNumericToString ( intlObject, x ), https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#sec-formatnumberstring
  346. FormatResult format_numeric_to_string(NumberFormatBase const& intl_object, MathematicalValue number)
  347. {
  348. bool is_negative = false;
  349. // 1. If x is negative-zero, then
  350. if (number.is_negative_zero()) {
  351. // a. Let isNegative be true.
  352. is_negative = true;
  353. // b. Set x to 0.
  354. number = MathematicalValue(0.0);
  355. }
  356. // 2. Else,
  357. else {
  358. // a. Assert: x is a mathematical value.
  359. VERIFY(number.is_mathematical_value());
  360. // b. If x < 0, let isNegative be true; else let isNegative be false.
  361. is_negative = number.is_negative();
  362. // c. If isNegative, then
  363. if (is_negative) {
  364. // i. Set x to -x.
  365. number.negate();
  366. }
  367. }
  368. // 3. Let unsignedRoundingMode be GetUnsignedRoundingMode(intlObject.[[RoundingMode]], isNegative).
  369. // FIXME: Spec issue: Intl.PluralRules does not have [[RoundingMode]], see https://github.com/tc39/proposal-intl-numberformat-v3/issues/103
  370. Optional<NumberFormat::UnsignedRoundingMode> unsigned_rounding_mode;
  371. if (intl_object.rounding_mode() != NumberFormat::RoundingMode::Invalid)
  372. unsigned_rounding_mode = get_unsigned_rounding_mode(intl_object.rounding_mode(), is_negative);
  373. RawFormatResult result {};
  374. switch (intl_object.rounding_type()) {
  375. // 4. If intlObject.[[RoundingType]] is significantDigits, then
  376. case NumberFormatBase::RoundingType::SignificantDigits:
  377. // a. Let result be ToRawPrecision(x, intlObject.[[MinimumSignificantDigits]], intlObject.[[MaximumSignificantDigits]], unsignedRoundingMode).
  378. result = to_raw_precision(number, intl_object.min_significant_digits(), intl_object.max_significant_digits(), unsigned_rounding_mode);
  379. break;
  380. // 5. Else if intlObject.[[RoundingType]] is fractionDigits, then
  381. case NumberFormatBase::RoundingType::FractionDigits:
  382. // a. Let result be ToRawFixed(x, intlObject.[[MinimumFractionDigits]], intlObject.[[MaximumFractionDigits]], intlObject.[[RoundingIncrement]], unsignedRoundingMode).
  383. result = to_raw_fixed(number, intl_object.min_fraction_digits(), intl_object.max_fraction_digits(), intl_object.rounding_increment(), unsigned_rounding_mode);
  384. break;
  385. // 6. Else,
  386. case NumberFormatBase::RoundingType::MorePrecision:
  387. case NumberFormatBase::RoundingType::LessPrecision: {
  388. // a. Let sResult be ToRawPrecision(x, intlObject.[[MinimumSignificantDigits]], intlObject.[[MaximumSignificantDigits]], unsignedRoundingMode).
  389. auto significant_result = to_raw_precision(number, intl_object.min_significant_digits(), intl_object.max_significant_digits(), unsigned_rounding_mode);
  390. // b. Let fResult be ToRawFixed(x, intlObject.[[MinimumFractionDigits]], intlObject.[[MaximumFractionDigits]], intlObject.[[RoundingIncrement]], unsignedRoundingMode).
  391. auto fraction_result = to_raw_fixed(number, intl_object.min_fraction_digits(), intl_object.max_fraction_digits(), intl_object.rounding_increment(), unsigned_rounding_mode);
  392. // c. If intlObj.[[RoundingType]] is morePrecision, then
  393. if (intl_object.rounding_type() == NumberFormatBase::RoundingType::MorePrecision) {
  394. // i. If sResult.[[RoundingMagnitude]] ≤ fResult.[[RoundingMagnitude]], then
  395. if (significant_result.rounding_magnitude <= fraction_result.rounding_magnitude) {
  396. // 1. Let result be sResult.
  397. result = move(significant_result);
  398. }
  399. // ii. Else,
  400. else {
  401. // 2. Let result be fResult.
  402. result = move(fraction_result);
  403. }
  404. }
  405. // d. Else,
  406. else {
  407. // i. Assert: intlObj.[[RoundingType]] is lessPrecision.
  408. VERIFY(intl_object.rounding_type() == NumberFormatBase::RoundingType::LessPrecision);
  409. // ii. If sResult.[[RoundingMagnitude]] ≤ fResult.[[RoundingMagnitude]], then
  410. if (significant_result.rounding_magnitude <= fraction_result.rounding_magnitude) {
  411. // 1. Let result be fResult.
  412. result = move(fraction_result);
  413. }
  414. // iii. Else,
  415. else {
  416. // 1. Let result be sResult.
  417. result = move(significant_result);
  418. }
  419. }
  420. break;
  421. }
  422. default:
  423. VERIFY_NOT_REACHED();
  424. }
  425. // 7. Let x be result.[[RoundedNumber]].
  426. number = move(result.rounded_number);
  427. // 8. Let string be result.[[FormattedString]].
  428. auto string = move(result.formatted_string);
  429. // 9. If intlObject.[[TrailingZeroDisplay]] is "stripIfInteger" and x modulo 1 = 0, then
  430. if ((intl_object.trailing_zero_display() == NumberFormat::TrailingZeroDisplay::StripIfInteger) && number.modulo_is_zero(1)) {
  431. // a. If string contains ".", then
  432. if (auto index = string.find('.'); index.has_value()) {
  433. // i. Set string to the substring of string from index 0 to the index of ".".
  434. string = string.substring(0, *index);
  435. }
  436. }
  437. // 10. Let int be result.[[IntegerDigitsCount]].
  438. int digits = result.digits;
  439. // 11. Let minInteger be intlObject.[[MinimumIntegerDigits]].
  440. int min_integer = intl_object.min_integer_digits();
  441. // 12. If int < minInteger, then
  442. if (digits < min_integer) {
  443. // a. Let forwardZeros be the String consisting of minInteger–int occurrences of the character "0".
  444. auto forward_zeros = DeprecatedString::repeated('0', min_integer - digits);
  445. // b. Set string to the string-concatenation of forwardZeros and string.
  446. string = DeprecatedString::formatted("{}{}", forward_zeros, string);
  447. }
  448. // 13. If isNegative and x is 0, then
  449. if (is_negative && number.is_zero()) {
  450. // a. Let x be -0.
  451. number = MathematicalValue { MathematicalValue::Symbol::NegativeZero };
  452. }
  453. // 14. Else if isNegative, then
  454. else if (is_negative) {
  455. // b. Let x be -x.
  456. number.negate();
  457. }
  458. // 15. Return the Record { [[RoundedNumber]]: x, [[FormattedString]]: string }.
  459. return { move(string), move(number) };
  460. }
  461. // 15.5.4 PartitionNumberPattern ( numberFormat, x ), https://tc39.es/ecma402/#sec-partitionnumberpattern
  462. // 1.5.4 PartitionNumberPattern ( numberFormat, x ), https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#sec-partitionnumberpattern
  463. Vector<PatternPartition> partition_number_pattern(VM& vm, NumberFormat& number_format, MathematicalValue number)
  464. {
  465. // 1. Let exponent be 0.
  466. int exponent = 0;
  467. DeprecatedString formatted_string;
  468. // 2. If x is not-a-number, then
  469. if (number.is_nan()) {
  470. // a. Let n be an implementation- and locale-dependent (ILD) String value indicating the NaN value.
  471. formatted_string = ::Locale::get_number_system_symbol(number_format.data_locale(), number_format.numbering_system(), ::Locale::NumericSymbol::NaN).value_or("NaN"sv);
  472. }
  473. // 3. Else if x is positive-infinity, then
  474. else if (number.is_positive_infinity()) {
  475. // a. Let n be an ILD String value indicating positive infinity.
  476. formatted_string = ::Locale::get_number_system_symbol(number_format.data_locale(), number_format.numbering_system(), ::Locale::NumericSymbol::Infinity).value_or("infinity"sv);
  477. }
  478. // 4. Else if x is negative-infinity, then
  479. else if (number.is_negative_infinity()) {
  480. // a. Let n be an ILD String value indicating negative infinity.
  481. // NOTE: The CLDR does not contain unique strings for negative infinity. The negative sign will
  482. // be inserted by the pattern returned from GetNumberFormatPattern.
  483. formatted_string = ::Locale::get_number_system_symbol(number_format.data_locale(), number_format.numbering_system(), ::Locale::NumericSymbol::Infinity).value_or("infinity"sv);
  484. }
  485. // 5. Else,
  486. else {
  487. // a. If x is not negative-zero,
  488. if (!number.is_negative_zero()) {
  489. // i. Assert: x is a mathematical value.
  490. VERIFY(number.is_mathematical_value());
  491. // ii. If numberFormat.[[Style]] is "percent", let x be 100 × x.
  492. if (number_format.style() == NumberFormat::Style::Percent)
  493. number = number.multiplied_by(100);
  494. // iii. Let exponent be ComputeExponent(numberFormat, x).
  495. exponent = compute_exponent(number_format, number);
  496. // iv. Let x be x × 10^-exponent.
  497. number = number.multiplied_by_power(-exponent);
  498. }
  499. // b. Let formatNumberResult be FormatNumericToString(numberFormat, x).
  500. auto format_number_result = format_numeric_to_string(number_format, move(number));
  501. // c. Let n be formatNumberResult.[[FormattedString]].
  502. formatted_string = move(format_number_result.formatted_string);
  503. // d. Let x be formatNumberResult.[[RoundedNumber]].
  504. number = move(format_number_result.rounded_number);
  505. }
  506. ::Locale::NumberFormat found_pattern {};
  507. // 6. Let pattern be GetNumberFormatPattern(numberFormat, x).
  508. auto pattern = get_number_format_pattern(vm, number_format, number, found_pattern);
  509. if (!pattern.has_value())
  510. return {};
  511. // 7. Let result be a new empty List.
  512. Vector<PatternPartition> result;
  513. // 8. Let patternParts be PartitionPattern(pattern).
  514. auto pattern_parts = pattern->visit([](auto const& p) { return partition_pattern(p); });
  515. // 9. For each Record { [[Type]], [[Value]] } patternPart of patternParts, do
  516. for (auto& pattern_part : pattern_parts) {
  517. // a. Let p be patternPart.[[Type]].
  518. auto part = pattern_part.type;
  519. // b. If p is "literal", then
  520. if (part == "literal"sv) {
  521. // i. Append a new Record { [[Type]]: "literal", [[Value]]: patternPart.[[Value]] } as the last element of result.
  522. result.append({ "literal"sv, move(pattern_part.value) });
  523. }
  524. // c. Else if p is equal to "number", then
  525. else if (part == "number"sv) {
  526. // i. Let notationSubParts be PartitionNotationSubPattern(numberFormat, x, n, exponent).
  527. auto notation_sub_parts = partition_notation_sub_pattern(number_format, number, formatted_string, exponent);
  528. // ii. Append all elements of notationSubParts to result.
  529. result.extend(move(notation_sub_parts));
  530. }
  531. // d. Else if p is equal to "plusSign", then
  532. else if (part == "plusSign"sv) {
  533. // i. Let plusSignSymbol be the ILND String representing the plus sign.
  534. auto plus_sign_symbol = ::Locale::get_number_system_symbol(number_format.data_locale(), number_format.numbering_system(), ::Locale::NumericSymbol::PlusSign).value_or("+"sv);
  535. // ii. Append a new Record { [[Type]]: "plusSign", [[Value]]: plusSignSymbol } as the last element of result.
  536. result.append({ "plusSign"sv, plus_sign_symbol });
  537. }
  538. // e. Else if p is equal to "minusSign", then
  539. else if (part == "minusSign"sv) {
  540. // i. Let minusSignSymbol be the ILND String representing the minus sign.
  541. auto minus_sign_symbol = ::Locale::get_number_system_symbol(number_format.data_locale(), number_format.numbering_system(), ::Locale::NumericSymbol::MinusSign).value_or("-"sv);
  542. // ii. Append a new Record { [[Type]]: "minusSign", [[Value]]: minusSignSymbol } as the last element of result.
  543. result.append({ "minusSign"sv, minus_sign_symbol });
  544. }
  545. // f. Else if p is equal to "percentSign" and numberFormat.[[Style]] is "percent", then
  546. else if ((part == "percentSign"sv) && (number_format.style() == NumberFormat::Style::Percent)) {
  547. // i. Let percentSignSymbol be the ILND String representing the percent sign.
  548. auto percent_sign_symbol = ::Locale::get_number_system_symbol(number_format.data_locale(), number_format.numbering_system(), ::Locale::NumericSymbol::PercentSign).value_or("%"sv);
  549. // ii. Append a new Record { [[Type]]: "percentSign", [[Value]]: percentSignSymbol } as the last element of result.
  550. result.append({ "percentSign"sv, percent_sign_symbol });
  551. }
  552. // g. Else if p is equal to "unitPrefix" and numberFormat.[[Style]] is "unit", then
  553. // h. Else if p is equal to "unitSuffix" and numberFormat.[[Style]] is "unit", then
  554. else if ((part.starts_with("unitIdentifier:"sv)) && (number_format.style() == NumberFormat::Style::Unit)) {
  555. // Note: Our implementation combines "unitPrefix" and "unitSuffix" into one field, "unitIdentifier".
  556. auto identifier_index = part.substring_view("unitIdentifier:"sv.length()).to_uint();
  557. VERIFY(identifier_index.has_value());
  558. // i. Let unit be numberFormat.[[Unit]].
  559. // ii. Let unitDisplay be numberFormat.[[UnitDisplay]].
  560. // iii. Let mu be an ILD String value representing unit before x in unitDisplay form, which may depend on x in languages having different plural forms.
  561. auto unit_identifier = found_pattern.identifiers[*identifier_index];
  562. // iv. Append a new Record { [[Type]]: "unit", [[Value]]: mu } as the last element of result.
  563. result.append({ "unit"sv, unit_identifier });
  564. }
  565. // i. Else if p is equal to "currencyCode" and numberFormat.[[Style]] is "currency", then
  566. // j. Else if p is equal to "currencyPrefix" and numberFormat.[[Style]] is "currency", then
  567. // k. Else if p is equal to "currencySuffix" and numberFormat.[[Style]] is "currency", then
  568. //
  569. // Note: Our implementation manipulates the format string to inject/remove spacing around the
  570. // currency code during GetNumberFormatPattern so that we do not have to do currency
  571. // display / plurality lookups more than once.
  572. else if ((part == "currency"sv) && (number_format.style() == NumberFormat::Style::Currency)) {
  573. result.append({ "currency"sv, number_format.resolve_currency_display() });
  574. }
  575. // l. Else,
  576. else {
  577. // i. Let unknown be an ILND String based on x and p.
  578. // ii. Append a new Record { [[Type]]: "unknown", [[Value]]: unknown } as the last element of result.
  579. // LibUnicode doesn't generate any "unknown" patterns.
  580. VERIFY_NOT_REACHED();
  581. }
  582. }
  583. // 10. Return result.
  584. return result;
  585. }
  586. static Vector<StringView> separate_integer_into_groups(::Locale::NumberGroupings const& grouping_sizes, StringView integer, NumberFormat::UseGrouping use_grouping)
  587. {
  588. Utf8View utf8_integer { integer };
  589. if (utf8_integer.length() <= grouping_sizes.primary_grouping_size)
  590. return { integer };
  591. size_t index = utf8_integer.length() - grouping_sizes.primary_grouping_size;
  592. switch (use_grouping) {
  593. case NumberFormat::UseGrouping::Min2:
  594. if (utf8_integer.length() < 5)
  595. return { integer };
  596. break;
  597. case NumberFormat::UseGrouping::Auto:
  598. if (index < grouping_sizes.minimum_grouping_digits)
  599. return { integer };
  600. break;
  601. case NumberFormat::UseGrouping::Always:
  602. break;
  603. default:
  604. VERIFY_NOT_REACHED();
  605. }
  606. Vector<StringView> groups;
  607. auto add_group = [&](size_t index, size_t length) {
  608. groups.prepend(utf8_integer.unicode_substring_view(index, length).as_string());
  609. };
  610. add_group(index, grouping_sizes.primary_grouping_size);
  611. while (index > grouping_sizes.secondary_grouping_size) {
  612. index -= grouping_sizes.secondary_grouping_size;
  613. add_group(index, grouping_sizes.secondary_grouping_size);
  614. }
  615. if (index > 0)
  616. add_group(0, index);
  617. return groups;
  618. }
  619. // 15.5.5 PartitionNotationSubPattern ( numberFormat, x, n, exponent ), https://tc39.es/ecma402/#sec-partitionnotationsubpattern
  620. // 1.5.5 PartitionNotationSubPattern ( numberFormat, x, n, exponent ), https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#sec-partitionnotationsubpattern
  621. Vector<PatternPartition> partition_notation_sub_pattern(NumberFormat& number_format, MathematicalValue const& number, DeprecatedString formatted_string, int exponent)
  622. {
  623. // 1. Let result be a new empty List.
  624. Vector<PatternPartition> result;
  625. auto grouping_sizes = ::Locale::get_number_system_groupings(number_format.data_locale(), number_format.numbering_system());
  626. if (!grouping_sizes.has_value())
  627. return {};
  628. // 2. If x is NaN, then
  629. if (number.is_nan()) {
  630. // a. Append a new Record { [[Type]]: "nan", [[Value]]: n } as the last element of result.
  631. result.append({ "nan"sv, move(formatted_string) });
  632. }
  633. // 3. Else if x is a non-finite Number, then
  634. else if (number.is_positive_infinity() || number.is_negative_infinity()) {
  635. // a. Append a new Record { [[Type]]: "infinity", [[Value]]: n } as the last element of result.
  636. result.append({ "infinity"sv, move(formatted_string) });
  637. }
  638. // 4. Else,
  639. else {
  640. // a. Let notationSubPattern be GetNotationSubPattern(numberFormat, exponent).
  641. auto notation_sub_pattern = get_notation_sub_pattern(number_format, exponent);
  642. if (!notation_sub_pattern.has_value())
  643. return {};
  644. // b. Let patternParts be PartitionPattern(notationSubPattern).
  645. auto pattern_parts = partition_pattern(*notation_sub_pattern);
  646. // c. For each Record { [[Type]], [[Value]] } patternPart of patternParts, do
  647. for (auto& pattern_part : pattern_parts) {
  648. // i. Let p be patternPart.[[Type]].
  649. auto part = pattern_part.type;
  650. // ii. If p is "literal", then
  651. if (part == "literal"sv) {
  652. // 1. Append a new Record { [[Type]]: "literal", [[Value]]: patternPart.[[Value]] } as the last element of result.
  653. result.append({ "literal"sv, move(pattern_part.value) });
  654. }
  655. // iii. Else if p is equal to "number", then
  656. else if (part == "number"sv) {
  657. // 1. If the numberFormat.[[NumberingSystem]] matches one of the values in the "Numbering System" column of Table 12 below, then
  658. // a. Let digits be a List whose elements are the code points specified in the "Digits" column of the matching row in Table 13.
  659. // b. Assert: The length of digits is 10.
  660. // c. Let transliterated be the empty String.
  661. // d. Let len be the length of n.
  662. // e. Let position be 0.
  663. // f. Repeat, while position < len,
  664. // i. Let c be the code unit at index position within n.
  665. // ii. If 0x0030 ≤ c ≤ 0x0039, then
  666. // i. NOTE: c is an ASCII digit.
  667. // ii. Let i be c - 0x0030.
  668. // iii. Set c to CodePointsToString(« digits[i] »).
  669. // iii. Set transliterated to the string-concatenation of transliterated and c.
  670. // iv. Set position to position + 1.
  671. // g. Set n to transliterated.
  672. // 2. Else use an implementation dependent algorithm to map n to the appropriate representation of n in the given numbering system.
  673. formatted_string = ::Locale::replace_digits_for_number_system(number_format.numbering_system(), formatted_string);
  674. // 3. Let decimalSepIndex be StringIndexOf(n, ".", 0).
  675. auto decimal_sep_index = formatted_string.find('.');
  676. StringView integer;
  677. Optional<StringView> fraction;
  678. // 4. If decimalSepIndex > 0, then
  679. if (decimal_sep_index.has_value() && (*decimal_sep_index > 0)) {
  680. // a. Let integer be the substring of n from position 0, inclusive, to position decimalSepIndex, exclusive.
  681. integer = formatted_string.substring_view(0, *decimal_sep_index);
  682. // b. Let fraction be the substring of n from position decimalSepIndex, exclusive, to the end of n.
  683. fraction = formatted_string.substring_view(*decimal_sep_index + 1);
  684. }
  685. // 5. Else,
  686. else {
  687. // a. Let integer be n.
  688. integer = formatted_string;
  689. // b. Let fraction be undefined.
  690. }
  691. // 6. If the numberFormat.[[UseGrouping]] is false, then
  692. if (number_format.use_grouping() == NumberFormat::UseGrouping::False) {
  693. // a. Append a new Record { [[Type]]: "integer", [[Value]]: integer } as the last element of result.
  694. result.append({ "integer"sv, integer });
  695. }
  696. // 7. Else,
  697. else {
  698. // a. Let groupSepSymbol be the implementation-, locale-, and numbering system-dependent (ILND) String representing the grouping separator.
  699. auto group_sep_symbol = ::Locale::get_number_system_symbol(number_format.data_locale(), number_format.numbering_system(), ::Locale::NumericSymbol::Group).value_or(","sv);
  700. // b. Let groups be a List whose elements are, in left to right order, the substrings defined by ILND set of locations within the integer, which may depend on the value of numberFormat.[[UseGrouping]].
  701. auto groups = separate_integer_into_groups(*grouping_sizes, integer, number_format.use_grouping());
  702. // c. Assert: The number of elements in groups List is greater than 0.
  703. VERIFY(!groups.is_empty());
  704. // d. Repeat, while groups List is not empty,
  705. while (!groups.is_empty()) {
  706. // i. Remove the first element from groups and let integerGroup be the value of that element.
  707. auto integer_group = groups.take_first();
  708. // ii. Append a new Record { [[Type]]: "integer", [[Value]]: integerGroup } as the last element of result.
  709. result.append({ "integer"sv, integer_group });
  710. // iii. If groups List is not empty, then
  711. if (!groups.is_empty()) {
  712. // i. Append a new Record { [[Type]]: "group", [[Value]]: groupSepSymbol } as the last element of result.
  713. result.append({ "group"sv, group_sep_symbol });
  714. }
  715. }
  716. }
  717. // 8. If fraction is not undefined, then
  718. if (fraction.has_value()) {
  719. // a. Let decimalSepSymbol be the ILND String representing the decimal separator.
  720. auto decimal_sep_symbol = ::Locale::get_number_system_symbol(number_format.data_locale(), number_format.numbering_system(), ::Locale::NumericSymbol::Decimal).value_or("."sv);
  721. // b. Append a new Record { [[Type]]: "decimal", [[Value]]: decimalSepSymbol } as the last element of result.
  722. result.append({ "decimal"sv, decimal_sep_symbol });
  723. // c. Append a new Record { [[Type]]: "fraction", [[Value]]: fraction } as the last element of result.
  724. result.append({ "fraction"sv, fraction.release_value() });
  725. }
  726. }
  727. // iv. Else if p is equal to "compactSymbol", then
  728. // v. Else if p is equal to "compactName", then
  729. else if (part.starts_with("compactIdentifier:"sv)) {
  730. // Note: Our implementation combines "compactSymbol" and "compactName" into one field, "compactIdentifier".
  731. auto identifier_index = part.substring_view("compactIdentifier:"sv.length()).to_uint();
  732. VERIFY(identifier_index.has_value());
  733. // 1. Let compactSymbol be an ILD string representing exponent in short form, which may depend on x in languages having different plural forms. The implementation must be able to provide this string, or else the pattern would not have a "{compactSymbol}" placeholder.
  734. auto compact_identifier = number_format.compact_format().identifiers[*identifier_index];
  735. // 2. Append a new Record { [[Type]]: "compact", [[Value]]: compactSymbol } as the last element of result.
  736. result.append({ "compact"sv, compact_identifier });
  737. }
  738. // vi. Else if p is equal to "scientificSeparator", then
  739. else if (part == "scientificSeparator"sv) {
  740. // 1. Let scientificSeparator be the ILND String representing the exponent separator.
  741. auto scientific_separator = ::Locale::get_number_system_symbol(number_format.data_locale(), number_format.numbering_system(), ::Locale::NumericSymbol::Exponential).value_or("E"sv);
  742. // 2. Append a new Record { [[Type]]: "exponentSeparator", [[Value]]: scientificSeparator } as the last element of result.
  743. result.append({ "exponentSeparator"sv, scientific_separator });
  744. }
  745. // vii. Else if p is equal to "scientificExponent", then
  746. else if (part == "scientificExponent"sv) {
  747. // 1. If exponent < 0, then
  748. if (exponent < 0) {
  749. // a. Let minusSignSymbol be the ILND String representing the minus sign.
  750. auto minus_sign_symbol = ::Locale::get_number_system_symbol(number_format.data_locale(), number_format.numbering_system(), ::Locale::NumericSymbol::MinusSign).value_or("-"sv);
  751. // b. Append a new Record { [[Type]]: "exponentMinusSign", [[Value]]: minusSignSymbol } as the last element of result.
  752. result.append({ "exponentMinusSign"sv, minus_sign_symbol });
  753. // c. Let exponent be -exponent.
  754. exponent *= -1;
  755. }
  756. // 2. Let exponentResult be ToRawFixed(exponent, 0, 0, 1, undefined).
  757. auto exponent_value = MathematicalValue { static_cast<double>(exponent) };
  758. auto exponent_result = to_raw_fixed(exponent_value, 0, 0, 1, {});
  759. // FIXME: The spec does not say to do this, but all of major engines perform this replacement.
  760. // Without this, formatting with non-Latin numbering systems will produce non-localized results.
  761. exponent_result.formatted_string = ::Locale::replace_digits_for_number_system(number_format.numbering_system(), exponent_result.formatted_string);
  762. // 3. Append a new Record { [[Type]]: "exponentInteger", [[Value]]: exponentResult.[[FormattedString]] } as the last element of result.
  763. result.append({ "exponentInteger"sv, move(exponent_result.formatted_string) });
  764. }
  765. // viii. Else,
  766. else {
  767. // 1. Let unknown be an ILND String based on x and p.
  768. // 2. Append a new Record { [[Type]]: "unknown", [[Value]]: unknown } as the last element of result.
  769. // LibUnicode doesn't generate any "unknown" patterns.
  770. VERIFY_NOT_REACHED();
  771. }
  772. }
  773. }
  774. // 5. Return result.
  775. return result;
  776. }
  777. // 15.5.6 FormatNumeric ( numberFormat, x ), https://tc39.es/ecma402/#sec-formatnumber
  778. DeprecatedString format_numeric(VM& vm, NumberFormat& number_format, MathematicalValue number)
  779. {
  780. // 1. Let parts be ? PartitionNumberPattern(numberFormat, x).
  781. // Note: Our implementation of PartitionNumberPattern does not throw.
  782. auto parts = partition_number_pattern(vm, number_format, move(number));
  783. // 2. Let result be the empty String.
  784. StringBuilder result;
  785. // 3. For each Record { [[Type]], [[Value]] } part in parts, do
  786. for (auto& part : parts) {
  787. // a. Set result to the string-concatenation of result and part.[[Value]].
  788. result.append(move(part.value));
  789. }
  790. // 4. Return result.
  791. return result.build();
  792. }
  793. // 15.5.7 FormatNumericToParts ( numberFormat, x ), https://tc39.es/ecma402/#sec-formatnumbertoparts
  794. Array* format_numeric_to_parts(VM& vm, NumberFormat& number_format, MathematicalValue number)
  795. {
  796. auto& realm = *vm.current_realm();
  797. // 1. Let parts be ? PartitionNumberPattern(numberFormat, x).
  798. // Note: Our implementation of PartitionNumberPattern does not throw.
  799. auto parts = partition_number_pattern(vm, number_format, move(number));
  800. // 2. Let result be ! ArrayCreate(0).
  801. auto result = MUST(Array::create(realm, 0));
  802. // 3. Let n be 0.
  803. size_t n = 0;
  804. // 4. For each Record { [[Type]], [[Value]] } part in parts, do
  805. for (auto& part : parts) {
  806. // a. Let O be OrdinaryObjectCreate(%Object.prototype%).
  807. auto object = Object::create(realm, realm.intrinsics().object_prototype());
  808. // b. Perform ! CreateDataPropertyOrThrow(O, "type", part.[[Type]]).
  809. MUST(object->create_data_property_or_throw(vm.names.type, PrimitiveString::create(vm, part.type)));
  810. // c. Perform ! CreateDataPropertyOrThrow(O, "value", part.[[Value]]).
  811. MUST(object->create_data_property_or_throw(vm.names.value, PrimitiveString::create(vm, move(part.value))));
  812. // d. Perform ! CreateDataPropertyOrThrow(result, ! ToString(n), O).
  813. MUST(result->create_data_property_or_throw(n, object));
  814. // e. Increment n by 1.
  815. ++n;
  816. }
  817. // 5. Return result.
  818. return result;
  819. }
  820. static DeprecatedString cut_trailing_zeroes(StringView string, int cut)
  821. {
  822. // These steps are exactly the same between ToRawPrecision and ToRawFixed.
  823. // Repeat, while cut > 0 and the last character of m is "0",
  824. while ((cut > 0) && string.ends_with('0')) {
  825. // Remove the last character from m.
  826. string = string.substring_view(0, string.length() - 1);
  827. // Decrease cut by 1.
  828. --cut;
  829. }
  830. // If the last character of m is ".", then
  831. if (string.ends_with('.')) {
  832. // Remove the last character from m.
  833. string = string.substring_view(0, string.length() - 1);
  834. }
  835. return string.to_deprecated_string();
  836. }
  837. enum class PreferredResult {
  838. LessThanNumber,
  839. GreaterThanNumber,
  840. };
  841. // ToRawPrecisionFn, https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#eqn-ToRawPrecisionFn
  842. static auto to_raw_precision_function(MathematicalValue const& number, int precision, PreferredResult mode)
  843. {
  844. struct {
  845. MathematicalValue number;
  846. int exponent { 0 };
  847. MathematicalValue rounded;
  848. } result {};
  849. result.exponent = number.logarithmic_floor();
  850. if (number.is_number()) {
  851. result.number = number.divided_by_power(result.exponent - precision + 1);
  852. switch (mode) {
  853. case PreferredResult::LessThanNumber:
  854. result.number = MathematicalValue { floor(result.number.as_number()) };
  855. break;
  856. case PreferredResult::GreaterThanNumber:
  857. result.number = MathematicalValue { ceil(result.number.as_number()) };
  858. break;
  859. }
  860. } else {
  861. // NOTE: In order to round the BigInt to the proper precision, this computation is initially off by a
  862. // factor of 10. This lets us inspect the ones digit and then round up if needed.
  863. result.number = number.divided_by_power(result.exponent - precision);
  864. // FIXME: Can we do this without string conversion?
  865. auto digits = result.number.to_deprecated_string();
  866. auto digit = digits.substring_view(digits.length() - 1);
  867. result.number = result.number.divided_by(10);
  868. if (mode == PreferredResult::GreaterThanNumber && digit.to_uint().value() != 0)
  869. result.number = result.number.plus(1);
  870. }
  871. result.rounded = result.number.multiplied_by_power(result.exponent - precision + 1);
  872. return result;
  873. }
  874. // 15.5.8 ToRawPrecision ( x, minPrecision, maxPrecision ), https://tc39.es/ecma402/#sec-torawprecision
  875. // 1.5.8 ToRawPrecision ( x, minPrecision, maxPrecision, unsignedRoundingMode ), https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#sec-torawprecision
  876. RawFormatResult to_raw_precision(MathematicalValue const& number, int min_precision, int max_precision, Optional<NumberFormat::UnsignedRoundingMode> const& unsigned_rounding_mode)
  877. {
  878. RawFormatResult result {};
  879. // 1. Let p be maxPrecision.
  880. int precision = max_precision;
  881. int exponent = 0;
  882. // 2. If x = 0, then
  883. if (number.is_zero()) {
  884. // a. Let m be the String consisting of p occurrences of the character "0".
  885. result.formatted_string = DeprecatedString::repeated('0', precision);
  886. // b. Let e be 0.
  887. exponent = 0;
  888. // c. Let xFinal be 0.
  889. result.rounded_number = MathematicalValue { 0.0 };
  890. }
  891. // 3. Else,
  892. else {
  893. // a. Let n1 and e1 each be an integer and r1 a mathematical value, with r1 = ToRawPrecisionFn(n1, e1, p), such that r1 ≤ x and r1 is maximized.
  894. auto [number1, exponent1, rounded1] = to_raw_precision_function(number, precision, PreferredResult::LessThanNumber);
  895. // b. Let n2 and e2 each be an integer and r2 a mathematical value, with r2 = ToRawPrecisionFn(n2, e2, p), such that r2 ≥ x and r2 is minimized.
  896. auto [number2, exponent2, rounded2] = to_raw_precision_function(number, precision, PreferredResult::GreaterThanNumber);
  897. // c. Let r be ApplyUnsignedRoundingMode(x, r1, r2, unsignedRoundingMode).
  898. auto rounded = apply_unsigned_rounding_mode(number, rounded1, rounded2, unsigned_rounding_mode);
  899. MathematicalValue n;
  900. // d. If r is r1, then
  901. if (rounded == RoundingDecision::LowerValue) {
  902. // i. Let n be n1.
  903. n = move(number1);
  904. // ii. Let e be e1.
  905. exponent = exponent1;
  906. // iii. Let xFinal be r1.
  907. result.rounded_number = move(rounded1);
  908. }
  909. // e. Else,
  910. else {
  911. // i. Let n be n2.
  912. n = move(number2);
  913. // ii. Let e be e2.
  914. exponent = exponent2;
  915. // iii. Let xFinal be r2.
  916. result.rounded_number = move(rounded2);
  917. }
  918. // f. Let m be the String consisting of the digits of the decimal representation of n (in order, with no leading zeroes).
  919. result.formatted_string = n.to_deprecated_string();
  920. }
  921. // 4. If e ≥ p–1, then
  922. if (exponent >= (precision - 1)) {
  923. // a. Let m be the string-concatenation of m and e–p+1 occurrences of the character "0".
  924. result.formatted_string = DeprecatedString::formatted(
  925. "{}{}",
  926. result.formatted_string,
  927. DeprecatedString::repeated('0', exponent - precision + 1));
  928. // b. Let int be e+1.
  929. result.digits = exponent + 1;
  930. }
  931. // 5. Else if e ≥ 0, then
  932. else if (exponent >= 0) {
  933. // a. Let m be the string-concatenation of the first e+1 characters of m, the character ".", and the remaining p–(e+1) characters of m.
  934. result.formatted_string = DeprecatedString::formatted(
  935. "{}.{}",
  936. result.formatted_string.substring_view(0, exponent + 1),
  937. result.formatted_string.substring_view(exponent + 1));
  938. // b. Let int be e+1.
  939. result.digits = exponent + 1;
  940. }
  941. // 6. Else,
  942. else {
  943. // a. Assert: e < 0.
  944. // b. Let m be the string-concatenation of "0.", –(e+1) occurrences of the character "0", and m.
  945. result.formatted_string = DeprecatedString::formatted(
  946. "0.{}{}",
  947. DeprecatedString::repeated('0', -1 * (exponent + 1)),
  948. result.formatted_string);
  949. // c. Let int be 1.
  950. result.digits = 1;
  951. }
  952. // 7. If m contains the character ".", and maxPrecision > minPrecision, then
  953. if (result.formatted_string.contains('.') && (max_precision > min_precision)) {
  954. // a. Let cut be maxPrecision – minPrecision.
  955. int cut = max_precision - min_precision;
  956. // Steps 8b-8c are implemented by cut_trailing_zeroes.
  957. result.formatted_string = cut_trailing_zeroes(result.formatted_string, cut);
  958. }
  959. // 8. Return the Record { [[FormattedString]]: m, [[RoundedNumber]]: xFinal, [[IntegerDigitsCount]]: int, [[RoundingMagnitude]]: e–p+1 }.
  960. result.rounding_magnitude = exponent - precision + 1;
  961. return result;
  962. }
  963. // ToRawFixedFn, https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#eqn-ToRawFixedFn
  964. static auto to_raw_fixed_function(MathematicalValue const& number, int fraction, int rounding_increment, PreferredResult mode)
  965. {
  966. struct {
  967. MathematicalValue number;
  968. MathematicalValue rounded;
  969. } result {};
  970. if (number.is_number()) {
  971. result.number = number.multiplied_by_power(fraction);
  972. switch (mode) {
  973. case PreferredResult::LessThanNumber:
  974. result.number = MathematicalValue { floor(result.number.as_number()) };
  975. break;
  976. case PreferredResult::GreaterThanNumber:
  977. result.number = MathematicalValue { ceil(result.number.as_number()) };
  978. break;
  979. }
  980. } else {
  981. // NOTE: In order to round the BigInt to the proper precision, this computation is initially off by a
  982. // factor of 10. This lets us inspect the ones digit and then round up if needed.
  983. result.number = number.multiplied_by_power(fraction - 1);
  984. // FIXME: Can we do this without string conversion?
  985. auto digits = result.number.to_deprecated_string();
  986. auto digit = digits.substring_view(digits.length() - 1);
  987. result.number = result.number.multiplied_by(10);
  988. if (mode == PreferredResult::GreaterThanNumber && digit.to_uint().value() != 0)
  989. result.number = result.number.plus(1);
  990. }
  991. while (!result.number.modulo_is_zero(rounding_increment)) {
  992. switch (mode) {
  993. case PreferredResult::LessThanNumber:
  994. result.number = result.number.minus(1);
  995. break;
  996. case PreferredResult::GreaterThanNumber:
  997. result.number = result.number.plus(1);
  998. break;
  999. }
  1000. }
  1001. result.rounded = result.number.divided_by_power(fraction);
  1002. return result;
  1003. }
  1004. // 15.5.9 ToRawFixed ( x, minInteger, minFraction, maxFraction ), https://tc39.es/ecma402/#sec-torawfixed
  1005. // 1.5.9 ToRawFixed ( x, minFraction, maxFraction, roundingIncrement, unsignedRoundingMode ), https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#sec-torawfixed
  1006. RawFormatResult to_raw_fixed(MathematicalValue const& number, int min_fraction, int max_fraction, int rounding_increment, Optional<NumberFormat::UnsignedRoundingMode> const& unsigned_rounding_mode)
  1007. {
  1008. RawFormatResult result {};
  1009. // 1. Let f be maxFraction.
  1010. int fraction = max_fraction;
  1011. // 2. Let n1 be an integer and r1 a mathematical value, with r1 = ToRawFixedFn(n1, f), such that n1 modulo roundingIncrement = 0, r1 ≤ x, and r1 is maximized.
  1012. auto [number1, rounded1] = to_raw_fixed_function(number, fraction, rounding_increment, PreferredResult::LessThanNumber);
  1013. // 3. Let n2 be an integer and r2 a mathematical value, with r2 = ToRawFixedFn(n2, f), such that n2 modulo roundingIncrement = 0, r2 ≥ x, and r2 is minimized.
  1014. auto [number2, rounded2] = to_raw_fixed_function(number, fraction, rounding_increment, PreferredResult::GreaterThanNumber);
  1015. // 4. Let r be ApplyUnsignedRoundingMode(x, r1, r2, unsignedRoundingMode).
  1016. auto rounded = apply_unsigned_rounding_mode(number, rounded1, rounded2, unsigned_rounding_mode);
  1017. MathematicalValue n;
  1018. // 5. If r is r1, then
  1019. if (rounded == RoundingDecision::LowerValue) {
  1020. // a. Let n be n1.
  1021. n = move(number1);
  1022. // b. Let xFinal be r1.
  1023. result.rounded_number = move(rounded1);
  1024. }
  1025. // 6. Else,
  1026. else {
  1027. // a. Let n be n2.
  1028. n = move(number2);
  1029. // b. Let xFinal be r2.
  1030. result.rounded_number = move(rounded2);
  1031. }
  1032. // 7. If n = 0, let m be "0". Otherwise, let m be the String consisting of the digits of the decimal representation of n (in order, with no leading zeroes).
  1033. result.formatted_string = n.is_zero() ? DeprecatedString("0"sv) : n.to_deprecated_string();
  1034. // 8. If f ≠ 0, then
  1035. if (fraction != 0) {
  1036. // a. Let k be the number of characters in m.
  1037. auto decimals = result.formatted_string.length();
  1038. // b. If k ≤ f, then
  1039. if (decimals <= static_cast<size_t>(fraction)) {
  1040. // i. Let z be the String value consisting of f+1–k occurrences of the character "0".
  1041. auto zeroes = DeprecatedString::repeated('0', fraction + 1 - decimals);
  1042. // ii. Let m be the string-concatenation of z and m.
  1043. result.formatted_string = DeprecatedString::formatted("{}{}", zeroes, result.formatted_string);
  1044. // iii. Let k be f+1.
  1045. decimals = fraction + 1;
  1046. }
  1047. // c. Let a be the first k–f characters of m, and let b be the remaining f characters of m.
  1048. auto a = result.formatted_string.substring_view(0, decimals - fraction);
  1049. auto b = result.formatted_string.substring_view(decimals - fraction, fraction);
  1050. // d. Let m be the string-concatenation of a, ".", and b.
  1051. result.formatted_string = DeprecatedString::formatted("{}.{}", a, b);
  1052. // e. Let int be the number of characters in a.
  1053. result.digits = a.length();
  1054. }
  1055. // 9. Else, let int be the number of characters in m.
  1056. else {
  1057. result.digits = result.formatted_string.length();
  1058. }
  1059. // 10. Let cut be maxFraction – minFraction.
  1060. int cut = max_fraction - min_fraction;
  1061. // Steps 11-12 are implemented by cut_trailing_zeroes.
  1062. result.formatted_string = cut_trailing_zeroes(result.formatted_string, cut);
  1063. // 13. Return the Record { [[FormattedString]]: m, [[RoundedNumber]]: xFinal, [[IntegerDigitsCount]]: int, [[RoundingMagnitude]]: –f }.
  1064. result.rounding_magnitude = -fraction;
  1065. return result;
  1066. }
  1067. // 15.5.11 GetNumberFormatPattern ( numberFormat, x ), https://tc39.es/ecma402/#sec-getnumberformatpattern
  1068. // 1.5.11 GetNumberFormatPattern ( numberFormat, x ), https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#sec-getnumberformatpattern
  1069. Optional<Variant<StringView, DeprecatedString>> get_number_format_pattern(VM& vm, NumberFormat& number_format, MathematicalValue const& number, ::Locale::NumberFormat& found_pattern)
  1070. {
  1071. // 1. Let localeData be %NumberFormat%.[[LocaleData]].
  1072. // 2. Let dataLocale be numberFormat.[[DataLocale]].
  1073. // 3. Let dataLocaleData be localeData.[[<dataLocale>]].
  1074. // 4. Let patterns be dataLocaleData.[[patterns]].
  1075. // 5. Assert: patterns is a Record (see 15.3.3).
  1076. Optional<::Locale::NumberFormat> patterns;
  1077. // 6. Let style be numberFormat.[[Style]].
  1078. switch (number_format.style()) {
  1079. // 7. If style is "percent", then
  1080. case NumberFormat::Style::Percent:
  1081. // a. Let patterns be patterns.[[percent]].
  1082. patterns = ::Locale::get_standard_number_system_format(number_format.data_locale(), number_format.numbering_system(), ::Locale::StandardNumberFormatType::Percent);
  1083. break;
  1084. // 8. Else if style is "unit", then
  1085. case NumberFormat::Style::Unit: {
  1086. // a. Let unit be numberFormat.[[Unit]].
  1087. // b. Let unitDisplay be numberFormat.[[UnitDisplay]].
  1088. // c. Let patterns be patterns.[[unit]].
  1089. // d. If patterns doesn't have a field [[<unit>]], then
  1090. // i. Let unit be "fallback".
  1091. // e. Let patterns be patterns.[[<unit>]].
  1092. // f. Let patterns be patterns.[[<unitDisplay>]].
  1093. auto formats = ::Locale::get_unit_formats(number_format.data_locale(), number_format.unit(), number_format.unit_display());
  1094. auto plurality = resolve_plural(number_format, ::Locale::PluralForm::Cardinal, number.to_value(vm));
  1095. if (auto it = formats.find_if([&](auto& p) { return p.plurality == plurality; }); it != formats.end())
  1096. patterns = move(*it);
  1097. break;
  1098. }
  1099. // 9. Else if style is "currency", then
  1100. case NumberFormat::Style::Currency:
  1101. // a. Let currency be numberFormat.[[Currency]].
  1102. // b. Let currencyDisplay be numberFormat.[[CurrencyDisplay]].
  1103. // c. Let currencySign be numberFormat.[[CurrencySign]].
  1104. // d. Let patterns be patterns.[[currency]].
  1105. // e. If patterns doesn't have a field [[<currency>]], then
  1106. // i. Let currency be "fallback".
  1107. // f. Let patterns be patterns.[[<currency>]].
  1108. // g. Let patterns be patterns.[[<currencyDisplay>]].
  1109. // h. Let patterns be patterns.[[<currencySign>]].
  1110. // Handling of other [[CurrencyDisplay]] options will occur after [[SignDisplay]].
  1111. if (number_format.currency_display() == NumberFormat::CurrencyDisplay::Name) {
  1112. auto formats = ::Locale::get_compact_number_system_formats(number_format.data_locale(), number_format.numbering_system(), ::Locale::CompactNumberFormatType::CurrencyUnit);
  1113. auto plurality = resolve_plural(number_format, ::Locale::PluralForm::Cardinal, number.to_value(vm));
  1114. if (auto it = formats.find_if([&](auto& p) { return p.plurality == plurality; }); it != formats.end()) {
  1115. patterns = move(*it);
  1116. break;
  1117. }
  1118. }
  1119. switch (number_format.currency_sign()) {
  1120. case NumberFormat::CurrencySign::Standard:
  1121. patterns = ::Locale::get_standard_number_system_format(number_format.data_locale(), number_format.numbering_system(), ::Locale::StandardNumberFormatType::Currency);
  1122. break;
  1123. case NumberFormat::CurrencySign::Accounting:
  1124. patterns = ::Locale::get_standard_number_system_format(number_format.data_locale(), number_format.numbering_system(), ::Locale::StandardNumberFormatType::Accounting);
  1125. break;
  1126. }
  1127. break;
  1128. // 10. Else,
  1129. case NumberFormat::Style::Decimal:
  1130. // a. Assert: style is "decimal".
  1131. // b. Let patterns be patterns.[[decimal]].
  1132. patterns = ::Locale::get_standard_number_system_format(number_format.data_locale(), number_format.numbering_system(), ::Locale::StandardNumberFormatType::Decimal);
  1133. break;
  1134. default:
  1135. VERIFY_NOT_REACHED();
  1136. }
  1137. if (!patterns.has_value())
  1138. return {};
  1139. StringView pattern;
  1140. // 11. Let signDisplay be numberFormat.[[SignDisplay]].
  1141. switch (number_format.sign_display()) {
  1142. // 12. If signDisplay is "never", then
  1143. case NumberFormat::SignDisplay::Never:
  1144. // a. Let pattern be patterns.[[zeroPattern]].
  1145. pattern = patterns->zero_format;
  1146. break;
  1147. // 13. Else if signDisplay is "auto", then
  1148. case NumberFormat::SignDisplay::Auto:
  1149. // a. If x is 0 or x > 0 or x is NaN, then
  1150. if (number.is_zero() || number.is_positive() || number.is_nan()) {
  1151. // i. Let pattern be patterns.[[zeroPattern]].
  1152. pattern = patterns->zero_format;
  1153. }
  1154. // b. Else,
  1155. else {
  1156. // i. Let pattern be patterns.[[negativePattern]].
  1157. pattern = patterns->negative_format;
  1158. }
  1159. break;
  1160. // 14. Else if signDisplay is "always", then
  1161. case NumberFormat::SignDisplay::Always:
  1162. // a. If x is 0 or x > 0 or x is NaN, then
  1163. if (number.is_zero() || number.is_positive() || number.is_nan()) {
  1164. // i. Let pattern be patterns.[[positivePattern]].
  1165. pattern = patterns->positive_format;
  1166. }
  1167. // b. Else,
  1168. else {
  1169. // i. Let pattern be patterns.[[negativePattern]].
  1170. pattern = patterns->negative_format;
  1171. }
  1172. break;
  1173. // 15. Else if signDisplay is "exceptZero", then
  1174. case NumberFormat::SignDisplay::ExceptZero:
  1175. // a. If x is 0 or x is -0 or x is NaN, then
  1176. if (number.is_zero() || number.is_negative_zero() || number.is_nan()) {
  1177. // i. Let pattern be patterns.[[zeroPattern]].
  1178. pattern = patterns->zero_format;
  1179. }
  1180. // b. Else if x > 0, then
  1181. else if (number.is_positive()) {
  1182. // i. Let pattern be patterns.[[positivePattern]].
  1183. pattern = patterns->positive_format;
  1184. }
  1185. // c. Else,
  1186. else {
  1187. // i. Let pattern be patterns.[[negativePattern]].
  1188. pattern = patterns->negative_format;
  1189. }
  1190. break;
  1191. // 16. Else,
  1192. case NumberFormat::SignDisplay::Negative:
  1193. // a. Assert: signDisplay is "negative".
  1194. // b. If x is 0 or x is -0 or x > 0 or x is NaN, then
  1195. if (number.is_zero() || number.is_negative_zero() || number.is_positive() || number.is_nan()) {
  1196. // i. Let pattern be patterns.[[zeroPattern]].
  1197. pattern = patterns->zero_format;
  1198. }
  1199. // c. Else,
  1200. else {
  1201. // i. Let pattern be patterns.[[negativePattern]].
  1202. pattern = patterns->negative_format;
  1203. }
  1204. break;
  1205. default:
  1206. VERIFY_NOT_REACHED();
  1207. }
  1208. found_pattern = patterns.release_value();
  1209. // Handling of steps 9b/9g: Depending on the currency display and the format pattern found above,
  1210. // we might need to mutate the format pattern to inject a space between the currency display and
  1211. // the currency number.
  1212. if (number_format.style() == NumberFormat::Style::Currency) {
  1213. auto modified_pattern = ::Locale::augment_currency_format_pattern(number_format.resolve_currency_display(), pattern);
  1214. if (modified_pattern.has_value())
  1215. return modified_pattern.release_value();
  1216. }
  1217. // 16. Return pattern.
  1218. return pattern;
  1219. }
  1220. // 15.5.12 GetNotationSubPattern ( numberFormat, exponent ), https://tc39.es/ecma402/#sec-getnotationsubpattern
  1221. Optional<StringView> get_notation_sub_pattern(NumberFormat& number_format, int exponent)
  1222. {
  1223. // 1. Let localeData be %NumberFormat%.[[LocaleData]].
  1224. // 2. Let dataLocale be numberFormat.[[DataLocale]].
  1225. // 3. Let dataLocaleData be localeData.[[<dataLocale>]].
  1226. // 4. Let notationSubPatterns be dataLocaleData.[[notationSubPatterns]].
  1227. // 5. Assert: notationSubPatterns is a Record (see 15.3.3).
  1228. // 6. Let notation be numberFormat.[[Notation]].
  1229. auto notation = number_format.notation();
  1230. // 7. If notation is "scientific" or notation is "engineering", then
  1231. if ((notation == NumberFormat::Notation::Scientific) || (notation == NumberFormat::Notation::Engineering)) {
  1232. // a. Return notationSubPatterns.[[scientific]].
  1233. auto notation_sub_patterns = ::Locale::get_standard_number_system_format(number_format.data_locale(), number_format.numbering_system(), ::Locale::StandardNumberFormatType::Scientific);
  1234. if (!notation_sub_patterns.has_value())
  1235. return {};
  1236. return notation_sub_patterns->zero_format;
  1237. }
  1238. // 8. Else if exponent is not 0, then
  1239. else if (exponent != 0) {
  1240. // a. Assert: notation is "compact".
  1241. VERIFY(notation == NumberFormat::Notation::Compact);
  1242. // b. Let compactDisplay be numberFormat.[[CompactDisplay]].
  1243. // c. Let compactPatterns be notationSubPatterns.[[compact]].[[<compactDisplay>]].
  1244. // d. Return compactPatterns.[[<exponent>]].
  1245. if (number_format.has_compact_format())
  1246. return number_format.compact_format().zero_format;
  1247. }
  1248. // 9. Else,
  1249. // a. Return "{number}".
  1250. return "{number}"sv;
  1251. }
  1252. // 15.5.13 ComputeExponent ( numberFormat, x ), https://tc39.es/ecma402/#sec-computeexponent
  1253. int compute_exponent(NumberFormat& number_format, MathematicalValue number)
  1254. {
  1255. // 1. If x = 0, then
  1256. if (number.is_zero()) {
  1257. // a. Return 0.
  1258. return 0;
  1259. }
  1260. // 2. If x < 0, then
  1261. if (number.is_negative()) {
  1262. // a. Let x = -x.
  1263. number.negate();
  1264. }
  1265. // 3. Let magnitude be the base 10 logarithm of x rounded down to the nearest integer.
  1266. int magnitude = number.logarithmic_floor();
  1267. // 4. Let exponent be ComputeExponentForMagnitude(numberFormat, magnitude).
  1268. int exponent = compute_exponent_for_magnitude(number_format, magnitude);
  1269. // 5. Let x be x × 10^(-exponent).
  1270. number = number.multiplied_by_power(-exponent);
  1271. // 6. Let formatNumberResult be FormatNumericToString(numberFormat, x).
  1272. auto format_number_result = format_numeric_to_string(number_format, move(number));
  1273. // 7. If formatNumberResult.[[RoundedNumber]] = 0, then
  1274. if (format_number_result.rounded_number.is_zero()) {
  1275. // a. Return exponent.
  1276. return exponent;
  1277. }
  1278. // 8. Let newMagnitude be the base 10 logarithm of formatNumberResult.[[RoundedNumber]] rounded down to the nearest integer.
  1279. int new_magnitude = format_number_result.rounded_number.logarithmic_floor();
  1280. // 9. If newMagnitude is magnitude – exponent, then
  1281. if (new_magnitude == magnitude - exponent) {
  1282. // a. Return exponent.
  1283. return exponent;
  1284. }
  1285. // 10. Return ComputeExponentForMagnitude(numberFormat, magnitude + 1).
  1286. return compute_exponent_for_magnitude(number_format, magnitude + 1);
  1287. }
  1288. // 15.5.14 ComputeExponentForMagnitude ( numberFormat, magnitude ), https://tc39.es/ecma402/#sec-computeexponentformagnitude
  1289. int compute_exponent_for_magnitude(NumberFormat& number_format, int magnitude)
  1290. {
  1291. // 1. Let notation be numberFormat.[[Notation]].
  1292. switch (number_format.notation()) {
  1293. // 2. If notation is "standard", then
  1294. case NumberFormat::Notation::Standard:
  1295. // a. Return 0.
  1296. return 0;
  1297. // 3. Else if notation is "scientific", then
  1298. case NumberFormat::Notation::Scientific:
  1299. // a. Return magnitude.
  1300. return magnitude;
  1301. // 4. Else if notation is "engineering", then
  1302. case NumberFormat::Notation::Engineering: {
  1303. // a. Let thousands be the greatest integer that is not greater than magnitude / 3.
  1304. double thousands = floor(static_cast<double>(magnitude) / 3.0);
  1305. // b. Return thousands × 3.
  1306. return static_cast<int>(thousands) * 3;
  1307. }
  1308. // 5. Else,
  1309. case NumberFormat::Notation::Compact: {
  1310. // a. Assert: notation is "compact".
  1311. VERIFY(number_format.has_compact_display());
  1312. // b. Let exponent be an implementation- and locale-dependent (ILD) integer by which to scale a number of the given magnitude in compact notation for the current locale.
  1313. // c. Return exponent.
  1314. Vector<::Locale::NumberFormat> format_rules;
  1315. if (number_format.style() == NumberFormat::Style::Currency)
  1316. format_rules = ::Locale::get_compact_number_system_formats(number_format.data_locale(), number_format.numbering_system(), ::Locale::CompactNumberFormatType::CurrencyShort);
  1317. else if (number_format.compact_display() == NumberFormat::CompactDisplay::Long)
  1318. format_rules = ::Locale::get_compact_number_system_formats(number_format.data_locale(), number_format.numbering_system(), ::Locale::CompactNumberFormatType::DecimalLong);
  1319. else
  1320. format_rules = ::Locale::get_compact_number_system_formats(number_format.data_locale(), number_format.numbering_system(), ::Locale::CompactNumberFormatType::DecimalShort);
  1321. ::Locale::NumberFormat const* best_number_format = nullptr;
  1322. for (auto const& format_rule : format_rules) {
  1323. if (format_rule.magnitude > magnitude)
  1324. break;
  1325. best_number_format = &format_rule;
  1326. }
  1327. if (best_number_format == nullptr)
  1328. return 0;
  1329. number_format.set_compact_format(*best_number_format);
  1330. return best_number_format->exponent;
  1331. }
  1332. default:
  1333. VERIFY_NOT_REACHED();
  1334. }
  1335. }
  1336. // 1.5.16 ToIntlMathematicalValue ( value ), https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#sec-tointlmathematicalvalue
  1337. ThrowCompletionOr<MathematicalValue> to_intl_mathematical_value(VM& vm, Value value)
  1338. {
  1339. // 1. Let primValue be ? ToPrimitive(value, number).
  1340. auto primitive_value = TRY(value.to_primitive(vm, Value::PreferredType::Number));
  1341. // 2. If Type(primValue) is BigInt, return the mathematical value of primValue.
  1342. if (primitive_value.is_bigint())
  1343. return primitive_value.as_bigint().big_integer();
  1344. // FIXME: The remaining steps are being refactored into a new Runtime Semantic, StringIntlMV.
  1345. // We short-circuit some of these steps to avoid known pitfalls.
  1346. // See: https://github.com/tc39/proposal-intl-numberformat-v3/pull/82
  1347. if (!primitive_value.is_string()) {
  1348. auto number = TRY(primitive_value.to_number(vm));
  1349. return number.as_double();
  1350. }
  1351. // 3. If Type(primValue) is String,
  1352. // a. Let str be primValue.
  1353. auto string = TRY(primitive_value.as_string().deprecated_string());
  1354. // Step 4 handled separately by the FIXME above.
  1355. // 5. If the grammar cannot interpret str as an expansion of StringNumericLiteral, return not-a-number.
  1356. // 6. Let mv be the MV, a mathematical value, of ? ToNumber(str), as described in 7.1.4.1.1.
  1357. auto mathematical_value = TRY(primitive_value.to_number(vm)).as_double();
  1358. // 7. If mv is 0 and the first non white space code point in str is -, return negative-zero.
  1359. if (mathematical_value == 0.0 && string.view().trim_whitespace(TrimMode::Left).starts_with('-'))
  1360. return MathematicalValue::Symbol::NegativeZero;
  1361. // 8. If mv is 10^10000 and str contains Infinity, return positive-infinity.
  1362. if (mathematical_value == pow(10, 10000) && string.contains("Infinity"sv))
  1363. return MathematicalValue::Symbol::PositiveInfinity;
  1364. // 9. If mv is -10^10000 and str contains Infinity, return negative-infinity.
  1365. if (mathematical_value == pow(-10, 10000) && string.contains("Infinity"sv))
  1366. return MathematicalValue::Symbol::NegativeInfinity;
  1367. // 10. Return mv.
  1368. return mathematical_value;
  1369. }
  1370. // 1.5.17 GetUnsignedRoundingMode ( roundingMode, isNegative ), https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#sec-getunsignedroundingmode
  1371. NumberFormat::UnsignedRoundingMode get_unsigned_rounding_mode(NumberFormat::RoundingMode rounding_mode, bool is_negative)
  1372. {
  1373. // 1. If isNegative is true, return the specification type in the third column of Table 2 where the first column is roundingMode and the second column is "negative".
  1374. // 2. Else, return the specification type in the third column of Table 2 where the first column is roundingMode and the second column is "positive".
  1375. // Table 2: Conversion from rounding mode to unsigned rounding mode, https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#table-intl-unsigned-rounding-modes
  1376. switch (rounding_mode) {
  1377. case NumberFormat::RoundingMode::Ceil:
  1378. return is_negative ? NumberFormat::UnsignedRoundingMode::Zero : NumberFormat::UnsignedRoundingMode::Infinity;
  1379. case NumberFormat::RoundingMode::Floor:
  1380. return is_negative ? NumberFormat::UnsignedRoundingMode::Infinity : NumberFormat::UnsignedRoundingMode::Zero;
  1381. case NumberFormat::RoundingMode::Expand:
  1382. return NumberFormat::UnsignedRoundingMode::Infinity;
  1383. case NumberFormat::RoundingMode::Trunc:
  1384. return NumberFormat::UnsignedRoundingMode::Zero;
  1385. case NumberFormat::RoundingMode::HalfCeil:
  1386. return is_negative ? NumberFormat::UnsignedRoundingMode::HalfZero : NumberFormat::UnsignedRoundingMode::HalfInfinity;
  1387. case NumberFormat::RoundingMode::HalfFloor:
  1388. return is_negative ? NumberFormat::UnsignedRoundingMode::HalfInfinity : NumberFormat::UnsignedRoundingMode::HalfZero;
  1389. case NumberFormat::RoundingMode::HalfExpand:
  1390. return NumberFormat::UnsignedRoundingMode::HalfInfinity;
  1391. case NumberFormat::RoundingMode::HalfTrunc:
  1392. return NumberFormat::UnsignedRoundingMode::HalfZero;
  1393. case NumberFormat::RoundingMode::HalfEven:
  1394. return NumberFormat::UnsignedRoundingMode::HalfEven;
  1395. default:
  1396. VERIFY_NOT_REACHED();
  1397. };
  1398. }
  1399. // 1.5.18 ApplyUnsignedRoundingMode ( x, r1, r2, unsignedRoundingMode ), https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#sec-applyunsignedroundingmode
  1400. RoundingDecision apply_unsigned_rounding_mode(MathematicalValue const& x, MathematicalValue const& r1, MathematicalValue const& r2, Optional<NumberFormat::UnsignedRoundingMode> const& unsigned_rounding_mode)
  1401. {
  1402. // 1. If x is equal to r1, return r1.
  1403. if (x.is_equal_to(r1))
  1404. return RoundingDecision::LowerValue;
  1405. // FIXME: We skip this assertion due floating point inaccuracies. For example, entering "1.2345"
  1406. // in the JS REPL results in "1.234499999999999", and may cause this assertion to fail.
  1407. //
  1408. // This should be resolved when the "Intl mathematical value" is implemented to support
  1409. // arbitrarily precise decimals.
  1410. // https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#intl-mathematical-value
  1411. // 2. Assert: r1 < x < r2.
  1412. // 3. Assert: unsignedRoundingMode is not undefined.
  1413. VERIFY(unsigned_rounding_mode.has_value());
  1414. // 4. If unsignedRoundingMode is zero, return r1.
  1415. if (unsigned_rounding_mode == NumberFormat::UnsignedRoundingMode::Zero)
  1416. return RoundingDecision::LowerValue;
  1417. // 5. If unsignedRoundingMode is infinity, return r2.
  1418. if (unsigned_rounding_mode == NumberFormat::UnsignedRoundingMode::Infinity)
  1419. return RoundingDecision::HigherValue;
  1420. // 6. Let d1 be x – r1.
  1421. auto d1 = x.minus(r1);
  1422. // 7. Let d2 be r2 – x.
  1423. auto d2 = r2.minus(x);
  1424. // 8. If d1 < d2, return r1.
  1425. if (d1.is_less_than(d2))
  1426. return RoundingDecision::LowerValue;
  1427. // 9. If d2 < d1, return r2.
  1428. if (d2.is_less_than(d1))
  1429. return RoundingDecision::HigherValue;
  1430. // 10. Assert: d1 is equal to d2.
  1431. VERIFY(d1.is_equal_to(d2));
  1432. // 11. If unsignedRoundingMode is half-zero, return r1.
  1433. if (unsigned_rounding_mode == NumberFormat::UnsignedRoundingMode::HalfZero)
  1434. return RoundingDecision::LowerValue;
  1435. // 12. If unsignedRoundingMode is half-infinity, return r2.
  1436. if (unsigned_rounding_mode == NumberFormat::UnsignedRoundingMode::HalfInfinity)
  1437. return RoundingDecision::HigherValue;
  1438. // 13. Assert: unsignedRoundingMode is half-even.
  1439. VERIFY(unsigned_rounding_mode == NumberFormat::UnsignedRoundingMode::HalfEven);
  1440. // 14. Let cardinality be (r1 / (r2 – r1)) modulo 2.
  1441. auto cardinality = r1.divided_by(r2.minus(r1));
  1442. // 15. If cardinality is 0, return r1.
  1443. if (cardinality.modulo_is_zero(2))
  1444. return RoundingDecision::LowerValue;
  1445. // 16. Return r2.
  1446. return RoundingDecision::HigherValue;
  1447. }
  1448. // 1.5.19 PartitionNumberRangePattern ( numberFormat, x, y ), https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#sec-partitionnumberrangepattern
  1449. ThrowCompletionOr<Vector<PatternPartitionWithSource>> partition_number_range_pattern(VM& vm, NumberFormat& number_format, MathematicalValue start, MathematicalValue end)
  1450. {
  1451. // 1. If x is NaN or y is NaN, throw a RangeError exception.
  1452. if (start.is_nan())
  1453. return vm.throw_completion<RangeError>(ErrorType::IntlNumberIsNaN, "start"sv);
  1454. if (end.is_nan())
  1455. return vm.throw_completion<RangeError>(ErrorType::IntlNumberIsNaN, "end"sv);
  1456. // 2. Let result be a new empty List.
  1457. Vector<PatternPartitionWithSource> result;
  1458. // 3. Let xResult be ? PartitionNumberPattern(numberFormat, x).
  1459. auto raw_start_result = partition_number_pattern(vm, number_format, move(start));
  1460. auto start_result = PatternPartitionWithSource::create_from_parent_list(move(raw_start_result));
  1461. // 4. Let yResult be ? PartitionNumberPattern(numberFormat, y).
  1462. auto raw_end_result = partition_number_pattern(vm, number_format, move(end));
  1463. auto end_result = PatternPartitionWithSource::create_from_parent_list(move(raw_end_result));
  1464. // 5. If xResult is equal to yResult, then
  1465. if (start_result == end_result) {
  1466. // a. Let appxResult be ? FormatApproximately(numberFormat, xResult).
  1467. auto approximate_result = format_approximately(number_format, move(start_result));
  1468. // b. For each r in appxResult, do
  1469. for (auto& result : approximate_result) {
  1470. // i. Set r.[[Source]] to "shared".
  1471. result.source = "shared"sv;
  1472. }
  1473. // c. Return appxResult.
  1474. return approximate_result;
  1475. }
  1476. // 6. For each r in xResult, do
  1477. for (auto& part : start_result) {
  1478. // i. Set r.[[Source]] to "startRange".
  1479. part.source = "startRange"sv;
  1480. }
  1481. // 7. Add all elements in xResult to result in order.
  1482. result = move(start_result);
  1483. // 8. Let rangeSeparator be an ILND String value used to separate two numbers.
  1484. auto range_separator_symbol = ::Locale::get_number_system_symbol(number_format.data_locale(), number_format.numbering_system(), ::Locale::NumericSymbol::RangeSeparator).value_or("-"sv);
  1485. auto range_separator = ::Locale::augment_range_pattern(range_separator_symbol, result.last().value, end_result[0].value);
  1486. // 9. Append a new Record { [[Type]]: "literal", [[Value]]: rangeSeparator, [[Source]]: "shared" } element to result.
  1487. PatternPartitionWithSource part;
  1488. part.type = "literal"sv;
  1489. part.value = range_separator.value_or(range_separator_symbol);
  1490. part.source = "shared"sv;
  1491. result.append(move(part));
  1492. // 10. For each r in yResult, do
  1493. for (auto& part : end_result) {
  1494. // a. Set r.[[Source]] to "endRange".
  1495. part.source = "endRange"sv;
  1496. }
  1497. // 11. Add all elements in yResult to result in order.
  1498. result.extend(move(end_result));
  1499. // 12. Return ! CollapseNumberRange(result).
  1500. return collapse_number_range(move(result));
  1501. }
  1502. // 1.5.20 FormatApproximately ( numberFormat, result ), https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#sec-formatapproximately
  1503. Vector<PatternPartitionWithSource> format_approximately(NumberFormat& number_format, Vector<PatternPartitionWithSource> result)
  1504. {
  1505. // 1. Let i be an index into result, determined by an implementation-defined algorithm based on numberFormat and result.
  1506. // 2. Let approximatelySign be an ILND String value used to signify that a number is approximate.
  1507. auto approximately_sign = ::Locale::get_number_system_symbol(number_format.data_locale(), number_format.numbering_system(), ::Locale::NumericSymbol::ApproximatelySign).value_or("~"sv);
  1508. // 3. Insert a new Record { [[Type]]: "approximatelySign", [[Value]]: approximatelySign } at index i in result.
  1509. PatternPartitionWithSource partition;
  1510. partition.type = "approximatelySign"sv;
  1511. partition.value = approximately_sign;
  1512. result.insert_before_matching(move(partition), [](auto const& part) {
  1513. return part.type.is_one_of("integer"sv, "decimal"sv, "plusSign"sv, "minusSign"sv, "percentSign"sv, "currency"sv);
  1514. });
  1515. // 4. Return result.
  1516. return result;
  1517. }
  1518. // 1.5.21 CollapseNumberRange ( result ), https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#sec-collapsenumberrange
  1519. Vector<PatternPartitionWithSource> collapse_number_range(Vector<PatternPartitionWithSource> result)
  1520. {
  1521. // Returning result unmodified is guaranteed to be a correct implementation of CollapseNumberRange.
  1522. return result;
  1523. }
  1524. // 1.5.22 FormatNumericRange( numberFormat, x, y ), https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#sec-formatnumericrange
  1525. ThrowCompletionOr<DeprecatedString> format_numeric_range(VM& vm, NumberFormat& number_format, MathematicalValue start, MathematicalValue end)
  1526. {
  1527. // 1. Let parts be ? PartitionNumberRangePattern(numberFormat, x, y).
  1528. auto parts = TRY(partition_number_range_pattern(vm, number_format, move(start), move(end)));
  1529. // 2. Let result be the empty String.
  1530. StringBuilder result;
  1531. // 3. For each part in parts, do
  1532. for (auto& part : parts) {
  1533. // a. Set result to the string-concatenation of result and part.[[Value]].
  1534. result.append(move(part.value));
  1535. }
  1536. // 4. Return result.
  1537. return result.build();
  1538. }
  1539. // 1.5.23 FormatNumericRangeToParts( numberFormat, x, y ), https://tc39.es/proposal-intl-numberformat-v3/out/numberformat/proposed.html#sec-formatnumericrangetoparts
  1540. ThrowCompletionOr<Array*> format_numeric_range_to_parts(VM& vm, NumberFormat& number_format, MathematicalValue start, MathematicalValue end)
  1541. {
  1542. auto& realm = *vm.current_realm();
  1543. // 1. Let parts be ? PartitionNumberRangePattern(numberFormat, x, y).
  1544. auto parts = TRY(partition_number_range_pattern(vm, number_format, move(start), move(end)));
  1545. // 2. Let result be ! ArrayCreate(0).
  1546. auto result = MUST(Array::create(realm, 0));
  1547. // 3. Let n be 0.
  1548. size_t n = 0;
  1549. // 4. For each Record { [[Type]], [[Value]] } part in parts, do
  1550. for (auto& part : parts) {
  1551. // a. Let O be OrdinaryObjectCreate(%Object.prototype%).
  1552. auto object = Object::create(realm, realm.intrinsics().object_prototype());
  1553. // b. Perform ! CreateDataPropertyOrThrow(O, "type", part.[[Type]]).
  1554. MUST(object->create_data_property_or_throw(vm.names.type, PrimitiveString::create(vm, part.type)));
  1555. // c. Perform ! CreateDataPropertyOrThrow(O, "value", part.[[Value]]).
  1556. MUST(object->create_data_property_or_throw(vm.names.value, PrimitiveString::create(vm, move(part.value))));
  1557. // d. Perform ! CreateDataPropertyOrThrow(O, "source", part.[[Source]]).
  1558. MUST(object->create_data_property_or_throw(vm.names.source, PrimitiveString::create(vm, part.source)));
  1559. // e. Perform ! CreateDataPropertyOrThrow(result, ! ToString(n), O).
  1560. MUST(result->create_data_property_or_throw(n, object));
  1561. // f. Increment n by 1.
  1562. ++n;
  1563. }
  1564. // 5. Return result.
  1565. return result.ptr();
  1566. }
  1567. }