かんな/emacs の input method 化

まず使い方。話はそれからだ！

事情を説明すると前置きが長くなりすぎるので、まずは使い方から。

1. このサイトのEmacs ページにあるように、 Canna for GNU Emacs 29 のパッチと 私の独自パッチを当 てる。
2. isearch-ext.el, canna.el を消去する。
3. loadup.el, subr.el に対する変更を、元に戻す （.orig ファイルを元のファイル名に復帰する） ※ emacs.c に対する変更も、もはや syms_of_canna の追加だけで十分ですが、そこはお好みで。
4. Emacs をコンパイル、インストールする。
5. canna-im.el.bz2（ver 2.4; 11722 bytes）の圧縮を解き、Emacs の load path 内のどこかに置く。
6. .emacs などで、(load "canna") や (require 'canna) となっていた所を、(load "canna-im") や (require 'canna-im) と直す。（※ 「(canna)」の所はそのままにする）

以上でいいはずです。新たに Emacs を起動すれば、これまでと同様に日本語 入力ができるでしょう。問題があればお知らせください。

isearch 中の日本語入力は、C-o ではなく C-\ でで きるようになっています。

変更履歴

1. [2020, 11/10] lexical binding を有効 にしてみた。

2. [2020, 8/25] emacs 27 になって、 set-minibuffer-message の働きで、ミニバッファで入力中 に一覧を表示するとき、一覧が未確定部の前に割り込んでくるようになっ た。かんなの入力中は従来通りの動作になるように、一時的に set-message-function を nil にした。

3. [2018, 7/4] isearch で input method を使うと（input method がオンの状態で isearch を呼び出した場 合も含む）、その後は minibuffer での入力中ではモード文字列が minibuffer の先頭に出なくなっていたのを修正。isearch の動作をちゃんと理解していま せんでした。

4. [2018, 7/4] marker の扱いを多少修正。

   • marker の insertion type は固定なので、毎度指定するのではな く作った時点で一度だけ指定するようにした。
   • region 再変換用の使い捨て marker を、必要なくなったらどこも指 さないようにした。そうしなくてもたぶん garbage collection の際 に消去されるんだと思うけど、gc が起きるまではバッファに残って 無駄に編集速度を低下させるので。

5. [2015, 6/3] かんな終了時にかんな側から出る warning を、これまで は完全に無視してしまっていた（coding miss で、拾うつもりの処理が書かれ ていながら実際には拾い損ねていた）のを修正。なお、 独自パッチで canna-finalize が返す値の形式を修正したの に合わせてあるので、そちらと合わせて更新しないと正しく動作しません。

6. [2015, 5/19] ウインドウの右下で入力していて、未確定文字列がウイ ンドウをはみ出したときに表示位置が調整されなくなってしまっていたのを修 正しました。

7. [2015, 5/16] 未確定文字列の表示は、バッファへ実際に文字列を挿入 するのではなく「見かけ上表示されるだけ」（overlay の before-string プロ パティを使用）にしました。なので、変換結果を確定するまではバッファの modified status は変更されません。また、未確定文字列の色等の装飾表示が、そのバッファの font lock の影響を受けずに済むようになりました。

   一方この結果、canna-with-fences を nil にして使ってい る場合、文字端末上でバッファの末尾で入力している場合に限り、カー ソル位置が本来未確定文字列の最後に来るはずの場面で、未確定文字列の 先頭に来てしまいます。恐らく emacs のバグによるものです。なる べく canna-with-fences は t のままで使ってください（どう しても気になる、という方がいらした場合は、お知らせ頂けたら emacs 開 発サイドに修正リクエストのバグレポートを書くかもしれません…）。

   ミニバッファへの候補一覧表示の仕方も text property を使うやり方 に合わせたので、見た目が従来と若干変わります。これまでは一覧表示の 文字反転装飾部にほんとのカーソルを置いていたので表示が濃かったので すが、変更後はカーソルが置かれなくなったのでグラフィック端末上では ちょっと色が薄くなったように見えます。

8. [2015, 5/16] 日本語モードで C-h c などの入力待ちに日 本語を入力しようとする際にちょくちょくエラーが起きていたのを修正しました。

9. [2015, 5/16] 変換結果確定を続けて何 回か行った後で通常の undo を行うと、直前の確定結果だけでなくそれ以 前の確定結果まで巻き込まれてしまっていたのを修正しました。

10. [2015, 5/16] emacs 24.4 での overriding-terminal-local-map の仕様変更のため、フェンスモー ドで、マウスによってメニューバー・ツールバーの項目を選択した時に動作が おかしくなることがあったのを修正しました。

    なお、フェンスモード中にかんなの日本語入力以外の操作を行うことは 元々想定していません。マウスで別のフレームを選択したりするとやはり 動作がおかしくなることが十分考えられます。この辺りはあんまりきちん と例外処理を拾うようには作っていないので、そのつもりでお使いくださ い（やはり、「何とかしてくれ」というリクエストがあれば直そうとする かもしれません…）。

11. [2015, 5/16] coding style をちょびっとだけ修正。 user-error を使うのがふさわしそうな場面では使い、また論理 的否定の意味で null を使っていた所は not に置 き換え、等。

12. input method 関数の本来の動作により合わせて、確定文字列は関数の返り 値として返して、バッファ内への挿入は emacs の側に任せました。これに より、overwrite mode ではちゃんと上書きが行われるようになります （auto fill も、emacs の側に任せられるようになりました）。

    また、あらかじめ日本語モードにしておけば、C-h c や C-h k に対して、漢字（やひらがななど）を入力することも可 能です。（文字が確定するまでの間は、minibuffer でカーソルが入力待ちしてるのに、未確定文字列が元のバッファ上に表示 されてしまってかなり珍妙な具合にはなりますが。また、表示され るメッセージには「translated from <return> …」みたいな余分な 部分がついてしまいますが、気にしないことにします）

    確定文字列の挿入は全部 emacs の側に任せた結果、 self-insert-after-hook や input-method-after-insert-chunk-hook もサポートしなくな りました（そういう特別扱いは不要になりました）。

13. カラー関連の設定を canna.el 独自のものから、emacs 標準 のものにしました。

    emacs 23 から、multi terminal 機能が導入されて、 １つの emacs session が X window 上と tty 上の両方で同時に動作でき るようになりました。このため、これまでの canna(-im).el では、先に X window の frame を開いてから tty の frame も開くような 場合、tty 用に調整した色が使われません（その逆も真）。また、「カラー が使えるかどうか」を始めとした端末（画面）の機能を emacs 起動時 に判定することは不可能になり、特に「起動は emacs --deamon で行い、以下の利用は常に emacsclient を通 じて行う」という使い方をする場合、起動時には一律「 カラーが使えない文字端末上」と判定されてしまうため、そのまま ではかんなでカラーグラフィック frame 用の色 が使えなくなっていました。

    canna-im.el バージョン 2 では、そういった問題点に対 処しました。カラー利用をデフォルトとし、使っている端末に応じてその 場で適切なカラーが選ばれるようにしてあります。

    なお、この変更によって、以下のような影響が出ていますので、該当す る方は注意してください。

    • 従来の canna-use-color による色指定はできなくなりま した。自分で色を指定したい場合は、M-x customize-face でかんな用 face canna-yomi, canna-henkan, canna-select をカスタマイズしてください。
    • 変数 canna-background-mode は廃止されていますので、 暗背景色モードを強制したい場合も上の face のカスタマイズで対処をお 願いします。
    • 変数 canna-use-color, canna-underline の 位置づけが従来と若干異なります。利用者がこれらの変数を設定した 時の振る舞いは以下のようになります（face をカスタマイズしてい ないとき）。
      1. canna-use-color が non-nil のとき（デフォルトで t になりました）で、かつカラーが可能な環境ではカラーを使う。 その場合、canna-underline は無視される。
      2. 前項に該当しない場合、canna-underline が non-nil で、かつ underline や highlight が利用可能ならそ れらを使う。（canna-underline のデフォルトは nil のまま）
      3. 前前項・前項に該当しない場合は、何も文字修飾は行われない。
      4. それぞれの機能が利用可能かどうかは、そのときの terminal に応じてその場で判断される。
      なお、これらの変数の値を .emacs などで変更する場 合は、(canna) を 実行canna-im.el をロードする前 に行ってください。後から変更してもそれは反映され ないようになっています。
    • 関数 canna-set-fence-mode-format の第 3 引数は、 文字修飾を行うかどうかを指定するように変更。

後者のカラー化に関する変更の結果、以前と動作が変わった点として、 「白黒の文字端末上でデフォルトの設定で使う場合、文節区切りのスペースが入 らないようになってしまったため、複数の文節を含む部分を変換している最中 は、着目文節がどこまで続いているのかわからなくなってしまっている」という 点があります。このような場合は、 canna-underline を t にして下線や反転で区別がつ くようになることを期待するか、関数 canna-set-bunsetsu-kugiri か canna-set-fence-mode-format によって文節区切りをオンにする 設定を入れるようにしてください。

バージョン 2 では主要な機能部分を完全に書き換えたので、動作に不具合が 発生するかもしれません。なので、旧バージョ ンもしばらくは残しておきます。

以下、バージョン 1 時代に書いた文章ですが、だいたいそのまま当てはまる ので残しておきます。

[2013, 3/24] 今回の変更点は以下の通りです。

1. C-SPC などで mark を打ったとき、日本語モードなら再変換 領域の設定も行っていました （canna-use-space-key-as-henkan-region が nil でないとき）が、C-u C-SPC などで pop-buffer 系のコマンドが実行されていた場合はその動作は適切ではない と思われるため、その場合は再変換領域を設定しないようにしました。
2. emacs 23 の時に入れていた、「minibuffer なしの frame で入力してい て、候補一覧が他の minibuffer のみの frame に表示された状態で C-g を入力するとエラーになってしまう」という問題への対策 は削除しました。emacs 24 になっていよいよその場当たり的な対処ではエ ラーになるようになってしまった上に、そのような環境ではかんなとは無 関係にそもそも emacs がまともに使えない（minibuffer への普通の入力 待ちの時に、minibuffer のみのframe のタイトルバーをクリックしてから C-g をタイプすると、quit がかかった後にポイントが minibuffer のみの frame に取り残されてしまい、以下まともな操作が困 難になる）ので、ここでだけ対処を入れても無意味だからです。

[2013, 3/16] isearch で日本語を検索したい 場合、従来の isearch-ext.el を使ったやり方と違って、isearch 中に C-\ をタイプすることで普通に日本語入力が可能です （C-o ではダメ）。このこともあって、 日本語モードの切り替えキーは、 .canna で C-\ に変更しておくのがお勧めです。

※ [2012, 9/30] これま でのバージョンでは、set-mark-command で再変換用のリージョンをセットするの に after advice を使っていたのですが、C-\ による日本語モード の on/off の度に advice を enable/disable する（他の input method への影 響をなるべく小さくする目的で）というやり方をとっていたため、buffer A で 日本語モードを off にすると、日本語モードが on のままの buffer B でまで advice が無効化されてしまうという問題がありました（考えてみれば当たり前 だった…）。

あとまあ、C-\ の度に set-mark-command の advice が強制的に activate されてしまうので、何らかの理由で非活性のままで保持しておきたい、 という人がもしいた場合、その人にとっては困る動作になっていました。

なので、advice を使うのはやめて、おとなしく、広瀬さんが canna.el でな さっていた方法に倣うことにしました。canna-set-mark-command 関数で this-command を上書きし、global-map で set-mark-command を canna-set-mark-command に remap します（ですので、複 数の input method を並行して使い分ける人では、他の input method も set-mark-command を乗っ取るタイプの動作だった場合、競合が起きることが考 えられます。ご注意ください）。

お題目

現在、Emacs 29 にはかんなで入力するための パッチが 公開されており、canna.el による日本語入力が可能になって います。さて、これも含め、従来の canna.el による日本語入力 には、以下のような問題点があります。

1. minor mode map（古いバージョンでは、local map） として実現されてい るので、他の minor mode map とキー定義が競合する可能性があります （emacs lisp では、複数の minor mode map の間の優先順位は決まってい ません）。また、keymap property がバッファ文字列や overlay に付与 されていた場合は、そちらが優先されてしまいます。 canna.el は、日本語入力途中のキー入力は全部かんなに渡 ることを前提とした作りになっているため、それが破れると動作に不具合 が出たり、最悪の場合はキーボードからの Emacs の操作がまったくでき なくなったりする可能性があります。
2. global map で、通常の ASCII 文字のキーに対応するコマンドを、すべて self-insert-command から canna-self-insert-command に置き換えているのですが、 これが他の elisp に不具合をもたらすことがあり、それらに対して個別 に修正が必要となります。実際、 Canna for GNU Emacs 27 のパッチでは subr.el や picture.el で、 canna-self-insert-command を特別扱いした処理を必要と しています。また、他の elisp library、例えば AUCTeX などにも 同様の特殊処理が盛り込まれているのが観察できます。 しかし、このような self-insert-command 系の置き換えは、 emacs lisp reference で

   In general ... the facilities for customizing `self-insert-command' are limited to special cases (designed for abbrevs and Auto Fill mode). (Do not try substituting your own definition of `self-insert-command' for the standard one. The editor command loop handles this function specially.

   と戒められています。また、他にも同様の置き換えを行う elisp が現れた場合、 いちいち個別の扱いを追加する手間がその都度増えていきます。

(2) の問題点に対しては、global map に手を加える代わりに minor mode map でやりくりする手もありそうですが、そうしたとしても (1) の問題点に制 約を受けることは変わりありません。Emacs 23 になって、いくつかの minor mode map 間での優先順位をきめ細かく分けるための emulation-mode-map-alists や minor-mode-overriding-map-alist といった変数が導入されまし たが、それらを利用したとしても、結局それらを利用する他の elisp との競合 は避けられず、keymap property に対して無力であることも変わらないのです。

この問題に対する答は最初からわかっていて、それは「かんなを input method 化する」ことです。input method というのは、非 ASCII 文字 を入力するための手段として Emacs 20（21 だったか？）から用意されたもので、 元々 minor mode map や keymap propery よりも高い優先順位で動作するように 設計されています。かんな/emacs のような枠組みは、本来 input method とし て動作するべきなのです。それで、上記のような問題は解消します。

そればかりか、input method は Emacs の標準機能なので、isearch も問題 なく動作するようになります。現状の canna.el は、そのままで は isearch 中に日本語入力ができないので、 Canna for GNU Emacs 29 では isearch-ext.el というパッケー ジを丸ごと付加して、それを Emacs に preload するということまでしていたの ですが、そういうことがまったく不要になるのです。

そこで、私は canna.el を改造して、input method として動 作するようにしてみました。それが、既に上でも登場し た canna-im.el です。試作品で すが、個人的にはもう何年も使ってきており、私の使用法では大きな問題は起こっ ていません。

input method 化に加えて、elisp coding convention に合わせた体裁の調整 も加えてあります。普通に使う分には、.emacs などへの調整はご く一部ですむはずですが、いくつか注意を述べます。

• boiled canna の機能は省いてあります。.canna での設定に よってはどうやっても実現不可能なので、とりあえず外しました。要望が 大きければ取り入れようとするかもしれません。
• かんなの、日本語モード切り替えキー（デフォルトでは C-o） には togge-input-method が割り当てられます。つまり、 標準では、C-o と C-\ の両方が toggle-input-method を引き起こすキーになります。個人 的なおすすめは、.canna で、日本語モードの切り替えキー を C-\ にして C-o への割り当てを解除しておく こと。そうすれば、C-o は Emacs 標準のキー割り当て （open-line）のままで、C-\ で日本語モード をオン・オフするようになります。
• minibuffer で日本語入力をする場合、日本語モード文字列の表示は、 canna.el と違って、普通の buffer の mode line 左端に 「m」付きで minibuffer のモード文字列を表示する状態にはなりません。 minibuffer の先頭にモード文字列が付加される状態一択です。
• canna-undo-hook をお使いの方は、できれば変数名 を canna-undo-after-function に変更してください。「hook」 という名前でありながら、実際の使われ方は hook ではないからです。
• ファンクションキー F1, F2, F3 の機能がどうしても必要でなければ、 canna-do-keybind-for-functionkeys は nil にして使うのが お勧めです。現在の Emacs は、これらに本来別機能を持たせているので。
• canna.el では、かんなの undo は Emacs の undo と一体化 させて、同じキーバインドで使うことが想定されているのですが、私は以前ど こかで見かけた記事（確か田岡さんの記事）で、その２つを分離すること の意義に気づかされ、今では「かんなの undo」はそれ単独で行う関数を 作って、それを（元記事通り）C-x SPC にバインドして使っ ています（[2015, 5/12] C-x SPC は emacs 24.4 で rectangle-mark-mode にバインドされるよう になったので、canna-do-undo は現在は C-c C-SPC に バイ ンドして使っています。今思いましたが、C-x C-/ とかの方 が関連性があっていいかもしれませんね…？）。canna-im.el では、 canna-do-undo という関数がそれです。なので私は、 C-x u や C-/, C-_ のキーバインド はいじらず、Emacs の undo のままにしてあります。
• canna-im.el は、お好みで byte compile してください。
• カスタマイズ用変数の一部は defcustom 化してあり、 M-x customize-option によって custom library によるカス タマイズが可能になっています。

既知の問題点

• 日本語モードで C-h c や C-h k をした場合、日本語入力の方が優先され、期待した動 作になりません。 [2013, 3/29] バージョン 2 で可能になりました。
• 日本語モードで、 C-u や M-1 などで数引数をつけた状態にしておく と、それに続く入力では日本語入力が優先されます。さらに、日本 語を確定させたときの echo area での key echo 表示がおかしくなり、 かつ数引数のついた状態での入力待ちが継続されます。 [2013, 3/29] バージョン 2 で、数 引数は確定文字列の最初の１文字に対してはたらくようになりました。た だし、日本語を確定させたときの echo area での key echo 表示がおかし くなるのはそのままです。（quail.el でもそうなので、ど うなるのが正しいのかよくわからないこともあって、放置してあります） [2015, 5/12] いつの間にか、emacs の動作が少し変わっていたらしく、現状では日本語モードであっても数引 数が付いている状態では日本語入力が優先されず、普通に数引数つきで入 力をおこなったのと同じ入力になります（つまり、日本語モードで C-u a と入力すると単に a が 4 文字入力される）。
• minibuffer での入力中に、input method のモード文字列を自前 で minibuffer 内に表示するような mode では、モード文字列の表示がダ ブって見苦しくなります。isearch についてだけは ad hoc な対応を入れておいたのでそういう問題は生じませんが、他に同様 の mode があった場合はそのままです。すっきりした解決は難しそう。
• frame を複数表示してあるとき、フェンスモードにあるときに別の frame のバッファをマウスでクリックしてキー入力すると、元のバッファへの入 力になってしまいます。さらに、そのとき C-g を行うと何だ か変なことになって、フェンスが残ったまま確定してしまいます。
• かんなの動作は .canna で一元的に管理するというのがかん なの考え方なので、elisp での以下の変数の設定は無視されます。
  • input-method-exit-on-first-char
  • input-method-exit-on-invalid-key
  • input-method-highlight-flag
  • input-method-verbose-flag
  • input-method-use-echo-area
• describe-current-input-method-function に対応する機能は 未実装です。
• カスタマイズ変数のうち、かんな初期化時にしか使われないものは defcustom してありません。custom library でカスタマイ ズした値は、普通は .emacs の最後にしか記録され ないからです。逆に言えば、defcustom しても、次のいずれ かの方法なら問題ありません。
  1. 一度かんなが起動した後、手で M-x canna-reset を実 行する。
  2. .emacs などの中で、「(canna)」の実 行を、custom-set-variables より遅らせる。
  3. .emacs などの中で「(canna)」を実行 するのはやめ、常に Emacs 起動後に手で M-x canna を実行する。
• emacs lisp reference の指示のうち、以下の指示には反してしまっていま す。
  1. advice は使うな Redefining or advising an Emacs primitive is a bad idea. It may do the right thing for a particular program, but there is no telling what other programs might break as a result. canna.el と同様 に、this-command の上書きを利用して global map で set-mark-command を canna-set-mark-command に書き換える手もありますが、他 の input method との共存を考えた場合、かんなのみが特権的にそのよう な書き換えを行うことにためらいを覚えたため、「まだ advice の方がい いだろう」と思ってそうしてあります。
  2. ESC 単独で終わる key sequence を使うな Don't bind a key sequence ending in <ESC> except following another <ESC>. (That is, it is OK to bind a sequence ending in `<ESC> <ESC>'.) The reason for this rule is that a non-prefix binding for <ESC> in any context prevents recognition of escape sequences as function keys in that context. .canna では、 ESC 単独で終わるキーにも機能を定義可能なので、 canna-mode-map では ESC も拾うようにせざるを 得ませんでした。ただ、これだと文字端末上でのファンクションキー（カー ソルキー等も含む）が拾えない、というのはその通りなので、 別ページでも書いたように、文字端末上では canna-mode-map で ESC への定義を nil にしてお くのがよいでしょう。
• overwrite mode に対応していません。 overwrite mode であっても、単純に挿入していくだけです。 [2013, 3/29] バージョン 2 で対応しました。