Sourcetrail

Wichtiger Hinweis: Dieses Projekt wurde von den ursprünglichen Autoren und Maintainern von Sourcetrail Ende 2021 archiviert. Wenn Sie mehr über diese Entscheidung erfahren möchten, lesen Sie mehr in unserem Blog.

Sourcetrail ist ein kostenloser und quelloffener plattformübergreifender Source-Explorer, der Ihnen hilft, produktiv mit unbekanntem Quellcode zu arbeiten.

Windows:

Linux:

Links

• Herunterladen
• Schnellstartanleitung
• Dokumentation
• Änderungsprotokoll

Sourcetrail ist:

• kostenlos
• arbeitet offline
• läuft auf Windows, macOS und Linux
• unterstützt C, C++, Java und Python
• bietet ein SDK (SourcetrailDB) zum Schreiben benutzerdefinierter Spracherweiterungen

Sourcetrail auf Patreon

Die Open-Source-Entwicklung und regelmäßige Software-Veröffentlichungen werden vollständig durch die Unterstützung dieser großartigen Gönner ermöglicht!

Sourcetrail verwenden

Um Sourcetrail auf Ihrem Rechner einzurichten, können Sie entweder den entsprechenden Build für Ihr Betriebssystem aus unserer Liste der Veröffentlichungen herunterladen und auf Ihrem Rechner installieren, oder einen der folgenden Paketmanager verwenden:

• Verwenden Sie das Chocolatey-Paket mit choco install sourcetrail

Nach Abschluss der Installation folgen Sie unserer Schnellstartanleitung, um Sourcetrail kennenzulernen.

Wie man Probleme meldet

Sie können alle Ihre Funktionsanfragen und Fehlerberichte in unserem Issue-Tracker veröffentlichen.

Melden

Verwenden Sie die folgende Vorlage:

• Plattformversion:
• Sourcetrail-Version:
• Beschreibung des Problems:
• Schritte zur Reproduktion des Problems:

Unterstützen

Wenn Sie eine bestimmte Funktionsanfrage unterstützen möchten oder das gleiche Problem haben, das bereits von einem anderen Benutzer gemeldet wurde, lassen Sie es uns wissen:

• posten Sie einen Kommentar mit "+1" zu dem Issue
• oder senden Sie eine E-Mail an [email protected] mit der Issue-ID

Wie man beiträgt

• Bitte lesen und befolgen Sie die Schritte in der Datei CONTRIBUTING.md.
• Sie können nach Issues Ausschau halten, die mit good first issue gekennzeichnet sind, um erste Aufgaben zu finden.
• Wenn Sie weitere Informationen zur Sourcetrail-Softwareentwicklung suchen, lesen Sie bitte unser Wiki.

Bauanleitung

Das Bauen von Sourcetrail erfordert mehrere Abhängigkeiten auf Ihrem Rechner. Unser CMake-basierter Setup ermöglicht es jedoch, die Indexierungsunterstützung für bestimmte Sprachen zu deaktivieren, was die Anzahl der Abhängigkeiten auf ein Minimum reduziert.

Bauen der Basis-Anwendung

Erforderliche Werkzeuge

• CMake v3.12 (erforderlich für Windows, Linux und MacOS)

  • Grund: Wird verwendet, um eine Build-Konfiguration für Ihr Build-System zu generieren
  • Download: https://cmake.org/download

• Git (erforderlich für Windows, Linux und MacOS)

  • Grund: Wird für die Versionskontrolle verwendet und um automatisch die Sourcetrail-Versionsnummer aus Commits und Tags zu generieren
  • Download: https://git-scm.com/download
  • Hinweis: Stellen Sie sicher, dass git zu Ihrer PATH-Umgebungsvariable hinzugefügt ist, bevor Sie CMake ausführen

• Visual Studio (erforderlich für Windows)

  • Grund: Wird zum Bauen von Sourcetrail verwendet
  • Download: https://visualstudio.microsoft.com/downloads/

• ccache (optional für Linux und MacOS)

  • Grund: Wird verwendet, um Neubauten zu beschleunigen, falls in PATH gefunden
  • Download: https://ccache.dev/download.html

Erforderliche Abhängigkeiten

• Boost 1.67

  • Grund: Wird für Dateisystemzugriff und Interprozesskommunikation verwendet
  • Prebuilt Download für Windows: https://sourceforge.net/projects/boost/files/boost-binaries/
  • Bauen für 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

  • Grund: Wird zum Rendern der GUI und zum Starten zusätzlicher (Indexer-)Prozesse verwendet.
  • Prebuilt Download: http://download.qt.io/official_releases/qt/

Bauen

Unter Windows

• Um Ihre Build-Umgebung einzurichten, führen Sie Folgendes aus:

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

  Hinweis: Wenn Sie die CMake-GUI verwenden, empfehlen wir, den erweiterten Modus zu aktivieren. Möglicherweise müssen Sie auch einige der Defines über die Schaltfläche "Add Entry" hinzufügen.

• Nachdem Sie die Build-Konfiguration generiert haben, öffnen Sie einfach die Datei Sourcetrail.sln, die von CMake erstellt wurde, und bauen Sie das Sourcetrail-Projekt.

Unter Unix

• Um Ihre Build-Umgebung einzurichten, führen Sie Folgendes aus:
  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> ../..
  

• Starten Sie nun den Build mit:
  root@kitploit:~

  $ make Sourcetrail
  

Ausführen

• Führen Sie Sourcetrail aus dem Build-Verzeichnis aus. Während der Ausführung benötigt Sourcetrail Ressourcen aus bin/app/data und bin/app/user. CMake erstellt Symlinks im Build-Verzeichnis, die diese Verzeichnisse zugänglich machen.

C/C++-Sprachunterstützung aktivieren

Erforderliche Abhängigkeiten

• LLVM/Clang 11.0.0
  • Grund: Wird verwendet, um den Präprozessor auf dem indizierten Quellcode auszuführen, einen abstrakten Syntaxbaum zu erstellen und zu durchlaufen und Fehlermeldungen zu generieren.
  • Bauen: Stellen Sie sicher, dass Sie das richtige Tag auschecken: git checkout llvmorg-11.0.0
  • Bauen für Windows: Folgen Sie diesen Schritten, um das Projekt zu bauen. Führen Sie den cmake-Befehl genau wie beschrieben aus.
  • Bauen für Unix: Folgen Sie dieser Installationsanleitung, um das Projekt zu bauen. Stellen Sie sicher, dass Sie mit -DLLVM_ENABLE_RTTI=ON bauen.

Bauen

• Führen Sie CMake mit diesen zusätzlichen Optionen aus:
  root@kitploit:~

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

• Bauen Sie Sourcetrail wie oben beschrieben.

Java-Sprachunterstützung aktivieren

Erforderliche Abhängigkeiten

• JDK 1.8

  • Grund: Wird verwendet, um den Java-Indexer zu bauen und ihn über JNI vom C++-Code aus aufrufbar zu machen.
  • Hinweis: Stellen Sie sicher, dass <jdk_root>/bin in Ihrer PATH-Umgebungsvariable verfügbar ist und dass die JAVA_HOME-Umgebungsvariable gesetzt ist:
    root@kitploit:~

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

• Maven

  • GRUND: Wird in den automatisierten Tests von Sourcetrail verwendet.
  • Hinweis: Stellen Sie sicher, dass .../apache-maven-x.x.x/bin in Ihrer PATH-Umgebungsvariable verfügbar ist und dass sowohl die M2_HOME- als auch die MAVEN_HOME-Umgebungsvariable gesetzt sind:
    root@kitploit:~

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

Bauen

• Führen Sie CMake mit diesen zusätzlichen Optionen aus:
  root@kitploit:~

  -DBUILD_JAVA_LANGUAGE_PACKAGE=ON
  

• Bauen Sie Sourcetrail wie oben beschrieben.

Python-Sprachunterstützung aktivieren

Erforderliche Werkzeuge

• 7z (erforderlich für Windows)
  • GRUND: Wird verwendet, um den vorgebauten SourcetrailPythonIndexer zu extrahieren, der automatisch während des Build-Vorgangs heruntergeladen wird.

Bauen

• Führen Sie CMake mit diesen zusätzlichen Optionen aus:
  root@kitploit:~

  -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON
  

• Bauen Sie Sourcetrail wie oben beschrieben.

Erstellen des Bereitstellungspakets

Windows

Erforderliche Werkzeuge

• Visual Studio (erforderlich für Windows)

  • Grund: Wird zum Bauen des Sourcetrail Windows-Installers verwendet.
  • Hinweis: Stellen Sie sicher, dass die Workload .Net desktop development installiert ist.
  • Download: https://visualstudio.microsoft.com/downloads/

• Wix 3.11

  • Grund: Wird verwendet, um den Windows-Installer sourcetrail.msi zu bauen.
  • Hinweis: Stellen Sie sicher, dass <path/to>/WiX Toolset v3.11/bin zu Ihrer PATH-Umgebungsvariable hinzugefügt ist.
  • Download: https://wixtoolset.org/releases/

• Wix-Erweiterung für Visual Studio

  • Grund: Wird verwendet, um Wix aus der Visual Studio-Build-Umgebung auszuführen.
  • Download: https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2017Extension

• JRE

  • Grund: Wird zum Indizieren des Java-Beispielprojekts verwendet, das mit dem Paket geliefert wird.

• WinRAR

  • Grund: Wird zum Erstellen der endgültigen Zip-Dateien für den Installer und das portable Paket verwendet.
  • Hinweis: Stellen Sie sicher, dass <path/to>/WinRAR zu Ihrer -Umgebungsvariable hinzugefügt ist.

Bauen

• Führen Sie ./script/deploy_windows.sh von Ihrer Developer-Eingabeaufforderung für Visual Studio aus. Das Skript generiert einen 64-Bit-Build und packt ihn jeweils in eine portable .zip-Datei und einen Wix-basierten Windows-Installer.

macOS

Führen Sie nach dem Bauen das Skript bundle_install.sh im Build-Verzeichnis aus. Es erstellt ein Sourcetrail.app-Bundle und generiert einen Sourcetrail_<version>.dmg-Container.

Linux

Führen Sie ./setup/Linux/createPackages.sh aus dem Hauptverzeichnis aus. Es erstellt sowohl ein .tar.gz- als auch ein .AppImage-Paket im Hauptverzeichnis. Die Paketerstellung hängt von linuxdeployqt ab.

So führen Sie die Tests aus

Die automatisierte Testsuite von Sourcetrail wird von Catch2 betrieben. Um die Tests auszuführen, führen Sie einfach die Binärdatei Sourcetrail_test aus. Stellen Sie vor der Ausführung sicher, dass das Arbeitsverzeichnis auf ./bin/test gesetzt ist.

Lizenz

Sourcetrail ist unter der GNU General Public License Version 3 lizenziert.

Markenzeichen

Der Name "Sourcetrail" ist eine Marke von Coati Software und ist nicht in den unter der GNU GPLv3 lizenzierten Assets enthalten.