Emacsをワンライナーとして使う

Emacsをワンライナーとして使う

この記事は[EmacsのAdventCalandar2016](http://qiita.com/advent-calendar/2016/emacs)の20日目の記事です。

前日の記事はkaz-yosさんの[mu4eでメール](http://qiita.com/kaz-yos/items/164f03c7bba401646783)でした。

この記事に触発されてこの記事を書くに至りました。
[vimをパイプにする - 余白の書きなぐり](http://auewe.hatenablog.com/entry/2016/12/03/001000)

「Emacsだって同じことができるのでは？」と考えました :laughing:   

---

まず、Vimではパイプでテキストを渡していました。[^1]

Emacsでもパイプでテキストを渡せなければ話になりません。

そこで単純にパイプでテキストを渡したみた結果......

```bash
$ echo "Hello! \nOneLinerEmacs" > oneliner.txt # サンプルテキストの作成
$ cat oneliner.txt | emacs
emacs: standard input is not a tty
```

...

......

どうやら標準入出力が渡せないようです......

しかし、これで終わりにするわけにはいかないです。  

「それなら、Emacsに標準入出力を渡すためのオプションがあるのでは:thinking:」と考え、GNUのEmacsリファレンスを漁ってみました。

すると以下の記述を見つかりました。  

[GNU Emacs Manual: Initial Options](https://www.gnu.org/software/emacs/manual/html_node/emacs/Initial-Options.html)

>
‘-batch’
‘--batch’
Run Emacs in batch mode. Batch mode is used for running programs written in Emacs Lisp from shell scripts, makefiles, and so on. To invoke a Lisp program, use the ‘-batch’ option in conjunction with one or more of ‘-l’, ‘-f’ or ‘--eval’ (see Action Arguments). See Command Example, for an example.
>

`-batch`というオプションをつけるとシェルスクリプトなどからEmacsLispを実行できるとのこと。
また、Action Argumentsというオプションを組み合わせることでいろいろできるとある。

[GNU Emacs Manual: Action Arguments]
(https://www.gnu.org/software/emacs/manual/html_node/emacs/Action-Arguments.html#Action-Arguments)

そして、ご丁寧にサンプルまで用意してくれていました :clap: 

[GNU Emacs Manual: Command Argument Example](https://www.gnu.org/software/emacs/manual/html_node/emacs/Command-Example.html#Command-Example)
>
```bash
$ emacs --batch foo.c -l hack-c -f save-buffer >& log
```
>

**Emacsで`foo.c`を読み込み、`hack-c.el`を読み込み`save-buffer`という関数を実行する。そして`log`というファイルに出力を行います。**

`-l`と`-f`はそれぞれ以下のことをやってくれます。

| 引数| 概要 |
|:-:|:-:|
| -l | 指定されたElispをロードする。 |
| -f | 指定されたEmacsLispの関数を実行する。 |


他にも以下のようなオプションが使えそうです。

| 引数| 概要 |
|:-:|:-:|
| --eval | 引数に指定したElispを実行する。 |


ここまでを踏まえてoneliner.txtの中身をlogに出力するという単純なものをまず書いてみます……

```bash
$ emacs --batch oneliner.txt --eval="(princ (buffer-string))" >& log
$ cat log
Hello 
OneLinerEmacs
```

これでようやくEmacsでテキスト処理をワンライナーでおこなう準備ができました。

けれども、この形では`cat`や`echo`などをパイプで渡した標準入出力を渡すことができないという問題があります。

それは`buffer-string`が現在のバッファの内容を文字列として返すするという関数だからです。

そこでElispで標準入出力を受け取ってバッファに入力し、最後にそのバッファを出力するという関数を書いてみます。

```el:elisp.el
(defun get-stdin ()
(let ((buf (generate-new-buffer "buf")))
    (set-buffer buf)
    (condition-case nil
        (let ((line))
          (while (setq line (read-string ""))
            (insert line "\n")))
      (error nil))
     (buffer-string)))
```

こうなるだろうでしょうか。

1行だけだったら`(read-string "")`でも受け取れるのだけれども、複数行を受け取るために`while`で回している。
また、`condition-case`はEOFによるエラーの対策です。

これを実際に使って「文字列の置き換えをElispでおこない、最後に置き換えた行をgrepで抽出する」というのをやってみます。

まずは適当に単語を並べたテキストファイルを作ります。

```text:hello.txt
Go
Hello
Yeah
NewYear
OneLiner

```

```bash
$ cat hello.txt | emacs --batch -l ~/.emacs.d/elisp/get-input.el --eval='(princ (replace-regexp-in-string "Hello" "Go" (get-stdin)))' | grep Go
Go
Go
```

これでEmacsでワンライナーが書けることがわかりましたよね……？

普段利用する関数をユーティリティ関数としてElispとして書いておけば、Emacs上でもBash上でも使うことができるようになるというわけです！

いやあ、Emacsはまるでスイスアーミーナイフですね！

・・・・・・

ここまで書いておいて、最後にアレですが……

**ここまでしてElispをコマンドラインで使いたいならeshellを使いますよね……。**

ここまでで「面白そう！」と思ってくれた方はElispを実行できるシェル環境であるeshellを使うことをオススメします……。


---
[^1]: -eオプションをつけないとダメなようです。

修正：直したはずの箇所が修正できていなかったので修正を加えました。編集履歴が無駄に増えてしまってすいません……。