mirror of
https://github.com/micropython/micropython.git
synced 2025-09-07 18:30:27 +02:00
decf8e6a8b
The STATIC macro was introduced a very long time ago in commit
d5df6cd44a. The original reason for this was
to have the option to define it to nothing so that all static functions
become global functions and therefore visible to certain debug tools, so
one could do function size comparison and other things.
This STATIC feature is rarely (if ever) used. And with the use of LTO and
heavy inline optimisation, analysing the size of individual functions when
they are not static is not a good representation of the size of code when
fully optimised.
So the macro does not have much use and it's simpler to just remove it.
Then you know exactly what it's doing. For example, newcomers don't have
to learn what the STATIC macro is and why it exists. Reading the code is
also less "loud" with a lowercase static.
One other minor point in favour of removing it, is that it stops bugs with
`STATIC inline`, which should always be `static inline`.
Methodology for this commit was:
1) git ls-files | egrep '\.[ch]$' | \
xargs sed -Ei "s/(^| )STATIC($| )/\1static\2/"
2) Do some manual cleanup in the diff by searching for the word STATIC in
comments and changing those back.
3) "git-grep STATIC docs/", manually fixed those cases.
4) "rg -t python STATIC", manually fixed codegen lines that used STATIC.
This work was funded through GitHub Sponsors.
Signed-off-by: Angus Gratton <angus@redyak.com.au>
61 lines
2.2 KiB
C
61 lines
2.2 KiB
C
/* This example demonstrates the following features in a native module:
|
|
- using types
|
|
- using constant objects
|
|
- creating dictionaries
|
|
*/
|
|
|
|
// Include the header file to get access to the MicroPython API.
|
|
#include "py/dynruntime.h"
|
|
|
|
// A function that returns a tuple of object types.
|
|
static mp_obj_t get_types(void) {
|
|
return mp_obj_new_tuple(9, ((mp_obj_t []) {
|
|
MP_OBJ_FROM_PTR(&mp_type_type),
|
|
MP_OBJ_FROM_PTR(&mp_type_NoneType),
|
|
MP_OBJ_FROM_PTR(&mp_type_bool),
|
|
MP_OBJ_FROM_PTR(&mp_type_int),
|
|
MP_OBJ_FROM_PTR(&mp_type_str),
|
|
MP_OBJ_FROM_PTR(&mp_type_bytes),
|
|
MP_OBJ_FROM_PTR(&mp_type_tuple),
|
|
MP_OBJ_FROM_PTR(&mp_type_list),
|
|
MP_OBJ_FROM_PTR(&mp_type_dict),
|
|
}));
|
|
}
|
|
static MP_DEFINE_CONST_FUN_OBJ_0(get_types_obj, get_types);
|
|
|
|
// A function that returns a tuple of constant objects.
|
|
static mp_obj_t get_const_objects(void) {
|
|
return mp_obj_new_tuple(5, ((mp_obj_t []) {
|
|
mp_const_none,
|
|
mp_const_false,
|
|
mp_const_true,
|
|
mp_const_empty_bytes,
|
|
mp_const_empty_tuple,
|
|
}));
|
|
}
|
|
static MP_DEFINE_CONST_FUN_OBJ_0(get_const_objects_obj, get_const_objects);
|
|
|
|
// A function that creates a dictionary from the given arguments.
|
|
static mp_obj_t make_dict(size_t n_args, const mp_obj_t *args) {
|
|
mp_obj_t dict = mp_obj_new_dict(n_args / 2);
|
|
for (; n_args >= 2; n_args -= 2, args += 2) {
|
|
mp_obj_dict_store(dict, args[0], args[1]);
|
|
}
|
|
return dict;
|
|
}
|
|
static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(make_dict_obj, 0, MP_OBJ_FUN_ARGS_MAX, make_dict);
|
|
|
|
// This is the entry point and is called when the module is imported.
|
|
mp_obj_t mpy_init(mp_obj_fun_bc_t *self, size_t n_args, size_t n_kw, mp_obj_t *args) {
|
|
// This must be first, it sets up the globals dict and other things.
|
|
MP_DYNRUNTIME_INIT_ENTRY
|
|
|
|
// Make the functions available in the module's namespace.
|
|
mp_store_global(MP_QSTR_make_dict, MP_OBJ_FROM_PTR(&make_dict_obj));
|
|
mp_store_global(MP_QSTR_get_types, MP_OBJ_FROM_PTR(&get_types_obj));
|
|
mp_store_global(MP_QSTR_get_const_objects, MP_OBJ_FROM_PTR(&get_const_objects_obj));
|
|
|
|
// This must be last, it restores the globals dict.
|
|
MP_DYNRUNTIME_INIT_EXIT
|
|
}
|