diff options
Diffstat (limited to 'js/src/builtin/intl/PluralRules.h')
-rw-r--r-- | js/src/builtin/intl/PluralRules.h | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/js/src/builtin/intl/PluralRules.h b/js/src/builtin/intl/PluralRules.h new file mode 100644 index 0000000000..e9ad2ea4c8 --- /dev/null +++ b/js/src/builtin/intl/PluralRules.h @@ -0,0 +1,115 @@ +/* -*- 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_PluralRules_h +#define builtin_intl_PluralRules_h + +#include "mozilla/Attributes.h" + +#include "builtin/SelfHostingDefines.h" +#include "js/Class.h" +#include "js/RootingAPI.h" +#include "vm/NativeObject.h" + +struct UFormattedNumber; +struct UNumberFormatter; +struct UPluralRules; + +namespace js { + +class PluralRulesObject : public NativeObject { + public: + static const JSClass class_; + static const JSClass& protoClass_; + + static constexpr uint32_t INTERNALS_SLOT = 0; + static constexpr uint32_t UPLURAL_RULES_SLOT = 1; + static constexpr uint32_t UNUMBER_FORMATTER_SLOT = 2; + static constexpr uint32_t UFORMATTED_NUMBER_SLOT = 3; + static constexpr uint32_t SLOT_COUNT = 4; + + 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 UNumberFormatterEstimatedMemoryUse = 750; + + // Estimated memory use for UPluralRules (see IcuMemoryUsage). + static constexpr size_t UPluralRulesEstimatedMemoryUse = 2976; + + UPluralRules* getPluralRules() const { + const auto& slot = getFixedSlot(UPLURAL_RULES_SLOT); + if (slot.isUndefined()) { + return nullptr; + } + return static_cast<UPluralRules*>(slot.toPrivate()); + } + + void setPluralRules(UPluralRules* pluralRules) { + setFixedSlot(UPLURAL_RULES_SLOT, PrivateValue(pluralRules)); + } + + UNumberFormatter* getNumberFormatter() const { + const auto& slot = getFixedSlot(UNUMBER_FORMATTER_SLOT); + if (slot.isUndefined()) { + return nullptr; + } + return static_cast<UNumberFormatter*>(slot.toPrivate()); + } + + void setNumberFormatter(UNumberFormatter* formatter) { + setFixedSlot(UNUMBER_FORMATTER_SLOT, PrivateValue(formatter)); + } + + UFormattedNumber* getFormattedNumber() const { + const auto& slot = getFixedSlot(UFORMATTED_NUMBER_SLOT); + if (slot.isUndefined()) { + return nullptr; + } + return static_cast<UFormattedNumber*>(slot.toPrivate()); + } + + void setFormattedNumber(UFormattedNumber* formatted) { + setFixedSlot(UFORMATTED_NUMBER_SLOT, PrivateValue(formatted)); + } + + private: + static const JSClassOps classOps_; + static const ClassSpec classSpec_; + + static void finalize(JSFreeOp* fop, JSObject* obj); +}; + +/** + * Returns a plural rule for the number x according to the effective + * locale and the formatting options of the given PluralRules. + * + * A plural rule is a grammatical category that expresses count distinctions + * (such as "one", "two", "few" etc.). + * + * Usage: rule = intl_SelectPluralRule(pluralRules, x) + */ +extern MOZ_MUST_USE bool intl_SelectPluralRule(JSContext* cx, unsigned argc, + JS::Value* vp); + +/** + * Returns an array of plural rules categories for a given pluralRules object. + * + * Usage: categories = intl_GetPluralCategories(pluralRules) + * + * Example: + * + * pluralRules = new Intl.PluralRules('pl', {type: 'cardinal'}); + * intl_getPluralCategories(pluralRules); // ['one', 'few', 'many', 'other'] + */ +extern MOZ_MUST_USE bool intl_GetPluralCategories(JSContext* cx, unsigned argc, + JS::Value* vp); + +} // namespace js + +#endif /* builtin_intl_PluralRules_h */ |