message

Запись сообщения.

Синопсис

General messages
  message([<mode>] "message text" ...)

Reporting checks
  message(<checkState> "message text" ...)

Общие сообщения

message([<mode>] "message text" ...)

Запишите указанный текст сообщения в журнал. Если передано более одной строки сообщения, они конкатенируются в одно сообщение без разделителей между строками.

Необязательное ключевое слово <mode> определяет тип сообщения, который влияет на способ обработки сообщения:

FATAL_ERROR

Ошибка CMake, остановка обработки и генерации.

SEND_ERROR

Ошибка CMake, продолжение обработки, но пропуск генерации.

WARNING

Предупреждение CMake, продолжение обработки.

AUTHOR_WARNING

Предупреждение CMake (dev), продолжение обработки.

DEPRECATION

Ошибка или предупреждение о устаревании CMake, если переменная CMAKE_ERROR_DEPRECATED или CMAKE_WARN_DEPRECATED соответственно включены, в противном случае сообщение не выводится.

(none) or NOTICE

Важное сообщение, выводимое на stderr, чтобы привлечь внимание пользователя.

STATUS

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

VERBOSE

Подробные информационные сообщения, предназначенные для пользователей проекта. Эти сообщения должны предоставлять дополнительные детали, которые в большинстве случаев не будут интересны, но которые могут быть полезны для разработчиков проекта, когда они хотят более глубоко понять происходящее.

DEBUG

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

TRACE

Подробные сообщения с очень низкоуровневыми деталями реализации. Сообщения с таким уровнем детализации обычно носят временный характер и должны быть удалены перед выпуском проекта, упаковкой файлов и т. д.

Инструмент CMake командной строки отображает сообщения STATUS до TRACE на stdout, с сообщением, предваряемым двумя дефисами и пробелом. Все остальные типы сообщений отправляются в stderr и не предваряются дефисами. CMake GUI отображает все сообщения в своей области журнала. curses interface показывает сообщения STATUS до TRACE по одному в строке состояния и другие сообщения в интерактивном всплывающем окне. Опция командной строки --log-level для каждого из этих инструментов может использоваться для управления отображаемыми сообщениями. Чтобы сохранить уровень журнала между запусками CMake, можно установить переменную CMAKE_MESSAGE_LOG_LEVEL. Обратите внимание, что опция командной строки имеет приоритет над переменной кэша.

Сообщения уровней журнала NOTICE и ниже будут иметь каждую строку, предваряемую содержимым переменной CMAKE_MESSAGE_INDENT (преобразованным в одну строку путем конкатенации элементов списка). Для сообщений STATUS до TRACE это отступы будут вставлены после дефисов.

Сообщения уровней журнала NOTICE и ниже также могут иметь каждую строку, предваряемую контекстом в формате [some.context.example]. Содержимое в квадратных скобках получается путем преобразования переменной списка CMAKE_MESSAGE_CONTEXT в строку, разделенную точками. Контекст сообщения всегда будет отображаться перед любым отступающим содержимым, но после автоматически добавленных ведущих дефисов. По умолчанию контекст сообщения не отображается, он должен быть явно включен, указав опцию командной строки cmake --log-context или установив переменную CMAKE_MESSAGE_CONTEXT_SHOW в значение true. См. документацию к CMAKE_MESSAGE_CONTEXT для примеров использования.

Текст сообщений CMake Warning и Error отображается с помощью простого языка разметки. Текст без отступов форматируется в переносимых абзацах, разделенных новыми строками. Отступленный текст считается предварительно отформатированным.

Отчет о проверках

Распространенным шаблоном в выводе CMake является сообщение, указывающее на начало какой-либо проверки, за которым следует другое сообщение, сообщающее результат этой проверки. Например:

message(STATUS "Looking for someheader.h")
#... do the checks, set checkSuccess with the result
if(checkSuccess)
  message(STATUS "Looking for someheader.h - found")
else()
  message(STATUS "Looking for someheader.h - not found")
endif()

Это можно более надежно и удобно выразить, используя форму ключевого слова CHECK_... для команды message():

message(<checkState> "message" ...)

где <checkState> должно быть одним из следующих:

CHECK_START

Запись краткого сообщения о проверке, которая будет выполнена.

CHECK_PASS

Запись успешного результата проверки.

CHECK_FAIL

Запись неудачного результата проверки.

При записи результата проверки команда повторяет сообщение из последней начатой проверки, для которой еще не был сообщен результат, затем некоторые разделители и затем текст сообщения, предоставленный после ключевого слова CHECK_PASS или CHECK_FAIL. Сообщения о проверках всегда сообщаются на уровне журнала STATUS.

Проверки могут быть вложенными, и каждая CHECK_START должна иметь ровно одну соответствующую CHECK_PASS или CHECK_FAIL. Переменную CMAKE_MESSAGE_INDENT также можно использовать для добавления отступов к вложенным проверкам, если это необходимо. Например:

message(CHECK_START "Finding my things")
list(APPEND CMAKE_MESSAGE_INDENT "  ")
unset(missingComponents)

message(CHECK_START "Finding partA")
# ... do check, assume we find A
message(CHECK_PASS "found")

message(CHECK_START "Finding partB")
# ... do check, assume we don't find B
list(APPEND missingComponents B)
message(CHECK_FAIL "not found")

list(POP_BACK CMAKE_MESSAGE_INDENT)
if(missingComponents)
  message(CHECK_FAIL "missing components: ${missingComponents}")
else()
  message(CHECK_PASS "all components found")
endif()

Вывод из вышеуказанного будет выглядеть примерно так:

-- Finding my things
--   Finding partA
--   Finding partA - found
--   Finding partB
--   Finding partB - not found
-- Finding my things - missing components: B