dom/indexedDB/KeyPath.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_indexeddb_keypath_h__
   8 #define mozilla_dom_indexeddb_keypath_h__
   9
  10 #include <new>
  11 #include <utility>
  12 #include "js/TypeDecls.h"
  13 #include "mozilla/Result.h"
  14 #include "mozilla/ipc/IPCForwards.h"
  15 #include "nsISupports.h"
  16 #include "nsError.h"
  17 #include "nsString.h"
  18 #include "nsTArray.h"
  19
  20 namespace JS {
  21 template <class T>
  22 class Heap;
  23 }
  24
  25 namespace mozilla::dom {
  26
  27 class OwningStringOrStringSequence;
  28 template <typename T>
  29 class Sequence;
  30 template <typename T>
  31 struct Nullable;
  32
  33 namespace indexedDB {
  34
  35 class IndexMetadata;
  36 class Key;
  37 class ObjectStoreMetadata;
  38
  39 class KeyPath {
  40   // This private constructor is only to be used by IPDL-generated classes.
  41   friend class IndexMetadata;
  42   friend class ObjectStoreMetadata;
  43   ALLOW_DEPRECATED_READPARAM
  44
  45   KeyPath() : mType(KeyPathType::NonExistent) { MOZ_COUNT_CTOR(KeyPath); }
  46
  47  public:
  48   using VoidOrObjectStoreKeyPathString = nsAString;
  49
  50   enum class KeyPathType { NonExistent, String, Array, EndGuard };
  51
  52   void SetType(KeyPathType aType);
  53
  54   bool AppendStringWithValidation(const nsAString& aString);
  55
  56   explicit KeyPath(int aDummy) : mType(KeyPathType::NonExistent) {
  57     MOZ_COUNT_CTOR(KeyPath);
  58   }
  59
  60   KeyPath(KeyPath&& aOther) {
  61     MOZ_COUNT_CTOR(KeyPath);
  62     *this = std::move(aOther);
  63   }
  64   KeyPath& operator=(KeyPath&&) = default;
  65
  66   KeyPath(const KeyPath& aOther) {
  67     MOZ_COUNT_CTOR(KeyPath);
  68     *this = aOther;
  69   }
  70   KeyPath& operator=(const KeyPath&) = default;
  71
  72   MOZ_COUNTED_DTOR(KeyPath)
  73
  74   static Result<KeyPath, nsresult> Parse(const nsAString& aString);
  75
  76   static Result<KeyPath, nsresult> Parse(const Sequence<nsString>& aStrings);
  77
  78   static Result<KeyPath, nsresult> Parse(
  79       const Nullable<OwningStringOrStringSequence>& aValue);
  80
  81   nsresult ExtractKey(
  82       JSContext* aCx, const JS::Value& aValue, Key& aKey,
  83       const VoidOrObjectStoreKeyPathString& aAutoIncrementedObjectStoreKeyPath =
  84           VoidString()) const;
  85
  86   nsresult ExtractKeyAsJSVal(JSContext* aCx, const JS::Value& aValue,
  87                              JS::Value* aOutVal) const;
  88
  89   using ExtractOrCreateKeyCallback = nsresult (*)(JSContext*, void*);
  90
  91   nsresult ExtractOrCreateKey(JSContext* aCx, const JS::Value& aValue,
  92                               Key& aKey, ExtractOrCreateKeyCallback aCallback,
  93                               void* aClosure) const;
  94
  95   inline bool IsValid() const { return mType != KeyPathType::NonExistent; }
  96
  97   inline bool IsArray() const { return mType == KeyPathType::Array; }
  98
  99   inline bool IsString() const { return mType == KeyPathType::String; }
 100
 101   inline bool IsEmpty() const {
 102     return mType == KeyPathType::String && mStrings[0].IsEmpty();
 103   }
 104
 105   bool operator==(const KeyPath& aOther) const {
 106     return mType == aOther.mType && mStrings == aOther.mStrings;
 107   }
 108
 109   nsAutoString SerializeToString() const;
 110   static KeyPath DeserializeFromString(const nsAString& aString);
 111
 112   nsresult ToJSVal(JSContext* aCx, JS::MutableHandle<JS::Value> aValue) const;
 113   nsresult ToJSVal(JSContext* aCx, JS::Heap<JS::Value>& aValue) const;
 114
 115   bool IsAllowedForObjectStore(bool aAutoIncrement) const;
 116
 117   KeyPathType mType;
 118
 119   CopyableTArray<nsString> mStrings;
 120 };
 121
 122 }  // namespace indexedDB
 123 }  // namespace mozilla::dom
 124
 125 #endif  // mozilla_dom_indexeddb_keypath_h__