VScode(8)之阅读大型CC++工程

VScode(8)之阅读大型CC++工程(Linux内核)代码

Author：Once Day Date：2023年4月25日/2024年3月17日

漫漫长路，有人对你微笑过嘛…

全系列文章请查看专栏: VScode开发_Once-Day的博客-优快云博客

参考文档:

1. 历史包袱

由于上世纪70-80年代的硬件限制，C语言的编译解析是"单遍编译(one pass)"，缺乏现代java，python，go等语言的模块化解析功能，这导致解析语法树需要“走一遍”上下文环境。

简单来说，如果不把include的文件走一遍，解析器无法确定各类符号的确切含义，而对于大型C/C++项目，随便include一个头文件，背后可能就有几千上万行代码，对于解析器来说，负担很大。

对于阅读大型的C/C++项目代码，需要一些辅助手段，下面是针对VScode的配置情况。

2. C和C++插件

vscode需要安装以下插件，以便提供良好的

• C/C++ ，必备插件，。
• c/c++ Extension Pack，扩展包。
• c/C++ GNU Global，支持gtags。
• GitLens，用于查看git commit记录和相关操作。
• GitLab Workflow，用于查看代码MR和review，支持语法查询。

2. GNU Global源码标签数据库

此外Linux服务器需要安装global，这是gnu提供的一个解析代码的工具。生成二进制的数据库，对于大型代码工程非常有帮助。

• GNU Global source code tagging system

下面是官网的介绍，传统上一般和Vim/Emacs等编辑器集成:

GNU Global is a source code tagging system that works the same way across diverse environments, such as Emacs editor, Vi editor, Less viewer, Bash shell, various web browsers, etc.

You can locate various objects, such as functions, macros, structs, classes, in your source files and move there easily. It is useful for hacking on large projects which contain many sub-directories, many #ifdef and many main() functions. It is similar to ctags or etags, but is different from them in the following two points:

• independence of any editor
• capability to treat definition and reference

It runs in UNIX (POSIX) compatible operating system, like GNU and BSD.

对于ubuntu系统，直接apt install global即可。其他linux系统仿照如此即可。

对于内网环境下的linux主机，需要本地编译运行，代码可在官网下载，或者下面的内网目录：

/mnt/sata0/chenguang/global-6.6.9.tar.gz

复制到~家目录解压后，cd源码目录，./configure配置编译，然后make编译，最终make install即可。

使用vscode连接ssh打开服务器上的内核代码文件夹。

设置配置文件(没有就新建)如下.vscode/settings.json:

{
    "C_Cpp.default.intelliSenseMode": "linux-gcc-x64",
    "search.followSymlinks": false,
    "C_Cpp.default.browse.limitSymbolsToIncludedHeaders": true,
}

"search.followSymlinks": false很关键，大型C工程代码有些文件是符号链接文件，可能造成循环引用，这会导致cpptool直接cpu占用拉满。其他配置字段的含义，可以自行百度，网上介绍非常多。

接下来是使用global生成代码解析文件，直接在vscode里面按下F1，然后搜索global：

第一个命令是建立数据库，执行一次即可，如果代码改变，也可以再执行一次。

这个过程会在后台一直运行，大概几分钟，等着就好。如果运行正常，目录下面会出现三个文件：

-rw-r--r--   1 ubuntu ubuntu        17M Jan  5 23:27 GPATH
-rw-r--r--   1 ubuntu ubuntu       534M Jan  5 23:27 GRTAGS
-rw-r--r--   1 ubuntu ubuntu       708M Jan  5 23:27 GTAGS

可以看到，数据是非常大的，然后就可以正常在代码使用跳转等功能了。

一般开源的大型C/C++大型项目，这三个文件已经在.gitignore里面了，所以可以忽略下面的步骤:

1. 可以在.gitignore中添加上面上个三个文件，但是这会对.gitignore造成改动。
2. 在.git/info/exclude中添加上面三个文化，这个是本地仓库屏蔽。

此外也可以使用clangd工具。

• 借助clangd实现VSCode C++代码补全 - 知乎 (zhihu.com)

3. 下面是使用实例截图

GNU Global不能支持变量解析，因此无法跳转变量，这个需要依靠cpp_tools进行解析。

函数跳转：

宏定义跳转：

源文件函数(标识符)列表：

结构体类型定义跳转：