/* -*- 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_DisplayNames_h
#define builtin_intl_DisplayNames_h

#include "mozilla/Attributes.h"

#include <stddef.h>
#include <stdint.h>

#include "jstypes.h"
#include "NamespaceImports.h"

#include "builtin/SelfHostingDefines.h"
#include "js/Class.h"  // JSClass, JSClassOps, js::ClassSpec
#include "js/Value.h"
#include "vm/JSObject.h"
#include "vm/List.h"
#include "vm/NativeObject.h"

struct JS_PUBLIC_API JSContext;
class JS_PUBLIC_API JSFreeOp;

struct ULocaleDisplayNames;

namespace js {
struct ClassSpec;

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

  static constexpr uint32_t INTERNALS_SLOT = 0;
  static constexpr uint32_t ULOCALE_DISPLAY_NAMES_SLOT = 1;
  static constexpr uint32_t DATE_TIME_NAMES_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 ULocaleDisplayNames (see IcuMemoryUsage).
  static constexpr size_t EstimatedMemoryUse = 1256;

  ULocaleDisplayNames* getLocaleDisplayNames() const {
    const auto& slot = getFixedSlot(ULOCALE_DISPLAY_NAMES_SLOT);
    if (slot.isUndefined()) {
      return nullptr;
    }
    return static_cast<ULocaleDisplayNames*>(slot.toPrivate());
  }

  void setLocaleDisplayNames(ULocaleDisplayNames* localeDisplayNames) {
    setFixedSlot(ULOCALE_DISPLAY_NAMES_SLOT, PrivateValue(localeDisplayNames));
  }

  ListObject* getDateTimeNames() const {
    const auto& slot = getFixedSlot(DATE_TIME_NAMES_SLOT);
    if (slot.isUndefined()) {
      return nullptr;
    }
    return &slot.toObject().as<ListObject>();
  }

  void setDateTimeNames(ListObject* names) {
    setFixedSlot(DATE_TIME_NAMES_SLOT, ObjectValue(*names));
  }

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

  static void finalize(JSFreeOp* fop, JSObject* obj);
};

/**
 * Return the display name for the requested code or undefined if no applicable
 * display name was found.
 *
 * Usage: result = intl_ComputeDisplayName(displayNames, locale, calendar,
 *                                         style, fallback, type, code)
 */
extern MOZ_MUST_USE bool intl_ComputeDisplayName(JSContext* cx, unsigned argc,
                                                 Value* vp);

}  // namespace js

#endif /* builtin_intl_DisplayNames_h */