Tufão 技术文档

一、安装指南

在安装 Tufão 前，请确保您的系统中已安装了 Qt 和 CMake，并且它们的执行路径已添加到环境变量中。以下是安装 Tufão 的步骤：

1. 获取依赖项：

   $ git submodule update --init
   

2. 创建一个构建文件夹，并从该文件夹中执行以下命令：

   $ cmake OPTIONS path_to_source_dir
   $ make MAKEOPTIONS
   

   OPTIONS 可以是以下值的组合：

   • -DCMAKE_INSTALL_PREFIX=${INSTALLDIR}：设置安装 Tufão 的目录。
   • -DCMAKE_BUILD_TYPE=Debug、Release、RelWithDebInfo、MinSizeRel：设置构建类型。
   • -DLIB_SUFFIX=${LIB_SUFFIX}：设置安装目录的后缀。
   • -DGENERATE_DOC=YES：生成文档。
   • -DENABLE_TESTS=YES：生成并运行测试。

   对于 Windows 系统，还可以使用以下选项：

   • -G"MinGW Makefiles"：为 MinGW 环境生成 Makefiles。
   • -G"Visual Studio 10"：为 Visual Studio 10 生成项目文件。

   MAKEOPTIONS 可以包含以下值：

   • install：安装 Tufão。
   • DESTDIR=${PKGDIR}：设置安装目录。

   示例：

   $ cmake -DCMAKE_INSTALL_PREFIX=/usr
   $ make DESTDIR=pkg install
   

3. 若要创建 CPack-based 安装程序，只需运行以下命令：

   # 创建二进制分发：
   cpack -C CPackConfig.cmake
   
   # 创建源分发：
   cpack -C CPackSourceConfig.cmake
   
   # 创建 Windows NSIS-based 安装程序：
   cpack -GNSIS
   

二、使用说明

文档生成

要生成文档，请使用 Doxygen，并使用 Doxyfile 作为配置文件。生成的文档将位于 doc 文件夹中。文档格式包括：

• HTML：始终生成，位于 doc/html 文件夹。
• LaTeX：可以生成 PDF，只需在 doc/latex 文件夹中运行 make 命令。
• Qt 压缩帮助文件：如果系统中存在 qhelpgenerator 工具，则该文件会在运行 Doxygen 时生成，位于 doc/qch/tufao.qch。

测试

Tufão 包含了大量的测试代码，基于 QTestLib，用于验证代码的正确性。可以通过以下命令运行测试：

make tests

或者，如果不使用 Makefiles：

ctest

在 Visual Studio 中，会创建一个 _RUN_TESTS_ 目标。

CTest 可以与 CDash 集成，允许开发者集中管理测试结果。您可以通过运行以下命令将测试结果发送到 CDash：

make Experimental

您可以在 Tufão CDash 项目页面 查看测试日志。

安装

默认的安装前缀是 /usr/local，如果您不打算更改它，只需在构建完成后运行以下命令：

# make install

若要安装到不同的前缀，请运行：

$ cmake -DCMAKE_INSTALL_PREFIX=${DESTDIR}
$ make install

注意：根据您的系统，安装后可能需要运行 ldconfig。

用法

要在 Qt 项目中使用 Tufão，请编辑您的 .pro 文件并添加以下行：

CONFIG += C++11 TUFAO1

您可以在 examples 文件夹中找到一些示例。

如果您计划在 OS X 上使用 Tufão，则还需要添加以下行（根据一些用户的报告）：

QMAKE_MACOSX_DEPLOYMENT_TARGET = 10.7

Tufão 也支持 PKG-CONFIG。其模块名称为 tufao1。

如果要在其他构建系统中使用 Tufão，只需添加编译器选项 -ltufao1。

您还可以在 QtAssistant 中查看 Tufão 文档。

三、项目 API 使用文档

Tufão 的 API 文档可在其 GitHub 页面上找到，包括类的详细描述、方法和属性。文档以 HTML 格式提供，方便用户查看和搜索。

四、项目安装方式

Tufão 的安装方式已在“安装指南”部分详细说明，主要包括使用 CMake 和 Make（或 Visual Studio）进行构建和安装。用户可以根据自己的操作系统和环境选择合适的安装方法。