PHP源码阅读笔记十九：array_file,range函

PHP源码阅读笔记十九：array_file,range函数
array_fill
(PHP 4 >= 4.2.0, PHP 5)

array_fill — 用给定的值填充数组
说明
array array_fill ( int start_index, int num, mixed value )

array_fill() 用 value 参数的值将一个数组填充 num 个条目，键名由 start_index 参数指定的开始。注意 num 必须是一个大于零的数值，否则 PHP 会发出一条警告。

对于参数start_index，只能是字符串，整形，浮点型
其源码如下：

1
2
3
4
5
6
7
8

switch (Z_TYPE_PP(start_key)) {
case IS_STRING:
case IS_LONG:
case IS_DOUBLE:
    .......
    convert_to_long_ex(start_key);
    ......
}

程序首先赋值给return_value第一个值，然后循环num – 1次: 给这个值添加refcount,并将它添加到return_value的Hash Table中

range
(PHP 3 >= 3.0.8, PHP 4, PHP 5)

range — 建立一个包含指定范围单元的数组
说明
array range ( mixed low, mixed high [, number step] )

range() 返回数组中从 low 到 high 的单元，包括它们本身。如果 low > high，则序列将从 high 到 low。

新参数: 可选的 step 参数是 PHP 5.0.0 新加的。

如果给出了 step 的值，它将被作为单元之间的步进值。step 应该为正值。如果未指定，step 则默认为 1。

从代码可以看出，本函数仅支持字符数组，浮点数组和整形数组，并且支持递增和递减两种形式（在版本4.0.1之后才有）
以字符数组为例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

 
if (Z_TYPE_P(zlow) == IS_STRING && Z_TYPE_P(zhigh) == IS_STRING && Z_STRLEN_P(zlow) >= 1 && Z_STRLEN_P(zhigh) >= 1) {
    int type1, type2;
    unsigned char *low, *high;
    long lstep = (long) step;
 
    type1 = is_numeric_string(Z_STRVAL_P(zlow), Z_STRLEN_P(zlow), NULL, NULL, 0);
    type2 = is_numeric_string(Z_STRVAL_P(zhigh), Z_STRLEN_P(zhigh), NULL, NULL, 0);
    if (type1 == IS_DOUBLE || type2 == IS_DOUBLE || is_step_double) {
        goto double_str;
    } else if (type1 == IS_LONG || type2 == IS_LONG) {
        goto long_str;
    }
    convert_to_string(zlow);    //    转化为字符串，此函数的实现在zend_operators.c的536行：ZEND_API void _convert_to_string(zval *op ZEND_FILE_LINE_DC)
    convert_to_string(zhigh);
    low = (unsigned char *)Z_STRVAL_P(zlow);    //    当所给字符串长度大于1时，取第一个字符
    high = (unsigned char *)Z_STRVAL_P(zhigh);
 
    if (*low > *high) { //    递减数组
    if (lstep <= 0) {
        err = 1;
        goto err;
    }
    for (; *low >= *high; (*low) -= (unsigned int)lstep) {
        add_next_index_stringl(return_value, low, 1, 1);
        if (((signed int)*low - lstep) < 0) {
            break;
        }
    }
    } else if (*high > *low) { //    递增数组
    if (lstep <= 0) {
        err = 1;
        goto err;
    }
    for (; *low <= *high; (*low) += (unsigned int)lstep) {
        add_next_index_stringl(return_value, low, 1, 1);
        if (((signed int)*low + lstep) > 255) {    //    只支持ASCII的255个字符
            break;
        }
    }
    } else {    //    开始和结束相等，则只返回包含一个元素的数组
        add_next_index_stringl(return_value, low, 1, 1);
}

对于浮点型和整形的处理基本类似，只有写入Hash Table的方法不同
浮点型用的是add_next_index_double
整形用的是add_next_index_long

EOF

PHP源码阅读笔记十八：array_diff_key，array_diff_assoc，array_udiff_assoc 函数

PHP源码阅读笔记十八：array_diff_key，array_diff_assoc，array_udiff_assoc
【array_diff_key】

(PHP 5 >= 5.1.0RC1)
array_diff_key — 使用键名比较计算数组的差集
说明

array array_diff_key ( array array1, array array2 [, array ...] )

array_diff_key() 返回一个数组，该数组包括了所有出现在 array1 中但是未出现在任何其它参数数组中的键名的值。注意关联关系保留不变。

【array_diff_assoc】

(PHP 4 >= 4.3.0, PHP 5)
array_diff_assoc — 带索引检查计算数组的差集
说明

array array_diff_assoc ( array array1, array array2 [, array ...] )

array_diff_assoc() 返回一个数组，该数组包括了所有在 array1 中但是不在任何其它参数数组中的值。注意和 array_diff() 不同的是键名也用于比较。

之所以把这三个函数放在一起是因为他们调用的最后是一个函数:php_array_diff_key
【array_diff_uassoc】

(PHP 5)
array_diff_uassoc — 用用户提供的回调函数做索引检查来计算数组的差集
说明

array array_diff_uassoc ( array array1, array array2 [, array ..., callback key_compare_func] )

array_diff_uassoc() 返回一个数组，该数组包括了所有在 array1 中但是不在任何其它参数数组中的值。

这三个函数调用php-array_diff_key的方式如下：

1
2
3

array_diff_key:         php_array_diff_key(INTERNAL_FUNCTION_PARAM_PASSTHRU, DIFF_COMP_DATA_NONE);
array_diff_assoc:      php_array_diff_key(INTERNAL_FUNCTION_PARAM_PASSTHRU, DIFF_COMP_DATA_INTERNAL);
array_udiff_assoc:    php_array_diff_key(INTERNAL_FUNCTION_PARAM_PASSTHRU, DIFF_COMP_DATA_USER);

其中参数的宏定义如下：

1
2
3
4
5

#define INTERNAL_FUNCTION_PARAM_PASSTHRU ht, return_value, return_value_ptr, this_ptr, return_value_used TSRMLS_CC
 
#define DIFF_COMP_DATA_NONE    -1
#define DIFF_COMP_DATA_INTERNAL 0
#define DIFF_COMP_DATA_USER     1

php_array_diff_key函数首先要根据传入的data_compare_type（即上面定义的三个宏），判断所要使用的比较函数，然后遍历第一个数组，针对每一个元素与其它数组比较，看其它数字是否存在
如果存在则删
针对此函数的源码做一个注释性的说明：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

 
    for (i = 0; i < argc; i++) {
        if (Z_TYPE_PP(args[i]) != IS_ARRAY) {
            php_error_docref(NULL TSRMLS_CC, E_WARNING, "Argument #%d is not an array", i + 1);
            RETVAL_NULL();
            goto out;    //    goto语句，这个貌似一般是高手用的，嘿嘿
        }
    }
 
    array_init(return_value);    //    返回数组初始化，初始化存储此数组的Hash Table
 
    for (p = Z_ARRVAL_PP(args[0])->pListHead; p != NULL; p = p->pListNext) {    //    遍历第一个参数包含的双向链表
        if (p->nKeyLength == 0) {    //    数组索引为数字
            ok = 1;
            for (i = 1; i < argc; i++) {    //    对其它的数组进行判断
                if (zend_hash_index_find(Z_ARRVAL_PP(args[i]), p->h, (void**)&data) == SUCCESS &&
                    (!diff_data_compare_func ||
                     diff_data_compare_func((zval**)p->pData, data TSRMLS_CC) == 0)) {
                    ok = 0;
                    break;
                }
            }
            if (ok) {    在第一个数组中，不在其它数组中
                (*((zval**)p->pData))->refcount++;
                zend_hash_index_update(Z_ARRVAL_P(return_value), p->h, p->pData, sizeof(zval*), NULL);
            }
        } else {    //    索引为字符串
            ok = 1;
            for (i = 1; i < argc; i++) {
                if (zend_hash_quick_find(Z_ARRVAL_PP(args[i]), p->arKey, p->nKeyLength, p->h, (void**)&data) == SUCCESS &&
                    (!diff_data_compare_func ||
                     diff_data_compare_func((zval**)p->pData, data TSRMLS_CC) == 0)) {
                    ok = 0;
                    break;
                }
            }
            if (ok) {
                (*((zval**)p->pData))->refcount++;
                zend_hash_quick_update(Z_ARRVAL_P(return_value), p->arKey, p->nKeyLength, p->h, p->pData, sizeof(zval*), NULL);
            }
        }
    }

关于比较函数：
DIFF_COMP_DATA_NONE参数对应的是NULL,即不存在比较，使用索引查找就可以了
DIFF_COMP_DATA_INTERNAL参数对应的是zval_compare，即索引和值都会比较
DIFF_COMP_DATA_USER参数对应的是zval_user_compare，即用户自定义的函数

EOF

PHP源码阅读笔记十七：array_diff，array_udiff，array_diff_ukey，array_diff_uassoc，array_udiff_uassoc

PHP源码阅读笔记十七：array_diff，array_udiff，array_diff_ukey，array_diff_uassoc，array_udiff_uassoc
这4个函数调用的是同一个函数php_array_diff，所不同的是他们的参数。
虽然这五个函数都是调用同一个方法，但是在这个方法中，除了对输入的处理和释放相关内存的操作外，程序的共用并不是太多
难道是因为在语义的相似？

1
2
3
4
5
6
7
8
9
10
11
12
13
14

array_diff:        php_array_diff(INTERNAL_FUNCTION_PARAM_PASSTHRU, DIFF_NORMAL,
                                    DIFF_COMP_DATA_INTERNAL, DIFF_COMP_KEY_INTERNAL);
 
array_diff_ukey: php_array_diff(INTERNAL_FUNCTION_PARAM_PASSTHRU, DIFF_KEY,
                                 DIFF_COMP_DATA_INTERNAL, DIFF_COMP_KEY_USER);
 
array_udiff:    php_array_diff(INTERNAL_FUNCTION_PARAM_PASSTHRU, DIFF_NORMAL,
                            DIFF_COMP_DATA_USER, DIFF_COMP_KEY_INTERNAL);
f
array_diff_uassoc: php_array_diff(INTERNAL_FUNCTION_PARAM_PASSTHRU, DIFF_ASSOC,
                            DIFF_COMP_DATA_INTERNAL, DIFF_COMP_KEY_USER);
 
array_udiff_uassoc: php_array_diff(INTERNAL_FUNCTION_PARAM_PASSTHRU, DIFF_ASSOC,
                            DIFF_COMP_DATA_USER, DIFF_COMP_KEY_USER);

程序说明：
在获得了输入和作了相关错误处理后
程序首先确认比较函数是哪个，此处，针对不同的behavior和data_compare_type有不同的比较函数，也有不同的输入参数错误处理
然后对输入的参数复制并按照之前得到的diff_key_compare_func进行排序，排序调用的是zend_qsort函数
然后初始化返回数组的hash table，并将第一个参数复制到返回数组
最后遍历第一个参数的所有值，并判断是否不在其它参数中，
在遍历过程中，如果某一个值在其它参数中则删除返回数组中所有等于这个值的元素，如果某一个值不在其它参数中，则跳过
这样留下来的就是需要返回的值。

EOF