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

#include "js/RootingAPI.h"
#include "js/Value.h"
#include "mozilla/dom/IndexedDatabaseManager.h"
#include "mozilla/dom/indexedDB/IDBResult.h"
#include "mozilla/dom/indexedDB/Key.h"
#include "nsCOMPtr.h"
#include "nsCycleCollectionParticipant.h"
#include "nsString.h"

class mozIStorageStatement;

namespace mozilla {

class ErrorResult;

namespace dom {

class GlobalObject;
class IDBTransaction;

namespace indexedDB {
class SerializedKeyRange;
}  // namespace indexedDB

class IDBKeyRange {
 protected:
  indexedDB::Key mLower;
  indexedDB::Key mUpper;
  JS::Heap<JS::Value> mCachedLowerVal;
  JS::Heap<JS::Value> mCachedUpperVal;

  const bool mLowerOpen : 1;
  const bool mUpperOpen : 1;
  const bool mIsOnly : 1;
  bool mHaveCachedLowerVal : 1;
  bool mHaveCachedUpperVal : 1;
  bool mRooted : 1;

 public:
  NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(IDBKeyRange)
  NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_NATIVE_CLASS(IDBKeyRange)

  // aCx is allowed to be null, but only if aVal.isUndefined().
  static void FromJSVal(JSContext* aCx, JS::Handle<JS::Value> aVal,
                        RefPtr<IDBKeyRange>* aKeyRange, ErrorResult& aRv,
                        IDBTransaction* aTransaction = nullptr);
  // Like above, but returns an IDBResult so that callers can distinguish
  // InvalidType from InvalidValue, unless of knowing only about
  // NS_ERROR_DOM_INDEXEDDB_DATA_ERR
  static indexedDB::IDBResult<mozilla::Ok,
                              indexedDB::IDBSpecialValue::InvalidType,
                              indexedDB::IDBSpecialValue::InvalidValue>
  FromJSVal(JSContext* aCx, JS::Handle<JS::Value> aVal,
            RefPtr<IDBKeyRange>* aKeyRange,
            IDBTransaction* aTransaction = nullptr);

  [[nodiscard]] static RefPtr<IDBKeyRange> FromSerialized(
      const indexedDB::SerializedKeyRange& aKeyRange);

  [[nodiscard]] static RefPtr<IDBKeyRange> Only(const GlobalObject& aGlobal,
                                                JS::Handle<JS::Value> aValue,
                                                ErrorResult& aRv);

  [[nodiscard]] static RefPtr<IDBKeyRange> LowerBound(
      const GlobalObject& aGlobal, JS::Handle<JS::Value> aValue, bool aOpen,
      ErrorResult& aRv);

  [[nodiscard]] static RefPtr<IDBKeyRange> UpperBound(
      const GlobalObject& aGlobal, JS::Handle<JS::Value> aValue, bool aOpen,
      ErrorResult& aRv);

  [[nodiscard]] static RefPtr<IDBKeyRange> Bound(const GlobalObject& aGlobal,
                                                 JS::Handle<JS::Value> aLower,
                                                 JS::Handle<JS::Value> aUpper,
                                                 bool aLowerOpen,
                                                 bool aUpperOpen,
                                                 ErrorResult& aRv);

  void AssertIsOnOwningThread() const { NS_ASSERT_OWNINGTHREAD(IDBKeyRange); }

  void ToSerialized(indexedDB::SerializedKeyRange& aKeyRange) const;

  const indexedDB::Key& Lower() const { return mLower; }

  indexedDB::Key& Lower() { return mLower; }

  const indexedDB::Key& Upper() const { return mIsOnly ? mLower : mUpper; }

  indexedDB::Key& Upper() { return mIsOnly ? mLower : mUpper; }

  bool Includes(JSContext* aCx, JS::Handle<JS::Value> aValue,
                ErrorResult& aRv) const;

  bool IsOnly() const { return mIsOnly; }

  void DropJSObjects();

  // WebIDL
  bool WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto,
                  JS::MutableHandle<JSObject*> aReflector);

  void GetLower(JSContext* aCx, JS::MutableHandle<JS::Value> aResult,
                ErrorResult& aRv);

  void GetUpper(JSContext* aCx, JS::MutableHandle<JS::Value> aResult,
                ErrorResult& aRv);

  bool LowerOpen() const { return mLowerOpen; }

  bool UpperOpen() const { return mUpperOpen; }

 protected:
  IDBKeyRange(bool aLowerOpen, bool aUpperOpen, bool aIsOnly);

  virtual ~IDBKeyRange();
};

}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_idbkeyrange_h_