1/*
2 * This file is part of the MicroPython project, http://micropython.org/
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (c) 2013, 2014 Damien P. George
7 * Copyright (c) 2014-2016 Paul Sokolovsky
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 * THE SOFTWARE.
26 */
27#ifndef MICROPY_INCLUDED_PY_STREAM_H
28#define MICROPY_INCLUDED_PY_STREAM_H
29
30#include "py/obj.h"
31#include "py/mperrno.h"
32
33#define MP_STREAM_ERROR ((mp_uint_t)-1)
34
35// Stream ioctl request codes
36#define MP_STREAM_FLUSH (1)
37#define MP_STREAM_SEEK (2)
38#define MP_STREAM_POLL (3)
39#define MP_STREAM_CLOSE (4)
40#define MP_STREAM_TIMEOUT (5) // Get/set timeout (single op)
41#define MP_STREAM_GET_OPTS (6) // Get stream options
42#define MP_STREAM_SET_OPTS (7) // Set stream options
43#define MP_STREAM_GET_DATA_OPTS (8) // Get data/message options
44#define MP_STREAM_SET_DATA_OPTS (9) // Set data/message options
45#define MP_STREAM_GET_FILENO (10) // Get fileno of underlying file
46
47// These poll ioctl values are compatible with Linux
48#define MP_STREAM_POLL_RD (0x0001)
49#define MP_STREAM_POLL_WR (0x0004)
50#define MP_STREAM_POLL_ERR (0x0008)
51#define MP_STREAM_POLL_HUP (0x0010)
52#define MP_STREAM_POLL_NVAL (0x0020)
53
54// Argument structure for MP_STREAM_SEEK
55struct mp_stream_seek_t {
56 // If whence == MP_SEEK_SET, offset should be treated as unsigned.
57 // This allows dealing with full-width stream sizes (16, 32, 64,
58 // etc. bits). For other seek types, should be treated as signed.
59 mp_off_t offset;
60 int whence;
61};
62
63// seek ioctl "whence" values
64#define MP_SEEK_SET (0)
65#define MP_SEEK_CUR (1)
66#define MP_SEEK_END (2)
67
68// Stream protocol
69typedef struct _mp_stream_p_t {
70 // On error, functions should return MP_STREAM_ERROR and fill in *errcode (values
71 // are implementation-dependent, but will be exposed to user, e.g. via exception).
72 mp_uint_t (*read)(mp_obj_t obj, void *buf, mp_uint_t size, int *errcode);
73 mp_uint_t (*write)(mp_obj_t obj, const void *buf, mp_uint_t size, int *errcode);
74 mp_uint_t (*ioctl)(mp_obj_t obj, mp_uint_t request, uintptr_t arg, int *errcode);
75 mp_uint_t is_text : 1; // default is bytes, set this for text stream
76} mp_stream_p_t;
77
78MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(mp_stream_read_obj);
79MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(mp_stream_read1_obj);
80MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(mp_stream_readinto_obj);
81MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(mp_stream_unbuffered_readline_obj);
82MP_DECLARE_CONST_FUN_OBJ_1(mp_stream_unbuffered_readlines_obj);
83MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(mp_stream_write_obj);
84MP_DECLARE_CONST_FUN_OBJ_2(mp_stream_write1_obj);
85MP_DECLARE_CONST_FUN_OBJ_1(mp_stream_close_obj);
86MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(mp_stream_seek_obj);
87MP_DECLARE_CONST_FUN_OBJ_1(mp_stream_tell_obj);
88MP_DECLARE_CONST_FUN_OBJ_1(mp_stream_flush_obj);
89MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(mp_stream_ioctl_obj);
90
91// these are for mp_get_stream_raise and can be or'd together
92#define MP_STREAM_OP_READ (1)
93#define MP_STREAM_OP_WRITE (2)
94#define MP_STREAM_OP_IOCTL (4)
95
96// Object is assumed to have a non-NULL stream protocol with valid r/w/ioctl methods
97static inline const mp_stream_p_t *mp_get_stream(mp_const_obj_t self) {
98 return (const mp_stream_p_t *)((const mp_obj_base_t *)MP_OBJ_TO_PTR(self))->type->protocol;
99}
100
101const mp_stream_p_t *mp_get_stream_raise(mp_obj_t self_in, int flags);
102mp_obj_t mp_stream_close(mp_obj_t stream);
103
104// Iterator which uses mp_stream_unbuffered_readline_obj
105mp_obj_t mp_stream_unbuffered_iter(mp_obj_t self);
106
107mp_obj_t mp_stream_write(mp_obj_t self_in, const void *buf, size_t len, byte flags);
108
109// C-level helper functions
110#define MP_STREAM_RW_READ 0
111#define MP_STREAM_RW_WRITE 2
112#define MP_STREAM_RW_ONCE 1
113mp_uint_t mp_stream_rw(mp_obj_t stream, void *buf, mp_uint_t size, int *errcode, byte flags);
114#define mp_stream_write_exactly(stream, buf, size, err) mp_stream_rw(stream, (byte *)buf, size, err, MP_STREAM_RW_WRITE)
115#define mp_stream_read_exactly(stream, buf, size, err) mp_stream_rw(stream, buf, size, err, MP_STREAM_RW_READ)
116
117void mp_stream_write_adaptor(void *self, const char *buf, size_t len);
118
119#if MICROPY_STREAMS_POSIX_API
120#include <sys/types.h>
121// Functions with POSIX-compatible signatures
122// "stream" is assumed to be a pointer to a concrete object with the stream protocol
123ssize_t mp_stream_posix_write(void *stream, const void *buf, size_t len);
124ssize_t mp_stream_posix_read(void *stream, void *buf, size_t len);
125off_t mp_stream_posix_lseek(void *stream, off_t offset, int whence);
126int mp_stream_posix_fsync(void *stream);
127#endif
128
129#if MICROPY_STREAMS_NON_BLOCK
130#define mp_is_nonblocking_error(errno) ((errno) == MP_EAGAIN || (errno) == MP_EWOULDBLOCK)
131#else
132#define mp_is_nonblocking_error(errno) (0)
133#endif
134
135#endif // MICROPY_INCLUDED_PY_STREAM_H
136