QCore/Library说明文档
QCore/Library说明文档
李文超
前言
QCore/Library是一套类STL的类库，它在标准库的范围内删去了不常用的heap、deque等结构（至少我是不常用的）。并为一些容器提供了一些特殊的接口，比如vector中的push_back_unique、add和add_unique等。
Library主要分为六部分，内存调试相关、容器、算法、正则、IO和Graphic，每个模块都有各自的分工，他们之间的耦合度极低，几乎每个模块都可以拆出来独立使用，下面来分别介绍各个模块。
内存调试
我们知道，在C/C++中内存相关的东西是极难控制的，在使用不当时可能造成各种错误，轻则内存泄漏，重则程序崩溃。所以，在生产环境中我们必须通过一个有效的手段来管理好内存。当然，在小块内存频繁new、delete的过程中也会产生大量的内存碎片，从而导致可用内存数量越来越少。应此我们设计了一个内存池来控制小块内存的频繁new、delete，以及做到对内存泄漏的检测。
在内存池的设计之初，我只是简单的设计出了可以使用的MemoryPool的最简版本，它包含一个大块内存的free_list和每个小块内存的chunk_list，当时足以应付大部分的需求，而且最初用的是Visual Leak Detector来检测内存泄漏。但随着时间的推移，想要自己检测内存泄漏的欲望越来越强烈，之后便有了一个use_list来保存内存块的释放情况。当时完成了这个patch之后，兴奋的跑了一下TestCase，然后的结果我想大家应该知道了，一路的飘红，到处是内存泄漏。
经过一天的调试，实在无法容忍的情况下，我翻阅了MSDN，查到了dbghelp.dll中可以通过许多函数来获取调用堆栈，于是在此之下便生产出了CallStack模块。有了它之后你就可以在任意地方保存当前的调用堆栈了，真是十分方便。当然直到现在，它还只支持在Windows下调用堆栈的获取（稍后我会翻阅资料，实现一个like unix的版本，如果可能的话）。
这里不过多的描述实现的细节，具体可以看http://www.cppblog.com/lwch/archive/2012/07/14/183420.html和http://www.cppblog.com/lwch/archive/2013/01/19/197415.html两篇文章。
最后来看allocator，这里只是简单的为其包装了一层。
template <typename T>
class allocator
{
public:
allocator()
{
}
allocator(const allocator<T>&)
{
}
static T* allocate()
{
MemoryPool* pool = getPool();
return reinterpret_cast<T*>(pool->allocate(sizeof(T), free_handler));
}
static T* allocate(size_t n)
{
MemoryPool* pool = getPool();
return reinterpret_cast<T*>(pool->allocate(n * sizeof(T), free_handler));
}
static void deallocate(T* p)
{
MemoryPool* pool = getPool();
pool->deallocate(p, sizeof(T));
}
static void deallocate(T* p, size_t n)
{
MemoryPool* pool = getPool();
pool->deallocate(p, n * sizeof(T));
}
static void deallocateWithSize(T* p, size_t n)
{
MemoryPool* pool = getPool();
pool->deallocate(p, n);
}
static T* reallocate(T* p, size_t old_size, size_t n)
{
MemoryPool* pool = getPool();
return pool->reallocate(p, old_size, n * sizeof(T), free_handler);
}
public:
static void(*free_handler)(size_t);
static void set_handler(void(*h)(size_t))
{
free_handler = h;
}
protected:
static MemoryPool* getPool()
{
static MemoryPool pool;
return &pool;
}
};
template <typename T>
void (*allocator<T>::free_handler)(size_t) = 0;
容器
容器占了Library的大部分，容器的作用是用来存储对象的，容器分为线性和非线性两种。线性的容器有vector、list、string以及用它们作为容器实现的queue、stack四种，非线性的则有rbtree、hashtable以及用它们作为容器实现的set、map、hashset、hashmap六种。对于每种容器，都必须定义出它的value_type、pointer、reference、const_reference、size_type、distance_type、const_iterator、const_reverse_iterator、iterator、reverse_iterator的类型。
所有容器必须包含以下几个接口：size（获取容器内元素个数）、clear（清空容器）、begin（获取[first,last)区间中的first迭代器）、end（获取[first,last)区间中的last迭代器）、rbegin（获取反向的first迭代器）、rend（获取反向的last迭代器）。
traits
traits是一种萃取技术，通过它你可以获取某种类型的一些特性，比如是否含有默认构造函数、拷贝构造函数等。
__type_traits
__type_traits用于萃取出某种类型的一些特性，它的原型如下
template <typename T>
struct __type_traits
{
typedef __true_type has_default_construct;
typedef __true_type has_copy_construct;
typedef __true_type has_assign_operator;
typedef __true_type has_destruct;
typedef __false_type is_POD;
};
通过特例化，可以定义出所有类型的这些属性，比如char
template <>
struct __type_traits<char>
{
typedef __true_type has_default_construct;
typedef __true_type has_copy_construct;
typedef __true_type has_assign_operator;
typedef __false_type has_destruct;
typedef __true_type is_POD;
};
__container_traits
__container_traits用于萃取出容器的特性，如上文所说的value_type等特性，它的代码很简单
template <typename T>
struct __container_traits
{
typedef typename T::value_type value_type;
typedef typename T::pointer pointer;
typedef typename T::reference reference;
typedef typename T::const_reference const_reference;
typedef typename T::size_type size_type;
typedef typename T::distance_type distance_type;
typedef typename T::const_iterator const_iterator;
typedef typename T::const_reverse_iterator const_reverse_iterator;
typedef typename T::iterator iterator;
typedef typename T::reverse_iterator reverse_iterator;
};
char_traits
char_traits定义了一些对于Char的操作，包括assign（赋值）、eq（相等）、lt（小于）、compare（比较两个字符串的大小）、length（获取字符串的长度）、move（移动）、copy（拷贝）、assign（字符串赋值）、eof（结束符），它的代码比较简洁，这里不做说明。
type_compare
type_compare用于对两种类型做运行时的匹配，判断所给定的两种类型是否相同。同样通过特例化技术可以很轻松的实现它的代码。
迭代器
迭代器类是一种类似于smart pointer的东西，一般的它都会支持前置和后置的++和--操作，有一些特殊的迭代器同样支持+=和-=操作。当然作为一种smart pointer少不了的是->和*操作，而对于比较操作，则比较的是迭代器所保存的值。
迭代器分为bidirectional_iterator和random_access_iterator两种类型，前者只支持++和--操作而后者支持+和-运算符，之所以会定义出这两种类型是为了提高算法的速度。对于一个迭代器来说同样需要定义value_type、distance_type、pointer、reference、const_pointer、const_reference的类型。
反向迭代器
反向迭代器与正向的正好相反，应此我们可以类似的定义它的++为正向迭代器的--等运算符
iterator_traits
iterator_traits用于萃取出迭代器的所有特性，应此它比较简单
template <typename Iterator>
struct iterator_traits
{
typedef typename Iterator::value_type value_type;
typedef typename Iterator::distance_type distance_type;
typedef typename Iterator::pointer pointer;
typedef typename Iterator::reference reference;
typedef typename Iterator::const_pointer const_pointer;
typedef typename Iterator::const_reference const_reference;
};
vector
vector是一种比较常用的容器，它的内部是一个连续的内存块，应此它有两个接口分别用于获取内存块已使用的大小和容器的大小，它们是size和capacity，同样它也有一个reserve接口来调整它的容量。由于vector的内部是连续的，应此它只允许从后面插入元素，所以它有push_back、push_back_unique和pop_back方法。当然为了作为queue的容器，我还为其增加了pop_front方法用于删除前端的元素。insert和erase用于在某个地方插入和删除元素，add和add_unique用于插入另一个vector里的内容，而unique则会将容器内重复的元素删除。
当然vector可以像数组一样的使用，它支持方括号的运算符与at接口来获取某个位置上的元素值。
vector容器就先介绍到这里，它的代码你可以在QCore/Library/vector.h中找到。
list
list的内部则是一个双向的链表，应此它在删除前端的元素时会比vector快很多，它的接口基本跟vector相同，这里就不做过多的介绍了。由于vector是内存连续的，所以它可以直接通过索引来访问某个元素，而list是一个双向的链表，应此通过制定索引去访问某个元素时会先看这个索引的值是否小于list长度的一半来决定是从list的头部遍历还是从list的尾部遍历，它的代码你可以在QCore/Library/list.h中找到。
queue和stack
queue是一种FIFO（先进先出）的结构，应此我们建议使用list作为它的容器，通过list的push_back和pop_front可以使代码变的高效。它拥有front和back方法来获取队列中队头和队尾的元素值，同样在插入队列时，你可以不加选择的直接插入或是插入一个不重复的值。
stack是一种FILO（先进后出）的结构，同样它拥有push、push_unique和pop方法以及top和bottom方法用于获取栈顶端和底部的元素值。
对于这两种结构的代码，你可以在QCore/Library/queue.h和QCore/Library/stack.h中找到。
rbtree
rbtree（红黑树）是一棵自平衡的二叉查找树，应此它拥有较高的查找效率，红黑树有以下5条性质
性质1. 节点是红色或黑色。
性质2. 根节点是黑色。
性质3 每个叶节点是黑色的。
性质4 每个红色节点的两个子节点都是黑色。(从每个叶子到根的所有路径上不能有两个连续的红色节点)
性质5. 从任一节点到其每个叶子的所有路径都包含相同数目的黑色节点。
以上摘自百度百科
对于红黑树的每个节点，它都拥有它的key和value，当然我们是按照节点的key来排序的（废话）。红黑树拥有insert_equal和insert_unique方法分别用于插入一个节点，前者允许待插入节点的key已存在于这棵树中，而后者在插入时并不允许这个节点的key已存在于这棵树中，应此它的返回值则是一个二元的。erase方法则提供了对于树中某个节点的删除操作，可以通过迭代器或某个key值来删除其中的节点。
由于红黑树是一棵二叉查找树，应此它应该具备find方法，用于在树中查找某个节点，它返回的则是指向这个节点的一个迭代器。由于红黑树是有序的，应此可以通过maximum和minimum方法得到其中的最大和最小值。通过lower_bound和upper_bound可以得到属于某个key的[first,last]区间，equal_range就是干这个活的，count方法可以得到某个key所对应的节点数。
rbtree就先介绍到这里，稍后我会在博客中继续更新提供更完整的实现方法，它的代码你可以在QCore/Library/rbtree.h中找到。
set和map
set是一种集合的结构，应此在集合中是不允许有重复的元素的，set是以rbtree作为容器的。应此它的insert方法对应于rbtree的insert_unique方法，同样rbtree所具备的接口set也同样拥有，set的key_type与value_type相同，都是给定的类型。
map则是一种key-value的directory结构，应此它的key是不允许重复的，map同样是以rbtree作为容器的。应此它的insert方法同样对应于rbtree的insert_unique方法，在map中除了rbtree的maximum、minimum、lower_bound、upper_bound、equal_range和count没有之外其他接口基本全都拥有，map的key_type是给定的类型，而value_type则是一个以Key和T组成的二元组。
对于这两种结构的代码，你可以在QCore/Library/set.h和QCore/Library/map.h中找到。
hashtable
hashtable是一种哈希结构，应此它的元素查找和插入是非常快的。在这里我用的是吊桶法来处理元素插入时的冲突，当吊桶长度过长（默认是11个元素）时，会将桶的大小翻一倍然后重建整个hashtable以提高hashtable中元素的查找速度。
同样的在hashtable中有insert_equal和insert_unique来分别插入允许相同和不同的元素，当遇到一个已有的元素时会将这个元素插入到第一个与它值相同的节点后面，这样做的好处是可以简单的实现equal_range方法。同时hashtable拥有value方法用于通过一个指定的key来查找到它对应的值，find方法则是用来查找一个key所对应的迭代器的。同样的hashtable也拥有count方法来获取某个key所对应的值的个数，maximum和minimum则是用来获取最大值和最小值的。
hashtable的代码，你可以在QCore/Library/hashtable.h中找到。
hashset和hashmap
hashset和hashmap基本与set和map相同，这里不过多做介绍，关于它们的代码，你可以在QCore/Library/hashset.h和QCore/Library/hashmap.h中找到。
basic_string
basic_string的实现方式基本和vector差不多，为了提高效率，在所有的插入操作中若新的长度的一倍小于一个定长（默认是512）字节时会申请新长度的一倍作为容器的容量。
与vector不同的是basic_string拥有c_str和data方法用于获取字符指针，append方法往字符串尾部链接另一个字符串，assign方法给字符串赋值，find方法查找到第一个指定的字符串的位置，substr则用来获取字符串中一部分的内容。
在basic_string中也有format的静态方法来生成一个指定形式的字符串，其他用法基本与vecotr相同。它的代码，你可以在QCore/Library/string.h中找到。
本章小结
上面介绍了所有的容器的接口和使用方法，以及在实现方式上的一些技巧。希望通过上面的介绍，读者们能够体会到STL为什么需要这么去设计、这么设计的好处是什么。
在我后来做regex的过程中，我深刻的体会到，选用一个合适的数据结构可以给代码的运行效率带来非常大的提升。比如给定NFA某个状态，需要找出所有从这个状态出发的边，之前使用的是map结构来保存从某个状态出发边的vector，之后发现遍历的速度非常缓慢，在换成hashmap之后，速度有显著的提升。应此在实际编程过程中，选用一个合适的数据结构显得尤为重要。
在使用线性结构时，一般在小数据量或不平凡插入或删除数据的情况下，选用vector作为容器会更快一些。而在需要平凡插入或删除数据的场合下，选用list作为容器会有更优异的结果。需要保持元素唯一性的情况下，我会优先选用set作为容器，而在数据量非常大的情况下，就会使用hashset来代替set。map则如它的名字那样，适用于key-value的场合，而hashmap在数据量非常大的情况下使用。
算法
min和max函数分别用于求取最小值和最大值，fill_n用来填充若干个对象的值。copy_backward用来从后往前拷贝值。distance用来求给定区间[first, last)的长度。search用于在给定范围[first1, last1)内查找符合序列[first2, last2)集合的值。swap和iterator_swap分别用于交换两个值和两个迭代器指向的值。sort用于将指定范围[first, last)内的值排序，find用于在指定范围[first, last)内查找指定的值。toArray用于将指定范围[first, last)内的值转换为内存连续的数组，compareArray则用于比较两个数组内的值的个数和值是否相同。
具体的实现代码，你可以在QCore/Library/algo.h中找到。
正则
通过重载+（相加）、-、|、+（前置）、*(前置）、!以及opt函数来生成正则表达式的ε-NFA，然后通过buildDFA函数生成DFA。通过parse和match可分析给定的字符串是否符合这个正则表达式，parse从头开始跑DFA看这个字符串的开头是否有符合这个正则表达式的字符串，而match则会找[first, last)区间内符合这个正则表达式的第一个字符串的相关结果。
具体的实现方法，你可以看http://www.cppblog.com/lwch/archive/2013/02/15/197848.html和http://www.cppblog.com/lwch/archive/2013/02/23/198043.html两篇文章，而代码则可在QCore/Library/regex/regex.h中找到。
IO
IO模块包含文件IO和标准输入输出IO，首先有两个基类分别是basic_istream和basic_ostream分别作为输入和输出stream的基类,其中分别定义了运算符>>和<<，通过这两个运算符可以直观的看到是从stream输出到变量或是从变量输入到stream中。之后有stdstream_basic和fstream_basic都继承自basic_istream和basic_ostream分别作为basic_stdstream和basic_fstream的基类，它们都有open、size、tell、seek、read、write和flush方法，它们都是对底层C函数的一些封装。而在下一层的basic_stdstream和basic_fstream中则实现了运算符>>和<<的所有重载，这样做的好处是可以使代码更有条理性，并方便阅读。
对于标准输入输出流来说，实际上是对stdin、stdout、stderr的一些封装，当然里面也有一些比较特殊的接口，比如setColor（用于设置输入输出流的字体颜色）以及一些颜色相关的函数。
对于fstream来说它是针对所有文件的，应此它会多一个readAll接口用于一次性的读出这个文件的所有内容，为了节省频繁读写磁盘所造成的性能损耗，我们给它定义了两个buffer用来做cache，当你要写入文件时，它并不是马上就直接往磁盘里写的，而会加到buffer当中，当达到一个预值时才真正的写入到磁盘。
那么IO模块就先介绍到这里了，它们的代码你可以在QCore/Library/ios.h、QCore/Library/istream.h、QCore/Library/ostream.h、QCore/Library/fstream.h、QCore/Library/stdstream.h、QCore/Library/iostream.h和QCore/Library/iostream.cpp中找到。
结束
上文介绍了大部分模块的实现过程与实现过程中的心得，让我们来按照顺序回顾一下。
首先介绍了内存池的实现过程，以及在实现过程中遇到的一些问题，比如如何检测内存泄漏、如何获取调用堆栈等。
然后介绍了traits技术，它是用来萃取出一些特性用的，通过traits技术你可以得到一个类型是否为POD是否有默认构造函数等特性。而__container_traits则萃取出了容器的一些特性，比如值类型等等。通过char_traits我们得到了一些关于字符串的操作，比如求字符串的长度等。
之后又通过特例化，我们实现了一种比较两个变量类型是否相同的手段。
接下来我们介绍了迭代器和反向迭代器，它们是一种类似于smart pointer的东西，我们可以通过一个[first, last]前闭后开区间来表示一个容器内的所有元素。然后我们通过iterator_traits萃取出了迭代器的一些特性，比如值类型等。
最后我们介绍了所有比较常用的容器，以及在某些场合下应该使用哪种容器来达到高效的目的。比如在数据量较大时使用hashset要比使用set在插入和查找速度要更快一些，而且时间负责度更稳定一些。
之后我们又介绍了一些常用算法，通过这些算法足以解决一些简单的问题。比如排序和求取一个范围[first, last]的长度等。
在正则这一章中，介绍了我们是如何通过一些运算符的重载来构造出某个正则表达式的状态机的，以及如何通过运行这些状态机来分析给定的字符串。
最后介绍了IO模块，其中分为标准输入输出流和文件流，通过重载<<和>>运算符，可以直观的看到是从流中讲内容输入到一个变量或是从一个变量中讲内容输入到流中。
希望通过本文可使读者体会到作者在设计这个库的时候所考虑的问题，以及对这个库有一个大概的认识，稍后我会在我的博客中补齐所有没有介绍过的模块是如何实现的。
修改记录
2013.4.23第一次编写
2013.4.24添加容器的说明
2013.4.25添加hashtable、hashset、hashmap和basic_string结构的说明
2013.4.28添加算法和正则的说明
2013.4.30添加IO的说明，完结此文
