File::lastModifiedDate should use NaN or separate boolean flag for null Date value
[WebKit-https.git] / Source / WebCore / platform / FileSystem.h
1 /*
2  * Copyright (C) 2007, 2008, 2011 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Collabora, Ltd. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef FileSystem_h
31 #define FileSystem_h
32
33 #include "PlatformString.h"
34 #include <time.h>
35 #include <wtf/Forward.h>
36 #include <wtf/MathExtras.h>
37 #include <wtf/Vector.h>
38
39 #if USE(CF)
40 #include <wtf/RetainPtr.h>
41 #endif
42
43 #if PLATFORM(QT)
44 #include <QFile>
45 #include <QLibrary>
46 #if defined(Q_OS_WIN32)
47 #include <windows.h>
48 #endif
49 #endif
50
51 #if PLATFORM(WX)
52 #include <wx/defs.h>
53 #include <wx/file.h>
54 #endif
55
56 #if USE(CF) || (PLATFORM(QT) && defined(Q_WS_MAC))
57 typedef struct __CFBundle* CFBundleRef;
58 typedef const struct __CFData* CFDataRef;
59 #endif
60
61 #if OS(WINDOWS)
62 // These are to avoid including <winbase.h> in a header for Chromium
63 typedef void *HANDLE;
64 // Assuming STRICT
65 typedef struct HINSTANCE__* HINSTANCE;
66 typedef HINSTANCE HMODULE;
67 #endif
68
69 #if PLATFORM(GTK)
70 typedef struct _GFileIOStream GFileIOStream;
71 typedef struct _GModule GModule;
72 #endif
73
74 namespace WebCore {
75
76 // PlatformModule
77 #if PLATFORM(GTK)
78 typedef GModule* PlatformModule;
79 #elif OS(WINDOWS)
80 typedef HMODULE PlatformModule;
81 #elif PLATFORM(QT)
82 #if defined(Q_WS_MAC)
83 typedef CFBundleRef PlatformModule;
84 #elif !defined(QT_NO_LIBRARY)
85 typedef QLibrary* PlatformModule;
86 #else
87 typedef void* PlatformModule;
88 #endif
89 #elif USE(CF)
90 typedef CFBundleRef PlatformModule;
91 #else
92 typedef void* PlatformModule;
93 #endif
94
95 // PlatformModuleVersion
96 #if OS(WINDOWS)
97 struct PlatformModuleVersion {
98     unsigned leastSig;
99     unsigned mostSig;
100
101     PlatformModuleVersion(unsigned)
102         : leastSig(0)
103         , mostSig(0)
104     {
105     }
106
107     PlatformModuleVersion(unsigned lsb, unsigned msb)
108         : leastSig(lsb)
109         , mostSig(msb)
110     {
111     }
112
113 };
114 #else
115 typedef unsigned PlatformModuleVersion;
116 #endif
117
118 // PlatformFileHandle
119 #if PLATFORM(QT)
120 typedef QFile* PlatformFileHandle;
121 const PlatformFileHandle invalidPlatformFileHandle = 0;
122 #elif PLATFORM(GTK)
123 typedef GFileIOStream* PlatformFileHandle;
124 const PlatformFileHandle invalidPlatformFileHandle = 0;
125 #elif OS(WINDOWS)
126 typedef HANDLE PlatformFileHandle;
127 // FIXME: -1 is INVALID_HANDLE_VALUE, defined in <winbase.h>. Chromium tries to
128 // avoid using Windows headers in headers.  We'd rather move this into the .cpp.
129 const PlatformFileHandle invalidPlatformFileHandle = reinterpret_cast<HANDLE>(-1);
130 #elif PLATFORM(WX)
131 typedef wxFile* PlatformFileHandle;
132 const PlatformFileHandle invalidPlatformFileHandle = 0;
133 #else
134 typedef int PlatformFileHandle;
135 const PlatformFileHandle invalidPlatformFileHandle = -1;
136 #endif
137
138 enum FileOpenMode {
139     OpenForRead = 0,
140     OpenForWrite
141 };
142
143 enum FileSeekOrigin {
144     SeekFromBeginning = 0,
145     SeekFromCurrent,
146     SeekFromEnd
147 };
148
149 #if OS(WINDOWS)
150 static const char PlatformFilePathSeparator = '\\';
151 #else
152 static const char PlatformFilePathSeparator = '/';
153 #endif
154
155 struct FileMetadata;
156
157 bool fileExists(const String&);
158 bool deleteFile(const String&);
159 bool deleteEmptyDirectory(const String&);
160 bool getFileSize(const String&, long long& result);
161 bool getFileModificationTime(const String&, time_t& result);
162 bool getFileMetadata(const String&, FileMetadata&);
163 String pathByAppendingComponent(const String& path, const String& component);
164 bool makeAllDirectories(const String& path);
165 String homeDirectoryPath();
166 String pathGetFileName(const String&);
167 String directoryName(const String&);
168
169 bool canExcludeFromBackup(); // Returns true if any file can ever be excluded from backup.
170 bool excludeFromBackup(const String&); // Returns true if successful.
171
172 Vector<String> listDirectory(const String& path, const String& filter = String());
173
174 CString fileSystemRepresentation(const String&);
175
176 inline bool isHandleValid(const PlatformFileHandle& handle) { return handle != invalidPlatformFileHandle; }
177
178 inline double invalidFileTime() { return std::numeric_limits<double>::quiet_NaN(); }
179 inline bool isValidFileTime(double time) { return isfinite(time); }
180
181 // Prefix is what the filename should be prefixed with, not the full path.
182 String openTemporaryFile(const String& prefix, PlatformFileHandle&);
183 PlatformFileHandle openFile(const String& path, FileOpenMode);
184 void closeFile(PlatformFileHandle&);
185 // Returns the resulting offset from the beginning of the file if successful, -1 otherwise.
186 long long seekFile(PlatformFileHandle, long long offset, FileSeekOrigin);
187 bool truncateFile(PlatformFileHandle, long long offset);
188 // Returns number of bytes actually read if successful, -1 otherwise.
189 int writeToFile(PlatformFileHandle, const char* data, int length);
190 // Returns number of bytes actually written if successful, -1 otherwise.
191 int readFromFile(PlatformFileHandle, char* data, int length);
192
193 // Functions for working with loadable modules.
194 bool unloadModule(PlatformModule);
195
196 // Encode a string for use within a file name.
197 String encodeForFileName(const String&);
198
199 #if USE(CF)
200 RetainPtr<CFURLRef> pathAsURL(const String&);
201 #endif
202
203 #if PLATFORM(MAC)
204 void setMetadataURL(String& URLString, const String& referrer, const String& path);
205 #endif
206
207 #if PLATFORM(GTK)
208 String filenameToString(const char*);
209 String filenameForDisplay(const String&);
210 CString applicationDirectoryPath();
211 CString sharedResourcesPath();
212 #endif
213 #if PLATFORM(GTK) || PLATFORM(QT)
214 uint64_t getVolumeFreeSizeForPath(const char*);
215 #endif
216
217 #if PLATFORM(WIN) && !OS(WINCE)
218 String localUserSpecificStorageDirectory();
219 String roamingUserSpecificStorageDirectory();
220 #endif
221
222 #if PLATFORM(WIN) && USE(CF)
223 bool safeCreateFile(const String&, CFDataRef);
224 #endif
225
226 } // namespace WebCore
227
228 #endif // FileSystem_h