add_custom_target

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

add_custom_target(Name [ALL] [command1 [args1...]]
                  [COMMAND command2 [args2...] ...]
                  [DEPENDS depend depend depend ... ]
                  [BYPRODUCTS [files...]]
                  [WORKING_DIRECTORY dir]
                  [COMMENT comment]
                  [VERBATIM] [USES_TERMINAL]
                  [SOURCES src1 [src2...]])

Добавляет целевой объект с заданным именем, который выполняет заданные команды. Целевой объект не имеет выходного файла и всегда считается устаревшим, даже если команды пытаются создать файл с именем целевого объекта. Используйте команду add_custom_command(), чтобы сгенерировать файл с зависимостями. По умолчанию ничто не зависит от пользовательского целевого объекта. Используйте команду add_dependencies(), чтобы добавить зависимости к другим целевым объектам или от них.

Параметры:

ALL

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

BYPRODUCTS

Указывает файлы, которые, как ожидается, будут созданы командой, но время их изменения может или не может обновляться при последующих сборках. Если имя побочного продукта — относительный путь, оно будет интерпретироваться относительно каталога дерева сборки, соответствующего текущей директории исходного кода. Каждый файл побочного продукта будет автоматически помечен свойством файла-источника GENERATED.

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

Параметр BYPRODUCTS игнорируется в генераторах, отличных от Ninja, за исключением маркировки побочных продуктов GENERATED.

COMMAND

Указывает командную строку(и) для выполнения во время сборки. Если указано более одной COMMAND, они будут выполняться в порядке, но не обязательно объединяться в состояние shell или пакетный скрипт. (Для запуска полного скрипта используйте команду configure_file() или команду file(GENERATE) для его создания, а затем укажите COMMAND для запуска.)

Если COMMAND указывает имя целевого объекта исполняемого файла (созданного с помощью команды add_executable()), он будет автоматически заменен местоположением исполняемого файла, созданного во время сборки. Если установлено, свойство целевого объекта исполняемого файла CROSSCOMPILING_EMULATOR также будет добавлено перед командой, чтобы позволить исполняемому файлу работать на хосте. Кроме того, будет добавлена зависимость на уровне целевого объекта, чтобы исполняемый целевой объект был собран до этого пользовательского целевого объекта.

Аргументы к COMMAND могут использовать generator expressions. Ссылки на имена целевых объектов в выражениях генератора подразумевают зависимости на уровне целевого объекта.

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

COMMENT

Вывести заданное сообщение перед выполнением команд во время сборки.

DEPENDS

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

Используйте команду add_dependencies() для добавления зависимостей от других целевых объектов.

SOURCES

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

VERBATIM

Все аргументы команд будут корректно экранированы для инструмента сборки, чтобы вызываемая команда получала каждый аргумент без изменений. Обратите внимание, что один уровень экранирования по-прежнему используется процессором языка CMake перед тем, как add_custom_target даже увидит аргументы. Рекомендуется использование VERBATIM, так как это обеспечивает корректное поведение. Если VERBATIM не указано, поведение зависит от платформы, поскольку нет защиты от специальных символов, специфичных для инструмента.

USES_TERMINAL

Если возможно, команде будет предоставлен прямой доступ к терминалу. С генератором Ninja, это помещает команду в console пул задач pool.

WORKING_DIRECTORY

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