C++后端开发(1.4.1)——Makefile/cmake/configure使用教程
- 1 Cmake
- 1.1 语法特性
- 1.2 cmake重要指令
- 1.3 常用变量
- 1.3.1 gcc编译选项
- 1.3.2 g++编译选项
- 1.3.3 编译类型(Debug, Release)
- 1.3.4 CMAKE_BINARY_DIR 、PROJECT_BINARY_DIR、__BINARY_DIR
- 1.3.5 CMAKE_SOURCE_DIR、PROJECT_SOURCE_DIR、__SOURCE_DIR
- 1.3.6 CMAKE_C_COMPILER:指定C编译器
- 1.3.6 CMAKE_CXX_COMPILER:指定C++编译器
- 1.3.7 EXECUTABLE_OUTPUT_PATH:可执行文件输出的存放路径
- 1.3.8 LIBRARY_OUTPUT_PATH:库文件输出的存放路径
- 1.4 CMake编译工程
小节提纲
Makefile的规则与make的工作原理
单文件编译与多文件编译
Makefile的參数传递
多目录文件央递归编译与嵌套执行make
Makefile的通配符,伪目标,文件搜索
Makefile的操作函数与t特殊语法
configure生成makefile的原则
cmake的写法
1 Cmake
1.1 语法特性
- 基本语法格式:指令(参数 1 参数 2…)
- 参数使用括弧括起
- 参数之间使用空格或分号分开
- 指令是大小写无关的,参数和变量是大小写相关的
set(HELLO hello.cpp)
add_executable(hello main.cpp hello.cpp)
ADD_EXECUTABLE(hello main.cpp ${HELLO})
- 变量使用${}方式取值,但是在 IF 控制语句中是直接使用变量名
1.2 cmake重要指令
1.2.1 指定CMake的最小版本要求
- 语法:cmake_minimum_required(VERSION versionNumber [FATAL_ERROR])
# CMake最小版本要求为2.8.3
cmake_minimum_required(VERSION 2.8.3)
1.2.2 定义工程名称,并可指定工程支持的语言
- 语法:project(projectname [CXX] [C] [Java])
# 指定工程名为HELLOWORLD
project(HELLOWORLD)
1.2.3 显式的定义变量
- 语法:set(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])
# 定义SRC变量,其值为main.cpp hello.cpp
set(SRC sayhello.cpp hello.cpp)
1.2.4 向工程添加多个特定的头文件搜索路径 —>相当于指定g++编译器的-I参数
- 语法:cmake_minimum_required(VERSION versionNumber [FATAL_ERROR])
# 将/usr/include/myincludefolder 和 ./include 添加到头文件搜索路径
include_directories(/usr/include/myincludefolder ./include)
1.2.5 生成库文件
- 语法:add_library(libname [SHARED|STATIC|MODULE] [EXCLUDE_FROM_ALL] source1 source2 … sourceN)
# 通过变量 SRC 生成 libhello.so 共享库
add_library(hello SHARED ${SRC})
1.2.6 添加编译参数
- 语法:add_compile_options
# 添加编译参数 -Wall -std=c++11
add_compile_options(-Wall -std=c++11 -O2)
1.2.7 生成可执行文件
- 语法:add_executable(exename source1 source2 … sourceN)
# 编译main.cpp生成可执行文件main
add_executable(main main.cpp)
1.2.8 为 target 添加需要链接的共享库 —>相同于指定g++编译器-l参数
- 语法:target_link_libraries(target library1library2…)
# 将hello动态库文件链接到可执行文件main
target_link_libraries(main hello)
1.2.9 向当前工程添加存放源文件的子目录,并可以指定中间二进制和目标二进制存放的位置
- 语法:add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])
# 添加src子目录,src中需有一个CMakeLists.txt
add_subdirectory(src)
1.2.10 发现一个目录下所有的源代码文件并将列表存储在一个变量中,这个指令临时被用来自动构建源文件列表
- 语法:aux_source_directory(dir VARIABLE)
# 定义SRC变量,其值为当前目录下所有的源代码文件
aux_source_directory(. SRC)
# 编译SRC变量所代表的源代码文件,生成main可执行文件
add_executable(main ${SRC})
1.3 常用变量
1.3.1 gcc编译选项
1.3.2 g++编译选项
# 在CMAKE_CXX_FLAGS编译选项后追加-std=c++11
set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
1.3.3 编译类型(Debug, Release)
# 设定编译类型为debug,调试时需要选择debug
set(CMAKE_BUILD_TYPE Debug)
# 设定编译类型为release,发布时需要选择release
set(CMAKE_BUILD_TYPE Release)
1.3.4 CMAKE_BINARY_DIR 、PROJECT_BINARY_DIR、__BINARY_DIR
- 这三个变量指代的内容是一致的。
- 如果是 in source build,指的就是工程顶层目录。
- 如果是 out-of-source 编译,指的是工程编译发生的目录。
- PROJECT_BINARY_DIR 跟其他指令稍有区别,不过现在,你可以理解为他们是一致的。
1.3.5 CMAKE_SOURCE_DIR、PROJECT_SOURCE_DIR、__SOURCE_DIR
- 这三个变量指代的内容是一致的,不论采用何种编译方式,都是工程顶层目录。
- 也就是在 in source build时,他跟 CMAKE_BINARY_DIR 等变量一致。
- PROJECT_SOURCE_DIR 跟其他指令稍有区别,现在,你可以理解为他们是一致的。
1.3.6 CMAKE_C_COMPILER:指定C编译器
1.3.6 CMAKE_CXX_COMPILER:指定C++编译器
1.3.7 EXECUTABLE_OUTPUT_PATH:可执行文件输出的存放路径
1.3.8 LIBRARY_OUTPUT_PATH:库文件输出的存放路径
1.4 CMake编译工程
1.4.1 CMake目录结构
项目主目录存在一个CMakeLists.txt文件
两种方式设置编译规则:
- 包含源文件的子文件夹包含CMakeLists.txt文件,主目录的CMakeLists.txt通过add_subdirectory添加子目录即可;
- 包含源文件的子文件夹未包含CMakeLists.txt文件,子目录编译规则体现在主目录的CMakeLists.txt中;
1.4.2 CMake编译流程
在 linux 平台下使用 CMake 构建C/C++工程的流程如下:
- 手动编写 CmakeLists.txt。
- 执行命令 cmakePATH生成 Makefile ( PATH 是顶层CMakeLists.txt 所在的目录 )。
- 执行命令make 进行编译。
1.4.3 两种构建方式
- 内部构建(in-source build):不推荐使用
内部构建会在同级目录下产生一大堆中间文件,这些中间文件并不是我们最终所需要的,和工程源文件放在一起会显得杂乱无章。
## 内部构建
# 在当前目录下,编译本目录的CMakeLists.txt,生成Makefile和其他文件
cmake .
# 执行make命令,生成target
make
- 外部构建(out-of-source build):推荐使用
将编译输出文件与源文件放到不同目录中
## 外部构建
# 1. 在当前目录下,创建build文件夹
mkdir build
# 2. 进入到build文件夹
cd build
# 3. 编译上级目录的CMakeLists.txt,生成Makefile和其他文件
cmake ..
# 4. 执行make命令,生成target
make