Chromium Code Reviews| OLD | NEW |
|---|---|
| 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef BASE_FILE_UTIL_PROXY_H_ | 5 #ifndef BASE_FILE_UTIL_PROXY_BASE_H_ |
| 6 #define BASE_FILE_UTIL_PROXY_H_ | 6 #define BASE_FILE_UTIL_PROXY_BASE_H_ |
| 7 | |
| 8 #include <vector> | |
| 9 | 7 |
| 10 #include "base/callback.h" | 8 #include "base/callback.h" |
| 11 #include "base/file_path.h" | 9 #include "base/file_path.h" |
| 12 #include "base/file_util.h" | |
| 13 #include "base/platform_file.h" | 10 #include "base/platform_file.h" |
| 14 #include "base/ref_counted.h" | |
| 15 #include "base/tracked_objects.h" | |
| 16 | 11 |
| 17 namespace base { | 12 namespace base { |
| 18 | 13 |
| 19 class MessageLoopProxy; | 14 class MessageLoopProxy; |
| 20 class Time; | 15 class Time; |
| 21 | 16 |
| 22 // This class provides asynchronous access to common file routines. | 17 class FileUtilProxyBase { |
|
darin (slow to review)
2011/02/11 18:16:10
what's the point of this base class? if the goal
| |
| 23 class FileUtilProxy { | |
| 24 public: | 18 public: |
| 19 | |
| 25 // Holds metadata for file or directory entry. Used by ReadDirectoryCallback. | 20 // Holds metadata for file or directory entry. Used by ReadDirectoryCallback. |
| 26 struct Entry { | 21 struct Entry { |
| 27 FilePath::StringType name; | 22 FilePath::StringType name; |
| 28 bool is_directory; | 23 bool is_directory; |
| 29 }; | 24 }; |
| 30 | 25 |
| 31 // This callback is used by methods that report only an error code. It is | 26 // This callback is used by methods that report only an error code. It is |
| 32 // valid to pass NULL as the callback parameter to any function that takes a | 27 // valid to pass NULL as the callback parameter to any function that takes a |
| 33 // StatusCallback, in which case the operation will complete silently. | 28 // StatusCallback, in which case the operation will complete silently. |
| 34 typedef Callback1<PlatformFileError /* error code */>::Type StatusCallback; | 29 typedef Callback1<PlatformFileError /* error code */>::Type StatusCallback; |
| (...skipping 12 matching lines...) Expand all Loading... | |
| 47 typedef Callback2<PlatformFileError /* error code */, | 42 typedef Callback2<PlatformFileError /* error code */, |
| 48 const std::vector<Entry>&>::Type ReadDirectoryCallback; | 43 const std::vector<Entry>&>::Type ReadDirectoryCallback; |
| 49 typedef Callback2<PlatformFileError /* error code */, | 44 typedef Callback2<PlatformFileError /* error code */, |
| 50 int /* bytes read/written */>::Type ReadWriteCallback; | 45 int /* bytes read/written */>::Type ReadWriteCallback; |
| 51 | 46 |
| 52 // Creates or opens a file with the given flags. It is invalid to pass NULL | 47 // Creates or opens a file with the given flags. It is invalid to pass NULL |
| 53 // for the callback. | 48 // for the callback. |
| 54 // If PLATFORM_FILE_CREATE is set in |file_flags| it always tries to create | 49 // If PLATFORM_FILE_CREATE is set in |file_flags| it always tries to create |
| 55 // a new file at the given |file_path| and calls back with | 50 // a new file at the given |file_path| and calls back with |
| 56 // PLATFORM_FILE_ERROR_FILE_EXISTS if the |file_path| already exists. | 51 // PLATFORM_FILE_ERROR_FILE_EXISTS if the |file_path| already exists. |
| 57 static bool CreateOrOpen(scoped_refptr<MessageLoopProxy> message_loop_proxy, | 52 virtual bool CreateOrOpen( |
| 58 const FilePath& file_path, | 53 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 59 int file_flags, | 54 const FilePath& file_path, |
| 60 CreateOrOpenCallback* callback); | 55 int file_flags, |
| 56 CreateOrOpenCallback* callback) = 0; | |
| 61 | 57 |
| 62 // Creates a temporary file for writing. The path and an open file handle | 58 // Creates a temporary file for writing. The path and an open file handle |
| 63 // are returned. It is invalid to pass NULL for the callback. | 59 // are returned. It is invalid to pass NULL for the callback. |
| 64 static bool CreateTemporary( | 60 virtual bool CreateTemporary( |
| 65 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 61 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 66 CreateTemporaryCallback* callback); | 62 CreateTemporaryCallback* callback) = 0; |
| 67 | 63 |
| 68 // Close the given file handle. | 64 // Close the given file handle. |
| 69 static bool Close(scoped_refptr<MessageLoopProxy> message_loop_proxy, | 65 virtual bool Close( |
| 70 PlatformFile, | 66 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 71 StatusCallback* callback); | 67 PlatformFile, |
| 68 StatusCallback* callback) = 0; | |
| 72 | 69 |
| 73 // Ensures that the given |file_path| exist. This creates a empty new file | 70 // Ensures that the given |file_path| exists. This creates a empty new file |
| 74 // at |file_path| if the |file_path| does not exist. | 71 // at |file_path| if the |file_path| does not exist. |
| 75 // If a new file han not existed and is created at the |file_path|, | 72 // If the file had not existed and is created at the |file_path|, |
| 76 // |created| of the callback argument is set true and |error code| | 73 // |created| of the callback argument is set to true and |error code| |
| 77 // is set PLATFORM_FILE_OK. | 74 // is set to PLATFORM_FILE_OK. |
| 78 // If the file already exists, |created| is set false and |error code| | 75 // If the file already exists, |created| is set to false and |error code| |
| 79 // is set PLATFORM_FILE_OK. | 76 // is set to PLATFORM_FILE_OK. |
| 80 // If the file hasn't existed but it couldn't be created for some other | 77 // If the file hadn't existed but it couldn't be created for any reason, |
| 81 // reasons, |created| is set false and |error code| indicates the error. | 78 // |created| is set to false and |error code| indicates the error. |
| 82 static bool EnsureFileExists( | 79 virtual bool EnsureFileExists( |
| 83 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 80 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 84 const FilePath& file_path, | 81 const FilePath& file_path, |
| 85 EnsureFileExistsCallback* callback); | 82 EnsureFileExistsCallback* callback) = 0; |
| 86 | 83 |
| 87 // Retrieves the information about a file. It is invalid to pass NULL for the | 84 // Retrieves the information about a file. It is invalid to pass NULL for the |
| 88 // callback. | 85 // callback. |
| 89 static bool GetFileInfo( | 86 virtual bool GetFileInfo( |
| 90 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 87 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 91 const FilePath& file_path, | 88 const FilePath& file_path, |
| 92 GetFileInfoCallback* callback); | 89 GetFileInfoCallback* callback) = 0; |
| 93 | 90 |
| 94 static bool GetFileInfoFromPlatformFile( | 91 virtual bool GetFileInfoFromPlatformFile( |
| 95 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 92 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 96 PlatformFile file, | 93 PlatformFile file, |
| 97 GetFileInfoCallback* callback); | 94 GetFileInfoCallback* callback) = 0; |
| 98 | 95 |
| 99 static bool ReadDirectory(scoped_refptr<MessageLoopProxy> message_loop_proxy, | 96 virtual bool ReadDirectory( |
| 100 const FilePath& file_path, | 97 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 101 ReadDirectoryCallback* callback); | 98 const FilePath& file_path, |
| 99 ReadDirectoryCallback* callback) = 0; | |
| 102 | 100 |
| 103 // Creates directory at given path. It's an error to create | 101 // Creates directory at given path. It's an error to create |
| 104 // if |exclusive| is true and dir already exists. | 102 // if |exclusive| is true and dir already exists. |
| 105 static bool CreateDirectory( | 103 virtual bool CreateDirectory( |
| 106 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 104 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 107 const FilePath& file_path, | 105 const FilePath& file_path, |
| 108 bool exclusive, | 106 bool exclusive, |
| 109 bool recursive, | 107 bool recursive, |
| 110 StatusCallback* callback); | 108 StatusCallback* callback) = 0; |
| 111 | 109 |
| 112 // Copies a file or a directory from |src_file_path| to |dest_file_path| | 110 // Copies a file or a directory from |src_file_path| to |dest_file_path| |
| 113 // Error cases: | 111 // Error cases: |
| 114 // If destination file doesn't exist or destination's parent | 112 // If destination file doesn't exist or destination's parent |
| 115 // doesn't exists. | 113 // doesn't exists. |
| 116 // If source dir exists but destination path is an existing file. | 114 // If source dir exists but destination path is an existing file. |
| 117 // If source file exists but destination path is an existing directory. | 115 // If source file exists but destination path is an existing directory. |
| 118 // If source is a parent of destination. | 116 // If source is a parent of destination. |
| 119 // If source doesn't exists. | 117 // If source doesn't exists. |
| 120 static bool Copy(scoped_refptr<MessageLoopProxy> message_loop_proxy, | 118 virtual bool Copy( |
| 121 const FilePath& src_file_path, | 119 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 122 const FilePath& dest_file_path, | 120 const FilePath& src_file_path, |
| 123 StatusCallback* callback); | 121 const FilePath& dest_file_path, |
| 122 StatusCallback* callback) = 0; | |
| 124 | 123 |
| 125 // Moves a file or a directory from src_file_path to dest_file_path. | 124 // Moves a file or a directory from src_file_path to dest_file_path. |
| 126 // Error cases are similar to Copy method's error cases. | 125 // Error cases are similar to Copy method's error cases. |
| 127 static bool Move( | 126 virtual bool Move( |
| 128 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 127 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 129 const FilePath& src_file_path, | 128 const FilePath& src_file_path, |
| 130 const FilePath& dest_file_path, | 129 const FilePath& dest_file_path, |
| 131 StatusCallback* callback); | 130 StatusCallback* callback) = 0; |
| 132 | 131 |
| 133 // Deletes a file or a directory. | 132 // Deletes a file or a directory. |
| 134 // It is an error to delete a non-empty directory with recursive=false. | 133 // It is an error to delete a non-empty directory with recursive=false. |
| 135 static bool Delete(scoped_refptr<MessageLoopProxy> message_loop_proxy, | 134 virtual bool Delete( |
| 136 const FilePath& file_path, | 135 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 137 bool recursive, | 136 const FilePath& file_path, |
| 138 StatusCallback* callback); | 137 bool recursive, |
| 138 StatusCallback* callback) = 0; | |
| 139 | 139 |
| 140 // Deletes a directory and all of its contents. | 140 // Deletes a directory and all of its contents. |
| 141 static bool RecursiveDelete( | 141 virtual bool RecursiveDelete( |
| 142 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 142 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 143 const FilePath& file_path, | 143 const FilePath& file_path, |
| 144 StatusCallback* callback); | 144 StatusCallback* callback) = 0; |
| 145 | 145 |
| 146 // Reads from a file. On success, the file pointer is moved to position | 146 // Reads from a file. On success, the file pointer is moved to position |
| 147 // |offset + bytes_to_read| in the file. The callback can be NULL. | 147 // |offset + bytes_to_read| in the file. The callback can be NULL. |
| 148 static bool Read( | 148 virtual bool Read( |
| 149 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 149 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 150 PlatformFile file, | 150 PlatformFile file, |
| 151 int64 offset, | 151 int64 offset, |
| 152 char* buffer, | 152 char* buffer, |
| 153 int bytes_to_read, | 153 int bytes_to_read, |
| 154 ReadWriteCallback* callback); | 154 ReadWriteCallback* callback) = 0; |
| 155 | 155 |
| 156 // Writes to a file. If |offset| is greater than the length of the file, | 156 // Writes to a file. If |offset| is greater than the length of the file, |
| 157 // |false| is returned. On success, the file pointer is moved to position | 157 // |false| is returned. On success, the file pointer is moved to position |
| 158 // |offset + bytes_to_write| in the file. The callback can be NULL. | 158 // |offset + bytes_to_write| in the file. The callback can be NULL. |
| 159 static bool Write( | 159 virtual bool Write( |
| 160 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 160 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 161 PlatformFile file, | 161 PlatformFile file, |
| 162 int64 offset, | 162 int64 offset, |
| 163 const char* buffer, | 163 const char* buffer, |
| 164 int bytes_to_write, | 164 int bytes_to_write, |
| 165 ReadWriteCallback* callback); | 165 ReadWriteCallback* callback) = 0; |
| 166 | 166 |
| 167 // Touches a file. The callback can be NULL. | 167 // Touches a file. The callback can be NULL. |
| 168 static bool Touch( | 168 virtual bool Touch( |
| 169 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 169 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 170 PlatformFile file, | 170 PlatformFile file, |
| 171 const Time& last_access_time, | 171 const Time& last_access_time, |
| 172 const Time& last_modified_time, | 172 const Time& last_modified_time, |
| 173 StatusCallback* callback); | 173 StatusCallback* callback) = 0; |
| 174 | 174 |
| 175 // Touches a file. The callback can be NULL. | 175 // Touches a file. The callback can be NULL. |
| 176 static bool Touch( | 176 virtual bool Touch( |
| 177 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 177 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 178 const FilePath& file_path, | 178 const FilePath& file_path, |
| 179 const Time& last_access_time, | 179 const Time& last_access_time, |
| 180 const Time& last_modified_time, | 180 const Time& last_modified_time, |
| 181 StatusCallback* callback); | 181 StatusCallback* callback) = 0; |
| 182 | 182 |
| 183 // Truncates a file to the given length. If |length| is greater than the | 183 // Truncates a file to the given length. If |length| is greater than the |
| 184 // current length of the file, the file will be extended with zeroes. | 184 // current length of the file, the file will be extended with zeroes. |
| 185 // The callback can be NULL. | 185 // The callback can be NULL. |
| 186 static bool Truncate( | 186 virtual bool Truncate( |
| 187 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 187 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 188 PlatformFile file, | 188 PlatformFile file, |
| 189 int64 length, | 189 int64 length, |
| 190 StatusCallback* callback); | 190 StatusCallback* callback) = 0; |
| 191 | 191 |
| 192 // Truncates a file to the given length. If |length| is greater than the | 192 // Truncates a file to the given length. If |length| is greater than the |
| 193 // current length of the file, the file will be extended with zeroes. | 193 // current length of the file, the file will be extended with zeroes. |
| 194 // The callback can be NULL. | 194 // The callback can be NULL. |
| 195 static bool Truncate( | 195 virtual bool Truncate( |
| 196 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 196 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 197 const FilePath& path, | 197 const FilePath& path, |
| 198 int64 length, | 198 int64 length, |
| 199 StatusCallback* callback); | 199 StatusCallback* callback) = 0; |
| 200 | 200 |
| 201 // Flushes a file. The callback can be NULL. | 201 // Flushes a file. The callback can be NULL. |
| 202 static bool Flush( | 202 virtual bool Flush( |
| 203 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 203 scoped_refptr<MessageLoopProxy> message_loop_proxy, |
| 204 PlatformFile file, | 204 PlatformFile file, |
| 205 StatusCallback* callback); | 205 StatusCallback* callback) = 0; |
| 206 | 206 protected: |
| 207 private: | 207 FileUtilProxyBase() {} |
| 208 DISALLOW_IMPLICIT_CONSTRUCTORS(FileUtilProxy); | 208 DISALLOW_COPY_AND_ASSIGN(FileUtilProxyBase); |
| 209 }; | 209 }; |
| 210 | 210 |
| 211 } // namespace base | 211 } // namespace base |
| 212 | 212 |
| 213 #endif // BASE_FILE_UTIL_PROXY_H_ | 213 #endif // BASE_FILE_UTIL_PROXY_BASE_H_ |
| OLD | NEW |