[PHP源码阅读]strpos、strstr和stripos、stristr函数

自己在github有对PHP源码更详细的笺注。感兴趣的能够扫描一下,给个star。PHP5.4源码注解。可以通过commit记录翻开已添加的评释。

strpos

mixed strpos ( string $haystack, mixed $needle [, int $offset = 0 ] )

一经offset指定了,查找会从offset的地点上马。offset不可能为负数。

回来needle第两遍面世在haystack的地点。如若在haystack中找不到needle,则赶回FALSE。

needle,假使needle不是字符串,它会被转换成整型数值并赋值为该数值的ASCII字符。请看上面例子。

例子

$str = "hello";
$pos = strpos($str, 111);
// 111的ASCII值是o,因此$pos = 4

strpos要旨源码

if (Z_TYPE_P(needle) == IS_STRING) {
     if (!Z_STRLEN_P(needle)) {
          php_error_docref(NULL TSRMLS_CC, E_WARNING, "Empty needle");
          RETURN_FALSE;
     }

     // 调用php_memnstr函数查找needle
     found = php_memnstr(haystack + offset,
                            Z_STRVAL_P(needle),
                            Z_STRLEN_P(needle),
                            haystack + haystack_len);
 } else {
      // 如果不是字符串,转换成数字并赋值为该数字的ASCII字符。
      if (php_needle_char(needle, needle_char TSRMLS_CC) != SUCCESS) {
          RETURN_FALSE;
      }
      //设置结束字符
      needle_char[1] = 0;
      found = php_memnstr(haystack + offset,
                        needle_char,
                        1,
                        haystack + haystack_len);
}

有某些要留心的是,假诺needle不是字符串的话,会调用php_needle_char函数将needle转成整型数字并更换为其ASCII值。

探寻函数

函数最终回到的是found,php_memnstr函数完结了探寻的章程。那么再持续看看php_memnstr函数做了怎么:

#define php_memnstr zend_memnstr

php_memnstr是函数zend_memnstr的宏定义,查看zend_memnstr函数如下:

static inline char *
zend_memnstr(char *haystack, char *needle, int needle_len, char *end)
{
    char *p = haystack;
    char ne = needle[needle_len-1];
    if (needle_len == 1) {
        return (char *)memchr(p, *needle, (end-p));
    }

    if (needle_len > end-haystack) {
        return NULL;
    }

    // 第一个优化,只查找end - needle_len次
    end -= needle_len;

    while (p <= end) {
        // 第二个优化,先判断字符串的开头和结尾是否一样再判断整个字符串
        if ((p = (char *)memchr(p, *needle, (end-p+1))) && ne == p[needle_len-1]) {
            if (!memcmp(needle, p, needle_len-1)) {
                return p;
            }
        }

        if (p == NULL) {
            return NULL;
        }

        p++;
    }

    return NULL;
}

end原来指向\0字符,然后end –
needle_len,若是前面部分是needle,就不用继续移动,因而只相比较end –
needle_len次。

strstr

string strstr ( string $haystack, mixed $needle [, bool $before_needle = false ] )

回去needle在haystack中首先次出现的职位到截至的字符串。

本条函数的界别轻重缓急写的。

假使needle在haystack中不设有,重回FALSE。

如果before_needle为true,则赶回haystack中needle在haystack第四遍面世的地点之前的字符串。

strstr主旨源码

if (found) {
        // 计算出found的位置
        found_offset = found - haystack;
        if (part) {
            RETURN_STRINGL(haystack, found_offset, 1);
        } else {
            RETURN_STRINGL(found, haystack_len - found_offset, 1);
        }
    }

strstr函数的前半有的跟strpos类似,不相同在于strstr函数在找到地点后,要求回到haystack部分的字符串。part变量就是调用strstr函数时传递的before_needle变量。

stripos

mixed stripos ( string $haystack, string $needle [, int $offset = 0 ] )

不区分轻重缓急写的strpos。完毕格局跟下边的近乎,紧假诺行使一份拷贝然后将急需比较的字符串转换成小写字符后进行再举办搜索。

stristr

string stristr ( string $haystack, mixed $needle [, bool $before_needle = false ] )

不区分轻重缓急写的strstr。

骨干源码

// 拷贝一份haystack
     haystack_dup = estrndup(haystack, haystack_len);

    if (Z_TYPE_P(needle) == IS_STRING) {
        char *orig_needle;
        if (!Z_STRLEN_P(needle)) {
            php_error_docref(NULL TSRMLS_CC, E_WARNING, "Empty needle");
            efree(haystack_dup);
            RETURN_FALSE;
        }
        orig_needle = estrndup(Z_STRVAL_P(needle), Z_STRLEN_P(needle));
        // 调用php_stristr函数找出orig_needle的值。
        found = php_stristr(haystack_dup, orig_needle,    haystack_len, Z_STRLEN_P(needle));
        efree(orig_needle);
    } else {
        if (php_needle_char(needle, needle_char TSRMLS_CC) != SUCCESS) {
            efree(haystack_dup);
            RETURN_FALSE;
        }
        needle_char[1] = 0;

        found = php_stristr(haystack_dup, needle_char,    haystack_len, 1);
    }

    if (found) {
        found_offset = found - haystack_dup;
        if (part) {
            RETVAL_STRINGL(haystack, found_offset, 1);
        } else {
            RETVAL_STRINGL(haystack + found_offset, haystack_len - found_offset, 1);
        }
    } else {
        RETVAL_FALSE;
    }

    // 释放变量
    efree(haystack_dup);

可以领会,found是从php_stristr中取得的,继续翻看php_stristr函数:

PHPAPI char *php_stristr(char *s, char *t, size_t s_len, size_t t_len)
{
    php_strtolower(s, s_len);
    php_strtolower(t, t_len);
    return php_memnstr(s, t, t_len, s + s_len);
}

其一函数的成效就是将字符串都转成小写之后调用php_mennstr函数来寻找needle在haystack第四次面世的地点。

总结

因为strpos/stripos再次来到的是岗位,地方从0开头盘算,所以判断查找未果都用  === FALSE 更适合。

阅读PHP的源码收获挺多,一方面可以了解某个函数的切切实实贯彻原理是哪些的,另一方面可以学学到一些编程优化方案。

 

到此本文为止,如果还有啥样难点照旧提议,可以多多调换,原创文章,文笔有限,才疏学浅,文中若有不正之处,万望告知。

如果本文对你有帮扶,望点下推荐,谢谢^_^

 

末尾再安利一下,我在github有对PHP源码更详细的诠释。感兴趣的可以扫描一下,给个star。PHP5.4源码表明。可以经过commit记录翻开已添加的笺注。

更多源码小说,欢迎访问个人主页继续翻看:hoohack