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.