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