1 ;;; esh-proc.el --- process management
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 ;; Author: John Wiegley <johnw@gnu.org>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
33 (defgroup eshell-proc nil
34 "When Eshell invokes external commands, it always does so
35 asynchronously, so that Emacs isn't tied up waiting for the process to
37 :tag
"Process management"
42 (defcustom eshell-proc-load-hook
'(eshell-proc-initialize)
43 "*A hook that gets run when `eshell-proc' is loaded."
47 (defcustom eshell-process-wait-seconds
0
48 "*The number of seconds to delay waiting for a synchronous process."
52 (defcustom eshell-process-wait-milliseconds
50
53 "*The number of milliseconds to delay waiting for a synchronous process."
57 (defcustom eshell-done-messages-in-minibuffer t
58 "*If non-nil, subjob \"Done\" messages will display in minibuffer."
62 (defcustom eshell-delete-exited-processes t
63 "*If nil, process entries will stick around until `jobs' is run.
64 This variable sets the buffer-local value of `delete-exited-processes'
67 This variable causes Eshell to mimic the behavior of bash when set to
68 nil. It allows the user to view the exit status of a completed subjob
69 \(process) at their leisure, because the process entry remains in
70 memory until the user examines it using \\[list-processes].
72 Otherwise, if `eshell-done-messages-in-minibuffer' is nil, and this
73 variable is set to t, the only indication the user will have that a
74 subjob is done is that it will no longer appear in the
75 \\[list-processes\\] display.
77 Note that Eshell will have to be restarted for a change in this
78 variable's value to take effect."
82 (defcustom eshell-reset-signals
83 "^\\(interrupt\\|killed\\|quit\\|stopped\\)"
84 "*If a termination signal matches this regexp, the terminal will be reset."
88 (defcustom eshell-exec-hook nil
89 "*Called each time a process is exec'd by `eshell-gather-process-output'.
90 It is passed one argument, which is the process that was just started.
91 It is useful for things that must be done each time a process is
92 executed in a eshell mode buffer (e.g., `process-kill-without-query').
93 In contrast, `eshell-mode-hook' is only executed once when the buffer
98 (defcustom eshell-kill-hook
'(eshell-reset-after-proc)
99 "*Called when a process run by `eshell-gather-process-output' has ended.
100 It is passed two arguments: the process that was just ended, and the
101 termination status (as a string). Note that the first argument may be
102 nil, in which case the user attempted to send a signal, but there was
103 no relevant process. This can be used for displaying help
104 information, for example."
108 ;;; Internal Variables:
110 (defvar eshell-current-subjob-p nil
)
112 (defvar eshell-process-list nil
113 "A list of the current status of subprocesses.")
117 (defun eshell-proc-initialize ()
118 "Initialize the process handling code."
119 (make-local-variable 'eshell-process-list
)
120 (define-key eshell-command-map
[(meta ?i
)] 'eshell-insert-process
)
121 (define-key eshell-command-map
[(control ?c
)] 'eshell-interrupt-process
)
122 (define-key eshell-command-map
[(control ?k
)] 'eshell-kill-process
)
123 (define-key eshell-command-map
[(control ?d
)] 'eshell-send-eof-to-process
)
124 ; (define-key eshell-command-map [(control ?q)] 'eshell-continue-process)
125 (define-key eshell-command-map
[(control ?s
)] 'list-processes
)
126 ; (define-key eshell-command-map [(control ?z)] 'eshell-stop-process)
127 (define-key eshell-command-map
[(control ?
\\)] 'eshell-quit-process
))
129 (defun eshell-reset-after-proc (proc status
)
130 "Reset the command input location after a process terminates.
131 The signals which will cause this to happen are matched by
132 `eshell-reset-signals'."
133 (if (and (stringp status
)
134 (string-match eshell-reset-signals status
))
137 (defun eshell-wait-for-process (&rest procs
)
138 "Wait until PROC has successfully completed."
140 (let ((proc (car procs
)))
141 (when (eshell-processp proc
)
142 ;; NYI: If the process gets stopped here, that's bad.
143 (while (assq proc eshell-process-list
)
144 (if (input-pending-p)
146 (sit-for eshell-process-wait-seconds
147 eshell-process-wait-milliseconds
))))
148 (setq procs
(cdr procs
))))
150 (defalias 'eshell
/wait
'eshell-wait-for-process
)
152 (defun eshell/jobs
(&rest args
)
153 "List processes, if there are any."
154 (and (fboundp 'process-list
)
158 (defun eshell/kill
(&rest args
)
159 "Kill processes, buffers, symbol or files."
163 (if (or (eshell-processp (car ptr
))
164 (and (stringp (car ptr
))
165 (string-match "^[A-Za-z/][A-Za-z0-9<>/]+$"
167 ;; What about when $lisp-variable is possible here?
168 ;; It could very well name a process.
169 (setcar ptr
(get-process (car ptr
))))
170 (setq ptr
(cdr ptr
)))
172 (let ((id (if (eshell-processp (car args
))
173 (process-id (car args
))
178 (error "kill: bad signal spec"))
179 ((and (numberp id
) (= id
0))
180 (error "kill: bad signal spec `%d'" id
))
182 (string-match "^-?[0-9]+$" id
))
183 (setq signum
(abs (string-to-number id
))))
185 (let (case-fold-search)
186 (if (string-match "^-\\([A-Z]+[12]?\\)$" id
)
188 (intern (concat "SIG" (match-string 1 id
))))
189 (error "kill: bad signal spec `%s'" id
))))
191 (setq signum
(abs id
)))
193 (signal-process id signum
)))))
194 (setq args
(cdr args
)))
197 (defun eshell-read-process-name (prompt)
198 "Read the name of a process from the minibuffer, using completion.
199 The prompt will be set to PROMPT."
200 (completing-read prompt
204 (cons (process-name proc
) t
)))
205 (process-list)) nil t
))
207 (defun eshell-insert-process (process)
208 "Insert the name of PROCESS into the current buffer at point."
211 (eshell-read-process-name "Name of process: "))))
212 (insert-and-inherit "#<process " (process-name process
) ">"))
214 (defsubst eshell-record-process-object
(object)
215 "Record OBJECT as now running."
216 (if (and (eshell-processp object
)
217 eshell-current-subjob-p
)
218 (eshell-interactive-print
219 (format "[%s] %d\n" (process-name object
) (process-id object
))))
220 (setq eshell-process-list
221 (cons (list object eshell-current-handles
222 eshell-current-subjob-p nil nil
)
223 eshell-process-list
)))
225 (defun eshell-remove-process-entry (entry)
226 "Record the process ENTRY as fully completed."
227 (if (and (eshell-processp (car entry
))
229 eshell-done-messages-in-minibuffer
)
230 (message "[%s]+ Done %s" (process-name (car entry
))
231 (process-command (car entry
))))
232 (setq eshell-process-list
233 (delq entry eshell-process-list
)))
235 (defvar eshell-scratch-buffer
" *eshell-scratch*"
236 "Scratch buffer for holding Eshell's input/output.")
237 (defvar eshell-last-sync-output-start nil
238 "A marker that tracks the beginning of output of the last subprocess.
239 Used only on systems which do not support async subprocesses.")
241 (defvar eshell-needs-pipe
'("bc")
242 "List of commands which need `process-connection-type' to be nil.
243 Currently only affects commands in pipelines, and not those at
244 the front. If an element contains a directory part it must match
245 the full name of a command, otherwise just the nondirectory part must match.")
247 (defun eshell-needs-pipe-p (command)
248 "Return non-nil if COMMAND needs `process-connection-type' to be nil.
249 See `eshell-needs-pipe'."
250 (and eshell-in-pipeline-p
251 (not (eq eshell-in-pipeline-p
'first
))
252 ;; FIXME should this return non-nil for anything that is
253 ;; neither 'first nor 'last? See bug#1388 discussion.
255 (dolist (exe eshell-needs-pipe
)
256 (if (string-equal exe
(if (string-match "/" exe
)
258 (file-name-nondirectory command
)))
259 (throw 'found t
))))))
261 (defun eshell-gather-process-output (command args
)
262 "Gather the output from COMMAND + ARGS."
263 (unless (and (file-executable-p command
)
264 (file-regular-p command
))
265 (error "%s: not an executable file" command
))
266 (let* ((delete-exited-processes
267 (if eshell-current-subjob-p
268 eshell-delete-exited-processes
269 delete-exited-processes
))
270 (process-environment (eshell-environment-variables))
271 proc decoding encoding changed
)
273 ((fboundp 'start-process
)
275 (let ((process-connection-type
276 (unless (eshell-needs-pipe-p command
)
277 process-connection-type
)))
278 (apply 'start-process
279 (file-name-nondirectory command
) nil
280 ;; `start-process' can't deal with relative filenames.
281 (append (list (expand-file-name command
)) args
))))
282 (eshell-record-process-object proc
)
283 (set-process-buffer proc
(current-buffer))
284 (if (eshell-interactive-output-p)
285 (set-process-filter proc
'eshell-output-filter
)
286 (set-process-filter proc
'eshell-insertion-filter
))
287 (set-process-sentinel proc
'eshell-sentinel
)
288 (run-hook-with-args 'eshell-exec-hook proc
)
289 (when (fboundp 'process-coding-system
)
290 (let ((coding-systems (process-coding-system proc
)))
291 (setq decoding
(car coding-systems
)
292 encoding
(cdr coding-systems
)))
293 ;; If start-process decided to use some coding system for
294 ;; decoding data sent from the process and the coding system
295 ;; doesn't specify EOL conversion, we had better convert CRLF
297 (if (vectorp (coding-system-eol-type decoding
))
298 (setq decoding
(coding-system-change-eol-conversion decoding
'dos
)
300 ;; Even if start-process left the coding system for encoding
301 ;; data sent from the process undecided, we had better use the
302 ;; same one as what we use for decoding. But, we should
303 ;; suppress EOL conversion.
304 (if (and decoding
(not encoding
))
305 (setq encoding
(coding-system-change-eol-conversion decoding
'unix
)
308 (set-process-coding-system proc decoding encoding
))))
310 ;; No async subprocesses...
311 (let ((oldbuf (current-buffer))
312 (interact-p (eshell-interactive-output-p))
313 lbeg lend line proc-buf exit-status
)
314 (and (not (markerp eshell-last-sync-output-start
))
315 (setq eshell-last-sync-output-start
(point-marker)))
317 (set-buffer (get-buffer-create eshell-scratch-buffer
)))
320 (run-hook-with-args 'eshell-exec-hook command
)
322 (apply 'call-process-region
323 (append (list eshell-last-sync-output-start
(point)
325 eshell-scratch-buffer nil
)
327 ;; When in a pipeline, record the place where the output of
328 ;; this process will begin.
329 (and eshell-in-pipeline-p
330 (set-marker eshell-last-sync-output-start
(point)))
331 ;; Simulate the effect of the process filter.
332 (when (numberp exit-status
)
333 (set-buffer proc-buf
)
334 (goto-char (point-min))
336 (while (eq 0 (forward-line 1))
338 line
(buffer-substring-no-properties lbeg lend
))
341 (eshell-output-filter nil line
)
342 (eshell-output-object line
))
344 (set-buffer proc-buf
))
346 (eshell-update-markers eshell-last-output-end
)
347 ;; Simulate the effect of eshell-sentinel.
348 (eshell-close-handles (if (numberp exit-status
) exit-status -
1))
349 (run-hook-with-args 'eshell-kill-hook command exit-status
)
350 (or eshell-in-pipeline-p
351 (setq eshell-last-sync-output-start nil
))
352 (if (not (numberp exit-status
))
353 (error "%s: external command failed: %s" command exit-status
))
357 (defun eshell-insertion-filter (proc string
)
358 "Insert a string into the eshell buffer, or a process/file/buffer.
359 PROC is the process for which we're inserting output. STRING is the
361 (when (buffer-live-p (process-buffer proc
))
362 (with-current-buffer (process-buffer proc
)
363 (let ((entry (assq proc eshell-process-list
)))
365 (setcar (nthcdr 3 entry
)
366 (concat (nth 3 entry
) string
))
367 (unless (nth 4 entry
) ; already being handled?
369 (let ((data (nth 3 entry
)))
370 (setcar (nthcdr 3 entry
) nil
)
371 (setcar (nthcdr 4 entry
) t
)
372 (eshell-output-object data nil
(cadr entry
))
373 (setcar (nthcdr 4 entry
) nil
)))))))))
375 (defun eshell-sentinel (proc string
)
376 "Generic sentinel for command processes. Reports only signals.
377 PROC is the process that's exiting. STRING is the exit message."
378 (when (buffer-live-p (process-buffer proc
))
379 (with-current-buffer (process-buffer proc
)
381 (let* ((entry (assq proc eshell-process-list
)))
383 ; (error "Sentinel called for unowned process `%s'"
384 ; (process-name proc))
388 (unless (string= string
"run")
389 (unless (string-match "^\\(finished\\|exited\\)" string
)
390 (eshell-insertion-filter proc string
))
391 (eshell-close-handles (process-exit-status proc
) 'nil
393 (eshell-remove-process-entry entry
))))
394 (run-hook-with-args 'eshell-kill-hook proc string
)))))
396 (defun eshell-process-interact (func &optional all query
)
397 "Interact with a process, using PROMPT if more than one, via FUNC.
398 If ALL is non-nil, background processes will be interacted with as well.
399 If QUERY is non-nil, query the user with QUERY before calling FUNC."
400 (let (defunct result
)
401 (eshell-for entry eshell-process-list
402 (if (and (memq (process-status (car entry
))
403 '(run stop open closed
))
407 (y-or-n-p (format query
(process-name (car entry
))))))
408 (setq result
(funcall func
(car entry
))))
409 (unless (memq (process-status (car entry
))
410 '(run stop open closed
))
411 (setq defunct
(cons entry defunct
))))
412 ;; clean up the process list; this can get dirty if an error
413 ;; occurred that brought the user into the debugger, and then they
414 ;; quit, so that the sentinel was never called.
415 (eshell-for d defunct
416 (eshell-remove-process-entry d
))
419 (defcustom eshell-kill-process-wait-time
5
420 "*Seconds to wait between sending termination signals to a subprocess."
424 (defcustom eshell-kill-process-signals
'(SIGINT SIGQUIT SIGKILL
)
425 "*Signals used to kill processes when an Eshell buffer exits.
426 Eshell calls each of these signals in order when an Eshell buffer is
427 killed; if the process is still alive afterwards, Eshell waits a
428 number of seconds defined by `eshell-kill-process-wait-time', and
429 tries the next signal in the list."
430 :type
'(repeat symbol
)
433 (defcustom eshell-kill-processes-on-exit nil
434 "*If non-nil, kill active processes when exiting an Eshell buffer.
435 Emacs will only kill processes owned by that Eshell buffer.
437 If nil, ownership of background and foreground processes reverts to
438 Emacs itself, and will die only if the user exits Emacs, calls
439 `kill-process', or terminates the processes externally.
441 If `ask', Emacs prompts the user before killing any processes.
443 If `every', it prompts once for every process.
445 If t, it kills all buffer-owned processes without asking.
447 Processes are first sent SIGHUP, then SIGINT, then SIGQUIT, then
448 SIGKILL. The variable `eshell-kill-process-wait-time' specifies how
449 long to delay between signals."
450 :type
'(choice (const :tag
"Kill all, don't ask" t
)
451 (const :tag
"Ask before killing" ask
)
452 (const :tag
"Ask for each process" every
)
453 (const :tag
"Don't kill subprocesses" nil
))
456 (defun eshell-round-robin-kill (&optional query
)
457 "Kill current process by trying various signals in sequence.
458 See the variable `eshell-kill-processes-on-exit'."
459 (let ((sigs eshell-kill-process-signals
))
461 (eshell-process-interact
464 (signal-process (process-id proc
) (car sigs
)))) t query
)
466 (if (not eshell-process-list
)
468 (sleep-for eshell-kill-process-wait-time
)
469 (setq sigs
(cdr sigs
))))))
471 (defun eshell-query-kill-processes ()
472 "Kill processes belonging to the current Eshell buffer, possibly w/ query."
473 (when (and eshell-kill-processes-on-exit
475 (save-window-excursion
477 (if (or (not (eq eshell-kill-processes-on-exit
'ask
))
478 (y-or-n-p (format "Kill processes owned by `%s'? "
480 (eshell-round-robin-kill
481 (if (eq eshell-kill-processes-on-exit
'every
)
482 "Kill Eshell child process `%s'? ")))
483 (let ((buf (get-buffer "*Process List*")))
484 (if (and buf
(buffer-live-p buf
))
488 (custom-add-option 'eshell-exit-hook
'eshell-query-kill-processes
)
490 (defun eshell-interrupt-process ()
491 "Interrupt a process."
493 (unless (eshell-process-interact 'interrupt-process
)
494 (run-hook-with-args 'eshell-kill-hook nil
"interrupt")))
496 (defun eshell-kill-process ()
499 (unless (eshell-process-interact 'kill-process
)
500 (run-hook-with-args 'eshell-kill-hook nil
"killed")))
502 (defun eshell-quit-process ()
503 "Send quit signal to process."
505 (unless (eshell-process-interact 'quit-process
)
506 (run-hook-with-args 'eshell-kill-hook nil
"quit")))
508 ;(defun eshell-stop-process ()
509 ; "Send STOP signal to process."
511 ; (unless (eshell-process-interact 'stop-process)
512 ; (run-hook-with-args 'eshell-kill-hook nil "stopped")))
514 ;(defun eshell-continue-process ()
515 ; "Send CONTINUE signal to process."
517 ; (unless (eshell-process-interact 'continue-process)
518 ; ;; jww (1999-09-17): this signal is not dealt with yet. For
519 ; ;; example, `eshell-reset' will be called, and so will
520 ; ;; `eshell-resume-eval'.
521 ; (run-hook-with-args 'eshell-kill-hook nil "continue")))
523 (defun eshell-send-eof-to-process ()
524 "Send EOF to process."
526 (eshell-send-input nil nil t
)
527 (eshell-process-interact 'process-send-eof
))
529 ;; arch-tag: ac477a3e-ee4d-4b44-8ec6-212010e607bb
530 ;;; esh-proc.el ends here