CMake和vscode文件配置

博主： Solost
发布时间：2023 年 11 月 16 日
215 次浏览
暂无评论
5895字数
分类： Cmake vscode

### 第一讲：GCC编译器

#### 1.1 编译过程

##### 预处理-Pre-Processing	//.i文件

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

##### 编译-Compiling	// .s文件

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

##### 汇编-Assembling	// .o文件

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

##### 链接-Linking	// bin文件

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

#### 1.2 g++重要编译参数

##### g 编译带调试信息的可执行文件

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

##### -O[n] 优化源代码

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

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

~~~bash
# -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
~~~

##### I 指定头文件搜索目录

~~~bash
# -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
~~~

##### Wall 打印警告信息

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

##### w 关闭警告信息

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

##### std=c++11 设置编译标准

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

##### o 指定输出文件名

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

##### D定义宏

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

示例代码：

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

注：使用 `man gcc`命令可以查看gcc英文使用手册，见下图

#### 1.3 【实战】g++`命令行编译`

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

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

#### 1.3.1 直接编译

最简单的编译，并运行

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

增加参数编译，并运行

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

#### 1.3.2 生成库文件并编译

链接静态库生成可执行文件①：

~~~bash
## 进入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
~~~

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

~~~bash
## 进入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
~~~

编译完成后的目录结构
最终目录结构：2 directories, 8 files

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

#### 1.3.3 运行可执行文件

运行可执行文件①
Plain Text

~~~bash
# 运行可执行文件 
./staticmain
~~~

运行可执行文件②

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

### 第二讲：GDB调试器

前言：

- **GDB(GNU Debugger)**是一个用来**调试C/C++程序**的功能强大的**调试器**，是Linux系统开发C/C++最常用的调试器
- 程序员可以**使用GDB来跟踪程序中的错误**，从而减少程序员的工作量。
- Linux 开发C/C++ 一定要熟悉 GDB
- **VSCode是通过调用GDB调试器来实现C/C++的调试工作的；**

> Windows 系统中，常见的集成开发环境（IDE），如 VS、VC等，它们内部已经嵌套了相应的调试器

**GDB主要功能：**

- 设置断点(断点可以是条件表达式)
- 使程序在指定的代码行上暂停执行，便于观察
- 单不执行程序，便于调试
- 查看程序中变量值的变化
- 动态改变程序的执行环境
- 分析崩溃程序产生的core文件

#### 2.1 常用调试命令参数

调试开始：执行gdb [exefilename] ，进入gdb调试程序，其中exefilename为要调试的可执行文件名

~~~bash
## 以下命令后括号内为命令的简化使用，比如run（r），直接输入命令 r 就代表命令run

$(gdb)help(h)	# 查看命令帮助，具体命令查询在gdb中输入help + 命令

$(gdb)run(r)	# 重新开始运行文件（run-text：加载文本文件，run-bin：加载二进制文件）

$(gdb)start		# 单步执行，运行程序，停在第一行执行语句

$(gdb)list(l) 	# 查看原代码（list-n,从第n行开始查看代码。list+ 函数名：查看具体函数）

$(gdb)set		# 设置变量的值

$(gdb)next(n)   # 单步调试（逐过程，函数直接执行）

$(gdb)step(s)	# 单步调试（逐语句：跳入自定义函数内部执行）

$(gdb)backtrace(bt)	# 查看函数的调用的栈帧和层级关系

$(gdb)frame(f) 	# 切换函数的栈帧

$(gdb)info(i) 	# 查看函数内部局部变量的数值

$(gdb)finish	# 结束当前函数，返回到函数调用点

$(gdb)continue(c)	# 继续运行

$(gdb)print(p)	# 打印值及地址

$(gdb)quit(q) 	# 退出gdb
~~~

~~~bash
$(gdb)break+num(b)			# 在第num行设置断点

$(gdb)info breakpoints		# 查看当前设置的所有断点

$(gdb)delete breakpoints num(d)	# 删除第num个断点

$(gdb)display				# 追踪查看具体变量值

$(gdb)undisplay				# 取消追踪观察变量

$(gdb)watch					# 被设置观察点的变量发生修改时，打印显示

$(gdb)i watch				# 显示观察点

$(gdb)enable breakpoints	# 启用断点

$(gdb)disable breakpoints	# 禁用断点

$(gdb)x						# 查看内存x/20xw 显示20个单元，16进制，4字节每单元

$(gdb)run argv[1] argv[2]	# 调试时命令行传参

$(gdb)set follow-fork-mode child#Makefile项目管理：选择跟踪父子进程（fork()）
~~~

> Tips:
>
> 1. 编译程序时需要加上-g，之后才能用gdb进行调试：gcc -g main.c -o main
> 2. 回车键：重复上一命令

#### 2.2 【实战】命令行调试

给出一段简单代码，准备调试。
C++

~~~C++
#include <iostream>
using namespace std;

int main(int argc,char **argv)
{
    int N = 100;
    int sum = 0;
    int i = 1;

// calculate sum from 1 to 100
    while (i <= N)
    {
        sum = sum + i;
        i = i + 1;
    }

cout << "sum = " << sum << endl;
    cout << "The program is over."   << endl;

return 0;
}
~~~

### 第三讲：CMake

前言：

- CMake是一个跨平台的安装编译工具，可以用简单的语句来描述所有平台的安装(编译过程)。
- CMake可以说已经成为大部分C++开源项目标配

#### 3.1 语法特性介绍

- 基本语法格式：指令(参数 1 参数 2...)

- 参数使用括弧括起
  - 参数之间使用空格或分号分开
- 指令是大小写无关的，参数和变量是大小写相关的

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

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

#### 3.2 重要指令和CMake常用变量

#### 3.2.1 重要指令

- cmake_minimum_required 指定CMake的最小版本要求
  - 语法： cmake_minimum_required(VERSION versionNumber [FATAL_ERROR])

~~~Makefile
# CMake最小版本要求为2.8.3 cmake_minimum_required(VERSION 2.8.3)
~~~

- project 定义工程名称，并可指定工程支持的语言
  - 语法： project(projectname [CXX] [C] [Java])

~~~Makefile
# 指定工程名为HELLOWORLD project(HELLOWORLD)
~~~

- set 显式的定义变量
  - 语法：set(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])

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

- include_directories 向工程添加多个特定的头文件搜索路径 --->相当于指定g++编译器的-I参数
  - 语法： include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)

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

- link_directories 向工程添加多个特定的库文件搜索路径 --->相当于指定g++编译器的-L参数
  - 语法： link_directories(dir1 dir2 ...)

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

- add_library 生成库文件
  - 语法： add_library(libname [SHARED|STATIC|MODULE] [EXCLUDE_FROM_ALL] source1 source2 ... sourceN)

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

- add_compile_options 添加编译参数
  - 语法：add_compile_options(<option> ...)

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

- add_executable 生成可执行文件
  - 语法：add_executable(exename source1 source2 ... sourceN)

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

- target_link_libraries 为 target 添加需要链接的共享库 -->相同于指定g++编译器-l参数
  - 语法： target_link_libraries(target library1<debug | optimized> library2...)

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

- add_subdirectory 向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制存放的位置
  - 语法： add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

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

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

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

#### 3.2.2 CMake常用变量

- CMAKE_C_FLAGS gcc编译选项
- CMAKE_CXX_FLAGS g++编译选项

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

- CMAKE_BUILD_TYPE 编译类型(Debug, Release)

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

- CMAKE_BINARY_DIR

```
```

**PROJECT_BINARY_DIR**

```
```

<projectname>_BINARY_DIR

> 这三个变量指代的内容是一致的。如果是 in source build，指的就是工程顶层目录。如果是 out-of-source 编译,指的是工程编译发生的目录。PROJECT_BINARY_DIR 跟其他指令稍有区别，不过现在，你可以理解为他们是一致的。

- CMAKE_SOURCE_DIR
- PROJECT_SOURCE_DIR<projectname>_SOURCE_DIR
- 这三个变量指代的内容是一致的,不论采用何种编译方式,都是工程顶层目录。也就是在 in source build时,他跟 CMAKE_BINARY_DIR 等变量一致。PROJECT_SOURCE_DIR 跟其他指令稍有区别,现在,你可以理解为他们是一致的。
- CMAKE_C_COMPILER：指定C编译器
- CMAKE_CXX_COMPILER：指定C++编译器
- EXECUTABLE_OUTPUT_PATH：可执行文件输出的存放路径
- LIBRARY_OUTPUT_PATH：库文件输出的存放路径

#### 3.3 CMake编译工程

CMake目录结构：项目主目录存在一个CMakeLists.txt文件
两种方式设置编译规则：

1. 包含源文件的子文件夹包含CMakeLists.txt文件，主目录的CMakeLists.txt通过add_subdirectory添加子目录即可；
2. 包含源文件的子文件夹未包含CMakeLists.txt文件，子目录编译规则体现在主目录的CMakeLists.txt中；

#### 3.3.1 编译流程

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

- 手动编写 CMakeLists.txt。
- 执行命令 cmake PATH生成 Makefile ( PATH 是顶层CMakeLists.txt 所在的目录 )。
- 执行命令make 进行编译。

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

#### 3.3.2 两种构建方式

- 内部构建(in-source build)：不推荐使用

内部构建会在同级目录下产生一大堆中间文件，这些中间文件并不是我们最终所需要的，和工程源文件放在一起会显得杂乱无章。

~~~bash
## 内部构建 # 在当前目录下，编译本目录的CMakeLists.txt，生成Makefile和其他文件 cmake . # 执行make命令，生成target make
~~~

- 外部构建(out-of-source build)：推荐使用

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

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

#### 3.4 【实战】CMake代码实践

针对第五章写的两个小项目来写对应的CMakeLists.txt

#### 3.4.1 最小CMake工程

~~~bash
# 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)
~~~

#### 3.4.2 多目录工程 - 直接编译

~~~shell
# 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})
~~~

#### 3.4.3 多目录工程 - 生成库编译

~~~Shell
# 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 )
~~~

### 第四讲：tasks和launch文件编写

~~~json
//launch.json
{
    // 使用 IntelliSense 了解相关属性。 
    // 悬停以查看现有属性的描述。
    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "(gdb) 启动",
            "type": "cppdbg",
            "request": "launch",
            "program": "${workspaceFolder}/build/kilo",//启动路径
            "args": [],
            "stopAtEntry": false,
            "cwd": "${fileDirname}",
            "environment": [],
            "externalConsole": false,
            "MIMode": "gdb",
            "setupCommands": [
                {
                    "description": "为 gdb 启用整齐打印",
                    "text": "-enable-pretty-printing",
                    "ignoreFailures": true
                },
                {
                    "description": "将反汇编风格设置为 Intel",
                    "text": "-gdb-set disassembly-flavor intel",
                    "ignoreFailures": true
                }
            ],
            "preLaunchTask": "cppbuild",//执行launch之前先执行tasks的某个任务
        }

]
}
~~~

~~~json
//tasks.json
{
    "options": {
        "cwd": "${workspaceFolder}/build"//工作路径
    },
    "tasks": [
        {
            "type": "shell",
            "label": "cmake",//任务一先执行cmake
            "command": "cmake",
            "args": [
                ".."//相当于cmake ..
            ]
        },
        {
            "label": "make",//任务二make
            "group": {
                "kind": "build",
                "isDefault": true
            },
            "command": "make",
            "args": [
            
            ]
        },
        {
            "type": "cppbuild",//任务三执行
            "label": "C/C++: gcc 生成活动文件",
            "dependsOrder": "sequence",//按照任务顺序执行
            "dependsOn":[
                "cmake",
                "make"
            ],
            "command": "/usr/bin/gcc",
            "args": [
                "-fdiagnostics-color=always",
                "-g",
                "${file}",
                "-o",
                "${fileDirname}/${fileBasenameNoExtension}"
            ],
            "options": {
                "cwd": "${fileDirname}"
            },
            "problemMatcher": [
                "$gcc"
            ],
            "group": {
                "kind": "build",
                "isDefault": true
            },
            "detail": "调试器生成的任务。"
        }
    ],
    "version": "2.0.0"
}
~~~

~~~

最后修改：2023 年 11 月 16 日

如果觉得我的文章对你有用，请随意赞赏

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

评论 *

私密评论

名称 *

🎲

邮箱 *

地址

CMake和vscode文件配置

Solost • 2023 年 11 月 16 日