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]
                  [JOB_SERVER_AWARE <bool>]
                  [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 Generators удалят BYPRODUCTS и другие файлы GENERATED во время make clean.

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

Изменено в версии 3.28: В настраиваемых целевых объектах, использующих Наборы файлов, побочные продукты теперь считаются частными, если они не указаны в наборе файлов, не являющемся частным. См. политику CMP0154.

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

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

Добавлено в версии 3.26: Аргументы к COMMENT могут использовать generator expressions.

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 во время сборки.

JOB_SERVER_AWARE

Добавлено в версии 3.28.

Указывает, что команда поддерживает сервер задач GNU Make.

Для генераторов Unix Makefiles, MSYS Makefiles и MinGW Makefiles это добавит префикс + к строке рецепта. См. документацию GNU Make для получения дополнительной информации по GNU Make Documentation.

Этот параметр будет проигнорирован другими генераторами.

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

См. также

• add_custom_command()