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 требует правила сборки для любого сгенерированного файла, от которого зависит другое правило, даже если существуют только зависимости по порядку, чтобы гарантировать, что побочные продукты будут доступны до сборки их зависимых.

Генераторы Makefile удалят BYPRODUCTS и другие файлы GENERATED во время make clean.

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.