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

Указывает файлы, которые, как ожидается, будут созданы командой, но время модификации которых может или не может обновляться при последующих сборках. Если имя побочного продукта — относительный путь, оно будет интерпретироваться относительно каталога дерева сборки, соответствующего текущему каталогу исходных файлов. Каждый файл побочного продукта будет автоматически помечен свойством исходного файла GENERATED.

Явное указание побочных продуктов поддерживается генератором Ninja, чтобы сообщить инструменту сборки ninja о том, как перегенерировать побочные продукты, если они отсутствуют. Это также полезно, когда другие правила сборки (например, пользовательские команды) зависят от побочных продуктов. Ninja требует правила сборки для любого сгенерированного файла, от которого зависит другое правило, даже если есть только зависимость по порядку, чтобы гарантировать, что побочные продукты будут доступны перед сборкой их зависимых.

COMMAND

Указывает команду(ы) командной строки для выполнения во время сборки. Если указано более одной COMMAND, они будут выполняться в порядке, но не обязательно составляться в состоятельный командный интерпретатор или пакетный скрипт. (Чтобы запустить полный скрипт, используйте команду configure_file() или команду file(GENERATE) для его создания, а затем укажите COMMAND для запуска.)

Если COMMAND указывает имя исполняемого файла цели (созданное командой add_executable()), оно будет автоматически заменено расположением исполняемого файла, созданного во время сборки, если верно одно из следующих условий:

• Цель не компилируется кросс-платформенно (т.е. переменная CMAKE_CROSSCOMPILING не установлена в true).
• Цель компилируется кросс-платформенно и эмулятор предоставлен (т.е. свойство цели CROSSCOMPILING_EMULATOR установлено). В этом случае содержимое CROSSCOMPILING_EMULATOR будет добавлено в начало команды перед расположением исполняемого файла цели.

Если ни одно из вышеперечисленных условий не выполняется, предполагается, что имя команды — это программа, которую нужно найти в PATH во время сборки.

Аргументы COMMAND могут использовать generator expressions. Используйте выражение генератора TARGET_FILE, чтобы сослаться на расположение цели в командной строке позже (т.е. в качестве аргумента команды, а не как команды для выполнения).

Всякий раз, когда цель используется в качестве команды для выполнения или упоминается в выражении генератора в качестве аргумента команды, автоматически добавляется зависимость уровня цели, чтобы указанная цель была скомпилирована до этой пользовательской цели.

Команда и аргументы являются необязательными, и если они не указаны, будет создана пустая цель.

COMMENT

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

DEPENDS

Ссылки на файлы и выходные данные пользовательских команд, созданных вызовами команды add_custom_command() в том же каталоге (файл CMakeLists.txt). Они будут обновлены при сборке цели. Зависимость уровня цели добавляется, если какая-либо зависимость является побочным продуктом цели или любого из её событий сборки в том же каталоге, чтобы гарантировать, что побочные продукты будут доступны перед сборкой этой цели.

Используйте команду add_dependencies(), чтобы добавить зависимости от других целей.

COMMAND_EXPAND_LISTS

Списки в аргументах COMMAND будут расширяться, включая те, которые созданы с помощью generator expressions, что позволяет расширять аргументы COMMAND, такие как ${CC} "-I$<JOIN:$<TARGET_PROPERTY:foo,INCLUDE_DIRECTORIES>,;-I>" foo.cc.

JOB_POOL

Указать pool для генератора Ninja. Несовместимо с USES_TERMINAL, что подразумевает пул console . Использование пула, не определенного JOB_POOLS, вызывает ошибку ninja во время сборки.

SOURCES

Указать дополнительные исходные файлы для включения в пользовательскую цель. Указанные исходные файлы будут добавлены в файлы проектов IDE для удобства редактирования, даже если у них нет правил сборки.

VERBATIM

Все аргументы команд будут правильно экранированы для инструмента сборки, чтобы вызываемая команда получала каждый аргумент без изменений. Обратите внимание, что один уровень экранирования всё ещё используется процессором языка CMake перед тем, как add_custom_target даже увидит аргументы. Рекомендуется использовать VERBATIM, так как это обеспечивает правильное поведение. Когда VERBATIM не указан, поведение зависит от платформы, поскольку нет защиты от специфичных для инструмента специальных символов.

USES_TERMINAL

Команда получит прямой доступ к терминалу, если это возможно. С генератором Ninja это помещает команду в console pool.

WORKING_DIRECTORY

Выполнить команду с заданным текущим рабочим каталогом. Если это относительный путь, он будет интерпретироваться относительно каталога дерева сборки, соответствующего текущему каталогу исходных файлов.

Аргументы WORKING_DIRECTORY могут использовать generator expressions.