Хөгжүүлэлтийн явцад би хөрвүүлэгчийг өөрчлөх, горим барих, хамаарлын хувилбаруудыг өөрчлөх, статик шинжилгээ хийх, гүйцэтгэлийг хэмжих, хамрах хүрээ цуглуулах, баримт бичиг үүсгэх гэх мэт дуртай. Мөн би CMake-д үнэхээр дуртай, учир нь энэ нь надад хүссэн бүхнээ хийх боломжийг олгодог.
Олон хүмүүс CMake-ийг шүүмжилдэг, ихэнхдээ тэгж шүүмжилдэг, гэхдээ та үүнийг харвал бүх зүйл тийм ч муу биш бөгөөд саяхан огт муу биш, хөгжлийн чиг хандлага нэлээд эерэг байна.
Энэ тэмдэглэлд би CMake систем дэх C++ хэл дээрх толгойн номын санг хэрхэн энгийн байдлаар зохион байгуулж, дараах функцуудыг авахыг хэлмээр байна.
- Ассемблей;
- Автоматаар ажиллуулах туршилтууд;
- Кодын хамрах хүрээг хэмжих;
- Суурилуулалт;
- Автомат баримтжуулалт;
- Онлайн хамгаалагдсан хязгаарлагдмал орчин үүсгэх;
- Статик шинжилгээ.
Давуу тал болон C-ийн талаар аль хэдийн ойлгосон хэн бүхэн үүнийг хялбархан хийж чадна мөн үүнийг ашиглаж эхэлнэ.
Агуулга
.
├── CMakeLists.txt
├── README.en.md
├── README.md
├── doc
│ ├── CMakeLists.txt
│ └── Doxyfile.in
├── include
│ └── mylib
│ └── myfeature.hpp
├── online
│ ├── CMakeLists.txt
│ ├── mylib-example.cpp
│ └── wandbox.py
└── test
├── CMakeLists.txt
├── mylib
│ └── myfeature.cpp
└── test_main.cppБид CMake скриптүүдийг хэрхэн зохион байгуулах талаар голчлон ярих тул тэдгээрийг нарийвчлан авч үзэх болно. Бусад файлуудыг хэн ч шууд үзэх боломжтой .
Юуны өмнө та CMake системийн шаардлагатай хувилбарыг хүсэх хэрэгтэй. CMake хөгжиж, тушаалын гарын үсэг, янз бүрийн нөхцөлд зан төлөв өөрчлөгдөж байна. CMake бидний юу хүсч байгаагаа шууд ойлгохын тулд бид түүнд тавигдах шаардлагуудыг даруй бүртгэх хэрэгтэй.
cmake_minimum_required(VERSION 3.13)Дараа нь бид төсөл, түүний нэр, хувилбар, ашигласан хэл гэх мэтийг тодорхойлох болно (харна уу. ).
Энэ тохиолдолд бид хэлийг заана CXX (мөн энэ нь C++ гэсэн үг) бөгөөд ингэснээр CMake нь Си хэлний хөрвүүлэгчийг хайж олохгүй (анхдагчаар CMake нь C ба C++ гэсэн хоёр хэлийг агуулдаг).
project(Mylib VERSION 1.0 LANGUAGES CXX)Эндээс та манай төслийг өөр төсөлд дэд төсөл болгон оруулсан эсэхийг шууд шалгах боломжтой. Энэ нь ирээдүйд маш их тус болно.
get_directory_property(IS_SUBPROJECT PARENT_DIRECTORY)
Бид хоёр сонголтыг өгөх болно.
Эхний сонголт бол — нэгжийн туршилтыг идэвхгүй болгох. Хэрэв бид туршилтын дагуу бүх зүйл эмх цэгцтэй байгаа гэдэгт итгэлтэй байгаа бол энэ нь шаардлагатай байж болох ч, жишээ нь, бид зөвхөн төслөө суулгах эсвэл багцлахыг хүсч байна. Эсвэл манай төслийг дэд төсөл болгон оруулсан - энэ тохиолдолд манай төслийн хэрэглэгч бидний туршилтыг явуулах сонирхолгүй байна. Та хэрэглэж буй хамаарлаа шалгадаггүй биз дээ?
option(MYLIB_TESTING "Включить модульное тестирование" ON)Үүнээс гадна бид тусдаа сонголтыг хийх болно тестээр кодын хамрах хүрээг хэмжихэд зориулагдсан боловч нэмэлт хэрэгсэл шаардагдах тул үүнийг тодорхой идэвхжүүлэх шаардлагатай.
option(MYLIB_COVERAGE "Включить измерение покрытия кода тестами" OFF)
Мэдээжийн хэрэг, бид маш сайн програмистууд тул хөрвүүлэгчээс эмхэтгэлийн цаг хугацааны оношлогооны дээд түвшинг хүсч байна. Ганц ч хулгана дундуур гулсахгүй.
add_compile_options(
-Werror
-Wall
-Wextra
-Wpedantic
-Wcast-align
-Wcast-qual
-Wconversion
-Wctor-dtor-privacy
-Wenum-compare
-Wfloat-equal
-Wnon-virtual-dtor
-Wold-style-cast
-Woverloaded-virtual
-Wredundant-decls
-Wsign-conversion
-Wsign-promo
)Мөн бид C++ хэлний стандартыг бүрэн дагаж мөрдөхийн тулд өргөтгөлүүдийг идэвхгүй болгоно. Тэд CMake-д анхдагчаар идэвхждэг.
if(NOT CMAKE_CXX_EXTENSIONS)
set(CMAKE_CXX_EXTENSIONS OFF)
endif()
Манай номын сан нь зөвхөн толгойн файлуудаас бүрдэх бөгөөд энэ нь бидэнд статик эсвэл динамик номын сан байхгүй гэсэн үг юм. Нөгөөтэйгүүр, манай номын санг гаднаас ашиглахын тулд үүнийг суулгасан байх шаардлагатай бөгөөд үүнийг системд илрүүлж, таны төсөлд холбогдсон байх шаардлагатай бөгөөд үүний зэрэгцээ эдгээр толгойнууд, магадгүй зарим нэмэлтүүд, шинж чанаруудтай нь холбоотой байдаг.
Энэ зорилгоор бид интерфэйсийн номын сан үүсгэдэг.
add_library(mylib INTERFACE)Бид гарчигуудыг интерфэйсийнхээ номын санд холбодог.
CMake-ийн орчин үеийн, загварлаг, залуучуудын хэрэглээ нь толгой, шинж чанар гэх мэтийг илэрхийлдэг. нэг зорилтот замаар дамждаг. Тиймээс хэлэхэд хангалттай , болон зорилтоттой холбоотой бүх гарчиг dependency, зорилтот бүлэгт хамаарах эх сурвалжид бэлэн байх болно target. Мөн танд ямар ч хэрэггүй [target_]include_directories. Үүнийг шинжилгээнд доор харуулна .
Түүнчлэн гэж нэрлэгддэг зүйлд анхаарлаа хандуулах нь зүйтэй. .
Энэ тушаал нь бидэнд хэрэгтэй толгойг интерфэйсийн номын сантай холбодог бөгөөд хэрэв манай номын сан ижил CMake шатлал доторх дурын зорилттой холбогдсон бол лавлахын толгойнууд түүнтэй холбогдох болно. ${CMAKE_CURRENT_SOURCE_DIR}/include, мөн хэрэв манай номын сан системд суулгаж, тушаалыг ашиглан өөр төсөлд холбогдсон бол , дараа нь лавлахын толгойнууд түүнтэй холбогдох болно include суулгах лавлахтай харьцуулахад.
target_include_directories(mylib INTERFACE
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
$<INSTALL_INTERFACE:include>
)Хэлний стандарт тогтооё. Мэдээжийн хэрэг, хамгийн сүүлчийнх нь. Үүний зэрэгцээ бид стандартыг оруулаад зогсохгүй манай номын сангаар үйлчлүүлэх хүмүүст ч мөн энэ стандартыг нэвтрүүлдэг. Энэ нь тогтоосон өмч нь категоритой байдагтай холбоотой юм INTERFACE (харна уу ).
target_compile_features(mylib INTERFACE cxx_std_17)Номын сандаа өөр нэр үүсгэцгээе. Түүнээс гадна гоо сайхны хувьд энэ нь тусгай "нэрийн орон зайд" байх болно. Энэ нь манай номын санд өөр өөр модулиуд гарч ирэхэд хэрэг болох бөгөөд бид тэдгээрийг бие биенээсээ хамааралгүйгээр холбохоор явдаг. .
add_library(Mylib::mylib ALIAS mylib)
Толгойнуудыг системд суулгаж байна. Энд бүх зүйл энгийн. Бүх толгойтой хавтас нь лавлах руу орох ёстой гэж бид хэлдэг include суурилуулах байршилтай харьцуулахад.
install(DIRECTORY include/mylib DESTINATION include)Дараа нь бид гуравдагч этгээдийн төслүүдэд командыг дуудах боломжтой болохыг хүсч байгаагаа бүтээх системд мэдэгдэнэ find_package(Mylib) мөн зорилгоо аваарай Mylib::mylib.
install(TARGETS mylib EXPORT MylibConfig)
install(EXPORT MylibConfig NAMESPACE Mylib:: DESTINATION share/Mylib/cmake)Дараагийн шившлэгийг ингэж ойлгох хэрэгтэй. Гуравдагч этгээдийн төсөлд бид командыг дууддаг find_package(Mylib 1.2.3 REQUIRED), мөн суулгасан номын сангийн бодит хувилбар нь хувилбартай таарахгүй байх болно 1.2.3CMake автоматаар алдаа гаргах болно. Өөрөөр хэлбэл, та хувилбаруудыг гараар хянах шаардлагагүй болно.
include(CMakePackageConfigHelpers)
write_basic_package_version_file("${PROJECT_BINARY_DIR}/MylibConfigVersion.cmake"
VERSION
${PROJECT_VERSION}
COMPATIBILITY
AnyNewerVersion
)
install(FILES "${PROJECT_BINARY_DIR}/MylibConfigVersion.cmake" DESTINATION share/Mylib/cmake)
Хэрэв туршилтыг ашиглан идэвхгүй болгосон бол эсвэл манай төсөл бол дэд төсөл, өөрөөр хэлбэл командыг ашиглан өөр CMake төсөлтэй холбогдсон , бид шатлалын дагуу цааш явахгүй бөгөөд тест үүсгэх, ажиллуулах командуудыг тайлбарласан скрипт нь зүгээр л ажиллахгүй.
if(NOT MYLIB_TESTING)
message(STATUS "Тестирование проекта Mylib выключено")
elseif(IS_SUBPROJECT)
message(STATUS "Mylib не тестируется в режиме подмодуля")
else()
add_subdirectory(test)
endif()
Дэд төслийн хувьд баримт бичгийг мөн үүсгэхгүй.
if(NOT IS_SUBPROJECT)
add_subdirectory(doc)
endif()
Үүний нэгэн адил дэд төсөлд онлайн хамгаалагдсан хязгаарлагдмал орчин байхгүй болно.
if(NOT IS_SUBPROJECT)
add_subdirectory(online)
endif()
Юуны өмнө бид шаардлагатай тестийн хүрээ бүхий багцыг олдог (өөрийн дуртай зүйлээр солино уу).
find_package(doctest 2.3.3 REQUIRED)Тестүүдээр гүйцэтгэх боломжтой файлаа үүсгэцгээе. Би ихэвчлэн хоёртын файлд зөвхөн функцийг агуулсан файлыг шууд нэмдэг main.
add_executable(mylib-unit-tests test_main.cpp)Мөн би туршилтуудыг дараа нь тайлбарласан файлуудыг нэмж оруулав. Гэхдээ та үүнийг хийх шаардлагагүй.
target_sources(mylib-unit-tests PRIVATE mylib/myfeature.cpp)Бид хамаарлыг холбодог. Бид зөвхөн өөрт хэрэгтэй CMake зорилтуудыг хоёртын системтэй холбосон бөгөөд командыг дуудаагүй гэдгийг анхаарна уу target_include_directories. Туршилтын хүрээ болон бидний гарчиг Mylib::mylib, түүнчлэн бүтээх параметрүүд (манай тохиолдолд энэ нь C++ хэлний стандарт) эдгээр зорилгын хамт гарч ирсэн.
target_link_libraries(mylib-unit-tests
PRIVATE
Mylib::mylib
doctest::doctest
)Эцэст нь бид "бүтээл" нь ажиллаж байгаа тесттэй дүйцэхүйц хуурамч зорилтыг үүсгэж, энэ зорилтыг анхдагч бүтэц рүү нэмнэ (атрибут нь үүнийг хариуцдаг. ALL). Энэ нь өгөгдмөл бүтээц нь туршилтуудыг ажиллуулахыг идэвхжүүлдэг гэсэн үг бөгөөд бид тэдгээрийг ажиллуулахаа хэзээ ч мартахгүй гэсэн үг юм.
add_custom_target(check ALL COMMAND mylib-unit-tests)
Дараа нь, хэрэв тохирох сонголтыг зааж өгсөн бол бид кодын хамрах хүрээний хэмжилтийг идэвхжүүлнэ. Тэд CMake-аас илүү хамрах хүрээг хэмжих хэрэгсэлтэй холбоотой тул би дэлгэрэнгүй ярихгүй. Үр дүнд үндэслэн зорилго бий болно гэдгийг анхаарах нь чухал юм , үүний тусламжтайгаар хамрах хүрээг хэмжиж эхлэхэд тохиромжтой.
find_program(GCOVR_EXECUTABLE gcovr)
if(MYLIB_COVERAGE AND GCOVR_EXECUTABLE)
message(STATUS "Измерение покрытия кода тестами включено")
target_compile_options(mylib-unit-tests PRIVATE --coverage)
target_link_libraries(mylib-unit-tests PRIVATE gcov)
add_custom_target(coverage
COMMAND
${GCOVR_EXECUTABLE}
--root=${PROJECT_SOURCE_DIR}/include/
--object-directory=${CMAKE_CURRENT_BINARY_DIR}
DEPENDS
check
)
elseif(MYLIB_COVERAGE AND NOT GCOVR_EXECUTABLE)
set(MYLIB_COVERAGE OFF)
message(WARNING "Для замеров покрытия кода тестами требуется программа gcovr")
endif()
.
find_package(Doxygen)Дараа нь бид хэрэглэгч хэлний хувьсагчийг тохируулсан эсэхийг шалгана. Хэрэв тийм бол бид үүнд хүрэхгүй, үгүй бол орос хэлийг авдаг. Дараа нь бид Doxygen системийн файлуудыг тохируулна. Тохиргоо хийх явцад шаардлагатай бүх хувьсагч, түүний дотор хэл, тэнд очдог (харна уу. ).
Дараа нь бид зорилгоо бий болгодог , энэ нь баримт бичгийг үүсгэж эхэлнэ. Баримт бичгийг бүрдүүлэх нь боловсруулах явцад хамгийн том хэрэгцээ биш тул зорилтот тохиргоог анхдагчаар идэвхжүүлэхгүй бөгөөд үүнийг тодорхой эхлүүлэх шаардлагатай болно.
if (Doxygen_FOUND)
if (NOT MYLIB_DOXYGEN_LANGUAGE)
set(MYLIB_DOXYGEN_LANGUAGE Russian)
endif()
message(STATUS "Doxygen documentation will be generated in ${MYLIB_DOXYGEN_LANGUAGE}")
configure_file(Doxyfile.in Doxyfile)
add_custom_target(doc COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
endif ()
Энд бид гурав дахь Python-ийг олж, зорилтот дүрсийг үүсгэнэ , энэ нь үйлчилгээний API-д тохирох хүсэлтийг үүсгэдэг , мөн түүнийг явуулав. Хариулт нь дууссан хамгаалагдсан хязгаарлагдмал орчинд холбогдох холбоостой ирдэг.
find_program(PYTHON3_EXECUTABLE python3)
if(PYTHON3_EXECUTABLE)
set(WANDBOX_URL "https://wandbox.org/api/compile.json")
add_custom_target(wandbox
COMMAND
${PYTHON3_EXECUTABLE} wandbox.py mylib-example.cpp "${PROJECT_SOURCE_DIR}" include |
curl -H "Content-type: application/json" -d @- ${WANDBOX_URL}
WORKING_DIRECTORY
${CMAKE_CURRENT_SOURCE_DIR}
DEPENDS
mylib-unit-tests
)
else()
message(WARNING "Для создания онлайн-песочницы требуется интерпретатор ЯП python 3-й версии")
endif()
Одоо энэ бүхнийг хэрхэн ашиглахыг харцгаая.
CMake бүтээх системийн бусад төслийн нэгэн адил энэ төслийг бүтээх нь хоёр үе шатаас бүрдэнэ.
cmake -S путь/к/исходникам -B путь/к/сборочной/директории [опции ...]Хэрэв CMake-ийн хуучин хувилбараас болж дээрх тушаал ажиллахгүй бол орхиж үзнэ үү
-S:cmake путь/к/исходникам -B путь/к/сборочной/директории [опции ...]
.
cmake --build путь/к/сборочной/директории [--target target].
cmake -S ... -B ... -DMYLIB_COVERAGE=ON [прочие опции ...]Зорилтот багтана , үүний тусламжтайгаар та кодын хамрах хүрээг тестээр хэмжиж эхлэх боломжтой.
cmake -S ... -B ... -DMYLIB_TESTING=OFF [прочие опции ...]Нэгжийн туршилтын бүтэц, зорилтыг идэвхгүй болгох боломжийг олгодог . Үүний үр дүнд тестээр кодын хамрах хүрээг хэмжих нь унтарсан (харна уу. ).
Хэрэв төсөл өөр төсөлд командыг ашиглан дэд төсөл болгон холбогдсон бол туршилтыг мөн автоматаар идэвхгүй болгоно .
cmake -S ... -B ... -DMYLIB_DOXYGEN_LANGUAGE=English [прочие опции ...]Зорилтот үүсгэсэн баримт бичгийн хэлийг сэлгэнэ өгөгдсөн нэгэнд. Боломжтой хэлний жагсаалтыг үзнэ үү .
Орос хэлийг анхдагчаар идэвхжүүлсэн.
cmake --build path/to/build/directory
cmake --build path/to/build/directory --target allХэрэв зорилтыг заагаагүй бол (энэ нь зорилттой тэнцүү байна all), чадах бүхнээ цуглуулж, мөн байг дууддаг .
cmake --build path/to/build/directory --target mylib-unit-testsНэгжийн тестийг эмхэтгэдэг. Өгөгдмөлөөр идэвхжүүлсэн.
cmake --build путь/к/сборочной/директории --target checkЦуглуулсан (хэрэв цуглуулаагүй бол) нэгжийн тестүүдийг ажиллуулдаг. Өгөгдмөлөөр идэвхжүүлсэн.
Үүнийг бас үзнэ үү .
cmake --build путь/к/сборочной/директории --target coverageХөтөлбөрийг ашиглан тестээр кодын хамрах хүрээг тодорхойлох нэгжийн туршилтыг ажиллуулж (хэрэв ажиллаагүй бол) шинжилдэг .
Бүрхүүлийн яндан нь иймэрхүү харагдах болно.
------------------------------------------------------------------------------
GCC Code Coverage Report
Directory: /path/to/cmakecpptemplate/include/
------------------------------------------------------------------------------
File Lines Exec Cover Missing
------------------------------------------------------------------------------
mylib/myfeature.hpp 2 2 100%
------------------------------------------------------------------------------
TOTAL 2 2 100%
------------------------------------------------------------------------------Зорилтот нь зөвхөн сонголтыг идэвхжүүлсэн үед л боломжтой .
Үүнийг бас үзнэ үү .
cmake --build путь/к/сборочной/директории --target docСистемийг ашиглан кодын баримт бичгийг үүсгэж эхэлнэ .
cmake --build путь/к/сборочной/директории --target wandboxҮйлчилгээний хариу дараах байдалтай байна.
{
"permlink" : "QElvxuMzHgL9fqci",
"status" : "0",
"url" : "https://wandbox.org/permlink/QElvxuMzHgL9fqci"
}Үүний тулд үйлчилгээг ашигладаг . Тэдний серверүүд хэр уян хатан байдгийг би мэдэхгүй ч энэ боломжийг буруугаар ашиглах ёсгүй гэж би бодож байна.
Хамрах хүрээний хэмжилтээр дибаг хийх горимд төслийг бий болгох
cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Debug -DMYLIB_COVERAGE=ON
cmake --build путь/к/сборочной/директории --target coverage --parallel 16Урьдчилсан угсралт, туршилтгүйгээр төслийг суурилуулах
cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DMYLIB_TESTING=OFF -DCMAKE_INSTALL_PREFIX=путь/к/установойной/директории
cmake --build путь/к/сборочной/директории --target installӨгөгдсөн хөрвүүлэгчтэй хувилбарын горимд бүтээх
cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER=g++-8 -DCMAKE_PREFIX_PATH=путь/к/директории/куда/установлены/зависимости
cmake --build путь/к/сборочной/директории --parallel 4Англи хэл дээр бичиг баримт бүрдүүлэх
cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Release -DMYLIB_DOXYGEN_LANGUAGE=English
cmake --build путь/к/сборочной/директории --target doc
-
3.13
Үнэн хэрэгтээ CMake хувилбар 3.13 нь энэ тусламжид тайлбарласан консолын зарим командыг ажиллуулахад л шаардлагатай. CMake скриптүүдийн синтаксийн үүднээс авч үзвэл үүслийг өөр аргаар дуудвал 3.8 хувилбар хангалттай.
-
Туршилтын номын сан
Туршилтыг идэвхгүй болгож болно (харна уу ).
-
Баримт бичгийг үүсгэх хэлийг өөрчлөхийн тулд сонголтыг өгсөн болно .
-
Хэлний орчуулагч
Автомат үүсгэх зориулалттай .
CMake болон хэд хэдэн сайн хэрэгслийн тусламжтайгаар та хамгийн бага хүчин чармайлтаар статик дүн шинжилгээ хийх боломжтой.
Cppcheck
CMake нь статик дүн шинжилгээ хийх хэрэгсэлд суурилуулсан дэмжлэгтэй .
Үүнийг хийхийн тулд та сонголтыг ашиглах хэрэгтэй :
cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_CPPCHECK="cppcheck;--enable=all;-Iпуть/к/исходникам/include"Үүний дараа эх сурвалжийг эмхэтгэж, дахин эмхэтгэх бүрт статик анализ автоматаар эхлэх болно. Нэмэлт зүйл хийх шаардлагагүй.
Чанга
Гайхамшигтай хэрэгслийн тусламжтайгаар Та мөн статик шинжилгээг богино хугацаанд хийж болно:
scan-build cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Debug
scan-build cmake --build путь/к/сборочной/директорииЭнд, Cppcheck-ээс ялгаатай нь та угсралтыг хийх болгондоо ажиллуулах хэрэгтэй scan-build.
CMake бол амт, өнгө бүрийн функцийг хэрэгжүүлэх боломжийг олгодог маш хүчирхэг, уян хатан систем юм. Хэдийгээр синтакс нь заримдаа хүссэн зүйлээ үлдээдэг ч чөтгөр зурсан шигээ аймшигтай биш хэвээр байна. CMake build системийг нийгэм, эрүүл мэндийн тусын тулд ашигла.
→
Эх сурвалж: www.habr.com