7f9d1d6ab9
Previous to this patch the printing mechanism was a bit of a tangled
mess. This patch attempts to consolidate printing into one interface.
All (non-debug) printing now uses the mp_print* family of functions,
mainly mp_printf. All these functions take an mp_print_t structure as
their first argument, and this structure defines the printing backend
through the "print_strn" function of said structure.
Printing from the uPy core can reach the platform-defined print code via
two paths: either through mp_sys_stdout_obj (defined pert port) in
conjunction with mp_stream_write; or through the mp_plat_print structure
which uses the MP_PLAT_PRINT_STRN macro to define how string are printed
on the platform. The former is only used when MICROPY_PY_IO is defined.
With this new scheme printing is generally more efficient (less layers
to go through, less arguments to pass), and, given an mp_print_t*
structure, one can call mp_print_str for efficiency instead of
mp_printf("%s", ...). Code size is also reduced by around 200 bytes on
Thumb2 archs.
124 lines
4.4 KiB
C
124 lines
4.4 KiB
C
/*
|
|
* This file is part of the Micro Python project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2013, 2014, 2015 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.
|
|
*/
|
|
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
#include <errno.h>
|
|
|
|
#include "py/obj.h"
|
|
#include "py/stream.h"
|
|
#include MICROPY_HAL_H
|
|
|
|
// TODO make stdin, stdout and stderr writable objects so they can
|
|
// be changed by Python code. This requires some changes, as these
|
|
// objects are in a read-only module (py/modsys.c).
|
|
|
|
/******************************************************************************/
|
|
// Micro Python bindings
|
|
|
|
#define STDIO_FD_IN (0)
|
|
#define STDIO_FD_OUT (1)
|
|
#define STDIO_FD_ERR (2)
|
|
|
|
typedef struct _pyb_stdio_obj_t {
|
|
mp_obj_base_t base;
|
|
int fd;
|
|
} pyb_stdio_obj_t;
|
|
|
|
void stdio_obj_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
|
|
pyb_stdio_obj_t *self = self_in;
|
|
mp_printf(print, "<io.FileIO %d>", self->fd);
|
|
}
|
|
|
|
STATIC mp_uint_t stdio_read(mp_obj_t self_in, void *buf, mp_uint_t size, int *errcode) {
|
|
pyb_stdio_obj_t *self = self_in;
|
|
if (self->fd == STDIO_FD_IN) {
|
|
for (uint i = 0; i < size; i++) {
|
|
int c = mp_hal_stdin_rx_chr();
|
|
if (c == '\r') {
|
|
c = '\n';
|
|
}
|
|
((byte*)buf)[i] = c;
|
|
}
|
|
return size;
|
|
} else {
|
|
*errcode = EPERM;
|
|
return MP_STREAM_ERROR;
|
|
}
|
|
}
|
|
|
|
STATIC mp_uint_t stdio_write(mp_obj_t self_in, const void *buf, mp_uint_t size, int *errcode) {
|
|
pyb_stdio_obj_t *self = self_in;
|
|
if (self->fd == STDIO_FD_OUT || self->fd == STDIO_FD_ERR) {
|
|
mp_hal_stdout_tx_strn_cooked(buf, size);
|
|
return size;
|
|
} else {
|
|
*errcode = EPERM;
|
|
return MP_STREAM_ERROR;
|
|
}
|
|
}
|
|
|
|
STATIC mp_obj_t stdio_obj___exit__(mp_uint_t n_args, const mp_obj_t *args) {
|
|
return mp_const_none;
|
|
}
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(stdio_obj___exit___obj, 4, 4, stdio_obj___exit__);
|
|
|
|
// TODO gc hook to close the file if not already closed
|
|
|
|
STATIC const mp_map_elem_t stdio_locals_dict_table[] = {
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_read), (mp_obj_t)&mp_stream_read_obj },
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_readall), (mp_obj_t)&mp_stream_readall_obj },
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_readline), (mp_obj_t)&mp_stream_unbuffered_readline_obj},
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_write), (mp_obj_t)&mp_stream_write_obj },
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_close), (mp_obj_t)&mp_identity_obj },
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR___del__), (mp_obj_t)&mp_identity_obj },
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR___enter__), (mp_obj_t)&mp_identity_obj },
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR___exit__), (mp_obj_t)&stdio_obj___exit___obj },
|
|
};
|
|
|
|
STATIC MP_DEFINE_CONST_DICT(stdio_locals_dict, stdio_locals_dict_table);
|
|
|
|
STATIC const mp_stream_p_t stdio_obj_stream_p = {
|
|
.read = stdio_read,
|
|
.write = stdio_write,
|
|
.is_text = true,
|
|
};
|
|
|
|
STATIC const mp_obj_type_t stdio_obj_type = {
|
|
{ &mp_type_type },
|
|
.name = MP_QSTR_FileIO,
|
|
// TODO .make_new?
|
|
.print = stdio_obj_print,
|
|
.getiter = mp_identity,
|
|
.iternext = mp_stream_unbuffered_iter,
|
|
.stream_p = &stdio_obj_stream_p,
|
|
.locals_dict = (mp_obj_t)&stdio_locals_dict,
|
|
};
|
|
|
|
const pyb_stdio_obj_t mp_sys_stdin_obj = {{&stdio_obj_type}, .fd = STDIO_FD_IN};
|
|
const pyb_stdio_obj_t mp_sys_stdout_obj = {{&stdio_obj_type}, .fd = STDIO_FD_OUT};
|
|
const pyb_stdio_obj_t mp_sys_stderr_obj = {{&stdio_obj_type}, .fd = STDIO_FD_ERR};
|