Sourcetrail

Quellenpfad

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

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

Windows:

Linux:

Links

• Herunterladen
• Kurzanleitung
• Dokumentation
• Änderungsprotokoll

Sourcetrail ist:

• frei
• offline arbeiten
• Betrieb unter Windows, macOS und Linux
• unterstützt C, C++, Java und Python
• bietet ein SDK (SourcetrailDB) zum Schreiben benutzerdefinierter Spracherweiterungen an

Sourcetrail auf Patreon

Die Open-Source-Entwicklung und regelmäßige Software-Releases werden ausschließlich durch die Unterstützung dieser großartigen Gönner ermöglicht!

Verwenden von Sourcetrail

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

• Verwenden Sie das Chocolatey-Paket mit choco install sourcetrail

Nachdem Ihre Installation abgeschlossen ist, folgen Sie unserer Kurzanleitung, um Sourcetrail kennenzulernen.

So melden Sie Probleme

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

Berichterstattung

Verwenden Sie die folgende Vorlage:

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

Unterstützend

Wenn Sie eine bestimmte Funktionsanfrage unterstützen möchten oder denselben Fehler haben, den bereits ein anderer Benutzer gemeldet hat, teilen Sie uns dies bitte mit:

• Schreiben Sie einen Kommentar mit „+1“ zum Problem
• oder senden Sie eine E-Mail mit der Problem-ID an [email protected]

So können Sie einen Beitrag leisten

• Bitte lesen und befolgen Sie die Schritte in der Datei CONTRIBUTING.md.
• Möglicherweise möchten Sie nach Problemen mit der Bezeichnung „Gutes erstes Problem“ Ausschau halten, um einige erste Aufgaben zu finden, die Sie in Angriff nehmen können.
• Wenn Sie weitere Informationen zur Sourcetrail-Softwareentwicklung suchen, lesen Sie bitte unser Wiki.

Wie man baut

Für die Erstellung von Sourcetrail müssen mehrere Abhängigkeiten auf Ihrem Computer vorhanden sein. Unser CMake-basiertes Setup ermöglicht jedoch die Deaktivierung der Indizierungsunterstützung für bestimmte Sprachen, wodurch die Anzahl der Abhängigkeiten auf ein Minimum reduziert wird.

Erstellen der Basisanwendung

Erforderliche Werkzeuge

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

  • Grund : Wird zum Generieren einer Build-Konfiguration für Ihr Build-System verwendet
  • Herunterladen : https://cmake.org/download

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

  • Grund : Wird zur Versionskontrolle und zur automatischen Generierung der Sourcetrail-Versionsnummer aus Commits und Tags verwendet
  • Herunterladen : https://git-scm.com/download
  • Anmerkungen : Stellen Sie sicher, dass git zu Ihrer PATH Umgebungsvariablen hinzugefügt wird, bevor Sie CMake ausführen

• Visual Studio (erforderlich für Windows)

  • Grund : Wird für den Bau von Sourcetrail verwendet
  • Herunterladen : https://visualstudio.microsoft.com/downloads/

• ccache (optional für Linux und MacOS)

  • Grund : Wird verwendet, um Neuerstellungen zu beschleunigen, wenn es in PATH gefunden wird
  • Herunterladen : https://ccache.dev/download.html

Erforderliche Abhängigkeiten

• Boost 1,67

  • Grund : Wird für den Zugriff auf das Dateisystem und die Kommunikation zwischen Prozessen verwendet
  • Vorgefertigter Download für Windows : https://sourceforge.net/projects/boost/files/boost-binaries/
  • Erstellen für 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

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

Gebäude

Unter Windows

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

   $ 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 Ihnen, den erweiterten Modus zu aktivieren. Möglicherweise müssen Sie auch einige der Definitionen über die Schaltfläche „Eintrag hinzufügen“ hinzufügen.

• Öffnen Sie nach dem Generieren der Build-Konfiguration einfach die von CMake generierte Datei Sourcetrail.sln und erstellen Sie das Sourcetrail-Projekt.

Unter Unix

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

   $ 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:

   $ make Sourcetrail
  

Läuft

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

Aktivieren Sie die C/C++-Sprachunterstützung

Erforderliche Abhängigkeiten

• LLVM/Clang 11.0.0
  • Grund : Wird zum Ausführen des Präprozessors für den indizierten Quellcode, zum Erstellen und Durchlaufen eines abstrakten Syntaxbaums und zum Generieren von Fehlermeldungen verwendet.
  • Gebäude : Stellen Sie sicher, dass Sie das richtige Tag überprüfen: git checkout llvmorg-11.0.0
  • Erstellen für Windows : Befolgen Sie diese Schritte, um das Projekt zu erstellen. Führen Sie den Befehl cmake genau wie beschrieben aus.
  • Erstellen für Unix : Befolgen Sie diese Installationsanleitung, um das Projekt zu erstellen. Stellen Sie sicher, dass Sie mit -DLLVM_ENABLE_RTTI=ON erstellen.

Gebäude

• Führen Sie CMake mit diesen zusätzlichen Optionen aus:

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

• Erstellen Sie Sourcetrail wie oben beschrieben.

Aktivieren Sie die Java-Sprachunterstützung

Erforderliche Abhängigkeiten

• JDK 1.8

  • Grund : Wird verwendet, um den Java-Indexer zu erstellen und ihn über JNI aus dem C++-Code aufrufbar zu machen.
  • Anmerkungen : Stellen Sie sicher, dass <jdk_root>/bin in Ihrer PATH Umgebungsvariablen verfügbar ist und dass die Umgebungsvariable JAVA_HOME festgelegt ist:

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

• Maven

  • GRUND : Wird im Rahmen der automatisierten Tests von Sourcetrail verwendet.
  • Anmerkungen : Stellen Sie sicher .../apache-maven-xxx/bin in Ihrer PATH Umgebungsvariablen verfügbar ist und dass sowohl die Umgebungsvariablen M2_HOME als auch MAVEN_HOME festgelegt sind:

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

Gebäude

• Führen Sie CMake mit diesen zusätzlichen Optionen aus:

   -DBUILD_JAVA_LANGUAGE_PACKAGE=ON
  

• Erstellen Sie Sourcetrail wie oben beschrieben.

Aktivieren Sie die Python-Sprachunterstützung

Erforderliche Werkzeuge

• 7z (erforderlich für Windows)
  • GRUND : Wird zum Extrahieren des vorgefertigten SourcetrailPythonIndexer verwendet, der während der Build-Ausführung automatisch heruntergeladen wird.

Gebäude

• Führen Sie CMake mit diesen zusätzlichen Optionen aus:

   -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON
  

• Erstellen Sie Sourcetrail wie oben beschrieben.

Erstellen des Bereitstellungspakets

Windows

Erforderliche Werkzeuge

• Visual Studio (erforderlich für Windows)

  • Grund : Wird zum Erstellen des Sourcetrail-Windows-Installationsprogramms verwendet.
  • Anmerkungen : Stellen Sie sicher, dass Sie den .Net desktop development -Workload installieren.
  • Herunterladen : https://visualstudio.microsoft.com/downloads/

• Wix 3.11

  • Grund : Wird zum Erstellen des Windows-Installationsprogramms sourcetrail.msi verwendet.
  • Anmerkungen : Stellen Sie sicher, dass Sie <path/to>/WiX Toolset v3.11/bin zu Ihrer PATH Umgebungsvariablen hinzufügen.
  • Herunterladen : https://wixtoolset.org/releases/

• Wix-Erweiterung für Visual Studio

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

• JRE

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

• WinRAR

  • Grund : Wird zum Erstellen der endgültigen ZIP-Dateien für das Installationsprogramm und das tragbare Paket verwendet.
  • Anmerkungen : Stellen Sie sicher, dass Sie <path/to>/WinRAR zu Ihrer PATH Umgebungsvariablen hinzufügen.

Gebäude

• Führen Sie ./script/deploy_windows.sh über die Entwickler-Eingabeaufforderung für Visual Studio aus. Das Skript, das einen 64-Bit-Build generiert und ihn jeweils in eine portable .zip Datei und ein Wix-basiertes Windows-Installationsprogramm verpackt.

macOS

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

Linux

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

So führen Sie die Tests durch

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

Lizenz

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

Warenzeichen

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