Help us understand the problem. What is going on with this article?

Emacs入門から始めるleaf.el入門

背景

leaf.elの日本語情報は比較的充実していると思いますが、やはり多少の背後情報が必要です。Emacsの設定はどのファイルで行なうのか、マクロとは、バイトコンパイルとは、、、
leafが設定の簡略化をしてくれるとはいえ、基本的なEmacsのしくみについて知っておく必要があります。

この記事では初期状態のEmacsからleaf.elの導入と利用までを解説します。この記事を読んだ後なら、下記のleafの記事をスムーズに読むことができ、Emacsの動作をあなたの好きなようにカスタマイズできるようになると思います。

また、leafも一定の知名度を得てきたようで、レポジトリは記念すべき100スターを達成し、MELPAでは3万ダウンロードを達成しました!

気に入ってもらえればレポジトリのスターとleafのダウンロードをしていただければ泣いて喜びます!

Emacsのインストール

まずEmacs-26.3をどうにかしてインストールします。もしEmacs-22とかいう化石を使っている場合はすぐEmacs-26.3に移行してください。(自戒)

leaf.elは24.4から動きますが、とても便利なleaf-convert.elはEmacs-26.1を要求します。

Emacs-26.1とEmacs-26.2はELPAからのダウンロードに問題があります。結局Emacs-26.3を使うしか選択肢がありません。

各OSでのインストール方法は他の記事に譲り、下のような出力が得られたら次に進みます。

$ emacs --version
GNU Emacs 26.3
Copyright (C) 2019 Free Software Foundation, Inc.
GNU Emacs comes with ABSOLUTELY NO WARRANTY.
You may redistribute copies of GNU Emacs
under the terms of the GNU General Public License.
For more information about these matters, see the file named COPYING.

もし M-x leaf-available-keywords と記事に書かれていたときにどういう意味が分からない場合は、ここでEmacsに慣れておいた方が良いかもしれません。少し鬼軍曹1な気はありますが、「Emacs教習所に行ってきた(チートシート付き) - Qiita」が参考になるかもしれません。

Emacs設定ファイル

init.elの作成

Emacsの設定ファイルは ~/.emacs.d/init.el です。既にディレクトリがある場合は ~/.emacs.d/~/.emacs.d.old などにリネームした上で新しくディレクトリを作成してください。~/.emacs.d/init.el にファイルを作成し、その先頭にleafのインストールコードを貼り付けます2

なお、現在では leaf のimenuインテグレーションのおかげでファイル分割しないinit.el管理がトレンドです。

;;; init.el --- My init.el  -*- lexical-binding: t; -*-

;; Copyright (C) 2020  Naoya Yamashita

;; Author: Naoya Yamashita <conao3@gmail.com>

;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; My init.el.

;;; Code:

;; this enables this running method
;;   emacs -q -l ~/.debug.emacs.d/{{pkg}}/init.el
(eval-and-compile
  (when (or load-file-name byte-compile-current-file)
    (setq user-emacs-directory
          (expand-file-name
           (file-name-directory (or load-file-name byte-compile-current-file))))))

(eval-and-compile
  (customize-set-variable
   'package-archives '(("org"   . "https://orgmode.org/elpa/")
                       ("melpa" . "https://melpa.org/packages/")
                       ("gnu"   . "https://elpa.gnu.org/packages/")))
  (package-initialize)
  (unless (package-installed-p 'leaf)
    (package-refresh-contents)
    (package-install 'leaf))

  (leaf leaf-keywords
    :ensure t
    :init
    ;; optional packages if you want to use :hydra, :el-get, :blackout,,,
    (leaf hydra :ensure t)
    (leaf el-get :ensure t)
    (leaf blackout :ensure t)

    :config
    ;; initialize leaf-keywords.el
    (leaf-keywords-init)))

;; ここにいっぱい設定を書く

(provide 'init)

;; Local Variables:
;; indent-tabs-mode: nil
;; End:

;;; init.el ends here

init.elのバイトコンパイル

init.elのバイトコンパイルは以下のように行ないます。バイトコンパイルによる実行速度への寄与は少ないですが、コンパイラのワーニング(未定義変数の参照、未定義関数の評価など)を受け取るためにもバイトコンパイルをした方が良いです。ただ、バイトコンパイルした .elc とバイトコンパイル前の .el.elc の方が優先度が高いので、init.elを編集した後は必ずバイトコンパイルを忘れないようにしましょう。

初回にはleafやhydraのインストールが入るのでログが大量に流れます。

コンパイラのワーニングが見づらいようでしたら、もう一度実行することをお勧めします。出力がなければ正常終了であり、ワーニングなしでバイトコンパイルできたことを示します。

$ cd .emacs.d
$ emacs --batch -f batch-byte-compile init.el 
Importing package-keyring.gpg...
Importing package-keyring.gpg...done
Contacting host: orgmode.org:443
Contacting host: orgmode.org:443
Contacting host: melpa.org:443
Contacting host: elpa.gnu.org:443
Package refresh done
Setting ‘package-selected-packages’ temporarily since "emacs -q" would overwrite customizations
Setting ‘package-selected-packages’ temporarily since "emacs -q" would overwrite customizations
Contacting host: melpa.org:443
Generating autoloads for leaf.el...
Generating autoloads for leaf.el...done
Wrote /home/conao/.emacs.d/elpa/leaf-20200415.417/leaf-autoloads.el
...
Wrote /home/conao/.emacs.d/elpa/blackout-20200404.1550/blackout-autoloads.el
Checking /home/conao/.emacs.d/elpa/blackout-20200404.1550...
Compiling /home/conao/.emacs.d/elpa/blackout-20200404.1550/blackout-autoloads.el...
Compiling /home/conao/.emacs.d/elpa/blackout-20200404.1550/blackout-pkg.el...
Compiling /home/conao/.emacs.d/elpa/blackout-20200404.1550/blackout.el...
Done (Total of 1 file compiled, 2 skipped)

$ emacs --batch -f batch-byte-compile init.el

Emacsの起動

コマンドラインからEmacsを起動します。

emacs

M-x leaf-available-keywords を実行して、 leaf の使えるキーワードを表示できるはずです。

378842b3-64d0-4200-9d8f-3953f002bce6.gif

便利パッケージのインストール

leaf.elを使うにあたって、相性の良いパッケージがいくつかあります。早速leafを使ってインストールしてみましょう。

先程の ;; ここにいっぱい設定を書く の場所に以下の設定を書きます。

(leaf leaf
  :config
  (leaf leaf-convert :ensure t)
  (leaf leaf-tree
    :ensure t
    :custom ((imenu-list-size . 30)
             (imenu-list-position . 'left))))

(leaf macrostep
  :ensure t
  :bind (("C-c e" . macrostep-expand)))

迷子防止のために今回だけinit.elの全文を貼ります。一緒のコードになりましたでしょうか?

;;; init.el --- My init.el  -*- lexical-binding: t; -*-

;; Copyright (C) 2020  Naoya Yamashita

;; Author: Naoya Yamashita <conao3@gmail.com>

;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; My init.el.

;;; Code:

;; this enables this running method
;;   emacs -q -l ~/.debug.emacs.d/{{pkg}}/init.el
(eval-and-compile
  (when (or load-file-name byte-compile-current-file)
    (setq user-emacs-directory
          (expand-file-name
           (file-name-directory (or load-file-name byte-compile-current-file))))))

(eval-and-compile
  (customize-set-variable
   'package-archives '(("org"   . "https://orgmode.org/elpa/")
                       ("melpa" . "https://melpa.org/packages/")
                       ("gnu"   . "https://elpa.gnu.org/packages/")))
  (package-initialize)
  (unless (package-installed-p 'leaf)
    (package-refresh-contents)
    (package-install 'leaf))

  (leaf leaf-keywords
    :ensure t
    :init
    ;; optional packages if you want to use :hydra, :el-get, :blackout,,,
    (leaf hydra :ensure t)
    (leaf el-get :ensure t)
    (leaf blackout :ensure t)

    :config
    ;; initialize leaf-keywords.el
    (leaf-keywords-init)))

;; ここにいっぱい設定を書く

(leaf leaf
  :config
  (leaf leaf-convert :ensure t)
  (leaf leaf-tree
    :ensure t
    :custom ((imenu-list-size . 30)
             (imenu-list-position . 'left))))

(leaf macrostep
  :ensure t
  :bind (("C-c e" . macrostep-expand)))


(provide 'init)

;; Local Variables:
;; indent-tabs-mode: nil
;; End:

;;; init.el ends here

編集後にはバイトコンパイルを忘れないでください。バイトコンパイルが終わったらEmacsを再起動します。

leaf-convert

leaf-convertはプレーンなElispやuse-packageからleafへの変換機能を提供します。目玉機能は2つです。

  • M-x leaf-convert-replace-pop, M-x leaf-convert-replace-region

    選択したS式をleafブロックに変換し、 M-x leaf-convert-replace-pop は別バッファーに表示します。M-x leaf-convert-replace-region は変換したleafブロックで置換します。

    leafの第1引数は prog1 の第1引数に渡すことで指定できます。gifではひとつのS式しか選択していませんが、複数S式を同時に選択して変換することも可能です。

    1910e495-fca3-42b1-8240-d9af77bef202.gif

  • M-x leaf-convert-insert-template

    package.el が持っている情報からよさげなleafブロックを生成し、挿入します。ただ、自動生成された :after キーワードと引数については削除した方が事故が少ないかもしれません。

    c27d723a-3ad9-434c-8419-c403e00e14fb.gif

leaf-tree

leaf.elで書かれたinit.elを開き、 M-x leaf-tree-mode を実行することでクリックできるサイドバーを表示します。サイドバーはリアルタイムに更新され、現在のポインターがあるアイテムがハイライトされます。

サイドバーのアイテムをクリックすると、そのleafブロックにジャンプします。

10c8a24e-cd57-4909-bf09-8ff388b4d14d.gif

macrostep

leafに限らず、マクロを1ステップごとに展開することができます。

標準キーバインディングでは、展開したいS式で C-c e すると macro-step-mode という特殊なモードになります。バッファは読み取り専用となり、 np でさらに展開するS式を選び、 e を押すと展開されます。c を押すと展開を元に巻き戻すことができます。 C-gmacro-step-mode から抜けることができます。

この macrostep による確認はleafで何かうまくいかないときに最初に取る行動です。leafに何を入力したら、どんなS式が生成されるかを意識するのは重要です。

leafは単なるマクロであり、雑多で典型的なS式を自動生成するためのパッケージにすぎないからです。

a7661d45-1eac-4b24-8967-bb0738986037.gif

実践的なあれこれ

変数の変更について

パッケージで公開されている変数の変更には、全ての場合について setq ではなく custom-set-variables で設定するべきです。ネットを検索すると以下の記事があり、公開順から「結局、setqを使う方が良い選択だ」となってしまっています。

しかし時代は変わりました。「ユーザーが変更できる変数」はほとんどの場合で defcustom で宣言され、defvar で宣言されたものは「パッケージの内部変数である」という慣習を多くのパッケージ開発者が守っています。

require 前に値をセットしておくことでパッケージの動作が変更されるのは悪い設計であり、そのような設計を現在あえて採用するパッケージはありません。

また、実際には custom-set-variables での変更は最終的に set を実行するので defvar で宣言された変数も問題なく変更できます。

ということで常に custom-set-variables を使うべきであり、leafでは :setq ではなく、 :custom を使うほうが良いということになります。

問題はcustomがinit.elに次のようなダンプを出力する点です。このダンプにより、leafの :custom で管理している場合、2箇所を修正する必要が生じます。

(custom-set-variables
 ;; custom-set-variables was added by Custom.
 ;; If you edit it by hand, you could mess it up, so be careful.
 ;; Your init file should contain only one such instance.
 ;; If there is more than one, they won't work right.
 '(ag-highligh-search t t)
 '(ag-reuse-buffers t t)
 '(ag-reuse-window t t)
 ;;...
 )

この動作については custom-file という変数を変えれば出力先を変更でき、そのファイルを load しないことで単に無視することができます。

そのため、次のような設定を書いておくことはleafの全ユーザーに勧められます。

(leaf cus-edit
  :doc "tools for customizing Emacs and Lisp packages"
  :tag "builtin" "faces" "help"
  :custom `((custom-file . ,(locate-user-emacs-file "custom.el"))))

なお、動的な値をleafで設定するには上記のようにバッククオートとカンマを使うことによって実現します。

パッケージインストーラについて

基本的に M-x leaf-convert-insert-template の出力を参考にします。MELPAかELPAに存在するパッケージは自動的に :ensure t が展開されます。:ensure はpacakge.elを使用してパッケージをインストールする設定です。

存在しないパッケージの場合は、 :el-get {user}/{repo} が展開されるので、 GitHubにある場合{user} を調べて置換するだけで設定が完了します。例えば、point-undoは emacsmirror/point-undo にあるので、 emacsmirror を追加するだけで大丈夫です。

しかし、 GitLabにある場合 、きちんとリストにしてgitのurlを指定する必要があります。これはleafの使い方ではなく、どちらかというとel-getの使い方です。

f5d42290-fd35-4675-bc6e-c8fad8c39097.gif

とりあえず:config

leafには与えられたS式をそのまま展開するキーワードがあり、 :preface, :init, :config の3種類が用意されています。それぞれ以下の場所に展開されます

  • :preface:if, :when, :unless の前
  • :init:if, :when, :unless:require の間
  • :config:require の後

3種類ありますが、基本的には :config を使用します。:config のS式はそのまま展開されるので、最初にleafを使う際はとりあえず :config に書いておくのは良い方針だと思います。

なお、leaf-convertはleafからleafへの変換も可能なので、変換してみると、よりよいキーワードを使ったleafに変換してくれる可能性もあります。

:customnil を設定する設定の変換結果は、ただのリストになってしまい、手で直す必要がありました。これは難しい問題ですが、将来的に解決したい問題ではあります。

85bae766-658d-42b8-a463-bf6cbd804e5f.gif

leaf-convertについて

leaf-convertを手に入れたおかげで、use-packageの設定例があればleafに変換できるようになりました。例えば Emacsモダン化計画 -かわEmacs編- - コードが読みやすいテーマ を参考にして、下記のuse-package設定例があるとします。

(use-package doom-themes
  :custom
  (doom-themes-enable-italic t)
  (doom-themes-enable-bold t)
  :custom-face
  (doom-modeline-bar ((t (:background "#6272a4"))))
  :config
  (load-theme 'doom-dracula t)
  (doom-themes-neotree-config)
  (doom-themes-org-config))

この場合、コード貼り付け、範囲選択、 M-x leaf-convert-region-replace を実行することでleafに変換できます。use-package を一度展開する必要があるので、 use-package をインストールする必要があることに注意する必要があります。

ここで注目したいのは、これまでleaf移行で鬼門となっていた :custom:custom-face の引数の微妙な違いをleaf-convertに任せることができるようになった点です。

ただ、 :custom-face の変換結果の quote は見た目を気にすると、手で直す必要があります。これも難しい問題ですが、将来的に解決したいです。

64ee7df6-6191-46e2-aa4a-dc005e1f48c7.gif

まとめ

空のinit.elを作るところからleafの入門記事を書きました。leafを使うことによってEmacsのパッケージ設定を簡潔に宣言的に行うことができ、init.elの簡略化を実現できます。

また高速化についてはあまり意識していなかったのですが、実際のところleafに移行したことで高速化したことが複数人から報告があります。

    • use-package.elからleaf.elに移行した

      • 移行しただけでEmacsの起動時間が半分になった
        • use-package.elでは:defer tで遅延読み込みの指定がいるが、 leaf.elではデフォルトで遅延読み込みなのも効いていそう
        • use-package.elは起動時間の統計をとるなどリッチな機能を持っており、 そもそも遅いのも効いていそう
        • 詳細な原因調査はしていない
        • な に も し て な い の に Emacs が は や く な り ま し た
  • 私の.emacs.dをelpaをgit管理下に入れる気の狂った管理方法からleafに移行させました

    起動が早くなった気がします
    init-loaderをやめたからなのかわかりませんが,何故か起動が早くなった気がします.

参考として私のinit.elを読み込んだ場合、223パッケージ(elpaディレクトリには archivegnupg ディレクトリがあるのを忘れていた)インストールされたEmacsを4.2秒で起動できています。 HDDの環境なので、測定には悪条件ですが5秒未満なら十分に耐えられます。

bbac83c9-1266-48e2-8e2b-73b81e7accc6.png

これはleafが prog1 に展開されて、use-packageのように require を標準では展開しないからだと思われます。

use-packageが作られた当時はきちんとautoloadをパッケージ開発者が書いていなかったので require に展開することが求められていましたが、現代では善いパッケージ作法が広く知られているので問題はありません。


最後にpatreonの宣伝をします。

私はleaf.elやleaf-keywords、leaf-tree、leaf-convertといったleaf関連のEmacsパッケージ、他にもseml-modeやpppといったEmacsパッケージを書いています。作成した全てのパッケージと管理を手伝っているパッケージとリンクについてはEmacswikiのページ、アクティビティに関してはGitHubのユーザーページを参照して頂ければと思います。

Screenshot_2020-04-16_05-42-42.png

支援を頂くことで、これまでよりも気軽にオライリーの本をポチることができ、バイトの時間を減らしコーディングの時間を増やすことができます。

また、去年から先週までpatreonになることのメリットが全くなかった;;のですが、さすがに申し訳なくなってしまったので、これまでGitHubのconao3/dotfilesで公開していたdotfilesをプライベートに設定し、patreon限定でダウンロードできるようにしました。

ぜひ下記URLからご支援いただければと思います。よろしくお願いします!

https://www.patreon.com/conao3

Footnotes

1 : 実際に鬼軍曹.elというパッケージがあり、インストールすることで軍曹の指導を受けることができる。

2 : leafのインストールコードには書いてませんが、別途 user-emacs-directory の設定を加えました。理由はコメントのような起動方法ができるからです。参考ブログ: Emacsでお試しinit.elの指針 - peccu.hatenablog

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした