php strpad函数源码解析-乐工具技术知识

str_pad 是 PHP 中的一个字符串处理函数，用于将字符串填充到指定长度

/* {{{ proto string str_pad(string input, int pad_length[, string pad_string[, int pad_type]])
   Pad a string to a certain length with another string */
PHP_FUNCTION(str_pad)
{
    zend_string *input;        // 输入字符串
    zend_long pad_length;      // 需要填充到的长度
    zend_string *pad_string = NULL; // 填充字符串，默认为空格
    zend_long pad_type_val = STR_PAD_RIGHT; // 填充类型，默认为右侧填充
    zend_long left_pad = 0, right_pad = 0; // 左侧和右侧需要填充的长度
    zend_string *result = NULL; // 结果字符串

    // 解析参数
    ZEND_PARSE_PARAMETERS_START(2, 4)
        Z_PARAM_STR(input)
        Z_PARAM_LONG(pad_length)
        Z_PARAM_OPTIONAL
        Z_PARAM_STR(pad_string)
        Z_PARAM_LONG(pad_type_val)
    ZEND_PARSE_PARAMETERS_END();

    // 检查填充字符串是否为空，如果为空则使用空格作为填充字符串
    if (!pad_string) {
        pad_string = ZSTR_EMPTY_ALLOC();
    }

    // 检查填充类型是否合法
    if (pad_type_val < STR_PAD_LEFT || pad_type_val > STR_PAD_BOTH) {
        php_error_docref(NULL, E_WARNING, "Padding type has to be STR_PAD_LEFT, STR_PAD_RIGHT, or STR_PAD_BOTH");
        RETURN_FALSE;
    }

    // 计算需要填充的长度
    if (pad_length < 0 || (size_t)pad_length <= ZSTR_LEN(input)) {
        RETURN_STR_COPY(input);
    }

    // 计算左侧和右侧需要填充的长度
    if (pad_type_val == STR_PAD_BOTH) {
        left_pad = (pad_length - ZSTR_LEN(input)) / 2;
        right_pad = (pad_length - ZSTR_LEN(input)) - left_pad;
    } else {
        right_pad = pad_length - ZSTR_LEN(input);
        if (pad_type_val == STR_PAD_LEFT) {
            left_pad = right_pad;
            right_pad = 0;
        }
    }

    // 分配足够的内存空间来存储结果字符串
    result = zend_string_alloc(ZSTR_LEN(input) + left_pad + right_pad, 0);

    // 填充左侧
    memset(ZSTR_VAL(result), ' ', left_pad);

    // 复制原始字符串到结果字符串
    memcpy(ZSTR_VAL(result) + left_pad, ZSTR_VAL(input), ZSTR_LEN(input));

    // 填充右侧
    memset(ZSTR_VAL(result) + left_pad + ZSTR_LEN(input), ' ', right_pad);

    // 设置结果字符串的长度并返回
    ZSTR_VAL(result)[ZSTR_LEN(result)] = '\0';
    RETURN_NEW_STR(result);
}
/* }}} */

这段代码首先解析了传入的参数，然后根据填充类型计算出左侧和右侧需要填充的长度。接着，它会分配足够的内存空间来存储结果字符串，并将原始字符串复制到结果字符串中。最后，它会在左侧和右侧添加填充字符串，并返回结果字符串。