CMake进行C/C++开发(linux下)

开发环境配置

安装GCC，GDB

sudo apt update
# 通过以下命令安装编译器和调试器
sudo apt install build-essential gdb

• 安装成功确认

# 以下命令确认每个软件是否安装成功
# 如果成功，则显示版本号
gcc --version
g++ --version
gdb --version

CMake安装

# 通过以下命令安装编译器和调试器
sudo apt install cmake
# 确认是否安装成功
# 如果成功，则显示版本号
cmake --version

gcc编译器

预热:

1. GCC 编译器支持编译 Go、Objective-C，Objective-C ++，Fortran，Ada，D 和 BRIG（HSAIL）等程序；
2. VSCode是通过调用GCC编译器来实现C/C++的编译工作的；

• 实际使用中
  • 使用 gcc 指令编译 C 代码
  • 使用 g++指令编译 C++ 代码

编译过程

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

g++重要编译参数

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

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

1. -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

1. -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

1. -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

1. -Wall 打印警告信息

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

1. -w 关闭警告信息

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

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

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

1. -o 指定输出文件名

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

1. -D 定义宏

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

• 实例代码

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

实战: g++命令行编译

• 案例：最初目录结构: 2 directories, 3 files

# 最初目录结构
.
├── 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.out
./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
# 生成静态库libSwap.a
ar rs libSwap.a Swap.o
## 回到上级目录
$cd ..
# 链接，生成可执行文件:staticmain
g++ main.cpp -Iinclude -Lsrc -lSwap -o staticmain
静态库文件通常以.a结尾
二进制文件通常以.o结尾

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

## 进入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
-FPIC与路径无关的选项
-shared生成动态库文件
动态库文件的扩展名.so
-lswap 指定库文件名
-Lsrc 库文件名路径

• 目录结构

# 最终目录结构
.
├── include
│   └── Swap.h
├── main.cpp
├── sharemain
├── src
│   ├── libSwap.a
│   ├── libSwap.so
│   ├── Swap.cpp
│   └── Swap.o
└── staticmain
142 directories, 8 files

运行可执行文件

运行可执行文件①
# 运行可执行文件  --静态库
./staticmain
运行可执行文件② -- 动态库
# 运行可执行文件
LD_LIBRARY_PATH=src ./sharemain

CMake

语法特性介绍

• 基本语法格式： 指令(参数 1 参数 2…)

参数使用括弧括起
参数之间使用空格或分号分开

• 指令是大小写无关的，参数和变量是大小写相关的

set(HELLO hello.cpp)
add_executable(hello main.cpp hello.cpp)
ADD_EXECUTABLE(hello main.cpp ${HELLO})

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

重要指令和CMake常用变量

重要指令

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

# CMake最小版本要求为2.8.3
cmake_minimum_required(VERSION 2.8.3)
语法：cmake_minimum_required(VERSION versionNumber [FATAL_ERROR])

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

# 指定工程名为HELLOWORLD
project(HELLOWORLD)
语法：project(projectname [CXX] [C] [Java])-->[]为可选

• set - 显式的定义变量

# 定义SRC变量，其值为main.cpp hello.cpp
set(SRC sayhello.cpp hello.cpp)
语法：set(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])

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

# 将/usr/include/myincludefolder 和 ./include 添加到头文件搜索路径
include_directories(/usr/include/myincludefolder ./include)
语法：include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 …)

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

# 将/usr/lib/mylibfolder 和 ./lib 添加到库文件搜索路径
link_directories(/usr/lib/mylibfolder ./lib)
语法：link_directories(dir1 dir2 …)

• add_library - 生成库文件

# 通过变量 SRC 生成 libhello.so 共享库
add_library(hello SHARED ${SRC})
语法：add_library(libname [SHARED|STATIC|MODULE] [EXCLUDE_FROM_ALL] source1 source2 … sourceN)

• add_compile_options - 添加编译参数

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

• add_executable - 生成可执行文件

# 编译main.cpp生成可执行文件main
add_executable(main main.cpp)
语法：add_library(exename source1 source2 … sourceN)

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

# 将hello动态库文件链接到可执行文件main
target_link_libraries(main hello)
语法：target_link_libraries(target library1library2…)

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

# 添加src子目录，src中需有一个CMakeLists.txt
add_subdirectory(src)
语法：add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

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

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

两种构建方式

内部构建(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