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