conan 入门(三十二):package_info中配置禁用CMakeDeps生成使用项目自己生成的config.cmake

news2024/12/22 20:07:22

conanfile.py中定义的package_info()方法用于向package的调用者(conumer)提供包库名，编译/连接选项，文件夹等等信息，有了这些信息构建工具的generator就可以根据它们生成对应的文件，用于调用者引用package.
比如基于cmake的CMakeDeps可以根据这些信息自动生成Find<Package>.cmake和<Package>-config.cmake.
调用者的CMakeLists.txt中通过FindPackage(<Package>)就可以自动找到package.创建对应的import target.

比如我为mnn 项目写的conanfile.py(https://gitee.com/l0km/mnn/blob/conan1.2.7/conanfile.py)

    def package_info(self):
        self.cpp_info.libs = ["MNN"]
        if not self.options.shared :
            if self.settings.compiler == "msvc":
                self.cpp_info.sharedlinkflags.extend(["/WHOLEARCHIVE:MNN"])
                self.cpp_info.exelinkflags = self.cpp_info.sharedlinkflags
            elif self.settings.compiler == "gcc":
                # about LINKER: ,see also https://cmake.org/cmake/help/latest/command/target_link_options.html#handling-compiler-driver-differences
                self.cpp_info.sharedlinkflags.extend(["LINKER:--whole-archive",self._mnn_lib,"LINKER:--no-whole-archive"])
                self.cpp_info.exelinkflags = self.cpp_info.sharedlinkflags
            elif self.settings.compiler == "clang":
                self.cpp_info.sharedlinkflags.extend(["LINKER:--whole-archive",self._mnn_lib,"LINKER:--no-whole-archive"])
                self.cpp_info.exelinkflags = self.cpp_info.sharedlinkflags

mnn这个项目本身没有生成cmake配置文件，但conan会在调用方在引用mnn package时CMakeDeps generator会自动生成mnn-config.cmake及相关文件，如下图,这样就减少了package开发中编译脚本的工作量。
在这里插入图片描述

但是有的时候，package本身的CMake编译脚本中已经有了config-cmake生成的逻辑，可以自己生成config-cmake.我们可以通过在package_info()进行配置，让conan使用package自带的config.cmake.而不需要CMakeDeps生成cmake配置文件。

如下在package_info中定义builddirs和cmake_find_mode参数就可以实现

    def package_info(self):
        self.cpp_info.builddirs.append(self.package_folder)
        self.cpp_info.set_property("cmake_find_mode", "none")

参见《Disable CMakeDeps For Installed CMake configuration files》

jpegwrapper是我几年前写的一个jpeg相关项目，最近给它增加了conan支持，这个项目原本就会自动生成config.cmake。所以写conanfile.py时我希望调用者使用原本的config.cmake，
所以在package_info方法就是通过上面的定义来实现的：

https://gitee.com/l0km/jpegwrapper/blob/master/conanfile.py

    def package_info(self):
        self.cpp_info.libs = ["jpegwrapper"]
        # 指定将安装路径加入CMAKE_PREFIX_PATH,以便执行find_package时能扫描到安装路径
        self.cpp_info.builddirs.append(self.package_folder)
        # 抑制conan生成jpegwrapper-config.cmake使用jpegwrapper自己生成的cmake配置文件 
        self.cpp_info.set_property("cmake_find_mode", "none")
        # cmake_find_mode为none时不需要配置此参数
        #self.cpp_info.requires = ["common_source_cpp::common_source_cpp","libjpeg-turbo::libjpeg-turbo","openjpeg::openjpeg"]