dom/indexedDB/PBackgroundIDBSharedTypes.ipdlh

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   3  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 include protocol PBackgroundIDBDatabaseFile;
   6 include protocol PBackgroundMutableFile;
   7 include protocol PChildToParentStream; // FIXME: bug 792908
   8 include protocol PFileDescriptorSet; // FIXME: bug 792908
   9 include protocol PParentToChildStream; // FIXME: bug 792908
  10 include protocol PRemoteLazyInputStream; // FIXME: bug 792908
  11
  12 include DOMTypes;
  13 include IPCBlob;
  14 include ProtocolTypes;
  15
  16 include "mozilla/dom/indexedDB/SerializationHelpers.h";
  17 include "mozilla/dom/quota/SerializationHelpers.h";
  18
  19 using struct mozilla::null_t from "mozilla/ipc/IPCCore.h";
  20
  21 using struct mozilla::void_t from "mozilla/ipc/IPCCore.h";
  22
  23 using mozilla::dom::IDBCursor::Direction
  24   from "mozilla/dom/IDBCursor.h";
  25
  26 using mozilla::dom::indexedDB::StructuredCloneFileBase::FileType
  27   from "mozilla/dom/IndexedDatabase.h";
  28
  29 using class mozilla::dom::indexedDB::Key
  30   from "mozilla/dom/indexedDB/Key.h";
  31
  32 using class mozilla::dom::indexedDB::KeyPath
  33   from "mozilla/dom/indexedDB/KeyPath.h";
  34
  35 using mozilla::dom::quota::PersistenceType
  36   from "mozilla/dom/quota/PersistenceType.h";
  37
  38 [MoveOnly=data] using mozilla::SerializedStructuredCloneBuffer
  39   from "mozilla/ipc/SerializedStructuredCloneBuffer.h";
  40
  41 namespace mozilla {
  42 namespace dom {
  43 namespace indexedDB {
  44
  45 struct SerializedKeyRange
  46 {
  47   Key lower;
  48   Key upper;
  49   bool lowerOpen;
  50   bool upperOpen;
  51   bool isOnly;
  52 };
  53
  54 union BlobOrMutableFile
  55 {
  56   null_t;
  57   IPCBlob;
  58   PBackgroundMutableFile;
  59 };
  60
  61 struct SerializedStructuredCloneFile
  62 {
  63   BlobOrMutableFile file;
  64   FileType type;
  65 };
  66
  67 struct SerializedStructuredCloneReadInfo
  68 {
  69   SerializedStructuredCloneBuffer data;
  70   SerializedStructuredCloneFile[] files;
  71   bool hasPreprocessInfo;
  72 };
  73
  74 struct SerializedStructuredCloneWriteInfo
  75 {
  76   SerializedStructuredCloneBuffer data;
  77   uint64_t offsetToKeyProp;
  78 };
  79
  80 struct IndexUpdateInfo
  81 {
  82   int64_t indexId;
  83   Key value;
  84   Key localizedValue;
  85 };
  86
  87 struct DatabaseMetadata
  88 {
  89   nsString name;
  90   uint64_t version;
  91   PersistenceType persistenceType;
  92 };
  93
  94 struct ObjectStoreMetadata
  95 {
  96   int64_t id;
  97   nsString name;
  98   KeyPath keyPath;
  99   bool autoIncrement;
 100 };
 101
 102 struct IndexMetadata
 103 {
 104   int64_t id;
 105   nsString name;
 106   KeyPath keyPath;
 107   nsCString locale;
 108   bool unique;
 109   bool multiEntry;
 110   bool autoLocale;
 111 };
 112
 113 struct DatabaseSpec
 114 {
 115   DatabaseMetadata metadata;
 116   ObjectStoreSpec[] objectStores;
 117 };
 118
 119 struct ObjectStoreSpec
 120 {
 121   ObjectStoreMetadata metadata;
 122   IndexMetadata[] indexes;
 123 };
 124
 125 struct CommonOpenCursorParams
 126 {
 127   int64_t objectStoreId;
 128   SerializedKeyRange? optionalKeyRange;
 129   Direction direction;
 130 };
 131
 132 struct ObjectStoreOpenCursorParams
 133 {
 134   CommonOpenCursorParams commonParams;
 135 };
 136
 137 struct ObjectStoreOpenKeyCursorParams
 138 {
 139   CommonOpenCursorParams commonParams;
 140 };
 141
 142 struct CommonIndexOpenCursorParams
 143 {
 144   CommonOpenCursorParams commonParams;
 145   int64_t indexId;
 146 };
 147
 148 struct IndexOpenCursorParams
 149 {
 150   CommonIndexOpenCursorParams commonIndexParams;
 151 };
 152
 153 struct IndexOpenKeyCursorParams
 154 {
 155   CommonIndexOpenCursorParams commonIndexParams;
 156 };
 157
 158 // TODO: Actually, using a union here is not very nice, unless IPDL supported
 159 // struct inheritance. Alternatively, if IPDL supported enums, we could merge
 160 // the subtypes into one. Using a plain integer for discriminating the
 161 // subtypes would be too error-prone.
 162 union OpenCursorParams
 163 {
 164   ObjectStoreOpenCursorParams;
 165   ObjectStoreOpenKeyCursorParams;
 166   IndexOpenCursorParams;
 167   IndexOpenKeyCursorParams;
 168 };
 169
 170 union DatabaseOrMutableFile
 171 {
 172   PBackgroundIDBDatabaseFile;
 173   PBackgroundMutableFile;
 174 };
 175
 176 struct FileAddInfo
 177 {
 178   DatabaseOrMutableFile file;
 179   FileType type;
 180 };
 181
 182 struct ObjectStoreAddPutParams
 183 {
 184   int64_t objectStoreId;
 185   SerializedStructuredCloneWriteInfo cloneInfo;
 186   Key key;
 187   IndexUpdateInfo[] indexUpdateInfos;
 188   FileAddInfo[] fileAddInfos;
 189 };
 190
 191 struct ObjectStoreAddParams
 192 {
 193   ObjectStoreAddPutParams commonParams;
 194 };
 195
 196 struct ObjectStorePutParams
 197 {
 198   ObjectStoreAddPutParams commonParams;
 199 };
 200
 201 struct ObjectStoreGetParams
 202 {
 203   int64_t objectStoreId;
 204   SerializedKeyRange keyRange;
 205 };
 206
 207 struct ObjectStoreGetKeyParams
 208 {
 209   int64_t objectStoreId;
 210   SerializedKeyRange keyRange;
 211 };
 212
 213 struct ObjectStoreGetAllParams
 214 {
 215   int64_t objectStoreId;
 216   SerializedKeyRange? optionalKeyRange;
 217   uint32_t limit;
 218 };
 219
 220 struct ObjectStoreGetAllKeysParams
 221 {
 222   int64_t objectStoreId;
 223   SerializedKeyRange? optionalKeyRange;
 224   uint32_t limit;
 225 };
 226
 227 struct ObjectStoreDeleteParams
 228 {
 229   int64_t objectStoreId;
 230   SerializedKeyRange keyRange;
 231 };
 232
 233 struct ObjectStoreClearParams
 234 {
 235   int64_t objectStoreId;
 236 };
 237
 238 struct ObjectStoreCountParams
 239 {
 240   int64_t objectStoreId;
 241   SerializedKeyRange? optionalKeyRange;
 242 };
 243
 244 struct IndexGetParams
 245 {
 246   int64_t objectStoreId;
 247   int64_t indexId;
 248   SerializedKeyRange keyRange;
 249 };
 250
 251 struct IndexGetKeyParams
 252 {
 253   int64_t objectStoreId;
 254   int64_t indexId;
 255   SerializedKeyRange keyRange;
 256 };
 257
 258 struct IndexGetAllParams
 259 {
 260   int64_t objectStoreId;
 261   int64_t indexId;
 262   SerializedKeyRange? optionalKeyRange;
 263   uint32_t limit;
 264 };
 265
 266 struct IndexGetAllKeysParams
 267 {
 268   int64_t objectStoreId;
 269   int64_t indexId;
 270   SerializedKeyRange? optionalKeyRange;
 271   uint32_t limit;
 272 };
 273
 274 struct IndexCountParams
 275 {
 276   int64_t objectStoreId;
 277   int64_t indexId;
 278   SerializedKeyRange? optionalKeyRange;
 279 };
 280
 281 union RequestParams
 282 {
 283   ObjectStoreAddParams;
 284   ObjectStorePutParams;
 285   ObjectStoreGetParams;
 286   ObjectStoreGetKeyParams;
 287   ObjectStoreGetAllParams;
 288   ObjectStoreGetAllKeysParams;
 289   ObjectStoreDeleteParams;
 290   ObjectStoreClearParams;
 291   ObjectStoreCountParams;
 292   IndexGetParams;
 293   IndexGetKeyParams;
 294   IndexGetAllParams;
 295   IndexGetAllKeysParams;
 296   IndexCountParams;
 297 };
 298
 299 struct LoggingInfo
 300 {
 301   nsID backgroundChildLoggingId;
 302   int64_t nextTransactionSerialNumber;
 303   int64_t nextVersionChangeTransactionSerialNumber;
 304   uint64_t nextRequestSerialNumber;
 305 };
 306
 307 } // namespace indexedDB
 308 } // namespace dom
 309 } // namespace mozilla