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

Опция 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, для правильного расширения.

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.