dom/indexedDB/IDBCursorType.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_idbcursortype_h__
   8 #define mozilla_dom_idbcursortype_h__
   9
  10 #include "IndexedDatabase.h"
  11 #include "mozilla/dom/indexedDB/Key.h"
  12
  13 namespace mozilla::dom {
  14 namespace indexedDB {
  15 class ObjectStoreCursorResponse;
  16 class ObjectStoreKeyCursorResponse;
  17 class IndexCursorResponse;
  18 class IndexKeyCursorResponse;
  19 }  // namespace indexedDB
  20
  21 enum struct IDBCursorType {
  22   ObjectStore,
  23   ObjectStoreKey,
  24   Index,
  25   IndexKey,
  26 };
  27
  28 template <IDBCursorType CursorType>
  29 struct CursorTypeTraits;
  30
  31 class IDBIndex;
  32 class IDBObjectStore;
  33
  34 class IDBIndexCursor;
  35 class IDBIndexKeyCursor;
  36 class IDBObjectStoreCursor;
  37 class IDBObjectStoreKeyCursor;
  38
  39 template <>
  40 struct CursorTypeTraits<IDBCursorType::Index> {
  41   using Type = IDBIndexCursor;
  42   using ResponseType = indexedDB::IndexCursorResponse;
  43   static constexpr bool IsObjectStoreCursor = false;
  44   static constexpr bool IsKeyOnlyCursor = false;
  45 };
  46
  47 template <>
  48 struct CursorTypeTraits<IDBCursorType::IndexKey> {
  49   using Type = IDBIndexKeyCursor;
  50   using ResponseType = indexedDB::IndexKeyCursorResponse;
  51   static constexpr bool IsObjectStoreCursor = false;
  52   static constexpr bool IsKeyOnlyCursor = true;
  53 };
  54
  55 template <>
  56 struct CursorTypeTraits<IDBCursorType::ObjectStore> {
  57   using Type = IDBObjectStoreCursor;
  58   using ResponseType = indexedDB::ObjectStoreCursorResponse;
  59   static constexpr bool IsObjectStoreCursor = true;
  60   static constexpr bool IsKeyOnlyCursor = false;
  61 };
  62
  63 template <>
  64 struct CursorTypeTraits<IDBCursorType::ObjectStoreKey> {
  65   using Type = IDBObjectStoreKeyCursor;
  66   using ResponseType = indexedDB::ObjectStoreKeyCursorResponse;
  67   static constexpr bool IsObjectStoreCursor = true;
  68   static constexpr bool IsKeyOnlyCursor = true;
  69 };
  70
  71 template <IDBCursorType CursorType>
  72 using CursorSourceType =
  73     std::conditional_t<CursorTypeTraits<CursorType>::IsObjectStoreCursor,
  74                        IDBObjectStore, IDBIndex>;
  75
  76 using Key = indexedDB::Key;
  77 using StructuredCloneReadInfoChild = indexedDB::StructuredCloneReadInfoChild;
  78
  79 struct CommonCursorDataBase {
  80   CommonCursorDataBase() = delete;
  81
  82   explicit CommonCursorDataBase(Key aKey);
  83
  84   Key mKey;  ///< The current key, i.e. the key representing the cursor's
  85              ///< position
  86              ///< (https://w3c.github.io/IndexedDB/#cursor-position).
  87 };
  88
  89 template <IDBCursorType CursorType>
  90 struct CursorData;
  91
  92 struct ObjectStoreCursorDataBase : CommonCursorDataBase {
  93   using CommonCursorDataBase::CommonCursorDataBase;
  94
  95   const Key& GetSortKey(const bool aIsLocaleAware) const {
  96     MOZ_ASSERT(!aIsLocaleAware);
  97     return GetObjectStoreKey();
  98   }
  99   const Key& GetObjectStoreKey() const { return mKey; }
 100   static constexpr const char* GetObjectStoreKeyForLogging() { return "NA"; }
 101 };
 102
 103 struct IndexCursorDataBase : CommonCursorDataBase {
 104   IndexCursorDataBase(Key aKey, Key aLocaleAwareKey, Key aObjectStoreKey);
 105
 106   const Key& GetSortKey(const bool aIsLocaleAware) const {
 107     return aIsLocaleAware ? mLocaleAwareKey : mKey;
 108   }
 109   const Key& GetObjectStoreKey() const { return mObjectStoreKey; }
 110   const char* GetObjectStoreKeyForLogging() const {
 111     return GetObjectStoreKey().GetBuffer().get();
 112   }
 113
 114   Key mLocaleAwareKey;  ///< If the index's mLocale is set, this is mKey
 115                         ///< converted to mLocale. Otherwise, it is unset.
 116   Key mObjectStoreKey;  ///< The key representing the cursor's object store
 117                         ///< position
 118   ///< (https://w3c.github.io/IndexedDB/#cursor-object-store-position).
 119 };
 120
 121 struct ValueCursorDataBase {
 122   explicit ValueCursorDataBase(StructuredCloneReadInfoChild&& aCloneInfo);
 123
 124   StructuredCloneReadInfoChild mCloneInfo;
 125 };
 126
 127 template <>
 128 struct CursorData<IDBCursorType::ObjectStoreKey> : ObjectStoreCursorDataBase {
 129   using ObjectStoreCursorDataBase::ObjectStoreCursorDataBase;
 130 };
 131
 132 template <>
 133 struct CursorData<IDBCursorType::ObjectStore> : ObjectStoreCursorDataBase,
 134                                                 ValueCursorDataBase {
 135   CursorData(Key aKey, StructuredCloneReadInfoChild&& aCloneInfo);
 136 };
 137
 138 template <>
 139 struct CursorData<IDBCursorType::IndexKey> : IndexCursorDataBase {
 140   using IndexCursorDataBase::IndexCursorDataBase;
 141 };
 142
 143 template <>
 144 struct CursorData<IDBCursorType::Index> : IndexCursorDataBase,
 145                                           ValueCursorDataBase {
 146   CursorData(Key aKey, Key aLocaleAwareKey, Key aObjectStoreKey,
 147              StructuredCloneReadInfoChild&& aCloneInfo);
 148 };
 149
 150 }  // namespace mozilla::dom
 151
 152 #endif