#8 カスタマブルな Emacs Lisp 製シェル「eshell」 (Software Design 2014年12月号掲載記事) Emacs インストール 設定 使い方

　Emacs 24.4がリリースされましたね！筆者のサイト「日刊Emacs」でも新機能レビューしています。http://rubikitch.com/category/emacs-24-4/

　Emacsでは様々なアプリケーションがEmacs Lispで書かれています。eshellはEmacs Lispで書かれたシェルです。Emacsとシェルといえば通常のシェル(bash、zshなど)をEmacsのバッファで動かすM-x shellがありますが、eshellはそれよりもEmacsとの親和性が強いです。シェルスクリプトよりもEmacsが好きな筆者は、eshellを愛用しています。

　eshellはすべてがEmacs Lispで書かれています。その事実はたくさんのメリットをもたらします。

　まず、eshellはプラットフォームを選びません。Emacsが動く環境であればすべての環境でeshellが動きます。特にUnix系OSを得意とする人がWindowsを使わされている場合、eshellは強い味方になります。WindowsでもGNU Screenやzshなどを導入できますが、eshellはEmacsさえインストールすれば即座に使える手軽さがあります。代表的なUnixコマンドもEmacs Lispで実装されているので、そのままでcpやmvなどが実行できます。WindowsでもUnix系OSに負けない強力なシェルが使えるということです。

　そして、前回のdiredのところでお話したように、Emacs Lispで書かれているということは、すべての挙動がコントロール可能ということです。他のシェルでもシェルスクリプトで柔軟にカスタマイズできますが、それにも限界があります。シェルのコアとなる部分がＣ言語で書かれているので、コアに触れるカスタマイズまではできません。対してeshellはコアも含めてEmacs Lispで書かれているので、コアを再定義できます。新機能追加も自由自在で、あっさりとオレオレeshellが構築できます。

　M-x shellのメリットはすべて受け継いでいます。バッファに出力が蓄積するのでスクロールしてしまった出力をあっさり遡れます。入力補完機能も当然あります。コマンドの出力を他のバッファに貼り付けるのも楽勝です。

　とはいえM-x shellではシェル本来の機能を発揮しきれない欠点があります。とくにzshには、Emacsではないかと錯覚してしまうほどの能力を持っています。実際zshにおいてM-xをタイプすると、様々なコマンドが実行できます。zshは実際のところ行指向どころか画面指向のシェルという様相です。設定すればM-x tetrisでzshでテトリスが遊べてしまいます。M-x shellでは、シェル独自の機能を殺してしまうのです。eshellはそれ自体が完結されたシェルであるため、当然M-x shellよりもシェルとして作り込まれています。

　eshellはEmacsのシェルだけあって、Emacs Lispとの連携ができます。具体的にはeshellから直接Emacs Lisp式を評価させたり、Emacsのコマンドを実行したりもできます。さらにおもしろいことに、Emacs Lispの任意の関数をシェル形式で呼び出せます。とにかくeshellからはすべてのEmacsの機能が呼び出せるので、eshellのバックにはすべてのEmacsの関数・コマンドが味方についているのです。Emacsのスキルが上がれば自動的にeshellも強化されます。まさにEmacsヘビーユーザーにとって最強のシェルといえるでしょう。

　eshellはそれ自体がシェルの働きをするので、シェルの基本的な機能はすべておさえてあります。リダイレクト・パイプ、複文、コマンド・ファイル名補完、バッククォート、シェル変数、エイリアスも実装されています。複雑なので本稿では解説しませんが、状況に応じて補完できるプログラマブル補完(pcomplete)もあります。また、zshのグロブ(ワイルドカード)も実装されています。

　一方でeshellはEmacsの機能にシェルのインターフェースでアクセスしているものと考えることができます。Emacsは元来テキストエディタであり2次元ですが、シェルのコマンドラインは1次元です。テキストエディタがシェルを模倣するのは容易いことです。eshellで書かれた命令を内部でLispに変換してEmacsに送信しています。

　eshellを起動するには、M-x eshellを実行します。すると、M-x shell同様なプロンプトが出てきます。あとは通常通りシェルとして使っていけばいいです。

　eshellは複数枚立ち上げられます。C-u M-x eshellで新しいeshellバッファが作成されます。C-u 数字 M-x eshellで *eshell*<数字> バッファが作成されます。それぞれのeshellバッファは独立したカレントディレクトリが持てます。複数のディレクトリで作業する場合に便利です。

Fig1: M-x eshell

Fig2: C-u 22 M-x eshell

　M-x eshell-commandは、M-!のeshell版です。eshellで一回だけコマンドを実行するのに便利です。

　eshellは出力リダイレクト・パイプが実装されています。使い方は通常のシェルと変わりません。

~ $ echo xxx > test.txt
~ $ cat test.txt
xxx
~ $ echo foo | wc
      0       1       3

　zshと同様に複数のファイルに書き込んだり、リダイレクト後にパイプを通すことも可能です。eshell版echoはデフォルトでは改行を入れないので-nで改行を入れています。

~ $ echo -n hoge > a > b > c | wc
      1       1       5
~ $ cat a
hoge
~ $ cat b
hoge
~ $ cat c
hoge

　eshellならではの仮想デバイスもあります。/dev/nullはeshell側で実装されているのでWindowsでも使えます。

~ $ echo test > /dev/null
[出力を非表示にする]
~ $ echo test > /dev/kill
[出力をキルリングに入れる(内容:test)]
~ $ echo test >> /dev/kill
[出力をキルリングに追記する(内容:testtest)]
~ $ echo test > /dev/clip
[出力をクリップボードに入れる]

　リダイレクト先にバッファも指定できるのはさすがEmacs上のシェルです。話の都合上、先に出してしまいましたが、eshellではLisp式を評価させることができます。

~ $ echo buf > #<buffer output>
[バッファoutputに出力する]
~ $ (with-current-buffer "output" (buffer-string))
[バッファoutputの内容を表示する]
buf
~ $ echo buf >> #<buffer output>
[バッファoutputに追記する]
~ $ (with-current-buffer "output" (buffer-string))
bufbuf
~ $ (with-current-buffer "output" (goto-char 4))
[バッファoutputのカーソルを移動させる]
4
~ $ echo X >>> #<buffer output>
[バッファoutputの現カーソル位置に出力する]
~ $ (with-current-buffer "output" (buffer-string))
bufXbuf

　eshellでの複文はUnixシェルと同じです。

• 「;」で続けてコマンドを実行
  
• 「&&」で前のコマンドが正常終了なら次のコマンドを実行
  
• 「||」で前のコマンドが異常終了なら次のコマンドを実行
  

~ $ echo a; echo b
[echo aとecho bを実行する]
a
b

~ $ sh -c 'exit 0' && echo normal
[終了ステータス0(正常終了)なのでnormalが表示される]
normal
~ $ sh -c 'exit 1' && echo normal
[終了ステータスが1(異常終了)なのでnormalは表示されない]
~ $ sh -c 'exit 0' || echo abnormal
[正常終了なのでechoは実行されない]
~ $ sh -c 'exit 1' || echo abnormal
[異常終了なのでechoは実行される]
abnormal

　eshellにおけるシェル変数はEmacsの変数です。シェル変数を設定するにはsetqコマンドを使います。シェル変数は変数名の前に$をつけて参照します。

~ $ setq a 10
10
~ $ echo $a
10
~ $ echo a=$a
a=10

　文字列は通常のシェル同様""と''で囲むことができ、両者の違いも同じです。

~ $ echo "a=$a"
a=10
~ $ echo 'a=$a'
a=$a
~ $ echo "a"$a"a"
a10a
~ $ echo a$a"a"
a10a

　eshellでコマンド実行結果を引数にするには {〜} を使います。シェルのバッククォートとは異なるので気をつけてください。{〜}の中はeshellのコマンドそのものなので、Lisp式も書けます。文字列に埋め込むには${〜}を使います。

~ $ cd /
/ $ pwd
/
/ $ echo `pwd`
`pwd`
/ $ echo {pwd}
/
/ $ echo ${pwd}
/
/ $ echo pwd=${pwd}
pwd=/
/ $ echo "pwd=${pwd}"
pwd=/
/ $ echo {(+ 3 4)}
7

　eshellはEmacs Lispで書かれたシェルなので、eshellの中でLisp式を評価させることも簡単です。関数呼び出し(開括弧から始まる)についてはそのまま実行できます。なおconcat関数は引数に指定した文字列を結合した文字列を返します。

~ $ (+ 1 2)
3
~ $ (concat "foo" "bar")
foobar

　関数呼び出しそのものもeshellのコマンドになるので、「;」で区切って複数の実行結果を得ることもできます。

~ $ (+ 1 2); (+ 3 4)
3
7

　関数呼び出しの結果を文字列に埋め込むには$(〜)を使います。なお、*echoはeshellの内部コマンドのechoではなくて外部コマンドのechoを呼び出します。内部コマンドのechoは複数の引数をリスト化する性質があります。

~ $ echo $(+ 1 2) $(+ 3 4)
(3 7)
~ $ echo "$(+ 1 2) $(+ 3 4)"
3 7
~ $ *echo $(+ 1 2) $(+ 3 4)
3 7

　ただし、変数の値を得る場合は変数名がコマンド名とみなされるため、そのままではうまくいきません。Lisp式の評価値を表示するeshell/e関数を定義することで、eshellでeコマンドが使えるようにしておきます。(List1)

　eコマンドは変数の評価値をきれいな表示形式(pp形式)で出力します。表示形式にすると文字列は""で囲まれ、nilはnilと表示されます。通常の表示形式(prin1形式)ではなくてきれいな表示形式にすると、ネストしたリストは複数行に分けて見やすく表示してくれます。

== List1:Emacs Lisp評価関数

(defun eshell/e (arg)
  (eshell-printn (pp-to-string (eval (if (listp arg) arg (read (format "%s" arg))))))
  nil)

==

~ $ setq a 1
1
~ $ a
a: command not found
~ $ echo $a
1
~ $ e a
1
~ $ e emacs-version
"24.4.1"
~ $ e nil
nil

　元々Emacs Lispをシェル的インターフェースで評価するM-x ielmがありますが、eshellを使えばもはや不要です。

　eshellにおいては、Lisp関数をシェルコマンドのように呼び出せます。Lisp関数呼び出しは
(関数名 引数 引数...)
の形式ですが、この機能を使うことで括弧が省けます。

<書式>
関数名 引数 引数...

~ $ find-file ~/.emacs.d/init.el
#<buffer init.el>

　この場合、Emacs Lispをeshellのコマンドとして実行しています。このように実体がEmacs Lispであってもeshellの文法に則り、$で変数の値を参照します。

~ $ find-file $user-init-file
#<buffer init.el>

　引数に渡されたオブジェクトは適宜型変換されます。たとえば整数を渡したら整数型に、小数を渡したら浮動小数点数型になります。型変換を抑制し、文字列そのものとして渡すには""か''で囲みます。

　シンボルを渡すには「`」でバッククオートします。Emacs Lispにおいてバッククォートはリスト展開機能を含むクオート(')で、複雑なリストを作成したりマクロを定義するときに使われます。Emacs Lispの関数呼び出しにおいて、シンボルを渡すにはシンボル名にクオートするのとバッククォートするのとでは同じ結果になります。eshellではクオートはシェルの文字列表現として使われているので、バッククォートがeshellにおけるシンボル渡しに適任なのです。eshellでシェル的バッククォートが使えないのは、こういう背景があるからです。

~ $ symbol-name `a
a

　バッククォートが``のように囲まれている場合は、文字列としてそのまま渡されます。

~ $ echo `pwd`
`pwd`
~ $ echo `pwd
pwd

　引数にリストを渡す場合もバッククォートします。eコマンドにリストを渡したらそれを関数呼び出しとして評価します。そのため、関数を評価するときにはバッククォートを置く必要があります。

~ $ e (concat "foo" "bar")
[評価結果foobarを変数名として参照するため未定義エラー]
Symbol's value as variable is void: foobar
~ $ e `(concat "foo" "bar")
"foobar"
~ $ e `(+ 1 2)
3
~ $ e `(symbol-name `a)
"a"

　eshellにもエイリアス機能があります。eshellのエイリアスは定義すると即座にファイルに保存され、永続化されます。

<書式>
alias 別名 '定義'

　「ll」を「ls -l」のエイリアスに定義します。それでは、以下のように打ち込んでください。

~ $ alias ll 'ls -l $*'

　他のシェルとは異なり、エイリアスに渡された引数に展開する$*が必要です。また、$*をそのまま渡す必要があるため、エイリアス定義には' 'で囲む必要もあります。

　定義を省略することで、そのエイリアスを削除します。

~ $ alias ll

　エイリアスはコマンド実行の優先順位では最上位に位置します。そのため、たとえeshell/ll関数が定義されていたとしても、エイリアスllが定義されているときには、ls -lにエイリアス展開されます。

　eshellは魅力的なシェルですが、弱点もいくつかあります。弱点はeshellがEmacs Lispで書かれていることとEmacsのバッファに起因します。ですが、ちゃんと抜け道もあるので安心してください。筆者はeshellを愛用しているのは、それぞれの弱点を克服する方法があり、eshellのメリットが強力だからです。そもそも弱点にひっかかる頻度は多くないです。

• リダイレクト・パイプの処理速度がとても遅い
  
• 他の文字コード・バイナリデータが扱えない
  
• 入力リダイレクトが未実装
  
• 画面指向プログラムがそのまま実行できない
  
• Emacs Lisp版Unixコマンドが遅い
  

　eshellの主な操作方法を表にまとめておきます。eshellはとても奥が深い世界であり、ここで伝えたことはほんのさわりに過ぎません。シェルコマンドとEmacs Lispが絶妙なバランスで調和した世界をお楽しみください。

表:eshell操作方法のまとめ