构建工具开发工具CLI【免费下载链接】CMakeMirror of CMake upstream repository项目地址https://gitcode.com/gh_mirrors/cm/CMake点击查看免费下载CMake 的CMakeBackwardCompatibilityCXX模块专为编写于 C98 标准化之前的旧式pre-C98 / ANSI CC 代码提供向后兼容支持通过一组轻量级编译探测自动判定编译器是否具备for语句变量作用域隔离、无扩展名标准头文件、sstream、std命名空间等能力并将结果以缓存变量形式暴露给项目供配置头文件与条件编译使用。阅读本文后你将掌握该模块的加载方式、全部缓存变量的取值语义、底层探测实现原理以及如何将其与file(CONFIGURE)配合生成config.h并驱动 C 源码中的条件编译。本文对应仓库中的模块文件为 Modules/CMakeBackwardCompatibilityCXX.cmake其帮助文档位于 Help/module/CMakeBackwardCompatibilityCXX.rst该.rst通过.. cmake-module::指令直接引用模块文件头部文档块两者内容一致。一、模块定位解决 C98 之前的四大兼容性问题在 C 尚未标准化即 ANSI C、pre-C98的年代不同编译器对语言和标准库的实现存在显著差异。CMakeBackwardCompatibilityCXX模块针对的是以下四类典型问题for初始化语句中变量的作用域早期 C 中for(int i 0; ...)声明的i在循环结束后仍可被访问而 C98 起其作用域被严格限定在循环体内。标准头文件的包含方式早期编译器要求使用带扩展名的头文件如iostream.h不支持 C98 引入的无扩展名标准头如iostream。sstream的可用性sstream头文件在 C98 之前并未正式标准化部分编译器可能缺失。std命名空间的存在性早期 STL 与标准库组件如list、cout、endl直接位于全局作用域尚无std::命名空间。从源码结构看该模块的职责本质上是能力探测并导出结果它自身并不修改编译器行为而是把探测结论交给项目代码去适配——这一设计思路在后续篇幅的缓存变量与示例中体现得十分明确。二、加载方式与依赖模块在 CMake 项目中通过include()加载include(CMakeBackwardCompatibilityCXX)加载后模块会自动依次包含以下四个子模块对应 Modules/CMakeBackwardCompatibilityCXX.cmake 中的 include 顺序子模块帮助文档探测目标TestForANSIForScopeHelp/module/TestForANSIForScope.rstfor初始化语句作用域是否受限TestForANSIStreamHeadersHelp/module/TestForANSIStreamHeaders.rst标准头文件是否可无.h扩展名包含TestForSSTREAMHelp/module/TestForSSTREAM.rstsstream头文件是否存在且功能正常TestForSTDNamespaceHelp/module/TestForSTDNamespace.rststd命名空间是否受支持这 4 个子模块均可单独include()使用帮助文档中均注明了它们与CMakeBackwardCompatibilityCXX的关联关系See Also 一节。三、模块定义的缓存变量3.1CMAKE_ANSI_CXXFLAGS一个由空格分隔的字符串保存启用 ANSI C 模式所需的编译器选项若编译器支持。该变量仅在探测成功时以CACHE INTERNAL形式写入见下文实现原理项目可用它补充到编译选项中。3.2 四个CMAKE_NO_*探测结果变量这四个缓存变量由上述子模块定义取值语义一致值为0表示支持现代C98 及更新行为值为1表示不支持ANSI C 行为。注意这里的值 0/1 与常规 CMake 布尔真/假约定相反——1代表存在问题/缺失命名前缀NO_正是为了配合#cmakedefine生成条件宏。缓存变量定义于0的含义1的含义CMAKE_NO_ANSI_FOR_SCOPETestForANSIForScope支持 for-init 作用域限制不支持变量逃逸到循环外CMAKE_NO_ANSI_STREAM_HEADERSTestForANSIStreamHeaders支持无扩展名标准头必须使用iostream.h形式CMAKE_NO_ANSI_STRING_STREAMTestForSSTREAMsstream可用sstream缺失CMAKE_NO_STD_NAMESPACETestForSTDNamespace支持std::不支持需全局符号此外TestForSSTREAM还额外定义了一个与之互补的布尔缓存变量CMAKE_HAS_ANSI_STRING_STREAMsstream可用时为真缺失时为假语义与CMAKE_NO_ANSI_STRING_STREAM恰好相反。四、底层实现原理源码级剖析整个探测流程位于 Modules/CMakeBackwardCompatibilityCXX.cmake 的if(NOT CMAKE_SKIP_COMPATIBILITY_TESTS)代码块内。4.1 总开关CMAKE_SKIP_COMPATIBILITY_TESTS模块以CMAKE_SKIP_COMPATIBILITY_TESTS作为总开关若该变量为非空通常由用户在配置时预先定义则跳过全部探测不定义任何缓存变量。这为不需要兼容探测的现代项目提供了快速退出路径。4.2 ANSI 编译选项探测仅非 GNU 编译器if(NOT CMAKE_CXX_COMPILER_ID STREQUAL GNU) include(TestCXXAcceptsFlag) set(CMAKE_TRY_ANSI_CXX_FLAGS ) if(CMAKE_SYSTEM_NAME MATCHES OSF) set(CMAKE_TRY_ANSI_CXX_FLAGS -std strict_ansi -nopure_cname) endif() if(NOT CMAKE_TRY_ANSI_CXX_FLAGS STREQUAL ) check_cxx_accepts_flag(${CMAKE_TRY_ANSI_CXX_FLAGS} CMAKE_CXX_ACCEPTS_FLAGS) if(CMAKE_CXX_ACCEPTS_FLAGS) set(CMAKE_ANSI_CXXFLAGS ${CMAKE_TRY_ANSI_CXX_FLAGS} CACHE INTERNAL What flags are required by the c compiler to make it ansi.) endif() endif() endif()实现要点GNU 编译器直接跳过CMAKE_CXX_COMPILER_ID为GNU时不做 flag 探测隐含假设 GCC 无需额外选项即可满足 ANSI C 要求。OSFTru64 UNIX平台特例仅当CMAKE_SYSTEM_NAME匹配OSF时才尝试-std strict_ansi -nopure_cname这一组选项。flag 接受性检测通过include(TestCXXAcceptsFlag)引入check_cxx_accepts_flag(flags result-variable)命令。从 Modules/TestCXXAcceptsFlag.cmake 的宏实现可见它利用try_compile编译DummyCXXFile.cxx并传入-DCOMPILE_DEFINITIONS:STRING${FLAGS}来验证编译器是否接受给定 flag结果存入指定的缓存变量。该模块自 CMake 3.0 起已被标注为废弃deprecated官方建议改用CheckCXXCompilerFlag/CheckCompilerFlag模块见其文档注释。探测成功后CMAKE_ANSI_CXXFLAGS以CACHE INTERNAL写入。4.3 临时追加 flag 执行四项探测set(CMAKE_CXX_FLAGS_SAVE ${CMAKE_CXX_FLAGS}) string(APPEND CMAKE_CXX_FLAGS ${CMAKE_ANSI_CXXFLAGS}) include(TestForANSIStreamHeaders) include(CheckIncludeFileCXX) include(TestForSTDNamespace) include(TestForANSIForScope) include(TestForSSTREAM) set(CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS_SAVE})模块先把探测期间得到的CMAKE_ANSI_CXXFLAGS临时追加到CMAKE_CXX_FLAGS确保子探测在 ANSI 模式下编译测试代码依次执行四个子模块后恢复原CMAKE_CXX_FLAGS。这里有个值得注意的细节模块虽然调用了include(CheckIncludeFileCXX)但实际并不直接使用它而是由TestForANSIStreamHeaders内部再次引入见 Modules/TestForANSIStreamHeaders.cmake。4.4 各子探测的实现方式TestForANSIForScopeModules/TestForANSIForScope.cmake通过try_compile编译 Modules/TestForAnsiForScope.cxx。该测试源在for循环外声明int i;再在 for-init 中声明同名int i循环后(void)i;引用外层变量——若编译器将 for-init 变量限制在循环体内则编译成功CMAKE_NO_ANSI_FOR_SCOPE置0若变量逃逸导致重定义冲突则编译失败置1。同时输出Check for ANSI scope的 CHECK_START / CHECK_PASS / CHECK_FAIL 状态消息。TestForANSIStreamHeadersModules/TestForANSIStreamHeaders.cmake引入CheckIncludeFileCXX后调用check_include_file_cxx(iostream CMAKE_ANSI_STREAM_HEADERS)判断iostream是否可包含据此设置CMAKE_NO_ANSI_STREAM_HEADERS并以mark_as_advanced()隐藏该变量。TestForSSTREAMModules/TestForSSTREAM.cmaketry_compile编译 Modules/TestForSSTREAM.cxx。该测试源使用std::ostringstream写入12345并断言os.str().size() 5——不仅验证头文件存在还验证stringstream实际功能正确。成功时CMAKE_HAS_ANSI_STRING_STREAM为真且CMAKE_NO_ANSI_STRING_STREAM置0否则反之并输出Check for sstream状态消息。TestForSTDNamespaceModules/TestForSTDNamespace.cmaketry_compile编译 Modules/TestForSTDNamespace.cxx。该测试源包含list并构造std::listint()——若编译成功说明std命名空间可用置0失败则置1同时输出Check for STD namespace状态消息。从上述源码可以推断这些探测均以编译一个最小测试程序是否成功为依据且各子模块内部都有if(NOT DEFINED ...)保护保证探测只在首次配置时执行一次结果写入缓存后后续配置不再重复编译。五、实战示例生成 config.h 并驱动条件编译模块官方文档给出了完整的集成范式先在CMakeLists.txt中加载模块并生成配置头再在 C 源码中根据宏做条件适配。5.1 CMakeLists.txtinclude(CMakeBackwardCompatibilityCXX) file( CONFIGURE OUTPUT config.h CONTENT [[ #cmakedefine CMAKE_NO_ANSI_FOR_SCOPE #cmakedefine CMAKE_NO_ANSI_STRING_STREAM #cmakedefine CMAKE_NO_ANSI_STREAM_HEADERS #cmakedefine CMAKE_NO_STD_NAMESPACE ]] )file(CONFIGURE)会将缓存变量值展开到config.h中缓存变量为1时生成#define CMAKE_NO_XXX为0时该行被注释掉。由此C 源码中#ifdef CMAKE_NO_XXX即可精确表达编译器存在该兼容性问题。5.2 C 源码中的条件适配各子模块帮助文档提供了对应的 C 侧使用范例组合起来即为一份完整的旧代码移植模板#include config.h // for-init 变量逃逸到循环外时用宏强制隔离作用域 #ifdef CMAKE_NO_ANSI_FOR_SCOPE # define for if(false) {} else for #endif // 标准头文件需带 .h 扩展名时条件包含 #ifdef CMAKE_NO_ANSI_STREAM_HEADERS # include iostream.h #else # include iostream #endif // sstream 缺失时跳过相关代码或走替代实现 #ifndef CMAKE_NO_ANSI_STRING_STREAM # include sstream #endif // std 命名空间缺失时将 std 退化为空宏使 std::cout 变为 cout #ifdef CMAKE_NO_STD_NAMESPACE # define std #endif int main() { std::cout hello std::endl; return 0; }其中#define for if(false) {} else for是利用if 体与 else 体作用域隔离的经典技巧为不支持 for-init 作用域限制的老编译器模拟 C98 行为#define std则在无命名空间环境下把std::前缀无害化。这些技巧与 Modules/TestForANSIForScope.cmake、Modules/TestForSTDNamespace.cmake 文档中的示例一一对应。六、适用前提与现状说明适用对象本模块面向编写于 C98 之前的遗留 C 代码库迁移场景。模块文档的 note 明确指出C98 标准已正式解决上述四类问题对现代编译器而言这些探测已属多余obsolete。运行开销首次配置会触发多次try_compile编译与check_include_file_cxx检查可通过预定义CMAKE_SKIP_COMPATIBILITY_TESTS跳过整个流程。现代替代TestCXXAcceptsFlag依赖的check_cxx_accepts_flag自 CMake 3.0 起废弃新项目应使用 Modules/CheckCXXCompilerFlag.cmakeCMake 3.19 起也可用跨语言的 Modules/CheckCompilerFlag.cmake对 C 标准方言的统一控制更推荐通过CMAKE_CXX_STANDARD/CMAKE_CXX_STANDARD_REQUIRED属性实现。版本与路径以上分析均基于当前仓库Modules/CMakeBackwardCompatibilityCXX.cmake的实际实现模块头部遵循 BSD 3-Clause 许可见 LICENSE.rst。需要进一步深入时可依次阅读四个子模块的帮助文档TestForANSIForScope.rst、TestForANSIStreamHeaders.rst、TestForSSTREAM.rst、TestForSTDNamespace.rst及其对应实现与测试源文件形成从能力探测 → 缓存变量 → 配置头 → 源码适配的完整链路认知。赞分享构建工具开发工具CLI【免费下载链接】CMakeMirror of CMake upstream repository项目地址https://gitcode.com/gh_mirrors/cm/CMake点击查看免费下载相关推荐JSMpeg WebAssembly模块C代码编译为WASM的完整流程JSMpeg WebAssembly模块C代码编译为WASM的完整流程 1. 引言WebAssembly在实时视频解码中的突破 在低延迟视频流传输场景中J音视频视频前端Area51代码重构指南从C98到现代C的迁移Area51代码重构指南从C98到现代C的迁移 重构背景与目标 Area51项目作为GitHub推荐的经典代码库其渲染模块 Support/Rend探索LLVM的Clang现代C编译器的卓越之选探索LLVM的Clang现代C编译器的卓越之选 Clang编译器作为LLVM项目的重要组成部分正在成为C开发者的首选工具。它不仅提供了出色的编译性能上一篇50KB内核驱动万物互联Zephyr RTOS架构解密与实战指南下一篇思源笔记快捷键冲突解决自定义你的操作习惯创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考