Bug 1295570 - Entries API - part 7 - Split WebIDL files, r=smaug

dom/filesystem/compat/CallbackRunnables.cpp

@@ -9,6 +9,7 @@
 #include "mozilla/dom/DOMError.h"
 #include "mozilla/dom/File.h"
 #include "mozilla/dom/FileBinding.h"
+#include "mozilla/dom/FileSystemDirectoryReaderBinding.h"
 #include "mozilla/dom/FileSystemFileEntry.h"
 #include "mozilla/dom/Promise.h"
 #include "nsIGlobalObject.h"

dom/filesystem/compat/CallbackRunnables.h

@@ -16,6 +16,8 @@ class nsIGlobalObject;
 namespace mozilla {
 namespace dom {
 
+class FileSystemEntriesCallback;
+
 class EntryCallbackRunnable final : public Runnable
 {
 public:

dom/filesystem/compat/FileSystemDirectoryEntry.cpp

@@ -8,6 +8,7 @@
 #include "CallbackRunnables.h"
 #include "FileSystemDirectoryReader.h"
 #include "mozilla/dom/Directory.h"
+#include "mozilla/dom/FileSystemDirectoryEntryBinding.h"
 #include "mozilla/dom/FileSystemUtils.h"
 
 namespace mozilla {

dom/filesystem/compat/FileSystemDirectoryEntry.h

@@ -14,6 +14,7 @@ namespace mozilla {
 namespace dom {
 
 class Directory;
+class FileSystemDirectoryReader;
 
 class FileSystemDirectoryEntry : public FileSystemEntry
 {

dom/filesystem/compat/FileSystemDirectoryReader.h

@@ -20,6 +20,7 @@ namespace dom {
 
 class Directory;
 class FileSystem;
+class FileSystemEntriesCallback;
 
 class FileSystemDirectoryReader
   : public nsISupports

dom/filesystem/compat/FileSystemEntry.cpp

@@ -7,6 +7,7 @@
 #include "FileSystemEntry.h"
 #include "FileSystemDirectoryEntry.h"
 #include "FileSystemFileEntry.h"
+#include "mozilla/dom/FileSystemEntryBinding.h"
 #include "mozilla/dom/UnionTypes.h"
 
 namespace mozilla {

dom/filesystem/compat/FileSystemFileEntry.cpp

@@ -7,6 +7,7 @@
 #include "FileSystemFileEntry.h"
 #include "CallbackRunnables.h"
 #include "mozilla/dom/File.h"
+#include "mozilla/dom/FileSystemFileEntryBinding.h"
 
 namespace mozilla {
 namespace dom {

dom/filesystem/compat/FileSystemFileEntry.h

@@ -13,6 +13,7 @@ namespace mozilla {
 namespace dom {
 
 class File;
+class BlobCallback;
 
 class FileSystemFileEntry final : public FileSystemEntry
 {

dom/webidl/FileSystem.webidl

@@ -4,35 +4,6 @@
  * You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
-[NoInterfaceObject]
-interface FileSystemEntry {
-    readonly attribute boolean isFile;
-    readonly attribute boolean isDirectory;
-
-    [GetterThrows]
-    readonly attribute DOMString name;
-
-    [GetterThrows]
-    readonly attribute DOMString fullPath;
-
-    readonly attribute FileSystem filesystem;
-
-/** Not implemented:
- *  void getMetadata(MetadataCallback successCallback,
- *                   optional ErrorCallback errorCallback);
- *  void moveTo(FileSystemDirectoryEntry parent, optional DOMString? name,
- *              optional FileSystemEntryCallback successCallback,
- *              optional ErrorCallback errorCallback);
- *  void copyTo(FileSystemDirectoryEntry parent, optional DOMString? name,
- *              optional FileSystemEntryCallback successCallback,
- *              optional ErrorCallback errorCallback);
- *  DOMString toURL();
- *  void remove(VoidCallback successCallback,
- *              optional ErrorCallback errorCallback);
- *  void getParent(optional FileSystemEntryCallback successCallback,
- *                 optional ErrorCallback errorCallback);
- */
-};
 
 dictionary FileSystemFlags {
     boolean create = false;
@@ -47,62 +18,11 @@ callback interface VoidCallback {
     void handleEvent();
 };
 
-[NoInterfaceObject]
-interface FileSystemDirectoryEntry : FileSystemEntry {
-    FileSystemDirectoryReader createReader();
-
-    void getFile(DOMString? path,
-                 optional FileSystemFlags options,
-                 optional FileSystemEntryCallback successCallback,
-                 optional ErrorCallback errorCallback);
-
-    void getDirectory(DOMString? path,
-                      optional FileSystemFlags options,
-                      optional FileSystemEntryCallback successCallback,
-                      optional ErrorCallback errorCallback);
-
-    // This method is not implemented. ErrorCallback will be called
-    // with NS_ERROR_DOM_NOT_SUPPORTED_ERR.
-    void removeRecursively(VoidCallback successCallback,
-                           optional ErrorCallback errorCallback);
-};
-
-callback interface FileSystemEntriesCallback {
-    void handleEvent(sequence<FileSystemEntry> entries);
-};
-
 callback interface ErrorCallback {
     // This should be FileError but we are implementing just a subset of this API.
     void handleEvent(DOMError error);
 };
 
-[NoInterfaceObject]
-interface FileSystemDirectoryReader {
-
-    // readEntries can be called just once. The second time it returns no data.
-
-    [Throws]
-    void readEntries(FileSystemEntriesCallback successCallback,
-                     optional ErrorCallback errorCallback);
-};
-
-callback interface BlobCallback {
-    void handleEvent(Blob? blob);
-};
-
-[NoInterfaceObject]
-interface FileSystemFileEntry : FileSystemEntry {
-    // the successCallback should be a FileWriteCallback but this method is not
-    // implemented. ErrorCallback will be called with
-    // NS_ERROR_DOM_NOT_SUPPORTED_ERR.
-    void createWriter (VoidCallback successCallback,
-                       optional ErrorCallback errorCallback);
-
-    [BinaryName="GetFile"]
-    void file (BlobCallback successCallback,
-               optional ErrorCallback errorCallback);
-};
-
 [NoInterfaceObject]
 interface FileSystem {
     readonly    attribute DOMString name;

dom/webidl/FileSystemDirectoryEntry.webidl

@@ -0,0 +1,25 @@
+/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* 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/.
+ */
+
+[NoInterfaceObject]
+interface FileSystemDirectoryEntry : FileSystemEntry {
+    FileSystemDirectoryReader createReader();
+
+    void getFile(DOMString? path,
+                 optional FileSystemFlags options,
+                 optional FileSystemEntryCallback successCallback,
+                 optional ErrorCallback errorCallback);
+
+    void getDirectory(DOMString? path,
+                      optional FileSystemFlags options,
+                      optional FileSystemEntryCallback successCallback,
+                      optional ErrorCallback errorCallback);
+
+    // This method is not implemented. ErrorCallback will be called
+    // with NS_ERROR_DOM_NOT_SUPPORTED_ERR.
+    void removeRecursively(VoidCallback successCallback,
+                           optional ErrorCallback errorCallback);
+};

dom/webidl/FileSystemDirectoryReader.webidl

@@ -0,0 +1,19 @@
+/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* 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/.
+ */
+
+callback interface FileSystemEntriesCallback {
+    void handleEvent(sequence<FileSystemEntry> entries);
+};
+
+[NoInterfaceObject]
+interface FileSystemDirectoryReader {
+
+    // readEntries can be called just once. The second time it returns no data.
+
+    [Throws]
+    void readEntries(FileSystemEntriesCallback successCallback,
+                     optional ErrorCallback errorCallback);
+};

dom/webidl/FileSystemEntry.webidl

@@ -0,0 +1,35 @@
+/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* 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/.
+ */
+
+[NoInterfaceObject]
+interface FileSystemEntry {
+    readonly attribute boolean isFile;
+    readonly attribute boolean isDirectory;
+
+    [GetterThrows]
+    readonly attribute DOMString name;
+
+    [GetterThrows]
+    readonly attribute DOMString fullPath;
+
+    readonly attribute FileSystem filesystem;
+
+/** Not implemented:
+ *  void getMetadata(MetadataCallback successCallback,
+ *                   optional ErrorCallback errorCallback);
+ *  void moveTo(FileSystemDirectoryEntry parent, optional DOMString? name,
+ *              optional FileSystemEntryCallback successCallback,
+ *              optional ErrorCallback errorCallback);
+ *  void copyTo(FileSystemDirectoryEntry parent, optional DOMString? name,
+ *              optional FileSystemEntryCallback successCallback,
+ *              optional ErrorCallback errorCallback);
+ *  DOMString toURL();
+ *  void remove(VoidCallback successCallback,
+ *              optional ErrorCallback errorCallback);
+ *  void getParent(optional FileSystemEntryCallback successCallback,
+ *                 optional ErrorCallback errorCallback);
+ */
+};

dom/webidl/FileSystemFileEntry.webidl

@@ -0,0 +1,22 @@
+/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* 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/.
+ */
+
+callback interface BlobCallback {
+    void handleEvent(Blob? blob);
+};
+
+[NoInterfaceObject]
+interface FileSystemFileEntry : FileSystemEntry {
+    // the successCallback should be a FileWriteCallback but this method is not
+    // implemented. ErrorCallback will be called with
+    // NS_ERROR_DOM_NOT_SUPPORTED_ERR.
+    void createWriter (VoidCallback successCallback,
+                       optional ErrorCallback errorCallback);
+
+    [BinaryName="GetFile"]
+    void file (BlobCallback successCallback,
+               optional ErrorCallback errorCallback);
+};

dom/webidl/moz.build

@@ -162,6 +162,10 @@ WEBIDL_FILES = [
     'FileReader.webidl',
     'FileReaderSync.webidl',
     'FileSystem.webidl',
+    'FileSystemDirectoryEntry.webidl',
+    'FileSystemDirectoryReader.webidl',
+    'FileSystemEntry.webidl',
+    'FileSystemFileEntry.webidl',
     'FlyWebDiscoveryManager.webidl',
     'FlyWebFetchEvent.webidl',
     'FlyWebPublish.webidl',