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

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

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

COMMAND

Укажите командную строку(и) для выполнения во время сборки. Если указано более одной COMMAND, они будут выполняться в порядке, но не обязательно объединяться в состоятельное командное или пакетное script. (Для запуска полного скрипта используйте команду 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 для получения дополнительной информации.

Этот параметр молча игнорируется другими генераторами.

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