Sourcetrail

Nota importante: Questo progetto è stato archiviato dagli autori e manutentori originali di Sourcetrail alla fine del 2021. Se vuoi saperne di più su questa decisione, leggi di più sul nostro blog.

Sourcetrail è un esploratore di codice sorgente multipiattaforma gratuito e open-source che ti aiuta a diventare produttivo su codice sorgente sconosciuto.

Windows:

Linux:

Link

• Scarica
• Guida rapida
• Documentazione
• Registro delle modifiche

Sourcetrail è:

• gratuito
• funziona offline
• operativo su Windows, macOS e Linux
• supporta C, C++, Java e Python
• offre un SDK (SourcetrailDB) per scrivere estensioni linguistiche personalizzate

Sourcetrail su Patreon

Lo sviluppo open-source e i rilasci regolari del software sono resi possibili interamente dal supporto di questi fantastici sostenitori!

Usare Sourcetrail

Per configurare Sourcetrail sulla tua macchina, puoi scaricare la build corrispondente per il tuo sistema operativo dalla nostra lista di Release e installarla, oppure utilizzare uno dei seguenti gestori di pacchetti:

• Usa il pacchetto Chocolatey con choco install sourcetrail

Dopo aver completato l'installazione, segui la nostra Guida rapida per conoscere Sourcetrail.

Come segnalare problemi

Puoi pubblicare tutte le tue richieste di funzionalità e segnalazioni di bug sul nostro tracciatore di problemi.

Segnalare

Usa il seguente modello:

• versione della piattaforma:
• versione di Sourcetrail:
• descrizione del problema:
• passi per riprodurre il problema:

Supportare

Se vuoi supportare una determinata richiesta di funzionalità o hai lo stesso bug già segnalato da un altro utente, faccelo sapere:

• pubblica un commento con "+1" al problema
• oppure invia un'email a [email protected] con l'ID del problema

Come contribuire

• Leggi e segui i passaggi nel file CONTRIBUTING.md.
• Potresti voler cercare problemi etichettati come good first issue per trovare attività iniziali su cui lavorare.
• Se cerchi maggiori informazioni sullo sviluppo software di Sourcetrail, fai riferimento al nostro wiki.

Come compilare

La compilazione di Sourcetrail richiede diverse dipendenze sulla tua macchina. Tuttavia, la nostra configurazione basata su CMake consente di disabilitare il supporto all'indicizzazione per linguaggi specifici, riducendo al minimo il numero di dipendenze.

Compilare l'applicazione base

Strumenti richiesti

• CMake v3.12 (richiesto per Windows, Linux e MacOS)

  • Motivo: Utilizzato per generare una configurazione di compilazione per il tuo sistema di build
  • Download: https://cmake.org/download

• Git (richiesto per Windows, Linux e MacOS)

  • Motivo: Utilizzato per il controllo versione e per generare automaticamente il numero di versione di Sourcetrail da commit e tag
  • Download: https://git-scm.com/download
  • Note: Assicurati che git sia aggiunto alla tua variabile d'ambiente PATH prima di eseguire CMake

• Visual Studio (richiesto per Windows)

  • Motivo: Utilizzato per compilare Sourcetrail
  • Download: https://visualstudio.microsoft.com/downloads/

• ccache (opzionale per Linux e MacOS)

  • Motivo: Utilizzato per velocizzare le ricompilazioni se trovato in PATH
  • Download: https://ccache.dev/download.html

Dipendenze richieste

• Boost 1.67

  • Motivo: Utilizzato per l'accesso al filesystem e la comunicazione interprocesso
  • Download precompilato per Windows: https://sourceforge.net/projects/boost/files/boost-binaries/
  • Compilazione per 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

  • Motivo: Utilizzato per il rendering dell'interfaccia grafica e per avviare processi aggiuntivi (indicizzatori).
  • Download precompilato: http://download.qt.io/official_releases/qt/

Compilazione

Su Windows

• Per configurare il tuo ambiente di compilazione esegui:

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

  Suggerimento: Se usi l'interfaccia grafica di CMake, ti consigliamo di attivare la modalità avanzata. Potrebbe anche essere necessario aggiungere alcune delle definizioni tramite il pulsante "Add Entry".

• Dopo aver generato la configurazione di compilazione, apri il file Sourcetrail.sln generato da CMake e compila il progetto Sourcetrail.

Su Unix

• Per configurare il tuo ambiente di compilazione esegui:
  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> ../..
  

• Ora avvia la compilazione con:
  root@kitploit:~

  $ make Sourcetrail
  

Esecuzione

• Esegui Sourcetrail dalla directory di compilazione. Durante l'esecuzione, Sourcetrail necessita delle risorse da bin/app/data e bin/app/user. CMake crea collegamenti simbolici nella directory di compilazione che rendono accessibili queste directory.

Abilitare il supporto per C/C++

Dipendenze richieste

• LLVM/Clang 11.0.0
  • Motivo: Utilizzato per eseguire il preprocessore sul codice sorgente indicizzato, costruire e attraversare un Albero Sintattico Astratto e generare messaggi di errore.
  • Compilazione: Assicurati di fare il checkout del tag corretto: git checkout llvmorg-11.0.0
  • Compilazione per Windows: Segui questi passi per compilare il progetto. Esegui il comando cmake esattamente come descritto.
  • Compilazione per Unix: Segui questa guida all'installazione per compilare il progetto. Assicurati di compilare con -DLLVM_ENABLE_RTTI=ON.

Compilazione

• Esegui CMake con queste opzioni aggiuntive:
  root@kitploit:~

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

• Compila Sourcetrail come descritto sopra.

Abilitare il supporto per Java

Dipendenze richieste

• JDK 1.8

  • Motivo: Utilizzato per compilare l'indicizzatore Java e renderlo richiamabile dal codice C++ tramite JNI.
  • Note: Assicurati che <jdk_root>/bin sia disponibile nella tua variabile d'ambiente PATH e che la variabile d'ambiente JAVA_HOME sia impostata:
    root@kitploit:~

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

• Maven

  • Motivo: Utilizzato nei test automatici di Sourcetrail.
  • Note: Assicurati che .../apache-maven-x.x.x/bin sia disponibile nella tua variabile d'ambiente PATH e che entrambe le variabili d'ambiente M2_HOME e MAVEN_HOME siano impostate:
    root@kitploit:~

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

Compilazione

• Esegui CMake con queste opzioni aggiuntive:
  root@kitploit:~

  -DBUILD_JAVA_LANGUAGE_PACKAGE=ON
  

• Compila Sourcetrail come descritto sopra.

Abilitare il supporto per Python

Strumenti richiesti

• 7z (richiesto per Windows)
  • Motivo: Utilizzato per estrarre l'indicizzatore Python precompilato (SourcetrailPythonIndexer) che viene scaricato automaticamente durante la compilazione.

Compilazione

• Esegui CMake con queste opzioni aggiuntive:
  root@kitploit:~

  -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON
  

• Compila Sourcetrail come descritto sopra.

Creare il pacchetto di distribuzione

Windows

Strumenti richiesti

• Visual Studio (richiesto per Windows)

  • Motivo: Utilizzato per compilare l'installer di Sourcetrail per Windows.
  • Note: Assicurati di installare il carico di lavoro .Net desktop development.
  • Download: https://visualstudio.microsoft.com/downloads/

• Wix 3.11

  • Motivo: Utilizzato per compilare l'installer Windows sourcetrail.msi.
  • Note: Assicurati di aggiungere <path/to>/WiX Toolset v3.11/bin alla tua variabile d'ambiente PATH.
  • Download: https://wixtoolset.org/releases/

• Estensione Wix per Visual Studio

  • Motivo: Utilizzato per eseguire Wix dall'ambiente di compilazione di Visual Studio.
  • Download: https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2017Extension

• JRE

  • Motivo: Utilizzato per indicizzare il progetto di esempio Java che viene fornito con il pacchetto.

• WinRAR

  • Motivo: Utilizzato per creare i file zip finali per l'installer e il pacchetto portatile.
  • Note: Assicurati di aggiungere <path/to>/WinRAR alla tua variabile d'ambiente .

Compilazione

• Esegui ./script/deploy_windows.sh dal Prompt dei comandi per sviluppatori di Visual Studio. Lo script genererà una build a 64 bit e la impacchetterà in un file .zip portatile e in un installer Windows basato su Wix, ciascuno.

macOS

Dopo la compilazione, esegui lo script bundle_install.sh all'interno della directory di compilazione, che creerà un bundle Sourcetrail.app e genererà un contenitore Sourcetrail_<version>.dmg.

Linux

Esegui ./setup/Linux/createPackages.sh dalla directory principale, che crea sia un pacchetto .tar.gz che un pacchetto .AppImage nella directory principale. Il packaging dipende da linuxdeployqt.

Come eseguire i test

La suite di test automatici di Sourcetrail è basata su Catch2. Per eseguire i test, esegui semplicemente il binario Sourcetrail_test. Prima di eseguire, assicurati di impostare la directory di lavoro su ./bin/test.

Licenza

Sourcetrail è concesso in licenza sotto la GNU General Public License Versione 3.

Marchio

Il nome "Sourcetrail" è un marchio di proprietà di Coati Software e non è incluso tra le risorse concesse in licenza sotto la GNU GPLv3.