【C++ 基础】CmakeLists常用语法以及实操

最新推荐文章于 2024-05-14 23:31:03 发布
最新推荐文章于 2024-05-14 23:31:03 发布
阅读量2.5k 收藏 26
点赞数 22
分类专栏： C++ 文章标签： c++ 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_37245700/article/details/135122982
版权

CMakeLists语法

1.1 设置版本要求

CMAKE_MINIMUM_REQUIRED(VERSION 3.8.0)

1.2 设置工程名

SET(TARGET "工程名")

1.3 声明变量

SET(TARGET_OUTPUT_NAME "libZLMediaKit");

1.3.1 常用的预定义变量

CMAKE_MAJOR_VERSION：cmake 主版本号
CMAKE_MINOR_VERSION：cmake 次版本号
CMAKE_C_FLAGS：设置 C 编译选项
CMAKE_CXX_FLAGS：设置 C++ 编译选项
PROJECT_SOURCE_DIR：工程的根目录
PROJECT_BINARY_DIR：运行 cmake 命令的目录
CMAKE_CURRENT_SOURCE_DIR：当前CMakeLists.txt 所在路径
CMAKE_CURRENT_BINARY_DIR：目标文件编译目录
EXECUTABLE_OUTPUT_PATH：重新定义目标二进制可执行文件的存放位置
LIBRARY_OUTPUT_PATH：重新定义目标链接库文件的存放位置
UNIX：如果为真，表示为UNIX-like的系统，包括AppleOSX和CygWin
WIN32：如果为真，表示为 Windows 系统，包括 CygWin
APPLE：如果为真，表示为 Apple 系统
CMAKE_SIZEOF_VOID_P：表示void*的大小（例如为4或者8），可以使用其来判断当前构建为32位还是64位
CMAKE_CURRENT_LIST_DIR：表示正在处理的CMakeLists.txt文件所在目录的绝对路径
CMAKE_ARCHIVE_OUTPUT_DIRECTORY：用于设置ARCHIVE目标的输出路径
CMAKE_LIBRARY_OUTPUT_DIRECTORY：用于设置LIBRARY目标的输出路径
CMAKE_RUNTIME_OUTPUT_DIRECTORY：用于设置RUNTIME目标的输出路径

1.4 引用变量

${TARGET_OUTPUT_NAME}

1.5 输出变量

message("${TARGET_OUTPUT_NAME}");

1.6引入到include

可以使用#include 包含头文件

INCLUDE_DIRECTORIES(头文件所在文件夹路径)
SET (FILE_INCLUDE_PATH "D:\\workspace\\Codec")
INCLUDE_DIRECTORIES(${FILE_INCLUDE_PATH})

1.7 把文件夹下所有子目录在工程中显示

如果文件夹下没有任何文件，那么在工程中就不会显示

# 设置工程名——A
SET (TARGET "myProject")
# 设置需要在工程中显示的文件夹名——B
SET (FILE_INCLUDE_PATH "D:\\workspace\\Codec")
# 获取文件夹B下的全部子目录
file(GLOB subdirectories RELATIVE ${FILE_INCLUDE_PATH} ${FILE_INCLUDE_PATH}/*)
# 遍历获取到的子目录名
foreach(subdirectory ${subdirectories})
	# 设置每个子目录名的路径
	SET(ITEM_PATH "${FILE_INCLUDE_PATH}/${subdirectory}")
	# 获取每个子目录路径下的所有.h、.cpp、.c文件，并命名为ITEM
	file(GLOB ITEM "${ITEM_PATH}/*.h" "${ITEM_PATH}/*.cpp" "${ITEM_PATH}/*.c")
	# 将ITEM命名为${subdirectory}，也就是子目录名，并在工程中显示
	source_group(${subdirectory} FILES ${ITEM})
	# 将ITEM中的文件加入名为ALL_SOURCES的list中
	list(APPEND ALL_SOURCES ${ITEM})
endforeach()

# 将ALL_SOURCES中的文件放入工程的lib中，并可共享
ADD_LIBRARY(${TARGET} SHARED ${ALL_SOURCES})

1.8 如果文件夹下的子目录中还有子目录需要在工程中显示

# 设置工程名——A
SET (TARGET "myProject")
# 设置需要在工程中显示的文件夹名——B
SET (FILE_INCLUDE_PATH "D:\\workspace\\Codec")
# 获取文件夹B下的全部子目录
file(GLOB subdirectories RELATIVE ${FILE_INCLUDE_PATH} ${FILE_INCLUDE_PATH}/*)
# 遍历获取到的子目录名
foreach(subdirectory ${subdirectories})
	# 设置每个子目录名的路径
	SET(ITEM_PATH "${FILE_INCLUDE_PATH}/${subdirectory}")
	# 获取每个子目录路径下的所有.h、.cpp、.c文件，并命名为ITEM
	file(GLOB ITEM "${ITEM_PATH}/*.h" "${ITEM_PATH}/*.cpp" "${ITEM_PATH}/*.c")
	# 将ITEM命名为${subdirectory}，也就是子目录名，并在工程中显示
	source_group(${subdirectory} FILES ${ITEM})
	# 将ITEM中的文件加入名为ALL_SOURCES的list中
	list(APPEND ALL_SOURCES ${ITEM})
endforeach()

SET (SUBFILE_INCLUDE_PATH "D:\\workspace\\Codec\\Encode")
file(GLOB directories RELATIVE ${SUBFILE_INCLUDE_PATH} ${SUBFILE_INCLUDE_PATH}/*)
# 遍历获取到的子目录名
foreach(directory ${directories})
	# 设置每个子目录名的路径
	SET(ITEM_PATH "${SUBFILE_INCLUDE_PATH}/${directory}")
	# 获取每个子目录路径下的所有.h、.cpp、.c文件，并命名为ITEM
	file(GLOB ITEM "${ITEM_PATH}/*.h" "${ITEM_PATH}/*.cpp" "${ITEM_PATH}/*.c")
	
	# 主要区别在这里，其他的没变化
	# 将ITEM命名为${SUBFILE_INCLUDE_PATH}/${directory}，也就是父文件名\子目录名，并在工程中显示
	source_group(${SUBFILE_INCLUDE_PATH}/${directory} FILES ${ITEM})
	
	
	# 将ITEM中的文件加入名为ALL_SOURCES的list中
	list(APPEND ALL_SOURCES ${ITEM})
endforeach()

# 将ALL_SOURCES中的文件放入工程的lib中，生成动态库
ADD_LIBRARY(${TARGET} SHARED ${ALL_SOURCES})
# 生成静态库
ADD_LIBRARY(${TARGET} STATIC ${ALL_SOURCES})

1.9在project下创建子项目

如果顶层CMakeLists.txt，定义了project。

# 创建工程，设置工程名为myProject，使用的语言是c c++。
project(myProject LANGUAGES C CXX)

二、CMakeLists编写的技巧

初学者的理解：

  • 顶层cmake需要设置project
  • 如果没有需要引用的外部库，就直接
    • add_library（不需要执行的子项目）或者
    • add_executable（需要执行的子项目）或者
    • 只需要以文件夹的形式显示，file收集需要显示的文件，source_group为其分组（设置显示的名字），最后add_library所有文件，才能在VS项目中显示
  • 如果需要引入外部库，使用include_directories

其他一些常用的：

  • file，获取指定文件下的指定类型文件

  • aux_source_directory，获取指定文件夹下的所有源文件

  • include_directories，获取指定路径下的所有头文件，使用时其形式为include “*.h”，如果还有子文件夹会遍历子文件夹，并把子文件名作为include时的路径元素，比如include “subdir/*.h”。

  • 设置VS中文件夹路径

    见3.4

三、实操

3.1 project

CMAKE_MINIMUM_REQUIRED(VERSION 3.1.3...3.8.0)
project(myProject)
set(CMAKE_CXX_STANDARD 11)

file(GLOB source_list ${CMAKE_CURRENT_SOURCE_DIR}/src/mediaServer/source/*.cpp ${CMAKE_CURRENT_SOURCE_DIR}/src/mediaServer/source/*.h)
source_group("src" FILES ${source_list})
add_library(${PROJECT_NAME} SHARED ${source_list})

在这里插入图片描述

这里又需要注意的地方，就是这个project下面必须要又内容，才能被可视。如果上述cmakelists代码，只有如下：

CMAKE_MINIMUM_REQUIRED(VERSION 3.1.3...3.8.0)
project(myproject)
set(CMAKE_CXX_STANDARD 11)

那么就没有myproject项目的显示，如下：

在这里插入图片描述

3.2 只想文件夹下的各个文件在VS中显示

只想这些文件在文件夹下显示，而不是在子项目中显示

#找到执行路径下所有cpp和h文件，并存放在source_list中
file(GLOB source_list ${CMAKE_CURRENT_SOURCE_DIR}/src/mediaServer/source/*.cpp ${CMAKE_CURRENT_SOURCE_DIR}/src/mediaServer/source/*.h)
add_library(${PROJECT_NAME} SHARED ${source_list})

如果这样写，会将指定路径下的所有指定类型的文件，全部在myproject的Source Files和Header Files中显示，系统会自动将头文件和源文件分开。

如下

在这里插入图片描述

如果需要将，指定文件夹下的所有文件存放在一个文件夹下在VS中显示，需要使用source_group，如下

CMAKE_MINIMUM_REQUIRED(VERSION 3.1.3...3.8.0)
project(myproject)
set(CMAKE_CXX_STANDARD 11)

set(mediaserver_source_root ${CMAKE_CURRENT_SOURCE_DIR}/src/mediaServer/source)

file(GLOB source_list ${mediaserver_source_root}/*.cpp ${mediaserver_source_root}/*.h)
source_group("src" FILES ${source_list})

add_library(${PROJECT_NAME} SHARED ${source_list})

在这里插入图片描述

3.3 加入库，通过include使用

使用add_library加入project后，就可以直接使用，示例代码入3.2所示

在这里插入图片描述

3.4 set FOLDER

在VS中设置文件夹路径

#需要先将能使用文件夹打开
set_property(GLOBAL PROPERTY USE_FOLDERS ON)
#再设置文件夹路径
set(FOLDER_PATH "TEST")
#最后将需要放在该文件夹下的子项目或文件夹，链接上
set_target_properties(${TARGET} PROPERTIES FOLDER ${FOLDER_PATH})

其中将使用文件夹功能打开，建议在顶层cmakelists文件中设置，设置后，全局都默认是打开的。

具体示例代码：

# 设置target名字
SET(TARGET PUSHER)
# 开启使用文件夹
set_property(GLOBAL PROPERTY USE_FOLDERS ON)
# 设置pusher的源文件路径
set(PUSHER_SOURCE_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/src)
# 获取源文件下所有的cpp文件
aux_source_directory(${PUSHER_SOURCE_ROOT} pusher_source_list 
# 加入到库，会创建子项目
add_library(PUSHER ${pusher_source_list})
# 设置文件夹名字
set(FOLDER_PATH "TEST")
# 将子项目放入该文件夹下
set_target_properties(${TARGET} PROPERTIES FOLDER ${FOLDER_PATH})

结果如下：

在这里插入图片描述

3.5 使用其他库的头文件

如下

在这里插入图片描述

有两个项目，myproject和PUSHER，现在这两个项目，只能使用其自己项目的头文件。如果PUSHER的name.cpp需要使用myproject的Client.h或者Server.h，是会报错的，如下

在这里插入图片描述

如果需要PUSHER使用（include）myproject的头文件，那么需要使用include_directories。

具体代码如下

SET(TARGET PUSHER)
set(PUSHER_SOURCE_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/src)
message("PUSHER_SOURCE_ROOT: ${PUSHER_SOURCE_ROOT}")
aux_source_directory(${PUSHER_SOURCE_ROOT} pusher_source_list )
message("pusher_source_list : ${pusher_source_list}")
foreach(item ${pusher_source_list})
	message("pusher_source_list :${item}")
endforeach()
add_executable(PUSHER ${pusher_source_list})
set(FOLDER_PATH "TEST")
message("FOLDER_PATH : ${FOLDER_PATH}")
message("TARGET_NAME : ${TARGET}")
set_target_properties(${TARGET} PROPERTIES FOLDER ${FOLDER_PATH})

# 主要是
# 设置需要include的库路径
set(3rdpart_root ${PROJECT_SOURCE_DIR}/src/mediaServer/source)
message("3rdpart_root : ${3rdpart_root}")
# 加入库
include_directories("${3rdpart_root}")

这样之后，就能够使用myprojecct的头文件了。结果如下：

在这里插入图片描述

如果某个路径下，有多个文件夹，每个文件夹下都有需要include的头文件，那么直接include_directories其上层路径，如下

set(3rdpart_root ${PROJECT_SOURCE_DIR}/src/mediaServer)
message("3rdpart_root : ${3rdpart_root}")
include_directories("${3rdpart_root}")

注意和上面的区别，只是mediaServer后面没有跟具体include哪个文件夹下的头文件，测试效果如下：

在这里插入图片描述
在这里插入图片描述

豆得儿不是猫
关注
  • 22
    点赞
  • 踩
  • 26
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
C++版本使用CMakeLists.txt编译（不同目录多个源文件）可执行文件
07-12
C++版本使用CMakeLists.txt编译（不同目录多个源文件）可执行文件-C++版本使用CMakeLists.txt编译（不同目录多个源文件）可执行文件-C++版本使用CMakeLists.txt编译（不同目录多个源文件）可执行文件
CMake简介及CMakeLists的语法和简单示例
09-15
CMake 是一个跨平台的构建工具，用于管理C++项目的构建流程。它的主要目标是通过一个统一的配置文件——CMakeLists.txt，为不同的构建系统（如Unix的make，Windows的Visual Studio，或者Apple的Xcode）生成相应的...
【CMakeLists】学习笔记（指令详解&&即学即用&&快速入门哦）
SensizliK
12-05 2334
编写CMakeLists.txt最常用的功能就是调用其他的头文件（*.h*.hpp）、动态链接库（*.so）、静态链接库（*.a），将源文件*.cpp*.c*.cc编译成目标可执行或目标可链接库文件。CMake是makefile的上层工具，用于跨平台构建环境，生成可移植的makefile，并简化自己动手写makefile时的巨大工作量。
C C++最全【CMake】CMakeLists(1)，2024年最新疯狂涨知识
2401_84976093的博客
05-14 622
add_library(库文件名称 STATIC 文件) #通常子目录(二选一)add_executable(可执行文件名称 文件) #通常父目录(二选一)target_link_libraries(库文件名称/可执行文件名称 链接的库文件名称) #必须。target_link_libraries(库文件名称/可执行文件名称 链接的库文件名称)link_directories(路径)
CMakeLists完整解析（一）
Raymond_ss的博客
02-18 847
CMakeLists介绍
C++重温笔记(十二): C++多文件编程
Miracle8070
12-24 1万+
1. 写在前面 c++在线编译工具，可快速进行实验: https://www.bejson.com/runcode/cpp920/ 这段时间打算重新把c++捡起来， 实习给我的一个体会就是算法工程师是去解决实际问题的，所以呢，不能被算法或者工程局限住，应时刻提高解决问题的能力，在这个过程中，我发现cpp很重要， 正好这段时间也在接触些c++开发相关的任务，所有想借这个机会把c++重新学习一遍。 在推荐领域， 目前我接触到的算法模型方面主要是基于Python， 而线上的服务全是c++(算法侧， 业务那边基本上
cmake使用教程（实操版）
热门推荐
qq_34796146的博客
10-08 12万+
cmake使用教程 目录 一、初识cmake PS:绝大部分使用变量的情况要通过${}引用，而在IF语句中却必须直接使用变量名。 官网：www.cmake.org 优点： 1、开源代码，使用类BSD许可发布。 2、跨平台，并可以生成native编译配置文件，在linux/Unix平台，生成makefile,在苹果平台可以生成Xcode,在windows平台，可以生成MSVC的工程文件。 3、能够管理大型项目。 4、简化编译构建过程和编译过程。cmake的工具链：cmake+make。 5、高效率，因为cma
C++学习笔记【封装、继承、多态】
weixin_45045804的博客
09-29 1819
c++
CMake基础入门
Ricardo2的博客
07-18 417
CMakeLists 所在的路径工程编译发生的目录。表示当前的构建目录，即执行 CMake 构建命令时所在的目录的路径。: 工程顶层目录。表示包含项目名的最近一个 CMakeLists.txt 文件所在的目录的路径。：表示当前正在处理的 CMakeLists.txt 文件的所在目录的绝对路径。：指定 C 编译器：指定 C++ 编译器：可执行文件输出的存放路径：库文件输出的存放路径: 构建的类型，例如 Debug(默认有-g) ，Release用于指定 cmake 的最小版本要求。
c++下程序的运行（第3方库的安装及安装gdal）
xiaotiig的博客
03-16 4638
（1）理清c++程序执行流程：5步：准备好编程所需文件、搭好环境、编程、编译、执行（2）理清编译软件有哪些：（3）理清编译流程分为哪4步：（4）理清什么是动态库和静态库：（5）理清在一个项目中如何使用第三方库，在c++程序执行的4步中都需要考虑第3方库：准备编程所需文件时要考虑第三方库是源码还是编译好的文件（是源码还需要先将第3方库进行编译），搭建环境的时候需要配置好第三方库，编程时引用第三方库头文件并使用第3方库函数，编译时考虑怎么打包，执行时考虑用不用第三方库的动态库的.dll文件。
Linux下编译C++
Boys_Wu的博客
08-22 538
当在Linux系统下编写程序时候，不能用或者不用visual studio、vs code等IDE进行C/C++开发时，我们要如何编译、运行程序呢？一种方法是编写makefile文件，用makefile文件管理程序脚本之间的相互依赖关系，其语法相对比较复杂。还有另一种有效的方法就是利用cmake工具，自动生成makefile文件。 cmake是什么？ CMake是一个跨平台的安装（编译）工具，可以用简单的语句来描述所有平台的安装(编译过程)。Linux/Ubuntu上基本都预先安装好了cmake工具，如果没
许三多测试C++源码 CMakeLists.txt项目管理使用方法
10-09
本篇文章将深入探讨`CMakeLists.txt`的使用方法以及如何结合其他配置文件如`launch.json`和`tasks.json`来优化开发流程。 `CMakeLists.txt`是CMake项目的配置文件，它定义了项目的基本结构、编译选项、依赖库等。...
C++版本使用CMakeLists.txt编译（同目录多个源文件）可执行文件
07-12
C++版本使用CMakeLists.txt编译（同目录多个源文件）可执行文件-C++版本使用CMakeLists.txt编译（同目录多个源文件）可执行文件-C++版本使用CMakeLists.txt编译（同目录多个源文件）可执行文件
C++版本使用CMakeLists.txt编译（单个源文件）可执行文件
07-12
C++版本使用CMakeLists.txt编译（单个源文件）可执行文件-C++版本使用CMakeLists.txt编译（单个源文件）可执行文件-C++版本使用CMakeLists.txt编译（单个源文件）可执行文件
CMAKE基础知识、编写语法
最新发布
07-06
·cmake命令：根据CMakeLists.txt（配置文件），创建makefile。 然后，需要用户手动执行make命令，进行编译！ ·CMakeLists.txt的基本格式：最少需要3行command。 cmake_minimum_required（VERSION 3.10） #cmake...
Android开发，JNI和Java、Kotlin代码的互相调用以及CMakeLists的常用属性使用
09-06
本篇将深入探讨JNI的使用，以及如何在Java、Kotlin与C/C++之间进行调用，并介绍CMakeLists.txt配置文件的常用属性。 首先，Java或Kotlin调用C/C++代码通常涉及以下几个步骤： 1. **定义JNI函数**：在Java或Kotlin...
自动驾驶规划控制常用算法c++代码实现
06-04
项目依赖 本项目在Ubuntu 20.04下运行，windows下尚未...用cmake管理项目的时候，只需要在CMakeLists.txt里面添加头文件的路径即可： find_package(Eigen3 REQUIRED) include_directories(${EIGEN3_INCLUDE_DIR}) ...
cmakelists管理大型工程实例
06-21
CMakeLists.txt是C++开发中的一个重要工具，用于管理和构建大型工程。在现代软件开发中，尤其是当项目变得庞大和复杂时，一个有效的构建系统至关重要。CMake是一种跨平台的构建系统，它允许开发者用一种统一的方式来...
cmakelist install
05-28
你的问题是关于 CMakeList.txt 文件中的 install 命令吗？ 如果是的话，install 命令是用来将构建好的二进制文件、库文件、头文件等安装到指定的目录中，方便用户使用。通常情况下，我们会在 CMakeList.txt 文件中使用 install 命令来指定需要安装的文件或目录，以及安装到哪个位置。 例如，以下是一个简单的 CMakeList.txt 文件，其中使用 install 命令将编译好的可执行文件安装到 /usr/local/bin 目录中： ``` cmake_minimum_required(VERSION 3.0) project(myproject) add_executable(myexe myexe.cpp) install(TARGETS myexe DESTINATION /usr/local/bin) ``` 这样，在执行 make install 命令后，myexe 可执行文件就会被安装到 /usr/local/bin 目录中。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

豆得儿不是猫

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值