CMake

CMake
Тип	система сборки, свободное и открытое программное обеспечение и утилита
Автор	Kitware
Разработчики	Kitware, Александр Нойндорф, Кен Мартин, Андрей Седильник, Уильям Хоффман и Брэд Кинг
Написана на	C++ и Си
Интерфейс	Qt[…]
Операционные системы	Unix-подобная операционная система и Windows
Языки интерфейса	английский
Первый выпуск	2000
Аппаратная платформа	кроссплатформенность
Последняя версия	3.31.3 (20 декабря 2024)
Кандидат в релизы	3.31.0-rc3 (29 октября 2024)
Репозиторий	gitlab.kitware.com/cmake…
Состояние	активное
Лицензия	модифицированная лицензия BSD[…]
Сайт	cmake.org (англ.)
Медиафайлы на Викискладе

CMake (МФА [ˈsiːmeɪk]; от англ. Cross-platform Make — «Кроссплатформенный Make») — это кроссплатформенная утилита, обладающая возможностями автоматизации сборки программного обеспечения из исходного кода. Сам CMake не занимается непосредственно сборкой, а лишь генерирует файлы сборки из предварительно написанного скрипт-файла «CMakeLists.txt» и предоставляет простой единый интерфейс управления. Помимо этого, CMake способен автоматизировать процесс установки и пакетирования.

Считается альтернативой распространённой в сообществе GNU системе Autotools, разработанной на базе Perl и M4, которая требует определённых навыков для практического использования, а существующие версии в ряде случаев несовместимы друг с другом.

В сравнении с другой альтернативой Autotools — появившейся в 2008 году системой SCons основанной на Python — является более быстродействующей, поскольку написана на Си и использует крайне простой макроязык, но при этом SCons обладает большими возможностями по расширению.

История

Разработка CMake началась в 1999 году в ответ на потребность в кроссплатформенной системе сборки для ITK. Проект финансируемый национальной библиотекой медицины США, как часть проекта «Visible Human Project». Задача по разработке была возложена на небольшую компанию Kitware. На него повлияла более ранняя система под названием pcmaker, созданная Кеном Мартином (Ken Martin) и другими разработчиками для поддержки инструментария визуализации (VTK).

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

Возможности

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

Настраиваемая структура проекта

CMake может находить общесистемные и пользовательские каталоги исполняемых файлов, файлов конфигураций и библиотек. Эти местоположения хранятся в кэше, который можно конфигурировать перед созданием целевых файлов сборки. CMake кэш можно редактировать с помощью графического редактора, который поставляется вместе с CMake, либо вручную, посредством оболочки командной строки с помощью команд CMake.

Сложные иерархии каталогов проектов, рассчитанные на разные конфигурации, сборку с разными библиотеками и инструментами, также хорошо поддерживаются CMake. По сути CMake предоставляет возможность создавать подпроекты, собираемые перед сборкой основного проекта, что позволяет создавать цепочки зависимостей, собираемые в правильной необходимой разработчику последовательности.

Поддержка разных сред разработки

CMake может создавать файлы проектов для нескольких популярных ИСР, таких как Microsoft Visual Studio, Xcode и Eclipse CDT.

Он также может создавать сценарии сборки для:

• MSBuild и Nmake в Windows;
• Unix Make на Unix-подобных платформах, таких как Linux, BSD, macOS и Cygwin;
• А также Ninja, как на Windows, так и на Unix-подобных платформах.

Для упрощения внедрения поддержки CMake в новые ИСР, рекомендуется использовать файлы преднастройки «CMakePresets.json», для более удобного конфигурирования процесса сборки, а также «File API», содержащий всю необходимую для ИСР информацию.

Поддержка компиляторов

CMake позволяет определять свойства, которые компилятор должен поддерживать, чтобы скомпилировать целевую программу или библиотеку.

CMake поддерживает обширный список компиляторов, в который входят:

• Apple Clang;
• Clang;
• GNU GCC;
• MSVC;
• SunPro;
• Intel C++.

Процесс сборки

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

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

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

Типы целей сборки

В зависимости от конфигурации CMakeLists.txt и выбранной цели, файлы сборки могут создавать:

• исполняемые файлы;
• разделяемые библиотеки (например, libxyz, xyz.dll и т. п.);
• библиотеки объектных файлов;
• псевдо цели (включая псевдонимы).

CMake может создавать объектные файлы, которые могут быть связаны с исполняемыми двоичными файлами / библиотеками, избегая динамического (во время выполнения) связывания и вместо этого используя статическое (во время компиляции). Это обеспечивает гибкость в настройке различных оптимизаций (зависимости сборки могут определяться автоматически).

Предкомпилированные заголовочные файлы

Начиная с версии CMake 3.6, можно создавать предварительно скомпилированные заголовочные файлы.

Язык

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

Синтаксис команд

Аргументы команд разделены пробелами и могут содержать ключевые слова, для разделения групп аргументов. Например, в команде

# Команда установки
install(TARGETS ...                # ЦЕЛИ
        CONFIGURATIONS ...         # КОНФИГУРАЦИИ (Debug, Release…)
        RUNTIME DESTINATION ...)   # (Исполняемый файл, MACOSX_BUNDLE, DLL) МЕСТО_НАЗНАЧЕНИЯ

ключевые слова — TARGETS, CONFIGURATIONS и RUNTIME DESTINATION. В данном случае TARGETS и CONFIGURATIONS служат разделителями между «целями» и «конфигурациями».

Примеры команд CMake, которые определяют цели и их зависимости:

• add_executable(...) — определяет цель (исполняемый файл, например .exe, зависит от целевой платформы);
• add_library(...) — определяет цель (библиотеку, например .so или .dll);
• target_link_libraries(...) — определяет зависимости указанной цели.

Поддержка JSON

CMake поддерживает извлечение значений данных в переменные из строк JSON (начиная с версии 3.19).

Модули и инструменты

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

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

CPack

Начиная с версии 2.4.2, в состав CMake включены система автоматизированной сборки пакетов программного обеспечения CPack и модуль CMake для взаимодействия с ней. Система позволяет создавать пакеты программного обеспечения для популярных пакетных менеджеров (DEB, RPM, DMG), средства установки программного обеспечения (NSIS для Microsoft Windows), а также архивы со сборкой (TGZ, TBZ2, ZIP, самораспаковывающийся TGZ).

Программные проекты использующие CMake

CMake получил очень широкое распространение среди проектов с открытым исходным кодом, а также среди коммерческих и академических программных проектов.

Проекты с открытым исходным кодом

• Apache Qpid (система сообщений);
• Boost (набор C++ библиотек);
• Blender (программа 3D моделирования);
• ReactOS (операционная система совместимая с Windows программами и драйверами);
• MySQL (система управления базами данных);
• KDE (среда рабочего стола и смежные проекты);
• KiCad (САПР);
• FreeCAD (САПР);
• WebKit (веб движок);
• Hierarchical Data Format (иерархический формат данных).

Научно исследовательские проекты

Программное обеспечение, используемое в эксперименте ATLAS, создано с использованием CMake. Само программное обеспечение написано на C/C++ и Python.

Исследовательский институт во франции INRIA применил CMake в медицинском исследовании в проекте SOFA.

Компании и проекты с закрытым кодом

• Netflix (стриминговый сервис фильмов и сериалов);
• Second Life (виртуальный мир с элементами социальной сети).

Пример

Пример простого «Hello, World!» проекта на языке CMake.

# Файл — «CMakeLists.txt»

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

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

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

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

install(                                 # Указываем цель и путь установки
  TARGETS ${PROJECT_NAME}                # Путь прибавляется к префиксу
  RUNTIME DESTINATION bin                # bin - binary (путь к исполняемым файлам)
)                                        # Стандартный префикс для UNIX систем
                                         # "/usr/local" + "/bin"

// файл — «main.cpp»

# include <iostream>

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

Сборка осуществляется посредством следующих команд в каталоге с файлами:

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

При этом, есть возможность получить справочную информацию об отдельном элементе языка CMake и его команд.

$ 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 (англ.)