cc05b02c1cf8821e3c01104d2682716850d55fc4
[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/Vector.h>
37
38 #if USE(CF)
39 #include <wtf/RetainPtr.h>
40 #endif
41
42 #if PLATFORM(QT)
43 #include <QFile>
44 #include <QLibrary>
45 #if defined(Q_OS_WIN32)
46 #include <windows.h>
47 #endif
48 #endif
49
50 #if PLATFORM(WX)
51 #include <wx/defs.h>
52 #include <wx/file.h>
53 #endif
54
55 #if USE(CF) || (PLATFORM(QT) && defined(Q_WS_MAC))
56 typedef struct __CFBundle* CFBundleRef;
57 typedef const struct __CFData* CFDataRef;
58 #endif
59
60 #if OS(WINDOWS)
61 // These are to avoid including <winbase.h> in a header for Chromium
62 typedef void *HANDLE;
63 // Assuming STRICT
64 typedef struct HINSTANCE__* HINSTANCE;
65 typedef HINSTANCE HMODULE;
66 #endif
67
68 #if PLATFORM(GTK)
69 typedef struct _GFileIOStream GFileIOStream;
70 typedef struct _GModule GModule;
71 #endif
72
73 namespace WebCore {
74
75 // PlatformModule
76 #if PLATFORM(GTK)
77 typedef GModule* PlatformModule;
78 #elif OS(WINDOWS)
79 typedef HMODULE PlatformModule;
80 #elif PLATFORM(QT)
81 #if defined(Q_WS_MAC)
82 typedef CFBundleRef PlatformModule;
83 #elif !defined(QT_NO_LIBRARY)
84 typedef QLibrary* PlatformModule;
85 #else
86 typedef void* PlatformModule;
87 #endif
88 #elif USE(CF)
89 typedef CFBundleRef PlatformModule;
90 #else
91 typedef void* PlatformModule;
92 #endif
93
94 // PlatformModuleVersion
95 #if OS(WINDOWS)
96 struct PlatformModuleVersion {
97     unsigned leastSig;
98     unsigned mostSig;
99
100     PlatformModuleVersion(unsigned)
101         : leastSig(0)
102         , mostSig(0)
103     {
104     }
105
106     PlatformModuleVersion(unsigned lsb, unsigned msb)
107         : leastSig(lsb)
108         , mostSig(msb)
109     {
110     }
111
112 };
113 #else
114 typedef unsigned PlatformModuleVersion;
115 #endif
116
117 // PlatformFileHandle
118 #if PLATFORM(QT)
119 typedef QFile* PlatformFileHandle;
120 const PlatformFileHandle invalidPlatformFileHandle = 0;
121 #elif PLATFORM(GTK)
122 typedef GFileIOStream* PlatformFileHandle;
123 const PlatformFileHandle invalidPlatformFileHandle = 0;
124 #elif OS(WINDOWS)
125 typedef HANDLE PlatformFileHandle;
126 // FIXME: -1 is INVALID_HANDLE_VALUE, defined in <winbase.h>. Chromium tries to
127 // avoid using Windows headers in headers.  We'd rather move this into the .cpp.
128 const PlatformFileHandle invalidPlatformFileHandle = reinterpret_cast<HANDLE>(-1);
129 #elif PLATFORM(WX)
130 typedef wxFile* PlatformFileHandle;
131 const PlatformFileHandle invalidPlatformFileHandle = 0;
132 #else
133 typedef int PlatformFileHandle;
134 const PlatformFileHandle invalidPlatformFileHandle = -1;
135 #endif
136
137 enum FileOpenMode {
138     OpenForRead = 0,
139     OpenForWrite
140 };
141
142 enum FileSeekOrigin {
143     SeekFromBeginning = 0,
144     SeekFromCurrent,
145     SeekFromEnd
146 };
147
148 #if OS(WINDOWS)
149 static const char PlatformFilePathSeparator = '\\';
150 #else
151 static const char PlatformFilePathSeparator = '/';
152 #endif
153
154 struct FileMetadata;
155
156 bool fileExists(const String&);
157 bool deleteFile(const String&);
158 bool deleteEmptyDirectory(const String&);
159 bool getFileSize(const String&, long long& result);
160 bool getFileModificationTime(const String&, time_t& result);
161 bool getFileMetadata(const String&, FileMetadata&);
162 String pathByAppendingComponent(const String& path, const String& component);
163 bool makeAllDirectories(const String& path);
164 String homeDirectoryPath();
165 String pathGetFileName(const String&);
166 String directoryName(const String&);
167
168 bool canExcludeFromBackup(); // Returns true if any file can ever be excluded from backup.
169 bool excludeFromBackup(const String&); // Returns true if successful.
170
171 Vector<String> listDirectory(const String& path, const String& filter = String());
172
173 CString fileSystemRepresentation(const String&);
174
175 inline bool isHandleValid(const PlatformFileHandle& handle) { return handle != invalidPlatformFileHandle; }
176
177 // Prefix is what the filename should be prefixed with, not the full path.
178 String openTemporaryFile(const String& prefix, PlatformFileHandle&);
179 PlatformFileHandle openFile(const String& path, FileOpenMode);
180 void closeFile(PlatformFileHandle&);
181 // Returns the resulting offset from the beginning of the file if successful, -1 otherwise.
182 long long seekFile(PlatformFileHandle, long long offset, FileSeekOrigin);
183 bool truncateFile(PlatformFileHandle, long long offset);
184 // Returns number of bytes actually read if successful, -1 otherwise.
185 int writeToFile(PlatformFileHandle, const char* data, int length);
186 // Returns number of bytes actually written if successful, -1 otherwise.
187 int readFromFile(PlatformFileHandle, char* data, int length);
188
189 // Functions for working with loadable modules.
190 bool unloadModule(PlatformModule);
191
192 // Encode a string for use within a file name.
193 String encodeForFileName(const String&);
194
195 #if USE(CF)
196 RetainPtr<CFURLRef> pathAsURL(const String&);
197 #endif
198
199 #if PLATFORM(MAC)
200 void setMetadataURL(String& URLString, const String& referrer, const String& path);
201 #endif
202
203 #if PLATFORM(GTK)
204 String filenameToString(const char*);
205 String filenameForDisplay(const String&);
206 CString applicationDirectoryPath();
207 CString sharedResourcesPath();
208 #endif
209 #if PLATFORM(GTK) || PLATFORM(QT)
210 uint64_t getVolumeFreeSizeForPath(const char*);
211 #endif
212
213 #if PLATFORM(WIN) && !OS(WINCE)
214 String localUserSpecificStorageDirectory();
215 String roamingUserSpecificStorageDirectory();
216 #endif
217
218 #if PLATFORM(WIN) && USE(CF)
219 bool safeCreateFile(const String&, CFDataRef);
220 #endif
221
222 } // namespace WebCore
223
224 #endif // FileSystem_h