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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
use std::convert::AsRef;
use std::ffi::CString;
use std::io;
use std::mem;
use std::path::Path;
use std::str;
use foreign_types::{foreign_type, ForeignType, ForeignTypeRef};
cfg_if! {
if #[cfg(unix)] {
use std::os::unix::ffi::OsStrExt;
use std::os::unix::io::{AsRawFd, IntoRawFd, RawFd};
} else {
use std::os::windows::io::{AsRawHandle, IntoRawHandle, RawHandle};
}
}
macro_rules! cstr {
($s:expr) => {
CString::new($s)?.as_ptr() as *const i8
};
}
foreign_type! {
/// A reference to an open stream on the filesystem.
///
/// An instance of a `CFile` can be read and/or written depending on what modes it was opened with.
/// `CFile` also implement `Seek` to alter the logical cursor that the file contains internally.
///
pub unsafe type CFile: Send {
type CType = libc::FILE;
fn drop = libc::fclose;
}
}
cfg_if! {
if #[cfg(unix)] {
impl AsRawFd for CFileRef {
fn as_raw_fd(&self) -> RawFd {
unsafe { libc::fileno(self.as_ptr()) }
}
}
impl IntoRawFd for CFile {
fn into_raw_fd(self) -> RawFd {
let fd = self.as_raw_fd();
mem::forget(self);
fd
}
}
} else {
impl AsRawHandle for CFileRef {
fn as_raw_handle(&self) -> RawHandle {
unsafe { libc::get_osfhandle(libc::fileno(self.as_ptr())) as RawHandle }
}
}
impl IntoRawHandle for CFile {
fn into_raw_handle(self) -> RawHandle {
let handle = self.as_raw_handle();
mem::forget(self);
handle
}
}
}
}
impl CFileRef {
/// opens the file whose name is the string pointed to by `filename`
/// and associates the stream pointed to by stream with it.
///
/// The original stream (if it exists) is closed.
/// The mode argument is used just as in the `open()` function.
///
pub fn reopen(&self, filename: &str, mode: &str) -> io::Result<CFile> {
unsafe {
let p = libc::freopen(cstr!(filename), cstr!(mode), self.as_ptr());
if p.is_null() {
Err(io::Error::last_os_error())
} else {
Ok(CFile::from_ptr(p))
}
}
}
}
cfg_if! {
if #[cfg(unix)] {
/// opens the file whose name is the string pointed to by filename
/// and associates a stream with it.
///
/// The argument mode points to a string beginning with one of the following
/// sequences (Additional characters may follow these sequences.)
///
/// ## Modes
///
/// * `r` Open text file for reading. The stream is positioned at the
/// beginning of the file.
///
/// * `r+` Open for reading and writing. The stream is positioned at the
/// beginning of the file.
///
/// * `w` Truncate to zero length or create text file for writing. The
/// stream is positioned at the beginning of the file.
///
/// * `w+` Open for reading and writing. The file is created if it does not
/// exist, otherwise it is truncated. The stream is positioned at
/// the beginning of the file.
///
/// * `a` Open for writing. The file is created if it does not exist. The
/// stream is positioned at the end of the file. Subsequent writes
/// to the file will always end up at the then current end of file,
/// irrespective of any intervening fseek(3) or similar.
///
/// * `a+` Open for reading and writing. The file is created if it does not
/// exist. The stream is positioned at the end of the file. Subse-
/// quent writes to the file will always end up at the then current
/// end of file, irrespective of any intervening fseek(3) or similar.
///
/// The mode string can also include the letter `b` either as last charac-
/// ter or as a character between the characters in any of the two-character
/// strings described above. This is strictly for compatibility with ISO/IEC
/// 9899:1990 (ISO C90) and has no effect; the `b` is ignored.
///
pub fn open<P: AsRef<Path>>(path: P, mode: &str) -> io::Result<CFile> {
unsafe {
let p = libc::fopen(
cstr!(path.as_ref().as_os_str().as_bytes()),
cstr!(mode),
);
if p.is_null() {
Err(io::Error::last_os_error())
} else {
Ok(CFile::from_ptr(p))
}
}
}
} else {
/// opens the file whose name is the string pointed to by filename
/// and associates a stream with it.
///
/// The argument mode points to a string beginning with one of the following
/// sequences (Additional characters may follow these sequences.)
///
/// ## Modes
///
/// * `r` Open text file for reading. The stream is positioned at the
/// beginning of the file.
///
/// * `r+` Open for reading and writing. The stream is positioned at the
/// beginning of the file.
///
/// * `w` Truncate to zero length or create text file for writing. The
/// stream is positioned at the beginning of the file.
///
/// * `w+` Open for reading and writing. The file is created if it does not
/// exist, otherwise it is truncated. The stream is positioned at
/// the beginning of the file.
///
/// * `a` Open for writing. The file is created if it does not exist. The
/// stream is positioned at the end of the file. Subsequent writes
/// to the file will always end up at the then current end of file,
/// irrespective of any intervening fseek(3) or similar.
///
/// * `a+` Open for reading and writing. The file is created if it does not
/// exist. The stream is positioned at the end of the file. Subse-
/// quent writes to the file will always end up at the then current
/// end of file, irrespective of any intervening fseek(3) or similar.
///
/// The mode string can also include the letter `b` either as last charac-
/// ter or as a character between the characters in any of the two-character
/// strings described above. This is strictly for compatibility with ISO/IEC
/// 9899:1990 (ISO C90) and has no effect; the `b` is ignored.
///
pub fn open<P: AsRef<Path>>(path: P, mode: &str) -> io::Result<CFile> {
let filename = path.as_ref().to_string_lossy().to_string();
unsafe {
let p = libc::fopen(
cstr!(filename),
cstr!(mode),
);
if p.is_null() {
Err(io::Error::last_os_error())
} else {
Ok(CFile::from_ptr(p))
}
}
}
}
}
cfg_if! {
if #[cfg(unix)] {
/// open stdin as a read only stream
///
/// ```
/// use std::os::unix::io::AsRawFd;
///
/// let stdin = cfile::stdin().unwrap();
///
/// assert_eq!(stdin.as_raw_fd(), libc::STDIN_FILENO);
/// ```
pub fn stdin() -> io::Result<&'static CFileRef> {
CFileRef::fdopen(libc::STDIN_FILENO, "r")
}
/// open stdout as a write only stream
pub fn stdout() -> io::Result<&'static CFileRef> {
CFileRef::fdopen(libc::STDOUT_FILENO, "w")
}
/// open stderr as a write only stream
pub fn stderr() -> io::Result<&'static CFileRef> {
CFileRef::fdopen(libc::STDERR_FILENO, "w")
}
} else {
use winapi::um::processenv::GetStdHandle;
use winapi::um::handleapi::INVALID_HANDLE_VALUE;
use winapi::um::winbase::{STD_INPUT_HANDLE, STD_OUTPUT_HANDLE, STD_ERROR_HANDLE};
/// open stdin as a read only stream
pub fn stdin() -> io::Result<&'static CFileRef> {
let h = unsafe { GetStdHandle(STD_INPUT_HANDLE) };
if h == INVALID_HANDLE_VALUE {
Err(io::Error::last_os_error())
} else {
CFileRef::fdopen(h as *mut _, "r")
}
}
/// open stdout as a write only stream
pub fn stdout() -> io::Result<&'static CFileRef> {
let h = unsafe { GetStdHandle(STD_OUTPUT_HANDLE) };
if h == INVALID_HANDLE_VALUE {
Err(io::Error::last_os_error())
} else {
CFileRef::fdopen(h as *mut _, "w")
}
}
/// open stderr as a write only stream
pub fn stderr() -> io::Result<&'static CFileRef> {
let h = unsafe { GetStdHandle(STD_ERROR_HANDLE) };
if h == INVALID_HANDLE_VALUE {
Err(io::Error::last_os_error())
} else {
CFileRef::fdopen(h as *mut _, "w")
}
}
}
}
/// open a temporary file as a read/write stream
pub fn tmpfile() -> io::Result<CFile> {
unsafe {
let p = libc::tmpfile();
if p.is_null() {
Err(io::Error::last_os_error())
} else {
Ok(CFile::from_ptr(p))
}
}
}
cfg_if! {
if #[cfg(unix)] {
/// associates a stream with the existing file descriptor.
///
/// The mode of the stream must be compatible with the mode of the file descriptor.
///
pub fn fdopen<S: AsRawFd>(s: &S, mode: &str) -> io::Result<CFile> {
CFile::fdopen(s.as_raw_fd(), mode)
}
} else {
/// associates a stream with the existing file descriptor.
///
/// The mode of the stream must be compatible with the mode of the file descriptor.
///
pub fn fdopen<S: AsRawHandle>(s: &S, mode: &str) -> io::Result<CFile> {
CFile::fdopen(s.as_raw_handle(), mode)
}
}
}
cfg_if! {
if #[cfg(unix)] {
impl CFileRef {
pub fn fdopen<S: AsRef<str>>(fd: RawFd, mode: S) -> io::Result<&'static CFileRef> {
unsafe {
let p = libc::fdopen(fd, cstr!(mode.as_ref()));
if p.is_null() {
Err(io::Error::last_os_error())
} else {
Ok(Self::from_ptr(p))
}
}
}
}
impl CFile {
pub fn fdopen<S: AsRef<str>>(fd: RawFd, mode: S) -> io::Result<CFile> {
CFileRef::fdopen(fd, mode).map(|f| unsafe { Self::from_ptr(f.as_ptr()) })
}
}
} else {
impl CFileRef {
pub fn fdopen<S: AsRef<str>>(handle: RawHandle, mode: S) -> io::Result<&'static CFileRef> {
unsafe {
let mode = mode.as_ref();
let flags = if mode == "r" { libc::O_RDONLY } else {0};
let fd = libc::open_osfhandle(handle as isize, flags);
if fd == -1 {
Err(io::Error::last_os_error())
} else {
let p = libc::fdopen(fd, cstr!(mode));
if p.is_null() {
Err(io::Error::last_os_error())
} else {
Ok(Self::from_ptr(p))
}
}
}
}
}
impl CFile {
pub fn fdopen<S: AsRef<str>>(handle: RawHandle, mode: S) -> io::Result<CFile> {
CFileRef::fdopen(handle, mode).map(|f| unsafe { Self::from_ptr(f.as_ptr()) })
}
}
}
}
#[cfg(test)]
mod tests {
use std::io::{prelude::*, SeekFrom};
use super::*;
use crate::stream::Stream;
#[test]
fn test_cfile() {
let mut f = tmpfile().unwrap();
assert_eq!(f.write(b"test").unwrap(), 4);
assert_eq!(f.seek(SeekFrom::Current(0)).unwrap(), 4);
let mut buf: [u8; 4] = [0; 4];
assert_eq!(f.read(&mut buf[..]).unwrap(), 0);
assert_eq!(f.seek(SeekFrom::Start(0)).unwrap(), 0);
f.flush().unwrap();
assert_eq!(f.read(&mut buf[..]).unwrap(), 4);
assert_eq!(buf, &b"test"[..]);
let filename = f.file_name().unwrap();
println!("{:?}", filename);
assert!(filename.parent().unwrap().is_dir());
}
}