Zshの補完について 2

以前、 Zshの補完についてちょっと書きましたが、足りない所とか理解しきれてなかった所があるので追記。

Zshの補完について
補完設定ファイルの作成
補間関数がロードされるタイミング

Zshの補完について

取り敢えず前回のはこちら。

Zshの補完について

補完を有効にするために

autoload -U compinit
compinit

を.zshrc等で設定しておくことやcompdef/compadd等の補完を作成、登録するコマンドなどについてまとめています。

上のautoloadはcompinitを有効にさせるためのコマンド。

compinitは指定されたパスにある補完ファイルから補完をアップデートして、~/.zcompdumpというファイルにコマンドとそれに使う補間関数の定義の一覧を作成します。

パスはfpathまたはFPATHで設定されていて、何方も同じパスが入っていますが、 fpathの方は配列、FPATHの方は通常のPATHの様に:で区切られた文字列として登録されています。

何方かをアップデートするともう片方も自動的にアップデートされるので何方かだけをいじればOK。

$ echo $fpath
/usr/local/share/zsh-completions /usr/local/share/zsh/site-functions /usr/local/Cellar/zsh/5.2/share/zsh/functions
$ echo $FPATH
/usr/local/share/zsh-completions:/usr/local/share/zsh/site-functions:/usr/local/Cellar/zsh/5.2/share/zsh/functions
$ fpath=(/new/path "${fpath[@]}")
$ echo $fpath
/new/path /usr/local/share/zsh-completions /usr/local/share/zsh/site-functions /usr/local/Cellar/zsh/5.2/share/zsh/functions
$ echo $FPATH
/new/path:/usr/local/share/zsh-completions:/usr/local/share/zsh/site-functions:/usr/local/Cellar/zsh/5.2/share/zsh/functions

.zcompdumpには以下の様にコマンドと関数が登録されています。

.zcompdump

...
_comps=(
...
'brew' '_brew'
'brew-file' '_brew-file'
...
)
...

コマンドに対して補間関数が定義されていれば、こんな感じで

'<command>' '<completion (initialization) function>'

と言った感じに書かれているはずです。注意なのは下に書くように、この2番めは実際に補完を行う関数だけが書かれたファイルか、または、補完の定義を行う関数(ファイル)でもOK、と言う点。

補完設定ファイルの作成

Homebrewの補助コマンドの Brew-file ではbrew fileコマンドに対する補完や、さらにbrewコマンド自体にも補完に関する強化を行っています。

Brew-fileにコマンド補完を追加

で、普段Bashばかり使っているのであれでしたが、 Zshの方で実はきちんと補完が動いてませんでした。なのでその辺のアップデートがてらの補完に関するメモです。

まず、補完の作り方は Zshの補完についてで大体書いた感じですが、そのファイルの記述で一つ忘れていたのが、ファイルの先頭にShebangの様な形で、

#compdef brew-file

と書いておく必要があります。 #!/bin/zsh等普通のShebangを書いてはダメ ¹。

ここでcompdefの後ろに書いてある物が対象のコマンドになります。

また、使われる関数名は記述されているファイル名になります。このbrew-fileコマンドの場合には

/usr/local/share/zsh/site-functions/_brew-file

というファイルがfpathの中に入っています。

この様なファイルがfpathに入った状態でcompinitすると補完の定義がアップデートされ.zcompdumpが更新されます。

上にも書いたように、この_brew-fileはbrew-fileコマンドを最初に呼んだ時に呼ばれ、補完の方法をロードするために使われます。

実際に、_brew-fileの内容は以下のようになっています²。

homebrew-file/brew-file

この中では_brew_fileという関数を定義して、

compdef _brew_file brew-file

とbrew-fileの補完を定義しています。

なので、実際に補完に使われる関数は_brew_file(真ん中アンダーバー)になり、 _brew-file(真ん中ハイフン)はこのファイルが初回だけ補完の定義用に呼び出される、と言う形になっています。

ファイルの中にcompdef等がない補完ファイルもあり、この場合はそのファイルが補完関数として登録されます。

また、gitの補完ファイルなどは

git/git-completion.zshlink

#compdef git gitk
...
_git ()
{
...
}

_git

みたいな定義になっていて、無限再帰しそうな感じもあるのですが、この場合は関数の_gitが良しなにgitへの補完関数として登録されています。

なので書き方として、#compdef <command>を書いた上で、

中でもcompdefを使い指定のコマンドに特定の関数を補間関数として与える。
補完関数の内容を直接ファイルに書き込み、そのファイル自体を補間関数だとして使う。
ファイル名と同様の関数を書き、それを最後に呼び出すような形で置いておいてその関数を補間関数として使う。

と言った書き方が出来ます。

最後の形式のものだと、最後に関数を呼ぶ際、

_git "$@"

みたいな形で引数を渡す形のものもありましたが、そうで無いものも動いているので、この辺は古い書き方?なのかもしれません。 (昔はファイル内で定義された関数、みたいなのを上手くロードできずにファイルの中身そのものを補完関数として渡していたために直接引数を渡す必要があった?)

man zshcompsysとかを読んでみたもののこの辺イマイチはっきりしなかったんですが、取り敢えず zsh-users/zsh-completions とかにある補完を参考にしていけばやりたいことは出来る様になるかと。

補間関数がロードされるタイミング

一つ大きく勘違いしてたのがこれらの補間関数がロードされるタイミング。

Bashの場合、補完をロードするには単に定義が書いてあるスクリプトをロードするだけです。 Bash-Completion では

source /usr/local/bash_completion

のようにbash_completionという親ファイルを読み込み、この中から/usr/local/bash_completion.d内にある定義ファイルを片っ端から読み込んでいく、と言う形です。

この際、関数などは勿論読み込まれ、completeコマンドによって各コマンドと結び付けられます。

一方、Zshの場合は上に書いたようにcompinitを呼ぶのが通常の補完の有効化です。

この際、起こることはコマンドと各補完初期化ファイル/関数との結びつけだけです。実際にファイルが読み込まれたりはしません。

従って、compinitした後だからといって該当の関数を直接使おうとするとエラーが起こります。

但し、fpathに含まれるファイルは、その名前の関数として、

_brew-file () {
        # undefined
        builtin autoload -XUz
}

みたいな感じで定義されています。 (where _brew-fileまたはautoloadとすると全てのこの様な読み込み前関数を見れます。)

ここで、autoload -Xは、autoloadが実行されるその関数名と同じ名前のファイルをfpath内から探してその内容を関数の内容と置き換える、と言った操作をします ³。

つまり、compinit時には本当に結びつけだけして、この関数を一度呼んで初めて中身が実装されます。

他の-Uオプションはこの関数内でエイリアスを展開しないようにするオプション、 -zはZsh形式で読み込む、と言うオプション。通常はこれですが、-kというksh形式で読み込むオプションもあります。

builtinはautoloadが下手にエイリアスとかされてても元のビルトインコマンドをそのまま使うためのコマンドです。

ここで困ったのが homebrew-file/brew-wrap というbrewコマンドを拡張するファイルの中で、この補完関数を使っている所。

homebrew-fileのwrapper関数を'brew init'等一部コマンドを直接使える様にアップデート

compinitを下あとで、**brew-wrap**を読みこむようにしておいてもこの関数がまだキチンと定義されてないためおかしな挙動をします。

これを回避するために以下の用に.zcompdumpの中の定義を見て、ここにファイルが登録されていれば関数をロードして実行(補完を定義する)、ということをする様にしました。

brew-wrap

# Wrap the brew command completion, to use the completion on `brew file`.
if ! type -a _brew >& /dev/null;then
  return
elif [ "$ZSH_VERSION" = "" ] && ! type -a _brew_file >& /dev/null;then
  return
elif [ "$ZSH_VERSION" != "" ];then
  if ! type -a _brew-file >& /dev/null;then
    return
  fi
  _brew-file
fi