1 /*
2  * This file is part of the MicroPython project, http://micropython.org/
3  *
4  * The MIT License (MIT)
5  *
6  * Copyright (c) 2013-2016 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 #ifndef MICROPY_INCLUDED_PY_READER_H
27 #define MICROPY_INCLUDED_PY_READER_H
28 
29 #include "py/obj.h"
30 
31 // the readbyte function must return the next byte in the input stream
32 // it must return MP_READER_EOF if end of stream
33 // it can be called again after returning MP_READER_EOF, and in that case must return MP_READER_EOF
34 #define MP_READER_EOF ((mp_uint_t)(-1))
35 
36 typedef struct _mp_reader_t {
37     void *data;
38     mp_uint_t (*readbyte)(void *data);
39     void (*close)(void *data);
40 } mp_reader_t;
41 
42 void mp_reader_new_mem(mp_reader_t *reader, const byte *buf, size_t len, size_t free_len);
43 void mp_reader_new_file(mp_reader_t *reader, const char *filename);
44 void mp_reader_new_file_from_fd(mp_reader_t *reader, int fd, bool close_fd);
45 
46 #endif // MICROPY_INCLUDED_PY_READER_H
47