1 ;;; shell.el --- specialized comint.el for running the shell -*- lexical-binding: t -*-
3 ;; Copyright (C) 1988, 1993-1997, 2000-2016 Free Software Foundation,
6 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
7 ;; Simon Marshall <simon@gnu.org>
8 ;; Maintainer: 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 customizing 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 init 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-delete-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 completion-at-point Complete filename/command/history
84 ;; m-? comint-dynamic-list-filename-completions
85 ;; List completions in help buffer
86 ;; c-c c-f shell-forward-command Forward a shell command
87 ;; c-c 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 initialized to shell-prompt-pattern, for backwards
96 ;; Read the rest of this file for more information.
103 ;;; Customization and Buffer Variables
106 "Running shell from within Emacs buffers."
110 (defgroup shell-directories nil
111 "Directory support in shell mode."
115 ;;; (defgroup shell-faces nil
116 ;;; "Faces in shell buffers."
120 (defcustom shell-dumb-shell-regexp
(purecopy "cmd\\(proxy\\)?\\.exe")
121 "Regexp to match shells that don't save their command history, and
122 don't handle the backslash as a quote character. For shells that
123 match this regexp, Emacs will write out the command history when the
124 shell finishes, and won't remove backslashes when it unquotes shell
129 (defcustom shell-prompt-pattern
"^[^#$%>\n]*[#$%>] *"
130 "Regexp to match prompts in the inferior shell.
131 Defaults to \"^[^#$%>\\n]*[#$%>] *\", which works pretty well.
132 This variable is used to initialize `comint-prompt-regexp' in the
135 If `comint-use-prompt-regexp' is nil, then this variable is only used
136 to determine paragraph boundaries. See Info node `Shell Prompts' for
137 how Shell mode treats paragraphs.
139 The pattern should probably not match more than one line. If it does,
140 Shell mode may become confused trying to distinguish prompt from input
141 on lines which don't start with a prompt."
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 (\"~\" \"#\" \"%\")."
150 :type
'(repeat (string :tag
"Suffix"))
153 (defcustom shell-delimiter-argument-list
'(?\| ?
& ?
< ?
> ?\
( ?\
) ?\
;)
154 "List of characters to recognize as separate arguments.
155 This variable is used to initialize `comint-delimiter-argument-list' in the
156 shell buffer. The value may depend on the operating system or shell."
157 :type
'(choice (const nil
)
158 (repeat :tag
"List of characters" character
))
161 (defcustom shell-file-name-chars
162 (if (memq system-type
'(ms-dos windows-nt cygwin
))
163 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
164 "[]~/A-Za-z0-9+@:_.$#%,={}-")
165 "String of characters valid in a file name.
166 This variable is used to initialize `comint-file-name-chars' in the
167 shell buffer. The value may depend on the operating system or shell."
171 (defcustom shell-file-name-quote-list
172 (if (memq system-type
'(ms-dos windows-nt
))
174 (append shell-delimiter-argument-list
'(?\s ?$ ?\
* ?\
! ?
\" ?
\' ?\
` ?\
# ?
\\)))
175 "List of characters to quote when in a file name.
176 This variable is used to initialize `comint-file-name-quote-list' in the
177 shell buffer. The value may depend on the operating system or shell."
178 :type
'(repeat character
)
181 (defcustom shell-dynamic-complete-functions
182 '(comint-c-a-p-replace-by-expanded-history
183 shell-environment-variable-completion
184 shell-command-completion
185 shell-c-a-p-replace-by-expanded-directory
186 pcomplete-completions-at-point
187 shell-filename-completion
188 comint-filename-completion
)
189 "List of functions called to perform completion.
190 This variable is used to initialize `comint-dynamic-complete-functions' in the
192 :type
'(repeat function
)
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 ;; Tell bash not to use readline. It's safe to assume --noediting now,
288 ;; as it was introduced in 1996 in Bash version 2.
289 '("--noediting" "-i")
290 "Args passed to inferior shell by \\[shell], if the shell is bash.
291 Value is a list of strings, which may be nil."
292 :type
'(repeat (string :tag
"Argument"))
295 (defcustom shell-input-autoexpand
'history
296 "If non-nil, expand input command history references on completion.
297 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
299 If the value is `input', then the expansion is seen on input.
300 If the value is `history', then the expansion is only when inserting
301 into the buffer's input ring. See also `comint-magic-space' and
302 `comint-dynamic-complete-functions'.
304 This variable supplies a default for `comint-input-autoexpand',
305 for Shell mode only."
306 :type
'(choice (const :tag
"off" nil
)
312 (defvar shell-dirstack nil
313 "List of directories saved by pushd in this buffer's shell.
314 Thus, this does not include the shell's current directory.")
316 (defvar shell-dirtrackp t
317 "Non-nil in a shell buffer means directory tracking is enabled.")
319 (defvar shell-last-dir nil
320 "Keep track of last directory for ksh `cd -' command.")
322 (defvar shell-dirstack-query nil
323 "Command used by `shell-resync-dirs' to query the shell.")
325 (defvar shell-mode-map
326 (let ((map (nconc (make-sparse-keymap) comint-mode-map
)))
327 (define-key map
"\C-c\C-f" 'shell-forward-command
)
328 (define-key map
"\C-c\C-b" 'shell-backward-command
)
329 (define-key map
"\t" 'completion-at-point
)
330 (define-key map
(kbd "M-RET") 'shell-resync-dirs
)
331 (define-key map
"\M-?" 'comint-dynamic-list-filename-completions
)
332 (define-key map
[menu-bar completion
]
334 (copy-keymap (lookup-key comint-mode-map
[menu-bar completion
]))))
335 (define-key-after (lookup-key map
[menu-bar completion
])
336 [complete-env-variable
] '("Complete Env. Variable Name" .
337 shell-dynamic-complete-environment-variable
)
339 (define-key-after (lookup-key map
[menu-bar completion
])
340 [expand-directory
] '("Expand Directory Reference" .
341 shell-replace-by-expanded-directory
)
345 (defcustom shell-mode-hook
'()
346 "Hook for customizing Shell mode."
350 (defvar shell-font-lock-keywords
351 '(("[ \t]\\([+-][^ \t\n]+\\)" 1 font-lock-comment-face
)
352 ("^[^ \t\n]+:.*" . font-lock-string-face
)
353 ("^\\[[1-9][0-9]*\\]" . font-lock-string-face
))
354 "Additional expressions to highlight in Shell mode.")
358 (defun shell--unquote&requote-argument
(qstr &optional upos
)
359 (unless upos
(setq upos
0))
365 "\\|\\$\\(?:\\([[:alpha:]][[:alnum:]]*\\)"
366 "\\|{\\(?1:[^{}]+\\)}\\)"
367 (when (memq system-type
'(ms-dos windows-nt
))
368 "\\|%\\(?1:[^\\\\/]*\\)%")
369 (when comint-file-name-quote-list
372 (push (lambda (str end
)
374 (setq upos
(- upos
(length str
)))
375 (unless (or qupos
(> upos
0))
376 (setq qupos
(if (< end
0) (- end
) (+ upos end
))))))
378 (while (setq match
(string-match re qstr qpos
))
379 (funcall push
(substring qstr qpos match
) match
)
381 ((match-beginning 2) (funcall push
(match-string 2 qstr
) (match-end 0)))
382 ((match-beginning 1) (funcall push
(getenv (match-string 1 qstr
))
384 ((eq (aref qstr match
) ?
\") (setq dquotes
(not dquotes
)))
385 ((eq (aref qstr match
) ?
\')
387 ;; Treat single quote as text if inside double quotes.
388 (dquotes (funcall push
"'" (match-end 0)))
389 ((< (1+ match
) (length qstr
))
390 (let ((end (string-match "'" qstr
(1+ match
))))
392 (setq end
(length qstr
))
393 (set-match-data (list match
(length qstr
))))
394 (funcall push
(substring qstr
(1+ match
) end
) end
)))
395 ;; Ignore if at the end of string.
397 (t (error "Unexpected case in shell--unquote&requote-argument!")))
398 (setq qpos
(match-end 0)))
399 (funcall push
(substring qstr qpos
) (length qstr
))
400 (list (mapconcat #'identity
(nreverse ustrs
) "")
401 qupos
#'comint-quote-filename
)))
403 (defun shell--unquote-argument (str)
404 (car (shell--unquote&requote-argument str
)))
405 (defun shell--requote-argument (upos qstr
)
406 ;; See `completion-table-with-quoting'.
407 (let ((res (shell--unquote&requote-argument qstr upos
)))
408 (cons (nth 1 res
) (nth 2 res
))))
410 (defun shell--parse-pcomplete-arguments ()
411 "Parse whitespace separated arguments in the current region."
412 ;; FIXME: share code with shell--unquote&requote-argument.
413 (let ((begin (save-excursion (shell-backward-command 1) (point)))
418 (while (< (point) end
)
419 (skip-chars-forward " \t\n")
420 (push (point) begins
)
425 "\\(?:[^\s\t\n\\\"']+"
427 "\\|\"\\(\\(?:[^\"\\]\\|\\\\.\\)*\\)\"?"
428 "\\|\\\\\\(\\(?:.\\|\n\\)?\\)\\)")))
429 (goto-char (match-end 0))
431 ((match-beginning 3) ;Backslash escape.
433 ((null comint-file-name-quote-list
)
434 (goto-char (match-beginning 3)) "\\")
435 ((= (match-beginning 3) (match-end 3)) "\\")
436 (t (match-string 3)))
438 ((match-beginning 2) ;Double quote.
439 (push (if (null comint-file-name-quote-list
) (match-string 2)
440 (replace-regexp-in-string
441 "\\\\\\(.\\)" "\\1" (match-string 2)))
443 ((match-beginning 1) ;Single quote.
444 (push (match-string 1) arg
))
445 (t (push (match-string 0) arg
))))
446 (push (mapconcat #'identity
(nreverse arg
) "") args
)))
447 (cons (nreverse args
) (nreverse begins
)))))
449 (defun shell-command-completion-function ()
450 "Completion function for shell command names.
451 This is the value of `pcomplete-command-completion-function' for
452 Shell buffers. It implements `shell-completion-execonly' for
453 `pcomplete' completion."
454 (pcomplete-here (pcomplete-entries nil
455 (if shell-completion-execonly
456 'file-executable-p
))))
458 (defun shell-completion-vars ()
459 "Setup completion vars for `shell-mode' and `read-shell-command'."
460 (set (make-local-variable 'comint-completion-fignore
)
461 shell-completion-fignore
)
462 (set (make-local-variable 'comint-delimiter-argument-list
)
463 shell-delimiter-argument-list
)
464 (set (make-local-variable 'comint-file-name-chars
) shell-file-name-chars
)
465 (set (make-local-variable 'comint-file-name-quote-list
)
466 shell-file-name-quote-list
)
467 (set (make-local-variable 'comint-dynamic-complete-functions
)
468 shell-dynamic-complete-functions
)
469 (setq-local comint-unquote-function
#'shell--unquote-argument
)
470 (setq-local comint-requote-function
#'shell--requote-argument
)
471 (set (make-local-variable 'pcomplete-parse-arguments-function
)
472 #'shell--parse-pcomplete-arguments
)
473 (set (make-local-variable 'pcomplete-termination-string
)
474 (cond ((not comint-completion-addsuffix
) "")
475 ((stringp comint-completion-addsuffix
)
476 comint-completion-addsuffix
)
477 ((not (consp comint-completion-addsuffix
)) " ")
478 (t (cdr comint-completion-addsuffix
))))
479 (set (make-local-variable 'pcomplete-command-completion-function
)
480 #'shell-command-completion-function
)
481 ;; Don't use pcomplete's defaulting mechanism, rely on
482 ;; shell-dynamic-complete-functions instead.
483 (set (make-local-variable 'pcomplete-default-completion-function
) #'ignore
)
484 (setq comint-input-autoexpand shell-input-autoexpand
)
485 ;; Not needed in shell-mode because it's inherited from comint-mode, but
486 ;; placed here for read-shell-command.
487 (add-hook 'completion-at-point-functions
'comint-completion-at-point nil t
))
489 (put 'shell-mode
'mode-class
'special
)
491 (define-derived-mode shell-mode comint-mode
"Shell"
492 "Major mode for interacting with an inferior shell.\\<shell-mode-map>
493 \\[comint-send-input] after the end of the process' output sends the text from
494 the end of process to the end of the current line.
495 \\[comint-send-input] before end of process output copies the current line minus the prompt to
496 the end of the buffer and sends it (\\[comint-copy-old-input] just copies the current line).
497 \\[send-invisible] reads a line of text without echoing it, and sends it to
498 the shell. This is useful for entering passwords. Or, add the function
499 `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
501 If you want to make multiple shell buffers, rename the `*shell*' buffer
502 using \\[rename-buffer] or \\[rename-uniquely] and start a new shell.
504 If you want to make shell buffers limited in length, add the function
505 `comint-truncate-buffer' to `comint-output-filter-functions'.
507 If you accidentally suspend your process, use \\[comint-continue-subjob]
510 `cd', `pushd' and `popd' commands given to the shell are watched by Emacs to
511 keep this buffer's default directory the same as the shell's working directory.
512 While directory tracking is enabled, the shell's working directory is displayed
513 by \\[list-buffers] or \\[mouse-buffer-menu] in the `File' field.
514 \\[dirs] queries the shell and resyncs Emacs's idea of what the current
516 \\[shell-dirtrack-mode] turns directory tracking on and off.
517 \(The `dirtrack' package provides an alternative implementation of this
518 feature - see the function `dirtrack-mode'.)
521 Customization: Entry to this mode runs the hooks on `comint-mode-hook' and
522 `shell-mode-hook' (in that order). Before each input, the hooks on
523 `comint-input-filter-functions' are run. After each shell output, the hooks
524 on `comint-output-filter-functions' are run.
526 Variables `shell-cd-regexp', `shell-chdrive-regexp', `shell-pushd-regexp'
527 and `shell-popd-regexp' are used to match their respective commands,
528 while `shell-pushd-tohome', `shell-pushd-dextract' and `shell-pushd-dunique'
529 control the behavior of the relevant command.
531 Variables `comint-completion-autolist', `comint-completion-addsuffix',
532 `comint-completion-recexact' and `comint-completion-fignore' control the
533 behavior of file name, command name and variable name completion. Variable
534 `shell-completion-execonly' controls the behavior of command name completion.
535 Variable `shell-completion-fignore' is used to initialize the value of
536 `comint-completion-fignore'.
538 Variables `comint-input-ring-file-name' and `comint-input-autoexpand' control
539 the initialization of the input ring history, and history expansion.
541 Variables `comint-output-filter-functions', a hook, and
542 `comint-scroll-to-bottom-on-input' and `comint-scroll-to-bottom-on-output'
543 control whether input and output cause the window to scroll to the end of the
545 (setq comint-prompt-regexp shell-prompt-pattern
)
546 (shell-completion-vars)
547 (set (make-local-variable 'paragraph-separate
) "\\'")
548 (set (make-local-variable 'paragraph-start
) comint-prompt-regexp
)
549 (set (make-local-variable 'font-lock-defaults
) '(shell-font-lock-keywords t
))
550 (set (make-local-variable 'shell-dirstack
) nil
)
551 (set (make-local-variable 'shell-last-dir
) nil
)
552 (shell-dirtrack-mode 1)
554 ;; By default, ansi-color applies faces using overlays. This is
555 ;; very inefficient in Shell buffers (e.g. Bug#10835). We use a
556 ;; custom `ansi-color-apply-face-function' to convert color escape
557 ;; sequences into `font-lock-face' properties.
558 (setq-local ansi-color-apply-face-function
#'shell-apply-ansi-color
)
559 (shell-reapply-ansi-color)
561 ;; This is not really correct, since the shell buffer does not really
562 ;; edit this directory. But it is useful in the buffer list and menus.
563 (setq list-buffers-directory
(expand-file-name default-directory
))
564 ;; shell-dependent assignments.
565 (when (ring-empty-p comint-input-ring
)
566 (let ((shell (file-name-nondirectory (car
567 (process-command (get-buffer-process (current-buffer))))))
568 (hsize (getenv "HISTSIZE")))
570 (integerp (setq hsize
(string-to-number hsize
)))
572 (set (make-local-variable 'comint-input-ring-size
) hsize
))
573 (setq comint-input-ring-file-name
574 (or (getenv "HISTFILE")
575 (cond ((string-equal shell
"bash") "~/.bash_history")
576 ((string-equal shell
"ksh") "~/.sh_history")
578 (if (or (equal comint-input-ring-file-name
"")
579 (equal (file-truename comint-input-ring-file-name
)
580 (file-truename "/dev/null")))
581 (setq comint-input-ring-file-name nil
))
582 ;; Arrange to write out the input ring on exit, if the shell doesn't
584 (if (and comint-input-ring-file-name
585 (string-match shell-dumb-shell-regexp shell
))
586 (set-process-sentinel (get-buffer-process (current-buffer))
587 #'shell-write-history-on-exit
))
588 (setq shell-dirstack-query
589 (cond ((string-equal shell
"sh") "pwd")
590 ((string-equal shell
"ksh") "echo $PWD ~-")
591 ;; Bypass any aliases. TODO all shells could use this.
592 ((string-equal shell
"bash") "command dirs")
594 ;; Bypass a bug in certain versions of bash.
595 (when (string-equal shell
"bash")
596 (add-hook 'comint-preoutput-filter-functions
597 'shell-filter-ctrl-a-ctrl-b nil t
)))
598 (comint-read-input-ring t
)))
600 (defun shell-apply-ansi-color (beg end face
)
601 "Apply FACE as the ansi-color face for the text between BEG and END."
603 (put-text-property beg end
'ansi-color-face face
)
604 (put-text-property beg end
'font-lock-face face
)))
606 (defun shell-reapply-ansi-color ()
607 "Reapply ansi-color faces to the existing contents of the buffer."
610 (let* ((pos (point-min))
611 (end (or (next-single-property-change pos
'ansi-color-face
)
615 (if (setq face
(get-text-property pos
'ansi-color-face
))
616 (put-text-property pos
(or end
(point-max))
617 'font-lock-face face
))
619 end
(next-single-property-change pos
'ansi-color-face
))))))
621 (defun shell-filter-ctrl-a-ctrl-b (string)
622 "Remove `^A' and `^B' characters from comint output.
624 Bash uses these characters as internal quoting characters in its
625 prompt. Due to a bug in some bash versions (including 2.03,
626 2.04, and 2.05b), they may erroneously show up when bash is
627 started with the `--noediting' option and Select Graphic
628 Rendition (SGR) control sequences (formerly known as ANSI escape
629 sequences) are used to color the prompt.
631 This function can be put on `comint-preoutput-filter-functions'."
632 (if (string-match "[\C-a\C-b]" string
)
633 (replace-regexp-in-string "[\C-a\C-b]" "" string t t
)
636 (defun shell-write-history-on-exit (process event
)
637 "Called when the shell process is stopped.
639 Writes the input history to a history file
640 `comint-input-ring-file-name' using `comint-write-input-ring'
641 and inserts a short message in the shell buffer.
643 This function is a sentinel watching the shell interpreter process.
644 Sentinels will always get the two parameters PROCESS and EVENT."
646 (comint-write-input-ring)
647 (let ((buf (process-buffer process
)))
648 (when (buffer-live-p buf
)
649 (with-current-buffer buf
650 (insert (format "\nProcess %s %s\n" process event
))))))
653 (defun shell (&optional buffer
)
654 "Run an inferior shell, with I/O through BUFFER (which defaults to `*shell*').
655 Interactively, a prefix arg means to prompt for BUFFER.
656 If `default-directory' is a remote file name, it is also prompted
657 to change if called with a prefix arg.
659 If BUFFER exists but shell process is not running, make new shell.
660 If BUFFER exists and shell process is running, just switch to BUFFER.
661 Program used comes from variable `explicit-shell-file-name',
662 or (if that is nil) from the ESHELL environment variable,
663 or (if that is nil) from `shell-file-name'.
664 If a file `~/.emacs_SHELLNAME' exists, or `~/.emacs.d/init_SHELLNAME.sh',
665 it is given as initial input (but this may be lost, due to a timing
666 error, if the shell discards input when it starts up).
667 The buffer is put in Shell mode, giving commands for sending input
668 and controlling the subjobs of the shell. See `shell-mode'.
669 See also the variable `shell-prompt-pattern'.
671 To specify a coding system for converting non-ASCII characters
672 in the input and output to the shell, use \\[universal-coding-system-argument]
673 before \\[shell]. You can also specify this with \\[set-buffer-process-coding-system]
674 in the shell buffer, after you start the shell.
675 The default comes from `process-coding-system-alist' and
676 `default-process-coding-system'.
678 The shell file name (sans directories) is used to make a symbol name
679 such as `explicit-csh-args'. If that symbol is a variable,
680 its value is used as a list of arguments when invoking the shell.
681 Otherwise, one argument `-i' is passed to the shell.
683 \(Type \\[describe-mode] in the shell buffer for a list of commands.)"
686 (and current-prefix-arg
688 (read-buffer "Shell buffer: "
689 ;; If the current buffer is an inactive
690 ;; shell buffer, use it as the default.
691 (if (and (eq major-mode
'shell-mode
)
692 (null (get-buffer-process (current-buffer))))
694 (generate-new-buffer-name "*shell*")))
695 (if (file-remote-p default-directory
)
696 ;; It must be possible to declare a local default-directory.
697 ;; FIXME: This can't be right: it changes the default-directory
698 ;; of the current-buffer rather than of the *shell* buffer.
699 (setq default-directory
702 "Default directory: " default-directory default-directory
704 (setq buffer
(if (or buffer
(not (derived-mode-p 'shell-mode
))
705 (comint-check-proc (current-buffer)))
706 (get-buffer-create (or buffer
"*shell*"))
707 ;; If the current buffer is a dead shell buffer, use it.
710 ;; On remote hosts, the local `shell-file-name' might be useless.
711 (if (and (called-interactively-p 'any
)
712 (file-remote-p default-directory
)
713 (null explicit-shell-file-name
)
714 (null (getenv "ESHELL")))
715 (with-current-buffer buffer
716 (set (make-local-variable 'explicit-shell-file-name
)
720 "Remote shell path: " default-directory shell-file-name
721 t shell-file-name
))))))
723 ;; The buffer's window must be correctly set when we call comint (so
724 ;; that comint sets the COLUMNS env var properly).
725 (pop-to-buffer buffer
)
726 (unless (comint-check-proc buffer
)
727 (let* ((prog (or explicit-shell-file-name
728 (getenv "ESHELL") shell-file-name
))
729 (name (file-name-nondirectory prog
))
730 (startfile (concat "~/.emacs_" name
))
731 (xargs-name (intern-soft (concat "explicit-" name
"-args"))))
732 (unless (file-exists-p startfile
)
733 (setq startfile
(concat user-emacs-directory
"init_" name
".sh")))
734 (apply 'make-comint-in-buffer
"shell" buffer prog
735 (if (file-exists-p startfile
) startfile
)
736 (if (and xargs-name
(boundp xargs-name
))
737 (symbol-value xargs-name
)
742 ;;; Directory tracking
744 ;; This code provides the shell mode input sentinel
745 ;; SHELL-DIRECTORY-TRACKER
746 ;; that tracks cd, pushd, and popd commands issued to the shell, and
747 ;; changes the current directory of the shell buffer accordingly.
749 ;; This is basically a fragile hack, although it's more accurate than
750 ;; the version in Emacs 18's shell.el. It has the following failings:
751 ;; 1. It doesn't know about the cdpath shell variable.
752 ;; 2. It cannot infallibly deal with command sequences, though it does well
753 ;; with these and with ignoring commands forked in another shell with ()s.
754 ;; 3. More generally, any complex command is going to throw it. Otherwise,
755 ;; you'd have to build an entire shell interpreter in Emacs Lisp. Failing
756 ;; that, there's no way to catch shell commands where cd's are buried
757 ;; inside conditional expressions, aliases, and so forth.
759 ;; The whole approach is a crock. Shell aliases mess it up. File sourcing
760 ;; messes it up. You run other processes under the shell; these each have
761 ;; separate working directories, and some have commands for manipulating
762 ;; their w.d.'s (e.g., the lcd command in ftp). Some of these programs have
763 ;; commands that do *not* affect the current w.d. at all, but look like they
764 ;; do (e.g., the cd command in ftp). In shells that allow you job
765 ;; control, you can switch between jobs, all having different w.d.'s. So
766 ;; simply saying %3 can shift your w.d..
768 ;; The solution is to relax, not stress out about it, and settle for
769 ;; a hack that works pretty well in typical circumstances. Remember
770 ;; that a half-assed solution is more in keeping with the spirit of Unix,
773 ;; One good hack not implemented here for users of programmable shells
774 ;; is to program up the shell w.d. manipulation commands to output
775 ;; a coded command sequence to the tty. Something like
777 ;; where <cwd> is the new current working directory. Then trash the
778 ;; directory tracking machinery currently used in this package, and
779 ;; replace it with a process filter that watches for and strips out
782 (defun shell-directory-tracker (str)
783 "Tracks cd, pushd and popd commands issued to the shell.
784 This function is called on each input passed to the shell.
785 It watches for cd, pushd and popd commands and sets the buffer's
786 default directory to track these commands.
788 You may toggle this tracking on and off with \\[shell-dirtrack-mode].
789 If Emacs gets confused, you can resync with the shell with \\[dirs].
790 \(The `dirtrack' package provides an alternative implementation of this
791 feature - see the function `dirtrack-mode'.)
793 See variables `shell-cd-regexp', `shell-chdrive-regexp', `shell-pushd-regexp',
794 and `shell-popd-regexp', while `shell-pushd-tohome', `shell-pushd-dextract',
795 and `shell-pushd-dunique' control the behavior of the relevant command.
797 Environment variables are expanded, see function `substitute-in-file-name'."
799 ;; We fail gracefully if we think the command will fail in the shell.
800 ;;; (with-demoted-errors "Directory tracker failure: %s"
801 ;; This fails so often that it seems better to just ignore errors (?).
802 ;; Eg even: foo=/tmp; cd $foo is beyond us (bug#17159).
804 (let ((start (progn (string-match
805 (concat "^" shell-command-separator-regexp
)
806 str
) ; skip whitespace
810 (while (string-match shell-command-regexp str start
)
811 (setq end
(match-end 0)
812 cmd
(comint-arguments (substring str start end
) 0 0)
813 arg1
(comint-arguments (substring str start end
) 1 1))
815 (setq arg1
(shell-unquote-argument arg1
)))
816 (cond ((string-match (concat "\\`\\(" shell-popd-regexp
817 "\\)\\($\\|[ \t]\\)")
819 (shell-process-popd (comint-substitute-in-file-name arg1
)))
820 ((string-match (concat "\\`\\(" shell-pushd-regexp
821 "\\)\\($\\|[ \t]\\)")
823 (shell-process-pushd (comint-substitute-in-file-name arg1
)))
824 ((string-match (concat "\\`\\(" shell-cd-regexp
825 "\\)\\($\\|[ \t]\\)")
827 (shell-process-cd (comint-substitute-in-file-name arg1
)))
828 ((and shell-chdrive-regexp
829 (string-match (concat "\\`\\(" shell-chdrive-regexp
830 "\\)\\($\\|[ \t]\\)")
832 (shell-process-cd (comint-substitute-in-file-name cmd
))))
833 (setq start
(progn (string-match shell-command-separator-regexp
838 (defun shell-unquote-argument (string)
839 "Remove all kinds of shell quoting from STRING."
841 (let ((idx 0) next inside
843 (if (string-match shell-dumb-shell-regexp
844 (file-name-nondirectory
845 (car (process-command (get-buffer-process (current-buffer))))))
848 (while (and (< idx
(length string
))
849 (setq next
(string-match quote-chars string next
)))
850 (cond ((= (aref string next
) ?
\\)
851 (setq string
(replace-match "" nil nil string
))
852 (setq next
(1+ next
)))
853 ((and inside
(= (aref string next
) inside
))
854 (setq string
(replace-match "" nil nil string
))
857 (setq next
(1+ next
)))
859 (setq inside
(aref string next
))
860 (setq string
(replace-match "" nil nil string
)))))
864 (defun shell-process-popd (arg)
865 (let ((num (or (shell-extract-num arg
) 0)))
866 (cond ((and num
(= num
0) shell-dirstack
)
867 (shell-cd (shell-prefixed-directory-name (car shell-dirstack
)))
868 (setq shell-dirstack
(cdr shell-dirstack
))
869 (shell-dirstack-message))
870 ((and num
(> num
0) (<= num
(length shell-dirstack
)))
871 (let* ((ds (cons nil shell-dirstack
))
872 (cell (nthcdr (1- num
) ds
)))
873 (rplacd cell
(cdr (cdr cell
)))
874 (setq shell-dirstack
(cdr ds
))
875 (shell-dirstack-message)))
877 (error "Couldn't popd")))))
879 ;; Return DIR prefixed with comint-file-name-prefix as appropriate.
880 (defun shell-prefixed-directory-name (dir)
881 (if (= (length comint-file-name-prefix
) 0)
883 (if (file-name-absolute-p dir
)
884 ;; The name is absolute, so prepend the prefix.
885 (concat comint-file-name-prefix dir
)
886 ;; For relative name we assume default-directory already has the prefix.
887 (expand-file-name dir
))))
890 (defun shell-process-cd (arg)
891 (let ((new-dir (cond ((zerop (length arg
)) (concat comint-file-name-prefix
893 ((string-equal "-" arg
) shell-last-dir
)
894 (t (shell-prefixed-directory-name arg
)))))
895 (setq shell-last-dir default-directory
)
897 (shell-dirstack-message)))
900 (defun shell-process-pushd (arg)
901 (let ((num (shell-extract-num arg
)))
902 (cond ((zerop (length arg
))
903 ;; no arg -- swap pwd and car of stack unless shell-pushd-tohome
904 (cond (shell-pushd-tohome
905 (shell-process-pushd (concat comint-file-name-prefix
"~")))
907 (let ((old default-directory
))
908 (shell-cd (car shell-dirstack
))
909 (setq shell-dirstack
(cons old
(cdr shell-dirstack
)))
910 (shell-dirstack-message)))
912 (message "Directory stack empty."))))
915 (cond ((> num
(length shell-dirstack
))
916 (message "Directory stack not that deep."))
918 (error "Couldn't cd"))
919 (shell-pushd-dextract
920 (let ((dir (nth (1- num
) shell-dirstack
)))
921 (shell-process-popd arg
)
922 (shell-process-pushd default-directory
)
924 (shell-dirstack-message)))
926 (let* ((ds (cons default-directory shell-dirstack
))
928 (front (nthcdr num ds
))
929 (back (reverse (nthcdr (- dslen num
) (reverse ds
))))
930 (new-ds (append front back
)))
931 (shell-cd (car new-ds
))
932 (setq shell-dirstack
(cdr new-ds
))
933 (shell-dirstack-message)))))
936 (let ((old-wd default-directory
))
937 (shell-cd (shell-prefixed-directory-name arg
))
938 (if (or (null shell-pushd-dunique
)
939 (not (member old-wd shell-dirstack
)))
940 (setq shell-dirstack
(cons old-wd shell-dirstack
)))
941 (shell-dirstack-message))))))
943 ;; If STR is of the form +n, for n>0, return n. Otherwise, nil.
944 (defun shell-extract-num (str)
945 (and (string-match "^\\+[1-9][0-9]*$" str
)
946 (string-to-number str
)))
948 (defvaralias 'shell-dirtrack-mode
'shell-dirtrackp
)
949 (define-minor-mode shell-dirtrack-mode
950 "Toggle directory tracking in this shell buffer (Shell Dirtrack mode).
951 With a prefix argument ARG, enable Shell Dirtrack mode if ARG is
952 positive, and disable it otherwise. If called from Lisp, enable
953 the mode if ARG is omitted or nil.
955 The `dirtrack' package provides an alternative implementation of
956 this feature; see the function `dirtrack-mode'."
958 (setq list-buffers-directory
(if shell-dirtrack-mode default-directory
))
959 (if shell-dirtrack-mode
960 (add-hook 'comint-input-filter-functions
'shell-directory-tracker nil t
)
961 (remove-hook 'comint-input-filter-functions
'shell-directory-tracker t
)))
963 (define-obsolete-function-alias 'shell-dirtrack-toggle
'shell-dirtrack-mode
966 (defun shell-cd (dir)
967 "Do normal `cd' to DIR, and set `list-buffers-directory'."
970 (setq list-buffers-directory default-directory
)))
972 (defun shell-resync-dirs ()
973 "Resync the buffer's idea of the current directory stack.
974 This command queries the shell with the command bound to
975 `shell-dirstack-query' (default \"dirs\"), reads the next
976 line output and parses it to form the new directory stack.
977 DON'T issue this command unless the buffer is at a shell prompt.
978 Also, note that if some other subprocess decides to do output
979 immediately after the query, its output will be taken as the
980 new directory stack -- you lose. If this happens, just do the
983 (let* ((proc (get-buffer-process (current-buffer)))
984 (pmark (process-mark proc
))
985 (started-at-pmark (= (point) (marker-position pmark
))))
988 ;; If the process echoes commands, don't insert a fake command in
989 ;; the buffer or it will appear twice.
990 (unless comint-process-echoes
991 (insert shell-dirstack-query
) (insert "\n"))
992 (sit-for 0) ; force redisplay
993 (comint-send-string proc shell-dirstack-query
)
994 (comint-send-string proc
"\n")
995 (set-marker pmark
(point))
999 (if comint-process-echoes
1000 ;; Skip command echo if the process echoes
1001 (concat "\\(" (regexp-quote shell-dirstack-query
) "\n\\)")
1004 ;; This extra newline prevents the user's pending input from spoofing us.
1005 (insert "\n") (backward-char 1)
1006 ;; Wait for one line.
1007 (while (not (looking-at regexp
))
1008 (accept-process-output proc
)
1010 (goto-char pmark
) (delete-char 1) ; remove the extra newline
1011 ;; That's the dirlist. grab it & parse it.
1012 (let* ((dl (buffer-substring (match-beginning 2) (1- (match-end 2))))
1013 (dl-len (length dl
))
1014 (ds '()) ; new dir stack
1017 ;; regexp = optional whitespace, (non-whitespace), optional whitespace
1018 (string-match "\\s *\\(\\S +\\)\\s *" dl i
) ; pick off next dir
1019 (setq ds
(cons (concat comint-file-name-prefix
1020 (substring dl
(match-beginning 1)
1023 (setq i
(match-end 0)))
1024 (let ((ds (nreverse ds
)))
1025 (with-demoted-errors "Couldn't cd: %s"
1027 (setq shell-dirstack
(cdr ds
)
1028 shell-last-dir
(car shell-dirstack
))
1029 (shell-dirstack-message)))))
1030 (if started-at-pmark
(goto-char (marker-position pmark
)))))
1032 ;; For your typing convenience:
1033 (defalias 'dirs
'shell-resync-dirs
)
1036 ;; Show the current dirstack on the message line.
1037 ;; Pretty up dirs a bit by changing "/usr/jqr/foo" to "~/foo".
1038 ;; (This isn't necessary if the dirlisting is generated with a simple "dirs".)
1039 ;; All the commands that mung the buffer's dirstack finish by calling
1041 (defun shell-dirstack-message ()
1042 (when shell-dirtrack-verbose
1044 (ds (cons default-directory shell-dirstack
))
1045 (home (expand-file-name (concat comint-file-name-prefix
"~/")))
1046 (homelen (length home
)))
1048 (let ((dir (car ds
)))
1049 (and (>= (length dir
) homelen
)
1050 (string= home
(substring dir
0 homelen
))
1051 (setq dir
(concat "~/" (substring dir homelen
))))
1052 ;; Strip off comint-file-name-prefix if present.
1053 (and comint-file-name-prefix
1054 (>= (length dir
) (length comint-file-name-prefix
))
1055 (string= comint-file-name-prefix
1056 (substring dir
0 (length comint-file-name-prefix
)))
1057 (setq dir
(substring dir
(length comint-file-name-prefix
)))
1059 (setq msg
(concat msg
(directory-file-name dir
) " "))
1060 (setq ds
(cdr ds
))))
1061 (message "%s" msg
))))
1063 ;; This was mostly copied from shell-resync-dirs.
1064 (defun shell-snarf-envar (var)
1065 "Return as a string the shell's value of environment variable VAR."
1066 (let* ((cmd (format "printenv '%s'\n" var
))
1067 (proc (get-buffer-process (current-buffer)))
1068 (pmark (process-mark proc
)))
1071 (sit-for 0) ; force redisplay
1072 (comint-send-string proc cmd
)
1073 (set-marker pmark
(point))
1074 (let ((pt (point))) ; wait for 1 line
1075 ;; This extra newline prevents the user's pending input from spoofing us.
1076 (insert "\n") (backward-char 1)
1077 (while (not (looking-at ".+\n"))
1078 (accept-process-output proc
)
1080 (goto-char pmark
) (delete-char 1) ; remove the extra newline
1081 (buffer-substring (match-beginning 0) (1- (match-end 0)))))
1083 (defun shell-copy-environment-variable (variable)
1084 "Copy the environment variable VARIABLE from the subshell to Emacs.
1085 This command reads the value of the specified environment variable
1086 in the shell, and sets the same environment variable in Emacs
1087 \(what `getenv' in Emacs would return) to that value.
1088 That value will affect any new subprocesses that you subsequently start
1090 (interactive (list (read-envvar-name "\
1091 Copy Shell environment variable to Emacs: ")))
1092 (setenv variable
(shell-snarf-envar variable
)))
1094 (defun shell-forward-command (&optional arg
)
1095 "Move forward across ARG shell command(s). Does not cross lines.
1096 See `shell-command-regexp'."
1098 (let ((limit (line-end-position))
1100 (re-search-forward (concat shell-command-regexp
"\\([;&|][\t ]*\\)+")
1102 (and (/= pt
(point))
1103 (skip-syntax-backward " " pt
))))
1106 (defun shell-backward-command (&optional arg
)
1107 "Move backward across ARG shell command(s). Does not cross lines.
1108 See `shell-command-regexp'."
1110 (let ((limit (save-excursion (comint-bol nil
) (point))))
1111 (when (> limit
(point))
1112 (setq limit
(line-beginning-position)))
1113 (skip-syntax-backward " " limit
)
1115 (if (re-search-backward
1116 (format "[;&|]+[\t ]*\\(%s\\)" shell-command-regexp
) limit
'move arg
)
1117 (progn (goto-char (match-beginning 1))
1118 (skip-chars-forward ";&|")))
1119 (and (/= pt
(point))
1120 (skip-syntax-forward " " pt
)))))
1122 (defun shell-dynamic-complete-command ()
1123 "Dynamically complete the command at point.
1124 This function is similar to `comint-dynamic-complete-filename', except that it
1125 searches `exec-path' (minus trailing `exec-directory') for completion
1126 candidates. Note that this may not be the same as the shell's idea of the
1129 Completion is dependent on the value of `shell-completion-execonly',
1130 `shell-completion-fignore', plus those that affect file completion. See Info
1131 node `Shell Options'.
1133 Returns t if successful."
1135 (let ((data (shell-command-completion)))
1137 (prog2 (unless (window-minibuffer-p)
1138 (message "Completing command name..."))
1139 (apply #'completion-in-region data
)))))
1141 (defun shell-command-completion ()
1142 "Return the completion data for the command at point, if any."
1143 (let ((filename (comint-match-partial-filename)))
1145 (save-match-data (not (string-match "[~/]" filename
)))
1146 (eq (match-beginning 0)
1147 (save-excursion (shell-backward-command 1) (point))))
1148 (shell--command-completion-data))))
1150 (defun shell--command-completion-data ()
1151 "Return the completion data for the command at point."
1152 (let* ((filename (or (comint-match-partial-filename) ""))
1153 (start (if (zerop (length filename
)) (point) (match-beginning 0)))
1154 (end (if (zerop (length filename
)) (point) (match-end 0)))
1155 (filenondir (file-name-nondirectory filename
))
1156 ; why cdr? see `shell-dynamic-complete-command'
1157 (path-dirs (append (cdr (reverse exec-path
))
1158 (if (memq system-type
'(windows-nt ms-dos
)) '("."))))
1159 (cwd (file-name-as-directory (expand-file-name default-directory
)))
1161 (and comint-completion-fignore
1162 (mapconcat (function (lambda (x) (concat (regexp-quote x
) "\\'")))
1163 comint-completion-fignore
"\\|")))
1164 (dir "") (comps-in-dir ())
1165 (file "") (abs-file-name "") (completions ()))
1166 ;; Go thru each dir in the search path, finding completions.
1168 (setq dir
(file-name-as-directory (comint-directory (or (car path-dirs
) ".")))
1169 comps-in-dir
(and (file-accessible-directory-p dir
)
1170 (file-name-all-completions filenondir dir
)))
1171 ;; Go thru each completion found, to see whether it should be used.
1173 (setq file
(car comps-in-dir
)
1174 abs-file-name
(concat dir file
))
1175 (if (and (not (member file completions
))
1176 (not (and ignored-extensions
1177 (string-match ignored-extensions file
)))
1178 (or (string-equal dir cwd
)
1179 (not (file-directory-p abs-file-name
)))
1180 (or (null shell-completion-execonly
)
1181 (file-executable-p abs-file-name
)))
1182 (setq completions
(cons file completions
)))
1183 (setq comps-in-dir
(cdr comps-in-dir
)))
1184 (setq path-dirs
(cdr path-dirs
)))
1185 ;; OK, we've got a list of completions.
1188 (lambda (string pred action
)
1189 (if (string-match "/" string
)
1190 (completion-file-name-table string pred action
)
1191 (complete-with-action action completions string pred
)))
1193 (lambda (_string finished
)
1194 (when (memq finished
'(sole finished
))
1195 (if (looking-at " ")
1196 (goto-char (match-end 0))
1199 ;; (defun shell-dynamic-complete-as-command ()
1200 ;; "Dynamically complete at point as a command.
1201 ;; See `shell-dynamic-complete-filename'. Returns t if successful."
1202 ;; (apply #'completion-in-region shell--command-completion-data))
1204 (defun shell-dynamic-complete-filename ()
1205 "Dynamically complete the filename at point.
1206 This completes only if point is at a suitable position for a
1209 (let ((data (shell-filename-completion)))
1210 (if data
(apply #'completion-in-region data
))))
1212 (defun shell-filename-completion ()
1213 "Return the completion data for file name at point, if any."
1214 (let ((opoint (point))
1215 (beg (comint-line-beginning-position)))
1216 (when (save-excursion
1217 (goto-char (if (re-search-backward "[;|&]" beg t
)
1220 (re-search-forward "[^ \t][ \t]" opoint t
))
1221 (comint-filename-completion))))
1223 (defun shell-match-partial-variable ()
1224 "Return the shell variable at point, or nil if none is found."
1226 (if (re-search-backward "[^A-Za-z0-9_{(]" nil
'move
)
1227 (or (looking-at "\\$") (forward-char 1)))
1228 (if (or (eolp) (looking-at "[^A-Za-z0-9_{($]"))
1230 (looking-at "\\$?[{(]?[A-Za-z0-9_]*[})]?")
1231 (buffer-substring (match-beginning 0) (match-end 0)))))
1233 (defun shell-dynamic-complete-environment-variable ()
1234 "Dynamically complete the environment variable at point.
1235 Completes if after a variable, i.e., if it starts with a \"$\".
1237 This function is similar to `comint-dynamic-complete-filename', except that it
1238 searches `process-environment' for completion candidates. Note that this may
1239 not be the same as the interpreter's idea of variable names. The main problem
1240 with this type of completion is that `process-environment' is the environment
1241 which Emacs started with. Emacs does not track changes to the environment made
1242 by the interpreter. Perhaps it would be more accurate if this function was
1243 called `shell-dynamic-complete-process-environment-variable'.
1245 Returns non-nil if successful."
1247 (let ((data (shell-environment-variable-completion)))
1249 (prog2 (unless (window-minibuffer-p)
1250 (message "Completing variable name..."))
1251 (apply #'completion-in-region data
)))))
1254 (defun shell-environment-variable-completion ()
1255 "Completion data for an environment variable at point, if any."
1256 (let* ((var (shell-match-partial-variable))
1257 (end (match-end 0)))
1258 (when (and (not (zerop (length var
))) (eq (aref var
0) ?$
))
1261 (goto-char (match-beginning 0))
1262 (looking-at "\\$?[({]*")
1264 (variables (mapcar (lambda (x)
1265 (substring x
0 (string-match "=" x
)))
1266 process-environment
))
1267 (suffix (pcase (char-before start
) (?\
{ "}") (?\
( ")") (_ ""))))
1268 (list start end variables
1270 (lambda (s finished
)
1271 (when (memq finished
'(sole finished
))
1272 (let ((suf (concat suffix
1273 (if (file-directory-p
1274 (comint-directory (getenv s
)))
1276 (if (looking-at (regexp-quote suf
))
1277 (goto-char (match-end 0))
1278 (insert suf
))))))))))
1281 (defun shell-c-a-p-replace-by-expanded-directory ()
1282 "Expand directory stack reference before point.
1283 For use on `completion-at-point-functions'."
1284 (when (comint-match-partial-filename)
1286 (goto-char (match-beginning 0))
1287 (let ((stack (cons default-directory shell-dirstack
))
1288 (index (cond ((looking-at "=-/?")
1289 (length shell-dirstack
))
1290 ((looking-at "=\\([0-9]+\\)/?")
1293 (match-beginning 1) (match-end 1)))))))
1295 (let ((start (match-beginning 0))
1297 (replacement (file-name-as-directory (nth index stack
))))
1300 ((>= index
(length stack
))
1301 (error "Directory stack not that deep"))
1305 (insert replacement
)
1306 (delete-char (- end start
)))
1307 (message "Directory item: %d" index
)
1310 (defun shell-replace-by-expanded-directory ()
1311 "Expand directory stack reference before point.
1312 Directory stack references are of the form \"=digit\" or \"=-\".
1313 See `default-directory' and `shell-dirstack'.
1315 Returns t if successful."
1317 (let ((f (shell-c-a-p-replace-by-expanded-directory)))
1318 (if f
(funcall f
))))
1322 ;;; shell.el ends here