【PHP】[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

相关文章