| 1 | ;;; shell.el --- specialized comint.el for running the shell -*- lexical-binding: t -*- |
| 2 | |
| 3 | ;; Copyright (C) 1988, 1993-1997, 2000-2012 Free Software Foundation, Inc. |
| 4 | |
| 5 | ;; Author: Olin Shivers <shivers@cs.cmu.edu> |
| 6 | ;; Simon Marshall <simon@gnu.org> |
| 7 | ;; Maintainer: FSF <emacs-devel@gnu.org> |
| 8 | ;; Keywords: processes |
| 9 | |
| 10 | ;; This file is part of GNU Emacs. |
| 11 | |
| 12 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
| 13 | ;; it under the terms of the GNU General Public License as published by |
| 14 | ;; the Free Software Foundation, either version 3 of the License, or |
| 15 | ;; (at your option) any later version. |
| 16 | |
| 17 | ;; GNU Emacs is distributed in the hope that it will be useful, |
| 18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 20 | ;; GNU General Public License for more details. |
| 21 | |
| 22 | ;; You should have received a copy of the GNU General Public License |
| 23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
| 24 | |
| 25 | ;;; Commentary: |
| 26 | |
| 27 | ;; This file defines a shell-in-a-buffer package (shell mode) built on |
| 28 | ;; top of comint mode. This is actually cmushell with things renamed |
| 29 | ;; to replace its counterpart in Emacs 18. cmushell is more |
| 30 | ;; featureful, robust, and uniform than the Emacs 18 version. |
| 31 | |
| 32 | ;; Since this mode is built on top of the general command-interpreter-in- |
| 33 | ;; a-buffer mode (comint mode), it shares a common base functionality, |
| 34 | ;; and a common set of bindings, with all modes derived from comint mode. |
| 35 | ;; This makes these modes easier to use. |
| 36 | |
| 37 | ;; For documentation on the functionality provided by comint mode, and |
| 38 | ;; the hooks available for customizing it, see the file comint.el. |
| 39 | ;; For further information on shell mode, see the comments below. |
| 40 | |
| 41 | ;; Needs fixin: |
| 42 | ;; When sending text from a source file to a subprocess, the process-mark can |
| 43 | ;; move off the window, so you can lose sight of the process interactions. |
| 44 | ;; Maybe I should ensure the process mark is in the window when I send |
| 45 | ;; text to the process? Switch selectable? |
| 46 | |
| 47 | ;; YOUR .EMACS FILE |
| 48 | ;;============================================================================= |
| 49 | ;; Some suggestions for your init file. |
| 50 | ;; |
| 51 | ;; ;; Define M-# to run some strange command: |
| 52 | ;; (eval-after-load "shell" |
| 53 | ;; '(define-key shell-mode-map "\M-#" 'shells-dynamic-spell)) |
| 54 | |
| 55 | ;; Brief Command Documentation: |
| 56 | ;;============================================================================ |
| 57 | ;; Comint Mode Commands: (common to shell and all comint-derived modes) |
| 58 | ;; |
| 59 | ;; m-p comint-previous-input Cycle backwards in input history |
| 60 | ;; m-n comint-next-input Cycle forwards |
| 61 | ;; m-r comint-previous-matching-input Previous input matching a regexp |
| 62 | ;; m-s comint-next-matching-input Next input that matches |
| 63 | ;; m-c-l comint-show-output Show last batch of process output |
| 64 | ;; return comint-send-input |
| 65 | ;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff. |
| 66 | ;; c-c c-a comint-bol Beginning of line; skip prompt |
| 67 | ;; c-c c-u comint-kill-input ^u |
| 68 | ;; c-c c-w backward-kill-word ^w |
| 69 | ;; c-c c-c comint-interrupt-subjob ^c |
| 70 | ;; c-c c-z comint-stop-subjob ^z |
| 71 | ;; c-c c-\ comint-quit-subjob ^\ |
| 72 | ;; c-c c-o comint-delete-output Delete last batch of process output |
| 73 | ;; c-c c-r comint-show-output Show last batch of process output |
| 74 | ;; c-c c-l comint-dynamic-list-input-ring List input history |
| 75 | ;; send-invisible Read line w/o echo & send to proc |
| 76 | ;; comint-continue-subjob Useful if you accidentally suspend |
| 77 | ;; top-level job |
| 78 | ;; comint-mode-hook is the comint mode hook. |
| 79 | |
| 80 | ;; Shell Mode Commands: |
| 81 | ;; shell Fires up the shell process |
| 82 | ;; tab completion-at-point Complete filename/command/history |
| 83 | ;; m-? comint-dynamic-list-filename-completions |
| 84 | ;; List completions in help buffer |
| 85 | ;; m-c-f shell-forward-command Forward a shell command |
| 86 | ;; m-c-b shell-backward-command Backward a shell command |
| 87 | ;; dirs Resync the buffer's dir stack |
| 88 | ;; shell-dirtrack-mode Turn dir tracking on/off |
| 89 | ;; comint-strip-ctrl-m Remove trailing ^Ms from output |
| 90 | ;; |
| 91 | ;; The shell mode hook is shell-mode-hook |
| 92 | ;; comint-prompt-regexp is initialized to shell-prompt-pattern, for backwards |
| 93 | ;; compatibility. |
| 94 | |
| 95 | ;; Read the rest of this file for more information. |
| 96 | |
| 97 | ;;; Code: |
| 98 | |
| 99 | (require 'comint) |
| 100 | (require 'pcomplete) |
| 101 | |
| 102 | ;;; Customization and Buffer Variables |
| 103 | |
| 104 | (defgroup shell nil |
| 105 | "Running shell from within Emacs buffers." |
| 106 | :group 'processes |
| 107 | :group 'unix) |
| 108 | |
| 109 | (defgroup shell-directories nil |
| 110 | "Directory support in shell mode." |
| 111 | :group 'shell) |
| 112 | |
| 113 | (defgroup shell-faces nil |
| 114 | "Faces in shell buffers." |
| 115 | :group 'shell) |
| 116 | |
| 117 | ;;;###autoload |
| 118 | (defcustom shell-dumb-shell-regexp (purecopy "cmd\\(proxy\\)?\\.exe") |
| 119 | "Regexp to match shells that don't save their command history, and |
| 120 | don't handle the backslash as a quote character. For shells that |
| 121 | match this regexp, Emacs will write out the command history when the |
| 122 | shell finishes, and won't remove backslashes when it unquotes shell |
| 123 | arguments." |
| 124 | :type 'regexp |
| 125 | :group 'shell) |
| 126 | |
| 127 | (defcustom shell-prompt-pattern "^[^#$%>\n]*[#$%>] *" |
| 128 | "Regexp to match prompts in the inferior shell. |
| 129 | Defaults to \"^[^#$%>\\n]*[#$%>] *\", which works pretty well. |
| 130 | This variable is used to initialize `comint-prompt-regexp' in the |
| 131 | shell buffer. |
| 132 | |
| 133 | If `comint-use-prompt-regexp' is nil, then this variable is only used |
| 134 | to determine paragraph boundaries. See Info node `Shell Prompts' for |
| 135 | how Shell mode treats paragraphs. |
| 136 | |
| 137 | The pattern should probably not match more than one line. If it does, |
| 138 | Shell mode may become confused trying to distinguish prompt from input |
| 139 | on lines which don't start with a prompt." |
| 140 | :type 'regexp |
| 141 | :group 'shell) |
| 142 | |
| 143 | (defcustom shell-completion-fignore nil |
| 144 | "List of suffixes to be disregarded during file/command completion. |
| 145 | This variable is used to initialize `comint-completion-fignore' in the shell |
| 146 | buffer. The default is nil, for compatibility with most shells. |
| 147 | Some people like (\"~\" \"#\" \"%\")." |
| 148 | :type '(repeat (string :tag "Suffix")) |
| 149 | :group 'shell) |
| 150 | |
| 151 | (defcustom shell-delimiter-argument-list '(?\| ?& ?< ?> ?\( ?\) ?\;) |
| 152 | "List of characters to recognize as separate arguments. |
| 153 | This variable is used to initialize `comint-delimiter-argument-list' in the |
| 154 | shell buffer. The value may depend on the operating system or shell." |
| 155 | :type '(choice (const nil) |
| 156 | (repeat :tag "List of characters" character)) |
| 157 | :group 'shell) |
| 158 | |
| 159 | (defcustom shell-file-name-chars |
| 160 | (if (memq system-type '(ms-dos windows-nt cygwin)) |
| 161 | "~/A-Za-z0-9_^$!#%&{}@`'.,:()-" |
| 162 | "[]~/A-Za-z0-9+@:_.$#%,={}-") |
| 163 | "String of characters valid in a file name. |
| 164 | This variable is used to initialize `comint-file-name-chars' in the |
| 165 | shell buffer. The value may depend on the operating system or shell." |
| 166 | :type 'string |
| 167 | :group 'shell) |
| 168 | |
| 169 | (defcustom shell-file-name-quote-list |
| 170 | (if (memq system-type '(ms-dos windows-nt)) |
| 171 | nil |
| 172 | (append shell-delimiter-argument-list '(?\s ?$ ?\* ?\! ?\" ?\' ?\` ?\# ?\\))) |
| 173 | "List of characters to quote when in a file name. |
| 174 | This variable is used to initialize `comint-file-name-quote-list' in the |
| 175 | shell buffer. The value may depend on the operating system or shell." |
| 176 | :type '(repeat character) |
| 177 | :group 'shell) |
| 178 | |
| 179 | (defcustom shell-dynamic-complete-functions |
| 180 | '(comint-c-a-p-replace-by-expanded-history |
| 181 | shell-environment-variable-completion |
| 182 | shell-command-completion |
| 183 | shell-c-a-p-replace-by-expanded-directory |
| 184 | pcomplete-completions-at-point |
| 185 | shell-filename-completion |
| 186 | comint-filename-completion) |
| 187 | "List of functions called to perform completion. |
| 188 | This variable is used to initialize `comint-dynamic-complete-functions' in the |
| 189 | shell buffer." |
| 190 | :type '(repeat function) |
| 191 | :group 'shell) |
| 192 | |
| 193 | (defcustom shell-command-regexp "[^;&|\n]+" |
| 194 | "Regexp to match a single command within a pipeline. |
| 195 | This is used for directory tracking and does not do a perfect job." |
| 196 | :type 'regexp |
| 197 | :group 'shell) |
| 198 | |
| 199 | (defcustom shell-command-separator-regexp "[;&|\n \t]*" |
| 200 | "Regexp to match a single command within a pipeline. |
| 201 | This is used for directory tracking and does not do a perfect job." |
| 202 | :type 'regexp |
| 203 | :group 'shell) |
| 204 | |
| 205 | (defcustom shell-completion-execonly t |
| 206 | "If non-nil, use executable files only for completion candidates. |
| 207 | This mirrors the optional behavior of tcsh. |
| 208 | |
| 209 | Detecting executability of files may slow command completion considerably." |
| 210 | :type 'boolean |
| 211 | :group 'shell) |
| 212 | |
| 213 | (defcustom shell-popd-regexp "popd" |
| 214 | "Regexp to match subshell commands equivalent to popd." |
| 215 | :type 'regexp |
| 216 | :group 'shell-directories) |
| 217 | |
| 218 | (defcustom shell-pushd-regexp "pushd" |
| 219 | "Regexp to match subshell commands equivalent to pushd." |
| 220 | :type 'regexp |
| 221 | :group 'shell-directories) |
| 222 | |
| 223 | (defcustom shell-pushd-tohome nil |
| 224 | "If non-nil, make pushd with no arg behave as \"pushd ~\" (like cd). |
| 225 | This mirrors the optional behavior of tcsh." |
| 226 | :type 'boolean |
| 227 | :group 'shell-directories) |
| 228 | |
| 229 | (defcustom shell-pushd-dextract nil |
| 230 | "If non-nil, make \"pushd +n\" pop the nth dir to the stack top. |
| 231 | This mirrors the optional behavior of tcsh." |
| 232 | :type 'boolean |
| 233 | :group 'shell-directories) |
| 234 | |
| 235 | (defcustom shell-pushd-dunique nil |
| 236 | "If non-nil, make pushd only add unique directories to the stack. |
| 237 | This mirrors the optional behavior of tcsh." |
| 238 | :type 'boolean |
| 239 | :group 'shell-directories) |
| 240 | |
| 241 | (defcustom shell-cd-regexp "cd" |
| 242 | "Regexp to match subshell commands equivalent to cd." |
| 243 | :type 'regexp |
| 244 | :group 'shell-directories) |
| 245 | |
| 246 | (defcustom shell-chdrive-regexp |
| 247 | (if (memq system-type '(ms-dos windows-nt)) |
| 248 | ; NetWare allows the five chars between upper and lower alphabetics. |
| 249 | "[]a-zA-Z^_`\\[\\\\]:" |
| 250 | nil) |
| 251 | "If non-nil, is regexp used to track drive changes." |
| 252 | :type '(choice regexp |
| 253 | (const nil)) |
| 254 | :group 'shell-directories) |
| 255 | |
| 256 | (defcustom shell-dirtrack-verbose t |
| 257 | "If non-nil, show the directory stack following directory change. |
| 258 | This is effective only if directory tracking is enabled. |
| 259 | The `dirtrack' package provides an alternative implementation of this feature - |
| 260 | see the function `dirtrack-mode'." |
| 261 | :type 'boolean |
| 262 | :group 'shell-directories) |
| 263 | |
| 264 | (defcustom explicit-shell-file-name nil |
| 265 | "If non-nil, is file name to use for explicitly requested inferior shell." |
| 266 | :type '(choice (const :tag "None" nil) file) |
| 267 | :group 'shell) |
| 268 | |
| 269 | ;; Note: There are no explicit references to the variable `explicit-csh-args'. |
| 270 | ;; It is used implicitly by M-x shell when the shell is `csh'. |
| 271 | (defcustom explicit-csh-args |
| 272 | (if (eq system-type 'hpux) |
| 273 | ;; -T persuades HP's csh not to think it is smarter |
| 274 | ;; than us about what terminal modes to use. |
| 275 | '("-i" "-T") |
| 276 | '("-i")) |
| 277 | "Args passed to inferior shell by \\[shell], if the shell is csh. |
| 278 | Value is a list of strings, which may be nil." |
| 279 | :type '(repeat (string :tag "Argument")) |
| 280 | :group 'shell) |
| 281 | |
| 282 | ;; Note: There are no explicit references to the variable `explicit-bash-args'. |
| 283 | ;; It is used implicitly by M-x shell when the interactive shell is `bash'. |
| 284 | (defcustom explicit-bash-args |
| 285 | (let* ((prog (or (and (boundp 'explicit-shell-file-name) explicit-shell-file-name) |
| 286 | (getenv "ESHELL") shell-file-name)) |
| 287 | (name (file-name-nondirectory prog))) |
| 288 | ;; Tell bash not to use readline, except for bash 1.x which |
| 289 | ;; doesn't grok --noediting. Bash 1.x has -nolineediting, but |
| 290 | ;; process-send-eof cannot terminate bash if we use it. |
| 291 | (if (and (not purify-flag) |
| 292 | (equal name "bash") |
| 293 | (file-executable-p prog) |
| 294 | (string-match "bad option" |
| 295 | (shell-command-to-string |
| 296 | (concat (shell-quote-argument prog) |
| 297 | " --noediting")))) |
| 298 | '("-i") |
| 299 | '("--noediting" "-i"))) |
| 300 | "Args passed to inferior shell by \\[shell], if the shell is bash. |
| 301 | Value is a list of strings, which may be nil." |
| 302 | :type '(repeat (string :tag "Argument")) |
| 303 | :group 'shell) |
| 304 | |
| 305 | (defcustom shell-input-autoexpand 'history |
| 306 | "If non-nil, expand input command history references on completion. |
| 307 | This mirrors the optional behavior of tcsh (its autoexpand and histlit). |
| 308 | |
| 309 | If the value is `input', then the expansion is seen on input. |
| 310 | If the value is `history', then the expansion is only when inserting |
| 311 | into the buffer's input ring. See also `comint-magic-space' and |
| 312 | `comint-dynamic-complete-functions'. |
| 313 | |
| 314 | This variable supplies a default for `comint-input-autoexpand', |
| 315 | for Shell mode only." |
| 316 | :type '(choice (const :tag "off" nil) |
| 317 | (const input) |
| 318 | (const history) |
| 319 | (const :tag "on" t)) |
| 320 | :group 'shell) |
| 321 | |
| 322 | (defvar shell-dirstack nil |
| 323 | "List of directories saved by pushd in this buffer's shell. |
| 324 | Thus, this does not include the shell's current directory.") |
| 325 | |
| 326 | (defvar shell-dirtrackp t |
| 327 | "Non-nil in a shell buffer means directory tracking is enabled.") |
| 328 | |
| 329 | (defvar shell-last-dir nil |
| 330 | "Keep track of last directory for ksh `cd -' command.") |
| 331 | |
| 332 | (defvar shell-dirstack-query nil |
| 333 | "Command used by `shell-resync-dirs' to query the shell.") |
| 334 | |
| 335 | (defvar shell-mode-map |
| 336 | (let ((map (nconc (make-sparse-keymap) comint-mode-map))) |
| 337 | (define-key map "\C-c\C-f" 'shell-forward-command) |
| 338 | (define-key map "\C-c\C-b" 'shell-backward-command) |
| 339 | (define-key map "\t" 'completion-at-point) |
| 340 | (define-key map (kbd "M-RET") 'shell-resync-dirs) |
| 341 | (define-key map "\M-?" 'comint-dynamic-list-filename-completions) |
| 342 | (define-key map [menu-bar completion] |
| 343 | (cons "Complete" |
| 344 | (copy-keymap (lookup-key comint-mode-map [menu-bar completion])))) |
| 345 | (define-key-after (lookup-key map [menu-bar completion]) |
| 346 | [complete-env-variable] '("Complete Env. Variable Name" . |
| 347 | shell-dynamic-complete-environment-variable) |
| 348 | 'complete-file) |
| 349 | (define-key-after (lookup-key map [menu-bar completion]) |
| 350 | [expand-directory] '("Expand Directory Reference" . |
| 351 | shell-replace-by-expanded-directory) |
| 352 | 'complete-expand) |
| 353 | map)) |
| 354 | |
| 355 | (defcustom shell-mode-hook '() |
| 356 | "Hook for customizing Shell mode." |
| 357 | :type 'hook |
| 358 | :group 'shell) |
| 359 | |
| 360 | (defvar shell-font-lock-keywords |
| 361 | '(("[ \t]\\([+-][^ \t\n]+\\)" 1 font-lock-comment-face) |
| 362 | ("^[^ \t\n]+:.*" . font-lock-string-face) |
| 363 | ("^\\[[1-9][0-9]*\\]" . font-lock-string-face)) |
| 364 | "Additional expressions to highlight in Shell mode.") |
| 365 | |
| 366 | ;;; Basic Procedures |
| 367 | |
| 368 | (defun shell--unquote&requote-argument (qstr &optional upos) |
| 369 | (unless upos (setq upos 0)) |
| 370 | (let* ((qpos 0) |
| 371 | (dquotes nil) |
| 372 | (ustrs '()) |
| 373 | (re (concat |
| 374 | "[\"']" |
| 375 | "\\|\\$\\(?:\\([[:alpha:]][[:alnum:]]*\\)" |
| 376 | "\\|{\\(?1:[^{}]+\\)}\\)" |
| 377 | (when (memq system-type '(ms-dos windows-nt)) |
| 378 | "\\|%\\(?1:[^\\\\/]*\\)%") |
| 379 | (when comint-file-name-quote-list |
| 380 | "\\|\\\\\\(.\\)"))) |
| 381 | (qupos nil) |
| 382 | (push (lambda (str end) |
| 383 | (push str ustrs) |
| 384 | (setq upos (- upos (length str))) |
| 385 | (unless (or qupos (> upos 0)) |
| 386 | (setq qupos (if (< end 0) (- end) (+ upos end)))))) |
| 387 | match) |
| 388 | (while (setq match (string-match re qstr qpos)) |
| 389 | (funcall push (substring qstr qpos match) match) |
| 390 | (cond |
| 391 | ((match-beginning 2) (funcall push (match-string 2 qstr) (match-end 0))) |
| 392 | ((match-beginning 1) (funcall push (getenv (match-string 1 qstr)) |
| 393 | (- (match-end 0)))) |
| 394 | ((eq (aref qstr match) ?\") (setq dquotes (not dquotes))) |
| 395 | ((eq (aref qstr match) ?\') |
| 396 | (cond |
| 397 | (dquotes (funcall push "'" (match-end 0))) |
| 398 | ((< match (1+ (length qstr))) |
| 399 | (let ((end (string-match "'" qstr (1+ match)))) |
| 400 | (funcall push (substring qstr (1+ match) end) |
| 401 | (or end (length qstr))))) |
| 402 | (t nil))) |
| 403 | (t (error "Unexpected case in shell--unquote&requote-argument!"))) |
| 404 | (setq qpos (match-end 0))) |
| 405 | (funcall push (substring qstr qpos) (length qstr)) |
| 406 | (list (mapconcat #'identity (nreverse ustrs) "") |
| 407 | qupos #'comint-quote-filename))) |
| 408 | |
| 409 | (defun shell--unquote-argument (str) |
| 410 | (car (shell--unquote&requote-argument str))) |
| 411 | (defun shell--requote-argument (upos qstr) |
| 412 | ;; See `completion-table-with-quoting'. |
| 413 | (let ((res (shell--unquote&requote-argument qstr upos))) |
| 414 | (cons (nth 1 res) (nth 2 res)))) |
| 415 | |
| 416 | (defun shell--parse-pcomplete-arguments () |
| 417 | "Parse whitespace separated arguments in the current region." |
| 418 | ;; FIXME: share code with shell--unquote&requote-argument. |
| 419 | (let ((begin (save-excursion (shell-backward-command 1) (point))) |
| 420 | (end (point)) |
| 421 | begins args) |
| 422 | (save-excursion |
| 423 | (goto-char begin) |
| 424 | (while (< (point) end) |
| 425 | (skip-chars-forward " \t\n") |
| 426 | (push (point) begins) |
| 427 | (let ((arg ())) |
| 428 | (while (looking-at |
| 429 | (eval-when-compile |
| 430 | (concat |
| 431 | "\\(?:[^\s\t\n\\\"']+" |
| 432 | "\\|'\\([^']*\\)'?" |
| 433 | "\\|\"\\(\\(?:[^\"\\]\\|\\\\.\\)*\\)\"?" |
| 434 | "\\|\\\\\\(\\(?:.\\|\n\\)?\\)\\)"))) |
| 435 | (goto-char (match-end 0)) |
| 436 | (cond |
| 437 | ((match-beginning 3) ;Backslash escape. |
| 438 | (push (cond |
| 439 | ((null comint-file-name-quote-list) |
| 440 | (goto-char (match-beginning 3)) "\\") |
| 441 | ((= (match-beginning 3) (match-end 3)) "\\") |
| 442 | (t (match-string 3))) |
| 443 | arg)) |
| 444 | ((match-beginning 2) ;Double quote. |
| 445 | (push (if (null comint-file-name-quote-list) (match-string 2) |
| 446 | (replace-regexp-in-string |
| 447 | "\\\\\\(.\\)" "\\1" (match-string 2))) |
| 448 | arg)) |
| 449 | ((match-beginning 1) ;Single quote. |
| 450 | (push (match-string 1) arg)) |
| 451 | (t (push (match-string 0) arg)))) |
| 452 | (push (mapconcat #'identity (nreverse arg) "") args))) |
| 453 | (cons (nreverse args) (nreverse begins))))) |
| 454 | |
| 455 | (defun shell-command-completion-function () |
| 456 | "Completion function for shell command names. |
| 457 | This is the value of `pcomplete-command-completion-function' for |
| 458 | Shell buffers. It implements `shell-completion-execonly' for |
| 459 | `pcomplete' completion." |
| 460 | (pcomplete-here (pcomplete-entries nil |
| 461 | (if shell-completion-execonly |
| 462 | 'file-executable-p)))) |
| 463 | |
| 464 | (defun shell-completion-vars () |
| 465 | "Setup completion vars for `shell-mode' and `read-shell-command'." |
| 466 | (set (make-local-variable 'comint-completion-fignore) |
| 467 | shell-completion-fignore) |
| 468 | (set (make-local-variable 'comint-delimiter-argument-list) |
| 469 | shell-delimiter-argument-list) |
| 470 | (set (make-local-variable 'comint-file-name-chars) shell-file-name-chars) |
| 471 | (set (make-local-variable 'comint-file-name-quote-list) |
| 472 | shell-file-name-quote-list) |
| 473 | (set (make-local-variable 'comint-dynamic-complete-functions) |
| 474 | shell-dynamic-complete-functions) |
| 475 | (setq-local comint-unquote-function #'shell--unquote-argument) |
| 476 | (setq-local comint-requote-function #'shell--requote-argument) |
| 477 | (set (make-local-variable 'pcomplete-parse-arguments-function) |
| 478 | #'shell--parse-pcomplete-arguments) |
| 479 | (set (make-local-variable 'pcomplete-termination-string) |
| 480 | (cond ((not comint-completion-addsuffix) "") |
| 481 | ((stringp comint-completion-addsuffix) |
| 482 | comint-completion-addsuffix) |
| 483 | ((not (consp comint-completion-addsuffix)) " ") |
| 484 | (t (cdr comint-completion-addsuffix)))) |
| 485 | (set (make-local-variable 'pcomplete-command-completion-function) |
| 486 | #'shell-command-completion-function) |
| 487 | ;; Don't use pcomplete's defaulting mechanism, rely on |
| 488 | ;; shell-dynamic-complete-functions instead. |
| 489 | (set (make-local-variable 'pcomplete-default-completion-function) #'ignore) |
| 490 | (setq comint-input-autoexpand shell-input-autoexpand) |
| 491 | ;; Not needed in shell-mode because it's inherited from comint-mode, but |
| 492 | ;; placed here for read-shell-command. |
| 493 | (add-hook 'completion-at-point-functions 'comint-completion-at-point nil t)) |
| 494 | |
| 495 | (put 'shell-mode 'mode-class 'special) |
| 496 | |
| 497 | (define-derived-mode shell-mode comint-mode "Shell" |
| 498 | "Major mode for interacting with an inferior shell.\\<shell-mode-map> |
| 499 | \\[comint-send-input] after the end of the process' output sends the text from |
| 500 | the end of process to the end of the current line. |
| 501 | \\[comint-send-input] before end of process output copies the current line minus the prompt to |
| 502 | the end of the buffer and sends it (\\[comint-copy-old-input] just copies the current line). |
| 503 | \\[send-invisible] reads a line of text without echoing it, and sends it to |
| 504 | the shell. This is useful for entering passwords. Or, add the function |
| 505 | `comint-watch-for-password-prompt' to `comint-output-filter-functions'. |
| 506 | |
| 507 | If you want to make multiple shell buffers, rename the `*shell*' buffer |
| 508 | using \\[rename-buffer] or \\[rename-uniquely] and start a new shell. |
| 509 | |
| 510 | If you want to make shell buffers limited in length, add the function |
| 511 | `comint-truncate-buffer' to `comint-output-filter-functions'. |
| 512 | |
| 513 | If you accidentally suspend your process, use \\[comint-continue-subjob] |
| 514 | to continue it. |
| 515 | |
| 516 | `cd', `pushd' and `popd' commands given to the shell are watched by Emacs to |
| 517 | keep this buffer's default directory the same as the shell's working directory. |
| 518 | While directory tracking is enabled, the shell's working directory is displayed |
| 519 | by \\[list-buffers] or \\[mouse-buffer-menu] in the `File' field. |
| 520 | \\[dirs] queries the shell and resyncs Emacs's idea of what the current |
| 521 | directory stack is. |
| 522 | \\[shell-dirtrack-mode] turns directory tracking on and off. |
| 523 | \(The `dirtrack' package provides an alternative implementation of this |
| 524 | feature - see the function `dirtrack-mode'.) |
| 525 | |
| 526 | \\{shell-mode-map} |
| 527 | Customization: Entry to this mode runs the hooks on `comint-mode-hook' and |
| 528 | `shell-mode-hook' (in that order). Before each input, the hooks on |
| 529 | `comint-input-filter-functions' are run. After each shell output, the hooks |
| 530 | on `comint-output-filter-functions' are run. |
| 531 | |
| 532 | Variables `shell-cd-regexp', `shell-chdrive-regexp', `shell-pushd-regexp' |
| 533 | and `shell-popd-regexp' are used to match their respective commands, |
| 534 | while `shell-pushd-tohome', `shell-pushd-dextract' and `shell-pushd-dunique' |
| 535 | control the behavior of the relevant command. |
| 536 | |
| 537 | Variables `comint-completion-autolist', `comint-completion-addsuffix', |
| 538 | `comint-completion-recexact' and `comint-completion-fignore' control the |
| 539 | behavior of file name, command name and variable name completion. Variable |
| 540 | `shell-completion-execonly' controls the behavior of command name completion. |
| 541 | Variable `shell-completion-fignore' is used to initialize the value of |
| 542 | `comint-completion-fignore'. |
| 543 | |
| 544 | Variables `comint-input-ring-file-name' and `comint-input-autoexpand' control |
| 545 | the initialization of the input ring history, and history expansion. |
| 546 | |
| 547 | Variables `comint-output-filter-functions', a hook, and |
| 548 | `comint-scroll-to-bottom-on-input' and `comint-scroll-to-bottom-on-output' |
| 549 | control whether input and output cause the window to scroll to the end of the |
| 550 | buffer." |
| 551 | (setq comint-prompt-regexp shell-prompt-pattern) |
| 552 | (shell-completion-vars) |
| 553 | (set (make-local-variable 'paragraph-separate) "\\'") |
| 554 | (set (make-local-variable 'paragraph-start) comint-prompt-regexp) |
| 555 | (set (make-local-variable 'font-lock-defaults) '(shell-font-lock-keywords t)) |
| 556 | (set (make-local-variable 'shell-dirstack) nil) |
| 557 | (set (make-local-variable 'shell-last-dir) nil) |
| 558 | (shell-dirtrack-mode 1) |
| 559 | |
| 560 | ;; By default, ansi-color applies faces using overlays. This is |
| 561 | ;; very inefficient in Shell buffers (e.g. Bug#10835). We use a |
| 562 | ;; custom `ansi-color-apply-face-function' to convert color escape |
| 563 | ;; sequences into `font-lock-face' properties. |
| 564 | (set (make-local-variable 'ansi-color-apply-face-function) |
| 565 | (lambda (beg end face) |
| 566 | (when face |
| 567 | (put-text-property beg end 'font-lock-face face)))) |
| 568 | |
| 569 | ;; This is not really correct, since the shell buffer does not really |
| 570 | ;; edit this directory. But it is useful in the buffer list and menus. |
| 571 | (setq list-buffers-directory (expand-file-name default-directory)) |
| 572 | ;; shell-dependent assignments. |
| 573 | (when (ring-empty-p comint-input-ring) |
| 574 | (let ((shell (file-name-nondirectory (car |
| 575 | (process-command (get-buffer-process (current-buffer)))))) |
| 576 | (hsize (getenv "HISTSIZE"))) |
| 577 | (and (stringp hsize) |
| 578 | (integerp (setq hsize (string-to-number hsize))) |
| 579 | (> hsize 0) |
| 580 | (set (make-local-variable 'comint-input-ring-size) hsize)) |
| 581 | (setq comint-input-ring-file-name |
| 582 | (or (getenv "HISTFILE") |
| 583 | (cond ((string-equal shell "bash") "~/.bash_history") |
| 584 | ((string-equal shell "ksh") "~/.sh_history") |
| 585 | (t "~/.history")))) |
| 586 | (if (or (equal comint-input-ring-file-name "") |
| 587 | (equal (file-truename comint-input-ring-file-name) |
| 588 | (file-truename "/dev/null"))) |
| 589 | (setq comint-input-ring-file-name nil)) |
| 590 | ;; Arrange to write out the input ring on exit, if the shell doesn't |
| 591 | ;; do this itself. |
| 592 | (if (and comint-input-ring-file-name |
| 593 | (string-match shell-dumb-shell-regexp shell)) |
| 594 | (set-process-sentinel (get-buffer-process (current-buffer)) |
| 595 | #'shell-write-history-on-exit)) |
| 596 | (setq shell-dirstack-query |
| 597 | (cond ((string-equal shell "sh") "pwd") |
| 598 | ((string-equal shell "ksh") "echo $PWD ~-") |
| 599 | (t "dirs"))) |
| 600 | ;; Bypass a bug in certain versions of bash. |
| 601 | (when (string-equal shell "bash") |
| 602 | (add-hook 'comint-preoutput-filter-functions |
| 603 | 'shell-filter-ctrl-a-ctrl-b nil t))) |
| 604 | (comint-read-input-ring t))) |
| 605 | |
| 606 | (defun shell-filter-ctrl-a-ctrl-b (string) |
| 607 | "Remove `^A' and `^B' characters from comint output. |
| 608 | |
| 609 | Bash uses these characters as internal quoting characters in its |
| 610 | prompt. Due to a bug in some bash versions (including 2.03, |
| 611 | 2.04, and 2.05b), they may erroneously show up when bash is |
| 612 | started with the `--noediting' option and Select Graphic |
| 613 | Rendition (SGR) control sequences (formerly known as ANSI escape |
| 614 | sequences) are used to color the prompt. |
| 615 | |
| 616 | This function can be put on `comint-preoutput-filter-functions'." |
| 617 | (if (string-match "[\C-a\C-b]" string) |
| 618 | (replace-regexp-in-string "[\C-a\C-b]" "" string t t) |
| 619 | string)) |
| 620 | |
| 621 | (defun shell-write-history-on-exit (process event) |
| 622 | "Called when the shell process is stopped. |
| 623 | |
| 624 | Writes the input history to a history file |
| 625 | `comint-input-ring-file-name' using `comint-write-input-ring' |
| 626 | and inserts a short message in the shell buffer. |
| 627 | |
| 628 | This function is a sentinel watching the shell interpreter process. |
| 629 | Sentinels will always get the two parameters PROCESS and EVENT." |
| 630 | ;; Write history. |
| 631 | (comint-write-input-ring) |
| 632 | (let ((buf (process-buffer process))) |
| 633 | (when (buffer-live-p buf) |
| 634 | (with-current-buffer buf |
| 635 | (insert (format "\nProcess %s %s\n" process event)))))) |
| 636 | |
| 637 | ;;;###autoload |
| 638 | (defun shell (&optional buffer) |
| 639 | "Run an inferior shell, with I/O through BUFFER (which defaults to `*shell*'). |
| 640 | Interactively, a prefix arg means to prompt for BUFFER. |
| 641 | If `default-directory' is a remote file name, it is also prompted |
| 642 | to change if called with a prefix arg. |
| 643 | |
| 644 | If BUFFER exists but shell process is not running, make new shell. |
| 645 | If BUFFER exists and shell process is running, just switch to BUFFER. |
| 646 | Program used comes from variable `explicit-shell-file-name', |
| 647 | or (if that is nil) from the ESHELL environment variable, |
| 648 | or (if that is nil) from `shell-file-name'. |
| 649 | If a file `~/.emacs_SHELLNAME' exists, or `~/.emacs.d/init_SHELLNAME.sh', |
| 650 | it is given as initial input (but this may be lost, due to a timing |
| 651 | error, if the shell discards input when it starts up). |
| 652 | The buffer is put in Shell mode, giving commands for sending input |
| 653 | and controlling the subjobs of the shell. See `shell-mode'. |
| 654 | See also the variable `shell-prompt-pattern'. |
| 655 | |
| 656 | To specify a coding system for converting non-ASCII characters |
| 657 | in the input and output to the shell, use \\[universal-coding-system-argument] |
| 658 | before \\[shell]. You can also specify this with \\[set-buffer-process-coding-system] |
| 659 | in the shell buffer, after you start the shell. |
| 660 | The default comes from `process-coding-system-alist' and |
| 661 | `default-process-coding-system'. |
| 662 | |
| 663 | The shell file name (sans directories) is used to make a symbol name |
| 664 | such as `explicit-csh-args'. If that symbol is a variable, |
| 665 | its value is used as a list of arguments when invoking the shell. |
| 666 | Otherwise, one argument `-i' is passed to the shell. |
| 667 | |
| 668 | \(Type \\[describe-mode] in the shell buffer for a list of commands.)" |
| 669 | (interactive |
| 670 | (list |
| 671 | (and current-prefix-arg |
| 672 | (prog1 |
| 673 | (read-buffer "Shell buffer: " |
| 674 | (generate-new-buffer-name "*shell*")) |
| 675 | (if (file-remote-p default-directory) |
| 676 | ;; It must be possible to declare a local default-directory. |
| 677 | ;; FIXME: This can't be right: it changes the default-directory |
| 678 | ;; of the current-buffer rather than of the *shell* buffer. |
| 679 | (setq default-directory |
| 680 | (expand-file-name |
| 681 | (read-directory-name |
| 682 | "Default directory: " default-directory default-directory |
| 683 | t nil)))))))) |
| 684 | (setq buffer (if (or buffer (not (derived-mode-p 'shell-mode)) |
| 685 | (comint-check-proc (current-buffer))) |
| 686 | (get-buffer-create (or buffer "*shell*")) |
| 687 | ;; If the current buffer is a dead shell buffer, use it. |
| 688 | (current-buffer))) |
| 689 | |
| 690 | ;; On remote hosts, the local `shell-file-name' might be useless. |
| 691 | (if (and (called-interactively-p 'any) |
| 692 | (file-remote-p default-directory) |
| 693 | (null explicit-shell-file-name) |
| 694 | (null (getenv "ESHELL"))) |
| 695 | (with-current-buffer buffer |
| 696 | (set (make-local-variable 'explicit-shell-file-name) |
| 697 | (file-remote-p |
| 698 | (expand-file-name |
| 699 | (read-file-name |
| 700 | "Remote shell path: " default-directory shell-file-name |
| 701 | t shell-file-name)) |
| 702 | 'localname)))) |
| 703 | |
| 704 | ;; The buffer's window must be correctly set when we call comint (so |
| 705 | ;; that comint sets the COLUMNS env var properly). |
| 706 | (pop-to-buffer-same-window buffer) |
| 707 | (unless (comint-check-proc buffer) |
| 708 | (let* ((prog (or explicit-shell-file-name |
| 709 | (getenv "ESHELL") shell-file-name)) |
| 710 | (name (file-name-nondirectory prog)) |
| 711 | (startfile (concat "~/.emacs_" name)) |
| 712 | (xargs-name (intern-soft (concat "explicit-" name "-args")))) |
| 713 | (unless (file-exists-p startfile) |
| 714 | (setq startfile (concat user-emacs-directory "init_" name ".sh"))) |
| 715 | (apply 'make-comint-in-buffer "shell" buffer prog |
| 716 | (if (file-exists-p startfile) startfile) |
| 717 | (if (and xargs-name (boundp xargs-name)) |
| 718 | (symbol-value xargs-name) |
| 719 | '("-i"))) |
| 720 | (shell-mode))) |
| 721 | buffer) |
| 722 | |
| 723 | ;;; Directory tracking |
| 724 | ;; |
| 725 | ;; This code provides the shell mode input sentinel |
| 726 | ;; SHELL-DIRECTORY-TRACKER |
| 727 | ;; that tracks cd, pushd, and popd commands issued to the shell, and |
| 728 | ;; changes the current directory of the shell buffer accordingly. |
| 729 | ;; |
| 730 | ;; This is basically a fragile hack, although it's more accurate than |
| 731 | ;; the version in Emacs 18's shell.el. It has the following failings: |
| 732 | ;; 1. It doesn't know about the cdpath shell variable. |
| 733 | ;; 2. It cannot infallibly deal with command sequences, though it does well |
| 734 | ;; with these and with ignoring commands forked in another shell with ()s. |
| 735 | ;; 3. More generally, any complex command is going to throw it. Otherwise, |
| 736 | ;; you'd have to build an entire shell interpreter in Emacs Lisp. Failing |
| 737 | ;; that, there's no way to catch shell commands where cd's are buried |
| 738 | ;; inside conditional expressions, aliases, and so forth. |
| 739 | ;; |
| 740 | ;; The whole approach is a crock. Shell aliases mess it up. File sourcing |
| 741 | ;; messes it up. You run other processes under the shell; these each have |
| 742 | ;; separate working directories, and some have commands for manipulating |
| 743 | ;; their w.d.'s (e.g., the lcd command in ftp). Some of these programs have |
| 744 | ;; commands that do *not* affect the current w.d. at all, but look like they |
| 745 | ;; do (e.g., the cd command in ftp). In shells that allow you job |
| 746 | ;; control, you can switch between jobs, all having different w.d.'s. So |
| 747 | ;; simply saying %3 can shift your w.d.. |
| 748 | ;; |
| 749 | ;; The solution is to relax, not stress out about it, and settle for |
| 750 | ;; a hack that works pretty well in typical circumstances. Remember |
| 751 | ;; that a half-assed solution is more in keeping with the spirit of Unix, |
| 752 | ;; anyway. Blech. |
| 753 | ;; |
| 754 | ;; One good hack not implemented here for users of programmable shells |
| 755 | ;; is to program up the shell w.d. manipulation commands to output |
| 756 | ;; a coded command sequence to the tty. Something like |
| 757 | ;; ESC | <cwd> | |
| 758 | ;; where <cwd> is the new current working directory. Then trash the |
| 759 | ;; directory tracking machinery currently used in this package, and |
| 760 | ;; replace it with a process filter that watches for and strips out |
| 761 | ;; these messages. |
| 762 | |
| 763 | (defun shell-directory-tracker (str) |
| 764 | "Tracks cd, pushd and popd commands issued to the shell. |
| 765 | This function is called on each input passed to the shell. |
| 766 | It watches for cd, pushd and popd commands and sets the buffer's |
| 767 | default directory to track these commands. |
| 768 | |
| 769 | You may toggle this tracking on and off with \\[shell-dirtrack-mode]. |
| 770 | If Emacs gets confused, you can resync with the shell with \\[dirs]. |
| 771 | \(The `dirtrack' package provides an alternative implementation of this |
| 772 | feature - see the function `dirtrack-mode'.) |
| 773 | |
| 774 | See variables `shell-cd-regexp', `shell-chdrive-regexp', `shell-pushd-regexp', |
| 775 | and `shell-popd-regexp', while `shell-pushd-tohome', `shell-pushd-dextract', |
| 776 | and `shell-pushd-dunique' control the behavior of the relevant command. |
| 777 | |
| 778 | Environment variables are expanded, see function `substitute-in-file-name'." |
| 779 | (if shell-dirtrackp |
| 780 | ;; We fail gracefully if we think the command will fail in the shell. |
| 781 | (condition-case nil |
| 782 | (let ((start (progn (string-match |
| 783 | (concat "^" shell-command-separator-regexp) |
| 784 | str) ; skip whitespace |
| 785 | (match-end 0))) |
| 786 | (case-fold-search) |
| 787 | end cmd arg1) |
| 788 | (while (string-match shell-command-regexp str start) |
| 789 | (setq end (match-end 0) |
| 790 | cmd (comint-arguments (substring str start end) 0 0) |
| 791 | arg1 (comint-arguments (substring str start end) 1 1)) |
| 792 | (if arg1 |
| 793 | (setq arg1 (shell-unquote-argument arg1))) |
| 794 | (cond ((string-match (concat "\\`\\(" shell-popd-regexp |
| 795 | "\\)\\($\\|[ \t]\\)") |
| 796 | cmd) |
| 797 | (shell-process-popd (comint-substitute-in-file-name arg1))) |
| 798 | ((string-match (concat "\\`\\(" shell-pushd-regexp |
| 799 | "\\)\\($\\|[ \t]\\)") |
| 800 | cmd) |
| 801 | (shell-process-pushd (comint-substitute-in-file-name arg1))) |
| 802 | ((string-match (concat "\\`\\(" shell-cd-regexp |
| 803 | "\\)\\($\\|[ \t]\\)") |
| 804 | cmd) |
| 805 | (shell-process-cd (comint-substitute-in-file-name arg1))) |
| 806 | ((and shell-chdrive-regexp |
| 807 | (string-match (concat "\\`\\(" shell-chdrive-regexp |
| 808 | "\\)\\($\\|[ \t]\\)") |
| 809 | cmd)) |
| 810 | (shell-process-cd (comint-substitute-in-file-name cmd)))) |
| 811 | (setq start (progn (string-match shell-command-separator-regexp |
| 812 | str end) |
| 813 | ;; skip again |
| 814 | (match-end 0))))) |
| 815 | (error "Couldn't cd")))) |
| 816 | |
| 817 | (defun shell-unquote-argument (string) |
| 818 | "Remove all kinds of shell quoting from STRING." |
| 819 | (save-match-data |
| 820 | (let ((idx 0) next inside |
| 821 | (quote-chars |
| 822 | (if (string-match shell-dumb-shell-regexp |
| 823 | (file-name-nondirectory |
| 824 | (car (process-command (get-buffer-process (current-buffer)))))) |
| 825 | "['`\"]" |
| 826 | "[\\'`\"]"))) |
| 827 | (while (and (< idx (length string)) |
| 828 | (setq next (string-match quote-chars string next))) |
| 829 | (cond ((= (aref string next) ?\\) |
| 830 | (setq string (replace-match "" nil nil string)) |
| 831 | (setq next (1+ next))) |
| 832 | ((and inside (= (aref string next) inside)) |
| 833 | (setq string (replace-match "" nil nil string)) |
| 834 | (setq inside nil)) |
| 835 | (inside |
| 836 | (setq next (1+ next))) |
| 837 | (t |
| 838 | (setq inside (aref string next)) |
| 839 | (setq string (replace-match "" nil nil string))))) |
| 840 | string))) |
| 841 | |
| 842 | ;; popd [+n] |
| 843 | (defun shell-process-popd (arg) |
| 844 | (let ((num (or (shell-extract-num arg) 0))) |
| 845 | (cond ((and num (= num 0) shell-dirstack) |
| 846 | (shell-cd (shell-prefixed-directory-name (car shell-dirstack))) |
| 847 | (setq shell-dirstack (cdr shell-dirstack)) |
| 848 | (shell-dirstack-message)) |
| 849 | ((and num (> num 0) (<= num (length shell-dirstack))) |
| 850 | (let* ((ds (cons nil shell-dirstack)) |
| 851 | (cell (nthcdr (1- num) ds))) |
| 852 | (rplacd cell (cdr (cdr cell))) |
| 853 | (setq shell-dirstack (cdr ds)) |
| 854 | (shell-dirstack-message))) |
| 855 | (t |
| 856 | (error "Couldn't popd"))))) |
| 857 | |
| 858 | ;; Return DIR prefixed with comint-file-name-prefix as appropriate. |
| 859 | (defun shell-prefixed-directory-name (dir) |
| 860 | (if (= (length comint-file-name-prefix) 0) |
| 861 | dir |
| 862 | (if (file-name-absolute-p dir) |
| 863 | ;; The name is absolute, so prepend the prefix. |
| 864 | (concat comint-file-name-prefix dir) |
| 865 | ;; For relative name we assume default-directory already has the prefix. |
| 866 | (expand-file-name dir)))) |
| 867 | |
| 868 | ;; cd [dir] |
| 869 | (defun shell-process-cd (arg) |
| 870 | (let ((new-dir (cond ((zerop (length arg)) (concat comint-file-name-prefix |
| 871 | "~")) |
| 872 | ((string-equal "-" arg) shell-last-dir) |
| 873 | (t (shell-prefixed-directory-name arg))))) |
| 874 | (setq shell-last-dir default-directory) |
| 875 | (shell-cd new-dir) |
| 876 | (shell-dirstack-message))) |
| 877 | |
| 878 | ;; pushd [+n | dir] |
| 879 | (defun shell-process-pushd (arg) |
| 880 | (let ((num (shell-extract-num arg))) |
| 881 | (cond ((zerop (length arg)) |
| 882 | ;; no arg -- swap pwd and car of stack unless shell-pushd-tohome |
| 883 | (cond (shell-pushd-tohome |
| 884 | (shell-process-pushd (concat comint-file-name-prefix "~"))) |
| 885 | (shell-dirstack |
| 886 | (let ((old default-directory)) |
| 887 | (shell-cd (car shell-dirstack)) |
| 888 | (setq shell-dirstack (cons old (cdr shell-dirstack))) |
| 889 | (shell-dirstack-message))) |
| 890 | (t |
| 891 | (message "Directory stack empty.")))) |
| 892 | ((numberp num) |
| 893 | ;; pushd +n |
| 894 | (cond ((> num (length shell-dirstack)) |
| 895 | (message "Directory stack not that deep.")) |
| 896 | ((= num 0) |
| 897 | (error (message "Couldn't cd"))) |
| 898 | (shell-pushd-dextract |
| 899 | (let ((dir (nth (1- num) shell-dirstack))) |
| 900 | (shell-process-popd arg) |
| 901 | (shell-process-pushd default-directory) |
| 902 | (shell-cd dir) |
| 903 | (shell-dirstack-message))) |
| 904 | (t |
| 905 | (let* ((ds (cons default-directory shell-dirstack)) |
| 906 | (dslen (length ds)) |
| 907 | (front (nthcdr num ds)) |
| 908 | (back (reverse (nthcdr (- dslen num) (reverse ds)))) |
| 909 | (new-ds (append front back))) |
| 910 | (shell-cd (car new-ds)) |
| 911 | (setq shell-dirstack (cdr new-ds)) |
| 912 | (shell-dirstack-message))))) |
| 913 | (t |
| 914 | ;; pushd <dir> |
| 915 | (let ((old-wd default-directory)) |
| 916 | (shell-cd (shell-prefixed-directory-name arg)) |
| 917 | (if (or (null shell-pushd-dunique) |
| 918 | (not (member old-wd shell-dirstack))) |
| 919 | (setq shell-dirstack (cons old-wd shell-dirstack))) |
| 920 | (shell-dirstack-message)))))) |
| 921 | |
| 922 | ;; If STR is of the form +n, for n>0, return n. Otherwise, nil. |
| 923 | (defun shell-extract-num (str) |
| 924 | (and (string-match "^\\+[1-9][0-9]*$" str) |
| 925 | (string-to-number str))) |
| 926 | |
| 927 | (defvaralias 'shell-dirtrack-mode 'shell-dirtrackp) |
| 928 | (define-minor-mode shell-dirtrack-mode |
| 929 | "Toggle directory tracking in this shell buffer (Shell Dirtrack mode). |
| 930 | With a prefix argument ARG, enable Shell Dirtrack mode if ARG is |
| 931 | positive, and disable it otherwise. If called from Lisp, enable |
| 932 | the mode if ARG is omitted or nil. |
| 933 | |
| 934 | The `dirtrack' package provides an alternative implementation of |
| 935 | this feature; see the function `dirtrack-mode'." |
| 936 | nil nil nil |
| 937 | (setq list-buffers-directory (if shell-dirtrack-mode default-directory)) |
| 938 | (if shell-dirtrack-mode |
| 939 | (add-hook 'comint-input-filter-functions 'shell-directory-tracker nil t) |
| 940 | (remove-hook 'comint-input-filter-functions 'shell-directory-tracker t))) |
| 941 | |
| 942 | (define-obsolete-function-alias 'shell-dirtrack-toggle 'shell-dirtrack-mode |
| 943 | "23.1") |
| 944 | |
| 945 | (defun shell-cd (dir) |
| 946 | "Do normal `cd' to DIR, and set `list-buffers-directory'." |
| 947 | (cd dir) |
| 948 | (if shell-dirtrackp |
| 949 | (setq list-buffers-directory default-directory))) |
| 950 | |
| 951 | (defun shell-resync-dirs () |
| 952 | "Resync the buffer's idea of the current directory stack. |
| 953 | This command queries the shell with the command bound to |
| 954 | `shell-dirstack-query' (default \"dirs\"), reads the next |
| 955 | line output and parses it to form the new directory stack. |
| 956 | DON'T issue this command unless the buffer is at a shell prompt. |
| 957 | Also, note that if some other subprocess decides to do output |
| 958 | immediately after the query, its output will be taken as the |
| 959 | new directory stack -- you lose. If this happens, just do the |
| 960 | command again." |
| 961 | (interactive) |
| 962 | (let* ((proc (get-buffer-process (current-buffer))) |
| 963 | (pmark (process-mark proc)) |
| 964 | (started-at-pmark (= (point) (marker-position pmark)))) |
| 965 | (save-excursion |
| 966 | (goto-char pmark) |
| 967 | ;; If the process echoes commands, don't insert a fake command in |
| 968 | ;; the buffer or it will appear twice. |
| 969 | (unless comint-process-echoes |
| 970 | (insert shell-dirstack-query) (insert "\n")) |
| 971 | (sit-for 0) ; force redisplay |
| 972 | (comint-send-string proc shell-dirstack-query) |
| 973 | (comint-send-string proc "\n") |
| 974 | (set-marker pmark (point)) |
| 975 | (let ((pt (point)) |
| 976 | (regexp |
| 977 | (concat |
| 978 | (if comint-process-echoes |
| 979 | ;; Skip command echo if the process echoes |
| 980 | (concat "\\(" (regexp-quote shell-dirstack-query) "\n\\)") |
| 981 | "\\(\\)") |
| 982 | "\\(.+\n\\)"))) |
| 983 | ;; This extra newline prevents the user's pending input from spoofing us. |
| 984 | (insert "\n") (backward-char 1) |
| 985 | ;; Wait for one line. |
| 986 | (while (not (looking-at regexp)) |
| 987 | (accept-process-output proc) |
| 988 | (goto-char pt))) |
| 989 | (goto-char pmark) (delete-char 1) ; remove the extra newline |
| 990 | ;; That's the dirlist. grab it & parse it. |
| 991 | (let* ((dl (buffer-substring (match-beginning 2) (1- (match-end 2)))) |
| 992 | (dl-len (length dl)) |
| 993 | (ds '()) ; new dir stack |
| 994 | (i 0)) |
| 995 | (while (< i dl-len) |
| 996 | ;; regexp = optional whitespace, (non-whitespace), optional whitespace |
| 997 | (string-match "\\s *\\(\\S +\\)\\s *" dl i) ; pick off next dir |
| 998 | (setq ds (cons (concat comint-file-name-prefix |
| 999 | (substring dl (match-beginning 1) |
| 1000 | (match-end 1))) |
| 1001 | ds)) |
| 1002 | (setq i (match-end 0))) |
| 1003 | (let ((ds (nreverse ds))) |
| 1004 | (condition-case nil |
| 1005 | (progn (shell-cd (car ds)) |
| 1006 | (setq shell-dirstack (cdr ds) |
| 1007 | shell-last-dir (car shell-dirstack)) |
| 1008 | (shell-dirstack-message)) |
| 1009 | (error (message "Couldn't cd")))))) |
| 1010 | (if started-at-pmark (goto-char (marker-position pmark))))) |
| 1011 | |
| 1012 | ;; For your typing convenience: |
| 1013 | (defalias 'dirs 'shell-resync-dirs) |
| 1014 | |
| 1015 | |
| 1016 | ;; Show the current dirstack on the message line. |
| 1017 | ;; Pretty up dirs a bit by changing "/usr/jqr/foo" to "~/foo". |
| 1018 | ;; (This isn't necessary if the dirlisting is generated with a simple "dirs".) |
| 1019 | ;; All the commands that mung the buffer's dirstack finish by calling |
| 1020 | ;; this guy. |
| 1021 | (defun shell-dirstack-message () |
| 1022 | (when shell-dirtrack-verbose |
| 1023 | (let* ((msg "") |
| 1024 | (ds (cons default-directory shell-dirstack)) |
| 1025 | (home (expand-file-name (concat comint-file-name-prefix "~/"))) |
| 1026 | (homelen (length home))) |
| 1027 | (while ds |
| 1028 | (let ((dir (car ds))) |
| 1029 | (and (>= (length dir) homelen) |
| 1030 | (string= home (substring dir 0 homelen)) |
| 1031 | (setq dir (concat "~/" (substring dir homelen)))) |
| 1032 | ;; Strip off comint-file-name-prefix if present. |
| 1033 | (and comint-file-name-prefix |
| 1034 | (>= (length dir) (length comint-file-name-prefix)) |
| 1035 | (string= comint-file-name-prefix |
| 1036 | (substring dir 0 (length comint-file-name-prefix))) |
| 1037 | (setq dir (substring dir (length comint-file-name-prefix))) |
| 1038 | (setcar ds dir)) |
| 1039 | (setq msg (concat msg (directory-file-name dir) " ")) |
| 1040 | (setq ds (cdr ds)))) |
| 1041 | (message "%s" msg)))) |
| 1042 | |
| 1043 | ;; This was mostly copied from shell-resync-dirs. |
| 1044 | (defun shell-snarf-envar (var) |
| 1045 | "Return as a string the shell's value of environment variable VAR." |
| 1046 | (let* ((cmd (format "printenv '%s'\n" var)) |
| 1047 | (proc (get-buffer-process (current-buffer))) |
| 1048 | (pmark (process-mark proc))) |
| 1049 | (goto-char pmark) |
| 1050 | (insert cmd) |
| 1051 | (sit-for 0) ; force redisplay |
| 1052 | (comint-send-string proc cmd) |
| 1053 | (set-marker pmark (point)) |
| 1054 | (let ((pt (point))) ; wait for 1 line |
| 1055 | ;; This extra newline prevents the user's pending input from spoofing us. |
| 1056 | (insert "\n") (backward-char 1) |
| 1057 | (while (not (looking-at ".+\n")) |
| 1058 | (accept-process-output proc) |
| 1059 | (goto-char pt))) |
| 1060 | (goto-char pmark) (delete-char 1) ; remove the extra newline |
| 1061 | (buffer-substring (match-beginning 0) (1- (match-end 0))))) |
| 1062 | |
| 1063 | (defun shell-copy-environment-variable (variable) |
| 1064 | "Copy the environment variable VARIABLE from the subshell to Emacs. |
| 1065 | This command reads the value of the specified environment variable |
| 1066 | in the shell, and sets the same environment variable in Emacs |
| 1067 | \(what `getenv' in Emacs would return) to that value. |
| 1068 | That value will affect any new subprocesses that you subsequently start |
| 1069 | from Emacs." |
| 1070 | (interactive (list (read-envvar-name "\ |
| 1071 | Copy Shell environment variable to Emacs: "))) |
| 1072 | (setenv variable (shell-snarf-envar variable))) |
| 1073 | |
| 1074 | (defun shell-forward-command (&optional arg) |
| 1075 | "Move forward across ARG shell command(s). Does not cross lines. |
| 1076 | See `shell-command-regexp'." |
| 1077 | (interactive "p") |
| 1078 | (let ((limit (line-end-position))) |
| 1079 | (if (re-search-forward (concat shell-command-regexp "\\([;&|][\t ]*\\)+") |
| 1080 | limit 'move arg) |
| 1081 | (skip-syntax-backward " ")))) |
| 1082 | |
| 1083 | |
| 1084 | (defun shell-backward-command (&optional arg) |
| 1085 | "Move backward across ARG shell command(s). Does not cross lines. |
| 1086 | See `shell-command-regexp'." |
| 1087 | (interactive "p") |
| 1088 | (let ((limit (save-excursion (comint-bol nil) (point)))) |
| 1089 | (when (> limit (point)) |
| 1090 | (setq limit (line-beginning-position))) |
| 1091 | (skip-syntax-backward " " limit) |
| 1092 | (if (re-search-backward |
| 1093 | (format "[;&|]+[\t ]*\\(%s\\)" shell-command-regexp) limit 'move arg) |
| 1094 | (progn (goto-char (match-beginning 1)) |
| 1095 | (skip-chars-forward ";&|"))))) |
| 1096 | |
| 1097 | (defun shell-dynamic-complete-command () |
| 1098 | "Dynamically complete the command at point. |
| 1099 | This function is similar to `comint-dynamic-complete-filename', except that it |
| 1100 | searches `exec-path' (minus the trailing Emacs library path) for completion |
| 1101 | candidates. Note that this may not be the same as the shell's idea of the |
| 1102 | path. |
| 1103 | |
| 1104 | Completion is dependent on the value of `shell-completion-execonly', plus |
| 1105 | those that effect file completion. |
| 1106 | |
| 1107 | Returns t if successful." |
| 1108 | (interactive) |
| 1109 | (let ((data (shell-command-completion))) |
| 1110 | (if data |
| 1111 | (prog2 (unless (window-minibuffer-p (selected-window)) |
| 1112 | (message "Completing command name...")) |
| 1113 | (apply #'completion-in-region data))))) |
| 1114 | |
| 1115 | (defun shell-command-completion () |
| 1116 | "Return the completion data for the command at point, if any." |
| 1117 | (let ((filename (comint-match-partial-filename))) |
| 1118 | (if (and filename |
| 1119 | (save-match-data (not (string-match "[~/]" filename))) |
| 1120 | (eq (match-beginning 0) |
| 1121 | (save-excursion (shell-backward-command 1) (point)))) |
| 1122 | (shell--command-completion-data)))) |
| 1123 | |
| 1124 | (defun shell--command-completion-data () |
| 1125 | "Return the completion data for the command at point." |
| 1126 | (let* ((filename (or (comint-match-partial-filename) "")) |
| 1127 | (start (if (zerop (length filename)) (point) (match-beginning 0))) |
| 1128 | (end (if (zerop (length filename)) (point) (match-end 0))) |
| 1129 | (filenondir (file-name-nondirectory filename)) |
| 1130 | (path-dirs (cdr (reverse exec-path))) ;FIXME: Why `cdr'? |
| 1131 | (cwd (file-name-as-directory (expand-file-name default-directory))) |
| 1132 | (ignored-extensions |
| 1133 | (and comint-completion-fignore |
| 1134 | (mapconcat (function (lambda (x) (concat (regexp-quote x) "\\'"))) |
| 1135 | comint-completion-fignore "\\|"))) |
| 1136 | (dir "") (comps-in-dir ()) |
| 1137 | (file "") (abs-file-name "") (completions ())) |
| 1138 | ;; Go thru each dir in the search path, finding completions. |
| 1139 | (while path-dirs |
| 1140 | (setq dir (file-name-as-directory (comint-directory (or (car path-dirs) "."))) |
| 1141 | comps-in-dir (and (file-accessible-directory-p dir) |
| 1142 | (file-name-all-completions filenondir dir))) |
| 1143 | ;; Go thru each completion found, to see whether it should be used. |
| 1144 | (while comps-in-dir |
| 1145 | (setq file (car comps-in-dir) |
| 1146 | abs-file-name (concat dir file)) |
| 1147 | (if (and (not (member file completions)) |
| 1148 | (not (and ignored-extensions |
| 1149 | (string-match ignored-extensions file))) |
| 1150 | (or (string-equal dir cwd) |
| 1151 | (not (file-directory-p abs-file-name))) |
| 1152 | (or (null shell-completion-execonly) |
| 1153 | (file-executable-p abs-file-name))) |
| 1154 | (setq completions (cons file completions))) |
| 1155 | (setq comps-in-dir (cdr comps-in-dir))) |
| 1156 | (setq path-dirs (cdr path-dirs))) |
| 1157 | ;; OK, we've got a list of completions. |
| 1158 | (list |
| 1159 | start end |
| 1160 | (lambda (string pred action) |
| 1161 | (if (string-match "/" string) |
| 1162 | (completion-file-name-table string pred action) |
| 1163 | (complete-with-action action completions string pred))) |
| 1164 | :exit-function |
| 1165 | (lambda (_string finished) |
| 1166 | (when (memq finished '(sole finished)) |
| 1167 | (if (looking-at " ") |
| 1168 | (goto-char (match-end 0)) |
| 1169 | (insert " "))))))) |
| 1170 | |
| 1171 | ;; (defun shell-dynamic-complete-as-command () |
| 1172 | ;; "Dynamically complete at point as a command. |
| 1173 | ;; See `shell-dynamic-complete-filename'. Returns t if successful." |
| 1174 | ;; (apply #'completion-in-region shell--command-completion-data)) |
| 1175 | |
| 1176 | (defun shell-dynamic-complete-filename () |
| 1177 | "Dynamically complete the filename at point. |
| 1178 | This completes only if point is at a suitable position for a |
| 1179 | filename argument." |
| 1180 | (interactive) |
| 1181 | (let ((data (shell-filename-completion))) |
| 1182 | (if data (apply #'completion-in-region data)))) |
| 1183 | |
| 1184 | (defun shell-filename-completion () |
| 1185 | "Return the completion data for file name at point, if any." |
| 1186 | (let ((opoint (point)) |
| 1187 | (beg (comint-line-beginning-position))) |
| 1188 | (when (save-excursion |
| 1189 | (goto-char (if (re-search-backward "[;|&]" beg t) |
| 1190 | (match-end 0) |
| 1191 | beg)) |
| 1192 | (re-search-forward "[^ \t][ \t]" opoint t)) |
| 1193 | (comint-filename-completion)))) |
| 1194 | |
| 1195 | (defun shell-match-partial-variable () |
| 1196 | "Return the shell variable at point, or nil if none is found." |
| 1197 | (save-excursion |
| 1198 | (if (re-search-backward "[^A-Za-z0-9_{(]" nil 'move) |
| 1199 | (or (looking-at "\\$") (forward-char 1))) |
| 1200 | (if (or (eolp) (looking-at "[^A-Za-z0-9_{($]")) |
| 1201 | nil |
| 1202 | (looking-at "\\$?[{(]?[A-Za-z0-9_]*[})]?") |
| 1203 | (buffer-substring (match-beginning 0) (match-end 0))))) |
| 1204 | |
| 1205 | (defun shell-dynamic-complete-environment-variable () |
| 1206 | "Dynamically complete the environment variable at point. |
| 1207 | Completes if after a variable, i.e., if it starts with a \"$\". |
| 1208 | |
| 1209 | This function is similar to `comint-dynamic-complete-filename', except that it |
| 1210 | searches `process-environment' for completion candidates. Note that this may |
| 1211 | not be the same as the interpreter's idea of variable names. The main problem |
| 1212 | with this type of completion is that `process-environment' is the environment |
| 1213 | which Emacs started with. Emacs does not track changes to the environment made |
| 1214 | by the interpreter. Perhaps it would be more accurate if this function was |
| 1215 | called `shell-dynamic-complete-process-environment-variable'. |
| 1216 | |
| 1217 | Returns non-nil if successful." |
| 1218 | (interactive) |
| 1219 | (let ((data (shell-environment-variable-completion))) |
| 1220 | (if data |
| 1221 | (prog2 (unless (window-minibuffer-p (selected-window)) |
| 1222 | (message "Completing variable name...")) |
| 1223 | (apply #'completion-in-region data))))) |
| 1224 | |
| 1225 | |
| 1226 | (defun shell-environment-variable-completion () |
| 1227 | "Completion data for an environment variable at point, if any." |
| 1228 | (let* ((var (shell-match-partial-variable)) |
| 1229 | (end (match-end 0))) |
| 1230 | (when (and (not (zerop (length var))) (eq (aref var 0) ?$)) |
| 1231 | (let* ((start |
| 1232 | (save-excursion |
| 1233 | (goto-char (match-beginning 0)) |
| 1234 | (looking-at "\\$?[({]*") |
| 1235 | (match-end 0))) |
| 1236 | (variables (mapcar (lambda (x) |
| 1237 | (substring x 0 (string-match "=" x))) |
| 1238 | process-environment)) |
| 1239 | (suffix (pcase (char-before start) (?\{ "}") (?\( ")") (_ "")))) |
| 1240 | (list start end variables |
| 1241 | :exit-function |
| 1242 | (lambda (s finished) |
| 1243 | (when (memq finished '(sole finished)) |
| 1244 | (let ((suf (concat suffix |
| 1245 | (if (file-directory-p |
| 1246 | (comint-directory (getenv s))) |
| 1247 | "/")))) |
| 1248 | (if (looking-at (regexp-quote suf)) |
| 1249 | (goto-char (match-end 0)) |
| 1250 | (insert suf)))))))))) |
| 1251 | |
| 1252 | |
| 1253 | (defun shell-c-a-p-replace-by-expanded-directory () |
| 1254 | "Expand directory stack reference before point. |
| 1255 | For use on `completion-at-point-functions'." |
| 1256 | (when (comint-match-partial-filename) |
| 1257 | (save-excursion |
| 1258 | (goto-char (match-beginning 0)) |
| 1259 | (let ((stack (cons default-directory shell-dirstack)) |
| 1260 | (index (cond ((looking-at "=-/?") |
| 1261 | (length shell-dirstack)) |
| 1262 | ((looking-at "=\\([0-9]+\\)/?") |
| 1263 | (string-to-number |
| 1264 | (buffer-substring |
| 1265 | (match-beginning 1) (match-end 1))))))) |
| 1266 | (when index |
| 1267 | (let ((start (match-beginning 0)) |
| 1268 | (end (match-end 0)) |
| 1269 | (replacement (file-name-as-directory (nth index stack)))) |
| 1270 | (lambda () |
| 1271 | (cond |
| 1272 | ((>= index (length stack)) |
| 1273 | (error "Directory stack not that deep")) |
| 1274 | (t |
| 1275 | (save-excursion |
| 1276 | (goto-char start) |
| 1277 | (insert replacement) |
| 1278 | (delete-char (- end start))) |
| 1279 | (message "Directory item: %d" index) |
| 1280 | t))))))))) |
| 1281 | |
| 1282 | (defun shell-replace-by-expanded-directory () |
| 1283 | "Expand directory stack reference before point. |
| 1284 | Directory stack references are of the form \"=digit\" or \"=-\". |
| 1285 | See `default-directory' and `shell-dirstack'. |
| 1286 | |
| 1287 | Returns t if successful." |
| 1288 | (interactive) |
| 1289 | (let ((f (shell-c-a-p-replace-by-expanded-directory))) |
| 1290 | (if f (funcall f)))) |
| 1291 | |
| 1292 | (provide 'shell) |
| 1293 | |
| 1294 | ;;; shell.el ends here |