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, они будут выполнены в порядке следования, но не обязательно объединятся в состояние скрипта оболочки или пакетного скрипта. (Для выполнения полного скрипта используйте команду configure_file() или команду file(GENERATE) для его создания, а затем укажите COMMAND для запуска.)

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

Аргументы к 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

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