shell.el 33.4 KB
Newer Older
1
;;; shell.el --- specialized comint.el for running the shell.
2

3
;; Copyright (C) 1988, 1993, 1994, 1995, 1996 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Author: Olin Shivers <shivers@cs.cmu.edu>
6
;; Maintainer: Simon Marshall <simon@gnu.ai.mit.edu>
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: processes
Eric S. Raymond's avatar
Eric S. Raymond committed
8

9
;; This file is part of GNU Emacs.
Eric S. Raymond's avatar
Eric S. Raymond committed
10

11 12 13 14
;; 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.
Eric S. Raymond's avatar
Eric S. Raymond committed
15

16 17 18 19
;; 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.
Eric S. Raymond's avatar
Eric S. Raymond committed
20

21
;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
22 23 24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
David Lawrence's avatar
David Lawrence committed
25

Eric S. Raymond's avatar
Eric S. Raymond committed
26 27
;;; Commentary:

Erik Naggum's avatar
Erik Naggum committed
28 29 30 31
;; 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)
;;     - Simon Marshall (simon@gnu.ai.mit.edu)
David Lawrence's avatar
David Lawrence committed
32

Erik Naggum's avatar
Erik Naggum committed
33 34 35 36
;; 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.
David Lawrence's avatar
David Lawrence committed
37

Erik Naggum's avatar
Erik Naggum committed
38 39 40 41
;; 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.
David Lawrence's avatar
David Lawrence committed
42

Erik Naggum's avatar
Erik Naggum committed
43 44 45
;; 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.
David Lawrence's avatar
David Lawrence committed
46

Erik Naggum's avatar
Erik Naggum committed
47 48 49 50 51
;; Needs fixin:
;; When sending text from a source file to a subprocess, the process-mark can 
;; move off the window, so you can lose sight of the process interactions.
;; Maybe I should ensure the process mark is in the window when I send
;; text to the process? Switch selectable?
David Lawrence's avatar
David Lawrence committed
52

Jim Blandy's avatar
Jim Blandy committed
53 54 55 56
;; YOUR .EMACS FILE
;;=============================================================================
;; Some suggestions for your .emacs file.
;;
57 58 59
;; ;; Define M-# to run some strange command:
;; (eval-after-load "shell"
;;  '(define-key shell-mode-map "\M-#" 'shells-dynamic-spell))
Jim Blandy's avatar
Jim Blandy committed
60

Erik Naggum's avatar
Erik Naggum committed
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
;; 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-r     comint-previous-matching-input  Previous input matching a regexp
;; m-s     comint-next-matching-input      Next input that matches
;; m-c-l   comint-show-output		    Show last batch of process output
;; return  comint-send-input
;; c-d	    comint-delchar-or-maybe-eof	    Delete char unless at end of buff.
;; c-c c-a comint-bol                      Beginning of line; skip prompt
;; 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
;; c-c c-h comint-dynamic-list-input-ring  List input history
;;         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 filename/command/history
;; m-?     comint-dynamic-list-filename-completions
;;					List completions in help buffer
;; m-c-f   shell-forward-command	Forward a shell command
;; m-c-b   shell-backward-command	Backward a shell command
;; 	    dirs			Resync the buffer's dir stack
;; 	    dirtrack-toggle		Turn dir tracking on/off
;;         comint-strip-ctrl-m		Remove trailing ^Ms from output
;;
;; The shell mode hook is shell-mode-hook
;; comint-prompt-regexp is initialised to shell-prompt-pattern, for backwards
;; compatibility.
Jim Blandy's avatar
Jim Blandy committed
100

Erik Naggum's avatar
Erik Naggum committed
101
;; Read the rest of this file for more information.
Jim Blandy's avatar
Jim Blandy committed
102

Eric S. Raymond's avatar
Eric S. Raymond committed
103 104 105 106
;;; Code:

(require 'comint)

Erik Naggum's avatar
Erik Naggum committed
107 108
;;; Customization and Buffer Variables

Eric S. Raymond's avatar
Eric S. Raymond committed
109
;;;###autoload
110
(defvar shell-prompt-pattern "^[^#$%>\n]*[#$%>] *"
Jim Blandy's avatar
Jim Blandy committed
111
  "Regexp to match prompts in the inferior shell.
112
Defaults to \"^[^#$%>\\n]*[#$%>] *\", which works pretty well.
113
This variable is used to initialise `comint-prompt-regexp' in the 
Jim Blandy's avatar
Jim Blandy committed
114 115
shell buffer.

116
The pattern should probably not match more than one line.  If it does,
117
Shell mode may become confused trying to distinguish prompt from input
118 119
on lines which don't start with a prompt.

120
This is a fine thing to set in your `.emacs' file.")
Jim Blandy's avatar
Jim Blandy committed
121

122 123 124 125 126 127 128 129
(defvar shell-completion-fignore nil
  "*List of suffixes to be disregarded during file/command completion.
This variable is used to initialize `comint-completion-fignore' in the shell
buffer.  The default is nil, for compatibility with most shells.
Some people like (\"~\" \"#\" \"%\").

This is a fine thing to set in your `.emacs' file.")  

130
(defvar shell-delimiter-argument-list '(?\| ?& ?< ?> ?\( ?\) ?\;)
131
  "List of characters to recognise as separate arguments.
132 133
This variable is used to initialize `comint-delimiter-argument-list' in the
shell buffer.  The default is (?\\| ?& ?< ?> ?\\( ?\\) ?\\;).
134 135 136

This is a fine thing to set in your `.emacs' file.")

137 138 139 140 141 142 143 144 145
(defvar shell-file-name-quote-list
  (append shell-delimiter-argument-list '(?\  ?\* ?\! ?\" ?\' ?\`))
  "List of characters to quote when in a file name.
This variable is used to initialize `comint-file-name-quote-list' in the
shell buffer.  The default is (?\  ?\* ?\! ?\" ?\' ?\`) plus characters
in `shell-delimiter-argument-list'.

This is a fine thing to set in your `.emacs' file.")

146 147 148 149 150 151 152 153 154 155 156 157
(defvar shell-dynamic-complete-functions
  '(comint-replace-by-expanded-history
    shell-dynamic-complete-environment-variable
    shell-dynamic-complete-command
    shell-replace-by-expanded-directory
    comint-dynamic-complete-filename)
  "List of functions called to perform completion.
This variable is used to initialise `comint-dynamic-complete-functions' in the
shell buffer.

This is a fine thing to set in your `.emacs' file.")

158 159 160
(defvar shell-command-regexp "[^;&|\n]+"
  "*Regexp to match a single command within a pipeline.
This is used for directory tracking and does not do a perfect job.")
161 162 163

(defvar shell-completion-execonly t
  "*If non-nil, use executable files only for completion candidates.
Richard M. Stallman's avatar
Richard M. Stallman committed
164
This mirrors the optional behavior of tcsh.
165 166 167

Detecting executability of files may slow command completion considerably.")

David Lawrence's avatar
David Lawrence committed
168 169 170 171 172 173
(defvar shell-popd-regexp "popd"
  "*Regexp to match subshell commands equivalent to popd.")

(defvar shell-pushd-regexp "pushd"
  "*Regexp to match subshell commands equivalent to pushd.")

174 175
(defvar shell-pushd-tohome nil
  "*If non-nil, make pushd with no arg behave as \"pushd ~\" (like cd).
Richard M. Stallman's avatar
Richard M. Stallman committed
176
This mirrors the optional behavior of tcsh.")
177 178 179

(defvar shell-pushd-dextract nil
  "*If non-nil, make \"pushd +n\" pop the nth dir to the stack top.
Richard M. Stallman's avatar
Richard M. Stallman committed
180
This mirrors the optional behavior of tcsh.")
181 182 183

(defvar shell-pushd-dunique nil
  "*If non-nil, make pushd only add unique directories to the stack.
Richard M. Stallman's avatar
Richard M. Stallman committed
184
This mirrors the optional behavior of tcsh.")
185

David Lawrence's avatar
David Lawrence committed
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
(defvar shell-cd-regexp "cd"
  "*Regexp to match subshell commands equivalent to cd.")

(defvar explicit-shell-file-name nil
  "*If non-nil, is file name to use for explicitly requested inferior shell.")

(defvar explicit-csh-args
  (if (eq system-type 'hpux)
      ;; -T persuades HP's csh not to think it is smarter
      ;; than us about what terminal modes to use.
      '("-i" "-T")
    '("-i"))
  "*Args passed to inferior shell by M-x shell, if the shell is csh.
Value is a list of strings, which may be nil.")

201 202 203 204 205 206 207 208 209 210 211 212
(defvar shell-input-autoexpand 'history
  "*If non-nil, expand input command history references on completion.
This mirrors the optional behavior of tcsh (its autoexpand and histlit).

If the value is `input', then the expansion is seen on input.
If the value is `history', then the expansion is only when inserting
into the buffer's input ring.  See also `comint-magic-space' and
`comint-dynamic-complete'.

This variable supplies a default for `comint-input-autoexpand',
for Shell mode only.")

David Lawrence's avatar
David Lawrence committed
213
(defvar shell-dirstack nil
Eric S. Raymond's avatar
Eric S. Raymond committed
214 215
  "List of directories saved by pushd in this buffer's shell.
Thus, this does not include the shell's current directory.")
David Lawrence's avatar
David Lawrence committed
216

217 218 219
(defvar shell-dirtrackp t
  "Non-nil in a shell buffer means directory tracking is enabled.")

220 221 222
(defvar shell-last-dir nil
  "Keep track of last directory for ksh `cd -' command.")

223
(defvar shell-dirstack-query nil
224
  "Command used by `shell-resync-dir' to query the shell.")
David Lawrence's avatar
David Lawrence committed
225

226
(defvar shell-mode-map nil)
David Lawrence's avatar
David Lawrence committed
227
(cond ((not shell-mode-map)
228
       (setq shell-mode-map (nconc (make-sparse-keymap) comint-mode-map))
229 230
       (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
       (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
David Lawrence's avatar
David Lawrence committed
231
       (define-key shell-mode-map "\t" 'comint-dynamic-complete)
232
       (define-key shell-mode-map "\M-?"
233
	 'comint-dynamic-list-filename-completions)
234 235
       (define-key shell-mode-map [menu-bar completion]
	 (copy-keymap (lookup-key comint-mode-map [menu-bar completion])))
236 237 238 239 240 241 242 243
       (define-key-after (lookup-key shell-mode-map [menu-bar completion])
	 [complete-env-variable] '("Complete Env. Variable Name" .
				   shell-dynamic-complete-environment-variable)
	 'complete-file)
       (define-key-after (lookup-key shell-mode-map [menu-bar completion])
	 [expand-directory] '("Expand Directory Reference" .
			      shell-replace-by-expanded-directory)
	 'complete-expand)))
David Lawrence's avatar
David Lawrence committed
244 245

(defvar shell-mode-hook '()
246
  "*Hook for customising Shell mode.")
David Lawrence's avatar
David Lawrence committed
247

248 249 250
(defvar shell-font-lock-keywords
  (list (cons shell-prompt-pattern 'font-lock-keyword-face)
	'("[ \t]\\([+-][^ \t\n]+\\)" 1 font-lock-comment-face)
251
	'("^[^ \t\n]+:.*" . font-lock-string-face)
252 253
	'("^\\[[1-9][0-9]*\\]" . font-lock-string-face))
  "Additional expressions to highlight in Shell mode.")
David Lawrence's avatar
David Lawrence committed
254 255 256 257 258

;;; Basic Procedures

(defun shell-mode ()
  "Major mode for interacting with an inferior shell.
259 260 261 262
\\[comint-send-input] after the end of the process' output sends the text from
    the end of process to the end of the current line.
\\[comint-send-input] before end of process output copies the current line minus the prompt to
    the end of the buffer and sends it (\\[comint-copy-old-input] just copies the current line).
263
\\[send-invisible] reads a line of text without echoing it, and sends it to
264 265
    the shell.  This is useful for entering passwords.  Or, add the function
    `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
David Lawrence's avatar
David Lawrence committed
266

267 268 269
If you want to make multiple shell buffers, rename the `*shell*' buffer
using \\[rename-buffer] or \\[rename-uniquely] and start a new shell.

270
If you want to make shell buffers limited in length, add the function
271
`comint-truncate-buffer' to `comint-output-filter-functions'.
272

David Lawrence's avatar
David Lawrence committed
273 274 275
If you accidentally suspend your process, use \\[comint-continue-subjob]
to continue it.

276 277
`cd', `pushd' and `popd' commands given to the shell are watched by Emacs to
keep this buffer's default directory the same as the shell's working directory.
278 279
While directory tracking is enabled, the shell's working directory is displayed
by \\[list-buffers] or \\[mouse-buffer-menu] in the `File' field.
280
\\[dirs] queries the shell and resyncs Emacs' idea of what the current 
David Lawrence's avatar
David Lawrence committed
281
    directory stack is.
282
\\[dirtrack-toggle] turns directory tracking on and off.
David Lawrence's avatar
David Lawrence committed
283 284

\\{shell-mode-map}
285
Customization: Entry to this mode runs the hooks on `comint-mode-hook' and
286
`shell-mode-hook' (in that order).  Before each input, the hooks on
287 288
`comint-input-filter-functions' are run.  After each shell output, the hooks
on `comint-output-filter-functions' are run.
David Lawrence's avatar
David Lawrence committed
289

290
Variables `shell-cd-regexp', `shell-pushd-regexp' and `shell-popd-regexp'
291
are used to match their respective commands, while `shell-pushd-tohome',
Richard M. Stallman's avatar
Richard M. Stallman committed
292
`shell-pushd-dextract' and `shell-pushd-dunique' control the behavior of the
293 294
relevant command.

295 296 297 298 299 300
Variables `comint-completion-autolist', `comint-completion-addsuffix',
`comint-completion-recexact' and `comint-completion-fignore' control the
behavior of file name, command name and variable name completion.  Variable
`shell-completion-execonly' controls the behavior of command name completion.
Variable `shell-completion-fignore' is used to initialise the value of
`comint-completion-fignore'.
301 302 303 304

Variables `comint-input-ring-file-name' and `comint-input-autoexpand' control
the initialisation of the input ring history, and history expansion.

305
Variables `comint-output-filter-functions', a hook, and
306
`comint-scroll-to-bottom-on-input' and `comint-scroll-to-bottom-on-output'
307 308
control whether input and output cause the window to scroll to the end of the
buffer."
David Lawrence's avatar
David Lawrence committed
309 310
  (interactive)
  (comint-mode)
Jim Blandy's avatar
Jim Blandy committed
311
  (setq major-mode 'shell-mode)
312
  (setq mode-name "Shell")
David Lawrence's avatar
David Lawrence committed
313
  (use-local-map shell-mode-map)
314
  (setq comint-prompt-regexp shell-prompt-pattern)
315
  (setq comint-completion-fignore shell-completion-fignore)
316
  (setq comint-delimiter-argument-list shell-delimiter-argument-list)
317
  (setq comint-file-name-quote-list shell-file-name-quote-list)
318
  (setq comint-dynamic-complete-functions shell-dynamic-complete-functions)
319 320
  (make-local-variable 'paragraph-start)
  (setq paragraph-start comint-prompt-regexp)
321 322
  (make-local-variable 'font-lock-defaults)
  (setq font-lock-defaults '(shell-font-lock-keywords t))
David Lawrence's avatar
David Lawrence committed
323
  (make-local-variable 'shell-dirstack)
Jim Blandy's avatar
Jim Blandy committed
324
  (setq shell-dirstack nil)
325
  (setq shell-last-dir nil)
Jim Blandy's avatar
Jim Blandy committed
326 327
  (make-local-variable 'shell-dirtrackp)
  (setq shell-dirtrackp t)
328
  (add-hook 'comint-input-filter-functions 'shell-directory-tracker nil t)
329
  (setq comint-input-autoexpand shell-input-autoexpand)
330 331
  (make-local-variable 'list-buffers-directory)
  (setq list-buffers-directory (expand-file-name default-directory))
332
  ;; shell-dependent assignments.
333 334
  (let ((shell (file-name-nondirectory (car
		 (process-command (get-buffer-process (current-buffer)))))))
335 336
    (setq comint-input-ring-file-name
	  (or (getenv "HISTFILE")
337 338 339
	      (cond ((string-equal shell "bash") "~/.bash_history")
		    ((string-equal shell "ksh") "~/.sh_history")
		    (t "~/.history"))))
340 341
    (if (or (equal comint-input-ring-file-name "")
	    (equal (file-truename comint-input-ring-file-name) "/dev/null"))
342
	(setq comint-input-ring-file-name nil))
343
    (setq shell-dirstack-query
344 345 346
	  (cond ((string-equal shell "sh") "pwd")
		((string-equal shell "ksh") "echo $PWD ~-")
		(t "dirs"))))
347
  (run-hooks 'shell-mode-hook)
348
  (comint-read-input-ring t))
David Lawrence's avatar
David Lawrence committed
349

Eric S. Raymond's avatar
Eric S. Raymond committed
350
;;;###autoload
David Lawrence's avatar
David Lawrence committed
351 352 353
(defun shell ()
  "Run an inferior shell, with I/O through buffer *shell*.
If buffer exists but shell process is not running, make new shell.
354
If buffer exists and shell process is running, just switch to buffer `*shell*'.
355
Program used comes from variable `explicit-shell-file-name',
Jim Blandy's avatar
Jim Blandy committed
356 357
 or (if that is nil) from the ESHELL environment variable,
 or else from SHELL if there is no ESHELL.
Richard M. Stallman's avatar
Richard M. Stallman committed
358
If a file `~/.emacs_SHELLNAME' exists, it is given as initial input
Jim Blandy's avatar
Jim Blandy committed
359 360
 (Note that this may lose due to a timing error if the shell
  discards input when it starts up.)
Richard M. Stallman's avatar
Richard M. Stallman committed
361 362 363
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'.
David Lawrence's avatar
David Lawrence committed
364

Jim Blandy's avatar
Jim Blandy committed
365
The shell file name (sans directories) is used to make a symbol name
Richard M. Stallman's avatar
Richard M. Stallman committed
366
such as `explicit-csh-args'.  If that symbol is a variable,
David Lawrence's avatar
David Lawrence committed
367 368 369 370 371
its value is used as a list of arguments when invoking the shell.
Otherwise, one argument `-i' is passed to the shell.

\(Type \\[describe-mode] in the shell buffer for a list of commands.)"
  (interactive)
372 373 374 375 376 377 378
  (if (not (comint-check-proc "*shell*"))
      (let* ((prog (or explicit-shell-file-name
		       (getenv "ESHELL")
		       (getenv "SHELL")
		       "/bin/sh"))		     
	     (name (file-name-nondirectory prog))
	     (startfile (concat "~/.emacs_" name))
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
	     (xargs-name (intern-soft (concat "explicit-" name "-args")))
	     shell-buffer)
	(save-excursion
	  (set-buffer (apply 'make-comint "shell" prog
			     (if (file-exists-p startfile) startfile)
			     (if (and xargs-name (boundp xargs-name))
				 (symbol-value xargs-name)
			       '("-i"))))
	  (setq shell-buffer (current-buffer))
	  (shell-mode))
	(pop-to-buffer shell-buffer))
    (pop-to-buffer "*shell*")))

;;; Don't do this when shell.el is loaded, only while dumping.
;;;###autoload (add-hook 'same-window-buffer-names "*shell*")
David Lawrence's avatar
David Lawrence committed
394 395

;;; Directory tracking
Erik Naggum's avatar
Erik Naggum committed
396
;;;
David Lawrence's avatar
David Lawrence committed
397 398 399 400 401 402
;;; This code provides the shell mode input sentinel
;;;     SHELL-DIRECTORY-TRACKER
;;; that tracks cd, pushd, and popd commands issued to the shell, and
;;; changes the current directory of the shell buffer accordingly.
;;;
;;; This is basically a fragile hack, although it's more accurate than
Jim Blandy's avatar
Jim Blandy committed
403
;;; the version in Emacs 18's shell.el. It has the following failings:
David Lawrence's avatar
David Lawrence committed
404
;;; 1. It doesn't know about the cdpath shell variable.
405 406 407 408 409 410
;;; 2. It cannot infallibly deal with command sequences, though it does well
;;;    with these and with ignoring commands forked in another shell with ()s.
;;; 3. More generally, any complex command is going to throw it. Otherwise,
;;;    you'd have to build an entire shell interpreter in emacs lisp.  Failing
;;;    that, there's no way to catch shell commands where cd's are buried
;;;    inside conditional expressions, aliases, and so forth.
David Lawrence's avatar
David Lawrence committed
411 412 413 414 415
;;;
;;; The whole approach is a crock. Shell aliases mess it up. File sourcing
;;; 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
Jim Blandy's avatar
Jim Blandy committed
416
;;; commands that do *not* affect the current w.d. at all, but look like they
David Lawrence's avatar
David Lawrence committed
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
;;; 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..
;;;
;;; The solution is to relax, not stress out about it, and settle for
;;; a hack that works pretty well in typical circumstances. Remember
;;; that a half-assed solution is more in keeping with the spirit of Unix, 
;;; anyway. Blech.
;;;
;;; One good hack not implemented here for users of programmable shells
;;; is to program up the shell w.d. manipulation commands to output
;;; a coded command sequence to the tty. Something like
;;;     ESC | <cwd> |
;;; where <cwd> is the new current working directory. Then trash the
;;; directory tracking machinery currently used in this package, and
;;; replace it with a process filter that watches for and strips out
;;; these messages.

(defun shell-directory-tracker (str)
  "Tracks cd, pushd and popd commands issued to the shell.
This function is called on each input passed to the shell.
It watches for cd, pushd and popd commands and sets the buffer's
default directory to track these commands.

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.

444 445
See variables `shell-cd-regexp', `shell-pushd-regexp', and `shell-popd-regexp',
while `shell-pushd-tohome', `shell-pushd-dextract' and `shell-pushd-dunique'
Richard M. Stallman's avatar
Richard M. Stallman committed
446
control the behavior of the relevant command.
447

448
Environment variables are expanded, see function `substitute-in-file-name'."
449 450 451
  (if shell-dirtrackp
      ;; We fail gracefully if we think the command will fail in the shell.
      (condition-case chdir-failure
452
	  (let ((start (progn (string-match "^[; \t]*" str) ; skip whitespace
453 454 455 456 457 458
			      (match-end 0)))
		end cmd arg1)
	    (while (string-match shell-command-regexp str start)
	      (setq end (match-end 0)
		    cmd (comint-arguments (substring str start end) 0 0)
		    arg1 (comint-arguments (substring str start end) 1 1))
459 460 461
	      (cond ((string-match (concat "\\`\\(" shell-popd-regexp
					   "\\)\\($\\|[ \t]\\)")
				   cmd)
462
		     (shell-process-popd (substitute-in-file-name arg1)))
463 464 465
		    ((string-match (concat "\\`\\(" shell-pushd-regexp
					   "\\)\\($\\|[ \t]\\)")
				   cmd)
466
		     (shell-process-pushd (substitute-in-file-name arg1)))
467 468 469
		    ((string-match (concat "\\`\\(" shell-cd-regexp
					   "\\)\\($\\|[ \t]\\)")
				   cmd)
470
		     (shell-process-cd (substitute-in-file-name arg1))))
471
	      (setq start (progn (string-match "[; \t]*" str end) ; skip again
472
				 (match-end 0)))))
473
	(error "Couldn't cd"))))
474

David Lawrence's avatar
David Lawrence committed
475 476
;;; popd [+n]
(defun shell-process-popd (arg)
477 478
  (let ((num (or (shell-extract-num arg) 0)))
    (cond ((and num (= num 0) shell-dirstack)
479
	   (shell-cd (car shell-dirstack))
480 481 482 483 484 485 486 487 488
	   (setq shell-dirstack (cdr shell-dirstack))
	   (shell-dirstack-message))
	  ((and num (> num 0) (<= num (length shell-dirstack)))
	   (let* ((ds (cons nil shell-dirstack))
		  (cell (nthcdr (1- num) ds)))
	     (rplacd cell (cdr (cdr cell)))
	     (setq shell-dirstack (cdr ds))
	     (shell-dirstack-message)))
	  (t
489
	   (error "Couldn't popd")))))
David Lawrence's avatar
David Lawrence committed
490

Roland McGrath's avatar
Roland McGrath committed
491
;; Return DIR prefixed with comint-file-name-prefix as appropriate.
492 493 494 495 496 497
(defun shell-prefixed-directory-name (dir)
  (if (= (length comint-file-name-prefix) 0)
      dir
    (if (file-name-absolute-p dir)
	;; The name is absolute, so prepend the prefix.
	(concat comint-file-name-prefix dir)
498
      ;; For relative name we assume default-directory already has the prefix.
499
      (expand-file-name dir))))
Roland McGrath's avatar
Roland McGrath committed
500

David Lawrence's avatar
David Lawrence committed
501 502
;;; cd [dir]
(defun shell-process-cd (arg)
Roland McGrath's avatar
Roland McGrath committed
503 504
  (let ((new-dir (cond ((zerop (length arg)) (concat comint-file-name-prefix
						     "~"))
505
		       ((string-equal "-" arg) shell-last-dir)
Roland McGrath's avatar
Roland McGrath committed
506
		       (t (shell-prefixed-directory-name arg)))))
507
    (setq shell-last-dir default-directory)
508
    (shell-cd new-dir)
509
    (shell-dirstack-message)))
David Lawrence's avatar
David Lawrence committed
510 511 512

;;; pushd [+n | dir]
(defun shell-process-pushd (arg)
513 514 515 516
  (let ((num (shell-extract-num arg)))
    (cond ((zerop (length arg))
	   ;; no arg -- swap pwd and car of stack unless shell-pushd-tohome
	   (cond (shell-pushd-tohome
Roland McGrath's avatar
Roland McGrath committed
517
		  (shell-process-pushd (concat comint-file-name-prefix "~")))
518 519
		 (shell-dirstack
		  (let ((old default-directory))
520
		    (shell-cd (car shell-dirstack))
521
		    (setq shell-dirstack (cons old (cdr shell-dirstack)))
522 523 524 525 526 527 528 529 530 531 532 533 534
		    (shell-dirstack-message)))
		 (t
		  (message "Directory stack empty."))))
	  ((numberp num)
	   ;; pushd +n
	   (cond ((> num (length shell-dirstack))
		  (message "Directory stack not that deep."))
		 ((= num 0)
		  (error (message "Couldn't cd.")))
		 (shell-pushd-dextract
		  (let ((dir (nth (1- num) shell-dirstack)))
		    (shell-process-popd arg)
		    (shell-process-pushd default-directory)
535
		    (shell-cd dir)
536 537 538 539 540 541 542
		    (shell-dirstack-message)))
		 (t
		  (let* ((ds (cons default-directory shell-dirstack))
			 (dslen (length ds))
			 (front (nthcdr num ds))
			 (back (reverse (nthcdr (- dslen num) (reverse ds))))
			 (new-ds (append front back)))
543
		    (shell-cd (car new-ds))
544 545 546 547 548
		    (setq shell-dirstack (cdr new-ds))
		    (shell-dirstack-message)))))
	  (t
	   ;; pushd <dir>
	   (let ((old-wd default-directory))
549
	     (shell-cd (shell-prefixed-directory-name arg))
550 551 552 553
	     (if (or (null shell-pushd-dunique)
		     (not (member old-wd shell-dirstack)))
		 (setq shell-dirstack (cons old-wd shell-dirstack)))
	     (shell-dirstack-message))))))
David Lawrence's avatar
David Lawrence committed
554 555 556 557 558 559 560 561 562 563

;; If STR is of the form +n, for n>0, return n. Otherwise, nil.
(defun shell-extract-num (str)
  (and (string-match "^\\+[1-9][0-9]*$" str)
       (string-to-int str)))


(defun shell-dirtrack-toggle ()
  "Turn directory tracking on and off in a shell buffer."
  (interactive)
564 565 566
  (if (setq shell-dirtrackp (not shell-dirtrackp))
      (setq list-buffers-directory default-directory)
    (setq list-buffers-directory nil))
567
  (message "Directory tracking %s" (if shell-dirtrackp "ON" "OFF")))
David Lawrence's avatar
David Lawrence committed
568 569

;;; For your typing convenience:
570
(defalias 'dirtrack-toggle 'shell-dirtrack-toggle)
David Lawrence's avatar
David Lawrence committed
571

572 573
(defun shell-cd (dir)
  "Do normal `cd' to DIR, and set `list-buffers-directory'."
574 575 576
  (if shell-dirtrackp
      (setq list-buffers-directory (file-name-as-directory
				    (expand-file-name dir))))
577
  (cd dir))
David Lawrence's avatar
David Lawrence committed
578 579 580 581

(defun shell-resync-dirs ()
  "Resync the buffer's idea of the current directory stack.
This command queries the shell with the command bound to 
582
`shell-dirstack-query' (default \"dirs\"), reads the next
David Lawrence's avatar
David Lawrence committed
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
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
immediately after the query, its output will be taken as the
new directory stack -- you lose. If this happens, just do the
command again."
  (interactive)
  (let* ((proc (get-buffer-process (current-buffer)))
	 (pmark (process-mark proc)))
    (goto-char pmark)
    (insert shell-dirstack-query) (insert "\n")
    (sit-for 0) ; force redisplay
    (comint-send-string proc shell-dirstack-query) 
    (comint-send-string proc "\n")
    (set-marker pmark (point))
    (let ((pt (point))) ; wait for 1 line
      ;; This extra newline prevents the user's pending input from spoofing us.
      (insert "\n") (backward-char 1)
      (while (not (looking-at ".+\n"))
	(accept-process-output proc)
	(goto-char pt)))
    (goto-char pmark) (delete-char 1) ; remove the extra newline
    ;; That's the dirlist. grab it & parse it.
606
    (let* ((dl (buffer-substring (match-beginning 0) (1- (match-end 0))))
David Lawrence's avatar
David Lawrence committed
607 608 609 610 611 612
	   (dl-len (length dl))
	   (ds '())			; new dir stack
	   (i 0))
      (while (< i dl-len)
	;; regexp = optional whitespace, (non-whitespace), optional whitespace
	(string-match "\\s *\\(\\S +\\)\\s *" dl i) ; pick off next dir
Roland McGrath's avatar
Roland McGrath committed
613 614 615
	(setq ds (cons (concat comint-file-name-prefix
			       (substring dl (match-beginning 1)
					  (match-end 1)))
David Lawrence's avatar
David Lawrence committed
616 617
		       ds))
	(setq i (match-end 0)))
Roland McGrath's avatar
Roland McGrath committed
618
      (let ((ds (nreverse ds)))
David Lawrence's avatar
David Lawrence committed
619
	(condition-case nil
620
	    (progn (shell-cd (car ds))
621 622
		   (setq shell-dirstack (cdr ds)
			 shell-last-dir (car shell-dirstack))
David Lawrence's avatar
David Lawrence committed
623 624 625 626
		   (shell-dirstack-message))
	  (error (message "Couldn't cd.")))))))

;;; For your typing convenience:
627
(defalias 'dirs 'shell-resync-dirs)
David Lawrence's avatar
David Lawrence committed
628 629 630 631 632 633 634 635


;;; Show the current dirstack on the message line.
;;; Pretty up dirs a bit by changing "/usr/jqr/foo" to "~/foo".
;;; (This isn't necessary if the dirlisting is generated with a simple "dirs".)
;;; All the commands that mung the buffer's dirstack finish by calling
;;; this guy.
(defun shell-dirstack-message ()
636 637
  (let* ((msg "")
	 (ds (cons default-directory shell-dirstack))
638
	 (home (expand-file-name (concat comint-file-name-prefix "~/")))
639
	 (homelen (length home)))
David Lawrence's avatar
David Lawrence committed
640 641
    (while ds
      (let ((dir (car ds)))
642 643
	(and (>= (length dir) homelen) (string= home (substring dir 0 homelen))
	    (setq dir (concat "~/" (substring dir homelen))))
644 645 646 647 648 649
	;; Strip off comint-file-name-prefix if present.
	(and comint-file-name-prefix
	     (>= (length dir) (length comint-file-name-prefix))
	     (string= comint-file-name-prefix
		      (substring dir 0 (length comint-file-name-prefix)))
	     (setq dir (substring dir (length comint-file-name-prefix)))
650
	     (setcar ds dir))
651
	(setq msg (concat msg (directory-file-name dir) " "))
David Lawrence's avatar
David Lawrence committed
652
	(setq ds (cdr ds))))
653
    (message "%s" msg)))
Jim Blandy's avatar
Jim Blandy committed
654

655 656 657 658 659
(defun shell-forward-command (&optional arg)
  "Move forward across ARG shell command(s).  Does not cross lines.
See `shell-command-regexp'."
  (interactive "p")
  (let ((limit (save-excursion (end-of-line nil) (point))))
660
    (if (re-search-forward (concat shell-command-regexp "\\([;&|][\t ]*\\)+")
661
			   limit 'move arg)
662
	(skip-syntax-backward " "))))
663 664 665 666 667 668 669


(defun shell-backward-command (&optional arg)
  "Move backward across ARG shell command(s).  Does not cross lines.
See `shell-command-regexp'."
  (interactive "p")
  (let ((limit (save-excursion (comint-bol nil) (point))))
670 671 672
    (if (> limit (point))
	(save-excursion (beginning-of-line) (setq limit (point))))
    (skip-syntax-backward " " limit)
673
    (if (re-search-backward
674
	 (format "[;&|]+[\t ]*\\(%s\\)" shell-command-regexp) limit 'move arg)
675
	(progn (goto-char (match-beginning 1))
676
	       (skip-chars-forward ";&|")))))
677 678 679 680 681 682 683 684 685 686


(defun shell-dynamic-complete-command ()
  "Dynamically complete the command at point.
This function is similar to `comint-dynamic-complete-filename', except that it
searches `exec-path' (minus the trailing emacs library path) for completion
candidates.  Note that this may not be the same as the shell's idea of the
path.

Completion is dependent on the value of `shell-completion-execonly', plus
687 688 689
those that effect file completion.  See `shell-dynamic-complete-as-command'.

Returns t if successful."
690
  (interactive)
691 692 693 694 695 696 697 698 699 700 701 702
  (let ((filename (comint-match-partial-filename)))
    (if (and filename
	     (save-match-data (not (string-match "[~/]" filename)))
	     (eq (match-beginning 0)
		 (save-excursion (shell-backward-command 1) (point))))
	(prog2 (message "Completing command name...")
	    (shell-dynamic-complete-as-command)))))


(defun shell-dynamic-complete-as-command ()
  "Dynamically complete at point as a command.
See `shell-dynamic-complete-filename'.  Returns t if successful."
703
  (let* ((filename (or (comint-match-partial-filename) ""))
704 705 706 707
	 (pathnondir (file-name-nondirectory filename))
	 (paths (cdr (reverse exec-path)))
	 (cwd (file-name-as-directory (expand-file-name default-directory)))
	 (ignored-extensions
708 709 710
	  (and comint-completion-fignore
	       (mapconcat (function (lambda (x) (concat (regexp-quote x) "$")))
			  comint-completion-fignore "\\|")))
711 712 713 714 715 716 717 718 719 720 721
	 (path "") (comps-in-path ()) (file "") (filepath "") (completions ()))
    ;; Go thru each path in the search path, finding completions.
    (while paths
      (setq path (file-name-as-directory (comint-directory (or (car paths) ".")))
	    comps-in-path (and (file-accessible-directory-p path)
			       (file-name-all-completions pathnondir path)))
      ;; Go thru each completion found, to see whether it should be used.
      (while comps-in-path
	(setq file (car comps-in-path)
	      filepath (concat path file))
	(if (and (not (member file completions))
722 723
		 (not (and ignored-extensions
			   (string-match ignored-extensions file)))
724 725 726 727 728 729 730 731
		 (or (string-equal path cwd)
		     (not (file-directory-p filepath)))
		 (or (null shell-completion-execonly)
		     (file-executable-p filepath)))
	    (setq completions (cons file completions)))
	(setq comps-in-path (cdr comps-in-path)))
      (setq paths (cdr paths)))
    ;; OK, we've got a list of completions.
732 733 734 735 736 737
    (let ((success (let ((comint-completion-addsuffix nil))
		     (comint-dynamic-simple-complete pathnondir completions))))
      (if (and (memq success '(sole shortest)) comint-completion-addsuffix
	       (not (file-directory-p (comint-match-partial-filename))))
	  (insert " "))
      success)))
738 739 740 741 742 743 744 745 746 747 748 749 750


(defun shell-match-partial-variable ()
  "Return the variable at point, or nil if non is found."
  (save-excursion
    (let ((limit (point)))
      (if (re-search-backward "[^A-Za-z0-9_{}]" nil 'move)
	  (or (looking-at "\\$") (forward-char 1)))
      ;; Anchor the search forwards.
      (if (or (eolp) (looking-at "[^A-Za-z0-9_{}$]"))
	  nil
	(re-search-forward "\\$?{?[A-Za-z0-9_]*}?" limit)
	(buffer-substring (match-beginning 0) (match-end 0))))))
Jim Blandy's avatar
Jim Blandy committed
751

752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825

(defun shell-dynamic-complete-environment-variable ()
  "Dynamically complete the environment variable at point.
Completes if after a variable, i.e., if it starts with a \"$\".
See `shell-dynamic-complete-as-environment-variable'.

This function is similar to `comint-dynamic-complete-filename', except that it
searches `process-environment' for completion candidates.  Note that this may
not be the same as the interpreter's idea of variable names.  The main problem
with this type of completion is that `process-environment' is the environment
which Emacs started with.  Emacs does not track changes to the environment made
by the interpreter.  Perhaps it would be more accurate if this function was
called `shell-dynamic-complete-process-environment-variable'.

Returns non-nil if successful."
  (interactive)
  (let ((variable (shell-match-partial-variable)))
    (if (and variable (string-match "^\\$" variable))
	(prog2 (message "Completing variable name...")
	    (shell-dynamic-complete-as-environment-variable)))))


(defun shell-dynamic-complete-as-environment-variable ()
  "Dynamically complete at point as an environment variable.
Used by `shell-dynamic-complete-environment-variable'.
Uses `comint-dynamic-simple-complete'."
  (let* ((var (or (shell-match-partial-variable) ""))
	 (variable (substring var (or (string-match "[^$({]\\|$" var) 0)))
	 (variables (mapcar (function (lambda (x)
					(substring x 0 (string-match "=" x))))
			    process-environment))
	 (addsuffix comint-completion-addsuffix)
	 (comint-completion-addsuffix nil)
	 (success (comint-dynamic-simple-complete variable variables)))
    (if (memq success '(sole shortest))
	(let* ((var (shell-match-partial-variable))
	       (variable (substring var (string-match "[^$({]" var)))
	       (protection (cond ((string-match "{" var) "}")
				 ((string-match "(" var) ")")
				 (t "")))
	       (suffix (cond ((null addsuffix) "")
			     ((file-directory-p
			       (comint-directory (getenv variable))) "/")
			     (t " "))))
	  (insert protection suffix)))
    success))


(defun shell-replace-by-expanded-directory ()
  "Expand directory stack reference before point.
Directory stack references are of the form \"=digit\" or \"=-\".
See `default-directory' and `shell-dirstack'.

Returns t if successful."
  (interactive)
  (if (comint-match-partial-filename)
      (save-excursion
	(goto-char (match-beginning 0))
	(let ((stack (cons default-directory shell-dirstack))
	      (index (cond ((looking-at "=-/?")
			    (length shell-dirstack))
			   ((looking-at "=\\([0-9]+\\)")
			    (string-to-number
			     (buffer-substring
			      (match-beginning 1) (match-end 1)))))))
	  (cond ((null index)
		 nil)
		((>= index (length stack))
		 (error "Directory stack not that deep."))
		(t
		 (replace-match (file-name-as-directory (nth index stack)) t t)
		 (message "Directory item: %d" index)
		 t))))))

Eric S. Raymond's avatar
Eric S. Raymond committed
826 827 828
(provide 'shell)

;;; shell.el ends here