tbox: 跨平台的c开发库，提供asio、stream、容器、算法、xml/json/plist解析、数据库等常用模块

The Treasure Box Library
========================

TBOX is a mutli-platform c library for unix, windows, mac, ios, android, etc.

It includes asio, stream, network, container, algorithm, object, memory, database, string, charset, math, libc, libm, utils and other library modules.

features
--------

### the stream io library
-	supports file, data, http and socket source
-	supports the stream filter for gzip charset and ..
-	implements the multi-stream transfer using asio

### the asynchronous io library
-	supports reactor and proactor mode
-	using epoll, poll, select ,kqueue and iocp os system api

### the database library
-	supports mysql and sqlite3 database and enumerates data using the iterator mode

### the xml parser library
-	supports DOM and SAX mode and supports xpath.

### the serialization and deserialization library. 
-	supports xml, json, bplist, xplist, binary formats

### the memory library
-	implements some memory pools for optimizating memory.
-	supports fast memory error detecting. it can detect the following types of bugs for the debug mode:
 - out-of-bounds accesses to heap and globals
 - use-after-free
 -	double-free, invalid free
 -	memory leaks

### the container library
-	implements hash table, single list, double list, vector, stack, queue
	and min/max heap. supports iterator mode for algorithm.

### the algorithm library
-	using the iterator mode
-	implements find, binary find and reverse find algorithm.
-	implements sort, bubble sort, quick sort, heap sort and insert sort algorithm. 
-	implements count, walk items, reverse walk items, for_all and rfor_all.

### the network library
-	implements dns(cached), ssl(openssl and polarssl), http and cookies
-	supports asynchronous io mode for dns, ssl and http using the asio and stream library

### the platform library
-	implements timer, faster and lower precision timer
-	implements atomic and atomic64 operation
-	implements spinlock, mutex, event, semaphore, thread and thread pool 
-	implements file, socket operation

### the charset library
-	supports utf8, utf16, gbk, gb2312, uc2 and uc4
-	supports big endian and little endian mode

### the zip library
-	supports gzip, zlibraw, zlib formats using the zlib library if exists
-	implements lzsw, lz77 and rlc algorithm

### the utils library
-	implements base32, base64, md5 and sha algorithm
-	implements assert and trace output for the debug mode

### the math library
-	implements random generator
-	implements fast fixed-point calculation, supports 6-bits, 16-bits, 30-bits fixed-point number

### the libc library
-	implements lightweight libc library interfaces, the interface name contains tb_xxx prefix for avoiding conflict.
-	implements strixxx strrxxx wcsixxx wcsrxxx interface extension.
-	optimizates some frequently-used interface, .e.g. memset, memcpy, strcpy ... 
-	implements memset_u16, memset_u32, memset_u64 extension interfaces.

### the libm library
-	implements lightweight libm library interfaces, the interface name contains tb_xxx prefix for avoiding conflict.
-	supports float and double type.

## 简介
TBOX是一个用c语言实现的多平台开发库，支持windows、linux、mac、ios、android以及其他嵌入式系统。

针对各个平台，封装了统一的接口，简化了各类开发过程中常用操作，使你在开发过程中，更加关注实际应用的开发，而不是把时间浪费在琐碎的接口兼容性上面，并且充分利用了各个平台独有的一些特性进行优化。

* [在线文档](https://github.com/waruqi/tbox/wiki/%E7%9B%AE%E5%BD%95)
* [在线手册](http://tboox.github.io/doc/tbox/html/index.html)
* [在线源码](https://github.com/waruqi/tbox)

## 流库
针对http、file、socket、data等流数据，实现统一接口进行读写，并且支持: 阻塞、非阻塞、异步 三种读写模式。
支持中间增加多层filter流进行流过滤，实现边读取，内部边进行解压、编码转换、加密等操作，极大的减少了内存使用。

主要提供以下特性：

1. stream：通用非阻塞流，用于一般的单独io处理。
2. async_stream：利用asio实现的纯异步流，基于回调模式，可同时处理大量并发io。
3. transfer：传输器，维护两路流的传输，对async_stream的使用进行更上层的封装，用其可以很方便的实现下载、上传、复制等io传输操作。
4. transfer_pool：传输池，基于asio，维护大量并发的传输，可以用于实现爬虫、批量下载等等。
5. static_stream：针对静态数据buffer优化的静态流，用于轻量快速的数据解析。

## asio库
1. 支持reactor和proactor两种模型，针对不同平台，采用epoll/poll/select/kqueue/iocp接口，最大化异步操作的性能。
2. 并且对http、ssl、dns也提供了纯异步模式的实现。基于此库完全可以很方便的写出一个高性能的小型服务器。

## 数据库
1. 统一并简化数据库操作接口，适配各种数据源，通过统一的url来自动连接打开支持的数据库，数据的枚举采用迭代器模型。
2. 目前支持sqlite3以及mysql两种关系型数据库，也可自定义扩展使用其他关系型数据库。

## xml库
1. 针对xml提供DOM和SAX两种解析模式，SAX方式采用外部迭代模式，灵活性和性能更高，并且可以选择指定路径，进行解析。
2. 解析过程完全基于stream，所以是高度流化的，可以实现边下载、边解压、边转码、边解析一条龙服务，使用较低的内存也可以解析大规模数据。
3. 提供xml writer以支持对xml生成

## 内存库
1. 参考linux内核内存管理机制的实现，并对其进行各种改造和优化，所实现的TBOX独有的一整套内存池管理架构。
2. 调试模式下，可以轻松检测并定位内存泄露、内存越界溢出、内存重叠覆盖等常见内存问题，并对整体内存的使用进行了统计和简要分析。
3. 针对大块数据、小块数据、字符串数据进行了充分的利用，避免了大量外部碎片和内部碎片的产生。分配操作进行了各种优化，96%的情况下，效率都是在O(1)。

## 容器库
1. 提供哈希、链表、数组、队列、堆栈、最小最大堆等常用容器。
2. 支持各种常用成员类型，在原有的容器期初上，其成员类型还可以完全自定义扩展。
3. 所有容器都支持迭代器操作。
4. 大部分容器都可以支持基于stream的序列化和反序列化操作。

## 算法库
1. 提供各种排序算法：冒泡排序、堆排序、快速排序、插入排序。
2. 提供各种查找算法：线性遍历、二分法搜索。
3. 提供各种遍历、删除、统计算法。
4. 以迭代器为接口，实现算法和容器的分离，类似stl，但是c实现的，更加轻量。

## 网络库
1. 实现http、cookies、dns解析与缓存、ipv4、url的封装。

## 数学运算库
1. 提供各种精度的定点运算支持
2. 提供随机数生成器

## libc库
1. libc的一个轻量级实现，完全跨平台，并且针对不同架构进行了优化。
2. 支持大部分字符串、宽字符串操作。
3. 扩展字符串、宽字符串的各种大小写不敏感操作接口
4. 扩展memset_u16、memset_u32等接口，并对其进行高度优化，尤其适合图形渲染程序

## libm库
1. libm部分接口的一个轻量级实现，以及对常用系统接口的封装。（目前只实现了部分，之后有时间会完全实现掉）
2. 扩展部分常用接口，增加对sqrt、log2等常用函数的整数版本计算，进行高度优化，不涉及浮点运算，适合嵌入式环境使用。

## object库
1. 轻量级类apple的CoreFoundation库，支持object、dictionary、array、string、number、date、data等常用对象，并且可以方便扩展自定义对象的序列化。
2. 支持对xml、json、binary以及apple的plist(xplist/bplist)格式序列化和反序列化。
并且实现自有的binary序列化格式， 针对明文进行了简单的加密，在不影响性能的前提下，序列化后的大小比bplist节省30%。

## 平台库
1. 提供file、directory、socket、thread、time等常用系统接口
2. 提供atomic、atomic64接口
3. 提供高精度、低精度定时器
4. 提供高性能的线程池操作
5. 提供event、mutex、semaphore、spinlock等事件、互斥、信号量、自旋锁操作
6. 提供获取函数堆栈信息的接口，方便调试和错误定位
7. 提供跨平台动态库加载接口（如果系统支持的话）

## 压缩库
1. 支持zlib/zlibraw/gzip的压缩与解压（需要第三方zlib库支持）。

## 字符编码库
1. 支持utf8、utf16、gbk、gb2312、uc2、uc4 之间的互相转码，并且支持大小端格式。

## 实用工具库
1. 提供base64/32编解码、crc32、md5、sha等hash算法、日志输出、断言、url编解码

contact
-------

- email:   	    
	- waruqi@gmail.com
	- waruqi@126.com
- source:  	    
	- [github](https://github.com/waruqi/tbox)
	- [coding](https://coding.net/u/waruqi/p/tbox/git)
	- [oschina](http://git.oschina.net/tboox/tbox)
- website: 	    
	- http://www.tboox.org
	- http://www.tboox.net
- download:
 	- [github](https://github.com/waruqi/tbox/archive/master.zip)
 	- [coding](https://coding.net/u/waruqi/p/tbox/git/archive/master)
 	- [oschina](http://git.oschina.net/tboox/tbox/repository/archive?ref=master)
- document:
	- [github](https://github.com/waruqi/tbox/wiki/)
	- [oschina](http://git.oschina.net/tboox/tbox/wikis/home)
- qq(group):    
	- 343118190

donate
------

####alipay
<img src="http://www.tboox.net/ruki/alipay.png" alt="alipay" width="128" height="128">

####paypal
<a href="http://tboox.net/%E6%8D%90%E5%8A%A9/">
<img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" alt="paypal">
</a>

build
-----

please install xmake first: [xmake](https://github.com/waruqi/xmake)

```bash
	// build for the host platform
    cd ./tbox
    xmake

// build for the iphoneos platform
    cd ./tbox
    xmake f -p iphoneos 
    xmake
    
	// build for the android platform
    cd ./tbox
    xmake f -p android --ndk=xxxxx
    xmake
```

example
-----------
```c
    #include "tbox/tbox.h"

int main(int argc, char** argv)
    {
        /* init tbox
         *
         * @param priv      the platform private data
         *                  pass JNIEnv* env for android
         *                  pass tb_null for other platform
         * @param data      the memory data for the memory pool, uses the native memory if be tb_null
         * @param size      the memory size for the memory pool, uses the native memory if be zero
         *
         * for android:     tb_init(jenv, tb_null, 0)
         * for memory pool: tb_init(tb_null, malloc(10 * 1024 * 1024), 10 * 1024 * 1024);
         */
        if (!tb_init(tb_null, tb_null, 0)) return 0;

// print info with tag
        tb_trace_i("hello tbox");

// print info only for debug
        tb_trace_d("hello tbox");

// print error info
        tb_trace_e("hello tbox");

// init stream
        tb_stream_ref_t stream = tb_stream_init_from_url("http://www.xxxx.com/index.html");
        if (stream)
        {
            // save stream data to file
            tb_transfer_done_to_url(stream, "/home/file/index.html", 0, tb_null, tb_null);

// exit stream
            tb_stream_exit(stream);
        }

// block: save http to file
        tb_transfer_done_url("http://www.xxxx.com/index.html", "/home/file/index.html", 0, tb_null, tb_null);

// async: save http to file for windows path
        tb_transfer_pool_done(tb_transfer_pool(), "http://www.xxxx.com/index3.html", "c:/home/file/index4.html", 0, 0, tb_null, tb_null, tb_null);

// async: save http to file for unix path
        tb_transfer_pool_done(tb_transfer_pool(), "http://www.xxxx.com/index0.html", "/home/file/index0.html", 0, 0, tb_null, tb_null, tb_null);
        tb_transfer_pool_done(tb_transfer_pool(), "http://www.xxxx.com/index1.html", "/home/file/index2.html", 0, 0, tb_null, tb_null, tb_null);
        tb_transfer_pool_done(tb_transfer_pool(), "http://www.xxxx.com/index2.html", "/home/file/index3.html", 0, 0, tb_null, tb_null, tb_null);

// wait some time
        getchar();

// exit tbox
        tb_exit();
        return 0;
    }
```

zhakui/tbox

简介

发行版

贡献者

近期动态