message

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

Синтаксис

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

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

Configure Log
  message(CONFIGURE_LOG <text>...)

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

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

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

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

FATAL_ERROR

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

Исполняемый файл cmake(1) вернёт ненулевое значение выхода.

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

Журнал конфигурации

message(CONFIGURE_LOG <text>...)

Записать событие сообщения configure-log с указанным <text>. По соглашению, если текст содержит более одной строки, первая строка должна быть кратким описанием события.

Этот режим предназначен для записи подробностей проверки системы или другой операции разового характера, защищённой записью в кэш, но которая не выполняется с помощью try_compile() или try_run(), которые автоматически записывают свои подробности. Проекты должны избегать его вызова каждый раз, когда CMake запускается. Например:

if (NOT DEFINED MY_CHECK_RESULT)
  # Print check summary in configure output.
  message(CHECK_START "My Check")

  # ... perform system inspection, e.g., with execute_process ...

  # Cache the result so we do not run the check again.
  set(MY_CHECK_RESULT "${MY_CHECK_RESULT}" CACHE INTERNAL "My Check")

  # Record the check details in the cmake-configure-log.
  message(CONFIGURE_LOG
    "My Check Result: ${MY_CHECK_RESULT}\n"
    "${details}"
  )

  # Print check result in configure output.
  if(MY_CHECK_RESULT)
    message(CHECK_PASS "passed")
  else()
    message(CHECK_FAIL "failed")
  endif()
endif()

Если в данный момент не происходит конфигурирование проекта, например, в режиме скрипта cmake -P, эта команда ничего не делает.

См. также

• cmake_language(GET_MESSAGE_LOG_LEVEL)