[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;
}

第一個優化，由於(char *)memchr(p, *needle, (end-p+1)是在end - needle_len + 1（即haystack_len+1）中查找，若是p爲空，說明needle的第一個字符在p中從未出現過。

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記錄查看已添加的註解。