AUTOMOC

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

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

Это свойство инициализируется значением переменной 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,

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

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

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

• 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[45]...) устанавливает переменные QT/Qt5Core_VERSION_MAJOR/MINOR. Если вызов находится в другом контексте, чем вызов add_executable() или add_library(), например, в функции, то переменные версии могут быть недоступны для целевого объекта, включившего AUTOMOC. В этом случае переменные версии могут быть пересланы из контекста вызова find_package(Qt[45]...) в контекст вызова 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 вместе в IDE, например, в MSVS.

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

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

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

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