CMake

Материал из Википедии — свободной энциклопедии
Это старая версия этой страницы, сохранённая Dr64h (обсуждение | вклад) в 14:43, 23 марта 2022 (→Синтаксис команд). Она может серьёзно отличаться от текущей версии.
Перейти к навигации Перейти к поиску
CMake
Логотип программы CMake
Скриншот программы CMake
Тип система сборки[вд], свободное и открытое программное обеспечение и утилита
Автор Kitware[вд]
Разработчики Kitware[вд], Александр Нойндорф[вд], Кен Мартин[вд], Андрей Седильник[вд], Уильям Хоффман[вд] и Брэд Кинг[вд]
Написана на C++ и Си[3]
Интерфейс Qt[4][5][…]
Операционные системы Unix-подобная операционная система[6] и Windows[6]
Языки интерфейса английский
Первый выпуск 2000
Аппаратная платформа кроссплатформенность[7]
Последняя версия
Кандидат в релизы
Репозиторий gitlab.kitware.com/cmake…
Состояние активное
Лицензия модифицированная лицензия BSD[вд][8][9][…]
Сайт 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[англ.][10]. Проект финансируемый национальной библиотекой медицины США, как часть проекта «Visible Human Project[англ.]». Задача по разработке была возложена на небольшую компанию Kitware[англ.]. На него повлияла более ранняя система под названием pcmaker, созданная Кеном Мартином (Ken Martin) и другими разработчиками для поддержки инструментария визуализации (VTK)[11].

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

Возможности

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

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

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»[15], для более удобного конфигурирования процесса сборки, а также «File API»[16], содержащий всю необходимую для ИСР информацию.

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

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

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

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

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

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

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

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

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

Язык

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

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

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

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

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

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

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

Поддержка JSON

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

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

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

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

CPack

Основная статья: CPack

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

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

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

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

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

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

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

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

Пример

Далее приведён пример простого «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(                                 # Указываем цель и путь установки
  TARGETS ${PROJECT_NAME}                # Путь прибавляется к префиксу
  RUNTIME DESTINATION bin                # bin - binary (путь к исполняемым файлам)
)                                        # Стандартный префикс для UNIX систем
                                         # "/usr/local" + "/bin"

В этом же каталоге создаём файл — «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

См. также

Примечания

  1. ↑ CMake 3.31.2 available for download (англ.) — 2024.
  2. ↑ CMake 3.31.0-rc3 is ready for testing (англ.) — 2024.
  3. ↑ The cmake Open Source Project on Open Hub: Languages Page — 2006.
  4. ↑ https://cmake.org/cmake/help/latest/manual/cmake-gui.1.html
  5. ↑ https://cmake.org/runningcmake
  6. ↑ 1 2 https://cmake.org/download/
  7. ↑ https://cmake.org/
  8. ↑ https://gitlab.kitware.com/cmake/cmake/blob/master/Copyright.txt
  9. ↑ The cmake Open Source Project on Open Hub: Licenses Page — 2006.
  10. ↑ FLOSS Weekly 111: CMake (англ.). podcast. TWiT Network.. Дата обращения: 19 января 2022.
  11. ↑ About CMake (англ.). cmake.org. Дата обращения: 15 марта 2022.
  12. ↑ Перевод главы о CMake из книги «The Architecture of Open Source Applications». rus-linux.net (28 августа 2012). Дата обращения: 19 января 2022.
  13. ↑ Глава о CMake из книги «The Architecture of Open Source Applications» (англ.). aosabook.org (2012). Дата обращения: 19 января 2022.
  14. ↑ 1 2 Александр Нойндорф (Alexander Neundorf). Why the KDE project switched to CMake — and how (англ.). lwn.net (21 июня 2006). Дата обращения: 19 января 2022.
  15. ↑ CMake documentation: IDE Integration Guide (англ.). cmake.org. Дата обращения: 26 января 2022.
  16. ↑ CMake documentation: cmake-file-api(7) (англ.). cmake.org. Дата обращения: 26 января 2022.
  17. ↑ CMake documentation: cmake-toolchains(7) (англ.). cmake.org. Дата обращения: 19 января 2022.
  18. ↑ Дэниел Пфайфер (Daniel Pfeifer). Effective CMake (англ.) (PDF). GitHub (19 мая 2017). Дата обращения: 19 января 2022.
  19. ↑ CMake documentation: cmake-buildsystem(7) — Object Libraries (англ.). cmake.org. Дата обращения: 19 января 2022.
  20. ↑ CMake documentation: target precompile headers (англ.). cmake.org. Дата обращения: 19 января 2022.
  21. ↑ CMake documentation: cmake-language(7) (англ.). cmake.org. Дата обращения: 19 января 2022.
  22. ↑ Андрей Седильник (Andrej Cedilnik). Cross-Platform Software Development Using CMake (англ.). linuxjournal (3 октября 2003). Дата обращения: 19 января 2022.
  23. ↑ CMake documentation: cmake-commands(7) ― add_executable (англ.). cmake.org. Дата обращения: 19 января 2022.
  24. ↑ CMake documentation: cmake-commands(7) ― add_library (англ.). cmake.org. Дата обращения: 19 января 2022.
  25. ↑ CMake documentation: cmake-commands(7) ― target_link_libraries (англ.). cmake.org. Дата обращения: 19 января 2022.
  26. ↑ CMake documentation: CMake 3.19 Release Notes (англ.). cmake.org. Дата обращения: 19 января 2022.
  27. ↑ CMake documentation: cmake-modules(7) (англ.). cmake.org. Дата обращения: 19 января 2022.
  28. ↑ CMake documentation: cmake-modules(7) — ExternalProject (англ.). cmake.org. Дата обращения: 19 января 2022.
  29. ↑ CMake:Packaging With CPack - KitwarePublic (англ.). GitLab. Дата обращения: 19 января 2022.
  30. ↑ CMake:CPackPackageGenerators - KitwarePublic (англ.). GitLab. Дата обращения: 19 января 2022.
  31. ↑ Blender wiki — Building Blender (англ.). blender.org. Дата обращения: 19 января 2022.
  32. ↑ KDE Adopts CMake (англ.). kitware.com. Дата обращения: 15 марта 2022.
  33. ↑ J. Elmsheuser, A. Krasznahorkay, E. Obreshkov, A. Undrus. Large Scale Software Building with CMake in ATLAS (англ.) (PDF). ЦЕРН. Дата обращения: 19 января 2022.
  34. ↑ Converting SOFA to CMake (англ.). kitware.com. Дата обращения: 15 марта 2022.
  35. ↑ CMake, CTest, and CDash at Netflix (англ.). kitware.com. Дата обращения: 15 марта 2022.
  36. ↑ Second Life Chooses CMake as its Build System (англ.). kitware.com. Дата обращения: 15 марта 2022.

Ссылки

Источник — https://ru.wikipedia.org/ruwiki/w/index.php?title=CMake&oldid=120868886