AUTOMOC

Необходимо ли обрабатывать целевой объект с помощью auto-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

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

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

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

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

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

#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 автоматически добавляется в 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[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 цель, которая зависит от всех сгенерированных <ORIGIN>_autogen целевых объектов AUTOMOC или AUTOUIC в проекте, будет сгенерирована, когда эта переменная ON.

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

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