diff options
Diffstat (limited to 'dom/indexedDB/IDBIndex.h')
| -rw-r--r-- | dom/indexedDB/IDBIndex.h | 234 |
1 files changed, 234 insertions, 0 deletions
diff --git a/dom/indexedDB/IDBIndex.h b/dom/indexedDB/IDBIndex.h new file mode 100644 index 000000000..54b49f283 --- /dev/null +++ b/dom/indexedDB/IDBIndex.h @@ -0,0 +1,234 @@ +/* -*- 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 mozilla_dom_idbindex_h__ +#define mozilla_dom_idbindex_h__ + +#include "js/RootingAPI.h" +#include "mozilla/Attributes.h" +#include "mozilla/dom/IDBCursorBinding.h" +#include "nsAutoPtr.h" +#include "nsCycleCollectionParticipant.h" +#include "nsISupports.h" +#include "nsTArrayForwardDeclare.h" +#include "nsWrapperCache.h" + +class nsPIDOMWindowInner; + +namespace mozilla { + +class ErrorResult; + +namespace dom { + +class IDBObjectStore; +class IDBRequest; +template <typename> class Sequence; + +namespace indexedDB { +class IndexMetadata; +class KeyPath; +} // namespace indexedDB + +class IDBIndex final + : public nsISupports + , public nsWrapperCache +{ + RefPtr<IDBObjectStore> mObjectStore; + + JS::Heap<JS::Value> mCachedKeyPath; + + // This normally points to the IndexMetadata owned by the parent IDBDatabase + // object. However, if this index is part of a versionchange transaction and + // it gets deleted then the metadata is copied into mDeletedMetadata and + // mMetadata is set to point at mDeletedMetadata. + const indexedDB::IndexMetadata* mMetadata; + nsAutoPtr<indexedDB::IndexMetadata> mDeletedMetadata; + + const int64_t mId; + bool mRooted; + +public: + NS_DECL_CYCLE_COLLECTING_ISUPPORTS + NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(IDBIndex) + + static already_AddRefed<IDBIndex> + Create(IDBObjectStore* aObjectStore, const indexedDB::IndexMetadata& aMetadata); + + int64_t + Id() const + { + AssertIsOnOwningThread(); + + return mId; + } + + const nsString& + Name() const; + + bool + Unique() const; + + bool + MultiEntry() const; + + bool + LocaleAware() const; + + const indexedDB::KeyPath& + GetKeyPath() const; + + void + GetLocale(nsString& aLocale) const; + + const nsCString& + Locale() const; + + bool + IsAutoLocale() const; + + IDBObjectStore* + ObjectStore() const + { + AssertIsOnOwningThread(); + return mObjectStore; + } + + nsPIDOMWindowInner* + GetParentObject() const; + + void + GetName(nsString& aName) const + { + aName = Name(); + } + + void + SetName(const nsAString& aName, ErrorResult& aRv); + + void + GetKeyPath(JSContext* aCx, + JS::MutableHandle<JS::Value> aResult, + ErrorResult& aRv); + + already_AddRefed<IDBRequest> + OpenCursor(JSContext* aCx, + JS::Handle<JS::Value> aRange, + IDBCursorDirection aDirection, + ErrorResult& aRv) + { + AssertIsOnOwningThread(); + + return OpenCursorInternal(/* aKeysOnly */ false, aCx, aRange, aDirection, + aRv); + } + + already_AddRefed<IDBRequest> + OpenKeyCursor(JSContext* aCx, + JS::Handle<JS::Value> aRange, + IDBCursorDirection aDirection, + ErrorResult& aRv) + { + AssertIsOnOwningThread(); + + return OpenCursorInternal(/* aKeysOnly */ true, aCx, aRange, aDirection, + aRv); + } + + already_AddRefed<IDBRequest> + Get(JSContext* aCx, JS::Handle<JS::Value> aKey, ErrorResult& aRv) + { + AssertIsOnOwningThread(); + + return GetInternal(/* aKeyOnly */ false, aCx, aKey, aRv); + } + + already_AddRefed<IDBRequest> + GetKey(JSContext* aCx, JS::Handle<JS::Value> aKey, ErrorResult& aRv) + { + AssertIsOnOwningThread(); + + return GetInternal(/* aKeyOnly */ true, aCx, aKey, aRv); + } + + already_AddRefed<IDBRequest> + Count(JSContext* aCx, JS::Handle<JS::Value> aKey, + ErrorResult& aRv); + + already_AddRefed<IDBRequest> + GetAll(JSContext* aCx, JS::Handle<JS::Value> aKey, + const Optional<uint32_t>& aLimit, ErrorResult& aRv) + { + AssertIsOnOwningThread(); + + return GetAllInternal(/* aKeysOnly */ false, aCx, aKey, aLimit, aRv); + } + + already_AddRefed<IDBRequest> + GetAllKeys(JSContext* aCx, JS::Handle<JS::Value> aKey, + const Optional<uint32_t>& aLimit, ErrorResult& aRv) + { + AssertIsOnOwningThread(); + + return GetAllInternal(/* aKeysOnly */ true, aCx, aKey, aLimit, aRv); + } + + void + RefreshMetadata(bool aMayDelete); + + void + NoteDeletion(); + + bool + IsDeleted() const + { + AssertIsOnOwningThread(); + + return !!mDeletedMetadata; + } + + void + AssertIsOnOwningThread() const +#ifdef DEBUG + ; +#else + { } +#endif + + // nsWrapperCache + virtual JSObject* + WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override; + +private: + IDBIndex(IDBObjectStore* aObjectStore, const indexedDB::IndexMetadata* aMetadata); + + ~IDBIndex(); + + already_AddRefed<IDBRequest> + GetInternal(bool aKeyOnly, + JSContext* aCx, + JS::Handle<JS::Value> aKey, + ErrorResult& aRv); + + already_AddRefed<IDBRequest> + GetAllInternal(bool aKeysOnly, + JSContext* aCx, + JS::Handle<JS::Value> aKey, + const Optional<uint32_t>& aLimit, + ErrorResult& aRv); + + already_AddRefed<IDBRequest> + OpenCursorInternal(bool aKeysOnly, + JSContext* aCx, + JS::Handle<JS::Value> aRange, + IDBCursorDirection aDirection, + ErrorResult& aRv); +}; + +} // namespace dom +} // namespace mozilla + +#endif // mozilla_dom_idbindex_h__ |