php trim函數是怎麼實現的

在實際開發中遇到關於 trim 函數的2個問題：
1：使用trim函數不能去除2個以上的連續點號(.)
2 : 使用trim函數去除字串的問題
先說一下第一個問題。
下面的一段程式碼：
php -r "echo trim('abcdcba...','...');"
我的本意是要將字串abcdcba...最後三個點去掉，結果是報錯。

PHP Warning:  trim(): Invalid '..'-range, no character to the left of '..' in Command line code on line 1
Warning: trim(): Invalid '..'-range, no character to the left of '..' in Command line code on line 1
PHP Warning:  trim(): Invalid '..'-range, no character to the right of '..' inCommand line code on line 1
Warning: trim(): Invalid '..'-range, no character to the right of '..' in Command line code on line 1

這個問題其實很好解釋，因為 trim 函數本書可以範圍操作，例如 如果trim函數的第二個引數 a..d，它就會把a b c d 都去掉。因為省略號的原因，所以trim函數的第二個引數不能用..開頭或者結尾。

第二個問題：
再看一個例子:
php -r 'echo trim("abcdcba","abc")."\n";'
我的本意是將字串abcdcba最前面的abc去掉保留dcba,但結果卻是這樣的:
d
也就是說他會把a b c分別去掉。這應該算是個坑吧。

通過對底層原始碼的分析來說一下為什麼會出現這2種情況。
trim函數的原始碼師在php程式碼根目錄開始的 ext/standard/string.c
函數的定義如下:

PHP_FUNCTION(trim)
{
    php_do_trim(INTERNAL_FUNCTION_PARAM_PASSTHRU, 3);
}

可以看到，定義呼叫了另外的函數,函數體如下:

static void php_do_trim(INTERNAL_FUNCTION_PARAMETERS, int mode)
{
    char *str;
    char *what = NULL;
    int str_len, what_len = 0;
    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRM\_CC, "s|s", &str, &str_len, &what, &what_len) == FAILURE) {
        return;
    } 
    php_trim(str, str_len, what, what_len, return_value, mode TSRMLS_CC);
}

zend_parse_parameters函數的作用就是接受引數,有興趣的同學可以查閱相關資料。從程式碼可以看到，函數接受了2個字串型別的引數，一個str,就是需要處理的字串，第二個引數是what,用來表示需要去除的字元。
這個函數在最後用呼叫了另外一個函數，函數php_trim,函數體如下:

PHPAPI char *php_trim(char *c, int len, char *what, int what_len, zval *return_value, int mode TSRMLS_DC)
{
    register int i;
    int trimmed = 0;
    char mask[256];
    
        if(what) {
            php_charmask((unsigned char*)what, what_len, mask TSRMLS_CC);
        } else {
            php_charmask((unsigned char*)" \n\r\t\v\0", 6, mask TSRMLS_CC);
        }

        if (mode & 1) {
            for (i = 0; i = 0; i--) {
                if (mask[(unsigned char)c[i]]) {
                    len--;
                } else {
                    break;
                }
            }
        }

        if (return_value) {
            RETVAL_STRINGL(c, len, 1);
        } else {
            return estrndup(c, len);
        }
        return "";
}

這個函數就是php真正處理去除操作的結構。
剛開始就是定義了簡單的變數，再下面對變數what有一個判斷，來判斷是否傳遞了要去除的字元。可以看到，根據是不是傳遞了what，函數傳遞給php_charmask函數的引數不一樣，從這兒可以看出，如果trim沒有傳要去除的字元，預設情況是去除" \n\r\t\v\0"六個字元的,下面來看看php_charmask函數進行了哪些操作。

static inline int php\_charmask(unsigned char *input, int len, char *mask TSRMLS_DC)
{
    unsigned char *end;
    unsigned char c;
    int result = SUCCESS;
    memset(mask, 0, 256);
    for (end = input+len; input = c) { 
            memset(mask+c, 1, input[3] - c + 1);
            input+=3;
        } else if ((input+1 = input) { /\* there was no 'left' char \*/
                php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid '..'-range, no character to the left of '..'");
                result = FAILURE;
                continue;
            }
            if (input+2 >= end) { /\* there is no 'right' char \*/
                php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid '..'-range, no character to the right of '..'");
                result = FAILURE;
                continue;
            }
            if (input[-1] > input[2]) { /\* wrong order \*/
                php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid '..'-range, '..'-range needs to be incrementing");
                result = FAILURE;
                continue;
            }
            /* FIXME: better error (a..b..c is the only left possibility?) */
            php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid '..'-range");
            result = FAILURE;
            continue;
        } else {
            mask[c]=1;
        }
    }    
    return result;
}

這個函數的作用主要是，建立要去除的字元的雜湊對應關係,剛開始考慮了特殊情況像a..d這樣的情況(從這兒也能看出來為什麼trim函數不能處理...的情況)。後面就是建立hash結構的過程。最後的結果是一個陣列，以要去除的字元是　abc　為例:

    mask['a'] = 1;
    mask['b'] = 1;
    mask['c'] = 1;

這樣的hash結構，最後返回的就是這個 mask(實際沒有返回，使用參照變數傳值的方式做到資料的返回)
前面的都是準備工作，後面的就是真正處理去除操作了。
通過原始碼可以看到，下面的操作先對mode這個變數做了判斷，那麼mode這個變數是幹嘛的?答案就是用來處理　ltrim rtirm trim３個函數的。
下面師一段Ｃ語言程式碼:

#includeint main(){
     printf("%d\n",1&1);
     printf("%d\n",2&2);
     printf("%d\n",3&1);
     printf("%d\n",3&2);
     return 0;
}

這段程式碼的輸出結果如下:

1
2
1
2

通過這個大家可以看出來，trim的底層是怎麼處理的。先對ｍｏｄｅ 分別取模，再做相應的操作。
實際的去除操作就很簡單了。
定義一個len來儲存字串的長度，c　是一個字元指標，剛開始從左邊開始去除，判斷c中的字元是否在hashmask中存在，如果存在，就將c 的指標向後移動一位，將len減去一位，如果發現*c的字元不存在於hashmask中，停止操作(可能和實際程式碼邏輯不不一致，但思想師一樣的)。相關程式碼如下:

for (i = 0; i

左邊操作完成以後，右邊的操作比較簡單，從*c最右邊開始匹配，如果匹配到，就將len的長度減１，如果沒有舊停止操作。相關的程式碼如下:

for (i = len - 1; i >= 0; i--) {
    if (mask[(unsigned char)c[i]]) {
        len--;
    } else {
        break;
    }
}

最後就是一個簡單返回操，把c指標現在指向的位置以後的len個字元返回。實現返回的操作。整個過程完成。
相關程式碼如下:

if (return_value) {
   RETVAL_STRINGL(c, len, 1);
} else {
   return estrndup(c, len);
}

最後感嘆一下:所有的事情最重要的還是你自己.