microPython的源码解析之 modstruct.c

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

microPython Python最小内核源码解析

以下是您提供的代码，已经将其中的英文注释翻译为中文，并补充了一些注释以帮助理解代码的功能和结构。

#include <assert.h>
#include <string.h>

#include "py/runtime.h"
#include "py/builtin.h"
#include "py/objtuple.h"
#include "py/binary.h"
#include "py/parsenum.h"

#if MICROPY_PY_STRUCT

/*
    此模块实现了CPython中的大部分字符类型代码，并进行了一些扩展：

    O - 任意Python对象的指针（在结构中作为回调数据等使用）。注意，您必须在Python应用程序中保持对传递对象的引用，
    否则它可能会被垃圾回收，当您从回调中获取此值时，它可能已经无效（并导致崩溃）。
    S - 字符串的指针（作为Python字符串返回）。注意与"Ns"的区别，后者表示“结构的这个位置是最多N字节长度的字符数据”，
    而"S"表示“结构的这个位置是一个指向以零结尾的字符数据的指针”。
*/

// 获取格式字符串中的类型字符
static char get_fmt_type(const char **fmt) {
   
    char t = **fmt;
    switch (t) {
   
        case '!':
            t = '>';
            break;
        case '@':
        case '=':
        case '<':
        case '>':
            break;
        default:
            return '@';
    }
    // 跳过类型字符
    (*fmt)++;
    return t;
}

// 获取格式字符串中的数字
static mp_uint_t get_fmt_num(const char **p) {
   
    const char *num = *p;
    uint len = 1;
    while (unichar_isdigit(*++num)) {
   
        len++;
    }
    mp_uint_t val = (mp_uint_t)MP_OBJ_SMALL_INT_VALUE(mp_parse_num_integer(*p, len, 10, NULL));
    *p = num;
    return val;
}

// 计算结构体大小和元素总数
static size_t calc_size_items(const char *fmt, size_t *total_sz) {
   
    char fmt_type = get_fmt_type(&fmt);
    size_t total_cnt = 0;
    size_t size;
    for (size = 0; *fmt; fmt++) {
   
        mp_uint_t cnt = 1;
        if (unichar_isdigit(*fmt)) {
   
            cnt = get_fmt_num(&fmt);
        }

        if (*fmt == 'x') {
   
            size += cnt;
        } else if (*fmt == 's') {
   
            total_cnt += 1;
            size += cnt;
        } else {
   
            total_cnt += cnt;
            size_t align;
            size_t sz = mp_binary_get_size(fmt_type, *fmt, &align);
            while (cnt--) {
   
                // 应用对齐
                size = (size + align - 1) & ~(align - 1);
                size += sz;
            }
        }
    }
    *total_sz = size;
    return total_cnt;
}

// 计算结构体大小的函数实现
static mp_obj_t struct_calcsize(mp_obj_t fmt_in) {
   
    const char *fmt = mp_obj_str_get_str(fmt_in);
    size_t size;
    calc_size_items(fmt, &size);
    return MP_OBJ_NEW_SMALL_INT(size);
}
MP_DEFINE_CONST_FUN_OBJ_1(struct_calcsize_obj, struct_calcsize);

// 从二进制数据中解包数据的函数实现
static mp_obj_t struct_unpack_from(size_t n_args, const mp_obj_t *args) {
   
    // 解包要求缓冲区大小完全正确。
    // unpack_from要求缓冲区“足够大”。
    // 由于我们使用相同的函数实现unpack和unpack_from，
    // 我们放宽了“完全正确”的要求，只实现了“足够大”。
    const char *fmt = mp_obj_str_get_str(args[0]);
    size_t total_sz;
    size_t num_items = calc_size_items(fmt, &total_sz);
    char fmt_type = get_fmt_type(&fmt);
    mp_obj_tuple_t *res = MP_OBJ_TO_PTR(mp_obj_new_tuple(num_items, NULL));
    mp_buffer_info_t bufinfo;
    mp_get_buffer_raise(args[1], &bufinfo, MP_BUFFER_READ);
    byte *p = bufinfo.buf;
    byte *end_p = &p[bufinfo.len];
    mp_int_t offset = 0;

    if (n_args > 2) {
   
        // 提供了偏移参数
        offset = mp_obj_get_int(args[2]);
        if (offset