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 для ссылки на расположение цели позже в командной строке (т.е. в качестве аргумента команды, а не команды для выполнения).

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

• TARGET_FILE
• TARGET_LINKER_FILE
• TARGET_SONAME_FILE
• TARGET_PDB_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.