TBOX 项目技术文档

1. 安装指南

1.1 安装依赖

在安装 TBOX 之前，请确保系统中已经安装了以下依赖：

• 编译工具链（如 GCC、Clang 等）
• 如果需要编译 Android 平台，请安装 Android NDK
• 如果需要编译 iOS 平台，请确保 Xcode 已安装

1.2 使用 Xmake 编译

TBOX 推荐使用 Xmake 进行编译。首先，确保你已经安装了 Xmake。

# 安装 Xmake
$ curl -fsSL https://xmake.io/shget.text | bash

1.3 编译 TBOX

进入 TBOX 项目目录，使用 Xmake 进行编译：

# 默认编译当前主机平台
$ cd ./tbox
$ xmake

# 编译 mingw 平台
$ xmake f -p mingw --sdk=/home/mingwsdk
$ xmake

# 编译 iphoneos 平台
$ xmake f -p iphoneos
$ xmake

# 编译 android 平台
$ xmake f -p android --ndk=xxxxx
$ xmake

# 交叉编译
$ xmake f -p linux --sdk=/home/sdk
$ xmake

1.4 使用 xmake.sh 编译

如果你不想使用 Xmake，也可以使用 xmake.sh 进行编译：

$ ./configure
$ make

2. 项目的使用说明

2.1 初始化与退出

在使用 TBOX 库之前，需要先进行初始化：

#include "tbox/tbox.h"

int main(int argc, char** argv) {
    if (!tb_init(tb_null, tb_null)) return 0;

    // 你的代码逻辑

    tb_exit();
    return 0;
}

2.2 容器使用示例

TBOX 提供了丰富的容器库，以下是一个简单的向量容器使用示例：

tb_vector_ref_t vector = tb_vector_init(0, tb_element_str(tb_true));
if (vector) {
    tb_vector_insert_tail(vector, "hello");
    tb_vector_insert_tail(vector, "tbox");

    tb_for_all (tb_char_t const*, cstr, vector) {
        tb_trace_i("%s", cstr);
    }
    tb_vector_exit(vector);
}

2.3 协程使用示例

TBOX 的协程库支持异步操作，以下是一个简单的协程示例：

tb_coroutine_func_t func = tb_coroutine_func_init(tb_coroutine_func(test), tb_null);
tb_coroutine_start(func);

3. 项目 API 使用文档

3.1 流库 API

TBOX 的流库提供了统一的接口来处理不同类型的流数据，支持阻塞、非阻塞和异步模式。

// 创建一个文件流
tb_stream_ref_t stream = tb_stream_init_from_file("test.txt", TB_FILE_MODE_RW);
if (stream) {
    tb_stream_read(stream, buffer, size);
    tb_stream_write(stream, buffer, size);
    tb_stream_exit(stream);
}

3.2 协程库 API

协程库提供了高效的协程切换支持，以下是一些常用的协程 API：

// 创建一个协程
tb_coroutine_ref_t coroutine = tb_coroutine_init(tb_coroutine_func(my_coroutine), tb_null);

// 启动协程
tb_coroutine_start(coroutine);

// 等待协程结束
tb_coroutine_wait(coroutine);

3.3 数据库 API

TBOX 的数据库模块支持 SQLite3 和 MySQL，以下是一个简单的数据库操作示例：

tb_database_ref_t db = tb_database_init("sqlite3://test.db");
if (db) {
    tb_database_execute(db, "CREATE TABLE test (id INTEGER PRIMARY KEY, name TEXT)");
    tb_database_execute(db, "INSERT INTO test (name) VALUES ('tbox')");
    tb_database_exit(db);
}

4. 项目安装方式

4.1 使用 Xmake 安装

编译完成后，可以使用 Xmake 进行安装：

$ xmake install

4.2 手动安装

如果你不想使用 Xmake，也可以手动将编译好的库文件和头文件复制到系统目录：

$ cp -r ./tbox/include /usr/local/include
$ cp -r ./tbox/lib /usr/local/lib

通过以上步骤，你可以成功安装并使用 TBOX 库进行开发。