CMake
说明
cmake的定义是什么 ?-----高级编译配置工具。
当多个人用不同的语言或者编译器开发一个项目,最终要输出一个可执行文件或者共享库(dll,so等等)这时候神器就出现了-----CMake!
所有操作都是通过编译CMakeLists.txt来完成的—简单。
官 方网站是 www.cmake.org,可以通过访问官方网站获得更多关于 cmake 的信息。
学习CMake的目的,为将来处理大型的C/C++/JAVA项目做准备。
CMake安装
1、绝大多数的linux系统已经安装了CMake。
2、Windows或某些没有安装过的linux系统,去http://www.cmake.org/HTML/Download.html 可以下载安装。
CMake一个Add
1、步骤一,写一个加法程序。
#include<iostream>
#include<functional>
#include<stdlib.h>
int add(int a,int b)
{
return a+b;
}
int test(std::function<int(int,int)> &&a)
{
return a(1,2);
}
#include"function.h"
int main()
{
std::cout<<test(add)<<std::endl;
system("pause");
return 0;
}
2、步骤二,写CMakeLists.txt。
cmake_minimum_required(VERSION 2.8)
project(测试cmake)
set(SRC_LIST main.cpp)
add_executable(main ${SRC_LIST})
MESSAGE(STATUS "This is BINARY dir " ${HELLO_BINARY_DIR})
MESSAGE(STATUS "This is SOURCE dir "${HELLO_SOURCE_DIR})
ADD_EXECUTABLE(hello ${SRC_LIST})
3、步骤三、使用cmake,生成makefile文件。
cmake .
输出:
-- Building for: Visual Studio 16 2019
CMake Deprecation Warning at CMakeLists.txt:1 (cmake_minimum_required):
Compatibility with CMake < 2.8.12 will be removed from a future version of
CMake.
Update the VERSION argument <min> value or use a ...<max> suffix to tell
CMake that the project does not need compatibility with older versions.
-- Selecting Windows SDK version 10.0.18362.0 to target Windows 10.0.19042.
-- The C compiler identification is MSVC 19.27.29112.0
-- The CXX compiler identification is MSVC 19.27.29112.0
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: C:/Program Files (x86)/Microsoft Visual Studio/2019/Community/VC/Tools/MSVC/14.27.29110/bin/Hostx64/x64/cl.exe - skipped
-- Detecting C compile features
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: C:/Program Files (x86)/Microsoft Visual Studio/2019/Community/VC/Tools/MSVC/14.27.29110/bin/Hostx64/x64/cl.exe - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done
-- Generating done
PS D:\cmake教程代码\包含头文件的cpp文件\win64> cmake --build .
用于 .NET Framework 的 Microsoft (R) 生成引擎版本 16.7.0+b89cb5fde
版权所有(C) Microsoft Corporation。保留所有权利。
Checking Build System
Building Custom Rule D:/cmake??????/??????????cpp???/src/CMakeLists.txt
main.cpp
main.vcxproj -> D:\cmake教程代码\包含头文件的cpp文件\win64\bin\Debug\main.exe
Building Custom Rule D:/cmake??????/??????????cpp???/CMakeLists.txt
PS D:\cmake教程代码\包含头文件的cpp文件\win64> cmake ..
CMake Deprecation Warning at CMakeLists.txt:1 (cmake_minimum_required):
Compatibility with CMake < 2.8.12 will be removed from a future version of
CMake.
Update the VERSION argument <min> value or use a ...<max> suffix to tell
CMake that the project does not need compatibility with older versions.
-- Selecting Windows SDK version 10.0.18362.0 to target Windows 10.0.19042.
CMake Warning (dev) at src/CMakeLists.txt:7:
Argument not separated from preceding token by whitespace.
This warning is for project developers. Use -Wno-dev to suppress it.
-- This is BINARY dir
-- This is SOURCE dir
-- Configuring done
-- Generating done
-- Build files have been written to: D:/cmake教程代码/包含头文件的cpp文件/win64
目录下就生成了这些文件-CMakeFiles, CMakeCache.txt, cmake_install.cmake 等文件,并且生成了Makefile.
现在不需要理会这些文件的作用,以后你也可以不去理会。最关键的是,它自动生成了Makefile.
4、使用cmake --build.命令编译。
PS D:\cmake教程代码\包含头文件的cpp文件\win64> cmake --build .
CMake is re-running because D:/cmake教程代码/包含头文件的cpp文件/win64/CMakeFiles/generate.stamp is out-of-date. the file 'D:/cmake教程代码/包含头文件的cpp文件/CMakeLists.txt'
is newer than 'D:/cmake教程代码/包含头文件的cpp文件/win64/CMakeFiles/generate.stamp.depend'
result='-1'
CMake Deprecation Warning at CMakeLists.txt:1 (cmake_minimum_required):
Compatibility with CMake < 2.8.12 will be removed from a future version of
CMake.
Update the VERSION argument <min> value or use a ...<max> suffix to tell
CMake that the project does not need compatibility with older versions.
-- Selecting Windows SDK version 10.0.18362.0 to target Windows 10.0.19042.
CMake Warning (dev) at src/CMakeLists.txt:7:
Syntax Warning in cmake code at column 37
Argument not separated from preceding token by whitespace.
This warning is for project developers. Use -Wno-dev to suppress it.
-- This is BINARY dir
-- This is SOURCE dir
-- Configuring done
-- Generating done
-- Build files have been written to: D:/cmake教程代码/包含头文件的cpp文件/win64
用于 .NET Framework 的 Microsoft (R) 生成引擎版本 16.7.0+b89cb5fde
版权所有(C) Microsoft Corporation。保留所有权利。
Checking Build System
main.vcxproj -> D:\cmake教程代码\包含头文件的cpp文件\win64\bin\Debug\main.exe
Building Custom Rule D:/cmake??????/??????????cpp???/CMakeLists.txt
5、最终生成了main的可执行程序。
CMake一个Add的语法介绍
PROJECT关键字
可以用来指定工程的名字和支持的语言,默认支持所有语言
PROJECT (HELLO) 指定了工程的名字,并且支持所有语言—建议
PROJECT (HELLO CXX) 指定了工程的名字,并且支持语言是C++
PROJECT (HELLO C CXX) 指定了工程的名字,并且支持语言是C和C++
该指定隐式定义了两个CMAKE的变量
_BINARY_DIR,本例中是 HELLO_BINARY_DIR
_SOURCE_DIR,本例中是 HELLO_SOURCE_DIR
MESSAGE关键字就可以直接使用者两个变量,当前都指向当前的工作目录,后面会讲外部编译
问题:如果改了工程名,这两个变量名也会改变
解决:又定义两个预定义变量:PROJECT_BINARY_DIR和PROJECT_SOURCE_DIR,这两个变量和HELLO_BINARY_DIR,HELLO_SOURCE_DIR是一致的。所以改了工程名也没有关系
SET关键字
用来显示的指定变量的
SET(SRC_LIST main.cpp) SRC_LIST变量就包含了main.cpp
也可以 SET(SRC_LIST main.cpp t1.cpp t2.cpp)
MESSAGE关键字
向终端输出用户自定义的信息
主要包含三种信息:
- SEND_ERROR,产生错误,生成过程被跳过。
- SATUS,输出前缀为—的信息。
- FATAL_ERROR,立即终止所有 cmake 过程.
ADD_EXECUTABLE关键字
生成可执行文件。
ADD_EXECUTABLE(main ${SRC_LIST}) 生成的可执行文件名是main,源文件读取变量SRC_LIST中的内容。
也可以直接写 ADD_EXECUTABLE(mainmain.cpp)
上述例子可以简化的写成:
PROJECT(测试cmake)
ADD_EXECUTABLE(main main.cpp)
注意:工程名的 测试cmake 和生成的可执行文件 main是没有任何关系的。
语法的基本原则
-
变量使用${}方式取值,但是在 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”),如果源文件名中含有空格,就必须要加双引号。
- ADD_EXECUTABLE(main main) 后缀可以不行,他会自动去找.c和.cpp,最好不要这样写,可能会有这两个文件main.cpp和main。
内部构建和外部构建
- 上述例子就是内部构建,他生产的临时文件特别多,不方便清理。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-XbiFdz2D-1662808022836)(C:\Users\hp\AppData\Roaming\Typora\typora-user-images\image-20220909232843454.png)]
- 外部构建,就会把生成的临时文件放在build目录下,不会对源文件有任何影响强烈使用外部构建方式。
外部构建方式举例
//例子目录,CMakeLists.txt和上面例子一致
驱动器 D 中的卷是 新加卷
卷的序列号是 A257-2975
D:\cmake教程代码\单cpp文件 的目录
2022/09/09 下午 10:40 <DIR> .
2022/09/09 下午 10:40 <DIR> ..
2022/09/09 下午 10:37 48,201 ALL_BUILD.vcxproj
2022/09/09 下午 10:37 288 ALL_BUILD.vcxproj.filters
2022/09/09 下午 10:33 <DIR> build
2022/09/09 下午 10:37 14,009 CMakeCache.txt
2022/09/09 下午 10:37 <DIR> CMakeFiles
2022/09/09 下午 10:39 125 CMakeLists.txt
2022/09/09 下午 10:37 1,448 cmake_install.cmake
2022/09/09 下午 10:37 <DIR> Debug
2022/09/09 下午 10:21 96 main.cpp
2022/09/09 下午 10:37 <DIR> main.dir
2022/09/09 下午 10:37 57,441 main.vcxproj
2022/09/09 下午 10:37 579 main.vcxproj.filters
2022/09/09 下午 10:37 <DIR> x64
2022/09/09 下午 10:37 47,887 ZERO_CHECK.vcxproj
2022/09/09 下午 10:37 525 ZERO_CHECK.vcxproj.filters
2022/09/09 下午 10:37 3,108 测试cmake.sln
11 个文件 173,707 字节
7 个目录 263,814,991,872 可用字节
1、建立一个build目录,可以在任何地方,建议在当前目录下
2、进入build,运行cmake … 当然…表示上一级目录,你可以写CMakeLists.txt所在的绝对路径,生产的文件都在build目录下了。
3、在build目录下,运行cmake --build.来构建工程
注意外部构建的两个变量
1、HELLO_SOURCE_DIR 还是工程路径
2、HELLO_BINARY_DIR 编译路径 也就是 D:\cmake教程代码\单cpp文件\build
让Add看起来更像一个工程
- 为工程添加一个子目录 src,用来放置工程源代码
- 添加一个子目录 doc,用来放置这个工程的文档 hello.txt
- 在工程目录添加文本文件 COPYRIGHT, README
- 在工程目录添加一个 runhello.sh 脚本,用来调用 hello 二进制
- 将构建后的目标文件放入构建目录的 bin 子目录
- 将 doc 目录 的内容以及 COPYRIGHT/README 安装到/usr/share/doc/cmake/
将目标文件放入构建目录的 bin 子目录
每个目录下都要有一个CMakeLists.txt说明
D:\cmake教程代码\包含头文件的cpp文件>dir
驱动器 D 中的卷是 新加卷
卷的序列号是 A257-2975
D:\cmake教程代码\包含头文件的cpp文件 的目录
2022/09/09 下午 11:12 <DIR> .
2022/09/09 下午 11:12 <DIR> ..
2022/09/09 下午 11:00 <DIR> build
2022/09/09 下午 11:20 149 CMakeLists.txt
2022/09/09 下午 11:08 <DIR> src
2022/09/09 下午 11:21 <DIR> win64
1 个文件 149 字节
5 个目录 263,814,987,776 可用字节
外层CMakeLists.txt
cmake_minimum_required(VERSION 2.8)
project(hello)
#增加一个子目录到src下,二进制文件生成在bin目录
add_subdirectory(src bin)
src下的CMakeLists.txt
project(测试cmake)
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(main ${SRC_LIST})
#project(测试cmake)
#AUX_SOURCE_DIRECTORY(. DIR_SRCS)
#ADD_EXECUTABLE(main main.cpp)
#AUX_SOURCE_DIRECTORY(. DIR_SRCS)
#ADD_EXECUTABLE(main main.cpp)
ADD_SUBDIRECTORY 指令
ADD_SUBDIRECTORY(source_dir [binary_dir] [EXCLUDE_FROM_ALL])
#增加一个子目录到src下,二进制文件生成在bin目录
add_subdirectory(src bin)
-
这个指令用于向当前工程添加存放源文件的子目录,并可以指定中间二进制和目标二进制以及可执行文件存放的位置在bin位置。
-
EXCLUDE_FROM_ALL函数是将写的目录从编译中排除,如程序中的example
-
ADD_SUBDIRECTORY(src bin)
将 src 子目录加入工程并指定编译输出(包含编译中间结果)路径为bin 目录。
如果不进行 bin 目录的指定,那么编译结果(包括中间结果)都将存放在build/src 目录。
更改二进制的保存路径
SET 指令重新定义 EXECUTABLE_OUTPUT_PATH 和 LIBRARY_OUTPUT_PATH 变量 来指定最终的目标二进制的位置。
SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)
思考:加载哪个CMakeLists.txt当中?
哪里要改变目标存放路径,就在哪里加入上述的定义,所以应该在src下的CMakeLists.txt下写。
安装
- 一种是从代码编译后直接 make install 安装。
- 一种是打包时的指定 目录安装。
- 简单的可以这样指定目录:make install DESTDIR=/tmp/test。
- 稍微复杂一点可以这样指定目录:./configure –prefix=/usr。
如何安装Add
使用CMAKE一个新的指令:INSTALL。
INSTALL的安装可以包括:二进制、动态库、静态库以及文件、目录、脚本等。
使用CMAKE一个新的变量:CMAKE_INSTALL_PREFIX。
// 目录树结构
D:\cmake教程代码\包含头文件的cpp文件>tree
卷 新加卷 的文件夹 PATH 列表
卷序列号为 A257-2975
D:.
├── build
├── CMakeLists.txt
├── COPYRIGHT
├── doc
│ └── hello.txt
├── README
├── runhello.sh
└── src
├── CMakeLists.txt
└── main.cpp
└── function.h
├── win64
3 directories, 7 files
安装文件COPYRIGHT和README
INSTALL(FILES COPYRIGHT README DESTINATION share/doc/cmake/)
FILES:文件
DESTINATION:
1、写绝对路径
2、可以写相对路径,相对路径实际路径是:${CMAKE_INSTALL_PREFIX}/<DESTINATION 定义的路径>
CMAKE_INSTALL_PREFIX 默认是在 /usr/local/
cmake -DCMAKE_INSTALL_PREFIX=/usr 在cmake的时候指定CMAKE_INSTALL_PREFIX变量的路径
安装脚本runhello.sh
PROGRAMS:非目标文件的可执行程序安装(比如脚本之类)
INSTALL(PROGRAMS runhello.sh DESTINATION bin)
说明:实际安装到的是 /usr/bin
安装 doc 中的 hello.txt
-
一、是通过在 doc 目录建立CMakeLists.txt ,通过install下的file。
-
二、是直接在工程目录通过。
INSTALL(DIRECTORY doc/ DESTINATION share/doc/cmake)
DIRECTORY 后面连接的是所在 Source 目录的相对路径。
注意:abc 和 abc/有很大的区别。
目录名不以/结尾:这个目录将被安装为目标路径下的。
目录名以/结尾:将这个目录中的内容安装到目标路径。
cmake_minimum_required(VERSION 2.8)
project(hello)
#安装文件COPYRIGHT和README
INSTALL(FILES COPYRIGHT README DESTINATION D:/cmake教程代码/CMAKE)
#安装脚本runhello.sh
INSTALL(PROGRAMS runhello.sh DESTINATION bin)
#安装 doc 中的 hello.txt
INSTALL(DIRECTORY doc/ DESTINATION D:/cmake教程代码/CMAKE)
#增加一个子目录到src下,二进制文件生成在bin目录
add_subdirectory(src bin)
安装过程
cmake …
cmake --build .
make install
静态库和动态库的构建
任务:
1,建立一个静态库和动态库,提供 Add 函数供其他程序编程使用,Add 向终端输出 3。
2,安装头文件与共享库。
静态库和动态库的区别
- 静态库的扩展名一般为“.a”或“.lib”;动态库的扩展名一般为“.so”或“.dll”。
- 静态库在编译时会直接整合到目标程序中,编译成功的可执行文件可独立运行
- 动态库在编译时不会放到连接的目标程序中,即可执行文件无法单独运行。
构建实例
D:\cmake教程代码\动态库和静态库的构建>tree
卷 新加卷 的文件夹 PATH 列表
卷序列号为 A257-2975
D:
├── build
├── CMakeLists.txt
└── lib
├── CMakeLists.txt
├── main.cpp
└── function.h
function.h中的内容
#ifndef FUNCTION_H
#define FUNCTION_H
#include<iostream>
#include<functional>
#include<stdlib.h>
int add(int a,int b)
{
return a+b;
}
int test(std::function<int(int,int)> &&a)
{
return a(1,2);
}
#endif
main.cpp中的内容
#include"function.h"
int main()
{
std::cout<<test(add)<<std::endl;
system("pause");
return 0;
}
项目中的cmake内容
cmake_minimum_required(VERSION 2.8) //注意VERSION是大写
project(add)
add_subdirectory(lib bin)
lib中CMakeLists.txt中的内容
set(libary_src main.cpp)
add_library(main SHARED ${libary_src}) //SHARED也要大写
ADD_LIBRARY
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
- main:就是正常的库名,生成的名字前面会加上lib,最终产生的文件是libmain.dll
- SHARED,动态库 STATIC,静态库
- ${LIBHELLO_SRC} :源文件
同时构建静态和动态库
// 如果用这种方式,只会构建一个动态库,不会构建出静态库,虽然静态库的后缀是.lib
ADD_LIBRARY(main SHARED ${libary_src})
ADD_LIBRARY(main STATIC ${libary_src})
// 修改静态库的名字,这样是可以的,但是我们往往希望他们的名字是相同的,只是后缀不同而已
ADD_LIBRARY(main SHARED ${libary_src})
ADD_LIBRARY(main_static STATIC ${libary_src})
SET_TARGET_PROPERTIES
这条指令可以用来设置输出的名称,对于动态库,还可以用来指定动态库版本和 API 版本
同时构建静态和动态库
SET(LIBHELLO_SRC main.cpp)
ADD_LIBRARY(main_static STATIC ${LIBHELLO_SRC})
//对main_static的重名为main
SET_TARGET_PROPERTIES(main_static PROPERTIES OUTPUT_NAME "main")
//cmake 在构建一个新的target 时,会尝试清理掉其他使用这个名字的库,因为,在构建 libhello.so 时, 就会清理掉 libmain.lib
SET_TARGET_PROPERTIES(main_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)
ADD_LIBRARY(main SHARED ${LIBmain_SRC})
SET_TARGET_PROPERTIES(main PROPERTIES OUTPUT_NAME "main")
SET_TARGET_PROPERTIES(main PROPERTIES CLEAN_DIRECT_OUTPUT 1)
动态库的版本号
一般动态库都有一个版本号的关联
libhello.so.1.2
libhello.so ->libhello.so.1
libhello.so.1->libhello.so.1.2
CMakeLists.txt 插入如下
SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.2 SOVERSION 1)
VERSION 指代动态库版本,SOVERSION 指代 API 版本。
安装共享库和头文件
本例中我们将 main的共享库安装到/lib目录,
将 main.h 安装到/include/main 目录
//文件放到该目录下
INSTALL(FILES function.h DESTINATION include/main)
//二进制,静态库,动态库安装都用TARGETS
//ARCHIVE 特指静态库,LIBRARY 特指动态库,RUNTIME 特指可执行目标二进制。
INSTALL(TARGETS main main_static LIBRARY DESTINATION lib ARCHIVE DESTINATION lib)
注意:
安装的时候,指定一下路径,放到系统下
cmake -DCMAKE_INSTALL_PREFIX=/usr ..
使用外部共享库和头文件
准备工作,新建一个目录来使用外部共享库和头文件
[root@MiWiFi-R4CM-srv cmake3]# tree
.
├── build
├── CMakeLists.txt
└── src
├── CMakeLists.txt
└── main.cpp
main.cpp
#include <hello.h>
int main(){
HelloFunc();
}
解决:cmake --build .后头文件找不到的问题
PS:include <hello/hello.h> 这样include是可以,这么做的话,就没啥好讲的了
关键字:INCLUDE_DIRECTORIES 这条指令可以用来向工程添加多个特定的头文件搜索路径,路径之间用空格分割
在CMakeLists.txt中加入头文件搜索路径
INCLUDE_DIRECTORIES(/usr/include/hello)
感谢:
网友:zcc720的提醒
解决:找到引用的函数问题
报错信息:undefined reference to `HelloFunc()’
关键字:LINK_DIRECTORIES 添加非标准的共享库搜索路径
指定第三方库所在路径,LINK_DIRECTORIES(/home/myproject/libs)
关键字:TARGET_LINK_LIBRARIES 添加需要链接的共享库
TARGET_LINK_LIBRARIES的时候,只需要给出动态链接库的名字就行了。
在CMakeLists.txt中插入链接共享库,主要要插在executable的后面
查看main的链接情况
[root@MiWiFi-R4CM-srv bin]# ldd main
linux-vdso.so.1 => (0x00007ffedfda4000)
libhello.so => /lib64/libhello.so (0x00007f41c0d8f000)
libstdc++.so.6 => /lib64/libstdc++.so.6 (0x00007f41c0874000)
libm.so.6 => /lib64/libm.so.6 (0x00007f41c0572000)
libgcc_s.so.1 => /lib64/libgcc_s.so.1 (0x00007f41c035c000)
libc.so.6 => /lib64/libc.so.6 (0x00007f41bff8e000)
/lib64/ld-linux-x86-64.so.2 (0x00007f41c0b7c000)
链接静态库
TARGET_LINK_LIBRARIES(main libhello.a)
特殊的环境变量 CMAKE_INCLUDE_PATH 和 CMAKE_LIBRARY_PATH
注意:这两个是环境变量而不是 cmake 变量,可以在linux的bash中进行设置
我们上面例子中使用了绝对路径INCLUDE_DIRECTORIES(/usr/include/hello)来指明include路径的位置
我们还可以使用另外一种方式,使用环境变量export CMAKE_INCLUDE_PATH=/usr/include/hello
补充:生产debug版本的方法:
cmake … -DCMAKE_BUILD_TYPE=debug