CMake基本使用

最新推荐文章于 2023-04-30 15:15:19 发布
最新推荐文章于 2023-04-30 15:15:19 发布
阅读量280 收藏
点赞数
分类专栏： C/C++ 文章标签： c++
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_49723651/article/details/125503470
版权

CMake基本使用


文章目录


1. Linux环境安装

  1. 安装gcc软件依赖

    yum install -y gcc gcc-c++ make automake

# 输出版本则安装成功
gcc -v

  2. 下载最新CMake

    https://cmake.org/download/

    # 下载完成后解压
tar -xvf [压缩包]

  3. 进入根目录，运行命令

    ./bootstrap

    如果出现以下错误：
    在这里插入图片描述
    运行命令：

    yum install  -y openssl  openssl-devel

    然后重新运行即可

    ./bootstrap

  4. 运行gmake

    gmake

  5. 进行安装

    gmake install

    输入cmake -v，如果出现版本号则安装成功：
    在这里插入图片描述

2. 使用CMake运行C++程序

2.1 运行简单的示例程序

用vim编写一段C++代码：

#include <iostream>
using namespace std;
int main() {
        cout << "hello world" << endl;
}

在同一个目录下编写CMakeLists.txt文件：

PROJECT (HELLO)
SET(SRC_LIST main.cpp)
MESSAGE(STATUS "This is BINARY dir" ${HELLO_BINARY_DIR})
MESSAGE(STATUS "This is SOURCE dir" ${HELLO_SOURCE_DIR})
ADD_EXECUTABLE (hello ${SRC_LIST})

使用CMake生成Makefile文件：

cmake .

在这里插入图片描述自动生成了以下文件：

在这里插入图片描述

使用make命令编译：

make

在这里插入图片描述
编译出了一个可执行文件
在这里插入图片描述
运行可执行文件：

hello

在这里插入图片描述

3. CMake基本语法

用上面编写的CMakeLists.txt文件做示例：

PROJECT (HELLO)
SET(SRC_LIST main.cpp)
MESSAGE(STATUS "This is BINARY dir" ${HELLO_BINARY_DIR})
MESSAGE(STATUS "This is SOURCE dir" ${HELLO_SOURCE_DIR})
ADD_EXECUTABLE (hello ${SRC_LIST})

3.1 关键字

PROJECT关键字

可以用来指定工程的名字和支持的语言，默认支持所有语言.
PROJECT (HELLO)：指定了工程的名字，并且支持所有语言.
PROJECT (HELLO CXX)：指定了 工程的名字，并且支持语言是C++.
PROJECT (HELLO C CXX)：指定了工程的名字，并且支持语言是C和C++.

该指令隐式定义了两个CMAKE的变量
<projectname>_ BINARY_ DIR,本例中是HELLO_ BINARY_ DIR.
<projectname>_ SOURCE_ DIR, 本例中是HELLO_ SOURCE DIR.
MESSAGE关键字就可以直接使用这两个变量，当前都指向当前的工作目录，后面会讲外部编译.

问题：如果改了工程名，这两个变量名也会改变.
解决：可以使用CMake为我们预定义的两个变量: PROJECT_ BINARY_ DIR和PROJECT_SOURCE_ DIR, 这两个变量和HELLO_ BINARY_ DIR, HELLO_ SOURCE_ DIR是一致的.

SET关键字

用于显示的指定变量.
SET(SRC_ LIST main.cpp)指令中的SRC_ LIST变量就包含了main.cpp.
如果当前有多个cpp文件，也可以SET(SRC_LIST main.cpp t1.cpp t2.cpp).

MESSAGE关键字

向终端输出用户自定义的信息
主要包含三种信息:

  • SEND_ ERROR,产生错误，生成过程被跳过.
  • SATUS, 输出前缀为-的信息.
  • FATAL_ ERROR，立即终止所有cmake过程.

ADD_EXECUTABLE关键字

生成可执行文件
ADD_ EXECUTABLE(hello ${SRC_ LIST})指令表示生成的可执行文件名是hello，源文件读取变量SRC_ LIST中的内容.
也可以直接写ADD_ EXECUTABLE(hello main.cpp).

所以工程名HELLO与生成的可执行文件名hello是没有任何关系的.

上述例子可以简化的写成：

PROJECT(HELLO)
ADD_EXECUTABLE(hello main.cpp)

3.2 语法的基本原则


  • 变量使用${}方式取值，但是在IF控制语句中可以直接使用变量名.
  • 指令(参数1 参数2…) 参数使用括弧括起，参数之间使用空格或分号分开.以上面的ADD_ EXECUTABLE指令为例，如果存在另外一个func.cpp源文件
    就要写成: ADD_ EXECUTABLE(hello main.cpp func.cpp)或者ADD_ EXECUTABLE(hello main.cpp;func.cpp).
  • 指令是大小写无关的，但是参数和变量是大小写相关的。推荐全部使用大写指令.
  • SET(SRC_ LIST main.cpp)可以写成SET(SRC_ LIST "main.cpp"), 但是如果源文件名中含有空格,就必须要加双引号.

3.3 内部构建和外部构建

  • 内部构建：上述例子就是内部构建，生产的临时文件特别多，不方便清理.
  • 外部构建：会把生成的临时文件放在build目录下，不会对源文件有任何影响，推荐使用外部构建的方式.

外部构建

先回退到刚刚编写完CMakeLists.txt文件的时候：
在这里插入图片描述创建一个build目录并进入：

mkdir build
cd build

在build目录中执行cmake命令：

cmake ..

在build目录中执行make命令：

make

生成的临时文件都会在build目录中：

在这里插入图片描述

4. 工程化项目

  • 为工程添加一个子目录src，用来放置工程源代码.
  • 添加一个子目录doc，用来放置这个工程的文档hello.txt.
  • 在工程目录添加文本文件COPYRIGHT README.
  • 在工程目录添加一个runhello.sh脚本，用来调用hello二进制.
  • 将构建后的目标文件放入构建目录的bin子目录.
  • 将doc目录的内容以及 COPYRIGHT/README 安装到/usr/share/doc/cmake/.
.
├── build
├── CMakeLists.txt
├── COPYRIGHT
├── doc
│   └── hello.txt
├── README
├── runhello.sh
└── src
    ├── CMakeLists.txt
    └── main.cpp

4.1 生成二进制文件到bin目录中

每个目录下都要有一个CMakeLists.txt说明：

.
├── build
├── CMakeLists.txt
└── src
    ├── CMakeLists.txt
    └── main.cpp

外层CMakeLIsts.txt：

PROJECT(HELLO)
ADD_SUBDIRECTORY(src bin)

src下的CMakeLists.txt：

ADD_EXECUTABLE(hello main.cpp)

ADD_SUBDIRECTORY指令

ADD_SUBDIRECTORY(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

  • 这个指令用于向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制存放的位置.
  • EXCLUDE_FROM_ALL函数是将写的目录从编译中排除，如程序中的example.
  • ADD_SUBDIRECTORY(src bin)
    将src子目录加入工程并指定编译输出(包含编译中间结果)路径为bin目录
    如果不进行bin目录的指定，那么编译结果(包括中间结果)都将存放在build/src目录.

更改二进制的保存路径

SET指令重新定义EXECUTABLE_OUTPUT_PATH和LIBRARY_OUTPUT_ PATH变量来指定最终的目标二进制的位置：

SET(EXECUTABLE_OUTPUT_PATH ../../src/bin)
SET(LIBRARY_OUTPUT_PATH ../../src/lib)

注意：哪里要改变目标存放路径，就在哪里加入上述的定义，所以就在src目录下的CMakeLists.txt中写.

改变之后重新执行：

.
├── build
├── CMakeLists.txt
└── src
    ├── bin
    │   └── hello
    ├── CMakeLists.txt
    └── main.cpp

可以看到可执行文件hello 已经到了src/bin目录下.


4.2 使用CMake进行安装

安装文件COPYRIGHT和README

在根目录下的CMakeLists.txt文件中加上：

INSTALL(FILES COPYRIGHT README DESTINATION share/doc/cmake/)

FILES:文件名.
DESTINATION:
1.可以直接写绝对路径.
2.也可以写相对路径，相对路径实际路径是：${CMAKE_INSTALL _PREFIX}/<DESTINATION>定义的路径.
CMAKE_JINSTALL_PREFIX默认是在/usr/local/.
cmake-DCMAKE_JNSTALL_PREFIX=/usr 在cmake的时候指定CMAKE_ JNSTALL_ PREFIX变量的路径.

安装脚本runhello.sh

PROGRAMS：非目标文件的可执行程序安装（比如脚本之类）.

在根目录下的CMakeLists.txt文件中加上：

INSTALL(PROGRAMS runhello.sh DESTINATION bin)

说明：实际安装到的是/usr/bin.

安装doc目录下的hello.txt

在根目录下的CMakeLists.txt文件中加上：

INSTALL(DIRECTORY doc/ DESTINATION share/doc/cmake)

DIRECTORY后面连接的是所在Source目录的相对路径.

注意: abc和abc/有很大的区别

  • 目录名不以/结尾:这个目录将被安装为目标路径下的abc.
  • 目录名以/结尾:将这个目录中的内容安装到目标路径.

安装

cd build
cmake ..
make
make install

在这里插入图片描述


5. 静态库与动态库的构建和使用

静态库和动态库的区别：

  • 静态库的扩展名一般为".a”或".lib"; 动态库的扩展名- -般为".so"或".dIl".
  • 静态库在编译时会直接整合到目标程序中，编译成功的可执行文件可独立运行.
  • 动态库在编译时不会放到连接的目标程序中，即可执行文件无法单独运行.

下面我们来创建一个静态库和动态库，提供HelloFunc函数供其它程序编程使用，HelloFunc向终端输出Hello World字符串.

构建实例：

.
├── build
├── CMakeLists.txt
└── lib
    ├── CMakeLists.txt
    ├── hello.cpp
    └── hello.h

hello.h中的内容：

#ifndef HELLO_H
#define Hello_H

void HelloFunc();

#endif

hello.cpp中的内容：

#include "hello.h"
#include <iostream>
using namespace std;
void HelloFunc() {
        cout << "hello world" << endl;
}

5.1 单独构建静态库或动态库

根目录下CMakeLists.txt中的内容：

PROJECT(HELLO)
ADD_SUBDIRECTORY(lib bin)

lib目录下CMakeLists.txt中的内容：

SET(LIBHELLO_SRC hello.cpp)
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

ADD_LIBRARY

ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

  • hello: 就是正常的库名，生成的名字前面会加上lib,最终产生的文件是libhello.so.
  • SHARED：动态库；STATIC： 静态库.
  • ${LIBHELLO_ SRC}：源文件.

在这里插入图片描述

5.2 同时构建静态库和动态库

SET_TARGET_PROPERTIES

这条指令可以用来设置输出的名称，对于动态库，还可以用来指定动态库版本和API版本.

同时构建静态和动态

lib目录下CMakeLists.txt中的内容：

SET(LIBHELLO_SRC hello.cpp)

ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})

SET_TARGET_PROPERTIES(hello_static PROPERTIES OUTPUT_NAME "hello")
SET_TARGET_PROPERTIES(hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)

ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

SET_TARGET_PROPERTIES(hello PROPERTIES OUTPUT_NAME "hello")
SET_TARGET_PROPERTIES(hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)

编译之后：

在这里插入图片描述

5.3 动态库的版本号

一般动态库都有一个版本号的关联.

libhello.so.1.2
libhello.so ->libhello.so.1
libhello.so.1->libhello.so.1.2

CMakeList.txt插入如下：

SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.2 SOVERSION 1)

VERSION指代动态库版本，SOVERSION指代API版本.

5.4 安装共享库和头文件

本例中我们将hello的共享库安装到<prefix>/lib目录，将hello.h安装到<prefix>/include/hello目录.

在lib目录下CMakeLists.txt的添加：

# 文件放到该目录下
INSTALL(FILES hello.h DESTINATION include/hello)

# 二进制、静态库、动态库安装都用TARGETS
# ARCHIVE 特指静态库，LIBRARY 特指动态库，RUNTIME 特指可执行目标二进制
INSTALL(TARGETS hello hello_static LIBRARY DESTINATION lib ARCHIVE DESTINATION lib)

安装的时候指定一下路径，放到系统下：

cmake -D CMAKE_INSTALL_PREFIX=/usr ..

在这里插入图片描述

5.5 使用共享库和头文件

构建实例：

.
├── build
├── CMakeLists.txt
└── src
    ├── CMakeLists.txt
    ├── main.cpp

main.cpp中的内容：

#include <hello.h>
using namespace std;
int main() {
	HelloFunc();
}

根目录下的CMakeLists.txt:

PROJECT(HELLO)
ADD_SUBDIRECTORY(src bin)

src下的CMakeLists.txt:

ADD_EXECUTABLE(hello main.cpp)

然后编译：

会报找不到hello.h头文件的错误：
在这里插入图片描述需要在src下的CMakeLists.txt加上：

# 表示在hello目录下去找头文件
INCLUDE_DIRECTORIES(/usr/include/hello)

再编译，还会报错，找不到HelloFunc这个函数：

在这里插入图片描述
可以使用TARGET_LINK_LIBRARIES关键字添加需要链接的共享库，注意一定要写在ADD_EXECUTABLE关键字的后面：

TARGET_LINK_LIBRARIES (hello libhello.so)

注意hello是生成的二进制文件的名字.

所以最终src下的CMakeLists.txt文件内容：

INCLUDE_DIRECTORIES(/usr/include/hello)

ADD_EXECUTABLE(hello main.cpp)

TARGET_LINK_LIBRARIES (hello libhello.so)

再次编译的时候，就可以成功生成可执行文件hello了，但是运行hello的时候会再次报错：

在这里插入图片描述

原因是我们之前生成的动态库libhello.so是在/usr/lib/目录下的，但是我的linux系统是64位的，需要把这个动态库移动到/usr/lib64/目录下才能使用：

mv /usr/lib/libhello.so /usr/lib64/

之后就可以正常运行了：

在这里插入图片描述

jenrain
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
cmake / cmake --build 如何理解
布袋和尚
03-31 1万+
对于 cmake ，一直理解为项目构建工具，知道遇到 --build 才发现，cmake 还统一了各个平台的编译阶段。下面摘抄知乎上大神的理解： 简单说一下cmake项目构建过程: 1、首先，使用命令行：‘cmake <source tree>’，比如：cmake .. ，在你的构建目录（外部构建方式）下生成了项目文件 project files，官方文档中又叫 build tree / binary tree，这其中就包括，比如：Makefile，还有一些其他相关文件 / 目录 / 子目
【C++】Cmake使用教程（看这一篇就够了）
热门推荐
Friday
11-25 8万+
以上是自己学习CMake的一点学习记录，通过简单的例子让大家入门CMake，学习的同时也阅读了很多网友的博客。CMake的知识点还有很多，具体详情可以在网上搜索。总之，CMake可以让我们不用去编写复杂的Makefile，并且跨平台，是个非常强大并值得一学的工具。
备用备用备用备用备用备用备用备用备用备用
u013250861的博客
11-13 670
备用备用备用备用备用备用备用备用备用备用备用备用备用。
1.初始cmake
刘望的博客
11-04 330
初始cmake
CMake | CMake快速上手（3.26.3）
Mculover666的博客（嵌入式）
04-30 2051
CMake是一个开源、跨平台的工具系列，用于构建、测试和打包软件。CMake用于使用简单的平台和编译器独立的配置文件来控制软件编译过程，并生成可在您选择的编译器环境中使用的本地makefile和工作区。CMake工具套件由Kitware创建，以响应开源项目(如ITK和VTK)对强大的跨平台构建环境的需求。
cmake入门使用方法
04-17
对于初学者来说，理解CMake的基本概念和用法是至关重要的。本篇文章将深入浅出地介绍CMake的基本知识，帮助你快速入门。 ### 1. CMake简介 CMake是一个开源的构建系统，它的目标是简化跨平台项目的构建过程。它不...
cmake使用文档.pdf
02-02
### CMake 使用文档知识点概述 #### 一、CMake简介 CMake是一个强大的跨平台构建系统，能够简化软件项目的构建过程。它通过一系列简洁的语句来描述不同平台下的安装和编译流程，并能输出各种格式的makefile或...
cmake使用实例
12-05
1. CMake的基本概念和作用。 2. `CMakeLists.txt`文件的编写，包括设置项目属性、添加源文件和库依赖。 3. CMake命令的使用，如`cmake_minimum_required`、`project`、`add_executable`、`find_package`和`target_...
CMake使用教程.pdf
01-03
#### 三、CMake基本概念 - **CMakeLists.txt**：每个项目的根目录及其子目录下都包含一个名为CMakeLists.txt的文本文件，用于定义项目的构建规则。 - **变量与宏**：CMake支持定义变量和宏，用于简化配置文件和实现...
ios使用cmake编译framework
10-12
本篇文章将深入探讨如何使用CMake构建iOS框架（framework），并介绍相关的关键知识点。 首先，我们来理解“iOS.cmake”——这是一个工具链文件（toolchain file）。在CMake中，工具链文件用于指定特定平台的编译器...
cmake使用详细教程（日常使用这一篇就足够了）
iuu77的博客
02-27 7万+
此时可以使用cmake中的函数存储这些源文件。只需要在CMakeLists.txt中添加所依赖的.cpp文件，编译步骤和上面相同。有时编译程序时想添加一些编译选项，如-Wall，-std=c++11等，可以使用。此时在当前目录新增两个依赖，并mian函数的执行需要依赖这两个文件。1、在官网下载cmake的安装包，这里我下载的是v3.26。4、此时已经安装完成，可以在shell中使用cmake命令。2、找到下载的sh文件，并使用bash来执行sh脚本。对于集中的头文件，CMake提供了一个很方便的函数。
cmake集合教程 ( 详细 )
a15322910600的博客
10-15 1485
构建和运行： 构建：cmake ./ 编译/链接 cmake --build .
cmake的基本使用
u013798595的博客
03-24 170
常用编译方式 # 建造中间目录,编译好后可删去 mkdir build cd build cmake .. make 基本语法 # 声明要求的 cmake 最低版本 cmake_minimum_required( VERSION 2.8 ) # 声明一个 cmake 工程 project( HelloSLAM ) # 设置编译模式 set( CMAKE_BUILD_TYPE "Debug" ) # 添加一个可执行程序 # 语法：add_executable( 程序名 源代码文件 ） add_exe
cmake的使用-目标类型详解
AndrewYZWang的博客
10-18 3668
Target Types 本章概括 CMake支持的类型有很多种，可以是可执行文件或者库文件，也可以在不构建的情况下作为其它实体的引用。 使用这种引用作用：可以在不将对象构建成自己的二进制文件的情况下，为这些被引用的文件属性和依赖项。你也可以将这些被引用的文件称为一种新型库，这种库不是传统意义上的静态库或者动态库，而是一种对象文件的集合。 很多事物都可以抽象为一个对象来隐藏复杂的平台的差异、文件在系统中的位置、文件名等，本章会介绍所有对象类型，并介绍他们的用途。 除了上述提到的静态库、动态库以及引用库，还有
【cmake】cmake使用教程（实操版）
Dayu_log的博客
11-09 3463
cmake
cmake编译
weixin_44359953的博客
08-15 1万+
CMake编译原理 CMake是一种跨平台编译工具，比make更为高级，使用起来要方便得多。CMake主要是编写CMakeLists.txt文件，然后用cmake命令将CMakeLists.txt文件转化为make所需要的makefile文件，最后用make命令编译源码生成可执行程序或共享库（so(shared object)）。因此CMake的编译基本就两个步骤： cmake make CMake说明 一般把CMakeLists.txt文件放在工程目录下，使用时，先创建一个叫build的文件夹（这个并
CMakeListx.txt 编辑语法学习
weixin_34306593的博客
07-12 217
2019独角兽企业重金招聘Python工程师标准>>> ...
cmake 的使用方法
123
12-06 1万+
  cmake 是一个跨平台的自动构建工具， cmake 是为了解决直接使用 make+Makefile 这种方式无法实现跨平台的问题，所以 cmake 是可以实现跨平台的编译工具。即：cmake 就是用来产生 Makefile 的工具，解析 CMakeLists.txt 自动生成 Makefile。 一、cmake的安装   cmake 的官网是https://cmake.org/。   cmake 就是一个工具命令，在 Ubuntu 系统下通过 apt-get 命令可以在线安装，如下所示： sudo
CMakeLists.txt 设置编译模式为debug
u012194446的博客
07-09 5126
SET(CMAKE_BUILD_TYPE “Debug”)
cmake命令使用手册
最新发布
01-24
cmake是一种跨平台的开源构建工具，用于自动化生成各种编译工程的构建文件。它的使用手册提供了对cmake命令的详细说明，使开发者能够熟练使用cmake构建工程。 cmake命令使用手册包含了各种命令和选项，用于定义构建规则、设置构建属性和配置工程。 首先是cmake命令的基本语法，在命令行中输入"cmake [options] <path>"，其中options可以是一些用于配置的选项，path代表CMakeLists.txt文件所在的路径。 手册介绍了一些常用的cmake选项，比如"-D<var>:<type>=<value>"用于设置变量的值和类型，"-G <generator>"用于指定生成器，"-B <dir>"用于设置构建目录等。 手册还详细阐述了cmake命令的各种命令，比如add_executable用于添加可执行文件的编译规则，add_library用于添加静态库或动态库的编译规则，target_link_libraries用于连接库等。 手册还对cmake命令的补充和扩展进行了介绍，比如通过include命令可以引入其他cmake文件的内容，通过find_package命令可以查找外部依赖的包等。 此外，手册还提供了大量的实例和示例，帮助开发者理解和掌握cmake命令的使用。 总之，cmake命令使用手册是一个非常有用的文档，它详细介绍了cmake的语法、选项和命令，能够帮助开发者正确地配置和构建项目，提高开发效率。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值