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