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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
|
/*
* Copyright (C) 2020 Linux Studio Plugins Project <https://lsp-plug.in/>
* (C) 2020 Vladimir Sadovnikov <sadko4u@gmail.com>
*
* This file is part of lsp-runtime-lib
* Created on: 6 мар. 2019 г.
*
* lsp-runtime-lib is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* lsp-runtime-lib is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with lsp-runtime-lib. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef LSP_PLUG_IN_IO_FILE_H_
#define LSP_PLUG_IN_IO_FILE_H_
#include <lsp-plug.in/runtime/version.h>
#include <lsp-plug.in/common/types.h>
#include <lsp-plug.in/common/status.h>
#include <lsp-plug.in/runtime/LSPString.h>
#include <lsp-plug.in/io/Path.h>
#include <lsp-plug.in/stdlib/stdio.h>
#define IO_FILE_DEFAULT_BUF_SIZE 0x1000
namespace lsp
{
namespace io
{
/**
* Binary file interface, allows to perform read/write access
* to the file on local file system
*/
class File
{
public:
enum seek_t {
FSK_SET,
FSK_CUR,
FSK_END
};
enum mode_t {
FM_READ = 1 << 0, // Open for reading
FM_WRITE = 1 << 1, // Open for writing
FM_CREATE = 1 << 2, // Create file if not exists
FM_TRUNC = 1 << 3, // Truncate file
FM_DIRECT = 1 << 4, // Do not use buffered input/output if possible
FM_READWRITE = FM_READ | FM_WRITE,
FM_WRITE_NEW = FM_CREATE | FM_WRITE | FM_TRUNC,
FM_READWRITE_NEW = FM_CREATE | FM_READ | FM_WRITE | FM_TRUNC
};
protected:
status_t nErrorCode;
protected:
inline status_t set_error(status_t error) { return nErrorCode = error; }
private:
File & operator = (const File &); // Deny copying
public:
explicit File();
virtual ~File();
public:
/**
* Read binary file
* @param dst target buffer to perform read
* @param count amount of bytes to read
* @return number of bytes read or negative status of operation,
* on end of file -STATUS_EOF is returned
*/
virtual ssize_t read(void *dst, size_t count);
/**
* Perform positioned read of binary file
* @param pos offset in bytes relative to the beginning of the file
* @param dst target buffer to perform read
* @param count amount of bytes to read
* @return number of bytes read or status of operation
*/
virtual ssize_t pread(wsize_t pos, void *dst, size_t count);
/**
* Write binary file.
* The implementation should write the most possible amount
* of bytes before exit. Such behaviour will simplify the caller's
* implementation.
* @param dst source buffer to perform write
* @param count number of bytes to write
* @return status of operation
*/
virtual ssize_t write(const void *src, size_t count);
/**
* Perform positioned write of binary file
* @param pos offset in bytes relative to the beginning of the file
* @param dst source buffer to perform write
* @param count number of bytes to write
* @return status of operation
*/
virtual ssize_t pwrite(wsize_t pos, const void *src, size_t count);
/**
* Perform seek to the specified position
* @param pos position to perform seek
* @param type seek type
* @return status of operation
*/
virtual status_t seek(wssize_t pos, size_t type);
/**
* Obtain current file's position
* @return current file's position or negative error code
*/
virtual wssize_t position();
/**
* Obtain current file's size
* @return current file's size or negative error code
*/
virtual wssize_t size();
/**
* Get file attributes
* @param attr file attributes
* @return
*/
virtual status_t stat(fattr_t *attr);
/**
* Truncate the file
* @param length the final file length
* @return status of operation
*/
virtual status_t truncate(wsize_t length);
/**
* Return last error code
* @return last error code
*/
inline status_t last_error() const { return nErrorCode; };
/**
* Return true if last read operations reached end of file
* @return true if last read operations reached end of file
*/
inline bool eof() const { return nErrorCode == STATUS_EOF; };
/**
* Flush usespace file buffer
* @return status of operation
*/
virtual status_t flush();
/**
* Sync file with the underlying storage
* @return status of operation
*/
virtual status_t sync();
/**
* Close file
* @return status of operation
*/
virtual status_t close();
public:
/**
* Obtain file information. If the file is symbolic link,
* return information about the symbolic link
* @param path UTF-8 encoded path to file
* @param attr structure to return file attributes
* @return status of operation
*/
static status_t stat(const char *path, fattr_t *attr);
/**
* Obtain file information. If the file is symbolic link,
* return information about the symbolic link
* @param path path to file
* @param attr structure to return file attributes
* @return status of operation
*/
static status_t stat(const LSPString *path, fattr_t *attr);
/**
* Obtain file information. If the file is symbolic link,
* return information about the symbolic link
* @param path path to file
* @param attr structure to return file attributes
* @return status of operation
*/
static status_t stat(const Path *path, fattr_t *attr);
/**
* Obtain file information
* @param fd native file descriptor
* @param attr structure to return file attributes
* @return status of operation
*/
static status_t stat(fhandle_t fd, fattr_t *attr);
/**
* Obtain file information
* @param fd stdio file descriptor
* @param attr structure to return file attributes
* @return status of operation
*/
static status_t stat(FILE *fd, fattr_t *attr);
/**
* Obtain file information. If the file is symbolic link,
* return information about the file the link refers to
* @param path UTF-8 encoded path to file
* @param attr structure to return file attributes
* @return status of operation
*/
static status_t sym_stat(const char *path, fattr_t *attr);
/**
* Obtain file information. If the file is symbolic link,
* return information about the file the link refers to
* @param path path to file
* @param attr structure to return file attributes
* @return status of operation
*/
static status_t sym_stat(const LSPString *path, fattr_t *attr);
/**
* Obtain file information. If the file is symbolic link,
* return information about the file the link refers to
* @param path path to file
* @param attr structure to return file attributes
* @return status of operation
*/
static status_t sym_stat(const Path *path, fattr_t *attr);
/**
* Delete file
* @param path path to file
* @return status of operation
*/
static status_t remove(const char *path);
/**
* Delete file
* @param path path to file
* @return status of operation
*/
static status_t remove(const LSPString *path);
/**
* Delete file
* @param path path to file
* @return status of operation
*/
static status_t remove(const Path *path);
/**
* Rename the file. If the destination file exists, it will be replaced
*
* @param from source name
* @param to destination name
* @return status of operation
*/
static status_t rename(const char *from, const char *to);
static status_t rename(const LSPString *from, const char *to);
static status_t rename(const Path *from, const char *to);
static status_t rename(const char *from, const LSPString *to);
static status_t rename(const LSPString *from, const LSPString *to);
static status_t rename(const Path *from, const LSPString *to);
static status_t rename(const char *from, const Path *to);
static status_t rename(const LSPString *from, const Path *to);
static status_t rename(const Path *from, const Path *to);
/**
* Copy the file.
* @param from source file path
* @param to destination file path
* @param io_buf_size the size of the IO buffer
* @return number of bytes copied or negative error code
*/
static wssize_t copy(const char *from, const char *to, size_t io_buf_size = IO_FILE_DEFAULT_BUF_SIZE);
static wssize_t copy(const LSPString *from, const char *to, size_t io_buf_size = IO_FILE_DEFAULT_BUF_SIZE);
static wssize_t copy(const Path *from, const char *to, size_t io_buf_size = IO_FILE_DEFAULT_BUF_SIZE);
static wssize_t copy(const char *from, const LSPString *to, size_t io_buf_size = IO_FILE_DEFAULT_BUF_SIZE);
static wssize_t copy(const LSPString *from, const LSPString *to, size_t io_buf_size = IO_FILE_DEFAULT_BUF_SIZE);
static wssize_t copy(const Path *from, const LSPString *to, size_t io_buf_size = IO_FILE_DEFAULT_BUF_SIZE);
static wssize_t copy(const char *from, const Path *to, size_t io_buf_size = IO_FILE_DEFAULT_BUF_SIZE);
static wssize_t copy(const LSPString *from, const Path *to, size_t io_buf_size = IO_FILE_DEFAULT_BUF_SIZE);
static wssize_t copy(const Path *from, const Path *to, size_t io_buf_size = IO_FILE_DEFAULT_BUF_SIZE);
/**
* Create parent directory
* @param path path to the directory
* @return status of operation
*/
static status_t mkparent(const char *path);
static status_t mkparent(const LSPString *path);
static status_t mkparent(const io::Path *path);
static status_t mkparent(const char *path, bool recursive);
static status_t mkparent(const LSPString *path, bool recursive);
static status_t mkparent(const io::Path *path, bool recursive);
};
} /* namespace io */
} /* namespace lsp */
#endif /* LSP_PLUG_IN_IO_FILE_H_ */
|
