Mercurial > emacs
annotate lispref/processes.texi @ 19968:88dd57f50303
Merge changes mistakenly made to `Makefile'.
(INFO_TARGETS): Change ../info/custom to ../info/customize.
(../info/customize): Renamed from ../info/custom.
(../info/viper, viper.dvi): Remove dependency on viper-cmd.texi.
author | Paul Eggert <eggert@twinsun.com> |
---|---|
date | Tue, 23 Sep 1997 18:23:17 +0000 |
parents | 1b2afa6391ca |
children | 66d807bdc5b4 |
rev | line source |
---|---|
6558 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. | |
4 @c See the file elisp.texi for copying conditions. | |
5 @setfilename ../info/processes | |
6 @node Processes, System Interface, Abbrevs, Top | |
7 @chapter Processes | |
8 @cindex child process | |
9 @cindex parent process | |
10 @cindex subprocess | |
11 @cindex process | |
12 | |
13 In the terminology of operating systems, a @dfn{process} is a space in | |
14 which a program can execute. Emacs runs in a process. Emacs Lisp | |
15 programs can invoke other programs in processes of their own. These are | |
16 called @dfn{subprocesses} or @dfn{child processes} of the Emacs process, | |
17 which is their @dfn{parent process}. | |
18 | |
19 A subprocess of Emacs may be @dfn{synchronous} or @dfn{asynchronous}, | |
20 depending on how it is created. When you create a synchronous | |
21 subprocess, the Lisp program waits for the subprocess to terminate | |
22 before continuing execution. When you create an asynchronous | |
23 subprocess, it can run in parallel with the Lisp program. This kind of | |
24 subprocess is represented within Emacs by a Lisp object which is also | |
25 called a ``process''. Lisp programs can use this object to communicate | |
26 with the subprocess or to control it. For example, you can send | |
27 signals, obtain status information, receive output from the process, or | |
28 send input to it. | |
29 | |
30 @defun processp object | |
31 This function returns @code{t} if @var{object} is a process, | |
32 @code{nil} otherwise. | |
33 @end defun | |
34 | |
35 @menu | |
36 * Subprocess Creation:: Functions that start subprocesses. | |
37 * Synchronous Processes:: Details of using synchronous subprocesses. | |
7411
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
38 * MS-DOS Subprocesses:: On MS-DOS, you must indicate text vs binary |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
39 for data sent to and from a subprocess. |
6558 | 40 * Asynchronous Processes:: Starting up an asynchronous subprocess. |
41 * Deleting Processes:: Eliminating an asynchronous subprocess. | |
42 * Process Information:: Accessing run-status and other attributes. | |
43 * Input to Processes:: Sending input to an asynchronous subprocess. | |
44 * Signals to Processes:: Stopping, continuing or interrupting | |
45 an asynchronous subprocess. | |
46 * Output from Processes:: Collecting output from an asynchronous subprocess. | |
47 * Sentinels:: Sentinels run when process run-status changes. | |
48 * Transaction Queues:: Transaction-based communication with subprocesses. | |
12098 | 49 * Network:: Opening network connections. |
6558 | 50 @end menu |
51 | |
52 @node Subprocess Creation | |
53 @section Functions that Create Subprocesses | |
54 | |
55 There are three functions that create a new subprocess in which to run | |
56 a program. One of them, @code{start-process}, creates an asynchronous | |
57 process and returns a process object (@pxref{Asynchronous Processes}). | |
58 The other two, @code{call-process} and @code{call-process-region}, | |
59 create a synchronous process and do not return a process object | |
60 (@pxref{Synchronous Processes}). | |
61 | |
62 Synchronous and asynchronous processes are explained in following | |
63 sections. Since the three functions are all called in a similar | |
64 fashion, their common arguments are described here. | |
65 | |
66 @cindex execute program | |
67 @cindex @code{PATH} environment variable | |
68 @cindex @code{HOME} environment variable | |
69 In all cases, the function's @var{program} argument specifies the | |
70 program to be run. An error is signaled if the file is not found or | |
71 cannot be executed. If the file name is relative, the variable | |
72 @code{exec-path} contains a list of directories to search. Emacs | |
73 initializes @code{exec-path} when it starts up, based on the value of | |
74 the environment variable @code{PATH}. The standard file name | |
75 constructs, @samp{~}, @samp{.}, and @samp{..}, are interpreted as usual | |
76 in @code{exec-path}, but environment variable substitutions | |
77 (@samp{$HOME}, etc.) are not recognized; use | |
78 @code{substitute-in-file-name} to perform them (@pxref{File Name | |
79 Expansion}). | |
80 | |
81 Each of the subprocess-creating functions has a @var{buffer-or-name} | |
82 argument which specifies where the standard output from the program will | |
83 go. If @var{buffer-or-name} is @code{nil}, that says to discard the | |
84 output unless a filter function handles it. (@xref{Filter Functions}, | |
7411
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
85 and @ref{Read and Print}.) Normally, you should avoid having multiple |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
86 processes send output to the same buffer because their output would be |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
87 intermixed randomly. |
6558 | 88 |
89 @cindex program arguments | |
90 All three of the subprocess-creating functions have a @code{&rest} | |
91 argument, @var{args}. The @var{args} must all be strings, and they are | |
92 supplied to @var{program} as separate command line arguments. Wildcard | |
93 characters and other shell constructs are not allowed in these strings, | |
94 since they are passed directly to the specified program. | |
95 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7411
diff
changeset
|
96 @strong{Please note:} The argument @var{program} contains only the |
6558 | 97 name of the program; it may not contain any command-line arguments. You |
98 must use @var{args} to provide those. | |
99 | |
100 The subprocess gets its current directory from the value of | |
101 @code{default-directory} (@pxref{File Name Expansion}). | |
102 | |
103 @cindex environment variables, subprocesses | |
104 The subprocess inherits its environment from Emacs; but you can | |
105 specify overrides for it with @code{process-environment}. @xref{System | |
106 Environment}. | |
107 | |
108 @defvar exec-directory | |
17611
1b2afa6391ca
(exec-directory): Wakeup no longer exists, so use movemail as example.
Richard M. Stallman <rms@gnu.org>
parents:
16664
diff
changeset
|
109 @pindex movemail |
6558 | 110 The value of this variable is the name of a directory (a string) that |
111 contains programs that come with GNU Emacs, that are intended for Emacs | |
17611
1b2afa6391ca
(exec-directory): Wakeup no longer exists, so use movemail as example.
Richard M. Stallman <rms@gnu.org>
parents:
16664
diff
changeset
|
112 to invoke. The program @code{movemail} is an example of such a program; |
1b2afa6391ca
(exec-directory): Wakeup no longer exists, so use movemail as example.
Richard M. Stallman <rms@gnu.org>
parents:
16664
diff
changeset
|
113 Rmail uses it to fetch new mail from an inbox. |
6558 | 114 @end defvar |
115 | |
116 @defopt exec-path | |
117 The value of this variable is a list of directories to search for | |
118 programs to run in subprocesses. Each element is either the name of a | |
119 directory (i.e., a string), or @code{nil}, which stands for the default | |
120 directory (which is the value of @code{default-directory}). | |
121 @cindex program directories | |
122 | |
123 The value of @code{exec-path} is used by @code{call-process} and | |
124 @code{start-process} when the @var{program} argument is not an absolute | |
125 file name. | |
126 @end defopt | |
127 | |
128 @node Synchronous Processes | |
129 @section Creating a Synchronous Process | |
130 @cindex synchronous subprocess | |
131 | |
132 After a @dfn{synchronous process} is created, Emacs waits for the | |
133 process to terminate before continuing. Starting Dired is an example of | |
134 this: it runs @code{ls} in a synchronous process, then modifies the | |
135 output slightly. Because the process is synchronous, the entire | |
136 directory listing arrives in the buffer before Emacs tries to do | |
137 anything with it. | |
138 | |
139 While Emacs waits for the synchronous subprocess to terminate, the | |
140 user can quit by typing @kbd{C-g}. The first @kbd{C-g} tries to kill | |
141 the subprocess with a @code{SIGINT} signal; but it waits until the | |
142 subprocess actually terminates before quitting. If during that time the | |
143 user types another @kbd{C-g}, that kills the subprocess instantly with | |
144 @code{SIGKILL} and quits immediately. @xref{Quitting}. | |
145 | |
146 The synchronous subprocess functions returned @code{nil} in version | |
147 18. In version 19, they return an indication of how the process | |
148 terminated. | |
149 | |
12067 | 150 @defun call-process program &optional infile destination display &rest args |
6558 | 151 This function calls @var{program} in a separate process and waits for |
152 it to finish. | |
153 | |
154 The standard input for the process comes from file @var{infile} if | |
12067 | 155 @var{infile} is not @code{nil} and from @file{/dev/null} otherwise. |
156 The argument @var{destination} says where to put the process output. | |
157 Here are the possibilities: | |
158 | |
159 @table @asis | |
160 @item a buffer | |
161 Insert the output in that buffer, before point. This includes both the | |
162 standard output stream and the standard error stream of the process. | |
163 | |
164 @item a string | |
16664
f67402af7555
call-process does not create a buffer.
Richard M. Stallman <rms@gnu.org>
parents:
15759
diff
changeset
|
165 Find the buffer with that name, then insert the output in that buffer, |
f67402af7555
call-process does not create a buffer.
Richard M. Stallman <rms@gnu.org>
parents:
15759
diff
changeset
|
166 before point. |
12067 | 167 |
168 @item @code{t} | |
169 Insert the output in the current buffer, before point. | |
170 | |
171 @item @code{nil} | |
172 Discard the output. | |
6558 | 173 |
12067 | 174 @item 0 |
175 Discard the output, and return immediately without waiting | |
176 for the subprocess to finish. | |
177 | |
178 In this case, the process is not truly synchronous, since it can run in | |
179 parallel with Emacs; but you can think of it as synchronous in that | |
180 Emacs is essentially finished with the subprocess as soon as this | |
181 function returns. | |
182 | |
183 @item (@var{real-destination} @var{error-destination}) | |
184 Keep the standard output stream separate from the standard error stream; | |
185 deal with the ordinary output as specified by @var{real-destination}, | |
186 and dispose of the error output according to @var{error-destination}. | |
187 The value @code{nil} means discard it, @code{t} means mix it with the | |
188 ordinary output, and a string specifies a file name to redirect error | |
189 output into. | |
190 | |
191 You can't directly specify a buffer to put the error output in; that is | |
192 too difficult to implement. But you can achieve this result by sending | |
193 the error output to a temporary file and then inserting the file into a | |
194 buffer. | |
195 @end table | |
6558 | 196 |
197 If @var{display} is non-@code{nil}, then @code{call-process} redisplays | |
198 the buffer as output is inserted. Otherwise the function does no | |
199 redisplay, and the results become visible on the screen only when Emacs | |
200 redisplays that buffer in the normal course of events. | |
201 | |
202 The remaining arguments, @var{args}, are strings that specify command | |
203 line arguments for the program. | |
204 | |
205 The value returned by @code{call-process} (unless you told it not to | |
206 wait) indicates the reason for process termination. A number gives the | |
207 exit status of the subprocess; 0 means success, and any other value | |
208 means failure. If the process terminated with a signal, | |
209 @code{call-process} returns a string describing the signal. | |
210 | |
211 In the examples below, the buffer @samp{foo} is current. | |
212 | |
213 @smallexample | |
214 @group | |
215 (call-process "pwd" nil t) | |
216 @result{} nil | |
217 | |
218 ---------- Buffer: foo ---------- | |
219 /usr/user/lewis/manual | |
220 ---------- Buffer: foo ---------- | |
221 @end group | |
222 | |
223 @group | |
224 (call-process "grep" nil "bar" nil "lewis" "/etc/passwd") | |
225 @result{} nil | |
226 | |
227 ---------- Buffer: bar ---------- | |
228 lewis:5LTsHm66CSWKg:398:21:Bil Lewis:/user/lewis:/bin/csh | |
229 | |
230 ---------- Buffer: bar ---------- | |
231 @end group | |
232 @end smallexample | |
233 | |
234 The @code{insert-directory} function contains a good example of the use | |
235 of @code{call-process}: | |
236 | |
237 @smallexample | |
238 @group | |
239 (call-process insert-directory-program nil t nil switches | |
240 (if full-directory-p | |
241 (concat (file-name-as-directory file) ".") | |
242 file)) | |
243 @end group | |
244 @end smallexample | |
245 @end defun | |
246 | |
12067 | 247 @defun call-process-region start end program &optional delete destination display &rest args |
6558 | 248 This function sends the text between @var{start} to @var{end} as |
249 standard input to a process running @var{program}. It deletes the text | |
250 sent if @var{delete} is non-@code{nil}; this is useful when @var{buffer} | |
251 is @code{t}, to insert the output in the current buffer. | |
252 | |
12067 | 253 The arguments @var{destination} and @var{display} control what to do |
6558 | 254 with the output from the subprocess, and whether to update the display |
255 as it comes in. For details, see the description of | |
12067 | 256 @code{call-process}, above. If @var{destination} is the integer 0, |
6558 | 257 @code{call-process-region} discards the output and returns @code{nil} |
258 immediately, without waiting for the subprocess to finish. | |
259 | |
260 The remaining arguments, @var{args}, are strings that specify command | |
261 line arguments for the program. | |
262 | |
263 The return value of @code{call-process-region} is just like that of | |
264 @code{call-process}: @code{nil} if you told it to return without | |
265 waiting; otherwise, a number or string which indicates how the | |
266 subprocess terminated. | |
267 | |
268 In the following example, we use @code{call-process-region} to run the | |
269 @code{cat} utility, with standard input being the first five characters | |
270 in buffer @samp{foo} (the word @samp{input}). @code{cat} copies its | |
271 standard input into its standard output. Since the argument | |
12067 | 272 @var{destination} is @code{t}, this output is inserted in the current |
6558 | 273 buffer. |
274 | |
275 @smallexample | |
276 @group | |
277 ---------- Buffer: foo ---------- | |
278 input@point{} | |
279 ---------- Buffer: foo ---------- | |
280 @end group | |
281 | |
282 @group | |
283 (call-process-region 1 6 "cat" nil t) | |
284 @result{} nil | |
285 | |
286 ---------- Buffer: foo ---------- | |
287 inputinput@point{} | |
288 ---------- Buffer: foo ---------- | |
289 @end group | |
290 @end smallexample | |
291 | |
292 The @code{shell-command-on-region} command uses | |
293 @code{call-process-region} like this: | |
294 | |
295 @smallexample | |
296 @group | |
297 (call-process-region | |
298 start end | |
299 shell-file-name ; @r{Name of program.} | |
300 nil ; @r{Do not delete region.} | |
301 buffer ; @r{Send output to @code{buffer}.} | |
302 nil ; @r{No redisplay during output.} | |
303 "-c" command) ; @r{Arguments for the shell.} | |
304 @end group | |
305 @end smallexample | |
306 @end defun | |
307 | |
7411
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
308 @node MS-DOS Subprocesses |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
309 @section MS-DOS Subprocesses |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
310 |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
311 On MS-DOS, you must indicate whether the data going to and from |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
312 a synchronous subprocess are text or binary. Text data requires |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
313 translation between the end-of-line convention used within Emacs |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
314 (a single newline character) and the convention used outside Emacs |
12098 | 315 (the two-character sequence, @sc{crlf}). |
7411
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
316 |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
317 The variable @code{binary-process-input} applies to input sent to the |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
318 subprocess, and @code{binary-process-output} applies to output received |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
319 from it. A non-@code{nil} value means the data is non-text; @code{nil} |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
320 means the data is text, and calls for conversion. |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
321 |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
322 @defvar binary-process-input |
12098 | 323 If this variable is @code{nil}, convert newlines to @sc{crlf} sequences in |
7411
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
324 the input to a synchronous subprocess. |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
325 @end defvar |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
326 |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
327 @defvar binary-process-output |
12098 | 328 If this variable is @code{nil}, convert @sc{crlf} sequences to newlines in |
7411
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
329 the output from a synchronous subprocess. |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
330 @end defvar |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
331 |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
332 @xref{Files and MS-DOS}, for related information. |
266b18250120
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7115
diff
changeset
|
333 |
6558 | 334 @node Asynchronous Processes |
335 @section Creating an Asynchronous Process | |
336 @cindex asynchronous subprocess | |
337 | |
338 After an @dfn{asynchronous process} is created, Emacs and the Lisp | |
339 program both continue running immediately. The process may thereafter | |
340 run in parallel with Emacs, and the two may communicate with each other | |
341 using the functions described in following sections. Here we describe | |
342 how to create an asynchronous process with @code{start-process}. | |
343 | |
344 @defun start-process name buffer-or-name program &rest args | |
345 This function creates a new asynchronous subprocess and starts the | |
346 program @var{program} running in it. It returns a process object that | |
347 stands for the new subprocess in Lisp. The argument @var{name} | |
348 specifies the name for the process object; if a process with this name | |
349 already exists, then @var{name} is modified (by adding @samp{<1>}, etc.) | |
350 to be unique. The buffer @var{buffer-or-name} is the buffer to | |
351 associate with the process. | |
352 | |
353 The remaining arguments, @var{args}, are strings that specify command | |
354 line arguments for the program. | |
355 | |
356 In the example below, the first process is started and runs (rather, | |
357 sleeps) for 100 seconds. Meanwhile, the second process is started, and | |
358 given the name @samp{my-process<1>} for the sake of uniqueness. It | |
359 inserts the directory listing at the end of the buffer @samp{foo}, | |
360 before the first process finishes. Then it finishes, and a message to | |
361 that effect is inserted in the buffer. Much later, the first process | |
362 finishes, and another message is inserted in the buffer for it. | |
363 | |
364 @smallexample | |
365 @group | |
366 (start-process "my-process" "foo" "sleep" "100") | |
367 @result{} #<process my-process> | |
368 @end group | |
369 | |
370 @group | |
371 (start-process "my-process" "foo" "ls" "-l" "/user/lewis/bin") | |
372 @result{} #<process my-process<1>> | |
373 | |
374 ---------- Buffer: foo ---------- | |
375 total 2 | |
376 lrwxrwxrwx 1 lewis 14 Jul 22 10:12 gnuemacs --> /emacs | |
377 -rwxrwxrwx 1 lewis 19 Jul 30 21:02 lemon | |
378 | |
379 Process my-process<1> finished | |
380 | |
381 Process my-process finished | |
382 ---------- Buffer: foo ---------- | |
383 @end group | |
384 @end smallexample | |
385 @end defun | |
386 | |
387 @defun start-process-shell-command name buffer-or-name command &rest command-args | |
388 This function is like @code{start-process} except that it uses a shell | |
389 to execute the specified command. The argument @var{command} is a shell | |
390 command name, and @var{command-args} are the arguments for the shell | |
391 command. | |
392 @end defun | |
393 | |
394 @defvar process-connection-type | |
395 @cindex pipes | |
396 @cindex @sc{pty}s | |
397 This variable controls the type of device used to communicate with | |
12098 | 398 asynchronous subprocesses. If it is non-@code{nil}, then @sc{pty}s are |
399 used, when available. Otherwise, pipes are used. | |
6558 | 400 |
401 @sc{pty}s are usually preferable for processes visible to the user, as | |
402 in Shell mode, because they allow job control (@kbd{C-c}, @kbd{C-z}, | |
403 etc.) to work between the process and its children whereas pipes do not. | |
404 For subprocesses used for internal purposes by programs, it is often | |
405 better to use a pipe, because they are more efficient. In addition, the | |
406 total number of @sc{pty}s is limited on many systems and it is good not | |
407 to waste them. | |
408 | |
409 The value @code{process-connection-type} is used when | |
410 @code{start-process} is called. So you can specify how to communicate | |
411 with one subprocess by binding the variable around the call to | |
412 @code{start-process}. | |
413 | |
414 @smallexample | |
415 @group | |
416 (let ((process-connection-type nil)) ; @r{Use a pipe.} | |
417 (start-process @dots{})) | |
418 @end group | |
419 @end smallexample | |
12067 | 420 |
421 To determine whether a given subprocess actually got a pipe or a | |
422 @sc{pty}, use the function @code{process-tty-name} (@pxref{Process | |
423 Information}). | |
6558 | 424 @end defvar |
425 | |
426 @node Deleting Processes | |
427 @section Deleting Processes | |
428 @cindex deleting processes | |
429 | |
430 @dfn{Deleting a process} disconnects Emacs immediately from the | |
431 subprocess, and removes it from the list of active processes. It sends | |
432 a signal to the subprocess to make the subprocess terminate, but this is | |
433 not guaranteed to happen immediately. The process object itself | |
15759
e74f36ff89e7
Explain how deletion of process doesn't affect process mark.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
434 continues to exist as long as other Lisp objects point to it. The |
e74f36ff89e7
Explain how deletion of process doesn't affect process mark.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
435 process mark continues to point to the same place as before (usually |
e74f36ff89e7
Explain how deletion of process doesn't affect process mark.
Richard M. Stallman <rms@gnu.org>
parents:
12125
diff
changeset
|
436 into a buffer where output from the process was being inserted). |
6558 | 437 |
438 You can delete a process explicitly at any time. Processes are | |
439 deleted automatically after they terminate, but not necessarily right | |
440 away. If you delete a terminated process explicitly before it is | |
441 deleted automatically, no harm results. | |
442 | |
443 @defvar delete-exited-processes | |
444 This variable controls automatic deletion of processes that have | |
445 terminated (due to calling @code{exit} or to a signal). If it is | |
446 @code{nil}, then they continue to exist until the user runs | |
447 @code{list-processes}. Otherwise, they are deleted immediately after | |
448 they exit. | |
449 @end defvar | |
450 | |
451 @defun delete-process name | |
452 This function deletes the process associated with @var{name}, killing it | |
453 with a @code{SIGHUP} signal. The argument @var{name} may be a process, | |
454 the name of a process, a buffer, or the name of a buffer. | |
455 | |
456 @smallexample | |
457 @group | |
458 (delete-process "*shell*") | |
459 @result{} nil | |
460 @end group | |
461 @end smallexample | |
462 @end defun | |
463 | |
464 @defun process-kill-without-query process | |
465 This function declares that Emacs need not query the user if | |
466 @var{process} is still running when Emacs is exited. The process will | |
467 be deleted silently. The value is @code{t}. | |
468 | |
469 @smallexample | |
470 @group | |
471 (process-kill-without-query (get-process "shell")) | |
472 @result{} t | |
473 @end group | |
474 @end smallexample | |
475 @end defun | |
476 | |
477 @node Process Information | |
478 @section Process Information | |
479 | |
480 Several functions return information about processes. | |
481 @code{list-processes} is provided for interactive use. | |
482 | |
483 @deffn Command list-processes | |
484 This command displays a listing of all living processes. In addition, | |
485 it finally deletes any process whose status was @samp{Exited} or | |
486 @samp{Signaled}. It returns @code{nil}. | |
487 @end deffn | |
488 | |
489 @defun process-list | |
490 This function returns a list of all processes that have not been deleted. | |
491 | |
492 @smallexample | |
493 @group | |
494 (process-list) | |
495 @result{} (#<process display-time> #<process shell>) | |
496 @end group | |
497 @end smallexample | |
498 @end defun | |
499 | |
500 @defun get-process name | |
501 This function returns the process named @var{name}, or @code{nil} if | |
502 there is none. An error is signaled if @var{name} is not a string. | |
503 | |
504 @smallexample | |
505 @group | |
506 (get-process "shell") | |
507 @result{} #<process shell> | |
508 @end group | |
509 @end smallexample | |
510 @end defun | |
511 | |
512 @defun process-command process | |
513 This function returns the command that was executed to start | |
514 @var{process}. This is a list of strings, the first string being the | |
515 program executed and the rest of the strings being the arguments that | |
516 were given to the program. | |
517 | |
518 @smallexample | |
519 @group | |
520 (process-command (get-process "shell")) | |
521 @result{} ("/bin/csh" "-i") | |
522 @end group | |
523 @end smallexample | |
524 @end defun | |
525 | |
526 @defun process-id process | |
527 This function returns the @sc{pid} of @var{process}. This is an | |
9009 | 528 integer that distinguishes the process @var{process} from all other |
6558 | 529 processes running on the same computer at the current time. The |
530 @sc{pid} of a process is chosen by the operating system kernel when the | |
531 process is started and remains constant as long as the process exists. | |
532 @end defun | |
533 | |
534 @defun process-name process | |
535 This function returns the name of @var{process}. | |
536 @end defun | |
537 | |
538 @defun process-status process-name | |
539 This function returns the status of @var{process-name} as a symbol. | |
540 The argument @var{process-name} must be a process, a buffer, a | |
541 process name (string) or a buffer name (string). | |
542 | |
543 The possible values for an actual subprocess are: | |
544 | |
545 @table @code | |
546 @item run | |
547 for a process that is running. | |
548 @item stop | |
549 for a process that is stopped but continuable. | |
550 @item exit | |
551 for a process that has exited. | |
552 @item signal | |
553 for a process that has received a fatal signal. | |
554 @item open | |
555 for a network connection that is open. | |
556 @item closed | |
557 for a network connection that is closed. Once a connection | |
558 is closed, you cannot reopen it, though you might be able to open | |
559 a new connection to the same place. | |
560 @item nil | |
561 if @var{process-name} is not the name of an existing process. | |
562 @end table | |
563 | |
564 @smallexample | |
565 @group | |
566 (process-status "shell") | |
567 @result{} run | |
568 @end group | |
569 @group | |
570 (process-status (get-buffer "*shell*")) | |
571 @result{} run | |
572 @end group | |
573 @group | |
574 x | |
575 @result{} #<process xx<1>> | |
576 (process-status x) | |
577 @result{} exit | |
578 @end group | |
579 @end smallexample | |
580 | |
581 For a network connection, @code{process-status} returns one of the symbols | |
582 @code{open} or @code{closed}. The latter means that the other side | |
583 closed the connection, or Emacs did @code{delete-process}. | |
584 | |
585 In earlier Emacs versions (prior to version 19), the status of a network | |
586 connection was @code{run} if open, and @code{exit} if closed. | |
587 @end defun | |
588 | |
589 @defun process-exit-status process | |
590 This function returns the exit status of @var{process} or the signal | |
591 number that killed it. (Use the result of @code{process-status} to | |
592 determine which of those it is.) If @var{process} has not yet | |
593 terminated, the value is 0. | |
594 @end defun | |
595 | |
12067 | 596 @defun process-tty-name process |
597 This function returns the terminal name that @var{process} is using for | |
598 its communication with Emacs---or @code{nil} if it is using pipes | |
599 instead of a terminal (see @code{process-connection-type} in | |
600 @ref{Asynchronous Processes}). | |
601 @end defun | |
602 | |
6558 | 603 @node Input to Processes |
604 @section Sending Input to Processes | |
605 @cindex process input | |
606 | |
607 Asynchronous subprocesses receive input when it is sent to them by | |
608 Emacs, which is done with the functions in this section. You must | |
609 specify the process to send input to, and the input data to send. The | |
610 data appears on the ``standard input'' of the subprocess. | |
611 | |
612 Some operating systems have limited space for buffered input in a | |
613 @sc{pty}. On these systems, Emacs sends an @sc{eof} periodically amidst | |
614 the other characters, to force them through. For most programs, | |
615 these @sc{eof}s do no harm. | |
616 | |
617 @defun process-send-string process-name string | |
618 This function sends @var{process-name} the contents of @var{string} as | |
619 standard input. The argument @var{process-name} must be a process or | |
620 the name of a process. If it is @code{nil}, the current buffer's | |
621 process is used. | |
622 | |
623 The function returns @code{nil}. | |
624 | |
625 @smallexample | |
626 @group | |
627 (process-send-string "shell<1>" "ls\n") | |
628 @result{} nil | |
629 @end group | |
630 | |
631 | |
632 @group | |
633 ---------- Buffer: *shell* ---------- | |
634 ... | |
635 introduction.texi syntax-tables.texi~ | |
636 introduction.texi~ text.texi | |
637 introduction.txt text.texi~ | |
638 ... | |
639 ---------- Buffer: *shell* ---------- | |
640 @end group | |
641 @end smallexample | |
642 @end defun | |
643 | |
644 @deffn Command process-send-region process-name start end | |
645 This function sends the text in the region defined by @var{start} and | |
646 @var{end} as standard input to @var{process-name}, which is a process or | |
647 a process name. (If it is @code{nil}, the current buffer's process is | |
648 used.) | |
649 | |
650 An error is signaled unless both @var{start} and @var{end} are | |
651 integers or markers that indicate positions in the current buffer. (It | |
652 is unimportant which number is larger.) | |
653 @end deffn | |
654 | |
655 @defun process-send-eof &optional process-name | |
656 This function makes @var{process-name} see an end-of-file in its | |
657 input. The @sc{eof} comes after any text already sent to it. | |
658 | |
659 If @var{process-name} is not supplied, or if it is @code{nil}, then | |
660 this function sends the @sc{eof} to the current buffer's process. An | |
661 error is signaled if the current buffer has no process. | |
662 | |
663 The function returns @var{process-name}. | |
664 | |
665 @smallexample | |
666 @group | |
667 (process-send-eof "shell") | |
668 @result{} "shell" | |
669 @end group | |
670 @end smallexample | |
671 @end defun | |
672 | |
673 @node Signals to Processes | |
674 @section Sending Signals to Processes | |
675 @cindex process signals | |
676 @cindex sending signals | |
677 @cindex signals | |
678 | |
679 @dfn{Sending a signal} to a subprocess is a way of interrupting its | |
680 activities. There are several different signals, each with its own | |
681 meaning. The set of signals and their names is defined by the operating | |
682 system. For example, the signal @code{SIGINT} means that the user has | |
683 typed @kbd{C-c}, or that some analogous thing has happened. | |
684 | |
685 Each signal has a standard effect on the subprocess. Most signals | |
686 kill the subprocess, but some stop or resume execution instead. Most | |
687 signals can optionally be handled by programs; if the program handles | |
688 the signal, then we can say nothing in general about its effects. | |
689 | |
690 You can send signals explicitly by calling the functions in this | |
691 section. Emacs also sends signals automatically at certain times: | |
692 killing a buffer sends a @code{SIGHUP} signal to all its associated | |
693 processes; killing Emacs sends a @code{SIGHUP} signal to all remaining | |
694 processes. (@code{SIGHUP} is a signal that usually indicates that the | |
695 user hung up the phone.) | |
696 | |
697 Each of the signal-sending functions takes two optional arguments: | |
698 @var{process-name} and @var{current-group}. | |
699 | |
700 The argument @var{process-name} must be either a process, the name of | |
701 one, or @code{nil}. If it is @code{nil}, the process defaults to the | |
702 process associated with the current buffer. An error is signaled if | |
703 @var{process-name} does not identify a process. | |
704 | |
705 The argument @var{current-group} is a flag that makes a difference | |
706 when you are running a job-control shell as an Emacs subprocess. If it | |
707 is non-@code{nil}, then the signal is sent to the current process-group | |
9009 | 708 of the terminal that Emacs uses to communicate with the subprocess. If |
6558 | 709 the process is a job-control shell, this means the shell's current |
710 subjob. If it is @code{nil}, the signal is sent to the process group of | |
711 the immediate subprocess of Emacs. If the subprocess is a job-control | |
712 shell, this is the shell itself. | |
713 | |
714 The flag @var{current-group} has no effect when a pipe is used to | |
715 communicate with the subprocess, because the operating system does not | |
716 support the distinction in the case of pipes. For the same reason, | |
717 job-control shells won't work when a pipe is used. See | |
718 @code{process-connection-type} in @ref{Asynchronous Processes}. | |
719 | |
720 @defun interrupt-process &optional process-name current-group | |
721 This function interrupts the process @var{process-name} by sending the | |
722 signal @code{SIGINT}. Outside of Emacs, typing the ``interrupt | |
723 character'' (normally @kbd{C-c} on some systems, and @code{DEL} on | |
724 others) sends this signal. When the argument @var{current-group} is | |
725 non-@code{nil}, you can think of this function as ``typing @kbd{C-c}'' | |
726 on the terminal by which Emacs talks to the subprocess. | |
727 @end defun | |
728 | |
729 @defun kill-process &optional process-name current-group | |
730 This function kills the process @var{process-name} by sending the | |
731 signal @code{SIGKILL}. This signal kills the subprocess immediately, | |
732 and cannot be handled by the subprocess. | |
733 @end defun | |
734 | |
735 @defun quit-process &optional process-name current-group | |
736 This function sends the signal @code{SIGQUIT} to the process | |
737 @var{process-name}. This signal is the one sent by the ``quit | |
738 character'' (usually @kbd{C-b} or @kbd{C-\}) when you are not inside | |
739 Emacs. | |
740 @end defun | |
741 | |
742 @defun stop-process &optional process-name current-group | |
743 This function stops the process @var{process-name} by sending the | |
744 signal @code{SIGTSTP}. Use @code{continue-process} to resume its | |
745 execution. | |
746 | |
747 On systems with job control, the ``stop character'' (usually @kbd{C-z}) | |
748 sends this signal (outside of Emacs). When @var{current-group} is | |
749 non-@code{nil}, you can think of this function as ``typing @kbd{C-z}'' | |
750 on the terminal Emacs uses to communicate with the subprocess. | |
751 @end defun | |
752 | |
753 @defun continue-process &optional process-name current-group | |
754 This function resumes execution of the process @var{process} by sending | |
755 it the signal @code{SIGCONT}. This presumes that @var{process-name} was | |
756 stopped previously. | |
757 @end defun | |
758 | |
759 @c Emacs 19 feature | |
760 @defun signal-process pid signal | |
761 This function sends a signal to process @var{pid}, which need not be | |
762 a child of Emacs. The argument @var{signal} specifies which signal | |
763 to send; it should be an integer. | |
764 @end defun | |
765 | |
766 @node Output from Processes | |
767 @section Receiving Output from Processes | |
768 @cindex process output | |
769 @cindex output from processes | |
770 | |
771 There are two ways to receive the output that a subprocess writes to | |
772 its standard output stream. The output can be inserted in a buffer, | |
773 which is called the associated buffer of the process, or a function | |
9009 | 774 called the @dfn{filter function} can be called to act on the output. If |
775 the process has no buffer and no filter function, its output is | |
776 discarded. | |
6558 | 777 |
778 @menu | |
779 * Process Buffers:: If no filter, output is put in a buffer. | |
780 * Filter Functions:: Filter functions accept output from the process. | |
781 * Accepting Output:: Explicitly permitting subprocess output. | |
782 Waiting for subprocess output. | |
783 @end menu | |
784 | |
785 @node Process Buffers | |
786 @subsection Process Buffers | |
787 | |
788 A process can (and usually does) have an @dfn{associated buffer}, | |
789 which is an ordinary Emacs buffer that is used for two purposes: storing | |
790 the output from the process, and deciding when to kill the process. You | |
791 can also use the buffer to identify a process to operate on, since in | |
792 normal practice only one process is associated with any given buffer. | |
793 Many applications of processes also use the buffer for editing input to | |
794 be sent to the process, but this is not built into Emacs Lisp. | |
795 | |
796 Unless the process has a filter function (@pxref{Filter Functions}), | |
797 its output is inserted in the associated buffer. The position to insert | |
9009 | 798 the output is determined by the @code{process-mark}, which is then |
799 updated to point to the end of the text just inserted. Usually, but not | |
800 always, the @code{process-mark} is at the end of the buffer. | |
6558 | 801 |
802 @defun process-buffer process | |
803 This function returns the associated buffer of the process | |
804 @var{process}. | |
805 | |
806 @smallexample | |
807 @group | |
808 (process-buffer (get-process "shell")) | |
809 @result{} #<buffer *shell*> | |
810 @end group | |
811 @end smallexample | |
812 @end defun | |
813 | |
814 @defun process-mark process | |
815 This function returns the process marker for @var{process}, which is the | |
816 marker that says where to insert output from the process. | |
817 | |
818 If @var{process} does not have a buffer, @code{process-mark} returns a | |
819 marker that points nowhere. | |
820 | |
821 Insertion of process output in a buffer uses this marker to decide where | |
822 to insert, and updates it to point after the inserted text. That is why | |
823 successive batches of output are inserted consecutively. | |
824 | |
825 Filter functions normally should use this marker in the same fashion | |
826 as is done by direct insertion of output in the buffer. A good | |
827 example of a filter function that uses @code{process-mark} is found at | |
828 the end of the following section. | |
829 | |
830 When the user is expected to enter input in the process buffer for | |
831 transmission to the process, the process marker is useful for | |
832 distinguishing the new input from previous output. | |
833 @end defun | |
834 | |
835 @defun set-process-buffer process buffer | |
836 This function sets the buffer associated with @var{process} to | |
837 @var{buffer}. If @var{buffer} is @code{nil}, the process becomes | |
838 associated with no buffer. | |
839 @end defun | |
840 | |
841 @defun get-buffer-process buffer-or-name | |
842 This function returns the process associated with @var{buffer-or-name}. | |
843 If there are several processes associated with it, then one is chosen. | |
844 (Presently, the one chosen is the one most recently created.) It is | |
845 usually a bad idea to have more than one process associated with the | |
846 same buffer. | |
847 | |
848 @smallexample | |
849 @group | |
850 (get-buffer-process "*shell*") | |
851 @result{} #<process shell> | |
852 @end group | |
853 @end smallexample | |
854 | |
855 Killing the process's buffer deletes the process, which kills the | |
856 subprocess with a @code{SIGHUP} signal (@pxref{Signals to Processes}). | |
857 @end defun | |
858 | |
859 @node Filter Functions | |
860 @subsection Process Filter Functions | |
861 @cindex filter function | |
862 @cindex process filter | |
863 | |
864 A process @dfn{filter function} is a function that receives the | |
865 standard output from the associated process. If a process has a filter, | |
9009 | 866 then @emph{all} output from that process is passed to the filter. The |
867 process buffer is used directly for output from the process only when | |
868 there is no filter. | |
6558 | 869 |
870 A filter function must accept two arguments: the associated process and | |
871 a string, which is the output. The function is then free to do whatever it | |
872 chooses with the output. | |
873 | |
874 A filter function runs only while Emacs is waiting (e.g., for terminal | |
875 input, or for time to elapse, or for process output). This avoids the | |
876 timing errors that could result from running filters at random places in | |
877 the middle of other Lisp programs. You may explicitly cause Emacs to | |
9009 | 878 wait, so that filter functions will run, by calling @code{sit-for} or |
879 @code{sleep-for} (@pxref{Waiting}), or @code{accept-process-output} | |
880 (@pxref{Accepting Output}). Emacs is also waiting when the command loop | |
881 is reading input. | |
6558 | 882 |
883 Quitting is normally inhibited within a filter function---otherwise, | |
884 the effect of typing @kbd{C-g} at command level or to quit a user | |
885 command would be unpredictable. If you want to permit quitting inside a | |
886 filter function, bind @code{inhibit-quit} to @code{nil}. | |
887 @xref{Quitting}. | |
888 | |
12067 | 889 If an error happens during execution of a filter function, it is |
890 caught automatically, so that it doesn't stop the execution of whatever | |
12125
995be67f3fd1
updates for version 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
891 program was running when the filter function was started. However, if |
12067 | 892 @code{debug-on-error} is non-@code{nil}, the error-catching is turned |
893 off. This makes it possible to use the Lisp debugger to debug the | |
894 filter function. @xref{Debugger}. | |
895 | |
6558 | 896 Many filter functions sometimes or always insert the text in the |
897 process's buffer, mimicking the actions of Emacs when there is no | |
898 filter. Such filter functions need to use @code{set-buffer} in order to | |
899 be sure to insert in that buffer. To avoid setting the current buffer | |
900 semipermanently, these filter functions must use @code{unwind-protect} | |
901 to make sure to restore the previous current buffer. They should also | |
902 update the process marker, and in some cases update the value of point. | |
903 Here is how to do these things: | |
904 | |
905 @smallexample | |
906 @group | |
907 (defun ordinary-insertion-filter (proc string) | |
908 (let ((old-buffer (current-buffer))) | |
909 (unwind-protect | |
910 (let (moving) | |
911 (set-buffer (process-buffer proc)) | |
912 (setq moving (= (point) (process-mark proc))) | |
913 @end group | |
914 @group | |
915 (save-excursion | |
916 ;; @r{Insert the text, moving the process-marker.} | |
917 (goto-char (process-mark proc)) | |
918 (insert string) | |
919 (set-marker (process-mark proc) (point))) | |
920 (if moving (goto-char (process-mark proc)))) | |
921 (set-buffer old-buffer)))) | |
922 @end group | |
923 @end smallexample | |
924 | |
925 @noindent | |
926 The reason to use an explicit @code{unwind-protect} rather than letting | |
927 @code{save-excursion} restore the current buffer is so as to preserve | |
928 the change in point made by @code{goto-char}. | |
929 | |
930 To make the filter force the process buffer to be visible whenever new | |
931 text arrives, insert the following line just before the | |
932 @code{unwind-protect}: | |
933 | |
934 @smallexample | |
935 (display-buffer (process-buffer proc)) | |
936 @end smallexample | |
937 | |
938 To force point to move to the end of the new output no matter where | |
939 it was previously, eliminate the variable @code{moving} and call | |
940 @code{goto-char} unconditionally. | |
941 | |
10039
6eb5cd200068
Match data now saved automatically around filters and sentinels.
Richard M. Stallman <rms@gnu.org>
parents:
9009
diff
changeset
|
942 In earlier Emacs versions, every filter function that did regexp |
6eb5cd200068
Match data now saved automatically around filters and sentinels.
Richard M. Stallman <rms@gnu.org>
parents:
9009
diff
changeset
|
943 searching or matching had to explicitly save and restore the match data. |
6eb5cd200068
Match data now saved automatically around filters and sentinels.
Richard M. Stallman <rms@gnu.org>
parents:
9009
diff
changeset
|
944 Now Emacs does this automatically; filter functions never need to do it |
6eb5cd200068
Match data now saved automatically around filters and sentinels.
Richard M. Stallman <rms@gnu.org>
parents:
9009
diff
changeset
|
945 explicitly. @xref{Match Data}. |
6558 | 946 |
947 A filter function that writes the output into the buffer of the | |
12098 | 948 process should check whether the buffer is still alive. If it tries to |
6558 | 949 insert into a dead buffer, it will get an error. If the buffer is dead, |
950 @code{(buffer-name (process-buffer @var{process}))} returns @code{nil}. | |
951 | |
952 The output to the function may come in chunks of any size. A program | |
953 that produces the same output twice in a row may send it as one batch | |
954 of 200 characters one time, and five batches of 40 characters the next. | |
955 | |
956 @defun set-process-filter process filter | |
957 This function gives @var{process} the filter function @var{filter}. If | |
958 @var{filter} is @code{nil}, it gives the process no filter. | |
959 @end defun | |
960 | |
961 @defun process-filter process | |
962 This function returns the filter function of @var{process}, or @code{nil} | |
963 if it has none. | |
964 @end defun | |
965 | |
966 Here is an example of use of a filter function: | |
967 | |
968 @smallexample | |
969 @group | |
970 (defun keep-output (process output) | |
971 (setq kept (cons output kept))) | |
972 @result{} keep-output | |
973 @end group | |
974 @group | |
975 (setq kept nil) | |
976 @result{} nil | |
977 @end group | |
978 @group | |
979 (set-process-filter (get-process "shell") 'keep-output) | |
980 @result{} keep-output | |
981 @end group | |
982 @group | |
983 (process-send-string "shell" "ls ~/other\n") | |
984 @result{} nil | |
985 kept | |
986 @result{} ("lewis@@slug[8] % " | |
987 @end group | |
988 @group | |
989 "FINAL-W87-SHORT.MSS backup.otl kolstad.mss~ | |
990 address.txt backup.psf kolstad.psf | |
991 backup.bib~ david.mss resume-Dec-86.mss~ | |
992 backup.err david.psf resume-Dec.psf | |
993 backup.mss dland syllabus.mss | |
994 " | |
995 "#backups.mss# backup.mss~ kolstad.mss | |
996 ") | |
997 @end group | |
998 @end smallexample | |
999 | |
1000 @ignore @c The code in this example doesn't show the right way to do things. | |
1001 Here is another, more realistic example, which demonstrates how to use | |
1002 the process mark to do insertion in the same fashion as is done when | |
1003 there is no filter function: | |
1004 | |
1005 @smallexample | |
1006 @group | |
1007 ;; @r{Insert input in the buffer specified by @code{my-shell-buffer}} | |
1008 ;; @r{and make sure that buffer is shown in some window.} | |
1009 (defun my-process-filter (proc str) | |
1010 (let ((cur (selected-window)) | |
1011 (pop-up-windows t)) | |
1012 (pop-to-buffer my-shell-buffer) | |
1013 @end group | |
1014 @group | |
1015 (goto-char (point-max)) | |
1016 (insert str) | |
1017 (set-marker (process-mark proc) (point-max)) | |
1018 (select-window cur))) | |
1019 @end group | |
1020 @end smallexample | |
1021 @end ignore | |
1022 | |
1023 @node Accepting Output | |
1024 @subsection Accepting Output from Processes | |
1025 | |
1026 Output from asynchronous subprocesses normally arrives only while | |
1027 Emacs is waiting for some sort of external event, such as elapsed time | |
1028 or terminal input. Occasionally it is useful in a Lisp program to | |
1029 explicitly permit output to arrive at a specific point, or even to wait | |
1030 until output arrives from a process. | |
1031 | |
1032 @defun accept-process-output &optional process seconds millisec | |
1033 This function allows Emacs to read pending output from processes. The | |
1034 output is inserted in the associated buffers or given to their filter | |
1035 functions. If @var{process} is non-@code{nil} then this function does | |
1036 not return until some output has been received from @var{process}. | |
1037 | |
1038 @c Emacs 19 feature | |
1039 The arguments @var{seconds} and @var{millisec} let you specify timeout | |
1040 periods. The former specifies a period measured in seconds and the | |
1041 latter specifies one measured in milliseconds. The two time periods | |
1042 thus specified are added together, and @code{accept-process-output} | |
1043 returns after that much time whether or not there has been any | |
1044 subprocess output. | |
1045 | |
12098 | 1046 The argument @var{seconds} need not be an integer. If it is a floating |
1047 point number, this function waits for a fractional number of seconds. | |
1048 Some systems support only a whole number of seconds; on these systems, | |
1049 @var{seconds} is rounded down. If the system doesn't support waiting | |
1050 fractions of a second, you get an error if you specify nonzero | |
1051 @var{millisec}. | |
1052 | |
6558 | 1053 Not all operating systems support waiting periods other than multiples |
1054 of a second; on those that do not, you get an error if you specify | |
1055 nonzero @var{millisec}. | |
1056 | |
1057 The function @code{accept-process-output} returns non-@code{nil} if it | |
1058 did get some output, or @code{nil} if the timeout expired before output | |
1059 arrived. | |
1060 @end defun | |
1061 | |
1062 @node Sentinels | |
1063 @section Sentinels: Detecting Process Status Changes | |
1064 @cindex process sentinel | |
1065 @cindex sentinel | |
1066 | |
1067 A @dfn{process sentinel} is a function that is called whenever the | |
1068 associated process changes status for any reason, including signals | |
1069 (whether sent by Emacs or caused by the process's own actions) that | |
1070 terminate, stop, or continue the process. The process sentinel is also | |
1071 called if the process exits. The sentinel receives two arguments: the | |
1072 process for which the event occurred, and a string describing the type | |
1073 of event. | |
1074 | |
1075 The string describing the event looks like one of the following: | |
1076 | |
1077 @itemize @bullet | |
1078 @item | |
1079 @code{"finished\n"}. | |
1080 | |
1081 @item | |
1082 @code{"exited abnormally with code @var{exitcode}\n"}. | |
1083 | |
1084 @item | |
1085 @code{"@var{name-of-signal}\n"}. | |
1086 | |
1087 @item | |
1088 @code{"@var{name-of-signal} (core dumped)\n"}. | |
1089 @end itemize | |
1090 | |
1091 A sentinel runs only while Emacs is waiting (e.g., for terminal input, | |
1092 or for time to elapse, or for process output). This avoids the timing | |
1093 errors that could result from running them at random places in the | |
1094 middle of other Lisp programs. A program can wait, so that sentinels | |
9009 | 1095 will run, by calling @code{sit-for} or @code{sleep-for} |
1096 (@pxref{Waiting}), or @code{accept-process-output} (@pxref{Accepting | |
1097 Output}). Emacs is also waiting when the command loop is reading input. | |
6558 | 1098 |
1099 Quitting is normally inhibited within a sentinel---otherwise, the | |
1100 effect of typing @kbd{C-g} at command level or to quit a user command | |
1101 would be unpredictable. If you want to permit quitting inside a | |
1102 sentinel, bind @code{inhibit-quit} to @code{nil}. @xref{Quitting}. | |
1103 | |
1104 A sentinel that writes the output into the buffer of the process | |
12098 | 1105 should check whether the buffer is still alive. If it tries to insert |
6558 | 1106 into a dead buffer, it will get an error. If the buffer is dead, |
1107 @code{(buffer-name (process-buffer @var{process}))} returns @code{nil}. | |
1108 | |
12067 | 1109 If an error happens during execution of a sentinel, it is caught |
1110 automatically, so that it doesn't stop the execution of whatever | |
1111 programs was running when the sentinel was started. However, if | |
1112 @code{debug-on-error} is non-@code{nil}, the error-catching is turned | |
1113 off. This makes it possible to use the Lisp debugger to debug the | |
1114 sentinel. @xref{Debugger}. | |
1115 | |
12098 | 1116 In earlier Emacs versions, every sentinel that did regexp searching or |
1117 matching had to explicitly save and restore the match data. Now Emacs | |
1118 does this automatically; sentinels never need to do it explicitly. | |
1119 @xref{Match Data}. | |
1120 | |
6558 | 1121 @defun set-process-sentinel process sentinel |
1122 This function associates @var{sentinel} with @var{process}. If | |
1123 @var{sentinel} is @code{nil}, then the process will have no sentinel. | |
1124 The default behavior when there is no sentinel is to insert a message in | |
1125 the process's buffer when the process status changes. | |
1126 | |
1127 @smallexample | |
1128 @group | |
1129 (defun msg-me (process event) | |
1130 (princ | |
1131 (format "Process: %s had the event `%s'" process event))) | |
1132 (set-process-sentinel (get-process "shell") 'msg-me) | |
1133 @result{} msg-me | |
1134 @end group | |
1135 @group | |
1136 (kill-process (get-process "shell")) | |
1137 @print{} Process: #<process shell> had the event `killed' | |
1138 @result{} #<process shell> | |
1139 @end group | |
1140 @end smallexample | |
1141 @end defun | |
1142 | |
1143 @defun process-sentinel process | |
1144 This function returns the sentinel of @var{process}, or @code{nil} if it | |
1145 has none. | |
1146 @end defun | |
1147 | |
1148 @defun waiting-for-user-input-p | |
1149 While a sentinel or filter function is running, this function returns | |
1150 non-@code{nil} if Emacs was waiting for keyboard input from the user at | |
1151 the time the sentinel or filter function was called, @code{nil} if it | |
1152 was not. | |
1153 @end defun | |
1154 | |
1155 @node Transaction Queues | |
1156 @section Transaction Queues | |
1157 @cindex transaction queue | |
1158 | |
1159 You can use a @dfn{transaction queue} for more convenient communication | |
1160 with subprocesses using transactions. First use @code{tq-create} to | |
1161 create a transaction queue communicating with a specified process. Then | |
1162 you can call @code{tq-enqueue} to send a transaction. | |
1163 | |
1164 @defun tq-create process | |
1165 This function creates and returns a transaction queue communicating with | |
1166 @var{process}. The argument @var{process} should be a subprocess | |
1167 capable of sending and receiving streams of bytes. It may be a child | |
9009 | 1168 process, or it may be a TCP connection to a server, possibly on another |
6558 | 1169 machine. |
1170 @end defun | |
1171 | |
1172 @defun tq-enqueue queue question regexp closure fn | |
1173 This function sends a transaction to queue @var{queue}. Specifying the | |
1174 queue has the effect of specifying the subprocess to talk to. | |
1175 | |
9009 | 1176 The argument @var{question} is the outgoing message that starts the |
6558 | 1177 transaction. The argument @var{fn} is the function to call when the |
1178 corresponding answer comes back; it is called with two arguments: | |
1179 @var{closure}, and the answer received. | |
1180 | |
1181 The argument @var{regexp} is a regular expression that should match the | |
1182 entire answer, but nothing less; that's how @code{tq-enqueue} determines | |
1183 where the answer ends. | |
1184 | |
1185 The return value of @code{tq-enqueue} itself is not meaningful. | |
1186 @end defun | |
1187 | |
1188 @defun tq-close queue | |
1189 Shut down transaction queue @var{queue}, waiting for all pending transactions | |
1190 to complete, and then terminate the connection or child process. | |
1191 @end defun | |
1192 | |
1193 Transaction queues are implemented by means of a filter function. | |
1194 @xref{Filter Functions}. | |
1195 | |
12098 | 1196 @node Network |
1197 @section Network Connections | |
1198 @cindex network connection | |
6558 | 1199 @cindex TCP |
1200 | |
12098 | 1201 Emacs Lisp programs can open TCP network connections to other processes on |
1202 the same machine or other machines. A network connection is handled by Lisp | |
6558 | 1203 much like a subprocess, and is represented by a process object. |
1204 However, the process you are communicating with is not a child of the | |
1205 Emacs process, so you can't kill it or send it signals. All you can do | |
1206 is send and receive data. @code{delete-process} closes the connection, | |
1207 but does not kill the process at the other end; that process must decide | |
1208 what to do about closure of the connection. | |
1209 | |
1210 You can distinguish process objects representing network connections | |
1211 from those representing subprocesses with the @code{process-status} | |
12098 | 1212 function. It always returns either @code{open} or @code{closed} for a |
1213 network connection, and it never returns either of those values for a | |
1214 real subprocess. @xref{Process Information}. | |
6558 | 1215 |
1216 @defun open-network-stream name buffer-or-name host service | |
1217 This function opens a TCP connection for a service to a host. It | |
1218 returns a process object to represent the connection. | |
1219 | |
1220 The @var{name} argument specifies the name for the process object. It | |
1221 is modified as necessary to make it unique. | |
1222 | |
1223 The @var{buffer-or-name} argument is the buffer to associate with the | |
1224 connection. Output from the connection is inserted in the buffer, | |
1225 unless you specify a filter function to handle the output. If | |
1226 @var{buffer-or-name} is @code{nil}, it means that the connection is not | |
1227 associated with any buffer. | |
1228 | |
1229 The arguments @var{host} and @var{service} specify where to connect to; | |
1230 @var{host} is the host name (a string), and @var{service} is the name of | |
1231 a defined network service (a string) or a port number (an integer). | |
1232 @end defun |