Colin Hogben / micropython

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   micropython-repl

py/stream.h@0:5868e8752d44, 2016-04-16 (annotated)

Committer:
pythontech
Date:
Sat Apr 16 17:11:56 2016 +0000
Revision:
0:5868e8752d44
Split off library from repl

Who changed what in which revision?

UserRevisionLine numberNew contents of line
pythontech 0:5868e8752d44 1 /*
pythontech 0:5868e8752d44 2 * This file is part of the Micro Python project, http://micropython.org/
pythontech 0:5868e8752d44 3 *
pythontech 0:5868e8752d44 4 * The MIT License (MIT)
pythontech 0:5868e8752d44 5 *
pythontech 0:5868e8752d44 6 * Copyright (c) 2013, 2014 Damien P. George
pythontech 0:5868e8752d44 7 *
pythontech 0:5868e8752d44 8 * Permission is hereby granted, free of charge, to any person obtaining a copy
pythontech 0:5868e8752d44 9 * of this software and associated documentation files (the "Software"), to deal
pythontech 0:5868e8752d44 10 * in the Software without restriction, including without limitation the rights
pythontech 0:5868e8752d44 11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
pythontech 0:5868e8752d44 12 * copies of the Software, and to permit persons to whom the Software is
pythontech 0:5868e8752d44 13 * furnished to do so, subject to the following conditions:
pythontech 0:5868e8752d44 14 *
pythontech 0:5868e8752d44 15 * The above copyright notice and this permission notice shall be included in
pythontech 0:5868e8752d44 16 * all copies or substantial portions of the Software.
pythontech 0:5868e8752d44 17 *
pythontech 0:5868e8752d44 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
pythontech 0:5868e8752d44 19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
pythontech 0:5868e8752d44 20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
pythontech 0:5868e8752d44 21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
pythontech 0:5868e8752d44 22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
pythontech 0:5868e8752d44 23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
pythontech 0:5868e8752d44 24 * THE SOFTWARE.
pythontech 0:5868e8752d44 25 */
pythontech 0:5868e8752d44 26 #ifndef __MICROPY_INCLUDED_PY_STREAM_H__
pythontech 0:5868e8752d44 27 #define __MICROPY_INCLUDED_PY_STREAM_H__
pythontech 0:5868e8752d44 28
pythontech 0:5868e8752d44 29 #include "py/obj.h"
pythontech 0:5868e8752d44 30
pythontech 0:5868e8752d44 31 #define MP_STREAM_ERROR ((mp_uint_t)-1)
pythontech 0:5868e8752d44 32
pythontech 0:5868e8752d44 33 // Stream ioctl request codes
pythontech 0:5868e8752d44 34 #define MP_STREAM_FLUSH (1)
pythontech 0:5868e8752d44 35 #define MP_STREAM_SEEK (2)
pythontech 0:5868e8752d44 36 #define MP_STREAM_POLL (3)
pythontech 0:5868e8752d44 37 //#define MP_STREAM_CLOSE (4) // Not yet implemented
pythontech 0:5868e8752d44 38 #define MP_STREAM_TIMEOUT (5) // Get/set timeout (single op)
pythontech 0:5868e8752d44 39 #define MP_STREAM_GET_OPTS (6) // Get stream options
pythontech 0:5868e8752d44 40 #define MP_STREAM_SET_OPTS (7) // Set stream options
pythontech 0:5868e8752d44 41 #define MP_STREAM_GET_DATA_OPTS (8) // Get data/message options
pythontech 0:5868e8752d44 42 #define MP_STREAM_SET_DATA_OPTS (9) // Set data/message options
pythontech 0:5868e8752d44 43
pythontech 0:5868e8752d44 44 // Argument structure for MP_STREAM_SEEK
pythontech 0:5868e8752d44 45 struct mp_stream_seek_t {
pythontech 0:5868e8752d44 46 mp_off_t offset;
pythontech 0:5868e8752d44 47 int whence;
pythontech 0:5868e8752d44 48 };
pythontech 0:5868e8752d44 49
pythontech 0:5868e8752d44 50 MP_DECLARE_CONST_FUN_OBJ(mp_stream_read_obj);
pythontech 0:5868e8752d44 51 MP_DECLARE_CONST_FUN_OBJ(mp_stream_readinto_obj);
pythontech 0:5868e8752d44 52 MP_DECLARE_CONST_FUN_OBJ(mp_stream_readall_obj);
pythontech 0:5868e8752d44 53 MP_DECLARE_CONST_FUN_OBJ(mp_stream_unbuffered_readline_obj);
pythontech 0:5868e8752d44 54 MP_DECLARE_CONST_FUN_OBJ(mp_stream_unbuffered_readlines_obj);
pythontech 0:5868e8752d44 55 MP_DECLARE_CONST_FUN_OBJ(mp_stream_write_obj);
pythontech 0:5868e8752d44 56 MP_DECLARE_CONST_FUN_OBJ(mp_stream_seek_obj);
pythontech 0:5868e8752d44 57 MP_DECLARE_CONST_FUN_OBJ(mp_stream_tell_obj);
pythontech 0:5868e8752d44 58 MP_DECLARE_CONST_FUN_OBJ(mp_stream_ioctl_obj);
pythontech 0:5868e8752d44 59
pythontech 0:5868e8752d44 60 // these are for mp_get_stream_raise and can be or'd together
pythontech 0:5868e8752d44 61 #define MP_STREAM_OP_READ (1)
pythontech 0:5868e8752d44 62 #define MP_STREAM_OP_WRITE (2)
pythontech 0:5868e8752d44 63 #define MP_STREAM_OP_IOCTL (4)
pythontech 0:5868e8752d44 64
pythontech 0:5868e8752d44 65 const mp_stream_p_t *mp_get_stream_raise(mp_obj_t self_in, int flags);
pythontech 0:5868e8752d44 66
pythontech 0:5868e8752d44 67 // Iterator which uses mp_stream_unbuffered_readline_obj
pythontech 0:5868e8752d44 68 mp_obj_t mp_stream_unbuffered_iter(mp_obj_t self);
pythontech 0:5868e8752d44 69
pythontech 0:5868e8752d44 70 mp_obj_t mp_stream_write(mp_obj_t self_in, const void *buf, size_t len);
pythontech 0:5868e8752d44 71
pythontech 0:5868e8752d44 72 // Helper function to write entire buf to *blocking* stream
pythontech 0:5868e8752d44 73 mp_uint_t mp_stream_writeall(mp_obj_t stream, const byte *buf, mp_uint_t size, int *errcode);
pythontech 0:5868e8752d44 74
pythontech 0:5868e8752d44 75 #if MICROPY_STREAMS_NON_BLOCK
pythontech 0:5868e8752d44 76 // TODO: This is POSIX-specific (but then POSIX is the only real thing,
pythontech 0:5868e8752d44 77 // and anything else just emulates it, right?)
pythontech 0:5868e8752d44 78 #define mp_is_nonblocking_error(errno) ((errno) == EAGAIN || (errno) == EWOULDBLOCK)
pythontech 0:5868e8752d44 79 #else
pythontech 0:5868e8752d44 80 #define mp_is_nonblocking_error(errno) (0)
pythontech 0:5868e8752d44 81 #endif
pythontech 0:5868e8752d44 82
pythontech 0:5868e8752d44 83 #endif // __MICROPY_INCLUDED_PY_STREAM_H__
pythontech 0:5868e8752d44 84 void mp_stream_write_adaptor(void *self, const char *buf, size_t len);