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 Generators удалят 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

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

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

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()