📚

fcitx5 で vi エスケープ

に公開

以前 fcitx5-lua を使って vi 協調モードを行うという記事を書いたことがありました。

https://zenn.dev/anyakichi/articles/a3aab8d80994d1

ただ、この記事自体は fcitx5-lua の紹介的な位置づけで、実用上はプレエディットが残っているときに Esc を押すとプレエディットの中身が残ってしまったり、結構イマイチだと思っていました。実際のところ自分自身でもこれは使っておらず、好みの挙動に合わせて fcitx5 にパッチを当てて使っていました。

とはいえパッチ当てるのも面倒くさいなとは以前から思っていて、何かもうちょっと良い方法はないのかと思っていました。

そして今回新しく作ることにしたのがこちら。

https://github.com/anyakichi/fcitx5-vi-escape

普通の C++ の fcitx5 用のアドオンで、Esc と Ctrl-[ をプレエディットが出ていない場合に IME を off にしつつアプリケーションに透過させます。基本的にはそれだけです。

Arch Linux 向けには一応 AUR も作ってあります。以下のような感じでインストールできます。

yay -S fcitx5-vi-escape-git

というわけで以上です。おつかれさまでした。

技術的な話

fcitx5-lua は fcitx5 の PreInputMethod というタイミングでフックをかけて処理を追加できます。PreInputMethod というのは要するに入力が IME に渡される前です。

このタイミングでフックがかかる場合、プレエディット中であれば Esc を奪わないということをしようと思うと、「プレエディット中かどうか」を判定しなければいけません。fcitx5 の API にはそれを判定できる関数もあるので、もしも fcitx5-lua がその判定関数を export していればそれを使うという解決方法はあったと思います。

一方で今回は PostInputMethod という場所でフックをかけています。これは IME が処理を行った後に呼ばれるものです。fcitx5 では内部的に入力を使ったかどうか (accept) と消費して後続には回さないか (filter) というフラグがあるのですが、filter されていれば IME 本体(例えば mozc)が入力を使ったということなので IME は off にせずにそのままとし、filter されていなければ IME は入力をアプリケーションに透過していいと言っているので、ついでに IME も off にしてしまいましょうということです。

この方式であれば、Esc を IME が受け取って入力状態をキャンセルしていき、キャンセルするものがなくなってアプリケーションに透過してもいいとなった時点で IME も off にすればいいということで、本質的にシンプルな話になっていると思います。

Discussion