Emacsカスタマイズ入門(Emacsをsetqする方法)

目次

本資料のライセンス

• ライセンスはOPLに従います。 OPL日本語訳(参考)

本資料のめざすところ

• なるべく例を多く使います
• Emacsのカスタマイズを行なうための基本的な事柄を解説します(後で応用がきくように)

  概要

  Emacsを自分流にカスタマイズすればプログラミングやメール、Webブラウジ ング等、最高の環境を手に入れることができます。しかし、Emacsに新しいソ フトウェアを追加したりカスタマイズするためにはelispの基礎知識が必要に なる場面も多く、ソフトウェアの追加を躊躇される方もいらっしゃるようです。

  Emacsカスタマイズに必要な最低限のelispの知識や、Emacsの設定ファイル(.emacsファイル)で発生するエラーの対処方法などを中心に解説したいと思います。

Emacsをカスタマイズしよう

Emacsってどんなもの？

世間ではテキストエディタということになっていますが、ただのエディタではありません。

• Emacs lisp(elispともいう)で動いています。
• 日常的な操作のいろんなところでelispが顔を出します。
• エディタとして使うならelispの「さわり」だけを知ればより便利に使えます。
• elispで書かれたアプリケーションを追加することで、メール・Webブラウジング等にも使えるようになります。

カスタマイズって何？

• 一言で言えば「Emacsを自分に会うようにカスタマイズする」でしょう。

• 他にもelispアプリケーションをインストールすることもカスタマイズといえるかもしれません。

  ※Emacsをカスタマイズするのとelispアプリケーションを作るということの境目は特に無いと考えて良いでしょう。(但し作ったアプリケーションを配布しようとすると少し事情が変ってきます。この資料では扱いません)

なぜカスタマイズするのか？

• 人それぞれ好みが違うからだと思います。

  例えば、「なんで、ここはこう動いてくれんのや!」という場面があるたびにカスタマイズし、違和感がなくなるまで続けていけばいいのです。

Emacsのカスタマイズ手段

要はEmacsを自分の使いやすいものにできればいいのです。 どんな手段があるのでしょうか？

• .emacsファイルの変更(一番オーソドックスなやりかた。実はこれだけではない)
• アプリケーションのインストール(一般的には.emacsの変更をともなうことが多い)
• customize機能を使う
• アプリケーションを作る!(メジャーモード、マイナーモードを作るなども含む)

.emacsの編集するために知っておきたい知識

Emacsの始動

Emacsが始動する時のelispファイルの読み込み順について解説します。これにより、.emacsの位置付けがわかるでしょう。

ロード順

Emacsは始動時に、startup.elというファイルをロードして実行します。以下はstartup.elでの処理内容です。

※ ここでは GNU Emacs 20.6 の動作を例として挙げています。XEmacs等では少し違うかもしれません。

1. ロードパスload-pathにある各ディレクトリにおいてsubdirs.elを実行する
2. LANG等の環境変数から言語環境・端末のコーディングシステムを設定する
3. ウィンドウシステムを利用している場合はウィンドウシステムに関係している初期化をする
4. 初期化オプションを処理する
5. 必要ならば、ウィンドウフレームとフェイスを初期化する
6. site-start.elをロードする
7. ~/.emacsをロードする(コマンド行で-qや-batchが指定されていない場合のみ)
8. 以下、長くなるので略(コマンドラインスイッチ等の処理も行なう)

.emacsについて

.emacsはユーザー毎の設定を記述するのを目的としたファイルです。

• XEmacs,Meadow,GNU Emacs等で共通して参照されるので、設定が共有可能です。
• customize機能でカスタマイズした情報も保存されます。(custom-set-variablesという行から始まる部分)

最低限のelispの知識

• S式
  • (+ 1 2)のような式のこと
  • elispのソースはコメントを除いて全てS式です。
  • S式は悪名高い'('と')'のネストした表現で記述されます。
  • ソースファイルに複数のS式が並んでいる場合は上から順に実行されます。(lispでは評価するといいます)

  • 代表的なS式の表記は

    ( 関数 引数1 引数2 ... )

    のような形式です。

  ; コメント
  ; (1 + 2) * 3 を実行する式
  (* (+ 1 2) 3)
  

• シンボル
  • シンボルはlisp特有のもので、C言語でいう識別子のようなものです。
  • シンボルには文字列や値、リスト、関数など、なんでもバインドできます。
  • シンボルには 空(バインドされていない)という状態があります。

  ; シンボルの例
  abc
  this-is-a-symbol
  

• tとnil

  特別なシンボルです。(値を変更することはできません。)

  tは真、nilは偽 を表わすのに使われます。(if 等の評価値や 真偽値を返す関数等)

  elispアプリケーションでは、機能をon/offする変数に t か nil を入れるようになっているものが多いです。

• 代入(setq)

  変数に値をセットする最も一般的な方法です。(lispではシンボルにバインドすると言う)

  • 表記方法

    (setq シンボル 式) ※ 第一引数は評価されません。

  ; シンボル a に 計算結果をバインドする
  (setq a (+ 1 2))
  ; シンボル this-is-a-symbol に nil を代入する
  (setq this-is-a-symbol nil)
  

• load

  指定ファイルをロードして評価します。

  ; t.el をロード・評価します。
  (load "t.el")
  

customize機能を使ってみる

customize機能とは

Emacsに関係するユーザー設定をメニューで変更できるものです。

ほとんどのアプリケーションは この customize を利用して代表的な設定項目を変更できるようになっています。

• Emacsの設定をメニューで対話的に変更できる機能です。
• 設定項目とEmacsの変数は1対1に対応しています。
  • ※内部的な仕組

    defcustom関数で作った変数には、(カスタマイズグループ名、設定されるべき値の型、値の取るべき範囲、デフォルトの初期値)などの情報が指定されているため、Emacsはその情報を利用して対話的なインターフェースを作ることができます。

customize機能の起動方法

• customize機能

  customize機能のトップ画面を生成する

  M-x customize
  

• customize-group機能

  指定カスタマイズグループのトップ画面を生成する

  M-x customize-group カスタマイズグループ名
  

• customize-apropos機能

  指定キーワードを含む設定項目を抜き出した画面を生成する

  M-x customize-apropos キーワード
  

カスタマイズ変数値を変更する場合の注意

カスタマイズ変数は必ずしもcustomize機能から対話的に設定しなくても良いのです。setqを使って直接、変数を変更することができます。

但し、注意しなければならないこともあります。

カスタマイズ変数の挙動

カスタマイズ変数に関連する挙動は次の通りです。

• defcustomで定義が評価された時点で既にそのシンボルが空でなければ、初期値が適用されます。
• customize機能を使って生成されるcustom-set-variables関数は常にシンボル値を上書きします。

例

• test-varはnilとなります

  (defcustom test-var nil
    "A variable for test"
    :type 'boolean
    :group 'test)
  

• test-varはtとなります

  (setq test-var t)
  
  (defcustom test-var nil
    "A variable for test"
    :type 'boolean
    :group 'test)
  

• test-varは値が更新されてnilとなります

  (setq test-var t)
  
  (defcustom test-var nil
    "A variable for test"
    :type 'boolean
    :group 'test)
  
  (custom-set-variables
   '(test-var nil))
  

失敗例と対策

• .emacsの中でsetqしたはずの変数の値が反映されない
  • 原因→setqした変数値をcustomize機能を使って値を上書きしている。
  • 対策→どちらかにする(setqだけにするか、customize機能を使って値を設定するだけにするか)

代表的なカスタマイズ項目

• transient-mark-mode :選択中のリージョンに色を付けるかどうか
• scroll-bar-mode :スクロールバーを表示する/しない
• tool-bar-mode :ツールバーを表示する/しない

トラブルシューティングのノウハウ

.emacsを変更しているうちに、括弧の対応が合わなくなってエラーになる等の問題が出てきます。

ここではその場合の対応方法等を解説します。

どこでエラーが出ているのか調べる

• 起動時のスイッチに--debug-initを付けることで、エラーの個所がわかる

括弧の対応が狂ってないか調べる

• 次の操作でファイル内の括弧の対応が合ってないところを調べてくれる。

  M-x check-parens
  

byte-compiled(.elc)ファイルに問題がないか調べる

.elcファイルは .elをEmacsでバイトコンパイルしたものなのですが、これはXEmacsとGNU Emacsでフォーマットが 異なります。ですので、.elcファイルを共有しようとするとエラーが出ます。

問題が無いかどうかは以下のようにして調べます。

• エラーの出た.elcファイルを消去してエラーが出なくなるかどうか確認する

アプリケーション同士の整合・依存関係に問題が無いか調べる

• READMEを良く読んで必要なアプリケーションがインストールされているか調べる
• 実際にアプリケーションのロードが完了しているかを確認する方法としては以下のようなものがあります。
  • アプリケーションのトップ関数を呼び出してみる(*scratch*バッファで関数名C-j)
  • M-xアプリケーション名-versionを実行してみる(アプリケーションによっては定義されていないものもあります)

      M-x apel-version
    

アプリケーションのバグかどうか調べる

ここまで来ると、かなり高度な話題になります。一応指針だけ書いておきます。

• -qスイッチを付けて起動し.emacsを読み込まずに起動します。
• M-x load-fileで目的のアプリケーションだけをロードし、それでも問題が発生するかを確認します。
  • もし、問題が出なくなったらあなたの.emacsの設定に何か問題がある可能性が高いです。
  • まだ、問題が出るならアプリケーションのバグの可能性があります。その場合、作者に報告しましょう。
    • ※バグレポートはあなたの使っている環境と起きた現象を全て書きましょう。
    • ※事実と推測は明確に分けて書きましょう。

まとめ

基本的な部分のカスタマイズはそれほど難しくないということが分かっていただけたと思います。

• カスタマイズしてどんどんEmacsを便利にしよう
  • カスタマイズ機能をどんどん使おう
• 新しいアプリケーションをインストールしよう
  • .emacsでエラーが出ても、恐れずやってみよう

参考資料

Emacsのカスタマイズは無限です。興味を持ったら以下の資料等でelispを習って次のステップに進みましょう。

• Bil Lewis,Dan LaLiberte, Richard Stallman and the GNU Manual Gourp著大木敦雄訳

  Emacs Lispリファレンスマニュアル

  (株)アスキー

  • このリファレンスマニュアルはInternet上にも公開されています。
    • GNU Emacs 20.6 Emacs Lisp リファレンスマニュアル 日本語約版
    • @nodeの不備を補完するパッチ
  • また、Debian Woodyならelisp-manual-jaというパッケージが用意されています。

• 山本和彦著

  リスト遊び

  (株)アスキー