Bug 1295570 - Entries API - part 5 - Rename DirectoryReader to FileSystemDirectoryReader, r=smaug

This commit is contained in:
Andrea Marchesini
2016-08-18 09:18:51 +02:00
parent a78df67fce
commit 4632d7f831
10 changed files with 69 additions and 63 deletions

View File

@@ -6,7 +6,7 @@
#include "FileSystemDirectoryEntry.h" #include "FileSystemDirectoryEntry.h"
#include "CallbackRunnables.h" #include "CallbackRunnables.h"
#include "DirectoryReader.h" #include "FileSystemDirectoryReader.h"
#include "mozilla/dom/Directory.h" #include "mozilla/dom/Directory.h"
#include "mozilla/dom/FileSystemUtils.h" #include "mozilla/dom/FileSystemUtils.h"
@@ -55,13 +55,13 @@ FileSystemDirectoryEntry::GetFullPath(nsAString& aPath, ErrorResult& aRv) const
mDirectory->GetPath(aPath, aRv); mDirectory->GetPath(aPath, aRv);
} }
already_AddRefed<DirectoryReader> already_AddRefed<FileSystemDirectoryReader>
FileSystemDirectoryEntry::CreateReader() const FileSystemDirectoryEntry::CreateReader() const
{ {
MOZ_ASSERT(mDirectory); MOZ_ASSERT(mDirectory);
RefPtr<DirectoryReader> reader = RefPtr<FileSystemDirectoryReader> reader =
new DirectoryReader(GetParentObject(), Filesystem(), mDirectory); new FileSystemDirectoryReader(GetParentObject(), Filesystem(), mDirectory);
return reader.forget(); return reader.forget();
} }

View File

@@ -41,7 +41,7 @@ public:
virtual void virtual void
GetFullPath(nsAString& aFullPath, ErrorResult& aRv) const override; GetFullPath(nsAString& aFullPath, ErrorResult& aRv) const override;
virtual already_AddRefed<DirectoryReader> virtual already_AddRefed<FileSystemDirectoryReader>
CreateReader() const; CreateReader() const;
void void

View File

@@ -4,7 +4,7 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this file, * 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/. */ * You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "DirectoryReader.h" #include "FileSystemDirectoryReader.h"
#include "CallbackRunnables.h" #include "CallbackRunnables.h"
#include "FileSystemFileEntry.h" #include "FileSystemFileEntry.h"
#include "mozilla/dom/FileBinding.h" #include "mozilla/dom/FileBinding.h"
@@ -116,20 +116,20 @@ NS_IMPL_ISUPPORTS0(PromiseHandler);
} // anonymous namespace } // anonymous namespace
NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE(DirectoryReader, mParent, mDirectory, NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE(FileSystemDirectoryReader, mParent,
mFileSystem) mDirectory, mFileSystem)
NS_IMPL_CYCLE_COLLECTING_ADDREF(DirectoryReader) NS_IMPL_CYCLE_COLLECTING_ADDREF(FileSystemDirectoryReader)
NS_IMPL_CYCLE_COLLECTING_RELEASE(DirectoryReader) NS_IMPL_CYCLE_COLLECTING_RELEASE(FileSystemDirectoryReader)
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(DirectoryReader) NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(FileSystemDirectoryReader)
NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY
NS_INTERFACE_MAP_ENTRY(nsISupports) NS_INTERFACE_MAP_ENTRY(nsISupports)
NS_INTERFACE_MAP_END NS_INTERFACE_MAP_END
DirectoryReader::DirectoryReader(nsIGlobalObject* aGlobal, FileSystemDirectoryReader::FileSystemDirectoryReader(nsIGlobalObject* aGlobal,
FileSystem* aFileSystem, FileSystem* aFileSystem,
Directory* aDirectory) Directory* aDirectory)
: mParent(aGlobal) : mParent(aGlobal)
, mFileSystem(aFileSystem) , mFileSystem(aFileSystem)
, mDirectory(aDirectory) , mDirectory(aDirectory)
@@ -139,19 +139,20 @@ DirectoryReader::DirectoryReader(nsIGlobalObject* aGlobal,
MOZ_ASSERT(aFileSystem); MOZ_ASSERT(aFileSystem);
} }
DirectoryReader::~DirectoryReader() FileSystemDirectoryReader::~FileSystemDirectoryReader()
{} {}
JSObject* JSObject*
DirectoryReader::WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) FileSystemDirectoryReader::WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto)
{ {
return DirectoryReaderBinding::Wrap(aCx, this, aGivenProto); return FileSystemDirectoryReaderBinding::Wrap(aCx, this, aGivenProto);
} }
void void
DirectoryReader::ReadEntries(EntriesCallback& aSuccessCallback, FileSystemDirectoryReader::ReadEntries(EntriesCallback& aSuccessCallback,
const Optional<OwningNonNull<ErrorCallback>>& aErrorCallback, const Optional<OwningNonNull<ErrorCallback>>& aErrorCallback,
ErrorResult& aRv) ErrorResult& aRv)
{ {
MOZ_ASSERT(mDirectory); MOZ_ASSERT(mDirectory);

View File

@@ -4,8 +4,8 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this file, * 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/. */ * You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_dom_DirectoryReader_h #ifndef mozilla_dom_FileSystemDirectoryReader_h
#define mozilla_dom_DirectoryReader_h #define mozilla_dom_FileSystemDirectoryReader_h
#include "mozilla/Attributes.h" #include "mozilla/Attributes.h"
#include "mozilla/ErrorResult.h" #include "mozilla/ErrorResult.h"
@@ -21,17 +21,17 @@ namespace dom {
class Directory; class Directory;
class FileSystem; class FileSystem;
class DirectoryReader class FileSystemDirectoryReader
: public nsISupports : public nsISupports
, public nsWrapperCache , public nsWrapperCache
{ {
public: public:
NS_DECL_CYCLE_COLLECTING_ISUPPORTS NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(DirectoryReader) NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(FileSystemDirectoryReader)
explicit DirectoryReader(nsIGlobalObject* aGlobalObject, explicit FileSystemDirectoryReader(nsIGlobalObject* aGlobalObject,
FileSystem* aFileSystem, FileSystem* aFileSystem,
Directory* aDirectory); Directory* aDirectory);
nsIGlobalObject* nsIGlobalObject*
GetParentObject() const GetParentObject() const
@@ -48,7 +48,7 @@ public:
ErrorResult& aRv); ErrorResult& aRv);
protected: protected:
virtual ~DirectoryReader(); virtual ~FileSystemDirectoryReader();
private: private:
nsCOMPtr<nsIGlobalObject> mParent; nsCOMPtr<nsIGlobalObject> mParent;
@@ -61,4 +61,4 @@ private:
} // namespace dom } // namespace dom
} // namespace mozilla } // namespace mozilla
#endif // mozilla_dom_DirectoryReader_h #endif // mozilla_dom_FileSystemDirectoryReader_h

View File

@@ -5,7 +5,7 @@
* You can obtain one at http://mozilla.org/MPL/2.0/. */ * You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "FileSystemRootDirectoryEntry.h" #include "FileSystemRootDirectoryEntry.h"
#include "RootDirectoryReader.h" #include "FileSystemRootDirectoryReader.h"
#include "mozilla/dom/FileSystemUtils.h" #include "mozilla/dom/FileSystemUtils.h"
namespace mozilla { namespace mozilla {
@@ -44,11 +44,12 @@ FileSystemRootDirectoryEntry::GetFullPath(nsAString& aPath, ErrorResult& aRv) co
aPath.AssignLiteral(FILESYSTEM_DOM_PATH_SEPARATOR_LITERAL); aPath.AssignLiteral(FILESYSTEM_DOM_PATH_SEPARATOR_LITERAL);
} }
already_AddRefed<DirectoryReader> already_AddRefed<FileSystemDirectoryReader>
FileSystemRootDirectoryEntry::CreateReader() const FileSystemRootDirectoryEntry::CreateReader() const
{ {
RefPtr<DirectoryReader> reader = RefPtr<FileSystemDirectoryReader> reader =
new RootDirectoryReader(GetParentObject(), Filesystem(), mEntries); new FileSystemRootDirectoryReader(GetParentObject(), Filesystem(),
mEntries);
return reader.forget(); return reader.forget();
} }

View File

@@ -28,7 +28,7 @@ public:
virtual void virtual void
GetFullPath(nsAString& aFullPath, ErrorResult& aRv) const override; GetFullPath(nsAString& aFullPath, ErrorResult& aRv) const override;
virtual already_AddRefed<DirectoryReader> virtual already_AddRefed<FileSystemDirectoryReader>
CreateReader() const override; CreateReader() const override;
private: private:

View File

@@ -4,7 +4,7 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this file, * 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/. */ * You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "RootDirectoryReader.h" #include "FileSystemRootDirectoryReader.h"
#include "CallbackRunnables.h" #include "CallbackRunnables.h"
#include "nsIGlobalObject.h" #include "nsIGlobalObject.h"
@@ -45,18 +45,21 @@ private:
} // anonymous namespace } // anonymous namespace
NS_IMPL_CYCLE_COLLECTION_INHERITED(RootDirectoryReader, DirectoryReader, mEntries) NS_IMPL_CYCLE_COLLECTION_INHERITED(FileSystemRootDirectoryReader,
FileSystemDirectoryReader, mEntries)
NS_IMPL_ADDREF_INHERITED(RootDirectoryReader, DirectoryReader) NS_IMPL_ADDREF_INHERITED(FileSystemRootDirectoryReader,
NS_IMPL_RELEASE_INHERITED(RootDirectoryReader, DirectoryReader) FileSystemDirectoryReader)
NS_IMPL_RELEASE_INHERITED(FileSystemRootDirectoryReader,
FileSystemDirectoryReader)
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION_INHERITED(RootDirectoryReader) NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION_INHERITED(FileSystemRootDirectoryReader)
NS_INTERFACE_MAP_END_INHERITING(DirectoryReader) NS_INTERFACE_MAP_END_INHERITING(FileSystemDirectoryReader)
RootDirectoryReader::RootDirectoryReader(nsIGlobalObject* aGlobal, FileSystemRootDirectoryReader::FileSystemRootDirectoryReader(nsIGlobalObject* aGlobal,
FileSystem* aFileSystem, FileSystem* aFileSystem,
const Sequence<RefPtr<FileSystemEntry>>& aEntries) const Sequence<RefPtr<FileSystemEntry>>& aEntries)
: DirectoryReader(aGlobal, aFileSystem, nullptr) : FileSystemDirectoryReader(aGlobal, aFileSystem, nullptr)
, mEntries(aEntries) , mEntries(aEntries)
, mAlreadyRead(false) , mAlreadyRead(false)
{ {
@@ -64,13 +67,13 @@ RootDirectoryReader::RootDirectoryReader(nsIGlobalObject* aGlobal,
MOZ_ASSERT(aFileSystem); MOZ_ASSERT(aFileSystem);
} }
RootDirectoryReader::~RootDirectoryReader() FileSystemRootDirectoryReader::~FileSystemRootDirectoryReader()
{} {}
void void
RootDirectoryReader::ReadEntries(EntriesCallback& aSuccessCallback, FileSystemRootDirectoryReader::ReadEntries(EntriesCallback& aSuccessCallback,
const Optional<OwningNonNull<ErrorCallback>>& aErrorCallback, const Optional<OwningNonNull<ErrorCallback>>& aErrorCallback,
ErrorResult& aRv) ErrorResult& aRv)
{ {
if (mAlreadyRead) { if (mAlreadyRead) {
RefPtr<EmptyEntriesCallbackRunnable> runnable = RefPtr<EmptyEntriesCallbackRunnable> runnable =

View File

@@ -4,23 +4,24 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this file, * 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/. */ * You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_dom_RootDirectoryReader_h #ifndef mozilla_dom_FileSystemRootDirectoryReader_h
#define mozilla_dom_RootDirectoryReader_h #define mozilla_dom_FileSystemRootDirectoryReader_h
#include "DirectoryReader.h" #include "FileSystemDirectoryReader.h"
namespace mozilla { namespace mozilla {
namespace dom { namespace dom {
class RootDirectoryReader final : public DirectoryReader class FileSystemRootDirectoryReader final : public FileSystemDirectoryReader
{ {
public: public:
NS_DECL_ISUPPORTS_INHERITED NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(RootDirectoryReader, DirectoryReader) NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(FileSystemRootDirectoryReader,
FileSystemDirectoryReader)
explicit RootDirectoryReader(nsIGlobalObject* aGlobalObject, explicit FileSystemRootDirectoryReader(nsIGlobalObject* aGlobalObject,
FileSystem* aFileSystem, FileSystem* aFileSystem,
const Sequence<RefPtr<FileSystemEntry>>& aEntries); const Sequence<RefPtr<FileSystemEntry>>& aEntries);
virtual void virtual void
ReadEntries(EntriesCallback& aSuccessCallback, ReadEntries(EntriesCallback& aSuccessCallback,
@@ -28,7 +29,7 @@ public:
ErrorResult& aRv) override; ErrorResult& aRv) override;
private: private:
~RootDirectoryReader(); ~FileSystemRootDirectoryReader();
Sequence<RefPtr<FileSystemEntry>> mEntries; Sequence<RefPtr<FileSystemEntry>> mEntries;
bool mAlreadyRead; bool mAlreadyRead;
@@ -37,4 +38,4 @@ private:
} // namespace dom } // namespace dom
} // namespace mozilla } // namespace mozilla
#endif // mozilla_dom_RootDirectoryReader_h #endif // mozilla_dom_FileSystemRootDirectoryReader_h

View File

@@ -7,22 +7,22 @@
TEST_DIRS += ['tests'] TEST_DIRS += ['tests']
EXPORTS.mozilla.dom += [ EXPORTS.mozilla.dom += [
'DirectoryReader.h',
'FileSystem.h', 'FileSystem.h',
'FileSystemDirectoryEntry.h', 'FileSystemDirectoryEntry.h',
'FileSystemDirectoryReader.h',
'FileSystemEntry.h', 'FileSystemEntry.h',
'FileSystemFileEntry.h', 'FileSystemFileEntry.h',
] ]
UNIFIED_SOURCES += [ UNIFIED_SOURCES += [
'CallbackRunnables.cpp', 'CallbackRunnables.cpp',
'DirectoryReader.cpp',
'FileSystem.cpp', 'FileSystem.cpp',
'FileSystemDirectoryEntry.cpp', 'FileSystemDirectoryEntry.cpp',
'FileSystemDirectoryReader.cpp',
'FileSystemEntry.cpp', 'FileSystemEntry.cpp',
'FileSystemFileEntry.cpp', 'FileSystemFileEntry.cpp',
'FileSystemRootDirectoryEntry.cpp', 'FileSystemRootDirectoryEntry.cpp',
'RootDirectoryReader.cpp', 'FileSystemRootDirectoryReader.cpp',
] ]
FINAL_LIBRARY = 'xul' FINAL_LIBRARY = 'xul'

View File

@@ -42,7 +42,7 @@ callback interface VoidCallback {
[NoInterfaceObject] [NoInterfaceObject]
interface FileSystemDirectoryEntry : FileSystemEntry { interface FileSystemDirectoryEntry : FileSystemEntry {
DirectoryReader createReader(); FileSystemDirectoryReader createReader();
void getFile(DOMString? path, optional FileSystemFlags options, optional EntryCallback successCallback, optional ErrorCallback errorCallback); void getFile(DOMString? path, optional FileSystemFlags options, optional EntryCallback successCallback, optional ErrorCallback errorCallback);
@@ -63,7 +63,7 @@ callback interface ErrorCallback {
}; };
[NoInterfaceObject] [NoInterfaceObject]
interface DirectoryReader { interface FileSystemDirectoryReader {
// readEntries can be called just once. The second time it returns no data. // readEntries can be called just once. The second time it returns no data.