Commit | Line | Data |
---|---|---|
5336e829 | 1 | ;;; shell.el --- specialized comint.el for running the shell. |
5109bfb0 KH |
2 | |
3 | ;; Copyright (C) 1988, 1993, 1994 Free Software Foundation, Inc. | |
6d74b528 | 4 | |
630cc463 | 5 | ;; Author: Olin Shivers <shivers@cs.cmu.edu> |
ba02c167 | 6 | ;; Maintainer: Simon Marshall <s.marshall@dcs.hull.ac.uk> |
d7b4d18f | 7 | ;; Keywords: processes |
630cc463 | 8 | |
5109bfb0 | 9 | ;; This file is part of GNU Emacs. |
c88ab9ce | 10 | |
5109bfb0 KH |
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify |
12 | ;; it under the terms of the GNU General Public License as published by | |
13 | ;; the Free Software Foundation; either version 2, or (at your option) | |
14 | ;; any later version. | |
c88ab9ce | 15 | |
5109bfb0 KH |
16 | ;; GNU Emacs is distributed in the hope that it will be useful, |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
c88ab9ce | 20 | |
5109bfb0 KH |
21 | ;; You should have received a copy of the GNU General Public License |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to | |
23 | ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
be9b65ac | 24 | |
630cc463 ER |
25 | ;;; Commentary: |
26 | ||
a9ec2adb JB |
27 | ;;; Please send me bug reports, bug fixes, and extensions, so that I can |
28 | ;;; merge them into the master source. | |
29 | ;;; - Olin Shivers (shivers@cs.cmu.edu) | |
d76b71af | 30 | ;;; - Simon Marshall (s.marshall@dcs.hull.ac.uk) |
be9b65ac | 31 | |
a9ec2adb | 32 | ;;; This file defines a a shell-in-a-buffer package (shell mode) built |
c88ab9ce ER |
33 | ;;; on top of comint mode. This is actually cmushell with things |
34 | ;;; renamed to replace its counterpart in Emacs 18. cmushell is more | |
35 | ;;; featureful, robust, and uniform than the Emacs 18 version. | |
be9b65ac DL |
36 | |
37 | ;;; Since this mode is built on top of the general command-interpreter-in- | |
38 | ;;; a-buffer mode (comint mode), it shares a common base functionality, | |
39 | ;;; and a common set of bindings, with all modes derived from comint mode. | |
a9ec2adb | 40 | ;;; This makes these modes easier to use. |
be9b65ac DL |
41 | |
42 | ;;; For documentation on the functionality provided by comint mode, and | |
43 | ;;; the hooks available for customising it, see the file comint.el. | |
a9ec2adb | 44 | ;;; For further information on shell mode, see the comments below. |
be9b65ac DL |
45 | |
46 | ;;; Needs fixin: | |
47 | ;;; When sending text from a source file to a subprocess, the process-mark can | |
48 | ;;; move off the window, so you can lose sight of the process interactions. | |
49 | ;;; Maybe I should ensure the process mark is in the window when I send | |
50 | ;;; text to the process? Switch selectable? | |
51 | ||
a9ec2adb JB |
52 | ;; YOUR .EMACS FILE |
53 | ;;============================================================================= | |
54 | ;; Some suggestions for your .emacs file. | |
55 | ;; | |
3bede93e | 56 | ;; ;; Define C-c t to run my favorite command in shell mode: |
d76b71af | 57 | ;; (setq shell-mode-hook |
a9ec2adb | 58 | ;; '((lambda () |
fa8f1b25 | 59 | ;; (define-key shell-mode-map "\C-ct" 'favorite-cmd)))) |
a9ec2adb JB |
60 | |
61 | \f | |
62 | ;;; Brief Command Documentation: | |
63 | ;;;============================================================================ | |
64 | ;;; Comint Mode Commands: (common to shell and all comint-derived modes) | |
65 | ;;; | |
66 | ;;; m-p comint-previous-input Cycle backwards in input history | |
67 | ;;; m-n comint-next-input Cycle forwards | |
d76b71af RS |
68 | ;;; m-r comint-previous-matching-input Previous input matching a regexp |
69 | ;;; m-R comint-previous-matching-input-from-input -"- matching input | |
70 | ;;; m-s comint-next-matching-input Next input that matches | |
71 | ;;; m-S comint-next-matching-input-from-input -"- matching input | |
f5a131d8 | 72 | ;;; m-c-l comint-show-output Show last batch of process output |
a9ec2adb | 73 | ;;; return comint-send-input |
d76b71af | 74 | ;;; c-a comint-bol Beginning of line; skip prompt |
a9ec2adb JB |
75 | ;;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff. |
76 | ;;; c-c c-u comint-kill-input ^u | |
77 | ;;; c-c c-w backward-kill-word ^w | |
78 | ;;; c-c c-c comint-interrupt-subjob ^c | |
79 | ;;; c-c c-z comint-stop-subjob ^z | |
80 | ;;; c-c c-\ comint-quit-subjob ^\ | |
81 | ;;; c-c c-o comint-kill-output Delete last batch of process output | |
82 | ;;; c-c c-r comint-show-output Show last batch of process output | |
d76b71af | 83 | ;;; c-c c-h comint-dynamic-list-input-ring List input history |
a9ec2adb JB |
84 | ;;; send-invisible Read line w/o echo & send to proc |
85 | ;;; comint-continue-subjob Useful if you accidentally suspend | |
d76b71af | 86 | ;;; top-level job |
a9ec2adb JB |
87 | ;;; comint-mode-hook is the comint mode hook. |
88 | ||
89 | ;;; Shell Mode Commands: | |
d76b71af RS |
90 | ;;; shell Fires up the shell process |
91 | ;;; tab comint-dynamic-complete Complete filename/command/history | |
92 | ;;; m-? comint-dynamic-list-filename-completions List completions in help buffer | |
93 | ;;; m-c-f shell-forward-command Forward a shell command | |
94 | ;;; m-c-b shell-backward-command Backward a shell command | |
95 | ;;; dirs Resync the buffer's dir stack | |
96 | ;;; dirtrack-toggle Turn dir tracking on/off | |
56783585 | 97 | ;;; shell-strip-ctrl-m Remove trailing ^Ms from output |
a9ec2adb JB |
98 | ;;; |
99 | ;;; The shell mode hook is shell-mode-hook | |
a9ec2adb JB |
100 | ;;; comint-prompt-regexp is initialised to shell-prompt-pattern, for backwards |
101 | ;;; compatibility. | |
102 | ||
103 | ;;; Read the rest of this file for more information. | |
104 | \f | |
c88ab9ce ER |
105 | ;;; SHELL.EL COMPATIBILITY |
106 | ;;; Notes from when this was called cmushell, and was not the standard emacs | |
107 | ;;; shell package. | |
a9ec2adb JB |
108 | ;;;============================================================================ |
109 | ;;; In brief: this package should have no trouble coexisting with shell.el. | |
110 | ;;; | |
111 | ;;; Most customising variables -- e.g., explicit-shell-file-name -- are the | |
112 | ;;; same, so the users shouldn't have much trouble. Hooks have different | |
c88ab9ce | 113 | ;;; names, however, so you can customise shell mode differently from cmushell |
a9ec2adb JB |
114 | ;;; mode. You basically just have to remember to type M-x cmushell instead of |
115 | ;;; M-x shell. | |
116 | ;;; | |
117 | ;;; It would be nice if this file was completely plug-compatible with the old | |
118 | ;;; shell package -- if you could just name this file shell.el, and have it | |
119 | ;;; transparently replace the old one. But you can't. Several other packages | |
120 | ;;; (tex-mode, background, dbx, gdb, kermit, monkey, prolog, telnet) are also | |
121 | ;;; clients of shell mode. These packages assume detailed knowledge of shell | |
122 | ;;; mode internals in ways that are incompatible with cmushell mode (mostly | |
123 | ;;; because of cmushell mode's greater functionality). So, unless we are | |
124 | ;;; willing to port all of these packages, we can't have this file be a | |
125 | ;;; complete replacement for shell.el -- that is, we can't name this file | |
126 | ;;; shell.el, and its main entry point (shell), because dbx.el will break | |
127 | ;;; when it loads it in and tries to use it. | |
128 | ;;; | |
129 | ;;; There are two ways to fix this. One: rewrite these other modes to use the | |
130 | ;;; new package. This is a win, but can't be assumed. The other, backwards | |
131 | ;;; compatible route, is to make this package non-conflict with shell.el, so | |
132 | ;;; both files can be loaded in at the same time. And *that* is why some | |
133 | ;;; functions and variables have different names: (cmushell), | |
134 | ;;; cmushell-mode-map, that sort of thing. All the names have been carefully | |
135 | ;;; chosen so that shell.el and cmushell.el won't tromp on each other. | |
136 | \f | |
8f95f0ce | 137 | ;;; Customization and Buffer Variables |
a9ec2adb JB |
138 | ;;; =========================================================================== |
139 | ;;; | |
140 | ||
630cc463 ER |
141 | ;;; Code: |
142 | ||
143 | (require 'comint) | |
144 | ||
c88ab9ce | 145 | ;;;###autoload |
ac75ef20 | 146 | (defvar shell-prompt-pattern "^[^#$%>\n]*[#$%>] *" |
a9ec2adb | 147 | "Regexp to match prompts in the inferior shell. |
ac75ef20 | 148 | Defaults to \"^[^#$%>\\n]*[#$%>] *\", which works pretty well. |
24fdffaa | 149 | This variable is used to initialise `comint-prompt-regexp' in the |
a9ec2adb JB |
150 | shell buffer. |
151 | ||
ac75ef20 JB |
152 | The pattern should probably not match more than one line. If it does, |
153 | shell-mode may become confused trying to distinguish prompt from input | |
154 | on lines which don't start with a prompt. | |
155 | ||
24fdffaa | 156 | This is a fine thing to set in your `.emacs' file.") |
a9ec2adb | 157 | |
e11284d5 RS |
158 | (defvar shell-completion-fignore nil |
159 | "*List of suffixes to be disregarded during file/command completion. | |
160 | This variable is used to initialize `comint-completion-fignore' in the shell | |
161 | buffer. The default is nil, for compatibility with most shells. | |
162 | Some people like (\"~\" \"#\" \"%\"). | |
163 | ||
164 | This is a fine thing to set in your `.emacs' file.") | |
165 | ||
56eb1060 | 166 | (defvar shell-delimiter-argument-list '(?\| ?& ?< ?> ?\( ?\) ?\;) |
d76b71af | 167 | "List of characters to recognise as separate arguments. |
56eb1060 RS |
168 | This variable is used to initialize `comint-delimiter-argument-list' in the |
169 | shell buffer. The default is (?\\| ?& ?< ?> ?\\( ?\\) ?\\;). | |
d76b71af RS |
170 | |
171 | This is a fine thing to set in your `.emacs' file.") | |
172 | ||
988a4d60 RS |
173 | (defvar shell-dynamic-complete-functions |
174 | '(comint-replace-by-expanded-history | |
175 | shell-dynamic-complete-environment-variable | |
176 | shell-dynamic-complete-command | |
177 | shell-replace-by-expanded-directory | |
178 | comint-dynamic-complete-filename) | |
179 | "List of functions called to perform completion. | |
180 | This variable is used to initialise `comint-dynamic-complete-functions' in the | |
181 | shell buffer. | |
182 | ||
183 | This is a fine thing to set in your `.emacs' file.") | |
184 | ||
d76b71af RS |
185 | (defvar shell-command-regexp "\\((.*)\\|[^;&|]\\)+" |
186 | "*Regexp to match shell commands. | |
187 | Elements of pipes are considered as separate commands, forks and redirections | |
188 | as part of one command.") | |
189 | ||
190 | (defvar shell-completion-execonly t | |
191 | "*If non-nil, use executable files only for completion candidates. | |
5394cb44 | 192 | This mirrors the optional behavior of tcsh. |
d76b71af RS |
193 | |
194 | Detecting executability of files may slow command completion considerably.") | |
195 | ||
be9b65ac DL |
196 | (defvar shell-popd-regexp "popd" |
197 | "*Regexp to match subshell commands equivalent to popd.") | |
198 | ||
199 | (defvar shell-pushd-regexp "pushd" | |
200 | "*Regexp to match subshell commands equivalent to pushd.") | |
201 | ||
d76b71af RS |
202 | (defvar shell-pushd-tohome nil |
203 | "*If non-nil, make pushd with no arg behave as \"pushd ~\" (like cd). | |
5394cb44 | 204 | This mirrors the optional behavior of tcsh.") |
d76b71af RS |
205 | |
206 | (defvar shell-pushd-dextract nil | |
207 | "*If non-nil, make \"pushd +n\" pop the nth dir to the stack top. | |
5394cb44 | 208 | This mirrors the optional behavior of tcsh.") |
d76b71af RS |
209 | |
210 | (defvar shell-pushd-dunique nil | |
211 | "*If non-nil, make pushd only add unique directories to the stack. | |
5394cb44 | 212 | This mirrors the optional behavior of tcsh.") |
d76b71af | 213 | |
be9b65ac DL |
214 | (defvar shell-cd-regexp "cd" |
215 | "*Regexp to match subshell commands equivalent to cd.") | |
216 | ||
217 | (defvar explicit-shell-file-name nil | |
218 | "*If non-nil, is file name to use for explicitly requested inferior shell.") | |
219 | ||
220 | (defvar explicit-csh-args | |
221 | (if (eq system-type 'hpux) | |
222 | ;; -T persuades HP's csh not to think it is smarter | |
223 | ;; than us about what terminal modes to use. | |
224 | '("-i" "-T") | |
225 | '("-i")) | |
226 | "*Args passed to inferior shell by M-x shell, if the shell is csh. | |
227 | Value is a list of strings, which may be nil.") | |
228 | ||
4f99443b RS |
229 | (defvar shell-input-autoexpand 'history |
230 | "*If non-nil, expand input command history references on completion. | |
231 | This mirrors the optional behavior of tcsh (its autoexpand and histlit). | |
232 | ||
233 | If the value is `input', then the expansion is seen on input. | |
234 | If the value is `history', then the expansion is only when inserting | |
235 | into the buffer's input ring. See also `comint-magic-space' and | |
236 | `comint-dynamic-complete'. | |
237 | ||
238 | This variable supplies a default for `comint-input-autoexpand', | |
239 | for Shell mode only.") | |
240 | ||
be9b65ac | 241 | (defvar shell-dirstack nil |
c88ab9ce ER |
242 | "List of directories saved by pushd in this buffer's shell. |
243 | Thus, this does not include the shell's current directory.") | |
be9b65ac | 244 | |
b493a9b2 RS |
245 | (defvar shell-dirtrackp t |
246 | "Non-nil in a shell buffer means directory tracking is enabled.") | |
247 | ||
fa8f1b25 ER |
248 | (defvar shell-last-dir nil |
249 | "Keep track of last directory for ksh `cd -' command.") | |
250 | ||
c63e83a4 | 251 | (defvar shell-dirstack-query nil |
24fdffaa | 252 | "Command used by `shell-resync-dir' to query the shell.") |
be9b65ac | 253 | |
9376442d | 254 | (defvar shell-mode-map nil) |
be9b65ac | 255 | (cond ((not shell-mode-map) |
9376442d | 256 | (setq shell-mode-map (copy-keymap comint-mode-map)) |
d76b71af RS |
257 | (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command) |
258 | (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command) | |
be9b65ac | 259 | (define-key shell-mode-map "\t" 'comint-dynamic-complete) |
d76b71af | 260 | (define-key shell-mode-map "\M-?" |
988a4d60 | 261 | 'comint-dynamic-list-filename-completions) |
5109bfb0 KH |
262 | (define-key-after (lookup-key shell-mode-map [menu-bar completion]) |
263 | [complete-env-variable] '("Complete Env. Variable Name" . | |
264 | shell-dynamic-complete-environment-variable) | |
265 | 'complete-file) | |
266 | (define-key-after (lookup-key shell-mode-map [menu-bar completion]) | |
267 | [expand-directory] '("Expand Directory Reference" . | |
268 | shell-replace-by-expanded-directory) | |
269 | 'complete-expand))) | |
be9b65ac DL |
270 | |
271 | (defvar shell-mode-hook '() | |
24fdffaa | 272 | "*Hook for customising Shell mode.") |
be9b65ac DL |
273 | |
274 | \f | |
275 | ;;; Basic Procedures | |
276 | ;;; =========================================================================== | |
277 | ;;; | |
278 | ||
279 | (defun shell-mode () | |
280 | "Major mode for interacting with an inferior shell. | |
281 | Return after the end of the process' output sends the text from the | |
282 | end of process to the end of the current line. | |
c88ab9ce ER |
283 | Return before end of process output copies the current line (except |
284 | for the prompt) to the end of the buffer and sends it. | |
be9b65ac | 285 | M-x send-invisible reads a line of text without echoing it, and sends it to |
56783585 RS |
286 | the shell. This is useful for entering passwords. Or, add the function |
287 | `comint-watch-for-password-prompt' to `comint-output-filter-functions'. | |
be9b65ac DL |
288 | |
289 | If you accidentally suspend your process, use \\[comint-continue-subjob] | |
290 | to continue it. | |
291 | ||
292 | cd, pushd and popd commands given to the shell are watched by Emacs to keep | |
293 | this buffer's default directory the same as the shell's working directory. | |
294 | M-x dirs queries the shell and resyncs Emacs' idea of what the current | |
295 | directory stack is. | |
296 | M-x dirtrack-toggle turns directory tracking on and off. | |
297 | ||
298 | \\{shell-mode-map} | |
24fdffaa | 299 | Customization: Entry to this mode runs the hooks on `comint-mode-hook' and |
988a4d60 | 300 | `shell-mode-hook' (in that order). Before each input, the hooks on |
ba02c167 RS |
301 | `comint-input-filter-functions' are run. After each shell output, the hooks |
302 | on `comint-output-filter-functions' are run. | |
be9b65ac | 303 | |
24fdffaa | 304 | Variables `shell-cd-regexp', `shell-pushd-regexp' and `shell-popd-regexp' |
d76b71af | 305 | are used to match their respective commands, while `shell-pushd-tohome', |
5394cb44 | 306 | `shell-pushd-dextract' and `shell-pushd-dunique' control the behavior of the |
d76b71af RS |
307 | relevant command. |
308 | ||
e11284d5 RS |
309 | Variables `comint-completion-autolist', `comint-completion-addsuffix', |
310 | `comint-completion-recexact' and `comint-completion-fignore' control the | |
311 | behavior of file name, command name and variable name completion. Variable | |
312 | `shell-completion-execonly' controls the behavior of command name completion. | |
313 | Variable `shell-completion-fignore' is used to initialise the value of | |
314 | `comint-completion-fignore'. | |
d76b71af RS |
315 | |
316 | Variables `comint-input-ring-file-name' and `comint-input-autoexpand' control | |
317 | the initialisation of the input ring history, and history expansion. | |
318 | ||
ba02c167 | 319 | Variables `comint-output-filter-functions', a hook, and |
e11284d5 | 320 | `comint-scroll-to-bottom-on-input' and `comint-scroll-to-bottom-on-output' |
988a4d60 RS |
321 | control whether input and output cause the window to scroll to the end of the |
322 | buffer." | |
be9b65ac DL |
323 | (interactive) |
324 | (comint-mode) | |
a9ec2adb | 325 | (setq major-mode 'shell-mode) |
bd5201e3 | 326 | (setq mode-name "Shell") |
be9b65ac | 327 | (use-local-map shell-mode-map) |
d76b71af | 328 | (setq comint-prompt-regexp shell-prompt-pattern) |
e11284d5 | 329 | (setq comint-completion-fignore shell-completion-fignore) |
d76b71af | 330 | (setq comint-delimiter-argument-list shell-delimiter-argument-list) |
988a4d60 | 331 | (setq comint-dynamic-complete-functions shell-dynamic-complete-functions) |
d76b71af RS |
332 | (make-local-variable 'paragraph-start) |
333 | (setq paragraph-start comint-prompt-regexp) | |
be9b65ac | 334 | (make-local-variable 'shell-dirstack) |
a9ec2adb | 335 | (setq shell-dirstack nil) |
fa8f1b25 | 336 | (setq shell-last-dir nil) |
a9ec2adb JB |
337 | (make-local-variable 'shell-dirtrackp) |
338 | (setq shell-dirtrackp t) | |
ba02c167 | 339 | (add-hook 'comint-input-filter-functions 'shell-directory-tracker) |
4f99443b | 340 | (setq comint-input-autoexpand shell-input-autoexpand) |
d76b71af | 341 | ;; shell-dependent assignments. |
c63e83a4 RS |
342 | (let ((shell (file-name-nondirectory (car |
343 | (process-command (get-buffer-process (current-buffer))))))) | |
d76b71af RS |
344 | (setq comint-input-ring-file-name |
345 | (or (getenv "HISTFILE") | |
c63e83a4 RS |
346 | (cond ((string-equal shell "bash") "~/.bash_history") |
347 | ((string-equal shell "ksh") "~/.sh_history") | |
348 | (t "~/.history")))) | |
349 | (setq shell-dirstack-query | |
350 | (if (string-match "^k?sh$" shell) "pwd" "dirs"))) | |
d76b71af | 351 | (run-hooks 'shell-mode-hook) |
4f99443b | 352 | (comint-read-input-ring t)) |
be9b65ac | 353 | \f |
c88ab9ce | 354 | ;;;###autoload |
be9b65ac DL |
355 | (defun shell () |
356 | "Run an inferior shell, with I/O through buffer *shell*. | |
357 | If buffer exists but shell process is not running, make new shell. | |
d76b71af | 358 | If buffer exists and shell process is running, just switch to buffer `*shell*'. |
24fdffaa | 359 | Program used comes from variable `explicit-shell-file-name', |
a9ec2adb JB |
360 | or (if that is nil) from the ESHELL environment variable, |
361 | or else from SHELL if there is no ESHELL. | |
fbc270e7 | 362 | If a file `~/.emacs_SHELLNAME' exists, it is given as initial input |
a9ec2adb JB |
363 | (Note that this may lose due to a timing error if the shell |
364 | discards input when it starts up.) | |
fbc270e7 RS |
365 | The buffer is put in Shell mode, giving commands for sending input |
366 | and controlling the subjobs of the shell. See `shell-mode'. | |
367 | See also the variable `shell-prompt-pattern'. | |
be9b65ac | 368 | |
a9ec2adb | 369 | The shell file name (sans directories) is used to make a symbol name |
62c9fad7 | 370 | such as `explicit-csh-args'. If that symbol is a variable, |
be9b65ac DL |
371 | its value is used as a list of arguments when invoking the shell. |
372 | Otherwise, one argument `-i' is passed to the shell. | |
373 | ||
374 | \(Type \\[describe-mode] in the shell buffer for a list of commands.)" | |
375 | (interactive) | |
d76b71af RS |
376 | (if (not (comint-check-proc "*shell*")) |
377 | (let* ((prog (or explicit-shell-file-name | |
378 | (getenv "ESHELL") | |
379 | (getenv "SHELL") | |
380 | "/bin/sh")) | |
381 | (name (file-name-nondirectory prog)) | |
382 | (startfile (concat "~/.emacs_" name)) | |
383 | (xargs-name (intern-soft (concat "explicit-" name "-args")))) | |
384 | (set-buffer (apply 'make-comint "shell" prog | |
385 | (if (file-exists-p startfile) startfile) | |
386 | (if (and xargs-name (boundp xargs-name)) | |
387 | (symbol-value xargs-name) | |
388 | '("-i")))) | |
389 | (shell-mode))) | |
be9b65ac | 390 | (switch-to-buffer "*shell*")) |
be9b65ac DL |
391 | \f |
392 | ;;; Directory tracking | |
393 | ;;; =========================================================================== | |
394 | ;;; This code provides the shell mode input sentinel | |
395 | ;;; SHELL-DIRECTORY-TRACKER | |
396 | ;;; that tracks cd, pushd, and popd commands issued to the shell, and | |
397 | ;;; changes the current directory of the shell buffer accordingly. | |
398 | ;;; | |
399 | ;;; This is basically a fragile hack, although it's more accurate than | |
b7fc702e | 400 | ;;; the version in Emacs 18's shell.el. It has the following failings: |
be9b65ac | 401 | ;;; 1. It doesn't know about the cdpath shell variable. |
d76b71af RS |
402 | ;;; 2. It cannot infallibly deal with command sequences, though it does well |
403 | ;;; with these and with ignoring commands forked in another shell with ()s. | |
404 | ;;; 3. More generally, any complex command is going to throw it. Otherwise, | |
405 | ;;; you'd have to build an entire shell interpreter in emacs lisp. Failing | |
406 | ;;; that, there's no way to catch shell commands where cd's are buried | |
407 | ;;; inside conditional expressions, aliases, and so forth. | |
be9b65ac DL |
408 | ;;; |
409 | ;;; The whole approach is a crock. Shell aliases mess it up. File sourcing | |
410 | ;;; messes it up. You run other processes under the shell; these each have | |
411 | ;;; separate working directories, and some have commands for manipulating | |
412 | ;;; their w.d.'s (e.g., the lcd command in ftp). Some of these programs have | |
a9ec2adb | 413 | ;;; commands that do *not* affect the current w.d. at all, but look like they |
be9b65ac DL |
414 | ;;; do (e.g., the cd command in ftp). In shells that allow you job |
415 | ;;; control, you can switch between jobs, all having different w.d.'s. So | |
416 | ;;; simply saying %3 can shift your w.d.. | |
417 | ;;; | |
418 | ;;; The solution is to relax, not stress out about it, and settle for | |
419 | ;;; a hack that works pretty well in typical circumstances. Remember | |
420 | ;;; that a half-assed solution is more in keeping with the spirit of Unix, | |
421 | ;;; anyway. Blech. | |
422 | ;;; | |
423 | ;;; One good hack not implemented here for users of programmable shells | |
424 | ;;; is to program up the shell w.d. manipulation commands to output | |
425 | ;;; a coded command sequence to the tty. Something like | |
426 | ;;; ESC | <cwd> | | |
427 | ;;; where <cwd> is the new current working directory. Then trash the | |
428 | ;;; directory tracking machinery currently used in this package, and | |
429 | ;;; replace it with a process filter that watches for and strips out | |
430 | ;;; these messages. | |
431 | ||
be9b65ac DL |
432 | (defun shell-directory-tracker (str) |
433 | "Tracks cd, pushd and popd commands issued to the shell. | |
434 | This function is called on each input passed to the shell. | |
435 | It watches for cd, pushd and popd commands and sets the buffer's | |
436 | default directory to track these commands. | |
437 | ||
438 | You may toggle this tracking on and off with M-x dirtrack-toggle. | |
439 | If emacs gets confused, you can resync with the shell with M-x dirs. | |
440 | ||
d76b71af RS |
441 | See variables `shell-cd-regexp', `shell-pushd-regexp', and `shell-popd-regexp', |
442 | while `shell-pushd-tohome', `shell-pushd-dextract' and `shell-pushd-dunique' | |
5394cb44 | 443 | control the behavior of the relevant command. |
d76b71af | 444 | |
24fdffaa | 445 | Environment variables are expanded, see function `substitute-in-file-name'." |
d76b71af RS |
446 | (if shell-dirtrackp |
447 | ;; We fail gracefully if we think the command will fail in the shell. | |
448 | (condition-case chdir-failure | |
449 | (let ((start (progn (string-match "^[;\\s ]*" str) ; skip whitespace | |
450 | (match-end 0))) | |
451 | end cmd arg1) | |
452 | (while (string-match shell-command-regexp str start) | |
453 | (setq end (match-end 0) | |
454 | cmd (comint-arguments (substring str start end) 0 0) | |
455 | arg1 (comint-arguments (substring str start end) 1 1)) | |
456 | (cond ((eq (string-match shell-popd-regexp cmd) 0) | |
457 | (shell-process-popd (substitute-in-file-name arg1))) | |
458 | ((eq (string-match shell-pushd-regexp cmd) 0) | |
459 | (shell-process-pushd (substitute-in-file-name arg1))) | |
460 | ((eq (string-match shell-cd-regexp cmd) 0) | |
461 | (shell-process-cd (substitute-in-file-name arg1)))) | |
462 | (setq start (progn (string-match "[;\\s ]*" str end) ; skip again | |
463 | (match-end 0))))) | |
ba02c167 | 464 | (error "Couldn't cd")))) |
d76b71af | 465 | |
be9b65ac DL |
466 | ;;; popd [+n] |
467 | (defun shell-process-popd (arg) | |
d76b71af RS |
468 | (let ((num (or (shell-extract-num arg) 0))) |
469 | (cond ((and num (= num 0) shell-dirstack) | |
3db9a4eb | 470 | (cd (car shell-dirstack)) |
d76b71af RS |
471 | (setq shell-dirstack (cdr shell-dirstack)) |
472 | (shell-dirstack-message)) | |
473 | ((and num (> num 0) (<= num (length shell-dirstack))) | |
474 | (let* ((ds (cons nil shell-dirstack)) | |
475 | (cell (nthcdr (1- num) ds))) | |
476 | (rplacd cell (cdr (cdr cell))) | |
477 | (setq shell-dirstack (cdr ds)) | |
478 | (shell-dirstack-message))) | |
479 | (t | |
ba02c167 | 480 | (error "Couldn't popd"))))) |
be9b65ac | 481 | |
3db9a4eb | 482 | ;; Return DIR prefixed with comint-file-name-prefix as appropriate. |
4a02b552 RS |
483 | (defun shell-prefixed-directory-name (dir) |
484 | (if (= (length comint-file-name-prefix) 0) | |
485 | dir | |
486 | (if (file-name-absolute-p dir) | |
487 | ;; The name is absolute, so prepend the prefix. | |
488 | (concat comint-file-name-prefix dir) | |
489 | ;; For a relative name we assume default-directory already has the prefix. | |
490 | (expand-file-name dir)))) | |
3db9a4eb | 491 | |
be9b65ac DL |
492 | ;;; cd [dir] |
493 | (defun shell-process-cd (arg) | |
3db9a4eb RM |
494 | (let ((new-dir (cond ((zerop (length arg)) (concat comint-file-name-prefix |
495 | "~")) | |
d76b71af | 496 | ((string-equal "-" arg) shell-last-dir) |
3db9a4eb | 497 | (t (shell-prefixed-directory-name arg))))) |
d76b71af | 498 | (setq shell-last-dir default-directory) |
3db9a4eb | 499 | (cd new-dir) |
d76b71af | 500 | (shell-dirstack-message))) |
be9b65ac DL |
501 | |
502 | ;;; pushd [+n | dir] | |
503 | (defun shell-process-pushd (arg) | |
d76b71af RS |
504 | (let ((num (shell-extract-num arg))) |
505 | (cond ((zerop (length arg)) | |
506 | ;; no arg -- swap pwd and car of stack unless shell-pushd-tohome | |
507 | (cond (shell-pushd-tohome | |
3db9a4eb | 508 | (shell-process-pushd (concat comint-file-name-prefix "~"))) |
d76b71af RS |
509 | (shell-dirstack |
510 | (let ((old default-directory)) | |
3db9a4eb | 511 | (cd (car shell-dirstack)) |
d76b71af RS |
512 | (setq shell-dirstack |
513 | (cons old (cdr shell-dirstack))) | |
514 | (shell-dirstack-message))) | |
515 | (t | |
516 | (message "Directory stack empty.")))) | |
517 | ((numberp num) | |
518 | ;; pushd +n | |
519 | (cond ((> num (length shell-dirstack)) | |
520 | (message "Directory stack not that deep.")) | |
521 | ((= num 0) | |
522 | (error (message "Couldn't cd."))) | |
523 | (shell-pushd-dextract | |
524 | (let ((dir (nth (1- num) shell-dirstack))) | |
525 | (shell-process-popd arg) | |
526 | (shell-process-pushd default-directory) | |
3db9a4eb | 527 | (cd dir) |
d76b71af RS |
528 | (shell-dirstack-message))) |
529 | (t | |
530 | (let* ((ds (cons default-directory shell-dirstack)) | |
531 | (dslen (length ds)) | |
532 | (front (nthcdr num ds)) | |
533 | (back (reverse (nthcdr (- dslen num) (reverse ds)))) | |
534 | (new-ds (append front back))) | |
3db9a4eb | 535 | (cd (car new-ds)) |
d76b71af RS |
536 | (setq shell-dirstack (cdr new-ds)) |
537 | (shell-dirstack-message))))) | |
538 | (t | |
539 | ;; pushd <dir> | |
540 | (let ((old-wd default-directory)) | |
3db9a4eb | 541 | (cd (shell-prefixed-directory-name arg)) |
d76b71af RS |
542 | (if (or (null shell-pushd-dunique) |
543 | (not (member old-wd shell-dirstack))) | |
544 | (setq shell-dirstack (cons old-wd shell-dirstack))) | |
545 | (shell-dirstack-message)))))) | |
be9b65ac DL |
546 | |
547 | ;; If STR is of the form +n, for n>0, return n. Otherwise, nil. | |
548 | (defun shell-extract-num (str) | |
549 | (and (string-match "^\\+[1-9][0-9]*$" str) | |
550 | (string-to-int str))) | |
551 | ||
552 | ||
553 | (defun shell-dirtrack-toggle () | |
554 | "Turn directory tracking on and off in a shell buffer." | |
555 | (interactive) | |
556 | (setq shell-dirtrackp (not shell-dirtrackp)) | |
d76b71af | 557 | (message "Directory tracking %s" (if shell-dirtrackp "ON" "OFF"))) |
be9b65ac DL |
558 | |
559 | ;;; For your typing convenience: | |
31e1d920 | 560 | (defalias 'dirtrack-toggle 'shell-dirtrack-toggle) |
be9b65ac DL |
561 | |
562 | ||
563 | (defun shell-resync-dirs () | |
564 | "Resync the buffer's idea of the current directory stack. | |
565 | This command queries the shell with the command bound to | |
24fdffaa | 566 | `shell-dirstack-query' (default \"dirs\"), reads the next |
be9b65ac DL |
567 | line output and parses it to form the new directory stack. |
568 | DON'T issue this command unless the buffer is at a shell prompt. | |
569 | Also, note that if some other subprocess decides to do output | |
570 | immediately after the query, its output will be taken as the | |
571 | new directory stack -- you lose. If this happens, just do the | |
572 | command again." | |
573 | (interactive) | |
574 | (let* ((proc (get-buffer-process (current-buffer))) | |
575 | (pmark (process-mark proc))) | |
576 | (goto-char pmark) | |
577 | (insert shell-dirstack-query) (insert "\n") | |
578 | (sit-for 0) ; force redisplay | |
579 | (comint-send-string proc shell-dirstack-query) | |
580 | (comint-send-string proc "\n") | |
581 | (set-marker pmark (point)) | |
582 | (let ((pt (point))) ; wait for 1 line | |
583 | ;; This extra newline prevents the user's pending input from spoofing us. | |
584 | (insert "\n") (backward-char 1) | |
585 | (while (not (looking-at ".+\n")) | |
586 | (accept-process-output proc) | |
587 | (goto-char pt))) | |
588 | (goto-char pmark) (delete-char 1) ; remove the extra newline | |
589 | ;; That's the dirlist. grab it & parse it. | |
d76b71af | 590 | (let* ((dl (buffer-substring (match-beginning 0) (1- (match-end 0)))) |
be9b65ac DL |
591 | (dl-len (length dl)) |
592 | (ds '()) ; new dir stack | |
593 | (i 0)) | |
594 | (while (< i dl-len) | |
595 | ;; regexp = optional whitespace, (non-whitespace), optional whitespace | |
596 | (string-match "\\s *\\(\\S +\\)\\s *" dl i) ; pick off next dir | |
3db9a4eb RM |
597 | (setq ds (cons (concat comint-file-name-prefix |
598 | (substring dl (match-beginning 1) | |
599 | (match-end 1))) | |
be9b65ac DL |
600 | ds)) |
601 | (setq i (match-end 0))) | |
3db9a4eb | 602 | (let ((ds (nreverse ds))) |
be9b65ac | 603 | (condition-case nil |
d76b71af | 604 | (progn (cd (car ds)) |
be9b65ac DL |
605 | (setq shell-dirstack (cdr ds)) |
606 | (shell-dirstack-message)) | |
607 | (error (message "Couldn't cd."))))))) | |
608 | ||
609 | ;;; For your typing convenience: | |
31e1d920 | 610 | (defalias 'dirs 'shell-resync-dirs) |
be9b65ac DL |
611 | |
612 | ||
613 | ;;; Show the current dirstack on the message line. | |
614 | ;;; Pretty up dirs a bit by changing "/usr/jqr/foo" to "~/foo". | |
615 | ;;; (This isn't necessary if the dirlisting is generated with a simple "dirs".) | |
616 | ;;; All the commands that mung the buffer's dirstack finish by calling | |
617 | ;;; this guy. | |
618 | (defun shell-dirstack-message () | |
94f9dcbe RM |
619 | (let* ((msg "") |
620 | (ds (cons default-directory shell-dirstack)) | |
d76b71af | 621 | (home (expand-file-name (concat comint-file-name-prefix "~/"))) |
94f9dcbe | 622 | (homelen (length home))) |
be9b65ac DL |
623 | (while ds |
624 | (let ((dir (car ds))) | |
94f9dcbe RM |
625 | (and (>= (length dir) homelen) (string= home (substring dir 0 homelen)) |
626 | (setq dir (concat "~/" (substring dir homelen)))) | |
d76b71af RS |
627 | ;; Strip off comint-file-name-prefix if present. |
628 | (and comint-file-name-prefix | |
629 | (>= (length dir) (length comint-file-name-prefix)) | |
630 | (string= comint-file-name-prefix | |
631 | (substring dir 0 (length comint-file-name-prefix))) | |
632 | (setq dir (substring dir (length comint-file-name-prefix))) | |
94f9dcbe | 633 | (setcar ds dir)) |
d76b71af | 634 | (setq msg (concat msg (directory-file-name dir) " ")) |
be9b65ac DL |
635 | (setq ds (cdr ds)))) |
636 | (message msg))) | |
a9ec2adb | 637 | \f |
d76b71af RS |
638 | (defun shell-forward-command (&optional arg) |
639 | "Move forward across ARG shell command(s). Does not cross lines. | |
640 | See `shell-command-regexp'." | |
641 | (interactive "p") | |
642 | (let ((limit (save-excursion (end-of-line nil) (point)))) | |
19134c18 | 643 | (if (re-search-forward (concat shell-command-regexp "\\([;&|][\t ]*\\)+") |
d76b71af | 644 | limit 'move arg) |
b0f86743 | 645 | (skip-syntax-backward " ")))) |
d76b71af RS |
646 | |
647 | ||
648 | (defun shell-backward-command (&optional arg) | |
649 | "Move backward across ARG shell command(s). Does not cross lines. | |
650 | See `shell-command-regexp'." | |
651 | (interactive "p") | |
652 | (let ((limit (save-excursion (comint-bol nil) (point)))) | |
b0f86743 RS |
653 | (if (> limit (point)) |
654 | (save-excursion (beginning-of-line) (setq limit (point)))) | |
655 | (skip-syntax-backward " " limit) | |
d76b71af | 656 | (if (re-search-backward |
19134c18 | 657 | (format "[;&|]+[\t ]*\\(%s\\)" shell-command-regexp) limit 'move arg) |
d76b71af | 658 | (progn (goto-char (match-beginning 1)) |
b0f86743 | 659 | (skip-chars-forward ";&|"))))) |
d76b71af RS |
660 | |
661 | ||
d76b71af RS |
662 | (defun shell-dynamic-complete-command () |
663 | "Dynamically complete the command at point. | |
664 | This function is similar to `comint-dynamic-complete-filename', except that it | |
665 | searches `exec-path' (minus the trailing emacs library path) for completion | |
666 | candidates. Note that this may not be the same as the shell's idea of the | |
667 | path. | |
668 | ||
669 | Completion is dependent on the value of `shell-completion-execonly', plus | |
988a4d60 RS |
670 | those that effect file completion. See `shell-dynamic-complete-as-command'. |
671 | ||
672 | Returns t if successful." | |
d76b71af | 673 | (interactive) |
988a4d60 RS |
674 | (let ((filename (comint-match-partial-filename))) |
675 | (if (and filename | |
676 | (save-match-data (not (string-match "[~/]" filename))) | |
677 | (eq (match-beginning 0) | |
678 | (save-excursion (shell-backward-command 1) (point)))) | |
679 | (prog2 (message "Completing command name...") | |
680 | (shell-dynamic-complete-as-command))))) | |
681 | ||
682 | ||
683 | (defun shell-dynamic-complete-as-command () | |
684 | "Dynamically complete at point as a command. | |
685 | See `shell-dynamic-complete-filename'. Returns t if successful." | |
56783585 | 686 | (let* ((filename (or (comint-match-partial-filename) "")) |
d76b71af RS |
687 | (pathnondir (file-name-nondirectory filename)) |
688 | (paths (cdr (reverse exec-path))) | |
689 | (cwd (file-name-as-directory (expand-file-name default-directory))) | |
690 | (ignored-extensions | |
a867a90a RS |
691 | (and comint-completion-fignore |
692 | (mapconcat (function (lambda (x) (concat (regexp-quote x) "$"))) | |
693 | comint-completion-fignore "\\|"))) | |
d76b71af RS |
694 | (path "") (comps-in-path ()) (file "") (filepath "") (completions ())) |
695 | ;; Go thru each path in the search path, finding completions. | |
696 | (while paths | |
697 | (setq path (file-name-as-directory (comint-directory (or (car paths) "."))) | |
698 | comps-in-path (and (file-accessible-directory-p path) | |
699 | (file-name-all-completions pathnondir path))) | |
700 | ;; Go thru each completion found, to see whether it should be used. | |
701 | (while comps-in-path | |
702 | (setq file (car comps-in-path) | |
703 | filepath (concat path file)) | |
704 | (if (and (not (member file completions)) | |
7b2db0a0 KH |
705 | (not (and ignored-extensions |
706 | (string-match ignored-extensions file))) | |
d76b71af RS |
707 | (or (string-equal path cwd) |
708 | (not (file-directory-p filepath))) | |
709 | (or (null shell-completion-execonly) | |
710 | (file-executable-p filepath))) | |
711 | (setq completions (cons file completions))) | |
712 | (setq comps-in-path (cdr comps-in-path))) | |
713 | (setq paths (cdr paths))) | |
714 | ;; OK, we've got a list of completions. | |
56783585 RS |
715 | (let ((success (let ((comint-completion-addsuffix nil)) |
716 | (comint-dynamic-simple-complete pathnondir completions)))) | |
717 | (if (and (memq success '(sole shortest)) comint-completion-addsuffix | |
718 | (not (file-directory-p (comint-match-partial-filename)))) | |
719 | (insert " ")) | |
720 | success))) | |
988a4d60 RS |
721 | |
722 | ||
723 | (defun shell-match-partial-variable () | |
724 | "Return the variable at point, or nil if non is found." | |
725 | (save-excursion | |
726 | (let ((limit (point))) | |
727 | (if (re-search-backward "[^A-Za-z0-9_{}]" nil 'move) | |
728 | (or (looking-at "\\$") (forward-char 1))) | |
729 | ;; Anchor the search forwards. | |
730 | (if (or (eolp) (looking-at "[^A-Za-z0-9_{}$]")) | |
731 | nil | |
732 | (re-search-forward "\\$?{?[A-Za-z0-9_]*}?" limit) | |
733 | (buffer-substring (match-beginning 0) (match-end 0)))))) | |
a9ec2adb | 734 | |
988a4d60 RS |
735 | |
736 | (defun shell-dynamic-complete-environment-variable () | |
737 | "Dynamically complete the environment variable at point. | |
738 | Completes if after a variable, i.e., if it starts with a \"$\". | |
739 | See `shell-dynamic-complete-as-environment-variable'. | |
740 | ||
741 | This function is similar to `comint-dynamic-complete-filename', except that it | |
742 | searches `process-environment' for completion candidates. Note that this may | |
743 | not be the same as the interpreter's idea of variable names. The main problem | |
744 | with this type of completion is that `process-environment' is the environment | |
745 | which Emacs started with. Emacs does not track changes to the environment made | |
746 | by the interpreter. Perhaps it would be more accurate if this function was | |
747 | called `shell-dynamic-complete-process-environment-variable'. | |
748 | ||
749 | Returns non-nil if successful." | |
750 | (interactive) | |
751 | (let ((variable (shell-match-partial-variable))) | |
752 | (if (and variable (string-match "^\\$" variable)) | |
753 | (prog2 (message "Completing variable name...") | |
754 | (shell-dynamic-complete-as-environment-variable))))) | |
755 | ||
756 | ||
757 | (defun shell-dynamic-complete-as-environment-variable () | |
758 | "Dynamically complete at point as an environment variable. | |
759 | Used by `shell-dynamic-complete-environment-variable'. | |
760 | Uses `comint-dynamic-simple-complete'." | |
761 | (let* ((var (or (shell-match-partial-variable) "")) | |
762 | (variable (substring var (or (string-match "[^$({]\\|$" var) 0))) | |
763 | (variables (mapcar (function (lambda (x) | |
764 | (substring x 0 (string-match "=" x)))) | |
765 | process-environment)) | |
766 | (addsuffix comint-completion-addsuffix) | |
767 | (comint-completion-addsuffix nil) | |
768 | (success (comint-dynamic-simple-complete variable variables))) | |
769 | (if (memq success '(sole shortest)) | |
770 | (let* ((var (shell-match-partial-variable)) | |
771 | (variable (substring var (string-match "[^$({]" var))) | |
772 | (protection (cond ((string-match "{" var) "}") | |
773 | ((string-match "(" var) ")") | |
774 | (t ""))) | |
775 | (suffix (cond ((null addsuffix) "") | |
776 | ((file-directory-p | |
777 | (comint-directory (getenv variable))) "/") | |
778 | (t " ")))) | |
779 | (insert protection suffix))) | |
780 | success)) | |
781 | ||
782 | ||
783 | (defun shell-replace-by-expanded-directory () | |
784 | "Expand directory stack reference before point. | |
785 | Directory stack references are of the form \"=digit\" or \"=-\". | |
786 | See `default-directory' and `shell-dirstack'. | |
787 | ||
788 | Returns t if successful." | |
789 | (interactive) | |
790 | (if (comint-match-partial-filename) | |
791 | (save-excursion | |
988a4d60 RS |
792 | (goto-char (match-beginning 0)) |
793 | (let ((stack (cons default-directory shell-dirstack)) | |
794 | (index (cond ((looking-at "=-/?") | |
795 | (length shell-dirstack)) | |
796 | ((looking-at "=\\([0-9]+\\)") | |
797 | (string-to-number | |
798 | (buffer-substring | |
799 | (match-beginning 1) (match-end 1))))))) | |
800 | (cond ((null index) | |
801 | nil) | |
802 | ((>= index (length stack)) | |
803 | (error "Directory stack not that deep.")) | |
804 | (t | |
805 | (replace-match (file-name-as-directory (nth index stack)) t t) | |
806 | (message "Directory item: %d" index) | |
807 | t)))))) | |
808 | \f | |
56783585 RS |
809 | (defun shell-strip-ctrl-m (&optional string) |
810 | "Strip trailing `^M' characters from the current output group. | |
811 | ||
812 | This function could be in the list `comint-output-filter-functions' or bound to | |
813 | a key." | |
814 | (interactive) | |
bb55b64d | 815 | (let ((pmark (process-mark (get-buffer-process (current-buffer))))) |
56783585 RS |
816 | (save-excursion |
817 | (goto-char | |
818 | (if (interactive-p) comint-last-input-end comint-last-output-start)) | |
bb55b64d | 819 | (while (re-search-forward "\r+$" pmark t) |
56783585 RS |
820 | (replace-match "" t t))))) |
821 | \f | |
c88ab9ce ER |
822 | (provide 'shell) |
823 | ||
824 | ;;; shell.el ends here |