mirror of
https://github.com/licsber/micropython.git
synced 2024-09-20 17:10:24 +08:00
0c97e4c414
Will call underlying C virtual methods of stream interface. This isn't intended to be added to every stream object (it's not in CPython), but is convenient way to expose extra operation on Python side without adding bunch of Python-level methods.
85 lines
3.3 KiB
C
85 lines
3.3 KiB
C
/*
|
|
* 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.
|
|
*/
|
|
#ifndef __MICROPY_INCLUDED_PY_STREAM_H__
|
|
#define __MICROPY_INCLUDED_PY_STREAM_H__
|
|
|
|
#include "py/obj.h"
|
|
|
|
#define MP_STREAM_ERROR ((mp_uint_t)-1)
|
|
|
|
// Stream ioctl request codes
|
|
#define MP_STREAM_FLUSH (1)
|
|
#define MP_STREAM_SEEK (2)
|
|
#define MP_STREAM_POLL (3)
|
|
//#define MP_STREAM_CLOSE (4) // Not yet implemented
|
|
#define MP_STREAM_TIMEOUT (5) // Get/set timeout (single op)
|
|
#define MP_STREAM_GET_OPTS (6) // Get stream options
|
|
#define MP_STREAM_SET_OPTS (7) // Set stream options
|
|
#define MP_STREAM_GET_DATA_OPTS (8) // Get data/message options
|
|
#define MP_STREAM_SET_DATA_OPTS (9) // Set data/message options
|
|
|
|
// Argument structure for MP_STREAM_SEEK
|
|
struct mp_stream_seek_t {
|
|
mp_off_t offset;
|
|
int whence;
|
|
};
|
|
|
|
MP_DECLARE_CONST_FUN_OBJ(mp_stream_read_obj);
|
|
MP_DECLARE_CONST_FUN_OBJ(mp_stream_readinto_obj);
|
|
MP_DECLARE_CONST_FUN_OBJ(mp_stream_readall_obj);
|
|
MP_DECLARE_CONST_FUN_OBJ(mp_stream_unbuffered_readline_obj);
|
|
MP_DECLARE_CONST_FUN_OBJ(mp_stream_unbuffered_readlines_obj);
|
|
MP_DECLARE_CONST_FUN_OBJ(mp_stream_write_obj);
|
|
MP_DECLARE_CONST_FUN_OBJ(mp_stream_seek_obj);
|
|
MP_DECLARE_CONST_FUN_OBJ(mp_stream_tell_obj);
|
|
MP_DECLARE_CONST_FUN_OBJ(mp_stream_ioctl_obj);
|
|
|
|
// these are for mp_get_stream_raise and can be or'd together
|
|
#define MP_STREAM_OP_READ (1)
|
|
#define MP_STREAM_OP_WRITE (2)
|
|
#define MP_STREAM_OP_IOCTL (4)
|
|
|
|
const mp_stream_p_t *mp_get_stream_raise(mp_obj_t self_in, int flags);
|
|
|
|
// Iterator which uses mp_stream_unbuffered_readline_obj
|
|
mp_obj_t mp_stream_unbuffered_iter(mp_obj_t self);
|
|
|
|
mp_obj_t mp_stream_write(mp_obj_t self_in, const void *buf, size_t len);
|
|
|
|
// Helper function to write entire buf to *blocking* stream
|
|
mp_uint_t mp_stream_writeall(mp_obj_t stream, const byte *buf, mp_uint_t size, int *errcode);
|
|
|
|
#if MICROPY_STREAMS_NON_BLOCK
|
|
// TODO: This is POSIX-specific (but then POSIX is the only real thing,
|
|
// and anything else just emulates it, right?)
|
|
#define mp_is_nonblocking_error(errno) ((errno) == EAGAIN || (errno) == EWOULDBLOCK)
|
|
#else
|
|
#define mp_is_nonblocking_error(errno) (0)
|
|
#endif
|
|
|
|
#endif // __MICROPY_INCLUDED_PY_STREAM_H__
|
|
void mp_stream_write_adaptor(void *self, const char *buf, size_t len);
|