Monthly Archives: 8月 2022

2022-08-16 ,

org-modeの起動時間を短縮する(org-babel-load-languages編)

org-modeの読み込みは非常に遅い。

原因は色々あるが、その一つが org-babel-load-languages の読み込みである。 org-babel-do-load-languages 関数によって、 org-babel-load-languages で指定されている全ての言語バックエンド(ob-???.el)を起動時に読み込んでしまい、その結果数秒も待たされることがある。

解決策はいくつか考えられる。一つはorg-mode起動後にタイマーによって少しずつ読み込んでいく方法。もう一つは必要になってから必要な言語だけ読み込む方法。

今回は後者を実現する。

ただし、この方法はorg-modeのバージョンアップによって機能しなくなる可能性が前者の方法より高い。org-modeは起動時に全ての言語バックエンドが読み込まれていることが前提で書かれており、言語バックエンドが必要なところで必ず呼び出す関数などは存在しない。強いて言えば、 (intern (concat "org-babel-???:" lang)) のようなコードによって org-babel-???:??? のようなシンボルを生成している箇所があちこちに存在する(grep '"org-babel-.*:'等で検索すると良い)。今回はそのような場所を詳しく調査することで半ば場当たり的に言語バックエンドが必要な箇所に処理を挟んで遅延読み込み処理を追加した。従ってorg-modeのバージョンアップに弱くなっている。

しかしながら調査した結果、大半は一つのパターンで対処が可能であることが分かった。ほとんどの場合、言語バックエンドを必要とする処理の前にはソースブロックの言語名を取得する処理が入っており、それは (org-element-property :language element) のような形になっている。このコードはorg-elementで解析した構文要素オブジェクトから言語名プロパティを取得するものだ。このコードで返すのは#+begin_srcの後の言語名なので、 org-element-property にadviceをかけて戻り値の言語名を元に言語バックエンドを読み込んでしまえば良い。 org-element-property は頻繁に呼ばれる関数なのであまり気は進まないが、少なくとも改変の影響はorg-modeの範囲に留まる(intern等に引っかけるよりはマシである)。

org-babel-get-src-block-infoorg-babel-lob-get-info のようなソースブロックの情報を返す関数も、結局はorg-elementで解析を行い要素の:languageプロパティを取得している。

まれにそれ以外の方法で言語名を生成している場合がある。例えばob-table.elには"emacs-lisp"のように言語名をハードコードしている箇所がある。また、 org-babel-enter-header-arg-w-completion 関数に対して (match-string) の値を言語名として引き渡している箇所もある。このようなケースには個別に対処する必要がある。

;; 使い方:
;; 1. org-babel-load-languagesの値はCustomizeの方ではnilにしておくこと。
;; 2. (with-eval-after-load "org"
;;      (load "このコードを含むファイル")) などとする。

;; 使用する言語名とそれを提供するelファイル名の一覧。
(defvar my-org-babel-languages
  ;;(言語名 . ob-ファイル名.el)
  '((elisp . emacs-lisp)
    (emacs-lisp . emacs-lisp)
    (makefile . makefile)
    (ditaa . ditaa)
    (dot . dot)
    (plantuml . plantuml)
    (perl . perl)
    (cpp . C)
    (C++ . C)
    (D . C)
    (C . C)
    (js . js)
    (java . java)
    (org . org)
    (R . R)
    (python . python)
    (shell . shell)
    (sh . shell)
    (bash . shell)
    (zsh . shell)
    (fish . shell)
    (csh . shell)
    (ash . shell)
    (dash . shell)
    (ksh . shell)
    (mksh . shell)
    (posh . shell)))

(defun my-org-babel-language-files ()
  "重複しない全ての言語バックエンドファイル名を返す。"
  (seq-uniq (mapcar #'cdr my-org-babel-languages)))

;; my-org-babel-languagesからorg-babel-load-languagesを設定する。
;; org-lintやorg-pcompleteにorg-babel-load-languagesを使った処理がある
;; ようなので。
;; このときcustom-set-variablesを使わないようにすること。
;; org-babel-do-load-languagesが呼ばれて全部読み込まれてしまうので。
(setq org-babel-load-languages
      (mapcar (lambda (lang) (cons lang t)) ;;(emacs-lisp . t)のような形式
              (my-org-babel-language-files)))

(defun my-org-require-lang-file (lang-file-name)
  "ob-LANG-FILE-NAME.elを読み込む。"
  (when lang-file-name
    (require (intern (format "ob-%s" lang-file-name)) nil t)))

(defun my-org-require-lang (lang)
  "LANGを読み込む。"
  (my-org-require-lang-file
   (alist-get
    (if (stringp lang) (intern lang) lang)
    my-org-babel-languages)))

(defun my-org-require-lang-all ()
  "全ての言語を読み込む。"
  (mapc #'my-org-require-lang-file
        (my-org-babel-language-files)))

;; org-elementで言語名を返す時、その言語をロードする。
(advice-add #'org-element-property :around #'my-org-element-property)
(defun my-org-element-property (original-fun property element)
  (let ((value (funcall original-fun property element)))
    (when (eq property :language)
      (my-org-require-lang value))
    value))

;; ob-table.elに(org-babel-execute-src-block nil (list "emacs-lisp" "results" params))のような呼び出し方をする所があるので。
(advice-add #'org-babel-execute-src-block :around
            #'my-org-babel-execute-src-block)
(defun my-org-babel-execute-src-block (original-fun
                                       &optional arg info params)
  (my-org-require-lang (nth 0 info))
  (funcall original-fun arg info params))

;; (match-string)の値を直接langとして渡しているので。
(advice-add #'org-babel-enter-header-arg-w-completion :around
            #'my-org-babel-enter-header-arg-w-completion)
(defun my-org-babel-enter-header-arg-w-completion (original-fun
                                                   lang)
  (my-org-require-lang lang)
  (funcall original-fun lang))

;; org-lint(org-lint-wrong-header-argument, org-lint-wrong-header-value)内で参照しているので。
;; 面倒なので全部読み込んでしまう。
(advice-add #'org-lint :around #'my-org-lint)
(defun my-org-lint (original-fun &rest args)
  (my-org-require-lang-all)
  (apply original-fun args))

;; 他にもinfoやlangを引数に取るような関数がある。
;; my-org-element-propertyやorg-babel-get-src-block-info等を使ってlangや
;; infoを取得していれば問題ないが、予期していない方法でlangやinfoを取得し
;; ている場合は対処する必要がある。

と、書いた後にorg-modeのメーリングリストに次のような投稿を見つけた。

Load Org Babel Languages on Demand

見たところ org-src--get-lang-modeorg-babel-confirm-evaluate にadviceを追加して似たようなことをしている。 org-src--get-lang-mode 関数は現在見当たらないが何か変更があったのだろうか( org-src-get-lang-mode はあるので改名された?)。

2020年の投稿だがその後どうなったのかは不明。

ちゃんと修正するのであれば、まずはあちこちに散らばっている org-babel-*:* シンボルを組み立てる処理を関数にまとめるのが良さそう。そしてその関数から言語名に対応するob-ファイルを読み込むようにすれば良い。有効言語の設定変数をどうするかは迷い所だが org-babel-load-languages の形式を拡張できるかもしれないし、あるいは別に変数を用意しても良さそうだ。

2022-08-15

Ivy/CounselからVertico/Consultへ移行~補完候補以外を選びづらい問題

通常バッファ内での補完をcompanyからcorfuに変えたので、ミニバッファ補完もivyからverticoへ変えてみた。

設定:

(vertico-mode)
(setq vertico-cycle t) ;;最初と最後の候補を行き来できるようにする
(setq completion-styles '(basic substring partial-completion flex)) ;;適当

;; 大文字小文字の区別をしない
(setq read-file-name-completion-ignore-case t
      read-buffer-completion-ignore-case t
      completion-ignore-case t)

;; 候補更新時に最初の候補を選択しない (2023-03-19追記: verticoにカスタマイズ変数が追加された! https://github.com/minad/vertico/commit/bedd146c3ffc236d746d088a94c3858eca0618d9 (Add vertico-preselect option (Fix #306) · minad/vertico@bedd146))
(setq vertico-preselect 'prompt)

;; (2023-04-18追記)
;; ただし、require-matchがt(やそれに類するもの)で入力が空ではなくマッ
;; チする候補がある場合は、その候補の先頭を選択する。
(defun my-vertico--recompute (orig-fun pt content &rest args)
  (let ((result (apply orig-fun pt content args)))
    (if (and (not (equal content "")) ;;入力が空の時は(require-matchであっても)defaultまたはnilを返すことになっている。
             (> (alist-get 'vertico--total result) 0)
             ;; completing-readの説明によれば
             ;; nil,confirm,confirm-after-completion以外はtのように
             ;; 振る舞うべき。
             (not (memq minibuffer--require-match
                        '(nil confirm confirm-after-completion))))
        (setf (alist-get 'vertico--index result) 0))
    result))
(advice-add #'vertico--recompute :around #'my-vertico--recompute)

;; 以下は過去のもの
;; ;; 候補更新時に最初の候補を選択しない (2022-12-01追記: vertico--allow-prompt-p関数が無くなって代わりに戻り値にvertico--allow-promptが増えたので修正)
;; (defun my-vertico--recompute (original-fun &rest args)
;;   ;; vertico--update-candidatesの最後の処理を置き換える。
;;   (let ((result (apply original-fun args)))
;;     (when result
;;       (let ((lock         (alist-get 'vertico--lock-candidate result))
;;             (allow-prompt (alist-get 'vertico--allow-prompt result))
;;             (index        (alist-get 'vertico--index result)))
;;         (when (and (not lock)
;;                    allow-prompt)
;;           ;; lockされておらず, require-matchじゃない場合は現在入力中の文字列を選択する。
;;           (setf (alist-get 'vertico--index result) -1))))
;;     result))
;; (advice-add #'vertico--recompute :around #'my-vertico--recompute)

;; ;; 候補更新時に最初の候補を選択しない (2022-10-24追記: 関数名や戻り値が変わったので修正)
;; (defun my-vertico--recompute (original-fun &rest args)
;;   ;; vertico--update-candidatesの最後の処理を置き換える。
;;   (let ((result (apply original-fun args)))
;;     (when result
;;       (let ((lock        (alist-get 'vertico--lock-candidate result))
;;             (def-missing (alist-get 'vertico--default-missing result))
;;             (index       (alist-get 'vertico--index result)))
;;         (when (and (not lock)
;;                    (let ((vertico--default-missing def-missing)) (vertico--allow-prompt-p)))
;;           ;; lockされておらず, require-matchじゃない場合は現在入力中の文字列を選択する。
;;           (setf (alist-get 'vertico--index result) -1))))
;;     result))
;; (advice-add #'vertico--recompute :around #'my-vertico--recompute)

;; ;; 候補更新時に最初の候補を選択しない (旧バージョン用)
;; (defun my-vertico--recompute-candidates (original-fun &rest args)
;;   ;; vertico--update-candidatesの最後の処理を置き換える
;;   (let ((result (apply original-fun args)))
;;     (when result
;;       (unless (nth 3 result) ;;3=index
;;         (setq vertico--lock-candidate nil)
;;         (setf (nth 3 result) ;;3=index
;;               (if (vertico--allow-prompt-selection-p)
;;                   ;; require-matchじゃない場合は現在入力中の文字列を選択する
;;                   -1
;;                 ;; require-matchの場合は最初の候補を選択する
;;                 0))))
;;     result))
;; (advice-add #'vertico--recompute-candidates :around #'my-vertico--recompute-candidates)

;; より簡単な方法としてRETをvertico-exit-inputにするという方法もある。
;; (define-key vertico-map [remap exit-minibuffer] #'vertico-exit-input)
;; しかし補完候補がハイライトされるので気持ち悪い。
;; プロンプトがハイライトされているべき。

移行して一番気になったのが、何かを入力するとそれにマッチする候補の中から最初の物を選択してしまうという挙動だ。これはhelmでもivyでもどうしてもなじめなかった。

(2023-03-19追記: 最初の物を選択しないようにできるカスタマイズ変数 vertico-preselect が追加されたので設定でこの挙動は抑制できるようになった)

よく起きる問題としては、find-fileで新規ファイルを作るときに間違って既存のファイルを開いてしまうというものだ。ファイル名を入力してRETを押したとき、その入力した文字列と部分的にマッチする候補が開いてしまうのだ。

helmにせよivyにせよverticoにせよそれに対する標準の解決策は一応あって、何か特殊なキーで確定させるというものだ。ivyではC-M-j、verticoではM-RETで現在の入力をそのまま確定できる。helmは覚えていないが、何かしらあったと思う。

私はこの挙動にとても強い違和感を覚える。

find-fileで出てくるミニバッファ入力は、「任意の」ファイル名を入力するためのものだ。決して限られた候補の中から選ぶというものでは無い。Emacsの標準的な動作でも、任意の文字列を入力して明示的にTABを押したときだけ補完されるというものだ。どんなOSのファイル選択ダイアログだって、ファイル名を入力してEnterを押したら別のファイル名が入力されるなんてバカなことは起きない。それをverticoでは新規のファイルを作る時だけM-RETを押せと言うのである。Emacsを使う人たちは学習能力が高いからどんな特殊な操作でもすぐに慣れてしまうのだろうけど私はそんなものには慣れたくない。そんなことだから初心者に逃げられるのでは無いか。

Emacs Lispにおいて補完入力を行う関数はcompleting-readだ。Verticoはここにも作用する。

(completing-read "商品: " '("ringo-ame" "ringo-cake" "ringo-juice"))

上のような式を評価したとして、ringo RETと入力したらringoと入力されるべきでringo-ame等が入力されるのは納得いかない。ringo-ameやらは例えば開発者が気を利かせて用意しただけの何か優先度の低い候補に過ぎないかもしれない。ringoよりringo-ameを優先すべき理由はない。

(completing-read "商品: " '("ringo-ame" "ringo-cake" "ringo-juice") nil t)

completing-readの第4引数(REQUIRE-MATCH)がtならば分かる。この場合、任意の文字列は入力できず、必ず候補の中から選ばなければならないからだ(ただし何も入力せずRETを押したときは第7引数のデフォルト値またはnilとなる)。

というわけで、この辺りを修正したのが上の設定だ。文字列を入力すると候補は絞り込まれるが選択はされない。C-n、C-pで明示的に選択したときだけそれが使われる。ただし、REQUIRE-MATCHがtのときだけは最初の候補を自動的に選択する。

このやり方の欠点は大半は候補の中から選べば済むときでも必ず明示的に選択操作をしなければならない点だ。例えばfind-fileは既存のファイルを選択することの方が多いはずだ。また、switch-to-bufferも既存のバッファを選択することの方が多い(任意のバッファ名を入力して新しく作れるということを覚えていない人もいるのではないか)。こういったときに、一つに絞り込んだのにいちいち選択操作をしなければならないのは面倒に感じることもあるかもしれない。

しかしそれはfind-fileやswitch-to-bufferといった用途毎に特有な事情であって、ミニバッファ補完付き入力全般に適用出来る問題ではないはずだ。用途毎にどちらが多いかは異なるのだから。後は好みで、find-fileやswitch-to-bufferに設定があればよい。個人的にはswitch-to-bufferで新しいバッファを作る機能は使っていないので、REQUIRE-MATCH=t、つまり既存のバッファのみ選択出来るようになっていて構わない。find-fileはいちいち選択するのに苦は感じない。どちらにせよ一つに絞り込んだらTABを押してRETすれば素のEmacsと同じなのだから分かりやすい。

ミニバッファ補完を活用する応用コマンドについては、ivyに依存するcounselではなくより幅広いミニバッファ補完に対応したconsultへ移行した。比較してみるとcounselの方が若干使いやすいと感じることもあるが、両者そう大きくは違わない。それほど使い込んでいるわけではないというのもあるけれど。Embarkと組み合わせると絞り込んだ候補に対して色々アクションを適用出来たりするようだ。拙作のel-winsearchにはconsult版を追加した。

2022-08-15

companyからcorfuへ移行~自動と手動で補完候補を変える

corfucompanyよりは幾分素直で扱いやすい印象。

corfuの設定:

(2024-02-18追記: Corfuの自動補完で候補の存在を伝える事と候補を選べるようにする事を分離するで設定を書き直したので以下のコードは古い)

(setq corfu-cycle t) ;; 候補の最初と最後を行き来出来るようにする。
(setq corfu-auto t) ;; 自動的に補完候補を出す。
(setq corfu-preselect 'prompt) ;; 最初の候補を選択しない。誤入力が多すぎるので。

;; 無選択時のRETはquitだけでなく改行もする。
;; (2024-02-15修正:my-corfu-だと素早くC-M-iの後素早くRETを押したときに正しく補完されない。コマンド名がcorfu-で始まっているときだけupdateしている場所があるので)
(defun corfu-my-insert-or-newline ()
  (interactive)
  (if (>= corfu--index 0)
      (corfu--insert 'finished)
    (corfu-quit)
    ;; (2024-02-15修正:インタラクティブじゃないとインデントされなかったりする)
    (call-interactively 'newline)))
(with-eval-after-load "corfu"
  (define-key corfu-map (kbd "RET") 'corfu-my-insert-or-newline))

(global-corfu-mode)

;; lsp-modeでcorfuを使う。
;; (see: https://github.com/minad/corfu/wiki#example-configuration-with-flex)
(setq lsp-completion-provider :none)
(defun my-lsp-mode-setup-completion ()
  (setf (alist-get 'styles
                   (alist-get 'lsp-capf completion-category-defaults))
        '(flex)))
(add-hook 'lsp-completion-mode-hook #'my-lsp-mode-setup-completion)

;; corfuの候補リストにアイコンを表示する。
(setq kind-icon-default-face 'corfu-default)
(add-to-list 'corfu-margin-formatters #'kind-icon-margin-formatter)

(corfu-auto=tで)自動的に補完候補を出しつつ自動的に最初の候補を選択する(corfu-preselectが'firstや'valid)というのは誤操作を引き起こす可能性がある。 何かを入力してRETやTABを押したら自動的に出てきた補完候補の方を意図せず選んでしまったというようなことが起こりえる。そのためにcorfu-preselectを'promptにして明示的に選ばなければ補完しないように設定した。

それでも何かを入力してC-n RETを押すようなシチュエーションでは下に移動して改行するつもりが最初の候補を選択して確定してしまうので、結局誤入力は完全には回避できなかった。なので自動的に出す時の候補をできるだけ少なくする(自動ではあまり候補を出さない)ようにしてみた。補完候補(バックエンド)は completion-at-point-functions (capf)という元々Emacsに備わっている仕組みに一本化されているので、それを調整する。

completion-at-point-functionsの設定:

;; 補完候補を出すときの文脈を特定

(defvar my-capf-context nil)

;; (2022-10-26修正: corfu--auto-complete => corfu--auto-complete-deferred)
(defun my-capf--corfu--auto-complete-deferred (old-fun &rest args)
  ;; corfu-autoの作用で補完候補を出すときに呼び出される。
  (let (;; 自動で補完候補を出す文脈だということを変数に記録する。
        (my-capf-context 'in-corfu--auto-complete-deferred)
        ;; 2024-02-14追記:
        ;; 自動で補完候補を出すときは必ずbasicスタイルのみを使うべし!
        ;; 先頭すら一致していない候補をバリバリ出されたら鬱陶しい!
        (completion-styles '(basic)))
    ;; 元の処理
    (apply old-fun args)))
(advice-add 'corfu--auto-complete-deferred :around #'my-capf--corfu--auto-complete-deferred)

;; 追加の補完関数

(defun my-capf-additional ()
  (pcase my-capf-context
    ('in-corfu--auto-complete-deferred
     ;; 自動補完の場合は確度の高い候補しか出さない。
     nil)
    (_
     ;; 手動補完の場合は積極的にいろんな候補を出す。
     (my-capf-manual))))
(add-hook 'completion-at-point-functions #'my-capf-additional 100)

;; 手動補完時の補完関数

(defvar my-capf-manual nil)
(defun my-capf-manual ()
  ;; capeパッケージの読み込みを遅延させる。
  (unless my-capf-manual
    (setq my-capf-manual
          ;; いろんな補完候補を合成する。
          (cape-super-capf
           #'cape-file #'cape-dabbrev #'cape-abbrev #'cape-line)))
  (funcall my-capf-manual))

自動的に補完候補を出す場合は元々モードに備わっているような補完候補しか出さないようにした。プログラミング言語用のモードの場合は文法に則した候補が出るのでそれほど邪魔にならないと思われる。

逆にC-M-iで手動で補完候補を出す場合はcapeパッケージの多種多様な補完候補を利用する。手動で出しているのだから多少確度の低い候補が出てきても構わない。

cape-super-capfで複数のバックエンドをマージしている。

capeは他にもcompany用バックエンドをcapfに変換するアダプタも持っている。手元にはorg-modeの「#+」行をより良く補完する自作のCompanyバックエンドがあるので、このアダプタでcorfu用に変換した。

今のところM-/はdabbrev-expandのままにしてある。

補完候補については不満なところがまだまだ沢山あるので逐一直していくつもりだ。completion-stylesも過剰な補完生成に一役買っているように見える。verticoにせよcorfuにせよ、どうも補完することばかりを優先して補完させたくないケースを軽視しているように見える。

(2024-02-15追記: Corfuの自動補完で候補の存在を伝える事と候補を選べるようにする事を分離するで設定を追加した)