Cmake的基础用法

1. 什么是Cmake解决了什么问题当仅有一个源文件是如main.c仅采用gcc即可编译成可执行文件。但一个工程中有成千上万的源文件此时就有了makefile的出现。但又有问题出现了--不同平台的makefile语法、格式不一样这就导致软件想跨平台使用时每次都要根据新的平台编写一次makefile极其麻烦。针对上述问题引入了Cmake。它是一种跨平台工具允许开发者编写与平台无关的CMakeLists.txt文件来制定整个 工程的编译流程再根据具体的编译平台生成本地化的Makefile和工程文件最后执行make编译即Cmake就是生成makefile的工具。2. Cmake的使用方法下边从单源文件编译和不同目录下的多源文件编译两方面来介绍如何使用Cmake搭建编译环境。前提先在Linux环境下安装好Cmake、gcc、g不要忘记装如果没检测到cmake编译会报错。2.1 单源文件编译首先在某个工程文件夹下创建两个文件CmakeLists.txt以及main.c假设是一个hello world程序下边编辑CmakeLists.txt文件如下图所示# 不强制要求写此行代码但最好加上表示Cmake的最低版本要求 cmake_minimum_required(VERSION 3.16) # 表示项目信息括号里边的是自定义的项目名 project(Pro) # 表示生成一个可执行文件有两个参数main代表可执行文件名字 #main.c代表源文件 add_executable(main main.c)编辑完后保存然后在当前工程文件夹所在目录下打开终端执行命令如下# -S代表源代码目录-B代表指定构建目录build如果没有会创建 # 使用此命令代表在build目录下生成makefile cmake -S . -B build # 使用此命令代替make仅需在工程目录下即可使用 # 好处是跨平台能自动生成对应平台的编译工具 cmake --build build即可得到可执行文件main但此时会发现该工作区目录下还会存在很多Cmake的中间文件如下图所示这些文件与可执行文件以及源文件混淆在一起看着很不美观因此可以在工作区目录下再创建一个build文件夹创建好之后进入buiild文件夹cd build/然后再执行下述命令# -S代表源代码目录-B代表指定构建目录build如果没有会创建 # 使用此命令代表在build目录下生成makefile cmake -S . -B build # 使用此命令代替make仅需在工程目录下即可使用 # 好处是跨平台能自动生成对应平台的编译工具 cmake --build build即可将生成的cmake中间文件都保存在build文件夹下了。2.2 多目录多个源文件编译在真实开发环境中我们的代码工程肯定不止一个源文件因此采用的是模块化编程的思想将多个源文件存放在不同的目录在这种情况下Cmake的编译环境搭建目录架构如下图所示可以看到在每一层目录下都有一个CmakeLists.txt文件。接下来需要编辑每一层目录下的CmakeLists.txt文件。顶层Cmake# 版本号要求 cmake_minimum_required(VERSION 3.16) # 项目名 project(HELLO) # 表示告诉Cmake去子目录寻找新的CmakeLists.txt文件进行解析 add_subdirectory(libary) # 去src目录下寻找CmakeLists.txt文件解析 add_subdirectory(src)libhello目录下Cmake# set命令用于设置变量此处表示改编库文件的输出路径为build/lib set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib) # 表示添加库文件libhello为库文件夹名SHARED代表生成的是动态库文件 #以.so结尾STATIC是静态库文件以.a结尾 add_library(libhello SHARED hello.c) # 该命令是改变生成的库文件名 #因为最终生成的库文件名会包含前缀lib和后缀.so如果不加下述命令就会 #编程liblibhello.so不美观加了下述命令就会变成libxx.so set_target_properties(libary PROPERTIES OUTPUT_NAME xx)src目录下Cmake# 该命令用来指明头文件所在的路径并且使用到了PROJECT_SOURCE_DIR变量 # 该变量指向了一个路径表示工程源码的目录 include_directories(${PROJECT_SOURCE_DIR}/libhello) # 改变可执行文件的输出路径在build/bin文件目录下 set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin) # 生成可执行文件hello add_executable(hello main.c) # 链接库文件 target_link_libraries(hello libhello)一切就绪后进入build文件夹运行下述命令# -S代表源代码目录-B代表指定构建目录build如果没有会创建 # 使用此命令代表在build目录下生成makefile cmake -S . -B build # 使用此命令代替make仅需在工程目录下即可使用 # 好处是跨平台能自动生成对应平台的编译工具 cmake --build build即可得到可执行文件hello。如果libhello下的目录结构再改一下hello.c保存在libhello/src下hello.h保存在libhello/inc文件夹下此时的CmakeLists.txt要改写为# 设置库文件输出路径 set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib) # 获取当前目录下的src文件夹下的所有.c文件 file(GLOB LIB_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src/*.c) # 添加成动态库文件 add_library(libhello SHARED ${LIB_SOURCES}) # 指定 libhello/inc/ 为头文件目录PUBLIC 意味着链 # 接此库的目标如 main也能自动找到这些头文件 target_include_directories(libhello PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/inc) # 改变生成的库文件名字为libxx.so否则为liblibhello.so set_target_properties(libhello PROPERTIES OUTPUT_NAME xx)Notetarget_include_directories(命令中用了一个关键字PUBLIC表示如果下游的文件main.c要使用到hello.c里边的功能时需要加关键字PUBLIC如果不用需要将关键字改为PRIVATE。总结来说有这几种权限private代表仅对当前目标有效public对当前目标和链接它的目标都有效interface仅对链接它的目标有效。2.3 target_compile_definitions命令该命令用于向指定的目标库添加预处理器比如# 用于向指定目标vision_command_line库添加预处理器在编译时该定义会被编译器识别为#define XXX # private代表仅对当前目标有效public对当前目标和链接它的目标都有效interface仅对链接它的目标有效 # 宏名为 VISION_DEFAULT_RECIPE_PATH值为${VISION_RECIPE_PATH} target_compile_definitions( vision_command_line PRIVATE VISION_DEFAULT_RECIPE_PATH${VISION_RECIPE_PATH} )上图表示在指定的目标库vision_comman_line中添加预处理器当编译时会被编译器识别成#define VISION_DEFAULT_RECIPE_PATH ${VISION_RECIPE_PATH};后边代表宏的值这是变量可以任意改变。这样做的好处是如果要修改宏VISION_DEFAULT_RECIPE_PATH的值只需要在CMakeLists.txt中修改即可无需修改代码本身提高了灵活性和可维护性。2.4 add_library命令这个命令代表添加库的意思其实就是把c/cpp文件链接成一个库文件举例add_library(vision_capture src/camera/v4l2_camera_provider.cpp )上述就是将xxx.cpp添加成库文件vision_capture。2.5 target_include_directories命令一个源文件必然有与之配套的头文件因此这个命令用于链接相应的头文件用法如下target_include_directories(vision_capture PUBLIC src include ${OpenCV_INCLUDE_DIRS})2.6 target_link_libraries命令该命令用于链接库比如a.c文件中调用了b.c文件定义的函数那么就需要用这个命令来添加依赖关系target_link_libraries(vision_capture PUBLIC vision_data ${OpenCV_LIBS})3. 总结本篇文章笔者仅讲解了Cmake的基础用法。实际上Cmake还有很多语法和格式包括函数、条件、循环等大家在用到时再自行琢磨。