diff -r 000000000000 -r 6474c204b198 dom/file/FileHandle.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dom/file/FileHandle.h Wed Dec 31 06:09:35 2014 +0100 @@ -0,0 +1,149 @@ +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim: set ts=2 et sw=2 tw=80: */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this file, + * You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#ifndef mozilla_dom_file_filehandle_h__ +#define mozilla_dom_file_filehandle_h__ + +#include "FileCommon.h" + +#include "nsIFile.h" +#include "nsIFileStorage.h" + +#include "mozilla/Attributes.h" +#include "mozilla/DOMEventTargetHelper.h" +#include "mozilla/dom/FileModeBinding.h" + +class nsIDOMFile; +class nsIFileStorage; +class nsPIDOMWindow; + +namespace mozilla { +namespace dom { +class DOMRequest; +namespace indexedDB { +class FileInfo; +} // namespace indexedDB +} // namespace dom +} // namespace mozilla + +BEGIN_FILE_NAMESPACE + +class FileService; +class LockedFile; +class FinishHelper; +class FileHelper; + +/** + * This class provides a default FileHandle implementation, but it can be also + * subclassed. The subclass can override implementation of GetFileId, + * GetFileInfo, CreateStream and CreateFileObject. + * (for example IDBFileHandle provides IndexedDB specific implementation). + */ +class FileHandle : public DOMEventTargetHelper +{ + friend class FileService; + friend class LockedFile; + friend class FinishHelper; + friend class FileHelper; + +public: + NS_DECL_ISUPPORTS_INHERITED + NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(FileHandle, DOMEventTargetHelper) + + static already_AddRefed + Create(nsPIDOMWindow* aWindow, + nsIFileStorage* aFileStorage, + nsIFile* aFile); + + const nsAString& + Name() const + { + return mName; + } + + const nsAString& + Type() const + { + return mType; + } + + virtual int64_t + GetFileId() + { + return -1; + } + + virtual mozilla::dom::indexedDB::FileInfo* + GetFileInfo() + { + return nullptr; + } + + virtual already_AddRefed + CreateStream(nsIFile* aFile, bool aReadOnly); + + virtual already_AddRefed + CreateFileObject(LockedFile* aLockedFile, uint32_t aFileSize); + + // nsWrapperCache + virtual JSObject* + WrapObject(JSContext* aCx) MOZ_OVERRIDE; + + // WebIDL + nsPIDOMWindow* + GetParentObject() const + { + return GetOwner(); + } + + void + GetName(nsString& aName) const + { + aName = mName; + } + + void + GetType(nsString& aType) const + { + aType = mType; + } + + already_AddRefed + Open(FileMode aMode, ErrorResult& aError); + + already_AddRefed + GetFile(ErrorResult& aError); + + IMPL_EVENT_HANDLER(abort) + IMPL_EVENT_HANDLER(error) + +protected: + FileHandle(nsPIDOMWindow* aWindow) + : DOMEventTargetHelper(aWindow) + { + } + + FileHandle(DOMEventTargetHelper* aOwner) + : DOMEventTargetHelper(aOwner) + { + } + + ~FileHandle() + { + } + + nsCOMPtr mFileStorage; + + nsString mName; + nsString mType; + + nsCOMPtr mFile; + nsString mFileName; +}; + +END_FILE_NAMESPACE + +#endif // mozilla_dom_file_filehandle_h__