-;; -*-Emacs-Lisp-*- run a shell in an Emacs window
-;; Copyright (C) 1985, 1986, 1987, 1990 Free Software Foundation, Inc.
-
-;; This file is part of GNU Emacs.
+;;; shell.el --- specialized comint.el for running the shell.
+;;; Copyright (C) 1988, 1993 Free Software Foundation, Inc.
-;; GNU Emacs is free software; you can redistribute it and/or modify
-;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 1, or (at your option)
-;; any later version.
+;; Author: Olin Shivers <shivers@cs.cmu.edu>
+;; Keywords: processes
-;; GNU Emacs is distributed in the hope that it will be useful,
-;; but WITHOUT ANY WARRANTY; without even the implied warranty of
-;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-;; GNU General Public License for more details.
+;;; This file is part of GNU Emacs.
-;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;;; GNU Emacs is free software; you can redistribute it and/or modify
+;;; it under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 2, or (at your option)
+;;; any later version.
-;;; Hacked from tea.el and shell.el by Olin Shivers (shivers@cs.cmu.edu). 8/88
+;;; GNU Emacs is distributed in the hope that it will be useful,
+;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;;; GNU General Public License for more details.
+
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNU Emacs; see the file COPYING. If not, write to
+;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+
+;;; Commentary:
+
+;;; The changelog is at the end of file.
+
+;;; Please send me bug reports, bug fixes, and extensions, so that I can
+;;; merge them into the master source.
+;;; - Olin Shivers (shivers@cs.cmu.edu)
+
+;;; This file defines a a shell-in-a-buffer package (shell mode) built
+;;; on top of comint mode. This is actually cmushell with things
+;;; renamed to replace its counterpart in Emacs 18. cmushell is more
+;;; featureful, robust, and uniform than the Emacs 18 version.
;;; Since this mode is built on top of the general command-interpreter-in-
;;; a-buffer mode (comint mode), it shares a common base functionality,
;;; and a common set of bindings, with all modes derived from comint mode.
+;;; This makes these modes easier to use.
;;; For documentation on the functionality provided by comint mode, and
;;; the hooks available for customising it, see the file comint.el.
+;;; For further information on shell mode, see the comments below.
;;; Needs fixin:
;;; When sending text from a source file to a subprocess, the process-mark can
;;; Maybe I should ensure the process mark is in the window when I send
;;; text to the process? Switch selectable?
+;; YOUR .EMACS FILE
+;;=============================================================================
+;; Some suggestions for your .emacs file.
+;;
+;; ; If shell lives in some non-standard directory, you must tell emacs
+;; ; where to get it. This may or may not be necessary.
+;; (setq load-path (cons (expand-file-name "~jones/lib/emacs") load-path))
+;;
+;; ; Autoload shell from file shell.el
+;; (autoload 'shell "shell"
+;; "Run an inferior shell process."
+;; t)
+;;
+;; ; Define C-c t to run my favorite command in shell mode:
+;; (setq shell-load-hook
+;; '((lambda ()
+;; (define-key shell-mode-map "\C-ct" 'favorite-cmd))))
+
+\f
+;;; Brief Command Documentation:
+;;;============================================================================
+;;; Comint Mode Commands: (common to shell and all comint-derived modes)
+;;;
+;;; m-p comint-previous-input Cycle backwards in input history
+;;; m-n comint-next-input Cycle forwards
+;;; m-c-r comint-previous-input-matching Search backwards in input history
+;;; return comint-send-input
+;;; c-a comint-bol Beginning of line; skip prompt.
+;;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff.
+;;; c-c c-u comint-kill-input ^u
+;;; c-c c-w backward-kill-word ^w
+;;; c-c c-c comint-interrupt-subjob ^c
+;;; c-c c-z comint-stop-subjob ^z
+;;; c-c c-\ comint-quit-subjob ^\
+;;; c-c c-o comint-kill-output Delete last batch of process output
+;;; c-c c-r comint-show-output Show last batch of process output
+;;; send-invisible Read line w/o echo & send to proc
+;;; comint-continue-subjob Useful if you accidentally suspend
+;;; top-level job.
+;;; comint-mode-hook is the comint mode hook.
+
+;;; Shell Mode Commands:
+;;; shell Fires up the shell process.
+;;; tab comint-dynamic-complete Complete a partial file name
+;;; m-? comint-dynamic-list-completions List completions in help buffer
+;;; dirs Resync the buffer's dir stack.
+;;; dirtrack-toggle Turn dir tracking on/off.
+;;;
+;;; The shell mode hook is shell-mode-hook
+;;; The shell-load-hook is run after this file is loaded.
+;;; comint-prompt-regexp is initialised to shell-prompt-pattern, for backwards
+;;; compatibility.
+
+;;; Read the rest of this file for more information.
+\f
+;;; SHELL.EL COMPATIBILITY
+;;; Notes from when this was called cmushell, and was not the standard emacs
+;;; shell package.
+;;;============================================================================
+;;; In brief: this package should have no trouble coexisting with shell.el.
+;;;
+;;; Most customising variables -- e.g., explicit-shell-file-name -- are the
+;;; same, so the users shouldn't have much trouble. Hooks have different
+;;; names, however, so you can customise shell mode differently from cmushell
+;;; mode. You basically just have to remember to type M-x cmushell instead of
+;;; M-x shell.
+;;;
+;;; It would be nice if this file was completely plug-compatible with the old
+;;; shell package -- if you could just name this file shell.el, and have it
+;;; transparently replace the old one. But you can't. Several other packages
+;;; (tex-mode, background, dbx, gdb, kermit, monkey, prolog, telnet) are also
+;;; clients of shell mode. These packages assume detailed knowledge of shell
+;;; mode internals in ways that are incompatible with cmushell mode (mostly
+;;; because of cmushell mode's greater functionality). So, unless we are
+;;; willing to port all of these packages, we can't have this file be a
+;;; complete replacement for shell.el -- that is, we can't name this file
+;;; shell.el, and its main entry point (shell), because dbx.el will break
+;;; when it loads it in and tries to use it.
+;;;
+;;; There are two ways to fix this. One: rewrite these other modes to use the
+;;; new package. This is a win, but can't be assumed. The other, backwards
+;;; compatible route, is to make this package non-conflict with shell.el, so
+;;; both files can be loaded in at the same time. And *that* is why some
+;;; functions and variables have different names: (cmushell),
+;;; cmushell-mode-map, that sort of thing. All the names have been carefully
+;;; chosen so that shell.el and cmushell.el won't tromp on each other.
+\f
+;;; Customization and Buffer Variables
+;;; ===========================================================================
+;;;
+
+;;; Code:
+
(require 'comint)
-(provide 'shell)
+
+;;;###autoload
+(defvar shell-prompt-pattern "^[^#$%>]*[#$%>] *"
+ "Regexp to match prompts in the inferior shell.
+Defaults to \"^[^#$%>]*[#$%>] *\", which works pretty well.
+This variable is used to initialise `comint-prompt-regexp' in the
+shell buffer.
+
+This is a fine thing to set in your `.emacs' file.")
(defvar shell-popd-regexp "popd"
"*Regexp to match subshell commands equivalent to popd.")
"*Args passed to inferior shell by M-x shell, if the shell is csh.
Value is a list of strings, which may be nil.")
+;;; All the above vars aren't prefixed "cmushell-" to make them
+;;; backwards compatible w/shell.el and old .emacs files.
+
(defvar shell-dirstack nil
- "List of directories saved by pushd in this buffer's shell.")
+ "List of directories saved by pushd in this buffer's shell.
+Thus, this does not include the shell's current directory.")
+
+(defvar shell-last-dir nil
+ "Keep track of last directory for ksh `cd -' command.")
(defvar shell-dirstack-query "dirs"
- "Command used by shell-resync-dirlist to query shell.")
+ "Command used by `shell-resync-dir' to query the shell.")
-(defvar shell-mode-map ())
+(defvar shell-mode-map '())
(cond ((not shell-mode-map)
- (setq shell-mode-map (copy-keymap comint-mode-map))
+ (setq shell-mode-map (full-copy-sparse-keymap comint-mode-map))
(define-key shell-mode-map "\t" 'comint-dynamic-complete)
(define-key shell-mode-map "\M-?" 'comint-dynamic-list-completions)))
(defvar shell-mode-hook '()
- "*Hook for customising shell mode")
+ "*Hook for customising Shell mode.")
\f
;;; Basic Procedures
"Major mode for interacting with an inferior shell.
Return after the end of the process' output sends the text from the
end of process to the end of the current line.
-Return before end of process output copies rest of line to end (skipping
- the prompt) and sends it.
+Return before end of process output copies the current line (except
+ for the prompt) to the end of the buffer and sends it.
M-x send-invisible reads a line of text without echoing it, and sends it to
- the shell.
+ the shell. This is useful for entering passwords.
If you accidentally suspend your process, use \\[comint-continue-subjob]
to continue it.
M-x dirtrack-toggle turns directory tracking on and off.
\\{shell-mode-map}
-Customisation: Entry to this mode runs the hooks on comint-mode-hook and
-shell-mode-hook (in that order).
+Customization: Entry to this mode runs the hooks on `comint-mode-hook' and
+`shell-mode-hook' (in that order).
-Variables shell-cd-regexp, shell-pushd-regexp and shell-popd-regexp are used
-to match their respective commands."
+Variables `shell-cd-regexp', `shell-pushd-regexp' and `shell-popd-regexp'
+are used to match their respective commands."
(interactive)
(comint-mode)
- (setq major-mode 'shell-mode
- mode-name "Shell"
- comint-prompt-regexp shell-prompt-pattern
- comint-input-sentinel 'shell-directory-tracker)
+ (setq comint-prompt-regexp shell-prompt-pattern)
+ (setq major-mode 'shell-mode)
+ (setq mode-name "Shell")
(use-local-map shell-mode-map)
(make-local-variable 'shell-dirstack)
- (set (make-local-variable 'shell-dirtrackp) t)
+ (setq shell-dirstack nil)
+ (setq shell-last-dir nil)
+ (make-local-variable 'shell-dirtrackp)
+ (setq shell-dirtrackp t)
+ (setq comint-input-sentinel 'shell-directory-tracker)
(run-hooks 'shell-mode-hook))
\f
+;;;###autoload
(defun shell ()
"Run an inferior shell, with I/O through buffer *shell*.
If buffer exists but shell process is not running, make new shell.
-If buffer exists and shell process is running, just switch to buffer *shell*.
-
-The shell to use comes from the first non-nil variable found from these:
-explicit-shell-file-name in Emacs, ESHELL in the environment or SHELL in the
-environment. If none is found, /bin/sh is used.
-
-If a file ~/.emacs_SHELLNAME exists, it is given as initial input, simulating
-a start-up file for the shell like .profile or .cshrc. Note that this may
-lose due to a timing error if the shell discards input when it starts up.
-
-The buffer is put in shell-mode, giving commands for sending input
-and controlling the subjobs of the shell.
-
-The shell file name, sans directories, is used to make a symbol name
-such as `explicit-csh-arguments'. If that symbol is a variable,
+If buffer exists and shell process is running,
+ just switch to buffer `*shell*'.
+Program used comes from variable `explicit-shell-file-name',
+ or (if that is nil) from the ESHELL environment variable,
+ or else from SHELL if there is no ESHELL.
+If a file `~/.emacs_SHELLNAME' exists, it is given as initial input
+ (Note that this may lose due to a timing error if the shell
+ discards input when it starts up.)
+The buffer is put in Shell mode, giving commands for sending input
+and controlling the subjobs of the shell. See `shell-mode'.
+See also the variable `shell-prompt-pattern'.
+
+The shell file name (sans directories) is used to make a symbol name
+such as `explicit-csh-args'. If that symbol is a variable,
its value is used as a list of arguments when invoking the shell.
Otherwise, one argument `-i' is passed to the shell.
(let* ((prog (or explicit-shell-file-name
(getenv "ESHELL")
(getenv "SHELL")
- "/bin/sh"))
+ "/bin/sh"))
(name (file-name-nondirectory prog))
(startfile (concat "~/.emacs_" name))
(xargs-name (intern-soft (concat "explicit-" name "-args"))))
;;; changes the current directory of the shell buffer accordingly.
;;;
;;; This is basically a fragile hack, although it's more accurate than
-;;; the original version in shell.el. It has the following failings:
+;;; the version in Emacs 18's shell.el. It has the following failings:
;;; 1. It doesn't know about the cdpath shell variable.
;;; 2. It only spots the first command in a command sequence. E.g., it will
;;; miss the cd in "ls; cd foo"
;;; messes it up. You run other processes under the shell; these each have
;;; separate working directories, and some have commands for manipulating
;;; their w.d.'s (e.g., the lcd command in ftp). Some of these programs have
-;;; commands that do *not* effect the current w.d. at all, but look like they
+;;; commands that do *not* affect the current w.d. at all, but look like they
;;; do (e.g., the cd command in ftp). In shells that allow you job
;;; control, you can switch between jobs, all having different w.d.'s. So
;;; simply saying %3 can shift your w.d..
You may toggle this tracking on and off with M-x dirtrack-toggle.
If emacs gets confused, you can resync with the shell with M-x dirs.
-See variables shell-cd-regexp, shell-pushd-regexp, and shell-popd-regexp.
-Environment variables are expanded, see function substitute-in-file-name."
+See variables `shell-cd-regexp', `shell-pushd-regexp', and `shell-popd-regexp'.
+Environment variables are expanded, see function `substitute-in-file-name'."
(condition-case err
(cond (shell-dirtrackp
(string-match "^\\s *" str) ; skip whitespace
;;; cd [dir]
(defun shell-process-cd (arg)
- (condition-case nil (progn (cd (if (zerop (length arg)) (getenv "HOME")
- arg))
- (shell-dirstack-message))
- (error (message "Couldn't cd."))))
-
+ (condition-case nil
+ (let ((new-dir (cond
+ ((zerop (length arg)) (getenv "HOME"))
+ ((string-equal "-" arg) shell-last-dir)
+ (t arg))))
+ (setq shell-last-dir default-directory)
+ (cd new-dir)
+ (shell-dirstack-message))
+ (error (message "Couldn't cd."))))
;;; pushd [+n | dir]
(defun shell-process-pushd (arg)
(if shell-dirtrackp "ON" "OFF")))
;;; For your typing convenience:
-(fset 'dirtrack-toggle 'shell-dirtrack-toggle)
+(defalias 'dirtrack-toggle 'shell-dirtrack-toggle)
(defun shell-resync-dirs ()
"Resync the buffer's idea of the current directory stack.
This command queries the shell with the command bound to
-shell-dirstack-query (default \"dirs\"), reads the next
+`shell-dirstack-query' (default \"dirs\"), reads the next
line output and parses it to form the new directory stack.
DON'T issue this command unless the buffer is at a shell prompt.
Also, note that if some other subprocess decides to do output
(error (message "Couldn't cd.")))))))
;;; For your typing convenience:
-(fset 'dirs 'shell-resync-dirs)
+(defalias 'dirs 'shell-resync-dirs)
;;; Show the current dirstack on the message line.
(setq msg (concat msg dir " "))
(setq ds (cdr ds))))
(message msg)))
+
+
+\f
+;;; Interfacing to client packages (and converting them)
+;;; Notes from when this was called cmushell, and was not the standard emacs
+;;; shell package. Many of the conversions discussed here have been done.
+;;;============================================================================
+;;; Several gnu packages (tex-mode, background, dbx, gdb, kermit, prolog,
+;;; telnet are some) use the shell package as clients. Most of them would
+;;; be better off using the comint package directly, but they predate it.
+;;; The catch is that most of these packages (dbx, gdb, prolog, telnet)
+;;; assume total knowledge of all the local variables that shell mode
+;;; functions depend on. So they (kill-all-local-variables), then create
+;;; the few local variables that shell.el functions depend on. Alas,
+;;; cmushell.el functions depend on a different set of vars (for example,
+;;; the input history ring is a local variable in cmushell.el's shell mode,
+;;; whereas there is no input history ring in shell.el's shell mode).
+;;; So we have a situation where the greater functionality of cmushell.el
+;;; is biting us -- you can't just replace shell will cmushell.
+;;;
+;;; Altering these packages to use comint mode directly should *greatly*
+;;; improve their functionality, and is actually pretty easy. It's
+;;; mostly a matter of renaming a few variable names. See comint.el for more.
+;;; -Olin
+
+
+
+;;; Do the user's customization...
+;;;===============================
+(defvar shell-load-hook nil
+ "This hook is run when shell is loaded in.
+This is a good place to put keybindings.")
+
+(run-hooks 'shell-load-hook)
+
+(provide 'shell)
+
+;;; shell.el ends here