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, они будут выполняться в порядке, но не обязательно объединятся в состоятельный командный интерпретатор или пакетную программу. (Чтобы запустить полную программу, используйте команду 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()