// 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_LOCALE_H_
#define V8_OBJECTS_JS_LOCALE_H_

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

#include "src/execution/isolate.h"
#include "src/handles/global-handles.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 U_ICU_NAMESPACE

namespace v8 {
namespace internal {

V8_OBJECT class JSLocale : public JSObject {
 public:
  // Creates locale object with properties derived from input locale string
  // and options.
  static MaybeDirectHandle<JSLocale> New(Isolate* isolate,
                                         DirectHandle<Map> map,
                                         DirectHandle<String> locale,
                                         DirectHandle<JSReceiver> options);

  static MaybeDirectHandle<JSLocale> Maximize(Isolate* isolate,
                                              DirectHandle<JSLocale> locale);
  static MaybeDirectHandle<JSLocale> Minimize(Isolate* isolate,
                                              DirectHandle<JSLocale> locale);

  V8_WARN_UNUSED_RESULT static MaybeDirectHandle<JSArray> GetCalendars(
      Isolate* isolate, DirectHandle<JSLocale> locale);
  V8_WARN_UNUSED_RESULT static MaybeDirectHandle<JSArray> GetCollations(
      Isolate* isolate, DirectHandle<JSLocale> locale);
  V8_WARN_UNUSED_RESULT static MaybeDirectHandle<JSArray> GetHourCycles(
      Isolate* isolate, DirectHandle<JSLocale> locale);
  V8_WARN_UNUSED_RESULT static MaybeDirectHandle<JSArray> GetNumberingSystems(
      Isolate* isolate, DirectHandle<JSLocale> locale);
  V8_WARN_UNUSED_RESULT static MaybeDirectHandle<JSObject> GetTextInfo(
      Isolate* isolate, DirectHandle<JSLocale> locale);
  V8_WARN_UNUSED_RESULT static MaybeDirectHandle<Object> GetTimeZones(
      Isolate* isolate, DirectHandle<JSLocale> locale);
  V8_WARN_UNUSED_RESULT static MaybeDirectHandle<JSObject> GetWeekInfo(
      Isolate* isolate, DirectHandle<JSLocale> locale);

  static DirectHandle<Object> Language(Isolate* isolate,
                                       DirectHandle<JSLocale> locale);
  static DirectHandle<Object> Script(Isolate* isolate,
                                     DirectHandle<JSLocale> locale);
  static DirectHandle<Object> Region(Isolate* isolate,
                                     DirectHandle<JSLocale> locale);
  static DirectHandle<Object> Variants(Isolate* isolate,
                                       DirectHandle<JSLocale> locale);
  static DirectHandle<String> BaseName(Isolate* isolate,
                                       DirectHandle<JSLocale> locale);
  static DirectHandle<Object> Calendar(Isolate* isolate,
                                       DirectHandle<JSLocale> locale);
  static DirectHandle<Object> CaseFirst(Isolate* isolate,
                                        DirectHandle<JSLocale> locale);
  static DirectHandle<Object> Collation(Isolate* isolate,
                                        DirectHandle<JSLocale> locale);
  static DirectHandle<Object> HourCycle(Isolate* isolate,
                                        DirectHandle<JSLocale> locale);
  static DirectHandle<Object> FirstDayOfWeek(Isolate* isolate,
                                             DirectHandle<JSLocale> locale);
  static DirectHandle<Object> Numeric(Isolate* isolate,
                                      DirectHandle<JSLocale> locale);
  static DirectHandle<Object> NumberingSystem(Isolate* isolate,
                                              DirectHandle<JSLocale> locale);
  static DirectHandle<String> ToString(Isolate* isolate,
                                       DirectHandle<JSLocale> locale);
  static std::string ToString(DirectHandle<JSLocale> locale);

  // Help function to validate locale by other Intl objects.
  static bool StartsWithUnicodeLanguageId(std::string_view value);

  // Help function to check well-formed
  // "(3*8alphanum) *("-" (3*8alphanum)) sequence" sequence
  static bool Is38AlphaNumList(std::string_view value);

  // Help function to check well-formed "3alpha"
  static bool Is3Alpha(std::string_view value);

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

  DECL_PRINTER(JSLocale)
  DECL_VERIFIER(JSLocale)

  static const int kHeaderSize;

 public:
  TaggedMember<Foreign> icu_locale_;
} V8_OBJECT_END;

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

}  // namespace internal
}  // namespace v8

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

#endif  // V8_OBJECTS_JS_LOCALE_H_