mirror of
https://github.com/licsber/micropython.git
synced 2024-09-20 09:00:23 +08:00
d87f42b0e5
It's a bit of a pitfall with user C modules that including them in the build does not automatically enable them. This commit changes the docs and examples for user C modules to encourage writers of user C modules to enable them unconditionally. This makes things simpler and covers most use cases. See discussion in issue #6960, and also #7086. Signed-off-by: Damien George <damien@micropython.org>
38 lines
1.6 KiB
C
38 lines
1.6 KiB
C
// Include MicroPython API.
|
|
#include "py/runtime.h"
|
|
|
|
// This is the function which will be called from Python as cexample.add_ints(a, b).
|
|
STATIC mp_obj_t example_add_ints(mp_obj_t a_obj, mp_obj_t b_obj) {
|
|
// Extract the ints from the micropython input objects.
|
|
int a = mp_obj_get_int(a_obj);
|
|
int b = mp_obj_get_int(b_obj);
|
|
|
|
// Calculate the addition and convert to MicroPython object.
|
|
return mp_obj_new_int(a + b);
|
|
}
|
|
// Define a Python reference to the function above.
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_2(example_add_ints_obj, example_add_ints);
|
|
|
|
// Define all properties of the module.
|
|
// Table entries are key/value pairs of the attribute name (a string)
|
|
// and the MicroPython object reference.
|
|
// All identifiers and strings are written as MP_QSTR_xxx and will be
|
|
// optimized to word-sized integers by the build system (interned strings).
|
|
STATIC const mp_rom_map_elem_t example_module_globals_table[] = {
|
|
{ MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_cexample) },
|
|
{ MP_ROM_QSTR(MP_QSTR_add_ints), MP_ROM_PTR(&example_add_ints_obj) },
|
|
};
|
|
STATIC MP_DEFINE_CONST_DICT(example_module_globals, example_module_globals_table);
|
|
|
|
// Define module object.
|
|
const mp_obj_module_t example_user_cmodule = {
|
|
.base = { &mp_type_module },
|
|
.globals = (mp_obj_dict_t *)&example_module_globals,
|
|
};
|
|
|
|
// Register the module to make it available in Python.
|
|
// Note: the "1" in the third argument means this module is always enabled.
|
|
// This "1" can be optionally replaced with a macro like MODULE_CEXAMPLE_ENABLED
|
|
// which can then be used to conditionally enable this module.
|
|
MP_REGISTER_MODULE(MP_QSTR_cexample, example_user_cmodule, 1);
|