（P1-P6）Cmake介绍
原创
©著作权归作者所有：来自51CTO博客作者喜欢打篮球的普通人的原创作品，请联系作者获取转载授权，否则将追究法律责任
文章目录
- 1.Cmake说明
- 2.Cmake之HelloWorld
- 3.Cmkae之HelloWorld语法介绍
- 4.Cmake之内部构件和外部构建
- 5.让Hello World看起来更像一个工程
- 6.如何安装HelloWord
1.Cmake说明
cmake的定义是什么 ？
- -----高级编译配置工具
- 当多个人用不同的语言或者编译器开发一个项目，最终要输出一个可执行文件或者共享库（dll，so等等）这时候神器就出现了-----CMake！
- 所有操作都是通过编译CMakeLists.txt来完成的—简单
官方网站是 www.cmake.org，可以通过访问官方网站获得更多关于 cmake 的信息 - 学习CMake的目的，为将来处理大型的C/C++/JAVA项目做准备
2.Cmake之HelloWorld
步骤一，写一个HelloWord
#main.cpp
#include <iostream>
int main(){
std::cout << "hello word" << std::endl;
}
步骤二，写CMakeLists.txt（名字严格区分大小写）
#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文件
- 目录下就生成了这些文件-CMakeFiles, CMakeCache.txt, cmake_install.cmake 等文件，并且生成了Makefile.
- 最关键的是，它自动生成了Makefile.
cmake .
输出：
[root@localhost cmake]# cmake .
CMake Warning (dev) in CMakeLists.txt:
Syntax Warning in cmake code at
/root/cmake/CMakeLists.txt:7:37
Argument not separated from preceding token by whitespace.
This warning is for project developers. Use -Wno-dev to suppress it.
-- The C compiler identification is GNU 10.2.1
-- The CXX compiler identification is GNU 10.2.1
-- 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
-- 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
-- This is BINARY dir /root/cmake
-- This is SOURCE dir /root/cmake
-- Configuring done
-- Generating done
-- Build files have been written to: /root/cmake
使用make命令编译
root@localhost cmake]# make
Scanning dependencies of target hello
[100%] Building CXX object CMakeFiles/hello.dir/main.cpp.o
Linking CXX executable hello
[100%] Built target hello
最终生成了Hello的可执行程序
3.Cmkae之HelloWorld语法介绍
PROJECT关键字
- 可以用来指定工程的名字和支持的语言，默认支持所有语言
PROJECT (HELLO) 指定了工程的名字，并且支持所有语言—建议
PROJECT (HELLO CXX) 指定了工程的名字，并且支持语言是C++
PROJECT (HELLO C CXX) 指定了工程的名字，并且支持语言是C和C++
PROJECT (HELLO JAVA)支持JAVA
<projectname>_BINARY_DIR，本例中是 HELLO_BINARY_DIR
<projectname>_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，产生错误，生成过程被跳过。
- STATUS，输出前缀为--的信息。
- FATAL_ERROR，立即终止所有 cmake 过程.
ADD_EXECUTABLE关键字
ADD_EXECUTABLE(hello ${SRC_LIST}) 生成的可执行文件名是hello，源文件读取变量SRC_LIST中的内容
也可以直接写 ADD_EXECUTABLE(hello main.cpp)
上述例子可以简化的写成
PROJECT(HELLO)
ADD_EXECUTABLE(hello main.cpp)
注意：工程名的 HELLO 和生成的可执行文件 hello 是没有任何关系的语法的基本原则
- 变量使用${}方式取值，但是在 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(hello main) 后缀可以不写，但是他会自动去找.c和.cpp，最好不要这样写，可能会有这两个文件main.cpp和main
4.Cmake之内部构件和外部构建
- 上述例子就是内部构建，他生产的临时文件特别多，不方便清理
- 外部构建，就会把生成的临时文件放在build目录下，不会对源文件有任何影响强烈使用外部构建方式
- 外部构建eg：
[root@localhost cmake]# pwd
/root/cmake
[root@localhost cmake]# ll
total 8
-rw-r--r--. 1 root root 198 Dec 28 20:59 CMakeLists.txt
-rw-r--r--. 1 root root 76 Dec 28 00:18 main.cpp
1、建立一个build目录，可以在任何地方，建议在当前目录下
2、进入build，运行cmake .. 当然..表示上一级目录，你可以写CMakeLists.txt所在的绝对路径，生产的文件都在build目录下了
3、在build目录下，运行make来构建工程
注意外部构建的两个变量
1、HELLO_SOURCE_DIR 还是工程路径
2、HELLO_BINARY_DIR 编译路径也就是 /root/cmake/bulid
5.让Hello World看起来更像一个工程
操作如下
- 为工程添加一个子目录 src，用来放置工程源代码
- 添加一个子目录 doc，用来放置这个工程的文档 hello.txt
- 在工程目录添加文本文件 COPYRIGHT, README
- 在工程目录添加一个 runhello.sh 脚本，用来调用 hello 二进制
- 将构建后的目标文件放入构建目录的 bin 子目录
- 将 doc 目录 的内容以及 COPYRIGHT/README 安装到/usr/share/doc/cmake/
将目标文件放入构建目录的 bin 子目录
[root@localhost cmake]# tree
.
├── build
├── CMakeLists.txt
└── src
├── CMakeLists.txt
└── main.cpp
PROJECT(HELLO)
ADD_SUBDIRECTORY(src bin)
ADD_SUBDIRECTORY(source_dir [binary_dir] [EXCLUDE_FROM_ALL])
- 这个指令用于向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制存放的位置[binary_dir]，该目录会自动创建
- EXCLUDE_FROM_ALL函数是将写的目录从编译中排除，如程序中的example
- ADD_SUBDIRECTORY(src bin)
将 src 子目录加入工程并指定编译输出(包含编译中间结果)路径为bin目录
如果不进行 bin 目录的指定，那么编译结果(包括中间结果)都将存放在build/src 目录
ADD_EXECUTABLE(hello main.cpp)
更改二进制的保存路径
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下写
6.如何安装HelloWord
安装
- 一种是从代码编译后直接 make install 安装
- 一种是打包时的指定目录安装。
- 简单的可以这样指定目录：make install DESTDIR=/tmp/test
- 稍微复杂一点可以这样指定目录：./configure –prefix=/usr
如何安装HelloWord
- 使用CMAKE一个新的指令：INSTALL
- INSTALL的安装可以包括：二进制、动态库、静态库以及文件、目录、脚本等
// 目录树结构
[root@localhost cmake]# tree
.
├── build
├── CMakeLists.txt
├── COPYRIGHT
├── doc
│ └── hello.txt
├── README
├── runhello.sh
└── src
├── CMakeLists.txt
└── main.cpp
- 使用CMAKE一个新的变量：CMAKE_INSTALL_PREFIX
CMAKE_INSTALL_PREFIX 默认是在 /usr/local/
cmake -DCMAKE_INSTALL_PREFIX=/usr 在cmake的时候指定CMAKE_INSTALL_PREFIX变量的路径
- 安装文件COPYRIGHT和README（最外层Cmake文件）
INSTALL(FILES COPYRIGHT README DESTINATION share/doc/cmake/)
##所以这里会安装到/usr/local/share/doc/cmake/
FILES：文件
DESTINATION：
1、写绝对路径
2、可以写相对路径，相对路径实际路径是：${CMAKE_INSTALL_PREFIX}/<DESTINATION 定义的路径>
PROGRAMS：目标文件的非可执行程序安装(比如脚本之类)
INSTALL(PROGRAMS runhello.sh DESTINATION bin)
说明：实际安装到的是 /usr/local/bin/
方法：
- 方法一、是通过在 doc 目录建立CMakeLists.txt ，通过install下的file
- 方法二、是直接在工程目录通过
INSTALL(DIRECTORY doc/ DESTINATION share/doc/cmake)
DIRECTORY 后面连接的是所在 Source 目录的相对路径
注意：abc 和 abc/有很大的区别
目录名不以/结尾：这个目录将被安装为目标路径下的
目录名以/结尾：将这个目录中的内容安装到目标路径
INSTALL(TARGETS hello DESTINATION bin/)
