最近補完まわりを色々改善したので気を良くしてあちこちで無駄に補完をさせて楽しんでいるのですが、org-modeの補完がイマイチうまく動かないことが多いです。色々調べた結果org-pcomplete.elに問題があることが分かってきました。なので少し直してみました。
見つけた問題はだいたい次の通りです:
- リンクタイプが補完できない (→「org-modeでの入力補完」で解決済み)
- #+ATTR_HTML等一部のキーワードが補完できない (→「org-modeでの入力補完」で解決済み)
- 行の途中に区切り文字(スペースや[)があると、その行の末尾でリンクが補完できない
- 行の途中にあるリンクが補完できない
- 行の途中にある見出し検索リンクが補完できない (→最近1/7のコミット「Fix [[* completion when there is text after point」で解決済み)
- 行の途中にあるTeX表記が補完できない
- 右に既に優先度や見出しが入っている場合にTODOキーワードが補完できない
一番気になったのがリンクの補完です。例えば
[[ hoge [[ あれは[[
の末尾では補完できますが
hoge hoge [[ あれは[[file:hoge.txt]]または[[
の末尾では補完できません。日本語は空白で区切らないので最初は空白が入っていると同じ問題が起きることには気が付きませんでした。日本語でも二つ目以降のリンクが補完されません。
また、行の途中に戻って補完するのも無理なようです。基本的に行末で無ければ補完できません。
というわけで、それらを直すコードを作ってみました。
(with-eval-after-load "org-pcomplete" ;; 「#+」の部分を補完する関数。 ;; ATTR_HTMLやBEGIN_FIGURES-COL2等を追加。 ;; `pcomplete/org-mode/file-option'を置き換える。 (defun my-pcomplete/org-mode/file-option () "Complete against all valid file options." ;; org-pcomplete.elの`pcomplete/org-mode/file-option'よりコピーして改変 (require 'org-element) (pcomplete-here (org-pcomplete-case-double (append (mapcar (lambda (keyword) (concat keyword " ")) org-options-keywords) (mapcar (lambda (keyword) (concat keyword ": ")) org-element-affiliated-keywords) ;; ★[変更]: 追加。 (mapcar (lambda (keyword) (concat keyword ": ")) '("ATTR_HTML" "ATTR_ORG")) (let (block-names) (dolist (name '("CENTER" "COMMENT" "EXAMPLE" "EXPORT" "QUOTE" "SRC" "VERSE" ;; ★[変更]: 追加。 "FIGURES-FLOW" "FIGURES-COL2" "FIGURES-COL3") block-names) (push (format "END_%s" name) block-names) (push (concat "BEGIN_" name ;; Since language is compulsory in ;; export blocks source blocks, add ;; a space. (and (member name '("EXPORT" "SRC")) " ")) block-names) ;; ★[変更]: 削除。ATTR_CENTERって何だよ…… ;;(push (format "ATTR_%s: " name) block-names) )) (mapcar (lambda (keyword) (concat keyword ": ")) (org-get-export-keywords)))) (substring pcomplete-stub 2))) (advice-add 'pcomplete/org-mode/file-option :override 'my-pcomplete/org-mode/file-option) ;; リンクを補完する関数。 ;; link-abbrevだけでなくリンクタイプも補完させる。 ;; `pcomplete/org-mode/link'を置き換える。 (defun my-pcomplete/org-mode/link () "Complete against defined #+LINK patterns." ;; org-pcomplete.elの`pcomplete/org-mode/link'よりコピーして改変 (while ;;★[変更]: ←追加(ただし`my-org-parse-arguments'の修正で不要) (pcomplete-here (pcomplete-uniquify-list (copy-sequence (mapcar (lambda (e) (concat (car e) ":")) (append org-link-abbrev-alist-local org-link-abbrev-alist ;; ★[変更]: 追加 org-link-parameters))))))) (advice-add 'pcomplete/org-mode/link :override 'my-pcomplete/org-mode/link) ;; 見出しへの検索リンク([[*)を補完する関数。 ;; エラーが出るので最新のコミットでの修正を取りこむ。 ;; `pcomplete/org-mode/searchhead'を置き換える。 (defun my-pcomplete/org-mode/searchhead () "Complete against all headings. This needs more work, to handle headings with lots of spaces in them." (while (pcomplete-here (save-excursion (goto-char (point-min)) (let (tbl) (while (re-search-forward org-outline-regexp nil t) ;; Remove the leading asterisk from ;; `org-link-heading-search-string' result. (push (substring (org-link-heading-search-string) 1) tbl)) (pcomplete-uniquify-list tbl))) ;; ★[変更]: この部分を削除。substringでpcomplete-stubが空の時にargs-out-of-rangeが出る。最新版では削除されてる。 ;; ;; When completing a bracketed link, i.e., "[[*", argument ;; ;; starts at the star, so remove this character. ;; ;; Also, if the completion is done inside [[*head<point>]], ;; ;; drop the closing parentheses. ;; (replace-regexp-in-string ;; "\\]+$" "" ;; (substring pcomplete-stub 1)) ))) (advice-add 'pcomplete/org-mode/searchhead :override 'my-pcomplete/org-mode/searchhead) ;; ★引数列の抽出部分を根本的に直す。 ;; `org-parse-arguments'を置き換える。 (defun my-org-parse-arguments () "Parse whitespace separated arguments in the current region." (pcase (org-thing-at-point) ;; 2024-01-07のコミットで追加された部分 ;; Fix [[* completion when there is text after point ;; https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/lisp/org-pcomplete.el?id=97951352bb4a32b06f0dede37cf5f796ad3f14c2 (`("searchhead" . nil) ;; [[* foo<point> bar link::search option. ;; Arguments are not simply space-separated. (save-excursion (let ((origin (point))) (skip-chars-backward "^*" (line-beginning-position)) (cons (list (buffer-substring-no-properties (point) origin)) (list (point)))))) ;; 行指向の文法要素のみ行頭から引数を集める ((or `("file-option" . ,thing) `("block-option" . ,_)) (let ((begin (line-beginning-position)) ;; #+STARTUPはpcomplete-argsを参照しているので行末まで集める ;; (ただし最後の引数より前で補完が出来ないバグはそのままになる) (end (if (equal thing "startup") (line-end-position) (point))) begins args) (save-excursion (goto-char begin) (while (< (point) end) (skip-chars-forward " \t[") (push (point) begins) (skip-chars-forward "^ \t\n[") (push (buffer-substring-no-properties (car begins) (point)) args))) (cons (reverse args) (reverse begins)))) ;; それ以外は基本的に直前のみを返す ;; リンクは[の後からリンクタイプの後(:があればそれも含む)まで (`("link") (save-excursion (skip-chars-backward "^[" (line-beginning-position)) (let ((beg (point)) (end (progn (skip-chars-forward "-A-Za-z0-9_") (if (eq (char-after) ?:) (1+ (point)) (point))))) (cons (list (buffer-substring-no-properties beg end)) (list beg))))) (_ (save-excursion (let ((end (point))) (skip-chars-backward "^ \t\n[") ;; TODO: 現在の引数の末尾まで含めるか迷う (cons (list (buffer-substring-no-properties (point) end)) (list (point)))))))) (advice-add 'org-parse-arguments :override 'my-org-parse-arguments) ;; 現在いる場所の文法要素を調べる関数。 ;; ★`org-thing-at-point'で検出できなかったものを補う。 (defun my-org-thing-at-point:after-until () ;; 元の`org-thing-at-point'がnilを返したとき、 (cond ;; [[type:のようにコロンの後でもlinkにする。 ;; 補完するのはコロンまでなのだから、コロンまで含めるべき。 ((save-excursion (skip-chars-backward ":" (1- (point))) (skip-chars-backward "-A-Za-z0-9_") (and (eq ?\[ (char-before)) (eq ?\[ (char-before (1- (point)))))) (cons "link" nil)) ;; 既に右に見出しが入っているときのTODOキーワード ((save-excursion (let ((pos (point))) (goto-char (line-beginning-position)) (save-match-data (and (looking-at "^\\*+ +\\([^ \t\\[]*\\)") (<= (match-beginning 1) pos) (<= pos (match-end 1)))))) (cons "todo" nil)))) (advice-add 'org-thing-at-point :after-until 'my-org-thing-at-point:after-until) ) ;; End of with-eval-after-load "org-pcomplete"
「org-modeでの入力補完」ですでに書いたコードも含めているので少々長くなっています。
一番大きな原因はorg-parse-arguments関数の動作にあるようです。他の同種の関数(pcomplete-parse-arguments-function変数に設定される関数)であるpcomplete-parse-comint-arguments(shellのコマンドラインの補完に使われる)と比べてみるとよく分かるのですが、org-parse-argumentsは現在の行の頭から末尾まで全てを解析してしまっている一方pcomplete-parse-comint-argumentsは現在ポイントが指している引数までしか解析しません。pcompleteはそれらが返した引数列の最後の要素しか補完しないので、org-modeでは行末部分でしか補完されません。
org-parse-argumentsがなぜ行の末尾まで解析しているのかは不明ですが、pcomplete/org-mode/file-option/startupにはpcomplete-argsを参照して排他的なオプションを候補から外す処理をしているので、その時に末尾まで解析するように修正したのかもしれません。あくまで想像ですが。
いずれにせよ、基本的にはorg-parse-argumentsが返すのは現在のポイントが指している引数(字句)までに限るべきです。そうでないと行の途中で補完できなくなってしまいます。
そもそも「#+」のような行指向の文法要素なら別ですが、リンクやTeX表記などはポイントが指している字句のみを返せば十分であり、行頭から解析する必要は全くありません。最近(1月7日に) [[* で始まるリンク(見出し検索リンク)に対する修正が入りましたが(Fix [[* completion when there is text after point)これもその点は分かっているようで、ポイントが指している部分しか返していません。
上に書いたmy-org-parse-arguments関数の部分はその辺りを修正しました。
二つ目以降のリンクが補完されない原因はpcomplete/org-mode/link関数内のpcomplete-hereの前にwhileが無いからなのですが、org-parse-argumentsがポイントが指している部分しか返さないようにすればwhileが無くても問題ありません。
TODOキーワードが空の見出しで無ければ補完されないのはマニュアルにも書いてある(Completion (The Org Manual))ので仕様なのですが、一応修正しました。
単語の途中にポイントを置いて補完したときにどうなるべきなのかは微妙な問題な気がします。基本的にはその単語を置き換えるように動作すべきだと思うのですが、現状では必ずしもそうはなっていません。Corfuが有効だとエラーが発生するケースもありました。Corfuを無効化するとエラーは出なくなるのですが、かといって正しく補完されるわけでも無く単に空白が一文字挿入されるだけだったりします。よく分からないので未解決です。
pcompleteのことは詳しくないのですが、元々コマンドラインの補完をするためのライブラリなのでしょうか？ org-modeの補完に利用するのが適切なのかは正直疑問だと思います。org-thing-at-pointで調べたものをorg-parse-argumentsで再度調べ直さなければならないような状況に陥っていますし、使わずに書いた方がスッキリしそうな気がします。まぁ、補完関数に必要な処理を全て知らないので分かりませんが。