Commit | Line | Data |
---|---|---|
1cd7adc6 | 1 | ;;; shell.el --- specialized comint.el for running the shell |
5109bfb0 | 2 | |
c90f2757 | 3 | ;; Copyright (C) 1988, 1993, 1994, 1995, 1996, 1997, 2000, 2001, |
409cc4a3 | 4 | ;; 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
6d74b528 | 5 | |
1cd7adc6 | 6 | ;; Author: Olin Shivers <shivers@cs.cmu.edu> |
5762abec | 7 | ;; Simon Marshall <simon@gnu.org> |
f8604035 | 8 | ;; Maintainer: FSF |
d7b4d18f | 9 | ;; Keywords: processes |
630cc463 | 10 | |
5109bfb0 | 11 | ;; This file is part of GNU Emacs. |
c88ab9ce | 12 | |
5109bfb0 KH |
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 | |
b4aa6026 | 15 | ;; the Free Software Foundation; either version 3, or (at your option) |
5109bfb0 | 16 | ;; any later version. |
c88ab9ce | 17 | |
5109bfb0 KH |
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. | |
c88ab9ce | 22 | |
5109bfb0 | 23 | ;; You should have received a copy of the GNU General Public License |
b578f267 | 24 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
086add15 LK |
25 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
26 | ;; Boston, MA 02110-1301, USA. | |
be9b65ac | 27 | |
630cc463 ER |
28 | ;;; Commentary: |
29 | ||
b578f267 EN |
30 | ;; Please send me bug reports, bug fixes, and extensions, so that I can |
31 | ;; merge them into the master source. | |
32 | ;; - Olin Shivers (shivers@cs.cmu.edu) | |
5762abec | 33 | ;; - Simon Marshall (simon@gnu.org) |
be9b65ac | 34 | |
4696802b JB |
35 | ;; This file defines a shell-in-a-buffer package (shell mode) built on |
36 | ;; top of comint mode. This is actually cmushell with things renamed | |
37 | ;; to replace its counterpart in Emacs 18. cmushell is more | |
b578f267 | 38 | ;; featureful, robust, and uniform than the Emacs 18 version. |
be9b65ac | 39 | |
b578f267 | 40 | ;; Since this mode is built on top of the general command-interpreter-in- |
84728570 | 41 | ;; a-buffer mode (comint mode), it shares a common base functionality, |
b578f267 EN |
42 | ;; and a common set of bindings, with all modes derived from comint mode. |
43 | ;; This makes these modes easier to use. | |
be9b65ac | 44 | |
b578f267 EN |
45 | ;; For documentation on the functionality provided by comint mode, and |
46 | ;; the hooks available for customising it, see the file comint.el. | |
47 | ;; For further information on shell mode, see the comments below. | |
be9b65ac | 48 | |
b578f267 | 49 | ;; Needs fixin: |
84728570 | 50 | ;; When sending text from a source file to a subprocess, the process-mark can |
b578f267 EN |
51 | ;; move off the window, so you can lose sight of the process interactions. |
52 | ;; Maybe I should ensure the process mark is in the window when I send | |
53 | ;; text to the process? Switch selectable? | |
be9b65ac | 54 | |
a9ec2adb JB |
55 | ;; YOUR .EMACS FILE |
56 | ;;============================================================================= | |
57 | ;; Some suggestions for your .emacs file. | |
58 | ;; | |
0b3c9cf1 SM |
59 | ;; ;; Define M-# to run some strange command: |
60 | ;; (eval-after-load "shell" | |
61 | ;; '(define-key shell-mode-map "\M-#" 'shells-dynamic-spell)) | |
84728570 | 62 | |
b578f267 EN |
63 | ;; Brief Command Documentation: |
64 | ;;============================================================================ | |
65 | ;; Comint Mode Commands: (common to shell and all comint-derived modes) | |
66 | ;; | |
a9e73449 RS |
67 | ;; m-p comint-previous-input Cycle backwards in input history |
68 | ;; m-n comint-next-input Cycle forwards | |
b578f267 EN |
69 | ;; m-r comint-previous-matching-input Previous input matching a regexp |
70 | ;; m-s comint-next-matching-input Next input that matches | |
a9e73449 | 71 | ;; m-c-l comint-show-output Show last batch of process output |
b578f267 | 72 | ;; return comint-send-input |
a9e73449 | 73 | ;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff. |
b578f267 | 74 | ;; c-c c-a comint-bol Beginning of line; skip prompt |
a9e73449 RS |
75 | ;; c-c c-u comint-kill-input ^u |
76 | ;; c-c c-w backward-kill-word ^w | |
77 | ;; c-c c-c comint-interrupt-subjob ^c | |
78 | ;; c-c c-z comint-stop-subjob ^z | |
79 | ;; c-c c-\ comint-quit-subjob ^\ | |
80 | ;; c-c c-o comint-kill-output Delete last batch of process output | |
81 | ;; c-c c-r comint-show-output Show last batch of process output | |
94c34f7a | 82 | ;; c-c c-l comint-dynamic-list-input-ring List input history |
b578f267 | 83 | ;; send-invisible Read line w/o echo & send to proc |
a9e73449 | 84 | ;; comint-continue-subjob Useful if you accidentally suspend |
b578f267 EN |
85 | ;; top-level job |
86 | ;; comint-mode-hook is the comint mode hook. | |
87 | ||
88 | ;; Shell Mode Commands: | |
89 | ;; shell Fires up the shell process | |
90 | ;; tab comint-dynamic-complete Complete filename/command/history | |
91 | ;; m-? comint-dynamic-list-filename-completions | |
92 | ;; List completions in help buffer | |
93 | ;; m-c-f shell-forward-command Forward a shell command | |
94 | ;; m-c-b shell-backward-command Backward a shell command | |
a9e73449 | 95 | ;; dirs Resync the buffer's dir stack |
0a9f2dcf | 96 | ;; shell-dirtrack-mode Turn dir tracking on/off |
b578f267 EN |
97 | ;; comint-strip-ctrl-m Remove trailing ^Ms from output |
98 | ;; | |
99 | ;; The shell mode hook is shell-mode-hook | |
100 | ;; comint-prompt-regexp is initialised to shell-prompt-pattern, for backwards | |
101 | ;; compatibility. | |
a9ec2adb | 102 | |
b578f267 | 103 | ;; Read the rest of this file for more information. |
84728570 | 104 | |
630cc463 ER |
105 | ;;; Code: |
106 | ||
107 | (require 'comint) | |
108 | ||
b578f267 EN |
109 | ;;; Customization and Buffer Variables |
110 | ||
ed366e87 | 111 | (defgroup shell nil |
edf959f9 | 112 | "Running shell from within Emacs buffers." |
ed366e87 RS |
113 | :group 'processes |
114 | :group 'unix) | |
115 | ||
116 | (defgroup shell-directories nil | |
edf959f9 | 117 | "Directory support in shell mode." |
ed366e87 RS |
118 | :group 'shell) |
119 | ||
120 | (defgroup shell-faces nil | |
edf959f9 | 121 | "Faces in shell buffers." |
ed366e87 RS |
122 | :group 'shell) |
123 | ||
c88ab9ce | 124 | ;;;###autoload |
4dced927 | 125 | (defcustom shell-dumb-shell-regexp "cmd\\(proxy\\)?\\.exe" |
f5058b96 EZ |
126 | "Regexp to match shells that don't save their command history, and |
127 | don't handle the backslash as a quote character. For shells that | |
128 | match this regexp, Emacs will write out the command history when the | |
129 | shell finishes, and won't remove backslashes when it unquotes shell | |
130 | arguments." | |
4dced927 AI |
131 | :type 'regexp |
132 | :group 'shell) | |
133 | ||
fad22e2e | 134 | (defcustom shell-prompt-pattern "^[^#$%>\n]*[#$%>] *" |
a9ec2adb | 135 | "Regexp to match prompts in the inferior shell. |
ac75ef20 | 136 | Defaults to \"^[^#$%>\\n]*[#$%>] *\", which works pretty well. |
2df2f980 | 137 | This variable is used to initialize `comint-prompt-regexp' in the |
a9ec2adb JB |
138 | shell buffer. |
139 | ||
e03035e3 LT |
140 | If `comint-use-prompt-regexp' is nil, then this variable is only used |
141 | to determine paragraph boundaries. See Info node `Shell Prompts' for | |
142 | how Shell mode treats paragraphs. | |
28bc09d6 | 143 | |
ac75ef20 | 144 | The pattern should probably not match more than one line. If it does, |
221ca406 | 145 | Shell mode may become confused trying to distinguish prompt from input |
ac75ef20 JB |
146 | on lines which don't start with a prompt. |
147 | ||
fad22e2e RS |
148 | This is a fine thing to set in your `.emacs' file." |
149 | :type 'regexp | |
150 | :group 'shell) | |
a9ec2adb | 151 | |
ed366e87 | 152 | (defcustom shell-completion-fignore nil |
05327ca9 | 153 | "List of suffixes to be disregarded during file/command completion. |
e11284d5 RS |
154 | This variable is used to initialize `comint-completion-fignore' in the shell |
155 | buffer. The default is nil, for compatibility with most shells. | |
156 | Some people like (\"~\" \"#\" \"%\"). | |
157 | ||
ed366e87 RS |
158 | This is a fine thing to set in your `.emacs' file." |
159 | :type '(repeat (string :tag "Suffix")) | |
160 | :group 'shell) | |
e11284d5 | 161 | |
56eb1060 | 162 | (defvar shell-delimiter-argument-list '(?\| ?& ?< ?> ?\( ?\) ?\;) |
2df2f980 | 163 | "List of characters to recognize as separate arguments. |
56eb1060 | 164 | This variable is used to initialize `comint-delimiter-argument-list' in the |
39d1a2ce SM |
165 | shell buffer. The value may depend on the operating system or shell. |
166 | ||
167 | This is a fine thing to set in your `.emacs' file.") | |
168 | ||
76f63ea0 | 169 | (defvar shell-file-name-chars |
c60ee5e7 | 170 | (if (memq system-type '(ms-dos windows-nt cygwin)) |
4aed0379 | 171 | "~/A-Za-z0-9_^$!#%&{}@`'.,:()-" |
f0d5dc24 | 172 | "[]~/A-Za-z0-9+@:_.$#%,={}-") |
76f63ea0 RS |
173 | "String of characters valid in a file name. |
174 | This variable is used to initialize `comint-file-name-chars' in the | |
39d1a2ce | 175 | shell buffer. The value may depend on the operating system or shell. |
d76b71af RS |
176 | |
177 | This is a fine thing to set in your `.emacs' file.") | |
178 | ||
7b4c6503 | 179 | (defvar shell-file-name-quote-list |
39d1a2ce SM |
180 | (if (memq system-type '(ms-dos windows-nt)) |
181 | nil | |
edf959f9 | 182 | (append shell-delimiter-argument-list '(?\s ?\* ?\! ?\" ?\' ?\` ?\# ?\\))) |
7b4c6503 SM |
183 | "List of characters to quote when in a file name. |
184 | This variable is used to initialize `comint-file-name-quote-list' in the | |
39d1a2ce | 185 | shell buffer. The value may depend on the operating system or shell. |
7b4c6503 SM |
186 | |
187 | This is a fine thing to set in your `.emacs' file.") | |
188 | ||
988a4d60 RS |
189 | (defvar shell-dynamic-complete-functions |
190 | '(comint-replace-by-expanded-history | |
191 | shell-dynamic-complete-environment-variable | |
192 | shell-dynamic-complete-command | |
193 | shell-replace-by-expanded-directory | |
194 | comint-dynamic-complete-filename) | |
195 | "List of functions called to perform completion. | |
2df2f980 | 196 | This variable is used to initialize `comint-dynamic-complete-functions' in the |
988a4d60 RS |
197 | shell buffer. |
198 | ||
199 | This is a fine thing to set in your `.emacs' file.") | |
200 | ||
ed366e87 | 201 | (defcustom shell-command-regexp "[^;&|\n]+" |
05327ca9 | 202 | "Regexp to match a single command within a pipeline. |
ed366e87 RS |
203 | This is used for directory tracking and does not do a perfect job." |
204 | :type 'regexp | |
205 | :group 'shell) | |
d76b71af | 206 | |
6ed020c8 | 207 | (defcustom shell-command-separator-regexp "[;&|\n \t]*" |
05327ca9 | 208 | "Regexp to match a single command within a pipeline. |
6ed020c8 JB |
209 | This is used for directory tracking and does not do a perfect job." |
210 | :type 'regexp | |
211 | :group 'shell) | |
212 | ||
ed366e87 | 213 | (defcustom shell-completion-execonly t |
05327ca9 | 214 | "If non-nil, use executable files only for completion candidates. |
5394cb44 | 215 | This mirrors the optional behavior of tcsh. |
d76b71af | 216 | |
ed366e87 RS |
217 | Detecting executability of files may slow command completion considerably." |
218 | :type 'boolean | |
219 | :group 'shell) | |
d76b71af | 220 | |
ed366e87 | 221 | (defcustom shell-popd-regexp "popd" |
05327ca9 | 222 | "Regexp to match subshell commands equivalent to popd." |
ed366e87 RS |
223 | :type 'regexp |
224 | :group 'shell-directories) | |
be9b65ac | 225 | |
ed366e87 | 226 | (defcustom shell-pushd-regexp "pushd" |
05327ca9 | 227 | "Regexp to match subshell commands equivalent to pushd." |
ed366e87 RS |
228 | :type 'regexp |
229 | :group 'shell-directories) | |
be9b65ac | 230 | |
ed366e87 | 231 | (defcustom shell-pushd-tohome nil |
05327ca9 | 232 | "If non-nil, make pushd with no arg behave as \"pushd ~\" (like cd). |
ed366e87 RS |
233 | This mirrors the optional behavior of tcsh." |
234 | :type 'boolean | |
235 | :group 'shell-directories) | |
d76b71af | 236 | |
ed366e87 | 237 | (defcustom shell-pushd-dextract nil |
05327ca9 | 238 | "If non-nil, make \"pushd +n\" pop the nth dir to the stack top. |
ed366e87 RS |
239 | This mirrors the optional behavior of tcsh." |
240 | :type 'boolean | |
241 | :group 'shell-directories) | |
d76b71af | 242 | |
ed366e87 | 243 | (defcustom shell-pushd-dunique nil |
05327ca9 | 244 | "If non-nil, make pushd only add unique directories to the stack. |
ed366e87 RS |
245 | This mirrors the optional behavior of tcsh." |
246 | :type 'boolean | |
247 | :group 'shell-directories) | |
d76b71af | 248 | |
ed366e87 | 249 | (defcustom shell-cd-regexp "cd" |
05327ca9 | 250 | "Regexp to match subshell commands equivalent to cd." |
ed366e87 RS |
251 | :type 'regexp |
252 | :group 'shell-directories) | |
be9b65ac | 253 | |
ed366e87 | 254 | (defcustom shell-chdrive-regexp |
84728570 | 255 | (if (memq system-type '(ms-dos windows-nt)) |
32d01212 RS |
256 | ; NetWare allows the five chars between upper and lower alphabetics. |
257 | "[]a-zA-Z^_`\\[\\\\]:" | |
258 | nil) | |
05327ca9 | 259 | "If non-nil, is regexp used to track drive changes." |
233f3fb8 RS |
260 | :type '(choice regexp |
261 | (const nil)) | |
ed366e87 | 262 | :group 'shell-directories) |
32d01212 | 263 | |
8a6387ed | 264 | (defcustom shell-dirtrack-verbose t |
05327ca9 | 265 | "If non-nil, show the directory stack following directory change. |
0a9f2dcf GM |
266 | This is effective only if directory tracking is enabled. |
267 | The `dirtrack' package provides an alternative implementation of this feature - | |
268 | see the function `dirtrack-mode'." | |
8a6387ed SM |
269 | :type 'boolean |
270 | :group 'shell-directories) | |
271 | ||
ed366e87 | 272 | (defcustom explicit-shell-file-name nil |
05327ca9 | 273 | "If non-nil, is file name to use for explicitly requested inferior shell." |
ed366e87 RS |
274 | :type '(choice (const :tag "None" nil) file) |
275 | :group 'shell) | |
be9b65ac | 276 | |
400b0022 KS |
277 | ;; Note: There are no explicit references to the variable `explicit-csh-args'. |
278 | ;; It is used implicitly by M-x shell when the shell is `csh'. | |
ed366e87 | 279 | (defcustom explicit-csh-args |
be9b65ac DL |
280 | (if (eq system-type 'hpux) |
281 | ;; -T persuades HP's csh not to think it is smarter | |
282 | ;; than us about what terminal modes to use. | |
283 | '("-i" "-T") | |
284 | '("-i")) | |
05327ca9 | 285 | "Args passed to inferior shell by \\[shell], if the shell is csh. |
ed366e87 RS |
286 | Value is a list of strings, which may be nil." |
287 | :type '(repeat (string :tag "Argument")) | |
288 | :group 'shell) | |
be9b65ac | 289 | |
400b0022 KS |
290 | ;; Note: There are no explicit references to the variable `explicit-bash-args'. |
291 | ;; It is used implicitly by M-x shell when the interactive shell is `bash'. | |
6674676b | 292 | (defcustom explicit-bash-args |
969a0631 KS |
293 | (let* ((prog (or (and (boundp 'explicit-shell-file-name) explicit-shell-file-name) |
294 | (getenv "ESHELL") shell-file-name)) | |
295 | (name (file-name-nondirectory prog))) | |
491bf4bc RS |
296 | ;; Tell bash not to use readline, except for bash 1.x which |
297 | ;; doesn't grook --noediting. Bash 1.x has -nolineediting, but | |
298 | ;; process-send-eof cannot terminate bash if we use it. | |
969a0631 KS |
299 | (if (and (not purify-flag) |
300 | (equal name "bash") | |
301 | (file-executable-p prog) | |
302 | (string-match "bad option" | |
88b7c0e4 KS |
303 | (shell-command-to-string |
304 | (concat (shell-quote-argument prog) | |
305 | " --noediting")))) | |
969a0631 KS |
306 | '("-i") |
307 | '("--noediting" "-i"))) | |
05327ca9 | 308 | "Args passed to inferior shell by \\[shell], if the shell is bash. |
6674676b AS |
309 | Value is a list of strings, which may be nil." |
310 | :type '(repeat (string :tag "Argument")) | |
311 | :group 'shell) | |
312 | ||
ed366e87 | 313 | (defcustom shell-input-autoexpand 'history |
05327ca9 | 314 | "If non-nil, expand input command history references on completion. |
4f99443b RS |
315 | This mirrors the optional behavior of tcsh (its autoexpand and histlit). |
316 | ||
317 | If the value is `input', then the expansion is seen on input. | |
318 | If the value is `history', then the expansion is only when inserting | |
319 | into the buffer's input ring. See also `comint-magic-space' and | |
320 | `comint-dynamic-complete'. | |
321 | ||
322 | This variable supplies a default for `comint-input-autoexpand', | |
ed366e87 | 323 | for Shell mode only." |
6f0984e5 AS |
324 | :type '(choice (const :tag "off" nil) |
325 | (const input) | |
326 | (const history) | |
327 | (const :tag "on" t)) | |
362ae0b3 | 328 | :group 'shell) |
4f99443b | 329 | |
be9b65ac | 330 | (defvar shell-dirstack nil |
c88ab9ce ER |
331 | "List of directories saved by pushd in this buffer's shell. |
332 | Thus, this does not include the shell's current directory.") | |
be9b65ac | 333 | |
b493a9b2 RS |
334 | (defvar shell-dirtrackp t |
335 | "Non-nil in a shell buffer means directory tracking is enabled.") | |
336 | ||
fa8f1b25 ER |
337 | (defvar shell-last-dir nil |
338 | "Keep track of last directory for ksh `cd -' command.") | |
339 | ||
c63e83a4 | 340 | (defvar shell-dirstack-query nil |
4dea1735 | 341 | "Command used by `shell-resync-dirs' to query the shell.") |
be9b65ac | 342 | |
9376442d | 343 | (defvar shell-mode-map nil) |
be9b65ac | 344 | (cond ((not shell-mode-map) |
1ed30e75 | 345 | (setq shell-mode-map (nconc (make-sparse-keymap) comint-mode-map)) |
d76b71af RS |
346 | (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command) |
347 | (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command) | |
8f36167a | 348 | (define-key shell-mode-map "\t" 'comint-dynamic-complete) |
d76b71af | 349 | (define-key shell-mode-map "\M-?" |
988a4d60 | 350 | 'comint-dynamic-list-filename-completions) |
1ed30e75 | 351 | (define-key shell-mode-map [menu-bar completion] |
f19be163 | 352 | (cons "Complete" |
cdf07453 | 353 | (copy-keymap (lookup-key comint-mode-map [menu-bar completion])))) |
5109bfb0 KH |
354 | (define-key-after (lookup-key shell-mode-map [menu-bar completion]) |
355 | [complete-env-variable] '("Complete Env. Variable Name" . | |
356 | shell-dynamic-complete-environment-variable) | |
357 | 'complete-file) | |
358 | (define-key-after (lookup-key shell-mode-map [menu-bar completion]) | |
359 | [expand-directory] '("Expand Directory Reference" . | |
360 | shell-replace-by-expanded-directory) | |
361 | 'complete-expand))) | |
be9b65ac | 362 | |
ed366e87 RS |
363 | (defcustom shell-mode-hook '() |
364 | "*Hook for customising Shell mode." | |
365 | :type 'hook | |
366 | :group 'shell) | |
be9b65ac | 367 | |
5945a1f7 | 368 | (defvar shell-font-lock-keywords |
cb6e07b1 | 369 | '(("[ \t]\\([+-][^ \t\n]+\\)" 1 font-lock-comment-face) |
473fbd89 SM |
370 | ("^[^ \t\n]+:.*" . font-lock-string-face) |
371 | ("^\\[[1-9][0-9]*\\]" . font-lock-string-face)) | |
5945a1f7 | 372 | "Additional expressions to highlight in Shell mode.") |
84728570 | 373 | |
be9b65ac | 374 | ;;; Basic Procedures |
be9b65ac | 375 | |
e9904b59 RS |
376 | (put 'shell-mode 'mode-class 'special) |
377 | ||
9f299ecb | 378 | (define-derived-mode shell-mode comint-mode "Shell" |
933907e9 | 379 | "Major mode for interacting with an inferior shell.\\<shell-mode-map> |
8079b590 SM |
380 | \\[comint-send-input] after the end of the process' output sends the text from |
381 | the end of process to the end of the current line. | |
382 | \\[comint-send-input] before end of process output copies the current line minus the prompt to | |
383 | the end of the buffer and sends it (\\[comint-copy-old-input] just copies the current line). | |
e9933cb1 | 384 | \\[send-invisible] reads a line of text without echoing it, and sends it to |
56783585 RS |
385 | the shell. This is useful for entering passwords. Or, add the function |
386 | `comint-watch-for-password-prompt' to `comint-output-filter-functions'. | |
be9b65ac | 387 | |
e9933cb1 SM |
388 | If you want to make multiple shell buffers, rename the `*shell*' buffer |
389 | using \\[rename-buffer] or \\[rename-uniquely] and start a new shell. | |
390 | ||
8079b590 | 391 | If you want to make shell buffers limited in length, add the function |
4841acc4 | 392 | `comint-truncate-buffer' to `comint-output-filter-functions'. |
8079b590 | 393 | |
be9b65ac DL |
394 | If you accidentally suspend your process, use \\[comint-continue-subjob] |
395 | to continue it. | |
396 | ||
e9933cb1 SM |
397 | `cd', `pushd' and `popd' commands given to the shell are watched by Emacs to |
398 | keep this buffer's default directory the same as the shell's working directory. | |
0b3c9cf1 SM |
399 | While directory tracking is enabled, the shell's working directory is displayed |
400 | by \\[list-buffers] or \\[mouse-buffer-menu] in the `File' field. | |
84728570 | 401 | \\[dirs] queries the shell and resyncs Emacs' idea of what the current |
be9b65ac | 402 | directory stack is. |
0a9f2dcf GM |
403 | \\[shell-dirtrack-mode] turns directory tracking on and off. |
404 | \(The `dirtrack' package provides an alternative implementation of this | |
405 | feature.) | |
be9b65ac DL |
406 | |
407 | \\{shell-mode-map} | |
24fdffaa | 408 | Customization: Entry to this mode runs the hooks on `comint-mode-hook' and |
988a4d60 | 409 | `shell-mode-hook' (in that order). Before each input, the hooks on |
ba02c167 RS |
410 | `comint-input-filter-functions' are run. After each shell output, the hooks |
411 | on `comint-output-filter-functions' are run. | |
be9b65ac | 412 | |
84728570 SS |
413 | Variables `shell-cd-regexp', `shell-chdrive-regexp', `shell-pushd-regexp' |
414 | and `shell-popd-regexp' are used to match their respective commands, | |
415 | while `shell-pushd-tohome', `shell-pushd-dextract' and `shell-pushd-dunique' | |
32d01212 | 416 | control the behavior of the relevant command. |
d76b71af | 417 | |
e11284d5 RS |
418 | Variables `comint-completion-autolist', `comint-completion-addsuffix', |
419 | `comint-completion-recexact' and `comint-completion-fignore' control the | |
420 | behavior of file name, command name and variable name completion. Variable | |
421 | `shell-completion-execonly' controls the behavior of command name completion. | |
2df2f980 | 422 | Variable `shell-completion-fignore' is used to initialize the value of |
e11284d5 | 423 | `comint-completion-fignore'. |
d76b71af RS |
424 | |
425 | Variables `comint-input-ring-file-name' and `comint-input-autoexpand' control | |
ab646e49 | 426 | the initialization of the input ring history, and history expansion. |
d76b71af | 427 | |
ba02c167 | 428 | Variables `comint-output-filter-functions', a hook, and |
e11284d5 | 429 | `comint-scroll-to-bottom-on-input' and `comint-scroll-to-bottom-on-output' |
988a4d60 RS |
430 | control whether input and output cause the window to scroll to the end of the |
431 | buffer." | |
d76b71af | 432 | (setq comint-prompt-regexp shell-prompt-pattern) |
e11284d5 | 433 | (setq comint-completion-fignore shell-completion-fignore) |
d76b71af | 434 | (setq comint-delimiter-argument-list shell-delimiter-argument-list) |
76f63ea0 | 435 | (setq comint-file-name-chars shell-file-name-chars) |
7b4c6503 | 436 | (setq comint-file-name-quote-list shell-file-name-quote-list) |
898cfc1d SM |
437 | (set (make-local-variable 'comint-dynamic-complete-functions) |
438 | shell-dynamic-complete-functions) | |
e03035e3 | 439 | (set (make-local-variable 'paragraph-separate) "\\'") |
d76b71af RS |
440 | (make-local-variable 'paragraph-start) |
441 | (setq paragraph-start comint-prompt-regexp) | |
c156572f SM |
442 | (make-local-variable 'font-lock-defaults) |
443 | (setq font-lock-defaults '(shell-font-lock-keywords t)) | |
be9b65ac | 444 | (make-local-variable 'shell-dirstack) |
a9ec2adb | 445 | (setq shell-dirstack nil) |
fdcc1ef7 | 446 | (make-local-variable 'shell-last-dir) |
fa8f1b25 | 447 | (setq shell-last-dir nil) |
4f99443b | 448 | (setq comint-input-autoexpand shell-input-autoexpand) |
5d9719e6 RS |
449 | ;; This is not really correct, since the shell buffer does not really |
450 | ;; edit this directory. But it is useful in the buffer list and menus. | |
451 | (make-local-variable 'list-buffers-directory) | |
438a5bf6 | 452 | (shell-dirtrack-mode 1) |
5d9719e6 | 453 | (setq list-buffers-directory (expand-file-name default-directory)) |
d76b71af | 454 | ;; shell-dependent assignments. |
6ba0fd3e | 455 | (when (ring-empty-p comint-input-ring) |
ee8107c0 RS |
456 | (let ((shell (file-name-nondirectory (car |
457 | (process-command (get-buffer-process (current-buffer))))))) | |
458 | (setq comint-input-ring-file-name | |
459 | (or (getenv "HISTFILE") | |
460 | (cond ((string-equal shell "bash") "~/.bash_history") | |
461 | ((string-equal shell "ksh") "~/.sh_history") | |
462 | (t "~/.history")))) | |
463 | (if (or (equal comint-input-ring-file-name "") | |
464 | (equal (file-truename comint-input-ring-file-name) | |
465 | (file-truename "/dev/null"))) | |
466 | (setq comint-input-ring-file-name nil)) | |
467 | ;; Arrange to write out the input ring on exit, if the shell doesn't | |
468 | ;; do this itself. | |
469 | (if (and comint-input-ring-file-name | |
470 | (string-match shell-dumb-shell-regexp shell)) | |
471 | (set-process-sentinel (get-buffer-process (current-buffer)) | |
472 | #'shell-write-history-on-exit)) | |
473 | (setq shell-dirstack-query | |
474 | (cond ((string-equal shell "sh") "pwd") | |
475 | ((string-equal shell "ksh") "echo $PWD ~-") | |
3811bec8 LK |
476 | (t "dirs"))) |
477 | ;; Bypass a bug in certain versions of bash. | |
478 | (when (string-equal shell "bash") | |
479 | (add-hook 'comint-output-filter-functions | |
480 | 'shell-filter-ctrl-a-ctrl-b nil t))) | |
ee8107c0 | 481 | (comint-read-input-ring t))) |
4dced927 | 482 | |
3811bec8 LK |
483 | (defun shell-filter-ctrl-a-ctrl-b (string) |
484 | "Remove `^A' and `^B' characters from comint output. | |
485 | ||
486 | Bash uses these characters as internal quoting characters in its | |
487 | prompt. Due to a bug in some bash versions (including 2.03, | |
488 | 2.04, and 2.05b), they may erroneously show up when bash is | |
489 | started with the `--noediting' option and Select Graphic | |
490 | Rendition (SGR) control sequences (formerly known as ANSI escape | |
491 | sequences) are used to color the prompt. | |
492 | ||
493 | This function can be put on `comint-output-filter-functions'. | |
494 | The argument STRING is ignored." | |
495 | (let ((pmark (process-mark (get-buffer-process (current-buffer))))) | |
496 | (save-excursion | |
cc6e650e JL |
497 | (goto-char (or (and (markerp comint-last-output-start) |
498 | (marker-position comint-last-output-start)) | |
499 | (point-min))) | |
3811bec8 LK |
500 | (while (re-search-forward "[\C-a\C-b]" pmark t) |
501 | (replace-match ""))))) | |
502 | ||
4dced927 AI |
503 | (defun shell-write-history-on-exit (process event) |
504 | "Called when the shell process is stopped. | |
505 | ||
506 | Writes the input history to a history file | |
84728570 | 507 | `comint-input-ring-file-name' using `comint-write-input-ring' |
4dced927 AI |
508 | and inserts a short message in the shell buffer. |
509 | ||
510 | This function is a sentinel watching the shell interpreter process. | |
511 | Sentinels will always get the two parameters PROCESS and EVENT." | |
512 | ;; Write history. | |
513 | (comint-write-input-ring) | |
84728570 SS |
514 | (let ((buf (process-buffer process))) |
515 | (when (buffer-live-p buf) | |
516 | (with-current-buffer buf | |
517 | (insert (format "\nProcess %s %s\n" process event)))))) | |
518 | ||
c88ab9ce | 519 | ;;;###autoload |
fd1035aa MB |
520 | (defun shell (&optional buffer) |
521 | "Run an inferior shell, with I/O through BUFFER (which defaults to `*shell*'). | |
522 | Interactively, a prefix arg means to prompt for BUFFER. | |
523 | If BUFFER exists but shell process is not running, make new shell. | |
524 | If BUFFER exists and shell process is running, just switch to BUFFER. | |
24fdffaa | 525 | Program used comes from variable `explicit-shell-file-name', |
a9ec2adb | 526 | or (if that is nil) from the ESHELL environment variable, |
c3342e8e | 527 | or (if that is nil) from `shell-file-name'. |
ec1d7c6e | 528 | If a file `~/.emacs_SHELLNAME' exists, or `~/.emacs.d/init_SHELLNAME.sh', |
71af6fc4 RS |
529 | it is given as initial input (but this may be lost, due to a timing |
530 | error, if the shell discards input when it starts up). | |
fbc270e7 RS |
531 | The buffer is put in Shell mode, giving commands for sending input |
532 | and controlling the subjobs of the shell. See `shell-mode'. | |
533 | See also the variable `shell-prompt-pattern'. | |
be9b65ac | 534 | |
ebe4d555 RS |
535 | To specify a coding system for converting non-ASCII characters |
536 | in the input and output to the shell, use \\[universal-coding-system-argument] | |
537 | before \\[shell]. You can also specify this with \\[set-buffer-process-coding-system] | |
538 | in the shell buffer, after you start the shell. | |
539 | The default comes from `process-coding-system-alist' and | |
540 | `default-process-coding-system'. | |
541 | ||
a9ec2adb | 542 | The shell file name (sans directories) is used to make a symbol name |
62c9fad7 | 543 | such as `explicit-csh-args'. If that symbol is a variable, |
be9b65ac DL |
544 | its value is used as a list of arguments when invoking the shell. |
545 | Otherwise, one argument `-i' is passed to the shell. | |
546 | ||
547 | \(Type \\[describe-mode] in the shell buffer for a list of commands.)" | |
fd1035aa MB |
548 | (interactive |
549 | (list | |
550 | (and current-prefix-arg | |
aafd1093 MR |
551 | (read-buffer "Shell buffer: " |
552 | (generate-new-buffer-name "*shell*"))))) | |
5a45735a SM |
553 | (setq buffer (get-buffer-create (or buffer "*shell*"))) |
554 | ;; Pop to buffer, so that the buffer's window will be correctly set | |
555 | ;; when we call comint (so that comint sets the COLUMNS env var properly). | |
556 | (pop-to-buffer buffer) | |
557 | (unless (comint-check-proc buffer) | |
558 | (let* ((prog (or explicit-shell-file-name | |
559 | (getenv "ESHELL") shell-file-name)) | |
560 | (name (file-name-nondirectory prog)) | |
561 | (startfile (concat "~/.emacs_" name)) | |
562 | (xargs-name (intern-soft (concat "explicit-" name "-args")))) | |
ec1d7c6e JB |
563 | (unless (file-exists-p startfile) |
564 | (setq startfile (concat "~/.emacs.d/init_" name ".sh"))) | |
5a45735a SM |
565 | (apply 'make-comint-in-buffer "shell" buffer prog |
566 | (if (file-exists-p startfile) startfile) | |
567 | (if (and xargs-name (boundp xargs-name)) | |
568 | (symbol-value xargs-name) | |
569 | '("-i"))) | |
570 | (shell-mode))) | |
571 | buffer) | |
519bfec4 | 572 | |
05327ca9 | 573 | ;; Don't do this when shell.el is loaded, only while dumping. |
519bfec4 | 574 | ;;;###autoload (add-hook 'same-window-buffer-names "*shell*") |
84728570 | 575 | |
be9b65ac | 576 | ;;; Directory tracking |
05327ca9 SM |
577 | ;; |
578 | ;; This code provides the shell mode input sentinel | |
579 | ;; SHELL-DIRECTORY-TRACKER | |
580 | ;; that tracks cd, pushd, and popd commands issued to the shell, and | |
581 | ;; changes the current directory of the shell buffer accordingly. | |
582 | ;; | |
583 | ;; This is basically a fragile hack, although it's more accurate than | |
584 | ;; the version in Emacs 18's shell.el. It has the following failings: | |
585 | ;; 1. It doesn't know about the cdpath shell variable. | |
586 | ;; 2. It cannot infallibly deal with command sequences, though it does well | |
587 | ;; with these and with ignoring commands forked in another shell with ()s. | |
588 | ;; 3. More generally, any complex command is going to throw it. Otherwise, | |
589 | ;; you'd have to build an entire shell interpreter in Emacs Lisp. Failing | |
590 | ;; that, there's no way to catch shell commands where cd's are buried | |
591 | ;; inside conditional expressions, aliases, and so forth. | |
592 | ;; | |
593 | ;; The whole approach is a crock. Shell aliases mess it up. File sourcing | |
594 | ;; messes it up. You run other processes under the shell; these each have | |
595 | ;; separate working directories, and some have commands for manipulating | |
596 | ;; their w.d.'s (e.g., the lcd command in ftp). Some of these programs have | |
597 | ;; commands that do *not* affect the current w.d. at all, but look like they | |
598 | ;; do (e.g., the cd command in ftp). In shells that allow you job | |
599 | ;; control, you can switch between jobs, all having different w.d.'s. So | |
600 | ;; simply saying %3 can shift your w.d.. | |
601 | ;; | |
602 | ;; The solution is to relax, not stress out about it, and settle for | |
603 | ;; a hack that works pretty well in typical circumstances. Remember | |
604 | ;; that a half-assed solution is more in keeping with the spirit of Unix, | |
605 | ;; anyway. Blech. | |
606 | ;; | |
607 | ;; One good hack not implemented here for users of programmable shells | |
608 | ;; is to program up the shell w.d. manipulation commands to output | |
609 | ;; a coded command sequence to the tty. Something like | |
610 | ;; ESC | <cwd> | | |
611 | ;; where <cwd> is the new current working directory. Then trash the | |
612 | ;; directory tracking machinery currently used in this package, and | |
613 | ;; replace it with a process filter that watches for and strips out | |
614 | ;; these messages. | |
be9b65ac | 615 | |
be9b65ac DL |
616 | (defun shell-directory-tracker (str) |
617 | "Tracks cd, pushd and popd commands issued to the shell. | |
618 | This function is called on each input passed to the shell. | |
619 | It watches for cd, pushd and popd commands and sets the buffer's | |
620 | default directory to track these commands. | |
621 | ||
0a9f2dcf | 622 | You may toggle this tracking on and off with \\[shell-dirtrack-mode]. |
05327ca9 | 623 | If Emacs gets confused, you can resync with the shell with \\[dirs]. |
0a9f2dcf GM |
624 | \(The `dirtrack' package provides an alternative implementation of this |
625 | feature - see the function `dirtrack-mode'.) | |
be9b65ac | 626 | |
32d01212 | 627 | See variables `shell-cd-regexp', `shell-chdrive-regexp', `shell-pushd-regexp', |
84728570 | 628 | and `shell-popd-regexp', while `shell-pushd-tohome', `shell-pushd-dextract', |
32d01212 | 629 | and `shell-pushd-dunique' control the behavior of the relevant command. |
d76b71af | 630 | |
24fdffaa | 631 | Environment variables are expanded, see function `substitute-in-file-name'." |
d76b71af RS |
632 | (if shell-dirtrackp |
633 | ;; We fail gracefully if we think the command will fail in the shell. | |
634 | (condition-case chdir-failure | |
6ed020c8 JB |
635 | (let ((start (progn (string-match |
636 | (concat "^" shell-command-separator-regexp) | |
637 | str) ; skip whitespace | |
d76b71af RS |
638 | (match-end 0))) |
639 | end cmd arg1) | |
640 | (while (string-match shell-command-regexp str start) | |
641 | (setq end (match-end 0) | |
642 | cmd (comint-arguments (substring str start end) 0 0) | |
643 | arg1 (comint-arguments (substring str start end) 1 1)) | |
5f49d5e8 KH |
644 | (if arg1 |
645 | (setq arg1 (shell-unquote-argument arg1))) | |
54021695 KH |
646 | (cond ((string-match (concat "\\`\\(" shell-popd-regexp |
647 | "\\)\\($\\|[ \t]\\)") | |
648 | cmd) | |
32d01212 | 649 | (shell-process-popd (comint-substitute-in-file-name arg1))) |
54021695 KH |
650 | ((string-match (concat "\\`\\(" shell-pushd-regexp |
651 | "\\)\\($\\|[ \t]\\)") | |
652 | cmd) | |
32d01212 | 653 | (shell-process-pushd (comint-substitute-in-file-name arg1))) |
54021695 KH |
654 | ((string-match (concat "\\`\\(" shell-cd-regexp |
655 | "\\)\\($\\|[ \t]\\)") | |
656 | cmd) | |
32d01212 RS |
657 | (shell-process-cd (comint-substitute-in-file-name arg1))) |
658 | ((and shell-chdrive-regexp | |
659 | (string-match (concat "\\`\\(" shell-chdrive-regexp | |
660 | "\\)\\($\\|[ \t]\\)") | |
661 | cmd)) | |
662 | (shell-process-cd (comint-substitute-in-file-name cmd)))) | |
6ed020c8 JB |
663 | (setq start (progn (string-match shell-command-separator-regexp |
664 | str end) | |
665 | ;; skip again | |
d76b71af | 666 | (match-end 0))))) |
ba02c167 | 667 | (error "Couldn't cd")))) |
d76b71af | 668 | |
5f49d5e8 KH |
669 | (defun shell-unquote-argument (string) |
670 | "Remove all kinds of shell quoting from STRING." | |
671 | (save-match-data | |
f5058b96 EZ |
672 | (let ((idx 0) next inside |
673 | (quote-chars | |
674 | (if (string-match shell-dumb-shell-regexp | |
675 | (file-name-nondirectory | |
676 | (car (process-command (get-buffer-process (current-buffer)))))) | |
677 | "['`\"]" | |
678 | "[\\'`\"]"))) | |
5f49d5e8 | 679 | (while (and (< idx (length string)) |
f5058b96 | 680 | (setq next (string-match quote-chars string next))) |
5f49d5e8 KH |
681 | (cond ((= (aref string next) ?\\) |
682 | (setq string (replace-match "" nil nil string)) | |
683 | (setq next (1+ next))) | |
684 | ((and inside (= (aref string next) inside)) | |
685 | (setq string (replace-match "" nil nil string)) | |
686 | (setq inside nil)) | |
687 | (inside | |
688 | (setq next (1+ next))) | |
689 | (t | |
690 | (setq inside (aref string next)) | |
691 | (setq string (replace-match "" nil nil string))))) | |
692 | string))) | |
693 | ||
05327ca9 | 694 | ;; popd [+n] |
be9b65ac | 695 | (defun shell-process-popd (arg) |
d76b71af RS |
696 | (let ((num (or (shell-extract-num arg) 0))) |
697 | (cond ((and num (= num 0) shell-dirstack) | |
0b3c9cf1 | 698 | (shell-cd (car shell-dirstack)) |
d76b71af RS |
699 | (setq shell-dirstack (cdr shell-dirstack)) |
700 | (shell-dirstack-message)) | |
701 | ((and num (> num 0) (<= num (length shell-dirstack))) | |
702 | (let* ((ds (cons nil shell-dirstack)) | |
703 | (cell (nthcdr (1- num) ds))) | |
704 | (rplacd cell (cdr (cdr cell))) | |
705 | (setq shell-dirstack (cdr ds)) | |
706 | (shell-dirstack-message))) | |
707 | (t | |
ba02c167 | 708 | (error "Couldn't popd"))))) |
be9b65ac | 709 | |
3db9a4eb | 710 | ;; Return DIR prefixed with comint-file-name-prefix as appropriate. |
4a02b552 RS |
711 | (defun shell-prefixed-directory-name (dir) |
712 | (if (= (length comint-file-name-prefix) 0) | |
713 | dir | |
714 | (if (file-name-absolute-p dir) | |
715 | ;; The name is absolute, so prepend the prefix. | |
716 | (concat comint-file-name-prefix dir) | |
0b3c9cf1 | 717 | ;; For relative name we assume default-directory already has the prefix. |
4a02b552 | 718 | (expand-file-name dir)))) |
3db9a4eb | 719 | |
05327ca9 | 720 | ;; cd [dir] |
be9b65ac | 721 | (defun shell-process-cd (arg) |
3db9a4eb RM |
722 | (let ((new-dir (cond ((zerop (length arg)) (concat comint-file-name-prefix |
723 | "~")) | |
d76b71af | 724 | ((string-equal "-" arg) shell-last-dir) |
3db9a4eb | 725 | (t (shell-prefixed-directory-name arg))))) |
d76b71af | 726 | (setq shell-last-dir default-directory) |
0b3c9cf1 | 727 | (shell-cd new-dir) |
d76b71af | 728 | (shell-dirstack-message))) |
be9b65ac | 729 | |
05327ca9 | 730 | ;; pushd [+n | dir] |
be9b65ac | 731 | (defun shell-process-pushd (arg) |
d76b71af RS |
732 | (let ((num (shell-extract-num arg))) |
733 | (cond ((zerop (length arg)) | |
734 | ;; no arg -- swap pwd and car of stack unless shell-pushd-tohome | |
735 | (cond (shell-pushd-tohome | |
3db9a4eb | 736 | (shell-process-pushd (concat comint-file-name-prefix "~"))) |
d76b71af RS |
737 | (shell-dirstack |
738 | (let ((old default-directory)) | |
0b3c9cf1 | 739 | (shell-cd (car shell-dirstack)) |
221ca406 | 740 | (setq shell-dirstack (cons old (cdr shell-dirstack))) |
d76b71af RS |
741 | (shell-dirstack-message))) |
742 | (t | |
743 | (message "Directory stack empty.")))) | |
744 | ((numberp num) | |
745 | ;; pushd +n | |
746 | (cond ((> num (length shell-dirstack)) | |
747 | (message "Directory stack not that deep.")) | |
748 | ((= num 0) | |
1cd7adc6 | 749 | (error (message "Couldn't cd"))) |
d76b71af RS |
750 | (shell-pushd-dextract |
751 | (let ((dir (nth (1- num) shell-dirstack))) | |
752 | (shell-process-popd arg) | |
753 | (shell-process-pushd default-directory) | |
0b3c9cf1 | 754 | (shell-cd dir) |
d76b71af RS |
755 | (shell-dirstack-message))) |
756 | (t | |
757 | (let* ((ds (cons default-directory shell-dirstack)) | |
758 | (dslen (length ds)) | |
759 | (front (nthcdr num ds)) | |
760 | (back (reverse (nthcdr (- dslen num) (reverse ds)))) | |
761 | (new-ds (append front back))) | |
0b3c9cf1 | 762 | (shell-cd (car new-ds)) |
d76b71af RS |
763 | (setq shell-dirstack (cdr new-ds)) |
764 | (shell-dirstack-message))))) | |
765 | (t | |
766 | ;; pushd <dir> | |
767 | (let ((old-wd default-directory)) | |
0b3c9cf1 | 768 | (shell-cd (shell-prefixed-directory-name arg)) |
d76b71af RS |
769 | (if (or (null shell-pushd-dunique) |
770 | (not (member old-wd shell-dirstack))) | |
771 | (setq shell-dirstack (cons old-wd shell-dirstack))) | |
772 | (shell-dirstack-message)))))) | |
be9b65ac DL |
773 | |
774 | ;; If STR is of the form +n, for n>0, return n. Otherwise, nil. | |
775 | (defun shell-extract-num (str) | |
776 | (and (string-match "^\\+[1-9][0-9]*$" str) | |
027a4b6b | 777 | (string-to-number str))) |
be9b65ac | 778 | |
05327ca9 SM |
779 | (defvaralias 'shell-dirtrack-mode 'shell-dirtrackp) |
780 | (define-minor-mode shell-dirtrack-mode | |
0a9f2dcf GM |
781 | "Turn directory tracking on and off in a shell buffer. |
782 | The `dirtrack' package provides an alternative implementation of this | |
783 | feature - see the function `dirtrack-mode'." | |
05327ca9 SM |
784 | nil nil nil |
785 | (setq list-buffers-directory (if shell-dirtrack-mode default-directory)) | |
786 | (if shell-dirtrack-mode | |
787 | (add-hook 'comint-input-filter-functions 'shell-directory-tracker nil t) | |
788 | (remove-hook 'comint-input-filter-functions 'shell-directory-tracker t))) | |
789 | ||
790 | ;; For your typing convenience: | |
791 | (defalias 'shell-dirtrack-toggle 'shell-dirtrack-mode) ;??Convenience?? | |
be9b65ac | 792 | |
0b3c9cf1 SM |
793 | (defun shell-cd (dir) |
794 | "Do normal `cd' to DIR, and set `list-buffers-directory'." | |
05327ca9 | 795 | (cd dir) |
b7e97ed5 | 796 | (if shell-dirtrackp |
05327ca9 | 797 | (setq list-buffers-directory default-directory))) |
be9b65ac DL |
798 | |
799 | (defun shell-resync-dirs () | |
800 | "Resync the buffer's idea of the current directory stack. | |
84728570 | 801 | This command queries the shell with the command bound to |
24fdffaa | 802 | `shell-dirstack-query' (default \"dirs\"), reads the next |
be9b65ac DL |
803 | line output and parses it to form the new directory stack. |
804 | DON'T issue this command unless the buffer is at a shell prompt. | |
805 | Also, note that if some other subprocess decides to do output | |
806 | immediately after the query, its output will be taken as the | |
ab646e49 | 807 | new directory stack -- you lose. If this happens, just do the |
be9b65ac DL |
808 | command again." |
809 | (interactive) | |
810 | (let* ((proc (get-buffer-process (current-buffer))) | |
9de9ed52 GM |
811 | (pmark (process-mark proc)) |
812 | (started-at-pmark (= (point) (marker-position pmark)))) | |
813 | (save-excursion | |
814 | (goto-char pmark) | |
815 | ;; If the process echoes commands, don't insert a fake command in | |
816 | ;; the buffer or it will appear twice. | |
817 | (unless comint-process-echoes | |
818 | (insert shell-dirstack-query) (insert "\n")) | |
819 | (sit-for 0) ; force redisplay | |
820 | (comint-send-string proc shell-dirstack-query) | |
821 | (comint-send-string proc "\n") | |
822 | (set-marker pmark (point)) | |
823 | (let ((pt (point)) | |
824 | (regexp | |
825 | (concat | |
826 | (if comint-process-echoes | |
827 | ;; Skip command echo if the process echoes | |
828 | (concat "\\(" (regexp-quote shell-dirstack-query) "\n\\)") | |
829 | "\\(\\)") | |
830 | "\\(.+\n\\)"))) | |
831 | ;; This extra newline prevents the user's pending input from spoofing us. | |
832 | (insert "\n") (backward-char 1) | |
833 | ;; Wait for one line. | |
834 | (while (not (looking-at regexp)) | |
835 | (accept-process-output proc) | |
836 | (goto-char pt))) | |
837 | (goto-char pmark) (delete-char 1) ; remove the extra newline | |
838 | ;; That's the dirlist. grab it & parse it. | |
839 | (let* ((dl (buffer-substring (match-beginning 2) (1- (match-end 2)))) | |
840 | (dl-len (length dl)) | |
841 | (ds '()) ; new dir stack | |
842 | (i 0)) | |
843 | (while (< i dl-len) | |
844 | ;; regexp = optional whitespace, (non-whitespace), optional whitespace | |
845 | (string-match "\\s *\\(\\S +\\)\\s *" dl i) ; pick off next dir | |
846 | (setq ds (cons (concat comint-file-name-prefix | |
847 | (substring dl (match-beginning 1) | |
848 | (match-end 1))) | |
849 | ds)) | |
850 | (setq i (match-end 0))) | |
851 | (let ((ds (nreverse ds))) | |
852 | (condition-case nil | |
853 | (progn (shell-cd (car ds)) | |
854 | (setq shell-dirstack (cdr ds) | |
855 | shell-last-dir (car shell-dirstack)) | |
856 | (shell-dirstack-message)) | |
857 | (error (message "Couldn't cd")))))) | |
858 | (if started-at-pmark (goto-char (marker-position pmark))))) | |
be9b65ac | 859 | |
05327ca9 | 860 | ;; For your typing convenience: |
31e1d920 | 861 | (defalias 'dirs 'shell-resync-dirs) |
be9b65ac DL |
862 | |
863 | ||
05327ca9 SM |
864 | ;; Show the current dirstack on the message line. |
865 | ;; Pretty up dirs a bit by changing "/usr/jqr/foo" to "~/foo". | |
866 | ;; (This isn't necessary if the dirlisting is generated with a simple "dirs".) | |
867 | ;; All the commands that mung the buffer's dirstack finish by calling | |
868 | ;; this guy. | |
be9b65ac | 869 | (defun shell-dirstack-message () |
8a6387ed SM |
870 | (when shell-dirtrack-verbose |
871 | (let* ((msg "") | |
872 | (ds (cons default-directory shell-dirstack)) | |
873 | (home (expand-file-name (concat comint-file-name-prefix "~/"))) | |
874 | (homelen (length home))) | |
875 | (while ds | |
876 | (let ((dir (car ds))) | |
877 | (and (>= (length dir) homelen) | |
878 | (string= home (substring dir 0 homelen)) | |
879 | (setq dir (concat "~/" (substring dir homelen)))) | |
880 | ;; Strip off comint-file-name-prefix if present. | |
881 | (and comint-file-name-prefix | |
882 | (>= (length dir) (length comint-file-name-prefix)) | |
883 | (string= comint-file-name-prefix | |
884 | (substring dir 0 (length comint-file-name-prefix))) | |
885 | (setq dir (substring dir (length comint-file-name-prefix))) | |
886 | (setcar ds dir)) | |
887 | (setq msg (concat msg (directory-file-name dir) " ")) | |
888 | (setq ds (cdr ds)))) | |
889 | (message "%s" msg)))) | |
84728570 | 890 | |
c64d8c55 RS |
891 | ;; This was mostly copied from shell-resync-dirs. |
892 | (defun shell-snarf-envar (var) | |
893 | "Return as a string the shell's value of environment variable VAR." | |
894 | (let* ((cmd (format "printenv '%s'\n" var)) | |
895 | (proc (get-buffer-process (current-buffer))) | |
896 | (pmark (process-mark proc))) | |
897 | (goto-char pmark) | |
898 | (insert cmd) | |
899 | (sit-for 0) ; force redisplay | |
900 | (comint-send-string proc cmd) | |
901 | (set-marker pmark (point)) | |
902 | (let ((pt (point))) ; wait for 1 line | |
903 | ;; This extra newline prevents the user's pending input from spoofing us. | |
904 | (insert "\n") (backward-char 1) | |
905 | (while (not (looking-at ".+\n")) | |
906 | (accept-process-output proc) | |
907 | (goto-char pt))) | |
908 | (goto-char pmark) (delete-char 1) ; remove the extra newline | |
909 | (buffer-substring (match-beginning 0) (1- (match-end 0))))) | |
910 | ||
911 | (defun shell-copy-environment-variable (variable) | |
912 | "Copy the environment variable VARIABLE from the subshell to Emacs. | |
913 | This command reads the value of the specified environment variable | |
914 | in the shell, and sets the same environment variable in Emacs | |
a9e73449 | 915 | \(what `getenv' in Emacs would return) to that value. |
c64d8c55 RS |
916 | That value will affect any new subprocesses that you subsequently start |
917 | from Emacs." | |
918 | (interactive (list (read-envvar-name "\ | |
919 | Copy Shell environment variable to Emacs: "))) | |
920 | (setenv variable (shell-snarf-envar variable))) | |
84728570 | 921 | |
d76b71af RS |
922 | (defun shell-forward-command (&optional arg) |
923 | "Move forward across ARG shell command(s). Does not cross lines. | |
924 | See `shell-command-regexp'." | |
925 | (interactive "p") | |
926 | (let ((limit (save-excursion (end-of-line nil) (point)))) | |
19134c18 | 927 | (if (re-search-forward (concat shell-command-regexp "\\([;&|][\t ]*\\)+") |
d76b71af | 928 | limit 'move arg) |
b0f86743 | 929 | (skip-syntax-backward " ")))) |
d76b71af RS |
930 | |
931 | ||
932 | (defun shell-backward-command (&optional arg) | |
933 | "Move backward across ARG shell command(s). Does not cross lines. | |
934 | See `shell-command-regexp'." | |
935 | (interactive "p") | |
936 | (let ((limit (save-excursion (comint-bol nil) (point)))) | |
28bc09d6 MB |
937 | (when (> limit (point)) |
938 | (setq limit (line-beginning-position))) | |
b0f86743 | 939 | (skip-syntax-backward " " limit) |
d76b71af | 940 | (if (re-search-backward |
19134c18 | 941 | (format "[;&|]+[\t ]*\\(%s\\)" shell-command-regexp) limit 'move arg) |
d76b71af | 942 | (progn (goto-char (match-beginning 1)) |
b0f86743 | 943 | (skip-chars-forward ";&|"))))) |
d76b71af | 944 | |
d76b71af RS |
945 | (defun shell-dynamic-complete-command () |
946 | "Dynamically complete the command at point. | |
947 | This function is similar to `comint-dynamic-complete-filename', except that it | |
5113b294 | 948 | searches `exec-path' (minus the trailing Emacs library path) for completion |
d76b71af RS |
949 | candidates. Note that this may not be the same as the shell's idea of the |
950 | path. | |
951 | ||
952 | Completion is dependent on the value of `shell-completion-execonly', plus | |
988a4d60 RS |
953 | those that effect file completion. See `shell-dynamic-complete-as-command'. |
954 | ||
955 | Returns t if successful." | |
d76b71af | 956 | (interactive) |
988a4d60 RS |
957 | (let ((filename (comint-match-partial-filename))) |
958 | (if (and filename | |
959 | (save-match-data (not (string-match "[~/]" filename))) | |
960 | (eq (match-beginning 0) | |
961 | (save-excursion (shell-backward-command 1) (point)))) | |
962 | (prog2 (message "Completing command name...") | |
963 | (shell-dynamic-complete-as-command))))) | |
964 | ||
965 | ||
966 | (defun shell-dynamic-complete-as-command () | |
967 | "Dynamically complete at point as a command. | |
968 | See `shell-dynamic-complete-filename'. Returns t if successful." | |
56783585 | 969 | (let* ((filename (or (comint-match-partial-filename) "")) |
f0d5dc24 RS |
970 | (filenondir (file-name-nondirectory filename)) |
971 | (path-dirs (cdr (reverse exec-path))) | |
d76b71af RS |
972 | (cwd (file-name-as-directory (expand-file-name default-directory))) |
973 | (ignored-extensions | |
a867a90a RS |
974 | (and comint-completion-fignore |
975 | (mapconcat (function (lambda (x) (concat (regexp-quote x) "$"))) | |
976 | comint-completion-fignore "\\|"))) | |
2df2f980 | 977 | (dir "") (comps-in-dir ()) |
f0d5dc24 RS |
978 | (file "") (abs-file-name "") (completions ())) |
979 | ;; Go thru each dir in the search path, finding completions. | |
980 | (while path-dirs | |
981 | (setq dir (file-name-as-directory (comint-directory (or (car path-dirs) "."))) | |
982 | comps-in-dir (and (file-accessible-directory-p dir) | |
983 | (file-name-all-completions filenondir dir))) | |
d76b71af | 984 | ;; Go thru each completion found, to see whether it should be used. |
f0d5dc24 RS |
985 | (while comps-in-dir |
986 | (setq file (car comps-in-dir) | |
987 | abs-file-name (concat dir file)) | |
d76b71af | 988 | (if (and (not (member file completions)) |
7b2db0a0 KH |
989 | (not (and ignored-extensions |
990 | (string-match ignored-extensions file))) | |
f0d5dc24 RS |
991 | (or (string-equal dir cwd) |
992 | (not (file-directory-p abs-file-name))) | |
d76b71af | 993 | (or (null shell-completion-execonly) |
f0d5dc24 | 994 | (file-executable-p abs-file-name))) |
d76b71af | 995 | (setq completions (cons file completions))) |
f0d5dc24 RS |
996 | (setq comps-in-dir (cdr comps-in-dir))) |
997 | (setq path-dirs (cdr path-dirs))) | |
d76b71af | 998 | ;; OK, we've got a list of completions. |
56783585 | 999 | (let ((success (let ((comint-completion-addsuffix nil)) |
f0d5dc24 | 1000 | (comint-dynamic-simple-complete filenondir completions)))) |
56783585 RS |
1001 | (if (and (memq success '(sole shortest)) comint-completion-addsuffix |
1002 | (not (file-directory-p (comint-match-partial-filename)))) | |
1003 | (insert " ")) | |
1004 | success))) | |
988a4d60 RS |
1005 | |
1006 | ||
1007 | (defun shell-match-partial-variable () | |
da6a48c9 | 1008 | "Return the shell variable at point, or nil if none is found." |
988a4d60 RS |
1009 | (save-excursion |
1010 | (let ((limit (point))) | |
1011 | (if (re-search-backward "[^A-Za-z0-9_{}]" nil 'move) | |
1012 | (or (looking-at "\\$") (forward-char 1))) | |
1013 | ;; Anchor the search forwards. | |
1014 | (if (or (eolp) (looking-at "[^A-Za-z0-9_{}$]")) | |
1015 | nil | |
1016 | (re-search-forward "\\$?{?[A-Za-z0-9_]*}?" limit) | |
1017 | (buffer-substring (match-beginning 0) (match-end 0)))))) | |
a9ec2adb | 1018 | |
988a4d60 RS |
1019 | |
1020 | (defun shell-dynamic-complete-environment-variable () | |
1021 | "Dynamically complete the environment variable at point. | |
1022 | Completes if after a variable, i.e., if it starts with a \"$\". | |
1023 | See `shell-dynamic-complete-as-environment-variable'. | |
1024 | ||
1025 | This function is similar to `comint-dynamic-complete-filename', except that it | |
1026 | searches `process-environment' for completion candidates. Note that this may | |
1027 | not be the same as the interpreter's idea of variable names. The main problem | |
1028 | with this type of completion is that `process-environment' is the environment | |
1029 | which Emacs started with. Emacs does not track changes to the environment made | |
1030 | by the interpreter. Perhaps it would be more accurate if this function was | |
1031 | called `shell-dynamic-complete-process-environment-variable'. | |
1032 | ||
1033 | Returns non-nil if successful." | |
1034 | (interactive) | |
1035 | (let ((variable (shell-match-partial-variable))) | |
1036 | (if (and variable (string-match "^\\$" variable)) | |
1037 | (prog2 (message "Completing variable name...") | |
1038 | (shell-dynamic-complete-as-environment-variable))))) | |
1039 | ||
1040 | ||
1041 | (defun shell-dynamic-complete-as-environment-variable () | |
1042 | "Dynamically complete at point as an environment variable. | |
1043 | Used by `shell-dynamic-complete-environment-variable'. | |
1044 | Uses `comint-dynamic-simple-complete'." | |
1045 | (let* ((var (or (shell-match-partial-variable) "")) | |
1046 | (variable (substring var (or (string-match "[^$({]\\|$" var) 0))) | |
1047 | (variables (mapcar (function (lambda (x) | |
1048 | (substring x 0 (string-match "=" x)))) | |
1049 | process-environment)) | |
1050 | (addsuffix comint-completion-addsuffix) | |
1051 | (comint-completion-addsuffix nil) | |
1052 | (success (comint-dynamic-simple-complete variable variables))) | |
1053 | (if (memq success '(sole shortest)) | |
1054 | (let* ((var (shell-match-partial-variable)) | |
1055 | (variable (substring var (string-match "[^$({]" var))) | |
1056 | (protection (cond ((string-match "{" var) "}") | |
1057 | ((string-match "(" var) ")") | |
1058 | (t ""))) | |
1059 | (suffix (cond ((null addsuffix) "") | |
1060 | ((file-directory-p | |
1061 | (comint-directory (getenv variable))) "/") | |
1062 | (t " ")))) | |
1063 | (insert protection suffix))) | |
1064 | success)) | |
1065 | ||
1066 | ||
1067 | (defun shell-replace-by-expanded-directory () | |
1068 | "Expand directory stack reference before point. | |
1069 | Directory stack references are of the form \"=digit\" or \"=-\". | |
1070 | See `default-directory' and `shell-dirstack'. | |
1071 | ||
1072 | Returns t if successful." | |
1073 | (interactive) | |
1074 | (if (comint-match-partial-filename) | |
1075 | (save-excursion | |
988a4d60 RS |
1076 | (goto-char (match-beginning 0)) |
1077 | (let ((stack (cons default-directory shell-dirstack)) | |
1078 | (index (cond ((looking-at "=-/?") | |
1079 | (length shell-dirstack)) | |
1b93984e | 1080 | ((looking-at "=\\([0-9]+\\)/?") |
988a4d60 RS |
1081 | (string-to-number |
1082 | (buffer-substring | |
1083 | (match-beginning 1) (match-end 1))))))) | |
1084 | (cond ((null index) | |
1085 | nil) | |
1086 | ((>= index (length stack)) | |
1cd7adc6 | 1087 | (error "Directory stack not that deep")) |
988a4d60 RS |
1088 | (t |
1089 | (replace-match (file-name-as-directory (nth index stack)) t t) | |
1090 | (message "Directory item: %d" index) | |
1091 | t)))))) | |
84728570 | 1092 | |
c88ab9ce ER |
1093 | (provide 'shell) |
1094 | ||
05327ca9 | 1095 | ;; arch-tag: bcb5f12a-c1f4-4aea-a809-2504bd5bd797 |
c88ab9ce | 1096 | ;;; shell.el ends here |