microPython的源码解析之 objfloat.c

MicroPython 是一种适用于微控制器和其他受限环境的 Python 编程语言的实现。它旨在提供与 Python 3 语言的紧密兼容，同时考虑到内存和计算资源的限制。MicroPython 库是这门语言的核心组成部分，提供了一系列的模块和函数，使得开发者能够在硬件上执行各种任务。
下面将通过系列文章,逐一解读microPython,以便让读者了解掌握microPython的整个核心逻辑.,以便读者可以透过这个Python的最小内核,掌握Python解析器的核心实现逻辑,学习世界上最优秀的源码设计之一.
microPython Python最小内核源码解析
这段代码是MicroPython的浮点数对象类型和相关操作的实现。它定义了浮点数对象的结构体、数学常量、打印函数、构造函数、一元和二元操作函数等。代码中包含了大量的注释，解释了每个函数和操作的目的和实现细节。此外，代码还考虑了浮点数的特殊情况，如零、无穷大和NaN，并遵循了Python的规范要求。

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

#include "py/parsenum.h"
#include "py/runtime.h"

// 当启用浮点数支持时
#if MICROPY_PY_BUILTINS_FLOAT

#include <math.h>
#include "py/formatfloat.h"

// 如果编译器没有定义数学常量M_E和M_PI，则手动定义它们
#if MICROPY_OBJ_REPR != MICROPY_OBJ_REPR_C && MICROPY_OBJ_REPR != MICROPY_OBJ_REPR_D
#ifndef M_E
#define M_E (2.7182818284590452354) // 自然对数的底数e
#endif
#ifndef M_PI
#define M_PI (3.14159265358979323846) // 圆周率π
#endif

// 定义一个浮点数对象结构体
typedef struct _mp_obj_float_t {
   
    mp_obj_base_t base; // 继承自基础对象
    mp_float_t value; // 浮点数值
} mp_obj_float_t;

// 定义数学常量e和π的浮点数对象
const mp_obj_float_t mp_const_float_e_obj = {
   {
   &mp_type_float}, (mp_float_t)M_E};
const mp_obj_float_t mp_const_float_pi_obj = {
   {
   &mp_type_float}, (mp_float_t)M_PI};
#if MICROPY_PY_MATH_CONSTANTS
// 定义数学常量τ、无穷大和NaN的浮点数对象
#ifndef NAN
#error NAN宏未定义
#endif
const mp_obj_float_t mp_const_float_tau_obj = {
   {
   &mp_type_float}, (mp_float_t)(2.0 * M_PI)};
const mp_obj_float_t mp_const_float_inf_obj = {
   {
   &mp_type_float}, (mp_float_t)INFINITY};
const mp_obj_float_t mp_const_float_nan_obj = {
   {
   &mp_type_float}, (mp_float_t)NAN};
#endif

// 定义浮点数零常量
#define MICROPY_FLOAT_ZERO MICROPY_FLOAT_CONST(0.0)

// 如果启用了高质量的浮点数哈希，则实现哈希函数
#if MICROPY_FLOAT_HIGH_QUALITY_HASH
mp_int_t mp_float_hash(mp_float_t src) {
   
    // 将浮点数转换为联合体，以便进行位操作
    mp_float_union_t u = {
   .f = src};
    mp_int_t val;
    // 调整指数部分
    const int adj_exp = (int)u.p.exp - MP_FLOAT_EXP_BIAS;
    if (adj_exp < 0) {
   
        // 值小于1，处理特殊情况0.0（返回0）
        val = u.i;
    } else {
   
        // 如果调整后的指数最大，则u.p.frc==0表示无穷大，否则为NaN
        // 否则：1 <= 值
        mp_float_uint_t frc = u.p.frc | ((mp_float_uint_t)1 << MP_FLOAT_FRAC_BITS);

        if (adj_exp <= MP_FLOAT_FRAC_BITS) {
   
            // 数字可能有小数部分；将整数部分与小数部分异或
            val = (frc >> (MP_FLOAT_FRAC_BITS - adj_exp))
                ^ (frc & (((mp_float_uint_t)1 << (MP_FLOAT_FRAC_BITS - adj_exp)) - 1));
        } else if ((unsigned int)adj_exp < MP_BITS_PER_BYTE * sizeof(mp_int_t) - 1) {
   
            // 数字是一个（大的）整数，可以适应val的有符号宽度
            val = (mp_int_t)frc << (adj_exp - MP_FLOAT_FRAC_BITS);
        } else {
   
            // 整数部分将超出val的宽度，所以只使用我们可以的位
            val = frc;
        }
    }

    if (u.p.sgn) {
   
        val = -(mp_uint_t)val;
    }

    return val;
}
#endif

// 浮点数打印函数
static void float_print(const mp_print_t *print, mp_obj_t o_in, mp_print_kind_t kind) {
   
    (void)kind;
    mp_float_t o_val = mp_obj_float_get(o_in);
    // 根据浮点数实现的不同，分配不同大小的缓冲区
    char buf[32];
    const int precision = 16; // 精度
    mp_format_float(o_val, buf, sizeof(buf), 'g', precision, '\0');
    mp_print_str(print, buf);
    // 如果打印结果中没有小数点、指数或NaN，则添加'.0'
    if (strchr(buf, '.') == NULL && strchr(buf, 'e') == NULL && strchr(buf, 'n') == NULL) {
   
        mp_print_str(print, ".0");
    }
}

// 浮点数构造函数
static mp_obj_t float_make_new(const mp_obj_type_t *type_in, size_t n_args, size_t n_kw, const mp_obj_t *args) {
   
    (void)type_in;
    mp_arg_check_num(n_args, n_kw, 0, 1, false);

    // 根据参数数量选择不同的处理方式
    switch (n_args) {
   
        case 0:
            return mp_obj_new_float(0); // 无参数，创建值为0的浮点数对象
        case 1:
        default: {
   
            // 参数为文本表示，解析它
            if (mp_get_buffer(args[0], &bufinfo, MP_BUFFER_READ)) {
   
                return mp_parse_num_float(bufinfo.buf, bufinfo.len, false, NULL);
            } else if (mp_obj_is_float(args[0])) {
   
                // 参数已经是一个浮点数对象，直接返回
                return args[0];
            } else {
   
                // 参数是其他类型，尝试将其转换为浮点数
                return mp_obj_new_float(mp_obj_get_float(args[0]));
            }
        }
    }
}

// 浮点数一元操作函数
static mp_obj_t float_unary_op(mp_unary_op_t op, mp_obj_t o_in) {
   
    mp_float_t val = mp_obj_float_get(o_in);
    // 根据操作类型执行相应的操作
    switch (op)