CMake FATAL_ERROR多行消息格式问题及最佳实践咨询

我完全理解你的 frustration——CMake的消息格式化系统确实有不少历史遗留的坑，文档含糊不清，FATAL_ERROR的换行bug更是困扰了很多开发者多年。针对你的问题，这里有几个经过实践验证的最佳实践和技巧：

1. 拆分详细信息与核心错误提示 #

这其实就是你已经在使用的思路，但可以优化细节：把详细的错误说明（比如可接受的CMAKE_BUILD_TYPE值）用STATUS模式输出，后续行缩进2个空格就能完美对齐--前缀；然后用FATAL_ERROR只输出最核心的错误标题，避免多行换行导致的格式混乱。

示例代码：

# 定义可接受的构建类型列表
set(VALID_BUILD_TYPES Debug Release RelWithDebInfo MinSizeRel)

if(NOT CMAKE_BUILD_TYPE IN_LIST VALID_BUILD_TYPES)
    message(STATUS "Invalid CMAKE_BUILD_TYPE value: '${CMAKE_BUILD_TYPE}'")
    message(STATUS "  Acceptable values are: ${VALID_BUILD_TYPES}")
    message(FATAL_ERROR "CMAKE_BUILD_TYPE configuration error")
endif()

这种方式在控制台和cmake-gui中都能保持良好的可读性，cmake-gui里的缩进也不会造成干扰。

2. 封装为自定义函数减少重复代码 #

如果你的项目中经常需要输出这类格式化的错误消息，可以封装成CMake函数，让代码更简洁、可维护：

function(print_invalid_build_type_error invalid_value)
    set(VALID_BUILD_TYPES Debug Release RelWithDebInfo MinSizeRel)
    message(STATUS "Invalid CMAKE_BUILD_TYPE: '${invalid_value}'")
    message(STATUS "  Valid options:")
    foreach(type IN LISTS VALID_BUILD_TYPES)
        message(STATUS "    - ${type}")
    endforeach()
    message(FATAL_ERROR "Aborting build due to invalid build type configuration")
endfunction()

# 调用示例
if(NOT CMAKE_BUILD_TYPE IN_LIST VALID_BUILD_TYPES)
    print_invalid_build_type_error("${CMAKE_BUILD_TYPE}")
endif()

3. 利用CMAKE_MESSAGE_INDENT统一缩进（CMake 3.15+） #

从CMake 3.15开始，官方提供了CMAKE_MESSAGE_INDENT变量来控制消息的缩进层级，不用手动添加空格。你可以用它来让详细说明自动对齐：

if(NOT CMAKE_BUILD_TYPE IN_LIST VALID_BUILD_TYPES)
    # 设置缩进，后续STATUS消息会自动添加该前缀
    set(CMAKE_MESSAGE_INDENT "  ")
    message(STATUS "Invalid CMAKE_BUILD_TYPE value: '${CMAKE_BUILD_TYPE}'")
    message(STATUS "Valid values include:")
    message(STATUS "- Debug")
    message(STATUS "- Release")
    message(STATUS "- RelWithDebInfo")
    message(STATUS "- MinSizeRel")
    # 重置缩进，避免影响后续消息
    unset(CMAKE_MESSAGE_INDENT)
    
    message(FATAL_ERROR "CMAKE_BUILD_TYPE configuration is invalid")
endif()

4. 尽量避免在FATAL_ERROR/SEND_ERROR中使用多行文本 #

正如你发现的，这两个模式的换行处理bug已经存在近20年，官方至今没有修复。所以除非绝对必要，不要在这些模式中写多行内容——详细说明放在STATUS或WARNING里，核心错误提示单独用FATAL_ERROR输出，是目前最稳妥的方案。

总的来说，CMake的消息系统确实不够完善，但通过这些技巧可以规避大部分格式问题，保证错误消息的可读性。

内容的提问来源于stack exchange，提问作者Adam Badura