microPython的源码解析之 builtinhelp.c

MicroPython 是一种适用于微控制器和其他受限环境的 Python 编程语言的实现。它旨在提供与 Python 3 语言的紧密兼容，同时考虑到内存和计算资源的限制。MicroPython 库是这门语言的核心组成部分，提供了一系列的模块和函数，使得开发者能够在硬件上执行各种任务。
下面将通过系列文章,逐一解读microPython,以便让读者了解掌握microPython的整个核心逻辑.,以便读者可以透过这个Python的最小内核,掌握Python解析器的核心实现逻辑,学习世界上最优秀的源码设计.

这段代码是MicroPython的一部分，MicroPython是一种轻量级的Python实现，专为微控制器和小型设备设计。代码中包含了帮助功能的一些实现细节，包括打印模块信息、对象信息以及控制命令等。

#include <stdio.h>
#include <string.h>

#include "py/builtin.h> // 包含MicroPython内置类型和函数的头文件
#include "py/objmodule.h" // 包含模块对象的头文件

#if MICROPY_PY_BUILTINS_HELP // 如果启用了帮助功能

// 默认的帮助信息文本
const char mp_help_default_text[] =
    "欢迎使用MicroPython!\n"
    "\n"
    "在线文档请访问 http://docs.micropython.org/\n" // MicroPython官方文档网址
    "\n"
    "控制命令：\n"
    "  CTRL-A        -- 在空白行输入时，进入原始REPL模式\n"
    "  CTRL-B        -- 在空白行输入时，进入正常REPL模式\n"
    "  CTRL-C        -- 中断正在运行的程序\n"
    "  CTRL-D        -- 在空白行输入时，退出或执行软重置\n"
    "  CTRL-E        -- 在空白行输入时，进入粘贴模式\n"
    "\n"
    "要获取特定对象的进一步帮助，输入 help(obj)\n"
;

// 打印关于对象的信息
static void mp_help_print_info_about_object(mp_obj_t name_o, mp_obj_t value) {
   
    mp_print_str(MP_PYTHON_PRINTER, "  "); // 打印两个空格
    mp_obj_print(name_o, PRINT_STR); // 打印对象名称
    mp_print_str(MP_PYTHON_PRINTER, " -- "); // 打印分隔符
    mp_obj_print(value, PRINT_STR); // 打印对象值
    mp_print_str(MP_PYTHON_PRINTER, "\n"); // 打印换行符
}

#if MICROPY_PY_BUILTINS_HELP_MODULES
// 从映射中添加帮助信息到列表
static void mp_help_add_from_map(mp_obj_t list, const mp_map_t *map) {
   
    for (size_t i = 0; i < map->alloc; i++) {
   
        if (mp_map_slot_is_filled(map, i)) {
   
            mp_obj_list_append(list, map->table[i].key); // 将键添加到列表中
        }
    }
}

#if MICROPY_MODULE_FROZEN
// 从冻结模块名称字符串中添加帮助信息到列表
static void mp_help_add_from_names(mp_obj_t list, const char *name) {
   
    while (*name) {
   
        size_t len = strlen(name);
        // 名称应该以 '.py' 结尾，我们将其剥离
        mp_obj_list_append(list, mp_obj_new_str(name, len - 3));
        name += len + 1;
    }
}
#endif

// 打印模块列表
static void mp_help_print_modules(void) {
   
    mp_obj_t list = mp_obj_new_list(0, NULL)