conan 入门(三十四):conan 2.x实现对只有Makefile的项目(erpcgen)的封装示例

2023-12-02 19:12
文章标签 实现 封装 入门 项目 示例 makefile 三十四 conan erpcgen

本文主要是介绍conan 入门(三十四):conan 2.x实现对只有Makefile的项目(erpcgen)的封装示例，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

一些已有的较老旧的项目只有Makefile，一般在Linux下编译，windows下编译需要借助cygwin或msys2,对于这样的项目如何实现conanfile.py使用conan进行构建呢？本文以erpc/erpcgen为例，说明实现步骤。

eRPC (Embedded RPC是一个适用于嵌入式系统的开源RPC框架，erpc/erpcgen为其下的IDL编译器，编译基于Makefile.现在需要把它封装为conan的package.这就是我最近遇到的问题。
下面我们分步说明实现的要点

requires

erpcgen依赖很简单，只有boost

requires = "boost/[>=1.69.0]"

build_requirements

erpcgen编译依赖的工具需要flex,bision,在windows下就是winflexbison,
在windows下需要在msys2环境编译，工具依赖还要加上msys2

    def build_requirements(self):if self._settings_build.os == "Windows":self.tool_requires("winflexbison/2.5.24")self.win_bash = Trueif 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")

msys2中的C++编译器

上一节说了windows下需要在msys2环境编译，msys2也是可以有自带的c++编译器的。如果msys2中的c++编译器与profile中定义的gcc编译版本不一致。那么erpcgen编译阶段可以正常通过，但在连接过程就会报错。因为依赖库boost的适用版本是按profile中定义的编译器版本提供的。
所以在msys2环境执行编译时不能使用msys2自带的编译器，需要通过CXX环境变量将windows系统安装的g++编译器传递给msys2环境而使用指定的外部编译器。
所以需要在 build_requirements 方法中增加如下逻辑，将在windows shell中获取g++编译器的全路径保存到成员self.cxx_path，注意这个时时候self.win_bash不能为True

    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]

然后这个self.cxx_path会在后面的AutotoolsToolchain生成时被定义到CXX环境变量中

generate

erpcgen中需要的编译工具flex,bision的可执行程序，头文件位置，以及boost的位置都是通过环境变量提供给Makefile的。所以需要在 generate 方法中定义相应的环境变量：FLEX,BISON,BOOST_ROOT,INCLUDES
同时还有上一节涉及到的将windows系统下的C++编译器位置通过定义CXX变量提供给msys2环境。
这里使用AutotoolsToolchain实现环境变量修改，与后面的package方法中的Autotools匹配

    def generate(self):tc = AutotoolsToolchain(self)env = tc.environment()if self._settings_build.os == "Windows":# erpcgen中使用环境变量FLEX定义flex,BISON定义bison,# 与winflexbison加载时定义的变量名不一样,所以这里要# 定义环境变量 FLEX=$LEX,BISON=$YACCenv.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_path))else:# 定义环境变量 FLEX=$LEX,BISON=$BISON_ROOT/bin/bisonenv.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"))tc.generate(env)# 输出环境变量self.output.info("Environment Variables:")for name, value in env.vars(self).items():self.output.info(f"{name}={value}")

package

虽然erpcgen项目不是autools生成的项目，但它可以调用make执行Makefile.所以在此一样可以使用AutotoolsToolchain，Autotools实现编译
如下package方法执行Autotools.install 方法实现 erpcgen编译并安装到package_folder

    def package(self):autotools = Autotools(self)autotools.install(args=["-C", "erpc/erpcgen", "PREFIX={}".format(unix_path(self,self.package_folder))])

完整代码

完整的python代码

from conan import ConanFile,tools
from conan.tools.env import VirtualBuildEnv
from conan.tools.microsoft.subsystems import unix_path
from conan.tools.files import chdir
from conan.tools.gnu import Autotools, AutotoolsToolchain
import os
from six import StringIOclass ErpcgenConan(ConanFile):name = "erpcgen"version = "1.7.3-patch"# Optional metadatalicense = "BSD-2-Clause"author = "guyadong 10km0811@sohu.com"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 configurationsettings = "os", "compiler", "build_type", "arch"options = {"shared": [True, False], "fPIC": [True, False]}default_options = {"shared": False, "fPIC": True}# Sources are located in the same place as this recipe, copy them to the recipeexports_sources = "erpc/*"@propertydef _settings_build(self):return getattr(self, "settings_build", self.settings)@propertydef _cxx_path(self):if self._settings_build.os == "Windows":buf = StringIO()self.run("where g++",stdout=buf)if not buf.getvalue():raise Exception("Not found g++ compiler by 'where gcc'")# 获取命令返回的第一行return buf.getvalue().strip().split('\r\n')[0]else:return ""def config_options(self):if self.settings.os == "Windows":del self.options.fPICif self.settings.compiler == "msvc":# 不支持Visual Studio编译,报错退出raise Exception("Unsupport Visual Studio,plese use MinGw compiler for Windows")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]self.tool_requires("winflexbison/2.5.24")self.win_bash = Trueif 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):tc = AutotoolsToolchain(self)env = tc.environment()if self._settings_build.os == "Windows":# erpcgen中使用环境变量FLEX定义flex,BISON定义bison,# 与winflexbison加载时定义的变量名不一样,所以这里要# 定义环境变量 FLEX=$LEX,BISON=$YACCenv.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_path))else:# 定义环境变量 FLEX=$LEX,BISON=$BISON_ROOT/bin/bisonenv.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"))tc.generate(env)# 输出环境变量self.output.info("Environment Variables:")for name, value in env.vars(self).items():self.output.info(f"{name}={value}")def package(self):autotools = Autotools(self)autotools.install(args=["-C", "erpc/erpcgen", "PREFIX={}".format(unix_path(self,self.package_folder))])

完整的项目参见我的代码仓库：https://gitee.com/l0km/erpcex

conanfile-erpcgen.py 使用示例：

conan create .\conanfile-erpcgen.py

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 入门(三十四):conan 2.x实现对只有Makefile的项目(erpcgen)的封装示例的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/446472。

相关文章

分布式锁在Spring Boot应用中的实现过程

分布式锁在Spring Boot应用中的实现过程

《分布式锁在SpringBoot应用中的实现过程》文章介绍在SpringBoot中通过自定义Lock注解、LockAspect切面和RedisLockUtils工具类实现分布式锁,确保多实例并发操作... 目录Lock注解LockASPect切面RedisLockUtils工具类总结在现代微服务架构中，分布
阅读更多...
Java使用Thumbnailator库实现图片处理与压缩功能

Java使用Thumbnailator库实现图片处理与压缩功能

《Java使用Thumbnailator库实现图片处理与压缩功能》Thumbnailator是高性能Java图像处理库,支持缩放、旋转、水印添加、裁剪及格式转换,提供易用API和性能优化,适合Web应... 目录1. 图片处理库Thumbnailator介绍2. 基本和指定大小图片缩放功能2.1 图片缩放的
阅读更多...
精选20个好玩又实用的的Python实战项目(有图文代码)

精选20个好玩又实用的的Python实战项目(有图文代码)

《精选20个好玩又实用的的Python实战项目(有图文代码)》文章介绍了20个实用Python项目,涵盖游戏开发、工具应用、图像处理、机器学习等,使用Tkinter、PIL、OpenCV、Kivy等库... 目录① 猜字游戏② 闹钟③ 骰子模拟器④ 二维码⑤ 语言检测⑥ 加密和解密⑦ URL缩短⑧ 音乐播放
阅读更多...
Python使用Tenacity一行代码实现自动重试详解

Python使用Tenacity一行代码实现自动重试详解

《Python使用Tenacity一行代码实现自动重试详解》tenacity是一个专为Python设计的通用重试库,它的核心理念就是用简单、清晰的方式,为任何可能失败的操作添加重试能力,下面我们就来看... 目录一切始于一个简单的 API 调用Tenacity 入门：一行代码实现优雅重试精细控制：让重试按我
阅读更多...
Springboot项目启动失败提示找不到dao类的解决

Springboot项目启动失败提示找不到dao类的解决

《Springboot项目启动失败提示找不到dao类的解决》SpringBoot启动失败,因ProductServiceImpl未正确注入ProductDao,原因：Dao未注册为Bean,解决：在启... 目录错误描述原因解决方法总结***************************APPLICA编
阅读更多...
MySQL常用字符串函数示例和场景介绍

MySQL常用字符串函数示例和场景介绍

《MySQL常用字符串函数示例和场景介绍》MySQL提供了丰富的字符串函数帮助我们高效地对字符串进行处理、转换和分析,本文我将全面且深入地介绍MySQL常用的字符串函数,并结合具体示例和场景,帮你熟练... 目录一、字符串函数概述1.1 字符串函数的作用1.2 字符串函数分类二、字符串长度与统计函数2.1
阅读更多...
Redis客户端连接机制的实现方案

Redis客户端连接机制的实现方案

《Redis客户端连接机制的实现方案》本文主要介绍了Redis客户端连接机制的实现方案,包括事件驱动模型、非阻塞I/O处理、连接池应用及配置优化,具有一定的参考价值,感兴趣的可以了解一下... 目录1. Redis连接模型概述2. 连接建立过程详解2.1 连php接初始化流程2.2 关键配置参数3. 最大连
阅读更多...
Python实现网格交易策略的过程

Python实现网格交易策略的过程

《Python实现网格交易策略的过程》本文讲解Python网格交易策略,利用ccxt获取加密货币数据及backtrader回测,通过设定网格节点,低买高卖获利,适合震荡行情,下面跟我一起看看我们的第一... 网格交易是一种经典的量化交易策略，其核心思想是在价格上下预设多个“网格”，当价格触发特定网格时执行买
阅读更多...
Spring WebClient从入门到精通

Spring WebClient从入门到精通

《SpringWebClient从入门到精通》本文详解SpringWebClient非阻塞响应式特性及优势,涵盖核心API、实战应用与性能优化,对比RestTemplate,为微服务通信提供高效解决... 目录一、WebClient 概述1.1 为什么选择 WebClient？1.2 WebClient 与
阅读更多...
python设置环境变量路径实现过程

python设置环境变量路径实现过程

《python设置环境变量路径实现过程》本文介绍设置Python路径的多种方法：临时设置（Windows用`set`,Linux/macOS用`export`）、永久设置（系统属性或shell配置文件... 目录设置python路径的方法临时设置环境变量（适用于当前会话）永久设置环境变量（Windows系统
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2