| blob | a8277da845db97b2c590bec6ec8e848d2d75f6ac |
1 ;;; shell.el --- general command interpreter in a window stuff
3 ;;; Copyright Olin Shivers (1988).
5 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
6 ;; Keywords: processes
8 ;;; This file is part of GNU Emacs.
10 ;;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;;; it under the terms of the GNU General Public License as published by
12 ;;; the Free Software Foundation; either version 2, or (at your option)
13 ;;; any later version.
15 ;;; GNU Emacs is distributed in the hope that it will be useful,
16 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;;; GNU General Public License for more details.
20 ;;; You should have received a copy of the GNU General Public License
21 ;;; along with GNU Emacs; see the file COPYING. If not, write to
22 ;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24 ;;; Commentary:
26 ;;; The changelog is at the end of file.
28 ;;; Please send me bug reports, bug fixes, and extensions, so that I can
29 ;;; merge them into the master source.
30 ;;; - Olin Shivers (shivers@cs.cmu.edu)
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 ;; ; If cmushell lives in some non-standard directory, you must tell emacs
57 ;; ; where to get it. This may or may not be necessary.
58 ;; (setq load-path (cons (expand-file-name "~jones/lib/emacs") load-path))
59 ;;
60 ;; ; Autoload cmushell from file cmushell.el
61 ;; (autoload 'cmushell "cmushell"
62 ;; "Run an inferior shell process."
63 ;; t)
64 ;;
65 ;; ; Define C-c t to run my favorite command in cmushell mode:
66 ;; (setq cmushell-load-hook
67 ;; '((lambda ()
68 ;; (define-key cmushell-mode-map "\C-ct" 'favorite-cmd))))
70 \f
71 ;;; Brief Command Documentation:
72 ;;;============================================================================
73 ;;; Comint Mode Commands: (common to shell and all comint-derived modes)
74 ;;;
75 ;;; m-p comint-previous-input Cycle backwards in input history
76 ;;; m-n comint-next-input Cycle forwards
77 ;;; m-c-r comint-previous-input-matching Search backwards in input history
78 ;;; return comint-send-input
79 ;;; c-a comint-bol Beginning of line; skip prompt.
80 ;;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff.
81 ;;; c-c c-u comint-kill-input ^u
82 ;;; c-c c-w backward-kill-word ^w
83 ;;; c-c c-c comint-interrupt-subjob ^c
84 ;;; c-c c-z comint-stop-subjob ^z
85 ;;; c-c c-\ comint-quit-subjob ^\
86 ;;; c-c c-o comint-kill-output Delete last batch of process output
87 ;;; c-c c-r comint-show-output Show last batch of process output
88 ;;; send-invisible Read line w/o echo & send to proc
89 ;;; comint-continue-subjob Useful if you accidentally suspend
90 ;;; top-level job.
91 ;;; comint-mode-hook is the comint mode hook.
93 ;;; Shell Mode Commands:
94 ;;; shell Fires up the shell process.
95 ;;; tab comint-dynamic-complete Complete a partial file name
96 ;;; m-? comint-dynamic-list-completions List completions in help buffer
97 ;;; dirs Resync the buffer's dir stack.
98 ;;; dirtrack-toggle Turn dir tracking on/off.
99 ;;;
100 ;;; The shell mode hook is shell-mode-hook
101 ;;; The shell-load-hook is run after this file is loaded.
102 ;;; comint-prompt-regexp is initialised to shell-prompt-pattern, for backwards
103 ;;; compatibility.
105 ;;; Read the rest of this file for more information.
106 \f
107 ;;; SHELL.EL COMPATIBILITY
108 ;;; Notes from when this was called cmushell, and was not the standard emacs
109 ;;; shell package.
110 ;;;============================================================================
111 ;;; In brief: this package should have no trouble coexisting with shell.el.
112 ;;;
113 ;;; Most customising variables -- e.g., explicit-shell-file-name -- are the
114 ;;; same, so the users shouldn't have much trouble. Hooks have different
115 ;;; names, however, so you can customise shell mode differently from cmushell
116 ;;; mode. You basically just have to remember to type M-x cmushell instead of
117 ;;; M-x shell.
118 ;;;
119 ;;; It would be nice if this file was completely plug-compatible with the old
120 ;;; shell package -- if you could just name this file shell.el, and have it
121 ;;; transparently replace the old one. But you can't. Several other packages
122 ;;; (tex-mode, background, dbx, gdb, kermit, monkey, prolog, telnet) are also
123 ;;; clients of shell mode. These packages assume detailed knowledge of shell
124 ;;; mode internals in ways that are incompatible with cmushell mode (mostly
125 ;;; because of cmushell mode's greater functionality). So, unless we are
126 ;;; willing to port all of these packages, we can't have this file be a
127 ;;; complete replacement for shell.el -- that is, we can't name this file
128 ;;; shell.el, and its main entry point (shell), because dbx.el will break
129 ;;; when it loads it in and tries to use it.
130 ;;;
131 ;;; There are two ways to fix this. One: rewrite these other modes to use the
132 ;;; new package. This is a win, but can't be assumed. The other, backwards
133 ;;; compatible route, is to make this package non-conflict with shell.el, so
134 ;;; both files can be loaded in at the same time. And *that* is why some
135 ;;; functions and variables have different names: (cmushell),
136 ;;; cmushell-mode-map, that sort of thing. All the names have been carefully
137 ;;; chosen so that shell.el and cmushell.el won't tromp on each other.
138 \f
139 ;;; Customisation and Buffer Variables
140 ;;; ===========================================================================
141 ;;;
143 ;;; Code:
147 ;;;###autoload
149 "Regexp to match prompts in the inferior shell.
151 This variable is used to initialise comint-prompt-regexp in the
152 shell buffer.
170 ;; -T persuades HP's csh not to think it is smarter
171 ;; than us about what terminal modes to use.
174 "*Args passed to inferior shell by M-x shell, if the shell is csh.
177 ;;; All the above vars aren't prefixed "cmushell-" to make them
178 ;;; backwards compatible w/shell.el and old .emacs files.
181 "List of directories saved by pushd in this buffer's shell.
196 \f
197 ;;; Basic Procedures
198 ;;; ===========================================================================
199 ;;;
202 "Major mode for interacting with an inferior shell.
203 Return after the end of the process' output sends the text from the
204 end of process to the end of the current line.
205 Return before end of process output copies the current line (except
206 for the prompt) to the end of the buffer and sends it.
207 M-x send-invisible reads a line of text without echoing it, and sends it to
208 the shell. This is useful for entering passwords.
211 to continue it.
213 cd, pushd and popd commands given to the shell are watched by Emacs to keep
214 this buffer's default directory the same as the shell's working directory.
215 M-x dirs queries the shell and resyncs Emacs' idea of what the current
216 directory stack is.
217 M-x dirtrack-toggle turns directory tracking on and off.
220 Customisation: Entry to this mode runs the hooks on comint-mode-hook and
221 shell-mode-hook (in that order).
223 Variables shell-cd-regexp, shell-pushd-regexp and shell-popd-regexp are used
224 to match their respective commands."
238 \f
239 ;;;###autoload
241 "Run an inferior shell, with I/O through buffer *shell*.
242 If buffer exists but shell process is not running, make new shell.
243 If buffer exists and shell process is running,
244 just switch to buffer *shell*.
245 Program used comes from variable explicit-shell-file-name,
246 or (if that is nil) from the ESHELL environment variable,
247 or else from SHELL if there is no ESHELL.
248 If a file ~/.emacs_SHELLNAME exists, it is given as initial input
249 (Note that this may lose due to a timing error if the shell
250 discards input when it starts up.)
251 The buffer is put in shell-mode, giving commands for sending input
252 and controlling the subjobs of the shell. See shell-mode.
253 See also variable shell-prompt-pattern.
255 The shell file name (sans directories) is used to make a symbol name
256 such as `explicit-csh-arguments'. If that symbol is a variable,
257 its value is used as a list of arguments when invoking the shell.
258 Otherwise, one argument `-i' is passed to the shell.
278 \f
279 ;;; Directory tracking
280 ;;; ===========================================================================
281 ;;; This code provides the shell mode input sentinel
282 ;;; SHELL-DIRECTORY-TRACKER
283 ;;; that tracks cd, pushd, and popd commands issued to the shell, and
284 ;;; changes the current directory of the shell buffer accordingly.
285 ;;;
286 ;;; This is basically a fragile hack, although it's more accurate than
287 ;;; the released version in shell.el. It has the following failings:
288 ;;; 1. It doesn't know about the cdpath shell variable.
289 ;;; 2. It only spots the first command in a command sequence. E.g., it will
290 ;;; miss the cd in "ls; cd foo"
291 ;;; 3. More generally, any complex command (like ";" sequencing) is going to
292 ;;; throw it. Otherwise, you'd have to build an entire shell interpreter in
293 ;;; emacs lisp. Failing that, there's no way to catch shell commands where
294 ;;; cd's are buried inside conditional expressions, aliases, and so forth.
295 ;;;
296 ;;; The whole approach is a crock. Shell aliases mess it up. File sourcing
297 ;;; messes it up. You run other processes under the shell; these each have
298 ;;; separate working directories, and some have commands for manipulating
299 ;;; their w.d.'s (e.g., the lcd command in ftp). Some of these programs have
300 ;;; commands that do *not* affect the current w.d. at all, but look like they
301 ;;; do (e.g., the cd command in ftp). In shells that allow you job
302 ;;; control, you can switch between jobs, all having different w.d.'s. So
303 ;;; simply saying %3 can shift your w.d..
304 ;;;
305 ;;; The solution is to relax, not stress out about it, and settle for
306 ;;; a hack that works pretty well in typical circumstances. Remember
307 ;;; that a half-assed solution is more in keeping with the spirit of Unix,
308 ;;; anyway. Blech.
309 ;;;
310 ;;; One good hack not implemented here for users of programmable shells
311 ;;; is to program up the shell w.d. manipulation commands to output
312 ;;; a coded command sequence to the tty. Something like
313 ;;; ESC | <cwd> |
314 ;;; where <cwd> is the new current working directory. Then trash the
315 ;;; directory tracking machinery currently used in this package, and
316 ;;; replace it with a process filter that watches for and strips out
317 ;;; these messages.
319 ;;; REGEXP is a regular expression. STR is a string. START is a fixnum.
320 ;;; Returns T if REGEXP matches STR where the match is anchored to start
321 ;;; at position START in STR. Sort of like LOOKING-AT for strings.
326 "Tracks cd, pushd and popd commands issued to the shell.
327 This function is called on each input passed to the shell.
328 It watches for cd, pushd and popd commands and sets the buffer's
329 default directory to track these commands.
331 You may toggle this tracking on and off with M-x dirtrack-toggle.
332 If emacs gets confused, you can resync with the shell with M-x dirs.
334 See variables shell-cd-regexp, shell-pushd-regexp, and shell-popd-regexp.
335 Environment variables are expanded, see function substitute-in-file-name."
342 str bos))
345 str bos))
348 str bos))
353 ;;; Try to match regexp CMD to string, anchored at position START.
354 ;;; CMD may be followed by a single argument. If a match, then return
355 ;;; the argument, if there is one, or the empty string if not. If
356 ;;; no match, return nil.
364 str eoc)
367 ;;; The first regexp is [optional whitespace, (";" or the end of string)].
368 ;;; The second regexp is [whitespace, (an arg), optional whitespace,
369 ;;; (";" or end of string)].
372 ;;; popd [+n]
391 ;;; cd [dir]
394 arg))
399 ;;; pushd [+n | dir]
402 ;; no arg -- swap pwd and car of shell stack
427 ;; pushd <dir>
436 ;; If STR is of the form +n, for n>0, return n. Otherwise, nil.
443 "Turn directory tracking on and off in a shell buffer."
449 ;;; For your typing convenience:
454 "Resync the buffer's idea of the current directory stack.
455 This command queries the shell with the command bound to
457 line output and parses it to form the new directory stack.
458 DON'T issue this command unless the buffer is at a shell prompt.
459 Also, note that if some other subprocess decides to do output
460 immediately after the query, its output will be taken as the
461 new directory stack -- you lose. If this happens, just do the
462 command again."
473 ;; This extra newline prevents the user's pending input from spoofing us.
479 ;; That's the dirlist. grab it & parse it.
485 ;; regexp = optional whitespace, (non-whitespace), optional whitespace
488 ds))
497 ;;; For your typing convenience:
501 ;;; Show the current dirstack on the message line.
502 ;;; Pretty up dirs a bit by changing "/usr/jqr/foo" to "~/foo".
503 ;;; (This isn't necessary if the dirlisting is generated with a simple "dirs".)
504 ;;; All the commands that mung the buffer's dirstack finish by calling
505 ;;; this guy.
519 \f
520 ;;; Interfacing to client packages (and converting them)
521 ;;; Notes from when this was called cmushell, and was not the standard emacs
522 ;;; shell package. Many of the conversions discussed here have been done.
523 ;;;============================================================================
524 ;;; Several gnu packages (tex-mode, background, dbx, gdb, kermit, prolog,
525 ;;; telnet are some) use the shell package as clients. Most of them would
526 ;;; be better off using the comint package directly, but they predate it.
527 ;;; The catch is that most of these packages (dbx, gdb, prolog, telnet)
528 ;;; assume total knowledge of all the local variables that shell mode
529 ;;; functions depend on. So they (kill-all-local-variables), then create
530 ;;; the few local variables that shell.el functions depend on. Alas,
531 ;;; cmushell.el functions depend on a different set of vars (for example,
532 ;;; the input history ring is a local variable in cmushell.el's shell mode,
533 ;;; whereas there is no input history ring in shell.el's shell mode).
534 ;;; So we have a situation where the greater functionality of cmushell.el
535 ;;; is biting us -- you can't just replace shell will cmushell.
536 ;;;
537 ;;; Altering these packages to use comint mode directly should *greatly*
538 ;;; improve their functionality, and is actually pretty easy. It's
539 ;;; mostly a matter of renaming a few variable names. See comint.el for more.
540 ;;; -Olin
544 ;;; Do the user's customisation...
545 ;;;===============================
547 "This hook is run when shell is loaded in.
552 ;;; Change Log
553 ;;; ===========================================================================
554 ;;; Olin 8/88
555 ;;; Created.
556 ;;;
557 ;;; Olin 5/26/90
558 ;;; - Split cmulisp and cmushell modes into separate files.
559 ;;; Not only is this a good idea, it's apparently the way it'll be rel 19.
560 ;;; - Souped up the directory tracking; it now can handle pushd, pushd +n,
561 ;;; and popd +n.
562 ;;; - Added cmushell-dirtrack-toggle command to toggle the directory
563 ;;; tracking that cmushell tries to do. This is useful, for example,
564 ;;; when you are running ftp -- it prevents the ftp "cd" command from
565 ;;; spoofing the tracking machinery. This command is also named
566 ;;; dirtrack-toggle, so you need only type M-x dirtrack to run it.
567 ;;; - Added cmushell-resync-dirs command. This queries the shell
568 ;;; for the current directory stack, and resets the buffer's stack
569 ;;; accordingly. This command is also named dirs, so you need only type
570 ;;; M-x dirs to run it.
571 ;;; - Bits of the new directory tracking code were adapted from source
572 ;;; contributed by Vince Broman, Jeff Peck, and Barry Warsaw.
573 ;;; - See also the improvements made to comint.el at the same time.
574 ;;; - Renamed several variables. Mostly this comprised changing "shell"
575 ;;; to "cmushell" in the names. The only variables that are not prefixed
576 ;;; with "cmushell-" are the ones that are common with shell.el:
577 ;;; explicit-shell-file-name shell-prompt-pattern explicit-csh-args
578 ;;; and shell-cd/popd/pushd-regexp
579 ;;; The variables and functions that were changed to have "cmushell-"
580 ;;; prefixes are:
581 ;;; shell-directory-stack (v), shell-directory-tracker (f)
582 ;;; This should not affect users, only Emacs Lisp hackers. Hopefully
583 ;;; one day shell.el will just go away, and we can drop all this
584 ;;; "cmushell" bullshit.
585 ;;; - Upgraded process sends to use comint-send-string instead of
586 ;;; process-send-string.
587 ;;;
588 ;;; Olin 6/14/90
589 ;;; - If your shell is named <shellname>, and a variable named
590 ;;; explicit-<shellname>-args exists, cmushell is supposed
591 ;;; to use its value as the arglist to the shell invocation.
592 ;;; E.g., if you define explicit-csh-args to be
593 ;;; ("-ifx"), then when cmushell cranks up a csh, it execs it
594 ;;; as "csh -ifx". This is what is documented. What has actually
595 ;;; been the case is that the variable checked is
596 ;;; explicit-<shellname>-arguments, not explicit-<shellname>-args.
597 ;;; The documentation has been changed to conform to the code (for
598 ;;; backwards compatibility with shell.el). This bug is inherited from
599 ;;; the same bug in shell.el.
600 ;;; This bug reported by Stephen Anderson.
601 ;;;
602 ;;; Olin 9/5/90
603 ;;; - Arguments to cd, popd, and pushd now have their env vars expanded
604 ;;; out by the tracking machinery. So if you say "cd $SRCDIR/funs", the
605 ;;; $SRCDIR var will be replaced by its value *in emacs' process
606 ;;; environment*. If this is different from the shell's binding of the
607 ;;; variable, you lose. Several users needed this feature, fragile
608 ;;; though it may be. The fix was contributed by sk@thp.Uni-Koeln.DE.
609 ;;;
610 ;;; Olin 3/12/91
611 ;;; - Moved comint-dynamic-complete (filename completion) from M-tab to tab.
612 ;;;
613 ;;; Jim Blandy 10/30/91
614 ;;; - Removed the "cmu" prefix from names, renamed file to shell.el,
615 ;;; to become the standard shell package.
619 ;;; shell.el ends here