Linux中使用CMake导入第三方开发库

Linux中使用CMake导入第三方开发库

背景

一般CMake中导入第三方库主要使用如下三个方法：

1. find_package
   主要使用场景是第三方库提供了CMake文件或是CMake官方适配了部分流行的开发库。
2. FindPkgConfig
   主要使用场景是第三方库没有提供CMake文件，但是提供了pkg-config文件。
3. FetchContent
   主要使用场景是从开发者网站获取最新源码或是制定版本的源码，并且这个开发库提供了CMake文件或是pkg-config文件。

上述三种场景，官方文档都有示例可以参考。今天主要记录下第三方开发库中没有提供CMake文件和pkg-config文件的情况下，如何使用CMake优雅的导入这个库。

add_library的imported用法

add_library 常用于生成静态或动态库，其实也可用于从外部导入第三方库。

add_library(<name> <type> IMPORTED [GLOBAL])

以libyuv-dev为例，其在linux中的安装目录结构和文件如下，没有CMake文件或是pkg-config文件。

/.
/usr
/usr/include
/usr/include/libyuv
/usr/include/libyuv/basic_types.h
/usr/include/libyuv/compare.h
/usr/include/libyuv/compare_row.h
/usr/include/libyuv/convert.h
/usr/include/libyuv/convert_argb.h
/usr/include/libyuv/convert_from.h
/usr/include/libyuv/convert_from_argb.h
/usr/include/libyuv/cpu_id.h
/usr/include/libyuv/macros_msa.h
/usr/include/libyuv/mjpeg_decoder.h
/usr/include/libyuv/planar_functions.h
/usr/include/libyuv/rotate.h
/usr/include/libyuv/rotate_argb.h
/usr/include/libyuv/rotate_row.h
/usr/include/libyuv/row.h
/usr/include/libyuv/scale.h
/usr/include/libyuv/scale_argb.h
/usr/include/libyuv/scale_row.h
/usr/include/libyuv/scale_uv.h
/usr/include/libyuv/version.h
/usr/include/libyuv/video_common.h
/usr/include/libyuv.h
/usr/lib
/usr/lib/x86_64-linux-gnu
/usr/lib/x86_64-linux-gnu/libyuv.a
/usr/share
/usr/share/doc
/usr/share/doc/libyuv-dev
/usr/share/doc/libyuv-dev/copyright
/usr/lib/x86_64-linux-gnu/libyuv.so
/usr/share/doc/libyuv-dev/changelog.Debian.gz

我们可以在项目中新建一个名如third_part.cmake文件，使用add_library导入这个库。

add_library(libyuv SHARED IMPORTED GLOBAL)
set_target_properties(libyuv PROPERTIES IMPORTED_LOCATION "/usr/lib/x86_64-linux-gnu/libyuv.so"
                                        INCLUDE_DIRECTORIES "/usr/include/")

其中,add_library中的IMPORTED表示这个库文件是外部导入，不参与本项目的编译。set_target_properties中的IMPORTED_LOCATION指定这个库的so文件的路径，INCLUDE_DIRECTORIES指定库的头文件所在目录的路径。

整个项目的目录结构如下：

ubuntu-razer:~/CLionProjects/cmake_library_imported$ tree
.
├── cmake
│ └── third_part.cmake
├── CMakeLists.txt
└── main.cpp

项目根目录中CMakeList.txt可以如下方式引用libyuv。整体来看，项目结构简洁，可读性高。

cmake_minimum_required(VERSION 3.28)
project(cmake_library_imported)
set(CMAKE_CXX_STANDARD 20)
include(cmake/third_part.cmake)
add_executable(cmake_library_imported main.cpp)
target_link_libraries(cmake_library_imported PRIVATE libyuv)

参考文章

1. https://cmake.org/cmake/help/latest/command/find_package.html
2. https://cmake.org/cmake/help/latest/module/FindPkgConfig.html
3. https://cmake.org/cmake/help/latest/module/FetchContent.html
4. https://cmake.org/cmake/help/latest/command/add_library.html#add-library
5. https://cmake.org/cmake/help/latest/guide/importing-exporting/index.html#importing-libraries