dom/indexedDB/IDBKeyRange.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_idbkeyrange_h__
   8 #define mozilla_dom_idbkeyrange_h__
   9
  10 #include "js/RootingAPI.h"
  11 #include "js/Value.h"
  12 #include "mozilla/Attributes.h"
  13 #include "mozilla/dom/IndexedDatabaseManager.h"
  14 #include "mozilla/dom/indexedDB/Key.h"
  15 #include "nsCOMPtr.h"
  16 #include "nsCycleCollectionParticipant.h"
  17 #include "nsISupports.h"
  18 #include "nsString.h"
  19
  20 class mozIStorageStatement;
  21
  22 namespace mozilla {
  23
  24 class ErrorResult;
  25
  26 namespace dom {
  27
  28 class GlobalObject;
  29
  30 namespace indexedDB {
  31 class SerializedKeyRange;
  32 }  // namespace indexedDB
  33
  34 class IDBKeyRange : public nsISupports {
  35  protected:
  36   nsCOMPtr<nsISupports> mGlobal;
  37   indexedDB::Key mLower;
  38   indexedDB::Key mUpper;
  39   JS::Heap<JS::Value> mCachedLowerVal;
  40   JS::Heap<JS::Value> mCachedUpperVal;
  41
  42   const bool mLowerOpen : 1;
  43   const bool mUpperOpen : 1;
  44   const bool mIsOnly : 1;
  45   bool mHaveCachedLowerVal : 1;
  46   bool mHaveCachedUpperVal : 1;
  47   bool mRooted : 1;
  48
  49  public:
  50   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  51   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(IDBKeyRange)
  52
  53   // aCx is allowed to be null, but only if aVal.isUndefined().
  54   static void FromJSVal(JSContext* aCx, JS::Handle<JS::Value> aVal,
  55                         RefPtr<IDBKeyRange>* aKeyRange, ErrorResult& aRv);
  56
  57   [[nodiscard]] static RefPtr<IDBKeyRange> FromSerialized(
  58       const indexedDB::SerializedKeyRange& aKeyRange);
  59
  60   [[nodiscard]] static RefPtr<IDBKeyRange> Only(const GlobalObject& aGlobal,
  61                                                 JS::Handle<JS::Value> aValue,
  62                                                 ErrorResult& aRv);
  63
  64   [[nodiscard]] static RefPtr<IDBKeyRange> LowerBound(
  65       const GlobalObject& aGlobal, JS::Handle<JS::Value> aValue, bool aOpen,
  66       ErrorResult& aRv);
  67
  68   [[nodiscard]] static RefPtr<IDBKeyRange> UpperBound(
  69       const GlobalObject& aGlobal, JS::Handle<JS::Value> aValue, bool aOpen,
  70       ErrorResult& aRv);
  71
  72   [[nodiscard]] static RefPtr<IDBKeyRange> Bound(const GlobalObject& aGlobal,
  73                                                  JS::Handle<JS::Value> aLower,
  74                                                  JS::Handle<JS::Value> aUpper,
  75                                                  bool aLowerOpen,
  76                                                  bool aUpperOpen,
  77                                                  ErrorResult& aRv);
  78
  79   void AssertIsOnOwningThread() const { NS_ASSERT_OWNINGTHREAD(IDBKeyRange); }
  80
  81   void ToSerialized(indexedDB::SerializedKeyRange& aKeyRange) const;
  82
  83   const indexedDB::Key& Lower() const { return mLower; }
  84
  85   indexedDB::Key& Lower() { return mLower; }
  86
  87   const indexedDB::Key& Upper() const { return mIsOnly ? mLower : mUpper; }
  88
  89   indexedDB::Key& Upper() { return mIsOnly ? mLower : mUpper; }
  90
  91   bool Includes(JSContext* aCx, JS::Handle<JS::Value> aValue,
  92                 ErrorResult& aRv) const;
  93
  94   bool IsOnly() const { return mIsOnly; }
  95
  96   void DropJSObjects();
  97
  98   // WebIDL
  99   bool WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto,
 100                   JS::MutableHandle<JSObject*> aReflector);
 101
 102   nsISupports* GetParentObject() const { return mGlobal; }
 103
 104   void GetLower(JSContext* aCx, JS::MutableHandle<JS::Value> aResult,
 105                 ErrorResult& aRv);
 106
 107   void GetUpper(JSContext* aCx, JS::MutableHandle<JS::Value> aResult,
 108                 ErrorResult& aRv);
 109
 110   bool LowerOpen() const { return mLowerOpen; }
 111
 112   bool UpperOpen() const { return mUpperOpen; }
 113
 114  protected:
 115   IDBKeyRange(nsISupports* aGlobal, bool aLowerOpen, bool aUpperOpen,
 116               bool aIsOnly);
 117
 118   virtual ~IDBKeyRange();
 119 };
 120
 121 class IDBLocaleAwareKeyRange final : public IDBKeyRange {
 122   IDBLocaleAwareKeyRange(nsISupports* aGlobal, bool aLowerOpen, bool aUpperOpen,
 123                          bool aIsOnly);
 124
 125   ~IDBLocaleAwareKeyRange();
 126
 127  public:
 128   [[nodiscard]] static RefPtr<IDBLocaleAwareKeyRange> Bound(
 129       const GlobalObject& aGlobal, JS::Handle<JS::Value> aLower,
 130       JS::Handle<JS::Value> aUpper, bool aLowerOpen, bool aUpperOpen,
 131       ErrorResult& aRv);
 132
 133   NS_INLINE_DECL_REFCOUNTING_INHERITED(IDBLocaleAwareKeyRange, IDBKeyRange)
 134
 135   // WebIDL
 136   bool WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto,
 137                   JS::MutableHandle<JSObject*> aReflector);
 138 };
 139
 140 }  // namespace dom
 141 }  // namespace mozilla
 142
 143 #endif  // mozilla_dom_idbkeyrange_h__