tor-browser

NumberFormat.h (6175B)

---

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: set ts=8 sts=2 et sw=2 tw=80:
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef builtin_intl_NumberFormat_h
#define builtin_intl_NumberFormat_h

#include <stdint.h>
#include <string_view>

#include "builtin/SelfHostingDefines.h"
#include "js/Class.h"
#include "vm/NativeObject.h"

class JSString;
class JSLinearString;

namespace mozilla::intl {
class NumberFormat;
class NumberRangeFormat;
}  // namespace mozilla::intl

namespace js {

class ArrayObject;

class NumberFormatObject : public NativeObject {
public:
 static const JSClass class_;
 static const JSClass& protoClass_;

 static constexpr uint32_t INTERNALS_SLOT = 0;
 static constexpr uint32_t UNUMBER_FORMATTER_SLOT = 1;
 static constexpr uint32_t UNUMBER_RANGE_FORMATTER_SLOT = 2;
 static constexpr uint32_t SLOT_COUNT = 3;

 static_assert(INTERNALS_SLOT == INTL_INTERNALS_OBJECT_SLOT,
               "INTERNALS_SLOT must match self-hosting define for internals "
               "object slot");

 // Estimated memory use for UNumberFormatter and UFormattedNumber
 // (see IcuMemoryUsage).
 static constexpr size_t EstimatedMemoryUse = 972;

 // Estimated memory use for UNumberRangeFormatter and UFormattedNumberRange
 // (see IcuMemoryUsage).
 static constexpr size_t EstimatedRangeFormatterMemoryUse = 19894;

 mozilla::intl::NumberFormat* getNumberFormatter() const {
   const auto& slot = getFixedSlot(UNUMBER_FORMATTER_SLOT);
   if (slot.isUndefined()) {
     return nullptr;
   }
   return static_cast<mozilla::intl::NumberFormat*>(slot.toPrivate());
 }

 void setNumberFormatter(mozilla::intl::NumberFormat* formatter) {
   setFixedSlot(UNUMBER_FORMATTER_SLOT, PrivateValue(formatter));
 }

 mozilla::intl::NumberRangeFormat* getNumberRangeFormatter() const {
   const auto& slot = getFixedSlot(UNUMBER_RANGE_FORMATTER_SLOT);
   if (slot.isUndefined()) {
     return nullptr;
   }
   return static_cast<mozilla::intl::NumberRangeFormat*>(slot.toPrivate());
 }

 void setNumberRangeFormatter(mozilla::intl::NumberRangeFormat* formatter) {
   setFixedSlot(UNUMBER_RANGE_FORMATTER_SLOT, PrivateValue(formatter));
 }

private:
 static const JSClassOps classOps_;
 static const ClassSpec classSpec_;

 static void finalize(JS::GCContext* gcx, JSObject* obj);
};

/**
* Returns a new instance of the standard built-in NumberFormat constructor.
*
* Usage: numberFormat = intl_NumberFormat(locales, options)
*/
[[nodiscard]] extern bool intl_NumberFormat(JSContext* cx, unsigned argc,
                                           Value* vp);

/**
* Returns the numbering system type identifier per Unicode
* Technical Standard 35, Unicode Locale Data Markup Language, for the
* default numbering system for the given locale.
*
* Usage: defaultNumberingSystem = intl_numberingSystem(locale)
*/
[[nodiscard]] extern bool intl_numberingSystem(JSContext* cx, unsigned argc,
                                              Value* vp);

/**
* Returns a string representing the number x according to the effective
* locale and the formatting options of the given NumberFormat.
*
* Spec: ECMAScript Internationalization API Specification, 11.3.2.
*
* Usage: formatted = intl_FormatNumber(numberFormat, x, formatToParts)
*/
[[nodiscard]] extern bool intl_FormatNumber(JSContext* cx, unsigned argc,
                                           Value* vp);

/**
* Returns a string representing the number range «x - y» according to the
* effective locale and the formatting options of the given NumberFormat.
*
* Usage: formatted = intl_FormatNumberRange(numberFormat, x, y, formatToParts)
*/
[[nodiscard]] extern bool intl_FormatNumberRange(JSContext* cx, unsigned argc,
                                                Value* vp);

#if DEBUG || MOZ_SYSTEM_ICU
/**
* Returns an object with all available measurement units.
*
* Usage: units = intl_availableMeasurementUnits()
*/
[[nodiscard]] extern bool intl_availableMeasurementUnits(JSContext* cx,
                                                        unsigned argc,
                                                        Value* vp);
#endif

namespace intl {

/**
* Returns a new instance of the standard built-in NumberFormat constructor.
*/
[[nodiscard]] extern NumberFormatObject* CreateNumberFormat(
   JSContext* cx, JS::Handle<JS::Value> locales,
   JS::Handle<JS::Value> options);

/**
* Returns a possibly cached instance of the standard built-in NumberFormat
* constructor.
*/
[[nodiscard]] extern NumberFormatObject* GetOrCreateNumberFormat(
   JSContext* cx, JS::Handle<JS::Value> locales,
   JS::Handle<JS::Value> options);

/**
* Returns a string representing the number x according to the effective locale
* and the formatting options of the given NumberFormat.
*/
[[nodiscard]] extern JSString* FormatNumber(
   JSContext* cx, Handle<NumberFormatObject*> numberFormat, double x);

/**
* Returns a string representing the BigInt x according to the effective locale
* and the formatting options of the given NumberFormat.
*/
[[nodiscard]] extern JSString* FormatBigInt(
   JSContext* cx, Handle<NumberFormatObject*> numberFormat, Handle<BigInt*> x);

using NumberFormatUnit = js::ImmutableTenuredPtr<PropertyName*> JSAtomState::*;

[[nodiscard]] extern JSLinearString* FormatNumber(
   JSContext* cx, mozilla::intl::NumberFormat* numberFormat, double x);

[[nodiscard]] extern JSLinearString* FormatNumber(
   JSContext* cx, mozilla::intl::NumberFormat* numberFormat,
   std::string_view x);

[[nodiscard]] extern ArrayObject* FormatNumberToParts(
   JSContext* cx, mozilla::intl::NumberFormat* numberFormat, double x,
   NumberFormatUnit unit = nullptr);

[[nodiscard]] extern ArrayObject* FormatNumberToParts(
   JSContext* cx, mozilla::intl::NumberFormat* numberFormat,
   std::string_view x, NumberFormatUnit unit = nullptr);

}  // namespace intl

}  // namespace js

#endif /* builtin_intl_NumberFormat_h */