CMake와 C++는 영원히 형제입니다

개발 중에는 컴파일러, 빌드 모드, 종속성 버전 변경, 정적 분석 수행, 성능 측정, 적용 범위 수집, 문서 생성 등을 좋아합니다. 그리고 저는 제가 원하는 모든 것을 할 수 있게 해주는 CMake를 정말 좋아합니다.

많은 사람들이 CMake를 비판하고, 당연히 그럴 때도 있지만, 살펴보면 모든 것이 그렇게 나쁘지는 않으며 최근에는 나쁘지 않아, 개발 방향은 상당히 긍정적입니다.

이 노트에서는 CMake 시스템에서 C++로 헤더 라이브러리를 간단히 구성하여 다음 기능을 얻는 방법을 알려 드리고자 합니다.

1. 집회;
2. 자동 실행 테스트;
3. 코드 커버리지 측정;
4. 설치;
5. 자동 문서화;
6. 온라인 샌드박스 생성;
7. 정적 분석.

이미 장점과 C-make를 이해하고 있는 사람이라면 누구나 간단히 할 수 있습니다. 프로젝트 템플릿 다운로드 그리고 그것을 사용하기 시작합니다.

내용

1. 내부에서 프로젝트하기
   1. 프로젝트 구조
   2. 기본 CMake 파일(./CMakeLists.txt)
      1. 프로젝트 정보
      2. 프로젝트 옵션
      3. 컴파일 옵션
      4. 주요 목표
      5. 설치
      6. 테스트
      7. Документация
      8. 온라인 샌드박스
   3. 테스트 스크립트(test/CMakeLists.txt)
      1. 테스트
      2. 적용 범위
   4. 문서용 스크립트(doc/CMakeLists.txt)
   5. 온라인 샌드박스용 스크립트(online/CMakeLists.txt)
2. 외부 프로젝트
   1. 조립
      1. 세대
      2. 조립
   2. 옵션
      1. MYLIB_COVERAGE
      2. MYLIB_테스트 중
      3. MYLIB_DOXYGEN_LANGUAGE
   3. 조립대상
      1. 기본적으로
      2. mylib 단위 테스트
      3. 검사
      4. 적용 범위
      5. 의사
      6. 지팡이 상자
   4. 예
3. 도구
4. 정적 분석
5. 사후

내부에서 프로젝트하기

프로젝트 구조

.
├── 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 파일(./CMakeLists.txt)

프로젝트 정보

우선, 필요한 CMake 시스템 버전을 요청해야 합니다. CMake는 발전하고 있으며 다양한 조건에서의 명령 서명과 동작이 변화하고 있습니다. CMake가 우리가 원하는 것이 무엇인지 즉시 이해하려면 이에 대한 요구 사항을 즉시 기록해야 합니다.

cmake_minimum_required(VERSION 3.13)

그런 다음 프로젝트, 이름, 버전, 사용된 언어 등을 지정합니다. команду project).

이 경우 언어를 나타냅니다. CXX (이것은 C++를 의미함) CMake가 C 언어 컴파일러를 무리하게 검색하지 않도록 하기 위한 것입니다(기본적으로 CMake에는 C와 C++라는 두 가지 언어가 포함되어 있습니다).

project(Mylib VERSION 1.0 LANGUAGES CXX)

여기에서 우리 프로젝트가 다른 프로젝트에 하위 프로젝트로 포함되어 있는지 즉시 확인할 수 있습니다. 이것은 앞으로 많은 도움이 될 것입니다.

get_directory_property(IS_SUBPROJECT PARENT_DIRECTORY)

프로젝트 옵션

우리는 두 가지 옵션을 제공할 것입니다.

첫 번째 옵션은 MYLIB_TESTING — 단위 테스트를 비활성화합니다. 모든 것이 테스트에 적합하다고 확신하지만 예를 들어 프로젝트를 설치하거나 패키지하기만 원하는 경우 이는 필요할 수 있습니다. 또는 프로젝트가 하위 프로젝트로 포함됩니다. 이 경우 프로젝트 사용자는 테스트 실행에 관심이 없습니다. 사용하는 종속성을 테스트하지 않습니까?

option(MYLIB_TESTING "Включить модульное тестирование" ON)

추가적으로 별도의 옵션을 만들어 드리겠습니다. MYLIB_COVERAGE 테스트를 통해 코드 적용 범위를 측정하기 위해서는 추가 도구가 필요하므로 명시적으로 활성화해야 합니다.

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의 현대적이고 패셔너블한 청소년 사용은 헤더, 속성 등을 의미합니다. 하나의 단일 대상을 통해 전송됩니다. 그러니까 말해도 충분해 target_link_libraries(target PRIVATE dependency)및 대상과 관련된 모든 헤더 dependency, 대상에 속한 소스에 사용할 수 있습니다. target. 그리고 당신은 아무것도 필요하지 않습니다 [target_]include_directories. 이는 아래 분석에서 설명하겠습니다. 단위 테스트를 위한 CMake 스크립트.

소위에도 주목할 가치가 있습니다. выражения-генераторы: $<...>.

이 명령은 필요한 헤더를 인터페이스 라이브러리와 연결하며, 라이브러리가 동일한 CMake 계층 내의 대상에 연결된 경우 디렉터리의 헤더가 해당 라이브러리와 연결됩니다. ${CMAKE_CURRENT_SOURCE_DIR}/include, 라이브러리가 시스템에 설치되어 있고 다음 명령을 사용하여 다른 프로젝트에 연결된 경우 find_package, 그러면 디렉터리의 헤더가 연결됩니다. include 설치 디렉토리에 상대적입니다.

target_include_directories(mylib INTERFACE
    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
    $<INSTALL_INTERFACE:include>
)

언어 표준을 설정해 봅시다. 물론, 가장 마지막 것. 동시에 우리는 표준을 포함할 뿐만 아니라 우리 라이브러리를 사용할 사람들에게도 이를 확장합니다. 이는 설정된 속성에 카테고리가 있다는 사실로 인해 달성됩니다. INTERFACE (참조하십시오. target_compile_features 명령).

target_compile_features(mylib INTERFACE cxx_std_17)

라이브러리의 별칭을 만들어 보겠습니다. 또한 아름다움을 위해 특별한 "네임스페이스"에 위치합니다. 이는 라이브러리에 다른 모듈이 나타날 때 유용하며, 서로 독립적으로 연결합니다. 예를 들어 Busta에서처럼.

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 프로젝트에 연결됩니다. add_subdirectory, 우리는 계층 구조를 따라 더 이상 이동하지 않으며 테스트 생성 및 실행 명령을 설명하는 스크립트는 단순히 실행되지 않습니다.

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()

테스트 스크립트(test/CMakeLists.txt)

테스트

우선, 필요한 테스트 프레임워크가 포함된 패키지를 찾습니다(원하는 프레임워크로 교체).

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보다는 커버리지 측정 도구와 더 관련이 있기 때문에 자세히 설명하지 않겠습니다. 결과에 따라 목표가 생성된다는 점만 알아두는 것이 중요합니다. coverage, 커버리지 측정을 시작하는 것이 편리합니다.

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()

문서용 스크립트(doc/CMakeLists.txt)

Doxygen을 찾았습니다.

find_package(Doxygen)

다음으로 사용자가 언어 변수를 설정했는지 확인합니다. 그렇다면 만지지 않고, 그렇지 않다면 러시아어를 사용합니다. 그런 다음 Doxygen 시스템 파일을 구성합니다. 언어를 포함하여 필요한 모든 변수는 구성 프로세스 중에 해당 위치로 이동합니다(참조: команду configure_file).

그런 다음 목표를 만듭니다. doc, 문서 생성이 시작됩니다. 문서 생성은 개발 프로세스에서 가장 큰 요구 사항이 아니기 때문에 대상은 기본적으로 활성화되지 않으며 명시적으로 시작해야 합니다.

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 ()

온라인 샌드박스용 스크립트(online/CMakeLists.txt)

여기서는 세 번째 Python을 찾아 타겟을 생성합니다. wandbox, 서비스 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]

조립 목표에 대한 추가 정보.

옵션

MYLIB_COVERAGE

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

대상 포함 coverage, 테스트를 통해 코드 적용 범위 측정을 시작할 수 있습니다.

MYLIB_테스트 중

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

단위 테스트 빌드 및 대상을 비활성화하는 기능을 제공합니다. check. 결과적으로 테스트에 의한 코드 적용 범위 측정이 꺼집니다(참조: MYLIB_COVERAGE).

프로젝트가 명령을 사용하여 하위 프로젝트로 다른 프로젝트에 연결된 경우에도 테스트가 자동으로 비활성화됩니다. add_subdirectory.

MYLIB_DOXYGEN_LANGUAGE

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

타겟이 생성하는 문서의 언어를 전환합니다. doc 주어진 것에게. 사용 가능한 언어 목록은 다음을 참조하세요. Doxygen 시스템 웹사이트.

러시아어는 기본적으로 활성화되어 있습니다.

조립대상

기본적으로

cmake --build path/to/build/directory
cmake --build path/to/build/directory --target all

대상이 지정되지 않은 경우(대상과 동일함) all), 가능한 모든 것을 수집하고 대상을 호출합니다. check.

mylib 단위 테스트

cmake --build path/to/build/directory --target mylib-unit-tests

단위 테스트를 컴파일합니다. 기본적으로 활성화되어 있습니다.

검사

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

수집된(아직 수집되지 않은 경우 수집된) 단위 테스트를 실행합니다. 기본적으로 활성화되어 있습니다.

См. также mylib-unit-tests.

적용 범위

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

프로그램을 사용한 테스트를 통해 코드 적용 범위에 대한 실행 중인(아직 실행되지 않은 경우) 단위 테스트를 분석합니다. gcovr.

코팅 배기 장치는 다음과 같습니다.

------------------------------------------------------------------------------
                           GCC Code Coverage Report
Directory: /path/to/cmakecpptemplate/include/
------------------------------------------------------------------------------
File                                       Lines    Exec  Cover   Missing
------------------------------------------------------------------------------
mylib/myfeature.hpp                            2       2   100%   
------------------------------------------------------------------------------
TOTAL                                          2       2   100%
------------------------------------------------------------------------------

옵션이 활성화된 경우에만 대상을 사용할 수 있습니다. MYLIB_COVERAGE.

См. также check.

의사

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

도구

1. CMake 3.13

   실제로 CMake 버전 3.13은 이 도움말에 설명된 일부 콘솔 명령을 실행하는 데만 필요합니다. CMake 스크립트 구문의 관점에서 생성이 다른 방식으로 호출되는 경우 버전 3.8이면 충분합니다.

2. 테스트 라이브러리 독테스트

   테스트를 비활성화할 수 있습니다(참조: опцию MYLIB_TESTING).

3. 독소

   문서가 생성되는 언어를 전환하기 위해 옵션이 제공됩니다. MYLIB_DOXYGEN_LANGUAGE.

4. 언어 통역사 파이썬 3

   자동 생성의 경우 온라인 샌드박스.

정적 분석

CMake와 몇 가지 좋은 도구를 사용하면 최소한의 노력으로 정적 분석을 제공할 수 있습니다.

Cppcheck

CMake에는 정적 분석 도구에 대한 지원이 내장되어 있습니다. Cppcheck.

이렇게 하려면 옵션을 사용해야 합니다. CMAKE_CXX_CPPCHECK:

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

이후에는 소스가 컴파일되고 다시 컴파일될 때마다 정적 분석이 자동으로 시작됩니다. 추가로 수행할 작업은 없습니다.

그 소리

훌륭한 도구의 도움으로 scan-build 또한 정적 분석을 즉시 실행할 수도 있습니다.

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

여기서는 Cppcheck의 경우와 달리 매번 빌드를 실행해야 합니다. scan-build.

사후

CMake는 모든 취향과 색상에 맞는 기능을 구현할 수 있는 매우 강력하고 유연한 시스템입니다. 그리고 구문이 때때로 부족한 점이 많지만 악마는 여전히 그려진 것만큼 끔찍하지 않습니다. 사회와 건강의 이익을 위해 CMake 빌드 시스템을 사용하세요.

→ 프로젝트 템플릿 다운로드

출처 : habr.com