Sourcetrail

Nota Importante: Este projeto foi arquivado pelos autores e mantenedores originais do Sourcetrail no final de 2021. Se quiser saber mais sobre esta decisão, leia mais no nosso blog.

Sourcetrail é um explorador de código-fonte gratuito e de código aberto, multiplataforma, que ajuda você a ser produtivo em código-fonte desconhecido.

Windows:

Linux:

Links

• Download
• Guia de Início Rápido
• Documentação
• Registro de Alterações

Sourcetrail é:

• gratuito
• funciona offline
• opera no Windows, macOS e Linux
• suporta C, C++, Java e Python
• oferece um SDK (SourcetrailDB) para escrever extensões de linguagem personalizadas

Sourcetrail no Patreon

O desenvolvimento de código aberto e os lançamentos regulares de software são possíveis inteiramente pelo apoio destes incríveis patrocinadores!

Usando o Sourcetrail

Para configurar o Sourcetrail na sua máquina, você pode baixar a versão correspondente para o seu sistema operacional da nossa lista de Releases e instalá-la na sua máquina, ou usar um dos seguintes gerenciadores de pacotes:

• Use o pacote Chocolatey com choco install sourcetrail

Após a instalação estar completa, siga nosso Guia de Início Rápido para conhecer o Sourcetrail.

Como Relatar Problemas

Você pode postar todas as suas solicitações de recursos e relatórios de bugs no nosso rastreador de problemas.

Relatando

Use o seguinte modelo:

• versão da plataforma:
• versão do Sourcetrail:
• descrição do problema:
• passos para reproduzir o problema:

Apoiando

Se você quiser apoiar uma determinada solicitação de recurso ou tiver o mesmo bug que outro usuário já relatou, informe-nos:

• poste um comentário com "+1" no problema
• ou envie um e-mail para [email protected] com o ID do problema

Como Contribuir

• Por favor, leia e siga os passos no arquivo CONTRIBUTING.md.
• Você pode querer procurar por problemas marcados como good first issue para encontrar algumas tarefas iniciais para enfrentar.
• Se você está procurando mais informações sobre o desenvolvimento de software do Sourcetrail, consulte nossa wiki.

Como Compilar

Compilar o Sourcetrail requer que várias dependências estejam presentes na sua máquina. No entanto, nossa configuração baseada em CMake permite desabilitar o suporte a indexação para linguagens específicas, o que reduz o número de dependências ao mínimo.

Compilando a Aplicação Base

Ferramentas Necessárias

• CMake v3.12 (necessário para Windows, Linux e MacOS)

  • Motivo: Usado para gerar uma configuração de compilação para seu sistema de compilação
  • Download: https://cmake.org/download

• Git (necessário para Windows, Linux e MacOS)

  • Motivo: Usado para controle de versão e para gerar automaticamente o número de versão do Sourcetrail a partir de commits e tags
  • Download: https://git-scm.com/download
  • Observações: Certifique-se de que git está adicionado à sua variável de ambiente PATH antes de executar o CMake

• Visual Studio (necessário para Windows)

  • Motivo: Usado para compilar o Sourcetrail
  • Download: https://visualstudio.microsoft.com/downloads/

• ccache (opcional para Linux e MacOS)

  • Motivo: Usado para acelerar recompilações se encontrado em PATH
  • Download: https://ccache.dev/download.html

Dependências Necessárias

• Boost 1.67

  • Motivo: Usado para acesso ao sistema de arquivos e comunicação entre processos
  • Download pré-compilado para Windows: https://sourceforge.net/projects/boost/files/boost-binaries/
  • Compilação para 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: Usado para renderizar a interface gráfica e para iniciar processos adicionais (indexadores).
  • Download pré-compilado: http://download.qt.io/official_releases/qt/

Compilando

No Windows

• Para configurar seu ambiente de compilação, execute:

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

  Dica: Se você estiver usando a GUI do CMake, recomendamos ativar o modo avançado. Além disso, pode ser necessário adicionar algumas das definições através do botão "Add Entry".

• Após gerar a configuração de compilação, basta abrir o arquivo Sourcetrail.sln que foi gerado pelo CMake e compilar o projeto Sourcetrail.

No Unix

• Para configurar seu ambiente de compilação, execute:
  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> ../..
  

• Agora inicie a compilação com:
  root@kitploit:~

  $ make Sourcetrail
  

Executando

• Execute o Sourcetrail a partir do diretório de compilação. Durante a execução, o Sourcetrail precisa de recursos de bin/app/data e bin/app/user. O CMake cria links simbólicos dentro do diretório de compilação que tornam esses diretórios acessíveis.

Habilitar Suporte para Linguagem C/C++

Dependências Necessárias

• LLVM/Clang 11.0.0
  • Motivo: Usado para executar o pré-processador no código-fonte indexado, construir e percorrer uma Árvore Sintática Abstrata e gerar mensagens de erro.
  • Compilação: Certifique-se de verificar a tag correta: git checkout llvmorg-11.0.0
  • Compilação para Windows: Siga estes passos para compilar o projeto. Execute o comando cmake exatamente como descrito.
  • Compilação para Unix: Siga este guia de instalação para compilar o projeto. Certifique-se de compilar com -DLLVM_ENABLE_RTTI=ON.

Compilando

• Execute o CMake com estas opções adicionais:
  root@kitploit:~

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

• Compile o Sourcetrail conforme descrito acima.

Habilitar Suporte para Linguagem Java

Dependências Necessárias

• JDK 1.8

  • Motivo: Usado para compilar o indexador Java e torná-lo chamável a partir do código C++ via JNI.
  • Observações: Certifique-se de que <jdk_root>/bin está disponível na sua variável de ambiente PATH e que a variável de ambiente JAVA_HOME está definida:
    root@kitploit:~

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

• Maven

  • MOTIVO: Usado nos testes automatizados do Sourcetrail.
  • Observações: Certifique-se de que .../apache-maven-x.x.x/bin está disponível na sua variável de ambiente PATH e que ambas as variáveis de ambiente M2_HOME e MAVEN_HOME estão definidas:
    root@kitploit:~

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

Compilando

• Execute o CMake com estas opções adicionais:
  root@kitploit:~

  -DBUILD_JAVA_LANGUAGE_PACKAGE=ON
  

• Compile o Sourcetrail conforme descrito acima.

Habilitar Suporte para Linguagem Python

Ferramentas Necessárias

• 7z (necessário para Windows)
  • MOTIVO: Usado para extrair o SourcetrailPythonIndexer pré-compilado que é baixado automaticamente durante a execução da compilação.

Compilando

• Execute o CMake com estas opções adicionais:
  root@kitploit:~

  -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON
  

• Compile o Sourcetrail conforme descrito acima.

Criando o Pacote de Implantação

Windows

Ferramentas Necessárias

• Visual Studio (necessário para Windows)

  • Motivo: Usado para compilar o instalador Windows do Sourcetrail.
  • Observações: Certifique-se de instalar a carga de trabalho .Net desktop development.
  • Download: https://visualstudio.microsoft.com/downloads/

• Wix 3.11

  • Motivo: Usado para compilar o instalador Windows sourcetrail.msi.
  • Observações: Certifique-se de adicionar <path/to>/WiX Toolset v3.11/bin à sua variável de ambiente PATH.
  • Download: https://wixtoolset.org/releases/

• Extensão Wix para Visual Studio

  • Motivo: Usado para executar o Wix a partir do ambiente de compilação do Visual Studio.
  • Download: https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2017Extension

• JRE

  • Motivo: Usado para indexar o projeto de exemplo Java que acompanha o pacote.

• WinRAR

  • Motivo: Usado para criar os arquivos zip finais para o instalador e o pacote portátil.
  • Observações: Certifique-se de adicionar <path/to>/WinRAR à sua variável de ambiente .

Compilando

• Execute ./script/deploy_windows.sh a partir do seu Prompt de Comando do Desenvolvedor para Visual Studio. O script irá gerar uma compilação de 64 bits e empacotá-la em um arquivo .zip portátil e em um instalador Windows baseado em Wix, cada um.

macOS

Após a compilação, execute o script bundle_install.sh dentro do diretório de compilação, que criará um pacote Sourcetrail.app e gerará um contêiner Sourcetrail_<version>.dmg.

Linux

Execute ./setup/Linux/createPackages.sh a partir do diretório principal, que cria tanto um pacote .tar.gz quanto um .AppImage no diretório principal. O empacotamento depende do linuxdeployqt.

Como Executar os Testes

O conjunto de testes automatizados do Sourcetrail é alimentado pelo Catch2. Para executar os testes, basta executar o binário Sourcetrail_test. Antes de executar, certifique-se de definir o diretório de trabalho para ./bin/test.

Licença

Sourcetrail é licenciado sob a GNU General Public License Versão 3.

Marca Comercial

O nome "Sourcetrail" é uma marca comercial pertencente à Coati Software e não está incluído nos ativos licenciados sob a GNU GPLv3.