CMake

Разработка CMake началась в 1999 году в ответ на потребность в кроссплатформенной системе сборки для ITK[4]. Проект финансируемый национальной библиотекой медицины США, как часть проекта «Visible Human Project». Задача по разработке была возложена на небольшую компанию Kitware.

В то время было нормой использовать конфигурационные скрипты и Make файлы для сборки программных проектов на Unix платформах и файлы проектов Visual Studio в среде Windows. Такой подход к разработке вызывал огромное неудобство, так как к примеру добавление обыкновенного файла исходного кода в проект, приводило к большим трудностям. Ведь для каждой платформы, это приходилось делать по отдельности и совершенно разными методами. Очевидно, что разработчики хотели иметь единую унифицированную систему сборки, не отнимающую лишнее время и имеющую все преимущества существующих систем сборки, но при этом не имеющую их недостатков[5][6].

Ключевой особенностью является возможность (необязательно) размещать выходные данные компилятора (например, объектные файлы) вне дерева исходного кода. Это позволяет выполнять несколько вариаций сборок из одного и того же исходного кода, а также кросскомпиляцию. Такой подход разделения файлов исходного кода и файлов сборки даёт гарантию, что удаление каталога сборки не приведет к удалению исходного кода. Однако сами пользователи не защищены от случайного удаления каталога с исходными файлами[7].

Сборка программы или библиотеки с помощью CMake, представляет собой двухэтапный процесс. Во-первых, стандартные файлы сборки создаются (генерируются) из файлов конфигурации (CMakeLists.txt), которые написаны на языке CMake. Затем задействуются системные инструменты сборки (Make, Ninja и т. п.) используемые для фактического создания программ[7][10].

Файлы сборки конфигурируются в зависимости от используемого генератора (например, генератор «Unix Makefiles» — для Make фaйлов). Продвинутые пользователи могут создавать и включать свои собственные генераторы файлов Make, для поддержки новых компиляторов и операционных систем. Сгенерированные файлы обычно помещаются (с помощью флага CMake) во внешний каталог, за пределами исходных файлов, например в каталог «build».

Каждый проект после сборки, в поддиректориях содержит «CMakeCache.txt» и каталог файлов Make, что помогает избежать или ускорить этап «перегенерации», после повторного запуска сборки[11].

CMake имеет относительно простой интерпретируемый императивный язык сценариев. Он поддерживает переменные, методы обработки строк, массивы, объявления функций и макросов, включение модулей (импортирование). Команды языка CMake (или директивы) считываются CMake из файла CMakeLists.txt. В этом файле указываются исходные файлы и параметры сборки, которые CMake размещает в спецификации сборки проекта (например, в файле Make). Кроме того, файлы с приставкой .cmake, могут содержать сценарии используемые CMake[14].

install(TARGETS ...
        CONFIGURATIONS ...
        RUNTIME DESTINATION ...)

CMake поставляется с большим количеством модулей и инструментов «.cmake». Они облегчают такую работу, как поиск зависимостей (как встроенных, так и внешних, например, FindXYZ модули), инструменты для тестирования исполняемых файлов, упаковка (модуль CPack и команда cpack) и управление зависимостями от внешних проектов (модуль ExternalProject)[20][21]:

• ctest — используется для тестирования целей, заданных в CMakeLists.txt;
• ccmake и cmake-gui — настраивает и обновляет переменные конфигурации, предназначенные для целевой системы сборки;
• cpack — помогает упаковывать и устанавливать программное обеспечение.

Далее приведён пример простого «Hello, World!» проекта.

В отдельном каталоге создаём файл с названием — «CMakeLists.txt» со следующим кодом.

cmake_minimum_required(VERSION 3.16)     # Выбираем минимальную необходимую версию cmake

set(PROJECT_NAME my_project)             # Записываем имя в переменную

project(${PROJECT_NAME})                 # Присваиваем имя проекту

add_executable(                          # Создаём цель (исполняемый файл) с именем проекта
  ${PROJECT_NAME}                        # Также, указываем файлы исходного кода
  main.cpp                               # Добавлять заголовочные файлы нет необходимости
)

install(                                 # Устанавливаем цель указав ключевое слово bin
  TARGETS ${PROJECT_NAME}                # Путь установки будет определён автоматически
  RUNTIME DESTINATION bin                # bin - binary (путь к исполняемым файлам)
)

В этом же каталоге создаём файл — «main.cpp» (исходный код C++).

# include <iostream>

int main()
{
    std::cout << "Hello, World!" << std::endl;
    return 0;
}

Помимо CMake, для сборки необходим базовый набор программ — любой компилятор С++ (clang++, g++) и система сборки (Ninja, Make). Далее для сборки необходимы выполнить ряд следующих команд (находясь в том же каталоге):

$ cmake .            # Вызываем генерацию файлов сборки
$ cmake --build .    # Собираем проект, на выходе получаем исполняемый файл
$ cmake --install .  # По необходимости устанавливаем

Для команды установки могут потребоваться повышенные права доступа.

Чтобы получить более подробную информацию, воспользуйтесь командой help.

$ cmake --help
$ cmake --help-command-list
$ cmake --help-command install

• Автоматизация сборки
• Make
• Ninja
• Autotools
• SCons
• Meson
• Premake

• Официальный сайт
• Разработчики рассказывают о истории проекта CMake // Журнал «Открытые системы», 2007/03
• Что за штука CMake? // Журнал «Linux Format», #99 (12), Декабрь 2007 (wiki)
• Как использовать CMake в KDE4
• Статьи по CMake
• Почему KDE перешёл к использованию CMake (англ.)