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 Многоконфигурационный