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

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