Sourcetrail

重要なお知らせ: このプロジェクトは、Sourcetrailのオリジナル作者およびメンテナーによって2021年末にアーカイブされました。この決定について詳しく知りたい場合は、ブログをご覧ください。

Sourcetrailは、フリーかつオープンソースのクロスプラットフォームソースエクスプローラで、不慣れなソースコードの生産性向上を支援します。

Windows:

Linux:

リンク

• ダウンロード
• クイックスタートガイド
• ドキュメント
• 変更履歴

Sourcetrailは:

• 無料
• オフラインで動作
• Windows、macOS、Linuxで動作
• C、C++、Java、Pythonに対応
• カスタム言語拡張を記述するためのSDK (SourcetrailDB)を提供

Patreon上のSourcetrail

オープンソースの開発と定期的なソフトウェアリリースは、これらの素晴らしいパトロンの支援によって完全に可能になっています！

Sourcetrailの使用

自分のマシンにSourcetrailをセットアップするには、リリースの一覧から該当するOS用ビルドをダウンロードしてインストールするか、以下のパッケージマネージャのいずれかを使用します：

• Chocolatey パッケージを choco install sourcetrail で使用

インストールが完了したら、クイックスタートガイドに従ってSourcetrailを理解してください。

問題の報告方法

機能リクエストやバグ報告は、イシュートラッカーに投稿できます。

報告

次のテンプレートを使用してください：

• プラットフォームバージョン:
• Sourcetrailバージョン:
• 問題の説明:
• 問題を再現する手順:

サポート

特定の機能リクエストをサポートしたい場合、または他のユーザーが既に報告したバグと同じものを持っている場合は、以下でお知らせください：

• イシューに「+1」のコメントを投稿する
• または、イシューIDを添えてメールを [email protected] に送信する

貢献方法

• CONTRIBUTING.mdファイルの手順を読んで従ってください。
• 最初のタスクとして取り組むために、good first issue とラベル付けされたイシューを探すとよいでしょう。
• Sourcetrailソフトウェア開発の詳細については、wiki を参照してください。

ビルド方法

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を使用する場合は、詳細モードを有効にすることをお勧めします。また、「Add Entry」ボタンから一部の定義を追加する必要がある場合があります。

• ビルド設定を生成したら、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 desktop development ワークロードをインストールしてください。
  • ダウンロード: 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 General Public License Version 3 の下でライセンスされています。

商標

"Sourcetrail" という名称は Coati Software が所有する商標であり、GNU GPLv3 の下でライセンスされたアセットには含まれていません。