php函數之子字串替換#65279; str_replace

str_replace — 子字串替換 [str_replace]
mixed str_replace ( mixed $search , mixed $replace , mixed $subject [, int &$count ] )
php函數str_replace: 返回一個字串或者數組。該字串或數組是將 subject 中全部的 search 都被 replace 替換之後的結果。

現在我們所能知道的一些這個函數的用法，如：str_replace("#", "-", "dizaz#7#final")，str_replace(array('#', '$'), "-", "dizaz#7$final") 等，就這些調用方式，php內部是如何?的呢，鑒於[深入理解PHP核心]，在這裡小做分析。

測試代碼：

複製代碼 代碼如下:<?php
$object = "dizaz#7#final";
$res = str_replace("#", "-", $object);
echo $res;

如上，先從字元“#”替換為字元“-”開始。

預備工作：

下載PHP原始碼，http://www.php.net下載即可
打造自己的閱讀代碼的工具[本人使用VIM+CSCOPE] 另：Linux使用者也推薦圖形化查看原始碼工具kscope [google之]
編譯工具[gcc]，調試工具[gdb]，另：GDB圖形化連接埠DDD也很不錯，推薦
編譯PHP源碼，記得使用--enable-debug [當然也希望通過./configure --help 看看PHP提供的一些編譯選項，會有很多收穫的]
開始分析：

通過[深入理解PHP核心]閱讀，我們不難發現其PHP提供標準函數所在目錄為PHP-SOURCE-DIR/ext/standard目錄下，由於是字串函數，很容易我們就可以在此目錄下找到str_replace函數實現的檔案 string.c，接下來就圍繞著這個檔案進行分析。[當然用CScope很容易就可以鎖定，用:cs find s str_replace]

查詢得知其定義實現： 複製代碼 代碼如下:/* {{{ proto mixed str_replace(mixed search, mixed replace, mixed subject [, int &replace_count])
Replaces all occurrences of search in haystack with replace */
PHP_FUNCTION(str_replace)
{
php_str_replace_common(INTERNAL_FUNCTION_PARAM_PASSTHRU, 1);

}
/* }}} */

現在需要查看函數php_str_replace_common函數 複製代碼 代碼如下:/* {{{ php_str_replace_common
*/
static void php_str_replace_common(INTERNAL_FUNCTION_PARAMETERS, int case_sensitivity)
{
/**
* TODO
* typedef struct _zval_struct zval;
* typedef struct _zend_class_entry zend_class_entry
*
* struct _zval_struct {
* zvalue_value value;
* zend_uint refcount__gc;
* zend_uchar type;
* zend_uchar is_ref__gc;
* };
*
* typedef union _zvalue_value {
* long lval;
* double dval;
* struct {
* char *val;
* int len;
* } str;
* HashTable *ht;
* zend_object_value obj;
* } zvalue_value;
*
* typedef struct _zend_object {
* zend_class_entry *ce;
* HashTable *properties;
* HashTable *guards;
* } zend_object;
*
*/
zval **subject, **search, **replace, **subject_entry, **zcount = NULL;
zval *result;
char *string_key;
uint string_key_len;
ulong num_key;
int count = 0;
int argc = ZEND_NUM_ARGS();
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ZZZ|Z", &search, &replace, &subject, &zcount) == FAILURE) {
return;
}
SEPARATE_ZVAL(search);
SEPARATE_ZVAL(replace);
SEPARATE_ZVAL(subject);
/* Make sure we're dealing with strings and do the replacement. */
if (Z_TYPE_PP(search) != IS_ARRAY) {
....//代碼省濾
} else { /* if subject is not an array */
php_str_replace_in_subject(*search, *replace, subject, return_value, case_sensitivity, (argc > 3) ? &count : NULL);
}
if (argc > 3) {
zval_dtor(*zcount);
ZVAL_LONG(*zcount, count);
}
}
/* }}} */

繼續跟蹤php_str_replace_in_subject 複製代碼 代碼如下:/* {{{ php_str_replace_in_subject
*/
static void php_str_replace_in_subject(zval *search, zval *replace, zval **subject, zval *result, int case_sensitivity, int *replace_count)
{
zval **search_entry,
**replace_entry = NULL,
temp_result;
char *replace_value = NULL;
int replace_len = 0;
/* Make sure we're dealing with strings. */
convert_to_string_ex(subject);
Z_TYPE_P(result) = IS_STRING;
if (Z_STRLEN_PP(subject) == 0) {
ZVAL_STRINGL(result, "", 0, 1);
return;
}
/* If search is an array */
if (Z_TYPE_P(search) == IS_ARRAY) {
...//不走這步
} else {
if (Z_STRLEN_P(search) == 1) { //例子中只有”#“所以，執行這一步。
php_char_to_str_ex(Z_STRVAL_PP(subject),//subject的值，也就是dizaz#7#final
Z_STRLEN_PP(subject), //擷取subject的長度
Z_STRVAL_P(search)[0], //由於只有1個”#”，所以只需要第一個字元
Z_STRVAL_P(replace), //所要替換成的字元，現在是“-”
Z_STRLEN_P(replace), //目標字元的長度，現在為1
result, //替換結果
case_sensitivity, //大小寫是否敏感，預設是1
replace_count); //替換次數
} else if (Z_STRLEN_P(search) > 1) {
Z_STRVAL_P(result) = php_str_to_str_ex(Z_STRVAL_PP(subject), Z_STRLEN_PP(subject),
Z_STRVAL_P(search), Z_STRLEN_P(search),
Z_STRVAL_P(replace), Z_STRLEN_P(replace), &Z_STRLEN_P(result), case_sensitivity, replace_count);
} else {
MAKE_COPY_ZVAL(subject, result);
}
}
}

到現在為止，我們的目標最終鎖定到了php_char_to_str_ex 函數，現在只需要分析這個函數就OK了。其實現為： 複製代碼 代碼如下:/* {{{ php_char_to_str_ex
*/
PHPAPI int php_char_to_str_ex(char *str, uint len, char from, char *to, int to_len, zval *result, int case_sensitivity, int *replace_count)
{
int char_count = 0;
int replaced = 0;
char *source, *target, *tmp, *source_end=str+len, *tmp_end = NULL;
if (case_sensitivity) { //現在case_sensitivity = 1
char *p = str, *e = p + len;
　　　　　//計算需要替換幾次
while ((p = memchr(p, from, (e - p)))) {
char_count++;
p++;
}
} else {
for (source = str; source < source_end; source++) {
if (tolower(*source) == tolower(from)) {
char_count++;
}
}
}
if (char_count == 0 && case_sensitivity) {
ZVAL_STRINGL(result, str, len, 1);
return 0;
}
//計算替換以後的長度，並且儲存到result中。
Z_STRLEN_P(result) = len + (char_count * (to_len - 1));
//申請記憶體，存放替換後的資料
Z_STRVAL_P(result) = target = safe_emalloc(char_count, to_len, len + 1);
//設定結果是一個字串
Z_TYPE_P(result) = IS_STRING;
//target跟result的值都指向統一塊記憶體，所以只需要處理target
if (case_sensitivity) {
char *p = str, *e = p + len, *s = str;
while ((p = memchr(p, from, (e - p)))) { //判斷在第幾個字元出現#
memcpy(target, s, (p - s)); //把#以前的資料拷貝給target
target += p - s;
memcpy(target, to, to_len); //把目標字元拷貝給target[當然此時的target是開始target+p-s的]
target += to_len;
p++;
s = p;
if (replace_count) {
*replace_count += 1; //設定替換次數
}
}
//如果後面還有，繼續添加到target後，這樣target所指向的記憶體塊已經是替換好的資料了。
if (s < e) {
memcpy(target, s, (e - s));
target += e - s;
}
} else {
for (source = str; source < source_end; source++) {
if (tolower(*source) == tolower(from)) {
replaced = 1;
if (replace_count) {
*replace_count += 1;
}
for (tmp = to, tmp_end = tmp+to_len; tmp < tmp_end; tmp++) {
*target = *tmp;
target++;
}
} else {
*target = *source;
target++;
}
}
}
*target = 0;
return replaced;
}
/* }}} */

如上注釋，其就這樣完成了對於字元到字串的替換。至於其中怎麼return，怎麼一個詳細的過程，需要再對PHP執行過程有個相對的瞭解。
當然可以用gdb下斷點到php_char_to_str_ex函數，來瞭解其詳細執行過程。
下一篇來做對於字串替換成字串的分析。
小結：
其結果是存在zval中
其對替換的實現比較巧妙，可以學習
需要繼續查看源碼，學習更多編寫技巧以及設計技巧。