file.c 8.95 KB
Newer Older
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
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

27
#include <stdio.h>
28
29
30
#include <unistd.h>
#include <fcntl.h>
#include <errno.h>
xbe's avatar
xbe committed
31
32
#include <sys/stat.h>
#include <sys/types.h>
33

34
#include "mpconfig.h"
35
36
#include "nlr.h"
#include "misc.h"
37
#include "qstr.h"
38
#include "obj.h"
39
#include "runtime.h"
40
41
#include "stream.h"

42
43
44
45
#ifdef _WIN32
#define fsync _commit
#endif

46
47
48
49
50
typedef struct _mp_obj_fdfile_t {
    mp_obj_base_t base;
    int fd;
} mp_obj_fdfile_t;

51
52
#ifdef MICROPY_CPYTHON_COMPAT
void check_fd_is_open(const mp_obj_fdfile_t *o) {
53
    if (o->fd < 0) {
54
        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError, "I/O operation on closed file"));
55
    }
56
57
58
59
60
}
#else
#define check_fd_is_open(o)
#endif

61
62
extern const mp_obj_type_t mp_type_fileio;
extern const mp_obj_type_t mp_type_textio;
63

64
STATIC void fdfile_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
65
    mp_obj_fdfile_t *self = self_in;
66
    print(env, "<io.%s %d>", mp_obj_get_type_str(self), self->fd);
67
68
}

69
STATIC mp_uint_t fdfile_read(mp_obj_t o_in, void *buf, mp_uint_t size, int *errcode) {
70
    mp_obj_fdfile_t *o = o_in;
71
    check_fd_is_open(o);
72
    mp_int_t r = read(o->fd, buf, size);
73
74
    if (r == -1) {
        *errcode = errno;
75
        return MP_STREAM_ERROR;
76
77
78
79
    }
    return r;
}

80
STATIC mp_uint_t fdfile_write(mp_obj_t o_in, const void *buf, mp_uint_t size, int *errcode) {
81
    mp_obj_fdfile_t *o = o_in;
82
    check_fd_is_open(o);
83
    mp_int_t r = write(o->fd, buf, size);
84
85
    if (r == -1) {
        *errcode = errno;
86
        return MP_STREAM_ERROR;
87
88
89
90
    }
    return r;
}

91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
STATIC mp_uint_t fdfile_ioctl(mp_obj_t o_in, mp_uint_t request, mp_uint_t arg, int *errcode) {
    mp_obj_fdfile_t *o = o_in;
    if (request == MP_STREAM_SEEK) {
        struct mp_stream_seek_t *s = (struct mp_stream_seek_t*)arg;
        off_t off = lseek(o->fd, s->offset, s->whence);
        if (off == (off_t)-1) {
            *errcode = errno;
            return MP_STREAM_ERROR;
        }
        s->offset = off;
        return 0;
    } else {
        *errcode = EINVAL;
        return MP_STREAM_ERROR;
    }
}

108
109
STATIC mp_obj_t fdfile_flush(mp_obj_t self_in) {
    mp_obj_fdfile_t *self = self_in;
110
    check_fd_is_open(self);
111
112
113
114
115
    fsync(self->fd);
    return mp_const_none;
}
STATIC MP_DEFINE_CONST_FUN_OBJ_1(fdfile_flush_obj, fdfile_flush);

116
STATIC mp_obj_t fdfile_close(mp_obj_t self_in) {
117
118
    mp_obj_fdfile_t *self = self_in;
    close(self->fd);
119
120
121
#ifdef MICROPY_CPYTHON_COMPAT
    self->fd = -1;
#endif
122
123
    return mp_const_none;
}
124
STATIC MP_DEFINE_CONST_FUN_OBJ_1(fdfile_close_obj, fdfile_close);
125

126
mp_obj_t fdfile___exit__(mp_uint_t n_args, const mp_obj_t *args) {
127
128
    return fdfile_close(args[0]);
}
129
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(fdfile___exit___obj, 4, 4, fdfile___exit__);
130

131
STATIC mp_obj_t fdfile_fileno(mp_obj_t self_in) {
132
    mp_obj_fdfile_t *self = self_in;
133
    check_fd_is_open(self);
134
    return MP_OBJ_NEW_SMALL_INT(self->fd);
135
}
136
STATIC MP_DEFINE_CONST_FUN_OBJ_1(fdfile_fileno_obj, fdfile_fileno);
137

138
139
140
141
142
143
144
145
146
147
// Note: encoding is ignored for now; it's also not a valid kwarg for CPython's FileIO,
// but by adding it here we can use one single mp_arg_t array for open() and FileIO's constructor
STATIC const mp_arg_t file_open_args[] = {
    { MP_QSTR_file, MP_ARG_OBJ | MP_ARG_REQUIRED, {.u_obj = mp_const_none} },
    { MP_QSTR_mode, MP_ARG_OBJ, {.u_obj = MP_OBJ_NEW_QSTR(MP_QSTR_r)} },
    { MP_QSTR_encoding, MP_ARG_OBJ | MP_ARG_KW_ONLY, {.u_obj = mp_const_none} },
};
#define FILE_OPEN_NUM_ARGS MP_ARRAY_SIZE(file_open_args)

STATIC mp_obj_t fdfile_open(mp_obj_t type_in, mp_arg_val_t *args) {
148
    mp_obj_fdfile_t *o = m_new_obj(mp_obj_fdfile_t);
149
    mp_const_obj_t type = type_in;
150
    const char *mode_s = mp_obj_str_get_str(args[1].u_obj);
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

    int mode = 0;
    while (*mode_s) {
        switch (*mode_s++) {
            // Note: these assume O_RDWR = O_RDONLY | O_WRONLY
            case 'r':
                mode |= O_RDONLY;
                break;
            case 'w':
                mode |= O_WRONLY | O_CREAT | O_TRUNC;
                break;
            case 'a':
                mode |= O_APPEND;
                break;
            case '+':
                mode |= O_RDWR;
                break;
168
            #if MICROPY_PY_IO_FILEIO
169
170
171
172
173
174
175
176
            // If we don't have io.FileIO, then files are in text mode implicitly
            case 'b':
                type = &mp_type_fileio;
                break;
            case 't':
                type = &mp_type_textio;
                break;
            #endif
177
178
179
        }
    }

180
181
    o->base.type = type;

182
183
184
185
    mp_obj_t fid = args[0].u_obj;

    if (MP_OBJ_IS_SMALL_INT(fid)) {
        o->fd = MP_OBJ_SMALL_INT_VALUE(fid);
186
187
188
        return o;
    }

189
    const char *fname = mp_obj_str_get_str(fid);
190
191
    int fd = open(fname, mode, 0644);
    if (fd == -1) {
192
        nlr_raise(mp_obj_new_exception_arg1(&mp_type_OSError, MP_OBJ_NEW_SMALL_INT(errno)));
193
    }
194
195
    o->fd = fd;
    return o;
196
197
}

198
199
200
201
202
203
STATIC mp_obj_t fdfile_make_new(mp_obj_t type_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
    mp_arg_val_t arg_vals[FILE_OPEN_NUM_ARGS];
    mp_arg_parse_all_kw_array(n_args, n_kw, args, FILE_OPEN_NUM_ARGS, file_open_args, arg_vals);
    return fdfile_open(type_in, arg_vals);
}

204
205
206
207
STATIC const mp_map_elem_t rawfile_locals_dict_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR_fileno), (mp_obj_t)&fdfile_fileno_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_read), (mp_obj_t)&mp_stream_read_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_readall), (mp_obj_t)&mp_stream_readall_obj },
208
    { MP_OBJ_NEW_QSTR(MP_QSTR_readinto), (mp_obj_t)&mp_stream_readinto_obj },
209
    { MP_OBJ_NEW_QSTR(MP_QSTR_readline), (mp_obj_t)&mp_stream_unbuffered_readline_obj},
210
    { MP_OBJ_NEW_QSTR(MP_QSTR_readlines), (mp_obj_t)&mp_stream_unbuffered_readlines_obj},
211
    { MP_OBJ_NEW_QSTR(MP_QSTR_write), (mp_obj_t)&mp_stream_write_obj },
212
    { MP_OBJ_NEW_QSTR(MP_QSTR_seek), (mp_obj_t)&mp_stream_seek_obj },
213
    { MP_OBJ_NEW_QSTR(MP_QSTR_flush), (mp_obj_t)&fdfile_flush_obj },
214
    { MP_OBJ_NEW_QSTR(MP_QSTR_close), (mp_obj_t)&fdfile_close_obj },
215
216
    { MP_OBJ_NEW_QSTR(MP_QSTR___enter__), (mp_obj_t)&mp_identity_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR___exit__), (mp_obj_t)&fdfile___exit___obj },
217
218
};

219
220
STATIC MP_DEFINE_CONST_DICT(rawfile_locals_dict, rawfile_locals_dict_table);

221
#if MICROPY_PY_IO_FILEIO
222
STATIC const mp_stream_p_t fileio_stream_p = {
223
224
    .read = fdfile_read,
    .write = fdfile_write,
225
    .ioctl = fdfile_ioctl,
226
227
};

228
const mp_obj_type_t mp_type_fileio = {
229
    { &mp_type_type },
230
    .name = MP_QSTR_FileIO,
231
232
    .print = fdfile_print,
    .make_new = fdfile_make_new,
233
234
    .getiter = mp_identity,
    .iternext = mp_stream_unbuffered_iter,
235
236
237
238
239
240
241
242
    .stream_p = &fileio_stream_p,
    .locals_dict = (mp_obj_t)&rawfile_locals_dict,
};
#endif

STATIC const mp_stream_p_t textio_stream_p = {
    .read = fdfile_read,
    .write = fdfile_write,
243
    .ioctl = fdfile_ioctl,
244
    .is_text = true,
245
246
247
248
249
250
251
252
253
254
};

const mp_obj_type_t mp_type_textio = {
    { &mp_type_type },
    .name = MP_QSTR_TextIOWrapper,
    .print = fdfile_print,
    .make_new = fdfile_make_new,
    .getiter = mp_identity,
    .iternext = mp_stream_unbuffered_iter,
    .stream_p = &textio_stream_p,
255
    .locals_dict = (mp_obj_t)&rawfile_locals_dict,
256
257
258
};

// Factory function for I/O stream classes
259
260
261
262
263
mp_obj_t mp_builtin_open(mp_uint_t n_args, const mp_obj_t *args, mp_map_t *kwargs) {
    // TODO: analyze buffering args and instantiate appropriate type
    mp_arg_val_t arg_vals[FILE_OPEN_NUM_ARGS];
    mp_arg_parse_all(n_args, args, kwargs, FILE_OPEN_NUM_ARGS, file_open_args, arg_vals);
    return fdfile_open((mp_obj_t)&mp_type_textio, arg_vals);
264
}
265
MP_DEFINE_CONST_FUN_OBJ_KW(mp_builtin_open_obj, 1, mp_builtin_open);
266

267
268
269
const mp_obj_fdfile_t mp_sys_stdin_obj  = { .base = {&mp_type_textio}, .fd = STDIN_FILENO };
const mp_obj_fdfile_t mp_sys_stdout_obj = { .base = {&mp_type_textio}, .fd = STDOUT_FILENO };
const mp_obj_fdfile_t mp_sys_stderr_obj = { .base = {&mp_type_textio}, .fd = STDERR_FILENO };