バブちゃんへ贈る Emacs の歩き方

December 13, 2021

この記事は Emacs Advent Calendar 2021 の14日目の記事です．

はじめに #

Emacs を始めたての頃はパッケージ導入の際の設定は理解しないままネットからコピペすることが多いと思う．この記事では，パッケージ導入から自分に適した設定までの一連の動作を一人で行えるようになることに重点を置く．

タイトルにあるバブちゃんとは，Emacs の基本的な操作に慣れ始めて，コピペを駆使すればパッケージ導入を行うことができるようになった人を指す．いわばハイハイができるようになった状態である．この記事では，そんなバブちゃんが Emacs 内での二足歩行を会得する際の助けになるような情報提供を目指す．

記事の前半では便利な tips やパッケージの紹介を行い，後半では前半に紹介した内容を活用してパッケージの設定を行った実例を紹介する．

想定読者 #

息をするように C-b, C-f, C-n, C-p などの移動ができる
C-c, M-x などの基本的な表記を理解している
以下の記事で解説されている内容が5割くらい理解できていれば (たぶん) 大丈夫
- https://qiita.com/eggc/items/8722d8883ebf1d9446da

この記事で扱わないこと #

elisp 全般
パッケージの導入方法
setq や custom-set-variables 等を用いた変数の設定方法

tips #

ここではパッケージ導入とその設定を行う際に知っておくと役に立つ built-in 機能を紹介する．

パッケージ検索 #

M-x list-packages でインストール可能なパッケージ一覧を見ることができる．(package-archives の設定が済んでいる前提)

このバッファ内で iserch 等の検索をかければ気になるパッケージに出会える可能性がある．パッケージをクリックまたは RET すればパッケージの説明と，github上で管理されていればそのリンクを見ることができる．

パッケージの説明はパッケージファイルの冒頭に書かれている #

多くの場合，パッケージファイルの冒頭にパッケージの説明が書かれている．親切なパッケージでは推奨設定が記載されていることもある．

ユーザーオプションは `defcustom` で定義されている #

パッケージファイル内で grep すれば設定可能なオプションが見つかる．

以下の画像では consult-grep で集めた情報を embark-export で抽出している．このバッファで n/p を押すとファイルをまたいでプレビューしてくれるため，複数ファイルで構成されているパッケージをカスタマイズしたい時に便利．

関数や変数の定義へ `M-.` でジャンプ #

xref-find-definitions (M-.) でポイント下にあるシンボルの定義へとジャンプすることができる．

ジャンプした後に迷子にならないために #

ジャンプ前にどこにいたのか覚えておくのは至難の技だと思う．少なくとも私はジャンプした瞬間に全てを忘れてしまう．

そんな鶏のような人のために， Emacs には以下2種類の便利な機能が用意されている．

C-u C-SPC or (set-mark-command 4)
set-mark-command 自体は範囲選択でおなじみの C-SPC だが，これに prefix キー C-u を付けて実行するとジャンプ前のところに戻ってくれる．(ただし，移動は同じバッファ内に限る)．ちなみに，prefixとして C-u を入力すると関数には 4 が渡される．
Emacs には mark-ring というものがあり，そこにポイントの位置が保存されている．保存タイミングは C-SPC や前述の M-. が実行されたとき，他にも様々． C-u C-SPC を実行すると mark-ring を遡るようにしてポイントを移動してくれるという仕組み．

switch-to-prev-buffer
バッファの並び順で一つ前のバッファに移動するコマンド．定義ジャンプした際に別ファイルに飛ばされたら C-u C-SPC で帰ってくることはできない．そんなときは M-x switch-to-prev-buffer を実行すれば元の場所に戻ることができる．
実行しすぎて元いたバッファを通り過ぎた場合は M-x switch-to-next-buffer を実行すればバッファを進めることで帰って来ることができる．
私は C-x C-p, C-x C-p にバインドして使っている．
```
(global-set-key (kbd "C-x C-p") #'switch-to-prev-buffer)
(global-set-key (kbd "C-x C-n") #'switch-to-next-buffer)
```

`describe-*` を実行すればたいてい分かる #

歩き回っていると未知のものに多々遭遇する．そんなときは M-x describe-* を実行すれば Emacs さんが describe してくれる．

describe-variable: 変数の中身確認ならこれ
describe-function: 関数定義の確認ならこれ
describe-symbol: alias や macro はこっちで見つかることがある
describe-key: キーバインドに割り当てられたコマンドを調べたいときはこれ． describe-key の実行後に調べたいキーバインドを入力すると describe してくれる．

そもそも elisp が良く分からん #

*scratch* バッファ (lisp-interaction-mode) で C-j しよう．ポイントの直前のシンボルやS式を評価して，結果を下に表示してくれる．

Emacs の中を歩き回るときや新しい elisp を学ぶとき，理解できないものに多々直面する．そんなときに実行結果を確認しながら試行錯誤すれば理解の助けとなる．

lisp-interaction-mode 以外では C-j による結果の確認はできない．代わりに C-x C-e (eval-last-sexp) を実行しよう．結果は *Message* バッファに出力される．

エラー箇所を知りたい #

*Message* バッファにエラーは出るけど，それがどのタイミングで発生しているか分からないことがある．そんなときは M-x toggle-debug-on-error or (setq debug-on-error t) を実行しよう．エラーが発生したときに，その詳細な箇所を教えてくれる．

便利な外部パッケージ #

ここでは歩き回る際に便利なパッケージを紹介する．

Helpful #

describe-* 実行時に表示される情報がリッチになる．ドキュメントに加え，定義や reference も表示される．

command-log-mode #

実行したキーバインドとコマンドを表示してくれる．キーボードを触っていて「今なにが起こった？!」となることは多々ある．そんなときは M-x command-log-mode をオンにして M-x cml/toggle-command-log-buffer を実行すれば，実行したキーバインドとコマンドが表示されるバッファが開く．