ParEdit チュートリアル

最初のうちは、「右丸括弧 ) を自動補完する」といった入力支援機能に目が行くかもしれないが、これはParEditにとってさほど重要な要素ではない。

ParEditの本質は、 リスト表記の丸括弧 () のバランスを維持する 点にある。 たとえば、

• リスト内部で M-s を押すと、そのリストの丸括弧 () を左右とも削除し、内容を上位リストに接合する。
• リスト内部で C-k を押すと、ポイントから(同じ行内にある)そのリストの右丸括弧 ) の直前までキルする。

といった具合に、さまざまな編集操作において丸括弧のバランスが崩れない²ように設計されている。 このほか、文字列表記の二重引用符ペア "" や、ベクター表記などに使われる角括弧³ [] についても、丸括弧と同様にバランスを維持してくれる。

ParEditの機能をうまく使えれば、「右丸括弧 ) の数が不足していないか(あるいは過剰ではないか)」を意識せずにLispコードを編集できる。 つまり、 括弧類の対応はParEditに任せてコードの内容に集中 できるのだ。

その反面、括弧類を始めとする様々なキーの動作を大胆に変更していることから、何も知らない状態で使うと、

• 「好きな位置に右丸括弧 ) を挿入できないじゃないか」
• 「BackSpaceキーを押したのに括弧が消えてくれない」
• 「コードをコピペして括弧類のバランスが崩れると悲惨だな」

といったネガティブな感想を抱きがちである。

実は、これらの問題にはそれぞれちゃんと解決策が用意されている。 たとえば、右丸括弧 ) を単独で挿入するとバランスが崩れてしまうので、「飲み込み」や「吐き出し」と呼ばれる操作で既存の右丸括弧 ) を移動させる。 また、リストの内容をすべて削除すれば丸括弧 () は消せるし、内容を残したまま丸括弧 () だけを消す「接合」や「上昇」と呼ばれる操作も用意されている。 さらには、括弧類のバランスが崩れてしまった場合に備えて、ユーザーが括弧類を単独で挿入・削除する方法が用意されている、といった具合だ。

しかし、ParEditに関する日本語の解説が(特にWeb上には)ないに等しいため、こうした解決策に気がつかないまま、ParEditの利用を断念する人が多いのではないかと思われる。 この文書がそうした人への助けとなれば幸いだ。

長い説明を読むのは面倒だから実例だけでいいよという人は、EmacsWikiの Paredit Cheet Sheet をご覧あれ。これはPNG形式の画像で、PareEditの機能/関数(要はfunction)ごとに、標準のキーバインドと操作例の一覧がまとめられている。

この文書では、ParEditの機能/関数のうち、これは覚えていないと損だよ と言えるものに絞って、実例を交えつつ説明する。 チートシートに紹介された30個の機能/関数⁴のうち、キーバインドを覚えておくべきなのはほんの数個で、残りは左丸括弧 ( のように覚えなくても自然に使えるものか、逆にほとんど使う機会がないものだ。

左丸括弧 ( を入力すると、現在のポイント(以下の例では | で示す)に空リスト () が挿入される。 ポイントはリスト内に移動するので、そのままリストの内容を入力すればいい。

(|)           ; ( を入力して空リスト () を挿入
(setq dbdir|) ; そのままリストの内容を入力

なお、文字列やコメントの内部のように、左丸括弧 ( を入力してもリストにはならない 場所では、ParEditを使っていないときと同じように左丸括弧 ( だけが挿入される。

左角括弧 [ や二重引用符 " を入力した場合も、ベクター表記や文字列表記のバランスを維持するために、同様の挙動になる。 つまり、現在のポイントに空ベクター [] や空文字列 "" が挿入され⁷、ポイントがそれらの内部に移動する。

(setq dbdir "|")          ; " を入力して空文字列 "" を挿入
(setq dbdir "~/Dropbox|") ; そのまま文字列の内容を入力

こうした入力時の補完機能はParEditの本質ではなく、括弧類だけにしか対応していない。 letのように複雑な構造のスペシャルフォームのコード片(スニペット)を挿入したいなら、Yet Another Snippet(yasnippet.el) の利用をお奨めする。 もちろん、ParEditと併用することも可能だ。

すでに入力済みのS式(複数可)を丸括弧 () で囲んでリストにするには2つの方法がある。 S式をひとつずつリストに取り込んでいくか、 C-M-SPC などでまとめて範囲指定してから左丸括弧 ( を入力するかだ。 ここでは前者の方法を説明する。

リスト内部で C-<right> (<right> は→キー)を押すと、そのリストの右丸括弧 ) が右に移動して、直後にあるS式をリストに 飲み込む(slurp)。 S式を飲み込み過ぎてしまった場合には、 C-<left> (<left> は←キー)を押せば、同じ右丸括弧 ) が左に移動して、リスト末尾のS式を 吐き出す(barf)。 これらは説明を聞くよりも、例を見てもらうほうが、さらには実際に自分で操作してみるほうが理解が早い。 なお、「オレのキーボードには軟弱な矢印キーなぞないのだ」という場合(HHK Proかな?)は、 それぞれ C-) と C-} で同じ結果が得られる⁸。

(setq dbdir |"~/Dropbox")     ; 文字列の直前をポイント
(setq dbdir (|) "~/Dropbox")  ; ( を入力して空リスト () を挿入
(setq dbdir (| "~/Dropbox"))  ; C-<right> で文字列をリストに飲み込む
(setq dbdir (expand-file-name| "~/Dropbox")) ; リストの内容を追加

もう少しニュアンスを込めて訳すと、slurp は ズルズル音を立てて(飲食物を)すすり込む 、barf は ゲロゲロと吐き出す となる。 イメージにはピッタリなんだけどね…。

もし、空リストを挿入して飲み込む手順がまだるっこしいなら、S式の直前をポイントして M-( を押せば、そのS式を即座に丸括弧 () で囲むことができる。 ただし、Meta(Alt)キーとShiftキーを同時に押すことになるので、かえって面倒かもしれない。 あるいは、 C-u 個数 ( のようにして、飲み込む個数を引数で指定することもできる。

(setq dbdir |"~/Dropbox")   ; 文字列の直前をポイント
(setq dbdir (|"~/Dropbox")) ; M-( を入力して文字列を () で囲む

ところで、移動すべき右丸括弧 ) が上位リストの右丸括弧 ) の直前にあると、飲み込むS式がないのでそれ以上右には移動できない。 この状態で C-<right> を押すと、 代わりに 上位リストの右丸括弧 ) が右に移動 して、直後のS式を飲み込む(このとき下位の右丸括弧 ) は動かない)。 さらに C-<right> を押すと、こんどは下位の右丸括弧 ) が右に移動して、直前に上位リストが飲み込んだS式を飲み込む。

(a ((b| c)) d e) ; 最下位の ) はこれ以上右に移動できない
(a ((b| c) d) e) ; C-<right> を入力すると、ひとつ上位の ) が右に移動
(a ((b| c d)) e) ; 再度 C-<right> を入力すると、下位の ) が右に移動
(a ((b| c d) e)) ; さらに C-<right> を入力すると、上位の ) が右に移動

このほか、リストの左丸括弧 ( を左右に移動させて飲み込みと吐き出しを行なうキー操作も用意されているが⁹、必要になる場面がほとんどないので説明は省略する。

こんどは、不要になった () を削除するときの操作だ。 リスト内部で M-s を押すと、そのリストの丸括弧 () を左右とも削除し、リストの内容を上位リストに 接合(splice) する。 spliceとは、ロープやフィルムなどの 端と端を繋ぎあわせる こと(撚り継ぎ/重ね継ぎ)を意味する言葉で、これもイメージによく合っている。

(list (list| "Okabe" "Shiina") "Hashida") ; 下位リスト内を適当にポイント
(list list| "Okabe" "Shiina" "Hashida")   ; M-s で丸括弧 () を削除
(list |"Okabe" "Shiina" "Hashida")        ; 不要な「list 」を削除

実際には、接合後にリストの内容の一部を削除することが多いので、接合時にリストの不要な部分も取り除いて ポイント以降の内容だけを残す 操作や、 S式ひとつだけを残す 操作を覚えておくと、Lispコードの編集作業がとても捗る。

残したいS式の直前をポイントして、 M-<up> (<up> は↑キー)を押してみよう¹⁰。 そのリストの丸括弧 () を削除し、リスト先頭からポイント直前までをキルして、ポイント以降のリストの内容だけを上位リストに接合してくれる。

たとえば、whenの条件判定が不要になったときや、letのローカル変数が不要になったときに M-<up> を使えば、内部フォームだけを残してさっくりと削除できるのだ。 丸括弧 () のバランスはParEditが維持してくれるので、「前半だけ消して右丸括弧 ) を消し忘れた」とか、「誤って別の右丸括弧 ) を消してしまった」といったミスを防げる。

(when tty-p |(menu-bar-mode -1)) ; 内部フォームの直前をポイント
|(menu-bar-mode -1)              ; M-<up> で内部フォーム以外を削除

いっぽう、リスト内部のS式をひとつだけ¹¹残す操作は 上昇(raise) と呼ばれる。 操作の対象とするS式の直前をポイントして M-r を押すと、そのS式を含む最下位リストの丸括弧 () や残りの内容がすべて削除される。 説明より、以下の例を見た方が早い。

(when (or |nt-p linux-p) (tool-bar-mode -1)) ; nt-p の直前をポイント
(when |nt-p (tool-bar-mode -1))              ; M-r で nt-p のみが残る

リストが複数行にわたっていても、ちゃんと処理される。

(if expert-p
   |(menu-bar-mode -1)
  (menu-bar-mode 1))   ; ifスペシャルフォームのリスト3行から

(menu-bar-mode -1)     ; M-r でthenフォーム部分のみを取り出す

ポイント直前の1文字を削除する DEL (BackSpaceキーのこと¹²)や C-h (設定が必要¹³)には、通常の delete-backward-char の代わりに、バランス維持機能を持たせた paredit-backward-delete が割り当てられている。関数名から char が取れているのは、以下に示すように文字単位ではない処理を含むからだろう。

• 通常は、ポイント直前の1文字を削除する。
• ただし、ポイント直前がリストの丸括弧 () なら、ポイントのみ左に移動。
• ただし、ポイント直前が空リストの左丸括弧 ( なら、空リストをまとめて削除。

(a (b))| ; リストの直後をポイント。ここでBackSpaceを連続して押すと…
(a (b)|) ; ポイントが最初の ) を飛び越える
(a (b|)) ; ポイントが2番目の ) を飛び越える
(a (|))  ; b が削除される
(a |)    ; () がまとめて削除される

この例でもわかるように、左丸括弧 ( や右丸括弧 ) を単独で削除できないようにしてリストのバランスを維持しているわけだ。 こうしたバランス維持機能は、文字列表記の二重引用符ペア "" や、ベクター表記などに使われる角括弧 [] に対しても働く。 ただし、コメントや文字列の内部ではバランスを維持する必要はないので、 DEL を使って、左丸括弧 ( などを単独で削除できるようになっている。

同様に、ポイント直後の1文字を削除する C-d や <delete> (Deleteキーのこと)に割り当てられた paredit-forward-delete もバランス維持機能を持っている。

|(a ) ; リストの直前をポイント。ここで C-d を連続して押すと…
(|a ) ; ポイントが ( を飛び越える
(| )  ; a が削除される
(|)   ; 空白が削除される
|     ; () がまとめて削除される

ポイントから行末までをキルする C-k には、通常の kill-line の代わりに、バランス維持機能を持たせた paredit-kill が割り当てられている。関数名から line が取れているのは、行単位ではない処理が含まれるからだろう。 というのも、ポイントを含むリストが行の途中で終わっている場合 や、キル範囲のリストが次行以降に継続している場合 にも対応しなければいけないからだ。 いずれの場合も、単純に行末までをキルすると丸括弧 () のバランスが崩れてしまう。

• 通常は、ポイントから行末までキルする(ポイントが行末なら改行をキル)。

  (if (or |nt-p
           linux-p)
      (tool-bar-mode -1)) ; kill-lineと同様に動作する例
  
  (if (or |
           linux-p)
      (tool-bar-mode -1)) ; ポイントから行末までキル
  

• ただし、ポイントを含むリストの右丸括弧 ) が行内に存在するなら、右丸括弧 ) の直前まで(リストの内容のみ)をキルする。

  (if (or |nt-p linux-p)
      (tool-bar-mode -1)) ; リスト内部での動作の例
  
  (if (or |)
      (tool-bar-mode -1)) ; C-k で ) の直前までキル
  

• また、キル範囲に含まれるリストが次行以降に継続しているなら、そのリスト全体を複数行にわたってキルする。

  (if |(or nt-p
           linux-p)
       (tool-bar-mode -1)) ; キル範囲のリストが次行に継続している例
  
  (if |
       (tool-bar-mode -1)) ; C-k でリスト全体をキル
  

1文字削除の場合と同様、こうしたバランス維持機能は、二重引用符ペア "" や角括弧 [] に対しても働く。 たとえば、行内で完結する文字列をポイントして C-k すると、ポイントから文字列末尾の二重引用符 " の直前までをキルする。 いっぽう、キル範囲に複数行にわたる文字列が含まれていれば、その文字列全体をキルする。

Lispコードの編集において、これまで紹介したParEditの機能を使っていれば、括弧類のバランスが崩れることはない。 バランスが崩れる最大の要因は、 ユーザーがS式の構造を無視して(たいていは行単位で)、Lispコードをカット&ペースト(Emacs風に言うと、キル&ヤンク)することにある。

ParEditは、 リージョンのキルやヤンクでは括弧類のバランスを維持しない ¹⁴。 このため、ユーザーが安易にLispコードを行単位で切り貼りすると、切り取られた部分や貼り付けられた部分でリスト表記の右丸括弧 ) が不足し(あるいは過剰になり)、容易にバランスが崩れてしまうのだ。 二重引用符ペア "" や角括弧 [] についても同じことが言える。

(when (require 'server nil t)
| (unless (equal (server-running-p) t)
    (message "Starting server...")
    (server-start)))                   ; ポイントから3行カットすると

(when (require 'server nil t)
|                                      ; ) が1個不足してしまう

バランスの崩れを修正するのは慣れていないと大変なので、リージョンのキルやヤンクにおいても括弧類のバランスを維持することが求められる。

お薦めの方法は、行単位ではなく S式の構造に基づいたリージョンを選択する ことだ。 とは言っても、自分でS式の終わりを見つける必要はない。 S式の先頭(リストの場合は左丸括弧 ( の直前)をポイントして C-M-SPC ¹⁵を押せば、そのS式の終わりまでGNU Emacsが自動的にリージョンにしてくれる。 あとはキルするなりコピーするなり、左丸括弧 ( を入力して全体を丸括弧 () で囲むなりすればいい。 C-M-k ¹⁵でS式のリージョン選択とキルを併せて行なうことも可能だ。

(when (require 'server nil t)
| (unless (equal (server-running-p) t)
    (message "Starting server...")
    (server-start)))                   ; C-M-kでS式をカット

(when (require 'server nil t)
|)                                     ; 末尾の ) がちゃんと残る

なお、S式の先頭や末尾へのポイント移動は C-M-b ¹⁵と C-M-f ¹⁵、上位や下位のS式へのポイント移動は C-M-u ¹⁵と C-M-d ¹⁵で行なえることも押さえておこう。

すでに説明したように、左丸括弧 ( の入力によって空リスト () が挿入されるのだから、右丸括弧 ) を単独で挿入する必要はない。左角括弧 [ と 右角括弧 ] についても同様だ。

このため、括弧類のバランスが維持されている状態では、閉じ括弧の入力に対して、文字の挿入ではなくポイント移動(および空白文字の整形)を行なう。 具体的には、リストやベクターの内部で右丸括弧 ) や右角括弧 ] を入力すると、どちらも以下の挙動をする。

• ポイントを含む最下位リスト(またはベクター)の閉じ括弧の直後までポイントを移動する(リスト・ベクターからの脱出)。

  (a (b| c)  d e)  ; 内側のリスト内で ) か ] を入力すると
  (a (b  c)| d e)  ; 内側のリストの ) の直後にポイントが移動
  (a (b  c)| d e)  ; この状態で再度 ) か ] を入力すると
  (a (b  c)  d e)| ; 外側のリストの ) の直後にポイントが移動
  

• そのさい、閉じ括弧直前のS式と閉じ括弧との間に空白文字(改行を含む)があるなら、それらをすべて削除する(空白文字の整形)。

  (a| b
    )        ; このリスト内で ) か ] を入力すると
  
  (a  b)|    ; 末尾の b と ) の間の空白文字(改行含む)をすべて削除
  

いっぽう、文字列やコメントの内部では リストやベクターにはならない ため、右丸括弧 ) や右角括弧 ] を単独で挿入できる。

(setq hoge "|")   ; 文字列の内部で ) を入力すると
(setq hoge ")|")  ; ) が挿入される
(setq hoge ")|")  ; 同様に、] を入力すると
(setq hoge ")]|") ; ] が挿入される

ちなみに、いずれの内部でもない場所で閉じ括弧を入力しても、エコーエリア(最下行)に「Not inside a list.」(リストの内部ではない)と表示されて挿入できない。

行単位のカット&ペーストなどによって不足する(あるいは過剰になる)のは、リストの右丸括弧 ) であることが圧倒的に多い。 このため、右丸括弧 ) (ついでに角右括弧 ])については、不足・過剰かどうかをParEditが自動的に検知し、ユーザーによるバランス修正を手助けしてくれる。

たとえば、右丸括弧 ) が不足しているリストでは、右丸括弧 ) を任意のポイントに単独で挿入できる。 右丸括弧 ) を入力すると、通常のポイント移動と整形ではなく、そのままポイントに右丸括弧 ) が挿入されるのだ。 このとき、エコーエリア(最下行)には、「Missing closing delimiter: )」(不足している閉じ区切り文字)と表示される。

(when (require 'server nil t)|  ; ) が不足したリスト末尾をポイント
(when (require 'server nil t))| ; ) を押せばそのまま単独で挿入される

逆に、右丸括弧 ) が過剰なリストでは、 DEL (BackSpaceキーのこと)により、 リスト末尾の右丸括弧 ) を単独で削除できる 。 エコーエリアには、「Deleting spurious closing delimiter.」(不要な閉じ区切り文字を削除)と表示される。 削除できるのはリスト末尾の右丸括弧 ) に限定されることに注意されたい(任意の位置で削除する方法は次小節を参照)。

なお、閉じ括弧や DEL のこうした挙動は、リストのバランスが崩れている間だけ有効で、バランスが修正されると通常の動作に戻る。

開き括弧(左丸括弧 ( や左角括弧 [)が過剰な場合は、C-d を使って リスト先頭の開き括弧を単独で削除できる。 いっぽう、開き括弧が不足している場合は、閉じ括弧のようにParEditが手助けしてくれないため、困ったことになる。

たとえば、不足している左丸括弧 ( を単独で挿入しようしても、いつもの空リスト () が挿入される。 それなら、不要な右括弧 ) だけ削除しようと DEL (BackSpaceキーのこと)を押すと、空リスト () がまとめて削除されてしまうのだ。 角括弧 [] や二重引用符ペア "" でも似たような事態になる。

こうした場合に備えて、ParEditが有効な状態でも、

• C-q を前置すれば 任意の括弧類を単独で挿入できる こと
• C-u を前置すれば 括弧類のバランスを無視して削除/キルできる こと

を覚えておこう。

たとえば、C-q ( や C-q ) によって、左丸括弧 ( や右丸括弧 ) を任意のポイントに単独で挿入できる。 また、C-u DEL や C-u C-d では任意の位置の括弧類を1文字削除できるし、C-u C-k でポイントから行末までを(括弧類のバランスを無視して)キルすることも可能だ。

なお、これらの操作はGNU Emacs標準の関数(quoted-insert や delete-backward-char など)を呼び出すため、常用してはParEditを使う意味がない。崩れてしまった括弧類のバランスを回復させる目的に限定すべきだ。