以前「Emacs Lisp要素へのorg-modeリンクをエクスポートする」や「Emacs Lisp要素へのリンクをorg-modeに追加する」という記事を書きましたが、そこで書いた物を org-elisp-link.el として一つのEmacs Lispにまとめました。
misohena/org-elisp-link: Org-mode Link Types for Emacs Lisp Elements
同様の事をやるEmacs Lispはいくつか見かけましたが、エクスポートまでするのは見つかりませんでした。org-modeのリンクタイプはエクスポートを実装していないものが多い気がします。もちろんEmacs内での作業に役に立てばほとんどの場合それで十分なのですが、たまにエクスポートすると「あれ？」と思うことがあります。
Emacs Lispの言語要素(関数、変数、フェイス、ライブラリ)へのリンクをエクスポートしたいなんて人はそう多くは無いでしょう。誰得？ オレだよオレ、俺得。私はこのブログで関数名や変数名を書くことがありますし、自分で見返したときにいちいちEmacsで定義を見に行くよりもブラウザでソースコードへ飛べた方が便利なケースもあります(常にとは言わない)。
READMEにも書きましたが、このEmacs Lispを使うと次のような記述が可能になります。
[[elisp-function:track-mouse]]関数は[[elisp-library:subr;line=4530][subr.elの4530行目]]に定義されています。[[elisp-variable:track-mouse]]という変数も別に定義されています。[[elisp-function:track-mouse]]関数は例えば[[elisp-function:artist-mouse-draw-continously;library=artist]]で使われています。
もちろんC-c C-o (org-open-at-point)で飛べますし、C-c l (org-store-link)でのリンクストア操作にも対応しています。
エクスポートについては以前「Emacs Lisp要素へのorg-modeリンクをエクスポートする」に書いたとおり、現在インストールされているソースコードの中からファイル名と行番号を探し、それに対応するWeb上のコードブラウザへのURLを作成しています。実際に上をエクスポートすると下のようになります。
<p> <code><a href="https://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/subr.el?h=emacs-29.2#n4530">track-mouse</a></code>関数は<a href="https://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/subr.el?h=emacs-29.2#n4530">subr.elの4530行目</a>に定義されています。<code><a href="https://git.savannah.gnu.org/cgit/emacs.git/tree/src/keyboard.c?h=emacs-29.2#n12850">track-mouse</a></code>という変数も別に定義されています。<code><a href="https://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/subr.el?h=emacs-29.2#n4530">track-mouse</a></code>関数は例えば<code><a href="https://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/textmodes/artist.el?h=emacs-29.2#n4899">artist-mouse-draw-continously</a></code>で使われています。 </p>
以前書いたEmacsをアップグレードしたときにエクスポート結果が変わってしまう問題に対処するため、いくつかオプションを指定出来るようにしました。
[[elisp-function:tetris-start-game;line=600;library=tetris;emacs-version=29.2][Emacs 29.2におけるtetris.el内の600行目にあるtetris-start-game関数]]
このように書けばEmacs 29.2におけるtetris.el内の600行目を指すURLが必ずエクスポートされます。まぁ、常にこのような記述をすべきだとは思いませんけど。
リンクのdescription部分を書いていないときに見た目が酷いことになるので、 :activate-function を使って、シンボル名以外の部分を隠す機能も用意しておきました。前から [[elisp-function:track-mouse]] と書くと elisp-function: の部分が邪魔だなぁと思っていたのでした。もちろんdescription部分も含めて [[elisp-function:track-mouse][track-mouse]] と書けば良いのですが、情報が重複してて嫌だなぁと思っていたのでした。
その他README.org(日本語)に色々説明を書いたので詳しくはそちらで。
以下メモ:
;や&を含む関数名は存在する(c-forward-to-nth-EOF-;-or-}やc-semi&comma-inside-parenlist)。もちろん<は>はある(string<とか)。\を含むものは見当たらない。ちゃんとエスケープできるようにした。
org-link-parametersの :activate-func は使い方が難しいのだけど(特に効果を打ち消す方。変更フックでは検出できないケースもあるので)、すでに隠している部分を少し広げるくらいなら問題ないと思う。
find-funcライブラリの中身を見てEmacsが各種定義場所を探すときに何をしているのか色々勉強になった。もうちょっと直交性がある感じで綺麗に書いて欲しい。関数がnilで変数がdefvarでフェイスがdeffaceとか終始そんな感じ。いや、そもそもライブラリ名がfind-funcだった。
find-function-regexp-alistが興味深い。その正規表現(find-function-regexpとか)を見ると、思っていたより色々関数や変数等を定義する書式があることが分かる。ただ、この正規表現は%s部分に名前を入れて関数や変数等の定義を探すためのものなので、今回の用途に直接使うのは難しい。
結構頑張ってdefcustomを沢山用意した。
先日Emacs Widget Libraryの勉強をしたのでdefcustomの:type部分を書くのがとても楽になった。
バッファ内オプション( #+HTML_LINK_???? みたいの)の処理とテンプレート文字列( <a href="{{{URL}}}">{{{CONTENTS}}}</a> みたいなの)の処理は以前org-geolinkを作ったときのものがわりとよく出来ていたのでそのまま持ってきた。バッファ内オプションを増やす方法はもうちょっとマシな方法がないのだろうか。それほどちゃんと調べていないのでよく分からない。
ELPAのURL変換はもうちょっと何とかならないだろうか。それと私はEmacs設定ディレクトリ(Gitで管理している)のsubmoduleにしているものも多いので(自分の作ったものは特に)、それを検出してGitHubへのURLを生成したい。
elisp-functionとelisp-funのどちらがいいか。elfunというのもあり？ elvar、elface、ellib。