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

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

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