conan 入门(三十五):在conanfile.py中获取C++编译器完整路径的方法

有的项目windows平台下构建时需要在msys2环境编译，而msys2也是可以有内置的c++编译器的。如果msys2中的c++编译器与profile中定义的gcc编译版本不一致。那么项目编译阶段可以正常通过，但在连接过程就有可能报错。因为如果项目的依赖库有C++库，那么它是按profile中定义的编译器版本提供的，就可能会因为符号表不匹配产生找不到引用的连接错误(undefiend reference)。
所以在msys2环境执行编译时为避免使用msys2自带的编译器带来麻烦，需要通过CXX环境变量将windows系统安装的g++编译器传递给msys2环境而使用指定的外部编译器。

那么如何在conanfile.py代码中获取当前profile中定义的C++编译器的全路径呢

上一篇博客《conan 入门(三十四):conan 2.x实现对只有Makefile的项目(erpcgen)的封装示例》为了解决问题使用执行where g++命令的方式获取CXX路径

如下：

    def build_requirements(self):
        if self._settings_build.os == "Windows":
            # 获取 windows系统定义的g++编译器位置
            buf = StringIO()
            self.run("where g++",stdout=buf)
            if not buf.getvalue():
                raise Exception("Not found g++ compiler by 'where gcc'")
            # 获取命令返回的第一行,删除末尾的换行符
            self.cxx_path = buf.getvalue().strip().split('\r\n')[0]

这个方法简单，直接，但可想而知，这种方法是有局限性的，如果如下在[buildenv]中定义了CXX变量，上面的办法获取的C++编译器位置就可能是不正确的

[buildenv]
CC=P:\MinGW\mingw64\bin\x86_64-w64-mingw32-gcc.exe 
CXX=P:\MinGW\mingw64\bin\x86_64-w64-mingw32-g++.exe

如何能正确获取到C++编译器的位置呢？
我想到了boost,
boost编译时要生成user-config.jam文件，这个文件中定义了c++编译器的位置，那么boost的conanfile.py肯定有办法正确获取，抄它的，肯定没错。
果然我在boost的conanfile.py(https://github.com/conan-io/conan-center-index/blob/master/recipes/boost/all/conanfile.py)找到了这个方法

from conan.tools.env import VirtualBuildEnv
from conan.tools.apple import is_apple_os, XCRun
import shutil
class BoostConan(ConanFile):

    @property
    def _cxx(self):
        compilers_by_conf = self.conf.get("tools.build:compiler_executables", default={}, check_type=dict)
        cxx = compilers_by_conf.get("cpp") or VirtualBuildEnv(self).vars().get("CXX")
        if cxx:
            return cxx
        if is_apple_os(self) and self.settings.compiler == "apple-clang":
            return XCRun(self).cxx
        compiler_version = str(self.settings.compiler.version)
        major = compiler_version.split(".", maxsplit=1)[0]
        if self.settings.compiler == "gcc":
            return shutil.which(f"g++-{compiler_version}") or shutil.which(f"g++-{major}") or shutil.which("g++") or ""
        if self.settings.compiler == "clang":
            return shutil.which(f"clang++-{compiler_version}") or shutil.which(f"clang++-{major}") or shutil.which("clang++") or ""
        return ""

上面的逻辑也不难理解，_cxx方法获取C++编译器的顺序是这样的：

• 如果[conf]字段定义了tools.build:compiler_executables（这是个json字段），如果其中 cpp字段有则- 返回该字段做为C++编译器路径
• 如果[buildenv]定义了CXX(这是个环境变量)则返回该字段做为C++编译器路径
• 如果是苹果系统且编译器为"apple-clang"则返回XCRun(self).cxx
• 如果是gcc或clang编译器则执行which命令查找返回结果

正确获取了C++编译器的位置在使用时需要unix_path方法转为unix路径，否则还有可能报错，示例如下：

from conan.tools.microsoft.subsystems import unix_path
from conan.tools.gnu import AutotoolsToolchain

    def generate(self):
        tc = AutotoolsToolchain(self)
        env = tc.environment()
        if self._settings_build.os == "Windows":
            # 使用外部定义的C++编译器，避免使用msys2内置的编译器，否则会因为编译版本不一致导致连接错误
            env.define('CXX',unix_path(self,self.cxx_path))
        tc.generate(env)
        # 输出环境变量
        self.output.info("Environment Variables:")
        for name, value in env.vars(self).items():
            self.output.info(f"{name}={value}")

参考资料

关于tools.build:compiler_executables的参数的字段参见：
《CMakeToolchain Reference》
关于tools.build:compiler_executables的参数的示例参见：
《Profile patterns》
[buildenv]字段说明参见：
《buildenv》

conan系列文章

《conan入门(一):conan 及 JFrog Artifactory 安装》
《conan入门(二)：conan 服务配置-密码管理及策略》
《conan入门(三):上传预编译的库(artifact)》
《conan入门(四):conan 引用第三方库示例》
《conan入门(五):conan 交叉编译引用第三方库示例》
《conan入门(六):conanfile.txt conanfile.py的区别》
《conan入门(七):将自己的项目生成conan包》
《conan入门(八):交叉编译自己的conan包项目》
《conan入门(九):NDK交叉编译自己的conan包项目塈profile的定义》
《conan入门(十):Windows下Android NDK交叉编译Boost》
《conan入门(十一):Linux下Android NDK交叉编译Boost》
《conan入门(十二):Windows NDK 编译 boost报错:CMake was unable to find a build program … MinGW Makefile》
《conan入门(十三):conan info 命令的基本用法》
《conan入门(十四):conan new 命令的新特性–模板功能(–template)》
《conan入门(十五):AttributeError: ‘CMake‘ object has no attribute ‘definitions‘》
《conan入门(十六):profile template功能实现不同平台下profile的统一》
《conan入门(十七):支持android NDK (armv7,armv8,x86,x86_64)交叉编译的统一profile jinja2模板》
《conan入门(十八):Cannot recognize the Windows subsystem, install MSYS2/cygwin or specify a build_require》
《conan入门(十九):封装第三方开源库cpp_redis示例》
《conan入门(二十):封装只包含头文件(header_only)的库示例》
《conan入门(二十一):解决MinGW编译Openssl的编译错误:crypto/dso/dso_win32.c》
《conan入门(二十二):编译 openssl要求python 3.7以上版本》
《conan入门(二十三):Windows下MinGW编译libcurl》
《conan入门(二十四):通过CONAN_DISABLE_CHECK_COMPILER禁用编译器检查》
《conan入门(二十五):imports将包安装到本地项目或其他指定位置》
《conan入门(二十七):因profile [env]字段废弃导致的boost/1.81.0 在aarch64-linux-gnu下交叉编译失败》
《conan入门(二十八):解决conan 1.60.0下 arch64-linux-gnu交叉编译openssl/3.1.2报错问题》
《conan入门(二十九):对阿里mnn进行Conan封装塈conans.CMake和conan.tools.cmake.CMake的区别》
《conan入门(三十):对腾讯ncnn进行Conan封装》
《conan入门(三十一):在命令行(shell)中从profile中读取配置参数》
《conan 入门(三十二):package_info中配置禁用CMakeDeps生成使用项目自己生成的config.cmake》
《conan 入门(三十三):requirements()指定header的可见性(transitive_headers)》
《conan 入门(三十四):conan 2.x实现对只有Makefile的项目(erpcgen)的封装示例》
《conan 入门(三十五):在conanfile.py中获取C++编译器完整路径的方法》