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 FileStream_h 32#define FileStream_h 33 34#include "FileSystem.h" 35#include <wtf/Forward.h> 36#include <wtf/PassRefPtr.h> 37#include <wtf/RefCounted.h> 38 39namespace WebCore { 40 41class URL; 42 43// All methods are synchronous. 44class FileStream : public RefCounted<FileStream> { 45public: 46 static PassRefPtr<FileStream> create() 47 { 48 return adoptRef(new FileStream()); 49 } 50 ~FileStream(); 51 52 // FIXME: To be removed when we switch to using BlobData. 53 void start(); 54 55 // Aborts the operation. 56 void stop(); 57 58 // Gets the size of a file. Also validates if the file has been changed or not if the expected modification time is provided, i.e. non-zero. 59 // Returns total number of bytes if successful. -1 otherwise. 60 long long getSize(const String& path, double expectedModificationTime); 61 62 // Opens a file for reading. The reading starts at the specified offset and lasts till the specified length. 63 // Returns true on success. False otherwise. 64 bool openForRead(const String& path, long long offset, long long length); 65 66 // Opens a file for writing. 67 // Returns true on success. False otherwise. 68 bool openForWrite(const String& path); 69 70 // Closes the file. 71 void close(); 72 73 // Reads a file into the provided data buffer. 74 // Returns number of bytes being read on success. -1 otherwise. 75 // If 0 is returned, it means that the reading is completed. 76 int read(char* buffer, int length); 77 78 // Writes a blob to the file. 79 // Returns number of bytes being written on success. -1 otherwise. 80 int write(const URL& blobURL, long long position, int length); 81 82 // Truncates the file to the specified position. 83 // Returns true on success. False otherwise. 84 bool truncate(long long position); 85 86private: 87 FileStream(); 88 89 PlatformFileHandle m_handle; 90 long long m_bytesProcessed; 91 long long m_totalBytesToRead; 92}; 93 94} // namespace WebCore 95 96#endif // FileStream_h 97