#22 auto-insert-mode でファイル新規作成を迅速に (Software Design 2016年2月号掲載記事) Emacs yatemplate yasnippet インストール 設定 使い方

今回は新規ファイルの作成を迅速に行う方法をお話します。
ここで用語を明確に定義させてください。
yasnippetの解説において「テンプレート」と「スニペット」を同じ意味の言葉として使ってきましたが、今回は明確に区別することにいたします。
どちらも定型文、とくに穴埋めが含まれる文字列の雛型を意味しますが、対象が異なります。
テンプレートとは、ファイル全体の雛型で新規作成時に予め展開(挿入)されるべき内容を意味することにします。
今回は「テンプレート」が話題の中心になります。
スニペットとは、任意のタイミングで展開される定型文を意味することにします。
当然、yasnippetのスニペットは「スニペット」であり、スケルトンの類もスニペットになります。
テンプレートはスニペットを使って定義されるので、スニペットの使用例のひとつと言えます。

新規ファイルのテンプレートを扱うには、Emacs標準のauto-insert-modeを使います。
グローバルマイナーモードなので、以下の1行を設定に加えればテンプレートが使用可能になります。

(auto-insert-mode 1)

テンプレートを定義する変数auto-insert-alistには予め以下のテンプレートが用意されています。

• C / C++ヘッダ
  
• C / C++コード
  
• HTML
  
• LaTeX
  
• Ada
  
• Man page
  
• elisp
  
• Texinfo
  

Emacsユーザにとって一番身近な例はelispのヘッダではないでしょうか。
elispを公開する場合、セミコロンの数も合わせて以下のテンプレートに従うよう規約に定められているのですが、毎回手作業で入力するのは馬鹿げています。
そういう決まり文句は*.elを新規作成したときにauto-insert-modeによって自動的に入力されるのが一番です。

;;; ファイル名 --- 説明

;; Copyright (C) 年 著者

;; Author: 著者 <メールアドレス>
;; Keywords: キーワード

;; This program is free software; you can redistribute it and/or modify
;; (略)

;;; Commentary:

;;; Code:

(provide 'ファイル名から拡張子を取り除いた文字列)
;;; ファイル名 ends here

auto-insert-alistは各要素が

(条件 . アクション)
あるいは
((条件 . 説明) . アクション)

の形をしたリストです。
条件はファイル名の正規表現かメジャーモードです。
また、自動挿入される内容に対して説明文をつけることもできます。
デフォルトの設定における条件・説明を抜き出すと、このようになります。

(("\\.\\([Hh]\\|hh\\|hpp\\)\\'" . "C / C++ header")
 ("\\.\\([Cc]\\|cc\\|cpp\\)\\'" . "C / C++ program")
 ("[Mm]akefile\\'" . "Makefile")
 html-mode plain-tex-mode bibtex-mode latex-mode
 ("/bin/.*[^/]\\'" . "Shell-Script mode magic number")
 ada-mode
 ("\\.[1-9]\\'" . "Man page skeleton")
 ("\\.el\\'" . "Emacs Lisp header")
 ("\\.texi\\(nfo\\)?\\'" . "Texinfo file skeleton"))

アクションはスケルトン、自動挿入されるファイルのファイル名、あるいは実行される関数を指定します。
ベクタ(配列)を指定すれば立て続けにアクションを実行できます。

auto-insert-modeを愛用するようになると、当然auto-insert-alistを変更せざるを得なくなります。
多くの場合はauto-insert-alistに新しい設定を追加することになると思いますが、それは次節に回します。
ここではauto-insert-alistにすでに登録されている内容を変更する方法です。
実際デフォルトのauto-insert-alistに登録されているEmacs Lisp Headerはスケルトンでありながらも出来がよいからです。
しかしながら、*.elを新規作成するたびにわざわざEmacs Lisp Headerを展開しますかと聞かれるのは煩わしいものです。
ヘッダが要求されるのはあくまでも公開用elispのみであり、個人設定では不要です。
多くの場合、新規作成されるのは個人設定ファイルです。
そこでEmacs Lisp Headerを展開するのを「*.el」から「src/*.el」に変更し、公開用elispはsrcディレクトリに置けば解決できます。

(require 'autoinsert)
(dolist (x auto-insert-alist)
  (when (equal "\\.el\\'" (car-safe (car x)))
    (setcar (car x) "/src/.+\\.el\\'")))

この設定内容を詳しく説明するのは少し難しいですが、setcar関数によって auto-insert-alist 中の "\\.el\\'" をピンポイントで "src.+\\.el\\'" に変更してします。

<f1> v auto-insert-alistでその値を表示してみると、紙面に掲載しきれないほどとてつもなく長くなります。
そのため前節では概略を説明するにとどめました。
auto-insert-modeを実用化するにあたってはauto-insert-alistを直接変更するのは賢明ではないからです。
auto-insert-alistで指定できるのは、スケルトン・穴埋めなしテンプレートファイル・関数のいずれかであり、どれも中途半端です。
スケルトンは表現力こそあれど可読性が低く、スニペット展開機能としてyasnippetに取って代わられました。
テンプレートファイルを指定しても、そのファイルの内容を字面通り挿入することしかできません。
関数定義は一般ユーザには荷が重すぎます。
そのままでは、せいぜい穴埋めなしテンプレートファイルで我慢するのが精一杯でしょう。

もしyasnippetファイルをテンプレートにできればとても嬉しいのではないでしょうか。
auto-insert-alistでアクションにベクタを指定すれば立て続けにアクションを実行できるので、yasnippetファイルの内容を挿入してからそれをyasnippetスニペットとして展開すれば可能です。
ファイル名に規約を設ければauto-insert-alistの設定も自動化できるでしょう。
ユーザ側がauto-insert-alistをいじらないでyasnippetをテンプレートにしてくれるパッケージはないでしょうか？
それを行うのがMELPAにあるyatemplateパッケージです。
M-x package-install yatemplateでインストールしてください。

yatemplateをインストールすると ~/.emacs.d/templates 以下に配置しているyasnippetファイルをテンプレートファイルとしてauto-insert-alistに登録します。
ファイル名は「数字 コロン 正規表現」のように指定します。
たとえば、Pythonのテンプレートならば以下のようになります。

00:test_.*.py
01:.*.py

数字は若い方が優先度が高くなります。
内部的には

(".*.py" . ACTION)
("test_.*.py" . ACTION)

の順にauto-insert-alistに登録されます。

yatemplateを使うには以下の設定をします。

(yatemplate-fill-alist)
(auto-insert-mode 1)

新しくyatemplateファイルを追加すると、自動的にauto-insert-alistに反映されます。
これでauto-insert-alistをいじることなく手軽に高機能テンプレートを設定できるようになりました。