package_type
从conan 2.x开始conafile.py增加了一个字段package_type
,用于定义当前package的类型,
参见 package-type
如果我们在写conanfile.py时不指定这个成员,则它默认为library
Requirement traits
不同的包类型定义默认定义不同的需求特性(Requirement traits),如下:
参见《package_type trait inferring》
关于headers,libs,run,visible,transitive_headers,transitive_libs
特性的说明参见《requirements()》
requirements()
conan 允许在conanfile.py的requirements()方法中手工指定依赖包的特性。
示例
一般来说,只要正确定义了package_type
,每个包类型提供的默认需求特性(Requirement traits)是满足大多数使用场景的。
不过conan包的头文件可见性只能传递一代,即只能传递直接引用包的项目,不能跨代传递。所以如果需要跨代传递,就要通过requirements()方法来指定transitive_headers
如下为一个conan 包 jpegwrapper的依赖树,其中common_source_cpp
的类型(package_type)为header_only
,libjpeg-turbo
和openjpege
为 library
,
如下为jpegwrapperr 测试项目的依赖定义文件conanfile.txt
[requires]
cimg/2.8.3
jpegwrapper/1.1.1-dev
[generators]
CMakeDeps
CMakeToolchain
对应的测试项目的依赖树如下
如果简单的如下定义jpegwrapper的依赖库列表
from conan import ConanFile
from conan.tools.cmake import CMake, CMakeDeps, CMakeToolchain
from conan.tools.env import VirtualBuildEnv
class JpegwrapperConan(ConanFile):
requires="libjpeg-turbo/2.1.5","openjpeg/2.3.1","common_source_cpp/1.0.1"
会在测试项目编译时报错CImg.h
找不到jpeglib.h
,也就是turbo-jpeg
的头文件。为会这样呢?
这是因为对于library
类型的依赖包,库文件可以向下传递,但头文件对于下游默认不可见的。
而上面测试项目的依赖树中cimg这个header_only的包中头文件引用了jpeglib.h
,所以问题就发生了。
我们详细看一下requirements()中对于transitive_headers,transitive_libs
特性的说明:
transitive_headers
If True the headers of the dependency will be visible downstream.
为True则依赖库的头文件对于下游可见transitive_libs
If True the libraries to link with of the dependency will be visible downstream.
为True则依赖库的库文件对于下游可见
再回顾一下上面《Requirement traits》章节,发现不论是static-library
还是shared-library
类型都没有定义transitive_headers
为True,即conan不会将openjpeg和turbo-jpeg的头文件传递jpegwrapper的下游调用者(consumer)。
所以CMakeDeps generator为turbo-jpeg生成的cmake配置文件中定义的import target中没有将依赖库的头文件位置定义到INTERFACE_INCLUDE_DIRECTORIES
属性,最终生成的Makefile中也就自然没有turbo-jpeg的头文件位置
要解决这个问题,就是要更新jpegwrapper的conanfile.py中对于依赖库的定义方式,通过self.requires()
方法强制指定transitive_headers=True
:
from conan import ConanFile
from conan.tools.cmake import CMake, CMakeDeps, CMakeToolchain
from conan.tools.env import VirtualBuildEnv
class JpegwrapperConan(ConanFile):
# requires="libjpeg-turbo/2.1.5","openjpeg/2.3.1","common_source_cpp/1.0.1"
def requirements(self):
self.requires("common_source_cpp/1.0.1", transitive_headers=True)
self.requires("libjpeg-turbo/2.1.5", transitive_headers=True)
self.requires("openjpeg/2.3.1", transitive_headers=True)
jpegwrapper的conanfile.py的完整代码参见 https://gitee.com/l0km/jpegwrapper/blob/master/conanfile.py
参考资料
requirements()
package-type