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 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