【cmake构建工程】

已于 2023-10-27 13:45:44 修改
阅读量265 收藏 1
点赞数
文章标签： c++ linux
于 2023-10-21 16:49:17 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/sinat_23896491/article/details/133961151
版权

cmake构建工程

1.安装cmake

sudo apt install cmake
cmake -version

2.简单示例

2.1. touch main.c CMakeLists.txt

main.c 文件内容

#include <stdio.h>
int main(void)
{
	printf("Hello World\n");
	return 0;
}

CMakeLists.txt 内容

cmake_minimum_required (VERSION 2.8)
project (demo)
add_executable(main main.c)

2.2. cmake .

shine@shine-virtual-machine:~/shineWork/demo$ ls
CMakeLists.txt  main.c
shine@shine-virtual-machine:~/shineWork/demo$ 
shine@shine-virtual-machine:~/shineWork/demo$ cmake .
shine@shine-virtual-machine:~/shineWork/demo$ ls
CMakeCache.txt  CMakeFiles  cmake_install.cmake  CMakeLists.txt  main.c  Makefile

2.3. make 编译

shine@shine-virtual-machine:~/shineWork/demo$ ls
CMakeCache.txt  CMakeFiles  cmake_install.cmake  CMakeLists.txt  main.c  Makefile
shine@shine-virtual-machine:~/shineWork/demo$ 
shine@shine-virtual-machine:~/shineWork/demo$ make
[ 50%] Building C object CMakeFiles/main.dir/main.c.o
[100%] Linking C executable main
[100%] Built target main
shine@shine-virtual-machine:~/shineWork/demo$ ls
CMakeCache.txt  CMakeFiles  cmake_install.cmake  CMakeLists.txt  main  main.c  Makefile

2.4. make

make clean就可以删除main这个文件。然后重新make就行。

3. 编译多个源文件：

3.1 在同一个目录下有多个源文件

  1. touch testFunc.c testFunc.h
    shine@shine-virtual-machine:~/shineWork/demo2$ touch testFunc.c testFunc.h
    shine@shine-virtual-machine:~/shineWork/demo2$ ls
    CMakeLists.txt main.c testFunc.c testFunc.h

文件内容如下：

/*
** testFunc.c
*/

#include <stdio.h>
#include "testFunc.h"

void func(int data)
{
	printf("data is %d\n", data);
}

/*
** testFunc.h
*/

#ifndef _TEST_FUNC_H_
#define _TEST_FUNC_H_

void func(int data);

#endif
  1. cat CMakeLists.txt 添加如下

cmake_minimum_required (VERSION 2.8)
project (demo)
add_executable(main main.c testFunc.c )

  1. cmake .
  2. make

如果在同一目录下有多个源文件，那么只要在add_executable里把所有源文件都添加进去就可以了。
但是如果有一百个源文件，再这样做就有点坑了，无法体现cmake的优越性。
因此cmake提供了一个命令可以把指定目录下所有的源文件存储在一个变量中，这个命令就是

aux_source_directory(dir var)
第一个参数dir是指定目录，第二个参数var是用于存放源文件列表的变量。

3.2 在同目录下有多个源文件

  1. touch testFunc1.c testFunc1.h
/*
** testFunc1.c
*/

#include <stdio.h>
#include "testFunc1.h"

void func1(int data)
{
	printf("data is %d\n", data);
}

//---------------------------------------------------------
/*
** testFunc1.c
*/

#include <stdio.h>
#include "testFunc1.h"

void func1(int data)
{
	printf("data is %d\n", data);
}
  1. 修改main.c
    修改main.c，调用testFunc1.h里声明的函数func1()：
#include <stdio.h>

#include "testFunc.h"
#include "testFunc1.h"

int main(void)
{
	func(100);
	func1(200);

	return 0;
}
  1. 修改CMakeLists.txt：
cmake_minimum_required (VERSION 2.8)
project (demo)
aux_source_directory(. SRC_LIST)
add_executable(main ${SRC_LIST})

使用aux_source_directory把当前目录下的源文件存列表存放到变量SRC_LIST里;
然后在add_executable里调用SRC_LIST（注意调用变量时的写法）。

  1. 再次执行cmake和make，并运行main
    在这里插入图片描述
    aux_source_directory()也存在弊端，它会把指定目录下的所有源文件都加进来，可能会加入一些我们不需要的文件，此时我们可以使用set命令去新建变量来存放需要的源文件，如下：
cmake_minimum_required (VERSION 2.8)

project (demo)

set( SRC_LIST
	 ./main.c
	 ./testFunc1.c
	 ./testFunc.c)

add_executable(main ${SRC_LIST})

3.3 在不同目录下有多个源文件

  1. 新建2个目录test_func和test_func1
    在这里插入图片描述
  2. 修改CMakeLists.txt和main.c在同一目录下
cmake_minimum_required (VERSION 2.8)

project (demo)

include_directories (test_func test_func1)

aux_source_directory (test_func SRC_LIST)
aux_source_directory (test_func1 SRC_LIST1)

add_executable (main main.c ${SRC_LIST} ${SRC_LIST1})

include_directories 该命令是用来向工程添加多个指定头文件的搜索路径，路径之间用空格分隔。

  1. 修改main.c
#include "test_func/testFunc.h"
#include "test_func1/testFunc1.h"

只是这种写法不好看。
另外，我们使用了2次aux_source_directory，因为源文件分布在2个目录下，所以添加2次。

  1. 运行查看
    在这里插入图片描述

4. 项目级的组织结构：

  1. 目录结构 一般会把源文件放到src目录下，把头文件放入到include文件下，生成的对象文件放入到build目录下，最终输出的可执行程序文件会放到bin目录下，这样整个结构更加清晰。
    在这里插入图片描述

  2. 修改CMakeLists.txt：

cmake_minimum_required (VERSION 2.8)
project (demo)
add_subdirectory (src)

add_subdirectory：这个语句的作用是增加编译子目录。其基本语法格式是：
add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

标志说明
source_dir 源代码目录指定一个包含CMakeLists.txt和代码文件所在的目录，该目录可以是绝对路径，也可以是相对路径，对于后者相对路径的起点是CMAKE_CURRENT_SOURCE_DIR。此外，如果子目录再次包含的CMakeLists.txt，则将继续处理里层的CMakeLists.txt，而不是继续处理当前源代码
binary_dir 二进制代码目录这个目录是可选的，如果指定，cmake命令执行后的输出文件将会存放在此处，若没有指定，默认情况等于source_dir没有进行相对路径计算前的路径，也就是CMAKE_BINARY_DIR。
EXCLUDE_FROM_ALL标记这个标志是可选的，如果传递了该参数表示新增加的子目录将会排除在ALL目录之外（可能是make系统中的make all？），表示这个目录将从IDE的工程中排除。用户必须显式在子文件这个编译目标（手动cmake之类的）。指定了这个文件夹，表示这个文件夹是独立于源工程的，这些函数是有用但是不是必要的，比如说我们一系列的例子。

add_subdirectory (src)
这里指定src目录下存放了源文件，当执行cmake时，就会进入src目录下去找src目录下的CMakeLists.txt，所以在src目录下也建立一个CMakeLists.txt，内容如下:

src/CMakeLists.txt

aux_source_directory (. SRC_LIST)
include_directories (../include)
add_executable (main ${SRC_LIST})
set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)

这里的set其实是和前面的一样，只是EXECUTABLE_OUTPUT_PATH是个系统自带的预定义变量，其意义如下：

EXECUTABLE_OUTPUT_PATH ：目标二进制可执行文件的存放位置
PROJECT_SOURCE_DIR：工程的根目录

所以，这里set的意思是把存放elf文件的位置设置为工程根目录下的bin目录。（cmake有很多预定义变量，详细的可以网上搜索一下）

添加好以上这2个CMakeLists.txt后，整体文件结构如下：
在这里插入图片描述

  1. 运行查看
    运行cmake，不过这次先让我们切到build目录下:
cd build
cmake ..
make

这样Makefile会在build目录下生成，二进制程序会在bin目录下生成，然后运行可执行程序：

  1. 执行
cd ../bin
./main 

这里解释一下为什么在build目录下运行cmake？
还记得在第一个例子里我让你着重看一下cmake和make之后会生成什么文件吗？这个过程中会生成很多文件，但是可惜的是跟我们的运行并没有什么关系，因此，如果能把编译隔离在某个文件夹，这样cmake的时候所有的中间文件都将在这个目录下生成，删除的时候也很好删除，非常方便。如果不这样做，cmake运行时生成的附带文件就会跟源码文件混在一起，这样会对程序的目录结构造成污染。
另外一种写法：
前面的工程使用了2个CMakeLists.txt，最外层的CMakeLists.txt用于掌控全局，使用add_subdirectory来控制其它目录下的CMakeLists.txt的运行。

add_subdirectory (src) // add_subdirectory来控制其它目录下的CMakeLists.txt的运行。

上面的例子也可以只使用一个CMakeLists.txt，把最外层的CMakeLists.txt内容改成如下

cmake_minimum_required (VERSION 2.8)

project (demo)

set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)

aux_source_directory (src SRC_LIST)

include_directories (include)

add_executable (main ${SRC_LIST})

同时，还要把src目录下的CMakeLists.txt删除。
然后正常编译运行就可以。

5. 生成库文件

在这里插入图片描述
我们会在build目录下运行cmake，并把生成的库文件存放到lib目录下。

CMakeLists.txt

cmake_minimum_required (VERSION 3.5)
project (demo)
set (SRC_LIST ${PROJECT_SOURCE_DIR}/testFunc/testFunc.c)

add_library (testFunc_shared SHARED ${SRC_LIST})
add_library (testFunc_static STATIC ${SRC_LIST})

set_target_properties (testFunc_shared PROPERTIES OUTPUT_NAME "testFunc")
set_target_properties (testFunc_static PROPERTIES OUTPUT_NAME "testFunc")

set (LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)

add_library: 生成动态库或静态库(第1个参数指定库的名字；第2个参数决定是动态还是静态，如果没有就默认静态；第3个参数指定生成库的源文件)
set_target_properties: 设置最终生成的库的名称，还有其它功能，如设置库的版本号等
LIBRARY_OUTPUT_PATH: 库文件的默认输出路径，这里设置为工程目录下的lib目录

PS：前面使用set_target_properties重新定义了库的输出名称，如果不使用set_target_properties也可以，那么库的名称就是add_library里定义的名称，只是连续2次使用add_library指定库名称时（第一个参数），这个名称不能相同，而set_target_properties可以把名称设置为相同，只是最终生成的库文件后缀不同（一个是.so，一个是.a），这样相对来说会好看点。

运行查看

cd build/
cmake ..
make
cd ../lib/
ls

在这里插入图片描述

#include <stdio.h>

#include "testFunc.h"

int main(void)
{
    func(100);
    
    return 0;
}

CMakeLists.txt

cmake_minimum_required (VERSION 3.5)

project (demo)


set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)

set (SRC_LIST ${PROJECT_SOURCE_DIR}/src/main.c)

# find testFunc.h
include_directories (${PROJECT_SOURCE_DIR}/testFunc/inc)

find_library(TESTFUNC_LIB testFunc HINTS ${PROJECT_SOURCE_DIR}/testFunc/lib)

add_executable (main ${SRC_LIST})

target_link_libraries (main ${TESTFUNC_LIB})

find_library: 在指定目录下查找指定库，并把库的绝对路径存放到变量里，其第一个参数是变量名称，第二个参数是库名称，第三个参数是HINTS，第4个参数是路径，其它用法可以参考cmake文档
target_link_libraries: 把目标文件与库文件进行链接
使用find_library的好处是在执行cmake …时就会去查找库是否存在，这样可以提前发现错误，不用等到链接时。

在lib目录下有testFunc的静态库和动态库，find_library(TESTFUNC_LIB testFunc
…默认是查找动态库，如果想直接指定使用动态库还是静态库，可以写成
find_library(TESTFUNC_LIBlibtestFunc.so …
find_library(TESTFUNC_LIB libtestFunc.a …

6 编译选项

有时编译程序时想添加一些编译选项，如-Wall，-std=c++11等，就可以使用add_compile_options来进行操作。
这里以一个简单程序来做演示。

在这里插入图片描述
main.cpp

#include <iostream>

int main(void)
{
    auto data = 100;
    std::cout << "data: " << data << "\n";
    return 0;
}

CMakeLists.txt

cmake_minimum_required (VERSION 2.8)

project (demo)

set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)

add_compile_options(-std=c++11 -Wall) 

add_executable(main main.cpp)

运行查看
然后cd到build目录下，执行cmake … && make命令，就可以在bin目录下得到main的可执行文件
在这里插入图片描述

7 编译部分代码

main.c

#include <stdio.h>

int main(void)
{
#ifdef WWW1
    printf("hello world1\n");
#endif    

#ifdef WWW2     
    printf("hello world2\n");
#endif

    return 0;
}

可以通过定义宏来控制打印的信息，我们CMakeLists.txt内容如下:

cmake_minimum_required(VERSION 3.5)

project(demo)

set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)

option(WWW1 "print one message" OFF)
option(WWW2 "print another message" OFF)

if (WWW1)
    add_definitions(-DWWW1)
endif()

if (WWW2)
    add_definitions(-DWWW2)
endif()

add_executable(main main.c)

这里把option的名字保持和main.c里的宏名称一致，这样更加直观，也可以选择不同的名字。通过与add_definitions()的配合，就可以控制单个bin文件的打印输出了。

接着分别按照下面指令去执行，然后查看打印效果，

cmake … -DWWW1=ON -DWWW2=OFF && make
cmake … -DWWW1=OFF -DWWW2=ON && make
cmake … -DWWW1=ON -DWWW2=ON && make

CMake构建Qt工程
追赶时代的博客
05-12 2304
cmake qt
利用CMake构建一个简单的工程hello
njr465167967的博客
09-27 562
在公司做项目都是看懂项目的构建体系就可以，最多就是在上面稍加改动，现在想尝试一下自己从无到有构建一个完整的工程。
【cmake工具构建工程】
sinat_23896491的博客
08-26 535
include_directories 命令用来指明头文件所在的路径，并且使用到了 PROJECT_SOURCE_DIR 变量，该变量指向了一个路径，我们已经加入了多个源文件，但是这些源文件都是放在同一个目录下，这样还是不太正规，我们应该将这些源文件按照类型、功能、模块给它们放置到不同的目录下。add_subdirectory 命令， 该命令告诉 cmake 去子目录中寻找新的CMakeLists.txt 文件并解析它；⚫ libhello 目录下的 CMakeLists.txt。
开源工程配置神器cmake
最新发布
m0_54069809的博客
05-06 1111
本文主要讲开源项目工程配置神器cmake的基本使用方式
创建CMake工程
weixin_45752116的博客
06-24 355
CMake工程创建
CMake工程构建详解
FLM19990626的博客
08-21 2637
CMake： 使用简单方便，可以跨平台，构建项目编译环境。比直接写Makefile简单(在构建大型工程编译时，需要写大量的文件依赖关系)，可以通过简单的CMake配置生成负责的本地Makefile文件，一个命令便将我们项目想编译的可执行文件、静态库、动态库都编译出来了。而且配置文件可以直接拿到其它平台上使用，无需修改，非常方便。1、：通过 project() 指定项目名称；2、：工程的根目录；3、：执行 cmake 命令的目录；4、：当前 CMakeList.txt 文件所在的目录；
【CMake】如何使用CMake构建一个工程
miyazono_的博客
04-24 1865
CMake
CMake构建工程配置HarmonyOS编译工具链
shangkangba的博客
11-15 1050
CMake是一个跨平台的构建工具，用于管理构建过程、编译、链接和打包软件项目，它可以生成Makefile等用于不同操作系统和编译器的构建脚本。CMake的配置过程是跨平台的，因此可以在不同的操作系统上运行，例如Linux、Windows和macOS。配置（Configuration）：配置阶段是CMake解析CMakeLists.txt文件的过程。在配置阶段，CMake会读取CMakeLists.txt文件，并执行其中的命令。
如何使用CMake构建工程
MaoMao-go
09-02 1327
目录工程内容目录结构总CMake动态库CMake可执行文件CMake有问题请留言，Thanks 本文举一个简单的使用CMake构建C++工程的例子。通过这个例子来看下如何使用CMake构建一个C++工程。 工程内容 产生一个动态库aaa，以及对外的头文件 产生一个可执行文件bbb，这个可执行文件依赖动态库aaa 目录结构 CMakeLists.txt # 总CMake aaa-dir # 动态库目录 CMakeLists.txt # 动态库aaa的CMake
C/C++ 项目构建 CMake 构建工程使用小结 CMake 常用函数介绍
07-16
CMake 是一个跨平台的构建系统，用于管理C和C++项目的编译过程。它通过生成特定于平台的构建文件，如Unix Makefiles、Visual Studio项目等，来简化多源文件项目的构建。在大型C/C++项目中，由于文件数量众多且结构...
Cmake构建工程设计——Cmake工程资源加载
zxng_work的博客
06-05 907
加载文件夹：add_subdirectory 添加CMakeLists.txt层级下的子文件夹，cmake执行时会自动进入该文件夹。添加时要确保子文件夹也要有CMakeLists.txt文件。父目录的变量可以传递给子级目录。 添加该CMakeLists.txt文件目录下的src文件夹 add_subdirectory(src) 添加头文件 include_directories 该命令默认的作用域为该层级目录以及下属子目录。 由于父目录的变量可以传递给子级目录，头文件路径添加也遵循该规律，但子级目录的变量
帮你快速构建自己的cmake工程
u011896834的博客
10-31 1708
本文旨在用较短的篇幅介绍一个cmake构建C++工程结构，并提供一个工程实例，方便大家参考。如果您时间充裕或想系统学习cmake，请参考本文最后的下载链接。 cmake的用途定义等不在此讨论，下面以目录为索引进行讲解。 一、工程目录结构介绍 .....................
CMake(一)：构建一个工程
12-22 1027
/MakeTable.cxx实现了生成Table.h内容//添加一个库//指定编译设置//添加命令 生成Table.h文件//让CMake知道，mysqrt.cxx用到了Table.h；这是通过将生成的Table.h添加到SqrtLibrary库的源列表中来实现的。//还必须将当前二进制目录添加到包含目录列表中，以便可以找到Table.h并由mysqrt.cxx包含。mysqrt.cxx//引用计算。
CMake之建立简单工程
阿兵-AI医疗的专栏
04-03 486
最简单的例子 目录结构 . ├── CMakeLists.txt └── main.cpp main.cpp #include <iostream> int main() { std::cout <<"Hello World" << std::endl; return 0; } CMakeLists.txt PROJECT (SimpleExample) SET(SRC_LIST main.cpp) MESSAGE(STATUS "This is BI
【cmake学习】搭建一个简单的cmake工程（初级版）
challenglistic的博客
04-12 1889
【cmake学习】搭建一个简单的cmake工程（初级版）
CMake构建
似水流年
11-08 2448
文章目录CMake是用来干啥的？Ubuntu安装CMake一、CMake构建的简单使用：Helloworld二、CMake构建：多源文件初级：少数源文件 add_executable()进阶：更多源文件 aux_source_directory() 或 set()三、CMake构建：多目录多源文件新命令：include_directories()四、CMake构建：正规组织结构方式一：两个CMakeLists.txt方式二：一个CMakeLists.txt五、CMake构建：编译动态库和静态库六、CMake
CMake构建工程
Erick Lv的笔记
02-23 514
目标：使用CMake构建多级的目录的C++项目，包含动态库的引用。 文件结构： . ├── CMakeLists.txt # 1 ├── build ├── lib # 这里存放动态库 │ ├── CMakeLists.txt # 2 │ ├── lib-bye │ │ ├── CMakeLists.txt # 3 │ │ └── bye.cc # 4 │ └──...
cmake 工程构建
帅的没拼音
04-17 2125
cmake 工程构建一:CMakeLists.txt 基本框架二:编译静态库或者动态库三:find_package()四:module和config模式五:引入第三方库文件六:编译选项指定七:交叉编译配置八:配置option可选选项九:安装十:参考资料 一:CMakeLists.txt 基本框架 工程目录结构: 根目录./CMakeLists.txt: # 指定cmake版本，只需要指定大版本和小版本即可 cmake_minimum_required(VERSION 3.10) # 指定项目名称，项目版
【小沐学C++】C++ 基于CMake构建工程项目（Windows、Linux）
爱看书的小沐
08-06 1812
CMake是一个跨平台的安装（编译）工具，可以用简单的语句来描述所有平台的安装(编译过程)。他能够输出各种各样的makefile或者project文件，能测试编译器所支持的C++特性,类似UNIX下的automake。只是 CMake 的组态档取名为 CMakeLists.txt。╮(￣▽￣)╭如果您感觉方法或代码不咋地//(ㄒoㄒ)//，就在评论处留言，作者继续改进；o_O???如果您需要相关功能的代码定制化开发，可以留言私信作者；(✿◡‿◡)！！
使用Cmake构建Qt工程的样例教程
对于想要使用Cmake构建Qt工程的用户，这个"CmakeQtDemo"样例项目可以提供很大的帮助。该样例项目使用Cmake来自动化构建过程，同时展示出如何有效地使用Cmake的其他特性。开发者可以参考这个项目来快速搭建和管理自己...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

光芒Shine

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

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

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

打赏作者

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

抵扣说明：

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

余额充值