add_custom_target

Добавить цель без вывода, чтобы она всегда компилировалась.

add_custom_target(Name [ALL] [command1 [args1...]]
                  [COMMAND command2 [args2...] ...]
                  [DEPENDS depend depend depend ... ]
                  [BYPRODUCTS [files...]]
                  [WORKING_DIRECTORY dir]
                  [COMMENT comment]
                  [VERBATIM] [USES_TERMINAL]
                  [COMMAND_EXPAND_LISTS]
                  [SOURCES src1 [src2...]])

Добавляет цель с заданным именем, которая выполняет заданные команды. Цель не имеет файла вывода и всегда считается устаревшей, даже если команды пытаются создать файл с именем цели. Используйте команду add_custom_command(), чтобы сгенерировать файл с зависимостями. По умолчанию ничто не зависит от пользовательской цели. Используйте команду add_dependencies(), чтобы добавить зависимости к или от других целей.

Опции:

ALL

Указывает, что эта цель должна быть добавлена в целевую сборку по умолчанию, чтобы она выполнялась каждый раз (команда не может быть вызвана ALL).

BYPRODUCTS

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

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

Опция BYPRODUCTS игнорируется в генераторах, не являющихся Ninja, за исключением обозначения побочных продуктов GENERATED.

COMMAND

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

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

Аргументы к COMMAND могут использовать generator expressions. Ссылки на имена целей в выражениях генератора подразумевают зависимости на уровне цели.

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

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.

SOURCES

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

VERBATIM

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

USES_TERMINAL

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

WORKING_DIRECTORY

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