1 ;;; shell.el --- specialized comint.el for running the shell
3 ;; Copyright (C) 1988, 1993, 1994, 1995, 1996, 1997, 2000, 2001,
4 ;; 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
7 ;; Simon Marshall <simon@gnu.org>
8 ;; Maintainer: FSF <emacs-devel@gnu.org>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; This file defines a shell-in-a-buffer package (shell mode) built on
29 ;; top of comint mode. This is actually cmushell with things renamed
30 ;; to replace its counterpart in Emacs 18. cmushell is more
31 ;; featureful, robust, and uniform than the Emacs 18 version.
33 ;; Since this mode is built on top of the general command-interpreter-in-
34 ;; a-buffer mode (comint mode), it shares a common base functionality,
35 ;; and a common set of bindings, with all modes derived from comint mode.
36 ;; This makes these modes easier to use.
38 ;; For documentation on the functionality provided by comint mode, and
39 ;; the hooks available for customising it, see the file comint.el.
40 ;; For further information on shell mode, see the comments below.
43 ;; When sending text from a source file to a subprocess, the process-mark can
44 ;; move off the window, so you can lose sight of the process interactions.
45 ;; Maybe I should ensure the process mark is in the window when I send
46 ;; text to the process? Switch selectable?
49 ;;=============================================================================
50 ;; Some suggestions for your .emacs file.
52 ;; ;; Define M-# to run some strange command:
53 ;; (eval-after-load "shell"
54 ;; '(define-key shell-mode-map "\M-#" 'shells-dynamic-spell))
56 ;; Brief Command Documentation:
57 ;;============================================================================
58 ;; Comint Mode Commands: (common to shell and all comint-derived modes)
60 ;; m-p comint-previous-input Cycle backwards in input history
61 ;; m-n comint-next-input Cycle forwards
62 ;; m-r comint-previous-matching-input Previous input matching a regexp
63 ;; m-s comint-next-matching-input Next input that matches
64 ;; m-c-l comint-show-output Show last batch of process output
65 ;; return comint-send-input
66 ;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff.
67 ;; c-c c-a comint-bol Beginning of line; skip prompt
68 ;; c-c c-u comint-kill-input ^u
69 ;; c-c c-w backward-kill-word ^w
70 ;; c-c c-c comint-interrupt-subjob ^c
71 ;; c-c c-z comint-stop-subjob ^z
72 ;; c-c c-\ comint-quit-subjob ^\
73 ;; c-c c-o comint-kill-output Delete last batch of process output
74 ;; c-c c-r comint-show-output Show last batch of process output
75 ;; c-c c-l comint-dynamic-list-input-ring List input history
76 ;; send-invisible Read line w/o echo & send to proc
77 ;; comint-continue-subjob Useful if you accidentally suspend
79 ;; comint-mode-hook is the comint mode hook.
81 ;; Shell Mode Commands:
82 ;; shell Fires up the shell process
83 ;; tab comint-dynamic-complete Complete filename/command/history
84 ;; m-? comint-dynamic-list-filename-completions
85 ;; List completions in help buffer
86 ;; m-c-f shell-forward-command Forward a shell command
87 ;; m-c-b shell-backward-command Backward a shell command
88 ;; dirs Resync the buffer's dir stack
89 ;; shell-dirtrack-mode Turn dir tracking on/off
90 ;; comint-strip-ctrl-m Remove trailing ^Ms from output
92 ;; The shell mode hook is shell-mode-hook
93 ;; comint-prompt-regexp is initialised to shell-prompt-pattern, for backwards
96 ;; Read the rest of this file for more information.
102 ;;; Customization and Buffer Variables
105 "Running shell from within Emacs buffers."
109 (defgroup shell-directories nil
110 "Directory support in shell mode."
113 (defgroup shell-faces nil
114 "Faces in shell buffers."
118 (defcustom shell-dumb-shell-regexp
"cmd\\(proxy\\)?\\.exe"
119 "Regexp to match shells that don't save their command history, and
120 don't handle the backslash as a quote character. For shells that
121 match this regexp, Emacs will write out the command history when the
122 shell finishes, and won't remove backslashes when it unquotes shell
127 (defcustom shell-prompt-pattern
"^[^#$%>\n]*[#$%>] *"
128 "Regexp to match prompts in the inferior shell.
129 Defaults to \"^[^#$%>\\n]*[#$%>] *\", which works pretty well.
130 This variable is used to initialize `comint-prompt-regexp' in the
133 If `comint-use-prompt-regexp' is nil, then this variable is only used
134 to determine paragraph boundaries. See Info node `Shell Prompts' for
135 how Shell mode treats paragraphs.
137 The pattern should probably not match more than one line. If it does,
138 Shell mode may become confused trying to distinguish prompt from input
139 on lines which don't start with a prompt.
141 This is a fine thing to set in your `.emacs' file."
145 (defcustom shell-completion-fignore nil
146 "List of suffixes to be disregarded during file/command completion.
147 This variable is used to initialize `comint-completion-fignore' in the shell
148 buffer. The default is nil, for compatibility with most shells.
149 Some people like (\"~\" \"#\" \"%\").
151 This is a fine thing to set in your `.emacs' file."
152 :type
'(repeat (string :tag
"Suffix"))
155 (defvar shell-delimiter-argument-list
'(?\| ?
& ?
< ?
> ?\
( ?\
) ?\
;)
156 "List of characters to recognize as separate arguments.
157 This variable is used to initialize `comint-delimiter-argument-list' in the
158 shell buffer. The value may depend on the operating system or shell.
160 This is a fine thing to set in your `.emacs' file.")
162 (defvar shell-file-name-chars
163 (if (memq system-type
'(ms-dos windows-nt cygwin
))
164 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
165 "[]~/A-Za-z0-9+@:_.$#%,={}-")
166 "String of characters valid in a file name.
167 This variable is used to initialize `comint-file-name-chars' in the
168 shell buffer. The value may depend on the operating system or shell.
170 This is a fine thing to set in your `.emacs' file.")
172 (defvar shell-file-name-quote-list
173 (if (memq system-type
'(ms-dos windows-nt
))
175 (append shell-delimiter-argument-list
'(?\s ?$ ?\
* ?\
! ?
\" ?
\' ?\
` ?\
# ?
\\)))
176 "List of characters to quote when in a file name.
177 This variable is used to initialize `comint-file-name-quote-list' in the
178 shell buffer. The value may depend on the operating system or shell.
180 This is a fine thing to set in your `.emacs' file.")
182 (defvar shell-dynamic-complete-functions
183 '(comint-replace-by-expanded-history
184 shell-dynamic-complete-environment-variable
185 shell-dynamic-complete-command
186 shell-replace-by-expanded-directory
187 shell-dynamic-complete-filename
188 comint-dynamic-complete-filename
)
189 "List of functions called to perform completion.
190 This variable is used to initialize `comint-dynamic-complete-functions' in the
193 This is a fine thing to set in your `.emacs' file.")
195 (defcustom shell-command-regexp
"[^;&|\n]+"
196 "Regexp to match a single command within a pipeline.
197 This is used for directory tracking and does not do a perfect job."
201 (defcustom shell-command-separator-regexp
"[;&|\n \t]*"
202 "Regexp to match a single command within a pipeline.
203 This is used for directory tracking and does not do a perfect job."
207 (defcustom shell-completion-execonly t
208 "If non-nil, use executable files only for completion candidates.
209 This mirrors the optional behavior of tcsh.
211 Detecting executability of files may slow command completion considerably."
215 (defcustom shell-popd-regexp
"popd"
216 "Regexp to match subshell commands equivalent to popd."
218 :group
'shell-directories
)
220 (defcustom shell-pushd-regexp
"pushd"
221 "Regexp to match subshell commands equivalent to pushd."
223 :group
'shell-directories
)
225 (defcustom shell-pushd-tohome nil
226 "If non-nil, make pushd with no arg behave as \"pushd ~\" (like cd).
227 This mirrors the optional behavior of tcsh."
229 :group
'shell-directories
)
231 (defcustom shell-pushd-dextract nil
232 "If non-nil, make \"pushd +n\" pop the nth dir to the stack top.
233 This mirrors the optional behavior of tcsh."
235 :group
'shell-directories
)
237 (defcustom shell-pushd-dunique nil
238 "If non-nil, make pushd only add unique directories to the stack.
239 This mirrors the optional behavior of tcsh."
241 :group
'shell-directories
)
243 (defcustom shell-cd-regexp
"cd"
244 "Regexp to match subshell commands equivalent to cd."
246 :group
'shell-directories
)
248 (defcustom shell-chdrive-regexp
249 (if (memq system-type
'(ms-dos windows-nt
))
250 ; NetWare allows the five chars between upper and lower alphabetics.
251 "[]a-zA-Z^_`\\[\\\\]:"
253 "If non-nil, is regexp used to track drive changes."
254 :type
'(choice regexp
256 :group
'shell-directories
)
258 (defcustom shell-dirtrack-verbose t
259 "If non-nil, show the directory stack following directory change.
260 This is effective only if directory tracking is enabled.
261 The `dirtrack' package provides an alternative implementation of this feature -
262 see the function `dirtrack-mode'."
264 :group
'shell-directories
)
266 (defcustom explicit-shell-file-name nil
267 "If non-nil, is file name to use for explicitly requested inferior shell."
268 :type
'(choice (const :tag
"None" nil
) file
)
271 ;; Note: There are no explicit references to the variable `explicit-csh-args'.
272 ;; It is used implicitly by M-x shell when the shell is `csh'.
273 (defcustom explicit-csh-args
274 (if (eq system-type
'hpux
)
275 ;; -T persuades HP's csh not to think it is smarter
276 ;; than us about what terminal modes to use.
279 "Args passed to inferior shell by \\[shell], if the shell is csh.
280 Value is a list of strings, which may be nil."
281 :type
'(repeat (string :tag
"Argument"))
284 ;; Note: There are no explicit references to the variable `explicit-bash-args'.
285 ;; It is used implicitly by M-x shell when the interactive shell is `bash'.
286 (defcustom explicit-bash-args
287 (let* ((prog (or (and (boundp 'explicit-shell-file-name
) explicit-shell-file-name
)
288 (getenv "ESHELL") shell-file-name
))
289 (name (file-name-nondirectory prog
)))
290 ;; Tell bash not to use readline, except for bash 1.x which
291 ;; doesn't grook --noediting. Bash 1.x has -nolineediting, but
292 ;; process-send-eof cannot terminate bash if we use it.
293 (if (and (not purify-flag
)
295 (file-executable-p prog
)
296 (string-match "bad option"
297 (shell-command-to-string
298 (concat (shell-quote-argument prog
)
301 '("--noediting" "-i")))
302 "Args passed to inferior shell by \\[shell], if the shell is bash.
303 Value is a list of strings, which may be nil."
304 :type
'(repeat (string :tag
"Argument"))
307 (defcustom shell-input-autoexpand
'history
308 "If non-nil, expand input command history references on completion.
309 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
311 If the value is `input', then the expansion is seen on input.
312 If the value is `history', then the expansion is only when inserting
313 into the buffer's input ring. See also `comint-magic-space' and
314 `comint-dynamic-complete'.
316 This variable supplies a default for `comint-input-autoexpand',
317 for Shell mode only."
318 :type
'(choice (const :tag
"off" nil
)
324 (defvar shell-dirstack nil
325 "List of directories saved by pushd in this buffer's shell.
326 Thus, this does not include the shell's current directory.")
328 (defvar shell-dirtrackp t
329 "Non-nil in a shell buffer means directory tracking is enabled.")
331 (defvar shell-last-dir nil
332 "Keep track of last directory for ksh `cd -' command.")
334 (defvar shell-dirstack-query nil
335 "Command used by `shell-resync-dirs' to query the shell.")
337 (defvar shell-mode-map nil
)
338 (cond ((not shell-mode-map
)
339 (setq shell-mode-map
(nconc (make-sparse-keymap) comint-mode-map
))
340 (define-key shell-mode-map
"\C-c\C-f" 'shell-forward-command
)
341 (define-key shell-mode-map
"\C-c\C-b" 'shell-backward-command
)
342 (define-key shell-mode-map
"\t" 'comint-dynamic-complete
)
343 (define-key shell-mode-map
"\M-?"
344 'comint-dynamic-list-filename-completions
)
345 (define-key shell-mode-map
[menu-bar completion
]
347 (copy-keymap (lookup-key comint-mode-map
[menu-bar completion
]))))
348 (define-key-after (lookup-key shell-mode-map
[menu-bar completion
])
349 [complete-env-variable
] '("Complete Env. Variable Name" .
350 shell-dynamic-complete-environment-variable
)
352 (define-key-after (lookup-key shell-mode-map
[menu-bar completion
])
353 [expand-directory
] '("Expand Directory Reference" .
354 shell-replace-by-expanded-directory
)
357 (defcustom shell-mode-hook
'()
358 "Hook for customizing Shell mode."
362 (defvar shell-font-lock-keywords
363 '(("[ \t]\\([+-][^ \t\n]+\\)" 1 font-lock-comment-face
)
364 ("^[^ \t\n]+:.*" . font-lock-string-face
)
365 ("^\\[[1-9][0-9]*\\]" . font-lock-string-face
))
366 "Additional expressions to highlight in Shell mode.")
370 (put 'shell-mode
'mode-class
'special
)
372 (define-derived-mode shell-mode comint-mode
"Shell"
373 "Major mode for interacting with an inferior shell.\\<shell-mode-map>
374 \\[comint-send-input] after the end of the process' output sends the text from
375 the end of process to the end of the current line.
376 \\[comint-send-input] before end of process output copies the current line minus the prompt to
377 the end of the buffer and sends it (\\[comint-copy-old-input] just copies the current line).
378 \\[send-invisible] reads a line of text without echoing it, and sends it to
379 the shell. This is useful for entering passwords. Or, add the function
380 `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
382 If you want to make multiple shell buffers, rename the `*shell*' buffer
383 using \\[rename-buffer] or \\[rename-uniquely] and start a new shell.
385 If you want to make shell buffers limited in length, add the function
386 `comint-truncate-buffer' to `comint-output-filter-functions'.
388 If you accidentally suspend your process, use \\[comint-continue-subjob]
391 `cd', `pushd' and `popd' commands given to the shell are watched by Emacs to
392 keep this buffer's default directory the same as the shell's working directory.
393 While directory tracking is enabled, the shell's working directory is displayed
394 by \\[list-buffers] or \\[mouse-buffer-menu] in the `File' field.
395 \\[dirs] queries the shell and resyncs Emacs' idea of what the current
397 \\[shell-dirtrack-mode] turns directory tracking on and off.
398 \(The `dirtrack' package provides an alternative implementation of this
399 feature - see the function `dirtrack-mode'.)
402 Customization: Entry to this mode runs the hooks on `comint-mode-hook' and
403 `shell-mode-hook' (in that order). Before each input, the hooks on
404 `comint-input-filter-functions' are run. After each shell output, the hooks
405 on `comint-output-filter-functions' are run.
407 Variables `shell-cd-regexp', `shell-chdrive-regexp', `shell-pushd-regexp'
408 and `shell-popd-regexp' are used to match their respective commands,
409 while `shell-pushd-tohome', `shell-pushd-dextract' and `shell-pushd-dunique'
410 control the behavior of the relevant command.
412 Variables `comint-completion-autolist', `comint-completion-addsuffix',
413 `comint-completion-recexact' and `comint-completion-fignore' control the
414 behavior of file name, command name and variable name completion. Variable
415 `shell-completion-execonly' controls the behavior of command name completion.
416 Variable `shell-completion-fignore' is used to initialize the value of
417 `comint-completion-fignore'.
419 Variables `comint-input-ring-file-name' and `comint-input-autoexpand' control
420 the initialization of the input ring history, and history expansion.
422 Variables `comint-output-filter-functions', a hook, and
423 `comint-scroll-to-bottom-on-input' and `comint-scroll-to-bottom-on-output'
424 control whether input and output cause the window to scroll to the end of the
426 (setq comint-prompt-regexp shell-prompt-pattern
)
427 (setq comint-completion-fignore shell-completion-fignore
)
428 (setq comint-delimiter-argument-list shell-delimiter-argument-list
)
429 (setq comint-file-name-chars shell-file-name-chars
)
430 (setq comint-file-name-quote-list shell-file-name-quote-list
)
431 (set (make-local-variable 'comint-dynamic-complete-functions
)
432 shell-dynamic-complete-functions
)
433 (set (make-local-variable 'paragraph-separate
) "\\'")
434 (make-local-variable 'paragraph-start
)
435 (setq paragraph-start comint-prompt-regexp
)
436 (make-local-variable 'font-lock-defaults
)
437 (setq font-lock-defaults
'(shell-font-lock-keywords t
))
438 (make-local-variable 'shell-dirstack
)
439 (setq shell-dirstack nil
)
440 (make-local-variable 'shell-last-dir
)
441 (setq shell-last-dir nil
)
442 (setq comint-input-autoexpand shell-input-autoexpand
)
443 ;; This is not really correct, since the shell buffer does not really
444 ;; edit this directory. But it is useful in the buffer list and menus.
445 (make-local-variable 'list-buffers-directory
)
446 (shell-dirtrack-mode 1)
447 (setq list-buffers-directory
(expand-file-name default-directory
))
448 ;; shell-dependent assignments.
449 (when (ring-empty-p comint-input-ring
)
450 (let ((shell (file-name-nondirectory (car
451 (process-command (get-buffer-process (current-buffer)))))))
452 (setq comint-input-ring-file-name
453 (or (getenv "HISTFILE")
454 (cond ((string-equal shell
"bash") "~/.bash_history")
455 ((string-equal shell
"ksh") "~/.sh_history")
457 (if (or (equal comint-input-ring-file-name
"")
458 (equal (file-truename comint-input-ring-file-name
)
459 (file-truename "/dev/null")))
460 (setq comint-input-ring-file-name nil
))
461 ;; Arrange to write out the input ring on exit, if the shell doesn't
463 (if (and comint-input-ring-file-name
464 (string-match shell-dumb-shell-regexp shell
))
465 (set-process-sentinel (get-buffer-process (current-buffer))
466 #'shell-write-history-on-exit
))
467 (setq shell-dirstack-query
468 (cond ((string-equal shell
"sh") "pwd")
469 ((string-equal shell
"ksh") "echo $PWD ~-")
471 ;; Bypass a bug in certain versions of bash.
472 (when (string-equal shell
"bash")
473 (add-hook 'comint-output-filter-functions
474 'shell-filter-ctrl-a-ctrl-b nil t
)))
475 (comint-read-input-ring t
)))
477 (defun shell-filter-ctrl-a-ctrl-b (string)
478 "Remove `^A' and `^B' characters from comint output.
480 Bash uses these characters as internal quoting characters in its
481 prompt. Due to a bug in some bash versions (including 2.03,
482 2.04, and 2.05b), they may erroneously show up when bash is
483 started with the `--noediting' option and Select Graphic
484 Rendition (SGR) control sequences (formerly known as ANSI escape
485 sequences) are used to color the prompt.
487 This function can be put on `comint-output-filter-functions'.
488 The argument STRING is ignored."
489 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
491 (goto-char (or (and (markerp comint-last-output-start
)
492 (marker-position comint-last-output-start
))
494 (while (re-search-forward "[\C-a\C-b]" pmark t
)
495 (replace-match "")))))
497 (defun shell-write-history-on-exit (process event
)
498 "Called when the shell process is stopped.
500 Writes the input history to a history file
501 `comint-input-ring-file-name' using `comint-write-input-ring'
502 and inserts a short message in the shell buffer.
504 This function is a sentinel watching the shell interpreter process.
505 Sentinels will always get the two parameters PROCESS and EVENT."
507 (comint-write-input-ring)
508 (let ((buf (process-buffer process
)))
509 (when (buffer-live-p buf
)
510 (with-current-buffer buf
511 (insert (format "\nProcess %s %s\n" process event
))))))
514 (defun shell (&optional buffer
)
515 "Run an inferior shell, with I/O through BUFFER (which defaults to `*shell*').
516 Interactively, a prefix arg means to prompt for BUFFER.
517 If `default-directory' is a remote file name, it is also prompted
518 to change if called with a prefix arg.
520 If BUFFER exists but shell process is not running, make new shell.
521 If BUFFER exists and shell process is running, just switch to BUFFER.
522 Program used comes from variable `explicit-shell-file-name',
523 or (if that is nil) from the ESHELL environment variable,
524 or (if that is nil) from `shell-file-name'.
525 If a file `~/.emacs_SHELLNAME' exists, or `~/.emacs.d/init_SHELLNAME.sh',
526 it is given as initial input (but this may be lost, due to a timing
527 error, if the shell discards input when it starts up).
528 The buffer is put in Shell mode, giving commands for sending input
529 and controlling the subjobs of the shell. See `shell-mode'.
530 See also the variable `shell-prompt-pattern'.
532 To specify a coding system for converting non-ASCII characters
533 in the input and output to the shell, use \\[universal-coding-system-argument]
534 before \\[shell]. You can also specify this with \\[set-buffer-process-coding-system]
535 in the shell buffer, after you start the shell.
536 The default comes from `process-coding-system-alist' and
537 `default-process-coding-system'.
539 The shell file name (sans directories) is used to make a symbol name
540 such as `explicit-csh-args'. If that symbol is a variable,
541 its value is used as a list of arguments when invoking the shell.
542 Otherwise, one argument `-i' is passed to the shell.
544 \(Type \\[describe-mode] in the shell buffer for a list of commands.)"
547 (and current-prefix-arg
549 (read-buffer "Shell buffer: "
550 (generate-new-buffer-name "*shell*"))
551 (if (file-remote-p default-directory
)
552 ;; It must be possible to declare a local default-directory.
553 (setq default-directory
556 "Default directory: " default-directory default-directory
557 t nil
'file-directory-p
))))))))
558 (setq buffer
(get-buffer-create (or buffer
"*shell*")))
559 ;; Pop to buffer, so that the buffer's window will be correctly set
560 ;; when we call comint (so that comint sets the COLUMNS env var properly).
561 (pop-to-buffer buffer
)
562 (unless (comint-check-proc buffer
)
563 (let* ((prog (or explicit-shell-file-name
564 (getenv "ESHELL") shell-file-name
))
565 (name (file-name-nondirectory prog
))
566 (startfile (concat "~/.emacs_" name
))
567 (xargs-name (intern-soft (concat "explicit-" name
"-args"))))
568 (unless (file-exists-p startfile
)
569 (setq startfile
(concat user-emacs-directory
"init_" name
".sh")))
570 (apply 'make-comint-in-buffer
"shell" buffer prog
571 (if (file-exists-p startfile
) startfile
)
572 (if (and xargs-name
(boundp xargs-name
))
573 (symbol-value xargs-name
)
578 ;; Don't do this when shell.el is loaded, only while dumping.
579 ;;;###autoload (add-hook 'same-window-buffer-names "*shell*")
581 ;;; Directory tracking
583 ;; This code provides the shell mode input sentinel
584 ;; SHELL-DIRECTORY-TRACKER
585 ;; that tracks cd, pushd, and popd commands issued to the shell, and
586 ;; changes the current directory of the shell buffer accordingly.
588 ;; This is basically a fragile hack, although it's more accurate than
589 ;; the version in Emacs 18's shell.el. It has the following failings:
590 ;; 1. It doesn't know about the cdpath shell variable.
591 ;; 2. It cannot infallibly deal with command sequences, though it does well
592 ;; with these and with ignoring commands forked in another shell with ()s.
593 ;; 3. More generally, any complex command is going to throw it. Otherwise,
594 ;; you'd have to build an entire shell interpreter in Emacs Lisp. Failing
595 ;; that, there's no way to catch shell commands where cd's are buried
596 ;; inside conditional expressions, aliases, and so forth.
598 ;; The whole approach is a crock. Shell aliases mess it up. File sourcing
599 ;; messes it up. You run other processes under the shell; these each have
600 ;; separate working directories, and some have commands for manipulating
601 ;; their w.d.'s (e.g., the lcd command in ftp). Some of these programs have
602 ;; commands that do *not* affect the current w.d. at all, but look like they
603 ;; do (e.g., the cd command in ftp). In shells that allow you job
604 ;; control, you can switch between jobs, all having different w.d.'s. So
605 ;; simply saying %3 can shift your w.d..
607 ;; The solution is to relax, not stress out about it, and settle for
608 ;; a hack that works pretty well in typical circumstances. Remember
609 ;; that a half-assed solution is more in keeping with the spirit of Unix,
612 ;; One good hack not implemented here for users of programmable shells
613 ;; is to program up the shell w.d. manipulation commands to output
614 ;; a coded command sequence to the tty. Something like
616 ;; where <cwd> is the new current working directory. Then trash the
617 ;; directory tracking machinery currently used in this package, and
618 ;; replace it with a process filter that watches for and strips out
621 (defun shell-directory-tracker (str)
622 "Tracks cd, pushd and popd commands issued to the shell.
623 This function is called on each input passed to the shell.
624 It watches for cd, pushd and popd commands and sets the buffer's
625 default directory to track these commands.
627 You may toggle this tracking on and off with \\[shell-dirtrack-mode].
628 If Emacs gets confused, you can resync with the shell with \\[dirs].
629 \(The `dirtrack' package provides an alternative implementation of this
630 feature - see the function `dirtrack-mode'.)
632 See variables `shell-cd-regexp', `shell-chdrive-regexp', `shell-pushd-regexp',
633 and `shell-popd-regexp', while `shell-pushd-tohome', `shell-pushd-dextract',
634 and `shell-pushd-dunique' control the behavior of the relevant command.
636 Environment variables are expanded, see function `substitute-in-file-name'."
638 ;; We fail gracefully if we think the command will fail in the shell.
639 (condition-case chdir-failure
640 (let ((start (progn (string-match
641 (concat "^" shell-command-separator-regexp
)
642 str
) ; skip whitespace
645 (while (string-match shell-command-regexp str start
)
646 (setq end
(match-end 0)
647 cmd
(comint-arguments (substring str start end
) 0 0)
648 arg1
(comint-arguments (substring str start end
) 1 1))
650 (setq arg1
(shell-unquote-argument arg1
)))
651 (cond ((string-match (concat "\\`\\(" shell-popd-regexp
652 "\\)\\($\\|[ \t]\\)")
654 (shell-process-popd (comint-substitute-in-file-name arg1
)))
655 ((string-match (concat "\\`\\(" shell-pushd-regexp
656 "\\)\\($\\|[ \t]\\)")
658 (shell-process-pushd (comint-substitute-in-file-name arg1
)))
659 ((string-match (concat "\\`\\(" shell-cd-regexp
660 "\\)\\($\\|[ \t]\\)")
662 (shell-process-cd (comint-substitute-in-file-name arg1
)))
663 ((and shell-chdrive-regexp
664 (string-match (concat "\\`\\(" shell-chdrive-regexp
665 "\\)\\($\\|[ \t]\\)")
667 (shell-process-cd (comint-substitute-in-file-name cmd
))))
668 (setq start
(progn (string-match shell-command-separator-regexp
672 (error "Couldn't cd"))))
674 (defun shell-unquote-argument (string)
675 "Remove all kinds of shell quoting from STRING."
677 (let ((idx 0) next inside
679 (if (string-match shell-dumb-shell-regexp
680 (file-name-nondirectory
681 (car (process-command (get-buffer-process (current-buffer))))))
684 (while (and (< idx
(length string
))
685 (setq next
(string-match quote-chars string next
)))
686 (cond ((= (aref string next
) ?
\\)
687 (setq string
(replace-match "" nil nil string
))
688 (setq next
(1+ next
)))
689 ((and inside
(= (aref string next
) inside
))
690 (setq string
(replace-match "" nil nil string
))
693 (setq next
(1+ next
)))
695 (setq inside
(aref string next
))
696 (setq string
(replace-match "" nil nil string
)))))
700 (defun shell-process-popd (arg)
701 (let ((num (or (shell-extract-num arg
) 0)))
702 (cond ((and num
(= num
0) shell-dirstack
)
703 (shell-cd (car shell-dirstack
))
704 (setq shell-dirstack
(cdr shell-dirstack
))
705 (shell-dirstack-message))
706 ((and num
(> num
0) (<= num
(length shell-dirstack
)))
707 (let* ((ds (cons nil shell-dirstack
))
708 (cell (nthcdr (1- num
) ds
)))
709 (rplacd cell
(cdr (cdr cell
)))
710 (setq shell-dirstack
(cdr ds
))
711 (shell-dirstack-message)))
713 (error "Couldn't popd")))))
715 ;; Return DIR prefixed with comint-file-name-prefix as appropriate.
716 (defun shell-prefixed-directory-name (dir)
717 (if (= (length comint-file-name-prefix
) 0)
719 (if (file-name-absolute-p dir
)
720 ;; The name is absolute, so prepend the prefix.
721 (concat comint-file-name-prefix dir
)
722 ;; For relative name we assume default-directory already has the prefix.
723 (expand-file-name dir
))))
726 (defun shell-process-cd (arg)
727 (let ((new-dir (cond ((zerop (length arg
)) (concat comint-file-name-prefix
729 ((string-equal "-" arg
) shell-last-dir
)
730 (t (shell-prefixed-directory-name arg
)))))
731 (setq shell-last-dir default-directory
)
733 (shell-dirstack-message)))
736 (defun shell-process-pushd (arg)
737 (let ((num (shell-extract-num arg
)))
738 (cond ((zerop (length arg
))
739 ;; no arg -- swap pwd and car of stack unless shell-pushd-tohome
740 (cond (shell-pushd-tohome
741 (shell-process-pushd (concat comint-file-name-prefix
"~")))
743 (let ((old default-directory
))
744 (shell-cd (car shell-dirstack
))
745 (setq shell-dirstack
(cons old
(cdr shell-dirstack
)))
746 (shell-dirstack-message)))
748 (message "Directory stack empty."))))
751 (cond ((> num
(length shell-dirstack
))
752 (message "Directory stack not that deep."))
754 (error (message "Couldn't cd")))
755 (shell-pushd-dextract
756 (let ((dir (nth (1- num
) shell-dirstack
)))
757 (shell-process-popd arg
)
758 (shell-process-pushd default-directory
)
760 (shell-dirstack-message)))
762 (let* ((ds (cons default-directory shell-dirstack
))
764 (front (nthcdr num ds
))
765 (back (reverse (nthcdr (- dslen num
) (reverse ds
))))
766 (new-ds (append front back
)))
767 (shell-cd (car new-ds
))
768 (setq shell-dirstack
(cdr new-ds
))
769 (shell-dirstack-message)))))
772 (let ((old-wd default-directory
))
773 (shell-cd (shell-prefixed-directory-name arg
))
774 (if (or (null shell-pushd-dunique
)
775 (not (member old-wd shell-dirstack
)))
776 (setq shell-dirstack
(cons old-wd shell-dirstack
)))
777 (shell-dirstack-message))))))
779 ;; If STR is of the form +n, for n>0, return n. Otherwise, nil.
780 (defun shell-extract-num (str)
781 (and (string-match "^\\+[1-9][0-9]*$" str
)
782 (string-to-number str
)))
784 (defvaralias 'shell-dirtrack-mode
'shell-dirtrackp
)
785 (define-minor-mode shell-dirtrack-mode
786 "Turn directory tracking on and off in a shell buffer.
787 The `dirtrack' package provides an alternative implementation of this
788 feature - see the function `dirtrack-mode'."
790 (setq list-buffers-directory
(if shell-dirtrack-mode default-directory
))
791 (if shell-dirtrack-mode
792 (add-hook 'comint-input-filter-functions
'shell-directory-tracker nil t
)
793 (remove-hook 'comint-input-filter-functions
'shell-directory-tracker t
)))
795 (define-obsolete-function-alias 'shell-dirtrack-toggle
'shell-dirtrack-mode
798 (defun shell-cd (dir)
799 "Do normal `cd' to DIR, and set `list-buffers-directory'."
802 (setq list-buffers-directory default-directory
)))
804 (defun shell-resync-dirs ()
805 "Resync the buffer's idea of the current directory stack.
806 This command queries the shell with the command bound to
807 `shell-dirstack-query' (default \"dirs\"), reads the next
808 line output and parses it to form the new directory stack.
809 DON'T issue this command unless the buffer is at a shell prompt.
810 Also, note that if some other subprocess decides to do output
811 immediately after the query, its output will be taken as the
812 new directory stack -- you lose. If this happens, just do the
815 (let* ((proc (get-buffer-process (current-buffer)))
816 (pmark (process-mark proc
))
817 (started-at-pmark (= (point) (marker-position pmark
))))
820 ;; If the process echoes commands, don't insert a fake command in
821 ;; the buffer or it will appear twice.
822 (unless comint-process-echoes
823 (insert shell-dirstack-query
) (insert "\n"))
824 (sit-for 0) ; force redisplay
825 (comint-send-string proc shell-dirstack-query
)
826 (comint-send-string proc
"\n")
827 (set-marker pmark
(point))
831 (if comint-process-echoes
832 ;; Skip command echo if the process echoes
833 (concat "\\(" (regexp-quote shell-dirstack-query
) "\n\\)")
836 ;; This extra newline prevents the user's pending input from spoofing us.
837 (insert "\n") (backward-char 1)
838 ;; Wait for one line.
839 (while (not (looking-at regexp
))
840 (accept-process-output proc
)
842 (goto-char pmark
) (delete-char 1) ; remove the extra newline
843 ;; That's the dirlist. grab it & parse it.
844 (let* ((dl (buffer-substring (match-beginning 2) (1- (match-end 2))))
846 (ds '()) ; new dir stack
849 ;; regexp = optional whitespace, (non-whitespace), optional whitespace
850 (string-match "\\s *\\(\\S +\\)\\s *" dl i
) ; pick off next dir
851 (setq ds
(cons (concat comint-file-name-prefix
852 (substring dl
(match-beginning 1)
855 (setq i
(match-end 0)))
856 (let ((ds (nreverse ds
)))
858 (progn (shell-cd (car ds
))
859 (setq shell-dirstack
(cdr ds
)
860 shell-last-dir
(car shell-dirstack
))
861 (shell-dirstack-message))
862 (error (message "Couldn't cd"))))))
863 (if started-at-pmark
(goto-char (marker-position pmark
)))))
865 ;; For your typing convenience:
866 (defalias 'dirs
'shell-resync-dirs
)
869 ;; Show the current dirstack on the message line.
870 ;; Pretty up dirs a bit by changing "/usr/jqr/foo" to "~/foo".
871 ;; (This isn't necessary if the dirlisting is generated with a simple "dirs".)
872 ;; All the commands that mung the buffer's dirstack finish by calling
874 (defun shell-dirstack-message ()
875 (when shell-dirtrack-verbose
877 (ds (cons default-directory shell-dirstack
))
878 (home (expand-file-name (concat comint-file-name-prefix
"~/")))
879 (homelen (length home
)))
881 (let ((dir (car ds
)))
882 (and (>= (length dir
) homelen
)
883 (string= home
(substring dir
0 homelen
))
884 (setq dir
(concat "~/" (substring dir homelen
))))
885 ;; Strip off comint-file-name-prefix if present.
886 (and comint-file-name-prefix
887 (>= (length dir
) (length comint-file-name-prefix
))
888 (string= comint-file-name-prefix
889 (substring dir
0 (length comint-file-name-prefix
)))
890 (setq dir
(substring dir
(length comint-file-name-prefix
)))
892 (setq msg
(concat msg
(directory-file-name dir
) " "))
894 (message "%s" msg
))))
896 ;; This was mostly copied from shell-resync-dirs.
897 (defun shell-snarf-envar (var)
898 "Return as a string the shell's value of environment variable VAR."
899 (let* ((cmd (format "printenv '%s'\n" var
))
900 (proc (get-buffer-process (current-buffer)))
901 (pmark (process-mark proc
)))
904 (sit-for 0) ; force redisplay
905 (comint-send-string proc cmd
)
906 (set-marker pmark
(point))
907 (let ((pt (point))) ; wait for 1 line
908 ;; This extra newline prevents the user's pending input from spoofing us.
909 (insert "\n") (backward-char 1)
910 (while (not (looking-at ".+\n"))
911 (accept-process-output proc
)
913 (goto-char pmark
) (delete-char 1) ; remove the extra newline
914 (buffer-substring (match-beginning 0) (1- (match-end 0)))))
916 (defun shell-copy-environment-variable (variable)
917 "Copy the environment variable VARIABLE from the subshell to Emacs.
918 This command reads the value of the specified environment variable
919 in the shell, and sets the same environment variable in Emacs
920 \(what `getenv' in Emacs would return) to that value.
921 That value will affect any new subprocesses that you subsequently start
923 (interactive (list (read-envvar-name "\
924 Copy Shell environment variable to Emacs: ")))
925 (setenv variable
(shell-snarf-envar variable
)))
927 (defun shell-forward-command (&optional arg
)
928 "Move forward across ARG shell command(s). Does not cross lines.
929 See `shell-command-regexp'."
931 (let ((limit (save-excursion (end-of-line nil
) (point))))
932 (if (re-search-forward (concat shell-command-regexp
"\\([;&|][\t ]*\\)+")
934 (skip-syntax-backward " "))))
937 (defun shell-backward-command (&optional arg
)
938 "Move backward across ARG shell command(s). Does not cross lines.
939 See `shell-command-regexp'."
941 (let ((limit (save-excursion (comint-bol nil
) (point))))
942 (when (> limit
(point))
943 (setq limit
(line-beginning-position)))
944 (skip-syntax-backward " " limit
)
945 (if (re-search-backward
946 (format "[;&|]+[\t ]*\\(%s\\)" shell-command-regexp
) limit
'move arg
)
947 (progn (goto-char (match-beginning 1))
948 (skip-chars-forward ";&|")))))
950 (defun shell-dynamic-complete-command ()
951 "Dynamically complete the command at point.
952 This function is similar to `comint-dynamic-complete-filename', except that it
953 searches `exec-path' (minus the trailing Emacs library path) for completion
954 candidates. Note that this may not be the same as the shell's idea of the
957 Completion is dependent on the value of `shell-completion-execonly', plus
958 those that effect file completion. See `shell-dynamic-complete-as-command'.
960 Returns t if successful."
962 (let ((filename (comint-match-partial-filename)))
964 (save-match-data (not (string-match "[~/]" filename
)))
965 (eq (match-beginning 0)
966 (save-excursion (shell-backward-command 1) (point))))
967 (prog2 (unless (window-minibuffer-p (selected-window))
968 (message "Completing command name..."))
969 (shell-dynamic-complete-as-command)))))
972 (defun shell-dynamic-complete-as-command ()
973 "Dynamically complete at point as a command.
974 See `shell-dynamic-complete-filename'. Returns t if successful."
975 (let* ((filename (or (comint-match-partial-filename) ""))
976 (filenondir (file-name-nondirectory filename
))
977 (path-dirs (cdr (reverse exec-path
)))
978 (cwd (file-name-as-directory (expand-file-name default-directory
)))
980 (and comint-completion-fignore
981 (mapconcat (function (lambda (x) (concat (regexp-quote x
) "$")))
982 comint-completion-fignore
"\\|")))
983 (dir "") (comps-in-dir ())
984 (file "") (abs-file-name "") (completions ()))
985 ;; Go thru each dir in the search path, finding completions.
987 (setq dir
(file-name-as-directory (comint-directory (or (car path-dirs
) ".")))
988 comps-in-dir
(and (file-accessible-directory-p dir
)
989 (file-name-all-completions filenondir dir
)))
990 ;; Go thru each completion found, to see whether it should be used.
992 (setq file
(car comps-in-dir
)
993 abs-file-name
(concat dir file
))
994 (if (and (not (member file completions
))
995 (not (and ignored-extensions
996 (string-match ignored-extensions file
)))
997 (or (string-equal dir cwd
)
998 (not (file-directory-p abs-file-name
)))
999 (or (null shell-completion-execonly
)
1000 (file-executable-p abs-file-name
)))
1001 (setq completions
(cons file completions
)))
1002 (setq comps-in-dir
(cdr comps-in-dir
)))
1003 (setq path-dirs
(cdr path-dirs
)))
1004 ;; OK, we've got a list of completions.
1005 (let ((success (let ((comint-completion-addsuffix nil
))
1006 (comint-dynamic-simple-complete filenondir completions
))))
1007 (if (and (memq success
'(sole shortest
)) comint-completion-addsuffix
1008 (not (file-directory-p (comint-match-partial-filename))))
1012 (defun shell-dynamic-complete-filename ()
1013 "Dynamically complete the filename at point.
1014 This completes only if point is at a suitable position for a
1017 (let ((opoint (point))
1018 (beg (comint-line-beginning-position)))
1019 (when (save-excursion
1020 (goto-char (if (re-search-backward "[;|&]" beg t
)
1023 (re-search-forward "[^ \t][ \t]" opoint t
))
1024 (comint-dynamic-complete-as-filename))))
1026 (defun shell-match-partial-variable ()
1027 "Return the shell variable at point, or nil if none is found."
1029 (let ((limit (point)))
1030 (if (re-search-backward "[^A-Za-z0-9_{}]" nil
'move
)
1031 (or (looking-at "\\$") (forward-char 1)))
1032 ;; Anchor the search forwards.
1033 (if (or (eolp) (looking-at "[^A-Za-z0-9_{}$]"))
1035 (re-search-forward "\\$?{?[A-Za-z0-9_]*}?" limit
)
1036 (buffer-substring (match-beginning 0) (match-end 0))))))
1038 (defun shell-dynamic-complete-environment-variable ()
1039 "Dynamically complete the environment variable at point.
1040 Completes if after a variable, i.e., if it starts with a \"$\".
1041 See `shell-dynamic-complete-as-environment-variable'.
1043 This function is similar to `comint-dynamic-complete-filename', except that it
1044 searches `process-environment' for completion candidates. Note that this may
1045 not be the same as the interpreter's idea of variable names. The main problem
1046 with this type of completion is that `process-environment' is the environment
1047 which Emacs started with. Emacs does not track changes to the environment made
1048 by the interpreter. Perhaps it would be more accurate if this function was
1049 called `shell-dynamic-complete-process-environment-variable'.
1051 Returns non-nil if successful."
1053 (let ((variable (shell-match-partial-variable)))
1054 (if (and variable
(string-match "^\\$" variable
))
1055 (prog2 (unless (window-minibuffer-p (selected-window))
1056 (message "Completing variable name..."))
1057 (shell-dynamic-complete-as-environment-variable)))))
1060 (defun shell-dynamic-complete-as-environment-variable ()
1061 "Dynamically complete at point as an environment variable.
1062 Used by `shell-dynamic-complete-environment-variable'.
1063 Uses `comint-dynamic-simple-complete'."
1064 (let* ((var (or (shell-match-partial-variable) ""))
1065 (variable (substring var
(or (string-match "[^$({]\\|$" var
) 0)))
1066 (variables (mapcar (function (lambda (x)
1067 (substring x
0 (string-match "=" x
))))
1068 process-environment
))
1069 (addsuffix comint-completion-addsuffix
)
1070 (comint-completion-addsuffix nil
)
1071 (success (comint-dynamic-simple-complete variable variables
)))
1072 (if (memq success
'(sole shortest
))
1073 (let* ((var (shell-match-partial-variable))
1074 (variable (substring var
(string-match "[^$({]" var
)))
1075 (protection (cond ((string-match "{" var
) "}")
1076 ((string-match "(" var
) ")")
1078 (suffix (cond ((null addsuffix
) "")
1080 (comint-directory (getenv variable
))) "/")
1082 (insert protection suffix
)))
1086 (defun shell-replace-by-expanded-directory ()
1087 "Expand directory stack reference before point.
1088 Directory stack references are of the form \"=digit\" or \"=-\".
1089 See `default-directory' and `shell-dirstack'.
1091 Returns t if successful."
1093 (if (comint-match-partial-filename)
1095 (goto-char (match-beginning 0))
1096 (let ((stack (cons default-directory shell-dirstack
))
1097 (index (cond ((looking-at "=-/?")
1098 (length shell-dirstack
))
1099 ((looking-at "=\\([0-9]+\\)/?")
1102 (match-beginning 1) (match-end 1)))))))
1105 ((>= index
(length stack
))
1106 (error "Directory stack not that deep"))
1108 (replace-match (file-name-as-directory (nth index stack
)) t t
)
1109 (message "Directory item: %d" index
)
1114 ;; arch-tag: bcb5f12a-c1f4-4aea-a809-2504bd5bd797
1115 ;;; shell.el ends here