STL源码剖析(list)

SGI STL中list是使用环状双向链表实现的。它的结点结构定义如下：

 template <class T>
 struct __list_node {
     typedef void* void_pointer;
     void_pointer next;
     void_pointer prev;
     T data;
 };

list定义了属于自己的迭代器，并重载了operator*(用于取结点的data成员)、operator+(用于取next结点)等等。

 template<class T, class Ref, class Ptr>
 struct __list_iterator {
     // 定义相应型别
     typedef __list_iterator<T, T&, T*>             iterator;
     typedef __list_iterator<T, Ref, Ptr>           self;

     typedef bidirectional_iterator_tag iterator_category;
     typedef T value_type;
     typedef Ptr pointer;
     typedef Ref reference;
     typedef __list_node<T>* link_type;
     typedef size_t size_type;
     typedef ptrdiff_t difference_type;

     // 拥有一个指向对应结点的指针
     link_type node;

     // 构造函数
     __list_iterator() {}
     __list_iterator(link_type x) : node(x) {}
     __list_iterator(const iterator& x) : node(x.node) {}    

     // 重载了iterator必须的操作符
     reference operator*() const { return (*node).data; }
     pointer operator->() const { return &(operator*()); }
     self& operator++() {
         node = (link_type)((*node).next);
         return *this;
     }
     self& operator--() {
         node = (link_type)((*node).prev);
         return *this;
     }
     // ...
 };

list的定义比较简单，而且环状双向链表的操作并不用过多的考虑边界条件。

list创建的时候会创建一个空白的结点，并用其node成员指向它，下面是list的基本定义：

 template <class T, class Alloc = alloc>
 class list {
 protected:
     typedef void* void_pointer;
     typedef __list_node<T> list_node;
     typedef simple_alloc<list_node, Alloc> list_node_allocator;
 public:
     typedef T value_type;
     typedef value_type* pointer;
     typedef value_type& reference;
     typedef list_node* link_type;
     typedef size_t size_type;
     typedef ptrdiff_t difference_type;
 public:
     // 定义迭代器类型
     typedef __list_iterator<T, T&, T*> iterator;
 protected:
     link_type node;  // 空白结点  链表尾结点
     // ...
 };

下面是list的示意图

根据示意图我们很容易理解list的构造：

 template <class T, class Alloc = alloc>
 class list {
 public:
 // ...
     // 可以从图中直观的看出来
     iterator begin() { return (link_type)((*node).next); }
     iterator end() { return node; }

     // 默认构造函数
     list() { empty_initialize(); }
 protected:
     // 为结点分配内存
     link_type get_node() { return list_node_allocator::allocate(); }
     // 回收内存
     void put_node(link_type p) { list_node_allocator::deallocate(p); }
     // 构造node
     link_type create_node(const T& x) {
         link_type p = get_node();
         construct(&p->data, x);
         return p;
     }
     // 销毁node
     void destroy_node(link_type p) {
         destroy(&p->data);
         put_node(p);
     }
     // 初始化
     void empty_initialize() {
         node = get_node();
         node->next = node;
         node->prev = node;
     }
 // ...
 };

list成员函数的实现其实就是对环状双向链表的操作。

首先是insert、erase、transfer的实现，关于插入删除大部分都调用这三个函数，实际上就是改变结点pre跟next指针的指向。

 iterator insert(iterator position, const T& x) {
     link_type tmp = create_node(x);
     // 改变四个指针的指向 实际就是双向链表元素的插入
     tmp->next = position.node;
     tmp->prev = position.node->prev;
     (link_type(position.node->prev))->next = tmp;
     position.node->prev = tmp;
     return tmp;
 }

 iterator erase(iterator position) {
     // 改变四个指针的指向 实际就是双向链表的元素删除
     link_type next_node = link_type(position.node->next);
     link_type prev_node = link_type(position.node->prev);
     prev_node->next = next_node;
     next_node->prev = prev_node;
     destroy_node(position.node);
     return iterator(next_node);
 }

 // 将[first, last)插入到position位置(可以是同一个链表)
 void transfer(iterator position, iterator first, iterator last) {
     if (position != last) {
         // 实际上也是改变双向链表结点指针的指向 具体操作看下图
         (*(link_type((*last.node).prev))).next = position.node;
         (*(link_type((*first.node).prev))).next = last.node;
         (*(link_type((*position.node).prev))).next = first.node;
         link_type tmp = link_type((*position.node).prev);
         (*position.node).prev = (*last.node).prev;
         (*last.node).prev = (*first.node).prev;
         (*first.node).prev = tmp;
     }
 }

有了上面3个函数，list对外的接口实现就非常简单了

 void push_front(const T& x) { insert(begin(), x); }
 void push_back(const T& x) { insert(end(), x); }
 void pop_front() { erase(begin()); }
 void pop_back() {
     iterator tmp = end();
     erase(--tmp);
 }

 // splice有很多重载版本
 void splice(iterator position, list&, iterator first, iterator last) {
     if (first != last)
         transfer(position, first, last);
 }

 // merge函数实现跟归并排序中合并的操作类似
 template <class T, class Alloc>
 void list<T, Alloc>::merge(list<T, Alloc>& x) { ... }

 // reserse函数每次都调用transfer将结点插入到begin()之前
 template <class T, class Alloc>
 void list<T, Alloc>::reverse() {
     if (node->next == node || link_type(node->next)->next == node) return;
     iterator first = begin();
     ++first;
     while (first != end()) {
         iterator old = first;
         ++first;
         transfer(begin(), old, first);
     }
 }    

 // list必须使用自己的sort()成员函数 因为STL算法中的sort()只接受RamdonAccessIterator
 // 该函数采用的是quick sort
 template <class T, class Alloc>
 void list<T, Alloc>::sort() { ... }