From 26105034da4fcce7ac883c899d781f016559310d Mon Sep 17 00:00:00 2001 From: ruki Date: Thu, 8 Nov 2018 00:38:48 +0800 Subject: switch to vuepress --- src/zh/README.md | 210 ++++++++++++++++++++++++++++++++++++++++ src/zh/api/introduction.md | 33 +++++++ src/zh/guide/faq.md | 0 src/zh/guide/getting-started.md | 94 ++++++++++++++++++ src/zh/guide/introduction.md | 172 ++++++++++++++++++++++++++++++++ src/zh/guide/sponsors.md | 0 src/zh/plugin/introduction.md | 33 +++++++ 7 files changed, 542 insertions(+) create mode 100644 src/zh/README.md create mode 100644 src/zh/api/introduction.md create mode 100644 src/zh/guide/faq.md create mode 100644 src/zh/guide/getting-started.md create mode 100644 src/zh/guide/introduction.md create mode 100644 src/zh/guide/sponsors.md create mode 100644 src/zh/plugin/introduction.md (limited to 'src/zh') diff --git a/src/zh/README.md b/src/zh/README.md new file mode 100644 index 00000000..1d32b8d6 --- /dev/null +++ b/src/zh/README.md @@ -0,0 +1,210 @@ +--- +home: true +heroImage: /hero.png +actionText: 快速上手 → +actionLink: /zh/guide/getting-started +features: + - title: 为什么使用 + details: 让开发者更加关注于项目本身开发，简化项目的描述和构建，并且提供平台无关性，使得一次编写，随处构建 + - title: 强大 + details: 提供大量的实用特性（例如：插件扩展、脚本宏记录、批量打包、自动文档生成等常用插件） + - title: 跨平台 + details: 支持windows, macOS, linux, android, ios +footer: Apache-2.0 Licensed | Copyright © 2015-present tboox.org +--- + +## 简单的工程描述 + + + +## 包依赖描述 + + + +官方的xmake包管理仓库: [xmake-repo](https://github.com/tboox/xmake-repo) + +## 构建工程 + +```bash +$ xmake +``` + +## 运行目标 + +```bash +$ xmake run console +``` + +## 调试程序 + +```bash +$ xmake run -d console +``` + +## 配置平台 + +```bash +$ xmake f -p [windows|linux|macosx|android|iphoneos ..] -a [x86|arm64 ..] -m [debug|release] +$ xmake +``` + +## 图形化菜单配置 + +```bash +$ xmake f --menu +``` + + + +## 包依赖管理 + + + +## 支持平台 + +* Windows (x86, x64) +* Macosx (i386, x86_64) +* Linux (i386, x86_64, cross-toolchains ...) +* Android (armv5te, armv6, armv7-a, armv8-a, arm64-v8a) +* iPhoneOS (armv7, armv7s, arm64, i386, x86_64) +* WatchOS (armv7k, i386) +* Mingw (i386, x86_64) + +## 支持语言 + +* C/C++ +* Objc/Objc++ +* Swift +* Assembly +* Golang +* Rust +* Dlang +* Cuda + +## 工程类型 + +* 静态库程序 +* 动态库类型 +* 控制台程序 +* Cuda程序 +* Qt应用程序 +* WDK驱动程序 +* WinSDK应用程序 + +## 内置插件 + +#### 宏记录脚本和回放插件 + +```bash +$ xmake m -b # 开始记录 +$ xmake f -p iphoneos -m debug +$ xmake +$ xmake f -p android --ndk=~/files/android-ndk-r16b +$ xmake +$ xmake m -e # 结束记录 +$ xmake m . # 回放命令 +``` + +#### 加载自定义lua脚本插件 + +```bash +$ xmake l ./test.lua +$ xmake l -c "print('hello xmake!')" +$ xmake l lib.detect.find_tool gcc +``` + +#### 生成IDE工程文件插件（makefile, vs2002 - vs2017, ...） + +```bash +$ xmake project -k vs2017 -m "debug,release" +``` + +#### 生成doxygen文档插件 + +```bash +$ xmake doxygen [srcdir] +``` + +## 更多插件 + +请到插件仓库进行下载安装: [xmake-plugins](https://github.com/tboox/xmake-plugins). + +## IDE和编辑器插件 + +* [xmake-vscode](https://github.com/tboox/xmake-vscode) + + + +* [xmake-sublime](https://github.com/tboox/xmake-sublime) + + + +* [xmake-idea](https://github.com/tboox/xmake-idea) + + + +* [xmake.vim](https://github.com/luzhlon/xmake.vim) (third-party, thanks [@luzhlon](https://github.com/luzhlon)) + +## 更多例子 + +Debug和Release模式： + +```lua +add_rules("mode.debug", "mode.release") + +target("console") + set_kind("binary") + add_files("src/*.c") + if is_plat("windows", "mingw") then + add_defines("XXX") + end +``` + +自定义脚本： + +```lua +target("test") + set_kind("static") + add_files("src/*.cpp") + after_build(function (target) + print("build %s ok!", target:targetfile()) + end) +``` + +使用扩展模块： + +```lua +target("test") + set_kind("shared") + add_files("src/*.c") + on_load(function (target) + import("lib.detect.find_package") + target:add(find_package("zlib")) + end) +``` + +## 项目例子 + +一些使用xmake的项目： + +* [tbox](https://github.com/tboox/tbox) +* [gbox](https://github.com/tboox/gbox) +* [vm86](https://github.com/tboox/vm86) +* [更多](https://github.com/tboox/awesome-xmake) + +## 演示视频 + + + + + +## 联系方式 + +* 邮箱：[waruqi@gmail.com](mailto:waruqi@gmail.com) +* 主页：[tboox.org](http://www.tboox.org/cn) +* 社区：[Reddit论坛](https://www.reddit.com/r/tboox/) +* 聊天：[Telegram群组](https://t.me/tbooxorg), [Gitter聊天室](https://gitter.im/tboox/tboox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +* 源码：[Github](https://github.com/tboox/xmake), [Gitee](https://gitee.com/tboox/xmake) +* QQ群：343118190 +* 微信公众号：tboox-os + diff --git a/src/zh/api/introduction.md b/src/zh/api/introduction.md new file mode 100644 index 00000000..8b572209 --- /dev/null +++ b/src/zh/api/introduction.md @@ -0,0 +1,33 @@ +# Title1 + +[[toc]] + +## Title2 + +### Title3 + +#### Title4 + +##### Title5 + +... + +##### Title5 + +... + +#### Title4 + +... + +### Title3 + +... + +## Title2 + +... + +### Title3 + +... diff --git a/src/zh/guide/faq.md b/src/zh/guide/faq.md new file mode 100644 index 00000000..e69de29b diff --git a/src/zh/guide/getting-started.md b/src/zh/guide/getting-started.md new file mode 100644 index 00000000..748ff3c0 --- /dev/null +++ b/src/zh/guide/getting-started.md @@ -0,0 +1,94 @@ +# 快速开始 + +## 编译 + +请先安装: [xmake](https://github.com/tboox/xmake) + +```bash +# 默认直接编译当前主机平台 +$ cd ./tbox +$ xmake + +# 编译mingw平台 +$ cd ./tbox +$ xmake f -p mingw --sdk=/home/mingwsdk +$ xmake + +# 编译iphoneos平台 +$ cd ./tbox +$ xmake f -p iphoneos +$ xmake + +# 编译android平台 +$ cd ./tbox +$ xmake f -p android --ndk=xxxxx +$ xmake + +# 交叉编译 +$ cd ./tbox +$ xmake f -p linux --sdk=/home/sdk #--bin=/home/sdk/bin +$ xmake +``` + +## 例子 + +```c +#include "tbox/tbox.h" + +int main(int argc, char** argv) +{ + // init tbox + if (!tb_init(tb_null, tb_null)) return 0; + + // trace + tb_trace_i("hello tbox"); + + // init vector + tb_vector_ref_t vector = tb_vector_init(0, tb_element_cstr(tb_true)); + if (vector) + { + // insert item + tb_vector_insert_tail(vector, "hello"); + tb_vector_insert_tail(vector, "tbox"); + + // dump all items + tb_for_all (tb_char_t const*, cstr, vector) + { + // trace + tb_trace_i("%s", cstr); + } + + // exit vector + tb_vector_exit(vector); + } + + // init stream + tb_stream_ref_t stream = tb_stream_init_from_url("http://www.xxx.com/file.txt"); + if (stream) + { + // open stream + if (tb_stream_open(stream)) + { + // read line + tb_long_t size = 0; + tb_char_t line[TB_STREAM_BLOCK_MAXN]; + while ((size = tb_stream_bread_line(stream, line, sizeof(line))) >= 0) + { + // trace + tb_trace_i("line: %s", line); + } + } + + // exit stream + tb_stream_exit(stream); + } + + // wait + getchar(); + + // exit tbox + tb_exit(); + return 0; +} +``` + diff --git a/src/zh/guide/introduction.md b/src/zh/guide/introduction.md new file mode 100644 index 00000000..76a4fe3a --- /dev/null +++ b/src/zh/guide/introduction.md @@ -0,0 +1,172 @@ +# 简介 + +TBOX是一个用c语言实现的跨平台开发库。 + +针对各个平台，封装了统一的接口，简化了各类开发过程中常用操作，使你在开发过程中，更加关注实际应用的开发，而不是把时间浪费在琐碎的接口兼容性上面，并且充分利用了各个平台独有的一些特性进行优化。 + +这个项目的目的，是为了使C开发更加的简单高效。 + +目前支持的平台有： + +- Windows +- Macosx +- Linux +- Android +- iOS + +通过[xmake](http://www.xmake.io/cn)支持各种编译模式： + +* Release: 正式版编译，禁用调试信息、断言，各种检测机制，启用编译器优化 +* Debug: 调试模式，默认启用详细调试信息、断言、内存越界检测、内存泄漏、锁竞争分析等检测机制 +* Small: 最小化编译，默认禁用所有扩展模块，启用编译器最小化优化 +* Micro: 针对嵌入式平台，仅仅编译tbox微内核，仅提供最基础的跨平台接口，生成库仅64K左右（内置轻量libc接口实现） + +如果你想了解更多，请参考： + +* [项目主页](http://www.tboox.org/cn) +* [在线文档](https://github.com/tboox/tbox/wiki/%E7%9B%AE%E5%BD%95) +* [Github](https://github.com/tboox/tbox) +* [Gitee](https://gitee.com/tboox/tbox) + +## 特性 + +#### 流库 + +针对http、file、socket、data等流数据，实现统一接口进行读写，并且支持: 阻塞、非阻塞、异步 三种读写模式。 +支持中间增加多层filter流进行流过滤，实现边读取，内部边进行解压、编码转换、加密等操作，极大的减少了内存使用。 + +主要提供以下模块： + +- `stream`：通用非阻塞流，用于一般的单独io处理，同时支持协程以实现异步传输。 +- `transfer`：流传输器，维护两路流的传输。 +- `static_stream`：针对静态数据buffer优化的静态流，用于轻量快速的数据解析。 + +#### 协程库 + +- 快速高效的协程切换支持（具体性能参考：[基准测试报告](http://tboox.org/cn/2016/10/28/benchbox-coroutine/)） +- 提供跨平台支持，核心切换算法参考boost，并且对其进行重写和优化，目前支持架构：x86, x86_64, arm, arm64, mips32 +- 提供channel协程间数据通信支持，基于生产、消费者模型 +- 提供信号量、协程锁支持 +- socket、stream都模块原生支持协程，并且可在线程和协程间进行无缝切换 +- 提供http、file等基于协程的简单服务器实例，只需几百行代码，就可以从socket开始写个高性能io服务器，代码逻辑比异步回调模式更加清晰 +- 同时提供stackfull, stackless两种协程模式支持，stackless协程更加的轻量（每个协程只占用几十个bytes），切换更快（会牺牲部分易用性） +- 支持epoll, kqueue, poll, select 和 IOCP + +#### 数据库 + +- 统一并简化数据库操作接口，适配各种数据源，通过统一的url来自动连接打开支持的数据库，数据的枚举采用迭代器模型。 +- 目前支持sqlite3以及mysql两种关系型数据库，也可自定义扩展使用其他关系型数据库。 + +#### xml库 + +- 针对xml提供DOM和SAX两种解析模式，SAX方式采用外部迭代模式，灵活性和性能更高，并且可以选择指定路径，进行解析。 +- 解析过程完全基于stream，所以是高度流化的，可以实现边下载、边解压、边转码、边解析一条龙服务，使用较低的内存也可以解析大规模数据。 +- 提供xml writer以支持对xml生成 + +#### 内存库 + +- 参考linux内核内存管理机制的实现，并对其进行各种改造和优化，所实现的TBOX独有的一整套内存池管理架构。 +- 调试模式下，可以轻松检测并定位内存泄露、内存越界溢出、内存重叠覆盖等常见内存问题，并对整体内存的使用进行了统计和简要分析。 +- 针对大块数据、小块数据、字符串数据进行了充分的利用，避免了大量外部碎片和内部碎片的产生。分配操作进行了各种优化，96%的情况下，效率都是在O(1)。 + +#### 容器库 + +- 提供哈希、链表、数组、队列、堆栈、最小最大堆等常用容器。 +- 支持各种常用成员类型，在原有的容器期初上，其成员类型还可以完全自定义扩展。 +- 所有容器都支持迭代器操作。 +- 大部分容器都可以支持基于stream的序列化和反序列化操作。 + +#### 算法库 + +- 提供各种排序算法：冒泡排序、堆排序、快速排序、插入排序。 +- 提供各种查找算法：线性遍历、二分法搜索。 +- 提供各种遍历、删除、统计算法。 +- 以迭代器为接口，实现算法和容器的分离，类似stl，但是c实现的，更加轻量。 + +#### 网络库 + +- 实现http客户端模块 +- 实现cookies +- 实现dns解析与缓存 +- 实现ssl(支持openssl, polarssl, mbedtls) +- 支持ipv4、ipv6 +- 支持通过协程实现异步模式 + +#### 数学运算库 + +- 提供各种精度的定点运算支持 +- 提供随机数生成器 + +#### libc库 + +- libc的一个轻量级实现，完全跨平台，并且针对不同架构进行了优化。 +- 支持大部分字符串、宽字符串操作。 +- 扩展字符串、宽字符串的各种大小写不敏感操作接口 +- 扩展`memset_u16`、`memset_u32`等接口，并对其进行高度优化，尤其适合图形渲染程序 + +#### libm库 + +- libm部分接口的一个轻量级实现，以及对常用系统接口的封装。（目前只实现了部分，之后有时间会完全实现掉） +- 扩展部分常用接口，增加对sqrt、log2等常用函数的整数版本计算，进行高度优化，不涉及浮点运算，适合嵌入式环境使用。 + +#### object库 + +- 轻量级类apple的CoreFoundation库，支持object、dictionary、array、string、number、date、data等常用对象，并且可以方便扩展自定义对象的序列化。 +- 支持对xml、json、binary以及apple的plist(xplist/bplist)格式序列化和反序列化。 +并且实现自有的binary序列化格式， 针对明文进行了简单的加密，在不影响性能的前提下，序列化后的大小比bplist节省30%。 + +#### 平台库 + +- 提供file、directory、socket、thread、time等常用系统接口 +- 提供atomic、atomic64接口 +- 提供高精度、低精度定时器 +- 提供高性能的线程池操作 +- 提供event、mutex、semaphore、spinlock等事件、互斥、信号量、自旋锁操作 +- 提供获取函数堆栈信息的接口，方便调试和错误定位 +- 提供跨平台动态库加载接口（如果系统支持的话） +- 提供io轮询器，针对epoll, poll, select, kqueue进行跨平台封装 +- 提供跨平台上下文切换接口，主要用于协程实现，切换效率非常高 + +#### 压缩库 + +- 支持zlib/zlibraw/gzip的压缩与解压（需要第三方zlib库支持）。 + +#### 字符编码库 + +- 支持utf8、utf16、gbk、gb2312、uc2、uc4 之间的互相转码，并且支持大小端格式。 + +#### 实用工具库 + +- 实现base64/32编解码 +- 实现crc32、adler32、md5、sha1等常用hash算法 +- 实现日志输出、断言等辅助调试工具 +- 实现url编解码 +- 实现位操作相关接口，支持各种数据格式的解析，可以对8bits、16bits、32bits、64bits、float、double以及任意bits的字段进行解析操作，并且同时支持大端、小端和本地端模式，并针对部分操作进行了优化，像static_stream、stream都有相关接口对其进行了封装，方便在流上进行快速数据解析。 +- 实现swap16、swap32、swap64等位交换操作，并针对各个平台进行了优化。 +- 实现一些高级的位处理接口，例如：位0的快速统计、前导0和前导1的快速位计数、后导01的快速位计数 +- 实现单例模块，可以对静态对象、实例对象进行快速的单例封装，实现全局线程安全 +- 实现option模块，对命令行参数进行解析，提供快速方便的命令行选项建立和解析操作，对于写终端程序还是很有帮助的 + +#### 正则表达式库 + +- 支持匹配和替换操作 +- 支持全局、多行、大小写不敏感等模式 +- 使用pcre, pcre2和posix正则库 + +## 项目例子 + +一些使用tbox的项目 + +* [gbox](https://github.com/tboox/gbox) +* [vm86](https://github.com/tboox/vm86) +* [xmake](http://www.xmake.io/cn) +* [itrace](https://github.com/tboox/itrace) +* [更多项目](https://github.com/tboox/tbox/wiki/%E4%BD%BF%E7%94%A8tbox%E7%9A%84%E5%BC%80%E6%BA%90%E5%BA%93) + +## 联系方式 + +* 邮箱：[waruqi@gmail.com](mailto:waruqi@gmail.com) +* 主页：[TBOOX开源工程](http://www.tboox.org/cn) +* 社区：[Reddit论坛](https://www.reddit.com/r/tboox/) +* QQ群：343118190 +* 微信公众号：tboox-os diff --git a/src/zh/guide/sponsors.md b/src/zh/guide/sponsors.md new file mode 100644 index 00000000..e69de29b diff --git a/src/zh/plugin/introduction.md b/src/zh/plugin/introduction.md new file mode 100644 index 00000000..8b572209 --- /dev/null +++ b/src/zh/plugin/introduction.md @@ -0,0 +1,33 @@ +# Title1 + +[[toc]] + +## Title2 + +### Title3 + +#### Title4 + +##### Title5 + +... + +##### Title5 + +... + +#### Title4 + +... + +### Title3 + +... + +## Title2 + +... + +### Title3 + +... -- cgit v1.2.3