Author Archives: AKIYAMA

2022-08-27 ,

org-modernとorg-indentを併用したときの表の乱れを直す

org-modern

先日org-modernを試してみました。org-modeの各部の見た目を綺麗に(モダンに)してくれます。

そんな中で私が最も気に入ったのは、表(テーブル)の線を綺麗にしてくれるという点です。

org-modernで見た目を改善したorg-modeの表
図1: org-modernで見た目を改善したorg-modeの表

もはやorg-modeと言われなければ分からないと思います。

いくつか問題もあって、 org-table-toggle-coordinate-overlays による座標表示は機能しなくなります。まぁ、仕方ないですね。(2022-08-27追記: org-table-toggle-column-width あたりも問題がありますね。これはちょっと気になるかなぁ)

その辺りは許容するとして、私が使っていて最も気になったのはorg-indentと併用した際の問題です。org-indentは階層に応じて左にインデントをつけてくれるモードです。org-modernはこのorg-indentと相性が悪いです。例えばブロック(#+begin_???から#+end_???までの間)の左に装飾を入れる機能があるのですが、これはorg-indentが有効になっているときは機能しません。

org-indentの併用で表に発生する問題

表の線についてはorg-indent使用時でも一見正しく機能するように見えましたが、よく見ると二つほど問題がありました。

  • 横線の下に大きく空白が空く
  • ウィンドウの先頭にある行がインデントされない
修正前
図2: 修正前

原因

横線の下に大きく空白が空く原因は、org-indentが挿入する空白文字が高さを持ってしまっているところにあります。高さを持っている以上、その行がそれ以上縮まることはありません。

ウィンドウの先頭がインデントされない原因は、先日書いたEmacsのバグにあります。

原因
図3: 原因

修正

org-indentで挿入する空白の高さを1ピクセルにする

org-indentが挿入する文字列が高さを持ってしまっていることが原因なので、それを無くせば良いのです。文字列では無くdisplayプロパティのspace指定を使うことで高さ1ピクセルの空白を作ります。

;; org-indentを使っていると表の水平線の高さが狭まらない問題を修正する。
;; インデントの空白文字列の高さよりも小さくならないのが原因。
;; インデントの空白文字列をdisplayプロパティで高さ1pxのspaceに置き換える。
;; @todo wrap-indentも修正すべき?
(defun my-org-indent--compute-prefixes-after ()
  ;; org-indent--text-line-prefixesはレベル毎のline-prefix。
  ;; org-indent--compute-prefixesがそれを計算した後ここが呼ばれる。
  (let ((prefixes org-indent--text-line-prefixes))
    ;; 各レベルのprefixを修正する。
    (dotimes (i (length prefixes))
      (let* ((space-str (aref prefixes i))
             (space-length (length space-str)))
        (when (> space-length 0)
          (aset prefixes i
                ;; テキストプロパティ
                ;; display (space :width i :height (1))
                ;; を追加する。
                ;; つまり、line-prefixとして空白文字ではなく高さ1pxのspace
                ;; が表示されるようになる。
                ;; これによって、(prefix以外の)行の高さが正しく反映される
                ;; ようになる。これまでは行が小さくなってもprefixの空白文
                ;; 字の高さより小さくならなかった。
                (org-add-props
                    space-str
                    nil
                  'display (cons 'space
                                 (list :width space-length
                                              ;; (list (* space-length
                                              ;;          (frame-char-width)))
                                       :height '(1))))))))))
(advice-add #'org-indent--compute-prefixes :after
            #'my-org-indent--compute-prefixes-after)

元々このorg-indentの空白文字を入れるという挙動は、org-modernに限らず他でも同様の問題を引き起こす可能性があるはずです。例えばfaceをカスタマイズして特定の行の文字サイズを小さくしたとき、文字は小さくなったのに行が一緒に小さくならなず無駄に空白が空くという問題が生じる可能性があります。

表の縦線部分をdisplay (space …)ではなくdisplay " "にする

先日書いた通りこの問題はdisplayプロパティにspaceではなく文字列を指定すれば発生しません。文字列にすると幅と高さを自由に指定できなくなってしまいますが、face属性に:height 0.1を設定することで極小文字にして回避します。

;; org-modern--tableを差し替える。
(defun org-modern--table ()
  "Prettify vertical table lines."
  (save-excursion
    (let* ((beg (match-beginning 0))
           (end (match-end 0))
           (tbeg (match-beginning 1))
           (tend (match-end 1))
           ;; Unique objects
           (sp1 (list 'space :width 1))
           (sp2 (list 'space :width 1))
           (color (face-attribute 'org-table :foreground nil t))
           (inner (progn
                    (goto-char beg)
                    (forward-line)
                    (re-search-forward "^[ \t]*|" (line-end-position) t)))
           (separator (progn
                        (goto-char beg)
                        (re-search-forward "^[ \t]*|-" end 'noerror))))

      ;; 横線を引く
      (goto-char beg)
      (when separator
        ;; overlineを引いて高さを縮める
        (when (numberp org-modern-table-horizontal)
          (add-face-text-property tbeg tend `(:overline ,color) 'append)
          (add-face-text-property beg (1+ end) `(:height ,org-modern-table-horizontal) 'append))
        ;; 横幅を1文字分確保する(縦線部分以外)
        (while (re-search-forward "[^|+]+" tend 'noerror)
          (let ((a (match-beginning 0))
                (b (match-end 0)))
            ;; TODO Text scaling breaks the table formatting since the space is not scaled accordingly
            (cl-loop for i from a below b do
                     (put-text-property i (1+ i) 'display
                                        (if (= 0 (mod i 2)) sp1 sp2))))))

      ;; 縦線を引く
      (goto-char beg)
      (while (re-search-forward
              "-+\\(?1:+\\)-\\|\\(?:^\\|[- ]\\)\\(?1:|\\)\\(?:$\\|[- ]\\)"
              end 'noerror)
        (let ((a (match-beginning 1))
              (b (match-end 1)))
          (cond
           ((and org-modern-table-vertical (or (not separator) inner))
            (add-text-properties
             a b
             `(;; vertical lineにspaceを使うとウィンドウ先頭でline-prefixが効かなくなる。
               ;;display (space :width (,org-modern-table-vertical))
               display
               " "
               face
               (:inherit org-table :inverse-video t)
               ))
            (add-face-text-property a b`(:height 0.1) 'append) ;;0.1の部分は,org-modern-table-verticalとしたいところだけどピクセル数で指定されるので無理。
            )
           ((and org-modern-table-horizontal separator)
            (put-text-property
             a b
             ;; vertical lineにspaceを使うとウィンドウ先頭でline-prefixが効かなくなる。
             ;;'display `(space :width (,org-modern-table-vertical))
             'display " "))
           (t (put-text-property a b 'face 'org-hide)))))
      )))

結果

修正後
図4: 修正後
2022-08-18

display spaceを併用するとウィンドウの先頭でline-prefixが効かなくなる件(Emacs Bug?)

org-modernを試したときに表の先頭が(org-indentによって)インデントされていないことに気がついた。(Emacs 28.1で確認)

ウィンドウの先頭部分が崩れている表
図1: ウィンドウの先頭部分が崩れている表

原因を調べたところ、org-modernに限らず次の条件で問題が起きることが分かった。

  • 行の先頭に対してline-prefixテキストプロパティとdisplayテキストプロパティの両方が指定されている
  • displayプロパティに(space …)を指定している
  • その行がウィンドウの先頭にある

この条件を満たすとき、なぜかline-prefixの効果が消えてしまう。

再現するコードは次の通り。

(progn
  ;; ウィンドウの先頭へ移動
  (goto-char (window-start))
  ;; line-prefixとdisplayの両方のテキストプロパティを持つテキストを挿入
  (insert (propertize "TEXT" ;;←この文字列はdisplayプロパティで置換される
                      'line-prefix "[PREFIX-STR]" ;;←行の前にこれが表示されるはず
                      'display '(space :width 1) ;;NG
                      ;;'display (svg-image (svg-create 10 10)) ;;OK
                      ;;'display "[DISPLAY-STR]" ;;OK
                      )))

displayテキストプロパティの値が(image …)の場合や単なる文字列の場合この現象は起きない。例えば単なる文字列の場合は[PREFIX-STR][DISPLAY-STR]と表示されるが、(space …)の場合は[PREFIX-STR]が表示されず1文字分の空白が表示されるだけとなる。

回避方法はちょっと思いつかない。いっそ表の部分はインデントを全部無効化するとか?

最初phscrollのせいかと思ったがそういうわけでは無さそうだ。

以前にもline-prefixでマウス入力の座標がずれる問題に遭遇したことがある。Emacsのソースコードを確認していないが、この辺りの処理には何らかの構造的な問題があるのかもしれない。私の経験的にもレイアウト処理というのはちゃんと設計しないと複雑怪奇なものになりがちだ。

それにしてもorg-modernの罫線の引き方、displayテキストプロパティの(space :width (1)) で幅1pxの空白を作って、faceに:inverse-video tを指定することで実現してるんだ! だからline-spacingがあっても隙間無く線が表示される。そんな方法考えもしなかった。

(insert
 ;; 1行目 赤い縦線にABC 行間は10
 (propertize "X"
             'display '(space :width (1))
             'font-lock-face '(:inverse-video t :foreground "red"))
 (propertize "ABC\n" 'line-spacing 10)
 ;; 2行目 赤い縦線にDEF
 (propertize "X"
             'display '(space :width (1))
             'font-lock-face '(:inverse-video t :foreground "red"))
 "DEF")

あー、透明な画像で1pxの空白を作れば回避可能かもしれない。でも全行に画像を挿入しまくるのもなぁ……。

(2022-08-27追記: org-modernでorg-indentを使っていると表のウィンドウ先頭部分がインデントされない問題は、displayテキストプロパティを" "にしてfaceの:heightを0.1にすることで回避した。org-modern–tableを色々といじると直せる。ちなみにこれとは別の話だが、org-indentを使っていると表の水平線の下に空白が空いてしまう問題は、org-indentが挿入する空白文字列の高さを小さくすることで回避できる。詳しくはorg-modernとorg-indentを併用したときの表の乱れを直すに書いた)

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 の形式を拡張できるかもしれないし、あるいは別に変数を用意しても良さそうだ。