如何在CMake中自动获取MSVC编译器警告的描述信息？

核心结论 #

可以实现，但CMake没有内置接口直接获取编译器警告的描述文本，需要手动维护警告编号与对应描述的映射表，再在函数中完成匹配与日志输出。

具体实现步骤 #

1. 维护警告描述映射表 #

针对MSVC编译器，创建一个警告编号到描述的映射，可选择两种方式：

方式一：普通列表（兼容所有CMake版本）

# 定义MSVC警告编号及对应描述，格式为 "编号:描述"
set(MSVC_WARNING_DESCRIPTIONS
    "4267:'var': conversion from 'size_t' to 'type', possible loss of data"
    "4305:'identifier': truncation from 'type1' to 'type2'"
    "4996:'function': was declared deprecated"
    # 根据需求继续添加其他警告条目
)

方式二：CMake字典（CMake 3.18及以上版本支持）

字典形式更直观，查找效率更高：

# 创建MSVC警告字典，键为警告编号，值为描述文本
cmake_dictionary(MSVC_WARNING_DICT
    "4267" "'var': conversion from 'size_t' to 'type', possible loss of data"
    "4305" "'identifier': truncation from 'type1' to 'type2'"
    "4996" "'function': was declared deprecated"
)

2. 修改警告禁用函数 #

根据选择的映射方式，更新disable_msvc_warning函数，自动匹配警告描述并输出日志：

对应列表方式的函数实现

function(disable_msvc_warning target visibility warning_no)
    set(warning_desc "")
    # 遍历列表查找对应警告的描述
    foreach(warning_entry IN LISTS MSVC_WARNING_DESCRIPTIONS)
        # 匹配当前警告编号的条目
        string(REGEX MATCH "^${warning_no}:" entry_prefix "${warning_entry}")
        if(entry_prefix)
            # 提取编号后的描述文本
            string(REGEX REPLACE "^${warning_no}:" "" warning_desc "${warning_entry}")
            break()
        endif()
    endforeach()

    # 构造并输出VERBOSE日志
    if(warning_desc)
        message(VERBOSE "Disabling warning for ${target} at ${visibility} visibility: C${warning_no} ${warning_desc}")
    else()
        message(VERBOSE "Disabling warning for ${target} at ${visibility} visibility: C${warning_no} (no description available)")
    endif()

    # 执行警告禁用操作
    target_compile_options(${target} ${visibility} "/wd${warning_no}")
endfunction()

对应字典方式的函数实现

function(disable_msvc_warning target visibility warning_no)
    # 从字典中获取警告描述
    cmake_dictionary_get(MSVC_WARNING_DICT "${warning_no}" warning_desc)

    # 构造并输出VERBOSE日志
    if(warning_desc)
        message(VERBOSE "Disabling warning for ${target} at ${visibility} visibility: C${warning_no} ${warning_desc}")
    else()
        message(VERBOSE "Disabling warning for ${target} at ${visibility} visibility: C${warning_no} (no description available)")
    endif()

    # 执行警告禁用操作
    target_compile_options(${target} ${visibility} "/wd${warning_no}")
endfunction()

3. 使用示例 #

调用方式和之前一致：

disable_msvc_warning(my_target PRIVATE 4267)

运行CMake时开启VERBOSE日志（如cmake --build . --verbose），即可看到期望的输出：

-- Disabling warning for my_target at PRIVATE visibility: C4267 'var': conversion from 'size_t' to 'type', possible loss of data

注意事项 #

• 映射表需要手动维护：编译器的警告描述可能随版本更新变化，需确保描述文本与当前使用的MSVC版本匹配，可从编译器警告输出或官方文档中提取对应内容。
• 扩展多编译器支持：如果需要兼容GCC/Clang等其他编译器，可以为每个编译器分别创建映射表，并在函数中通过CMAKE_CXX_COMPILER_ID判断当前编译器后选择对应映射。

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