dom/indexedDB/IndexedDatabase.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=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_indexeddatabase_h__
   8 #define mozilla_dom_indexeddb_indexeddatabase_h__
   9
  10 #include "nsIProgrammingLanguage.h"
  11
  12 #include "mozilla/Attributes.h"
  13 #include "jsapi.h"
  14 #include "nsAutoPtr.h"
  15 #include "nsCOMPtr.h"
  16 #include "nsDebug.h"
  17 #include "nsError.h"
  18 #include "nsStringGlue.h"
  19 #include "nsTArray.h"
  20
  21 #define BEGIN_INDEXEDDB_NAMESPACE \
  22   namespace mozilla { namespace dom { namespace indexedDB {
  23
  24 #define END_INDEXEDDB_NAMESPACE \
  25   } /* namespace indexedDB */ } /* namepsace dom */ } /* namespace mozilla */
  26
  27 #define USING_INDEXEDDB_NAMESPACE \
  28   using namespace mozilla::dom::indexedDB;
  29
  30 class nsIDOMBlob;
  31 class nsIInputStream;
  32
  33 BEGIN_INDEXEDDB_NAMESPACE
  34
  35 class FileInfo;
  36 class IDBDatabase;
  37 class IDBTransaction;
  38
  39 template <class T>
  40 void SwapData(T& aData1, T& aData2)
  41 {
  42   T temp = aData2;
  43   aData2 = aData1;
  44   aData1 = temp;
  45 }
  46
  47 struct StructuredCloneFile
  48 {
  49   bool operator==(const StructuredCloneFile& aOther) const
  50   {
  51     return this->mFile == aOther.mFile &&
  52            this->mFileInfo == aOther.mFileInfo &&
  53            this->mInputStream == aOther.mInputStream;
  54   }
  55
  56   nsCOMPtr<nsIDOMBlob> mFile;
  57   nsRefPtr<FileInfo> mFileInfo;
  58   nsCOMPtr<nsIInputStream> mInputStream;
  59 };
  60
  61 struct SerializedStructuredCloneReadInfo;
  62
  63 struct StructuredCloneReadInfo
  64 {
  65   // In IndexedDatabaseInlines.h
  66   inline StructuredCloneReadInfo();
  67
  68   void Swap(StructuredCloneReadInfo& aCloneReadInfo)
  69   {
  70     mCloneBuffer.swap(aCloneReadInfo.mCloneBuffer);
  71     mFiles.SwapElements(aCloneReadInfo.mFiles);
  72     SwapData(mDatabase, aCloneReadInfo.mDatabase);
  73   }
  74
  75   // In IndexedDatabaseInlines.h
  76   inline bool
  77   SetFromSerialized(const SerializedStructuredCloneReadInfo& aOther);
  78
  79   JSAutoStructuredCloneBuffer mCloneBuffer;
  80   nsTArray<StructuredCloneFile> mFiles;
  81   IDBDatabase* mDatabase;
  82 };
  83
  84 struct SerializedStructuredCloneReadInfo
  85 {
  86   SerializedStructuredCloneReadInfo()
  87   : data(nullptr), dataLength(0)
  88   { }
  89
  90   bool
  91   operator==(const SerializedStructuredCloneReadInfo& aOther) const
  92   {
  93     return this->data == aOther.data &&
  94            this->dataLength == aOther.dataLength;
  95   }
  96
  97   SerializedStructuredCloneReadInfo&
  98   operator=(const StructuredCloneReadInfo& aOther)
  99   {
 100     data = aOther.mCloneBuffer.data();
 101     dataLength = aOther.mCloneBuffer.nbytes();
 102     return *this;
 103   }
 104
 105   // Make sure to update ipc/SerializationHelpers.h when changing members here!
 106   uint64_t* data;
 107   size_t dataLength;
 108 };
 109
 110 struct SerializedStructuredCloneWriteInfo;
 111
 112 struct StructuredCloneWriteInfo
 113 {
 114   // In IndexedDatabaseInlines.h
 115   inline StructuredCloneWriteInfo();
 116
 117   void Swap(StructuredCloneWriteInfo& aCloneWriteInfo)
 118   {
 119     mCloneBuffer.swap(aCloneWriteInfo.mCloneBuffer);
 120     mFiles.SwapElements(aCloneWriteInfo.mFiles);
 121     SwapData(mTransaction, aCloneWriteInfo.mTransaction);
 122     SwapData(mOffsetToKeyProp, aCloneWriteInfo.mOffsetToKeyProp);
 123   }
 124
 125   bool operator==(const StructuredCloneWriteInfo& aOther) const
 126   {
 127     return this->mCloneBuffer.nbytes() == aOther.mCloneBuffer.nbytes() &&
 128            this->mCloneBuffer.data() == aOther.mCloneBuffer.data() &&
 129            this->mFiles == aOther.mFiles &&
 130            this->mTransaction == aOther.mTransaction &&
 131            this->mOffsetToKeyProp == aOther.mOffsetToKeyProp;
 132   }
 133
 134   // In IndexedDatabaseInlines.h
 135   inline bool
 136   SetFromSerialized(const SerializedStructuredCloneWriteInfo& aOther);
 137
 138   JSAutoStructuredCloneBuffer mCloneBuffer;
 139   nsTArray<StructuredCloneFile> mFiles;
 140   IDBTransaction* mTransaction;
 141   uint64_t mOffsetToKeyProp;
 142 };
 143
 144 struct SerializedStructuredCloneWriteInfo
 145 {
 146   SerializedStructuredCloneWriteInfo()
 147   : data(nullptr), dataLength(0), offsetToKeyProp(0)
 148   { }
 149
 150   bool
 151   operator==(const SerializedStructuredCloneWriteInfo& aOther) const
 152   {
 153     return this->data == aOther.data &&
 154            this->dataLength == aOther.dataLength &&
 155            this->offsetToKeyProp == aOther.offsetToKeyProp;
 156   }
 157
 158   SerializedStructuredCloneWriteInfo&
 159   operator=(const StructuredCloneWriteInfo& aOther)
 160   {
 161     data = aOther.mCloneBuffer.data();
 162     dataLength = aOther.mCloneBuffer.nbytes();
 163     offsetToKeyProp = aOther.mOffsetToKeyProp;
 164     return *this;
 165   }
 166
 167   // Make sure to update ipc/SerializationHelpers.h when changing members here!
 168   uint64_t* data;
 169   size_t dataLength;
 170   uint64_t offsetToKeyProp;
 171 };
 172
 173 END_INDEXEDDB_NAMESPACE
 174
 175 #endif // mozilla_dom_indexeddb_indexeddatabase_h__