Cmake中message函数 如何优雅地输出

已于 2023-05-31 23:22:25 修改
阅读量2.6k 收藏 4
点赞数 1
分类专栏： 构建系统全解：从CMake、Makefile到Conan指南 文章标签： 编辑器 c语言 开发语言 linux cmake
于 2023-05-31 13:02:45 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_21438461/article/details/130966617
版权

message函数说明

在CMake中，message()函数用于向终端输出信息。

message([<mode>] "message text" ...)函数的<mode>参数可以是以下之一：

  • (none): 等同于STATUS，但不推荐使用。
  • STATUS: 输出的信息会被发送到CMake的状态消息流，这是message()函数的默认模式。在命令行上，这些消息通常会被显示出来，但在图形界面中，它们可能会被重定向到其他地方。
  • WARNING: 输出的信息会被发送到CMake的警告消息流。这些消息会被显示出来，并且会标记为警告。
  • AUTHOR_WARNING: 这是WARNING模式的一种变体，只有在CMAKE_SUPPRESS_DEVELOPER_WARNINGS变量为FALSE时才会产生警告。
  • SEND_ERROR: 输出的信息会被发送到CMake的错误消息流，但不会立即停止CMake的处理过程。
  • FATAL_ERROR: 输出的信息会被发送到CMake的错误消息流，并立即停止CMake的处理过程。
参数使用场景底层原理优点缺点
(none)当你想输出一条普通的状态消息，但不希望给它指定任何特殊的模式时。输出的信息会被发送到CMake的状态消息流。简单易用，不需要指定模式。不推荐使用，因为它的行为可能会在未来的CMake版本中改变。
STATUS当你想输出一条状态消息，例如进度信息或配置信息时。输出的信息会被发送到CMake的状态消息流。明确表示这是一条状态消息，易于理解。在图形界面中，这些消息可能会被重定向到其他地方，不一定能被用户看到。
WARNING当你想输出一条警告消息，例如某个选项已被弃用或某个操作可能会失败时。输出的信息会被发送到CMake的警告消息流。明确表示这是一条警告消息，可以引起用户的注意。过多的警告消息可能会让用户感到困扰，忽视真正重要的警告。
AUTHOR_WARNING当你是项目的开发者，并且你想输出一条只有在开发模式下才会显示的警告消息时。输出的信息会被发送到CMake的警告消息流，但只有在CMAKE_SUPPRESS_DEVELOPER_WARNINGS变量为FALSE时才会产生警告。可以避免在用户模式下显示不必要的警告。如果CMAKE_SUPPRESS_DEVELOPER_WARNINGS变量被设置为TRUE，这些警告会被忽略。
SEND_ERROR当你遇到一个错误，但你希望CMake继续处理剩下的命令时。输出的信息会被发送到CMake的错误消息流，但不会立即停止CMake的处理过程。可以在发生错误时继续执行CMake的处理过程。由于CMake的处理过程没有立即停止，可能会导致更多的错误。
FATAL_ERROR当你遇到一个严重的错误，你希望立即停止CMake的处理过程时。输出的信息会被发送到CMake的错误消息流，并立即停止CMake的处理过程。可以在发生严重错误时立即停止CMake的处理过程，防止错误的扩散。一旦使用，CMake的处理过程会立即停止，无法执行任何后续的命令。

STATUS

在CMake中，message(STATUS "Your message")常常被用来输出构建过程中的状态信息。以下是一些具体的使用示例：

  1. 输出变量的值：
set(MY_VARIABLE "Hello, CMake!")
message(STATUS "MY_VARIABLE is: ${MY_VARIABLE}")

在这个例子中，message(STATUS "MY_VARIABLE is: ${MY_VARIABLE}")会输出一条状态消息，内容为"MY_VARIABLE is: Hello, CMake!"。${MY_VARIABLE}是CMake的变量引用语法，它会被替换为MY_VARIABLE变量的值。

  1. 输出配置信息：
option(USE_MY_LIBRARY "Use my library" ON)
message(STATUS "USE_MY_LIBRARY is set to: ${USE_MY_LIBRARY}")

在这个例子中，option(USE_MY_LIBRARY "Use my library" ON)定义了一个名为USE_MY_LIBRARY的选项，初始值为ON。message(STATUS "USE_MY_LIBRARY is set to: ${USE_MY_LIBRARY}")会输出一条状态消息，内容为"USE_MY_LIBRARY is set to: ON"或"USE_MY_LIBRARY is set to: OFF"，取决于USE_MY_LIBRARY选项的值。

  1. 输出构建目标信息：
add_library(MyLibrary SHARED src/my_library.cpp)
message(STATUS "Added shared library target: MyLibrary")

在这个例子中，add_library(MyLibrary SHARED src/my_library.cpp)添加了一个名为MyLibrary的共享库目标。message(STATUS "Added shared library target: MyLibrary")会输出一条状态消息，内容为"Added shared library target: MyLibrary"。

这些状态消息在命令行上运行CMake时会被显示出来，帮助你了解CMake的处理过程。在图形界面的CMake工具（如CMake GUI或IDE的CMake集成）中，这些消息可能会被显示在专门的输出窗口或日志文件中。

WARNING

在CMake中，message(WARNING "message text")函数用于输出警告消息。这些消息会被发送到CMake的警告消息流，并在终端中显示出来。同时，这些消息会被标记为警告，这意味着它们可能会引起用户的注意，或者在某些情况下，可能会导致构建过程失败。

例如，假设你正在编写一个需要某个库才能正常工作的项目，你可以使用find_package()函数来查找这个库。如果find_package()函数没有找到这个库，你可以使用message(WARNING)函数来输出一个警告消息，告诉用户这个库没有找到：

find_package(SomeLibrary)
if(NOT SomeLibrary_FOUND)
    message(WARNING "SomeLibrary not found, some features will not be available.")
endif()

在这个例子中，如果CMake在配置过程中没有找到SomeLibrary，它会输出一个警告消息，内容为"SomeLibrary not found, some features will not be available."。这个警告消息会被发送到CMake的警告消息流，并在终端中显示出来，从而让用户知道他们可能需要安装SomeLibrary才能使用所有的功能。

请注意，message(WARNING)函数只是输出警告消息，它不会改变CMake的处理过程。如果你想在发生错误时停止CMake的处理过程，你应该使用message(FATAL_ERROR)函数。

AUTHOR_WARNING

AUTHOR_WARNING模式在CMake中用于输出开发者警告。这种模式的警告只有在CMAKE_SUPPRESS_DEVELOPER_WARNINGS变量为FALSE时才会显示。这个变量默认为FALSE，但如果你在CMakeLists.txt文件中设置了这个变量为TRUE，那么AUTHOR_WARNING模式的警告就不会显示。

这种机制可以用于区分开发者警告和用户警告。例如，如果你是一个库的开发者，你可能希望在开发过程中看到所有的警告，包括开发者警告，但是你的用户可能只关心他们需要知道的警告，不希望看到开发者警告。这时，你就可以在你的CMakeLists.txt文件中使用AUTHOR_WARNING模式来输出开发者警告，然后告诉你的用户设置CMAKE_SUPPRESS_DEVELOPER_WARNINGS变量为TRUE来隐藏这些警告。

以下是一个AUTHOR_WARNING模式的示例：

# 如果某个变量没有被设置，输出一个开发者警告
if(NOT DEFINED MY_VARIABLE)
  message(AUTHOR_WARNING "MY_VARIABLE is not defined")
endif()

在这个示例中，如果MY_VARIABLE变量没有被设置，CMake会输出一个开发者警告，内容为"MY_VARIABLE is not defined"。如果CMAKE_SUPPRESS_DEVELOPER_WARNINGS变量被设置为TRUE，这个警告就不会显示。

SEND_ERROR

SEND_ERROR模式在message()函数中用于输出错误信息，但不会立即停止CMake的处理过程。这意味着CMake会继续处理剩余的命令，直到遇到一个FATAL_ERROR或者处理完所有命令。然后，CMake会以非零状态退出，表示出现了错误。

以下是一个SEND_ERROR的示例：

if(NOT DEFINED REQUIRED_VARIABLE)
    message(SEND_ERROR "REQUIRED_VARIABLE is not defined")
endif()

在这个示例中，我们首先检查变量REQUIRED_VARIABLE是否已经定义。如果没有定义，我们就使用message(SEND_ERROR ...)输出一条错误信息。这条错误信息会被发送到CMake的错误消息流，并且CMake的处理过程不会立即停止。相反，CMake会继续处理剩余的命令，直到遇到一个FATAL_ERROR或者处理完所有命令。然后，CMake会以非零状态退出，表示出现了错误。

请注意，虽然SEND_ERROR不会立即停止CMake的处理过程，但它会阻止生成步骤的执行。也就是说，如果CMake在处理过程中遇到了一个SEND_ERROR，那么即使CMake成功处理了所有命令，生成步骤也不会执行。这是因为SEND_ERROR表示了一个严重的问题，需要用户的注意和修复。

FATAL_ERROR

FATAL_ERROR是CMake中message()函数的一种模式，用于输出错误消息并立即停止CMake的处理过程。当CMake遇到一个无法继续的错误时，你可以使用message(FATAL_ERROR "error message")来输出错误消息并停止处理。

例如，假设你正在编写一个需要C++11或更高版本的项目，你可以使用以下代码来检查C++编译器是否支持C++11：

if(NOT CMAKE_CXX_STANDARD OR CMAKE_CXX_STANDARD LESS 11)
    message(FATAL_ERROR "This project requires C++11 or higher!")
endif()

在这个例子中，如果CMake检测到C++编译器的标准版本小于11，它会输出错误消息"This project requires C++11 or higher!"，并立即停止处理。这意味着CMake不会生成构建系统，也不会执行任何后续的CMake命令。这可以防止在不满足项目要求的情况下尝试构建项目，从而避免可能的构建错误和问题。

请注意，FATAL_ERROR应该谨慎使用，只有在确实需要立即停止CMake处理过程的情况下才应使用。在大多数情况下，使用WARNING或SEND_ERROR模式可能更合适。

CMake：message输出消息
风静如云的博客
12-18 1832
DEPRECATION：如果CMAKE_ERROR_DEPRECATED或CMAKE_WARN_DEPRECATED被使能，会输出此类错误或警告消息。其中TRACE和STATUS类型的消息会被输出到stdout，其他类型的消息会被输出到stderr。TRACE：最低等级的消息，通常用于跟踪一些细节，发布项目时通常不会包含此类信息。DEBUG：通常用于开发者调试输出的信息，项目的使用者不会在意此类信息。SEND_ERROR：用于错误，cmake会继续执行，但会跳过生成步骤。
cmake之输出日志
weixin_44769745的博客
11-01 537
【代码】cmake之输出日志。
cmake：message
OceanStar的博客
07-01 889
日志消息。 概要 General messages message([<mode>] "message text" ...) Reporting checks message(<checkState> "message text" ...) 一般消息 message([<mode>] "message text" ...) 在日志中记录指定的消息文本。如果给出了多个消息字符串，则将它们连接为单个消息，字符串之间没有分隔符。 可选的< mode >
cmake全局输出目录设定
最新发布
xuxuluo的博客
03-17 226
如果将来某个特定目标需要不同的输出位置，那时再单独为那个目标设置即可。子目录中就不需要重复设置。
【CMake 语法】(2) CMake 输出信息
m0_57845572的博客
07-01 5077
1. message 函数 我们使用 message 函数，输出消息 message([模式] “message text” …) 模式可以为: FATAL_ERROR, SEND_ERROR, WARNING, AUTHOR_WARNING, DEPRECATION, NOTICE, STATUS, VERBOSE, DEBUG, TRACE 可以定义不同级别的消息 (无) = ‘重要’ 消息； STATUS = ‘非重要’ 消息；–>‘常用’ WARNING = ‘警告’ 消息, 会继续执行； A
cmake message详解
qq_37805392的博客
06-27 1097
在 CMake 中，message 命令用于在生成过程中输出消息到控制台。这对于调试 CMake 脚本或向用户显示信息都非常有用。
Cmake MESSAGE命令
ppzzgg666的博客
03-06 1446
mode：打印消息的类别，有FATAL_ERROR，SEND_ERROR，WARNING，AUTHOR_WARNING，DEPRECATION，(none) or NOTICE，STATUS，VERBOSE，DEBUG，TRACE共10种。DEPRECATION：如果使用set方法设置CMAKE_ERROR_DEPRECATED为true(不区分大小写)，编译出错，否则继续编译。(none) or NOTICE：不设置mode，默认是NOTICE模式，不影响编译和生成，用于打印消息(信息白色)
cmake message显示
oldmoney
05-14 537
cmake message 在output中显示
灵活构建：在CMake中优雅处理可选依赖
07-26
下面我们将详细介绍如何在 CMake 中优雅地处理可选依赖，并通过具体的代码示例来展示这一过程。 #### 1. 可选依赖的重要性 可选依赖在软件项目中的作用非常重要，主要体现在以下几个方面： - **功能扩展**：允许...
CMake 中的函数和宏：深入理解函数和宏的定义与使用
在 CMake 中，函数和宏是非常重要的概念，它们可以帮助我们更好地组织代码和实现复用。本章将深入介绍 CMake 中函数和宏的基础知识，包括函数的定义和调用、参数传递、返回值等内容。 ### 函数的基础 在 CMake 中...
cmake 添加宏_CMake 入门3 —— CMake 的函数和宏
weixin_39572409的博客
12-19 957
CMake 中 function 和 macro 的区别通过代码直观地来看看区别。set(var "ABC")macro(Moo arg)message("arg = ${arg}") # 输出原值 ABCset(arg "abc")message("# After change the value of arg.")message("arg = ${arg}") # 输出原值 ABCendm...
[CMake教程] 使用 message() 打印信息
淋曦的进击手记
01-28 3995
使得在 CMakeLists.txt 中可以设置消息等级。大多数情况下只是打印一些变量与普通消息，例如。是在CMake 3.15 才被引入的新特性。另外，CMake 3.17 引入。三个等级的消息不会被打印。其中，对于mode类型，
CMAKE——message()函数
热门推荐
Zhanganliu的博客
08-20 4万+
message :为用户显示一条消息。 message( [STATUS|WARNING|AUTHOR_WARNING|FATAL_ERROR|SEND_ERROR] "message to display" ...) 可以用下述可选的关键字指定消息的类型： (无) = 重要消息； STATUS = 非重要消息； WARNING = CMake 警告, 会继续执行； AU...
CMake在Linux下生成程序并输出指定消息
HackCyberX的博客
09-18 167
CMake是一个跨平台的开源构建工具，它可以用于生成和管理多种编程语言的项目。本文将向您展示如何使用CMake在Linux下生成程序，并在生成过程中输出指定的消息。希望本文能帮助您了解如何使用CMake在Linux下生成程序并输出指定的消息。如果您看到了CMake的版本信息，那么说明CMake已经正确安装在您的系统中。接下来，我们将创建一个简单的C++程序，并使用CMake生成可执行文件。这证明我们成功地使用CMake在Linux下生成程序，并输出了指定的消息。文件，并生成构建所需的Makefile。
cmake(三)CMake输出自定义信息
wzj_110的博客
04-14 2009
一 message函数 ① 清理上次的构建产物 ② message函数 1）CMake 的命令行工具会在 'stdout' 上显示 'STATUS' 消息，在 stderr 上显示'其他所有'消息 2）CMake '警告和错误消息'的文本显示使用的是一种'简单的标记语言';文本'没有缩进',超过长度的行会'回卷'，段落之间以'新行'做为'分隔符' +++++++++'消息不同级别的行为'+++++++++ (无) = '重要'消息； STATUS = '非重要'消息；-...
CMake中message的使用
网络资源是无限的
11-12 8092
CMake中message的使用
1. cmake(注释+message)
2301_80967396的博客
07-23 393
注释分为# 与 #[[]]两种注释方式。
CMake语法-message命令-状态显示-math命令-简单数学计算-include命令-文件片段组织-编译信息提示
插件开发
02-26 1114
对于更复杂的数学运算或需要使用浮点数的情况，可能需要在CMake脚本中嵌入其他编程语言（如Python）脚本来完成。这些脚本可以是项目中的自定义模块、CMake自带的模块或第三方库提供的模块。命令用于输出信息到控制台或者日志文件，常用于调试CMake脚本或向用户显示构建过程中的状态信息。中的表达式字符串需要符合CMake的语法要求，而不是常规编程语言的数学表达式语法。: 输出警告信息，通常显示为黄色，表示可能会影响构建过程但不会导致构建失败的问题。，但指出的是开发人员需要注意的潜在问题，而不是终端用户。
CMake入门教程：使用message指令进行打印
PixelInk的博客
09-13 510
通过使用message指令，开发者可以在CMake的构建过程中输出有用的信息，帮助调试和验证代码。一旦CMake生成了构建文件，我们可以使用适当的构建工具（如make、Visual Studio等）来构建项目。首先，我们需要编写一个简单的CMakeLists.txt文件，用于定义我们的项目和构建规则。接下来，我们需要在命令行中执行CMake来生成构建文件。当我们运行CMake时，这条消息将显示在构建过程的输出中。这证明了我们成功使用了message指令，在构建过程中打印了一条消息。
cmakelist message
02-15
在 CMake 中，`message()` 函数用于向用户显示消息。这非常有助于调试、传递重要信息或警告开发者某些配置选项的状态。通过不同级别的日志输出，可以让构建过程更加透明化。 ### 常见的日志级别 `message()` 支持多种日志级别，默认情况下会打印出所有类型的消息： - **STATUS**: 通常是告知性的信息，表示正常的进度更新。 ```cmake message(STATUS "正在编译版本: ${PROJECT_VERSION}") ``` - **WARNING**: 发出一个警告但不会中断构建流程。 ```cmake if(SOME_CONDITION) message(WARNING "已检测到潜在的问题，请检查相关设置") endif() ``` - **AUTHOR_WARNING**: 类似于 WARNING ，不过主要用于提醒包维护者而不是普通终端用户。（从 CMake 3.0 开始支持） - **SEND_ERROR**: 输出错误并阻止后续 cmake 配置阶段继续执行，但是不终止整个处理过程。 ```cmake if(NOT EXISTS "${REQUIRED_FILE_PATH}") message(SEND_ERROR "缺失必要的文件: ${REQUIRED_FILE_PATH}") endif() ``` - **FATAL_ERROR**: 触发致命错误立即停止一切操作。 ```cmake if(MISSING_CRITICAL_DEPENDENCY) message(FATAL_ERROR "无法找到关键依赖项！") endif() ``` - 默认模式下没有指定类型的参数将被视为 STATUS 消息。 ```cmake message("这是一个默认的信息") ``` 此外还可以结合变量来构造动态内容，如上面例子中的 `${PROJECT_VERSION}` 或 `${REQUIRED_FILE_PATH}`, 这样可以使你的脚本更具灵活性和实用性。 如果你希望完全静默地运行而不输出任何信息，则可以在调用 `cmake` 工具时加上 `-Wno-dev` 参数忽略开发相关的警告，或者根据具体需求调整最低日志等级。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

泡沫o0

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值