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);
}
/* }}} */
這段代碼首先解析了傳入的參數,然后根據填充類型計算出左側和右側需要填充的長度。接著,它會分配足夠的內存空間來存儲結果字符串,并將原始字符串復制到結果字符串中。最后,它會在左側和右側添加填充字符串,并返回結果字符串。