circuitpython/extmod/misc.h

// Copyright (c) 2016 Paul Sokolovsky
// SPDX-FileCopyrightText: 2014 MicroPython & CircuitPython contributors (https://github.com/adafruit/circuitpython/graphs/contributors)
// SPDX-FileCopyrightText: Copyright (c) 2014-2016 Damien P. George
//
// SPDX-License-Identifier: MIT

#ifndef MICROPY_INCLUDED_EXTMOD_MISC_H
#define MICROPY_INCLUDED_EXTMOD_MISC_H

// This file contains cumulative declarations for extmod/ .

#include <stddef.h>
#include "py/runtime.h"

MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(mp_uos_dupterm_obj);

#if MICROPY_PY_OS_DUPTERM
bool mp_uos_dupterm_is_builtin_stream(mp_const_obj_t stream);
int mp_uos_dupterm_rx_chr(void);
void mp_uos_dupterm_tx_strn(const char *str, size_t len);
void mp_uos_deactivate(size_t dupterm_idx, const char *msg, mp_obj_t exc);
#else
#define mp_uos_dupterm_tx_strn(s, l)
#endif

#endif // MICROPY_INCLUDED_EXTMOD_MISC_H
Add license to some obvious files. 2020-06-03 18:40:05 -04:00			`// Copyright (c) 2016 Paul Sokolovsky`
			`// SPDX-FileCopyrightText: 2014 MicroPython & CircuitPython contributors (https://github.com/adafruit/circuitpython/graphs/contributors)`
			`// SPDX-FileCopyrightText: Copyright (c) 2014-2016 Damien P. George`
			`//`
			`// SPDX-License-Identifier: MIT`

all: Unify header guard usage. The code conventions suggest using header guards, but do not define how those should look like and instead point to existing files. However, not all existing files follow the same scheme, sometimes omitting header guards altogether, sometimes using non-standard names, making it easy to accidentally pick a "wrong" example. This commit ensures that all header files of the MicroPython project (that were not simply copied from somewhere else) follow the same pattern, that was already present in the majority of files, especially in the py folder. The rules are as follows. Naming convention: * start with the words MICROPY_INCLUDED * contain the full path to the file * replace special characters with _ In addition, there are no empty lines before #ifndef, between #ifndef and one empty line before #endif. #endif is followed by a comment containing the name of the guard macro. py/grammar.h cannot use header guards by design, since it has to be included multiple times in a single C file. Several other files also do not need header guards as they are only used internally and guaranteed to be included only once: * MICROPY_MPHALPORT_H * mpconfigboard.h * mpconfigport.h * mpthreadport.h * pin_defs_.h qstrdefs*.h 2017-06-29 17:14:58 -04:00			`#ifndef MICROPY_INCLUDED_EXTMOD_MISC_H`
			`#define MICROPY_INCLUDED_EXTMOD_MISC_H`
extmod/moduos_dupterm: Make uos.dupterm() implementation reusable. That's just function which sets/gets dup terminal object, and can be easily reused across ports. 2016-01-01 06:02:53 -05:00
			`// This file contains cumulative declarations for extmod/ .`

extmod/moduos_dupterm: Make mp_uos_dupterm_tx_strn() function reusable. Function to actually spool output terminal data to dupterm object. 2016-01-01 09:41:26 -05:00			`#include <stddef.h>`
extmod/moduos_dupterm: Make uos.dupterm() implementation reusable. That's just function which sets/gets dup terminal object, and can be easily reused across ports. 2016-01-01 06:02:53 -05:00			`#include "py/runtime.h"`

py: Be more specific with MP_DECLARE_CONST_FUN_OBJ macros. In order to have more fine-grained control over how builtin functions are constructed, the MP_DECLARE_CONST_FUN_OBJ macros are made more specific, with suffix of _0, _1, _2, _3, _VAR, _VAR_BETEEN or _KW. These names now match the MP_DEFINE_CONST_FUN_OBJ macros. 2016-10-17 20:06:20 -04:00			`MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(mp_uos_dupterm_obj);`
extmod/moduos_dupterm: Make mp_uos_dupterm_tx_strn() function reusable. Function to actually spool output terminal data to dupterm object. 2016-01-01 09:41:26 -05:00
			`#if MICROPY_PY_OS_DUPTERM`
Merge MicroPython v1.11 into CircuitPython 2021-04-22 20:55:39 -04:00			`bool mp_uos_dupterm_is_builtin_stream(mp_const_obj_t stream);`
extmod/uos_dupterm: Update uos.dupterm() and helper funcs to have index. The uos.dupterm() signature and behaviour is updated to reflect the latest enhancements in the docs. It has minor backwards incompatibility in that it no longer accepts zero arguments. The dupterm_rx helper function is moved from esp8266 to extmod and generalised to support multiple dupterm slots. A port can specify multiple slots by defining the MICROPY_PY_OS_DUPTERM config macro to an integer, being the number of slots it wants to have; 0 means to disable the dupterm feature altogether. The unix and esp8266 ports are updated to work with the new interface and are otherwise unchanged with respect to functionality. 2017-10-13 05:01:57 -04:00			`int mp_uos_dupterm_rx_chr(void);`
extmod/moduos_dupterm: Make mp_uos_dupterm_tx_strn() function reusable. Function to actually spool output terminal data to dupterm object. 2016-01-01 09:41:26 -05:00			`void mp_uos_dupterm_tx_strn(const char *str, size_t len);`
extmod/uos_dupterm: Update uos.dupterm() and helper funcs to have index. The uos.dupterm() signature and behaviour is updated to reflect the latest enhancements in the docs. It has minor backwards incompatibility in that it no longer accepts zero arguments. The dupterm_rx helper function is moved from esp8266 to extmod and generalised to support multiple dupterm slots. A port can specify multiple slots by defining the MICROPY_PY_OS_DUPTERM config macro to an integer, being the number of slots it wants to have; 0 means to disable the dupterm feature altogether. The unix and esp8266 ports are updated to work with the new interface and are otherwise unchanged with respect to functionality. 2017-10-13 05:01:57 -04:00			`void mp_uos_deactivate(size_t dupterm_idx, const char *msg, mp_obj_t exc);`
extmod/moduos_dupterm: Make mp_uos_dupterm_tx_strn() function reusable. Function to actually spool output terminal data to dupterm object. 2016-01-01 09:41:26 -05:00			`#else`
			`#define mp_uos_dupterm_tx_strn(s, l)`
			`#endif`
all: Unify header guard usage. The code conventions suggest using header guards, but do not define how those should look like and instead point to existing files. However, not all existing files follow the same scheme, sometimes omitting header guards altogether, sometimes using non-standard names, making it easy to accidentally pick a "wrong" example. This commit ensures that all header files of the MicroPython project (that were not simply copied from somewhere else) follow the same pattern, that was already present in the majority of files, especially in the py folder. The rules are as follows. Naming convention: * start with the words MICROPY_INCLUDED * contain the full path to the file * replace special characters with _ In addition, there are no empty lines before #ifndef, between #ifndef and one empty line before #endif. #endif is followed by a comment containing the name of the guard macro. py/grammar.h cannot use header guards by design, since it has to be included multiple times in a single C file. Several other files also do not need header guards as they are only used internally and guaranteed to be included only once: * MICROPY_MPHALPORT_H * mpconfigboard.h * mpconfigport.h * mpthreadport.h * pin_defs_.h qstrdefs*.h 2017-06-29 17:14:58 -04:00
			`#endif // MICROPY_INCLUDED_EXTMOD_MISC_H`