cleanCppProject

CleanCppProject

นี่คือเฟรมที่ว่างเปล่าสำหรับโครงการใน C ++ ควรช่วยเริ่มโครงการใหม่โดยไม่ต้องดูแลการตั้งค่าโครงการ/สร้างสภาพแวดล้อมมากนัก

คุณสมบัติ

• CMAKE สร้างสคริปต์ที่ทันสมัยและเรียบง่ายแบ่งออกเป็นหลายองค์ประกอบเพื่อการอ่าน
• เป้าหมายที่มีสติและเรียบง่ายสำหรับทุกสิ่ง (ดูส่วน เป้าหมาย )
• สคริปต์ CPACK ซึ่งสามารถสร้าง DEB , RPM , Windows Installer , แอพ Bundle , DMG และแพ็คเกจบีบอัดต่างๆ
• การทดสอบผ่าน CTEST
• การทดสอบหน่วยผ่านการจับ
• การสร้างเอกสารผ่าน Doxygen (รหัส + ไดอะแกรม Wiki + UML พร้อม graphviz และ planuml)
• การสนับสนุนการวิเคราะห์แบบคงที่ (Clang-Tidy, CPPCHECK)
• ผู้ช่วยการวิเคราะห์แบบไดนามิกผ่าน sanitizers (ดู cmake/sanitizers.cmake)
• ทำงานร่วมกับ Linux Distro, Windows และ MacOS ที่คุณชื่นชอบ
• ตัวอย่างการกำหนดค่า Gitlab CI และ Travis CI
• รองรับ Gold Linker สำหรับเวลาการเชื่อมโยงที่เร็วขึ้น
• ผู้ช่วยสำหรับการเพิ่มการพึ่งพาภายนอกที่ดาวน์โหลดระหว่างการกำหนดค่าหรือการสร้าง
  • ดู external/CMakeLists.txt และ cmake/cleanCppExtension.cmake

หน้าสำคัญ

• เอกสารออกแบบ
• รายชื่อ TODOS (Doxygen เท่านั้น)
• โครงสร้างไดเรกทอรีพื้นฐาน
• วิธีเริ่มทำงาน

todo ดูวิธีการทำงานของ Todo

วิธีการแปลงสิ่งนี้เป็นโครงการใหม่ของคุณ

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

เพิ่มเติมในการเริ่มทำงาน

วิธีเก็บลิงค์ไว้กับเรา

เรากำลังปรับปรุง repo นี้เป็นประจำหากคุณต้องการได้รับมากขึ้นจากเราลองดึง repo หลัก

 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 และมีที่ไหนสักแห่งที่ Path ชี้ไปที่

• 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 ลงใน เส้นทาง ติดตั้ง Java (มีไดเรกทอรีถังบน เส้นทาง ) ดาวน์โหลดไฟล์ Plantuml Jar และมีบน เส้นทาง

• Microsoft Visual Studio

  • ติดตั้ง cmake
  • ติดตั้ง Git
  • สำหรับคุณสมบัติเพิ่มเติมติดตั้งระบบคลากรัมด้วยเครื่องมือ Doxygen, GraphViz, Plantuml, Java และเพิ่มลงในเส้นทาง ( ไม่ได้ทดสอบ )

ข้อกำหนดเบื้องต้นบน macOS

• MacOS Sierra brew install llvm doxygen cppcheck graphviz

สร้างบน Linux & MacOS

makefiles มาตรฐาน:

 mkdir build ; cd build
cmake ..
make -j8

นินจาสร้างแม่มดคลางสร้าง+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

สร้างบน Windows โดยใช้ MSYS2 + NINJA

บน Windows คุณควรชอบนินจาเนื่องจากเร็วกว่าทำมาก (แต่ไม่มีสีในเปลือก)

กับ 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 ExampleApp Binary
  • ExampleApp -Run - สร้างติดตั้งและเรียกใช้ ExampleApp Binary (เพื่อความสะดวกของคุณ)
  • ExampleApp -GDB - สร้างติดตั้งและเรียกใช้ ExampleApp Binary ใน GDB (เพื่อความสะดวกของคุณ)
  • Run - นามแฝงสำหรับ ExampleApp -Run (เพื่อให้มันสั้น)
• การทดสอบ
  • ตรวจสอบ - เรียกใช้ชุดทดสอบทั้งหมด (ดูการทดสอบ/cmakelists.txt)
  • CheckverBose - เรียกใช้ชุดทดสอบทั้งหมด (ดูการทดสอบ/cmakelists.txt) แต่ verbose มากขึ้น
  • หน่วย - สร้างและเรียกใช้การทดสอบหน่วยเท่านั้น (ดูการทดสอบ/cmakelists.txt)
  • UnitAll - เหมือนกับก่อนหน้านี้พิมพ์เฉพาะการทดสอบหน่วยที่ประสบความสำเร็จ
• ปล่อย
  • แพ็คเกจ - Builds Packages (Zip, Deb, RPM, Windows Installer ขึ้นอยู่กับ OS)
• เบ็ดเตล็ด
  • เอกสาร - สร้างเอกสาร (ถ้ามี doxygen)
    • เอกสารสามารถพบได้ใน build_dir/doc/doc/index.html
    • หากคุณต้องการให้พวกเขาเป็นส่วนหนึ่งของแพ็คเกจการติดตั้งส่วนที่ไม่สม่ำเสมอในตอนท้ายของ doc/CMakeLists.txt
  • รูปแบบ -เรียกใช้รูปแบบ clang บนไฟล์ต้นฉบับทั้งหมด (. clang-format ในไดเรกทอรีรากของโครงการใช้)
  • GDB - เรียกใช้การปฏิบัติการเป้าหมายด้วย GDB (ไม่ทำงานจากนินจาต้องการ GDB)
• การวิเคราะห์แบบคงที่
  • เป็นระเบียบ - เรียกใช้การวิเคราะห์แบบคงที่ในทุกแหล่ง
  • CPPCHECK - โทร CPPCHECK ในไฟล์ทั้งหมด (การวิเคราะห์แบบคงอื่น)
• ภายนอก
  • อัปเดต - อัปเดตแหล่ง/โครงการภายนอกทั้งหมด

ตัวแปร cmake

• -DCMAKE_INSTALL_PREFIX - ตำแหน่งสำหรับการติดตั้ง
• -DVERSION_HOST - สร้างชื่อเครื่องดูเวอร์ชัน. h.in
• -DCMAKE_BUILD_TYPE - สำหรับประเภทการสร้าง
• -DMEASURE_ALL=ON/OFF - วัดเวลาของการรวบรวมทั้งหมดใช้งานได้ดีที่สุดกับบิลด์เกลียวเดี่ยว ต้องการคำสั่ง time (UNIX)
• -DUSE_GOLD_LINKER=ON/OFF - ไม่ว่าจะเชื่อมโยงกับ Gold Linker

ใบอนุญาต

ลิขสิทธิ์ (c) 2019 Kracejic

ได้รับอนุญาตโดยไม่ต้องเสียค่าใช้จ่ายสำหรับบุคคลใด ๆ ที่ได้รับสำเนาซอฟต์แวร์นี้และไฟล์เอกสารที่เกี่ยวข้อง ("ซอฟต์แวร์") เพื่อจัดการในซอฟต์แวร์โดยไม่มีการ จำกัด รวมถึง แต่ไม่ จำกัด เฉพาะสิทธิ์ในการใช้สำเนาดัดแปลงผสานเผยแพร่เผยแพร่

ประกาศลิขสิทธิ์ข้างต้นและประกาศการอนุญาตนี้จะรวมอยู่ในสำเนาทั้งหมดหรือส่วนสำคัญของซอฟต์แวร์

ซอฟต์แวร์มีให้ "ตามสภาพ" โดยไม่มีการรับประกันใด ๆ ไม่ว่าโดยชัดแจ้งหรือโดยนัยรวมถึง แต่ไม่ จำกัด เฉพาะการรับประกันความสามารถในการค้าการออกกำลังกายสำหรับวัตถุประสงค์เฉพาะและการไม่เข้าร่วม ไม่ว่าในกรณีใดผู้เขียนหรือผู้ถือลิขสิทธิ์จะต้องรับผิดชอบต่อการเรียกร้องความเสียหายหรือความรับผิดอื่น ๆ ไม่ว่าจะเป็นการกระทำของสัญญาการละเมิดหรืออื่น ๆ ที่เกิดขึ้นจากหรือเกี่ยวข้องกับซอฟต์แวร์หรือการใช้งานหรือการติดต่ออื่น ๆ ในซอฟต์แวร์