Sourcetrail

重要提示： 该项目已于2021年底被原始作者和维护者归档。如果您想了解更多关于这一决定的信息，请阅读我们的博客。

Sourcetrail 是一款免费开源的跨平台源代码浏览器，帮助您快速熟悉陌生的源代码。

Windows：

Linux：

链接

• 下载
• 快速入门指南
• 文档
• 更新日志

Sourcetrail 具备以下特点：

• 免费
• 离线工作
• 支持 Windows、macOS 和 Linux
• 支持 C、C++、Java 和 Python
• 提供 SDK（SourcetrailDB）用于编写自定义语言扩展

Sourcetrail 在 Patreon 上

开源开发和定期软件版本发布完全得益于这些优秀赞助人的支持！

使用 Sourcetrail

要在您的机器上安装 Sourcetrail，您可以从我们的发布页面下载适用于您操作系统的相应版本并安装，或者使用以下包管理器之一：

• 使用 Chocolatey 包，命令：choco install sourcetrail

安装完成后，请按照我们的快速入门指南了解 Sourcetrail。

如何报告问题

您可以将所有功能请求和错误报告发布到我们的问题追踪器上。

报告

请使用以下模板：

• 平台版本：
• Sourcetrail 版本：
• 问题描述：
• 复现步骤：

支持

如果您想要支持某个功能请求，或者遇到了其他用户已经报告的相同错误，请告知我们：

• 在问题下评论 "+1"
• 或发送邮件至 [email protected]，注明问题 ID

如何贡献

• 请阅读并遵循 CONTRIBUTING.md 文件中的步骤。
• 您可以关注标记为 good first issue 的问题，以找到可着手处理的初步任务。
• 如需了解更多关于 Sourcetrail 软件开发的信息，请参考我们的维基。

如何构建

构建 Sourcetrail 需要在您的机器上安装多个依赖项。不过，我们基于 CMake 的构建设置允许禁用对特定语言的索引支持，从而将依赖项减少到最低限度。

构建基础应用程序

必需工具

• CMake v3.12（Windows、Linux 和 MacOS 必需）

  • 原因：用于为构建系统生成构建配置
  • 下载地址：https://cmake.org/download

• Git（Windows、Linux 和 MacOS 必需）

  • 原因：用于版本控制，并自动从提交和标签生成 Sourcetrail 版本号
  • 下载地址：https://git-scm.com/download
  • 备注：运行 CMake 之前，请确保 git 已添加到 PATH 环境变量中

• Visual Studio（Windows 必需）

  • 原因：用于构建 Sourcetrail
  • 下载地址：https://visualstudio.microsoft.com/downloads/

• ccache（Linux 和 MacOS 可选）

  • 原因：如果在 PATH 中找到，可用于加速重新构建
  • 下载地址：https://ccache.dev/download.html

必需依赖项

• Boost 1.67

  • 原因：用于文件系统访问和进程间通信
  • Windows 预构建下载：https://sourceforge.net/projects/boost/files/boost-binaries/
  • Unix 构建方法：
    root@kitploit:~

    $ ./bootstrap.sh --with-libraries=filesystem,program_options,system,date_time
    $ ./b2 --link=static --variant=release --threading=multi --runtime-link=static --cxxflags=-fPIC
    

• Qt 5.12.3

  • 原因：用于渲染 GUI 和启动额外的（索引器）进程。
  • 预构建下载：http://download.qt.io/official_releases/qt/

构建

Windows 平台

• 设置构建环境，执行：

  root@kitploit:~

  $ git clone https://github.com/CoatiSoftware/Sourcetrail.git
  $ cd Sourcetrail
  $ mkdir -p build/win64
  $ cd build/win64
  $ cmake -G "Visual Studio 15 2017 Win64" -DBOOST_ROOT=<path/to/boost_1_67_0> -DQt5_DIR=<path/to/Qt/version/platform/compiler/lib/cmake/Qt5> ../..
  

  提示：如果您使用 CMake GUI，建议激活高级模式。此外，您可能需要通过 "添加条目" 按钮添加一些定义。

• 生成构建配置后，只需打开 CMake 生成的 Sourcetrail.sln 文件，然后构建 Sourcetrail 项目。

Unix 平台

• 设置构建环境，执行：
  root@kitploit:~

  $ cd Sourcetrail
  $ mkdir -p build/Release
  $ cd build/Release
  $ cmake -DCMAKE_BUILD_TYPE="Release" -DBOOST_ROOT=<path/to/boost_1_67_0> -DQt5_DIR=<path/to/Qt/version/platform/compiler/lib/cmake/Qt5> ../..
  

• 现在开始构建：
  root@kitploit:~

  $ make Sourcetrail
  

运行

• 在构建目录内运行 Sourcetrail。执行期间，Sourcetrail 需要 bin/app/data 和 bin/app/user 中的资源。CMake 会在构建目录内创建符号链接，使这些目录可访问。

启用 C/C++ 语言支持

必需依赖项

• LLVM/Clang 11.0.0
  • 原因：用于对被索引的源代码运行预处理器，构建和遍历抽象语法树，以及生成错误消息。
  • 构建方法：确保检出正确的标签：git checkout llvmorg-11.0.0
  • Windows 构建：按照这些步骤构建项目。请完全按照描述运行 cmake 命令。
  • Unix 构建：按照这个安装指南构建项目。确保使用 -DLLVM_ENABLE_RTTI=ON 进行构建。

构建

• 使用以下额外选项运行 CMake：
  root@kitploit:~

  -DClang_DIR=<path/to/llvm_build>/lib/cmake/clang
  -DBUILD_CXX_LANGUAGE_PACKAGE=ON
  

• 按照上述说明构建 Sourcetrail。

启用 Java 语言支持

必需依赖项

• JDK 1.8

  • 原因：用于构建 Java 索引器，并使其可通过 JNI 从 C++ 代码调用。
  • 备注：确保 <jdk_root>/bin 在 PATH 环境变量中可用，并且设置了 JAVA_HOME 环境变量：
    root@kitploit:~

    JAVA_HOME=<path/to/Java>/jdk1.x.x_xxx
    

• Maven

  • 原因：用于 Sourcetrail 的自动化测试。
  • 备注：确保 .../apache-maven-x.x.x/bin 在 PATH 环境变量中可用，并且设置了 M2_HOME 和 MAVEN_HOME 环境变量：
    root@kitploit:~

    M2_HOME=.../apache-maven-x.x.x
    MAVEN_HOME=.../apache-maven-x.x.x
    

构建

• 使用以下额外选项运行 CMake：
  root@kitploit:~

  -DBUILD_JAVA_LANGUAGE_PACKAGE=ON
  

• 按照上述说明构建 Sourcetrail。

启用 Python 语言支持

必需工具

• 7z（Windows 必需）
  • 原因：用于解压在构建过程中自动下载的预构建 SourcetrailPythonIndexer。

构建

• 使用以下额外选项运行 CMake：
  root@kitploit:~

  -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON
  

• 按照上述说明构建 Sourcetrail。

创建部署包

Windows

必需工具

• Visual Studio（Windows 必需）

  • 原因：用于构建 Sourcetrail Windows 安装程序。
  • 备注：确保安装了 ".Net 桌面开发" 工作负载。
  • 下载：https://visualstudio.microsoft.com/downloads/

• Wix 3.11

  • 原因：用于构建 sourcetrail.msi Windows 安装程序。
  • 备注：确保将 <path/to>/WiX Toolset v3.11/bin 添加到 PATH 环境变量中。
  • 下载：https://wixtoolset.org/releases/

• Visual Studio 的 Wix 扩展

  • 原因：用于在 Visual Studio 构建环境中运行 Wix。
  • 下载：https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2017Extension

• JRE

  • 原因：用于索引随包附带的 Java 示例项目。

• WinRAR

  • 原因：用于为安装程序和便携包创建最终的 zip 文件。
  • 备注：确保将 <path/to>/WinRAR 添加到 PATH 环境变量中。

构建

• 在 Visual Studio 的开发人员命令提示符下运行 ./script/deploy_windows.sh。该脚本将生成一个 64 位构建，并将其打包为便携 .zip 文件和一个基于 Wix 的 Windows 安装程序。

macOS

构建后，在构建目录内运行 bundle_install.sh 脚本，该脚本将创建一个 Sourcetrail.app 包，并生成一个 Sourcetrail_<version>.dmg 容器。

Linux

从主目录运行 ./setup/Linux/createPackages.sh，该脚本将在主目录中创建 .tar.gz 和 .AppImage 包。打包依赖 linuxdeployqt。

如何运行测试

Sourcetrail 的自动化测试套件由 Catch2 驱动。要运行测试，只需执行 Sourcetrail_test 二进制文件。执行前，请确保将工作目录设置为 ./bin/test。

许可证

Sourcetrail 采用 GNU 通用公共许可证第3版 授权。

商标

"Sourcetrail" 名称是 Coati Software 拥有的商标，不包含在 GNU GPLv3 许可的资产中。