161 lines
5.7 KiB
Markdown
161 lines
5.7 KiB
Markdown
|
||
|
||
  
|
||
|
||
---
|
||
|
||
AXE is a light-weight and cross platform library. It provides data structure handling, object system, multi-thread and network for C.
|
||
|
||
AXE是一个轻量级的跨平台程序库，它为C语言提供了数据结构封装、对象系统、多线程支持和网络.
|
||
|
||
## COMPILE AND INSTALL
|
||
|
||
该库在编译之前需要执行*configure*脚本进行配置，然后通过*make*(1)编译和安装.
|
||
|
||
编译结束后，在*lib*目录会生成一些库文件，包括
|
||
|
||
* *libaxcore.a* 核心模块，只依赖C99标准
|
||
* *libaxut.a* 单元测试模块
|
||
* *libaxthread.a* 多线程模块
|
||
* *libaxnet.a* 事件驱动的网络模块
|
||
* *libaxkit.a* 平台工具库
|
||
|
||
执行`configure --help`获取更多配置信息.
|
||
|
||
```
|
||
$ cd axe
|
||
$ ./configure
|
||
$ make
|
||
$ sudo make install
|
||
```
|
||
|
||
## HOW TO USE
|
||
|
||
您可以直接通过引入相关头文件来使用它们的功能，下面是一个样例程序，这其中包括一些有趣的特性，比如链表、迭代器算法、RAII、对象转储和容器遍历等操作. 在编译客户程序时需要通过加入编译参数`-lax*`来连接相关的库文件. 详细的帮助文档请参考MAN手册页，它们位于工程目录的 *man/man3* 目录下，或参考单元测试程序和附带的样例程序，它们分别位于工程目录的 *test* 和 *sample* 目录.
|
||
|
||
```c
|
||
/* gcc foo.c -lax */
|
||
#include "ax/algo.h" /* 引入算法函数 */
|
||
#include "ax/list.h" /* 引入双连表 */
|
||
#include "ax/ptra.h" /* 引入自动指针 */
|
||
#include <stdlib.h>
|
||
#include <stdio.h>
|
||
|
||
/* 定义一个一元算子函数 */
|
||
void oper_rmodd(void *out, const void *in, void *args)
|
||
{
|
||
const int *num = in;
|
||
int *ret = out;
|
||
if (*num % 2 == 1) /* 如果输入为基数，则输出为0 */
|
||
*ret = 0;
|
||
}
|
||
|
||
int main(void)
|
||
{
|
||
/* 定义一个双链表 */
|
||
ax_list_r l = ax_new(ax_list, ax_t(int));
|
||
|
||
int *count = malloc(sizeof *count);
|
||
|
||
/* 将双链表指针和堆变量加入范围块，当范围执行结束后，链表自动被释放，可放置多个指针 */
|
||
ax_scope(l.ax_one, ax_onelize(count)) {
|
||
|
||
/* 对区间[1, 11)进行循环迭代 */
|
||
ax_forrange(1, 11)
|
||
/* 将区间每个元素逐个压入链表 */
|
||
ax_seq_push(l.ax_seq, &_);
|
||
|
||
/* 对双链表进行转储 */
|
||
ax_any_so(l.ax_any);
|
||
// OUTPUT: string.c:12:one.any.box.seq.list {1, 2, 3, 4, 5, 6, 7, 8, 9, 10}
|
||
|
||
/* 创建一个一元谓词 */
|
||
ax_pred rmodd = ax_pred_unary_make(oper_rmodd, NULL, NULL);
|
||
/* 从头迭代器所在元素开始逐个执行谓词，将所有奇数元素设为0 */
|
||
ax_transform(
|
||
ax_p(ax_citer, ax_box_cbegin(l.ax_box)),
|
||
ax_p(ax_citer, ax_box_cend(l.ax_box)),
|
||
ax_p(ax_iter, ax_box_begin(l.ax_box)),
|
||
&rmodd);
|
||
|
||
/* 对双链表进行DUMP */
|
||
ax_any_so(l.ax_any);
|
||
// OUTPUT: string.c:33:one.any.box.seq.list {0, 2, 0, 4, 0, 6, 0, 8, 0, 10}
|
||
|
||
/* 按顺序枚举链表所有元素，求和 */
|
||
ax_box_foreach(l.ax_box, int *, i)
|
||
*count += *i;
|
||
|
||
printf("Sum of elements = %d\n", *count);
|
||
// OUTPUT: Sum of elements = 30
|
||
}
|
||
|
||
return 0;
|
||
}
|
||
```
|
||
|
||
## HEADERS DESCRIPTION
|
||
|
||
| 名称 | 描述 |
|
||
|--- |--- |
|
||
| ax/type/one.h | 根类型 |
|
||
| ax/type/any.h | 可序列化对象抽象 |
|
||
| ax/type/box.h | 可迭代容器抽象 |
|
||
| ax/type/seq.h | 线性表抽象 |
|
||
| ax/type/str.h | 字符串抽象 |
|
||
| ax/type/map.h | 映射表抽象 |
|
||
| ax/type/trie.h | 字典树抽象 |
|
||
| ax/type/tube.h | 单进单出管道抽象 |
|
||
| ax/def.h | 基本声明 |
|
||
| ax/flow.h | 高级流程控制 |
|
||
| ax/ring.h | 模板化循环队列 |
|
||
| ax/trick.h | 魔法宏 |
|
||
| ax/narg.h | 参数测量宏 |
|
||
| ax/detect.h | 编译环境探测宏 |
|
||
| ax/debug.h | 断言 |
|
||
| ax/arraya.h | 自动数组 |
|
||
| ax/oper.h | 算子，包括C语言运算符的函数化包装 |
|
||
| ax/dump.h | 容器内容的可视化转储 |
|
||
| ax/log.h | 日志打印 |
|
||
| ax/pred.h | 谓词和参数绑定 |
|
||
| ax/trait.h | 类型特性，对数据类型的描述 |
|
||
| ax/iter.h | 迭代器 |
|
||
| ax/algo.h | 基于迭代器的算法 |
|
||
| ax/mem.h | 内存和串的操作 |
|
||
| ax/u1024.h | 1024位无符号整数 |
|
||
| ax/array.h | 静态数组容器 |
|
||
| ax/vector.h | 向量表容器 |
|
||
| ax/deq.h | 双端队列容器 |
|
||
| ax/list.h | 双链表容器 |
|
||
| ax/hmap.h | 散列表容器 |
|
||
| ax/avl.h | 自平衡树容器 |
|
||
| ax/rb.h | 红黑树容器 |
|
||
| ax/string.h | 字符串容器 |
|
||
| ax/btrie.h | 平衡字典树容器 |
|
||
| ax/queue.h | 队列 |
|
||
| ax/stack.h | 栈 |
|
||
| ax/pque.h | 优先队列 |
|
||
| ax/thread.h | 线程操作 |
|
||
| ax/mutex.h | 互斥量 |
|
||
| ax/sem.h | 信号量 |
|
||
| ax/rwlock.h | 读写锁 |
|
||
| ax/cond.h | 条件变量 |
|
||
| ax/tss.h | 线程本地存储 |
|
||
| ax/tpool.h | 线程池 |
|
||
| ax/event.h | 事件结构 |
|
||
| ax/reactor.h | 基于Reactor结构的事件驱动模型 |
|
||
| ax/edit.h | 终端行编辑工具 |
|
||
| ax/lib.h | 动态加载共享对象(DLL活SO文件) |
|
||
| ut/case.h | 测试用例 |
|
||
| ut/suite.h | 测试用例集 |
|
||
| ut/runner.h | 测试用例执行容器 |
|
||
|
||
## LICENSE
|
||
|
||
该软件程序基于MIT协议发布.
|
||
|
||
## AUTHOR
|
||
|
||
李希林 <lihsilyn@gmail.com>
|
||
|