src/objects/js-duration-format.h

// Copyright 2022 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef V8_OBJECTS_JS_DURATION_FORMAT_H_
#define V8_OBJECTS_JS_DURATION_FORMAT_H_

#ifndef V8_INTL_SUPPORT
#error Internationalization is expected to be enabled.
#endif  // V8_INTL_SUPPORT

#include "src/base/bit-field.h"
#include "src/execution/isolate.h"
#include "src/heap/factory.h"
#include "src/objects/managed.h"
#include "src/objects/objects.h"

// Has to be the last include (doesn't have include guards):
#include "src/objects/object-macros.h"

namespace U_ICU_NAMESPACE {
class Locale;
namespace number {
class LocalizedNumberFormatter;
}  // namespace number
}  // namespace U_ICU_NAMESPACE

namespace v8 {
namespace internal {

V8_OBJECT class JSDurationFormat : public JSObject {
 public:
  // Creates duration format object with properties derived from input
  // locales and options.
  V8_WARN_UNUSED_RESULT static MaybeDirectHandle<JSDurationFormat> New(
      Isolate* isolate, DirectHandle<Map> map, DirectHandle<Object> locales,
      DirectHandle<Object> options, const char* method_name);

  V8_WARN_UNUSED_RESULT static DirectHandle<JSObject> ResolvedOptions(
      Isolate* isolate, DirectHandle<JSDurationFormat> format_holder);

  V8_WARN_UNUSED_RESULT static MaybeDirectHandle<String> Format(
      Isolate* isolate, DirectHandle<JSDurationFormat> df,
      DirectHandle<Object> duration);

  V8_WARN_UNUSED_RESULT static MaybeDirectHandle<JSArray> FormatToParts(
      Isolate* isolate, DirectHandle<JSDurationFormat> df,
      DirectHandle<Object> duration);

  V8_WARN_UNUSED_RESULT static MaybeDirectHandle<String> TemporalToLocaleString(
      Isolate* isolate, DirectHandle<JSReceiver> duration,
      DirectHandle<Object> locales, DirectHandle<Object> options);

  V8_EXPORT_PRIVATE static const std::set<std::string>& GetAvailableLocales();

  enum class Display {
    kAuto,
    kAlways,

    kMax = kAlways
  };

  enum class Style {
    kLong,
    kShort,
    kNarrow,
    kDigital,

    kMax = kDigital
  };

  // To optimize per object memory usage, we use 2 bits
  // to store one of the four possible time separators encoded in
  // icu/source/data/locales/$locale/NumberElements/$numberingSystem/timeSeparator
  enum class Separator {
    kColon,                   // U+003A
    kFullStop,                // U+002E
    kFullwidthColon,          // U+FF1A
    kArabicDecimalSeparator,  // U+066B

    kMax = kArabicDecimalSeparator
  };

  // The ordering of these values is significant, because sub-ranges are
  // encoded using bitfields.
  enum class FieldStyle {
    kLong,
    kShort,
    kNarrow,
    kNumeric,
    k2Digit,
    kFractional,
    kUndefined,

    kStyle3Max = kNarrow,
    kStyle4Max = kFractional,
    kStyle5Max = k2Digit,
  };

#define DECLARE_INLINE_SETTER_GETTER(T, n) \
  inline void set_##n(T);                  \
  inline T n() const;

#define DECLARE_INLINE_DISPLAY_SETTER_GETTER(f) \
  DECLARE_INLINE_SETTER_GETTER(Display, f##_display)

#define DECLARE_INLINE_FIELD_STYLE_SETTER_GETTER(f) \
  DECLARE_INLINE_SETTER_GETTER(FieldStyle, f##_style)

  DECLARE_INLINE_DISPLAY_SETTER_GETTER(years)
  DECLARE_INLINE_DISPLAY_SETTER_GETTER(months)
  DECLARE_INLINE_DISPLAY_SETTER_GETTER(weeks)
  DECLARE_INLINE_DISPLAY_SETTER_GETTER(days)
  DECLARE_INLINE_DISPLAY_SETTER_GETTER(hours)
  DECLARE_INLINE_DISPLAY_SETTER_GETTER(minutes)
  DECLARE_INLINE_DISPLAY_SETTER_GETTER(seconds)
  DECLARE_INLINE_DISPLAY_SETTER_GETTER(milliseconds)
  DECLARE_INLINE_DISPLAY_SETTER_GETTER(microseconds)
  DECLARE_INLINE_DISPLAY_SETTER_GETTER(nanoseconds)

  DECLARE_INLINE_SETTER_GETTER(Style, style)
  DECLARE_INLINE_SETTER_GETTER(Separator, separator)

  DECLARE_INLINE_FIELD_STYLE_SETTER_GETTER(years)
  DECLARE_INLINE_FIELD_STYLE_SETTER_GETTER(months)
  DECLARE_INLINE_FIELD_STYLE_SETTER_GETTER(weeks)
  DECLARE_INLINE_FIELD_STYLE_SETTER_GETTER(days)
  DECLARE_INLINE_FIELD_STYLE_SETTER_GETTER(hours)
  DECLARE_INLINE_FIELD_STYLE_SETTER_GETTER(minutes)
  DECLARE_INLINE_FIELD_STYLE_SETTER_GETTER(seconds)
  DECLARE_INLINE_FIELD_STYLE_SETTER_GETTER(milliseconds)
  DECLARE_INLINE_FIELD_STYLE_SETTER_GETTER(microseconds)
  DECLARE_INLINE_FIELD_STYLE_SETTER_GETTER(nanoseconds)

#undef DECLARE_INLINE_SETTER_GETTER
#undef DECLARE_INLINE_STYLE_SETTER_GETTER
#undef DECLARE_INLINE_FIELD_STYLE_SETTER_GETTER

  // Since we store the fractional_digits in 4 bits but only use 0-9 as valid
  // value. We use value 15 (max of 4 bits) to denote "undefined".
  static const uint32_t kUndefinedFractionalDigits = 15;
  inline void set_fractional_digits(int32_t digits);
  inline int32_t fractional_digits() const;

  // Bit positions in |display_flags|.
  using YearsDisplayBit =
      base::BitField<JSDurationFormat::Display, 0, 1, uint32_t>;
  using MonthsDisplayBit = YearsDisplayBit::Next<JSDurationFormat::Display, 1>;
  using WeeksDisplayBit = MonthsDisplayBit::Next<JSDurationFormat::Display, 1>;
  using DaysDisplayBit = WeeksDisplayBit::Next<JSDurationFormat::Display, 1>;
  using HoursDisplayBit = DaysDisplayBit::Next<JSDurationFormat::Display, 1>;
  using MinutesDisplayBit = HoursDisplayBit::Next<JSDurationFormat::Display, 1>;
  using SecondsDisplayBit =
      MinutesDisplayBit::Next<JSDurationFormat::Display, 1>;
  using MillisecondsDisplayBit =
      SecondsDisplayBit::Next<JSDurationFormat::Display, 1>;
  using MicrosecondsDisplayBit =
      MillisecondsDisplayBit::Next<JSDurationFormat::Display, 1>;
  using NanosecondsDisplayBit =
      MicrosecondsDisplayBit::Next<JSDurationFormat::Display, 1>;
  using FractionalDigitsBits = NanosecondsDisplayBit::Next<int32_t, 4>;
  // Bit positions in |style_flags|.
  using StyleBits = base::BitField<JSDurationFormat::Style, 0, 2, uint32_t>;
  using YearsStyleBits = StyleBits::Next<JSDurationFormat::FieldStyle, 2>;
  using MonthsStyleBits = YearsStyleBits::Next<JSDurationFormat::FieldStyle, 2>;
  using WeeksStyleBits = MonthsStyleBits::Next<JSDurationFormat::FieldStyle, 2>;
  using DaysStyleBits = WeeksStyleBits::Next<JSDurationFormat::FieldStyle, 2>;
  using HoursStyleBits = DaysStyleBits::Next<JSDurationFormat::FieldStyle, 3>;
  using MinutesStyleBits =
      HoursStyleBits::Next<JSDurationFormat::FieldStyle, 3>;
  using SecondsStyleBits =
      MinutesStyleBits::Next<JSDurationFormat::FieldStyle, 3>;
  using MillisecondsStyleBits =
      SecondsStyleBits::Next<JSDurationFormat::FieldStyle, 3>;
  using MicrosecondsStyleBits =
      MillisecondsStyleBits::Next<JSDurationFormat::FieldStyle, 3>;
  using NanosecondsStyleBits =
      MicrosecondsStyleBits::Next<JSDurationFormat::FieldStyle, 3>;
  using SeparatorBits =
      NanosecondsStyleBits::Next<JSDurationFormat::Separator, 2>;

  static_assert(YearsDisplayBit::is_valid(Display::kMax));
  static_assert(MonthsDisplayBit::is_valid(Display::kMax));
  static_assert(WeeksDisplayBit::is_valid(Display::kMax));
  static_assert(DaysDisplayBit::is_valid(Display::kMax));
  static_assert(HoursDisplayBit::is_valid(Display::kMax));
  static_assert(MinutesDisplayBit::is_valid(Display::kMax));
  static_assert(SecondsDisplayBit::is_valid(Display::kMax));
  static_assert(MillisecondsDisplayBit::is_valid(Display::kMax));
  static_assert(MicrosecondsDisplayBit::is_valid(Display::kMax));
  static_assert(NanosecondsDisplayBit::is_valid(Display::kMax));

  static_assert(StyleBits::is_valid(Style::kMax));

  static_assert(YearsStyleBits::is_valid(FieldStyle::kStyle3Max));
  static_assert(MonthsStyleBits::is_valid(FieldStyle::kStyle3Max));
  static_assert(WeeksStyleBits::is_valid(FieldStyle::kStyle3Max));
  static_assert(DaysStyleBits::is_valid(FieldStyle::kStyle3Max));
  static_assert(HoursStyleBits::is_valid(FieldStyle::kStyle5Max));
  static_assert(MinutesStyleBits::is_valid(FieldStyle::kStyle5Max));
  static_assert(SecondsStyleBits::is_valid(FieldStyle::kStyle5Max));
  static_assert(MillisecondsStyleBits::is_valid(FieldStyle::kStyle4Max));
  static_assert(MicrosecondsStyleBits::is_valid(FieldStyle::kStyle4Max));
  static_assert(NanosecondsStyleBits::is_valid(FieldStyle::kStyle4Max));

  inline int style_flags() const;
  inline void set_style_flags(int value);

  inline int display_flags() const;
  inline void set_display_flags(int value);

  inline Tagged<Managed<icu::Locale>> icu_locale() const;
  inline void set_icu_locale(Tagged<Managed<icu::Locale>> value,
                             WriteBarrierMode mode = UPDATE_WRITE_BARRIER);

  inline Tagged<Managed<icu::number::LocalizedNumberFormatter>>
  icu_number_formatter() const;
  inline void set_icu_number_formatter(
      Tagged<Managed<icu::number::LocalizedNumberFormatter>> value,
      WriteBarrierMode mode = UPDATE_WRITE_BARRIER);

  DECL_PRINTER(JSDurationFormat)
  DECL_VERIFIER(JSDurationFormat)

  static const int kHeaderSize;

 public:
  TaggedMember<Smi> style_flags_;
  TaggedMember<Smi> display_flags_;
  TaggedMember<Foreign> icu_locale_;
  TaggedMember<Foreign> icu_number_formatter_;
} V8_OBJECT_END;

inline constexpr int JSDurationFormat::kHeaderSize = sizeof(JSDurationFormat);

}  // namespace internal
}  // namespace v8

#include "src/objects/object-macros-undef.h"

#endif  // V8_OBJECTS_JS_DURATION_FORMAT_H_