1 ;;; shell.el --- specialized comint.el for running the shell -*- lexical-binding: t -*-
3 ;; Copyright (C) 1988, 1993-1997, 2000-2011 Free Software Foundation, Inc.
5 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
6 ;; Simon Marshall <simon@gnu.org>
7 ;; Maintainer: FSF <emacs-devel@gnu.org>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; This file defines a shell-in-a-buffer package (shell mode) built on
28 ;; top of comint mode. This is actually cmushell with things renamed
29 ;; to replace its counterpart in Emacs 18. cmushell is more
30 ;; featureful, robust, and uniform than the Emacs 18 version.
32 ;; Since this mode is built on top of the general command-interpreter-in-
33 ;; a-buffer mode (comint mode), it shares a common base functionality,
34 ;; and a common set of bindings, with all modes derived from comint mode.
35 ;; This makes these modes easier to use.
37 ;; For documentation on the functionality provided by comint mode, and
38 ;; the hooks available for customising it, see the file comint.el.
39 ;; For further information on shell mode, see the comments below.
42 ;; When sending text from a source file to a subprocess, the process-mark can
43 ;; move off the window, so you can lose sight of the process interactions.
44 ;; Maybe I should ensure the process mark is in the window when I send
45 ;; text to the process? Switch selectable?
48 ;;=============================================================================
49 ;; Some suggestions for your .emacs file.
51 ;; ;; Define M-# to run some strange command:
52 ;; (eval-after-load "shell"
53 ;; '(define-key shell-mode-map "\M-#" 'shells-dynamic-spell))
55 ;; Brief Command Documentation:
56 ;;============================================================================
57 ;; Comint Mode Commands: (common to shell and all comint-derived modes)
59 ;; m-p comint-previous-input Cycle backwards in input history
60 ;; m-n comint-next-input Cycle forwards
61 ;; m-r comint-previous-matching-input Previous input matching a regexp
62 ;; m-s comint-next-matching-input Next input that matches
63 ;; m-c-l comint-show-output Show last batch of process output
64 ;; return comint-send-input
65 ;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff.
66 ;; c-c c-a comint-bol Beginning of line; skip prompt
67 ;; c-c c-u comint-kill-input ^u
68 ;; c-c c-w backward-kill-word ^w
69 ;; c-c c-c comint-interrupt-subjob ^c
70 ;; c-c c-z comint-stop-subjob ^z
71 ;; c-c c-\ comint-quit-subjob ^\
72 ;; c-c c-o comint-delete-output Delete last batch of process output
73 ;; c-c c-r comint-show-output Show last batch of process output
74 ;; c-c c-l comint-dynamic-list-input-ring List input history
75 ;; send-invisible Read line w/o echo & send to proc
76 ;; comint-continue-subjob Useful if you accidentally suspend
78 ;; comint-mode-hook is the comint mode hook.
80 ;; Shell Mode Commands:
81 ;; shell Fires up the shell process
82 ;; tab completion-at-point Complete filename/command/history
83 ;; m-? comint-dynamic-list-filename-completions
84 ;; List completions in help buffer
85 ;; m-c-f shell-forward-command Forward a shell command
86 ;; m-c-b shell-backward-command Backward a shell command
87 ;; dirs Resync the buffer's dir stack
88 ;; shell-dirtrack-mode Turn dir tracking on/off
89 ;; comint-strip-ctrl-m Remove trailing ^Ms from output
91 ;; The shell mode hook is shell-mode-hook
92 ;; comint-prompt-regexp is initialised to shell-prompt-pattern, for backwards
95 ;; Read the rest of this file for more information.
99 (eval-when-compile (require 'cl
))
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
(purecopy "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 (defcustom shell-delimiter-argument-list nil
; '(?\| ?& ?< ?> ?\( ?\) ?\;)
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."
159 :type
'(choice (const nil
)
160 (repeat :tag
"List of characters" character
))
161 :version
"24.1" ; changed to nil (bug#8027)
164 (defvar shell-file-name-chars
165 (if (memq system-type
'(ms-dos windows-nt cygwin
))
166 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
167 "[]~/A-Za-z0-9+@:_.$#%,={}-")
168 "String of characters valid in a file name.
169 This variable is used to initialize `comint-file-name-chars' in the
170 shell buffer. The value may depend on the operating system or shell.
172 This is a fine thing to set in your `.emacs' file.")
174 (defvar shell-file-name-quote-list
175 (if (memq system-type
'(ms-dos windows-nt
))
177 (append shell-delimiter-argument-list
'(?\s ?$ ?\
* ?\
! ?
\" ?
\' ?\
` ?\
# ?
\\)))
178 "List of characters to quote when in a file name.
179 This variable is used to initialize `comint-file-name-quote-list' in the
180 shell buffer. The value may depend on the operating system or shell.
182 This is a fine thing to set in your `.emacs' file.")
184 (defvar shell-dynamic-complete-functions
185 '(comint-c-a-p-replace-by-expanded-history
186 shell-environment-variable-completion
187 shell-command-completion
188 shell-c-a-p-replace-by-expanded-directory
189 shell-filename-completion
190 comint-filename-completion
)
191 "List of functions called to perform completion.
192 This variable is used to initialize `comint-dynamic-complete-functions' in the
195 This is a fine thing to set in your `.emacs' file.")
197 (defcustom shell-command-regexp
"[^;&|\n]+"
198 "Regexp to match a single command within a pipeline.
199 This is used for directory tracking and does not do a perfect job."
203 (defcustom shell-command-separator-regexp
"[;&|\n \t]*"
204 "Regexp to match a single command within a pipeline.
205 This is used for directory tracking and does not do a perfect job."
209 (defcustom shell-completion-execonly t
210 "If non-nil, use executable files only for completion candidates.
211 This mirrors the optional behavior of tcsh.
213 Detecting executability of files may slow command completion considerably."
217 (defcustom shell-popd-regexp
"popd"
218 "Regexp to match subshell commands equivalent to popd."
220 :group
'shell-directories
)
222 (defcustom shell-pushd-regexp
"pushd"
223 "Regexp to match subshell commands equivalent to pushd."
225 :group
'shell-directories
)
227 (defcustom shell-pushd-tohome nil
228 "If non-nil, make pushd with no arg behave as \"pushd ~\" (like cd).
229 This mirrors the optional behavior of tcsh."
231 :group
'shell-directories
)
233 (defcustom shell-pushd-dextract nil
234 "If non-nil, make \"pushd +n\" pop the nth dir to the stack top.
235 This mirrors the optional behavior of tcsh."
237 :group
'shell-directories
)
239 (defcustom shell-pushd-dunique nil
240 "If non-nil, make pushd only add unique directories to the stack.
241 This mirrors the optional behavior of tcsh."
243 :group
'shell-directories
)
245 (defcustom shell-cd-regexp
"cd"
246 "Regexp to match subshell commands equivalent to cd."
248 :group
'shell-directories
)
250 (defcustom shell-chdrive-regexp
251 (if (memq system-type
'(ms-dos windows-nt
))
252 ; NetWare allows the five chars between upper and lower alphabetics.
253 "[]a-zA-Z^_`\\[\\\\]:"
255 "If non-nil, is regexp used to track drive changes."
256 :type
'(choice regexp
258 :group
'shell-directories
)
260 (defcustom shell-dirtrack-verbose t
261 "If non-nil, show the directory stack following directory change.
262 This is effective only if directory tracking is enabled.
263 The `dirtrack' package provides an alternative implementation of this feature -
264 see the function `dirtrack-mode'."
266 :group
'shell-directories
)
268 (defcustom explicit-shell-file-name nil
269 "If non-nil, is file name to use for explicitly requested inferior shell."
270 :type
'(choice (const :tag
"None" nil
) file
)
273 ;; Note: There are no explicit references to the variable `explicit-csh-args'.
274 ;; It is used implicitly by M-x shell when the shell is `csh'.
275 (defcustom explicit-csh-args
276 (if (eq system-type
'hpux
)
277 ;; -T persuades HP's csh not to think it is smarter
278 ;; than us about what terminal modes to use.
281 "Args passed to inferior shell by \\[shell], if the shell is csh.
282 Value is a list of strings, which may be nil."
283 :type
'(repeat (string :tag
"Argument"))
286 ;; Note: There are no explicit references to the variable `explicit-bash-args'.
287 ;; It is used implicitly by M-x shell when the interactive shell is `bash'.
288 (defcustom explicit-bash-args
289 (let* ((prog (or (and (boundp 'explicit-shell-file-name
) explicit-shell-file-name
)
290 (getenv "ESHELL") shell-file-name
))
291 (name (file-name-nondirectory prog
)))
292 ;; Tell bash not to use readline, except for bash 1.x which
293 ;; doesn't grook --noediting. Bash 1.x has -nolineediting, but
294 ;; process-send-eof cannot terminate bash if we use it.
295 (if (and (not purify-flag
)
297 (file-executable-p prog
)
298 (string-match "bad option"
299 (shell-command-to-string
300 (concat (shell-quote-argument prog
)
303 '("--noediting" "-i")))
304 "Args passed to inferior shell by \\[shell], if the shell is bash.
305 Value is a list of strings, which may be nil."
306 :type
'(repeat (string :tag
"Argument"))
309 (defcustom shell-input-autoexpand
'history
310 "If non-nil, expand input command history references on completion.
311 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
313 If the value is `input', then the expansion is seen on input.
314 If the value is `history', then the expansion is only when inserting
315 into the buffer's input ring. See also `comint-magic-space' and
316 `comint-dynamic-complete-functions'.
318 This variable supplies a default for `comint-input-autoexpand',
319 for Shell mode only."
320 :type
'(choice (const :tag
"off" nil
)
326 (defvar shell-dirstack nil
327 "List of directories saved by pushd in this buffer's shell.
328 Thus, this does not include the shell's current directory.")
330 (defvar shell-dirtrackp t
331 "Non-nil in a shell buffer means directory tracking is enabled.")
333 (defvar shell-last-dir nil
334 "Keep track of last directory for ksh `cd -' command.")
336 (defvar shell-dirstack-query nil
337 "Command used by `shell-resync-dirs' to query the shell.")
339 (defvar shell-mode-map
340 (let ((map (nconc (make-sparse-keymap) comint-mode-map
)))
341 (define-key map
"\C-c\C-f" 'shell-forward-command
)
342 (define-key map
"\C-c\C-b" 'shell-backward-command
)
343 (define-key map
"\t" 'completion-at-point
)
344 (define-key map
(kbd "M-RET") 'shell-resync-dirs
)
345 (define-key map
"\M-?" 'comint-dynamic-list-filename-completions
)
346 (define-key map
[menu-bar completion
]
348 (copy-keymap (lookup-key comint-mode-map
[menu-bar completion
]))))
349 (define-key-after (lookup-key map
[menu-bar completion
])
350 [complete-env-variable
] '("Complete Env. Variable Name" .
351 shell-dynamic-complete-environment-variable
)
353 (define-key-after (lookup-key map
[menu-bar completion
])
354 [expand-directory
] '("Expand Directory Reference" .
355 shell-replace-by-expanded-directory
)
359 (defcustom shell-mode-hook
'()
360 "Hook for customizing Shell mode."
364 (defvar shell-font-lock-keywords
365 '(("[ \t]\\([+-][^ \t\n]+\\)" 1 font-lock-comment-face
)
366 ("^[^ \t\n]+:.*" . font-lock-string-face
)
367 ("^\\[[1-9][0-9]*\\]" . font-lock-string-face
))
368 "Additional expressions to highlight in Shell mode.")
372 (defcustom shell-dir-cookie-re nil
373 "Regexp matching your prompt, including some part of the current directory.
374 If your prompt includes the current directory or the last few elements of it,
375 set this to a pattern that matches your prompt and whose subgroup 1 matches
376 the directory part of it.
377 This is used by `shell-dir-cookie-watcher' to try and use this info
378 to track your current directory. It can be used instead of or in addition
381 :type
'(choice (const nil
) regexp
))
383 (defvar pcomplete-parse-arguments-function
)
385 (defun shell-completion-vars ()
386 "Setup completion vars for `shell-mode' and `read-shell-command'."
387 (set (make-local-variable 'comint-completion-fignore
)
388 shell-completion-fignore
)
389 (set (make-local-variable 'comint-delimiter-argument-list
)
390 shell-delimiter-argument-list
)
391 (set (make-local-variable 'comint-file-name-chars
) shell-file-name-chars
)
392 (set (make-local-variable 'comint-file-name-quote-list
)
393 shell-file-name-quote-list
)
394 (set (make-local-variable 'comint-dynamic-complete-functions
)
395 shell-dynamic-complete-functions
)
396 (set (make-local-variable 'pcomplete-parse-arguments-function
)
397 ;; FIXME: This function should be moved to shell.el.
398 #'pcomplete-parse-comint-arguments
)
399 (setq comint-input-autoexpand shell-input-autoexpand
)
400 ;; Not needed in shell-mode because it's inherited from comint-mode, but
401 ;; placed here for read-shell-command.
402 (add-hook 'completion-at-point-functions
'comint-completion-at-point nil t
))
404 (put 'shell-mode
'mode-class
'special
)
406 (define-derived-mode shell-mode comint-mode
"Shell"
407 "Major mode for interacting with an inferior shell.\\<shell-mode-map>
408 \\[comint-send-input] after the end of the process' output sends the text from
409 the end of process to the end of the current line.
410 \\[comint-send-input] before end of process output copies the current line minus the prompt to
411 the end of the buffer and sends it (\\[comint-copy-old-input] just copies the current line).
412 \\[send-invisible] reads a line of text without echoing it, and sends it to
413 the shell. This is useful for entering passwords. Or, add the function
414 `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
416 If you want to make multiple shell buffers, rename the `*shell*' buffer
417 using \\[rename-buffer] or \\[rename-uniquely] and start a new shell.
419 If you want to make shell buffers limited in length, add the function
420 `comint-truncate-buffer' to `comint-output-filter-functions'.
422 If you accidentally suspend your process, use \\[comint-continue-subjob]
425 `cd', `pushd' and `popd' commands given to the shell are watched by Emacs to
426 keep this buffer's default directory the same as the shell's working directory.
427 While directory tracking is enabled, the shell's working directory is displayed
428 by \\[list-buffers] or \\[mouse-buffer-menu] in the `File' field.
429 \\[dirs] queries the shell and resyncs Emacs' idea of what the current
431 \\[shell-dirtrack-mode] turns directory tracking on and off.
432 \(The `dirtrack' package provides an alternative implementation of this
433 feature - see the function `dirtrack-mode'.)
436 Customization: Entry to this mode runs the hooks on `comint-mode-hook' and
437 `shell-mode-hook' (in that order). Before each input, the hooks on
438 `comint-input-filter-functions' are run. After each shell output, the hooks
439 on `comint-output-filter-functions' are run.
441 Variables `shell-cd-regexp', `shell-chdrive-regexp', `shell-pushd-regexp'
442 and `shell-popd-regexp' are used to match their respective commands,
443 while `shell-pushd-tohome', `shell-pushd-dextract' and `shell-pushd-dunique'
444 control the behavior of the relevant command.
446 Variables `comint-completion-autolist', `comint-completion-addsuffix',
447 `comint-completion-recexact' and `comint-completion-fignore' control the
448 behavior of file name, command name and variable name completion. Variable
449 `shell-completion-execonly' controls the behavior of command name completion.
450 Variable `shell-completion-fignore' is used to initialize the value of
451 `comint-completion-fignore'.
453 Variables `comint-input-ring-file-name' and `comint-input-autoexpand' control
454 the initialization of the input ring history, and history expansion.
456 Variables `comint-output-filter-functions', a hook, and
457 `comint-scroll-to-bottom-on-input' and `comint-scroll-to-bottom-on-output'
458 control whether input and output cause the window to scroll to the end of the
460 (setq comint-prompt-regexp shell-prompt-pattern
)
461 (shell-completion-vars)
462 (set (make-local-variable 'paragraph-separate
) "\\'")
463 (set (make-local-variable 'paragraph-start
) comint-prompt-regexp
)
464 (set (make-local-variable 'font-lock-defaults
) '(shell-font-lock-keywords t
))
465 (set (make-local-variable 'shell-dirstack
) nil
)
466 (set (make-local-variable 'shell-last-dir
) nil
)
467 (shell-dirtrack-mode 1)
468 ;; This is not really correct, since the shell buffer does not really
469 ;; edit this directory. But it is useful in the buffer list and menus.
470 (setq list-buffers-directory
(expand-file-name default-directory
))
471 ;; shell-dependent assignments.
472 (when (ring-empty-p comint-input-ring
)
473 (let ((shell (file-name-nondirectory (car
474 (process-command (get-buffer-process (current-buffer))))))
475 (hsize (getenv "HISTSIZE")))
477 (integerp (setq hsize
(string-to-number hsize
)))
479 (set (make-local-variable 'comint-input-ring-size
) hsize
))
480 (setq comint-input-ring-file-name
481 (or (getenv "HISTFILE")
482 (cond ((string-equal shell
"bash") "~/.bash_history")
483 ((string-equal shell
"ksh") "~/.sh_history")
485 (if (or (equal comint-input-ring-file-name
"")
486 (equal (file-truename comint-input-ring-file-name
)
487 (file-truename "/dev/null")))
488 (setq comint-input-ring-file-name nil
))
489 ;; Arrange to write out the input ring on exit, if the shell doesn't
491 (if (and comint-input-ring-file-name
492 (string-match shell-dumb-shell-regexp shell
))
493 (set-process-sentinel (get-buffer-process (current-buffer))
494 #'shell-write-history-on-exit
))
495 (setq shell-dirstack-query
496 (cond ((string-equal shell
"sh") "pwd")
497 ((string-equal shell
"ksh") "echo $PWD ~-")
499 ;; Bypass a bug in certain versions of bash.
500 (when (string-equal shell
"bash")
501 (add-hook 'comint-preoutput-filter-functions
502 'shell-filter-ctrl-a-ctrl-b nil t
)))
503 (when shell-dir-cookie-re
504 ;; Watch for magic cookies in the output to track the current dir.
505 (add-hook 'comint-output-filter-functions
506 'shell-dir-cookie-watcher nil t
))
507 (comint-read-input-ring t
)))
509 (defun shell-filter-ctrl-a-ctrl-b (string)
510 "Remove `^A' and `^B' characters from comint output.
512 Bash uses these characters as internal quoting characters in its
513 prompt. Due to a bug in some bash versions (including 2.03,
514 2.04, and 2.05b), they may erroneously show up when bash is
515 started with the `--noediting' option and Select Graphic
516 Rendition (SGR) control sequences (formerly known as ANSI escape
517 sequences) are used to color the prompt.
519 This function can be put on `comint-preoutput-filter-functions'."
520 (if (string-match "[\C-a\C-b]" string
)
521 (replace-regexp-in-string "[\C-a\C-b]" "" string t t
)
524 (defun shell-write-history-on-exit (process event
)
525 "Called when the shell process is stopped.
527 Writes the input history to a history file
528 `comint-input-ring-file-name' using `comint-write-input-ring'
529 and inserts a short message in the shell buffer.
531 This function is a sentinel watching the shell interpreter process.
532 Sentinels will always get the two parameters PROCESS and EVENT."
534 (comint-write-input-ring)
535 (let ((buf (process-buffer process
)))
536 (when (buffer-live-p buf
)
537 (with-current-buffer buf
538 (insert (format "\nProcess %s %s\n" process event
))))))
541 (defun shell (&optional buffer
)
542 "Run an inferior shell, with I/O through BUFFER (which defaults to `*shell*').
543 Interactively, a prefix arg means to prompt for BUFFER.
544 If `default-directory' is a remote file name, it is also prompted
545 to change if called with a prefix arg.
547 If BUFFER exists but shell process is not running, make new shell.
548 If BUFFER exists and shell process is running, just switch to BUFFER.
549 Program used comes from variable `explicit-shell-file-name',
550 or (if that is nil) from the ESHELL environment variable,
551 or (if that is nil) from `shell-file-name'.
552 If a file `~/.emacs_SHELLNAME' exists, or `~/.emacs.d/init_SHELLNAME.sh',
553 it is given as initial input (but this may be lost, due to a timing
554 error, if the shell discards input when it starts up).
555 The buffer is put in Shell mode, giving commands for sending input
556 and controlling the subjobs of the shell. See `shell-mode'.
557 See also the variable `shell-prompt-pattern'.
559 To specify a coding system for converting non-ASCII characters
560 in the input and output to the shell, use \\[universal-coding-system-argument]
561 before \\[shell]. You can also specify this with \\[set-buffer-process-coding-system]
562 in the shell buffer, after you start the shell.
563 The default comes from `process-coding-system-alist' and
564 `default-process-coding-system'.
566 The shell file name (sans directories) is used to make a symbol name
567 such as `explicit-csh-args'. If that symbol is a variable,
568 its value is used as a list of arguments when invoking the shell.
569 Otherwise, one argument `-i' is passed to the shell.
571 \(Type \\[describe-mode] in the shell buffer for a list of commands.)"
574 (and current-prefix-arg
576 (read-buffer "Shell buffer: "
577 (generate-new-buffer-name "*shell*"))
578 (if (file-remote-p default-directory
)
579 ;; It must be possible to declare a local default-directory.
580 ;; FIXME: This can't be right: it changes the default-directory
581 ;; of the current-buffer rather than of the *shell* buffer.
582 (setq default-directory
585 "Default directory: " default-directory default-directory
587 (require 'ansi-color
)
588 (setq buffer
(if (or buffer
(not (derived-mode-p 'shell-mode
))
589 (comint-check-proc (current-buffer)))
590 (get-buffer-create (or buffer
"*shell*"))
591 ;; If the current buffer is a dead shell buffer, use it.
594 ;; On remote hosts, the local `shell-file-name' might be useless.
595 (if (and (called-interactively-p 'any
)
596 (file-remote-p default-directory
)
597 (null explicit-shell-file-name
)
598 (null (getenv "ESHELL")))
599 (with-current-buffer buffer
600 (set (make-local-variable 'explicit-shell-file-name
)
604 "Remote shell path: " default-directory shell-file-name
608 ;; Pop to buffer, so that the buffer's window will be correctly set
609 ;; when we call comint (so that comint sets the COLUMNS env var properly).
610 (pop-to-buffer buffer
)
611 (unless (comint-check-proc buffer
)
612 (let* ((prog (or explicit-shell-file-name
613 (getenv "ESHELL") shell-file-name
))
614 (name (file-name-nondirectory prog
))
615 (startfile (concat "~/.emacs_" name
))
616 (xargs-name (intern-soft (concat "explicit-" name
"-args"))))
617 (unless (file-exists-p startfile
)
618 (setq startfile
(concat user-emacs-directory
"init_" name
".sh")))
619 (apply 'make-comint-in-buffer
"shell" buffer prog
620 (if (file-exists-p startfile
) startfile
)
621 (if (and xargs-name
(boundp xargs-name
))
622 (symbol-value xargs-name
)
627 ;; Don't do this when shell.el is loaded, only while dumping.
628 ;;;###autoload (add-hook 'same-window-buffer-names (purecopy "*shell*"))
630 ;;; Directory tracking
632 ;; This code provides the shell mode input sentinel
633 ;; SHELL-DIRECTORY-TRACKER
634 ;; that tracks cd, pushd, and popd commands issued to the shell, and
635 ;; changes the current directory of the shell buffer accordingly.
637 ;; This is basically a fragile hack, although it's more accurate than
638 ;; the version in Emacs 18's shell.el. It has the following failings:
639 ;; 1. It doesn't know about the cdpath shell variable.
640 ;; 2. It cannot infallibly deal with command sequences, though it does well
641 ;; with these and with ignoring commands forked in another shell with ()s.
642 ;; 3. More generally, any complex command is going to throw it. Otherwise,
643 ;; you'd have to build an entire shell interpreter in Emacs Lisp. Failing
644 ;; that, there's no way to catch shell commands where cd's are buried
645 ;; inside conditional expressions, aliases, and so forth.
647 ;; The whole approach is a crock. Shell aliases mess it up. File sourcing
648 ;; messes it up. You run other processes under the shell; these each have
649 ;; separate working directories, and some have commands for manipulating
650 ;; their w.d.'s (e.g., the lcd command in ftp). Some of these programs have
651 ;; commands that do *not* affect the current w.d. at all, but look like they
652 ;; do (e.g., the cd command in ftp). In shells that allow you job
653 ;; control, you can switch between jobs, all having different w.d.'s. So
654 ;; simply saying %3 can shift your w.d..
656 ;; The solution is to relax, not stress out about it, and settle for
657 ;; a hack that works pretty well in typical circumstances. Remember
658 ;; that a half-assed solution is more in keeping with the spirit of Unix,
661 ;; One good hack not implemented here for users of programmable shells
662 ;; is to program up the shell w.d. manipulation commands to output
663 ;; a coded command sequence to the tty. Something like
665 ;; where <cwd> is the new current working directory. Then trash the
666 ;; directory tracking machinery currently used in this package, and
667 ;; replace it with a process filter that watches for and strips out
670 (defun shell-dir-cookie-watcher (text)
671 ;; This is fragile: the TEXT could be split into several chunks and we'd
672 ;; miss it. Oh well. It's a best effort anyway. I'd expect that it's
673 ;; rather unusual to have the prompt split into several packets, but
674 ;; I'm sure Murphy will prove me wrong.
675 (when (and shell-dir-cookie-re
(string-match shell-dir-cookie-re text
))
676 (let ((dir (match-string 1 text
)))
678 ((file-name-absolute-p dir
) (shell-cd dir
))
679 ;; Let's try and see if it seems to be up or down from where we were.
680 ((string-match "\\`\\(.*\\)\\(?:/.*\\)?\n\\(.*/\\)\\1\\(?:/.*\\)?\\'"
681 (setq text
(concat dir
"\n" default-directory
)))
682 (shell-cd (concat (match-string 2 text
) dir
)))))))
684 (defun shell-directory-tracker (str)
685 "Tracks cd, pushd and popd commands issued to the shell.
686 This function is called on each input passed to the shell.
687 It watches for cd, pushd and popd commands and sets the buffer's
688 default directory to track these commands.
690 You may toggle this tracking on and off with \\[shell-dirtrack-mode].
691 If Emacs gets confused, you can resync with the shell with \\[dirs].
692 \(The `dirtrack' package provides an alternative implementation of this
693 feature - see the function `dirtrack-mode'.)
695 See variables `shell-cd-regexp', `shell-chdrive-regexp', `shell-pushd-regexp',
696 and `shell-popd-regexp', while `shell-pushd-tohome', `shell-pushd-dextract',
697 and `shell-pushd-dunique' control the behavior of the relevant command.
699 Environment variables are expanded, see function `substitute-in-file-name'."
701 ;; We fail gracefully if we think the command will fail in the shell.
703 (let ((start (progn (string-match
704 (concat "^" shell-command-separator-regexp
)
705 str
) ; skip whitespace
708 (while (string-match shell-command-regexp str start
)
709 (setq end
(match-end 0)
710 cmd
(comint-arguments (substring str start end
) 0 0)
711 arg1
(comint-arguments (substring str start end
) 1 1))
713 (setq arg1
(shell-unquote-argument arg1
)))
714 (cond ((string-match (concat "\\`\\(" shell-popd-regexp
715 "\\)\\($\\|[ \t]\\)")
717 (shell-process-popd (comint-substitute-in-file-name arg1
)))
718 ((string-match (concat "\\`\\(" shell-pushd-regexp
719 "\\)\\($\\|[ \t]\\)")
721 (shell-process-pushd (comint-substitute-in-file-name arg1
)))
722 ((string-match (concat "\\`\\(" shell-cd-regexp
723 "\\)\\($\\|[ \t]\\)")
725 (shell-process-cd (comint-substitute-in-file-name arg1
)))
726 ((and shell-chdrive-regexp
727 (string-match (concat "\\`\\(" shell-chdrive-regexp
728 "\\)\\($\\|[ \t]\\)")
730 (shell-process-cd (comint-substitute-in-file-name cmd
))))
731 (setq start
(progn (string-match shell-command-separator-regexp
735 (error "Couldn't cd"))))
737 (defun shell-unquote-argument (string)
738 "Remove all kinds of shell quoting from STRING."
740 (let ((idx 0) next inside
742 (if (string-match shell-dumb-shell-regexp
743 (file-name-nondirectory
744 (car (process-command (get-buffer-process (current-buffer))))))
747 (while (and (< idx
(length string
))
748 (setq next
(string-match quote-chars string next
)))
749 (cond ((= (aref string next
) ?
\\)
750 (setq string
(replace-match "" nil nil string
))
751 (setq next
(1+ next
)))
752 ((and inside
(= (aref string next
) inside
))
753 (setq string
(replace-match "" nil nil string
))
756 (setq next
(1+ next
)))
758 (setq inside
(aref string next
))
759 (setq string
(replace-match "" nil nil string
)))))
763 (defun shell-process-popd (arg)
764 (let ((num (or (shell-extract-num arg
) 0)))
765 (cond ((and num
(= num
0) shell-dirstack
)
766 (shell-cd (shell-prefixed-directory-name (car shell-dirstack
)))
767 (setq shell-dirstack
(cdr shell-dirstack
))
768 (shell-dirstack-message))
769 ((and num
(> num
0) (<= num
(length shell-dirstack
)))
770 (let* ((ds (cons nil shell-dirstack
))
771 (cell (nthcdr (1- num
) ds
)))
772 (rplacd cell
(cdr (cdr cell
)))
773 (setq shell-dirstack
(cdr ds
))
774 (shell-dirstack-message)))
776 (error "Couldn't popd")))))
778 ;; Return DIR prefixed with comint-file-name-prefix as appropriate.
779 (defun shell-prefixed-directory-name (dir)
780 (if (= (length comint-file-name-prefix
) 0)
782 (if (file-name-absolute-p dir
)
783 ;; The name is absolute, so prepend the prefix.
784 (concat comint-file-name-prefix dir
)
785 ;; For relative name we assume default-directory already has the prefix.
786 (expand-file-name dir
))))
789 (defun shell-process-cd (arg)
790 (let ((new-dir (cond ((zerop (length arg
)) (concat comint-file-name-prefix
792 ((string-equal "-" arg
) shell-last-dir
)
793 (t (shell-prefixed-directory-name arg
)))))
794 (setq shell-last-dir default-directory
)
796 (shell-dirstack-message)))
799 (defun shell-process-pushd (arg)
800 (let ((num (shell-extract-num arg
)))
801 (cond ((zerop (length arg
))
802 ;; no arg -- swap pwd and car of stack unless shell-pushd-tohome
803 (cond (shell-pushd-tohome
804 (shell-process-pushd (concat comint-file-name-prefix
"~")))
806 (let ((old default-directory
))
807 (shell-cd (car shell-dirstack
))
808 (setq shell-dirstack
(cons old
(cdr shell-dirstack
)))
809 (shell-dirstack-message)))
811 (message "Directory stack empty."))))
814 (cond ((> num
(length shell-dirstack
))
815 (message "Directory stack not that deep."))
817 (error (message "Couldn't cd")))
818 (shell-pushd-dextract
819 (let ((dir (nth (1- num
) shell-dirstack
)))
820 (shell-process-popd arg
)
821 (shell-process-pushd default-directory
)
823 (shell-dirstack-message)))
825 (let* ((ds (cons default-directory shell-dirstack
))
827 (front (nthcdr num ds
))
828 (back (reverse (nthcdr (- dslen num
) (reverse ds
))))
829 (new-ds (append front back
)))
830 (shell-cd (car new-ds
))
831 (setq shell-dirstack
(cdr new-ds
))
832 (shell-dirstack-message)))))
835 (let ((old-wd default-directory
))
836 (shell-cd (shell-prefixed-directory-name arg
))
837 (if (or (null shell-pushd-dunique
)
838 (not (member old-wd shell-dirstack
)))
839 (setq shell-dirstack
(cons old-wd shell-dirstack
)))
840 (shell-dirstack-message))))))
842 ;; If STR is of the form +n, for n>0, return n. Otherwise, nil.
843 (defun shell-extract-num (str)
844 (and (string-match "^\\+[1-9][0-9]*$" str
)
845 (string-to-number str
)))
847 (defvaralias 'shell-dirtrack-mode
'shell-dirtrackp
)
848 (define-minor-mode shell-dirtrack-mode
849 "Turn directory tracking on and off in a shell buffer.
850 The `dirtrack' package provides an alternative implementation of this
851 feature - see the function `dirtrack-mode'."
853 (setq list-buffers-directory
(if shell-dirtrack-mode default-directory
))
854 (if shell-dirtrack-mode
855 (add-hook 'comint-input-filter-functions
'shell-directory-tracker nil t
)
856 (remove-hook 'comint-input-filter-functions
'shell-directory-tracker t
)))
858 (define-obsolete-function-alias 'shell-dirtrack-toggle
'shell-dirtrack-mode
861 (defun shell-cd (dir)
862 "Do normal `cd' to DIR, and set `list-buffers-directory'."
865 (setq list-buffers-directory default-directory
)))
867 (defun shell-resync-dirs ()
868 "Resync the buffer's idea of the current directory stack.
869 This command queries the shell with the command bound to
870 `shell-dirstack-query' (default \"dirs\"), reads the next
871 line output and parses it to form the new directory stack.
872 DON'T issue this command unless the buffer is at a shell prompt.
873 Also, note that if some other subprocess decides to do output
874 immediately after the query, its output will be taken as the
875 new directory stack -- you lose. If this happens, just do the
878 (let* ((proc (get-buffer-process (current-buffer)))
879 (pmark (process-mark proc
))
880 (started-at-pmark (= (point) (marker-position pmark
))))
883 ;; If the process echoes commands, don't insert a fake command in
884 ;; the buffer or it will appear twice.
885 (unless comint-process-echoes
886 (insert shell-dirstack-query
) (insert "\n"))
887 (sit-for 0) ; force redisplay
888 (comint-send-string proc shell-dirstack-query
)
889 (comint-send-string proc
"\n")
890 (set-marker pmark
(point))
894 (if comint-process-echoes
895 ;; Skip command echo if the process echoes
896 (concat "\\(" (regexp-quote shell-dirstack-query
) "\n\\)")
899 ;; This extra newline prevents the user's pending input from spoofing us.
900 (insert "\n") (backward-char 1)
901 ;; Wait for one line.
902 (while (not (looking-at regexp
))
903 (accept-process-output proc
)
905 (goto-char pmark
) (delete-char 1) ; remove the extra newline
906 ;; That's the dirlist. grab it & parse it.
907 (let* ((dl (buffer-substring (match-beginning 2) (1- (match-end 2))))
909 (ds '()) ; new dir stack
912 ;; regexp = optional whitespace, (non-whitespace), optional whitespace
913 (string-match "\\s *\\(\\S +\\)\\s *" dl i
) ; pick off next dir
914 (setq ds
(cons (concat comint-file-name-prefix
915 (substring dl
(match-beginning 1)
918 (setq i
(match-end 0)))
919 (let ((ds (nreverse ds
)))
921 (progn (shell-cd (car ds
))
922 (setq shell-dirstack
(cdr ds
)
923 shell-last-dir
(car shell-dirstack
))
924 (shell-dirstack-message))
925 (error (message "Couldn't cd"))))))
926 (if started-at-pmark
(goto-char (marker-position pmark
)))))
928 ;; For your typing convenience:
929 (defalias 'dirs
'shell-resync-dirs
)
932 ;; Show the current dirstack on the message line.
933 ;; Pretty up dirs a bit by changing "/usr/jqr/foo" to "~/foo".
934 ;; (This isn't necessary if the dirlisting is generated with a simple "dirs".)
935 ;; All the commands that mung the buffer's dirstack finish by calling
937 (defun shell-dirstack-message ()
938 (when shell-dirtrack-verbose
940 (ds (cons default-directory shell-dirstack
))
941 (home (expand-file-name (concat comint-file-name-prefix
"~/")))
942 (homelen (length home
)))
944 (let ((dir (car ds
)))
945 (and (>= (length dir
) homelen
)
946 (string= home
(substring dir
0 homelen
))
947 (setq dir
(concat "~/" (substring dir homelen
))))
948 ;; Strip off comint-file-name-prefix if present.
949 (and comint-file-name-prefix
950 (>= (length dir
) (length comint-file-name-prefix
))
951 (string= comint-file-name-prefix
952 (substring dir
0 (length comint-file-name-prefix
)))
953 (setq dir
(substring dir
(length comint-file-name-prefix
)))
955 (setq msg
(concat msg
(directory-file-name dir
) " "))
957 (message "%s" msg
))))
959 ;; This was mostly copied from shell-resync-dirs.
960 (defun shell-snarf-envar (var)
961 "Return as a string the shell's value of environment variable VAR."
962 (let* ((cmd (format "printenv '%s'\n" var
))
963 (proc (get-buffer-process (current-buffer)))
964 (pmark (process-mark proc
)))
967 (sit-for 0) ; force redisplay
968 (comint-send-string proc cmd
)
969 (set-marker pmark
(point))
970 (let ((pt (point))) ; wait for 1 line
971 ;; This extra newline prevents the user's pending input from spoofing us.
972 (insert "\n") (backward-char 1)
973 (while (not (looking-at ".+\n"))
974 (accept-process-output proc
)
976 (goto-char pmark
) (delete-char 1) ; remove the extra newline
977 (buffer-substring (match-beginning 0) (1- (match-end 0)))))
979 (defun shell-copy-environment-variable (variable)
980 "Copy the environment variable VARIABLE from the subshell to Emacs.
981 This command reads the value of the specified environment variable
982 in the shell, and sets the same environment variable in Emacs
983 \(what `getenv' in Emacs would return) to that value.
984 That value will affect any new subprocesses that you subsequently start
986 (interactive (list (read-envvar-name "\
987 Copy Shell environment variable to Emacs: ")))
988 (setenv variable
(shell-snarf-envar variable
)))
990 (defun shell-forward-command (&optional arg
)
991 "Move forward across ARG shell command(s). Does not cross lines.
992 See `shell-command-regexp'."
994 (let ((limit (line-end-position)))
995 (if (re-search-forward (concat shell-command-regexp
"\\([;&|][\t ]*\\)+")
997 (skip-syntax-backward " "))))
1000 (defun shell-backward-command (&optional arg
)
1001 "Move backward across ARG shell command(s). Does not cross lines.
1002 See `shell-command-regexp'."
1004 (let ((limit (save-excursion (comint-bol nil
) (point))))
1005 (when (> limit
(point))
1006 (setq limit
(line-beginning-position)))
1007 (skip-syntax-backward " " limit
)
1008 (if (re-search-backward
1009 (format "[;&|]+[\t ]*\\(%s\\)" shell-command-regexp
) limit
'move arg
)
1010 (progn (goto-char (match-beginning 1))
1011 (skip-chars-forward ";&|")))))
1013 (defun shell-dynamic-complete-command ()
1014 "Dynamically complete the command at point.
1015 This function is similar to `comint-dynamic-complete-filename', except that it
1016 searches `exec-path' (minus the trailing Emacs library path) for completion
1017 candidates. Note that this may not be the same as the shell's idea of the
1020 Completion is dependent on the value of `shell-completion-execonly', plus
1021 those that effect file completion.
1023 Returns t if successful."
1025 (let ((data (shell-command-completion)))
1027 (prog2 (unless (window-minibuffer-p (selected-window))
1028 (message "Completing command name..."))
1029 (apply #'completion-in-region data
)))))
1031 (defun shell-command-completion ()
1032 "Return the completion data for the command at point, if any."
1033 (let ((filename (comint-match-partial-filename)))
1035 (save-match-data (not (string-match "[~/]" filename
)))
1036 (eq (match-beginning 0)
1037 (save-excursion (shell-backward-command 1) (point))))
1038 (shell--command-completion-data))))
1040 (defun shell--command-completion-data ()
1041 "Return the completion data for the command at point."
1042 (let* ((filename (or (comint-match-partial-filename) ""))
1043 (start (if (zerop (length filename
)) (point) (match-beginning 0)))
1044 (end (if (zerop (length filename
)) (point) (match-end 0)))
1045 (filenondir (file-name-nondirectory filename
))
1046 (path-dirs (cdr (reverse exec-path
))) ;FIXME: Why `cdr'?
1047 (cwd (file-name-as-directory (expand-file-name default-directory
)))
1049 (and comint-completion-fignore
1050 (mapconcat (function (lambda (x) (concat (regexp-quote x
) "\\'")))
1051 comint-completion-fignore
"\\|")))
1052 (dir "") (comps-in-dir ())
1053 (file "") (abs-file-name "") (completions ()))
1054 ;; Go thru each dir in the search path, finding completions.
1056 (setq dir
(file-name-as-directory (comint-directory (or (car path-dirs
) ".")))
1057 comps-in-dir
(and (file-accessible-directory-p dir
)
1058 (file-name-all-completions filenondir dir
)))
1059 ;; Go thru each completion found, to see whether it should be used.
1061 (setq file
(car comps-in-dir
)
1062 abs-file-name
(concat dir file
))
1063 (if (and (not (member file completions
))
1064 (not (and ignored-extensions
1065 (string-match ignored-extensions file
)))
1066 (or (string-equal dir cwd
)
1067 (not (file-directory-p abs-file-name
)))
1068 (or (null shell-completion-execonly
)
1069 (file-executable-p abs-file-name
)))
1070 (setq completions
(cons file completions
)))
1071 (setq comps-in-dir
(cdr comps-in-dir
)))
1072 (setq path-dirs
(cdr path-dirs
)))
1073 ;; OK, we've got a list of completions.
1076 (lambda (string pred action
)
1077 (if (string-match "/" string
)
1078 (completion-file-name-table string pred action
)
1079 (complete-with-action action completions string pred
)))
1081 (lambda (_string finished
)
1082 (when (memq finished
'(sole finished
))
1083 (if (looking-at " ")
1084 (goto-char (match-end 0))
1087 ;; (defun shell-dynamic-complete-as-command ()
1088 ;; "Dynamically complete at point as a command.
1089 ;; See `shell-dynamic-complete-filename'. Returns t if successful."
1090 ;; (apply #'completion-in-region shell--command-completion-data))
1092 (defun shell-dynamic-complete-filename ()
1093 "Dynamically complete the filename at point.
1094 This completes only if point is at a suitable position for a
1097 (let ((data (shell-filename-completion)))
1098 (if data
(apply #'completion-in-region data
))))
1100 (defun shell-filename-completion ()
1101 "Return the completion data for file name at point, if any."
1102 (let ((opoint (point))
1103 (beg (comint-line-beginning-position)))
1104 (when (save-excursion
1105 (goto-char (if (re-search-backward "[;|&]" beg t
)
1108 (re-search-forward "[^ \t][ \t]" opoint t
))
1109 (comint-filename-completion))))
1111 (defun shell-match-partial-variable ()
1112 "Return the shell variable at point, or nil if none is found."
1114 (if (re-search-backward "[^A-Za-z0-9_{(]" nil
'move
)
1115 (or (looking-at "\\$") (forward-char 1)))
1116 (if (or (eolp) (looking-at "[^A-Za-z0-9_{($]"))
1118 (looking-at "\\$?[{(]?[A-Za-z0-9_]*[})]?")
1119 (buffer-substring (match-beginning 0) (match-end 0)))))
1121 (defun shell-dynamic-complete-environment-variable ()
1122 "Dynamically complete the environment variable at point.
1123 Completes if after a variable, i.e., if it starts with a \"$\".
1125 This function is similar to `comint-dynamic-complete-filename', except that it
1126 searches `process-environment' for completion candidates. Note that this may
1127 not be the same as the interpreter's idea of variable names. The main problem
1128 with this type of completion is that `process-environment' is the environment
1129 which Emacs started with. Emacs does not track changes to the environment made
1130 by the interpreter. Perhaps it would be more accurate if this function was
1131 called `shell-dynamic-complete-process-environment-variable'.
1133 Returns non-nil if successful."
1135 (let ((data (shell-environment-variable-completion)))
1137 (prog2 (unless (window-minibuffer-p (selected-window))
1138 (message "Completing variable name..."))
1139 (apply #'completion-in-region data
)))))
1142 (defun shell-environment-variable-completion ()
1143 "Completion data for an environment variable at point, if any."
1144 (let* ((var (shell-match-partial-variable))
1145 (end (match-end 0)))
1146 (when (and (not (zerop (length var
))) (eq (aref var
0) ?$
))
1149 (goto-char (match-beginning 0))
1150 (looking-at "\\$?[({]*")
1152 (variables (mapcar (lambda (x)
1153 (substring x
0 (string-match "=" x
)))
1154 process-environment
))
1155 (suffix (case (char-before start
) (?\
{ "}") (?\
( ")") (t ""))))
1156 (list start end variables
1158 (lambda (s finished
)
1159 (when (memq finished
'(sole finished
))
1160 (let ((suf (concat suffix
1161 (if (file-directory-p
1162 (comint-directory (getenv s
)))
1164 (if (looking-at (regexp-quote suf
))
1165 (goto-char (match-end 0))
1166 (insert suf
))))))))))
1169 (defun shell-c-a-p-replace-by-expanded-directory ()
1170 "Expand directory stack reference before point.
1171 For use on `completion-at-point-functions'."
1172 (when (comint-match-partial-filename)
1174 (goto-char (match-beginning 0))
1175 (let ((stack (cons default-directory shell-dirstack
))
1176 (index (cond ((looking-at "=-/?")
1177 (length shell-dirstack
))
1178 ((looking-at "=\\([0-9]+\\)/?")
1181 (match-beginning 1) (match-end 1)))))))
1183 (let ((start (match-beginning 0))
1185 (replacement (file-name-as-directory (nth index stack
))))
1188 ((>= index
(length stack
))
1189 (error "Directory stack not that deep"))
1193 (insert replacement
)
1194 (delete-char (- end start
)))
1195 (message "Directory item: %d" index
)
1198 (defun shell-replace-by-expanded-directory ()
1199 "Expand directory stack reference before point.
1200 Directory stack references are of the form \"=digit\" or \"=-\".
1201 See `default-directory' and `shell-dirstack'.
1203 Returns t if successful."
1205 (let ((f (shell-c-a-p-replace-by-expanded-directory)))
1206 (if f
(funcall f
))))
1210 ;;; shell.el ends here