| 1 | ;;; comint.el --- general command interpreter in a window stuff -*- lexical-binding: t -*- |
| 2 | |
| 3 | ;; Copyright (C) 1988, 1990, 1992-2014 Free Software Foundation, Inc. |
| 4 | |
| 5 | ;; Author: Olin Shivers <shivers@cs.cmu.edu> |
| 6 | ;; Simon Marshall <simon@gnu.org> |
| 7 | ;; Maintainer: emacs-devel@gnu.org |
| 8 | ;; Keywords: processes |
| 9 | ;; Package: emacs |
| 10 | |
| 11 | ;; This file is part of GNU Emacs. |
| 12 | |
| 13 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
| 14 | ;; it under the terms of the GNU General Public License as published by |
| 15 | ;; the Free Software Foundation, either version 3 of the License, or |
| 16 | ;; (at your option) any later version. |
| 17 | |
| 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. |
| 22 | |
| 23 | ;; You should have received a copy of the GNU General Public License |
| 24 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
| 25 | |
| 26 | ;;; Commentary: |
| 27 | |
| 28 | ;; This file defines a general command-interpreter-in-a-buffer package |
| 29 | ;; (comint mode). The idea is that you can build specific process-in-a-buffer |
| 30 | ;; modes on top of comint mode -- e.g., Lisp, shell, scheme, T, soar, .... |
| 31 | ;; This way, all these specific packages share a common base functionality, |
| 32 | ;; and a common set of bindings, which makes them easier to use (and |
| 33 | ;; saves code, implementation time, etc., etc.). |
| 34 | |
| 35 | ;; Several packages are already defined using comint mode: |
| 36 | ;; - shell.el defines a shell-in-a-buffer mode. |
| 37 | ;; - cmulisp.el defines a simple lisp-in-a-buffer mode. |
| 38 | ;; |
| 39 | ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode. |
| 40 | ;; - The file tea.el tunes scheme and inferior-scheme modes for T. |
| 41 | ;; - The file soar.el tunes Lisp and inferior-lisp modes for Soar. |
| 42 | ;; - cmutex.el defines TeX and LaTeX modes that invoke TeX, LaTeX, BibTeX, |
| 43 | ;; previewers, and printers from within Emacs. |
| 44 | ;; - background.el allows csh-like job control inside Emacs. |
| 45 | ;; It is pretty easy to make new derived modes for other processes. |
| 46 | |
| 47 | ;; For documentation on the functionality provided by Comint mode, and |
| 48 | ;; the hooks available for customizing it, see the comments below. |
| 49 | ;; For further information on the standard derived modes (shell, |
| 50 | ;; inferior-lisp, inferior-scheme, ...), see the relevant source files. |
| 51 | |
| 52 | ;; For hints on converting existing process modes (e.g., tex-mode, |
| 53 | ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode |
| 54 | ;; instead of shell-mode, see the notes at the end of this file. |
| 55 | |
| 56 | \f |
| 57 | ;; Brief Command Documentation: |
| 58 | ;;============================================================================ |
| 59 | ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp |
| 60 | ;; mode) |
| 61 | ;; |
| 62 | ;; M-p comint-previous-input Cycle backwards in input history |
| 63 | ;; M-n comint-next-input Cycle forwards |
| 64 | ;; M-r comint-history-isearch-backward-regexp Isearch input regexp backward |
| 65 | ;; M-C-l comint-show-output Show last batch of process output |
| 66 | ;; RET comint-send-input |
| 67 | ;; C-d comint-delchar-or-maybe-eof Delete char unless at end of buff |
| 68 | ;; C-c C-a comint-bol-or-process-mark First time, move point to bol; |
| 69 | ;; second time, move to process-mark. |
| 70 | ;; C-c C-u comint-kill-input ^u |
| 71 | ;; C-c C-w backward-kill-word ^w |
| 72 | ;; C-c C-c comint-interrupt-subjob ^c |
| 73 | ;; C-c C-z comint-stop-subjob ^z |
| 74 | ;; C-c C-\ comint-quit-subjob ^\ |
| 75 | ;; C-c C-o comint-delete-output Delete last batch of process output |
| 76 | ;; C-c C-r comint-show-output Show last batch of process output |
| 77 | ;; C-c C-l comint-dynamic-list-input-ring List input history |
| 78 | ;; |
| 79 | ;; Not bound by default in comint-mode (some are in shell mode) |
| 80 | ;; comint-run Run a program under comint-mode |
| 81 | ;; send-invisible Read a line w/o echo, and send to proc |
| 82 | ;; comint-dynamic-complete-filename Complete filename at point. |
| 83 | ;; comint-dynamic-list-filename-completions List completions in help buffer. |
| 84 | ;; comint-replace-by-expanded-filename Expand and complete filename at point; |
| 85 | ;; replace with expanded/completed name. |
| 86 | ;; comint-replace-by-expanded-history Expand history at point; |
| 87 | ;; replace with expanded name. |
| 88 | ;; comint-magic-space Expand history and add (a) space(s). |
| 89 | ;; comint-kill-subjob No mercy. |
| 90 | ;; comint-show-maximum-output Show as much output as possible. |
| 91 | ;; comint-continue-subjob Send CONT signal to buffer's process |
| 92 | ;; group. Useful if you accidentally |
| 93 | ;; suspend your process (with C-c C-z). |
| 94 | ;; comint-get-next-from-history Fetch successive input history lines |
| 95 | ;; comint-accumulate Combine lines to send them together |
| 96 | ;; as input. |
| 97 | ;; comint-goto-process-mark Move point to where process-mark is. |
| 98 | ;; comint-set-process-mark Set process-mark to point. |
| 99 | |
| 100 | ;; comint-mode-hook is the Comint mode hook. Basically for your keybindings. |
| 101 | |
| 102 | ;;; Code: |
| 103 | |
| 104 | (require 'ring) |
| 105 | (require 'ansi-color) |
| 106 | (require 'regexp-opt) ;For regexp-opt-charset. |
| 107 | \f |
| 108 | ;; Buffer Local Variables: |
| 109 | ;;============================================================================ |
| 110 | ;; Comint mode buffer local variables: |
| 111 | ;; comint-prompt-regexp string comint-bol uses to match prompt |
| 112 | ;; comint-delimiter-argument-list list For delimiters and arguments |
| 113 | ;; comint-last-input-start marker Handy if inferior always echoes |
| 114 | ;; comint-last-input-end marker For comint-delete-output command |
| 115 | ;; comint-input-ring-size integer For the input history |
| 116 | ;; comint-input-ring ring mechanism |
| 117 | ;; comint-input-ring-index number ... |
| 118 | ;; comint-save-input-ring-index number ... |
| 119 | ;; comint-input-autoexpand symbol ... |
| 120 | ;; comint-input-ignoredups boolean ... |
| 121 | ;; comint-dynamic-complete-functions hook For the completion mechanism |
| 122 | ;; comint-completion-fignore list ... |
| 123 | ;; comint-file-name-chars string ... |
| 124 | ;; comint-file-name-quote-list list ... |
| 125 | ;; comint-get-old-input function Hooks for specific |
| 126 | ;; comint-input-filter-functions hook process-in-a-buffer |
| 127 | ;; comint-output-filter-functions hook function modes. |
| 128 | ;; comint-preoutput-filter-functions hook |
| 129 | ;; comint-input-filter function ... |
| 130 | ;; comint-input-sender function ... |
| 131 | ;; comint-eol-on-send boolean ... |
| 132 | ;; comint-process-echoes boolean ... |
| 133 | ;; comint-scroll-to-bottom-on-input symbol For scroll behavior |
| 134 | ;; comint-move-point-for-output symbol ... |
| 135 | ;; comint-scroll-show-maximum-output boolean ... |
| 136 | ;; comint-accum-marker maker For comint-accumulate |
| 137 | ;; |
| 138 | ;; Comint mode non-buffer local variables: |
| 139 | ;; comint-completion-addsuffix boolean/cons For file name |
| 140 | ;; comint-completion-autolist boolean completion behavior |
| 141 | ;; comint-completion-recexact boolean ... |
| 142 | |
| 143 | (defgroup comint nil |
| 144 | "General command interpreter in a window stuff." |
| 145 | :group 'processes) |
| 146 | |
| 147 | (defgroup comint-completion nil |
| 148 | "Completion facilities in comint." |
| 149 | :group 'comint) |
| 150 | |
| 151 | ;; Unused. |
| 152 | ;;; (defgroup comint-source nil |
| 153 | ;;; "Source finding facilities in comint." |
| 154 | ;;; :prefix "comint-" |
| 155 | ;;; :group 'comint) |
| 156 | |
| 157 | (defvar comint-prompt-regexp "^" |
| 158 | "Regexp to recognize prompts in the inferior process. |
| 159 | Defaults to \"^\", the null string at BOL. |
| 160 | |
| 161 | This variable is only used if the variable |
| 162 | `comint-use-prompt-regexp' is non-nil. |
| 163 | |
| 164 | Good choices: |
| 165 | Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp) |
| 166 | Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\" |
| 167 | franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\" |
| 168 | kcl: \"^>+ *\" |
| 169 | shell: \"^[^#$%>\\n]*[#$%>] *\" |
| 170 | T: \"^>+ *\" |
| 171 | |
| 172 | This is a good thing to set in mode hooks.") |
| 173 | |
| 174 | (defcustom comint-prompt-read-only nil |
| 175 | "If non-nil, the comint prompt is read only. |
| 176 | The read only region includes the newline before the prompt. |
| 177 | This does not affect existing prompts. |
| 178 | Certain derived modes may override this option. |
| 179 | |
| 180 | If you set this option to t, then the safe way to temporarily |
| 181 | override the read-only-ness of comint prompts is to call |
| 182 | `comint-kill-whole-line' or `comint-kill-region' with no |
| 183 | narrowing in effect. This way you will be certain that none of |
| 184 | the remaining prompts will be accidentally messed up. You may |
| 185 | wish to put something like the following in your init file: |
| 186 | |
| 187 | \(add-hook 'comint-mode-hook |
| 188 | (lambda () |
| 189 | (define-key comint-mode-map [remap kill-region] 'comint-kill-region) |
| 190 | (define-key comint-mode-map [remap kill-whole-line] |
| 191 | 'comint-kill-whole-line))) |
| 192 | |
| 193 | If you sometimes use comint-mode on text-only terminals or with `emacs -nw', |
| 194 | you might wish to use another binding for `comint-kill-whole-line'." |
| 195 | :type 'boolean |
| 196 | :group 'comint |
| 197 | :version "22.1") |
| 198 | |
| 199 | (defvar comint-delimiter-argument-list () |
| 200 | "List of characters to recognize as separate arguments in input. |
| 201 | Strings comprising a character in this list will separate the arguments |
| 202 | surrounding them, and also be regarded as arguments in their own right (unlike |
| 203 | whitespace). See `comint-arguments'. |
| 204 | Defaults to the empty list. |
| 205 | |
| 206 | For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;). |
| 207 | |
| 208 | This is a good thing to set in mode hooks.") |
| 209 | |
| 210 | (defcustom comint-input-autoexpand nil |
| 211 | "If non-nil, expand input command history references on completion. |
| 212 | This mirrors the optional behavior of tcsh (its autoexpand and histlist). |
| 213 | |
| 214 | If the value is `input', then the expansion is seen on input. |
| 215 | If the value is `history', then the expansion is only when inserting |
| 216 | into the buffer's input ring. See also `comint-magic-space' and |
| 217 | `completion-at-point'. |
| 218 | |
| 219 | This variable is buffer-local." |
| 220 | :type '(choice (const :tag "off" nil) |
| 221 | (const input) |
| 222 | (const history) |
| 223 | (other :tag "on" t)) |
| 224 | :group 'comint) |
| 225 | |
| 226 | (defface comint-highlight-input '((t (:weight bold))) |
| 227 | "Face to use to highlight user input." |
| 228 | :group 'comint) |
| 229 | |
| 230 | (defface comint-highlight-prompt |
| 231 | '((t :inherit minibuffer-prompt)) |
| 232 | "Face to use to highlight prompts." |
| 233 | :group 'comint) |
| 234 | |
| 235 | (defcustom comint-input-ignoredups nil |
| 236 | "If non-nil, don't add input matching the last on the input ring. |
| 237 | This mirrors the optional behavior of bash. |
| 238 | |
| 239 | This variable is buffer-local." |
| 240 | :type 'boolean |
| 241 | :group 'comint) |
| 242 | |
| 243 | (defcustom comint-input-ring-file-name nil |
| 244 | "If non-nil, name of the file to read/write input history. |
| 245 | See also `comint-read-input-ring' and `comint-write-input-ring'. |
| 246 | `comint-mode' makes this a buffer-local variable. You probably want |
| 247 | to set this in a mode hook, rather than customize the default value." |
| 248 | :type '(choice (const :tag "nil" nil) |
| 249 | file) |
| 250 | :group 'comint) |
| 251 | |
| 252 | (defcustom comint-scroll-to-bottom-on-input nil |
| 253 | "Controls whether input to interpreter causes window to scroll. |
| 254 | If nil, then do not scroll. If t or `all', scroll all windows showing buffer. |
| 255 | If `this', scroll only the selected window. |
| 256 | |
| 257 | The default is nil. |
| 258 | |
| 259 | See `comint-preinput-scroll-to-bottom'. This variable is buffer-local." |
| 260 | :type '(choice (const :tag "off" nil) |
| 261 | (const t) |
| 262 | (const all) |
| 263 | (const this)) |
| 264 | :group 'comint) |
| 265 | |
| 266 | (defcustom comint-move-point-for-output nil |
| 267 | "Controls whether interpreter output moves point to the end of the output. |
| 268 | If nil, then output never moves point to the output. |
| 269 | (If the output occurs at point, it is inserted before point.) |
| 270 | If t or `all', move point in all windows showing the buffer. |
| 271 | If `this', move point only the selected window. |
| 272 | If `others', move point only in other windows, not in the selected window. |
| 273 | |
| 274 | The default is nil. |
| 275 | |
| 276 | See the variable `comint-scroll-show-maximum-output' and the function |
| 277 | `comint-postoutput-scroll-to-bottom'. |
| 278 | This variable is buffer-local in all Comint buffers." |
| 279 | :type '(choice (const :tag "off" nil) |
| 280 | (const t) |
| 281 | (const all) |
| 282 | (const this) |
| 283 | (const others)) |
| 284 | :group 'comint) |
| 285 | |
| 286 | (defvaralias 'comint-scroll-to-bottom-on-output 'comint-move-point-for-output) |
| 287 | |
| 288 | (defcustom comint-scroll-show-maximum-output t |
| 289 | "Controls how to scroll due to interpreter output. |
| 290 | This variable applies when point is at the end of the buffer |
| 291 | \(either because it was originally there, or because |
| 292 | `comint-move-point-for-output' said to move it there) |
| 293 | and output from the subprocess is inserted. |
| 294 | |
| 295 | Non-nil means scroll so that the window is full of text |
| 296 | and point is on the last line. A value of nil |
| 297 | means don't do anything special--scroll normally. |
| 298 | |
| 299 | See also the variable `comint-move-point-for-output' and the function |
| 300 | `comint-postoutput-scroll-to-bottom'. |
| 301 | This variable is buffer-local in all Comint buffers." |
| 302 | :type 'boolean |
| 303 | :group 'comint) |
| 304 | |
| 305 | (defcustom comint-buffer-maximum-size 1024 |
| 306 | "The maximum size in lines for Comint buffers. |
| 307 | Comint buffers are truncated from the top to be no greater than this number, if |
| 308 | the function `comint-truncate-buffer' is on `comint-output-filter-functions'." |
| 309 | :type 'integer |
| 310 | :group 'comint) |
| 311 | |
| 312 | (defcustom comint-input-ring-size 500 |
| 313 | "Size of the input history ring in `comint-mode'." |
| 314 | :type 'integer |
| 315 | :group 'comint |
| 316 | :version "23.2") |
| 317 | |
| 318 | (defvar comint-input-ring-separator "\n" |
| 319 | "Separator between commands in the history file.") |
| 320 | |
| 321 | (defvar comint-input-history-ignore "^#" |
| 322 | "Regexp for history entries that should be ignored when Comint initializes.") |
| 323 | |
| 324 | (defcustom comint-process-echoes nil |
| 325 | "If non-nil, assume that the subprocess echoes any input. |
| 326 | If so, delete one copy of the input so that only one copy eventually |
| 327 | appears in the buffer. |
| 328 | |
| 329 | This variable is buffer-local." |
| 330 | :type 'boolean |
| 331 | :group 'comint) |
| 332 | |
| 333 | ;; AIX puts the name of the person being su'd to in front of the prompt. |
| 334 | ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '. |
| 335 | ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '. |
| 336 | ;; ssh-add prints a prompt like `Enter passphrase: '. |
| 337 | ;; plink prints a prompt like `Passphrase for key "root@GNU.ORG": '. |
| 338 | ;; Ubuntu's sudo prompts like `[sudo] password for user:' |
| 339 | ;; Some implementations of passwd use "Password (again)" as the 2nd prompt. |
| 340 | ;; Something called "perforce" uses "Enter password:". |
| 341 | ;; See M-x comint-testsuite--test-comint-password-prompt-regexp. |
| 342 | (defcustom comint-password-prompt-regexp |
| 343 | (concat |
| 344 | "\\(^ *\\|" |
| 345 | (regexp-opt |
| 346 | '("Enter" "enter" "Enter same" "enter same" "Enter the" "enter the" |
| 347 | "Old" "old" "New" "new" "'s" "login" |
| 348 | "Kerberos" "CVS" "UNIX" " SMB" "LDAP" "[sudo]" "Repeat" "Bad") t) |
| 349 | " +\\)" |
| 350 | "\\(?:" (regexp-opt password-word-equivalents) "\\|Response\\)" |
| 351 | "\\(?:\\(?:, try\\)? *again\\| (empty for no passphrase)\\| (again)\\)?\ |
| 352 | \\(?: for [^::៖]+\\)?[::៖]\\s *\\'") |
| 353 | "Regexp matching prompts for passwords in the inferior process. |
| 354 | This is used by `comint-watch-for-password-prompt'." |
| 355 | :version "24.4" |
| 356 | :type 'regexp |
| 357 | :group 'comint) |
| 358 | |
| 359 | ;; Here are the per-interpreter hooks. |
| 360 | (defvar comint-get-old-input (function comint-get-old-input-default) |
| 361 | "Function that returns old text in Comint mode. |
| 362 | This function is called when return is typed while the point is in old |
| 363 | text. It returns the text to be submitted as process input. The |
| 364 | default is `comint-get-old-input-default', which either grabs the |
| 365 | current input field or grabs the current line and strips off leading |
| 366 | text matching `comint-prompt-regexp', depending on the value of |
| 367 | `comint-use-prompt-regexp'.") |
| 368 | |
| 369 | (defvar comint-dynamic-complete-functions |
| 370 | '(comint-c-a-p-replace-by-expanded-history comint-filename-completion) |
| 371 | "List of functions called to perform completion. |
| 372 | Works like `completion-at-point-functions'. |
| 373 | See also `completion-at-point'. |
| 374 | |
| 375 | This is a good thing to set in mode hooks.") |
| 376 | |
| 377 | (defvar comint-input-filter |
| 378 | (function (lambda (str) (not (string-match "\\`\\s *\\'" str)))) |
| 379 | "Predicate for filtering additions to input history. |
| 380 | Takes one argument, the input. If non-nil, the input may be saved on the input |
| 381 | history list. Default is to save anything that isn't all whitespace.") |
| 382 | |
| 383 | (defvar comint-input-filter-functions '() |
| 384 | "Abnormal hook run before input is sent to the process. |
| 385 | These functions get one argument, a string containing the text to send.") |
| 386 | |
| 387 | ;;;###autoload |
| 388 | (defvar comint-output-filter-functions '(ansi-color-process-output comint-postoutput-scroll-to-bottom comint-watch-for-password-prompt) |
| 389 | "Functions to call after output is inserted into the buffer. |
| 390 | One possible function is `comint-postoutput-scroll-to-bottom'. |
| 391 | These functions get one argument, a string containing the text as originally |
| 392 | inserted. Note that this might not be the same as the buffer contents between |
| 393 | `comint-last-output-start' and the buffer's `process-mark', if other filter |
| 394 | functions have already modified the buffer. |
| 395 | |
| 396 | See also `comint-preoutput-filter-functions'. |
| 397 | |
| 398 | You can use `add-hook' to add functions to this list |
| 399 | either globally or locally.") |
| 400 | |
| 401 | (defvar comint-input-sender-no-newline nil |
| 402 | "Non-nil directs the `comint-input-sender' function not to send a newline.") |
| 403 | |
| 404 | (defvar comint-input-sender (function comint-simple-send) |
| 405 | "Function to actually send to PROCESS the STRING submitted by user. |
| 406 | Usually this is just `comint-simple-send', but if your mode needs to |
| 407 | massage the input string, put a different function here. |
| 408 | `comint-simple-send' just sends the string plus a newline. |
| 409 | \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.) |
| 410 | This is called from the user command `comint-send-input'.") |
| 411 | |
| 412 | (defcustom comint-eol-on-send t |
| 413 | "Non-nil means go to the end of the line before sending input. |
| 414 | See `comint-send-input'." |
| 415 | :type 'boolean |
| 416 | :group 'comint) |
| 417 | |
| 418 | (define-obsolete-variable-alias 'comint-use-prompt-regexp-instead-of-fields |
| 419 | 'comint-use-prompt-regexp "22.1") |
| 420 | |
| 421 | ;; Note: If it is decided to purge comint-prompt-regexp from the source |
| 422 | ;; entirely, searching for uses of this variable will help to identify |
| 423 | ;; places that need attention. |
| 424 | (defcustom comint-use-prompt-regexp nil |
| 425 | "If non-nil, use `comint-prompt-regexp' to recognize prompts. |
| 426 | If nil, then program output and user-input are given different `field' |
| 427 | properties, which Emacs commands can use to distinguish them (in |
| 428 | particular, common movement commands such as `beginning-of-line' |
| 429 | respect field boundaries in a natural way)." |
| 430 | :type 'boolean |
| 431 | :group 'comint) |
| 432 | |
| 433 | (defcustom comint-mode-hook nil |
| 434 | "Hook run upon entry to `comint-mode'. |
| 435 | This is run before the process is cranked up." |
| 436 | :type 'hook |
| 437 | :group 'comint) |
| 438 | |
| 439 | (defcustom comint-exec-hook '() |
| 440 | "Hook run each time a process is exec'd by `comint-exec'. |
| 441 | This is called after the process is cranked up. It is useful for things that |
| 442 | must be done each time a process is executed in a Comint mode buffer (e.g., |
| 443 | `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only |
| 444 | executed once when the buffer is created." |
| 445 | :type 'hook |
| 446 | :group 'comint) |
| 447 | |
| 448 | (defvar comint-mode-map |
| 449 | (let ((map (make-sparse-keymap))) |
| 450 | ;; Keys: |
| 451 | (define-key map "\ep" 'comint-previous-input) |
| 452 | (define-key map "\en" 'comint-next-input) |
| 453 | (define-key map [C-up] 'comint-previous-input) |
| 454 | (define-key map [C-down] 'comint-next-input) |
| 455 | (define-key map "\er" 'comint-history-isearch-backward-regexp) |
| 456 | (define-key map [?\C-c ?\M-r] 'comint-previous-matching-input-from-input) |
| 457 | (define-key map [?\C-c ?\M-s] 'comint-next-matching-input-from-input) |
| 458 | (define-key map "\e\C-l" 'comint-show-output) |
| 459 | (define-key map "\C-m" 'comint-send-input) |
| 460 | (define-key map "\C-d" 'comint-delchar-or-maybe-eof) |
| 461 | ;; The following two are standardly bound to delete-forward-char, |
| 462 | ;; but they should never do EOF, just delete. |
| 463 | (define-key map [delete] 'delete-forward-char) |
| 464 | (define-key map [kp-delete] 'delete-forward-char) |
| 465 | (define-key map "\C-c " 'comint-accumulate) |
| 466 | (define-key map "\C-c\C-x" 'comint-get-next-from-history) |
| 467 | (define-key map "\C-c\C-a" 'comint-bol-or-process-mark) |
| 468 | (define-key map "\C-c\C-u" 'comint-kill-input) |
| 469 | (define-key map "\C-c\C-w" 'backward-kill-word) |
| 470 | (define-key map "\C-c\C-c" 'comint-interrupt-subjob) |
| 471 | (define-key map "\C-c\C-z" 'comint-stop-subjob) |
| 472 | (define-key map "\C-c\C-\\" 'comint-quit-subjob) |
| 473 | (define-key map "\C-c\C-m" 'comint-copy-old-input) |
| 474 | (define-key map "\C-c\C-o" 'comint-delete-output) |
| 475 | (define-key map "\C-c\C-r" 'comint-show-output) |
| 476 | (define-key map "\C-c\C-e" 'comint-show-maximum-output) |
| 477 | (define-key map "\C-c\C-l" 'comint-dynamic-list-input-ring) |
| 478 | (define-key map "\C-c\C-n" 'comint-next-prompt) |
| 479 | (define-key map "\C-c\C-p" 'comint-previous-prompt) |
| 480 | (define-key map "\C-c\C-d" 'comint-send-eof) |
| 481 | (define-key map "\C-c\C-s" 'comint-write-output) |
| 482 | (define-key map "\C-c." 'comint-insert-previous-argument) |
| 483 | ;; Mouse Buttons: |
| 484 | (define-key map [mouse-2] 'comint-insert-input) |
| 485 | ;; Menu bars: |
| 486 | ;; completion: |
| 487 | (define-key map [menu-bar completion] |
| 488 | (cons "Complete" (make-sparse-keymap "Complete"))) |
| 489 | (define-key map [menu-bar completion complete-expand] |
| 490 | '("Expand File Name" . comint-replace-by-expanded-filename)) |
| 491 | (define-key map [menu-bar completion complete-listing] |
| 492 | '("File Completion Listing" . comint-dynamic-list-filename-completions)) |
| 493 | (define-key map [menu-bar completion complete-file] |
| 494 | '("Complete File Name" . comint-dynamic-complete-filename)) |
| 495 | (define-key map [menu-bar completion complete] |
| 496 | '("Complete at Point" . completion-at-point)) |
| 497 | ;; Input history: |
| 498 | (define-key map [menu-bar inout] |
| 499 | (cons "In/Out" (make-sparse-keymap "In/Out"))) |
| 500 | (define-key map [menu-bar inout delete-output] |
| 501 | '("Delete Current Output Group" . comint-delete-output)) |
| 502 | (define-key map [menu-bar inout append-output-to-file] |
| 503 | '("Append Current Output Group to File" . comint-append-output-to-file)) |
| 504 | (define-key map [menu-bar inout write-output] |
| 505 | '("Write Current Output Group to File" . comint-write-output)) |
| 506 | (define-key map [menu-bar inout next-prompt] |
| 507 | '("Forward Output Group" . comint-next-prompt)) |
| 508 | (define-key map [menu-bar inout previous-prompt] |
| 509 | '("Backward Output Group" . comint-previous-prompt)) |
| 510 | (define-key map [menu-bar inout show-maximum-output] |
| 511 | '("Show Maximum Output" . comint-show-maximum-output)) |
| 512 | (define-key map [menu-bar inout show-output] |
| 513 | '("Show Current Output Group" . comint-show-output)) |
| 514 | (define-key map [menu-bar inout kill-input] |
| 515 | '("Kill Current Input" . comint-kill-input)) |
| 516 | (define-key map [menu-bar inout copy-input] |
| 517 | '("Copy Old Input" . comint-copy-old-input)) |
| 518 | (define-key map [menu-bar inout history-isearch-backward-regexp] |
| 519 | '("Isearch Input Regexp Backward..." . comint-history-isearch-backward-regexp)) |
| 520 | (define-key map [menu-bar inout history-isearch-backward] |
| 521 | '("Isearch Input String Backward..." . comint-history-isearch-backward)) |
| 522 | (define-key map [menu-bar inout forward-matching-history] |
| 523 | '("Forward Matching Input..." . comint-forward-matching-input)) |
| 524 | (define-key map [menu-bar inout backward-matching-history] |
| 525 | '("Backward Matching Input..." . comint-backward-matching-input)) |
| 526 | (define-key map [menu-bar inout next-matching-history] |
| 527 | '("Next Matching Input..." . comint-next-matching-input)) |
| 528 | (define-key map [menu-bar inout previous-matching-history] |
| 529 | '("Previous Matching Input..." . comint-previous-matching-input)) |
| 530 | (define-key map [menu-bar inout next-matching-history-from-input] |
| 531 | '("Next Matching Current Input" . comint-next-matching-input-from-input)) |
| 532 | (define-key map [menu-bar inout previous-matching-history-from-input] |
| 533 | '("Previous Matching Current Input" . comint-previous-matching-input-from-input)) |
| 534 | (define-key map [menu-bar inout next-history] |
| 535 | '("Next Input" . comint-next-input)) |
| 536 | (define-key map [menu-bar inout previous-history] |
| 537 | '("Previous Input" . comint-previous-input)) |
| 538 | (define-key map [menu-bar inout list-history] |
| 539 | '("List Input History" . comint-dynamic-list-input-ring)) |
| 540 | (define-key map [menu-bar inout expand-history] |
| 541 | '("Expand History Before Point" . comint-replace-by-expanded-history)) |
| 542 | ;; Signals |
| 543 | (let ((signals-map (make-sparse-keymap "Signals"))) |
| 544 | (define-key map [menu-bar signals] (cons "Signals" signals-map)) |
| 545 | (define-key signals-map [eof] '("EOF" . comint-send-eof)) |
| 546 | (define-key signals-map [kill] '("KILL" . comint-kill-subjob)) |
| 547 | (define-key signals-map [quit] '("QUIT" . comint-quit-subjob)) |
| 548 | (define-key signals-map [cont] '("CONT" . comint-continue-subjob)) |
| 549 | (define-key signals-map [stop] '("STOP" . comint-stop-subjob)) |
| 550 | (define-key signals-map [break] '("BREAK" . comint-interrupt-subjob))) |
| 551 | ;; Put them in the menu bar: |
| 552 | (setq menu-bar-final-items (append '(completion inout signals) |
| 553 | menu-bar-final-items)) |
| 554 | map)) |
| 555 | |
| 556 | ;; Fixme: Is this still relevant? |
| 557 | (defvar comint-ptyp t |
| 558 | "Non-nil if communications via pty; false if by pipe. Buffer local. |
| 559 | This is to work around a bug in Emacs process signaling.") |
| 560 | |
| 561 | (defvar comint-input-ring nil) |
| 562 | (defvar comint-last-input-start nil) |
| 563 | (defvar comint-last-input-end nil) |
| 564 | (defvar comint-last-output-start nil) |
| 565 | (defvar comint-input-ring-index nil |
| 566 | "Index of last matched history element.") |
| 567 | (defvar comint-matching-input-from-input-string "" |
| 568 | "Input previously used to match input history.") |
| 569 | (defvar comint-save-input-ring-index nil |
| 570 | "Last input ring index which you copied. |
| 571 | This is to support the command \\[comint-get-next-from-history].") |
| 572 | |
| 573 | (defvar comint-accum-marker nil |
| 574 | "Non-nil if you are accumulating input lines to send as input together. |
| 575 | The command \\[comint-accumulate] sets this.") |
| 576 | |
| 577 | (defvar comint-stored-incomplete-input nil |
| 578 | "Stored input for history cycling.") |
| 579 | |
| 580 | (put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand) |
| 581 | (put 'comint-input-ring 'permanent-local t) |
| 582 | (put 'comint-input-ring-index 'permanent-local t) |
| 583 | (put 'comint-save-input-ring-index 'permanent-local t) |
| 584 | (put 'comint-input-autoexpand 'permanent-local t) |
| 585 | (put 'comint-input-filter-functions 'permanent-local t) |
| 586 | (put 'comint-output-filter-functions 'permanent-local t) |
| 587 | (put 'comint-preoutput-filter-functions 'permanent-local t) |
| 588 | (put 'comint-scroll-to-bottom-on-input 'permanent-local t) |
| 589 | (put 'comint-move-point-for-output 'permanent-local t) |
| 590 | (put 'comint-scroll-show-maximum-output 'permanent-local t) |
| 591 | (put 'comint-ptyp 'permanent-local t) |
| 592 | |
| 593 | (put 'comint-mode 'mode-class 'special) |
| 594 | |
| 595 | (define-derived-mode comint-mode fundamental-mode "Comint" |
| 596 | "Major mode for interacting with an inferior interpreter. |
| 597 | Interpreter name is same as buffer name, sans the asterisks. |
| 598 | Return at end of buffer sends line as input. |
| 599 | Return not at end copies rest of line to end and sends it. |
| 600 | Setting variable `comint-eol-on-send' means jump to the end of the line |
| 601 | before submitting new input. |
| 602 | |
| 603 | This mode is customized to create major modes such as Inferior Lisp |
| 604 | mode, Shell mode, etc. This can be done by setting the hooks |
| 605 | `comint-input-filter-functions', `comint-input-filter', `comint-input-sender' |
| 606 | and `comint-get-old-input' to appropriate functions, and the variable |
| 607 | `comint-prompt-regexp' to the appropriate regular expression. |
| 608 | |
| 609 | The mode maintains an input history of size `comint-input-ring-size'. |
| 610 | You can access this with the commands \\[comint-next-input], |
| 611 | \\[comint-previous-input], and \\[comint-dynamic-list-input-ring]. |
| 612 | Input ring history expansion can be achieved with the commands |
| 613 | \\[comint-replace-by-expanded-history] or \\[comint-magic-space]. |
| 614 | Input ring expansion is controlled by the variable `comint-input-autoexpand', |
| 615 | and addition is controlled by the variable `comint-input-ignoredups'. |
| 616 | |
| 617 | Commands with no default key bindings include `send-invisible', |
| 618 | `completion-at-point', `comint-dynamic-list-filename-completions', and |
| 619 | `comint-magic-space'. |
| 620 | |
| 621 | Input to, and output from, the subprocess can cause the window to scroll to |
| 622 | the end of the buffer. See variables `comint-output-filter-functions', |
| 623 | `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input', |
| 624 | and `comint-move-point-for-output'. |
| 625 | |
| 626 | If you accidentally suspend your process, use \\[comint-continue-subjob] |
| 627 | to continue it. |
| 628 | |
| 629 | \\{comint-mode-map} |
| 630 | |
| 631 | Entry to this mode runs the hooks on `comint-mode-hook'." |
| 632 | (setq mode-line-process '(":%s")) |
| 633 | (setq-local window-point-insertion-type t) |
| 634 | (setq-local comint-last-input-start (point-min-marker)) |
| 635 | (setq-local comint-last-input-end (point-min-marker)) |
| 636 | (setq-local comint-last-output-start (make-marker)) |
| 637 | (make-local-variable 'comint-last-prompt) |
| 638 | (make-local-variable 'comint-prompt-regexp) ; Don't set; default |
| 639 | (make-local-variable 'comint-input-ring-size) ; ...to global val. |
| 640 | (make-local-variable 'comint-input-ring) |
| 641 | (make-local-variable 'comint-input-ring-file-name) |
| 642 | (or (and (boundp 'comint-input-ring) comint-input-ring) |
| 643 | (setq comint-input-ring (make-ring comint-input-ring-size))) |
| 644 | (make-local-variable 'comint-input-ring-index) |
| 645 | (make-local-variable 'comint-save-input-ring-index) |
| 646 | (or (and (boundp 'comint-input-ring-index) comint-input-ring-index) |
| 647 | (setq comint-input-ring-index nil)) |
| 648 | (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index) |
| 649 | (setq comint-save-input-ring-index nil)) |
| 650 | (make-local-variable 'comint-matching-input-from-input-string) |
| 651 | (make-local-variable 'comint-input-autoexpand) |
| 652 | (make-local-variable 'comint-input-ignoredups) |
| 653 | (make-local-variable 'comint-delimiter-argument-list) |
| 654 | (make-local-variable 'comint-completion-fignore) |
| 655 | (make-local-variable 'comint-get-old-input) |
| 656 | (make-local-variable 'comint-input-filter) |
| 657 | (make-local-variable 'comint-input-sender) |
| 658 | (make-local-variable 'comint-eol-on-send) |
| 659 | (make-local-variable 'comint-scroll-to-bottom-on-input) |
| 660 | (make-local-variable 'comint-move-point-for-output) |
| 661 | (make-local-variable 'comint-scroll-show-maximum-output) |
| 662 | (make-local-variable 'comint-stored-incomplete-input) |
| 663 | ;; Following disabled because it seems to break the case when |
| 664 | ;; comint-scroll-show-maximum-output is nil, and no-one can remember |
| 665 | ;; what the original problem was. If there are problems with point |
| 666 | ;; not going to the end, consider re-enabling this. |
| 667 | ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00827.html |
| 668 | ;; |
| 669 | ;; This makes it really work to keep point at the bottom. |
| 670 | ;; (make-local-variable 'scroll-conservatively) |
| 671 | ;; (setq scroll-conservatively 10000) |
| 672 | (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t) |
| 673 | (make-local-variable 'comint-ptyp) |
| 674 | (make-local-variable 'comint-process-echoes) |
| 675 | (make-local-variable 'comint-file-name-chars) |
| 676 | (make-local-variable 'comint-file-name-quote-list) |
| 677 | ;; dir tracking on remote files |
| 678 | (setq-local comint-file-name-prefix |
| 679 | (or (file-remote-p default-directory) "")) |
| 680 | (setq-local comint-accum-marker (make-marker)) |
| 681 | (setq-local font-lock-defaults '(nil t)) |
| 682 | (add-hook 'change-major-mode-hook 'font-lock-defontify nil t) |
| 683 | (add-hook 'isearch-mode-hook 'comint-history-isearch-setup nil t) |
| 684 | (add-hook 'completion-at-point-functions 'comint-completion-at-point nil t) |
| 685 | ;; This behavior is not useful in comint buffers, and is annoying |
| 686 | (setq-local next-line-add-newlines nil)) |
| 687 | |
| 688 | (defun comint-check-proc (buffer) |
| 689 | "Return non-nil if there is a living process associated w/buffer BUFFER. |
| 690 | Living means the status is `open', `run', or `stop'. |
| 691 | BUFFER can be either a buffer or the name of one." |
| 692 | (let ((proc (get-buffer-process buffer))) |
| 693 | (and proc (memq (process-status proc) '(open run stop))))) |
| 694 | |
| 695 | ;;;###autoload |
| 696 | (defun make-comint-in-buffer (name buffer program &optional startfile &rest switches) |
| 697 | "Make a Comint process NAME in BUFFER, running PROGRAM. |
| 698 | If BUFFER is nil, it defaults to NAME surrounded by `*'s. |
| 699 | If there is a running process in BUFFER, it is not restarted. |
| 700 | |
| 701 | PROGRAM should be one of the following: |
| 702 | - a string, denoting an executable program to create via |
| 703 | `start-file-process' |
| 704 | - a cons pair of the form (HOST . SERVICE), denoting a TCP |
| 705 | connection to be opened via `open-network-stream' |
| 706 | - nil, denoting a newly-allocated pty. |
| 707 | |
| 708 | Optional fourth arg STARTFILE is the name of a file, whose |
| 709 | contents are sent to the process as its initial input. |
| 710 | |
| 711 | If PROGRAM is a string, any more args are arguments to PROGRAM. |
| 712 | |
| 713 | Return the (possibly newly created) process buffer." |
| 714 | (or (fboundp 'start-file-process) |
| 715 | (error "Multi-processing is not supported for this system")) |
| 716 | (setq buffer (get-buffer-create (or buffer (concat "*" name "*")))) |
| 717 | ;; If no process, or nuked process, crank up a new one and put buffer in |
| 718 | ;; comint mode. Otherwise, leave buffer and existing process alone. |
| 719 | (unless (comint-check-proc buffer) |
| 720 | (with-current-buffer buffer |
| 721 | (unless (derived-mode-p 'comint-mode) |
| 722 | (comint-mode))) ; Install local vars, mode, keymap, ... |
| 723 | (comint-exec buffer name program startfile switches)) |
| 724 | buffer) |
| 725 | |
| 726 | ;;;###autoload |
| 727 | (defun make-comint (name program &optional startfile &rest switches) |
| 728 | "Make a Comint process NAME in a buffer, running PROGRAM. |
| 729 | The name of the buffer is made by surrounding NAME with `*'s. |
| 730 | PROGRAM should be either a string denoting an executable program to create |
| 731 | via `start-file-process', or a cons pair of the form (HOST . SERVICE) denoting |
| 732 | a TCP connection to be opened via `open-network-stream'. If there is already |
| 733 | a running process in that buffer, it is not restarted. Optional third arg |
| 734 | STARTFILE is the name of a file, whose contents are sent to the |
| 735 | process as its initial input. |
| 736 | |
| 737 | If PROGRAM is a string, any more args are arguments to PROGRAM. |
| 738 | |
| 739 | Returns the (possibly newly created) process buffer." |
| 740 | (apply #'make-comint-in-buffer name nil program startfile switches)) |
| 741 | |
| 742 | ;;;###autoload |
| 743 | (defun comint-run (program) |
| 744 | "Run PROGRAM in a Comint buffer and switch to it. |
| 745 | The buffer name is made by surrounding the file name of PROGRAM with `*'s. |
| 746 | The file name is used to make a symbol name, such as `comint-sh-hook', and any |
| 747 | hooks on this symbol are run in the buffer. |
| 748 | See `make-comint' and `comint-exec'." |
| 749 | (declare (interactive-only make-comint)) |
| 750 | (interactive "sRun program: ") |
| 751 | (let ((name (file-name-nondirectory program))) |
| 752 | (switch-to-buffer (make-comint name program)) |
| 753 | (run-hooks (intern-soft (concat "comint-" name "-hook"))))) |
| 754 | |
| 755 | (defun comint-exec (buffer name command startfile switches) |
| 756 | "Start up a process named NAME in buffer BUFFER for Comint modes. |
| 757 | Runs the given COMMAND with SWITCHES, and initial input from STARTFILE. |
| 758 | |
| 759 | COMMAND should be one of the following: |
| 760 | - a string, denoting an executable program to create via |
| 761 | `start-file-process' |
| 762 | - a cons pair of the form (HOST . SERVICE), denoting a TCP |
| 763 | connection to be opened via `open-network-stream' |
| 764 | - nil, denoting a newly-allocated pty. |
| 765 | |
| 766 | This function blasts any old process running in the buffer, and |
| 767 | does not set the buffer mode. You can use this to cheaply run a |
| 768 | series of processes in the same Comint buffer. The hook |
| 769 | `comint-exec-hook' is run after each exec." |
| 770 | (with-current-buffer buffer |
| 771 | (let ((proc (get-buffer-process buffer))) ; Blast any old process. |
| 772 | (if proc (delete-process proc))) |
| 773 | ;; Crank up a new process |
| 774 | (let ((proc |
| 775 | (if (consp command) |
| 776 | (open-network-stream name buffer (car command) (cdr command)) |
| 777 | (comint-exec-1 name buffer command switches)))) |
| 778 | (set-process-filter proc 'comint-output-filter) |
| 779 | (setq-local comint-ptyp process-connection-type) ; t if pty, nil if pipe. |
| 780 | ;; Jump to the end, and set the process mark. |
| 781 | (goto-char (point-max)) |
| 782 | (set-marker (process-mark proc) (point)) |
| 783 | ;; Feed it the startfile. |
| 784 | (cond (startfile |
| 785 | ;;This is guaranteed to wait long enough |
| 786 | ;;but has bad results if the comint does not prompt at all |
| 787 | ;; (while (= size (buffer-size)) |
| 788 | ;; (sleep-for 1)) |
| 789 | ;;I hope 1 second is enough! |
| 790 | (sleep-for 1) |
| 791 | (goto-char (point-max)) |
| 792 | (insert-file-contents startfile) |
| 793 | (setq startfile (buffer-substring (point) (point-max))) |
| 794 | (delete-region (point) (point-max)) |
| 795 | (comint-send-string proc startfile))) |
| 796 | (run-hooks 'comint-exec-hook) |
| 797 | buffer))) |
| 798 | |
| 799 | ;; This auxiliary function cranks up the process for comint-exec in |
| 800 | ;; the appropriate environment. |
| 801 | |
| 802 | (defun comint-exec-1 (name buffer command switches) |
| 803 | (let ((process-environment |
| 804 | (nconc |
| 805 | ;; If using termcap, we specify `emacs' as the terminal type |
| 806 | ;; because that lets us specify a width. |
| 807 | ;; If using terminfo, we specify `dumb' because that is |
| 808 | ;; a defined terminal type. `emacs' is not a defined terminal type |
| 809 | ;; and there is no way for us to define it here. |
| 810 | ;; Some programs that use terminfo get very confused |
| 811 | ;; if TERM is not a valid terminal type. |
| 812 | ;; ;; There is similar code in compile.el. |
| 813 | (if (and (boundp 'system-uses-terminfo) system-uses-terminfo) |
| 814 | (list "TERM=dumb" "TERMCAP=" |
| 815 | (format "COLUMNS=%d" (window-width))) |
| 816 | (list "TERM=emacs" |
| 817 | (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width)))) |
| 818 | (unless (getenv "EMACS") |
| 819 | (list "EMACS=t")) |
| 820 | (list (format "INSIDE_EMACS=%s,comint" emacs-version)) |
| 821 | process-environment)) |
| 822 | (default-directory |
| 823 | (if (file-accessible-directory-p default-directory) |
| 824 | default-directory |
| 825 | "/")) |
| 826 | proc decoding encoding changed) |
| 827 | (let ((exec-path (if (and command (file-name-directory command)) |
| 828 | ;; If the command has slashes, make sure we |
| 829 | ;; first look relative to the current directory. |
| 830 | (cons default-directory exec-path) exec-path))) |
| 831 | (setq proc (apply 'start-file-process name buffer command switches))) |
| 832 | ;; Some file name handler cannot start a process, fe ange-ftp. |
| 833 | (unless (processp proc) (error "No process started")) |
| 834 | (let ((coding-systems (process-coding-system proc))) |
| 835 | (setq decoding (car coding-systems) |
| 836 | encoding (cdr coding-systems))) |
| 837 | ;; Even if start-file-process left the coding system for encoding data |
| 838 | ;; sent from the process undecided, we had better use the same one |
| 839 | ;; as what we use for decoding. But, we should suppress EOL |
| 840 | ;; conversion. |
| 841 | (if (and decoding (not encoding)) |
| 842 | (setq encoding (coding-system-change-eol-conversion decoding 'unix) |
| 843 | changed t)) |
| 844 | (if changed |
| 845 | (set-process-coding-system proc decoding encoding)) |
| 846 | proc)) |
| 847 | |
| 848 | (defun comint-insert-input (event) |
| 849 | "In a Comint buffer, set the current input to the previous input at point. |
| 850 | If there is no previous input at point, run the command specified |
| 851 | by the global keymap (usually `mouse-yank-at-click')." |
| 852 | (interactive "e") |
| 853 | ;; Don't set the mouse here, since it may otherwise change the behavior |
| 854 | ;; of the command on which we fallback if there's no field at point. |
| 855 | ;; (mouse-set-point event) |
| 856 | (let ((pos (posn-point (event-end event))) |
| 857 | field input) |
| 858 | (with-selected-window (posn-window (event-end event)) |
| 859 | ;; If pos is at the very end of a field, the mouse-click was |
| 860 | ;; probably outside (to the right) of the field. |
| 861 | (and (< pos (field-end pos)) |
| 862 | (< (field-end pos) (point-max)) |
| 863 | (progn (setq field (field-at-pos pos)) |
| 864 | (setq input (field-string-no-properties pos))))) |
| 865 | (if (or (null input) (null comint-accum-marker) field) |
| 866 | ;; Fall back to the global definition if (i) the selected |
| 867 | ;; buffer is not a comint buffer (which can happen if a |
| 868 | ;; non-comint window was selected and we clicked in a comint |
| 869 | ;; window), or (ii) there is no input at POS. |
| 870 | (let* ((keys (this-command-keys)) |
| 871 | (last-key (and (vectorp keys) (aref keys (1- (length keys))))) |
| 872 | (fun (and last-key (lookup-key global-map (vector last-key))))) |
| 873 | (and fun (not (eq fun 'comint-insert-input)) |
| 874 | (call-interactively fun))) |
| 875 | (with-selected-window (posn-window (event-end event)) |
| 876 | ;; Otherwise, insert the previous input. |
| 877 | (goto-char (point-max)) |
| 878 | ;; First delete any old unsent input at the end |
| 879 | (delete-region |
| 880 | (or (marker-position comint-accum-marker) |
| 881 | (process-mark (get-buffer-process (current-buffer)))) |
| 882 | (point)) |
| 883 | ;; Insert the input at point |
| 884 | (insert input))))) |
| 885 | \f |
| 886 | ;; Input history processing in a buffer |
| 887 | ;; =========================================================================== |
| 888 | ;; Useful input history functions, courtesy of the Ergo group. |
| 889 | |
| 890 | ;; Eleven commands: |
| 891 | ;; comint-dynamic-list-input-ring List history in help buffer. |
| 892 | ;; comint-previous-input Previous input... |
| 893 | ;; comint-previous-matching-input ...matching a string. |
| 894 | ;; comint-previous-matching-input-from-input ... matching the current input. |
| 895 | ;; comint-next-input Next input... |
| 896 | ;; comint-next-matching-input ...matching a string. |
| 897 | ;; comint-next-matching-input-from-input ... matching the current input. |
| 898 | ;; comint-backward-matching-input Backwards input... |
| 899 | ;; comint-forward-matching-input ...matching a string. |
| 900 | ;; comint-replace-by-expanded-history Expand history at point; |
| 901 | ;; replace with expanded history. |
| 902 | ;; comint-magic-space Expand history and insert space. |
| 903 | ;; |
| 904 | ;; Three functions: |
| 905 | ;; comint-read-input-ring Read into comint-input-ring... |
| 906 | ;; comint-write-input-ring Write to comint-input-ring-file-name. |
| 907 | ;; comint-replace-by-expanded-history-before-point Workhorse function. |
| 908 | |
| 909 | (defun comint-read-input-ring (&optional silent) |
| 910 | "Set the buffer's `comint-input-ring' from a history file. |
| 911 | The name of the file is given by the variable `comint-input-ring-file-name'. |
| 912 | The history ring is of size `comint-input-ring-size', regardless of file size. |
| 913 | If `comint-input-ring-file-name' is nil this function does nothing. |
| 914 | |
| 915 | If the optional argument SILENT is non-nil, we say nothing about a |
| 916 | failure to read the history file. |
| 917 | |
| 918 | This function is useful for major mode commands and mode hooks. |
| 919 | |
| 920 | The commands stored in the history file are separated by the |
| 921 | `comint-input-ring-separator', and entries that match |
| 922 | `comint-input-history-ignore' are ignored. The most recent command |
| 923 | comes last. |
| 924 | |
| 925 | See also `comint-input-ignoredups' and `comint-write-input-ring'." |
| 926 | (cond ((or (null comint-input-ring-file-name) |
| 927 | (equal comint-input-ring-file-name "")) |
| 928 | nil) |
| 929 | ((not (file-readable-p comint-input-ring-file-name)) |
| 930 | (or silent |
| 931 | (message "Cannot read history file %s" |
| 932 | comint-input-ring-file-name))) |
| 933 | (t |
| 934 | (let* ((file comint-input-ring-file-name) |
| 935 | (count 0) |
| 936 | ;; Some users set HISTSIZE or `comint-input-ring-size' |
| 937 | ;; to huge numbers. Don't allocate a huge ring right |
| 938 | ;; away; there might not be that much history. |
| 939 | (ring-size (min 1500 comint-input-ring-size)) |
| 940 | (ring (make-ring ring-size))) |
| 941 | (with-temp-buffer |
| 942 | (insert-file-contents file) |
| 943 | ;; Save restriction in case file is already visited... |
| 944 | ;; Watch for those date stamps in history files! |
| 945 | (goto-char (point-max)) |
| 946 | (let (start end history) |
| 947 | (while (and (< count comint-input-ring-size) |
| 948 | (re-search-backward comint-input-ring-separator |
| 949 | nil t) |
| 950 | (setq end (match-beginning 0))) |
| 951 | (setq start |
| 952 | (if (re-search-backward comint-input-ring-separator |
| 953 | nil t) |
| 954 | (match-end 0) |
| 955 | (point-min))) |
| 956 | (setq history (buffer-substring start end)) |
| 957 | (goto-char start) |
| 958 | (when (and (not (string-match comint-input-history-ignore |
| 959 | history)) |
| 960 | (or (null comint-input-ignoredups) |
| 961 | (ring-empty-p ring) |
| 962 | (not (string-equal (ring-ref ring 0) |
| 963 | history)))) |
| 964 | (when (= count ring-size) |
| 965 | (ring-extend ring (min (- comint-input-ring-size ring-size) |
| 966 | ring-size)) |
| 967 | (setq ring-size (ring-size ring))) |
| 968 | (ring-insert-at-beginning ring history) |
| 969 | (setq count (1+ count)))))) |
| 970 | (setq comint-input-ring ring |
| 971 | comint-input-ring-index nil))))) |
| 972 | |
| 973 | (defun comint-write-input-ring () |
| 974 | "Writes the buffer's `comint-input-ring' to a history file. |
| 975 | The name of the file is given by the variable `comint-input-ring-file-name'. |
| 976 | The original contents of the file are lost if `comint-input-ring' is not empty. |
| 977 | If `comint-input-ring-file-name' is nil this function does nothing. |
| 978 | |
| 979 | Useful within process sentinels. |
| 980 | |
| 981 | See also `comint-read-input-ring'." |
| 982 | (cond ((or (null comint-input-ring-file-name) |
| 983 | (equal comint-input-ring-file-name "") |
| 984 | (null comint-input-ring) (ring-empty-p comint-input-ring)) |
| 985 | nil) |
| 986 | ((not (file-writable-p comint-input-ring-file-name)) |
| 987 | (message "Cannot write history file %s" comint-input-ring-file-name)) |
| 988 | (t |
| 989 | (let* ((history-buf (get-buffer-create " *Temp Input History*")) |
| 990 | (ring comint-input-ring) |
| 991 | (file comint-input-ring-file-name) |
| 992 | (index (ring-length ring))) |
| 993 | ;; Write it all out into a buffer first. Much faster, but messier, |
| 994 | ;; than writing it one line at a time. |
| 995 | (with-current-buffer history-buf |
| 996 | (erase-buffer) |
| 997 | (while (> index 0) |
| 998 | (setq index (1- index)) |
| 999 | (insert (ring-ref ring index) comint-input-ring-separator)) |
| 1000 | (write-region (buffer-string) nil file nil 'no-message) |
| 1001 | (kill-buffer nil)))))) |
| 1002 | |
| 1003 | |
| 1004 | (defvar comint-dynamic-list-input-ring-window-conf) |
| 1005 | |
| 1006 | (defun comint-dynamic-list-input-ring-select () |
| 1007 | "Choose the input history entry that point is in or next to." |
| 1008 | (interactive) |
| 1009 | (let ((buffer completion-reference-buffer) |
| 1010 | beg end completion) |
| 1011 | (if (and (not (eobp)) (get-text-property (point) 'mouse-face)) |
| 1012 | (setq end (point) beg (1+ (point)))) |
| 1013 | (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face)) |
| 1014 | (setq end (1- (point)) beg (point))) |
| 1015 | (if (null beg) |
| 1016 | (error "No history entry here")) |
| 1017 | (setq beg (previous-single-property-change beg 'mouse-face)) |
| 1018 | (setq end (or (next-single-property-change end 'mouse-face) (point-max))) |
| 1019 | (setq completion (buffer-substring beg end)) |
| 1020 | (set-window-configuration comint-dynamic-list-input-ring-window-conf) |
| 1021 | (choose-completion-string completion buffer))) |
| 1022 | |
| 1023 | (defun comint-dynamic-list-input-ring () |
| 1024 | "Display a list of recent inputs entered into the current buffer." |
| 1025 | (interactive) |
| 1026 | (if (or (not (ring-p comint-input-ring)) |
| 1027 | (ring-empty-p comint-input-ring)) |
| 1028 | (message "No history") |
| 1029 | (let ((history nil) |
| 1030 | (history-buffer " *Input History*") |
| 1031 | (conf (current-window-configuration))) |
| 1032 | ;; We have to build up a list ourselves from the ring vector. |
| 1033 | (dotimes (index (ring-length comint-input-ring)) |
| 1034 | (push (ring-ref comint-input-ring index) history)) |
| 1035 | ;; Show them most-recent-first. |
| 1036 | (setq history (nreverse history)) |
| 1037 | ;; Change "completion" to "history reference" |
| 1038 | ;; to make the display accurate. |
| 1039 | (with-output-to-temp-buffer history-buffer |
| 1040 | (display-completion-list history) |
| 1041 | (set-buffer history-buffer) |
| 1042 | (let ((keymap (make-sparse-keymap))) |
| 1043 | (set-keymap-parent keymap (current-local-map)) |
| 1044 | (define-key keymap "\C-m" 'comint-dynamic-list-input-ring-select) |
| 1045 | (use-local-map keymap)) |
| 1046 | (forward-line 3) |
| 1047 | (while (search-backward "completion" nil 'move) |
| 1048 | (replace-match "history reference"))) |
| 1049 | (sit-for 0) |
| 1050 | (message "Hit space to flush") |
| 1051 | (setq comint-dynamic-list-input-ring-window-conf conf) |
| 1052 | (let ((ch (read-event))) |
| 1053 | (if (eq ch ?\s) |
| 1054 | (set-window-configuration conf) |
| 1055 | (setq unread-command-events (list ch))))))) |
| 1056 | |
| 1057 | |
| 1058 | (defun comint-regexp-arg (prompt) |
| 1059 | "Return list of regexp and prefix arg using PROMPT." |
| 1060 | (let* (;; Don't clobber this. |
| 1061 | (last-command last-command) |
| 1062 | (regexp (read-from-minibuffer prompt nil nil nil |
| 1063 | 'minibuffer-history-search-history))) |
| 1064 | ;; If the user didn't enter anything, nothing is added to m-h-s-h. |
| 1065 | ;; Use the previous search regexp, if there is one. |
| 1066 | (list (if (string-equal regexp "") |
| 1067 | (or (car minibuffer-history-search-history) |
| 1068 | regexp) |
| 1069 | regexp) |
| 1070 | (prefix-numeric-value current-prefix-arg)))) |
| 1071 | |
| 1072 | (defun comint-search-arg (arg) |
| 1073 | ;; First make sure there is a ring and that we are after the process mark |
| 1074 | (cond ((not (comint-after-pmark-p)) |
| 1075 | (user-error "Not at command line")) |
| 1076 | ((or (null comint-input-ring) |
| 1077 | (ring-empty-p comint-input-ring)) |
| 1078 | (user-error "Empty input ring")) |
| 1079 | ((zerop arg) |
| 1080 | ;; arg of zero resets search from beginning, and uses arg of 1 |
| 1081 | (setq comint-input-ring-index nil) |
| 1082 | 1) |
| 1083 | (t |
| 1084 | arg))) |
| 1085 | |
| 1086 | (defun comint-restore-input () |
| 1087 | "Restore unfinished input." |
| 1088 | (interactive) |
| 1089 | (when comint-input-ring-index |
| 1090 | (comint-delete-input) |
| 1091 | (when (> (length comint-stored-incomplete-input) 0) |
| 1092 | (insert comint-stored-incomplete-input) |
| 1093 | (message "Input restored")) |
| 1094 | (setq comint-input-ring-index nil))) |
| 1095 | |
| 1096 | (defun comint-search-start (arg) |
| 1097 | "Index to start a directional search, starting at `comint-input-ring-index'." |
| 1098 | (if comint-input-ring-index |
| 1099 | ;; If a search is running, offset by 1 in direction of arg |
| 1100 | (mod (+ comint-input-ring-index (if (> arg 0) 1 -1)) |
| 1101 | (ring-length comint-input-ring)) |
| 1102 | ;; For a new search, start from beginning or end, as appropriate |
| 1103 | (if (>= arg 0) |
| 1104 | 0 ; First elt for forward search |
| 1105 | (1- (ring-length comint-input-ring))))) ; Last elt for backward search |
| 1106 | |
| 1107 | (defun comint-previous-input-string (arg) |
| 1108 | "Return the string ARG places along the input ring. |
| 1109 | Moves relative to `comint-input-ring-index'." |
| 1110 | (ring-ref comint-input-ring (if comint-input-ring-index |
| 1111 | (mod (+ arg comint-input-ring-index) |
| 1112 | (ring-length comint-input-ring)) |
| 1113 | arg))) |
| 1114 | |
| 1115 | (defun comint-previous-input (arg) |
| 1116 | "Cycle backwards through input history, saving input." |
| 1117 | (interactive "*p") |
| 1118 | (if (and comint-input-ring-index |
| 1119 | (or ;; leaving the "end" of the ring |
| 1120 | (and (< arg 0) ; going down |
| 1121 | (eq comint-input-ring-index 0)) |
| 1122 | (and (> arg 0) ; going up |
| 1123 | (eq comint-input-ring-index |
| 1124 | (1- (ring-length comint-input-ring))))) |
| 1125 | comint-stored-incomplete-input) |
| 1126 | (comint-restore-input) |
| 1127 | (comint-previous-matching-input "." arg))) |
| 1128 | |
| 1129 | (defun comint-next-input (arg) |
| 1130 | "Cycle forwards through input history." |
| 1131 | (interactive "*p") |
| 1132 | (comint-previous-input (- arg))) |
| 1133 | |
| 1134 | (defun comint-previous-matching-input-string (regexp arg) |
| 1135 | "Return the string matching REGEXP ARG places along the input ring. |
| 1136 | Moves relative to `comint-input-ring-index'." |
| 1137 | (let* ((pos (comint-previous-matching-input-string-position regexp arg))) |
| 1138 | (if pos (ring-ref comint-input-ring pos)))) |
| 1139 | |
| 1140 | (defun comint-previous-matching-input-string-position (regexp arg &optional start) |
| 1141 | "Return the index matching REGEXP ARG places along the input ring. |
| 1142 | Moves relative to START, or `comint-input-ring-index'." |
| 1143 | (if (or (not (ring-p comint-input-ring)) |
| 1144 | (ring-empty-p comint-input-ring)) |
| 1145 | (user-error "No history")) |
| 1146 | (let* ((len (ring-length comint-input-ring)) |
| 1147 | (motion (if (> arg 0) 1 -1)) |
| 1148 | (n (mod (- (or start (comint-search-start arg)) motion) len)) |
| 1149 | (tried-each-ring-item nil) |
| 1150 | (prev nil)) |
| 1151 | ;; Do the whole search as many times as the argument says. |
| 1152 | (while (and (/= arg 0) (not tried-each-ring-item)) |
| 1153 | ;; Step once. |
| 1154 | (setq prev n |
| 1155 | n (mod (+ n motion) len)) |
| 1156 | ;; If we haven't reached a match, step some more. |
| 1157 | (while (and (< n len) (not tried-each-ring-item) |
| 1158 | (not (string-match regexp (ring-ref comint-input-ring n)))) |
| 1159 | (setq n (mod (+ n motion) len) |
| 1160 | ;; If we have gone all the way around in this search. |
| 1161 | tried-each-ring-item (= n prev))) |
| 1162 | (setq arg (if (> arg 0) (1- arg) (1+ arg)))) |
| 1163 | ;; Now that we know which ring element to use, if we found it, return that. |
| 1164 | (if (string-match regexp (ring-ref comint-input-ring n)) |
| 1165 | n))) |
| 1166 | |
| 1167 | (defun comint-delete-input () |
| 1168 | "Delete all input between accumulation or process mark and point." |
| 1169 | (delete-region |
| 1170 | ;; Can't use kill-region as it sets this-command |
| 1171 | (or (marker-position comint-accum-marker) |
| 1172 | (process-mark (get-buffer-process (current-buffer)))) |
| 1173 | (point-max))) |
| 1174 | |
| 1175 | (defun comint-previous-matching-input (regexp n) |
| 1176 | "Search backwards through input history for match for REGEXP. |
| 1177 | \(Previous history elements are earlier commands.) |
| 1178 | With prefix argument N, search for Nth previous match. |
| 1179 | If N is negative, find the next or Nth next match." |
| 1180 | (interactive (comint-regexp-arg "Previous input matching (regexp): ")) |
| 1181 | (setq n (comint-search-arg n)) |
| 1182 | (let ((pos (comint-previous-matching-input-string-position regexp n))) |
| 1183 | ;; Has a match been found? |
| 1184 | (if (null pos) |
| 1185 | (user-error "Not found") |
| 1186 | ;; If leaving the edit line, save partial input |
| 1187 | (if (null comint-input-ring-index) ;not yet on ring |
| 1188 | (setq comint-stored-incomplete-input |
| 1189 | (funcall comint-get-old-input))) |
| 1190 | (setq comint-input-ring-index pos) |
| 1191 | (unless isearch-mode |
| 1192 | (let ((message-log-max nil)) ; Do not write to *Messages*. |
| 1193 | (message "History item: %d" (1+ pos)))) |
| 1194 | (comint-delete-input) |
| 1195 | (insert (ring-ref comint-input-ring pos))))) |
| 1196 | |
| 1197 | (defun comint-next-matching-input (regexp n) |
| 1198 | "Search forwards through input history for match for REGEXP. |
| 1199 | \(Later history elements are more recent commands.) |
| 1200 | With prefix argument N, search for Nth following match. |
| 1201 | If N is negative, find the previous or Nth previous match." |
| 1202 | (interactive (comint-regexp-arg "Next input matching (regexp): ")) |
| 1203 | (comint-previous-matching-input regexp (- n))) |
| 1204 | |
| 1205 | (defun comint-previous-matching-input-from-input (n) |
| 1206 | "Search backwards through input history for match for current input. |
| 1207 | \(Previous history elements are earlier commands.) |
| 1208 | With prefix argument N, search for Nth previous match. |
| 1209 | If N is negative, search forwards for the -Nth following match." |
| 1210 | (interactive "p") |
| 1211 | (let ((opoint (point))) |
| 1212 | (unless (memq last-command '(comint-previous-matching-input-from-input |
| 1213 | comint-next-matching-input-from-input)) |
| 1214 | ;; Starting a new search |
| 1215 | (setq comint-matching-input-from-input-string |
| 1216 | (buffer-substring |
| 1217 | (or (marker-position comint-accum-marker) |
| 1218 | (process-mark (get-buffer-process (current-buffer)))) |
| 1219 | (point)) |
| 1220 | comint-input-ring-index nil)) |
| 1221 | (comint-previous-matching-input |
| 1222 | (concat "^" (regexp-quote comint-matching-input-from-input-string)) |
| 1223 | n) |
| 1224 | (goto-char opoint))) |
| 1225 | |
| 1226 | (defun comint-next-matching-input-from-input (n) |
| 1227 | "Search forwards through input history for match for current input. |
| 1228 | \(Following history elements are more recent commands.) |
| 1229 | With prefix argument N, search for Nth following match. |
| 1230 | If N is negative, search backwards for the -Nth previous match." |
| 1231 | (interactive "p") |
| 1232 | (comint-previous-matching-input-from-input (- n))) |
| 1233 | |
| 1234 | |
| 1235 | (defun comint-replace-by-expanded-history (&optional silent start) |
| 1236 | "Expand input command history references before point. |
| 1237 | Expansion is dependent on the value of `comint-input-autoexpand'. |
| 1238 | |
| 1239 | This function depends on the buffer's idea of the input history, which may not |
| 1240 | match the command interpreter's idea, assuming it has one. |
| 1241 | |
| 1242 | Assumes history syntax is like typical Un*x shells'. However, since Emacs |
| 1243 | cannot know the interpreter's idea of input line numbers, assuming it has one, |
| 1244 | it cannot expand absolute input line number references. |
| 1245 | |
| 1246 | If the optional argument SILENT is non-nil, never complain |
| 1247 | even if history reference seems erroneous. |
| 1248 | |
| 1249 | If the optional argument START is non-nil, that specifies the |
| 1250 | start of the text to scan for history references, rather |
| 1251 | than the logical beginning of line. |
| 1252 | |
| 1253 | See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'. |
| 1254 | |
| 1255 | Returns t if successful." |
| 1256 | (interactive) |
| 1257 | (let ((f (comint-c-a-p-replace-by-expanded-history silent start))) |
| 1258 | (if f (funcall f)))) |
| 1259 | |
| 1260 | (defun comint-c-a-p-replace-by-expanded-history (&optional silent start) |
| 1261 | "Expand input command history at point. |
| 1262 | For use on `completion-at-point-functions'." |
| 1263 | (if (and comint-input-autoexpand |
| 1264 | (if comint-use-prompt-regexp |
| 1265 | ;; Use comint-prompt-regexp |
| 1266 | (save-excursion |
| 1267 | (beginning-of-line) |
| 1268 | (looking-at (concat comint-prompt-regexp "!\\|\\^"))) |
| 1269 | ;; Use input fields. User input that hasn't been entered |
| 1270 | ;; yet, at the end of the buffer, has a nil `field' property. |
| 1271 | (and (null (get-char-property (point) 'field)) |
| 1272 | (string-match "!\\|^\\^" (field-string)))) |
| 1273 | (catch 'dry-run |
| 1274 | (comint-replace-by-expanded-history-before-point |
| 1275 | silent start 'dry-run))) |
| 1276 | (lambda () |
| 1277 | ;; Looks like there might be history references in the command. |
| 1278 | (let ((previous-modified-tick (buffer-modified-tick))) |
| 1279 | (comint-replace-by-expanded-history-before-point silent start) |
| 1280 | (/= previous-modified-tick (buffer-modified-tick)))))) |
| 1281 | |
| 1282 | |
| 1283 | (defun comint-replace-by-expanded-history-before-point |
| 1284 | (silent &optional start dry-run) |
| 1285 | "Expand directory stack reference before point. |
| 1286 | See `comint-replace-by-expanded-history'. Returns t if successful. |
| 1287 | |
| 1288 | If the optional argument START is non-nil, that specifies the |
| 1289 | start of the text to scan for history references, rather |
| 1290 | than the logical beginning of line. |
| 1291 | |
| 1292 | If DRY-RUN is non-nil, throw to DRY-RUN before performing any |
| 1293 | actual side-effect." |
| 1294 | (save-excursion |
| 1295 | (let ((toend (- (line-end-position) (point))) |
| 1296 | (start (or start (comint-line-beginning-position)))) |
| 1297 | (goto-char start) |
| 1298 | (while (progn |
| 1299 | (skip-chars-forward "^!^" (- (line-end-position) toend)) |
| 1300 | (< (point) (- (line-end-position) toend))) |
| 1301 | ;; This seems a bit complex. We look for references such as !!, !-num, |
| 1302 | ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^. |
| 1303 | ;; If that wasn't enough, the plings can be suffixed with argument |
| 1304 | ;; range specifiers. |
| 1305 | ;; Argument ranges are complex too, so we hive off the input line, |
| 1306 | ;; referenced with plings, with the range string to `comint-args'. |
| 1307 | (setq comint-input-ring-index nil) |
| 1308 | (cond ((or (= (preceding-char) ?\\) |
| 1309 | (comint-within-quotes start (point))) |
| 1310 | ;; The history is quoted, or we're in quotes. |
| 1311 | (goto-char (1+ (point)))) |
| 1312 | ((looking-at "![0-9]+\\($\\|[^-]\\)") |
| 1313 | ;; We cannot know the interpreter's idea of input line numbers. |
| 1314 | (if dry-run (throw dry-run 'message)) |
| 1315 | (goto-char (match-end 0)) |
| 1316 | (message "Absolute reference cannot be expanded")) |
| 1317 | ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?") |
| 1318 | ;; Just a number of args from `number' lines backward. |
| 1319 | (if dry-run (throw dry-run 'history)) |
| 1320 | (let ((number (1- (string-to-number |
| 1321 | (buffer-substring (match-beginning 1) |
| 1322 | (match-end 1)))))) |
| 1323 | (if (<= number (ring-length comint-input-ring)) |
| 1324 | (progn |
| 1325 | (replace-match |
| 1326 | (comint-args (comint-previous-input-string number) |
| 1327 | (match-beginning 2) (match-end 2)) |
| 1328 | t t) |
| 1329 | (setq comint-input-ring-index number) |
| 1330 | (message "History item: %d" (1+ number))) |
| 1331 | (goto-char (match-end 0)) |
| 1332 | (message "Relative reference exceeds input history size")))) |
| 1333 | ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!")) |
| 1334 | ;; Just a number of args from the previous input line. |
| 1335 | (if dry-run (throw dry-run 'expand)) |
| 1336 | (replace-match (comint-args (comint-previous-input-string 0) |
| 1337 | (match-beginning 1) (match-end 1)) |
| 1338 | t t) |
| 1339 | (message "History item: previous")) |
| 1340 | ((looking-at |
| 1341 | "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?") |
| 1342 | ;; Most recent input starting with or containing (possibly |
| 1343 | ;; protected) string, maybe just a number of args. Phew. |
| 1344 | (if dry-run (throw dry-run 'expand)) |
| 1345 | (let* ((mb1 (match-beginning 1)) (me1 (match-end 1)) |
| 1346 | (mb2 (match-beginning 2)) (me2 (match-end 2)) |
| 1347 | (exp (buffer-substring (or mb2 mb1) (or me2 me1))) |
| 1348 | (pref (if (save-match-data (looking-at "!\\?")) "" "^")) |
| 1349 | (pos (save-match-data |
| 1350 | (comint-previous-matching-input-string-position |
| 1351 | (concat pref (regexp-quote exp)) 1)))) |
| 1352 | (if (null pos) |
| 1353 | (progn |
| 1354 | (goto-char (match-end 0)) |
| 1355 | (or silent |
| 1356 | (progn (message "Not found") |
| 1357 | (ding)))) |
| 1358 | (setq comint-input-ring-index pos) |
| 1359 | (replace-match |
| 1360 | (comint-args (ring-ref comint-input-ring pos) |
| 1361 | (match-beginning 4) (match-end 4)) |
| 1362 | t t) |
| 1363 | (message "History item: %d" (1+ pos))))) |
| 1364 | ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?") |
| 1365 | ;; Quick substitution on the previous input line. |
| 1366 | (if dry-run (throw dry-run 'expand)) |
| 1367 | (let ((old (buffer-substring (match-beginning 1) (match-end 1))) |
| 1368 | (new (buffer-substring (match-beginning 2) (match-end 2))) |
| 1369 | (pos nil)) |
| 1370 | (replace-match (comint-previous-input-string 0) t t) |
| 1371 | (setq pos (point)) |
| 1372 | (goto-char (match-beginning 0)) |
| 1373 | (if (not (search-forward old pos t)) |
| 1374 | (or silent |
| 1375 | (user-error "Not found")) |
| 1376 | (replace-match new t t) |
| 1377 | (message "History item: substituted")))) |
| 1378 | (t |
| 1379 | (forward-char 1))))) |
| 1380 | nil)) |
| 1381 | |
| 1382 | |
| 1383 | (defun comint-magic-space (arg) |
| 1384 | "Expand input history references before point and insert ARG spaces. |
| 1385 | A useful command to bind to SPC. See `comint-replace-by-expanded-history'." |
| 1386 | (interactive "p") |
| 1387 | (comint-replace-by-expanded-history) |
| 1388 | (self-insert-command arg)) |
| 1389 | \f |
| 1390 | ;; Isearch in comint input history |
| 1391 | |
| 1392 | (defcustom comint-history-isearch nil |
| 1393 | "Non-nil to Isearch in input history only, not in comint buffer output. |
| 1394 | If t, usual Isearch keys like `C-r' and `C-M-r' in comint mode search |
| 1395 | in the input history. |
| 1396 | If `dwim', Isearch keys search in the input history only when initial |
| 1397 | point position is at the comint command line. When starting Isearch |
| 1398 | from other parts of the comint buffer, they search in the comint buffer. |
| 1399 | If nil, Isearch operates on the whole comint buffer." |
| 1400 | :type '(choice (const :tag "Don't search in input history" nil) |
| 1401 | (const :tag "When point is on command line initially, search history" dwim) |
| 1402 | (const :tag "Always search in input history" t)) |
| 1403 | :group 'comint |
| 1404 | :version "23.2") |
| 1405 | |
| 1406 | (defun comint-history-isearch-backward () |
| 1407 | "Search for a string backward in input history using Isearch." |
| 1408 | (interactive) |
| 1409 | (let ((comint-history-isearch t)) |
| 1410 | (isearch-backward nil t))) |
| 1411 | |
| 1412 | (defun comint-history-isearch-backward-regexp () |
| 1413 | "Search for a regular expression backward in input history using Isearch." |
| 1414 | (interactive) |
| 1415 | (let ((comint-history-isearch t)) |
| 1416 | (isearch-backward-regexp nil t))) |
| 1417 | |
| 1418 | (defvar-local comint-history-isearch-message-overlay nil) |
| 1419 | |
| 1420 | (defun comint-history-isearch-setup () |
| 1421 | "Set up a comint for using Isearch to search the input history. |
| 1422 | Intended to be added to `isearch-mode-hook' in `comint-mode'." |
| 1423 | (when (or (eq comint-history-isearch t) |
| 1424 | (and (eq comint-history-isearch 'dwim) |
| 1425 | ;; Point is at command line. |
| 1426 | (comint-after-pmark-p))) |
| 1427 | (setq isearch-message-prefix-add "history ") |
| 1428 | (setq-local isearch-search-fun-function |
| 1429 | #'comint-history-isearch-search) |
| 1430 | (setq-local isearch-message-function |
| 1431 | #'comint-history-isearch-message) |
| 1432 | (setq-local isearch-wrap-function |
| 1433 | #'comint-history-isearch-wrap) |
| 1434 | (setq-local isearch-push-state-function |
| 1435 | #'comint-history-isearch-push-state) |
| 1436 | (add-hook 'isearch-mode-end-hook 'comint-history-isearch-end nil t))) |
| 1437 | |
| 1438 | (defun comint-history-isearch-end () |
| 1439 | "Clean up the comint after terminating Isearch in comint." |
| 1440 | (if comint-history-isearch-message-overlay |
| 1441 | (delete-overlay comint-history-isearch-message-overlay)) |
| 1442 | (setq isearch-message-prefix-add nil) |
| 1443 | (setq isearch-search-fun-function 'isearch-search-fun-default) |
| 1444 | (setq isearch-message-function nil) |
| 1445 | (setq isearch-wrap-function nil) |
| 1446 | (setq isearch-push-state-function nil) |
| 1447 | (remove-hook 'isearch-mode-end-hook 'comint-history-isearch-end t)) |
| 1448 | |
| 1449 | (defun comint-goto-input (pos) |
| 1450 | "Put input history item of the absolute history position POS." |
| 1451 | ;; If leaving the edit line, save partial unfinished input. |
| 1452 | (if (null comint-input-ring-index) |
| 1453 | (setq comint-stored-incomplete-input |
| 1454 | (funcall comint-get-old-input))) |
| 1455 | (setq comint-input-ring-index pos) |
| 1456 | (comint-delete-input) |
| 1457 | (if (and pos (not (ring-empty-p comint-input-ring))) |
| 1458 | (insert (ring-ref comint-input-ring pos)) |
| 1459 | ;; Restore partial unfinished input. |
| 1460 | (when (> (length comint-stored-incomplete-input) 0) |
| 1461 | (insert comint-stored-incomplete-input)))) |
| 1462 | |
| 1463 | (defun comint-history-isearch-search () |
| 1464 | "Return the proper search function, for Isearch in input history." |
| 1465 | (lambda (string bound noerror) |
| 1466 | (let ((search-fun |
| 1467 | ;; Use standard functions to search within comint text |
| 1468 | (isearch-search-fun-default)) |
| 1469 | found) |
| 1470 | ;; Avoid lazy-highlighting matches in the comint prompt and in the |
| 1471 | ;; output when searching forward. Lazy-highlight calls this lambda |
| 1472 | ;; with the bound arg, so skip the prompt and the output. |
| 1473 | (if (and bound isearch-forward (not (comint-after-pmark-p))) |
| 1474 | (goto-char (process-mark (get-buffer-process (current-buffer))))) |
| 1475 | (or |
| 1476 | ;; 1. First try searching in the initial comint text |
| 1477 | (funcall search-fun string |
| 1478 | (if isearch-forward bound (comint-line-beginning-position)) |
| 1479 | noerror) |
| 1480 | ;; 2. If the above search fails, start putting next/prev history |
| 1481 | ;; elements in the comint successively, and search the string |
| 1482 | ;; in them. Do this only when bound is nil (i.e. not while |
| 1483 | ;; lazy-highlighting search strings in the current comint text). |
| 1484 | (unless bound |
| 1485 | (condition-case nil |
| 1486 | (progn |
| 1487 | (while (not found) |
| 1488 | (cond (isearch-forward |
| 1489 | ;; Signal an error here explicitly, because |
| 1490 | ;; `comint-next-input' doesn't signal an error. |
| 1491 | (when (null comint-input-ring-index) |
| 1492 | (error "End of history; no next item")) |
| 1493 | (comint-next-input 1) |
| 1494 | (goto-char (comint-line-beginning-position))) |
| 1495 | (t |
| 1496 | ;; Signal an error here explicitly, because |
| 1497 | ;; `comint-previous-input' doesn't signal an error. |
| 1498 | (when (eq comint-input-ring-index |
| 1499 | (1- (ring-length comint-input-ring))) |
| 1500 | (error "Beginning of history; no preceding item")) |
| 1501 | (comint-previous-input 1) |
| 1502 | (goto-char (point-max)))) |
| 1503 | (setq isearch-barrier (point) isearch-opoint (point)) |
| 1504 | ;; After putting the next/prev history element, search |
| 1505 | ;; the string in them again, until comint-next-input |
| 1506 | ;; or comint-previous-input raises an error at the |
| 1507 | ;; beginning/end of history. |
| 1508 | (setq found (funcall search-fun string |
| 1509 | (unless isearch-forward |
| 1510 | ;; For backward search, don't search |
| 1511 | ;; in the comint prompt |
| 1512 | (comint-line-beginning-position)) |
| 1513 | noerror))) |
| 1514 | ;; Return point of the new search result |
| 1515 | (point)) |
| 1516 | ;; Return nil on the error "no next/preceding item" |
| 1517 | (error nil))))))) |
| 1518 | |
| 1519 | (defun comint-history-isearch-message (&optional c-q-hack ellipsis) |
| 1520 | "Display the input history search prompt. |
| 1521 | If there are no search errors, this function displays an overlay with |
| 1522 | the Isearch prompt which replaces the original comint prompt. |
| 1523 | Otherwise, it displays the standard Isearch message returned from |
| 1524 | the function `isearch-message'." |
| 1525 | (if (not (and isearch-success (not isearch-error))) |
| 1526 | ;; Use standard function `isearch-message' when not in comint prompt, |
| 1527 | ;; or search fails, or has an error (like incomplete regexp). |
| 1528 | ;; This function displays isearch message in the echo area, |
| 1529 | ;; so it's possible to see what is wrong in the search string. |
| 1530 | (isearch-message c-q-hack ellipsis) |
| 1531 | ;; Otherwise, put the overlay with the standard isearch prompt over |
| 1532 | ;; the initial comint prompt. |
| 1533 | (if (overlayp comint-history-isearch-message-overlay) |
| 1534 | (move-overlay comint-history-isearch-message-overlay |
| 1535 | (save-excursion (forward-line 0) (point)) |
| 1536 | (comint-line-beginning-position)) |
| 1537 | (setq comint-history-isearch-message-overlay |
| 1538 | (make-overlay (save-excursion (forward-line 0) (point)) |
| 1539 | (comint-line-beginning-position))) |
| 1540 | (overlay-put comint-history-isearch-message-overlay 'evaporate t)) |
| 1541 | (overlay-put comint-history-isearch-message-overlay |
| 1542 | 'display (isearch-message-prefix c-q-hack ellipsis)) |
| 1543 | (if (and comint-input-ring-index (not ellipsis)) |
| 1544 | ;; Display the current history index. |
| 1545 | (message "History item: %d" (1+ comint-input-ring-index)) |
| 1546 | ;; Or clear a previous isearch message. |
| 1547 | (message "")))) |
| 1548 | |
| 1549 | (defun comint-history-isearch-wrap () |
| 1550 | "Wrap the input history search when search fails. |
| 1551 | Move point to the first history element for a forward search, |
| 1552 | or to the last history element for a backward search." |
| 1553 | ;; When `comint-history-isearch-search' fails on reaching the |
| 1554 | ;; beginning/end of the history, wrap the search to the first/last |
| 1555 | ;; input history element. |
| 1556 | (if isearch-forward |
| 1557 | (comint-goto-input (1- (ring-length comint-input-ring))) |
| 1558 | (comint-goto-input nil)) |
| 1559 | (setq isearch-success t) |
| 1560 | (goto-char (if isearch-forward (comint-line-beginning-position) (point-max)))) |
| 1561 | |
| 1562 | (defun comint-history-isearch-push-state () |
| 1563 | "Save a function restoring the state of input history search. |
| 1564 | Save `comint-input-ring-index' to the additional state parameter |
| 1565 | in the search status stack." |
| 1566 | (let ((index comint-input-ring-index)) |
| 1567 | (lambda (cmd) |
| 1568 | (comint-history-isearch-pop-state cmd index)))) |
| 1569 | |
| 1570 | (defun comint-history-isearch-pop-state (_cmd hist-pos) |
| 1571 | "Restore the input history search state. |
| 1572 | Go to the history element by the absolute history position HIST-POS." |
| 1573 | (comint-goto-input hist-pos)) |
| 1574 | |
| 1575 | \f |
| 1576 | (defun comint-within-quotes (beg end) |
| 1577 | "Return t if the number of quotes between BEG and END is odd. |
| 1578 | Quotes are single and double." |
| 1579 | (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end)) |
| 1580 | (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end))) |
| 1581 | (or (= (mod countsq 2) 1) (= (mod countdq 2) 1)))) |
| 1582 | |
| 1583 | (defun comint-how-many-region (regexp beg end) |
| 1584 | "Return number of matches for REGEXP from BEG to END." |
| 1585 | (let ((count 0)) |
| 1586 | (save-excursion |
| 1587 | (save-match-data |
| 1588 | (goto-char beg) |
| 1589 | (while (re-search-forward regexp end t) |
| 1590 | (setq count (1+ count))))) |
| 1591 | count)) |
| 1592 | |
| 1593 | (defun comint-args (string begin end) |
| 1594 | ;; From STRING, return the args depending on the range specified in the text |
| 1595 | ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'. |
| 1596 | ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $. |
| 1597 | (save-match-data |
| 1598 | (if (null begin) |
| 1599 | (comint-arguments string 0 nil) |
| 1600 | (let* ((range (buffer-substring |
| 1601 | (if (eq (char-after begin) ?:) (1+ begin) begin) end)) |
| 1602 | (nth (cond ((string-match "^[*^]" range) 1) |
| 1603 | ((string-match "^-" range) 0) |
| 1604 | ((string-equal range "$") nil) |
| 1605 | (t (string-to-number range)))) |
| 1606 | (mth (cond ((string-match "[-*$]$" range) nil) |
| 1607 | ((string-match "-" range) |
| 1608 | (string-to-number (substring range (match-end 0)))) |
| 1609 | (t nth)))) |
| 1610 | (comint-arguments string nth mth))))) |
| 1611 | |
| 1612 | (defun comint-delim-arg (arg) |
| 1613 | "Return a list of arguments from ARG. |
| 1614 | Break it up at the delimiters in `comint-delimiter-argument-list'. |
| 1615 | Returned list is backwards. |
| 1616 | |
| 1617 | Characters with non-nil values of the text property `literal' are |
| 1618 | assumed to have literal values (e.g., backslash-escaped |
| 1619 | characters), and are not considered to be delimiters." |
| 1620 | (if (null comint-delimiter-argument-list) |
| 1621 | (list arg) |
| 1622 | (let ((args nil) |
| 1623 | (pos 0) |
| 1624 | (len (length arg))) |
| 1625 | (while (< pos len) |
| 1626 | (let ((char (aref arg pos)) |
| 1627 | (start pos)) |
| 1628 | (if (and (memq char comint-delimiter-argument-list) |
| 1629 | ;; Ignore backslash-escaped characters. |
| 1630 | (not (get-text-property pos 'literal arg))) |
| 1631 | (while (and (< pos len) (eq (aref arg pos) char)) |
| 1632 | (setq pos (1+ pos))) |
| 1633 | (while (and (< pos len) |
| 1634 | (not (and (memq (aref arg pos) |
| 1635 | comint-delimiter-argument-list) |
| 1636 | (not (get-text-property |
| 1637 | pos 'literal arg))))) |
| 1638 | (setq pos (1+ pos)))) |
| 1639 | (setq args (cons (substring arg start pos) args)))) |
| 1640 | args))) |
| 1641 | |
| 1642 | (defun comint-arguments (string nth mth) |
| 1643 | "Return from STRING the NTH to MTH arguments. |
| 1644 | NTH and/or MTH can be nil, which means the last argument. |
| 1645 | Returned arguments are separated by single spaces. |
| 1646 | We assume whitespace separates arguments, except within quotes |
| 1647 | and except for a space or tab that immediately follows a backslash. |
| 1648 | Also, a run of one or more of a single character |
| 1649 | in `comint-delimiter-argument-list' is a separate argument. |
| 1650 | Argument 0 is the command name." |
| 1651 | ;; The first line handles ordinary characters and backslash-sequences |
| 1652 | ;; (except with w32 msdos-like shells, where backslashes are valid). |
| 1653 | ;; The second matches "-quoted strings. |
| 1654 | ;; The third matches '-quoted strings. |
| 1655 | ;; The fourth matches `-quoted strings. |
| 1656 | ;; This seems to fit the syntax of BASH 2.0. |
| 1657 | (let* ((backslash-escape (not (and (fboundp 'w32-shell-dos-semantics) |
| 1658 | (w32-shell-dos-semantics)))) |
| 1659 | (first (if backslash-escape |
| 1660 | "[^ \n\t\"'`\\]\\|\\(\\\\.\\)\\|" |
| 1661 | "[^ \n\t\"'`]+\\|")) |
| 1662 | (argpart (concat first |
| 1663 | "\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\ |
| 1664 | '[^']*'\\|\ |
| 1665 | `[^`]*`\\)")) |
| 1666 | (quote-subexpr (if backslash-escape 2 1)) |
| 1667 | (args ()) (pos 0) |
| 1668 | (count 0) |
| 1669 | beg str quotes) |
| 1670 | ;; Build a list of all the args until we have as many as we want. |
| 1671 | (while (and (or (null mth) (<= count mth)) |
| 1672 | (string-match argpart string pos)) |
| 1673 | ;; Apply the `literal' text property to backslash-escaped |
| 1674 | ;; characters, so that `comint-delim-arg' won't break them up. |
| 1675 | (and backslash-escape |
| 1676 | (match-beginning 1) |
| 1677 | (put-text-property (match-beginning 1) (match-end 1) |
| 1678 | 'literal t string)) |
| 1679 | (if (and beg (= pos (match-beginning 0))) |
| 1680 | ;; It's contiguous, part of the same arg. |
| 1681 | (setq pos (match-end 0) |
| 1682 | quotes (or quotes (match-beginning quote-subexpr))) |
| 1683 | ;; It's a new separate arg. |
| 1684 | (if beg |
| 1685 | ;; Put the previous arg, if there was one, onto ARGS. |
| 1686 | (setq str (substring string beg pos) |
| 1687 | args (if quotes (cons str args) |
| 1688 | (nconc (comint-delim-arg str) args)))) |
| 1689 | (setq count (length args)) |
| 1690 | (setq quotes (match-beginning quote-subexpr)) |
| 1691 | (setq beg (match-beginning 0)) |
| 1692 | (setq pos (match-end 0)))) |
| 1693 | (if beg |
| 1694 | (setq str (substring string beg pos) |
| 1695 | args (if quotes (cons str args) |
| 1696 | (nconc (comint-delim-arg str) args)))) |
| 1697 | (setq count (length args)) |
| 1698 | (let ((n (or nth (1- count))) |
| 1699 | (m (if mth (1- (- count mth)) 0))) |
| 1700 | (mapconcat |
| 1701 | (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " ")))) |
| 1702 | \f |
| 1703 | ;; |
| 1704 | ;; Input processing stuff |
| 1705 | ;; |
| 1706 | (defun comint-add-to-input-history (cmd) |
| 1707 | "Add CMD to the input history. |
| 1708 | Ignore duplicates if `comint-input-ignoredups' is non-nil." |
| 1709 | (when (and (funcall comint-input-filter cmd) |
| 1710 | (or (null comint-input-ignoredups) |
| 1711 | (not (ring-p comint-input-ring)) |
| 1712 | (ring-empty-p comint-input-ring) |
| 1713 | (not (string-equal (ring-ref comint-input-ring 0) cmd)))) |
| 1714 | ;; If `comint-input-ring' is full, maybe grow it. |
| 1715 | (let ((size (ring-size comint-input-ring))) |
| 1716 | (and (= size (ring-length comint-input-ring)) |
| 1717 | (< size comint-input-ring-size) |
| 1718 | (ring-extend comint-input-ring |
| 1719 | (min size (- comint-input-ring-size size))))) |
| 1720 | (ring-insert comint-input-ring cmd))) |
| 1721 | |
| 1722 | (defun comint-send-input (&optional no-newline artificial) |
| 1723 | "Send input to process. |
| 1724 | After the process output mark, sends all text from the process mark to |
| 1725 | point as input to the process. Before the process output mark, calls |
| 1726 | value of variable `comint-get-old-input' to retrieve old input, copies |
| 1727 | it to the process mark, and sends it. |
| 1728 | |
| 1729 | This command also sends and inserts a final newline, unless |
| 1730 | NO-NEWLINE is non-nil. |
| 1731 | |
| 1732 | Any history reference may be expanded depending on the value of the variable |
| 1733 | `comint-input-autoexpand'. The list of function names contained in the value |
| 1734 | of `comint-input-filter-functions' is called on the input before sending it. |
| 1735 | The input is entered into the input history ring, if the value of variable |
| 1736 | `comint-input-filter' returns non-nil when called on the input. |
| 1737 | |
| 1738 | If variable `comint-eol-on-send' is non-nil, then point is moved to the |
| 1739 | end of line before sending the input. |
| 1740 | |
| 1741 | After the input has been sent, if `comint-process-echoes' is non-nil, |
| 1742 | then `comint-send-input' waits to see if the process outputs a string |
| 1743 | matching the input, and if so, deletes that part of the output. |
| 1744 | If ARTIFICIAL is non-nil, it inhibits such deletion. |
| 1745 | Callers sending input not from the user should use ARTIFICIAL = t. |
| 1746 | |
| 1747 | The values of `comint-get-old-input', `comint-input-filter-functions', and |
| 1748 | `comint-input-filter' are chosen according to the command interpreter running |
| 1749 | in the buffer. E.g., |
| 1750 | |
| 1751 | If the interpreter is the csh, |
| 1752 | `comint-get-old-input' is the default: |
| 1753 | If `comint-use-prompt-regexp' is nil, then |
| 1754 | either return the current input field, if point is on an input |
| 1755 | field, or the current line, if point is on an output field. |
| 1756 | If `comint-use-prompt-regexp' is non-nil, then |
| 1757 | return the current line with any initial string matching the |
| 1758 | regexp `comint-prompt-regexp' removed. |
| 1759 | `comint-input-filter-functions' monitors input for \"cd\", \"pushd\", and |
| 1760 | \"popd\" commands. When it sees one, it cd's the buffer. |
| 1761 | `comint-input-filter' is the default: returns t if the input isn't all white |
| 1762 | space. |
| 1763 | |
| 1764 | If the Comint is Lucid Common Lisp, |
| 1765 | `comint-get-old-input' snarfs the sexp ending at point. |
| 1766 | `comint-input-filter-functions' does nothing. |
| 1767 | `comint-input-filter' returns nil if the input matches input-filter-regexp, |
| 1768 | which matches (1) all whitespace (2) :a, :c, etc. |
| 1769 | |
| 1770 | Similarly for Soar, Scheme, etc." |
| 1771 | (interactive) |
| 1772 | ;; If we're currently completing, stop. We're definitely done |
| 1773 | ;; completing, and by sending the input, we might cause side effects |
| 1774 | ;; that will confuse the code running in the completion |
| 1775 | ;; post-command-hook. |
| 1776 | (when completion-in-region-mode |
| 1777 | (completion-in-region-mode -1)) |
| 1778 | ;; Note that the input string does not include its terminal newline. |
| 1779 | (let ((proc (get-buffer-process (current-buffer)))) |
| 1780 | (if (not proc) (user-error "Current buffer has no process") |
| 1781 | (widen) |
| 1782 | (let* ((pmark (process-mark proc)) |
| 1783 | (intxt (if (>= (point) (marker-position pmark)) |
| 1784 | (progn (if comint-eol-on-send (end-of-line)) |
| 1785 | (buffer-substring pmark (point))) |
| 1786 | (let ((copy (funcall comint-get-old-input))) |
| 1787 | (goto-char pmark) |
| 1788 | (insert copy) |
| 1789 | copy))) |
| 1790 | (input (if (not (eq comint-input-autoexpand 'input)) |
| 1791 | ;; Just whatever's already there. |
| 1792 | intxt |
| 1793 | ;; Expand and leave it visible in buffer. |
| 1794 | (comint-replace-by-expanded-history t pmark) |
| 1795 | (buffer-substring pmark (point)))) |
| 1796 | (history (if (not (eq comint-input-autoexpand 'history)) |
| 1797 | input |
| 1798 | ;; This is messy 'cos ultimately the original |
| 1799 | ;; functions used do insertion, rather than return |
| 1800 | ;; strings. We have to expand, then insert back. |
| 1801 | (comint-replace-by-expanded-history t pmark) |
| 1802 | (let ((copy (buffer-substring pmark (point))) |
| 1803 | (start (point))) |
| 1804 | (insert input) |
| 1805 | (delete-region pmark start) |
| 1806 | copy)))) |
| 1807 | |
| 1808 | (unless no-newline |
| 1809 | (insert ?\n)) |
| 1810 | |
| 1811 | (comint-add-to-input-history history) |
| 1812 | |
| 1813 | (run-hook-with-args 'comint-input-filter-functions |
| 1814 | (if no-newline input |
| 1815 | (concat input "\n"))) |
| 1816 | |
| 1817 | (let ((beg (marker-position pmark)) |
| 1818 | (end (if no-newline (point) (1- (point))))) |
| 1819 | (with-silent-modifications |
| 1820 | (when (> end beg) |
| 1821 | (add-text-properties beg end |
| 1822 | '(front-sticky t |
| 1823 | font-lock-face comint-highlight-input)) |
| 1824 | (unless comint-use-prompt-regexp |
| 1825 | ;; Give old user input a field property of `input', to |
| 1826 | ;; distinguish it from both process output and unsent |
| 1827 | ;; input. The terminating newline is put into a special |
| 1828 | ;; `boundary' field to make cursor movement between input |
| 1829 | ;; and output fields smoother. |
| 1830 | (add-text-properties |
| 1831 | beg end |
| 1832 | '(mouse-face highlight |
| 1833 | help-echo "mouse-2: insert after prompt as new input")))) |
| 1834 | (unless (or no-newline comint-use-prompt-regexp) |
| 1835 | ;; Cover the terminating newline |
| 1836 | (add-text-properties end (1+ end) |
| 1837 | '(rear-nonsticky t |
| 1838 | field boundary |
| 1839 | inhibit-line-move-field-capture t))))) |
| 1840 | |
| 1841 | (comint-snapshot-last-prompt) |
| 1842 | |
| 1843 | (setq comint-save-input-ring-index comint-input-ring-index) |
| 1844 | (setq comint-input-ring-index nil) |
| 1845 | ;; Update the markers before we send the input |
| 1846 | ;; in case we get output amidst sending the input. |
| 1847 | (set-marker comint-last-input-start pmark) |
| 1848 | (set-marker comint-last-input-end (point)) |
| 1849 | (set-marker (process-mark proc) (point)) |
| 1850 | ;; clear the "accumulation" marker |
| 1851 | (set-marker comint-accum-marker nil) |
| 1852 | (let ((comint-input-sender-no-newline no-newline)) |
| 1853 | (funcall comint-input-sender proc input)) |
| 1854 | |
| 1855 | ;; Optionally delete echoed input (after checking it). |
| 1856 | (when (and comint-process-echoes (not artificial)) |
| 1857 | (let ((echo-len (- comint-last-input-end |
| 1858 | comint-last-input-start))) |
| 1859 | ;; Wait for all input to be echoed: |
| 1860 | (while (and (> (+ comint-last-input-end echo-len) |
| 1861 | (point-max)) |
| 1862 | (accept-process-output proc) |
| 1863 | (zerop |
| 1864 | (compare-buffer-substrings |
| 1865 | nil comint-last-input-start |
| 1866 | (- (point-max) echo-len) |
| 1867 | ;; Above difference is equivalent to |
| 1868 | ;; (+ comint-last-input-start |
| 1869 | ;; (- (point-max) comint-last-input-end)) |
| 1870 | nil comint-last-input-end (point-max))))) |
| 1871 | (if (and |
| 1872 | (<= (+ comint-last-input-end echo-len) |
| 1873 | (point-max)) |
| 1874 | (zerop |
| 1875 | (compare-buffer-substrings |
| 1876 | nil comint-last-input-start comint-last-input-end |
| 1877 | nil comint-last-input-end |
| 1878 | (+ comint-last-input-end echo-len)))) |
| 1879 | ;; Certain parts of the text to be deleted may have |
| 1880 | ;; been mistaken for prompts. We have to prevent |
| 1881 | ;; problems when `comint-prompt-read-only' is non-nil. |
| 1882 | (let ((inhibit-read-only t)) |
| 1883 | (delete-region comint-last-input-end |
| 1884 | (+ comint-last-input-end echo-len)) |
| 1885 | (when comint-prompt-read-only |
| 1886 | (save-excursion |
| 1887 | (goto-char comint-last-input-end) |
| 1888 | (comint-update-fence))))))) |
| 1889 | |
| 1890 | ;; This used to call comint-output-filter-functions, |
| 1891 | ;; but that scrolled the buffer in undesirable ways. |
| 1892 | (run-hook-with-args 'comint-output-filter-functions ""))))) |
| 1893 | |
| 1894 | (defvar comint-preoutput-filter-functions nil |
| 1895 | "List of functions to call before inserting Comint output into the buffer. |
| 1896 | Each function gets one argument, a string containing the text received |
| 1897 | from the subprocess. It should return the string to insert, perhaps |
| 1898 | the same string that was received, or perhaps a modified or transformed |
| 1899 | string. |
| 1900 | |
| 1901 | The functions on the list are called sequentially, and each one is |
| 1902 | given the string returned by the previous one. The string returned by |
| 1903 | the last function is the text that is actually inserted in the |
| 1904 | redirection buffer. |
| 1905 | |
| 1906 | You can use `add-hook' to add functions to this list |
| 1907 | either globally or locally.") |
| 1908 | |
| 1909 | (defvar comint-inhibit-carriage-motion nil |
| 1910 | "If nil, Comint will interpret `carriage control' characters in output. |
| 1911 | See `comint-carriage-motion' for details.") |
| 1912 | |
| 1913 | (defvar comint-last-prompt nil |
| 1914 | "Markers pointing to the last prompt. |
| 1915 | If non-nil, a cons cell containing markers. The car points to |
| 1916 | the start, the cdr to the end of the last prompt recognized.") |
| 1917 | |
| 1918 | (defun comint-snapshot-last-prompt () |
| 1919 | "Snapshot the current `comint-last-prompt'. |
| 1920 | Freezes the `font-lock-face' text property in place." |
| 1921 | (when comint-last-prompt |
| 1922 | (with-silent-modifications |
| 1923 | (add-text-properties |
| 1924 | (car comint-last-prompt) |
| 1925 | (cdr comint-last-prompt) |
| 1926 | '(font-lock-face comint-highlight-prompt))) |
| 1927 | ;; Reset comint-last-prompt so later on comint-output-filter does |
| 1928 | ;; not remove the font-lock-face text property of the previous |
| 1929 | ;; (this) prompt. |
| 1930 | (setq comint-last-prompt nil))) |
| 1931 | |
| 1932 | (defun comint-carriage-motion (start end) |
| 1933 | "Interpret carriage control characters in the region from START to END. |
| 1934 | Translate carriage return/linefeed sequences to linefeeds. |
| 1935 | Make single carriage returns delete to the beginning of the line. |
| 1936 | Make backspaces delete the previous character." |
| 1937 | (save-excursion |
| 1938 | ;; We used to check the existence of \b and \r at first to avoid |
| 1939 | ;; calling save-match-data and save-restriction. But, such a |
| 1940 | ;; check is not necessary now because we don't use regexp search |
| 1941 | ;; nor save-restriction. Note that the buffer is already widen, |
| 1942 | ;; and calling narrow-to-region and widen are not that heavy. |
| 1943 | (goto-char start) |
| 1944 | (let* ((inhibit-field-text-motion t) |
| 1945 | (inhibit-read-only t) |
| 1946 | (lbeg (line-beginning-position)) |
| 1947 | delete-end ch) |
| 1948 | ;; If the preceding text is marked as "must-overwrite", record |
| 1949 | ;; it in delete-end. |
| 1950 | (when (and (> start (point-min)) |
| 1951 | (get-text-property (1- start) 'comint-must-overwrite)) |
| 1952 | (setq delete-end (point-marker)) |
| 1953 | (remove-text-properties lbeg start '(comint-must-overwrite nil))) |
| 1954 | (narrow-to-region lbeg end) |
| 1955 | ;; Handle BS, LF, and CR specially. |
| 1956 | (while (and (skip-chars-forward "^\b\n\r") (not (eobp))) |
| 1957 | (setq ch (following-char)) |
| 1958 | (cond ((= ch ?\b) ; CH = BS |
| 1959 | (delete-char 1) |
| 1960 | (if (> (point) lbeg) |
| 1961 | (delete-char -1))) |
| 1962 | ((= ch ?\n) |
| 1963 | (when delete-end ; CH = LF |
| 1964 | (if (< delete-end (point)) |
| 1965 | (delete-region lbeg delete-end)) |
| 1966 | (set-marker delete-end nil) |
| 1967 | (setq delete-end nil)) |
| 1968 | (forward-char 1) |
| 1969 | (setq lbeg (point))) |
| 1970 | (t ; CH = CR |
| 1971 | (delete-char 1) |
| 1972 | (if delete-end |
| 1973 | (when (< delete-end (point)) |
| 1974 | (delete-region lbeg delete-end) |
| 1975 | (move-marker delete-end (point))) |
| 1976 | (setq delete-end (point-marker)))))) |
| 1977 | (when delete-end |
| 1978 | (if (< delete-end (point)) |
| 1979 | ;; As there's a text after the last CR, make the current |
| 1980 | ;; line contain only that text. |
| 1981 | (delete-region lbeg delete-end) |
| 1982 | ;; Remember that the process output ends by CR, and thus we |
| 1983 | ;; must overwrite the contents of the current line next |
| 1984 | ;; time. |
| 1985 | (put-text-property lbeg delete-end 'comint-must-overwrite t)) |
| 1986 | (set-marker delete-end nil)) |
| 1987 | (widen)))) |
| 1988 | |
| 1989 | ;; The purpose of using this filter for comint processes |
| 1990 | ;; is to keep comint-last-input-end from moving forward |
| 1991 | ;; when output is inserted. |
| 1992 | (defun comint-output-filter (process string) |
| 1993 | (let ((oprocbuf (process-buffer process))) |
| 1994 | ;; First check for killed buffer or no input. |
| 1995 | (when (and string oprocbuf (buffer-name oprocbuf)) |
| 1996 | (with-current-buffer oprocbuf |
| 1997 | ;; Run preoutput filters |
| 1998 | (let ((functions comint-preoutput-filter-functions)) |
| 1999 | (while (and functions string) |
| 2000 | (if (eq (car functions) t) |
| 2001 | (let ((functions |
| 2002 | (default-value 'comint-preoutput-filter-functions))) |
| 2003 | (while (and functions string) |
| 2004 | (setq string (funcall (car functions) string)) |
| 2005 | (setq functions (cdr functions)))) |
| 2006 | (setq string (funcall (car functions) string))) |
| 2007 | (setq functions (cdr functions)))) |
| 2008 | |
| 2009 | ;; Insert STRING |
| 2010 | (let ((inhibit-read-only t) |
| 2011 | ;; The point should float after any insertion we do. |
| 2012 | (saved-point (copy-marker (point) t))) |
| 2013 | |
| 2014 | ;; We temporarily remove any buffer narrowing, in case the |
| 2015 | ;; process mark is outside of the restriction |
| 2016 | (save-restriction |
| 2017 | (widen) |
| 2018 | |
| 2019 | (goto-char (process-mark process)) |
| 2020 | (set-marker comint-last-output-start (point)) |
| 2021 | |
| 2022 | ;; Try to skip repeated prompts, which can occur as a result of |
| 2023 | ;; commands sent without inserting them in the buffer. |
| 2024 | (let ((bol (save-excursion (forward-line 0) (point)))) ;No fields. |
| 2025 | (when (and (not (bolp)) |
| 2026 | (looking-back comint-prompt-regexp bol)) |
| 2027 | (let* ((prompt (buffer-substring bol (point))) |
| 2028 | (prompt-re (concat "\\`" (regexp-quote prompt)))) |
| 2029 | (while (string-match prompt-re string) |
| 2030 | (setq string (substring string (match-end 0))))))) |
| 2031 | (while (string-match (concat "\\(^" comint-prompt-regexp |
| 2032 | "\\)\\1+") |
| 2033 | string) |
| 2034 | (setq string (replace-match "\\1" nil nil string))) |
| 2035 | |
| 2036 | ;; insert-before-markers is a bad thing. XXX |
| 2037 | ;; Luckily we don't have to use it any more, we use |
| 2038 | ;; window-point-insertion-type instead. |
| 2039 | (insert string) |
| 2040 | |
| 2041 | ;; Advance process-mark |
| 2042 | (set-marker (process-mark process) (point)) |
| 2043 | |
| 2044 | (unless comint-inhibit-carriage-motion |
| 2045 | ;; Interpret any carriage motion characters (newline, backspace) |
| 2046 | (comint-carriage-motion comint-last-output-start (point))) |
| 2047 | |
| 2048 | ;; Run these hooks with point where the user had it. |
| 2049 | (goto-char saved-point) |
| 2050 | (run-hook-with-args 'comint-output-filter-functions string) |
| 2051 | (set-marker saved-point (point)) |
| 2052 | |
| 2053 | (goto-char (process-mark process)) ; In case a filter moved it. |
| 2054 | |
| 2055 | (unless comint-use-prompt-regexp |
| 2056 | (with-silent-modifications |
| 2057 | (add-text-properties comint-last-output-start (point) |
| 2058 | '(front-sticky |
| 2059 | (field inhibit-line-move-field-capture) |
| 2060 | rear-nonsticky t |
| 2061 | field output |
| 2062 | inhibit-line-move-field-capture t)))) |
| 2063 | |
| 2064 | ;; Highlight the prompt, where we define `prompt' to mean |
| 2065 | ;; the most recent output that doesn't end with a newline. |
| 2066 | (let ((prompt-start (save-excursion (forward-line 0) (point))) |
| 2067 | (inhibit-read-only t)) |
| 2068 | (when comint-prompt-read-only |
| 2069 | (with-silent-modifications |
| 2070 | (or (= (point-min) prompt-start) |
| 2071 | (get-text-property (1- prompt-start) 'read-only) |
| 2072 | (put-text-property (1- prompt-start) |
| 2073 | prompt-start 'read-only 'fence)) |
| 2074 | (add-text-properties prompt-start (point) |
| 2075 | '(read-only t front-sticky (read-only))))) |
| 2076 | (when comint-last-prompt |
| 2077 | (remove-text-properties (car comint-last-prompt) |
| 2078 | (cdr comint-last-prompt) |
| 2079 | '(font-lock-face))) |
| 2080 | (setq comint-last-prompt |
| 2081 | (cons (copy-marker prompt-start) (point-marker))) |
| 2082 | (add-text-properties prompt-start (point) |
| 2083 | '(rear-nonsticky t |
| 2084 | font-lock-face comint-highlight-prompt))) |
| 2085 | (goto-char saved-point))))))) |
| 2086 | |
| 2087 | (defun comint-preinput-scroll-to-bottom () |
| 2088 | "Go to the end of buffer in all windows showing it. |
| 2089 | Movement occurs if point in the selected window is not after the process mark, |
| 2090 | and `this-command' is an insertion command. Insertion commands recognized |
| 2091 | are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'. |
| 2092 | Depends on the value of `comint-scroll-to-bottom-on-input'. |
| 2093 | |
| 2094 | This function should be a pre-command hook." |
| 2095 | (if (and comint-scroll-to-bottom-on-input |
| 2096 | (memq this-command '(self-insert-command comint-magic-space yank |
| 2097 | hilit-yank))) |
| 2098 | (let* ((current (current-buffer)) |
| 2099 | (process (get-buffer-process current)) |
| 2100 | (scroll comint-scroll-to-bottom-on-input)) |
| 2101 | (if (and process (< (point) (process-mark process))) |
| 2102 | (if (eq scroll 'this) |
| 2103 | (goto-char (point-max)) |
| 2104 | (walk-windows |
| 2105 | (lambda (window) |
| 2106 | (if (and (eq (window-buffer window) current) |
| 2107 | (or (eq scroll t) (eq scroll 'all))) |
| 2108 | (with-selected-window window |
| 2109 | (goto-char (point-max))))) |
| 2110 | nil t)))))) |
| 2111 | |
| 2112 | (defvar follow-mode) |
| 2113 | (declare-function follow-comint-scroll-to-bottom "follow" (&optional window)) |
| 2114 | |
| 2115 | (defun comint-postoutput-scroll-to-bottom (_string) |
| 2116 | "Go to the end of buffer in some or all windows showing it. |
| 2117 | Do not scroll if the current line is the last line in the buffer. |
| 2118 | Depends on the value of `comint-move-point-for-output' and |
| 2119 | `comint-scroll-show-maximum-output'. |
| 2120 | |
| 2121 | This function should be in the list `comint-output-filter-functions'." |
| 2122 | (let* ((current (current-buffer)) |
| 2123 | (process (get-buffer-process current))) |
| 2124 | (unwind-protect |
| 2125 | (cond |
| 2126 | ((null process)) |
| 2127 | ((bound-and-true-p follow-mode) |
| 2128 | (follow-comint-scroll-to-bottom)) |
| 2129 | (t |
| 2130 | (dolist (w (get-buffer-window-list current nil t)) |
| 2131 | (comint-adjust-window-point w process) |
| 2132 | ;; Optionally scroll to the bottom of the window. |
| 2133 | (and comint-scroll-show-maximum-output |
| 2134 | (eq (window-point w) (point-max)) |
| 2135 | (with-selected-window w |
| 2136 | (recenter (- -1 scroll-margin))))))) |
| 2137 | (set-buffer current)))) |
| 2138 | |
| 2139 | |
| 2140 | (defun comint-adjust-window-point (window process) |
| 2141 | "Move point in WINDOW based on Comint settings. |
| 2142 | For point adjustment use the process-mark of PROCESS." |
| 2143 | (and (< (window-point window) (process-mark process)) |
| 2144 | (or (memq comint-move-point-for-output '(t all)) |
| 2145 | ;; Maybe user wants point to jump to end. |
| 2146 | (eq comint-move-point-for-output |
| 2147 | (if (eq (selected-window) window) 'this 'others)) |
| 2148 | ;; If point was at the end, keep it at end. |
| 2149 | (and (marker-position comint-last-output-start) |
| 2150 | (>= (window-point window) comint-last-output-start))) |
| 2151 | (set-window-point window (process-mark process)))) |
| 2152 | |
| 2153 | |
| 2154 | ;; this function is nowhere used |
| 2155 | (defun comint-adjust-point (selected) |
| 2156 | "Move point in the selected window based on Comint settings. |
| 2157 | SELECTED is the window that was originally selected." |
| 2158 | (let ((process (get-buffer-process (current-buffer)))) |
| 2159 | (and (< (point) (process-mark process)) |
| 2160 | (or (memq comint-move-point-for-output '(t all)) |
| 2161 | ;; Maybe user wants point to jump to end. |
| 2162 | (eq comint-move-point-for-output |
| 2163 | (if (eq (selected-window) selected) 'this 'others)) |
| 2164 | ;; If point was at the end, keep it at end. |
| 2165 | (and (marker-position comint-last-output-start) |
| 2166 | (>= (point) comint-last-output-start))) |
| 2167 | (goto-char (process-mark process))))) |
| 2168 | |
| 2169 | (defun comint-truncate-buffer (&optional _string) |
| 2170 | "Truncate the buffer to `comint-buffer-maximum-size'. |
| 2171 | This function could be on `comint-output-filter-functions' or bound to a key." |
| 2172 | (interactive) |
| 2173 | (save-excursion |
| 2174 | (goto-char (process-mark (get-buffer-process (current-buffer)))) |
| 2175 | (forward-line (- comint-buffer-maximum-size)) |
| 2176 | (beginning-of-line) |
| 2177 | (let ((inhibit-read-only t)) |
| 2178 | (delete-region (point-min) (point))))) |
| 2179 | |
| 2180 | (defun comint-strip-ctrl-m (&optional _string) |
| 2181 | "Strip trailing `^M' characters from the current output group. |
| 2182 | This function could be on `comint-output-filter-functions' or bound to a key." |
| 2183 | (interactive) |
| 2184 | (let ((pmark (process-mark (get-buffer-process (current-buffer))))) |
| 2185 | (save-excursion |
| 2186 | (condition-case nil |
| 2187 | (goto-char |
| 2188 | (if (called-interactively-p 'interactive) |
| 2189 | comint-last-input-end comint-last-output-start)) |
| 2190 | (error nil)) |
| 2191 | (while (re-search-forward "\r+$" pmark t) |
| 2192 | (replace-match "" t t))))) |
| 2193 | (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m) |
| 2194 | |
| 2195 | (defun comint-show-maximum-output () |
| 2196 | "Put the end of the buffer at the bottom of the window." |
| 2197 | (interactive) |
| 2198 | (goto-char (point-max)) |
| 2199 | (recenter (- -1 scroll-margin))) |
| 2200 | |
| 2201 | (defun comint-get-old-input-default () |
| 2202 | "Default for `comint-get-old-input'. |
| 2203 | If `comint-use-prompt-regexp' is nil, then either |
| 2204 | return the current input field, if point is on an input field, or the |
| 2205 | current line, if point is on an output field. |
| 2206 | If `comint-use-prompt-regexp' is non-nil, then return |
| 2207 | the current line with any initial string matching the regexp |
| 2208 | `comint-prompt-regexp' removed." |
| 2209 | (let (bof) |
| 2210 | (if (and (not comint-use-prompt-regexp) |
| 2211 | ;; Make sure we're in an input rather than output field. |
| 2212 | (null (get-char-property (setq bof (field-beginning)) 'field))) |
| 2213 | (field-string-no-properties bof) |
| 2214 | (comint-bol) |
| 2215 | (buffer-substring-no-properties (point) (line-end-position))))) |
| 2216 | |
| 2217 | (defun comint-copy-old-input () |
| 2218 | "Insert after prompt old input at point as new input to be edited. |
| 2219 | Calls `comint-get-old-input' to get old input." |
| 2220 | (interactive) |
| 2221 | (let ((input (funcall comint-get-old-input)) |
| 2222 | (process (get-buffer-process (current-buffer)))) |
| 2223 | (if (not process) |
| 2224 | (user-error "Current buffer has no process") |
| 2225 | (goto-char (process-mark process)) |
| 2226 | (insert input)))) |
| 2227 | |
| 2228 | (defun comint-skip-prompt () |
| 2229 | "Skip past the text matching regexp `comint-prompt-regexp'. |
| 2230 | If this takes us past the end of the current line, don't skip at all." |
| 2231 | (if (and (looking-at comint-prompt-regexp) |
| 2232 | (<= (match-end 0) (line-end-position))) |
| 2233 | (goto-char (match-end 0)))) |
| 2234 | |
| 2235 | (defun comint-after-pmark-p () |
| 2236 | "Return t if point is after the process output marker." |
| 2237 | (let ((pmark (process-mark (get-buffer-process (current-buffer))))) |
| 2238 | (<= (marker-position pmark) (point)))) |
| 2239 | |
| 2240 | (defun comint-simple-send (proc string) |
| 2241 | "Default function for sending to PROC input STRING. |
| 2242 | This just sends STRING plus a newline. To override this, |
| 2243 | set the hook `comint-input-sender'." |
| 2244 | (let ((send-string |
| 2245 | (if comint-input-sender-no-newline |
| 2246 | string |
| 2247 | ;; Sending as two separate strings does not work |
| 2248 | ;; on Windows, so concat the \n before sending. |
| 2249 | (concat string "\n")))) |
| 2250 | (comint-send-string proc send-string)) |
| 2251 | (if (and comint-input-sender-no-newline |
| 2252 | (not (string-equal string ""))) |
| 2253 | (process-send-eof))) |
| 2254 | |
| 2255 | (defun comint-line-beginning-position () |
| 2256 | "Return the buffer position of the beginning of the line, after any prompt. |
| 2257 | If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done by |
| 2258 | skipping text matching the regular expression `comint-prompt-regexp', |
| 2259 | a buffer local variable." |
| 2260 | (if comint-use-prompt-regexp |
| 2261 | ;; Use comint-prompt-regexp |
| 2262 | (save-excursion |
| 2263 | (beginning-of-line) |
| 2264 | (comint-skip-prompt) |
| 2265 | (point)) |
| 2266 | ;; Use input fields. Note that, unlike the behavior of |
| 2267 | ;; `line-beginning-position' inside a field, this function will |
| 2268 | ;; return the position of the end of a prompt, even if the point is |
| 2269 | ;; already inside the prompt. In order to do this, it assumes that |
| 2270 | ;; if there are two fields on a line, then the first one is the |
| 2271 | ;; prompt, and the second one is an input field, and is front-sticky |
| 2272 | ;; (as input fields should be). |
| 2273 | (constrain-to-field (line-beginning-position) (line-end-position)))) |
| 2274 | |
| 2275 | (defun comint-bol (&optional arg) |
| 2276 | "Go to the beginning of line, then skip past the prompt, if any. |
| 2277 | If prefix argument is given (\\[universal-argument]) the prompt is not skipped. |
| 2278 | If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done |
| 2279 | by skipping text matching the regular expression `comint-prompt-regexp', |
| 2280 | a buffer local variable." |
| 2281 | (interactive "P") |
| 2282 | (if arg |
| 2283 | ;; Unlike `beginning-of-line', forward-line ignores field boundaries |
| 2284 | (forward-line 0) |
| 2285 | (goto-char (comint-line-beginning-position)))) |
| 2286 | |
| 2287 | ;; For compatibility. |
| 2288 | (defun comint-read-noecho (prompt &optional _ignore) |
| 2289 | (read-passwd prompt)) |
| 2290 | |
| 2291 | ;; These three functions are for entering text you don't want echoed or |
| 2292 | ;; saved -- typically passwords to ftp, telnet, or somesuch. |
| 2293 | ;; Just enter m-x send-invisible and type in your line. |
| 2294 | |
| 2295 | (defun send-invisible (&optional prompt) |
| 2296 | "Read a string without echoing. |
| 2297 | Then send it to the process running in the current buffer. |
| 2298 | The string is sent using `comint-input-sender'. |
| 2299 | Security bug: your string can still be temporarily recovered with |
| 2300 | \\[view-lossage]; `clear-this-command-keys' can fix that." |
| 2301 | (interactive "P") ; Defeat snooping via C-x ESC ESC |
| 2302 | (let ((proc (get-buffer-process (current-buffer))) |
| 2303 | (prefix |
| 2304 | (if (eq (window-buffer) (current-buffer)) |
| 2305 | "" |
| 2306 | (format "(In buffer %s) " |
| 2307 | (current-buffer))))) |
| 2308 | (if proc |
| 2309 | (let ((str (read-passwd (concat prefix |
| 2310 | (or prompt "Non-echoed text: "))))) |
| 2311 | (if (stringp str) |
| 2312 | (progn |
| 2313 | (comint-snapshot-last-prompt) |
| 2314 | (funcall comint-input-sender proc str)) |
| 2315 | (message "Warning: text will be echoed"))) |
| 2316 | (error "Buffer %s has no process" (current-buffer))))) |
| 2317 | |
| 2318 | (defun comint-watch-for-password-prompt (string) |
| 2319 | "Prompt in the minibuffer for password and send without echoing. |
| 2320 | This function uses `send-invisible' to read and send a password to the buffer's |
| 2321 | process if STRING contains a password prompt defined by |
| 2322 | `comint-password-prompt-regexp'. |
| 2323 | |
| 2324 | This function could be in the list `comint-output-filter-functions'." |
| 2325 | (when (let ((case-fold-search t)) |
| 2326 | (string-match comint-password-prompt-regexp string)) |
| 2327 | (when (string-match "^[ \n\r\t\v\f\b\a]+" string) |
| 2328 | (setq string (replace-match "" t t string))) |
| 2329 | (send-invisible string))) |
| 2330 | \f |
| 2331 | ;; Low-level process communication |
| 2332 | |
| 2333 | (defun comint-send-string (process string) |
| 2334 | "Like `process-send-string', but also does extra bookkeeping for Comint mode." |
| 2335 | (if process |
| 2336 | (with-current-buffer (if (processp process) |
| 2337 | (process-buffer process) |
| 2338 | (get-buffer process)) |
| 2339 | (comint-snapshot-last-prompt)) |
| 2340 | (comint-snapshot-last-prompt)) |
| 2341 | (process-send-string process string)) |
| 2342 | |
| 2343 | (defun comint-send-region (process start end) |
| 2344 | "Like `process-send-region', but also does extra bookkeeping for Comint mode." |
| 2345 | (if process |
| 2346 | (with-current-buffer (if (processp process) |
| 2347 | (process-buffer process) |
| 2348 | (get-buffer process)) |
| 2349 | (comint-snapshot-last-prompt)) |
| 2350 | (comint-snapshot-last-prompt)) |
| 2351 | (process-send-region process start end)) |
| 2352 | |
| 2353 | \f |
| 2354 | ;; Random input hackage |
| 2355 | |
| 2356 | (defun comint-delete-output () |
| 2357 | "Delete all output from interpreter since last input. |
| 2358 | Does not delete the prompt." |
| 2359 | (interactive) |
| 2360 | (let ((proc (get-buffer-process (current-buffer))) |
| 2361 | (replacement nil) |
| 2362 | (inhibit-read-only t)) |
| 2363 | (save-excursion |
| 2364 | (let ((pmark (progn (goto-char (process-mark proc)) |
| 2365 | (forward-line 0) |
| 2366 | (point-marker)))) |
| 2367 | (delete-region comint-last-input-end pmark) |
| 2368 | (goto-char (process-mark proc)) |
| 2369 | (setq replacement (concat "*** output flushed ***\n" |
| 2370 | (buffer-substring pmark (point)))) |
| 2371 | (delete-region pmark (point)))) |
| 2372 | ;; Output message and put back prompt |
| 2373 | (comint-output-filter proc replacement))) |
| 2374 | |
| 2375 | (defun comint-write-output (filename &optional append mustbenew) |
| 2376 | "Write output from interpreter since last input to FILENAME. |
| 2377 | Any prompt at the end of the output is not written. |
| 2378 | |
| 2379 | If the optional argument APPEND (the prefix argument when interactive) |
| 2380 | is non-nil, the output is appended to the file instead. |
| 2381 | |
| 2382 | If the optional argument MUSTBENEW is non-nil, check for an existing |
| 2383 | file with the same name. If MUSTBENEW is `excl', that means to get an |
| 2384 | error if the file already exists; never overwrite. If MUSTBENEW is |
| 2385 | neither nil nor `excl', that means ask for confirmation before |
| 2386 | overwriting, but do go ahead and overwrite the file if the user |
| 2387 | confirms. When interactive, MUSTBENEW is nil when appending, and t |
| 2388 | otherwise." |
| 2389 | (interactive |
| 2390 | (list (read-file-name |
| 2391 | (if current-prefix-arg |
| 2392 | "Append output to file: " |
| 2393 | "Write output to file: ")) |
| 2394 | current-prefix-arg |
| 2395 | (not current-prefix-arg))) |
| 2396 | (save-excursion |
| 2397 | (goto-char (process-mark (get-buffer-process (current-buffer)))) |
| 2398 | (forward-line 0) |
| 2399 | (write-region comint-last-input-end (point) filename |
| 2400 | append nil nil mustbenew))) |
| 2401 | |
| 2402 | ;; This function exists for the benefit of the menu; from the keyboard, |
| 2403 | ;; users can just use `comint-write-output' with a prefix arg. |
| 2404 | (defun comint-append-output-to-file (filename) |
| 2405 | "Append output from interpreter since last input to FILENAME. |
| 2406 | Any prompt at the end of the output is not written." |
| 2407 | (interactive "fAppend output to file: ") |
| 2408 | (comint-write-output filename t)) |
| 2409 | |
| 2410 | (defun comint-show-output () |
| 2411 | "Display start of this batch of interpreter output at top of window. |
| 2412 | Sets mark to the value of point when this command is run." |
| 2413 | (interactive) |
| 2414 | (push-mark) |
| 2415 | (let ((pos (or (marker-position comint-last-input-end) (point-max)))) |
| 2416 | (cond (comint-use-prompt-regexp |
| 2417 | (goto-char pos) |
| 2418 | (beginning-of-line 0) |
| 2419 | (set-window-start (selected-window) (point)) |
| 2420 | (comint-skip-prompt)) |
| 2421 | (t |
| 2422 | (goto-char (field-beginning pos)) |
| 2423 | (set-window-start (selected-window) (point)))))) |
| 2424 | |
| 2425 | |
| 2426 | (defun comint-interrupt-subjob () |
| 2427 | "Interrupt the current subjob. |
| 2428 | This command also kills the pending input |
| 2429 | between the process mark and point." |
| 2430 | (interactive) |
| 2431 | (comint-skip-input) |
| 2432 | (interrupt-process nil comint-ptyp) |
| 2433 | ;; (process-send-string nil "\n") |
| 2434 | ) |
| 2435 | |
| 2436 | (defun comint-kill-subjob () |
| 2437 | "Send kill signal to the current subjob. |
| 2438 | This command also kills the pending input |
| 2439 | between the process mark and point." |
| 2440 | (interactive) |
| 2441 | (comint-skip-input) |
| 2442 | (kill-process nil comint-ptyp)) |
| 2443 | |
| 2444 | (defun comint-quit-subjob () |
| 2445 | "Send quit signal to the current subjob. |
| 2446 | This command also kills the pending input |
| 2447 | between the process mark and point." |
| 2448 | (interactive) |
| 2449 | (comint-skip-input) |
| 2450 | (quit-process nil comint-ptyp)) |
| 2451 | |
| 2452 | (defun comint-stop-subjob () |
| 2453 | "Stop the current subjob. |
| 2454 | This command also kills the pending input |
| 2455 | between the process mark and point. |
| 2456 | |
| 2457 | WARNING: if there is no current subjob, you can end up suspending |
| 2458 | the top-level process running in the buffer. If you accidentally do |
| 2459 | this, use \\[comint-continue-subjob] to resume the process. (This |
| 2460 | is not a problem with most shells, since they ignore this signal.)" |
| 2461 | (interactive) |
| 2462 | (comint-skip-input) |
| 2463 | (stop-process nil comint-ptyp)) |
| 2464 | |
| 2465 | (defun comint-continue-subjob () |
| 2466 | "Send CONT signal to process buffer's process group. |
| 2467 | Useful if you accidentally suspend the top-level process." |
| 2468 | (interactive) |
| 2469 | (continue-process nil comint-ptyp)) |
| 2470 | |
| 2471 | (defun comint-skip-input () |
| 2472 | "Skip all pending input, from last stuff output by interpreter to point. |
| 2473 | This means mark it as if it had been sent as input, without sending it." |
| 2474 | (let ((comint-input-sender 'ignore) |
| 2475 | (comint-input-filter-functions nil)) |
| 2476 | (comint-send-input t t)) |
| 2477 | (end-of-line) |
| 2478 | (let ((pos (point)) |
| 2479 | (marker (process-mark (get-buffer-process (current-buffer))))) |
| 2480 | (insert " " (key-description (this-command-keys))) |
| 2481 | (if (= marker pos) |
| 2482 | (set-marker marker (point))))) |
| 2483 | |
| 2484 | (defun comint-kill-input () |
| 2485 | "Kill all text from last stuff output by interpreter to point." |
| 2486 | (interactive) |
| 2487 | (let ((pmark (process-mark (get-buffer-process (current-buffer))))) |
| 2488 | (if (> (point) (marker-position pmark)) |
| 2489 | (kill-region pmark (point))))) |
| 2490 | |
| 2491 | (defun comint-delchar-or-maybe-eof (arg) |
| 2492 | "Delete ARG characters forward or send an EOF to subprocess. |
| 2493 | Sends an EOF only if point is at the end of the buffer and there is no input." |
| 2494 | (interactive "p") |
| 2495 | (let ((proc (get-buffer-process (current-buffer)))) |
| 2496 | (if (and (eobp) proc (= (point) (marker-position (process-mark proc)))) |
| 2497 | (comint-send-eof) |
| 2498 | (delete-char arg)))) |
| 2499 | |
| 2500 | (defun comint-send-eof () |
| 2501 | "Send an EOF to the current buffer's process." |
| 2502 | (interactive) |
| 2503 | (comint-send-input t t) |
| 2504 | (process-send-eof)) |
| 2505 | |
| 2506 | |
| 2507 | (defun comint-backward-matching-input (regexp n) |
| 2508 | "Search backward through buffer for input fields that match REGEXP. |
| 2509 | If `comint-use-prompt-regexp' is non-nil, then input fields are identified |
| 2510 | by lines that match `comint-prompt-regexp'. |
| 2511 | |
| 2512 | With prefix argument N, search for Nth previous match. |
| 2513 | If N is negative, find the next or Nth next match." |
| 2514 | (interactive (comint-regexp-arg "Backward input matching (regexp): ")) |
| 2515 | (if comint-use-prompt-regexp |
| 2516 | ;; Use comint-prompt-regexp |
| 2517 | (let* ((re (concat comint-prompt-regexp ".*" regexp)) |
| 2518 | (pos (save-excursion (end-of-line (if (> n 0) 0 1)) |
| 2519 | (if (re-search-backward re nil t n) |
| 2520 | (point))))) |
| 2521 | (if (null pos) |
| 2522 | (progn (message "Not found") |
| 2523 | (ding)) |
| 2524 | (goto-char pos) |
| 2525 | (comint-bol nil))) |
| 2526 | ;; Use input fields |
| 2527 | (let* ((dir (if (< n 0) -1 1)) |
| 2528 | (pos |
| 2529 | (save-excursion |
| 2530 | (while (/= n 0) |
| 2531 | (unless (re-search-backward regexp nil t dir) |
| 2532 | (user-error "Not found")) |
| 2533 | (unless (get-char-property (point) 'field) |
| 2534 | (setq n (- n dir)))) |
| 2535 | (field-beginning)))) |
| 2536 | (goto-char pos)))) |
| 2537 | |
| 2538 | |
| 2539 | (defun comint-forward-matching-input (regexp n) |
| 2540 | "Search forward through buffer for input fields that match REGEXP. |
| 2541 | If `comint-use-prompt-regexp' is non-nil, then input fields are identified |
| 2542 | by lines that match `comint-prompt-regexp'. |
| 2543 | |
| 2544 | With prefix argument N, search for Nth following match. |
| 2545 | If N is negative, find the previous or Nth previous match." |
| 2546 | (interactive (comint-regexp-arg "Forward input matching (regexp): ")) |
| 2547 | (comint-backward-matching-input regexp (- n))) |
| 2548 | |
| 2549 | |
| 2550 | (defun comint-next-prompt (n) |
| 2551 | "Move to end of Nth next prompt in the buffer. |
| 2552 | If `comint-use-prompt-regexp' is nil, then this means the beginning of |
| 2553 | the Nth next `input' field, otherwise, it means the Nth occurrence of |
| 2554 | text matching `comint-prompt-regexp'." |
| 2555 | (interactive "p") |
| 2556 | (if comint-use-prompt-regexp |
| 2557 | ;; Use comint-prompt-regexp |
| 2558 | (let ((paragraph-start comint-prompt-regexp)) |
| 2559 | (end-of-line (if (> n 0) 1 0)) |
| 2560 | (forward-paragraph n) |
| 2561 | (comint-skip-prompt)) |
| 2562 | ;; Use input fields |
| 2563 | (let ((pos (point)) |
| 2564 | (input-pos nil) |
| 2565 | prev-pos) |
| 2566 | (while (/= n 0) |
| 2567 | (setq prev-pos pos) |
| 2568 | (setq pos |
| 2569 | (if (> n 0) |
| 2570 | (next-single-char-property-change pos 'field) |
| 2571 | (previous-single-char-property-change pos 'field))) |
| 2572 | (cond ((= pos prev-pos) |
| 2573 | ;; Ran off the end of the buffer. |
| 2574 | (when (> n 0) |
| 2575 | ;; There's always an input field at the end of the |
| 2576 | ;; buffer, but it has a `field' property of nil. |
| 2577 | (setq input-pos (point-max))) |
| 2578 | ;; stop iterating |
| 2579 | (setq n 0)) |
| 2580 | ((null (get-char-property pos 'field)) |
| 2581 | (setq n (if (< n 0) (1+ n) (1- n))) |
| 2582 | (setq input-pos pos)))) |
| 2583 | (when input-pos |
| 2584 | (goto-char input-pos))))) |
| 2585 | |
| 2586 | |
| 2587 | (defun comint-previous-prompt (n) |
| 2588 | "Move to end of Nth previous prompt in the buffer. |
| 2589 | If `comint-use-prompt-regexp' is nil, then this means the beginning of |
| 2590 | the Nth previous `input' field, otherwise, it means the Nth occurrence of |
| 2591 | text matching `comint-prompt-regexp'." |
| 2592 | (interactive "p") |
| 2593 | (comint-next-prompt (- n))) |
| 2594 | |
| 2595 | ;; State used by `comint-insert-previous-argument' when cycling. |
| 2596 | (defvar-local comint-insert-previous-argument-last-start-pos nil) |
| 2597 | (defvar-local comint-insert-previous-argument-last-index nil) |
| 2598 | |
| 2599 | ;; Needs fixing: |
| 2600 | ;; make comint-arguments understand negative indices as bash does |
| 2601 | (defun comint-insert-previous-argument (index) |
| 2602 | "Insert the INDEXth argument from the previous Comint command-line at point. |
| 2603 | Spaces are added at beginning and/or end of the inserted string if |
| 2604 | necessary to ensure that it's separated from adjacent arguments. |
| 2605 | Interactively, if no prefix argument is given, the last argument is inserted. |
| 2606 | Repeated interactive invocations will cycle through the same argument |
| 2607 | from progressively earlier commands (using the value of INDEX specified |
| 2608 | with the first command). |
| 2609 | This command is like `M-.' in bash." |
| 2610 | (interactive "P") |
| 2611 | (unless (null index) |
| 2612 | (setq index (prefix-numeric-value index))) |
| 2613 | (cond ((eq last-command this-command) |
| 2614 | ;; Delete last input inserted by this command. |
| 2615 | (delete-region comint-insert-previous-argument-last-start-pos (point)) |
| 2616 | (setq index comint-insert-previous-argument-last-index)) |
| 2617 | (t |
| 2618 | ;; This is a non-repeat invocation, so initialize state. |
| 2619 | (setq comint-input-ring-index nil) |
| 2620 | (setq comint-insert-previous-argument-last-index index) |
| 2621 | (when (null comint-insert-previous-argument-last-start-pos) |
| 2622 | ;; First usage; initialize to a marker |
| 2623 | (setq comint-insert-previous-argument-last-start-pos |
| 2624 | (make-marker))))) |
| 2625 | ;; Make sure we're not in the prompt, and add a beginning space if necessary. |
| 2626 | (if (<= (point) (comint-line-beginning-position)) |
| 2627 | (comint-bol) |
| 2628 | (just-one-space)) |
| 2629 | ;; Remember the beginning of what we insert, so we can delete it if |
| 2630 | ;; the command is repeated. |
| 2631 | (set-marker comint-insert-previous-argument-last-start-pos (point)) |
| 2632 | ;; Insert the argument. |
| 2633 | (let ((input-string (comint-previous-input-string 0))) |
| 2634 | (when (string-match "[ \t\n]*&" input-string) |
| 2635 | ;; strip terminating '&' |
| 2636 | (setq input-string (substring input-string 0 (match-beginning 0)))) |
| 2637 | (insert (comint-arguments input-string index index))) |
| 2638 | ;; Make next invocation return arg from previous input |
| 2639 | (setq comint-input-ring-index (1+ (or comint-input-ring-index 0))) |
| 2640 | ;; Add a terminating space if necessary. |
| 2641 | (unless (eolp) |
| 2642 | (just-one-space))) |
| 2643 | |
| 2644 | \f |
| 2645 | ;; Support editing with `comint-prompt-read-only' set to t. |
| 2646 | |
| 2647 | (defun comint-update-fence () |
| 2648 | "Update read-only status of newline before point. |
| 2649 | The `fence' read-only property is used to indicate that a newline |
| 2650 | is read-only for no other reason than to \"fence off\" a |
| 2651 | following front-sticky read-only region. This is used to |
| 2652 | implement comint read-only prompts. If the text after a newline |
| 2653 | changes, the read-only status of that newline may need updating. |
| 2654 | That is what this function does. |
| 2655 | |
| 2656 | This function does nothing if point is not at the beginning of a |
| 2657 | line, or is at the beginning of the accessible portion of the buffer. |
| 2658 | Otherwise, if the character after point has a front-sticky |
| 2659 | read-only property, then the preceding newline is given a |
| 2660 | read-only property of `fence', unless it already is read-only. |
| 2661 | If the character after point does not have a front-sticky |
| 2662 | read-only property, any read-only property of `fence' on the |
| 2663 | preceding newline is removed." |
| 2664 | (let* ((pt (point)) (lst (get-text-property pt 'front-sticky))) |
| 2665 | (and (bolp) |
| 2666 | (not (bobp)) |
| 2667 | (with-silent-modifications |
| 2668 | (if (and (get-text-property pt 'read-only) |
| 2669 | (if (listp lst) (memq 'read-only lst) t)) |
| 2670 | (unless (get-text-property (1- pt) 'read-only) |
| 2671 | (put-text-property (1- pt) pt 'read-only 'fence)) |
| 2672 | (when (eq (get-text-property (1- pt) 'read-only) 'fence) |
| 2673 | (remove-list-of-text-properties (1- pt) pt '(read-only)))))))) |
| 2674 | |
| 2675 | (defun comint-kill-whole-line (&optional count) |
| 2676 | "Kill current line, ignoring read-only and field properties. |
| 2677 | With prefix arg COUNT, kill that many lines starting from the current line. |
| 2678 | If COUNT is negative, kill backward. Also kill the preceding newline, |
| 2679 | instead of the trailing one. \(This is meant to make \\[repeat] work well |
| 2680 | with negative arguments.) |
| 2681 | If COUNT is zero, kill current line but exclude the trailing newline. |
| 2682 | The read-only status of newlines is updated with `comint-update-fence', |
| 2683 | if necessary." |
| 2684 | (interactive "p") |
| 2685 | (let ((inhibit-read-only t) (inhibit-field-text-motion t)) |
| 2686 | (kill-whole-line count) |
| 2687 | (when (>= count 0) (comint-update-fence)))) |
| 2688 | |
| 2689 | (defun comint-kill-region (beg end) |
| 2690 | "Like `kill-region', but ignores read-only properties, if safe. |
| 2691 | This command assumes that the buffer contains read-only |
| 2692 | \"prompts\" which are regions with front-sticky read-only |
| 2693 | properties at the beginning of a line, with the preceding newline |
| 2694 | being read-only to protect the prompt. This is true of the |
| 2695 | comint prompts if `comint-prompt-read-only' is non-nil. This |
| 2696 | command will not delete the region if this would create mutilated |
| 2697 | or out of place prompts. That is, if any part of a prompt is |
| 2698 | deleted, the entire prompt must be deleted and all remaining |
| 2699 | prompts should stay at the beginning of a line. If this is not |
| 2700 | the case, this command just calls `kill-region' with all |
| 2701 | read-only properties intact. The read-only status of newlines is |
| 2702 | updated using `comint-update-fence', if necessary." |
| 2703 | (interactive "r") |
| 2704 | (save-excursion |
| 2705 | (let* ((true-beg (min beg end)) |
| 2706 | (true-end (max beg end)) |
| 2707 | (beg-bolp (progn (goto-char true-beg) (bolp))) |
| 2708 | (beg-lst (get-text-property true-beg 'front-sticky)) |
| 2709 | (beg-bad (and (get-text-property true-beg 'read-only) |
| 2710 | (if (listp beg-lst) (memq 'read-only beg-lst) t))) |
| 2711 | (end-bolp (progn (goto-char true-end) (bolp))) |
| 2712 | (end-lst (get-text-property true-end 'front-sticky)) |
| 2713 | (end-bad (and (get-text-property true-end 'read-only) |
| 2714 | (if (listp end-lst) (memq 'read-only end-lst) t)))) |
| 2715 | (if (or (and (not beg-bolp) (or beg-bad end-bad)) |
| 2716 | (and (not end-bolp) end-bad)) |
| 2717 | (kill-region beg end) |
| 2718 | (let ((inhibit-read-only t)) |
| 2719 | (kill-region beg end) |
| 2720 | (comint-update-fence)))))) |
| 2721 | \f |
| 2722 | ;; Support for source-file processing commands. |
| 2723 | ;;============================================================================ |
| 2724 | ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have |
| 2725 | ;; commands that process files of source text (e.g. loading or compiling |
| 2726 | ;; files). So the corresponding process-in-a-buffer modes have commands |
| 2727 | ;; for doing this (e.g., lisp-load-file). The functions below are useful |
| 2728 | ;; for defining these commands. |
| 2729 | ;; |
| 2730 | ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme |
| 2731 | ;; and Soar, in that they don't know anything about file extensions. |
| 2732 | ;; So the compile/load interface gets the wrong default occasionally. |
| 2733 | ;; The load-file/compile-file default mechanism could be smarter -- it |
| 2734 | ;; doesn't know about the relationship between filename extensions and |
| 2735 | ;; whether the file is source or executable. If you compile foo.lisp |
| 2736 | ;; with compile-file, then the next load-file should use foo.bin for |
| 2737 | ;; the default, not foo.lisp. This is tricky to do right, particularly |
| 2738 | ;; because the extension for executable files varies so much (.o, .bin, |
| 2739 | ;; .lbin, .mo, .vo, .ao, ...). |
| 2740 | |
| 2741 | |
| 2742 | ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing |
| 2743 | ;; commands. |
| 2744 | ;; |
| 2745 | ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you |
| 2746 | ;; want to save the buffer before issuing any process requests to the command |
| 2747 | ;; interpreter. |
| 2748 | ;; |
| 2749 | ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt |
| 2750 | ;; for the file to process. |
| 2751 | |
| 2752 | (defun comint-source-default (previous-dir/file source-modes) |
| 2753 | "Compute the defaults for `load-file' and `compile-file' commands. |
| 2754 | |
| 2755 | PREVIOUS-DIR/FILE is a pair (DIRECTORY . FILENAME) from the last |
| 2756 | source-file processing command, or nil if there hasn't been one yet. |
| 2757 | SOURCE-MODES is a list used to determine what buffers contain source |
| 2758 | files: if the major mode of the buffer is in SOURCE-MODES, it's source. |
| 2759 | Typically, (lisp-mode) or (scheme-mode). |
| 2760 | |
| 2761 | If the command is given while the cursor is inside a string, *and* |
| 2762 | the string is an existing filename, *and* the filename is not a directory, |
| 2763 | then the string is taken as default. This allows you to just position |
| 2764 | your cursor over a string that's a filename and have it taken as default. |
| 2765 | |
| 2766 | If the command is given in a file buffer whose major mode is in |
| 2767 | SOURCE-MODES, then the filename is the default file, and the |
| 2768 | file's directory is the default directory. |
| 2769 | |
| 2770 | If the buffer isn't a source file buffer (e.g., it's the process buffer), |
| 2771 | then the default directory & file are what was used in the last source-file |
| 2772 | processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time |
| 2773 | the command has been run (PREVIOUS-DIR/FILE is nil), the default directory |
| 2774 | is the cwd, with no default file. (\"no default file\" = nil) |
| 2775 | |
| 2776 | SOURCE-MODES is typically going to be something like (tea-mode) |
| 2777 | for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode) |
| 2778 | for Soar programs, etc. |
| 2779 | |
| 2780 | The function returns a pair: (default-directory . default-file)." |
| 2781 | (cond ((and buffer-file-name (memq major-mode source-modes)) |
| 2782 | (cons (file-name-directory buffer-file-name) |
| 2783 | (file-name-nondirectory buffer-file-name))) |
| 2784 | (previous-dir/file) |
| 2785 | (t |
| 2786 | (cons default-directory nil)))) |
| 2787 | |
| 2788 | |
| 2789 | (defun comint-check-source (fname) |
| 2790 | "Check whether to save buffers visiting file FNAME. |
| 2791 | Prior to loading or compiling (or otherwise processing) a file (in the CMU |
| 2792 | process-in-a-buffer modes), this function can be called on the filename. |
| 2793 | If the file is loaded into a buffer, and the buffer is modified, the user |
| 2794 | is queried to see if he wants to save the buffer before proceeding with |
| 2795 | the load or compile." |
| 2796 | (let ((buff (get-file-buffer fname))) |
| 2797 | (if (and buff |
| 2798 | (buffer-modified-p buff) |
| 2799 | (y-or-n-p (format "Save buffer %s first? " (buffer-name buff)))) |
| 2800 | (with-current-buffer buff |
| 2801 | (save-buffer))))) |
| 2802 | |
| 2803 | (defun comint-extract-string () |
| 2804 | "Return string around point, or nil." |
| 2805 | (let ((syntax (syntax-ppss))) |
| 2806 | (when (nth 3 syntax) |
| 2807 | (condition-case () |
| 2808 | (buffer-substring-no-properties (1+ (nth 8 syntax)) |
| 2809 | (progn (goto-char (nth 8 syntax)) |
| 2810 | (forward-sexp) |
| 2811 | (1- (point)))) |
| 2812 | (error nil))))) |
| 2813 | |
| 2814 | (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p) |
| 2815 | "Prompt for filenames in commands that process source files, |
| 2816 | e.g. loading or compiling a file. |
| 2817 | Provides a default, if there is one, and returns the result filename. |
| 2818 | |
| 2819 | See `comint-source-default' for more on determining defaults. |
| 2820 | |
| 2821 | PROMPT is the prompt string. PREV-DIR/FILE is the (DIRECTORY . FILE) pair |
| 2822 | from the last source processing command. SOURCE-MODES is a list of major |
| 2823 | modes used to determine what file buffers contain source files. (These |
| 2824 | two arguments are used for determining defaults.) If MUSTMATCH-P is true, |
| 2825 | then the filename reader will only accept a file that exists. |
| 2826 | |
| 2827 | A typical use: |
| 2828 | (interactive (comint-get-source \"Compile file: \" prev-lisp-dir/file |
| 2829 | '(lisp-mode) t))" |
| 2830 | (let* ((def (comint-source-default prev-dir/file source-modes)) |
| 2831 | (stringfile (comint-extract-string)) |
| 2832 | (sfile-p (and stringfile |
| 2833 | (condition-case () |
| 2834 | (file-exists-p stringfile) |
| 2835 | (error nil)) |
| 2836 | (not (file-directory-p stringfile)))) |
| 2837 | (defdir (if sfile-p (file-name-directory stringfile) |
| 2838 | (car def))) |
| 2839 | (deffile (if sfile-p (file-name-nondirectory stringfile) |
| 2840 | (cdr def))) |
| 2841 | (ans (read-file-name (if deffile (format "%s(default %s) " |
| 2842 | prompt deffile) |
| 2843 | prompt) |
| 2844 | defdir |
| 2845 | (concat defdir deffile) |
| 2846 | mustmatch-p))) |
| 2847 | (list (expand-file-name (substitute-in-file-name ans))))) |
| 2848 | |
| 2849 | ;; I am somewhat divided on this string-default feature. It seems |
| 2850 | ;; to violate the principle-of-least-astonishment, in that it makes |
| 2851 | ;; the default harder to predict, so you actually have to look and see |
| 2852 | ;; what the default really is before choosing it. This can trip you up. |
| 2853 | ;; On the other hand, it can be useful, I guess. I would appreciate feedback |
| 2854 | ;; on this. |
| 2855 | ;; -Olin |
| 2856 | |
| 2857 | \f |
| 2858 | ;; Simple process query facility. |
| 2859 | ;; =========================================================================== |
| 2860 | ;; This function is for commands that want to send a query to the process |
| 2861 | ;; and show the response to the user. For example, a command to get the |
| 2862 | ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query |
| 2863 | ;; to an inferior Common Lisp process. |
| 2864 | ;; |
| 2865 | ;; This simple facility just sends strings to the inferior process and pops |
| 2866 | ;; up a window for the process buffer so you can see what the process |
| 2867 | ;; responds with. We don't do anything fancy like try to intercept what the |
| 2868 | ;; process responds with and put it in a pop-up window or on the message |
| 2869 | ;; line. We just display the buffer. Low tech. Simple. Works good. |
| 2870 | |
| 2871 | (defun comint-proc-query (proc str) |
| 2872 | "Send to the inferior process PROC the string STR. |
| 2873 | Pop-up but do not select a window for the inferior process so that |
| 2874 | its response can be seen." |
| 2875 | (let* ((proc-buf (process-buffer proc)) |
| 2876 | (proc-mark (process-mark proc))) |
| 2877 | (display-buffer proc-buf) |
| 2878 | (set-buffer proc-buf) ; but it's not the selected *window* |
| 2879 | (let ((proc-win (get-buffer-window proc-buf 0)) |
| 2880 | (proc-pt (marker-position proc-mark))) |
| 2881 | (comint-send-string proc str) ; send the query |
| 2882 | (accept-process-output proc) ; wait for some output |
| 2883 | ;; Try to position the proc window so you can see the answer. |
| 2884 | ;; This is bogus code. If you delete the (sit-for 0), it breaks. |
| 2885 | ;; I don't know why. Wizards invited to improve it. |
| 2886 | (unless (pos-visible-in-window-p proc-pt proc-win) |
| 2887 | (let ((opoint (window-point proc-win))) |
| 2888 | (set-window-point proc-win proc-mark) |
| 2889 | (sit-for 0) |
| 2890 | (if (not (pos-visible-in-window-p opoint proc-win)) |
| 2891 | (push-mark opoint) |
| 2892 | (set-window-point proc-win opoint))))))) |
| 2893 | |
| 2894 | \f |
| 2895 | ;; Filename/command/history completion in a buffer |
| 2896 | ;; =========================================================================== |
| 2897 | ;; Useful completion functions, courtesy of the Ergo group. |
| 2898 | |
| 2899 | ;; Six commands: |
| 2900 | ;; completion-at-point Complete or expand command, filename, |
| 2901 | ;; history at point. |
| 2902 | ;; comint-dynamic-complete-filename Complete filename at point. |
| 2903 | ;; comint-dynamic-list-filename-completions List completions in help buffer. |
| 2904 | ;; comint-replace-by-expanded-filename Expand and complete filename at point; |
| 2905 | ;; replace with expanded/completed name. |
| 2906 | |
| 2907 | ;; These are not installed in the comint-mode keymap. But they are |
| 2908 | ;; available for people who want them. Shell-mode installs them: |
| 2909 | ;; (define-key shell-mode-map "\t" 'completion-at-point) |
| 2910 | ;; (define-key shell-mode-map "\M-?" |
| 2911 | ;; 'comint-dynamic-list-filename-completions))) |
| 2912 | ;; |
| 2913 | ;; Commands like this are fine things to put in load hooks if you |
| 2914 | ;; want them present in specific modes. |
| 2915 | |
| 2916 | (defcustom comint-completion-autolist nil |
| 2917 | "If non-nil, automatically list possibilities on partial completion. |
| 2918 | This mirrors the optional behavior of tcsh." |
| 2919 | :type 'boolean |
| 2920 | :group 'comint-completion) |
| 2921 | |
| 2922 | (defcustom comint-completion-addsuffix t |
| 2923 | "If non-nil, add ` ' to file names. |
| 2924 | It can either be a string FILESUFFIX or a cons (DIRSUFFIX . FILESUFFIX) |
| 2925 | where DIRSUFFIX is ignored and FILESUFFIX is a string added on unambiguous |
| 2926 | or exact completion. |
| 2927 | This mirrors the optional behavior of tcsh." |
| 2928 | :type '(choice (const :tag "None" nil) |
| 2929 | (const :tag "Add SPC" t) |
| 2930 | (string :tag "File suffix") |
| 2931 | (cons :tag "Obsolete suffix pair" |
| 2932 | (string :tag "Ignored") |
| 2933 | (string :tag "File suffix"))) |
| 2934 | :group 'comint-completion) |
| 2935 | |
| 2936 | (defcustom comint-completion-recexact nil |
| 2937 | "If non-nil, use shortest completion if characters cannot be added. |
| 2938 | This mirrors the optional behavior of tcsh. |
| 2939 | |
| 2940 | A non-nil value is useful if `comint-completion-autolist' is non-nil too." |
| 2941 | :type 'boolean |
| 2942 | :group 'comint-completion) |
| 2943 | |
| 2944 | (defcustom comint-completion-fignore nil |
| 2945 | "List of suffixes to be disregarded during file completion. |
| 2946 | This mirrors the optional behavior of bash and tcsh. |
| 2947 | |
| 2948 | Note that this applies to `comint-dynamic-complete-filename' only." |
| 2949 | :type '(repeat (string :tag "Suffix")) |
| 2950 | :group 'comint-completion) |
| 2951 | |
| 2952 | ;;;###autoload |
| 2953 | (defvar comint-file-name-prefix (purecopy "") |
| 2954 | "Prefix prepended to absolute file names taken from process input. |
| 2955 | This is used by Comint's and shell's completion functions, and by shell's |
| 2956 | directory tracking functions.") |
| 2957 | |
| 2958 | (defvar comint-file-name-chars |
| 2959 | (if (memq system-type '(ms-dos windows-nt cygwin)) |
| 2960 | "~/A-Za-z0-9_^$!#%&{}@`'.,:()-" |
| 2961 | "[]~/A-Za-z0-9+@:_.$#%,={}-") |
| 2962 | "String of characters valid in a file name. |
| 2963 | Note that all non-ASCII characters are considered valid in a file name |
| 2964 | regardless of what this variable says. |
| 2965 | |
| 2966 | This is a good thing to set in mode hooks.") |
| 2967 | |
| 2968 | (defvar comint-file-name-quote-list nil |
| 2969 | "List of characters to quote with `\\' when in a file name. |
| 2970 | |
| 2971 | This is a good thing to set in mode hooks.") |
| 2972 | |
| 2973 | |
| 2974 | (defun comint-directory (directory) |
| 2975 | "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute." |
| 2976 | (expand-file-name (if (file-name-absolute-p directory) |
| 2977 | (concat comint-file-name-prefix directory) |
| 2978 | directory))) |
| 2979 | |
| 2980 | |
| 2981 | (defun comint-word (word-chars) |
| 2982 | "Return the word of WORD-CHARS at point, or nil if none is found. |
| 2983 | Word constituents are considered to be those in WORD-CHARS, which is like the |
| 2984 | inside of a \"[...]\" (see `skip-chars-forward'), plus all non-ASCII characters." |
| 2985 | ;; FIXME: Need to handle "..." and '...' quoting in shell.el! |
| 2986 | ;; This should be combined with completion parsing somehow. |
| 2987 | (save-excursion |
| 2988 | (let ((here (point)) |
| 2989 | giveup) |
| 2990 | (while (not giveup) |
| 2991 | (let ((startpoint (point))) |
| 2992 | (skip-chars-backward (concat "\\\\" word-chars)) |
| 2993 | (if (and comint-file-name-quote-list |
| 2994 | (eq (char-before (1- (point))) ?\\)) |
| 2995 | (forward-char -2)) |
| 2996 | ;; FIXME: This isn't consistent with Bash, at least -- not |
| 2997 | ;; all non-ASCII chars should be word constituents. |
| 2998 | (if (and (not (bobp)) (>= (char-before) 128)) |
| 2999 | (forward-char -1)) |
| 3000 | (if (= (point) startpoint) |
| 3001 | (setq giveup t)))) |
| 3002 | ;; Set match-data to match the entire string. |
| 3003 | (when (< (point) here) |
| 3004 | (set-match-data (list (point) here)) |
| 3005 | (match-string 0))))) |
| 3006 | |
| 3007 | (defun comint-substitute-in-file-name (filename) |
| 3008 | "Return FILENAME with environment variables substituted. |
| 3009 | Supports additional environment variable syntax of the command |
| 3010 | interpreter (e.g., the percent notation of cmd.exe on Windows)." |
| 3011 | (let ((name (substitute-in-file-name filename))) |
| 3012 | (if (memq system-type '(ms-dos windows-nt)) |
| 3013 | (let (env-var-name |
| 3014 | env-var-val) |
| 3015 | (save-match-data |
| 3016 | (while (string-match "%\\([^\\\\/]*\\)%" name) |
| 3017 | (setq env-var-name (match-string 1 name)) |
| 3018 | (setq env-var-val (or (getenv env-var-name) "")) |
| 3019 | (setq name (replace-match env-var-val t t name)))))) |
| 3020 | name)) |
| 3021 | |
| 3022 | (defun comint--match-partial-filename () |
| 3023 | "Return the filename at point as-is, or nil if none is found. |
| 3024 | See `comint-word'." |
| 3025 | (comint-word comint-file-name-chars)) |
| 3026 | |
| 3027 | (defun comint--unquote&requote-argument (qstr &optional upos) |
| 3028 | (unless upos (setq upos 0)) |
| 3029 | (let* ((qpos 0) |
| 3030 | (ustrs '()) |
| 3031 | (re (concat |
| 3032 | "\\$\\(?:\\([[:alpha:]][[:alnum:]]*\\)" |
| 3033 | "\\|{\\(?1:[^{}]+\\)}\\)" |
| 3034 | (when (memq system-type '(ms-dos windows-nt)) |
| 3035 | "\\|%\\(?1:[^\\\\/]*\\)%") |
| 3036 | (when comint-file-name-quote-list |
| 3037 | "\\|\\\\\\(.\\)"))) |
| 3038 | (qupos nil) |
| 3039 | (push (lambda (str end) |
| 3040 | (push str ustrs) |
| 3041 | (setq upos (- upos (length str))) |
| 3042 | (unless (or qupos (> upos 0)) |
| 3043 | (setq qupos (if (< end 0) (- end) (+ upos end)))))) |
| 3044 | match) |
| 3045 | (while (setq match (string-match re qstr qpos)) |
| 3046 | (funcall push (substring qstr qpos match) match) |
| 3047 | (cond |
| 3048 | ((match-beginning 2) (funcall push (match-string 2 qstr) (match-end 0))) |
| 3049 | ((match-beginning 1) (funcall push (getenv (match-string 1 qstr)) |
| 3050 | (- (match-end 0)))) |
| 3051 | (t (error "Unexpected case in comint--unquote&requote-argument!"))) |
| 3052 | (setq qpos (match-end 0))) |
| 3053 | (funcall push (substring qstr qpos) (length qstr)) |
| 3054 | (list (mapconcat #'identity (nreverse ustrs) "") |
| 3055 | qupos #'comint-quote-filename))) |
| 3056 | |
| 3057 | (defun comint--unquote-argument (str) |
| 3058 | (car (comint--unquote&requote-argument str))) |
| 3059 | (define-obsolete-function-alias 'comint--unquote&expand-filename |
| 3060 | #'comint--unquote-argument "24.3") |
| 3061 | |
| 3062 | (defun comint-match-partial-filename () |
| 3063 | "Return the unquoted&expanded filename at point, or nil if none is found. |
| 3064 | Environment variables are substituted. See `comint-word'." |
| 3065 | (let ((filename (comint--match-partial-filename))) |
| 3066 | (and filename (comint--unquote-argument filename)))) |
| 3067 | |
| 3068 | (defun comint-quote-filename (filename) |
| 3069 | "Return FILENAME with magic characters quoted. |
| 3070 | Magic characters are those in `comint-file-name-quote-list'." |
| 3071 | (if (null comint-file-name-quote-list) |
| 3072 | filename |
| 3073 | (let ((regexp (regexp-opt-charset comint-file-name-quote-list))) |
| 3074 | (save-match-data |
| 3075 | (let ((i 0)) |
| 3076 | (while (string-match regexp filename i) |
| 3077 | (setq filename (replace-match "\\\\\\&" nil nil filename)) |
| 3078 | (setq i (1+ (match-end 0))))) |
| 3079 | filename)))) |
| 3080 | |
| 3081 | (defun comint-unquote-filename (filename) |
| 3082 | "Return FILENAME with quoted characters unquoted." |
| 3083 | (declare (obsolete nil "24.3")) |
| 3084 | (if (null comint-file-name-quote-list) |
| 3085 | filename |
| 3086 | (save-match-data |
| 3087 | (replace-regexp-in-string "\\\\\\(.\\)" "\\1" filename t)))) |
| 3088 | |
| 3089 | (defun comint--requote-argument (upos qstr) |
| 3090 | ;; See `completion-table-with-quoting'. |
| 3091 | (let ((res (comint--unquote&requote-argument qstr upos))) |
| 3092 | (cons (nth 1 res) (nth 2 res)))) |
| 3093 | |
| 3094 | (defun comint-completion-at-point () |
| 3095 | (run-hook-with-args-until-success 'comint-dynamic-complete-functions)) |
| 3096 | |
| 3097 | (define-obsolete-function-alias |
| 3098 | 'comint-dynamic-complete |
| 3099 | 'completion-at-point "24.1") |
| 3100 | |
| 3101 | (defun comint-dynamic-complete-filename () |
| 3102 | "Dynamically complete the filename at point. |
| 3103 | Completes if after a filename. |
| 3104 | This function is similar to `comint-replace-by-expanded-filename', except that |
| 3105 | it won't change parts of the filename already entered in the buffer; it just |
| 3106 | adds completion characters to the end of the filename. A completions listing |
| 3107 | may be shown in a separate buffer if completion is ambiguous. |
| 3108 | |
| 3109 | Completion is dependent on the value of `comint-completion-addsuffix', |
| 3110 | `comint-completion-recexact' and `comint-completion-fignore', and the timing of |
| 3111 | completions listing is dependent on the value of `comint-completion-autolist'. |
| 3112 | |
| 3113 | Returns t if successful." |
| 3114 | (interactive) |
| 3115 | (when (comint--match-partial-filename) |
| 3116 | (unless (window-minibuffer-p) |
| 3117 | (message "Completing file name...")) |
| 3118 | (let ((data (comint--complete-file-name-data))) |
| 3119 | (completion-in-region (nth 0 data) (nth 1 data) (nth 2 data))))) |
| 3120 | |
| 3121 | (defun comint-filename-completion () |
| 3122 | "Return completion data for filename at point, if any." |
| 3123 | (when (comint--match-partial-filename) |
| 3124 | (comint--complete-file-name-data))) |
| 3125 | |
| 3126 | (defun comint-completion-file-name-table (string pred action) |
| 3127 | (if (not (file-name-absolute-p string)) |
| 3128 | (completion-file-name-table string pred action) |
| 3129 | (cond |
| 3130 | ((memq action '(t lambda)) |
| 3131 | (completion-file-name-table |
| 3132 | (concat comint-file-name-prefix string) pred action)) |
| 3133 | ((null action) |
| 3134 | (let ((res (completion-file-name-table |
| 3135 | (concat comint-file-name-prefix string) pred action))) |
| 3136 | (if (and (stringp res) |
| 3137 | (string-match |
| 3138 | (concat "\\`" (regexp-quote comint-file-name-prefix)) |
| 3139 | res)) |
| 3140 | (substring res (match-end 0)) |
| 3141 | res))) |
| 3142 | (t (completion-file-name-table string pred action))))) |
| 3143 | |
| 3144 | (defvar comint-unquote-function #'comint--unquote-argument |
| 3145 | "Function to use for completion of quoted data. |
| 3146 | See `completion-table-with-quoting' and `comint-requote-function'.") |
| 3147 | (defvar comint-requote-function #'comint--requote-argument |
| 3148 | "Function to use for completion of quoted data. |
| 3149 | See `completion-table-with-quoting' and `comint-unquote-function'.") |
| 3150 | |
| 3151 | (defun comint--complete-file-name-data () |
| 3152 | "Return the completion data for file name at point." |
| 3153 | (let* ((filesuffix (cond ((not comint-completion-addsuffix) "") |
| 3154 | ((stringp comint-completion-addsuffix) |
| 3155 | comint-completion-addsuffix) |
| 3156 | ((not (consp comint-completion-addsuffix)) " ") |
| 3157 | (t (cdr comint-completion-addsuffix)))) |
| 3158 | (filename (comint--match-partial-filename)) |
| 3159 | (filename-beg (if filename (match-beginning 0) (point))) |
| 3160 | (filename-end (if filename (match-end 0) (point))) |
| 3161 | (table |
| 3162 | (completion-table-with-quoting |
| 3163 | #'comint-completion-file-name-table |
| 3164 | comint-unquote-function |
| 3165 | comint-requote-function))) |
| 3166 | (nconc |
| 3167 | (list |
| 3168 | filename-beg filename-end |
| 3169 | (lambda (string pred action) |
| 3170 | (let ((completion-ignore-case read-file-name-completion-ignore-case) |
| 3171 | (completion-ignored-extensions comint-completion-fignore)) |
| 3172 | (complete-with-action action table string pred)))) |
| 3173 | (unless (zerop (length filesuffix)) |
| 3174 | (list :exit-function |
| 3175 | (lambda (_s status) |
| 3176 | (when (eq status 'finished) |
| 3177 | (if (looking-at (regexp-quote filesuffix)) |
| 3178 | (goto-char (match-end 0)) |
| 3179 | (insert filesuffix))))))))) |
| 3180 | |
| 3181 | (defun comint-dynamic-complete-as-filename () |
| 3182 | "Dynamically complete at point as a filename. |
| 3183 | See `comint-dynamic-complete-filename'. Returns t if successful." |
| 3184 | (declare (obsolete comint-filename-completion "24.1")) |
| 3185 | (let ((data (comint--complete-file-name-data))) |
| 3186 | (completion-in-region (nth 0 data) (nth 1 data) (nth 2 data)))) |
| 3187 | |
| 3188 | (defun comint-replace-by-expanded-filename () |
| 3189 | "Dynamically expand and complete the filename at point. |
| 3190 | Replace the filename with an expanded, canonicalized and |
| 3191 | completed replacement, i.e. substituting environment |
| 3192 | variables (e.g. $HOME), `~'s, `..', and `.', and making the |
| 3193 | filename absolute. For expansion see `expand-file-name' and |
| 3194 | `substitute-in-file-name'. For completion see |
| 3195 | `comint-dynamic-complete-filename'." |
| 3196 | (interactive) |
| 3197 | (let ((filename (comint-match-partial-filename))) |
| 3198 | (when filename |
| 3199 | (replace-match (expand-file-name filename) t t) |
| 3200 | (comint-dynamic-complete-filename)))) |
| 3201 | |
| 3202 | |
| 3203 | (defun comint-dynamic-simple-complete (stub candidates) |
| 3204 | "Dynamically complete STUB from CANDIDATES list. |
| 3205 | This function inserts completion characters at point by |
| 3206 | completing STUB from the strings in CANDIDATES. If completion is |
| 3207 | ambiguous, possibly show a completions listing in a separate |
| 3208 | buffer. |
| 3209 | |
| 3210 | Return nil if no completion was inserted. |
| 3211 | Return `sole' if completed with the only completion match. |
| 3212 | Return `shortest' if completed with the shortest match. |
| 3213 | Return `partial' if completed as far as possible. |
| 3214 | Return `listed' if a completion listing was shown. |
| 3215 | |
| 3216 | See also `comint-dynamic-complete-filename'." |
| 3217 | (declare (obsolete completion-in-region "24.1")) |
| 3218 | (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin))) |
| 3219 | (minibuffer-p (window-minibuffer-p)) |
| 3220 | (suffix (cond ((not comint-completion-addsuffix) "") |
| 3221 | ((not (consp comint-completion-addsuffix)) " ") |
| 3222 | (t (cdr comint-completion-addsuffix)))) |
| 3223 | (completions (all-completions stub candidates))) |
| 3224 | (cond ((null completions) |
| 3225 | (if minibuffer-p |
| 3226 | (minibuffer-message "No completions of %s" stub) |
| 3227 | (message "No completions of %s" stub)) |
| 3228 | nil) |
| 3229 | ((= 1 (length completions)) ; Gotcha! |
| 3230 | (let ((completion (car completions))) |
| 3231 | (if (string-equal completion stub) |
| 3232 | (unless minibuffer-p |
| 3233 | (message "Sole completion")) |
| 3234 | (insert (substring completion (length stub))) |
| 3235 | (unless minibuffer-p |
| 3236 | (message "Completed"))) |
| 3237 | (insert suffix) |
| 3238 | 'sole)) |
| 3239 | (t ; There's no unique completion. |
| 3240 | (let ((completion (try-completion stub candidates))) |
| 3241 | ;; Insert the longest substring. |
| 3242 | (insert (substring completion (length stub))) |
| 3243 | (cond ((and comint-completion-recexact comint-completion-addsuffix |
| 3244 | (string-equal stub completion) |
| 3245 | (member completion completions)) |
| 3246 | ;; It's not unique, but user wants shortest match. |
| 3247 | (insert suffix) |
| 3248 | (unless minibuffer-p |
| 3249 | (message "Completed shortest")) |
| 3250 | 'shortest) |
| 3251 | ((or comint-completion-autolist |
| 3252 | (string-equal stub completion)) |
| 3253 | ;; It's not unique, list possible completions. |
| 3254 | (comint-dynamic-list-completions completions stub) |
| 3255 | 'listed) |
| 3256 | (t |
| 3257 | (unless minibuffer-p |
| 3258 | (message "Partially completed")) |
| 3259 | 'partial))))))) |
| 3260 | |
| 3261 | (defun comint-dynamic-list-filename-completions () |
| 3262 | "Display a list of possible completions for the filename at point." |
| 3263 | (interactive) |
| 3264 | (let* ((data (comint--complete-file-name-data)) |
| 3265 | (minibuffer-completion-table (nth 2 data)) |
| 3266 | (minibuffer-completion-predicate nil) |
| 3267 | (ol (make-overlay (nth 0 data) (nth 1 data) nil nil t))) |
| 3268 | (overlay-put ol 'field 'completion) |
| 3269 | (unwind-protect |
| 3270 | (call-interactively 'minibuffer-completion-help) |
| 3271 | (delete-overlay ol)))) |
| 3272 | |
| 3273 | |
| 3274 | ;; This is bound locally in a *Completions* buffer to the list of |
| 3275 | ;; completions displayed, and is used to detect the case where the same |
| 3276 | ;; command is repeatedly used without the set of completions changing. |
| 3277 | (defvar comint-displayed-dynamic-completions nil) |
| 3278 | |
| 3279 | (defvar comint-dynamic-list-completions-config nil) |
| 3280 | |
| 3281 | (defun comint-dynamic-list-completions (completions &optional common-substring) |
| 3282 | "Display a list of sorted COMPLETIONS. |
| 3283 | Typing SPC flushes the completions buffer. |
| 3284 | |
| 3285 | The optional argument COMMON-SUBSTRING, if non-nil, should be a string |
| 3286 | specifying a common substring for adding the faces |
| 3287 | `completions-first-difference' and `completions-common-part' to |
| 3288 | the completions." |
| 3289 | (let ((window (get-buffer-window "*Completions*" 0))) |
| 3290 | (setq completions (sort completions 'string-lessp)) |
| 3291 | (if (and (eq last-command this-command) |
| 3292 | window (window-live-p window) (window-buffer window) |
| 3293 | (buffer-name (window-buffer window)) |
| 3294 | ;; The above tests are not sufficient to detect the case where we |
| 3295 | ;; should scroll, because the top-level interactive command may |
| 3296 | ;; not have displayed a completions window the last time it was |
| 3297 | ;; invoked, and there may be such a window left over from a |
| 3298 | ;; previous completion command with a different set of |
| 3299 | ;; completions. To detect that case, we also test that the set |
| 3300 | ;; of displayed completions is in fact the same as the previously |
| 3301 | ;; displayed set. |
| 3302 | (equal completions |
| 3303 | (buffer-local-value 'comint-displayed-dynamic-completions |
| 3304 | (window-buffer window)))) |
| 3305 | ;; If this command was repeated, and |
| 3306 | ;; there's a fresh completion window with a live buffer, |
| 3307 | ;; and this command is repeated, scroll that window. |
| 3308 | (with-current-buffer (window-buffer window) |
| 3309 | (if (pos-visible-in-window-p (point-max) window) |
| 3310 | (set-window-start window (point-min)) |
| 3311 | (save-selected-window |
| 3312 | (select-window window) |
| 3313 | (scroll-up)))) |
| 3314 | |
| 3315 | ;; Display a completion list for the first time. |
| 3316 | (setq comint-dynamic-list-completions-config |
| 3317 | (current-window-configuration)) |
| 3318 | (with-output-to-temp-buffer "*Completions*" |
| 3319 | (display-completion-list |
| 3320 | (completion-hilit-commonality completions (length common-substring)))) |
| 3321 | (if (window-minibuffer-p) |
| 3322 | (minibuffer-message "Type space to flush; repeat completion command to scroll") |
| 3323 | (message "Type space to flush; repeat completion command to scroll"))) |
| 3324 | |
| 3325 | ;; Read the next key, to process SPC. |
| 3326 | (let (key first) |
| 3327 | (if (with-current-buffer (get-buffer "*Completions*") |
| 3328 | (setq-local comint-displayed-dynamic-completions |
| 3329 | completions) |
| 3330 | (setq key (read-key-sequence nil) |
| 3331 | first (aref key 0)) |
| 3332 | (and (consp first) (consp (event-start first)) |
| 3333 | (eq (window-buffer (posn-window (event-start first))) |
| 3334 | (get-buffer "*Completions*")) |
| 3335 | (memq (key-binding key) |
| 3336 | '(mouse-choose-completion choose-completion)))) |
| 3337 | ;; If the user does choose-completion with the mouse, |
| 3338 | ;; execute the command, then delete the completion window. |
| 3339 | (progn |
| 3340 | (choose-completion first) |
| 3341 | (set-window-configuration comint-dynamic-list-completions-config)) |
| 3342 | (if (eq first ?\s) |
| 3343 | (set-window-configuration comint-dynamic-list-completions-config) |
| 3344 | (setq unread-command-events (listify-key-sequence key))))))) |
| 3345 | \f |
| 3346 | (defun comint-get-next-from-history () |
| 3347 | "After fetching a line from input history, this fetches the following line. |
| 3348 | In other words, this recalls the input line after the line you recalled last. |
| 3349 | You can use this to repeat a sequence of input lines." |
| 3350 | (interactive) |
| 3351 | (if comint-save-input-ring-index |
| 3352 | (progn |
| 3353 | (setq comint-input-ring-index (1+ comint-save-input-ring-index)) |
| 3354 | (comint-next-input 1)) |
| 3355 | (message "No previous history command"))) |
| 3356 | |
| 3357 | (defun comint-accumulate () |
| 3358 | "Accumulate a line to send as input along with more lines. |
| 3359 | This inserts a newline so that you can enter more text |
| 3360 | to be sent along with this line. Use \\[comint-send-input] |
| 3361 | to send all the accumulated input, at once. |
| 3362 | The entire accumulated text becomes one item in the input history |
| 3363 | when you send it." |
| 3364 | (interactive) |
| 3365 | (insert "\n") |
| 3366 | (set-marker comint-accum-marker (point)) |
| 3367 | (if comint-input-ring-index |
| 3368 | (setq comint-save-input-ring-index |
| 3369 | (- comint-input-ring-index 1)))) |
| 3370 | |
| 3371 | (defun comint-goto-process-mark () |
| 3372 | "Move point to the process mark. |
| 3373 | The process mark separates output, and input already sent, |
| 3374 | from input that has not yet been sent." |
| 3375 | (interactive) |
| 3376 | (let ((proc (or (get-buffer-process (current-buffer)) |
| 3377 | (user-error "Current buffer has no process")))) |
| 3378 | (goto-char (process-mark proc)) |
| 3379 | (when (called-interactively-p 'interactive) |
| 3380 | (message "Point is now at the process mark")))) |
| 3381 | |
| 3382 | (defun comint-bol-or-process-mark () |
| 3383 | "Move point to beginning of line (after prompt) or to the process mark. |
| 3384 | The first time you use this command, it moves to the beginning of the line |
| 3385 | \(but after the prompt, if any). If you repeat it again immediately, |
| 3386 | it moves point to the process mark. |
| 3387 | |
| 3388 | The process mark separates the process output, along with input already sent, |
| 3389 | from input that has not yet been sent. Ordinarily, the process mark |
| 3390 | is at the beginning of the current input line; but if you have |
| 3391 | used \\[comint-accumulate] to send multiple lines at once, |
| 3392 | the process mark is at the beginning of the accumulated input." |
| 3393 | (interactive) |
| 3394 | (if (not (eq last-command 'comint-bol-or-process-mark)) |
| 3395 | (comint-bol nil) |
| 3396 | (comint-goto-process-mark))) |
| 3397 | |
| 3398 | (defun comint-set-process-mark () |
| 3399 | "Set the process mark at point." |
| 3400 | (interactive) |
| 3401 | (let ((proc (or (get-buffer-process (current-buffer)) |
| 3402 | (user-error "Current buffer has no process")))) |
| 3403 | (set-marker (process-mark proc) (point)) |
| 3404 | (message "Process mark set"))) |
| 3405 | |
| 3406 | \f |
| 3407 | ;; Author: Peter Breton <pbreton@cs.umb.edu> |
| 3408 | |
| 3409 | ;; This little add-on for comint is intended to make it easy to get |
| 3410 | ;; output from currently active comint buffers into another buffer, |
| 3411 | ;; or buffers, and then go back to using the comint shell. |
| 3412 | ;; |
| 3413 | ;; My particular use is SQL interpreters; I want to be able to execute a |
| 3414 | ;; query using the process associated with a comint-buffer, and save that |
| 3415 | ;; somewhere else. Because the process might have state (for example, it |
| 3416 | ;; could be in an uncommitted transaction), just running starting a new |
| 3417 | ;; process and having it execute the query and then finish, would not |
| 3418 | ;; work. I'm sure there are other uses as well, although in many cases |
| 3419 | ;; starting a new process is the simpler, and thus preferable, approach. |
| 3420 | ;; |
| 3421 | ;; The basic implementation is as follows: comint-redirect changes the |
| 3422 | ;; preoutput filter functions (`comint-preoutput-filter-functions') to use |
| 3423 | ;; its own filter. The filter puts the output into the designated buffer, |
| 3424 | ;; or buffers, until it sees a regexp that tells it to stop (by default, |
| 3425 | ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it |
| 3426 | ;; sees the stop regexp, it restores the old filter functions, and runs |
| 3427 | ;; `comint-redirect-hook'. |
| 3428 | ;; |
| 3429 | ;; Each comint buffer may only use one redirection at a time, but any number |
| 3430 | ;; of different comint buffers may be simultaneously redirected. |
| 3431 | ;; |
| 3432 | ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the |
| 3433 | ;; correct prompt for your interpreter, or that you supply a regexp that says |
| 3434 | ;; when the redirection is finished. Otherwise, redirection will continue |
| 3435 | ;; indefinitely. The code now does a sanity check to ensure that it can find |
| 3436 | ;; a prompt in the comint buffer; however, it is still important to ensure that |
| 3437 | ;; this prompt is set correctly. |
| 3438 | ;; |
| 3439 | ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set; |
| 3440 | ;; perhaps it should prompt for a terminating string (with an |
| 3441 | ;; appropriate magic default by examining what we think is the prompt)? |
| 3442 | ;; |
| 3443 | ;; Fixme: look for appropriate fields, rather than regexp, if |
| 3444 | ;; `comint-use-prompt-regexp' is true. |
| 3445 | |
| 3446 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
| 3447 | ;; Variables |
| 3448 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
| 3449 | |
| 3450 | (defcustom comint-redirect-verbose nil |
| 3451 | "If non-nil, print messages each time the redirection filter is invoked. |
| 3452 | Also print a message when redirection is completed." |
| 3453 | :group 'comint |
| 3454 | :type 'boolean) |
| 3455 | |
| 3456 | ;; Directly analogous to comint-preoutput-filter-functions |
| 3457 | (defvar comint-redirect-filter-functions nil |
| 3458 | "List of functions to call before inserting redirected process output. |
| 3459 | Each function gets one argument, a string containing the text received |
| 3460 | from the subprocess. It should return the string to insert, perhaps |
| 3461 | the same string that was received, or perhaps a modified or transformed |
| 3462 | string. |
| 3463 | |
| 3464 | The functions on the list are called sequentially, and each one is given |
| 3465 | the string returned by the previous one. The string returned by the |
| 3466 | last function is the text that is actually inserted in the redirection buffer. |
| 3467 | |
| 3468 | You can use `add-hook' to add functions to this list |
| 3469 | either globally or locally.") |
| 3470 | |
| 3471 | ;; Internal variables |
| 3472 | |
| 3473 | (defvar comint-redirect-output-buffer nil |
| 3474 | "The buffer or list of buffers to put output into.") |
| 3475 | |
| 3476 | (defvar comint-redirect-finished-regexp nil |
| 3477 | "Regular expression that determines when to stop redirection in Comint. |
| 3478 | When the redirection filter function is given output that matches this regexp, |
| 3479 | the output is inserted as usual, and redirection is completed.") |
| 3480 | |
| 3481 | (defvar comint-redirect-insert-matching-regexp nil |
| 3482 | "If non-nil, the text that ends a redirection is included in it. |
| 3483 | More precisely, the text that matches `comint-redirect-finished-regexp' |
| 3484 | and therefore terminates an output redirection is inserted in the |
| 3485 | redirection target buffer, along with the preceding output.") |
| 3486 | |
| 3487 | (defvar comint-redirect-echo-input nil |
| 3488 | "Non-nil means echo input in the process buffer even during redirection.") |
| 3489 | |
| 3490 | (defvar comint-redirect-completed nil |
| 3491 | "Non-nil if redirection has completed in the current buffer.") |
| 3492 | |
| 3493 | (defvar comint-redirect-original-mode-line-process nil |
| 3494 | "Original mode line for redirected process.") |
| 3495 | |
| 3496 | (defvar comint-redirect-perform-sanity-check t |
| 3497 | "If non-nil, check that redirection is likely to complete successfully. |
| 3498 | More precisely, before starting a redirection, verify that the |
| 3499 | regular expression `comint-redirect-finished-regexp' that controls |
| 3500 | when to terminate it actually matches some text already in the process |
| 3501 | buffer. The idea is that this regular expression should match a prompt |
| 3502 | string, and that there ought to be at least one copy of your prompt string |
| 3503 | in the process buffer already.") |
| 3504 | |
| 3505 | (defvar comint-redirect-subvert-readonly nil |
| 3506 | "Non-nil means `comint-redirect' can insert into read-only buffers. |
| 3507 | This works by binding `inhibit-read-only' around the insertion. |
| 3508 | This is useful, for instance, for insertion into Help mode buffers. |
| 3509 | You probably want to set it locally to the output buffer.") |
| 3510 | |
| 3511 | (defvar comint-redirect-previous-input-string nil |
| 3512 | "Last redirected line of text. |
| 3513 | Allows detection of the end of the redirection in case the |
| 3514 | completion string is split between two output segments.") |
| 3515 | |
| 3516 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
| 3517 | ;; Functions |
| 3518 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
| 3519 | |
| 3520 | (defun comint-redirect-setup (output-buffer |
| 3521 | comint-buffer |
| 3522 | finished-regexp |
| 3523 | &optional echo-input) |
| 3524 | "Set up for output redirection. |
| 3525 | This function sets local variables that are used by `comint-redirect-filter' |
| 3526 | to perform redirection. |
| 3527 | |
| 3528 | Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something |
| 3529 | in the output matches FINISHED-REGEXP. |
| 3530 | |
| 3531 | If optional argument ECHO-INPUT is non-nil, output is echoed to the |
| 3532 | original Comint buffer. |
| 3533 | |
| 3534 | This function is called by `comint-redirect-send-command-to-process', |
| 3535 | and does not normally need to be invoked by the end user or programmer." |
| 3536 | (with-current-buffer comint-buffer |
| 3537 | |
| 3538 | (setq-local comint-redirect-original-mode-line-process mode-line-process) |
| 3539 | |
| 3540 | (setq-local comint-redirect-output-buffer output-buffer) |
| 3541 | |
| 3542 | (setq-local comint-redirect-finished-regexp finished-regexp) |
| 3543 | |
| 3544 | (setq-local comint-redirect-echo-input echo-input) |
| 3545 | |
| 3546 | (setq-local comint-redirect-completed nil) |
| 3547 | |
| 3548 | (setq-local comint-redirect-previous-input-string "") |
| 3549 | |
| 3550 | (setq mode-line-process |
| 3551 | (if mode-line-process |
| 3552 | (list (concat (elt mode-line-process 0) " Redirection")) |
| 3553 | (list ":%s Redirection"))))) |
| 3554 | |
| 3555 | (defun comint-redirect-cleanup () |
| 3556 | "End a Comint redirection. See `comint-redirect-send-command'." |
| 3557 | (interactive) |
| 3558 | ;; Release the last redirected string |
| 3559 | (setq comint-redirect-previous-input-string nil) |
| 3560 | ;; Restore the process filter |
| 3561 | (remove-function (process-filter (get-buffer-process (current-buffer))) |
| 3562 | #'comint-redirect-filter) |
| 3563 | ;; Restore the mode line |
| 3564 | (setq mode-line-process comint-redirect-original-mode-line-process) |
| 3565 | ;; Set the completed flag |
| 3566 | (setq comint-redirect-completed t)) |
| 3567 | |
| 3568 | ;; Because the cleanup happens as a callback, it's not easy to guarantee |
| 3569 | ;; that it really occurs. |
| 3570 | (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup) |
| 3571 | |
| 3572 | (defun comint-redirect-filter (orig-filter process input-string) |
| 3573 | "Filter function which redirects output from PROCESS to a buffer or buffers. |
| 3574 | The variable `comint-redirect-output-buffer' says which buffer(s) to |
| 3575 | place output in. |
| 3576 | |
| 3577 | INPUT-STRING is the input from the Comint process. |
| 3578 | |
| 3579 | This function runs as a process filter, and does not need to be invoked by the |
| 3580 | end user." |
| 3581 | (and process |
| 3582 | (with-current-buffer (process-buffer process) |
| 3583 | (comint-redirect-preoutput-filter input-string) |
| 3584 | ;; If we have to echo output, give it to the original filter function |
| 3585 | (and comint-redirect-echo-input |
| 3586 | orig-filter |
| 3587 | (funcall orig-filter process input-string))))) |
| 3588 | |
| 3589 | |
| 3590 | (defun comint-redirect-preoutput-filter (input-string) |
| 3591 | "Comint filter function which redirects Comint output to a buffer or buffers. |
| 3592 | The variable `comint-redirect-output-buffer' says which buffer(s) to |
| 3593 | place output in. |
| 3594 | |
| 3595 | INPUT-STRING is the input from the Comint process. |
| 3596 | |
| 3597 | This function does not need to be invoked by the end user." |
| 3598 | (let ((output-buffer-list |
| 3599 | (if (listp comint-redirect-output-buffer) |
| 3600 | comint-redirect-output-buffer |
| 3601 | (list comint-redirect-output-buffer))) |
| 3602 | (filtered-input-string input-string)) |
| 3603 | |
| 3604 | ;; If there are any filter functions, give them a chance to modify |
| 3605 | ;; the string. |
| 3606 | (let ((functions comint-redirect-filter-functions)) |
| 3607 | (while (and functions filtered-input-string) |
| 3608 | (if (eq (car functions) t) |
| 3609 | ;; If a local value says "use the default value too", |
| 3610 | ;; do that. |
| 3611 | (let ((functions |
| 3612 | (default-value 'comint-redirect-filter-functions))) |
| 3613 | (while (and functions filtered-input-string) |
| 3614 | (setq filtered-input-string |
| 3615 | (funcall (car functions) filtered-input-string)) |
| 3616 | (setq functions (cdr functions)))) |
| 3617 | (setq filtered-input-string |
| 3618 | (funcall (car functions) filtered-input-string))) |
| 3619 | (setq functions (cdr functions)))) |
| 3620 | |
| 3621 | ;; Clobber `comint-redirect-finished-regexp' |
| 3622 | (or comint-redirect-insert-matching-regexp |
| 3623 | (and (string-match comint-redirect-finished-regexp filtered-input-string) |
| 3624 | (setq filtered-input-string |
| 3625 | (replace-match "" nil nil filtered-input-string)))) |
| 3626 | |
| 3627 | ;; Send output to all registered buffers |
| 3628 | (save-excursion |
| 3629 | (dolist (buf output-buffer-list) |
| 3630 | ;; Set this buffer to the output buffer |
| 3631 | (set-buffer (get-buffer-create buf)) |
| 3632 | ;; Go to the end of the buffer |
| 3633 | (goto-char (point-max)) |
| 3634 | ;; Insert the output |
| 3635 | (let ((inhibit-read-only comint-redirect-subvert-readonly)) |
| 3636 | (insert filtered-input-string)))) |
| 3637 | |
| 3638 | ;; Message |
| 3639 | (and comint-redirect-verbose |
| 3640 | (message "Redirected output to buffer(s) %s" output-buffer-list)) |
| 3641 | |
| 3642 | ;; If we see the prompt, tidy up |
| 3643 | ;; We'll look for the prompt in the original string, so nobody can |
| 3644 | ;; clobber it |
| 3645 | (and (string-match comint-redirect-finished-regexp |
| 3646 | (concat comint-redirect-previous-input-string |
| 3647 | input-string)) |
| 3648 | (progn |
| 3649 | (and comint-redirect-verbose |
| 3650 | (message "Redirection completed")) |
| 3651 | (comint-redirect-cleanup) |
| 3652 | (run-hooks 'comint-redirect-hook))) |
| 3653 | (setq comint-redirect-previous-input-string input-string) |
| 3654 | |
| 3655 | ;; Echo input? |
| 3656 | (if comint-redirect-echo-input |
| 3657 | filtered-input-string |
| 3658 | ""))) |
| 3659 | |
| 3660 | ;;;###autoload |
| 3661 | (defun comint-redirect-send-command (command output-buffer echo &optional no-display) |
| 3662 | "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER. |
| 3663 | With prefix arg ECHO, echo output in process buffer. |
| 3664 | |
| 3665 | If NO-DISPLAY is non-nil, do not show the output buffer." |
| 3666 | (interactive "sCommand: \nBOutput Buffer: \nP") |
| 3667 | (let ((process (get-buffer-process (current-buffer)))) |
| 3668 | (if process |
| 3669 | (comint-redirect-send-command-to-process |
| 3670 | command output-buffer (current-buffer) echo no-display) |
| 3671 | (error "No process for current buffer")))) |
| 3672 | |
| 3673 | ;;;###autoload |
| 3674 | (defun comint-redirect-send-command-to-process |
| 3675 | (command output-buffer process echo &optional no-display) |
| 3676 | "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER. |
| 3677 | With prefix arg, echo output in process buffer. |
| 3678 | |
| 3679 | If NO-DISPLAY is non-nil, do not show the output buffer." |
| 3680 | (interactive "sCommand: \nBOutput Buffer: \nbProcess Buffer: \nP") |
| 3681 | (let* (;; The process buffer |
| 3682 | (process-buffer (if (processp process) |
| 3683 | (process-buffer process) |
| 3684 | process)) |
| 3685 | (proc (get-buffer-process process-buffer))) |
| 3686 | ;; Change to the process buffer |
| 3687 | (with-current-buffer process-buffer |
| 3688 | |
| 3689 | ;; Make sure there's a prompt in the current process buffer |
| 3690 | (and comint-redirect-perform-sanity-check |
| 3691 | (save-excursion |
| 3692 | (goto-char (point-max)) |
| 3693 | (or (re-search-backward comint-prompt-regexp nil t) |
| 3694 | (error "No prompt found or `comint-prompt-regexp' not set properly")))) |
| 3695 | |
| 3696 | ;; Set up for redirection |
| 3697 | (comint-redirect-setup |
| 3698 | output-buffer |
| 3699 | (current-buffer) ; Comint Buffer |
| 3700 | comint-prompt-regexp ; Finished Regexp |
| 3701 | echo) ; Echo input |
| 3702 | |
| 3703 | ;; Set the filter. |
| 3704 | (add-function :around (process-filter proc) #'comint-redirect-filter) |
| 3705 | |
| 3706 | ;; Send the command |
| 3707 | (process-send-string (current-buffer) (concat command "\n")) |
| 3708 | |
| 3709 | ;; Show the output |
| 3710 | (or no-display |
| 3711 | (display-buffer |
| 3712 | (get-buffer-create |
| 3713 | (if (listp output-buffer) |
| 3714 | (car output-buffer) |
| 3715 | output-buffer))))))) |
| 3716 | |
| 3717 | ;;;###autoload |
| 3718 | (defun comint-redirect-results-list (command regexp regexp-group) |
| 3719 | "Send COMMAND to current process. |
| 3720 | Return a list of expressions in the output which match REGEXP. |
| 3721 | REGEXP-GROUP is the regular expression group in REGEXP to use." |
| 3722 | (comint-redirect-results-list-from-process |
| 3723 | (get-buffer-process (current-buffer)) |
| 3724 | command regexp regexp-group)) |
| 3725 | |
| 3726 | ;;;###autoload |
| 3727 | (defun comint-redirect-results-list-from-process (process command regexp regexp-group) |
| 3728 | "Send COMMAND to PROCESS. |
| 3729 | Return a list of expressions in the output which match REGEXP. |
| 3730 | REGEXP-GROUP is the regular expression group in REGEXP to use." |
| 3731 | (let ((output-buffer " *Comint Redirect Work Buffer*") |
| 3732 | results) |
| 3733 | (with-current-buffer (get-buffer-create output-buffer) |
| 3734 | (erase-buffer) |
| 3735 | (comint-redirect-send-command-to-process command |
| 3736 | output-buffer process nil t) |
| 3737 | ;; Wait for the process to complete |
| 3738 | (set-buffer (process-buffer process)) |
| 3739 | (while (and (null comint-redirect-completed) |
| 3740 | (accept-process-output process))) |
| 3741 | ;; Collect the output |
| 3742 | (set-buffer output-buffer) |
| 3743 | (goto-char (point-min)) |
| 3744 | ;; Skip past the command, if it was echoed |
| 3745 | (and (looking-at command) |
| 3746 | (forward-line)) |
| 3747 | (while (and (not (eobp)) |
| 3748 | (re-search-forward regexp nil t)) |
| 3749 | (push (buffer-substring-no-properties |
| 3750 | (match-beginning regexp-group) |
| 3751 | (match-end regexp-group)) |
| 3752 | results)) |
| 3753 | (nreverse results)))) |
| 3754 | \f |
| 3755 | ;; Converting process modes to use comint mode |
| 3756 | ;; =========================================================================== |
| 3757 | ;; The code in the Emacs 19 distribution has all been modified to use comint |
| 3758 | ;; where needed. However, there are `third-party' packages out there that |
| 3759 | ;; still use the old shell mode. Here's a guide to conversion. |
| 3760 | ;; |
| 3761 | ;; Renaming variables |
| 3762 | ;; Most of the work is renaming variables and functions. These are the common |
| 3763 | ;; ones: |
| 3764 | ;; Local variables: |
| 3765 | ;; last-input-start comint-last-input-start |
| 3766 | ;; last-input-end comint-last-input-end |
| 3767 | ;; shell-prompt-pattern comint-prompt-regexp |
| 3768 | ;; shell-set-directory-error-hook <no equivalent> |
| 3769 | ;; Miscellaneous: |
| 3770 | ;; shell-set-directory <unnecessary> |
| 3771 | ;; shell-mode-map comint-mode-map |
| 3772 | ;; Commands: |
| 3773 | ;; shell-send-input comint-send-input |
| 3774 | ;; shell-send-eof comint-delchar-or-maybe-eof |
| 3775 | ;; kill-shell-input comint-kill-input |
| 3776 | ;; interrupt-shell-subjob comint-interrupt-subjob |
| 3777 | ;; stop-shell-subjob comint-stop-subjob |
| 3778 | ;; quit-shell-subjob comint-quit-subjob |
| 3779 | ;; kill-shell-subjob comint-kill-subjob |
| 3780 | ;; kill-output-from-shell comint-delete-output |
| 3781 | ;; show-output-from-shell comint-show-output |
| 3782 | ;; copy-last-shell-input Use comint-previous-input/comint-next-input |
| 3783 | ;; |
| 3784 | ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by |
| 3785 | ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions. |
| 3786 | ;; Comint mode does not provide functionality equivalent to |
| 3787 | ;; shell-set-directory-error-hook; it is gone. |
| 3788 | ;; |
| 3789 | ;; comint-last-input-start is provided for modes which want to munge |
| 3790 | ;; the buffer after input is sent, perhaps because the inferior |
| 3791 | ;; insists on echoing the input. The LAST-INPUT-START variable in |
| 3792 | ;; the old shell package was used to implement a history mechanism, |
| 3793 | ;; but you should think twice before using comint-last-input-start |
| 3794 | ;; for this; the input history ring often does the job better. |
| 3795 | ;; |
| 3796 | ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do |
| 3797 | ;; *not* create the comint-mode local variables in your foo-mode function. |
| 3798 | ;; This is not modular. Instead, call comint-mode, and let *it* create the |
| 3799 | ;; necessary comint-specific local variables. Then create the |
| 3800 | ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to |
| 3801 | ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks |
| 3802 | ;; (comint-{prompt-regexp, input-filter, input-filter-functions, |
| 3803 | ;; get-old-input) that need to be different from the defaults. Call |
| 3804 | ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself; |
| 3805 | ;; comint-mode will take care of it. The following example, from shell.el, |
| 3806 | ;; is typical: |
| 3807 | ;; |
| 3808 | ;; (defvar shell-mode-map |
| 3809 | ;; (let ((map (make-sparse-keymap))) |
| 3810 | ;; (set-keymap-parent map comint-mode-map) |
| 3811 | ;; (define-key map "\C-c\C-f" 'shell-forward-command) |
| 3812 | ;; (define-key map "\C-c\C-b" 'shell-backward-command) |
| 3813 | ;; (define-key map "\t" 'completion-at-point) |
| 3814 | ;; (define-key map "\M-?" |
| 3815 | ;; 'comint-dynamic-list-filename-completions) |
| 3816 | ;; map)) |
| 3817 | ;; |
| 3818 | ;; (define-derived-mode shell-mode comint-mode "Shell" |
| 3819 | ;; "Doc." |
| 3820 | ;; (setq comint-prompt-regexp shell-prompt-pattern) |
| 3821 | ;; (setq-local shell-directory-stack nil) |
| 3822 | ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)) |
| 3823 | ;; |
| 3824 | ;; |
| 3825 | ;; Completion for comint-mode users |
| 3826 | ;; |
| 3827 | ;; For modes that use comint-mode, comint-dynamic-complete-functions is the |
| 3828 | ;; hook to add completion functions to. Functions on this list should return |
| 3829 | ;; the completion data according to the documentation of |
| 3830 | ;; `completion-at-point-functions' |
| 3831 | \f |
| 3832 | |
| 3833 | (provide 'comint) |
| 3834 | |
| 3835 | ;;; comint.el ends here |