Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(29)

Side by Side Diff: base/file_util_proxy.h

Issue 6286038: Add initial code to do filename munging in the FileSystem.... (Closed) Base URL: svn://chrome-svn/chrome/trunk/src/
Patch Set: '' Created 9 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
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_H_
6 #define BASE_FILE_UTIL_PROXY_H_ 6 #define BASE_FILE_UTIL_PROXY_H_
7 7
8 #include <vector> 8 #include <vector>
9 9
10 #include "base/callback.h" 10 #include "base/callback.h"
11 #include "base/file_path.h" 11 #include "base/file_path.h"
12 #include "base/file_util.h" 12 #include "base/file_util.h"
13 #include "base/file_util_proxy_base.h"
13 #include "base/platform_file.h" 14 #include "base/platform_file.h"
14 #include "base/ref_counted.h" 15 #include "base/ref_counted.h"
16 #include "base/singleton.h"
15 #include "base/tracked_objects.h" 17 #include "base/tracked_objects.h"
16 18
17 namespace base { 19 namespace base {
18 20
19 class MessageLoopProxy; 21 class MessageLoopProxy;
20 class Time; 22 class Time;
21 23
22 // This class provides asynchronous access to common file routines. 24 // This class provides asynchronous access to common file routines.
23 class FileUtilProxy { 25 class FileUtilProxy : public FileUtilProxyBase {
24 public: 26 public:
25 // Holds metadata for file or directory entry. Used by ReadDirectoryCallback. 27 static FileUtilProxy* GetInstance(); // Always call through this singleton
26 struct Entry { 28 virtual ~FileUtilProxy() {}
27 FilePath::StringType name;
28 bool is_directory;
29 };
30
31 // 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
33 // StatusCallback, in which case the operation will complete silently.
34 typedef Callback1<PlatformFileError /* error code */>::Type StatusCallback;
35
36 typedef Callback3<PlatformFileError /* error code */,
37 PassPlatformFile,
38 bool /* created */>::Type CreateOrOpenCallback;
39 typedef Callback3<PlatformFileError /* error code */,
40 PassPlatformFile,
41 FilePath>::Type CreateTemporaryCallback;
42 typedef Callback2<PlatformFileError /* error code */,
43 bool /* created */>::Type EnsureFileExistsCallback;
44 typedef Callback2<PlatformFileError /* error code */,
45 const PlatformFileInfo& /* file_info */
46 >::Type GetFileInfoCallback;
47 typedef Callback2<PlatformFileError /* error code */,
48 const std::vector<Entry>&>::Type ReadDirectoryCallback;
49 typedef Callback2<PlatformFileError /* error code */,
50 int /* bytes read/written */>::Type ReadWriteCallback;
51 29
52 // Creates or opens a file with the given flags. It is invalid to pass NULL 30 // Creates or opens a file with the given flags. It is invalid to pass NULL
53 // for the callback. 31 // for the callback.
54 // If PLATFORM_FILE_CREATE is set in |file_flags| it always tries to create 32 // 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 33 // a new file at the given |file_path| and calls back with
56 // PLATFORM_FILE_ERROR_FILE_EXISTS if the |file_path| already exists. 34 // PLATFORM_FILE_ERROR_FILE_EXISTS if the |file_path| already exists.
57 static bool CreateOrOpen(scoped_refptr<MessageLoopProxy> message_loop_proxy, 35 bool CreateOrOpen(scoped_refptr<MessageLoopProxy> message_loop_proxy,
58 const FilePath& file_path, 36 const FilePath& file_path,
59 int file_flags, 37 int file_flags,
60 CreateOrOpenCallback* callback); 38 CreateOrOpenCallback* callback);
61 39
62 // Creates a temporary file for writing. The path and an open file handle 40 // 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. 41 // are returned. It is invalid to pass NULL for the callback.
64 static bool CreateTemporary( 42 bool CreateTemporary(
65 scoped_refptr<MessageLoopProxy> message_loop_proxy, 43 scoped_refptr<MessageLoopProxy> message_loop_proxy,
66 CreateTemporaryCallback* callback); 44 CreateTemporaryCallback* callback);
67 45
68 // Close the given file handle. 46 // Close the given file handle.
69 static bool Close(scoped_refptr<MessageLoopProxy> message_loop_proxy, 47 bool Close(scoped_refptr<MessageLoopProxy> message_loop_proxy,
70 PlatformFile, 48 PlatformFile,
71 StatusCallback* callback); 49 StatusCallback* callback);
72 50
73 // Ensures that the given |file_path| exist. This creates a empty new file 51 // Ensures that the given |file_path| exists. This creates a empty new file
74 // at |file_path| if the |file_path| does not exist. 52 // 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|, 53 // 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| 54 // |created| of the callback argument is set to true and |error code|
77 // is set PLATFORM_FILE_OK. 55 // is set to PLATFORM_FILE_OK.
78 // If the file already exists, |created| is set false and |error code| 56 // If the file already exists, |created| is set to false and |error code|
79 // is set PLATFORM_FILE_OK. 57 // is set to PLATFORM_FILE_OK.
80 // If the file hasn't existed but it couldn't be created for some other 58 // 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. 59 // |created| is set to false and |error code| indicates the error.
82 static bool EnsureFileExists( 60 bool EnsureFileExists(
83 scoped_refptr<MessageLoopProxy> message_loop_proxy, 61 scoped_refptr<MessageLoopProxy> message_loop_proxy,
84 const FilePath& file_path, 62 const FilePath& file_path,
85 EnsureFileExistsCallback* callback); 63 EnsureFileExistsCallback* callback);
86 64
87 // Retrieves the information about a file. It is invalid to pass NULL for the 65 // Retrieves the information about a file. It is invalid to pass NULL for the
88 // callback. 66 // callback.
89 static bool GetFileInfo( 67 bool GetFileInfo(
90 scoped_refptr<MessageLoopProxy> message_loop_proxy, 68 scoped_refptr<MessageLoopProxy> message_loop_proxy,
91 const FilePath& file_path, 69 const FilePath& file_path,
92 GetFileInfoCallback* callback); 70 GetFileInfoCallback* callback);
93 71
94 static bool GetFileInfoFromPlatformFile( 72 bool GetFileInfoFromPlatformFile(
95 scoped_refptr<MessageLoopProxy> message_loop_proxy, 73 scoped_refptr<MessageLoopProxy> message_loop_proxy,
96 PlatformFile file, 74 PlatformFile file,
97 GetFileInfoCallback* callback); 75 GetFileInfoCallback* callback);
98 76
99 static bool ReadDirectory(scoped_refptr<MessageLoopProxy> message_loop_proxy, 77 bool ReadDirectory(scoped_refptr<MessageLoopProxy> message_loop_proxy,
100 const FilePath& file_path, 78 const FilePath& file_path,
101 ReadDirectoryCallback* callback); 79 ReadDirectoryCallback* callback);
102 80
103 // Creates directory at given path. It's an error to create 81 // Creates directory at given path. It's an error to create
104 // if |exclusive| is true and dir already exists. 82 // if |exclusive| is true and dir already exists.
105 static bool CreateDirectory( 83 bool CreateDirectory(
106 scoped_refptr<MessageLoopProxy> message_loop_proxy, 84 scoped_refptr<MessageLoopProxy> message_loop_proxy,
107 const FilePath& file_path, 85 const FilePath& file_path,
108 bool exclusive, 86 bool exclusive,
109 bool recursive, 87 bool recursive,
110 StatusCallback* callback); 88 StatusCallback* callback);
111 89
112 // Copies a file or a directory from |src_file_path| to |dest_file_path| 90 // Copies a file or a directory from |src_file_path| to |dest_file_path|
113 // Error cases: 91 // Error cases:
114 // If destination file doesn't exist or destination's parent 92 // If destination file doesn't exist or destination's parent
115 // doesn't exists. 93 // doesn't exists.
116 // If source dir exists but destination path is an existing file. 94 // If source dir exists but destination path is an existing file.
117 // If source file exists but destination path is an existing directory. 95 // If source file exists but destination path is an existing directory.
118 // If source is a parent of destination. 96 // If source is a parent of destination.
119 // If source doesn't exists. 97 // If source doesn't exists.
120 static bool Copy(scoped_refptr<MessageLoopProxy> message_loop_proxy, 98 bool Copy(scoped_refptr<MessageLoopProxy> message_loop_proxy,
121 const FilePath& src_file_path, 99 const FilePath& src_file_path,
122 const FilePath& dest_file_path, 100 const FilePath& dest_file_path,
123 StatusCallback* callback); 101 StatusCallback* callback);
124 102
125 // Moves a file or a directory from src_file_path to dest_file_path. 103 // 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. 104 // Error cases are similar to Copy method's error cases.
127 static bool Move( 105 bool Move(
128 scoped_refptr<MessageLoopProxy> message_loop_proxy, 106 scoped_refptr<MessageLoopProxy> message_loop_proxy,
129 const FilePath& src_file_path, 107 const FilePath& src_file_path,
130 const FilePath& dest_file_path, 108 const FilePath& dest_file_path,
131 StatusCallback* callback); 109 StatusCallback* callback);
132 110
133 // Deletes a file or a directory. 111 // Deletes a file or a directory.
134 // It is an error to delete a non-empty directory with recursive=false. 112 // It is an error to delete a non-empty directory with recursive=false.
135 static bool Delete(scoped_refptr<MessageLoopProxy> message_loop_proxy, 113 bool Delete(scoped_refptr<MessageLoopProxy> message_loop_proxy,
136 const FilePath& file_path, 114 const FilePath& file_path,
137 bool recursive, 115 bool recursive,
138 StatusCallback* callback); 116 StatusCallback* callback);
139 117
140 // Deletes a directory and all of its contents. 118 // Deletes a directory and all of its contents.
141 static bool RecursiveDelete( 119 bool RecursiveDelete(
142 scoped_refptr<MessageLoopProxy> message_loop_proxy, 120 scoped_refptr<MessageLoopProxy> message_loop_proxy,
143 const FilePath& file_path, 121 const FilePath& file_path,
144 StatusCallback* callback); 122 StatusCallback* callback);
145 123
146 // Reads from a file. On success, the file pointer is moved to position 124 // 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. 125 // |offset + bytes_to_read| in the file. The callback can be NULL.
148 static bool Read( 126 bool Read(
149 scoped_refptr<MessageLoopProxy> message_loop_proxy, 127 scoped_refptr<MessageLoopProxy> message_loop_proxy,
150 PlatformFile file, 128 PlatformFile file,
151 int64 offset, 129 int64 offset,
152 char* buffer, 130 char* buffer,
153 int bytes_to_read, 131 int bytes_to_read,
154 ReadWriteCallback* callback); 132 ReadWriteCallback* callback);
155 133
156 // Writes to a file. If |offset| is greater than the length of the file, 134 // 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 135 // |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. 136 // |offset + bytes_to_write| in the file. The callback can be NULL.
159 static bool Write( 137 bool Write(
160 scoped_refptr<MessageLoopProxy> message_loop_proxy, 138 scoped_refptr<MessageLoopProxy> message_loop_proxy,
161 PlatformFile file, 139 PlatformFile file,
162 int64 offset, 140 int64 offset,
163 const char* buffer, 141 const char* buffer,
164 int bytes_to_write, 142 int bytes_to_write,
165 ReadWriteCallback* callback); 143 ReadWriteCallback* callback);
166 144
167 // Touches a file. The callback can be NULL. 145 // Touches a file. The callback can be NULL.
168 static bool Touch( 146 bool Touch(
169 scoped_refptr<MessageLoopProxy> message_loop_proxy, 147 scoped_refptr<MessageLoopProxy> message_loop_proxy,
170 PlatformFile file, 148 PlatformFile file,
171 const Time& last_access_time, 149 const Time& last_access_time,
172 const Time& last_modified_time, 150 const Time& last_modified_time,
173 StatusCallback* callback); 151 StatusCallback* callback);
174 152
175 // Touches a file. The callback can be NULL. 153 // Touches a file. The callback can be NULL.
176 static bool Touch( 154 bool Touch(
177 scoped_refptr<MessageLoopProxy> message_loop_proxy, 155 scoped_refptr<MessageLoopProxy> message_loop_proxy,
178 const FilePath& file_path, 156 const FilePath& file_path,
179 const Time& last_access_time, 157 const Time& last_access_time,
180 const Time& last_modified_time, 158 const Time& last_modified_time,
181 StatusCallback* callback); 159 StatusCallback* callback);
182 160
183 // Truncates a file to the given length. If |length| is greater than the 161 // 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. 162 // current length of the file, the file will be extended with zeroes.
185 // The callback can be NULL. 163 // The callback can be NULL.
186 static bool Truncate( 164 bool Truncate(
187 scoped_refptr<MessageLoopProxy> message_loop_proxy, 165 scoped_refptr<MessageLoopProxy> message_loop_proxy,
188 PlatformFile file, 166 PlatformFile file,
189 int64 length, 167 int64 length,
190 StatusCallback* callback); 168 StatusCallback* callback);
191 169
192 // Truncates a file to the given length. If |length| is greater than the 170 // 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. 171 // current length of the file, the file will be extended with zeroes.
194 // The callback can be NULL. 172 // The callback can be NULL.
195 static bool Truncate( 173 bool Truncate(
196 scoped_refptr<MessageLoopProxy> message_loop_proxy, 174 scoped_refptr<MessageLoopProxy> message_loop_proxy,
197 const FilePath& path, 175 const FilePath& path,
198 int64 length, 176 int64 length,
199 StatusCallback* callback); 177 StatusCallback* callback);
200 178
201 // Flushes a file. The callback can be NULL. 179 // Flushes a file. The callback can be NULL.
202 static bool Flush( 180 bool Flush(
203 scoped_refptr<MessageLoopProxy> message_loop_proxy, 181 scoped_refptr<MessageLoopProxy> message_loop_proxy,
204 PlatformFile file, 182 PlatformFile file,
205 StatusCallback* callback); 183 StatusCallback* callback);
206 184
185 protected:
186 FileUtilProxy() {}
187
207 private: 188 private:
208 DISALLOW_IMPLICIT_CONSTRUCTORS(FileUtilProxy); 189 friend struct DefaultSingletonTraits<FileUtilProxy>;
190 DISALLOW_COPY_AND_ASSIGN(FileUtilProxy);
209 }; 191 };
210 192
211 } // namespace base 193 } // namespace base
212 194
213 #endif // BASE_FILE_UTIL_PROXY_H_ 195 #endif // BASE_FILE_UTIL_PROXY_H_
OLDNEW
« no previous file with comments | « base/base.gypi ('k') | base/file_util_proxy.cc » ('j') | base/file_util_proxy_base.h » ('J')

Powered by Google App Engine
This is Rietveld 408576698