| blob | abf901f870ccfb112f03ceb6897dc04c4ca96e93 |
1 ;;; shell.el --- specialized comint.el for running the shell.
3 ;; Copyright (C) 1988, 1993, 1994 Free Software Foundation, Inc.
5 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
6 ;; Maintainer: Simon Marshall <s.marshall@dcs.hull.ac.uk>
7 ;; Keywords: processes
9 ;; This file is part of GNU Emacs.
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.
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.
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.
25 ;;; Commentary:
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)
30 ;;; - Simon Marshall (s.marshall@dcs.hull.ac.uk)
32 ;;; This file defines a a shell-in-a-buffer package (shell mode) built
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.
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.
40 ;;; This makes these modes easier to use.
42 ;;; For documentation on the functionality provided by comint mode, and
43 ;;; the hooks available for customising it, see the file comint.el.
44 ;;; For further information on shell mode, see the comments below.
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?
52 ;; YOUR .EMACS FILE
53 ;;=============================================================================
54 ;; Some suggestions for your .emacs file.
55 ;;
56 ;; ;; Define C-c t to run my favorite command in shell mode:
57 ;; (setq shell-mode-hook
58 ;; '((lambda ()
59 ;; (define-key shell-mode-map "\C-ct" 'favorite-cmd))))
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
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
72 ;;; m-c-l comint-show-output Show last batch of process output
73 ;;; return comint-send-input
74 ;;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff.
75 ;;; c-c c-a comint-bol Beginning of line; skip prompt
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
83 ;;; c-c c-h comint-dynamic-list-input-ring List input history
84 ;;; send-invisible Read line w/o echo & send to proc
85 ;;; comint-continue-subjob Useful if you accidentally suspend
86 ;;; top-level job
87 ;;; comint-mode-hook is the comint mode hook.
89 ;;; Shell Mode Commands:
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
97 ;;; shell-strip-ctrl-m Remove trailing ^Ms from output
98 ;;;
99 ;;; The shell mode hook is shell-mode-hook
100 ;;; comint-prompt-regexp is initialised to shell-prompt-pattern, for backwards
101 ;;; compatibility.
103 ;;; Read the rest of this file for more information.
104 \f
105 ;;; SHELL.EL COMPATIBILITY
106 ;;; Notes from when this was called cmushell, and was not the standard emacs
107 ;;; shell package.
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
113 ;;; names, however, so you can customise shell mode differently from cmushell
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
137 ;;; Customization and Buffer Variables
138 ;;; ===========================================================================
139 ;;;
141 ;;; Code:
145 ;;;###autoload
147 "Regexp to match prompts in the inferior shell.
149 This variable is used to initialise `comint-prompt-regexp' in the
150 shell buffer.
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.
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.
167 "List of characters to recognise as separate arguments.
168 This variable is used to initialize `comint-delimiter-argument-list' in the
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.
186 "*Regexp to match a single command within a pipeline.
190 "*If non-nil, use executable files only for completion candidates.
191 This mirrors the optional behavior of tcsh.
210 "*If non-nil, make pushd only add unique directories to the stack.
221 ;; -T persuades HP's csh not to think it is smarter
222 ;; than us about what terminal modes to use.
225 "*Args passed to inferior shell by M-x shell, if the shell is csh.
229 "*If non-nil, expand input command history references on completion.
230 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
232 If the value is `input', then the expansion is seen on input.
233 If the value is `history', then the expansion is only when inserting
234 into the buffer's input ring. See also `comint-magic-space' and
235 `comint-dynamic-complete'.
237 This variable supplies a default for `comint-input-autoexpand',
241 "List of directories saved by pushd in this buffer's shell.
265 shell-dynamic-complete-environment-variable)
269 shell-replace-by-expanded-directory)
281 \f
282 ;;; Basic Procedures
283 ;;; ===========================================================================
284 ;;;
287 "Major mode for interacting with an inferior shell.
288 Return after the end of the process' output sends the text from the
289 end of process to the end of the current line.
290 Return before end of process output copies the current line (except
291 for the prompt) to the end of the buffer and sends it.
292 M-x send-invisible reads a line of text without echoing it, and sends it to
293 the shell. This is useful for entering passwords. Or, add the function
294 `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
297 to continue it.
299 cd, pushd and popd commands given to the shell are watched by Emacs to keep
300 this buffer's default directory the same as the shell's working directory.
301 M-x dirs queries the shell and resyncs Emacs' idea of what the current
302 directory stack is.
303 M-x dirtrack-toggle turns directory tracking on and off.
306 Customization: Entry to this mode runs the hooks on `comint-mode-hook' and
307 `shell-mode-hook' (in that order). Before each input, the hooks on
308 `comint-input-filter-functions' are run. After each shell output, the hooks
309 on `comint-output-filter-functions' are run.
311 Variables `shell-cd-regexp', `shell-pushd-regexp' and `shell-popd-regexp'
312 are used to match their respective commands, while `shell-pushd-tohome',
313 `shell-pushd-dextract' and `shell-pushd-dunique' control the behavior of the
314 relevant command.
316 Variables `comint-completion-autolist', `comint-completion-addsuffix',
317 `comint-completion-recexact' and `comint-completion-fignore' control the
318 behavior of file name, command name and variable name completion. Variable
319 `shell-completion-execonly' controls the behavior of command name completion.
320 Variable `shell-completion-fignore' is used to initialise the value of
321 `comint-completion-fignore'.
323 Variables `comint-input-ring-file-name' and `comint-input-autoexpand' control
324 the initialisation of the input ring history, and history expansion.
326 Variables `comint-output-filter-functions', a hook, and
327 `comint-scroll-to-bottom-on-input' and `comint-scroll-to-bottom-on-output'
328 control whether input and output cause the window to scroll to the end of the
329 buffer."
350 ;; shell-dependent assignments.
364 \f
365 ;;;###autoload
367 "Run an inferior shell, with I/O through buffer *shell*.
368 If buffer exists but shell process is not running, make new shell.
369 If buffer exists and shell process is running, just switch to buffer `*shell*'.
370 Program used comes from variable `explicit-shell-file-name',
371 or (if that is nil) from the ESHELL environment variable,
372 or else from SHELL if there is no ESHELL.
373 If a file `~/.emacs_SHELLNAME' exists, it is given as initial input
374 (Note that this may lose due to a timing error if the shell
375 discards input when it starts up.)
376 The buffer is put in Shell mode, giving commands for sending input
377 and controlling the subjobs of the shell. See `shell-mode'.
378 See also the variable `shell-prompt-pattern'.
380 The shell file name (sans directories) is used to make a symbol name
381 such as `explicit-csh-args'. If that symbol is a variable,
382 its value is used as a list of arguments when invoking the shell.
383 Otherwise, one argument `-i' is passed to the shell.
402 \f
403 ;;; Directory tracking
404 ;;; ===========================================================================
405 ;;; This code provides the shell mode input sentinel
406 ;;; SHELL-DIRECTORY-TRACKER
407 ;;; that tracks cd, pushd, and popd commands issued to the shell, and
408 ;;; changes the current directory of the shell buffer accordingly.
409 ;;;
410 ;;; This is basically a fragile hack, although it's more accurate than
411 ;;; the version in Emacs 18's shell.el. It has the following failings:
412 ;;; 1. It doesn't know about the cdpath shell variable.
413 ;;; 2. It cannot infallibly deal with command sequences, though it does well
414 ;;; with these and with ignoring commands forked in another shell with ()s.
415 ;;; 3. More generally, any complex command is going to throw it. Otherwise,
416 ;;; you'd have to build an entire shell interpreter in emacs lisp. Failing
417 ;;; that, there's no way to catch shell commands where cd's are buried
418 ;;; inside conditional expressions, aliases, and so forth.
419 ;;;
420 ;;; The whole approach is a crock. Shell aliases mess it up. File sourcing
421 ;;; messes it up. You run other processes under the shell; these each have
422 ;;; separate working directories, and some have commands for manipulating
423 ;;; their w.d.'s (e.g., the lcd command in ftp). Some of these programs have
424 ;;; commands that do *not* affect the current w.d. at all, but look like they
425 ;;; do (e.g., the cd command in ftp). In shells that allow you job
426 ;;; control, you can switch between jobs, all having different w.d.'s. So
427 ;;; simply saying %3 can shift your w.d..
428 ;;;
429 ;;; The solution is to relax, not stress out about it, and settle for
430 ;;; a hack that works pretty well in typical circumstances. Remember
431 ;;; that a half-assed solution is more in keeping with the spirit of Unix,
432 ;;; anyway. Blech.
433 ;;;
434 ;;; One good hack not implemented here for users of programmable shells
435 ;;; is to program up the shell w.d. manipulation commands to output
436 ;;; a coded command sequence to the tty. Something like
437 ;;; ESC | <cwd> |
438 ;;; where <cwd> is the new current working directory. Then trash the
439 ;;; directory tracking machinery currently used in this package, and
440 ;;; replace it with a process filter that watches for and strips out
441 ;;; these messages.
444 "Tracks cd, pushd and popd commands issued to the shell.
445 This function is called on each input passed to the shell.
446 It watches for cd, pushd and popd commands and sets the buffer's
447 default directory to track these commands.
449 You may toggle this tracking on and off with M-x dirtrack-toggle.
450 If emacs gets confused, you can resync with the shell with M-x dirs.
452 See variables `shell-cd-regexp', `shell-pushd-regexp', and `shell-popd-regexp',
453 while `shell-pushd-tohome', `shell-pushd-dextract' and `shell-pushd-dunique'
454 control the behavior of the relevant command.
456 Environment variables are expanded, see function `substitute-in-file-name'."
458 ;; We fail gracefully if we think the command will fail in the shell.
462 end cmd arg1)
477 ;;; popd [+n]
493 ;; Return DIR prefixed with comint-file-name-prefix as appropriate.
496 dir
498 ;; The name is absolute, so prepend the prefix.
500 ;; For a relative name we assume default-directory already has the prefix.
503 ;;; cd [dir]
513 ;;; pushd [+n | dir]
517 ;; no arg -- swap pwd and car of stack unless shell-pushd-tohome
529 ;; pushd +n
550 ;; pushd <dir>
558 ;; If STR is of the form +n, for n>0, return n. Otherwise, nil.
565 "Turn directory tracking on and off in a shell buffer."
570 ;;; For your typing convenience:
575 "Resync the buffer's idea of the current directory stack.
576 This command queries the shell with the command bound to
578 line output and parses it to form the new directory stack.
579 DON'T issue this command unless the buffer is at a shell prompt.
580 Also, note that if some other subprocess decides to do output
581 immediately after the query, its output will be taken as the
582 new directory stack -- you lose. If this happens, just do the
583 command again."
594 ;; This extra newline prevents the user's pending input from spoofing us.
600 ;; That's the dirlist. grab it & parse it.
606 ;; regexp = optional whitespace, (non-whitespace), optional whitespace
611 ds))
620 ;;; For your typing convenience:
624 ;;; Show the current dirstack on the message line.
625 ;;; Pretty up dirs a bit by changing "/usr/jqr/foo" to "~/foo".
626 ;;; (This isn't necessary if the dirlisting is generated with a simple "dirs".)
627 ;;; All the commands that mung the buffer's dirstack finish by calling
628 ;;; this guy.
638 ;; Strip off comint-file-name-prefix if present.
648 \f
650 "Move forward across ARG shell command(s). Does not cross lines.
651 See `shell-command-regexp'."
660 "Move backward across ARG shell command(s). Does not cross lines.
661 See `shell-command-regexp'."
674 "Dynamically complete the command at point.
675 This function is similar to `comint-dynamic-complete-filename', except that it
676 searches `exec-path' (minus the trailing emacs library path) for completion
677 candidates. Note that this may not be the same as the shell's idea of the
678 path.
680 Completion is dependent on the value of `shell-completion-execonly', plus
681 those that effect file completion. See `shell-dynamic-complete-as-command'.
683 Returns t if successful."
695 "Dynamically complete at point as a command.
696 See `shell-dynamic-complete-filename'. Returns t if successful."
706 ;; Go thru each path in the search path, finding completions.
711 ;; Go thru each completion found, to see whether it should be used.
725 ;; OK, we've got a list of completions.
731 success)))
735 "Return the variable at point, or nil if non is found."
740 ;; Anchor the search forwards.
742 nil
748 "Dynamically complete the environment variable at point.
750 See `shell-dynamic-complete-as-environment-variable'.
752 This function is similar to `comint-dynamic-complete-filename', except that it
753 searches `process-environment' for completion candidates. Note that this may
754 not be the same as the interpreter's idea of variable names. The main problem
755 with this type of completion is that `process-environment' is the environment
756 which Emacs started with. Emacs does not track changes to the environment made
757 by the interpreter. Perhaps it would be more accurate if this function was
758 called `shell-dynamic-complete-process-environment-variable'.
760 Returns non-nil if successful."
769 "Dynamically complete at point as an environment variable.
770 Used by `shell-dynamic-complete-environment-variable'.
771 Uses `comint-dynamic-simple-complete'."
776 process-environment))
791 success))
795 "Expand directory stack reference before point.
797 See `default-directory' and `shell-dirstack'.
799 Returns t if successful."
812 nil)
818 t))))))
819 \f
822 ;;; shell.el ends here