1 /* 2 * Copyright (C) 2010 Google Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google Inc. nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef AsyncFileSystemCallbacks_h 32 #define AsyncFileSystemCallbacks_h 33 34 #include "platform/FileMetadata.h" 35 #include "platform/FileSystemType.h" 36 #include "platform/blob/BlobData.h" 37 #include "public/platform/WebFileWriter.h" 38 #include "wtf/Assertions.h" 39 #include "wtf/Noncopyable.h" 40 #include "wtf/text/WTFString.h" 41 42 namespace WebCore { 43 44 class PLATFORM_EXPORT AsyncFileSystemCallbacks { 45 WTF_MAKE_NONCOPYABLE(AsyncFileSystemCallbacks); 46 public: AsyncFileSystemCallbacks()47 AsyncFileSystemCallbacks() : m_blockUntilCompletion(false) { } 48 49 // Called when a requested operation is completed successfully. didSucceed()50 virtual void didSucceed() { ASSERT_NOT_REACHED(); } 51 52 // Called when a requested file system is opened. didOpenFileSystem(const String & name,const KURL & rootURL)53 virtual void didOpenFileSystem(const String& name, const KURL& rootURL) { ASSERT_NOT_REACHED(); } 54 55 // Called when a filesystem URL is resolved. didResolveURL(const String & name,const KURL & rootURL,FileSystemType,const String & filePath,bool isDirectory)56 virtual void didResolveURL(const String& name, const KURL& rootURL, FileSystemType, const String& filePath, bool isDirectory) { ASSERT_NOT_REACHED(); } 57 58 // Called when a file metadata is read successfully. didReadMetadata(const FileMetadata &)59 virtual void didReadMetadata(const FileMetadata&) { ASSERT_NOT_REACHED(); } 60 61 // Called when a snapshot file is created successfully. didCreateSnapshotFile(const FileMetadata &,PassRefPtr<BlobDataHandle> snapshot)62 virtual void didCreateSnapshotFile(const FileMetadata&, PassRefPtr<BlobDataHandle> snapshot) { ASSERT_NOT_REACHED(); } 63 64 // Called when a directory entry is read. didReadDirectoryEntry(const String & name,bool isDirectory)65 virtual void didReadDirectoryEntry(const String& name, bool isDirectory) { ASSERT_NOT_REACHED(); } 66 67 // Called after a chunk of directory entries have been read (i.e. indicates it's good time to call back to the application). If hasMore is true there can be more chunks. didReadDirectoryEntries(bool hasMore)68 virtual void didReadDirectoryEntries(bool hasMore) { ASSERT_NOT_REACHED(); } 69 70 // Called when an AsyncFileWrter has been created successfully. didCreateFileWriter(PassOwnPtr<blink::WebFileWriter>,long long length)71 virtual void didCreateFileWriter(PassOwnPtr<blink::WebFileWriter>, long long length) { ASSERT_NOT_REACHED(); } 72 73 // Called when there was an error. 74 virtual void didFail(int code) = 0; 75 76 // Returns true if the caller expects that the calling thread blocks 77 // until completion. shouldBlockUntilCompletion()78 virtual bool shouldBlockUntilCompletion() const 79 { 80 return m_blockUntilCompletion; 81 } 82 setShouldBlockUntilCompletion(bool flag)83 void setShouldBlockUntilCompletion(bool flag) 84 { 85 m_blockUntilCompletion = flag; 86 } 87 ~AsyncFileSystemCallbacks()88 virtual ~AsyncFileSystemCallbacks() { } 89 90 private: 91 bool m_blockUntilCompletion; 92 }; 93 94 } // namespace 95 96 #endif // AsyncFileSystemCallbacks_h 97