现在是 2018 年,vim 8 已经发布了 2 年,并附带了所有平均流 Linux 发行版和 Mac OS X。但是很多 vim 教程仍然在教人们十年前的东西。
您可以使用 Vim 8 或 NeoVim 的一些专用插件在 vim 中编译您的 C++/Java 程序,就像 Sublime Text 或 NotePad++ 一样方便。
例如,AsyncRun插件将允许您在后台运行 shell 命令并实时读取 quickfix 窗口的输出。
请参阅屏幕截图。
就像在 IDE 中编译程序一样,编译错误将通过 errorformat 匹配并突出显示并成为可选的。您可以在快速修复窗口中导航错误或在编译时继续编辑。
快速设置
将以下行复制并粘贴到您的 vimrc 中:
Plug 'skywind3000/asyncrun.vim'
" open quickfix window automatically when AsyncRun is executed
" set the quickfix window 6 lines height.
let g:asyncrun_open = 6
" ring the bell to notify you job finished
let g:asyncrun_bell = 1
" F10 to toggle quickfix window
nnoremap <F10> :call asyncrun#quickfix_toggle(6)<cr>
在命令行中输入“:AsyncRun echo hello”时:
在此处查看捕获
您将在打开的 quickfix 窗口中看到实时命令输出。
编译并运行单个文件
使用 AsyncRun 编译单个文件比 Sublime Text 的构建系统要简单得多。我们可以为此设置 F9:
noremap <silent> <F9> :AsyncRun gcc -Wall -O2 "$(VIM_FILEPATH)" -o "$(VIM_FILEDIR)/$(VIM_FILENOEXT)" <cr>
表单中的宏$(..)
将扩展为真实的文件名或目录,然后我们将有 F5 运行可执行文件:
noremap <silent> <F5> :AsyncRun -raw -cwd=$(VIM_FILEDIR) "$(VIM_FILEDIR)/$(VIM_FILENOEXT)" <cr>
双引号用于处理包含空格的路径名。该选项-cwd=$(VIM_FILEDIR)
表示在文件目录中运行文件。使用绝对路径名$(VIM_FILEDIR)/$(VIM_FILENOEXT)
是因为 linux 需要./
前缀才能在当前目录中运行可执行文件,但 windows 不需要 . 使用二进制文件的绝对路径名可以处理这个跨平台问题。
另一个选项-raw
意味着输出将不会被 vim 的错误格式匹配,并且会在 quickfix 中显示为原来的样子。现在您可以使用 F9 编译文件,在 quickfix 窗口中检查编译错误,然后按 F5 运行二进制文件。
构建 C/C++ 项目
无论您使用什么构建工具,make 或 cmake,项目构建都意味着对一组文件进行操作。它需要找到项目根目录。AsyncRun 使用一种称为根标记的简单方法来识别项目根。项目根被标识为当前文件的最近的祖先目录,其中包含以下目录或文件之一:
let g:asyncrun_rootmarks = ['.svn', '.git', '.root', '_darcs']
如果没有父目录包含这些根标记,则将当前文件的目录用作项目根目录。这使我们能够使用<root>
或$(VIM_ROOT)
代表项目根。并且可以设置 F7 来构建当前项目:
noremap <silent> <F7> :AsyncRun -cwd=<root> make <cr>
如果您当前的项目不在任何 git 或 subversion 存储库中怎么办?如何找出我的项目根目录在哪里?解决方法很简单,只要在你的项目根目录下放一个空的 .root 文件,就可以轻松定位。
让我们继续,设置 F8 来运行当前项目:
noremap <silent> <F8> :AsyncRun -cwd=<root> -raw make run <cr>
该项目将在其根目录中运行。当然,您需要在自己的 makefile 中定义运行规则。然后重新映射 F6 进行测试:
noremap <silent> <F6> :AsyncRun -cwd=<root> -raw make test <cr>
如果您使用的是 cmake,则可以映射 F4 来更新您的 Makefile:
nnoremap <silent> <F4> :AsyncRun -cwd=<root> cmake . <cr>
由于c运行时的实现,如果进程运行的是非tty环境,stdout中的所有数据都会被缓冲,直到进程退出。因此,如果要查看实时输出,必须fflush(stdout)
在语句之后。printf
或者您可以在开始时关闭标准输出缓冲区
setbuf(stdout, NULL);
同时,如果您正在编写 C++ 代码,可以将 std::endl 附加到 std::cout 的末尾。它可以强制刷新标准输出缓冲区。如果你是在 windows 上开发,AsyncRun 可以为子进程打开一个新的 cmd 窗口:
nnoremap <silent> <F5> :AsyncRun -cwd=$(VIM_FILEDIR) -mode=4 "$(VIM_FILEDIR)/$(VIM_FILENOEXT)" <cr>
nnoremap <silent> <F8> :AsyncRun -cwd=<root> -mode=4 make run <cr>
在 windows 上使用该选项-mode=4
将打开一个新的提示窗口来运行命令,就像在 Visual Studio 中运行命令行程序一样。最后,我们在下面有这些键映射:
- F4:使用 cmake 更新 Makefile。
- F5:运行单个文件
- F6:运行项目测试
- F7:构建项目
- F8:运行项目
- F9:编译单个文件
- F10:切换快速修复窗口
它更像是 NotePad++ 和 GEdit 中的构建系统。如果您大量使用 cmake,您可以编写一个简单的 shell 脚本~/.vim/script/build.sh
,将 F4 和 F7 组合在一起:如果 CMakeList.txt 已更改,它将更新 Makefile,然后执行 make。
高级用法
您还可以在 dotfiles 存储库中定义 shell 脚本并使用 F3 执行脚本:
nnoremap <F3> :AsyncRun -cwd=<root> sh /path/to/your/dotfiles/script/build_advanced.sh <cr>
AsyncRun 定义了以下 shell 环境变量:
$VIM_FILEPATH - File name of current buffer with full path
$VIM_FILENAME - File name of current buffer without path
$VIM_FILEDIR - Full path of current buffer without the file name
$VIM_FILEEXT - File extension of current buffer
$VIM_FILENOEXT - File name of current buffer without path and extension
$VIM_CWD - Current directory
$VIM_RELDIR - File path relativize to current directory
$VIM_RELNAME - File name relativize to current directory
$VIM_ROOT - Project root directory
$VIM_CWORD - Current word under cursor
$VIM_CFILE - Current filename under cursor
$VIM_GUI - Is running under gui ?
$VIM_VERSION - Value of v:version
$VIM_COLUMNS - How many columns in vim's screen
$VIM_LINES - How many lines in vim's screen
$VIM_SVRNAME - Value of v:servername for +clientserver usage
以上所有环境变量都可以在您的build_advanced.sh
. 使用外部 shell 脚本文件可以完成比单个命令更复杂的工作。
grep 符号
有时,如果您的远程 linux 机器中没有良好的设置环境,则 grep 是在源中搜索符号定义和引用的最便宜的方法。现在我们将有 F2 在光标下搜索关键字:
if has('win32') || has('win64')
noremap <F2> :AsyncRun! -cwd=<root> grep -n -s -R <C-R><C-W> --include='*.h' --include='*.c*' '<root>' <cr>
else
noremap <F2> :AsyncRun! -cwd=<root> findstr /n /s /C:"<C-R><C-W>" "\%CD\%\*.h" "\%CD\%\*.c*" <cr>
endif
上面的脚本将在您的项目根目录中运行 grep 或 findstr,并仅在.c
,.cpp
和.h
文件中查找符号。现在我们移动光标并按 F2,当前项目中的符号引用将立即显示在 quickfix 窗口中。
这个简单的键盘映射在大多数情况下就足够了。您可以改进此脚本以在您的 vimrc 中支持更多文件类型或其他 grep 工具。
这是在 Vim 8 或 NeoVim 中构建/运行 C/C++ 项目的实用方法。就像 Sublime Text 的构建系统和 NotePad++ 的 NppExec。
不再有过时的 vim 教程,尝试一些新的东西。