Сборка проектов с CMake. Введение в блоге Личный опыт разработки ПО

Для автоматизации сборки проектов традиционно используют системы сборки, такие как make на Unix подобных системах и nmake для компилятора Microsoft. Также традиционно написание файлов для сборки проекта под эти системы является задачей нетривиальной. Конечно в пользуясь только Mictosoft Visual Studio можно даже не подозревать о существовании этих файлов, так как интегрированная среда разработки достаточно удобно скрывает всю кухню, оставляя снаружи несколько диалоговых окон и кнопку Build. Но для сложных проектов использующих массу сторонних библиотек и кроссплатформенных проектов такой подход часто оказывается неприемлемым.

Кратко говоря make-файл представляет из себя описания последовательности действий необходимых для того чтобы достичь какой либо цели, например скомпилировать программу. На псевдокоде это может выглядеть примерно так:

Что нужно сделать?

Собрать программу hello_world.

Как ее делать?

Взять файлы hello_world.h и hello_world.cpp и запустить компилятор передав их в качестве параметров.

Что делать когда компилятор закончит работать?

Взять получившийся в результате работы компилятора объектный файлы hello_world.o и запустить линковщик передав ему этот файл.

Все.

Причем каждый подпроект может иметь свой файл сборки, а главный make-файл сможет пройти рекурсивно по подпроектам, выполнив его файл сборки, а потом собрать проект из этих компонентов.

Выглядит все просто, проблемы возникают дальше и проблем несколько:

Разрешение зависимостей возникающих между частями проекта
Синтаксическая сложность и неоднозначность классических make-файлов
Привязка к конкретной утилите автоматической сборки и как следствие непереносимость на другие платформы

Для решения части этих проблем или всех сразу были созданы следующие инструменты: Automake (http://sourceware.org/automake/) , CMake (http://www.cmake.org/), SCons (http://www.scons.org/). Список далеко не полный.

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

Сам CMake не осуществляет сборку проекта, он лишь генерирует из своего файла сборки make-файл для конкретной платформы. Это может быть проект Microsoft Visual Studio, NMake makefile, проект XCode для MacOS, Unix makefile, Watcom makefile, проект Eclipse или CodeBlocks. Более того файлы CMake открывает как проект набирающая популярность среда разработки QtCreator.

Данный файл обычно называется CMakeLists.txt и содержит команды понятные CMake. Выполнив

cmake CMakeLists.txt

Мы получим либо проект который можно открыть в вашей среде разработки, либо makefile по которому можно собрать проект запустив соответствующую систему сборки (make, nmake, wmake). Всегда можно явно указать, что должна генерировать программа, указав ключ –G с нужным параметром (просто запустите cmake, чтобы увидеть доступные варианты).

Где взять CMake?

Дистрибутив CMake можно скачать с официального сайта (http://cmake.org/cmake/resources/software.html) где есть версии для всех популярных платформ или установить из репозитория вашего дистрибутива Linux, скорее всего он там уже есть.

Hello, World!

Предлагаю рассмотреть простой CMake-файл:

cmake_minimum_required (VERSION 2.6) 
 
set (PROJECT hello_world) 
 
project (${PROJECT}) 
 
set (HEADERS 
	hello.h)
 
set (SOURCES 
	hello.cpp
	main.cpp) 
 
add_executable (${PROJECT} ${HEADERS} ${SOURCES})

Что здесь происходит?

В первой строке просто указана минимальная версия CMake необходимая для успешной интерпретации файла.
В третьей строке определяется переменная PROJECT и ей задается значение hello_world — так будет называться наша программа.
О чем и говорится в пятой строке. Конструкция ${ИМЯ_ПЕРЕМЕННОЙ} возвращает значение переменной, таким образом проект будет называться hello_world.
В седьмой и десятой строках вводятся переменные содержащие список файлов необходимых для сборки проекта.
И в последней строке идет команда собрать исполняемый файл с именем указанном в переменной PROJECT и из файлов имена которых находятся в переменных HEADERS и SOURCES.

Здесь написано больше, чем требует CMake, но зато этот шаблон удобно использовать где угодно, для этого достаточно изменить название проекта и имена файлов.

Как собрать библиотеку с CMake?

Точно также как и исполняемый файл, но в последней строке вместо команды add_executable, укажите команду add_library. В этом случае будет собрана статическая библиотека, для сборки динамической библиотеки надо указать параметр SHARED после имени библиотеки:

add_library (${PROJECT} SHARED ${HEADERS} ${SOURCES})

Немного о стиле

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

Имена переменных пишутся английскими буквами в верхнем регистре
Команды CMake записываются английскими буквами в нижнем регистре
Параметры команд CMake пишутся английскими буквами в верхнем регистре
Команды CMake отделены пробелом от открывающей скобки

Где должен находится CMakeLists.txt?

Очень удобно в корне каждого проекта иметь директорию build с файлами сборки проекта, причем имя файла во всех директориях должно называться одинаково (название по умолчанию CMakeLists.txt отлично подойдет). Это позволит собирать сложные проекты рекурсивно подключая директории с подпроектами (о подключении подпроектов к проекту можно прочесть в моей заметке).

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

Сборка сложного проекта

Усложним задачу и соберем проект зависящий от библиотеки. Для этого надо сделать следующие вещи:

Собрать библиотеку
Подключить библиотеку к проекту

С пунктом 1 сложностей возникнуть не должно, о том как собрать исполняемый файл или библиотеку написано выше.

Теперь о том как эту библиотеку подключить. Сделать это можно добавив в CMakeLists.txt проекта три строки:

1
2
3

include_directories (../)
add_subdirectory (../ИМЯ_БИБЛИОТЕКИ/build bin/ИМЯ_БИБЛИОТЕКИ)
target_link_libraries (${PROJECT} ИМЯ_БИБЛИОТЕКИ)

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

Во второй строке идет указание CMake взять файл из директории build подпроекта, выполнить его и результат работы положить в директорию ./bin/ИМЯ_БИБЛИОТЕКИ.

Третья строка должна быть в файле после команды add_executable и указывает, что проект надо линковать вместе с указанной библиотекой.

Можно добавлять эти команды вручную, но я предлагаю изменить шаблон, чтобы было можно изменять только одну строку, указывая имя библиотеки:

cmake_minimum_required (VERSION 2.6)
 
set (PROJECT ИМЯ_ПРОЕКТА)
 
project (${PROJECT})
 
include_directories (../)
 
set (LIBRARIES
		ИМЯ_БИБЛИОТЕКИ_1
		ИМЯ_БИБЛИОТЕКИ_2)
 
foreach (LIBRARY ${LIBRARIES})
	add_subdirectory (../${LIBRARY}/build bin/${LIBRARY})
endforeach ()
 
set (HEADERS
		../ЗАГОЛОВОЧНЫЕ_ФАЙЛЫ)
set (SOURCES 
		../ФАЙЛЫ_С_РЕАЛИЗАЦИЕЙ)
 
add_executable (${PROJECT} ${HEADERS} ${SOURCES})
 
target_link_libraries (${PROJECT} ${LIBRARIES})

Остальные вопросы

Все хорошо, но почему в проекте Microsoft Visual Studio не показаны заголовочные файлы?

Это можно исправить добавив в файл две строки:

1 2	source_group ("Header Files" FILES ${HEADERS}) source_group ("Source Files" FILES ${SOURCES})

На работу CMake при генерации файлы для других систем это никак не повлияет.

Почему я не вижу предупреждений компилятора (warnings)?

Предупреждения можно включить следующим образом (пример для MS VS и GCC):

if (MSVC)
	add_definitions (/W4)
elseif (CMAKE_COMPILER_IS_GNUCXX)
	add_definitions (-Wall -pedantic)
else ()
	message ("Unknown compiler")
endif ()

На этом беглый обзор считаю можно закончить. Подробнее о CMake читайте в следующих заметках, в частности о подключении библиотек Qt и Boost.

Файл с примером

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

Скачать пример

Личный опыт разработки ПО