| blob | c561bab42e996a3d20dd346c2e1f591b699f7514 |
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 ;;; Customization and Buffer Variables
106 ;;; ===========================================================================
107 ;;;
109 ;;; Code:
113 ;;;###autoload
115 "Regexp to match prompts in the inferior shell.
117 This variable is used to initialise `comint-prompt-regexp' in the
118 shell buffer.
120 The pattern should probably not match more than one line. If it does,
121 shell-mode may become confused trying to distinguish prompt from input
122 on lines which don't start with a prompt.
127 "*List of suffixes to be disregarded during file/command completion.
128 This variable is used to initialize `comint-completion-fignore' in the shell
129 buffer. The default is nil, for compatibility with most shells.
135 "List of characters to recognise as separate arguments.
136 This variable is used to initialize `comint-delimiter-argument-list' in the
143 shell-dynamic-complete-environment-variable
144 shell-dynamic-complete-command
145 shell-replace-by-expanded-directory
146 comint-dynamic-complete-filename)
147 "List of functions called to perform completion.
148 This variable is used to initialise `comint-dynamic-complete-functions' in the
149 shell buffer.
154 "*Regexp to match a single command within a pipeline.
158 "*If non-nil, use executable files only for completion candidates.
159 This mirrors the optional behavior of tcsh.
178 "*If non-nil, make pushd only add unique directories to the stack.
189 ;; -T persuades HP's csh not to think it is smarter
190 ;; than us about what terminal modes to use.
193 "*Args passed to inferior shell by M-x shell, if the shell is csh.
197 "*If non-nil, expand input command history references on completion.
198 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
200 If the value is `input', then the expansion is seen on input.
201 If the value is `history', then the expansion is only when inserting
202 into the buffer's input ring. See also `comint-magic-space' and
203 `comint-dynamic-complete'.
205 This variable supplies a default for `comint-input-autoexpand',
209 "List of directories saved by pushd in this buffer's shell.
233 shell-dynamic-complete-environment-variable)
237 shell-replace-by-expanded-directory)
249 \f
250 ;;; Basic Procedures
251 ;;; ===========================================================================
252 ;;;
255 "Major mode for interacting with an inferior shell.
256 Return after the end of the process' output sends the text from the
257 end of process to the end of the current line.
258 Return before end of process output copies the current line (except
259 for the prompt) to the end of the buffer and sends it.
260 M-x send-invisible reads a line of text without echoing it, and sends it to
261 the shell. This is useful for entering passwords. Or, add the function
262 `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
265 to continue it.
267 cd, pushd and popd commands given to the shell are watched by Emacs to keep
268 this buffer's default directory the same as the shell's working directory.
269 M-x dirs queries the shell and resyncs Emacs' idea of what the current
270 directory stack is.
271 M-x dirtrack-toggle turns directory tracking on and off.
274 Customization: Entry to this mode runs the hooks on `comint-mode-hook' and
275 `shell-mode-hook' (in that order). Before each input, the hooks on
276 `comint-input-filter-functions' are run. After each shell output, the hooks
277 on `comint-output-filter-functions' are run.
279 Variables `shell-cd-regexp', `shell-pushd-regexp' and `shell-popd-regexp'
280 are used to match their respective commands, while `shell-pushd-tohome',
281 `shell-pushd-dextract' and `shell-pushd-dunique' control the behavior of the
282 relevant command.
284 Variables `comint-completion-autolist', `comint-completion-addsuffix',
285 `comint-completion-recexact' and `comint-completion-fignore' control the
286 behavior of file name, command name and variable name completion. Variable
287 `shell-completion-execonly' controls the behavior of command name completion.
288 Variable `shell-completion-fignore' is used to initialise the value of
289 `comint-completion-fignore'.
291 Variables `comint-input-ring-file-name' and `comint-input-autoexpand' control
292 the initialisation of the input ring history, and history expansion.
294 Variables `comint-output-filter-functions', a hook, and
295 `comint-scroll-to-bottom-on-input' and `comint-scroll-to-bottom-on-output'
296 control whether input and output cause the window to scroll to the end of the
297 buffer."
318 ;; shell-dependent assignments.
332 \f
333 ;;;###autoload
335 "Run an inferior shell, with I/O through buffer *shell*.
336 If buffer exists but shell process is not running, make new shell.
337 If buffer exists and shell process is running, just switch to buffer `*shell*'.
338 Program used comes from variable `explicit-shell-file-name',
339 or (if that is nil) from the ESHELL environment variable,
340 or else from SHELL if there is no ESHELL.
341 If a file `~/.emacs_SHELLNAME' exists, it is given as initial input
342 (Note that this may lose due to a timing error if the shell
343 discards input when it starts up.)
344 The buffer is put in Shell mode, giving commands for sending input
345 and controlling the subjobs of the shell. See `shell-mode'.
346 See also the variable `shell-prompt-pattern'.
348 The shell file name (sans directories) is used to make a symbol name
349 such as `explicit-csh-args'. If that symbol is a variable,
350 its value is used as a list of arguments when invoking the shell.
351 Otherwise, one argument `-i' is passed to the shell.
370 \f
371 ;;; Directory tracking
372 ;;; ===========================================================================
373 ;;; This code provides the shell mode input sentinel
374 ;;; SHELL-DIRECTORY-TRACKER
375 ;;; that tracks cd, pushd, and popd commands issued to the shell, and
376 ;;; changes the current directory of the shell buffer accordingly.
377 ;;;
378 ;;; This is basically a fragile hack, although it's more accurate than
379 ;;; the version in Emacs 18's shell.el. It has the following failings:
380 ;;; 1. It doesn't know about the cdpath shell variable.
381 ;;; 2. It cannot infallibly deal with command sequences, though it does well
382 ;;; with these and with ignoring commands forked in another shell with ()s.
383 ;;; 3. More generally, any complex command is going to throw it. Otherwise,
384 ;;; you'd have to build an entire shell interpreter in emacs lisp. Failing
385 ;;; that, there's no way to catch shell commands where cd's are buried
386 ;;; inside conditional expressions, aliases, and so forth.
387 ;;;
388 ;;; The whole approach is a crock. Shell aliases mess it up. File sourcing
389 ;;; messes it up. You run other processes under the shell; these each have
390 ;;; separate working directories, and some have commands for manipulating
391 ;;; their w.d.'s (e.g., the lcd command in ftp). Some of these programs have
392 ;;; commands that do *not* affect the current w.d. at all, but look like they
393 ;;; do (e.g., the cd command in ftp). In shells that allow you job
394 ;;; control, you can switch between jobs, all having different w.d.'s. So
395 ;;; simply saying %3 can shift your w.d..
396 ;;;
397 ;;; The solution is to relax, not stress out about it, and settle for
398 ;;; a hack that works pretty well in typical circumstances. Remember
399 ;;; that a half-assed solution is more in keeping with the spirit of Unix,
400 ;;; anyway. Blech.
401 ;;;
402 ;;; One good hack not implemented here for users of programmable shells
403 ;;; is to program up the shell w.d. manipulation commands to output
404 ;;; a coded command sequence to the tty. Something like
405 ;;; ESC | <cwd> |
406 ;;; where <cwd> is the new current working directory. Then trash the
407 ;;; directory tracking machinery currently used in this package, and
408 ;;; replace it with a process filter that watches for and strips out
409 ;;; these messages.
412 "Tracks cd, pushd and popd commands issued to the shell.
413 This function is called on each input passed to the shell.
414 It watches for cd, pushd and popd commands and sets the buffer's
415 default directory to track these commands.
417 You may toggle this tracking on and off with M-x dirtrack-toggle.
418 If emacs gets confused, you can resync with the shell with M-x dirs.
420 See variables `shell-cd-regexp', `shell-pushd-regexp', and `shell-popd-regexp',
421 while `shell-pushd-tohome', `shell-pushd-dextract' and `shell-pushd-dunique'
422 control the behavior of the relevant command.
424 Environment variables are expanded, see function `substitute-in-file-name'."
426 ;; We fail gracefully if we think the command will fail in the shell.
430 end cmd arg1)
445 ;;; popd [+n]
461 ;; Return DIR prefixed with comint-file-name-prefix as appropriate.
464 dir
466 ;; The name is absolute, so prepend the prefix.
468 ;; For a relative name we assume default-directory already has the prefix.
471 ;;; cd [dir]
481 ;;; pushd [+n | dir]
485 ;; no arg -- swap pwd and car of stack unless shell-pushd-tohome
497 ;; pushd +n
518 ;; pushd <dir>
526 ;; If STR is of the form +n, for n>0, return n. Otherwise, nil.
533 "Turn directory tracking on and off in a shell buffer."
538 ;;; For your typing convenience:
543 "Resync the buffer's idea of the current directory stack.
544 This command queries the shell with the command bound to
546 line output and parses it to form the new directory stack.
547 DON'T issue this command unless the buffer is at a shell prompt.
548 Also, note that if some other subprocess decides to do output
549 immediately after the query, its output will be taken as the
550 new directory stack -- you lose. If this happens, just do the
551 command again."
562 ;; This extra newline prevents the user's pending input from spoofing us.
568 ;; That's the dirlist. grab it & parse it.
574 ;; regexp = optional whitespace, (non-whitespace), optional whitespace
579 ds))
588 ;;; For your typing convenience:
592 ;;; Show the current dirstack on the message line.
593 ;;; Pretty up dirs a bit by changing "/usr/jqr/foo" to "~/foo".
594 ;;; (This isn't necessary if the dirlisting is generated with a simple "dirs".)
595 ;;; All the commands that mung the buffer's dirstack finish by calling
596 ;;; this guy.
606 ;; Strip off comint-file-name-prefix if present.
616 \f
618 "Move forward across ARG shell command(s). Does not cross lines.
619 See `shell-command-regexp'."
628 "Move backward across ARG shell command(s). Does not cross lines.
629 See `shell-command-regexp'."
642 "Dynamically complete the command at point.
643 This function is similar to `comint-dynamic-complete-filename', except that it
644 searches `exec-path' (minus the trailing emacs library path) for completion
645 candidates. Note that this may not be the same as the shell's idea of the
646 path.
648 Completion is dependent on the value of `shell-completion-execonly', plus
649 those that effect file completion. See `shell-dynamic-complete-as-command'.
651 Returns t if successful."
663 "Dynamically complete at point as a command.
664 See `shell-dynamic-complete-filename'. Returns t if successful."
674 ;; Go thru each path in the search path, finding completions.
679 ;; Go thru each completion found, to see whether it should be used.
693 ;; OK, we've got a list of completions.
699 success)))
703 "Return the variable at point, or nil if non is found."
708 ;; Anchor the search forwards.
710 nil
716 "Dynamically complete the environment variable at point.
718 See `shell-dynamic-complete-as-environment-variable'.
720 This function is similar to `comint-dynamic-complete-filename', except that it
721 searches `process-environment' for completion candidates. Note that this may
722 not be the same as the interpreter's idea of variable names. The main problem
723 with this type of completion is that `process-environment' is the environment
724 which Emacs started with. Emacs does not track changes to the environment made
725 by the interpreter. Perhaps it would be more accurate if this function was
726 called `shell-dynamic-complete-process-environment-variable'.
728 Returns non-nil if successful."
737 "Dynamically complete at point as an environment variable.
738 Used by `shell-dynamic-complete-environment-variable'.
739 Uses `comint-dynamic-simple-complete'."
744 process-environment))
759 success))
763 "Expand directory stack reference before point.
765 See `default-directory' and `shell-dirstack'.
767 Returns t if successful."
780 nil)
786 t))))))
787 \f
790 ;;; shell.el ends here