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.

См. политику CMP0058 для мотивации этой функции.

Явное указание побочных продуктов поддерживается генератором 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