Sourcetrail

ملاحظة مهمة: تم أرشفة هذا المشروع من قبل المؤلفين الأصليين والمشرفين على Sourcetrail في نهاية عام 2021. إذا كنت تريد معرفة المزيد عن هذا القرار، اقرأ المزيد على مدونتنا.

Sourcetrail هو مستكشف مصادر مفتوح المصدر ومتعدد المنصات مجاني يساعدك على الإنتاجية في شفرة المصدر غير المألوفة.

Windows:

Linux:

الروابط

• تنزيل
• دليل البدء السريع
• التوثيق
• سجل التغييرات

Sourcetrail هو:

• مجاني
• يعمل دون اتصال
• يعمل على ويندوز، ماك، ولينكس
• يدعم C و C++ وJava وPython
• يقدم SDK (SourcetrailDB) لكتابة إضافات لغوية مخصصة

Sourcetrail على Patreon

التطوير مفتوح المصدر والإصدارات المنتظمة للبرنامج أصبحت ممكنة بفضل دعم هؤلاء الرعاة الرائعين!

استخدام Sourcetrail

لإعداد Sourcetrail على جهازك، يمكنك إما تنزيل الإصدار المناسب لنظام التشغيل الخاص بك من قائمة الإصدارات وتثبيته على جهازك، أو استخدام أحد مديري الحزم التالية:

• استخدم حزمة Chocolatey مع choco install sourcetrail

بعد اكتمال التثبيت، اتبع دليل البدء السريع للتعرف على Sourcetrail.

كيفية الإبلاغ عن المشكلات

يمكنك نشر جميع طلبات الميزات وتقارير الأخطاء على متتبع المشكلات.

الإبلاغ

استخدم القالب التالي:

• إصدار المنصة:
• إصدار Sourcetrail:
• وصف المشكلة:
• خطوات إعادة إنتاج المشكلة:

الدعم

إذا كنت ترغب في دعم طلب ميزة معينة أو لديك نفس الخطأ الذي أبلغ عنه مستخدم آخر، فيرجى إخبارنا:

• انشر تعليقًا بـ "+1" على المشكلة
• أو أرسل بريدًا إلكترونيًا إلى [email protected] مع معرف المشكلة

كيفية المساهمة

• يرجى قراءة واتباع الخطوات في ملف CONTRIBUTING.md.
• قد ترغب في البحث عن المشكلات الموسومة بـ مشكلة أولى جيدة للعثور على بعض المهام الأولية للتعامل معها.
• إذا كنت تبحث عن مزيد من المعلومات حول تطوير برنامج Sourcetrail، فيرجى الرجوع إلى الويكي.

كيفية البناء

يتطلب بناء Sourcetrail وجود عدة تبعيات على جهازك. ومع ذلك، فإن الإعداد القائم على CMake يسمح بتعطيل دعم الفهرسة للغات محددة مما يقلل عدد التبعيات إلى الحد الأدنى.

بناء التطبيق الأساسي

الأدوات المطلوبة

• CMake v3.12 (مطلوب لويندوز ولينكس وماك)

  • السبب: يستخدم لتوليد تكوين بناء لنظام البناء الخاص بك
  • تنزيل: https://cmake.org/download

• Git (مطلوب لويندوز ولينكس وماك)

  • السبب: يستخدم للتحكم في الإصدارات وإنشاء رقم إصدار Sourcetrail تلقائيًا من الالتزامات والعلامات
  • تنزيل: https://git-scm.com/download
  • ملاحظات: تأكد من إضافة git إلى متغير البيئة PATH قبل تشغيل CMake

• Visual Studio (مطلوب لويندوز)

  • السبب: يستخدم لبناء Sourcetrail
  • تنزيل: https://visualstudio.microsoft.com/downloads/

• ccache (اختياري للينكس وماك)

  • السبب: يستخدم لتسريع عمليات إعادة البناء إذا تم العثور عليه في PATH
  • تنزيل: https://ccache.dev/download.html

التبعيات المطلوبة

• Boost 1.67

  • السبب: يستخدم للوصول إلى نظام الملفات والاتصال بين العمليات
  • تنزيل مُجمّع مسبقًا لويندوز: 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/

البناء

على ويندوز

• لإعداد بيئة البناء، قم بتشغيل:

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

  تلميح: إذا كنت تستخدم واجهة 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=<path/to/boost_1_67_0> -DQt5_DIR=<path/to/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
  • البناء لويندوز: اتبع هذه الخطوات لبناء المشروع. قم بتشغيل أمر cmake تمامًا كما هو موصوف.
  • البناء لأنظمة Unix: اتبع دليل التثبيت هذا لبناء المشروع. تأكد من البناء باستخدام -DLLVM_ENABLE_RTTI=ON.

البناء

• قم بتشغيل CMake مع هذه الخيارات الإضافية:
  root@kitploit:~

  -DClang_DIR=<path/to/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=<path/to/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 (مطلوب لويندوز)
  • السبب: يستخدم لاستخراج مفهرس SourcetrailPythonIndexer المُجمّع مسبقًا والذي يتم تنزيله تلقائيًا أثناء تنفيذ البناء.

البناء

• قم بتشغيل CMake مع هذه الخيارات الإضافية:
  root@kitploit:~

  -DBUILD_PYTHON_LANGUAGE_PACKAGE=ON
  

• قم ببناء Sourcetrail كما هو موضح أعلاه.

إنشاء حزمة النشر

ويندوز

الأدوات المطلوبة

• Visual Studio (مطلوب لويندوز)

  • السبب: يستخدم لبناء مثبت ويندوز لـ Sourcetrail.
  • ملاحظات: تأكد من تثبيت عبء العمل .Net desktop development.
  • تنزيل: https://visualstudio.microsoft.com/downloads/

• Wix 3.11

  • السبب: يستخدم لبناء مثبت ويندوز sourcetrail.msi.
  • ملاحظات: تأكد من إضافة <path/to>/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 النهائية للمثبت والحزمة المحمولة.
  • ملاحظات: تأكد من إضافة <path/to>/WinRAR إلى متغير البيئة PATH.

البناء

• قم بتشغيل ./script/deploy_windows.sh من موجه أوامر المطور لـ Visual Studio. سيقوم البرنامج النصي بتوليد بناء 64 بت وتعبئته في ملف .zip محمول ومثبت ويندوز قائم على Wix، كل على حدة.

ماك

بعد البناء، قم بتشغيل البرنامج النصي bundle_install.sh داخل دليل البناء الذي سينشئ حزمة Sourcetrail.app ويولد حاوية Sourcetrail_<version>.dmg.

لينكس

قم بتشغيل ./setup/Linux/createPackages.sh من الدليل الرئيسي، والذي ينشئ كلًا من حزمة .tar.gz و .AppImage في الدليل الرئيسي. تعتمد التعبئة على linuxdeployqt.

كيفية تشغيل الاختبارات

يتم تشغيل مجموعة الاختبارات الآلية لـ Sourcetrail بواسطة Catch2. لتشغيل الاختبارات، قم ببساطة بتنفيذ الملف الثنائي Sourcetrail_test. قبل التنفيذ، يرجى التأكد من تعيين دليل العمل إلى ./bin/test.

الترخيص

Sourcetrail مرخص بموجب رخصة GNU العامة العامة الإصدار 3.

العلامة التجارية

اسم "Sourcetrail" هو علامة تجارية مملوكة لـ Coati Software وهو غير مشمول ضمن الأصول المرخصة بموجب GNU GPLv3.