annotate lisp/process.el @ 209:41ff10fd062f r20-4b3

Import from CVS: tag r20-4b3
author cvs
date Mon, 13 Aug 2007 10:04:58 +0200
parents
children 0e522484dd2a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
1 ;;; process.el --- commands for subprocesses; split out of simple.el
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
2
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
3 ;; Copyright (C) 1985-7, 1993,4, 1997 Free Software Foundation, Inc.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
4 ;; Copyright (C) 1995 Ben Wing.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
5
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
6 ;; Author: Ben Wing
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
7 ;; Maintainer: XEmacs Development Team
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
8 ;; Keywords: internal, processes, dumped
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
9
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
10 ;; This file is part of XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
11
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
12 ;; XEmacs is free software; you can redistribute it and/or modify it
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
13 ;; under the terms of the GNU General Public License as published by
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
14 ;; the Free Software Foundation; either version 2, or (at your option)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
15 ;; any later version.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
16
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
17 ;; XEmacs is distributed in the hope that it will be useful, but
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
20 ;; General Public License for more details.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
21
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
22 ;; You should have received a copy of the GNU General Public License
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
23 ;; along with XEmacs; see the file COPYING. If not, write to the
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
24 ;; Free Software Foundation, 59 Temple Place - Suite 330,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
25 ;; Boston, MA 02111-1307, USA.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
26
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
27 ;;; Synched up with: FSF 19.30.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
28
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
29 ;;; Commentary:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
30
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
31 ;; This file is dumped with XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
32
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
33 ;;; Code:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
34
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
35
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
36 (defvar shell-command-switch "-c"
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
37 "Switch used to have the shell execute its command line argument.")
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
38
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
39 (defun start-process-shell-command (name buffer &rest args)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
40 "Start a program in a subprocess. Return the process object for it.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
41 Args are NAME BUFFER COMMAND &rest COMMAND-ARGS.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
42 NAME is name for process. It is modified if necessary to make it unique.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
43 BUFFER is the buffer or (buffer-name) to associate with the process.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
44 Process output goes at end of that buffer, unless you specify
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
45 an output stream or filter function to handle the output.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
46 BUFFER may be also nil, meaning that this process is not associated
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
47 with any buffer
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
48 Third arg is command name, the name of a shell command.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
49 Remaining arguments are the arguments for the command.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
50 Wildcards and redirection are handled as usual in the shell."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
51 (cond
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
52 ((eq system-type 'vax-vms)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
53 (apply 'start-process name buffer args))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
54 ;; We used to use `exec' to replace the shell with the command,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
55 ;; but that failed to handle (...) and semicolon, etc.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
56 (t
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
57 (start-process name buffer shell-file-name shell-command-switch
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
58 (mapconcat 'identity args " ")))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
59
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
60 (defun call-process (program &optional infile buffer displayp &rest args)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
61 "Call PROGRAM synchronously in separate process.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
62 The program's input comes from file INFILE (nil means `/dev/null').
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
63 Insert output in BUFFER before point; t means current buffer;
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
64 nil for BUFFER means discard it; 0 means discard and don't wait.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
65 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
66 REAL-BUFFER says what to do with standard output, as above,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
67 while STDERR-FILE says what to do with standard error in the child.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
68 STDERR-FILE may be nil (discard standard error output),
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
69 t (mix it with ordinary output), or a file name string.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
70
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
71 Fourth arg DISPLAYP non-nil means redisplay buffer as output is inserted.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
72 Remaining arguments are strings passed as command arguments to PROGRAM.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
73
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
74 If BUFFER is 0, `call-process' returns immediately with value nil.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
75 Otherwise it waits for PROGRAM to terminate and returns a numeric exit status
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
76 or a signal description string.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
77 If you quit, the process is killed with SIGINT, or SIGKILL if you
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
78 quit again."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
79 (apply 'call-process-internal program infile buffer displayp args))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
80
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
81 (defun call-process-region (start end program
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
82 &optional deletep buffer displayp
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
83 &rest args)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
84 "Send text from START to END to a synchronous process running PROGRAM.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
85 Delete the text if fourth arg DELETEP is non-nil.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
86
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
87 Insert output in BUFFER before point; t means current buffer;
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
88 nil for BUFFER means discard it; 0 means discard and don't wait.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
89 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
90 REAL-BUFFER says what to do with standard output, as above,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
91 while STDERR-FILE says what to do with standard error in the child.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
92 STDERR-FILE may be nil (discard standard error output),
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
93 t (mix it with ordinary output), or a file name string.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
94
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
95 Sixth arg DISPLAYP non-nil means redisplay buffer as output is inserted.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
96 Remaining args are passed to PROGRAM at startup as command args.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
97
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
98 If BUFFER is 0, returns immediately with value nil.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
99 Otherwise waits for PROGRAM to terminate
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
100 and returns a numeric exit status or a signal description string.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
101 If you quit, the process is first killed with SIGINT, then with SIGKILL if
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
102 you quit again before the process exits."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
103 (let ((temp (cond ((eq system-type 'vax-vms)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
104 (make-temp-name "tmp:emacs"))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
105 ((or (eq system-type 'ms-dos)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
106 (eq system-type 'windows-nt))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
107 (make-temp-name
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
108 (concat (file-name-as-directory
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
109 (or (getenv "TMP")
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
110 (getenv "TEMP")
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
111 ""))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
112 "em")))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
113 (t
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
114 (make-temp-name "/tmp/emacs")))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
115 (unwind-protect
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
116 (progn
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
117 (if (or (eq system-type 'ms-dos)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
118 (eq system-type 'windows-nt))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
119 (let ((buffer-file-type binary-process-output))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
120 (write-region start end temp nil 'silent))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
121 (write-region start end temp nil 'silent))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
122 (if deletep (delete-region start end))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
123 (apply #'call-process program temp buffer displayp args))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
124 (condition-case ()
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
125 (delete-file temp)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
126 (file-error nil)))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
127
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
128
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
129 (defun shell-command (command &optional output-buffer)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
130 "Execute string COMMAND in inferior shell; display output, if any.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
131
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
132 If COMMAND ends in ampersand, execute it asynchronously.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
133 The output appears in the buffer `*Async Shell Command*'.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
134 That buffer is in shell mode.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
135
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
136 Otherwise, COMMAND is executed synchronously. The output appears in the
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
137 buffer `*Shell Command Output*'.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
138 If the output is one line, it is displayed in the echo area *as well*,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
139 but it is nonetheless available in buffer `*Shell Command Output*',
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
140 even though that buffer is not automatically displayed.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
141 If there is no output, or if output is inserted in the current buffer,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
142 then `*Shell Command Output*' is deleted.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
143
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
144 The optional second argument OUTPUT-BUFFER, if non-nil,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
145 says to put the output in some other buffer.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
146 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
147 If OUTPUT-BUFFER is not a buffer and not nil,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
148 insert output in current buffer. (This cannot be done asynchronously.)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
149 In either case, the output is inserted after point (leaving mark after it)."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
150 (interactive (list (read-shell-command "Shell command: ")
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
151 current-prefix-arg))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
152 (if (and output-buffer
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
153 (not (or (bufferp output-buffer) (stringp output-buffer))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
154 (progn (barf-if-buffer-read-only)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
155 (push-mark)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
156 ;; We do not use -f for csh; we will not support broken use of
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
157 ;; .cshrcs. Even the BSD csh manual says to use
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
158 ;; "if ($?prompt) exit" before things which are not useful
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
159 ;; non-interactively. Besides, if someone wants their other
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
160 ;; aliases for shell commands then they can still have them.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
161 (call-process shell-file-name nil t nil
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
162 shell-command-switch command)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
163 (exchange-point-and-mark t))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
164 ;; Preserve the match data in case called from a program.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
165 (save-match-data
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
166 (if (string-match "[ \t]*&[ \t]*$" command)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
167 ;; Command ending with ampersand means asynchronous.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
168 (progn
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
169 (background (substring command 0 (match-beginning 0))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
170 (shell-command-on-region (point) (point) command output-buffer)))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
171
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
172 ;; We have a sentinel to prevent insertion of a termination message
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
173 ;; in the buffer itself.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
174 (defun shell-command-sentinel (process signal)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
175 (if (memq (process-status process) '(exit signal))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
176 (message "%s: %s."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
177 (car (cdr (cdr (process-command process))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
178 (substring signal 0 -1))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
179
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
180 (defun shell-command-on-region (start end command
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
181 &optional output-buffer replace)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
182 "Execute string COMMAND in inferior shell with region as input.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
183 Normally display output (if any) in temp buffer `*Shell Command Output*';
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
184 Prefix arg means replace the region with it.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
185
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
186 The noninteractive arguments are START, END, COMMAND, OUTPUT-BUFFER, REPLACE.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
187 If REPLACE is non-nil, that means insert the output
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
188 in place of text from START to END, putting point and mark around it.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
189
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
190 If the output is one line, it is displayed in the echo area,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
191 but it is nonetheless available in buffer `*Shell Command Output*'
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
192 even though that buffer is not automatically displayed.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
193 If there is no output, or if output is inserted in the current buffer,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
194 then `*Shell Command Output*' is deleted.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
195
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
196 If the optional fourth argument OUTPUT-BUFFER is non-nil,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
197 that says to put the output in some other buffer.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
198 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
199 If OUTPUT-BUFFER is not a buffer and not nil,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
200 insert output in the current buffer.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
201 In either case, the output is inserted after point (leaving mark after it)."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
202 (interactive (let ((string
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
203 ;; Do this before calling region-beginning
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
204 ;; and region-end, in case subprocess output
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
205 ;; relocates them while we are in the minibuffer.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
206 (read-shell-command "Shell command on region: ")))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
207 ;; call-interactively recognizes region-beginning and
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
208 ;; region-end specially, leaving them in the history.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
209 (list (region-beginning) (region-end)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
210 string
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
211 current-prefix-arg
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
212 current-prefix-arg)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
213 (if (or replace
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
214 (and output-buffer
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
215 (not (or (bufferp output-buffer) (stringp output-buffer)))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
216 ;; Replace specified region with output from command.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
217 (let ((swap (and replace (< start end))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
218 ;; Don't muck with mark unless REPLACE says we should.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
219 (goto-char start)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
220 (and replace (push-mark))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
221 (call-process-region start end shell-file-name t t nil
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
222 shell-command-switch command)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
223 (let ((shell-buffer (get-buffer "*Shell Command Output*")))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
224 (and shell-buffer (not (eq shell-buffer (current-buffer)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
225 (kill-buffer shell-buffer)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
226 ;; Don't muck with mark unless REPLACE says we should.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
227 (and replace swap (exchange-point-and-mark t)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
228 ;; No prefix argument: put the output in a temp buffer,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
229 ;; replacing its entire contents.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
230 (let ((buffer (get-buffer-create
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
231 (or output-buffer "*Shell Command Output*")))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
232 (success nil)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
233 (directory default-directory))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
234 (unwind-protect
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
235 (if (eq buffer (current-buffer))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
236 ;; If the input is the same buffer as the output,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
237 ;; delete everything but the specified region,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
238 ;; then replace that region with the output.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
239 (progn (setq buffer-read-only nil)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
240 (delete-region (max start end) (point-max))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
241 (delete-region (point-min) (max start end))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
242 (call-process-region (point-min) (point-max)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
243 shell-file-name t t nil
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
244 shell-command-switch command)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
245 (setq success t))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
246 ;; Clear the output buffer,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
247 ;; then run the command with output there.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
248 (save-excursion
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
249 (set-buffer buffer)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
250 (setq buffer-read-only nil)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
251 ;; XEmacs change
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
252 (setq default-directory directory)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
253 (erase-buffer))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
254 (call-process-region start end shell-file-name
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
255 nil buffer nil
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
256 shell-command-switch command)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
257 (setq success t))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
258 ;; Report the amount of output.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
259 (let ((lines (save-excursion
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
260 (set-buffer buffer)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
261 (if (= (buffer-size) 0)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
262 0
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
263 (count-lines (point-min) (point-max))))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
264 (cond ((= lines 0)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
265 (if success
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
266 (display-message
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
267 'command
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
268 "(Shell command completed with no output)"))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
269 (kill-buffer buffer))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
270 ((and success (= lines 1))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
271 (message "%s"
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
272 (save-excursion
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
273 (set-buffer buffer)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
274 (goto-char (point-min))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
275 (buffer-substring (point)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
276 (progn (end-of-line)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
277 (point))))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
278 (t
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
279 (set-window-start (display-buffer buffer) 1))))))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
280
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
281
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
282 (defun start-process (name buffer program &rest program-args)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
283 "Start a program in a subprocess. Return the process object for it.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
284 Args are NAME BUFFER PROGRAM &rest PROGRAM-ARGS
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
285 NAME is name for process. It is modified if necessary to make it unique.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
286 BUFFER is the buffer or (buffer-name) to associate with the process.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
287 Process output goes at end of that buffer, unless you specify
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
288 an output stream or filter function to handle the output.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
289 BUFFER may be also nil, meaning that this process is not associated
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
290 with any buffer
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
291 Third arg is program file name. It is searched for as in the shell.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
292 Remaining arguments are strings to give program as arguments.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
293 INCODE and OUTCODE specify the coding-system objects used in input/output
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
294 from/to the process."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
295 (apply 'start-process-internal name buffer program program-args))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
296
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
297 (defun open-network-stream (name buffer host service)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
298 "Open a TCP connection for a service to a host.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
299 Returns a subprocess-object to represent the connection.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
300 Input and output work as for subprocesses; `delete-process' closes it.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
301 Args are NAME BUFFER HOST SERVICE.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
302 NAME is name for process. It is modified if necessary to make it unique.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
303 BUFFER is the buffer (or buffer-name) to associate with the process.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
304 Process output goes at end of that buffer, unless you specify
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
305 an output stream or filter function to handle the output.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
306 BUFFER may be also nil, meaning that this process is not associated
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
307 with any buffer
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
308 Third arg is name of the host to connect to, or its IP address.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
309 Fourth arg SERVICE is name of the service desired, or an integer
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
310 specifying a port number to connect to."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
311 (open-network-stream-internal name buffer host service))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
312
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
313 (defun shell-quote-argument (argument)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
314 "Quote an argument for passing as argument to an inferior shell."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
315 (if (eq system-type 'ms-dos)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
316 ;; MS-DOS shells don't have quoting, so don't do any.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
317 argument
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
318 (if (eq system-type 'windows-nt)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
319 (concat "\"" argument "\"")
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
320 ;; Quote everything except POSIX filename characters.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
321 ;; This should be safe enough even for really weird shells.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
322 (let ((result "") (start 0) end)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
323 (while (string-match "[^-0-9a-zA-Z_./]" argument start)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
324 (setq end (match-beginning 0)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
325 result (concat result (substring argument start end)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
326 "\\" (substring argument end (1+ end)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
327 start (1+ end)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
328 (concat result (substring argument start))))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
329
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
330 (defun exec-to-string (command)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
331 "Execute COMMAND as an external process and return the output of that
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
332 process as a string"
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
333 ;; by "William G. Dubuque" <wgd@zurich.ai.mit.edu>
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
334 (with-output-to-string
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
335 (call-process shell-file-name nil t nil "-c" command)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
336
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
337 (defalias 'shell-command-to-string 'exec-to-string)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
338
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
339 ;;; process.el ends here