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
|
/*
* 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_STDIOFILE_H_
#define LSP_PLUG_IN_IO_STDIOFILE_H_
#include <lsp-plug.in/runtime/version.h>
#include <lsp-plug.in/io/File.h>
#include <lsp-plug.in/io/Path.h>
#include <lsp-plug.in/common/types.h>
#include <lsp-plug.in/stdlib/stdio.h>
namespace lsp
{
namespace io
{
/**
* This class provides file interface that uses <stdio.h> file functions
* at the backend for file operations. Also this class allows to
* wrap standard FILE * pointer into an object instance.
*/
class StdioFile: public File
{
private:
enum flags_t
{
SF_READ = 1 << 0,
SF_WRITE = 1 << 1,
SF_CLOSE = 1 << 2
};
protected:
FILE *pFD;
size_t nFlags;
private:
StdioFile &operator = (const StdioFile &fd); // Deny copying
public:
explicit StdioFile();
virtual ~StdioFile();
public:
/**
* Open file
* @param path file location
* @param mode open mode
* @return status of operation
*/
status_t open(const char *path, size_t mode);
/**
* Open file
* @param path file location
* @param mode open mode
* @return status of operation
*/
status_t open(const LSPString *path, size_t mode);
/**
* Open file
* @param path file location
* @param mode open mode
* @return status of operation
*/
status_t open(const Path *path, size_t mode);
/**
* Wrap the standard file descriptor and allow both read
* and write operations
* @param fd file descriptor to wrap
* @param close close the file descriptor on close() call
* @return status of operation
*/
status_t wrap(FILE *fd, bool close);
/**
* Wrap the standard file descriptor
* @param fd file descriptor to wrap
* @param mode allowed access modes (read, write or both)
* @param close close the file descriptor on close() call
* @return status of operation
*/
status_t wrap(FILE *fd, size_t mode, bool close);
/**
* 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
* @param dst source buffer to perform write
* @param count number of bytes to write
* @return number of bytes written or negative 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);
/**
* Flush file buffer to underlying storage
* @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();
};
} /* namespace io */
} /* namespace lsp */
#endif /* LSP_PLUG_IN_IO_STDIOFILE_H_ */
|
