Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / platform / FileStream.h
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
36 namespace WebCore {
37
38 // All methods are synchronous.
39 class FileStream {
40 public:
41     FileStream();
42     ~FileStream();
43
44     // 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.
45     // Returns total number of bytes if successful. -1 otherwise.
46     long long getSize(const String& path, double expectedModificationTime);
47
48     // Opens a file for reading. The reading starts at the specified offset and lasts till the specified length.
49     // Returns true on success. False otherwise.
50     bool openForRead(const String& path, long long offset, long long length);
51
52     // Closes the file.
53     void close();
54
55     // Reads a file into the provided data buffer.
56     // Returns number of bytes being read on success. -1 otherwise.
57     // If 0 is returned, it means that the reading is completed.
58     int read(char* buffer, int length);
59
60 private:
61     FileSystem::PlatformFileHandle m_handle;
62     long long m_bytesProcessed;
63     long long m_totalBytesToRead;
64 };
65
66 } // namespace WebCore
67
68 #endif // FileStream_h