C++笔记三（CMake）

CMake是一个跨平台的安装编译工具，可以用简单的语句来描述所有平台的安装(编译过程)。
在B站学习了Cmake，以此记录一下
https://www.bilibili.com/video/BV1fy4y1b7TC/?spm_id_from=333.999.0.0&vd_source=f7b062fc20f2b2fd7bbb4db80a72c84e

一、CMake安装

• 安装cmake

# 通过以下命令安装编译器和调试器
sudo apt install cmake

• 安装成功确认

# 确认是否安装成功
# 如果成功，则显示版本号
cmake --version

二、GCC编译器

• VSCode是通过调用GCC编译器来实现C/C++的编译工作的
• 使用gcc指令编译C代码
• 使用g++指令编译C++代码

2.1. 编译过程

1. 预处理（Pre-Processing）——>.i文件

# -E 选项指示编译器仅对输入文件进行预处理
g++  -E test.cpp  -o test.i   //.i文件

2.编译（Compiling）——>.s文件

# -S 编译选项告诉 g++ 在为 C++ 代码产生了汇编语言文件后停止编译
# g++ 产生的汇编语言文件的缺省扩展名是 .s 
g++  -S test.i  -o   test.s

3.汇编（Assembling）——>.o文件

# -c 选项告诉 g++ 仅把源代码编译为机器语言的目标代码
# 缺省时 g++ 建立的目标代码文件有一个 .o 的扩展名。
g++  -c test.s  -o test.o

4.连接（Linking）——>bin文件

# -o 编译选项来为将产生的可执行文件用指定的文件名
g++ test.o  -o test

3.2 g++重要编译参数

1. -g 编译带调试信息的可执行文件

# -g 选项告诉 GCC 产生能被 GNU 调试器GDB使用的调试信息，以调试程序。
# 产生带调试信息的可执行文件test
g++ -g test.cpp

2. -O[n] 优化源代码

## 所谓优化，例如省略掉代码中从未使用过的变量、直接将常量表达式用结果值代替等等，这些操作
会缩减目标文件所包含的代码量，提高最终生成的可执行文件的运行效率。
# -O 选项告诉 g++ 对源代码进行基本优化。这些优化在大多数情况下都会使程序执行的更快。 -O2 
选项告诉 g++ 产生尽可能小和尽可能快的代码。 如-O2，-O3，-On（n 常为0–3）
# -O 同时减小代码的长度和执行时间，其效果等价于-O1
# -O0 表示不做优化
# -O1 为默认优化
# -O2 除了完成-O1的优化之外，还进行一些额外的调整工作，如指令调整等。
# -O3 则包括循环展开和其他一些与处理特性相关的优化工作。
# 选项将使编译的速度比使用 -O 时慢， 但通常产生的代码执行速度会更快。
# 使用 -O2优化源代码，并输出可执行文件
g++ -O2 test.cpp

3. -l 和 -L 指定库文件 | 指定库文件路径

# -l参数(小写)就是用来指定程序要链接的库，-l参数紧接着就是库名
# 在/lib和/usr/lib和/usr/local/lib里的库直接用-l参数就能链接
# 链接glog库 g++ -lglog test.cpp
# 如果库文件没放在上面三个目录里，需要使用-L参数(大写)指定库文件所在目录
# -L参数跟着的是库文件所在的目录名
# 链接mytest库，libmytest.so在/home/bing/mytestlibfolder目录下
g++ -L/home/bing/mytestlibfolder -lmytest test.cpp

4. -I 指定头文件搜索目录

# -I 
# /usr/include目录一般是不用指定的，gcc知道去那里找，但 是如果头文件不在/usr/icnclude
里我们就要用-I参数指定了，比如头文件放在/myinclude目录里，那编译命令行就要加上-
I/myinclude 参数了，如果不加你会得到一个”xxxx.h: No such file or directory”的错
误。-I参数可以用相对路径，比如头文件在当前 目录，可以用-I.来指定。上面我们提到的–cflags参
数就是用来生成-I参数的。
g++ -I/myinclude test.cpp

5. -Wall 打印警告信息

# 打印出gcc提供的警告信息
g++ -Wall test.cpp

6. -w 关闭警告信息

# 关闭所有警告信息
g++ -w test.cpp

7. -std=c++11 设置编译标准

# 使用 c++11 标准编译 test.cpp
g++ -std=c++11 test.cpp

8. -o 指定输出文件名

# 指定即将产生的文件名
# 指定输出可执行文件名为test
g++ test.cpp -o test

9. -D 定义宏

# 在使用gcc/g++编译的时候定义宏
# 常用场景：
# -DDEBUG 定义DEBUG宏，可能文件中有DEBUG宏部分的相关信息，用个DDEBUG来选择开启或关闭
DEBUG

示例代码：

// -Dname 定义宏name,默认定义内容为字符串“1”
#include <stdio.h>
int main()
{
    #ifdef DEBUG
   printf("DEBUG LOG\n");
    #endif
   printf("in\n");
}
// 1. 在编译的时候，使用gcc -DDEBUG main.cpp
// 2. 第七行代码可以被执行

3.3 【实战】 g++命令行编译

# 最初目录结构
.
├── include
│   └── Swap.h
├── main.cpp
└── src
   └── Swap.cpp
    
2 directories, 3 files

1. 直接编译

• 最简单编译并运行

# 将 main.cpp src/Swap.cpp编译为可执行文件
g++ main.cpp src/Swap.cpp -Iinclude
# 运行a.cout
./a.out

• 增加参数编译，并运行

# 将 main.cpp src/Swap.cpp 编译为可执行文件 附带一堆参数
g++ main.cpp src/Swap.cpp -Iinclude -std=c++11 -O2 -Wall -o b.out
# 运行 b.out
./b.out

2. 生成库文件并编译

• 链接静态库生成可执行文件并运行：

## 进入src目录下
$cd src

# 汇编，生成Swap.o文件
g++ Swap.cpp -c -I../Include -o Swap.o
# 生成静态库libSwap.a
ar rs libSwap.a Swap.o

## 回到上级目录
$cd ..

# 链接，生成可执行文件：staticmain
g++ main.cpp -Iinclude -Lsrc -lSwap -o staticmain

# 运行可执行文件
./staticmain

• 链接动态库生成可执行文件并运行：

## 进入src目录下
$cd src

# 生成动态库libSwap.so
g++ Swap.cpp -I../include -fPIC -shared -o libSwap.so
## 上面命令相当于以下两条命令
# gcc Swap.cpp -I../include -c -fPIC
# gcc -shared -o libSwap.so Swap.o

## 回到上级目录
$cd ..

# 链接，生成可执行文件：sharemain
g++ main.cpp -Iinclude -Lsrc -lSwap -o sharemain

# 运行可执行文件
LD_LIBRARY_PATH=src ./sharemain

四、CMake

4.1 语法特性

• 基本语法特性：指令(参数1 参数2…)
  参数使用括弧括起
  参数之间使用空格或者分号隔开
• 指令是大小写无关的，参数和变量是大小写相关的

set(HELLO hello.cpp)
add_executable(hello main.cpp hello.cpp)
ADD_EXECUTABLE(hello main.cpp hello.cpp)

• 变量使用${}方式取值，但在 IF 控制语句中是直接使用变量名

4.2 CMake重要指令

1. cmake_minimum_required - 指定CMake的最小版本要求

语法：cmake_minimum_required(VERSION versionNumber[FATAL_ERROR])

# cmake 最小版本要求2.10.0
cmake_minimum_required(VERSION 2.10.0)

2. project - 定义工程名称，并可指定工程支持的语言

语法：project(projectname [CXX] [C] []Java)

# 定义工程名称为HELLOWORLD
project(HELLOWORLD)

3. set - 显示的定义变量

语法：set(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])

# 定义SRC变量，其值为sayhello.cpp hello.cpp
set(SRC sayhello.cpp hello.cpp)

4. include_directories - 向工程添加多个特定的头文件搜索路径 —>相当于指定g++编译器的-I参数

语法：include_directories([AFTER | BEFORE] [SYSTEM] dir1 dir2 …)

# 将/usr/include/myincludefolder 和 ./include 添加到头文件搜索路径
include_directories(/usr/include/myincludefolder ./include)

5. link_directories - 向工程添加多个特定的库文件搜索路径 —>相当于指定g++编译器的-L参数

语法：link_directories(dir1 dir2 …)

# 将/usr/lib/mylibfolder 和 ./lib 添加到库文件搜索路径
link_directories(/usr/lib/mylibfolder ./lib)

6. add_library - 生成库文件

语法：add_library(libname [SHARED|STATIC|MODULE] [EXCLUDE_FROM_ALL] source1 source2 …)

# 通过变量SRC生成libhello.so共享库
add_library(hello SHARED ${SRC})

7. add_compile_options - 添加编译参数

# 添加编译参数 -Wall -std=c++11 -o2
add_compare_options(-Wall -std=c++11 -o2)

8. add_executable - 生成可执行文件

语法：add_executable(exename source1 source2 …)

# 编译main.cpp生成可执行文件main
add_executable(main main.cpp)

9. target_link_libraries - 为target添加需要链接的共享库 —>相同于指定g++编译器-l参数

语法：target_link_libraries(target library1<debug | optimized> library2…)

# 将hello动态库文件链接到可执行文件main
target_link_libraries(main hello)

10. add_subdirectory - 向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制存放的位置

语法： add_subdirectory(source_dir [binary_dir][EXCLUDE_FROM_ALL])

# 添加src子目录，src中需有一个CMakeLists.txt
add_subdirectory(src)

11. aux_source_directory - 发现一个目录下所有的源代码文件并将列表存储在一个变量中，这个指令临时被用来自动构建源文件列表

语法：aux_source_directory(dir VARIABLE)

# 定义SRC变量，其值为当前目录下所有的源代码文件
aux_source_directory(. SRC)
# 编译SRC变量所代表的源代码文件，生成main可执行文件
add_executable(main ${SRC})

4.3 CMake常用变量

1. CMAKE_C_FLAGS - gcc编译选项

2. CMAKE_CXX_FLAGS - g++编译选项

# 在CMAKE_CXX_FLAGS编译选项后追加-std=c++11
set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")

3. CMAKE_BUILD_TYPE - 编译类型(Debug, Release)

# 设定编译类型为debug，调试时需要选择debug
set(CMAKE_BUILD_TYPE Debug)
# 设定编译类型为release，发布时需要选择release
set(CMAKE_BUILD_TYPE Release)

4.4 CMake编译工程

CMake目录结构：项目主目录存在一个CMakeLists.txt文件

两种方式设置编译规则：

1. 内部构建(in-source build)：包含源文件的子文件夹包含CMakeLists.txt，主目录的CMakeLists.txt通过add_subdirectory添加子目录即可
2. 外部构建(out-source build)：包含源文件的子文件夹未包含CmakeLists.txt，主目录编译规则体现在主目录的CMakeLists.txt中（推荐使用）

4.4.1 编译流程

在linux平台下使用CMake构建C/C++工程的流程如下：

• 手动编写CMakeLists.txt
• 执行命令cmake PATH生成Makefile（PATH是顶层CMakeLists.txt所在的目录）
• 执行命令make进行编译

# important tips
. # 表示当前目录
./ # 表示当前目录
.. # 表示上级目录
../ # 表示上级目录

4.4.2 外部构建方式

将编译输出文件与源文件放在不同目录中

# 1. 在当前目录下，创建build文件夹
mkdir build 
# 2. 进入到build文件夹
cd build
# 3. 编译上级目录的CMakeLists.txt，生成Makefile和其他文件
cmake ..
# 4. 执行make命令，生成target
make

4.5 【实战】CMake代码实践

4.5.1 最小CMake工程

# Set the minimum version of CMake that can be used
cmake_minimum_required(VERSION 3.0)
# Set the project name
project (HELLO)
# Add an executable
add_executable(hello_cmake main.cpp)

4.5.2 多目录工程 - 直接编译

# Set the minimum version of CMake that can be used
cmake_minimum_required(VERSION 3.0)
#project name
project(SWAP)
#head file pat
include_directories( include )
  
#source directory files to var
add_subdirectory( src DIR_SRCS )
  
#add executable file  
add_executable(swap_02 ${TEST_MATH})
  
#add link library
target_link_libraries(${FS_BUILD_BINARY_PREFIX}sqrt ${LIBRARIES})

4.5.3 多目录工程 - 生成库编译

# Set the minimum version of CMake that can be used
cmake_minimum_required(VERSION 3.0)
#project name  
project(SWAP_LIBRARY)
#add compile options
add_compile_options("-Wall -std=c++11")
#set CMAKE_BUILD_TYPE
set( CMAKE_BUILD_TYPE Debug )
# set output binary path  
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
############################################################
# Create a library
############################################################
#Generate the static library from the library sources
add_library( swap_library STATIC src/Swap.cpp )
target_include_directories( swap_lib PUBLIC ${PROJECT_SOURCE_DIR}/include )
############################################################
# Create an executable
############################################################
# Add an executable with the above sources
add_executable( swap_01 main.cpp )
# link the new swap_01 target with the swap_lib target
target_link_libraries( swap_01 swap_liby )