Bash 自动补全机制详解

2018-12-08 language bash

在 Linux 命令行中，当输入字符后，按两次 Tab 键，Shell 就会列出以这些字符打头的所有可用命令，如果只有一个命令匹配到，按一次 Tab 键就自动将这个命令补全。

比如，如果想更改密码，但只记得这个命令前几个字母是 pa，此时按 Tab 键 Shell 就会自动补全 passwd 命令，非常方便。除了命令补全，还有路径、文件名补全，这个在通过 cd 命令切换到指定目录时特别好用。

这里详细介绍其使用方法。

简介

大部分的终端都提供了自动补全功能，不同的终端略有区别，例如 zsh、bash 等等，这里仅介绍最常用的 bash 提供的补全功能。实际上，补齐功能可以通过脚本指定命令参数如何补全，默认的补全脚本保存在 /etc/bash_completion.d 目录下。

对于 bash 来说，使用的是内置的 complete 命令，用于支撑 tab 键的自动补齐。

----- 查看命令的类型
$ type -a complete
complete is a shell builtin

CentOS 默认会安装一个 bash-completion 包，这里面包含了常用命令的大部分自动补齐脚本，在编写脚本时可以直接参考这个包里的内容。

git 补齐

在使用命令行时，可以很方便的进行补齐操作，如果不好使，可以使用如下方式配置。

以 git 为例，不同的环境保存的路径可能会有些区别，一般来说，会有多个 git-completion.XXXX 文件，其后缀是终端的名称。

可以将如下的命令添加到 ~/.bashrc 文件中，在每次启动终端时自动加载。

if [ -f /etc/bash_completion.d/git-completion.bash ]; then
	. /etc/bash_completion.d/git-completion.bash
fi

简单示例

假设有一个命令 foobar ，接下来为该命令添加自动补齐功能。

# cat /etc/bash_completion.d/foobar.bash
_foobar()
{
	local cur=${COMP_WORDS[COMP_CWORD]}
	COMPREPLY=( $(compgen -W "exec help test" -- $cur) )
}
complete -F _foobar foobar

测试 foobar 命令是否可以自动补全。注意，foobar 命令自身没有自动补全，需要手动输入。

# source /etc/bash_completion.d/foobar.bash
# foobar <Tab><Tab>
exec  help  test

如上，source 命令是为了加载 foobar.bash 使其能在当前会话生效，为了可以自动生效，可以将上述的 source 命令添加到 bashrc 或者 profile 中。

常用命令

在上述的示例中使用到了两个命令 complete 和 compgen ，下面分别介绍这两个命令。

complete

补全命令，这是最核心的命令了，简单看下该命令的常用参数说明，可以通过 help complete 以及 man complete 查看详细帮助，这里简单列举一下常用参数。

-F function	执行 shell 函数，函数中生成COMPREPLY作为候选的补全结果
-C command	将 command 命令的执行结果作为候选的补全 结果
-G pattern	将匹配 pattern的文件名作为候选的补全结果
-W wordlist	分割 wordlist 中的单词，作为候选的补全结果
-p [name]	列出当前所有的补全命令
-r [name]	删除某个补全命令

另外，可以通过 -o 设置一些选项，常用的有。

nospace    默认会自动填充一个空格，用来区分，可以通过该参数关闭
filenames  在补全的时候会具体到文件，而不是目录，对于文件补齐比较有用

示例如下。

# complete -W 'word1 word2 word3 test' foobar
# foobar w<Tab>
# foobar word<Tab>
# complete -p
complete -W 'word1 word2 word3 test' foobar
... ...
# complete -r foobar
# complete -p
... ...

compgen

筛选命令，用来筛选生成匹配单词的候选补全结果，如下是一些简单的示例。

----- 单词匹配
$ compgen -W "hello world" -- h
hello

----- 文件匹配
$ compgen -f -- h
hello.txt

变量

除了上面常用的命令外，Bash 还提供了几个内置变量来辅助补全功能，如下：

  • COMP_WORDS 数组，存放当前命令行中输入的所有单词；
  • COMP_CWORD 整数，当前输入的单词在 COMP_WORDS 中的索引；
  • COMPREPLY 数组，候选的补全结果；
  • COMP_LINE 字符串，当前的命令行输入字符。

通过这些变量，可以在不同的场景下使用。

其它

另外，在库中还提供了一些常用的函数，在 CentOS 中可以通过 rpm -ql bash-completion 命令查看，一般在 /usr/share/bash-completion/bash_completion 文件中定义。

例如，如果想补齐文件路径，有如下的两种方式。

if [[ ${prev} == --*file ]]; then
	COMPREPLY=( $(compgen -f -- ${curr}) )
fi

if [[ ${prev} == --*file ]]; then
	_filedir
fi

上述的 _filedir 就是 bash-completion 提供的，在执行了上述内容之后，可以通过 declare -f _filedir 查看该函数的定义。

示例

多层

在上述的示例中，如果多次输入 <tab> 会导致重复填充一个字符串，如果一个命令包含了多层的子命令，例如 git checkout 后面需要再跟分支等信息，那么可以参考如下示例。

_foobar_completion()
{
	local curr prev

	COMPREPLY=()
	curr=${COMP_WORDS[COMP_CWORD]}
	prev=${COMP_WORDS[COMP_CWORD-1]}

	opts="hi hello"
	if [[ ${COMP_CWORD} -eq 1 ]]; then
		COMPREPLY=( $(compgen -W "${opts}" -- ${curr}) )
	fi

	case "${prev}" in
		"hi")
			COMPREPLY=( $(compgen -W "world foobar" -- ${curr}) )
			;;
		"hello")
			COMPREPLY=( $(compgen -W "ldrow raboof" -- ${curr}) )
			;;
		*)
			;;
	esac
}
complete -F _foobar_completion foobar