Branch data Line data Source code
1 : : /*
2 : : * This file is part of the MicroPython project, http://micropython.org/
3 : : *
4 : : * The MIT License (MIT)
5 : : *
6 : : * Copyright (c) 2022 Damien P. George
7 : : *
8 : : * Permission is hereby granted, free of charge, to any person obtaining a copy
9 : : * of this software and associated documentation files (the "Software"), to deal
10 : : * in the Software without restriction, including without limitation the rights
11 : : * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 : : * copies of the Software, and to permit persons to whom the Software is
13 : : * furnished to do so, subject to the following conditions:
14 : : *
15 : : * The above copyright notice and this permission notice shall be included in
16 : : * all copies or substantial portions of the Software.
17 : : *
18 : : * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 : : * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 : : * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 : : * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 : : * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 : : * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 : : * THE SOFTWARE.
25 : : */
26 : :
27 : : #include <string.h>
28 : :
29 : : #include "py/reader.h"
30 : : #include "py/runtime.h"
31 : : #include "py/stream.h"
32 : : #include "extmod/vfs_rom.h"
33 : :
34 : : #if MICROPY_VFS_ROM
35 : :
36 : : typedef struct _mp_obj_vfs_rom_file_t {
37 : : mp_obj_base_t base;
38 : : size_t file_size;
39 : : size_t file_offset;
40 : : const uint8_t *file_data;
41 : : } mp_obj_vfs_rom_file_t;
42 : :
43 : : static const mp_obj_type_t mp_type_vfs_rom_fileio;
44 : : static const mp_obj_type_t mp_type_vfs_rom_textio;
45 : :
46 : 46 : mp_obj_t mp_vfs_rom_file_open(mp_obj_t self_in, mp_obj_t path_in, mp_obj_t mode_in) {
47 : 46 : mp_obj_vfs_rom_t *self = MP_OBJ_TO_PTR(self_in);
48 : :
49 : 46 : const char *mode_s = mp_obj_str_get_str(mode_in);
50 : 46 : const mp_obj_type_t *type = &mp_type_vfs_rom_textio;
51 [ + + ]: 100 : while (*mode_s) {
52 [ + + + + ]: 60 : switch (*mode_s++) {
53 : : case 'r':
54 : : break;
55 : 6 : case 'w':
56 : : case 'a':
57 : : case '+':
58 : 6 : mp_raise_OSError(MP_EROFS);
59 : 22 : case 'b':
60 : 22 : type = &mp_type_vfs_rom_fileio;
61 : 22 : break;
62 : 2 : case 't':
63 : 2 : type = &mp_type_vfs_rom_textio;
64 : 2 : break;
65 : : }
66 : : }
67 : :
68 : 40 : mp_obj_vfs_rom_file_t *o = m_new_obj(mp_obj_vfs_rom_file_t);
69 : 40 : o->base.type = type;
70 : 40 : o->file_offset = 0;
71 : :
72 : 40 : const char *path = mp_vfs_rom_get_path_str(self, path_in);
73 : 40 : mp_import_stat_t stat = mp_vfs_rom_search_filesystem(self, path, &o->file_size, &o->file_data);
74 [ + + ]: 40 : if (stat == MP_IMPORT_STAT_NO_EXIST) {
75 : 4 : mp_raise_OSError(MP_ENOENT);
76 [ + + ]: 36 : } else if (stat == MP_IMPORT_STAT_DIR) {
77 : 4 : mp_raise_OSError(MP_EISDIR);
78 : : }
79 : :
80 : 32 : return MP_OBJ_FROM_PTR(o);
81 : : }
82 : :
83 : 24 : static mp_int_t vfs_rom_file_get_buffer(mp_obj_t self_in, mp_buffer_info_t *bufinfo, mp_uint_t flags) {
84 : 24 : mp_obj_vfs_rom_file_t *self = MP_OBJ_TO_PTR(self_in);
85 [ + + ]: 24 : if (flags == MP_BUFFER_READ) {
86 : 18 : bufinfo->buf = (void *)self->file_data;
87 : 18 : bufinfo->len = self->file_size;
88 : 18 : bufinfo->typecode = 'B';
89 : 18 : return 0;
90 : : } else {
91 : : // Can't write to a ROM file.
92 : : return 1;
93 : : }
94 : : }
95 : :
96 : 36 : static mp_uint_t vfs_rom_file_read(mp_obj_t o_in, void *buf, mp_uint_t size, int *errcode) {
97 : 36 : mp_obj_vfs_rom_file_t *self = MP_OBJ_TO_PTR(o_in);
98 : 36 : size_t remain = self->file_size - self->file_offset;
99 [ + - ]: 36 : if (size > remain) {
100 : 36 : size = remain;
101 : : }
102 : 36 : memcpy(buf, self->file_data + self->file_offset, size);
103 : 36 : self->file_offset += size;
104 : 36 : return size;
105 : : }
106 : :
107 : 46 : static mp_uint_t vfs_rom_file_ioctl(mp_obj_t o_in, mp_uint_t request, uintptr_t arg, int *errcode) {
108 : 46 : mp_obj_vfs_rom_file_t *self = MP_OBJ_TO_PTR(o_in);
109 : :
110 [ + + + ]: 46 : switch (request) {
111 : 18 : case MP_STREAM_SEEK: {
112 : 18 : struct mp_stream_seek_t *s = (struct mp_stream_seek_t *)arg;
113 [ + + ]: 18 : if (s->whence == 0) { // SEEK_SET
114 : 8 : self->file_offset = (size_t)s->offset;
115 [ + + ]: 10 : } else if (s->whence == 1) { // SEEK_CUR
116 : 4 : self->file_offset += s->offset;
117 : : } else { // SEEK_END
118 : 6 : self->file_offset = self->file_size + s->offset;
119 : : }
120 [ + + ]: 18 : if (self->file_offset > self->file_size) {
121 [ + + ]: 8 : if (s->offset < 0) {
122 : : // Seek to before the start of the file.
123 : 4 : *errcode = MP_EINVAL;
124 : 4 : return MP_STREAM_ERROR;
125 : : }
126 : 4 : self->file_offset = self->file_size;
127 : : }
128 : 14 : s->offset = self->file_offset;
129 : 14 : return 0;
130 : : }
131 : : case MP_STREAM_CLOSE:
132 : : return 0;
133 : 4 : default:
134 : 4 : *errcode = MP_EINVAL;
135 : 4 : return MP_STREAM_ERROR;
136 : : }
137 : : }
138 : :
139 : : static const mp_rom_map_elem_t vfs_rom_rawfile_locals_dict_table[] = {
140 : : { MP_ROM_QSTR(MP_QSTR_read), MP_ROM_PTR(&mp_stream_read_obj) },
141 : : { MP_ROM_QSTR(MP_QSTR_readinto), MP_ROM_PTR(&mp_stream_readinto_obj) },
142 : : { MP_ROM_QSTR(MP_QSTR_readline), MP_ROM_PTR(&mp_stream_unbuffered_readline_obj) },
143 : : { MP_ROM_QSTR(MP_QSTR_readlines), MP_ROM_PTR(&mp_stream_unbuffered_readlines_obj) },
144 : : { MP_ROM_QSTR(MP_QSTR_seek), MP_ROM_PTR(&mp_stream_seek_obj) },
145 : : { MP_ROM_QSTR(MP_QSTR_tell), MP_ROM_PTR(&mp_stream_tell_obj) },
146 : : { MP_ROM_QSTR(MP_QSTR_close), MP_ROM_PTR(&mp_stream_close_obj) },
147 : : { MP_ROM_QSTR(MP_QSTR___enter__), MP_ROM_PTR(&mp_identity_obj) },
148 : : { MP_ROM_QSTR(MP_QSTR___exit__), MP_ROM_PTR(&mp_stream___exit___obj) },
149 : : };
150 : : static MP_DEFINE_CONST_DICT(vfs_rom_rawfile_locals_dict, vfs_rom_rawfile_locals_dict_table);
151 : :
152 : : static const mp_stream_p_t vfs_rom_fileio_stream_p = {
153 : : .read = vfs_rom_file_read,
154 : : .ioctl = vfs_rom_file_ioctl,
155 : : };
156 : :
157 : : static MP_DEFINE_CONST_OBJ_TYPE(
158 : : mp_type_vfs_rom_fileio,
159 : : MP_QSTR_FileIO,
160 : : MP_TYPE_FLAG_ITER_IS_STREAM,
161 : : buffer, vfs_rom_file_get_buffer,
162 : : protocol, &vfs_rom_fileio_stream_p,
163 : : locals_dict, &vfs_rom_rawfile_locals_dict
164 : : );
165 : :
166 : : static const mp_stream_p_t vfs_rom_textio_stream_p = {
167 : : .read = vfs_rom_file_read,
168 : : .ioctl = vfs_rom_file_ioctl,
169 : : .is_text = true,
170 : : };
171 : :
172 : : static MP_DEFINE_CONST_OBJ_TYPE(
173 : : mp_type_vfs_rom_textio,
174 : : MP_QSTR_TextIOWrapper,
175 : : MP_TYPE_FLAG_ITER_IS_STREAM,
176 : : protocol, &vfs_rom_textio_stream_p,
177 : : locals_dict, &vfs_rom_rawfile_locals_dict
178 : : );
179 : :
180 : : #endif // MICROPY_VFS_ROM
|
