Sourcetrail

重要提示： 该项目已由原作者和维护者在2021年底存档。有关此决定的更多信息，请访问我们的博客。

Sourcetrail是一款免费开源的跨平台源代码探索器，助您快速掌握不熟悉的源代码。

• Windows: 链接

• Linux: 链接

链接

1. 下载
2. 快速入门指南
3. 文档
4. 更新日志

Sourcetrail具有以下特点：

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

Sourcetrail 在 Patreon 上

开放源码开发和定期软件发布完全得益于这些杰出赞助者的支持！

使用 Sourcetrail

要在您的计算机上设置 Sourcetrail，您可以从我们的发行版列表中下载相应构建，并安装到您的机器上，或者使用以下包管理器之一：

• 使用choco install sourcetrail安装Chocolatey 包。

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

报告问题

您可以在我们的问题跟踪器上提交所有功能请求和错误报告。

报告模板：

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

支持

如果您想要支持特定功能请求，或者遇到其他用户已经报告的相同问题，请告知我们：

• 对问题发表评论，注明“+1”
• 或发送电子邮件至 support@sourcetrail.com，附上问题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
  • 注意：确保将 git 添加到 PATH 环境变量，然后运行 CMake

• 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 编译：

    $ ./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上

1. 设置构建环境：

   $ 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图形界面，建议启用高级模式。可能需要通过“添加条目”按钮输入一些定义。

2. 生成配置后，只需打开由 CMake 生成的 Sourcetrail.sln 文件并构建 Sourcetrail 项目即可。

在Unix上

1. 设置构建环境：

   $ 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> ../..
   

2. 开始构建：

   $ 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时添加以下选项：

  -DClang_DIR=<路径/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环境变量：

    JAVA_HOME=<路径/to/Java>/jdk1.x.x_xxx
    

• Maven

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

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

构建

• 运行CMake时添加以下选项：

  -DBUILD_JAVA_LANGUAGE_PACKAGE=ON
  

• 如上文所述构建Sourcetrail。

开启 Python 语言支持

所需工具

• 7z（仅限Windows）
  • 原因：用于提取自动下载的预构建SourcetrailPythonIndexer。

构建

• 运行CMake时添加以下选项：

  -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON
  

• 如上文所述构建Sourcetrail。

创建部署包

Windows

所需工具

• Visual Studio（仅限Windows）

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

• Wix 3.11

  • 原因：用于构建sourcetrail.msiWindows安装程序。
  • 备注：请将<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_<版本>.dmg容器。

Linux

在主目录中运行./setup/Linux/createPackages.sh，这将在主目录中创建一个.tar.gz和一个.AppImage包。打包依赖于linuxdeployqt。

如何运行测试

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

许可证

Sourcetrail根据GNU 通用公共许可证第三版授权。

商标

"Sourcetrail"是Coati Software拥有的商标，不包含在根据GNU GPL v3许可的资产中。