js-list-format.h

Go to the documentation of this file.

// Copyright 2018 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_LIST_FORMAT_H_
#define V8_OBJECTS_JS_LIST_FORMAT_H_
 
#ifndef V8_INTL_SUPPORT
#error Internationalization is expected to be enabled.
#endif  // V8_INTL_SUPPORT
 
#include <set>
#include <string>
 
#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"
#include "unicode/uversion.h"
 
// Has to be the last include (doesn't have include guards):
#include "src/objects/object-macros.h"
 
namespace U_ICU_NAMESPACE {
class ListFormatter;
}  // namespace U_ICU_NAMESPACE
 
namespace v8 {
namespace internal {
 
#include "torque-generated/src/objects/js-list-format-tq.inc"
 
class JSListFormat
    : public TorqueGeneratedJSListFormat<JSListFormat, JSObject> {
 public:
  // Creates relative time format object with properties derived from input
  // locales and options.
  static MaybeDirectHandle<JSListFormat> New(Isolate* isolate,
                                             DirectHandle<Map> map,
                                             DirectHandle<Object> locales,
                                             DirectHandle<Object> options);
 
  static DirectHandle<JSObject> ResolvedOptions(
      Isolate* isolate, DirectHandle<JSListFormat> format_holder);
 
  // ecma402 #sec-formatlist
  V8_WARN_UNUSED_RESULT static MaybeDirectHandle<String> FormatList(
      Isolate* isolate, DirectHandle<JSListFormat> format_holder,
      DirectHandle<FixedArray> list);
 
  // ecma42 #sec-formatlisttoparts
  V8_WARN_UNUSED_RESULT static MaybeDirectHandle<JSArray> FormatListToParts(
      Isolate* isolate, DirectHandle<JSListFormat> format_holder,
      DirectHandle<FixedArray> list);
 
  V8_EXPORT_PRIVATE static const std::set<std::string>& GetAvailableLocales();
 
  Handle<String> StyleAsString(Isolate* isolate) const;
  Handle<String> TypeAsString(Isolate* isolate) const;
 
  // ListFormat accessors.
  DECL_ACCESSORS(icu_formatter, Tagged<Managed<icu::ListFormatter>>)
 
  // Style: identifying the relative time format style used.
  //
  // ecma402/#sec-properties-of-intl-listformat-instances
  enum class Style {
    LONG,   // Everything spelled out.
    SHORT,  // Abbreviations used when possible.
    NARROW  // Use the shortest possible form.
  };
  inline void set_style(Style style);
  inline Style style() const;
 
  // Type: identifying the list of types used.
  //
  // ecma402/#sec-properties-of-intl-listformat-instances
  enum class Type {
    CONJUNCTION,  // for "and"-based lists (e.g., "A, B and C")
    DISJUNCTION,  // for "or"-based lists (e.g., "A, B or C"),
    UNIT  // for lists of values with units (e.g., "5 pounds, 12 ounces").
  };
  inline void set_type(Type type);
  inline Type type() const;
 
  // Bit positions in |flags|.
  DEFINE_TORQUE_GENERATED_JS_LIST_FORMAT_FLAGS()
 
  static_assert(StyleBits::is_valid(Style::LONG));
  static_assert(StyleBits::is_valid(Style::SHORT));
  static_assert(StyleBits::is_valid(Style::NARROW));
  static_assert(TypeBits::is_valid(Type::CONJUNCTION));
  static_assert(TypeBits::is_valid(Type::DISJUNCTION));
  static_assert(TypeBits::is_valid(Type::UNIT));
 
  DECL_PRINTER(JSListFormat)
 
  TQ_OBJECT_CONSTRUCTORS(JSListFormat)
};
 
}  // namespace internal
}  // namespace v8
 
#include "src/objects/object-macros-undef.h"
 
#endif  // V8_OBJECTS_JS_LIST_FORMAT_H_