conan 入门(三十七):conan 2.x通过定义环境变量(environment)执行make编译只有Makefile的项目(erpcgen)

之前一篇博客《conan 入门(三十四):conan 2.x实现对只有Makefile的项目(erpcgen)的封装示例》介绍如何用AutotoolsToolchain,Autotools实现来编译只有Makefile的项目，因为Autotools.make,Autotools.install方法就是执行make来编译项目。
我原本是想用self.run来执行make进行编译的，因为去年编译erpcgen时，我就是用self.run来执行的(参见 《conan入门(二十六):使用make编译erpc/erpcgen(makefile)》)，那时conan 版本还是1.x，现在conan版本升级到2.x，不再兼容，原来的方式不能使用了，我一直没有搞明白如何合在conan 2.x下创建正确的环境变量，导致一直编译不成功。所以才摸索出用AutotoolsToolchain,Autotools实现来编译只有Makefile的项目。
但显而易见，用Autotools执行Makefile是有些把问题复杂化了。
直到找到conan 的官方说明《The environment management》，我才明白如何为self.run执行命令创建环境变量
以下是《The environment management》一文中的简单示例：

from conan import ConanFile
from conan.tools.env import Environment

class MyTestPkg(ConanFile):
    ...
    def generate(self):
        env = Environment()
        env.define("foo", "var")
        # scope="build" is the default
        envvars = env.vars(self, scope="build")
        # 生成环境变量定义脚本，根据执行环境不同脚本的后缀可以是bat|sh|ps1
        envvars.save_script("my_env")

    def build(self):
        # by default env="conanbuild"
        self.run("my_build_system.exe", env="conanbuild")

该示例中调用了EnvVars.save_script方法将定义的环境变量生成为指定的脚本my_env(根据执行环境不同脚本的后缀可以是bat|sh|ps1)。而这个my_env脚本会自动被在conan_build脚本中调用。
然后在self.run调用时env参数指定env="conanbuild"或env="my_env"就可以正确定义环境变量了。(其实不指定env参数也是可以的，因为默认就是conanbuild)
这个参数的意义就是self.run在执行指定的命令前，先执行env指定的脚本(*.bat|sh|ps1),该脚本用于自动定义环境变量。

如下是在conan build_folder生成的my_env.sh脚本的示例

script_folder="C:\Users\10km0\.conan2\p\b\erpcgba2d8dfcc1f65\b"
echo "echo Restoring environment" > "$script_folder\deactivate_my_env.sh"
for v in FLEX BISON CXX INCLUDES BOOST_ROOT LDFLAGS
do
    is_defined="true"
    value=$(printenv $v) || is_defined="" || true
    if [ -n "$value" ] || [ -n "$is_defined" ]
    then
        echo export "$v='$value'" >> "$script_folder\deactivate_my_env.sh"
    else
        echo unset $v >> "$script_folder\deactivate_my_env.sh"
    fi
done


export foo="var"

如下是在conan build_folder生成的conanbuild.sh脚本示例，只是简单的执行my_env.sh，所以env参数为conanbuild和my_env效果是一样的

. "/c/users/10km0/.conan2/p/b/erpcgba2d8dfcc1f65/b/my_env.sh"

基于此，我们可以在修改之前博客《conan 入门(三十四):conan 2.x实现对只有Makefile的项目(erpcgen)的封装示例》中的conanfile-erpcgen.py，直接使用conan.tools.env.Environment定义环境变量，并使用self.run执行make编译项目
如下，主要的修改都在generate,package方法中

from conan import ConanFile,tools
from conan.tools.env import VirtualBuildEnv,Environment
from conan.tools.microsoft.subsystems import unix_path
from conan.tools.files import copy
import os
import shutil

class ErpcgenConan(ConanFile):
    name = "erpcgen"
    version = "1.7.3-patch"
    # Optional metadata
    license = "BSD-2-Clause"
    author = "guyadong [email protected]"
    url = "https://gitee.com/l0km/erpcex"
    description = "erpcgen base NXP Embedded RPC"
    topics = ("embedded","erpc","nxp","erpcgen")

    package_type = "application"
    requires = "boost/[>=1.69.0]"
    # Binary configuration
    settings = "os", "arch"
    
    # Sources are located in the same place as this recipe, copy them to the recipe
    exports_sources = "erpc/*"

    # 获取 C++编译器位置
    # 基于 boost的conanfile.py中的_cxx 方法剪裁
    # https://github.com/conan-io/conan-center-index/blob/master/recipes/boost/all/conanfile.py
    @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
        compiler_version = str(self.settings_build.compiler.version)
        major = compiler_version.split(".", maxsplit=1)[0]
        if self.settings_build.compiler == "gcc":
            return shutil.which(f"g++-{compiler_version}") or shutil.which(f"g++-{major}") or shutil.which("g++") or ""
        return ""

    def config_options(self):
        if not self.settings_build.compiler == "gcc":
            # 只支持gcc编译,报错退出
            raise Exception("Only support gcc,plese use MinGw compiler for Windows")

    def build_requirements(self):
        if self.settings_build.os == "Windows":
            self.tool_requires("winflexbison/2.5.24")
            self.win_bash = True
            if not self.conf.get("tools.microsoft.bash:path", check_type=str):
                # Windows下需要在MSYS2环境编译
                self.tool_requires("msys2/cci.latest")

        else:
            self.tool_requires("flex/2.6.4")
            self.tool_requires("bison/3.7.6")


    def generate(self):
        env = Environment()
        if self.settings_build.os == "Windows":
            # erpcgen中使用环境变量FLEX定义flex,BISON定义bison,
            # 与winflexbison加载时定义的变量名不一样,所以这里要
            # 定义环境变量 FLEX=$LEX,BISON=$YACC
            env.define('FLEX',self.dependencies.build["winflexbison"].buildenv_info.vars(self).get("LEX"))
            env.define('BISON',self.dependencies.build["winflexbison"].buildenv_info.vars(self).get("YACC"))
            include_path = unix_path(self,os.path.join(self.dependencies.build["winflexbison"].package_folder, "include"))
            # 使用外部定义的C++编译器，避免使用msys2内置的编译器，否则会因为编译版本不一致导致连接错误
            env.define('CXX',unix_path(self,self._cxx))

        else:
            # 定义环境变量 FLEX=$LEX,BISON=$BISON_ROOT/bin/bison
            env.define('FLEX',os.path.join(self.dependencies.build["flex"].package_folder,"bin", "flex"))
            env.define('BISON',self.dependencies.build["bison"].buildenv_info.vars(self).get("CONAN_BISON_ROOT") + "/bin/bison")
            include_path = os.path.join(self.dependencies.build["flex"].package_folder, "include")

        # 将 flex的include文件夹添加到INCLUDES环境变量，参见 erpc/erpcgen/Makefile中INCLUDES变量
        env.append('INCLUDES',include_path)
        # 指定boost位置
        boost_root = unix_path(self,self.dependencies["boost"].package_folder)    
        env.define('BOOST_ROOT',boost_root)
        env.append('LDFLAGS',"-L" + os.path.join(boost_root,"lib"))
        envvars = env.vars(self)
        envvars.save_script("my_env")
        # 输出环境变量
        self.output.info("Environment Variables:")
        for name, value in envvars.items():
            self.output.info(f"{name}={value}")

    def package(self):
        # VERBOSE=1 编译时输出命令
        self.run(f"VERBOSE=0 make -C erpc/erpcgen install PREFIX={unix_path(self,self.package_folder)}")

        if self.settings_build.os == "Windows":
            # 复制 erpcgen.exe 的依赖库到bin
            _cxx_bin = os.path.dirname(self._cxx);
            _dst = os.path.join(self.package_folder,"bin");
            copy(self,"libgcc*.dll",_cxx_bin,_dst)
            copy(self,"libwinpthread*.dll",_cxx_bin,_dst)
            copy(self,"libstdc++*.dll",_cxx_bin,_dst)

conanfile-erpcgen.py 使用示例：

conan create .\conanfile-erpcgen.py 

参考资料

《Creating environment files》
《Running with environment files》
《The environment management》

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++编译器完整路径的方法》
《conan入门(三十六):在set_version方法中从pom.xml中读取版本号实现动态版本定义》
《conan 入门(三十七):conan 2.x通过定义环境变量(environment)执行make编译只有Makefile的项目(erpcgen)》
《conan 入门(三十八):conan二进制包的兼容性及自定义package_id的方式》