cleanCppProject

CleanCppProject

هذا هو إطار فارغ للمشروع في C ++. يجب أن تساعد في بدء مشروع جديد دون الاهتمام بالكثير حول إعداد بيئة المشروع/البناء.

سمات

• البرامج النصية الحديثة والبسيطة البسيطة ، مقسمة إلى عدة مكونات لقابلية القراءة.
• أهداف عاقلة وبسيطة لكل شيء (انظر قسم الأهداف ).
• البرنامج النصي CPACK الذي يمكن أن ينتج DEB و RPM و Windows Installer و Bundle App و DMG والحزم المضغوطة المختلفة.
• الاختبارات عبر CTEST.
• اختبارات الوحدة عبر الصيد.
• توليد الوثائق عبر Doxygen (الرمز + Wiki + UML المخططات مع GraphViz و Planuml).
• دعم التحليل الثابت (Clang Tidy ، CppCheck).
• مساعدون التحليل الديناميكي عن طريق المطهرات (انظر Cmake/Slitizers.cmake).
• يعمل مع Linux Distro و Windows و MacOS المفضل لديك.
• أمثلة تكوين Gitlab CI و Travis CI.
• دعم رابط الذهب لوقت ربط أسرع.
• المساعدون لإضافة التبعيات الخارجية التي تم تنزيلها أثناء التكوين أو الإنشاء.
  • انظر external/CMakeLists.txt و cmake/cleanCppExtension.cmake

صفحات مهمة

• وثيقة التصميم
• قائمة Todos (doxygen فقط)
• هيكل الدليل الأساسي
• كيف تبدأ العمل

تودو انظر كيف يعمل تودو

كيفية تحويل هذا إلى مشروعك الجديد

 git clone https://github.com/kracejic/cleanCppProject.git yourNewProject
cd yourNewProject
mv .git .git-cleanCppProject
git init
git add .
git commit -m "first commit"

المزيد في كيفية البدء في العمل.

كيفية الحفاظ على الرابط معنا

نحن نحسن هذا الريبو بشكل منتظم ، إذا كنت ترغب في الحصول على المزيد منا ، فحاول سحب الريبو الرئيسي.

 cd yourNewProject/ 
git pull --git-dir='.git-cleanCppProject'

تعليمات البناء

المتطلبات الأساسية

• Cmake 3.2 وأحدث
• المترجم بدعم من C ++ 14
• GIT - لتنزيل الموارد الخارجية
• Doxygen لمستندات ( GraphViz لمزيد من الرسوم البيانية في المستندات ، Plantuml لمزيد من المخططات UML ، احتياجات Plantuml Java)
• أدوات clang للتحليل الثابت والتنسيق
• cppcheck لتحليل ثابت آخر

المتطلبات الأساسية على Linux

• Arch Linux: sudo pacman -S cmake g++ graphviz git clang clang-tools-extra cppcheck java-runtime-common cppcheck

  • قم بتنزيل plantuml.jar وجعله في مكان ما يشير فيه المسار إلى

• Ubuntu 16.04: sudo apt-get install cmake g++ graphviz plantuml git clang clang-tidy clang-format cppcheck

المتطلبات الأساسية على Windows

طريقتين ، تم اختبارهما:

• MSYS2 على أساس

  • الحد الأدنى: pacman -S cmake g++ git
  • برنامج إضافي pacman -S clang mingw-w64-x86_64-clang-tools-extra mingw-w64-x86_64-clang-analyzer doxygen
  • بالنسبة للرسوم البيانية في الوثائق ، قم بتثبيت GraphViz (إلى c:Program FilesGraphviz ، بحيث يمكن أن تجدها البرامج النصية) وإضافة دليل bin الفرعي إلى PATH ، وتثبيت Java (اجعل دليل BIN على PATH ) ، تنزيل ملف جرة Plantuml والحصول عليه على المسار .

• Microsoft Visual Studio

  • تثبيت Cmake
  • تثبيت git
  • للحصول على ميزات إضافية ، قم بتثبيت clang مع الأدوات ، doxygen ، graphviz ، plantuml ، java وأضفها إلى المسار ( لم يتم اختبارها )

المتطلبات الأساسية على ماكوس

• Macos Sierra brew install llvm doxygen cppcheck graphviz

بناء على Linux و MacOS

Makefiles القياسية:

 mkdir build ; cd build
cmake ..
make -j8

Ninja Build Witch Clang ، قم ببناء All+Doc وتثبيته على مجلد Dist:

 mkdir build ; cd build
cmake -GNinja -DCMAKE_CXX_COMPILER="clang++" ..
ninja all doc install

بناء الإصدار الذي سيقوم بتثبيت نفسه في /usr بعد أن sudo make install

 mkdir build ; cd build
cmake .. -DCMAKE_INSTALL_PREFIX="/usr" -DCMAKE_BUILD_TYPE="Release"
make -j8 all
sudo make install

بناء على النوافذ

بناء على Windows باستخدام MSYS2 + Ninja

على Windows ، يجب أن تفضل Ninja لأنه أسرع بكثير من صنعه (ولكن ليس له لون في Shell).

مع GCC:

 mkdir build ; cd build
cmake -GNinja ..
ninja install

يمكنك استخدام cmake -G "MSYS Makefiles" .. إذا كنت تريد استخدام Make.

بناء على Windows باستخدام Microsoft Visual Studio 14

أولاً ، يمكنك تغيير اسم المشروع في CMakeLists.txt الرئيسية. ما عليك سوى الانتقال إلى المجلد مع المشروع وإنشاء دليل جديد وإنشاء ملفات مشروع مع هذا:

 mkdir buildmsvc
cd buildmsvc
cmake -G "Visual Studio 14 2015" ..

ويمكنك الآن فتح ملف .sln مع Visual Studio. تحتاج إلى النقر بزر الماوس الأيمن على الهدف القابل للتنفيذ وتعيين مشروع بدء التشغيل . لمشاهدة نافذة وحدة التحكم التي تريد البدء فيها دون تصحيح الأخطاء ، لأنه عند التشغيل في وضع التصحيح فقط ، يتم إغلاق أرملة وحدة التحكم بسرعة كبيرة.

الأهداف

ملاحظة: يعتمد توافر بعض الأهداف على توافر بعض الأهداف التنفيذية (مثل Clang-Format لهدف التنسيق )

• يبني
  • الكل (الافتراضي إذا لم يتم توفير هدف)
  • ينظف
  • تثبيت - تثبيت الثنائيات في cmake_install_prefix
  • exampleapp - Build ExamplePap Binary
  • Run -Run - بناء وتثبيت وتشغيل exampleapp ثنائي (لراحتك)
  • exampleapp -gdb - بناء وتثبيت وتشغيل examplepp ثنائي في GDB (لراحتك)
  • Run - الاسم المستعار ل expleapp -run (من أجل الحفاظ عليها قصيرة)
• الاختبار
  • تحقق - قم بتشغيل مجموعة اختبار كاملة (انظر الاختبار/cmakelists.txt)
  • CheckverBose - قم بتشغيل مجموعة اختبار كاملة (انظر الاختبار/cmakelists.txt) ، ولكن أكثر مطوّلة
  • وحدة - بناء وتشغيل اختبارات الوحدة فقط (انظر الاختبار/cmakelists.txt)
  • unitall - مثل السابق ، يطبع فقط حتى نتائج اختبارات الوحدة الناجحة
• الإصدارات
  • الحزمة - يبني الحزم (ZIP ، DEB ، RPM ، Windows Installer اعتمادًا على نظام التشغيل)
• متنوع
  • Doc - Build Documentation (إذا كان Doxygen متاحًا)
    • يمكن العثور على مستندات في build_dir/doc/doc/index.html
    • إذا كنت تريد أن يكونوا جزءًا من حزمة التثبيت ، فإن قسم Uncomment في نهاية doc/CMakeLists.txt
  • التنسيق -قم بتشغيل clang-format على جميع ملفات المصدر (.clang-format في دليل الجذر للمشروع)
  • GDB - Run Target قابل للتنفيذ باستخدام GDB (لا يعمل من Ninja ، يحتاج GDB)
• تحليل ثابت
  • مرتبة - قم بتشغيل تحليل ثابت على جميع المصادر
  • CPPCHECK - اتصل بـ CPPCHECK على جميع الملفات (تحليل ثابت آخر)
• خارجي
  • تحديث - تحديث جميع المصادر/المشاريع الخارجية

متغيرات cmake

• -DCMAKE_INSTALL_PREFIX - موقع التثبيت
• -DVERSION_HOST - بناء اسم الجهاز ، انظر الإصدار.
• -DCMAKE_BUILD_TYPE - لنوع البناء
• -DMEASURE_ALL=ON/OFF - وقت قياس جميع المجموعات ، وأفضل استخدام مع بناء واحد الخيوط. يحتاج الأمر time (UNIX).
• -DUSE_GOLD_LINKER=ON/OFF - سواء كنت ترتبط مع رابط الذهب.

رخصة

حقوق الطبع والنشر (C) 2019 Kracejic

يتم منح الإذن بموجب هذا ، مجانًا ، لأي شخص يحصل على نسخة من هذا البرنامج وملفات الوثائق المرتبطة به ("البرنامج") ، للتعامل في البرنامج دون تقييد ، بما في ذلك على سبيل المثال لا الحصر حقوق استخدام الأشخاص ونسخها ودمجها ودمجها وتوزيعها وتوزيعها على ما يلي:

يجب إدراج إشعار حقوق الطبع والنشر أعلاه وإشعار الإذن هذا في جميع النسخ أو الأجزاء الكبيرة من البرنامج.

يتم توفير البرنامج "كما هو" ، دون أي ضمان من أي نوع ، صريح أو ضمني ، بما في ذلك على سبيل المثال لا الحصر ضمانات القابلية للتسويق واللياقة لغرض معين وعدم الانفجار. لا يجوز بأي حال من الأحوال أن يكون المؤلفون أو حاملي حقوق الطبع والنشر مسؤولاً عن أي مطالبة أو أضرار أو مسؤولية أخرى ، سواء في إجراء عقد أو ضرر أو غير ذلك ، ناشئة عن أو خارج البرنامج أو الاستخدام أو غيرها من المعاملات في البرنامج.