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

Новое в версии 3.2.

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

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

Генераторы Makefile удалят BYPRODUCTS и другие файлы GENERATED во время make clean.

Новое в версии 3.20: Аргументы к BYPRODUCTS могут использовать ограниченный набор generator expressions. Зависимые от целевых выражения не допускаются.

COMMAND

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

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

• Целевой объект не компилируется в другой системе (т.е. переменная CMAKE_CROSSCOMPILING не установлена в true).

• Новое в версии 3.6: Целевой объект компилируется в другой системе, и эмулятор предоставлен (т.е. свойство целевого объекта 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). Они будут обновлены при сборке целевого объекта.

Изменено в версии 3.16: Добавляется зависимость уровня целевого объекта, если какая-либо зависимость является побочным продуктом целевого объекта или любого из его событий сборки в одном каталоге, чтобы гарантировать, что побочные продукты будут доступны перед сборкой этого целевого объекта.

Используйте команду add_dependencies(), чтобы добавить зависимости от других целевых объектов.

COMMAND_EXPAND_LISTS

Новое в версии 3.8.

Списки в COMMAND аргументах будут расширены, включая те, которые созданы с помощью generator expressions, позволяя COMMAND аргументам, таким как ${CC} "-I$<JOIN:$<TARGET_PROPERTY:foo,INCLUDE_DIRECTORIES>,;-I>" foo.cc, быть корректно расширенными.

JOB_POOL

Новое в версии 3.15.

Укажите пул задач pool для генератора Ninja. Несовместимо с USES_TERMINAL, что подразумевает пул console задач. Использование пула задач, который не определен в JOB_POOLS, вызывает ошибку ninja во время сборки.

SOURCES

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

VERBATIM

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

USES_TERMINAL

Новое в версии 3.2.

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

WORKING_DIRECTORY

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

Новое в версии 3.13: Аргументы к WORKING_DIRECTORY могут использовать generator expressions.

Ninja Multi-Config