char fold search等が使用できない

[tooro88]

emacs本体の機能として、isearch中に以下のキーを押すと特殊なサーチ機能が使えます。

• M-s ' (isearch-toggle-char-fold) : ウムラウトやアクサンを無視。(「cafe」が「café」にマッチする)
• M-s w (isearch-toggle-word) : 単語全体にマッチ。(「ice」が「rice」にマッチしない)
• M-s _ (isearch-toggle-symbol) : シンボル全体にマッチ。(「let」が「seq-let」にマッチしない)

tc.elを使用している場合、これらのモードに入ると文字を打っても何にもマッチしなくなってしまいます。(日本語入力状態でなくても)。

再現バージョン: emacs-30.2 + commit 6d7d16a (本投稿時点の再新commit)

再現方法: (require 'tc-setup)したあと、scratch bufferの先頭で「C-s M-s ' b」と押す。本来「buffer」のbにマッチするはずが、「Failing char-fold I-search」となる。

「C-s M-s '」の代わりに、「M-s w」や「M-s _」でも同様。

(emacs-24.5.1、emacs-25.3.1でも再現しました。すべてWindows版です。emacs-24にはisearch-toggle-wordしか実装されてないので、それで確認しています。)

原因は調べたので、追って書こうと思います。

[tooro88]

次のパッチでひとまず今回報告した問題は直りそうです。ただし、以下で説明しますが、これは見えている問題を直しただけで、他にも問題は残ります。

diff --git a/tc-is22.el b/tc-is22.el
index 5c9170b..2ff8dd4 100644
--- a/tc-is22.el
+++ b/tc-is22.el
@@ -98,8 +98,7 @@

 (defun tcode-isearch-search-fun ()
   (cond ((tcode-isearch-regexp-function)
-        (if isearch-forward
-            'word-search-forward 'word-search-backward))
+        (isearch-search-fun-default))
        ((or isearch-regexp
             (and (boundp 'tcode-isearch-enable-wrapped-search)
                  tcode-isearch-enable-wrapped-search))

バグの原因を説明します。

tcodeには、isearch時に日本語文字の間の空白や改行を無視する機能があります(tcode-isearch-enable-wrapped-searchがtのとき)。以下それを「行ラップサーチ」と呼びます。行ラップサーチを実現するために、tc-is22.elでは以下のことを行なっています。

1. emacs本体の関数をいくつか置き換えて、サーチ文字列に文字が追加されるたびに、それを、空白類を無視する正規表現に変更する。
2. 実際にサーチを行なう関数を、文字列サーチから正規表現サーチに変更する。

上のパッチが変更しているのは、2.を行なう部分です。修正前のコードの意図は、emacs-22時代のコードを見るとわかりやすいです。emacs-22本体に、isearch-search-funという関数があります。これは、関数を返す関数で、条件(前方か後方か、文字列サーチか正規表現サーチか、など)に応じてサーチ関数を選び出します。

(defun isearch-search-fun ()
  "Return the function to use for the search.
Can be changed via `isearch-search-fun-function' for special needs."
  (if isearch-search-fun-function
      (funcall isearch-search-fun-function)
    (cond
     (isearch-word
      (if isearch-forward 'word-search-forward 'word-search-backward))
     (isearch-regexp
      (if isearch-forward 're-search-forward 're-search-backward))
     (t
      (if isearch-forward 'search-forward 'search-backward)))))

cond文でやっていることはわかりやすく、サーチのモードに応じて適切な関数を返しています。

2.を実装するには、cond文の2番目のケースを修正して、「もし行ラップサーチが有効なら」という条件をorで加えればよさそうです。この関数を置き換えてそれを実現してもよかったのですが、関数の上の方を見るとわかる通り、isearch-search-fun-functionに関数をセットすれば、この関数をオーバーライドできます(diredやhexlなどでモード特有のサーチを実現するための機能のようです)。tc-is22.elはこの方法を用いて、tcode-isearch-search-funという関数でオーバーライドしています。emacs-22時代のコードを載せます。isearch-search-funを基本的に真似つつ、上で述べた通りの書き換えをしています。

(defun tcode-isearch-search-fun ()
  (cond (isearch-word
	 (if isearch-forward
	     'word-search-forward 'word-search-backward))
	((or isearch-regexp
	     (and (boundp 'tcode-isearch-enable-wrapped-search)
		  tcode-isearch-enable-wrapped-search))
	 (if isearch-forward
	     're-search-forward 're-search-backward))
	(t
	 (if isearch-forward 'search-forward 'search-backward))))

このemacs-22時代のコードを真似たコードが、emacsのバージョンアップとともに古くなってしまいました。それが原因で、今回報告した問題が起きたようです。本来の(私が推測する)設計意図からすると、この関数はemacsのバージョンごとに、そのバージョンのisearch-search-funに似せたコードを用意しなくてはなりません。

当然ですがその方針を実施するのは大変なので、emacs-22の段階でストップしてしまったようです。以降はemacs-22時代のコードをベースにしつつ、小修正のみが行なわれているようです。(私はその経緯は把握してないので、推測で話しています。思い違いがあればご指摘ください。)

上のパッチも、emacs-22時代のコードを継承しつつ今挙がっている問題だけに対処した修正です。内容を説明します。

問題となるのは、

  (cond (isearch-word
	 (if isearch-forward
	     'word-search-forward 'word-search-backward))

の部分、「もし単語サーチモードなら」「単語サーチ用の関数を使う」という部分です。emacs-25では単語サーチモードに加え、シンボルサーチモードやchar-foldサーチモードができ、それらをisearch-regexp-functionという共通の仕組みで実現しています。サーチ文字列を、モードごとに用意した関数で正規表現に変換して、それでサーチするという仕組みです。これにともない、「isearch-word(単語サーチモードかどうか)」というフラグはなくなりました。上記コードは「もしisearch-regexp-functionがセットされていたら」「それを呼び出して、結果を正規表現サーチする」というコードにする必要があります。現行のtc-is22.elは、

   (cond ((tcode-isearch-regexp-function)
        (if isearch-forward
            'word-search-forward 'word-search-backward))

となっています。tcode-isearch-regexp-functionというのは、isearch-wordフラグが無くなってしまったことを受けた修正で、バージョンによってisearch-wordかisearch-regexp-functionの存在する方をチェックしています。結果、emacs-25以降では、「もしisearch-regexp-functionがセットされていたら」「単語サーチ用の関数を使う」というちぐはぐな挙動になってしまっています。(なお、word-search-forward/backwardはemacs-24かそれ以前からすでに挙動が変わっていて、isearch目的には使えなくなっています。単語区切りにぴったりマッチしないといけないので、「buffer」に対して「b」がマッチしません。前ポストの挙動はそれが原因のようです。)

後半部の正しい挙動を自前で書くのではなく、emacs本体の実装にフォールバックするようにしたのが冒頭のパッチです。これで報告した問題は直ると思います。

しかし、emacs本体の実装と乖離してしまっていることには違いなく、isearch-lax-whitespaceという機能の実装も抜け落ちているようです。将来の新機能も使えないでしょう。だからと言って、emacsのバージョンアップごとにtc-is22.elを修正し続けるのも現実的でないです。そこで、tc-is22.elの「emacs本体の関数を置き換える」というデザインを見直した方がよいと思うのですが、どうでしょうか。例えば、行ラップサーチについては、上で触れたisearch-regexp-functionの仕組みを使えば実現できそうに思います。この辺の話はあとで、別issueで提案・相談しようと思います(いつになるかわかりませんが)。

今回のパッチは上で述べたように不完全ですし、tc-is22.elを大幅に見直すのであれば意味のないものになってしまいます。ですが、githubの使い方の練習を兼ねて、一応pull requestの形にしてみようと思います。

[tooro88]

冒頭に載せた修正よりもよい修正が、すでに commit 2d24476 「info で日本語 isearch できない不具合を修正した。」で行なわれていたようです。isearch-search-fun の呼び出し側に defadvice して、isearch-regexp を t にすることで、tcode-isearch-search-fun を全く不要にしています。

実際その commit では、tcode-isearch-search-fun を消しているのですが、その後の commit 11ee77c 「Merge branch 'is22'」にて、なぜか復活してしまったようです。2d24476c で消した部分をもう一度消せば、この issue は解決しそうです。

[tooro88]

2つ前のコメントで「isearch-regexp-function を用いる実装をあとで提案する」と書いた話は、「emacs 本体の関数の上書きを無くしたい #29」に書いて「isearch拡張機能のadviceによる再実装 #30」で実装しました。いずれにしてもこの問題自体は解決しているので、このissueはcloseしておきます。