add_custom_target

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

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

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

Параметры:

ALL

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

BYPRODUCTS

Новое в версии 3.2.

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

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

Генераторы Makefile удалят BYPRODUCTS и другие файлы GENERATED во время make clean.

Новое в версии 3.20: Аргументы для BYPRODUCTS могут использовать ограниченный набор generator expressions. Выражения, зависящие от целевых объектов запрещены.

COMMAND

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

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

• Целевой объект не компилируется в другой системе (т.е. переменная CMAKE_CROSSCOMPILING не установлена в значение true).

• Новое в версии 3.6: Целевой объект компилируется в другой системе, и предоставляется эмулятор (т.е. свойство целевого объекта CROSSCOMPILING_EMULATOR установлено). В этом случае содержимое CROSSCOMPILING_EMULATOR будет добавлено в начало команды перед расположением исполняемого файла целевого объекта.

Если ни одно из вышеперечисленных условий не выполнено, предполагается, что имя команды является программой, которая должна быть найдена в PATH во время сборки.

Аргументы для COMMAND могут использовать generator expressions. Используйте выражение генератора TARGET_FILE, чтобы сослаться на расположение целевого объекта в командной строке позже (т.е. как аргумент команды, а не как команду для выполнения).

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

• TARGET_FILE
• TARGET_LINKER_FILE
• TARGET_SONAME_FILE
• TARGET_PDB_FILE

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

COMMENT

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

DEPENDS

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

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

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

COMMAND_EXPAND_LISTS

Новое в версии 3.8.

Списки в COMMAND аргументах будут расширены, включая те, что созданы с помощью generator expressions, позволяя COMMAND аргументам, таким как ${CC} "-I$<JOIN:$<TARGET_PROPERTY:foo,INCLUDE_DIRECTORIES>,;-I>" foo.cc, правильно расширяться.

JOB_POOL

Новое в версии 3.15.

Укажите pool для генератора Ninja. Несовместимо с USES_TERMINAL, что подразумевает пул console . Использование пула, который не определён JOB_POOLS, приводит к ошибке ninja при сборке.

SOURCES

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

VERBATIM

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

USES_TERMINAL

Новое в версии 3.2.

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

WORKING_DIRECTORY

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

Новое в версии 3.13: Аргументы для WORKING_DIRECTORY могут использовать generator expressions.

Ninja Multi-Config