linux 函数自动补全,Shell脚本中实现自动补全功能

对于Linuxer来说，自动补全是再熟悉不过的一个功能了。当你在命令行敲下部分的命令时，肯定会本能地按下Tab键补全完整的命令，当然除了命令补全之外，还有文件名补全。

Bash-completion

自动补全这个功能是Bash自带的，但一般我们会安装bash-completion包来得到更好的补全效果，这个包提供了一些现成的命令补全脚本，一些基础的函数方便编写补全脚本，还有一个基本的配置脚本。但也正如之前说的，这个包不是必须的，只不过可以省些力气。

bash-completion这个包的安装位置因不同的发行版会有所区别，但是大致上启用的原理是类似的，一般会有一个名为bash_completion的脚本，这个脚本会在shell初始化时加载。例如对于RHEL系统来说，这个脚本位于/etc/bash_completion，而该脚本会由/etc/profile.d/bash_completion.sh中导入：

# Check for interactive bash and that we haven't already been sourced.

[ -z "$BASH_VERSION" -o -z "$PS1" -o -n "$BASH_COMPLETION" ] && return

# Check for recent enough version of bash.

bash=${BASH_VERSION%.*}; bmajor=${bash%.*}; bminor=${bash#*.}

if [ $bmajor -gt ] || [ $bmajor -eq -a $bminor -ge ]; then

if shopt -q progcomp && [ -r /etc/bash_completion ]; then

# Source completion code.

. /etc/bash_completion

fi

fi

unset bash bmajor bminor

而在bash_completion脚本中会加载/etc/bash_completion.d下面的补全脚本：

if [[ $BASH_COMPLETION_DIR != $BASH_COMPLETION_COMPAT_DIR && \

-d $BASH_COMPLETION_DIR && -r $BASH_COMPLETION_DIR && \

-x $BASH_COMPLETION_DIR ]]; then

for i in $(LC_ALL=C command ls "$BASH_COMPLETION_DIR"); do

i=$BASH_COMPLETION_DIR/$i

[[ ${i##*/} != @(*~|*.bak|*.swp|\#*\#|*.dpkg*|*.rpm@(orig|new|save)|Makefile*) \

&& -f $i && -r $i ]] && . "$i"

done

fi

unset i

补全脚本的名称一般就是命令名，这样比较容易查找：

$ ls i*

iconv iftop ifupdown info iproute2 iptables

内置补全命令

Bash内置有两个补全命令，分别是compgen和complete。compgen命令根据不同的参数，生成匹配单词的候选补全列表，例如：

$ compgen -W 'hi hello how world' h

hi

hello

how

compgen最常用的选项是-W，通过-W参数指定空格分隔的单词列表。h即我们在命令行当前键入的单词，执行完后会输出候选的匹配列表，这里是以h开头的所有单词。

complete命令的参数有点类似compgen，不过它的作用是说明命令如何进行补全，例如同样使用-W参数指定候选的单词列表：

$ complete -W 'word1 word2 word3 hello' foo

$ foo w

$ foo word

word1 word2 word3

我们还可以通过-F参数指定一个补全函数：

$ complete -F _foo foo

现在键入foo命令后，会调用_foo函数来生成补全的列表，完成补全的功能，这一点正是补全脚本实现的关键所在，我们会在后面介绍。

补全相关的内置变量

除了上面的两个补全命令外，Bash还有几个内置的变量用来辅助补全功能，这里主要介绍其中三个：

COMP_WORDS: 类型为数组，存放当前命令行中输入的所有单词；

COMP_CWORD: 类型为整数，当前光标下输入的单词位于COMP_WORDS数组中的索引；

COMPREPLY: 类型为数组，候选的补全结果；

COMP_WORDBREAKS: 类型为字符串，表示单词之间的分隔符；

COMP_LINE: 类型为字符串，表示当前的命令行输入；

例如我们定义这样一个补全函数_foo：

$ function _foo()

{

echo -e "\n"

declare -p COMP_WORDS

declare -p COMP_CWORD

declare -p COMP_LINE

declare -p COMP_WORDBREAKS

}

$ complete -F _foo foo

假设我们在命令行下输入以下内容，再按下Tab键补全：

$ foo b

declare -a COMP_WORDS='([0]="foo" [1]="b")'

declare -- COMP_CWORD=""

declare -- COMP_LINE="foo b"

declare -- COMP_WORDBREAKS="

对着上面的结果，我想应该比较容易理解这几个变量。当然正如我们之前据说，Bash-completion包并非是必须的，补全功能是Bash自带的。

编写脚本

补全脚本分成两个部分：编写一个补全函数和使用complete命令应用补全函数。后者的难度几乎忽略不计，重点在如何写好补全函数。难点在，似乎网上很少与此相关的文档，但是事实上，Bash-completion自带的补全脚本是最好的起点，可以挑几个简单的改改基本上就可以使用了。

一般补全函数(假设这里依然为_foo)都会定义以下两个变量：

local cur prev

其中cur表示当前光标下的单词，而prev则对应上一个单词：

cur="${COMP_WORDS[COMP_CWORD]}"

prev="${COMP_WORDS[COMP_CWORD-1]}"

初始化相应的变量后，我们需要定义补全行为，即输入什么的情况下补全什么内容，例如当输入-开头的选项的时候，我们将所有的选项作为候选的补全结果：

local opts="-h --help -f --file -o --output"

if [[ ${cur} == -* ]] ; then

COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )

return

fi

不过再给COMPREPLY赋值之前，最好将它重置清空，避免被其它补全函数干扰。

现在完整的补全函数是这样的：

function _foo() {

local cur prev opts

COMPREPLY=()

cur="${COMP_WORDS[COMP_CWORD]}"

prev="${COMP_WORDS[COMP_CWORD-1]}"

opts="-h --help -f --file -o --output"

if [[ ${cur} == -* ]] ; then

COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )

return

fi

}

现在在命令行下就可以对foo命令进行参数补全了：

$ complete -F _foo foo

$ foo -

-f --file -h --help -o --output

当然，似乎我们这里的例子没有用到prev变量。用好prev变量可以让补全的结果更加完整，例如当输入--file之后，我们希望补全特殊的文件(假设以.sh结尾的文件)：

case "${prev}" in

-f|--file)

COMPREPLY=( $(compgen -o filenames -W "`ls *.sh`" -- ${cur}) )

;;

esac

现在再执行foo命令，--file参数的值也可以补全了：

$ foo --file

a.sh b.sh c.sh

安装补全脚本

如果安装了Bash-completion包，可以将补全脚本放在/etc/bash_completion.d目录下，或者放到~/.bash_completion文件中。

如果没有安装Bash-completion包，可以把补全脚本放到~/.bashrc或者其它能被shell加载的初始化文件中。

在自己的base脚本中实现自动补全

在90年代Linux和DOS共存的年代里,Linux的Shell们有一个最微不足道但也最实用的小功能,就是命令自动补全.而DOS那个笨蛋一直到死都没学会什么叫易用. Linux的这个微不足道的小传统一 ...

purcell的emacs配置中的自动补全功能开启

标记一下,原文参看purcell的emacs配置中的自动补全功能开启 修改init-auto-complete.el文件 ;;(setq-default ac-expand-on-auto-compl ...

vue中实现中，自动补全功能

知识点:利用vue的基本语法实现,自动补全功能 参考博客:https://www.jb51.net/article/136282.htm 效果:在文本框中,输入相关名称,调用后台接口,将数据填充到下拉 ...

学会了vim中的自动补全功能

好开心,再也不用再多个工具之间切换了,哈哈 擦,功能太弱

Python3设置在shell脚本中自动补全功能的方法

本篇博客将会简短的介绍,如何在ubuntu中设置python自动补全功能. 需求:由于python中的内建函数较多,我们在百纳乘时,可能记不清函数的名字,同时自动补全功能,加快了我们开发的效率. 方法 ...

shell自动补全功能：bash和zsh

首要一点:shell有多种,比如bash.zsh.csh.ksh.sh.tcsh等 因此,制作自动补全功能时,要先搞清楚,你使用的是哪种shell,各个shell制作方法是不同的,网上大部分介绍的是关 ...

Xcode6中Swift没有智能提示和自动补全功能

今天在学习Swift的过程中,编写代码,发现没有智能提示和自动补全功能,一阵不适应,在网上溜达了下,找到了解决办法,测试可行 中文系统新建工程,copyright里有日期,2014年,“年”..然后删 ...

emacs: 文本输入中文件目录自动补全

emacs: 文本输入中文件目录自动补全 // */ // ]]> UP | HOME   emacs: 文本输入中文件目录自动补全 Table of Contents 1 引言 2 补全过程演 ...

如何为 .NET Core CLI 启用 TAB 自动补全功能

如何为 .NET Core CLI 启用 TAB 自动补全功能 Intro 在 Linux 下经常可以发现有些目录/文件名,以及有些工具可以命令输入几个字母之后按 TAB 自动补全,最近发现其实 do ...

随机推荐

第1章 (ASP.NET MVC简介)

一.MVC概念 MVC由三部分组成:视图(View).模型(Model).控制器(Controller)组成 二.运用VS创建MVC 1.新建一个"解决方案" 2.在"解 ...

分享我的开源项目-springmore

之前有在博客园分享过springmore,不知道是什么原因,被管理员移除首页 在此郑重声明,这是我个人的开源项目,东西不多,也不存在打广告,也没有什么利益可图 完全是出于分享的目的,望博客园管理员予以 ...

Grunt一辈子的好基友：yeoman

yeoman是什么 yeoman主要包含了三个工具:yo.grunt.bower.我们先看下这三个工具分别是做什么的: yo:脚手架工具,主要作用是创建项目骨架(跟grunt-init有点像). gr ...

饮水思源——python中常用基础类源码解析

1.bool类 2.int类 3.long类 4.float类 5.str类 6.list类 7.tuple类 8.dict类 9.collections类 Counter类:为hashable对象计 ...

linux 修改时间 - [命令操作]

我们一般使用“date -s”命令来修改系统时间.比如将系统时间设定成1996年6月10日的命令如下. #date -s 06/10/96 将系统时间设定成下午1点12分0秒的命令如下. #date ...

[设计模式] 23 访问者模式 visitor Pattern

在GOF的一书中对访问者模式是这样说的:表示一个作用于某对象结构中的各元素的操作.它使你可以在不改变各元素的类的前提下定义作用于这些元素的新操作.访问 ...

数学概念——H 最美素数

H - 数论,晒素数 Time Limit:1000MS     Memory Limit:32768KB     64bit IO Format:%I64d & %I64u Submit S ...

Ｗeb Application的目录结构

Java web工程下的webapp或WebContent就是工程的发布文件夹,发布时会把该文件夹发布到tomcat的webapps里. 一个web应用必须要有的目录文件如下: webapp/WebC ...

浏览器url传参中文时得到null的解决方法

在写一个中文参数需求的时候遇到了以下问题,经过半天的测试和各种编码,以及网上一些有用没用的资料尝试终于解决    比如下面的url地址:http://travel.widget.baike.com:8 ...

Android实战之ListView复选框

项目中有用到复选框的例子,啊啊......在网上查找有关资料,大多都是过于繁琐,所以自己决定写个这个方面的demo... 先给个效果图: 在ListView中添加复选框主要注意以下几个问题: 1.Li ...