2010-08-27 Kinuko Yasuda <kinuko@chromium.org>
Reviewed by Darin Fisher.
Add AsyncFileSystem interface for platform-dependent FileSystem API implementation
https://bugs.webkit.org/show_bug.cgi?id=44433
No new tests; tests will be added later.
* CMakeLists.txt:
* WebCore.gypi:
* WebCore.pro:
* WebCore.vcproj/WebCore.vcproj:
* WebCore.xcodeproj/project.pbxproj:
* platform/AsyncFileSystem.cpp: Added.
* platform/AsyncFileSystem.h: Added.
* platform/AsyncFileSystemCallbacks.h: Added.
* storage/DOMFileSystem.cpp:
(WebCore::DOMFileSystem::DOMFileSystem):
(WebCore::DOMFileSystem::~DOMFileSystem):
(WebCore::DOMFileSystem::stop):
(WebCore::DOMFileSystem::hasPendingActivity):
(WebCore::DOMFileSystem::contextDestroyed):
* storage/DOMFileSystem.h:
(WebCore::DOMFileSystem::create):
* storage/FileSystemCallbacks.cpp:
(WebCore::FileSystemCallbacksBase::didFail):
(WebCore::FileSystemCallbacks::FileSystemCallbacks):
(WebCore::FileSystemCallbacks::didOpenFileSystem):
* storage/FileSystemCallbacks.h:
* storage/LocalFileSystem.cpp: Added.
* storage/LocalFileSystem.h: Added.
* storage/Flags.h: Nits fix.
git-svn-id: http://svn.webkit.org/repository/webkit/trunk@66255 268f45cc-cd09-0410-ab3c-d52691b4dbfc
diff --git a/WebCore/platform/AsyncFileSystem.h b/WebCore/platform/AsyncFileSystem.h
new file mode 100644
index 0000000..82f7163
--- /dev/null
+++ b/WebCore/platform/AsyncFileSystem.h
@@ -0,0 +1,125 @@
+/*
+ * Copyright (C) 2010 Google Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ * * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef AsyncFileSystem_h
+#define AsyncFileSystem_h
+
+#if ENABLE(FILE_SYSTEM)
+
+#include "PlatformString.h"
+#include <wtf/PassOwnPtr.h>
+
+namespace WebCore {
+
+class AsyncFileSystem;
+class AsyncFileSystemCallbacks;
+
+// This class provides async interface for platform-specific DOMFileSystem implementation. Note that all the methods take canonicalized virtual paths.
+class AsyncFileSystem : public Noncopyable {
+public:
+ virtual ~AsyncFileSystem() { }
+
+ // FileSystem type
+ enum Type {
+ Temporary,
+ Persistent,
+ };
+
+ virtual void stop() { }
+ virtual bool hasPendingActivity() { return false; }
+
+ // Creates and returns a new platform-specific AsyncFileSystem instance if the platform has its own implementation.
+ static PassOwnPtr<AsyncFileSystem> create(const String& rootPath);
+
+ // Opens a new file system.
+ static void openFileSystem(const String& basePath, const String& storageIdentifier, Type, PassOwnPtr<AsyncFileSystemCallbacks>);
+
+ // Moves a file or directory from srcPath to destPath.
+ // AsyncFileSystemCallbacks::didSucceed() is called when the operation is completed successfully.
+ // AsyncFileSystemCallbacks::didFail() is called otherwise.
+ virtual void move(const String& srcPath, const String& destPath, PassOwnPtr<AsyncFileSystemCallbacks>) = 0;
+
+ // Copies a file or directory from srcPath to destPath.
+ // AsyncFileSystemCallbacks::didSucceed() is called when the operation is completed successfully.
+ // AsyncFileSystemCallbacks::didFail() is called otherwise.
+ virtual void copy(const String& srcPath, const String& destPath, PassOwnPtr<AsyncFileSystemCallbacks>) = 0;
+
+ // Deletes a file or directory at a given path.
+ // AsyncFileSystemCallbacks::didSucceed() is called when the operation is completed successfully.
+ // AsyncFileSystemCallbacks::didFail() is called otherwise.
+ virtual void remove(const String& path, PassOwnPtr<AsyncFileSystemCallbacks>) = 0;
+
+ // Retrieves the metadata information of the file or directory at a given path.
+ // AsyncFileSystemCallbacks::didReadMetadata() is called when the operation is completed successfully.
+ // AsyncFileSystemCallbacks::didFail() is called otherwise.
+ virtual void readMetadata(const String& path, PassOwnPtr<AsyncFileSystemCallbacks>) = 0;
+
+ // Creates a file at a given path. If exclusive flag is true, it fails if the path already exists.
+ // AsyncFileSystemCallbacks::didSucceed() is called when the operation is completed successfully.
+ // AsyncFileSystemCallbacks::didFail() is called otherwise.
+ virtual void createFile(const String& path, bool exclusive, PassOwnPtr<AsyncFileSystemCallbacks>) = 0;
+
+ // Creates a directory at a given path. If exclusive flag is true, it fails if the path already exists.
+ // AsyncFileSystemCallbacks::didSucceed() is called when the operation is completed successfully.
+ // AsyncFileSystemCallbacks::didFail() is called otherwise.
+ virtual void createDirectory(const String& path, bool exclusive, PassOwnPtr<AsyncFileSystemCallbacks>) = 0;
+
+ // Checks if a file exists at a given path.
+ // AsyncFileSystemCallbacks::didSucceed() is called if the file exists.
+ // AsyncFileSystemCallbacks::didFail() is called otherwise.
+ virtual void fileExists(const String& path, PassOwnPtr<AsyncFileSystemCallbacks>) = 0;
+
+ // Checks if a directory exists at a given path.
+ // AsyncFileSystemCallbacks::didSucceed() is called if the directory exists.
+ // AsyncFileSystemCallbacks::didFail() is called otherwise.
+ virtual void directoryExists(const String& path, PassOwnPtr<AsyncFileSystemCallbacks>) = 0;
+
+ // Reads directory entries of a given directory at path.
+ // AsyncFileSystemCallbacks::didReadDirectoryEntry() is called when each directory entry is called. AsyncFileSystemCallbacks::didReadDirectoryEntries() is called after a chunk of directory entries have been read.
+ // AsyncFileSystemCallbacks::didFail() is when there is an error.
+ virtual void readDirectory(const String& path, PassOwnPtr<AsyncFileSystemCallbacks>) = 0;
+
+ // Converts a given absolute virtual path to a platform path that starts with the platform root path of this file system.
+ virtual String virtualToPlatformPath(const String& path) const;
+
+protected:
+ AsyncFileSystem(const String& platformRootPath)
+ : m_platformRootPath(platformRootPath)
+ {
+ }
+
+ String m_platformRootPath;
+};
+
+} // namespace WebCore
+
+#endif // ENABLE(FILE_SYSTEM)
+
+#endif // AsyncFileSystem_h
