statuslineの%{}などでevalした際に，try-catch でVimのエラーをキャッチしていても statusline が disable されてしまう

[haya14busa]

質問・報告の内容

statuslineの%{}などでevalした際に，try-catch でエラーをキャッチしていても statusline が disable されてしまう

(キャッチされないエラーが発生したらstatuslineがdisableされるのは正しい)

再現方法

statusline_test.vimrc

set nocompatible

function! StatuslineKiller() abort
  try
    " :throw ではなく Vim のエラー(任意)を発生させる
    call eval('')
  catch
    return 'OK: error catched!'
  endtry
  return 'OK'
endfunction

set laststatus=2
set statusline=%{StatuslineKiller()}

1. vim -u statusline_test.vimrc -i NONE -N

• 'OK: error catched!' がstatuslineに表示される (actual & expected)

2. :redrawstatus
   • " Press ENTER or type command to continue が表示 (actual & expected)
   • Enter を押す
   • statusline が disable される (&statusline == '')

Expected な挙動

1. vim -u statusline_test.vimrc -i NONE -N

• 'OK: error catched!' がstatuslineに表示される

2. :redrawstatus
   • 'OK: error catched!' がstatuslineに表示される

関連問題

• actual: statuslineでVimのエラーが発生し，キャッチもされないと， silentlyにstatuslineがdisableされる
• 個人的な? expected: statuslineでVimのエラーが発生すると，エラーメッセージを表示した上でstatuslineがdisableされる

補足: statuslineがdisableされるのはstatuslineのredrawが起こるごとにエラーが出るとうっとおしいからdisableしているようです．

修正パッチ案

haya14busa/vim@0cd2c2f

ちょっと詳しくなくて付け焼き刃の調査をしながらの修正です．
なのでこれでいいのかよくわかりませんが，僕が意図した挙動になりました．

Vimのバージョン

7.4.1386

OSの種類

• ArchLinux

どのOSでも再現するはず

その他

• 関連 issues
  • RFC: Next release (1st beta release) lambdalisue/vim-gita#85 (comment)
  • vital モジュールのロードを爆速にする & ロード方法を考える vital.vim#415 (comment)

両者ともログ長いし読む必要はないですが，上記issueで問題が発覚し，silentlyにstatuslineがdisableされるせいで異常にデバッグが難しかったです．

問題や該当コードを見つけたのは @lambdalisue さんや watiko さんです．

cc @lambdalisue

[h-east]

補足: statuslineがdisableされるのはstatuslineのredrawが起こるごとにエラーが出るとうっとおしいからdisableしているようです．

一応、ドキュメントに書いてあります。
:h 'statusline'の20行下くらい。

    オプションを評価している間にエラーが発生すると、それ以降のエラーを避け
    るためにオプションに空が設定される。そうしないと画面更新がループに陥っ
    てしまう。

[h-east]

本題とあんまり関係ないけど、LANGで挙動が違いますね。

$ LANG=ja_JP.UTF-8 vim -Nu statusline_test.vimrc

起動直後に既に'statusline'が空。だからステータスラインに[無名]と表示される。
Vim内部のmulti-byte時の処理の中でステータスライン描画処理が呼ばれていると思われる。

$ LANG=C vim -Nu statusline_test.vimrc

@haya14busa さん報告の動作。

[mattn]

did_emsg も前のパッチと同様に saved_did_emsg で退避すべきです。

[haya14busa]

一応、ドキュメントに書いてあります。

確かに書いてありますね．エラーを出すかどうかについては言及してないけど黙って空に設定するところまで意図していた場合はこの修正ではだめそうですね．どうなんだろうか...

退避なるほど．修正しました．

diff --git a/src/screen.c b/src/screen.c
index 9d854a2..edd1dea 100644
--- a/src/screen.c
+++ b/src/screen.c
@@ -6779,7 +6779,7 @@ win_redr_status(win_T *wp)
 redraw_custom_statusline(win_T *wp)
 {
     static int     entered = FALSE;
-    int            save_called_emsg = called_emsg;
+    int            saved_did_emsg = did_emsg;

     /* When called recursively return.  This can happen when the statusline
      * contains an expression that triggers a redraw. */
@@ -6787,9 +6787,9 @@ redraw_custom_statusline(win_T *wp)
    return;
     entered = TRUE;

-    called_emsg = FALSE;
+    did_emsg = FALSE;
     win_redr_custom(wp, FALSE);
-    if (called_emsg)
+    if (did_emsg)
     {
    /* When there is an error disable the statusline, otherwise the
     * display is messed up with errors and a redraw triggers the problem
@@ -6798,7 +6798,7 @@ redraw_custom_statusline(win_T *wp)
        (char_u *)"", OPT_FREE | (*wp->w_p_stl != NUL
                    ? OPT_LOCAL : OPT_GLOBAL), SID_ERROR);
     }
-    called_emsg |= save_called_emsg;
+    did_emsg |= saved_did_emsg;
     entered = FALSE;
 }
 #endif

[lambdalisue]

try/catch が入ったのって何時なんだろう？もしも statusline が空っぽになるコードが追加されただいぶ後とかだったら「前はそういうの必要だったかもしれないけど今は try/catch あんだからそれを使ってない statusline のコンポーネント（ユーザーが書いてるものおよびプラグインの双方）が悪いだろJK」って言ってみるとか？

[mattn]

えと、try/catch してても駄目なんですよ。
本来「エラーがtry/catch無しの状態で投げられた」と判断すべきところが「エラーが発生したかどうか(try/catch有無関係なしに)」で判断しちゃってるというバグです。

[lambdalisue]

お、それがされてないのは無理だからだと勝手に思ってました。
内部のことは知らないのですが try/catch されたと判定できるのであればそちらの方が良いですね！

[haya14busa]

それを直してるつもりのパッチですね〜．(did_emsg で本当にいいか厳密に調べきれてませんが)

[mattn]

did_emsg で本当にいいか厳密に調べきれてませんが

did_emsg でいいですよ。

[haya14busa]

おお，よかったです:)

[mattn]

@haya14busa さん、テスト書けます？

[haya14busa]

これでよさそうならテスト書いてみます．(よく考えたらコードが正しいかどうかに関係なくテストかけましたね)

なんかわからなかったら聞くかも知れないですが，その時はよろしくお願いします 🙇

[haya14busa]

テストも足してみました vim/vim@master...haya14busa:fix-redrawstatusline-for-catched-error