36. プロセス

[ ? ]

36.1 サブプロセス作成関数

プログラムを実行するために新たなサブプロセスを作る関数が3つあります. その1つstart-processは, 非同期プロセスを作成してプロセスオブジェクトを返します（see section 非同期プロセスの作成）. 残りの2つ, call-processとcall-process-regionは同期プロセスを作成しますが, プロセスオブジェクトは返しません（see section 同期プロセスの作成）.

同期／非同期プロセスについては以下の節に述べます. 3つの関数の呼び出し方は類似しているので, ここではそれらに共通な引数について述べます.

いずれの場合でも, 関数の引数programは, 実行すべきプログラムを指定します. そのファイルがみつからなかったり実行できないと, エラーを通知します. ファイル名が相対名であると, 変数exec-pathは探索すべきディレクトリのリストを保持しています. Emacsは起動時に環境変数PATHの値に基づいてexec-pathを初期化します. ‘~’, ‘.’, ‘..’のファイル名の標準的な書き方は, exec-pathでも普通どおりに解釈されますが, （‘$HOME’などの）環境変数の置換は認識しません. それにはsubstitute-in-file-nameを使います（see section ファイル名を展開する関数）.

サブプロセスを作成する各関数には, プログラムの標準出力の受け取り場所を指定する引数buffer-or-nameがあります. これはバッファかバッファ名である必要があります. バッファ名であると, そのバッファが既存でなければ新たに作成します. nilでもかまいませんが, その場合, フィルタ関数で処理しない限り出力を破棄します. （プロセスフィルタ関数とsee section Lispオブジェクトの読み取りと表示）. 通常, 複数のプロセスの出力を同じバッファへは送らないようにします. それらの出力がでたらめに混ざってしまうからです.

サブプロセスを作成する3つの関数すべてに, &rest引数であるargsがあります. argsはすべてが文字列である必要があり, それぞれを区切ってコマンド行引数としてprogramに与えられます. 引数全体を指定されたプログラムへ直接渡すため, これらの引数ではワイルドカード文字や他のシェル構文の特別な意味はありません.

注意：引数programにはプログラムの名前だけを指定し, コマンド行引数はいっさい指定しない. コマンド行引数はargsで与えること.

サブプロセスのカレントディレクトリは default-directoryの値で決まります（see section ファイル名を展開する関数）.

サブプロセスはEmacsから環境変数を継承しますが, 優先するものをprocess-environmentで指定できます. See section オペレーティングシステム環境.

Variable: exec-directory: この変数の値は, Emaccsが起動することを意図した GNU Emacsとともに配布されたプログラム群を収めたディレクトリ名（文字列）である. プログラムmovemailはそのようなプログラムの例であり, inboxから新たなメイルを取り出すためにrmailが利用する.

User Option: exec-path

この変数の値は, サブプロセスで実行するプログラムを探索するディレクトリのリストである. 各要素はディレクトリ名（文字列）であるか, デフォルトディレクトリ（つまりdefault-directoryの値）を意味するnilである.

引数programが絶対ファイル名でないと, call-processとstart-processは exec-pathの値を使う.

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

36.2 シェル引数

Lispプログラムから, ユーザーが指定したファイル名を含んだコマンドを指定してシェルを実行する必要がときどきあります. これらのプログラムでは, 任意の正しいファイル名を扱える必要があります. しかし, シェルは, 特定の文字がファイル名として現れると特別に扱うので, そのような文字がシェルに混乱をもたらします. そのような文字を扱うには, 関数shell-quote-argumentを使います.

Function: shell-quote-argument argument

この関数は, argumentを実際の内容とするシェル構文で表した引数を文字列で返す. この戻り値をシェルコマンドに連結し, 実行のためにシェルに渡しても問題を生じないはずである.

この関数が行うことの詳細は読者のオペレーティングシステムに依存する. この関数は通常のシェル構文に合うように設計してある. 非標準のシェルを使う場合には, この関数を再定義する必要があろう. MS-DOSでは, この関数はargumentを無変更で返す. MS-DOSのシェルにはクォートの機能がないため, これは本当は正しいことではないが最良のことである.

;; つぎの例はGNUとUNIXシステムのふるまいである
(shell-quote-argument "foo > bar")
     ⇒ "foo\\ \\>\\ bar"

シェルコマンドを作るshell-quote-argumentの使用例をつぎに示す.

(concat "diff -c "
        (shell-quote-argument oldfile)
        " "
        (shell-quote-argument newfile))

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

36.3 同期プロセスの作成

同期プロセス（synchronous process）を作成すると, Emacsは実行を続行するまえにそのプロセスが終了するのを待ちます. diredはその例です. lsを同期プロセスで実行し, その出力を少々修正します. プロセスは同期なので, Emacsがなにかを行おうとするまえにディレクトリ一覧全部がバッファに届きます.

Emacsは同期サブプロセスの終了を待ちますが, ユーザーはC-gと打って中断できます. C-gはまずシグナルSIGINTでサブプロセスをキルしようとしますが, 中断を完了するまえにサブプロセスが終了するのを待ちます. その期間にユーザーがさらにC-gを打つと, SIGKILLでサブプロセスを即座にキルし, ただちに中断を完了します. See section 中断.

同期サブプロセス作成関数は, そのプロセスがどのように終了したかを表すものを返します.

同期サブプロセスからの出力は, ファイルから読むテキストと同様に, コーディングシステムを用いて一般には復号化します. call-process-regionがサブプロセスへ送る入力は, ファイルへ書くテキストと同様に, コーディングシステムを用いて符号化します. See section コーディングシステム.

Function: call-process program &optional infile destination display &rest args

この関数は, 別のプロセスでprogramを呼び出し, それが終了するのを待つ.

infileがnilでなければプロセスへの標準入力はinfileであるが, さもなければ‘/dev/null’である. 引数destinationでプロセスの出力先をつぎのように指定する.

バッファ

このバッファのポイントのまえに出力を挿入する. これにはプロセスの標準出力と標準エラーの両者を含む.

文字列

文字列で指定した名前のバッファのポイントのまえに出力を挿入する.

t

カレントバッファのポイントのまえに出力を挿入する.

nil

出力を破棄する.

0

出力を破棄し, サブプロセスの終了を待たずにただちに戻る.

この場合, このプロセスはEmacsと並行して動作するので真のサブプロセスではない. しかし, この関数から戻るとEmacsはサブプロセスの処理を本質的には終えたという意味で同期プロセスと考えることができる.

(real-destination error-destination)

標準出力と標準エラーを分離し, real-destinationの指定に従って通常の出力を扱い, error-destinationに従ってエラー出力を処理する. error-destinationがnilであるとエラー出力を破棄し, tであると通常の出力に混ぜ, 文字列であるとその名前のファイルにエラー出力を振り向ける.

エラー出力を入れるバッファを直接に指定することはできない. それを実装するのは難しすぎる. しかし, エラー出力を一時ファイルへ送ってからそのファイルをバッファに挿入すれば, 同じ効果を得られる.

displayがnil以外であると, call-processは, 出力が挿入されるとバッファを再表示する. （しかし, コーディングシステムとして実際のデータからコーディングシステムを推定するundecidedを指定していると, 非ASCII文字に出会うと再表示を継続できない場合もある. これを修正するのが困難である根本的な理由がある. ）さもなければ, 関数call-processは再表示しないので, Emacsが通常の過程でそのバッファを再表示するまでは, スクリーン上で結果は見えない.

残りの引数argsは, プログラムに対するコマンド行引数を指定する文字列である.

（待たないように指示しない限り）call-processが返す値は, プロセスの終了理由を表す. 数でサブプロセスの終了状態を表し, 0は成功, それ以外の値は失敗を意味する. プロセスがシグナルで終了すると, call-processはシグナルを記述する文字列を返す.

つぎの例では, バッファ‘foo’がカレントである.

(call-process "pwd" nil t)
     ⇒ nil

---------- Buffer: foo ----------
/usr/user/lewis/manual
---------- Buffer: foo ----------

(call-process "grep" nil "bar" nil "lewis" "/etc/passwd")
     ⇒ nil

---------- Buffer: bar ----------
lewis:5LTsHm66CSWKg:398:21:Bil Lewis:/user/lewis:/bin/csh

---------- Buffer: bar ----------

insert-directoryの定義にあるcall-processのよい使用例をつぎに示す.

(call-process insert-directory-program nil t nil switches
              (if full-directory-p
                  (concat (file-name-as-directory file) ".")
                file))

Function: call-process-region start end program &optional delete destination display &rest args

この関数は, programを動かすプロセスの標準入力として startとendのあいだのテキストを送る. deleteがnil以外であると, 送ったテキストを削除する. これは, カレントバッファに送った入力のかわりに出力を挿入することを意味するdestinationがtであるときに有用である.

引数destinationとdisplayは, サブプロセスからの出力をどのように扱い, 出力か到着するたびに表示を更新するかどうかを制御する. 詳しくは, 上記のcall-processの記述を参照. destinationが整数0であると, call-process-regionは, サブプロセスの終了を待たずに出力を破棄してただちにnilを返す.

残りの引数argsは, プログラムに対するコマンド行引数を指定する文字列である.

call-process-regionの戻り値はcall-processと同様であり, 待たずに戻るように指示するとnilであり, さもなければサブプロセスの終了状態を表す数か文字列である.

つぎの例では, バッファ‘foo’の始めの5文字（単語‘input’）を標準入力としてユーティリティcatを実行するためにcall-process-regionを使う. catは, 標準入力を標準出力へコピーする. 引数destinationがtであるので, 出力はカレントバッファに挿入される.

---------- Buffer: foo ----------
input∗
---------- Buffer: foo ----------

(call-process-region 1 6 "cat" nil t)
     ⇒ nil

---------- Buffer: foo ----------
inputinput∗
---------- Buffer: foo ----------

コマンドshell-command-on-regionは, つぎのようにcall-process-regionを使う.

(call-process-region 
 start end         
 shell-file-name      ; プログラムの名前
 nil                  ; リージョンを削除しない
 buffer               ; 出力はbufferへ入れる
 nil                  ; 出力中は再表示しない
 "-c" command)        ; シェルに対する引数

Function: shell-command-to-string command: この関数は, シェルコマンドとしてcommand（文字列）を実行し, コマンドの出力を文字列として返す.

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

36.4 非同期プロセスの作成

非同期プロセスを作成すると, Emacsとサブプロセスの両者はただちに動作を継続します. そしてプロセスはEmacsと並行に動作し, 両者は以下の節に述べる関数を用いて互いに通信できます. しかし, 通信は部分的に非同期です. 特定の関数を呼び出したときにだけEmacsはプロセスへデータを送り, Emacsが入力待ちか時間待ちをしているときにだけプロセスからの出力を受け取れます.

ここでは, 非同期プロセスの作成方法について述べます.

Function: start-process name buffer-or-name program &rest args

この関数は, 新たな非同期サブプロセスを作成し, そのプロセスでプログラムprogramを走らせる. Lispにおいて新たなサブプロセスを表すプロセスオブジェクトを返す. 引数nameはプロセスオブジェクトの名前を指定する. その名前のプロセスがすでに存在すると, 名前を一意にするために（‘<1>’などを付加して）nameを修正する. バッファbuffer-or-nameは, そのプロセスに対応付けるバッファである.

残りの引数argsは, プログラムに対するコマンド行引数を指定する文字列である.

つぎの例では, 最初のプロセスは動き始めると 100秒間（休止ではなく）動作する. そのあいだに2番目のプロセスを動かし始めると, 一意であるためにそれには名前‘my-process<1>’が与えられる. 2番目のプロセスは, 最初のプロセスが終了するまえにバッファ‘foo’にディレクトリ一覧を挿入する. 2番目のプロセスが終了するとそれを表すメッセージがバッファに挿入される. しばらくして最初のプロセスが終了すると, 別のメッセージがバッファに挿入される.

(start-process "my-process" "foo" "sleep" "100")
     ⇒ #<process my-process>

(start-process "my-process" "foo" "ls" "-l" "/user/lewis/bin")
     ⇒ #<process my-process<1>>

---------- Buffer: foo ----------
total 2
lrwxrwxrwx  1 lewis     14 Jul 22 10:12 gnuemacs --> /emacs
-rwxrwxrwx  1 lewis     19 Jul 30 21:02 lemon

Process my-process<1> finished

Process my-process finished
---------- Buffer: foo ----------

Function: start-process-shell-command name buffer-or-name command &rest command-args

この関数はstart-processと同様であるが, 指定したコマンドを実行するためにシェルを用いる点が異なる. 引数commandはシェルコマンドの名前であり, command-argsはそのシェルコマンドに対する引数である. 変数shell-file-nameは, 使用するシェルを指定する.

start-processで直接にではなくシェルを介してプログラムを実行すると, 引数のワイルドカードなどのシェルの機能を利用できる. つまり, ユーザー指定の任意のファイル名をコマンドに入れる場合には, まえもってshell-quote-argumentでクォートし, ファイル名内のシェルの特別な文字がそのような特別な意味を持たないようにする. see section シェル引数.

Variable: process-connection-type

この変数は, 非同期サブプロセスとの通信に用いる装置の型を制御する. これがnil以外であると疑似端末PTYを利用できる場合にはそれを用る. さもなければパイプを用いる.

シェル（shell）モードなどのユーザーに見えるプロセス向けには, パイプでは不可能なプロセスとその子プロセスとのあいだでジョブ制御（C-c, C-zなど）を許すので疑似端末PTYが望ましい. プログラムの内部目的向けに使われるサブプロセスでは, 効率的なパイプを用いるほうがよい. また, 多くのシステムでは疑似端末PTYの総数には制約があり, それらを浪費しないほうがよい.

process-connection-typeの値は start-processを呼び出したときに使われる. したがって, start-processの呼び出しの周りでこの変数を束縛することで, 1つのサブプロセスに対する通信方法を指定できる.

(let ((process-connection-type nil))  ; パイプを使う
  (start-process …))

サブプロセスが実際にはパイプか疑似端末PTYのどちらを使っているかを調べるには, 関数process-tty-nameを使う（see section プロセス情報）.

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

36.5 プロセスの削除

プロセスを削除するとは, サブプロセスからEmacsをただちに切り離し, サブプロセスを活性なプロセスリストから取り除くことです. サブプロセスへシグナルを送ってサブプロセスを終了させますが, ただちに終了するとは保証されません. プロセスオブジェクトを指すLispオブジェクトがある限り, プロセスオブジェクトは存在し続けます. プロセスマークは以前と同様に同じ場所（プロセスからの出力をバッファに挿入した箇所）を指し続けます.

プロセスはいつでも明示的に削除できます. プロセスは終了後に自動的に削除されますが, 終了後ただちにではありません. 終了したプロセスが自動的に削除されるまえに明示的に削除しても無害です.

User Option: delete-exited-processes: この変数は, （exitを呼び出すかシグナルのために）終了したプロセスの自動削除を制御する. nilであると, ユーザーがlist-processesを実行するまで存在し続ける. さもなければ, 終了後にただちに削除する.

Function: delete-process name

この関数は, nameに対応付けられたプロセスをシグナルSIGHUPでキルし削除する. 引数は, プロセス, プロセス名, バッファ, バッファ名のいずれかである.

(delete-process "*shell*")
     ⇒ nil

Function: process-kill-without-query process &optional do-query

この関数は, Emacsを終了するときにプロセスprocessが動作中であると, ユーザーに問い合わせるかどうかを指定する. do-queryがnilであると, プロセスを黙って削除する. さもなければ, Emacsはプロセスのキルに関して問い合わせる.

問い合わせるようにしてあったプロセスであると戻り値はtであり, さもなければ戻り値はnilである. 新たに作成されたプロセスは, つねに問い合わせ用になっている.

(process-kill-without-query (get-process "shell"))
     ⇒ t

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

36.6 プロセス情報

プロセスに関する情報を返す関数がいくつかあります. list-processesは対話的利用のためにあります.

コマンド: list-processes: このコマンドは, 活性なすべてのプロセスの一覧を表示する. さらに, ‘Exited’や‘Signaled’である状態のプロセスをすべて削除する. nilを返す.

Function: process-list

この関数は, 削除されていないすべてのプロセスのリストを返す.

(process-list)
     ⇒ (#<process display-time> #<process shell>)

Function: get-process name

この関数はnameという名前のプロセスを返す. あるいは, そのようなプロセスがなければnilを返す. nameが文字列でないとエラーを通知する.

(get-process "shell")
     ⇒ #<process shell>

Function: process-command process

この関数は, プロセスprocessを始動するために実行したコマンドを返す. これは文字列のリストであり, 最初の文字列は実行されたプログラム, 残りの文字列はそのプログラムに与えた引数である.

(process-command (get-process "shell"))
     ⇒ ("/bin/csh" "-i")

Function: process-id process: この関数は, プロセスprocessのプロセス番号PIDを返す. これは同じ計算機上で動いている他のすべてのプロセスとプロセスprocessを区別するための整数である. プロセスのPIDは, プロセスを始動したときにオペレーティングシステムのカーネルが選び, プロセスが終了するまで変わらない.

Function: process-name process: この関数はプロセスprocessの名前を返す.

Function: process-contact process: この関数は, 通常の子プロセスに対してはtを返し, ネットワーク接続に対しては(hostname service)を返す（see section ネットワーク接続）.

Function: process-status process-name

この関数は, process-nameの状態をシンボルとして返す. 引数process-nameは, プロセス, バッファ, プロセス名（文字列）, バッファ名（文字列）のいずれかであること.

実際のサブプロセスに対して可能な値はつぎのとおり.

run: 実行中のプロセスである.
stop: 一時停止しているが継続可能である.
exit: 終了したプロセス.
signal: 致命的なシグナルを受け取ったプロセスである.
open: ネットワーク接続を開いている.
closed: ネットワーク接続は閉じている. 接続をいったん閉じるとそれを再度開くことはできないが, 同じ接続先へ新たな接続を開くことはできる.
nil: process-nameは既存プロセスの名前ではない.

(process-status "shell")
     ⇒ run

(process-status (get-buffer "*shell*"))
     ⇒ run

x
     ⇒ #<process xx<1>>
(process-status x)
     ⇒ exit

ネットワーク接続では, process-statusはシンボルopenかclosedのいずれかを返す. 後者は, 相手側が接続を閉じたか Emacsがdelete-processを行ったことを表す.

Function: process-exit-status process: この関数は, プロセスprocessの終了状態か, プロセスをキルしたシグナル番号を返す. （どちらであるかを判定するには, process-statusの結果を用いる. ） processが終了していないと値は0である.

Function: process-tty-name process: この関数は, プロセスprocessがEmacsとの通信に用いている端末名を返す. あるいは, 端末のかわりにパイプを用いていればnilを返す（非同期プロセスの作成のprocess-connection-typeを参照）.

Function: process-coding-system process

この関数は, プロセスprocessからの出力を復号化するために用いているコーディングシステムと, processへの入力を符号化するために用いているコーディングシステムを記述するコンスセルを返す.

(coding-system-for-decoding . coding-system-for-encoding)

Function: set-process-coding-system process decoding-system encoding-system: この関数は, プロセスprocessからの以降の出力および入力に用いるコーディングシステムを指定する. サブプロセスから出力の復号化にはdecoding-systemを使い, サブプロセスの入力の符号化にはencoding-systemを使う.

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

36.7 プロセスへ入力を送る

本節の関数を用いてEmacsが入力を送ると, 非同期プロセスは入力を受け取ります. 入力の送先であるプロセスと, 送るべき入力データを指定する必要があります. そのデータは, サブプロセスの『標準入力』に現れます.

疑似端末PTYのバッファ付き入力の容量に上限があるオペレーティングシステムもあります. そのようなシステムでは, Emacsは他の文字に混ぜて定期的にEOFを送り, 文字が流れるように強制します. ほとんどのプログラムでは, このようなEOFは無害なはずです.

ファイルに書き込むテキストと同様に, サブプロセスの入力は, サブプロセスがそれを受け取るまえにコーディングシステムを用いて普通は符号化されます. set-process-coding-systemで使用するコーディングシステムを指定できます（see section プロセス情報）. さもなければ, coding-system-for-writeが nil以外であればこれを使います. それ以外ではデフォルトの機構で決まるものを使います（see section デフォルトのコーディングシステム）.

Function: process-send-string process-name string

この関数は, 文字列stringの内容を標準入力としてプロセスprocess-nameに送る. 引数process-nameは, プロセスかプロセス名であること. これがnilであると, カレントバッファのプロセスを用いる.

関数はnilを返す.

(process-send-string "shell<1>" "ls\n")
     ⇒ nil

---------- Buffer: *shell* ----------
...
introduction.texi               syntax-tables.texi~
introduction.texi~              text.texi
introduction.txt                text.texi~
...
---------- Buffer: *shell* ----------

コマンド: process-send-region process-name start end

この関数は, startとendで定義される領域内のテキストを標準入力としてプロセスprocess-nameへ送る. process-nameはプロセスかプロセス名であること. （nilであると, カレントバッファのプロセスを使う. ）

startとendのどちらかがカレントバッファ内の位置を表す整数でもマーカでもないと, エラーを通知する. （どちらが大きな数であるかは重要ではない. ）

Function: process-send-eof &optional process-name

この関数は, プロセスprocess-nameが入力で「ファイルの終りEOF」を見るようにする. EOFはそれまでに送ったテキストのあとにある.

process-nameを指定しなかったりnilであると, この関数はカレントバッファのプロセスにEOFを送る. カレントバッファにプロセスがないとエラーを通知する.

関数はprocess-nameを返す.

(process-send-eof "shell")
     ⇒ "shell"

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

36.8 プロセスにシグナルを送る

サブプロセスにシグナルを送ることは, サブプロセスの動作に割り込む一方法です. それぞれ独自の意味を持つ異なるシグナルがいくつかあります. 一連のシグナルとそれらの名前は, オペレーティングシステムが定義します. たとえば, シグナルSIGINTは, ユーザーがC-cを打った, あるいは, それと同様なことが起こったことを意味します.

各シグナルには, サブプロセスに対する標準的な効果があります. ほとんどのシグナルはサブプロセスをキルしますが, その実行を一時停止したり再開するものもあります. プログラムがシグナルを処理している場合には, シグナルの効果を一般的に述べることはできません.

本節の関数を呼び出してシグナルを明示的に送ることができます. また, Emacsは特定の場面で自動的にシグナルを送ります. バッファを削除すると, そのバッファに対応付けられているすべてのプロセスにシグナルSIGHUPを送ります. Emacsを終了するときには, 動作しているすべてのサブプロセスにシグナルSIGHUPを送ります. （SIGHUPは, ユーザーが電話を切ったことを普通は表すシグナル. ）

シグナルを送る各関数は, 省略可能な2つの引数, process-nameとcurrent-groupを受け付けます.

引数process-nameは, プロセス, プロセス名, nilのいずれかです. これがnilであると, カレントバッファに対応付けられているプロセスがデフォルトになります. process-nameがプロセスを指定しないとエラーを通知します.

引数current-groupは, Emacsのサブプロセスとしてジョブ制御可能なシェルを実行しているときに違いが現れるフラグです. これがnil以外であると, Emacsがサブプロセスとの通信に用いている端末の現在のプロセスグループにシグナルを送ります. プロセスがジョブ制御可能なシェルであると, これはシェルの現在のサブジョブ (10) であることを意味します. nilであると, Emacsのサブプロセスの直接のプロセスグループにシグナルを送ります. プロセスがジョブ制御可能なシェルであると, これはシェルそのものです.

オペレーティングシステムはパイプではプロセスグループを扱わないため, サブプロセスとの通信にパイプを用いている場合には, フラグcurrent-groupには効果はありません. 同じ理由で, パイプを用いている場合にはジョブ制御可能なシェル（のジョブ制御機能）は働きません. 非同期プロセスの作成の process-connection-typeを参照してください.

Function: interrupt-process &optional process-name current-group: この関数は, プロセスprocess-nameにシグナルSIGINTを送って割り込む. Emacsの外側では, 『割り込み文字』（普通, C-cであるシステムもあり, その他のシステムではDEL）を打つとこのシグナルを送る. 引数current-groupがnil以外であると, この関数は, Emacsがサブプロセスと通信している端末上で『C-cを打つ』と考えることができる.

Function: kill-process &optional process-name current-group: この関数は, プロセスprocess-nameにシグナルSIGKILLを送ってキルする. このシグナルはサブプロセスを即座にキルし, サブプロセスはこれを処理できない.

Function: quit-process &optional process-name current-group: この関数は, プロセスprocess-nameにシグナルSIGQUITを送る. このシグナルは, 『中断文字』（Emacsの外側では普通はC-bやC-\）が送るシグナルと同じものである.

Function: stop-process &optional process-name current-group

この関数は, プロセスprocess-nameにシグナルSIGTSTPを送って一時停止させる. その実行を再開させるにはcontinue-processを使う.

Emacsの外側でジョブ制御可能なシステムでは, 『一時停止文字』（普通はC-z）が普通はこのシグナルを送る. current-groupがnil以外であると, この関数は, Emacsがサブプロセスと通信している端末上で『C-zを打つ』と考えることができる.

Function: continue-process &optional process-name current-group: この関数は, プロセスprocessにシグナルSIGTCONTを送って実行を再開させる. 以前に一時停止させられたprocessを再開する.

Function: signal-process pid signal: この関数は, 必ずしもEmacsの子プロセスではないプロセスpidにシグナルを送る. 引数signalは, 送るべきシグナルを整数で指定する.

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

36.9 プロセスからの出力を受け取る

サブプロセスが標準出力に書く出力を受け取る方法は2つあります. プロセスに対応付けられたバッファに出力を挿入するか, あるいは, フィルタ関数（filter function）と呼ばれる関数を出力に対して作用させます. プロセスにバッファもフィルタ関数もなければ, その出力は破棄します.

サブプロセスからの出力は, Emacsが待っている, つまり, 端末入力を読んでいるとき, sit-forやsleep-forを実行中のとき（see section 時間待ちと入力待ち）, accept-process-output（see section プロセスからの出力を受け取る）を実行中のときにだけ到着します. これにより, 並行プログラムを普通は悩ますようなタイミングエラーの問題を最小に抑えます. たとえば, 安全にプロセスを作成してから, バッファかフィルタ関数を指定できます. この処理の途中で待つような基本関数を呼び出さなければ, 出力は到着しません.

ファイルから読むテキストと同様に, サブプロセスの出力は, バッファやフィルタ関数が受け取るまえにコーディングシステムを用いて普通は復号化します. set-process-coding-systemで使用するコーディングシステムを指定できます（see section プロセス情報）. さもなければ, coding-system-for-readが nil以外であればこれを使います. それ以外ではデフォルトの機構で決まるものを使います（see section デフォルトのコーディングシステム）.

警告： データからコーディングシステムを決定するundecidedのようなコーディングシステムは, 非同期サブプロセスの出力に対しては完全に信頼性のある動作はできない. これは, Emacsが非同期サブプロセスの出力が到着するたびに一塊で処理するからである. Emacsは1つの塊から正しい変換を検出しようと試みるが, これがつねに動作するとは限らない. したがって, 可能な限り文字コード変換と行末変換の両方を指定したコーディングシステムを使う. つまり, undecidedやlatin-1などではなく, latin-1-unixのようなものを使う.

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

36.9.1 プロセスバッファ

プロセスには対応付けられたバッファが（普通は）あります. そのバッファはEmacsの普通のバッファであり, 2つの目的に使われます. プロセスからの出力を保存することと, プロセスがキルされたことを判定するためです. バッファを用いてそれを操作しているプロセスを識別することもできます. 普通は1つのバッファに1つのプロセスを対応付けるからです. プロセスの多くの応用では, プロセスへ送る入力を編集するためにバッファを使いますが, これはEmacs Lispに組み込まれたことではありません.

プロセスにフィルタ関数（see section プロセスフィルタ関数）がなければ, その出力は対応付けられたバッファに挿入されます. 出力の挿入位置はprocess-markで決定され, process-markは挿入したばかりのテキストの末尾を指すように更新されます. process-markは普通はバッファの末尾にありますが, つねにそうであるとは限りません.

Function: process-buffer process

この関数は, プロセスprocessに対応付けられているバッファを返す.

(process-buffer (get-process "shell"))
     ⇒ #<buffer *shell*>

Function: process-mark process

この関数は, プロセスprocessからの出力を挿入する箇所を指定する processのプロセスマーカを返す.

processにバッファがなければ, process-markはどこも指していないマーカである.

バッファにプロセス出力を挿入する際には, 挿入箇所を決定するためにこのマーカを使用し, 挿入したテキストの末尾を指すようにこのマーカを更新する. これにより, 出力の連続した塊を順に挿入できるのである.

バッファに出力を直接挿入する場合と同様に, フィルタ関数はこのマーカを扱うべきである. process-markを用いたフィルタ関数の好例は, 以下の節にある.

プロセスへ送るためにユーザーがプロセスバッファに入力することが予想されるときは, プロセスマーカは新たな入力とそれ以前の出力を区切る.

Function: set-process-buffer process buffer: この関数は, プロセスprocessにバッファbufferを対応付ける. bufferがnilであると, プロセスに対応付けられたバッファはない.

Function: get-buffer-process buffer-or-name

この関数はbuffer-or-nameに対応付けられたプロセスを返す. バッファに複数のプロセスが対応付けられている場合には, それらの1つを選ぶ. （現状では, もっとも最近に作られたプロセスを選ぶ. ）同じバッファに複数のプロセスを対応付けることは一般にはよくない.

(get-buffer-process "*shell*")
     ⇒ #<process shell>

プロセスのバッファを削除すると, サブプロセスにシグナルSIGHUPを送ってプロセスを削除する（see section プロセスにシグナルを送る）.

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

36.9.2 プロセスフィルタ関数

プロセスのフィルタ関数（filter function）は, 対応付けられたプロセスからの標準出力を受け取る関数です. プロセスにフィルタがあると, そのプロセスからのすべての出力はフィルタに渡されます. プロセスにフィルタがない場合に限って, プロセスからの出力向けにプロセスバッファを直接使います.

フィルタ関数は, Emacsがなにかを待っているときにのみ呼ばれます. そのような期間にのみプロセスの出力が到着するからです. Emacsが待つのは, 端末入力を読んでいるとき, sit-forやsleep-forを実行中のとき（see section 時間待ちと入力待ち）, accept-process-output（see section プロセスからの出力を受け取る）を実行中のときです.

フィルタ関数は2つの引数, 対応付けられたプロセスとそのプロセスから受け取ったばかりの出力である文字列を受け取ります. 関数は出力に対してなにを行ってもかまいません.

フィルタ関数の内側では中断は普通は禁止されています. さもないと, コマンドレベルで打ったC-gの効果や, ユーザーコマンドを中断するために打ったC-gの効果は予測できません. フィルタ関数の内側で中断を行いたい場合には, inhibit-quitにnilを束縛します. See section 中断.

フィルタ関数の実行中にエラーが発生するとそのエラーは自動的に捕捉され, フィルタ関数を始動したときに動いていたプログラムの実行を停止しないようにします. しかし, debug-on-errorがnil以外であると, エラーを捕捉しません. これにより, Lispデバッガでフィルタ関数をデバッグできます. See section Lispデバッガ.

多くのフィルタ関数は, ときどきあるいはつねに, プロセスのバッファにテキストを挿入します. これはフィルタ関数がないときのEmacsの動作を模倣するものです. そのようなフィルタ関数では, 対象のバッファに挿入するために set-bufferを使う必要があります. カレントバッファをなかば恒久的に切り替えないように, これらのフィルタ関数はカレントバッファを記録／復元する必要があります. プロセスマーカを更新し, 必要に応じてポイントの値も更新します. これらはつぎのように行います.

(defun ordinary-insertion-filter (proc string)
  (with-current-buffer (process-buffer proc)
    (let ((moving (= (point) (process-mark proc))))

      (save-excursion
        ;; テキストを挿入し, プロセスマーカを進める
        (goto-char (process-mark proc))
        (insert string)
        (set-marker (process-mark proc) (point)))
      (if moving (goto-char (process-mark proc))))))

カレントバッファを記録／復元するためにsave-excursionではなく with-current-bufferを使うのは, 2番目のgoto-charの呼び出しで行うポイントの移動効果を有効にするためです.

新たにテキストが到着するたびにプロセスバッファが見えるようにフィルタ関数で強制するには, つぎのような行をwith-current-bufferの直前に入れます.

(display-buffer (process-buffer proc))

ポイント位置に関わらずに新たな出力の末尾にポイントを移動するには, 変数movingを削除して, 無条件にgoto-charを呼び出します.

Emacsの初期の版では, 正規表現を探索したり一致処理するフィルタ関数では, マッチデータを明示的に保存／復元する必要がありました. 今のEmacsは, フィルタ関数に対してはこれを自動的に行いますから, フィルタ関数で明示的に行う必要はありません. See section マッチデータ.

プロセスのバッファに出力を書き込むフィルタ関数は, そのバッファが有効であるかどうかを検査するべきです. 無効なバッファに挿入しようとするとエラーになります. バッファが無効であれば, 式(buffer-name (process-buffer process)) を実行するとnilを返します.

関数に渡される出力は任意のサイズの塊できます. 同じ出力を2回生成するプログラムは, あるときには一度に200文字の塊を1つ送る場合もあれば, 40文字の塊を5つ送る場合もあります. サブプロセスの出力から特定のテキスト文字列を探すフィルタでは, そのような文字列が2つかそれ以上の出力の塊に分割される場合も扱えるようにします.

Function: set-process-filter process filter: この関数は, プロセスprocessにフィルタ関数filterを指定する. filterがnilであると, プロセスにフィルタはない.

Function: process-filter process: この関数は, プロセスprocessのフィルタ関数を返す. あるいは, フィルタ関数がなければnilを返す.

フィルタ関数の使用例をつぎに示します.

(defun keep-output (process output)
   (setq kept (cons output kept)))
     ⇒ keep-output

(setq kept nil)
     ⇒ nil

(set-process-filter (get-process "shell") 'keep-output)
     ⇒ keep-output

(process-send-string "shell" "ls ~/other\n")
     ⇒ nil
kept
     ⇒ ("lewis@slug[8] % "

"FINAL-W87-SHORT.MSS    backup.otl              kolstad.mss~
address.txt             backup.psf              kolstad.psf
backup.bib~             david.mss               resume-Dec-86.mss~
backup.err              david.psf               resume-Dec.psf
backup.mss              dland                   syllabus.mss
"
"#backups.mss#          backup.mss~             kolstad.mss
")

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

36.9.3 プロセスからの出力を受け取る

非同期サブプロセスからの出力は, Emacsが時間待ちや端末入力などのなんらかの外部事象を待っているときにのみ到着します. Lispプログラムから特定の場面で出力の到着を明示的に許したり, プロセスの出力が到着するのを待つことができると有用なことがあります.

Function: accept-process-output &optional process seconds millisec

この関数は, Emacsにプロセスからの未処理の出力を読み取ることを許す. その出力は, 対応付けられたバッファに挿入されるか, フィルタ関数に与えられる. processがnil以外であると, この関数は, processからなんらかの出力を得るまで戻らない.

引数secondsとmillisecは, 時間切れを指定する. 前者は秒単位の時間, 後者はミリ秒単位の時間を指定する. 指定された2つの時間は合計され, 任意のサブプロセスの出力を受け取ったどうかに関わらず, その時間だけ経過するとaccept-process-outputは戻ってくる.

引数secondsは整数である必要はない. 浮動小数点数であると, この関数は秒未満の時間も待つ. 秒未満を扱えないシステムもある. そのようなシステムでは, secondsを切り下げる.

すべてのオペレーティングシステムで秒未満を扱えるわけではない. 扱えないシステムでmillisecにゼロ以外を指定するとエラーになる.

関数accept-process-outputは, 出力を得るとnil以外を返す. あるいは, 出力が到着するまえに時間切れするとnilを返す.

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

36.10 番兵：プロセスの状態変化の検出

プロセスの番兵（process sentinel）は, プロセスを終了／一時停止／継続させる（Emacsが送ったかプロセス自身の動作によって生起した）シグナルを含めて対応付けられたプロセスの状態が任意の理由で変化したときに呼び出される関数です. プロセスの番兵は, プロセスが終了しても呼び出されます. 番兵は2つの引数, 事象が発生したプロセスと事象の種類を記述する文字列を受け取ります.

事象を記述する文字列はつぎのとおりです.

"finished\n".
"exited abnormally with code exitcode\n".
"name-of-signal\n".
"name-of-signal (core dumped)\n".

番兵はEmacsが（たとえば, 端末入力や時間経過, プロセスの出力を）待っているときにのみ実行されます. 他のLispプログラムの実行途中で無秩序に番兵を実行した場合に起こるタイミングエラーを回避するためです. sit-forやsleep-for（see section 時間待ちと入力待ち）, あるいは, accept-process-output（see section プロセスからの出力を受け取る）を呼び出すとプログラムは待ちに入り, 番兵が動けることになります. Emacsは, コマンドループで入力を読むときにも番兵の実行を許します.

番兵の内側では中断は普通は禁止されています. さもないと, コマンドレベルで打ったC-gの効果や, ユーザーコマンドを中断するために打ったC-gの効果は予測できません. 番兵の内側で中断を行いたい場合には, inhibit-quitにnilを束縛します. See section 中断.

プロセスのバッファに出力を書き込む番兵は, そのバッファが有効であるかどうかを検査するべきです. 無効なバッファに挿入しようとするとエラーになります. バッファが無効であれば, 式(buffer-name (process-buffer process)) を実行するとnilを返します.

番兵の実行中にエラーが発生するとそのエラーは自動的に捕捉され, 番兵を始動したときに動いていたプログラムの実行を停止しないようにします. しかし, debug-on-errorがnil以外であると, エラーを捕捉しません. これにより, Lispデバッガで番兵をデバッグできます. See section Lispデバッガ.

Emacsの初期の版では, 正規表現を探索したり一致処理する番兵では, マッチデータを明示的に保存／復元する必要がありました. 今のEmacsは, 番兵に対してはこれを自動的に行いますから, 番兵で明示的に行う必要はありません. See section マッチデータ.

Function: set-process-sentinel process sentinel

この関数は, プロセスprocessに番兵sentinelを対応付ける. sentinelがnilであると, プロセスに番兵はない. 番兵がない場合のデフォルトのふるまいは, プロセス状態が変化するとプロセスのバッファにメッセージを挿入する.

(defun msg-me (process event)
   (princ
     (format "Process: %s had the event `%s'" process event)))
(set-process-sentinel (get-process "shell") 'msg-me)
     ⇒ msg-me

(kill-process (get-process "shell"))
     -| Process: #<process shell> had the event `killed'
     ⇒ #<process shell>

Function: process-sentinel process: この関数は, プロセスprocessの番兵を返すか, 番兵がなければnilを返す.

Function: waiting-for-user-input-p: 番兵やフィルタ関数が動作中にこの関数を呼び出すと, 番兵やフィルタ関数を呼び出したときにEmacsがユーザーからのキーボード入力を待ってるとnil以外を返し, それ以外ではnilを返す.

[ < ]

[ > ]

[ << ]

[上]

[ >> ]

[ ? ]

36.11 トランザクションキュー

トランザクションを用いたサブプロセスとの通信に トランザクションキュー（transaction queue）を使えます. まずtq-createを用いて, 指定したプロセスとの通信用トランザクションキューを作成します. そして, トランザクションを送るためにtq-enqueueを呼び出します.

Function: tq-create process: この関数は, プロセスprocessとの通信用トランザクションキューを作成して返す. 引数processは, バイトストリームを送受信できる機能を有するサブプロセスであること. つまり, 子プロセスであるか, 別のマシン上の可能性もあるサーバーへのTCP接続である.

Function: tq-enqueue queue question regexp closure fn

この関数はキューqueueにトランザクションを送る. キューを指定することは, 通信相手のサブプロセスを指定する効果がある.

引数questionは, トランザクションを始める送出メッセージである. 引数fnは, 対応する応答が戻ってきたときに呼び出す関数である. その関数は2つの引数, closureと受け取った応答で呼び出される.

引数regexpは, 1つの応答だけに一致する正規表現である. tq-enqueueが応答の末尾を判定するために使う.

tq-enqueueの戻り値そのものに意味はない.

Function: tq-close queue: 未処理のトランザクションすべてが完了するのを待ち, 接続や子プロセスを終了して, トランザクションキューqueueを終える.

トランザクションキューはフィルタ関数を用いて実装してあります. See section プロセスフィルタ関数.

[ << ]

[ >> ]