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

См. также

• Добавить пользовательскую команду