OLD | NEW |
1 /* | 1 /* |
2 * This file is part of Adblock Plus <https://adblockplus.org/>, | 2 * This file is part of Adblock Plus <https://adblockplus.org/>, |
3 * Copyright (C) 2006-2017 eyeo GmbH | 3 * Copyright (C) 2006-2017 eyeo GmbH |
4 * | 4 * |
5 * Adblock Plus is free software: you can redistribute it and/or modify | 5 * Adblock Plus is free software: you can redistribute it and/or modify |
6 * it under the terms of the GNU General Public License version 3 as | 6 * it under the terms of the GNU General Public License version 3 as |
7 * published by the Free Software Foundation. | 7 * published by the Free Software Foundation. |
8 * | 8 * |
9 * Adblock Plus is distributed in the hope that it will be useful, | 9 * Adblock Plus is distributed in the hope that it will be useful, |
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of | 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
12 * GNU General Public License for more details. | 12 * GNU General Public License for more details. |
13 * | 13 * |
14 * You should have received a copy of the GNU General Public License | 14 * You should have received a copy of the GNU General Public License |
15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>. | 15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>. |
16 */ | 16 */ |
17 | 17 |
18 #ifndef ADBLOCK_PLUS_FILE_SYSTEM_H | 18 #ifndef ADBLOCK_PLUS_FILE_SYSTEM_H |
19 #define ADBLOCK_PLUS_FILE_SYSTEM_H | 19 #define ADBLOCK_PLUS_FILE_SYSTEM_H |
20 | 20 |
21 #include <istream> | 21 #include <istream> |
22 #include <stdint.h> | 22 #include <stdint.h> |
23 #include <string> | 23 #include <string> |
24 #include <memory> | 24 #include <memory> |
25 | 25 |
| 26 #include "IFileSystem.h" |
| 27 |
26 namespace AdblockPlus | 28 namespace AdblockPlus |
27 { | 29 { |
28 /** | 30 /** |
29 * File system interface. | 31 * File system interface. |
30 */ | 32 */ |
31 class FileSystem | 33 class FileSystem |
32 { | 34 { |
33 public: | 35 public: |
34 /** | |
35 * Result of a stat operation, i.e.\ information about a file. | |
36 */ | |
37 struct StatResult | |
38 { | |
39 StatResult() | |
40 { | |
41 exists = false; | |
42 isDirectory = false; | |
43 isFile = false; | |
44 lastModified = 0; | |
45 } | |
46 | |
47 /** | |
48 * File exists. | |
49 */ | |
50 bool exists; | |
51 | |
52 /** | |
53 * File is a directory. | |
54 */ | |
55 bool isDirectory; | |
56 | |
57 /** | |
58 * File is a regular file. | |
59 */ | |
60 bool isFile; | |
61 | |
62 /** | |
63 * POSIX time of the last modification. | |
64 */ | |
65 int64_t lastModified; | |
66 }; | |
67 | |
68 typedef std::vector<uint8_t> IOBuffer; | |
69 | |
70 virtual ~FileSystem() {} | 36 virtual ~FileSystem() {} |
71 | 37 |
72 /** | 38 /** |
73 * Reads from a file. | 39 * Reads from a file. |
74 * @param path File path. | 40 * @param path File path. |
75 * @return Buffer with the file content. | 41 * @return Buffer with the file content. |
76 */ | 42 */ |
77 virtual IOBuffer Read(const std::string& path) const = 0; | 43 virtual IFileSystem::IOBuffer Read(const std::string& path) const = 0; |
78 | 44 |
79 /** | 45 /** |
80 * Writes to a file. | 46 * Writes to a file. |
81 * @param path File path. | 47 * @param path File path. |
82 * @param data Buffer with the data to write. | 48 * @param data Buffer with the data to write. |
83 */ | 49 */ |
84 virtual void Write(const std::string& path, | 50 virtual void Write(const std::string& path, |
85 const IOBuffer& data) = 0; | 51 const IFileSystem::IOBuffer& data) = 0; |
86 | 52 |
87 /** | 53 /** |
88 * Moves a file (i.e.\ renames it). | 54 * Moves a file (i.e.\ renames it). |
89 * @param fromPath Current path to the file. | 55 * @param fromPath Current path to the file. |
90 * @param toPath New path to the file. | 56 * @param toPath New path to the file. |
91 */ | 57 */ |
92 virtual void Move(const std::string& fromPath, | 58 virtual void Move(const std::string& fromPath, |
93 const std::string& toPath) = 0; | 59 const std::string& toPath) = 0; |
94 | 60 |
95 /** | 61 /** |
96 * Removes a file. | 62 * Removes a file. |
97 * @param path File path. | 63 * @param path File path. |
98 */ | 64 */ |
99 virtual void Remove(const std::string& path) = 0; | 65 virtual void Remove(const std::string& path) = 0; |
100 | 66 |
101 /** | 67 /** |
102 * Retrieves information about a file. | 68 * Retrieves information about a file. |
103 * @param path File path. | 69 * @param path File path. |
104 * @return File information. | 70 * @return File information. |
105 */ | 71 */ |
106 virtual StatResult Stat(const std::string& path) const = 0; | 72 virtual IFileSystem::StatResult Stat(const std::string& path) const = 0; |
107 | 73 |
108 /** | 74 /** |
109 * Returns the absolute path to a file. | 75 * Returns the absolute path to a file. |
110 * @param path File path (can be relative or absolute). | 76 * @param path File path (can be relative or absolute). |
111 * @return Absolute file path. | 77 * @return Absolute file path. |
112 */ | 78 */ |
113 virtual std::string Resolve(const std::string& path) const = 0; | 79 virtual std::string Resolve(const std::string& path) const = 0; |
114 }; | 80 }; |
115 | 81 |
116 /** | 82 /** |
117 * Shared smart pointer to a `FileSystem` instance. | 83 * Shared smart pointer to a `FileSystem` instance. |
118 */ | 84 */ |
119 typedef std::shared_ptr<FileSystem> FileSystemPtr; | 85 typedef std::shared_ptr<FileSystem> FileSystemSyncPtr; |
120 } | 86 } |
121 | 87 |
122 #endif | 88 #endif |
OLD | NEW |