Sourcetrail

Важное примечание: Этот проект был заархивирован оригинальными авторами и разработчиками Sourcetrail к концу 2021 года. Если вы хотите узнать больше об этом решении, читайте в нашем блоге.

Sourcetrail — это бесплатный кросс-платформенный навигатор по исходному коду с открытым исходным кодом, который помогает быстро освоиться в незнакомом коде.

Windows:

Linux:

Ссылки

• Загрузка
• Руководство по быстрому запуску
• Документация
• Список изменений

Sourcetrail:

• бесплатный
• работает офлайн
• работает на Windows, macOS и Linux
• поддерживает C, C++, Java и Python
• предоставляет SDK (SourcetrailDB) для написания пользовательских языковых расширений

Sourcetrail на Patreon

Разработка с открытым исходным кодом и регулярные релизы программного обеспечения стали возможны исключительно благодаря поддержке этих замечательных патронов!

Использование Sourcetrail

Чтобы установить Sourcetrail на вашу машину, вы можете либо загрузить сборку для вашей операционной системы из нашего списка релизов и установить её, либо воспользоваться одним из следующих менеджеров пакетов:

• Используйте пакет Chocolatey с командой choco install sourcetrail

После завершения установки следуйте нашему Руководству по быстрому запуску, чтобы познакомиться с Sourcetrail.

Как сообщать о проблемах

Вы можете публиковать все свои запросы функций и сообщения об ошибках в нашем трекере.

Сообщение

Используйте следующий шаблон:

• версия платформы:
• версия Sourcetrail:
• описание проблемы:
• шаги для воспроизведения проблемы:

Поддержка

Если вы хотите поддержать какой-либо запрос функции или у вас та же ошибка, которую уже сообщил другой пользователь, пожалуйста, дайте нам знать:

• оставьте комментарий с "+1" к задаче
• или отправьте электронное письмо на [email protected] с ID задачи

Как внести вклад

• Пожалуйста, прочитайте и выполните шаги, описанные в файле CONTRIBUTING.md.
• Возможно, вам стоит обратить внимание на задачи с меткой good first issue, чтобы найти начальные задачи.
• Если вы ищете дополнительную информацию о разработке Sourcetrail, обратитесь к нашей вики.

Как собрать

Сборка Sourcetrail требует наличия нескольких зависимостей на вашей машине. Однако наша конфигурация на основе CMake позволяет отключать поддержку индексации для конкретных языков, что сводит количество зависимостей к минимуму.

Сборка базового приложения

Необходимые инструменты

• CMake v3.12 (требуется для Windows, Linux и macOS)

  • Причина: Используется для генерации конфигурации сборки для вашей системы сборки
  • Загрузка: https://cmake.org/download

• Git (требуется для Windows, Linux и macOS)

  • Причина: Используется для контроля версий и автоматической генерации номера версии Sourcetrail из коммитов и тегов
  • Загрузка: https://git-scm.com/download
  • Замечания: Убедитесь, что git добавлен в переменную окружения PATH перед запуском CMake

• 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

  • Причина: Используется для отрисовки графического интерфейса и запуска дополнительных (индексаторных) процессов.
  • Готовая сборка: 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=<путь/к/boost_1_67_0> -DQt5_DIR=<путь/к/Qt/version/platform/compiler/lib/cmake/Qt5> ../..
  

  Подсказка: Если вы используете GUI CMake, рекомендуем включить расширенный режим. Также вам может понадобиться добавить некоторые определения через кнопку "Add Entry".

• После генерации конфигурации сборки просто откройте файл Sourcetrail.sln, созданный CMake, и соберите проект Sourcetrail.

На Unix

• Чтобы настроить среду сборки, выполните:
  root@kitploit:~

  $ cd Sourcetrail
  $ mkdir -p build/Release
  $ cd build/Release
  $ cmake -DCMAKE_BUILD_TYPE="Release" -DBOOST_ROOT=<путь/к/boost_1_67_0> -DQt5_DIR=<путь/к/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=<путь/к/llvm_build>/lib/cmake/clang
  -DBUILD_CXX_LANGUAGE_PACKAGE=ON
  

• Соберите Sourcetrail, как описано выше.

Включение поддержки языка Java

Необходимые зависимости

• JDK 1.8

  • Причина: Используется для сборки Java-индексатора и обеспечения его вызова из кода C++ через JNI.
  • Замечания: Убедитесь, что <jdk_root>/bin доступен в переменной окружения PATH и что переменная окружения JAVA_HOME установлена:
    root@kitploit:~

    JAVA_HOME=<путь/к/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

  • Причина: Используется для сборки установщика Windows sourcetrail.msi.
  • Замечания: Убедитесь, что <путь/к>/WiX Toolset v3.11/bin добавлен в переменную окружения PATH.
  • Загрузка: https://wixtoolset.org/releases/

• Расширение Wix для Visual Studio

  • Причина: Используется для запуска Wix из среды сборки Visual Studio.
  • Загрузка: https://marketplace.visualstudio.com/items?itemName=WixToolset.WixToolsetVisualStudio2017Extension

• JRE

  • Причина: Используется для индексации примера Java-проекта, который поставляется с пакетом.

• WinRAR

  • Причина: Используется для создания окончательных zip-файлов для установщика и портативного пакета.
  • Замечания: Убедитесь, что <путь/к>/WinRAR добавлен в переменную окружения .

Сборка

• Запустите ./script/deploy_windows.sh из командной строки разработчика для Visual Studio. Скрипт сгенерирует 64-битную сборку и упакует её в портативный .zip файл и в установщик Windows на основе Wix.

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.