code.delx.au - gnu-emacs/blob - lisp/shell.el

   1 ;;; shell.el --- specialized comint.el for running the shell.
   2 ;;; Copyright (C) 1988, 1993 Free Software Foundation, Inc.
   3
   4 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
   5 ;; Keywords: processes
   6
   7 ;;; This file is part of GNU Emacs.
   8
   9 ;;; GNU Emacs is free software; you can redistribute it and/or modify
  10 ;;; it under the terms of the GNU General Public License as published by
  11 ;;; the Free Software Foundation; either version 2, or (at your option)
  12 ;;; any later version.
  13
  14 ;;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;;; GNU General Public License for more details.
  18
  19 ;;; You should have received a copy of the GNU General Public License
  20 ;;; along with GNU Emacs; see the file COPYING.  If not, write to
  21 ;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  22
  23 ;;; Commentary:
  24
  25 ;;; The changelog is at the end of file.
  26
  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
  31 ;;; This file defines a a shell-in-a-buffer package (shell mode) built
  32 ;;; on top of comint mode.  This is actually cmushell with things
  33 ;;; renamed to replace its counterpart in Emacs 18.  cmushell is more
  34 ;;; featureful, robust, and uniform than the Emacs 18 version.
  35
  36 ;;; Since this mode is built on top of the general command-interpreter-in-
  37 ;;; a-buffer mode (comint mode), it shares a common base functionality,
  38 ;;; and a common set of bindings, with all modes derived from comint mode.
  39 ;;; This makes these modes easier to use.
  40
  41 ;;; For documentation on the functionality provided by comint mode, and
  42 ;;; the hooks available for customising it, see the file comint.el.
  43 ;;; For further information on shell mode, see the comments below.
  44
  45 ;;; Needs fixin:
  46 ;;; When sending text from a source file to a subprocess, the process-mark can
  47 ;;; move off the window, so you can lose sight of the process interactions.
  48 ;;; Maybe I should ensure the process mark is in the window when I send
  49 ;;; text to the process? Switch selectable?
  50
  51 ;; YOUR .EMACS FILE
  52 ;;=============================================================================
  53 ;; Some suggestions for your .emacs file.
  54 ;;
  55 ;; ; If shell lives in some non-standard directory, you must tell emacs
  56 ;; ; where to get it. This may or may not be necessary.
  57 ;; (setq load-path (cons (expand-file-name "~jones/lib/emacs") load-path))
  58 ;;
  59 ;; ; Autoload shell from file shell.el
  60 ;; (autoload 'shell "shell"
  61 ;;           "Run an inferior shell process."
  62 ;;           t)
  63 ;;
  64 ;; ; Define C-c t to run my favorite command in shell mode:
  65 ;; (setq shell-load-hook
  66 ;;       '((lambda ()
  67 ;;           (define-key shell-mode-map "\C-ct" 'favorite-cmd))))
  68
  69 \f
  70 ;;; Brief Command Documentation:
  71 ;;;============================================================================
  72 ;;; Comint Mode Commands: (common to shell and all comint-derived modes)
  73 ;;;
  74 ;;; m-p     comint-previous-input           Cycle backwards in input history
  75 ;;; m-n     comint-next-input               Cycle forwards
  76 ;;; m-c-r   comint-previous-input-matching  Search backwards in input history
  77 ;;; return  comint-send-input
  78 ;;; c-a     comint-bol                      Beginning of line; skip prompt.
  79 ;;; c-d     comint-delchar-or-maybe-eof     Delete char unless at end of buff.
  80 ;;; c-c c-u comint-kill-input               ^u
  81 ;;; c-c c-w backward-kill-word              ^w
  82 ;;; c-c c-c comint-interrupt-subjob         ^c
  83 ;;; c-c c-z comint-stop-subjob              ^z
  84 ;;; c-c c-\ comint-quit-subjob              ^\
  85 ;;; c-c c-o comint-kill-output              Delete last batch of process output
  86 ;;; c-c c-r comint-show-output              Show last batch of process output
  87 ;;;         send-invisible                  Read line w/o echo & send to proc
  88 ;;;         comint-continue-subjob          Useful if you accidentally suspend
  89 ;;;                                             top-level job.
  90 ;;; comint-mode-hook is the comint mode hook.
  91
  92 ;;; Shell Mode Commands:
  93 ;;;         shell                           Fires up the shell process.
  94 ;;; tab     comint-dynamic-complete         Complete a partial file name
  95 ;;; m-?     comint-dynamic-list-completions List completions in help buffer
  96 ;;;         dirs                            Resync the buffer's dir stack.
  97 ;;;         dirtrack-toggle                 Turn dir tracking on/off.
  98 ;;;
  99 ;;; The shell mode hook is shell-mode-hook
 100 ;;; The shell-load-hook is run after this file is loaded.
 101 ;;; comint-prompt-regexp is initialised to shell-prompt-pattern, for backwards
 102 ;;; compatibility.
 103
 104 ;;; Read the rest of this file for more information.
 105 \f
 106 ;;; SHELL.EL COMPATIBILITY
 107 ;;; Notes from when this was called cmushell, and was not the standard emacs
 108 ;;; shell package.
 109 ;;;============================================================================
 110 ;;; In brief: this package should have no trouble coexisting with shell.el.
 111 ;;;
 112 ;;; Most customising variables -- e.g., explicit-shell-file-name -- are the
 113 ;;; same, so the users shouldn't have much trouble. Hooks have different
 114 ;;; names, however, so you can customise shell mode differently from cmushell
 115 ;;; mode. You basically just have to remember to type M-x cmushell instead of
 116 ;;; M-x shell.
 117 ;;;
 118 ;;; It would be nice if this file was completely plug-compatible with the old
 119 ;;; shell package -- if you could just name this file shell.el, and have it
 120 ;;; transparently replace the old one. But you can't.  Several other packages
 121 ;;; (tex-mode, background, dbx, gdb, kermit, monkey, prolog, telnet) are also
 122 ;;; clients of shell mode. These packages assume detailed knowledge of shell
 123 ;;; mode internals in ways that are incompatible with cmushell mode (mostly
 124 ;;; because of cmushell mode's greater functionality).  So, unless we are
 125 ;;; willing to port all of these packages, we can't have this file be a
 126 ;;; complete replacement for shell.el -- that is, we can't name this file
 127 ;;; shell.el, and its main entry point (shell), because dbx.el will break
 128 ;;; when it loads it in and tries to use it.
 129 ;;;
 130 ;;; There are two ways to fix this. One: rewrite these other modes to use the
 131 ;;; new package. This is a win, but can't be assumed. The other, backwards
 132 ;;; compatible route, is to make this package non-conflict with shell.el, so
 133 ;;; both files can be loaded in at the same time. And *that* is why some
 134 ;;; functions and variables have different names: (cmushell),
 135 ;;; cmushell-mode-map, that sort of thing. All the names have been carefully
 136 ;;; chosen so that shell.el and cmushell.el won't tromp on each other.
 137 \f
 138 ;;; Customization and Buffer Variables
 139 ;;; ===========================================================================
 140 ;;;
 141
 142 ;;; Code:
 143
 144 (require 'comint)
 145
 146 ;;;###autoload
 147 (defvar shell-prompt-pattern "^[^#$%>\n]*[#$%>] *"
 148   "Regexp to match prompts in the inferior shell.
 149 Defaults to \"^[^#$%>\\n]*[#$%>] *\", which works pretty well.
 150 This variable is used to initialise `comint-prompt-regexp' in the
 151 shell buffer.
 152
 153 The pattern should probably not match more than one line.  If it does,
 154 shell-mode may become confused trying to distinguish prompt from input
 155 on lines which don't start with a prompt.
 156
 157 This is a fine thing to set in your `.emacs' file.")
 158
 159 (defvar shell-popd-regexp "popd"
 160   "*Regexp to match subshell commands equivalent to popd.")
 161
 162 (defvar shell-pushd-regexp "pushd"
 163   "*Regexp to match subshell commands equivalent to pushd.")
 164
 165 (defvar shell-cd-regexp "cd"
 166   "*Regexp to match subshell commands equivalent to cd.")
 167
 168 (defvar explicit-shell-file-name nil
 169   "*If non-nil, is file name to use for explicitly requested inferior shell.")
 170
 171 (defvar explicit-csh-args
 172   (if (eq system-type 'hpux)
 173       ;; -T persuades HP's csh not to think it is smarter
 174       ;; than us about what terminal modes to use.
 175       '("-i" "-T")
 176     '("-i"))
 177   "*Args passed to inferior shell by M-x shell, if the shell is csh.
 178 Value is a list of strings, which may be nil.")
 179
 180 ;;; All the above vars aren't prefixed "cmushell-" to make them
 181 ;;; backwards compatible w/shell.el and old .emacs files.
 182
 183 (defvar shell-dirstack nil
 184   "List of directories saved by pushd in this buffer's shell.
 185 Thus, this does not include the shell's current directory.")
 186
 187 (defvar shell-last-dir nil
 188   "Keep track of last directory for ksh `cd -' command.")
 189
 190 (defvar shell-dirstack-query "dirs"
 191   "Command used by `shell-resync-dir' to query the shell.")
 192
 193 (defvar shell-mode-map '())
 194 (cond ((not shell-mode-map)
 195        (setq shell-mode-map (full-copy-sparse-keymap comint-mode-map))
 196        (define-key shell-mode-map "\t" 'comint-dynamic-complete)
 197        (define-key shell-mode-map "\M-?"  'comint-dynamic-list-completions)))
 198
 199 (defvar shell-mode-hook '()
 200   "*Hook for customising Shell mode.")
 201
 202 \f
 203 ;;; Basic Procedures
 204 ;;; ===========================================================================
 205 ;;;
 206
 207 (defun shell-mode ()
 208   "Major mode for interacting with an inferior shell.
 209 Return after the end of the process' output sends the text from the
 210     end of process to the end of the current line.
 211 Return before end of process output copies the current line (except
 212     for the prompt) to the end of the buffer and sends it.
 213 M-x send-invisible reads a line of text without echoing it, and sends it to
 214     the shell.  This is useful for entering passwords.
 215
 216 If you accidentally suspend your process, use \\[comint-continue-subjob]
 217 to continue it.
 218
 219 cd, pushd and popd commands given to the shell are watched by Emacs to keep
 220 this buffer's default directory the same as the shell's working directory.
 221 M-x dirs queries the shell and resyncs Emacs' idea of what the current
 222     directory stack is.
 223 M-x dirtrack-toggle turns directory tracking on and off.
 224
 225 \\{shell-mode-map}
 226 Customization: Entry to this mode runs the hooks on `comint-mode-hook' and
 227 `shell-mode-hook' (in that order).
 228
 229 Variables `shell-cd-regexp', `shell-pushd-regexp' and `shell-popd-regexp'
 230 are used to match their respective commands."
 231   (interactive)
 232   (comint-mode)
 233   (setq comint-prompt-regexp shell-prompt-pattern)
 234   (setq major-mode 'shell-mode)
 235   (setq mode-name "Shell")
 236   (use-local-map shell-mode-map)
 237   (make-local-variable 'shell-dirstack)
 238   (setq shell-dirstack nil)
 239   (setq shell-last-dir nil)
 240   (make-local-variable 'shell-dirtrackp)
 241   (setq shell-dirtrackp t)
 242   (setq comint-input-sentinel 'shell-directory-tracker)
 243   (run-hooks 'shell-mode-hook))
 244
 245 \f
 246 ;;;###autoload
 247 (defun shell ()
 248   "Run an inferior shell, with I/O through buffer *shell*.
 249 If buffer exists but shell process is not running, make new shell.
 250 If buffer exists and shell process is running,
 251  just switch to buffer `*shell*'.
 252 Program used comes from variable `explicit-shell-file-name',
 253  or (if that is nil) from the ESHELL environment variable,
 254  or else from SHELL if there is no ESHELL.
 255 If a file `~/.emacs_SHELLNAME' exists, it is given as initial input
 256  (Note that this may lose due to a timing error if the shell
 257   discards input when it starts up.)
 258 The buffer is put in Shell mode, giving commands for sending input
 259 and controlling the subjobs of the shell.  See `shell-mode'.
 260 See also the variable `shell-prompt-pattern'.
 261
 262 The shell file name (sans directories) is used to make a symbol name
 263 such as `explicit-csh-args'.  If that symbol is a variable,
 264 its value is used as a list of arguments when invoking the shell.
 265 Otherwise, one argument `-i' is passed to the shell.
 266
 267 \(Type \\[describe-mode] in the shell buffer for a list of commands.)"
 268   (interactive)
 269   (cond ((not (comint-check-proc "*shell*"))
 270          (let* ((prog (or explicit-shell-file-name
 271                           (getenv "ESHELL")
 272                           (getenv "SHELL")
 273                           "/bin/sh"))
 274                 (name (file-name-nondirectory prog))
 275                 (startfile (concat "~/.emacs_" name))
 276                 (xargs-name (intern-soft (concat "explicit-" name "-args"))))
 277            (set-buffer (apply 'make-comint "shell" prog
 278                               (if (file-exists-p startfile) startfile)
 279                               (if (and xargs-name (boundp xargs-name))
 280                                   (symbol-value xargs-name)
 281                                   '("-i"))))
 282            (shell-mode))))
 283   (switch-to-buffer "*shell*"))
 284
 285 \f
 286 ;;; Directory tracking
 287 ;;; ===========================================================================
 288 ;;; This code provides the shell mode input sentinel
 289 ;;;     SHELL-DIRECTORY-TRACKER
 290 ;;; that tracks cd, pushd, and popd commands issued to the shell, and
 291 ;;; changes the current directory of the shell buffer accordingly.
 292 ;;;
 293 ;;; This is basically a fragile hack, although it's more accurate than
 294 ;;; the version in Emacs 18's shell.el. It has the following failings:
 295 ;;; 1. It doesn't know about the cdpath shell variable.
 296 ;;; 2. It only spots the first command in a command sequence. E.g., it will
 297 ;;;    miss the cd in "ls; cd foo"
 298 ;;; 3. More generally, any complex command (like ";" sequencing) is going to
 299 ;;;    throw it. Otherwise, you'd have to build an entire shell interpreter in
 300 ;;;    emacs lisp.  Failing that, there's no way to catch shell commands where
 301 ;;;    cd's are buried inside conditional expressions, aliases, and so forth.
 302 ;;;
 303 ;;; The whole approach is a crock. Shell aliases mess it up. File sourcing
 304 ;;; messes it up. You run other processes under the shell; these each have
 305 ;;; separate working directories, and some have commands for manipulating
 306 ;;; their w.d.'s (e.g., the lcd command in ftp). Some of these programs have
 307 ;;; commands that do *not* affect the current w.d. at all, but look like they
 308 ;;; do (e.g., the cd command in ftp).  In shells that allow you job
 309 ;;; control, you can switch between jobs, all having different w.d.'s. So
 310 ;;; simply saying %3 can shift your w.d..
 311 ;;;
 312 ;;; The solution is to relax, not stress out about it, and settle for
 313 ;;; a hack that works pretty well in typical circumstances. Remember
 314 ;;; that a half-assed solution is more in keeping with the spirit of Unix,
 315 ;;; anyway. Blech.
 316 ;;;
 317 ;;; One good hack not implemented here for users of programmable shells
 318 ;;; is to program up the shell w.d. manipulation commands to output
 319 ;;; a coded command sequence to the tty. Something like
 320 ;;;     ESC | <cwd> |
 321 ;;; where <cwd> is the new current working directory. Then trash the
 322 ;;; directory tracking machinery currently used in this package, and
 323 ;;; replace it with a process filter that watches for and strips out
 324 ;;; these messages.
 325
 326 ;;; REGEXP is a regular expression. STR is a string. START is a fixnum.
 327 ;;; Returns T if REGEXP matches STR where the match is anchored to start
 328 ;;; at position START in STR. Sort of like LOOKING-AT for strings.
 329 (defun shell-front-match (regexp str start)
 330   (eq start (string-match regexp str start)))
 331
 332 (defun shell-directory-tracker (str)
 333   "Tracks cd, pushd and popd commands issued to the shell.
 334 This function is called on each input passed to the shell.
 335 It watches for cd, pushd and popd commands and sets the buffer's
 336 default directory to track these commands.
 337
 338 You may toggle this tracking on and off with M-x dirtrack-toggle.
 339 If emacs gets confused, you can resync with the shell with M-x dirs.
 340
 341 See variables `shell-cd-regexp', `shell-pushd-regexp', and `shell-popd-regexp'.
 342 Environment variables are expanded, see function `substitute-in-file-name'."
 343   (condition-case err
 344     (cond (shell-dirtrackp
 345            (string-match "^\\s *" str) ; skip whitespace
 346            (let ((bos (match-end 0))
 347                  (x nil))
 348              (cond ((setq x (shell-match-cmd-w/optional-arg shell-popd-regexp
 349                                                                str bos))
 350                     (shell-process-popd (substitute-in-file-name x)))
 351                    ((setq x (shell-match-cmd-w/optional-arg shell-pushd-regexp
 352                                                                str bos))
 353                     (shell-process-pushd (substitute-in-file-name x)))
 354                    ((setq x (shell-match-cmd-w/optional-arg shell-cd-regexp
 355                                                                str bos))
 356                     (shell-process-cd (substitute-in-file-name x)))))))
 357     (error (message (car (cdr err))))))
 358
 359
 360 ;;; Try to match regexp CMD to string, anchored at position START.
 361 ;;; CMD may be followed by a single argument. If a match, then return
 362 ;;; the argument, if there is one, or the empty string if not. If
 363 ;;; no match, return nil.
 364
 365 (defun shell-match-cmd-w/optional-arg (cmd str start)
 366   (and (shell-front-match cmd str start)
 367        (let ((eoc (match-end 0))) ; end of command
 368          (cond ((shell-front-match "\\s *\\(\;\\|$\\)" str eoc)
 369                 "")                     ; no arg
 370                ((shell-front-match "\\s +\\([^ \t\;]+\\)\\s *\\(\;\\|$\\)"
 371                                       str eoc)
 372                 (substring str (match-beginning 1) (match-end 1))) ; arg
 373                (t nil))))) ; something else.
 374 ;;; The first regexp is [optional whitespace, (";" or the end of string)].
 375 ;;; The second regexp is [whitespace, (an arg), optional whitespace,
 376 ;;;     (";" or end of string)].
 377
 378
 379 ;;; popd [+n]
 380 (defun shell-process-popd (arg)
 381   (let ((num (if (zerop (length arg)) 0 ; no arg means +0
 382                  (shell-extract-num arg))))
 383     (if (and num (< num (length shell-dirstack)))
 384         (if (= num 0) ; condition-case because the CD could lose.
 385             (condition-case nil (progn (cd (car shell-dirstack))
 386                                        (setq shell-dirstack
 387                                              (cdr shell-dirstack))
 388                                        (shell-dirstack-message))
 389               (error (message "Couldn't cd.")))
 390             (let* ((ds (cons nil shell-dirstack))
 391                    (cell (nthcdr (- num 1) ds)))
 392               (rplacd cell (cdr (cdr cell)))
 393               (setq shell-dirstack (cdr ds))
 394               (shell-dirstack-message)))
 395         (message "Bad popd."))))
 396
 397
 398 ;;; cd [dir]
 399 (defun shell-process-cd (arg)
 400   (condition-case nil
 401       (let ((new-dir (cond
 402                       ((zerop (length arg)) (getenv "HOME"))
 403                       ((string-equal "-" arg) shell-last-dir)
 404                       (t arg))))
 405        (setq shell-last-dir default-directory)
 406        (cd new-dir)
 407        (shell-dirstack-message))
 408     (error (message "Couldn't cd."))))
 409
 410 ;;; pushd [+n | dir]
 411 (defun shell-process-pushd (arg)
 412   (if (zerop (length arg))
 413       ;; no arg -- swap pwd and car of shell stack
 414       (condition-case nil (if shell-dirstack
 415                               (let ((old default-directory))
 416                                 (cd (car shell-dirstack))
 417                                 (setq shell-dirstack
 418                                       (cons old (cdr shell-dirstack)))
 419                                 (shell-dirstack-message))
 420                               (message "Directory stack empty."))
 421         (error
 422          (message "Couldn't cd.")))
 423
 424       (let ((num (shell-extract-num arg)))
 425         (if num                         ; pushd +n
 426             (if (> num (length shell-dirstack))
 427                 (message "Directory stack not that deep.")
 428                 (let* ((ds (cons default-directory shell-dirstack))
 429                        (dslen (length ds))
 430                        (front (nthcdr num ds))
 431                        (back (reverse (nthcdr (- dslen num) (reverse ds))))
 432                        (new-ds (append front back)))
 433                   (condition-case nil
 434                       (progn (cd (car new-ds))
 435                              (setq shell-dirstack (cdr new-ds))
 436                              (shell-dirstack-message))
 437                     (error (message "Couldn't cd.")))))
 438
 439             ;; pushd <dir>
 440             (let ((old-wd default-directory))
 441               (condition-case nil
 442                   (progn (cd arg)
 443                          (setq shell-dirstack
 444                                (cons old-wd shell-dirstack))
 445                          (shell-dirstack-message))
 446                 (error (message "Couldn't cd."))))))))
 447
 448 ;; If STR is of the form +n, for n>0, return n. Otherwise, nil.
 449 (defun shell-extract-num (str)
 450   (and (string-match "^\\+[1-9][0-9]*$" str)
 451        (string-to-int str)))
 452
 453
 454 (defun shell-dirtrack-toggle ()
 455   "Turn directory tracking on and off in a shell buffer."
 456   (interactive)
 457   (setq shell-dirtrackp (not shell-dirtrackp))
 458   (message "directory tracking %s."
 459            (if shell-dirtrackp "ON" "OFF")))
 460
 461 ;;; For your typing convenience:
 462 (defalias 'dirtrack-toggle 'shell-dirtrack-toggle)
 463
 464
 465 (defun shell-resync-dirs ()
 466   "Resync the buffer's idea of the current directory stack.
 467 This command queries the shell with the command bound to
 468 `shell-dirstack-query' (default \"dirs\"), reads the next
 469 line output and parses it to form the new directory stack.
 470 DON'T issue this command unless the buffer is at a shell prompt.
 471 Also, note that if some other subprocess decides to do output
 472 immediately after the query, its output will be taken as the
 473 new directory stack -- you lose. If this happens, just do the
 474 command again."
 475   (interactive)
 476   (let* ((proc (get-buffer-process (current-buffer)))
 477          (pmark (process-mark proc)))
 478     (goto-char pmark)
 479     (insert shell-dirstack-query) (insert "\n")
 480     (sit-for 0) ; force redisplay
 481     (comint-send-string proc shell-dirstack-query)
 482     (comint-send-string proc "\n")
 483     (set-marker pmark (point))
 484     (let ((pt (point))) ; wait for 1 line
 485       ;; This extra newline prevents the user's pending input from spoofing us.
 486       (insert "\n") (backward-char 1)
 487       (while (not (looking-at ".+\n"))
 488         (accept-process-output proc)
 489         (goto-char pt)))
 490     (goto-char pmark) (delete-char 1) ; remove the extra newline
 491     ;; That's the dirlist. grab it & parse it.
 492     (let* ((dl (buffer-substring (match-beginning 0) (- (match-end 0) 1)))
 493            (dl-len (length dl))
 494            (ds '())                     ; new dir stack
 495            (i 0))
 496       (while (< i dl-len)
 497         ;; regexp = optional whitespace, (non-whitespace), optional whitespace
 498         (string-match "\\s *\\(\\S +\\)\\s *" dl i) ; pick off next dir
 499         (setq ds (cons (substring dl (match-beginning 1) (match-end 1))
 500                        ds))
 501         (setq i (match-end 0)))
 502       (let ((ds (reverse ds)))
 503         (condition-case nil
 504             (progn (cd (car ds))
 505                    (setq shell-dirstack (cdr ds))
 506                    (shell-dirstack-message))
 507           (error (message "Couldn't cd.")))))))
 508
 509 ;;; For your typing convenience:
 510 (defalias 'dirs 'shell-resync-dirs)
 511
 512
 513 ;;; Show the current dirstack on the message line.
 514 ;;; Pretty up dirs a bit by changing "/usr/jqr/foo" to "~/foo".
 515 ;;; (This isn't necessary if the dirlisting is generated with a simple "dirs".)
 516 ;;; All the commands that mung the buffer's dirstack finish by calling
 517 ;;; this guy.
 518 (defun shell-dirstack-message ()
 519   (let ((msg "")
 520         (ds (cons default-directory shell-dirstack)))
 521     (while ds
 522       (let ((dir (car ds)))
 523         (if (string-match (format "^%s\\(/\\|$\\)" (getenv "HOME")) dir)
 524             (setq dir (concat "~/" (substring dir (match-end 0)))))
 525         (if (string-equal dir "~/") (setq dir "~"))
 526         (setq msg (concat msg dir " "))
 527         (setq ds (cdr ds))))
 528     (message msg)))
 529
 530
 531 \f
 532 ;;; Interfacing to client packages (and converting them)
 533 ;;; Notes from when this was called cmushell, and was not the standard emacs
 534 ;;; shell package.  Many of the conversions discussed here have been done.
 535 ;;;============================================================================
 536 ;;; Several gnu packages (tex-mode, background, dbx, gdb, kermit, prolog,
 537 ;;; telnet are some) use the shell package as clients. Most of them would
 538 ;;; be better off using the comint package directly, but they predate it.
 539 ;;; The catch is that most of these packages (dbx, gdb, prolog, telnet)
 540 ;;; assume total knowledge of all the local variables that shell mode
 541 ;;; functions depend on. So they (kill-all-local-variables), then create
 542 ;;; the few local variables that shell.el functions depend on. Alas,
 543 ;;; cmushell.el functions depend on a different set of vars (for example,
 544 ;;; the input history ring is a local variable in cmushell.el's shell mode,
 545 ;;; whereas there is no input history ring in shell.el's shell mode).
 546 ;;; So we have a situation where the greater functionality of cmushell.el
 547 ;;; is biting us -- you can't just replace shell will cmushell.
 548 ;;;
 549 ;;; Altering these packages to use comint mode directly should *greatly*
 550 ;;; improve their functionality, and is actually pretty easy. It's
 551 ;;; mostly a matter of renaming a few variable names. See comint.el for more.
 552 ;;;     -Olin
 553
 554
 555
 556 ;;; Do the user's customization...
 557 ;;;===============================
 558 (defvar shell-load-hook nil
 559   "This hook is run when shell is loaded in.
 560 This is a good place to put keybindings.")
 561
 562 (run-hooks 'shell-load-hook)
 563
 564 (provide 'shell)
 565
 566 ;;; shell.el ends here