mylib

?? Versi bahasa Inggris

Template Proyek Berdasarkan Sistem Perakitan CMake untuk Bahasa C ++

Tiup dan ubah "mylib" menjadi namamu.

Atau hasilkan proyek Anda menggunakan skrip: https://github.com/izvolov/mylib-gen

Isi

1. Perakitan
   1. Generasi
   2. Perakitan
2. Opsi
   1. Mylib_coverage
   2. Mylib_testing
   3. Doxygen_output_language
3. Tujuan Majelis
   1. Secara default
   2. Mylib_library
   3. Mylib-unit-test
   4. Memeriksa
   5. Cakupan
   6. dokter
   7. Wandbox
4. Contoh
5. Penggunaan
   1. Melalui instalasi
   2. Sebagai submodule
6. Peralatan
7. Bonus

Perakitan

Perakitan proyek ini, seperti proyek lainnya di sistem perakitan CMake, terdiri dari dua tahap:

Generasi

cmake -S путь/к/исходникам -B путь/к/сборочной/директории [опции ...]

Baca lebih lanjut tentang opsi.

Majelis Proyek

cmake --build путь/к/сборочной/директории [--target target]

Baca lebih lanjut tentang tujuan perakitan.

Opsi

Mylib_coverage

cmake -S ... -B ... -DMYLIB_COVERAGE=ON [прочие опции ...]

Termasuk tujuan coverage , yang dengannya Anda dapat mulai mengukur penutup kode dengan tes.

Mylib_testing

cmake -S ... -B ... -DMYLIB_TESTING=OFF [прочие опции ...]

Memberikan kesempatan untuk mematikan perakitan tes modular dan tujuan check . Akibatnya, kode dimatikan oleh lapisan inti dengan tes (lihat Coating).

Pengujian juga secara otomatis terputus jika proyek terhubung ke proyek lain sebagai sub -proye menggunakan perintah add_subdirectory .

Doxygen_output_language

cmake -S ... -B ... -DDOXYGEN_OUTPUT_LANGUAGE=English [прочие опции ...]

Ini mengganti bahasa dokumentasi, yang dihasilkan oleh tujuan doc ke yang diberikan. Untuk daftar bahasa yang dapat diakses, lihat situs web Sistem Doxygen.

Secara default, orang Rusia disertakan.

Tujuan Majelis

Secara default

cmake --build путь/к/сборочной/директории
cmake --build путь/к/сборочной/директории --target all

Jika tujuan tidak diindikasikan (yang setara dengan tujuan all ), mengumpulkan segala sesuatu yang mungkin, dan juga menyebabkan tujuan check .

Mylib_library

cmake --build путь/к/сборочной/директории --target mylib_library

Disusun oleh perpustakaan mylib_library . Termasuk secara default.

Mylib-unit-test

cmake --build путь/к/сборочной/директории --target mylib-unit-tests

Mengkompilasi tes modular. Termasuk secara default.

Memeriksa

cmake --build путь/к/сборочной/директории --target check

Rune Tes modular yang dikumpulkan (mengumpulkan, jika belum). Termasuk secara default.

Lihat juga mylib-unit-tests .

Cakupan

cmake --build путь/к/сборочной/директории --target coverage

Analisis Tes Modular Lanjutan (Peluncuran, jika belum) untuk mencakup kode dengan tes menggunakan program GCOVR.

Tujuannya hanya tersedia dengan opsi MYLIB_COVERAGE yang disertakan.

Lihat juga check .

dokter

cmake --build путь/к/сборочной/директории --target doc

Runes Generasi dokumentasi untuk kode menggunakan sistem doxygen.

Wandbox

cmake --build путь/к/сборочной/директории --target wandbox

Untuk ini, layanan wandbox digunakan. Jangan menyalahgunakan hal ini, servernya bukan karet.

Contoh

Perakitan proyek dalam mode utang dengan mengukur lapisan

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Debug -DMYLIB_COVERAGE=ON
cmake --build путь/к/сборочной/директории --target coverage --parallel 16

Pemasangan proyek tanpa perakitan dan pengujian pendahuluan

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DMYLIB_TESTING=OFF -DCMAKE_INSTALL_PREFIX=путь/к/установойной/директории
cmake --build путь/к/сборочной/директории --target install

Perakitan dalam mode kelulusan dengan kompiler yang diberikan

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER=g++-8 -DCMAKE_PREFIX_PATH=путь/к/директории/куда/установлены/зависимости
cmake --build путь/к/сборочной/директории --parallel 4

Generasi dokumentasi dalam bahasa Inggris

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Release -DDOXYGEN_OUTPUT_LANGUAGE=English
cmake --build путь/к/сборочной/директории --target doc

Penggunaan

Melalui instalasi

Salah satu opsi untuk menggunakan modul adalah menginstalnya di sistem.

cmake --build путь/к/сборочной/директории --target install

Setelah itu, proyek lain, memanggil perintah find_package , mendapat kesempatan untuk menggunakan semua perpustakaan dari Mylib::

 find_package (Mylib 1.0 REQUIRED)

add_executable (some_executable some.cpp sources .cpp)
target_link_libraries (some_executable PRIVATE Mylib::library)

Mylib::library perlu dihubungkan ketika Anda perlu tetap dengan perpustakaan libmylib_library . Jika ada cukup berita utama, maka ada baiknya menggunakan Mylib::headers .

Sebagai submodule

Proyek ini juga dapat dihubungkan ke proyek lain sebagai submodule menggunakan perintah add_subdirectory .

Dalam hal ini, Mylib::library dan Mylib::headers akan tersedia dengan cara yang sama.

Peralatan

1. Cmake 3.14

   CMake 3.14 diperlukan karena dalam versi sebelumnya install(TARGETS ... EXPORT ...) salah dalam versi sebelumnya, yaitu, jalur default tidak ditentukan.

2. Perpustakaan Tes Doctest

   Pengujian dapat dimatikan (lihat Pengujian).

3. Doxygen

   Untuk mengganti bahasa di mana dokumentasi akan dihasilkan, opsi DOXYGEN_OUTPUT_LANGUAGE disediakan.

4. Interpreter Jap Python 3

   Untuk generasi otomatis sandwich online.

Bonus

Dengan bantuan CMake dan sepasang alat yang baik, Anda dapat memberikan analisis statis dengan gerakan tubuh minimal.

CPPCHECK

CMake telah membangun dukungan untuk analisis statis CPPCHECK.

Untuk melakukan ini, gunakan opsi CMAKE_CXX_CPPCHECK :

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_CPPCHECK= " cppcheck;--enable=all;-Iпуть/к/исходникам/include "

Setelah itu, analisis statis akan secara otomatis diluncurkan setiap kali selama kompilasi dan silang -kompleks dari sumber. Anda tidak perlu melakukan apa pun tambahan.

Dentang

Dengan bantuan alat scan-build yang indah, Anda juga dapat memulai analisis statis dalam dua skor:

scan-build cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Debug
scan-build cmake --build путь/к/сборочной/директории

Di sini, tidak seperti kasus dengan CPPCheck, perlu untuk menjalankan perakitan melalui scan-build setiap kali.