array.c(h) 通用数组解析

转自：http://www.cnblogs.com/kernel_hcy/archive/2009/10/23/1588873.html

Lighttpd提供了一个通用数组，这个数组与程序的其他部分练习较少，因此可以单独进行分析。

首先要说一下Lighttpd中的定义的一些数据结构。

在array.h中有下面的定义：

typedef enum { 
         TYPE_UNSET,         /* 数据的类型未设置，
                                这几种数据类型使用了面向对象的设计思想，
                                这个类型相当于父类型，继承关系见后面 
                              */
         TYPE_STRING,         /* 字符串类型 */
         TYPE_COUNT,         /* COUNT类型 */
         TYPE_ARRAY,         /* 数组类型 */
         TYPE_INTEGER,     /* 整数类型 */
         TYPE_FASTCGI,     /* FASTCGI类型 */
         TYPE_CONFIG         /* CONFIG类型 */
 } data_type_t;

这是一个枚举类型，定义了各个数据类型的标志。从中可以看出程序中所定义使用的数据类型的种类和个数。

Lighttpd在定义数据类型的时候使用了面向对象的思想，因此，程序具有很好的扩展性和适应性。这些类型中，最重要的是UNSET类型，这个类型在所有的数据类型中，起到了父类型的作用。在array.h中，UNSET类型的定义如下：

#define DATA_UNSET \
    data_type_t type; \
    buffer *key; \
    int is_index_key; /* 1 if key is a array index */ \
    struct data_unset *(*copy)(const struct data_unset *src); \
    void (* free)(struct data_unset *p); \
    void (* reset)(struct data_unset *p); \
        int (*insert_dup)(struct data_unset *dst, struct data_unset *src); \
    void (*print)(const struct data_unset *p, int depth)

typedef struct data_unset {
    DATA_UNSET;
} data_unset;

其中，UNSET类型数据的定义中，数据的实际定义部分使用宏DATA_UNSET，这样可以方便其他类型在定义中直接引用DATA_UNSET宏来模拟继承。在宏DATA_UNSET中，定义了下面五个函数指针：

struct data_unset *(*copy)(const struct data_unset *src); 
 void (* free)(struct data_unset *p); 
 void (* reset)(struct data_unset *p); 
 int (*insert_dup)(struct data_unset *dst, struct data_unset *src); 
 void (*print)(const struct data_unset *p, int depth)

这五个函数指针相当于UNSET的成员函数，其他类型可以通过对这五个指针赋值来实现成员函数的重写（Overwrite）。每种类型都配有自己特有的初始化函数，形式为：data_XXXXX *data_XXXXX_init(void)。在这些初始化函数中，对上面这五个函数指针进行赋值，当然，赋值的函数都应先定义好。

这几种类型的继承关系图如下：（类图）

下面分析一下STRING类型的初始化函数data_string * data_string_init(void):

 data_string *data_string_init(void)
 {
     data_string *ds;
     /*
 分配内存空间。
 这里用的是calloc函数，分配的空间会自动清零。
 */
     ds = calloc(1, sizeof(*ds));
     assert(ds);
     /*
 初始化各个数据成员，
 这里调用buffer_init函数，主要就是分配内存空间
 */
     ds->key = buffer_init();
     ds->value = buffer_init();
     /*确定成员函数的具体调用函数，对函数指针赋值*/
     ds->copy = data_string_copy;
     ds->free = data_string_free;
     ds->reset = data_string_reset;
     ds->insert_dup = data_string_insert_dup;
     ds->print = data_string_print;
     ds->type = TYPE_STRING;
     return ds;
 }

其他类型的init函数，以及其他函数都不难，读者可自行查看代码。

至于各个类型的用处以及各个类型中个成员变量的含义，暂且不用关心，只要知道这七个类型之间的关系即可，除了UNSET类型，其他类型的操作函数的实现都在文件data_XXXXX.c中。这些函数的实现都很简单，不在一一介绍，读者可自己看看。这七个类型构成了通用数组所要处理的类型，其中，在数组的定义和实现中只使用UNSET类型，利用上面的定义，通用数组可以不用关心数组中存储的到底是哪种具体的类型，只需将其按照UNSET类型来处理就可以了。这就实现了通用数组。

下面这个定义是通用数组的核心定义，也就是定义了数组。

typedef struct 
{
    /* UNSET类型的指针型数组，存放数组中的元素 */
    data_unset **data;
    /* 存放着排好序的各个元素的下标的数组 */
    size_t *sorted;
    size_t used;    /* data中使用了的长度，也就是数组中元素个数 */

        /* data的大小。data的大小会根据数据的多少变化，会为以后的数据预先分
           配空间 */
    size_t size;    
    
        size_t unique_ndx;        /*  */
        /* 比used大的最小的2的倍数。也就是离used最近的且比used大的2的倍
              数 ，用于在数组中利用二分法查找元素*/
    size_t next_power_of_2;
        /* data is weakref, don't bother the data */
        /* data就是一个指针，不用关系其所指向的内容 */
    int is_weakref;                
} array;

各个变量的含义见上。

array.h中还有一个定义：

typedef struct {
  DATA_UNSET;
  array *value;
} data_array;

这个定义了一个array类型的数据，也就是说，通用数组中存放的数据可以是通用数组也可以是通用数据类型，这样可以形成多维的通用数组。

在array.h中定义了如下的通用数组操作函数：

1、array *array_init(void);

初始化数组，分配空间。

2、array *array_init_array(array * a);

用数组a来初始化一个数组。也就是得到一个a的深拷贝。

3、void array_free(array * a);

释放数组。释放所有空间。

4、void array_reset(array * a);

重置data中的所有数据（调用UNSET类型数据中的reset函数），并将used设为0。相当于清空数组。

5、int array_insert_unique(array * a, data_unset * str);

将str插入到数组中。

6、data_unset *array_pop(array * a);

弹出data中的最后一个元素，返回奇指针，data中的最后一个位置设为NULL。

7、int array_print(array * a, int depth);

打印数组中的内容。depth参数用于在打印多维数组时，实现缩进。

8、a_unset *array_get_unused_element(array * a, data_type_t t);

返回第一个未使用的数据，也就是used位置的数据，这个数据不在数组中，返回这个数据指针后，将data[unsed]设为NULL。可能返回NULL。

9、data_unset *array_get_element(array * a, const char *key);

根据key值，返回数组中key值与之相同的数据

10、data_unset *array_replace(array * a, data_unset * du);

       如果数组中有与du的key值相同的数据，则用du替换那个数据，并返回那个数据的指针。如果不存在，则把du插入到数组中。（调用data_insert_unique函数）

11、 int array_strcasecmp(const char *a, size_t a_len, const char *b, size_t b_len);

这个函数并没用实现，仅仅给出了上面的定义。也许这个是用来比较两个字符串，并且可能会忽略大小写。

12、void array_print_indent(int depth);

根据depth打印空白，实现缩进。

13、size_t array_get_max_key_length(array * a);

返回数组中最长的key的长度。

另外，在array.c中定义了一个辅助函数static intarray_get_index(array *a, const char *key, size_t keylen, int *rndx)。这个函数的作用是通过key值，查找数据，返回其在数组data中的下标位置，并通过参数rndx返回其下标在数组sorted中的位置。

函数的定义如下：

static int array_get_index(array *a, const char *key, size_t keylen, int *rndx) 
 {
     /*参数keylen是key的长度*/
     int ndx = -1;
     int i, pos = 0;
     if (key == NULL) return -1;
     /* try to find the string */
     /* 
 * sorted数组是个下标数组，存放的是排好序的输入元素的下标，
 * 相当于一个排好序的数组。
      * 利用sorted数组进行二分查找。
      * 若找到，返回元素在data数组中的位置，并通过rndx返回
 * 其在sorted数组中的位置。
      * 若没有找到，通过rndx返回此元素在sorted中的位置，并返回-1
      */
 /* pos中存放的是元素在数组data中的位置 */
 /*  
 当data的空间不够时，通用数组每次为data增加16个空间，第一次初始化时，
 data的长度为16。因此，size始终是16的倍数。
 used可以为任何数值，当然要大于等于0,小于size。
 而next_power_of_2是大于used最小的2的倍数，如used=5,那么
 next_power_of_2就等于8。
 这样，used始终大于等于next_power_of_2的1/2。
 */
 /*
  在这儿的二分搜索中，next_power_of_2是个很有创意的技巧。
 next_power_of_2类似于一个标杆，利用这个标杆进行二分搜索可以减少很多
 出错的几率，也使程序更加易懂。效率上当然没有什么损失。下面的程序读者可
 自行看看，并不是很难。
  */
     for (i = pos = a->next_power_of_2 / 2; ; i >>= 1) 
 {
  int cmp;
  if (pos < 0) {
  pos += i;
  } else if (pos >= (int)a->used) {
  pos -= i;
  } else {
  /* 比较两个元素的key值 */
  cmp = buffer_caseless_compare(key, keylen
 , a->data[a->sorted[pos]]->key->ptr
 , a->data[a->sorted[pos]]->key->used
 );
  if (cmp == 0) {
  /* found */
  ndx = a->sorted[pos];
  break;
  } else if (cmp < 0) {/* 所找数据在前半部分 */
  pos -= i;
  } else { /*  所找数据在后半部分*/
  pos += i;
  }
  }
  if (i == 0) break;
     }
     if (rndx) *rndx = pos;
     return ndx;
 }

在上面列出的函数中，还有一个函数要重点讲解一下，也是最复杂的一个函数：int array_insert_unique(array *a, data_unset *str)。这个函数将数据str插入到数组中，当并不是单纯的插入，如果数组中存在key于str相同的数据，则把str的内容拷贝到这个数据中。

 int array_insert_unique(array *a, data_unset *str) {
     int ndx = -1;
     int pos = 0;
     size_t j;
     /* generate unique index if neccesary */
     if (str->key->used == 0 || str->is_index_key) {
                buffer_copy_long(str->key, a->unique_ndx++);
                    str->is_index_key = 1;
     }
     /* 在数组中查找与str具有相同key的数据 */
     if (-1 != (ndx = array_get_index(a, str->key->ptr, str->key->used, &pos))) 
         {
             /* 找到，复制 */
              if (a->data[ndx]->type == str->type) 
               {
                        str->insert_dup(a->data[ndx], str);
               } 
               else 
               {
                        fprintf(stderr, "a\n");
               }
               return 0;
     }
     /* 当数组的长度大于最大值时，不进行插入，并返回-1 */
     if (a->used+1 > INT_MAX) {
                     /* we can't handle more then INT_MAX entries: see array_get_index() */
                    return -1;
     }
 
     if (a->size == 0) {
                /* 数组为空 */
                /* 初始data的长度为16 */
                a->size   = 16;
                a->data   = malloc(sizeof(*a->data)     * a->size);
                a->sorted = malloc(sizeof(*a->sorted)   * a->size);
                assert(a->data);
                assert(a->sorted);
                for (j = a->used; j < a->size; j++) 
                             a->data[j] = NULL;
     } 
         else if (a->size == a->used) 
         {
           /* data已经满了，对data进行扩容，增加16个空间。 */
           /* 这就是为什么size一定是16的倍数 */
                a->size  += 16;
                a->data   = realloc(a->data, sizeof(*a->data) * a->size);
                a->sorted = realloc(a->sorted, sizeof(*a->sorted) * a->size);
                assert(a->data);
                assert(a->sorted);
                for (j = a->used; j < a->size; j++)
                              a->data[j] = NULL;
     }
     ndx = (int) a->used;
     a->data[a->used++] = str;
     /*
                在上面调用函数array_get_index的时候，
               已将str应该在数组sorted中位置存放在了pos中。 
         */
     if (pos != ndx /* 要插入的位置在中部 */&&((pos < 0) /* 在开始位置插入 */
                             ||buffer_caseless_compare(str->key->ptr
                                           , str->key->used
                                           , a->data[a->sorted[pos]]->key->ptr
                                           , a->data[a->sorted[pos]]->key->used
                             ) > 0)) 
         {
                /* 判断当前pos所对应的元素是否比str小，若是，这pos后移一位 */
                pos++;
     }
     /* 移动sorted数组中后面的数据，腾出位置。 */
     if (pos != ndx) {
                memmove(a->sorted + (pos + 1), a->sorted + (pos), (ndx - pos) * sizeof(*a->sorted));
     }
     /* insert */
     a->sorted[pos] = ndx;
     /* 如果used==next_power_of_2时，扩展next_power_of_2 */
     if (a->next_power_of_2 == (size_t)ndx) 
               a->next_power_of_2 <<= 1;
     return 0;
 }

其他函数都很简单，读者可自己查看。另外，print函数虽然复杂，但对整个程序的意义不大，读者可自行查看。

总结：

　　Lighttpd中的通用数组的设置主要是使用的面向对象的思想，使数组具有很好的扩展性和适应性。通用数组中二分查找的实现也是一个特色。还有就是使用sorted数组只对data中的数据的下标排序，这也是一个很有用的技巧。