4.cmake-更好的hello-world

最新推荐文章于 2023-06-14 02:06:52 发布
最新推荐文章于 2023-06-14 02:06:52 发布
阅读量252 收藏
点赞数
分类专栏： cmake快速入门 文章标签： linux cmake c++
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_29407397/article/details/127684863
版权

从本小节开始，后面所有的构建我们都将采用 out-of-source 外部构建，约定的构建目录是工程目录下的 build 自录
本小节的任务是让前面的 Hello World 更像一个工程，

我们需要作的是：
1，为工程添加一个子目录 src，用来放置工程源代码;
2，添加一个子目录 doc，用来放置这个工程的文档 hello.txt
3，在工程目录添加文本文件 COPYRIGHT, README；
4，在工程目录添加一个 runhello.sh 脚本，用来调用 hello 二进制
5，将构建后的目标文件放入构建目录的 bin 子目录；
6，最终安装这些文件：将 hello 二进制与 runhello.sh 安装至/usr/bin，将 doc 目录的内容以及 COPYRIGHT/README ，安装到/usr/share/doc/cmake/t2

1.准备工作

在cmake目录下建立t2目录
将t1工程里的main.c和CMakeLists.txt拷贝到t2目录中
main.c :

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

CMakeLists.txt:

cmake_minimum_required(VERSION 3.0.0)
project(hello)
 
set(SRC_LIST main.c)
 
message(STATUS "1.PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR}")
message(STATUS "1.PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR}")

add_executable(hello ${SRC_LIST})

2.添加子目录src

添加子目录并且把main.c放到src目录中:

mkdir src
mv main.c src

现在的工程看起来是这个样子：
一个子目录 src，一个 CMakeLists.txt。
上一节我们提到，需要为任何子目录建立一个 CMakeLists.txt，
进入子目录 src，编写 CMakeLists.txt 如下：

cmake_minimum_required(VERSION 3.0.0)
add_executable(hello main.cpp)

将 t2 工程的 CMakeLists.txt 修改为:

cmake_minimum_required(VERSION 3.0.0)
project(hello)
add_subdirectory(src bin)

然后建立 build 目录
可以看到当前的目录结构:

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2# tree
.
├── CMakeLists.txt
├── build
└── src
    ├── CMakeLists.txt
    └── main.c

2 directories, 3 files
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2#

进入 build 目录进行外部编译

cmake ..
make

我们可以看到编译过程如下:

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build# cmake ..
-- The C compiler identification is GNU 9.4.0
-- The CXX compiler identification is GNU 9.4.0
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done
-- Generating done
-- Build files have been written to: /mnt/d/study/lwstudy/cmake/t2/build
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build# make
Scanning dependencies of target hello
[ 50%] Building C object bin/CMakeFiles/hello.dir/main.c.o
[100%] Linking C executable hello
[100%] Built target hello
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build#

构建完成后，你会发现生成的目标文件 hello 位于 build/bin 目录中。

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build# cd bin/
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build/bin# ls
CMakeFiles  Makefile  cmake_install.cmake  hello
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build/bin#

语法解释:
ADD_SUBDIRECTORY 指令

ADD_SUBDIRECTORY(source_dir [binary_dir] 
                [EXCLUDE_FROM_ALL])

这个指令用于向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制存放的位置。EXCLUDE_FROM_ALL 参数的含义是将这个目录从编译过程中排除，比如，工程的 example，可能就需要工程构建完成后，再进入 example 目录单独进行构建(当然，你也可以通过定义依赖来解决此类问题)。

上面的例子定义了将 src 子目录加入工程，并指定编译输出(包含编译中间结果)路径为bin 目录。如果不进行 bin 目录的指定，那么编译结果(包括中间结果)都将存放在build/src 目录(这个目录跟原有的 src 目录对应)，指定 bin 目录后，相当于在编译时将 src 重命名为 bin，所有的中间结果和目标二进制都将存放在 bin 目录。
修改src目录下的CMakeLists.txt文件里面的add_subdirectory(src bin)

add_subdirectory(src)

编译结果如下:

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build# make
Scanning dependencies of target hello
[ 50%] Building C object src/CMakeFiles/hello.dir/main.c.o
[100%] Linking C executable hello
[100%] Built target hello
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build# ls
CMakeCache.txt  CMakeFiles  Makefile  cmake_install.cmake  src
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build# cd src/
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build/src# ls
CMakeFiles  Makefile  cmake_install.cmake  hello
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build/src#

这里需要提一下的是 SUBDIRS 指令，使用方法是:

SUBDIRS(dir1 dir2...)

它可以一次添加多个子目录，
并且，即使外部编译，子目录体系仍然会被保存。

如果我们在上面的例子中将 ADD_SUBDIRECTORY (src bin)修改为 SUBDIRS(src)。那么在 build 目录中将出现一个 src 目录，生成的目标代码 hello 将存放在 src 目录中

3.换个地方保存目标二进制

不论是 SUBDIRS 还是 ADD_SUBDIRECTORY 指令(不论是否指定编译输出目录)，我们都可以通过 SET 指令重新定义 EXECUTABLE_OUTPUT_PATH 和 LIBRARY_OUTPUT_PATH 变量来指定最终的目标二进制的位置(指最终生成的 hello 或者最终的共享库，不包含编译生成的中间文件)

SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)

在第一节我们提到了<projectname>_BINARY_DIR 和 PROJECT_BINARY_DIR 变量，他们指的编译发生的当前目录，如果是内部编译，就相当于 PROJECT_SOURCE_DIR 也就是工程代码所在目录，如果是外部编译，指的是外部编译所在目录，也就是本例中的 build目录。

所以，上面两个指令分别定义了：
可执行二进制的输出路径为 build/bin 和库的输出路径为 build/lib

本节我们没有提到共享库和静态库的构建，所以，你可以不考虑第二条指令

问题是，我应该把这两条指令写在工程的 CMakeLists.txt 还是 src 目录下的CMakeLists.txt，把握一个简单的原则，在哪里 ADD_EXECUTABLE 或 ADD_LIBRARY，如果需要改变目标存放路径，就在哪里加入上述的定义

在这个例子里，当然就是指 src 下的 CMakeLists.txt 了。

4.如何安装

安装的需要有两种，一种是从代码编译后直接 make install 安装，一种是打包时的指定目录安装。

所以，即使最简单的手工编写的 Makefile，看起来也是这个样子的:

DESTDIR=
install:
mkdir -p $(DESTDIR)/usr/bin
install -m 755 hello $(DESTDIR)/usr/bin

你可以通过:

make install

将 hello 直接安装到/usr/bin 目录，也可以通过 make install DESTDIR=/tmp/test 将他安装在
/tmp/test/usr/bin 目录，打包时这个方式经常被使用

稍微复杂一点的是还需要定义 PREFIX，一般 autotools 工程，会运行这样的指令:
./configure –prefix=/usr 或者./configure --prefix=/usr/local 来指定PREFIX
比如上面的 Makefile 就可以改写成:

DESTDIR=
PREFIX=/usr
install:
    mkdir -p $(DESTDIR)/$(PREFIX)/bin
    install -m 755 hello $(DESTDIR)/$(PREFIX)/bin

那么我们的 HelloWorld 应该怎么进行安装呢？
这里需要引入一个新的 cmake 指令 INSTALL 和一个非常有用的变量CMAKE_INSTALL_PREFIX。
CMAKE_INSTALL_PREFIX 变量类似于 configure 脚本的 –prefix，常见的使用方法看起来是这个样子：

cmake -DCMAKE_INSTALL_PREFIX=/usr ..

INSTALL 指令用于定义安装规则，安装的内容可以包括目标二进制、动态库、静态库以及文件、目录、脚本等。

INSTALL指令包含了各种安装类型，我们需要一个个分开解释:

目标文件的安装

INSTALL(TARGETS targets... [[ARCHIVE|LIBRARY|RUNTIME] 
        [DESTINATION <dir>] 
        [PERMISSIONS permissions...] 
        [CONFIGURATIONS [Debug|Release|...]] 
        [COMPONENT <component>] [OPTIONAL]] [...])

参数中的 TARGETS 后面跟的就是我们通过 ADD_EXECUTABLE 或者 ADD_LIBRARY 定义的目标文件，可能是可执行二进制、动态库、静态库。

目标类型也就相对应的有三种，ARCHIVE 特指静态库，LIBRARY 特指动态库，RUNTIME特指可执行目标二进制。

DESTINATION 定义了安装的路径，如果路径以/开头，那么指的是绝对路径，这时候CMAKE_INSTALL_PREFIX 其实就无效了。如果你希望使用 CMAKE_INSTALL_PREFIX 来定义安装路径，就要写成相对路径，即不要以/开头，那么安装后的路径就是

举个简单的例子:

INSTALL(TARGETS myrun mylib mystaticlib
        RUNTIME DESTINATION bin
        LIBRARY DESTINATION lib
        ARCHIVE DESTINATION libstatic
        )

上面的例子会将：
可执行二进制 myrun 安装到${CMAKE_INSTALL_PREFIX}/bin 目录 动态库 libmylib 安装到${CMAKE_INSTALL_PREFIX}/lib 目录
静态库 libmystaticlib 安装到${CMAKE_INSTALL_PREFIX}/libstatic 目录

特别注意的是你不需要关心 TARGETS 具体生成的路径，只需要写上 TARGETS 名称就可以
了。

普通文件的安装

INSTALL(FILES files... DESTINATION <dir> 
        [PERMISSIONS permissions...] 
        [CONFIGURATIONS [Debug|Release|...]] 
        [COMPONENT <component>] [RENAME <name>] [OPTIONAL])

可用于安装一般文件，并可以指定访问权限，文件名是此指令所在路径下的相对路径。如果默认不定义权限 PERMISSIONS，安装后的权限为：OWNER_WRITE, OWNER_READ, GROUP_READ,和 WORLD_READ，即644权限

非目标文件的可执行程序安装(比如脚本之类)

INSTALL(PROGRAMS files... DESTINATION <dir> 
        [PERMISSIONS permissions...] 
        [CONFIGURATIONS [Debug|Release|...]] 
        [COMPONENT <component>] 
        [RENAME <name>] [OPTIONAL])

跟上面的 FILES 指令使用方法一样，唯一的不同是安装后权限为:
OWNER_EXECUTE, GROUP_EXECUTE, 和 WORLD_EXECUTE，即 755 权限

目录的安装:

INSTALL(DIRECTORY dirs... DESTINATION <dir>
        [FILE_PERMISSIONS permissions...]
        [DIRECTORY_PERMISSIONS permissions...]
        [USE_SOURCE_PERMISSIONS]
        [CONFIGURATIONS [Debug|Release|...]]
        [COMPONENT <component>]
        [[PATTERN <pattern> | REGEX <regex>]
        [EXCLUDE] [PERMISSIONS permissions...]] [...])

这里主要介绍其中的 DIRECTORY、PATTERN 以及 PERMISSIONS 参数
DIRECTORY 后面连接的是所在 Source 目录的相对路径，但务必注意:
abc 和 abc/有很大的区别。
如果目录名不以/结尾，那么这个目录将被安装为目标路径下的 abc，如果目录名以/结尾，代表将这个目录中的内容安装到目标路径，但不包括这个目录本身。

PATTERN 用于使用正则表达式进行过滤，PERMISSIONS 用于指定 PATTERN 过滤后的文件权限。
我们来看一个例子:

INSTALL(DIRECTORY icons scripts/ DESTINATION share/myprojPATTERN "CVS" EXCLUDE
        PATTERN "scripts/*"
        PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ
        GROUP_EXECUTE GROUP_READ)

这条指令的执行结果是:
将 icons 目录安装到 <prefix>/share/myproj，将 scripts/中的内容安装到 <prefix>/share/myproj

不包含目录名为 CVS 的目录，对于 scripts/*文件指定权限为 OWNER_EXECUTE
OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ。

安装时CMAKE脚本的执行

todo liuwang 这个地方不是很明白

INSTALL([[SCRIPT <file>] [CODE <code>]] [...])
SCRIPT 参数用于在安装时调用 cmake 脚本文件（也就是<abc>.cmake 文件）
CODE 参数用于执行CMAKE指令, 必须以双引号括起来。比如:
INSTALL(CODE "MESSAGE(\"Sample install message.\")")

安装还有几个被标记为过时的指令，比如 INSTALL_FILES 等，这些指令已经不再推荐使用，所以，这里就不再赘述了。

下面，我们就来改写我们的工程文件，让他来支持各种文件的安装，并且，我们要使用CMAKE_INSTALL_PREFIX 指令。

5.修改Helloworld支持安装

在本节开头我们定义了本节的任务如下：
1，为工程添加一个子目录 src，用来存储源代码;
2，添加一个子目录 doc，用来存储这个工程的文档 hello.txt
3，在工程目录添加文本文件 COPYRIGHT, README；
4，在工程目录添加一个 runhello.sh 脚本，用来调用 hello 二进制
5，将构建后的目标文件放入构建目录的 bin 子目录；
6，最终安装这些文件：将 hello 二进制与 runhello.sh 安装至/<prefix>/bin，将doc 目录中的 hello.txt 以及 COPYRIGHT/README 安装到/<prefix>/share/doc/cmake/t2

首先我们先补上为添加的文件
添加 doc 目录及文件

cd /cmake/t2
mkdir doc
vi doc/hello.txt

随便填写一些内容并保存

在工程目录添加 runhello.sh 脚本，内容为:

./hello

添加工程目录中的COPYRIGHT和README

touch COPYRIGHT
touch README

下面改写各目录的CMakeLists.txt文件。
1，安装 COPYRIGHT/README，直接修改主工程文件 CMakelists.txt，加入以下指令：

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

2，安装 runhello.sh，直接修改主工程文件 CMakeLists.txt，加入如下指令：

```
INSTALL(PROGRAMS runhello.sh DESTINATION bin)
```

3，安装 doc 中的 hello.txt，这里有两种方式：一是通过在 doc 目录建立CMakeLists.txt 并将 doc 目录通过 ADD_SUBDIRECTORY 加入工程来完成。另一种方法是直接在工程目录通过

INSTALL(DIRECTORY 来完成)，前者比较简单，各位可以根据兴趣自己完成，我们来尝试
后者，顺便演示以下 DIRECTORY 的安装。

因为 hello.txt 要安装到/<prefix>/share/doc/cmake/t2，所以我们不能直接安装整个 doc 目录，这里采用的方式是安装 doc 目录中的内容，也就是使用”doc/”

在工程文件中添加

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

6.尝试我们修改的结果

现在进入 build 目录进行外部编译，注意使用 CMAKE_INSTALL_PREFIX 参数，这里我们将它安装到了/tmp/t2 目录

cmake -DCMAKE_INSTALL_PREFIX=/tmp/t2/usr ..

然后运行

make
make install

让我们进入/tmp/t2 目录看一下安装结果

./usr
./usr/share
./usr/share/doc./usr/share/doc/cmake
./usr/share/doc/cmake/t2
./usr/share/doc/cmake/t2/hello.txt
./usr/share/doc/cmake/t2/README
./usr/share/doc/cmake/t2/COPYRIGHT
./usr/bin
./usr/bin/hello
./usr/bin/runhello.sh

如果你要直接安装到系统，可以使用如下指令
cmake -DCMAKE_INSTALL_PREFIX=/usr …

如果我没有定义 CMAKE_INSTALL_PREFIX 会安装到什么地方？你可以尝试以下，cmake …;make;make install，你会发现CMAKE_INSTALL_PREFIX 的默认定义是/usr/local

小结

本小节主要描述了如何在工程中使用多目录、各种安装指令以及CMAKE_INSTALL_PREFIX 变量(你真够牛的，这么点东西居然罗唆了这么多文字)

在下一小节，我们将探讨如何在 cmake 中构建动态库和静态库，以及如何使用外部头文件和外部共享库，毕竟，这是程序编写中最长使用的（对了，你知道用怎样的 gcc 参数可以直接构建静态库和动态库吗？）

刘大望
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
cmake-3.26.4-windows-x86-64
05-26
文章《将 Rust 程序编译为 WebAssembly》可能用到的资源：cmake-3.26.4-windows-x86_64
cmake-3.23.2-windows-x86-64.msi
07-30
名称：cmake-3.23.2-windows-x86_64.msi 版本：3.23.2 文件类型：Windows安装程序（.msi） 描述： cmake-3.23.2-windows-x86_64.msi是用于Windows操作系统的CMake构建工具的安装程序文件。CMake是一个开源跨平台的...
【CMake】常见目录——10.1安装项目
I'm Zz.
03-20 1275
这意味着在执行时，将加载动态库。因此有关库位置的信息需要在某个地方进行编码，以便加载程序能够成功的完成其工作。
CMAKE编译输出目录
Wlk1229
04-18 3596
如果有编译和调用动态库，需要设置动态库的输出位置，否则运行时可能会出现找不到动态库，特别时MSVC生成的DLL。可以通过以下方式设置DLL的输出位置。这样所有的输出都会到指定目录。
cmake 构建工具 一 hello world
kangshuangzhu的博客
07-18 869
指定需要编译的源文件指定头文件的搜索目录指定库文件的搜索目录需要链接的动态库和静态库指定需要额外定义的宏或者取消定义的宏来控制编译指定编译优化选项指定语言标准等等直接使用gcc/g++命令在使用代码文件不多，库直接的依赖关系不复杂的情况下是可以接受的。但是在一些大型项目中，源文件上千上万，各个文件和库直接的依赖关系复杂，如果还手动输入编译命令的话，复杂度就会变得很大。简单来讲，代码变成可执行文件，叫做编译（compile）；
CMake详细解析及使用步骤
qq_49326230的博客
09-30 6252
cmake的使用及其详细步骤
cmake编译找不到已存在的动态库
liu__ting的博客
07-06 3671
cmake编译找不到已存在的动态库
cmake-3.29.0-windows-x86-64
最新发布
04-01
cmake-3.29.0-windows-x86_64
linux下安装 cmake-3.27.6安装脚本 cmake-3.27.6-linux-x86-64.sh
10-22
linux下安装cmake安装脚本： 方法如下： 1：sudo chmod +x cmake-3.27.6-linux-x86_64.sh 2：sudo sh cmake-3.27.6-linux-x86_64.sh --skip-license --prefix=/usr/local/
cmake-3.21.3-windows-x86_64.msi
10-14
win64 cmake 新版 3.21.3
CMake I CMake入门之hello world
该用户还没想到好的昵称的博客
01-04 2068
目录 一、环境安装 1.安装CMake 2.安装编译器 （1）visual studio 3.自动化构建工具 （1）visual studio （2）Ninja 二、hello world 1.编写cpp文件 2.编写CMakeLists.txt文件 3.项目配置 4.编译可执行文件 5.操作目标文件 一、环境安装 1.安装CMake 官网：Download | CMake 2.安装编译器 编译器就是将“一种语言（通常为高级语言）”翻译为“另一种语言（通常...
CMake HelloWorld!
guoqx的专栏
08-08 299
CMake is a meta build system that uses scripts called CMakeLists to generate build files for a specific environment (for example, makefiles on Unix machines). CMake是一个元构建系统，通过名为CMakeLists.txt的脚本，来生成一个本地环境的的 Makefile构建文件。说白了，cmake是用来帮助我们生成Makefile的，不用...
cmake编译之后产生的项目解析
贾路飞的博客
10-10 1032
cmake
Cmake Helloworld
weixin_44681349的博客
10-07 213
cmake
3.初试cmake-cmake的helloworld
刘望的博客
11-04 369
3.初试cmake-cmake的helloworld
cmake编译总结
qq_44986790的博客
01-08 857
cmake 编译总结
(CMake系列)CMAKE的hello world
LeMark2333的博客
10-29 522
cmake的hello world
CMake：01 编写 CMake 的 HelloWorld
韭菜鲜肉大馄饨的专栏
07-28 500
编写 Cmake 的 HelloWorld一、HelloWorld二、CMake 语法2.1 常见用法2.2 语法简介2.3 语法规则 一、HelloWorld 1.选择某个目录（这里我选择的是 /home/lql，即家目录）为根目录，进入该目录 ① 进入家目录命令（有两种方式） // 普通用户家目录 /home/xxx，root 用户家目录 /root cd /home/lql 或 cd ~ ...
windows下cmake的小白级入门使用教程(hello world)
热门推荐
我都博客
06-14 1万+
经过几天的努力将cmake的“hello world”整个步骤从新电脑(重装系统后的电脑，基于VMware虚拟机)的角度跑通了，并将下述过程记录进行了验证，结果是可行的。
ms-vscode.cmake-tools-1.4.0.vsix
09-09
ms-vscode.cmake-tools-1.4.0.vsix 是一个用于 Visual Studio Code 编辑器的插件，用于与 CMake 构建系统集成和管理项目。 CMake 是一个跨平台的开源构建工具，可以帮助开发者管理和构建 C/C++ 项目。而 ms-vscode....

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

刘大望

谢谢你请的咖啡

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

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

打赏作者

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

抵扣说明：

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

余额充值