dom/indexedDB/IDBFileHandle.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 file,
   5  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_indexeddb_idbfilehandle_h__
   8 #define mozilla_dom_indexeddb_idbfilehandle_h__
   9
  10 #include "IDBFileRequest.h"
  11 #include "js/TypeDecls.h"
  12 #include "MainThreadUtils.h"
  13 #include "mozilla/Assertions.h"
  14 #include "mozilla/Attributes.h"
  15 #include "mozilla/dom/FileHandle.h"
  16 #include "mozilla/DOMEventTargetHelper.h"
  17 #include "nsCycleCollectionParticipant.h"
  18
  19 class nsPIDOMWindow;
  20
  21 namespace mozilla {
  22 namespace dom {
  23
  24 struct IDBFileMetadataParameters;
  25
  26 namespace indexedDB {
  27
  28 class IDBMutableFile;
  29
  30 class IDBFileHandle MOZ_FINAL : public DOMEventTargetHelper,
  31                                 public nsIRunnable,
  32                                 public FileHandleBase
  33 {
  34 public:
  35   NS_DECL_ISUPPORTS_INHERITED
  36   NS_DECL_NSIRUNNABLE
  37
  38   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(IDBFileHandle, DOMEventTargetHelper)
  39
  40   static already_AddRefed<IDBFileHandle>
  41   Create(FileMode aMode,
  42          RequestMode aRequestMode,
  43          IDBMutableFile* aMutableFile);
  44
  45   virtual MutableFileBase*
  46   MutableFile() const MOZ_OVERRIDE;
  47
  48   // nsIDOMEventTarget
  49   virtual nsresult
  50   PreHandleEvent(EventChainPreVisitor& aVisitor) MOZ_OVERRIDE;
  51
  52   // WrapperCache
  53   virtual JSObject*
  54   WrapObject(JSContext* aCx) MOZ_OVERRIDE;
  55
  56   // WebIDL
  57   nsPIDOMWindow*
  58   GetParentObject() const
  59   {
  60     return GetOwner();
  61   }
  62
  63   IDBMutableFile*
  64   GetMutableFile() const
  65   {
  66     MOZ_ASSERT(NS_IsMainThread(), "Wrong thread!");
  67
  68     return mMutableFile;
  69   }
  70
  71   IDBMutableFile*
  72   GetFileHandle() const
  73   {
  74     return GetMutableFile();
  75   }
  76
  77   already_AddRefed<IDBFileRequest>
  78   GetMetadata(const IDBFileMetadataParameters& aParameters, ErrorResult& aRv);
  79
  80   already_AddRefed<IDBFileRequest>
  81   ReadAsArrayBuffer(uint64_t aSize, ErrorResult& aRv)
  82   {
  83     return Read(aSize, false, NullString(), aRv).downcast<IDBFileRequest>();
  84   }
  85
  86   already_AddRefed<IDBFileRequest>
  87   ReadAsText(uint64_t aSize, const nsAString& aEncoding, ErrorResult& aRv)
  88   {
  89     return Read(aSize, true, aEncoding, aRv).downcast<IDBFileRequest>();
  90   }
  91
  92   template<class T>
  93   already_AddRefed<IDBFileRequest>
  94   Write(const T& aValue, ErrorResult& aRv)
  95   {
  96     return
  97       WriteOrAppend(aValue, false, aRv).template downcast<IDBFileRequest>();
  98   }
  99
 100   template<class T>
 101   already_AddRefed<IDBFileRequest>
 102   Append(const T& aValue, ErrorResult& aRv)
 103   {
 104     return WriteOrAppend(aValue, true, aRv).template downcast<IDBFileRequest>();
 105   }
 106
 107   already_AddRefed<IDBFileRequest>
 108   Truncate(const Optional<uint64_t>& aSize, ErrorResult& aRv)
 109   {
 110     return FileHandleBase::Truncate(aSize, aRv).downcast<IDBFileRequest>();
 111   }
 112
 113   already_AddRefed<IDBFileRequest>
 114   Flush(ErrorResult& aRv)
 115   {
 116     return FileHandleBase::Flush(aRv).downcast<IDBFileRequest>();
 117   }
 118
 119   IMPL_EVENT_HANDLER(complete)
 120   IMPL_EVENT_HANDLER(abort)
 121   IMPL_EVENT_HANDLER(error)
 122
 123 private:
 124   IDBFileHandle(FileMode aMode,
 125                 RequestMode aRequestMode,
 126                 IDBMutableFile* aMutableFile);
 127   ~IDBFileHandle();
 128
 129   virtual nsresult
 130   OnCompleteOrAbort(bool aAborted) MOZ_OVERRIDE;
 131
 132   virtual bool
 133   CheckWindow() MOZ_OVERRIDE;
 134
 135   virtual already_AddRefed<FileRequestBase>
 136   GenerateFileRequest() MOZ_OVERRIDE;
 137
 138   nsRefPtr<IDBMutableFile> mMutableFile;
 139 };
 140
 141 } // namespace indexedDB
 142 } // namespace dom
 143 } // namespace mozilla
 144
 145 #endif // mozilla_dom_indexeddb_idbfilehandle_h__