php函数之子字符串替换 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中
其对替换的实现比较巧妙，可以学习
需要继续查看源码，学习更多编写技巧以及设计技巧。