AUTOMOC

Нужно ли обрабатывать целевой объект с помощью auto-moc (для проектов Qt)?

AUTOMOC — это булево значение, указывающее, будет ли CMake автоматически обрабатывать препроцессор Qt moc, т.е. без необходимости использовать команды, такие как QT4_WRAP_CPP(), QT5_WRAP_CPP(), и т.д. В настоящее время поддерживаются версии Qt с 4 по 6.

Это свойство инициализируется значением переменной CMAKE_AUTOMOC, если она задана при создании целевого объекта.

Когда это свойство установлено ON, CMake будет сканировать заголовочные и исходные файлы во время сборки и вызывать moc соответственно.

Обработка заголовочных файлов

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

• Все заголовочные файлы в исходных файлах целевого объекта добавляются в список сканирования.

• Для всех файлов исходного кода C++ <source_base>.<source_extension> в исходных файлах целевого объекта CMake ищет

  • заголовочный файл с тем же базовым именем (<source_base>.<header_extention>) и
  • заголовочный файл с тем же базовым именем и суффиксом _p (<source_base>_p.<header_extention>)

  и добавляет их в список сканирования.

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

• макрос Qt из AUTOMOC_MACRO_NAMES,
• дополнительные зависимости файлов из аргумента FILE макроса Q_PLUGIN_METADATA и
• дополнительные зависимости файлов, определённые фильтрами в AUTOMOC_DEPEND_FILTERS.

Если макрос Qt найден, заголовочный файл будет скомпилирован инструментом moc в выходной файл moc_<base_name>.cpp. Полный путь к выходному файлу описан в разделе Расположение выходного файла.

Заголовок moc будет перекомпилирован снова, если файл из дополнительных зависимостей файлов изменится.

Выходные файлы заголовочных moc файлов moc_<base_name>.cpp могут быть включены в исходные файлы. Более подробную информацию об этом можно найти в разделе Включение заголовочных файлов moc в исходные файлы.

Обработка файлов исходного кода

Во время сборки CMake сканирует каждый неизвестный или изменённый файл исходного кода C++ из исходных файлов целевого объекта, чтобы найти

• макрос Qt из AUTOMOC_MACRO_NAMES,
• включения заголовочных moc файлов (см. Включение заголовочных файлов moc в исходные файлы),
• дополнительные зависимости файлов из аргумента FILE макроса Q_PLUGIN_METADATA и
• дополнительные зависимости файлов, определённые фильтрами в AUTOMOC_DEPEND_FILTERS.

Если макрос Qt найден, файл исходного кода C++ <base>.<source_extension> должен также содержать оператор включения

#include <<base>.moc> // or
#include "<base>.moc"

Затем файл исходного кода будет скомпилирован инструментом moc в выходной файл <base>.moc. Описание полного пути к выходному файлу находится в разделе Расположение выходного файла.

Исходный код будет moc перекомпилирован снова, если изменится какой-либо файл из дополнительных зависимостей файлов.

Включение заголовочных файлов moc в исходные файлы

Файл исходного кода может включать выходной файл moc заголовочного файла <header_base>.<header_extension> с помощью оператора включения вида

#include <moc_<header_base>.cpp> // or
#include "moc_<header_base>.cpp"

Если выходной файл moc заголовочного файла включён в исходный файл, он будет сгенерирован в другом месте, чем если бы он не был включён. Это описано в разделе Расположение выходного файла.

Расположение выходного файла

Включенные выходные файлы moc

Выходные файлы moc, которые включены в исходный файл, будут сгенерированы в

• <AUTOGEN_BUILD_DIR>/include для генераторов с одной конфигурацией или в
• <AUTOGEN_BUILD_DIR>/include_<CONFIG> для генераторов multi configuration.

Где <AUTOGEN_BUILD_DIR> — значение свойства целевого объекта AUTOGEN_BUILD_DIR.

Директория включения автоматически добавляется в INCLUDE_DIRECTORIES целевого объекта.

Не включенные выходные файлы moc

Выходные файлы moc, которые не включены в исходный файл, будут сгенерированы в

• <AUTOGEN_BUILD_DIR>/<SOURCE_DIR_CHECKSUM> для генераторов с одной конфигурацией или в,
• <AUTOGEN_BUILD_DIR>/include_<CONFIG>/<SOURCE_DIR_CHECKSUM> для генераторов multi configuration.

Где <SOURCE_DIR_CHECKSUM> — контрольная сумма, вычисленная из пути к родительской директории файла moc входного файла. Эта схема позволяет иметь moc входные файлы с одинаковым именем в разных директориях.

Все не включенные выходные файлы moc будут автоматически включены файлом, сгенерированным CMake

• <AUTOGEN_BUILD_DIR>/mocs_compilation.cpp, или
• <AUTOGEN_BUILD_DIR>/mocs_compilation_$<CONFIG>.cpp,

который добавлен в исходные файлы целевого объекта.

Обнаружение версии Qt

AUTOMOC-разрешенные целевые объекты должны знать, с какой главной и дополнительной версиями Qt они работают. Главную версию обычно предоставляет свойство INTERFACE_QT_MAJOR_VERSION библиотеки Qt[456]Core, к которой ссылается целевой объект. Чтобы найти дополнительную версию, CMake строит список доступных версий Qt из

• Qt6Core_VERSION_MAJOR и Qt6Core_VERSION_MINOR переменных (обычно устанавливаются find_package(Qt6...))
• Qt6Core_VERSION_MAJOR и Qt6Core_VERSION_MINOR свойств директорий
• Qt5Core_VERSION_MAJOR и Qt5Core_VERSION_MINOR переменных (обычно устанавливаются find_package(Qt5...))
• Qt5Core_VERSION_MAJOR и Qt5Core_VERSION_MINOR свойств директорий
• QT_VERSION_MAJOR и QT_VERSION_MINOR переменных (обычно устанавливаются find_package(Qt4...))
• QT_VERSION_MAJOR и QT_VERSION_MINOR свойств директорий

в контексте вызова add_executable() или add_library().

Предполагается, что INTERFACE_QT_MAJOR_VERSION — это допустимое число. Первый элемент в списке с соответствующей главной версией берется. Если не найдена соответствующая главная версия, генерируется ошибка. Если INTERFACE_QT_MAJOR_VERSION не является допустимым числом, берется первый элемент в списке.

Вызов find_package(Qt[456]...) устанавливает переменные QT/Qt[56]Core_VERSION_MAJOR/MINOR. Если вызов находится в другом контексте, отличном от add_executable() или add_library(), например, в функции, то переменные версии могут быть недоступны для целевого объекта с включённым AUTOMOC. В этом случае переменные версии могут быть переданы из контекста вызова find_package(Qt[456]...) в контекст вызова add_executable() или add_library() в качестве свойств директорий. Следующий пример Qt5 демонстрирует эту процедуру.

function (add_qt5_client)
  find_package(Qt5 REQUIRED QUIET COMPONENTS Core Widgets)
  ...
  set_property(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
    PROPERTY Qt5Core_VERSION_MAJOR "${Qt5Core_VERSION_MAJOR}")
  set_property(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
    PROPERTY Qt5Core_VERSION_MINOR "${Qt5Core_VERSION_MAJOR}")
  ...
endfunction ()
...
add_qt5_client()
add_executable(myTarget main.cpp)
target_link_libraries(myTarget Qt5::QtWidgets)
set_property(TARGET myTarget PROPERTY AUTOMOC ON)

Модификаторы

AUTOMOC_EXECUTABLE: Исполняемый файл moc будет обнаружен автоматически, но может быть принудительно назначен определённому бинарнику с помощью этого свойства целевого объекта.

AUTOMOC_MOC_OPTIONS: Дополнительные параметры командной строки для moc могут быть заданы в этом свойстве целевого объекта.

AUTOMOC_MACRO_NAMES: Этот список имён макросов Qt может быть расширен для поиска дополнительных макросов в заголовочных и исходных файлах.

AUTOMOC_DEPEND_FILTERS: Имена файлов зависимостей moc могут быть извлечены из заголовочных или исходных файлов путём определения фильтров имён файлов в этом свойстве целевого объекта.

AUTOMOC_COMPILER_PREDEFINES: Препроцессорные определения компилятора для moc записываются в файл moc_predefs.h. Генерация этого файла может быть включена или выключена в этом свойстве целевого объекта.

SKIP_AUTOMOC: Источники и заголовки могут быть исключены из обработки AUTOMOC, установив это свойство файла-источника.

SKIP_AUTOGEN: Файлы-источники могут быть исключены из обработки AUTOMOC, AUTOUIC и AUTORCC, установив это свойство файла-источника.

AUTOGEN_SOURCE_GROUP: Это глобальное свойство может использоваться для группирования файлов, сгенерированных AUTOMOC или AUTORCC вместе в интегрированной среде разработки, например, в MSVS.

AUTOGEN_TARGETS_FOLDER: Это глобальное свойство может использоваться для группирования целей AUTOMOC, AUTOUIC и AUTORCC вместе в интегрированной среде разработки, например, в MSVS.

CMAKE_GLOBAL_AUTOGEN_TARGET: Глобальная autogen цель, зависящая от всех сгенерированных AUTOMOC или AUTOUIC целей в проекте, будет сгенерирована, когда эта переменная ON.

AUTOGEN_PARALLEL: Это свойство цели управляет количеством moc или uic процессов, которые будут запускаться параллельно во время сборки.

См. руководство cmake-qt(7) для получения дополнительной информации об использовании CMake с Qt.