1 ;;; comint.el --- general command interpreter in a window stuff -*- lexical-binding: t -*-
3 ;; Copyright (C) 1988, 1990, 1992-2018 Free Software Foundation, Inc.
5 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
6 ;; Simon Marshall <simon@gnu.org>
7 ;; Maintainer: emacs-devel@gnu.org
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
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.).
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.
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.
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.
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.
57 ;; Brief Command Documentation:
58 ;;============================================================================
59 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
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
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
97 ;; comint-goto-process-mark Move point to where process-mark is.
98 ;; comint-set-process-mark Set process-mark to point.
100 ;; comint-mode-hook is the Comint mode hook. Basically for your keybindings.
105 (require 'ansi-color
)
106 (require 'regexp-opt
) ;For regexp-opt-charset.
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
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 ...
144 "General command interpreter in a window stuff."
147 (defgroup comint-completion nil
148 "Completion facilities in comint."
152 ;;; (defgroup comint-source nil
153 ;;; "Source finding facilities in comint."
154 ;;; :prefix "comint-"
157 (defvar comint-prompt-regexp
"^"
158 "Regexp to recognize prompts in the inferior process.
159 Defaults to \"^\", the null string at BOL.
161 This variable is only used if the variable
162 `comint-use-prompt-regexp' is non-nil.
165 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
166 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
167 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
169 shell: \"^[^#$%>\\n]*[#$%>] *\"
172 This is a good thing to set in mode hooks.")
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.
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:
187 \(add-hook \\='comint-mode-hook
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)))
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'."
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.
206 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
208 This is a good thing to set in mode hooks.")
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).
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'.
219 This variable is buffer-local."
220 :type
'(choice (const :tag
"off" nil
)
226 (defface comint-highlight-input
'((t (:weight bold
)))
227 "Face to use to highlight user input."
230 (defface comint-highlight-prompt
231 '((t :inherit minibuffer-prompt
))
232 "Face to use to highlight prompts."
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.
239 This variable is buffer-local."
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
)
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.
259 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
260 :type
'(choice (const :tag
"off" nil
)
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.
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
)
286 (defcustom comint-move-point-for-matching-input
'after-input
287 "Controls where to place point after matching input.
288 \\<comint-mode-map>This influences the commands \\[comint-previous-matching-input-from-input] and \\[comint-next-matching-input-from-input].
289 If `after-input', point will be positioned after the input typed
290 by the user, but before the rest of the history entry that has
291 been inserted. If `end-of-line', point will be positioned at the
292 end of the current logical (not visual) line after insertion."
294 :type
'(radio (const :tag
"Stay after input" after-input
)
295 (const :tag
"Move to end of line" end-of-line
))
298 (defvaralias 'comint-scroll-to-bottom-on-output
'comint-move-point-for-output
)
300 (defcustom comint-scroll-show-maximum-output t
301 "Controls how to scroll due to interpreter output.
302 This variable applies when point is at the end of the buffer
303 \(either because it was originally there, or because
304 `comint-move-point-for-output' said to move it there)
305 and output from the subprocess is inserted.
307 Non-nil means scroll so that the window is full of text
308 and point is on the last line. A value of nil
309 means don't do anything special--scroll normally.
311 See also the variable `comint-move-point-for-output' and the function
312 `comint-postoutput-scroll-to-bottom'.
313 This variable is buffer-local in all Comint buffers."
317 (defcustom comint-buffer-maximum-size
1024
318 "The maximum size in lines for Comint buffers.
319 Comint buffers are truncated from the top to be no greater than this number, if
320 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
324 (defcustom comint-input-ring-size
500
325 "Size of the input history ring in `comint-mode'."
330 (defvar comint-input-ring-separator
"\n"
331 "Separator between commands in the history file.")
333 (defvar comint-input-history-ignore
"^#"
334 "Regexp for history entries that should be ignored when Comint initializes.")
336 (defcustom comint-process-echoes nil
337 "If non-nil, assume that the subprocess echoes any input.
338 If so, delete one copy of the input so that only one copy eventually
339 appears in the buffer.
341 This variable is buffer-local."
345 ;; AIX puts the name of the person being su'd to in front of the prompt.
346 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
347 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
348 ;; ssh-add prints a prompt like `Enter passphrase: '.
349 ;; plink prints a prompt like `Passphrase for key "root@GNU.ORG": '.
350 ;; Ubuntu's sudo prompts like `[sudo] password for user:'
351 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
352 ;; Something called "perforce" uses "Enter password:".
353 ;; See M-x comint-testsuite--test-comint-password-prompt-regexp.
354 (defcustom comint-password-prompt-regexp
358 '("Enter" "enter" "Enter same" "enter same" "Enter the" "enter the"
359 "Old" "old" "New" "new" "'s" "login"
360 "Kerberos" "CVS" "UNIX" " SMB" "LDAP" "PEM" "SUDO"
361 "[sudo]" "Repeat" "Bad" "Retype")
364 "\\(?:" (regexp-opt password-word-equivalents
) "\\|Response\\)"
365 "\\(?:\\(?:, try\\)? *again\\| (empty for no passphrase)\\| (again)\\)?"
366 ;; "[[:alpha:]]" used to be "for", which fails to match non-English.
367 "\\(?: [[:alpha:]]+ .+\\)?[\\s  ]*[::៖][\\s  ]*\\'")
368 "Regexp matching prompts for passwords in the inferior process.
369 This is used by `comint-watch-for-password-prompt'."
374 ;; Here are the per-interpreter hooks.
375 (defvar comint-get-old-input
(function comint-get-old-input-default
)
376 "Function that returns old text in Comint mode.
377 This function is called when return is typed while the point is in old
378 text. It returns the text to be submitted as process input. The
379 default is `comint-get-old-input-default', which either grabs the
380 current input field or grabs the current line and strips off leading
381 text matching `comint-prompt-regexp', depending on the value of
382 `comint-use-prompt-regexp'.")
384 (defvar comint-dynamic-complete-functions
385 '(comint-c-a-p-replace-by-expanded-history comint-filename-completion
)
386 "List of functions called to perform completion.
387 Works like `completion-at-point-functions'.
388 See also `completion-at-point'.
390 This is a good thing to set in mode hooks.")
392 (defvar comint-input-filter
#'comint-nonblank-p
393 "Predicate for filtering additions to input history.
394 Takes one argument, the input. If non-nil, the input may be saved on the input
395 history list. Default is to save anything that isn't all whitespace.")
397 (defvar comint-input-filter-functions
'()
398 "Abnormal hook run before input is sent to the process.
399 These functions get one argument, a string containing the text to send.")
402 (defvar comint-output-filter-functions
'(ansi-color-process-output comint-postoutput-scroll-to-bottom comint-watch-for-password-prompt
)
403 "Functions to call after output is inserted into the buffer.
404 One possible function is `comint-postoutput-scroll-to-bottom'.
405 These functions get one argument, a string containing the text as originally
406 inserted. Note that this might not be the same as the buffer contents between
407 `comint-last-output-start' and the buffer's `process-mark', if other filter
408 functions have already modified the buffer.
410 See also `comint-preoutput-filter-functions'.
412 You can use `add-hook' to add functions to this list
413 either globally or locally.")
415 (defvar comint-input-sender-no-newline nil
416 "Non-nil directs the `comint-input-sender' function not to send a newline.")
418 (defvar comint-input-sender
(function comint-simple-send
)
419 "Function to actually send to PROCESS the STRING submitted by user.
420 Usually this is just `comint-simple-send', but if your mode needs to
421 massage the input string, put a different function here.
422 `comint-simple-send' just sends the string plus a newline.
423 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
424 This is called from the user command `comint-send-input'.")
426 (defcustom comint-eol-on-send t
427 "Non-nil means go to the end of the line before sending input.
428 See `comint-send-input'."
432 (define-obsolete-variable-alias 'comint-use-prompt-regexp-instead-of-fields
433 'comint-use-prompt-regexp
"22.1")
435 ;; Note: If it is decided to purge comint-prompt-regexp from the source
436 ;; entirely, searching for uses of this variable will help to identify
437 ;; places that need attention.
438 (defcustom comint-use-prompt-regexp nil
439 "If non-nil, use `comint-prompt-regexp' to recognize prompts.
440 If nil, then program output and user-input are given different `field'
441 properties, which Emacs commands can use to distinguish them (in
442 particular, common movement commands such as `beginning-of-line'
443 respect field boundaries in a natural way)."
447 (defcustom comint-mode-hook nil
448 "Hook run upon entry to `comint-mode'.
449 This is run before the process is cranked up."
453 (defcustom comint-exec-hook
'()
454 "Hook run each time a process is exec'd by `comint-exec'.
455 This is called after the process is cranked up. It is useful for things that
456 must be done each time a process is executed in a Comint mode buffer (e.g.,
457 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
458 executed once when the buffer is created."
462 (defcustom comint-terminfo-terminal
"dumb"
463 "Value to use for TERM when the system uses terminfo."
468 (defvar comint-mode-map
469 (let ((map (make-sparse-keymap)))
471 (define-key map
"\ep" 'comint-previous-input
)
472 (define-key map
"\en" 'comint-next-input
)
473 (define-key map
[C-up
] 'comint-previous-input
)
474 (define-key map
[C-down
] 'comint-next-input
)
475 (define-key map
"\er" 'comint-history-isearch-backward-regexp
)
476 (define-key map
[?\C-c ?\M-r
] 'comint-previous-matching-input-from-input
)
477 (define-key map
[?\C-c ?\M-s
] 'comint-next-matching-input-from-input
)
478 (define-key map
"\e\C-l" 'comint-show-output
)
479 (define-key map
"\C-m" 'comint-send-input
)
480 (define-key map
"\C-d" 'comint-delchar-or-maybe-eof
)
481 ;; The following two are standardly bound to delete-forward-char,
482 ;; but they should never do EOF, just delete.
483 (define-key map
[delete] 'delete-forward-char)
484 (define-key map [kp-delete] 'delete-forward-char)
485 (define-key map "\C-c " 'comint-accumulate)
486 (define-key map "\C-c\C-x" 'comint-get-next-from-history)
487 (define-key map "\C-c\C-a" 'comint-bol-or-process-mark)
488 (define-key map "\C-c\C-u" 'comint-kill-input)
489 (define-key map "\C-c\C-w" 'backward-kill-word)
490 (define-key map "\C-c\C-c" 'comint-interrupt-subjob)
491 (define-key map "\C-c\C-z" 'comint-stop-subjob)
492 (define-key map "\C-c\C-\\" 'comint-quit-subjob)
493 (define-key map "\C-c\C-m" 'comint-copy-old-input)
494 (define-key map "\C-c\C-o" 'comint-delete-output)
495 (define-key map "\C-c\M-o" 'comint-clear-buffer)
496 (define-key map "\C-c\C-r" 'comint-show-output)
497 (define-key map "\C-c\C-e" 'comint-show-maximum-output)
498 (define-key map "\C-c\C-l" 'comint-dynamic-list-input-ring)
499 (define-key map "\C-c\C-n" 'comint-next-prompt)
500 (define-key map "\C-c\C-p" 'comint-previous-prompt)
501 (define-key map "\C-c\C-d" 'comint-send-eof)
502 (define-key map "\C-c\C-s" 'comint-write-output)
503 (define-key map "\C-c." 'comint-insert-previous-argument)
505 (define-key map [mouse-2] 'comint-insert-input)
508 (define-key map [menu-bar completion]
509 (cons "Complete" (make-sparse-keymap "Complete")))
510 (define-key map [menu-bar completion complete-expand]
511 '("Expand File Name" . comint-replace-by-expanded-filename))
512 (define-key map [menu-bar completion complete-listing]
513 '("File Completion Listing" . comint-dynamic-list-filename-completions))
514 (define-key map [menu-bar completion complete-file]
515 '("Complete File Name" . comint-dynamic-complete-filename))
516 (define-key map [menu-bar completion complete]
517 '("Complete at Point" . completion-at-point))
519 (define-key map [menu-bar inout]
520 (cons "In/Out" (make-sparse-keymap "In/Out")))
521 (define-key map [menu-bar inout delete-output]
522 '("Delete Current Output Group" . comint-delete-output))
523 (define-key map [menu-bar inout append-output-to-file]
524 '("Append Current Output Group to File" . comint-append-output-to-file))
525 (define-key map [menu-bar inout write-output]
526 '("Write Current Output Group to File" . comint-write-output))
527 (define-key map [menu-bar inout next-prompt]
528 '("Forward Output Group" . comint-next-prompt))
529 (define-key map [menu-bar inout previous-prompt]
530 '("Backward Output Group" . comint-previous-prompt))
531 (define-key map [menu-bar inout show-maximum-output]
532 '("Show Maximum Output" . comint-show-maximum-output))
533 (define-key map [menu-bar inout show-output]
534 '("Show Current Output Group" . comint-show-output))
535 (define-key map [menu-bar inout kill-input]
536 '("Kill Current Input" . comint-kill-input))
537 (define-key map [menu-bar inout copy-input]
538 '("Copy Old Input" . comint-copy-old-input))
539 (define-key map [menu-bar inout history-isearch-backward-regexp]
540 '("Isearch Input Regexp Backward..." . comint-history-isearch-backward-regexp))
541 (define-key map [menu-bar inout history-isearch-backward]
542 '("Isearch Input String Backward..." . comint-history-isearch-backward))
543 (define-key map [menu-bar inout forward-matching-history]
544 '("Forward Matching Input..." . comint-forward-matching-input))
545 (define-key map [menu-bar inout backward-matching-history]
546 '("Backward Matching Input..." . comint-backward-matching-input))
547 (define-key map [menu-bar inout next-matching-history]
548 '("Next Matching Input..." . comint-next-matching-input))
549 (define-key map [menu-bar inout previous-matching-history]
550 '("Previous Matching Input..." . comint-previous-matching-input))
551 (define-key map [menu-bar inout next-matching-history-from-input]
552 '("Next Matching Current Input" . comint-next-matching-input-from-input))
553 (define-key map [menu-bar inout previous-matching-history-from-input]
554 '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
555 (define-key map [menu-bar inout next-history]
556 '("Next Input" . comint-next-input))
557 (define-key map [menu-bar inout previous-history]
558 '("Previous Input" . comint-previous-input))
559 (define-key map [menu-bar inout list-history]
560 '("List Input History" . comint-dynamic-list-input-ring))
561 (define-key map [menu-bar inout expand-history]
562 '("Expand History Before Point" . comint-replace-by-expanded-history))
564 (let ((signals-map (make-sparse-keymap "Signals")))
565 (define-key map [menu-bar signals] (cons "Signals" signals-map))
566 (define-key signals-map [eof] '("EOF" . comint-send-eof))
567 (define-key signals-map [kill] '("KILL" . comint-kill-subjob))
568 (define-key signals-map [quit] '("QUIT" . comint-quit-subjob))
569 (define-key signals-map [cont] '("CONT" . comint-continue-subjob))
570 (define-key signals-map [stop] '("STOP" . comint-stop-subjob))
571 (define-key signals-map [break] '("BREAK" . comint-interrupt-subjob)))
572 ;; Put them in the menu bar:
573 (setq menu-bar-final-items (append '(completion inout signals)
574 menu-bar-final-items))
577 ;; Fixme: Is this still relevant?
578 (defvar comint-ptyp t
579 "Non-nil if communications via pty; false if by pipe. Buffer local.
580 This is to work around a bug in Emacs process signaling.")
582 (defvar comint-input-ring nil)
583 (defvar comint-last-input-start nil)
584 (defvar comint-last-input-end nil)
585 (defvar comint-last-output-start nil)
586 (defvar comint-input-ring-index nil
587 "Index of last matched history element.")
588 (defvar comint-matching-input-from-input-string ""
589 "Input previously used to match input history.")
590 (defvar comint-save-input-ring-index nil
591 "Last input ring index which you copied.
592 This is to support the command \\[comint-get-next-from-history].")
594 (defvar comint-accum-marker nil
595 "Non-nil if you are accumulating input lines to send as input together.
596 The command \\[comint-accumulate] sets this.")
598 (defvar comint-stored-incomplete-input nil
599 "Stored input for history cycling.")
601 (put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
602 (put 'comint-input-ring 'permanent-local t)
603 (put 'comint-input-ring-index 'permanent-local t)
604 (put 'comint-save-input-ring-index 'permanent-local t)
605 (put 'comint-input-autoexpand 'permanent-local t)
606 (put 'comint-input-filter-functions 'permanent-local t)
607 (put 'comint-output-filter-functions 'permanent-local t)
608 (put 'comint-preoutput-filter-functions 'permanent-local t)
609 (put 'comint-scroll-to-bottom-on-input 'permanent-local t)
610 (put 'comint-move-point-for-output 'permanent-local t)
611 (put 'comint-scroll-show-maximum-output 'permanent-local t)
612 (put 'comint-ptyp 'permanent-local t)
614 (put 'comint-mode 'mode-class 'special)
616 (define-derived-mode comint-mode fundamental-mode "Comint"
617 "Major mode for interacting with an inferior interpreter.
618 Interpreter name is same as buffer name, sans the asterisks.
619 Return at end of buffer sends line as input.
620 Return not at end copies rest of line to end and sends it.
621 Setting variable `comint-eol-on-send' means jump to the end of the line
622 before submitting new input.
624 This mode is customized to create major modes such as Inferior Lisp
625 mode, Shell mode, etc. This can be done by setting the hooks
626 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
627 and `comint-get-old-input' to appropriate functions, and the variable
628 `comint-prompt-regexp' to the appropriate regular expression.
630 The mode maintains an input history of size `comint-input-ring-size'.
631 You can access this with the commands \\[comint-next-input],
632 \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
633 Input ring history expansion can be achieved with the commands
634 \\[comint-replace-by-expanded-history] or \\[comint-magic-space].
635 Input ring expansion is controlled by the variable `comint-input-autoexpand',
636 and addition is controlled by the variable `comint-input-ignoredups'.
638 Commands with no default key bindings include `send-invisible',
639 `completion-at-point', `comint-dynamic-list-filename-completions', and
640 `comint-magic-space'.
642 Input to, and output from, the subprocess can cause the window to scroll to
643 the end of the buffer. See variables `comint-output-filter-functions',
644 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
645 and `comint-move-point-for-output'.
647 If you accidentally suspend your process, use \\[comint-continue-subjob]
652 Entry to this mode runs the hooks on `comint-mode-hook'."
653 (setq mode-line-process '(":%s"))
654 (setq-local window-point-insertion-type t)
655 (setq-local comint-last-input-start (point-min-marker))
656 (setq-local comint-last-input-end (point-min-marker))
657 (setq-local comint-last-output-start (make-marker))
658 (make-local-variable 'comint-last-prompt)
659 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
660 (make-local-variable 'comint-input-ring-size) ; ...to global val.
661 (make-local-variable 'comint-input-ring)
662 (make-local-variable 'comint-input-ring-file-name)
663 (or (and (boundp 'comint-input-ring) comint-input-ring)
664 (setq comint-input-ring (make-ring comint-input-ring-size)))
665 (make-local-variable 'comint-input-ring-index)
666 (make-local-variable 'comint-save-input-ring-index)
667 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
668 (setq comint-input-ring-index nil))
669 (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
670 (setq comint-save-input-ring-index nil))
671 (make-local-variable 'comint-matching-input-from-input-string)
672 (make-local-variable 'comint-input-autoexpand)
673 (make-local-variable 'comint-input-ignoredups)
674 (make-local-variable 'comint-delimiter-argument-list)
675 (make-local-variable 'comint-completion-fignore)
676 (make-local-variable 'comint-get-old-input)
677 (make-local-variable 'comint-input-filter)
678 (make-local-variable 'comint-input-sender)
679 (make-local-variable 'comint-eol-on-send)
680 (make-local-variable 'comint-scroll-to-bottom-on-input)
681 (make-local-variable 'comint-move-point-for-output)
682 (make-local-variable 'comint-scroll-show-maximum-output)
683 (make-local-variable 'comint-stored-incomplete-input)
684 ;; Following disabled because it seems to break the case when
685 ;; comint-scroll-show-maximum-output is nil, and no-one can remember
686 ;; what the original problem was. If there are problems with point
687 ;; not going to the end, consider re-enabling this.
688 ;; https://lists.gnu.org/r/emacs-devel/2007-08/msg00827.html
690 ;; This makes it really work to keep point at the bottom.
691 ;; (make-local-variable 'scroll-conservatively)
692 ;; (setq scroll-conservatively 10000)
693 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
694 (make-local-variable 'comint-ptyp)
695 (make-local-variable 'comint-process-echoes)
696 (make-local-variable 'comint-file-name-chars)
697 (make-local-variable 'comint-file-name-quote-list)
698 ;; dir tracking on remote files
699 (setq-local comint-file-name-prefix
700 (or (file-remote-p default-directory) ""))
701 (setq-local comint-accum-marker (make-marker))
702 (setq-local font-lock-defaults '(nil t))
703 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
704 (add-hook 'isearch-mode-hook 'comint-history-isearch-setup nil t)
705 (add-hook 'completion-at-point-functions 'comint-completion-at-point nil t)
706 ;; This behavior is not useful in comint buffers, and is annoying
707 (setq-local next-line-add-newlines nil))
709 (defun comint-check-proc (buffer)
710 "Return non-nil if there is a living process associated w/buffer BUFFER.
711 Living means the status is `open', `run', or `stop'.
712 BUFFER can be either a buffer or the name of one."
713 (let ((proc (get-buffer-process buffer)))
714 (and proc (memq (process-status proc) '(open run stop)))))
717 (defun make-comint-in-buffer (name buffer program &optional startfile &rest switches)
718 "Make a Comint process NAME in BUFFER, running PROGRAM.
719 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
720 If there is a running process in BUFFER, it is not restarted.
722 PROGRAM should be one of the following:
723 - a string, denoting an executable program to create via
725 - a cons pair of the form (HOST . SERVICE), denoting a TCP
726 connection to be opened via `open-network-stream'
727 - nil, denoting a newly-allocated pty.
729 Optional fourth arg STARTFILE is the name of a file, whose
730 contents are sent to the process as its initial input.
732 If PROGRAM is a string, any more args are arguments to PROGRAM.
734 Return the (possibly newly created) process buffer."
735 (or (fboundp 'start-file-process)
736 (error "Multi-processing is not supported for this system"))
737 (setq buffer (get-buffer-create (or buffer (concat "*" name "*"))))
738 ;; If no process, or nuked process, crank up a new one and put buffer in
739 ;; comint mode. Otherwise, leave buffer and existing process alone.
740 (unless (comint-check-proc buffer)
741 (with-current-buffer buffer
742 (unless (derived-mode-p 'comint-mode)
743 (comint-mode))) ; Install local vars, mode, keymap, ...
744 (comint-exec buffer name program startfile switches))
748 (defun make-comint (name program &optional startfile &rest switches)
749 "Make a Comint process NAME in a buffer, running PROGRAM.
750 The name of the buffer is made by surrounding NAME with `*'s.
751 PROGRAM should be either a string denoting an executable program to create
752 via `start-file-process', or a cons pair of the form (HOST . SERVICE) denoting
753 a TCP connection to be opened via `open-network-stream'. If there is already
754 a running process in that buffer, it is not restarted. Optional third arg
755 STARTFILE is the name of a file, whose contents are sent to the
756 process as its initial input.
758 If PROGRAM is a string, any more args are arguments to PROGRAM.
760 Returns the (possibly newly created) process buffer."
761 (apply #'make-comint-in-buffer name nil program startfile switches))
764 (defun comint-run (program)
765 "Run PROGRAM in a Comint buffer and switch to it.
766 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
767 The file name is used to make a symbol name, such as `comint-sh-hook', and any
768 hooks on this symbol are run in the buffer.
769 See `make-comint' and `comint-exec'."
770 (declare (interactive-only make-comint))
771 (interactive "sRun program: ")
772 (let ((name (file-name-nondirectory program)))
773 (switch-to-buffer (make-comint name program))
774 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
776 (defun comint-exec (buffer name command startfile switches)
777 "Start up a process named NAME in buffer BUFFER for Comint modes.
778 Runs the given COMMAND with SWITCHES, and initial input from STARTFILE.
780 COMMAND should be one of the following:
781 - a string, denoting an executable program to create via
783 - a cons pair of the form (HOST . SERVICE), denoting a TCP
784 connection to be opened via `open-network-stream'
785 - nil, denoting a newly-allocated pty.
787 This function blasts any old process running in the buffer, and
788 does not set the buffer mode. You can use this to cheaply run a
789 series of processes in the same Comint buffer. The hook
790 `comint-exec-hook' is run after each exec."
791 (with-current-buffer buffer
792 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
793 (if proc (delete-process proc)))
794 ;; Crank up a new process
797 (open-network-stream name buffer (car command) (cdr command))
798 (comint-exec-1 name buffer command switches))))
799 (set-process-filter proc 'comint-output-filter)
800 (setq-local comint-ptyp process-connection-type) ; t if pty, nil if pipe.
801 ;; Jump to the end, and set the process mark.
802 (goto-char (point-max))
803 (set-marker (process-mark proc) (point))
804 ;; Feed it the startfile.
806 ;;This is guaranteed to wait long enough
807 ;;but has bad results if the comint does not prompt at all
808 ;; (while (= size (buffer-size))
810 ;;I hope 1 second is enough!
812 (goto-char (point-max))
813 (insert-file-contents startfile)
814 (setq startfile (buffer-substring (point) (point-max)))
815 (delete-region (point) (point-max))
816 (comint-send-string proc startfile)))
817 (run-hooks 'comint-exec-hook)
820 ;; This auxiliary function cranks up the process for comint-exec in
821 ;; the appropriate environment.
823 (defun comint-exec-1 (name buffer command switches)
824 (let ((process-environment
826 (comint-term-environment)
827 (list (format "INSIDE_EMACS=%s,comint" emacs-version))
828 process-environment))
830 (if (file-accessible-directory-p default-directory)
833 proc decoding encoding changed)
834 (let ((exec-path (if (and command (file-name-directory command))
835 ;; If the command has slashes, make sure we
836 ;; first look relative to the current directory.
837 (cons default-directory exec-path) exec-path)))
838 (setq proc (apply 'start-file-process name buffer command switches)))
839 ;; Some file name handler cannot start a process, fe ange-ftp.
840 (unless (processp proc) (error "No process started"))
841 (let ((coding-systems (process-coding-system proc)))
842 (setq decoding (car coding-systems)
843 encoding (cdr coding-systems)))
844 ;; Even if start-file-process left the coding system for encoding data
845 ;; sent from the process undecided, we had better use the same one
846 ;; as what we use for decoding. But, we should suppress EOL
848 (if (and decoding (not encoding))
849 (setq encoding (coding-system-change-eol-conversion decoding 'unix)
852 (set-process-coding-system proc decoding encoding))
855 (defun comint-term-environment ()
856 "Return an environment variable list for terminal configuration."
857 ;; If using termcap, we specify `emacs' as the terminal type
858 ;; because that lets us specify a width.
859 ;; If using terminfo, we default to `dumb' because that is
860 ;; a defined terminal type. `emacs' is not a defined terminal type
861 ;; and there is no way for us to define it here.
862 ;; Some programs that use terminfo get very confused
863 ;; if TERM is not a valid terminal type.
864 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
865 (list (format "TERM=%s" comint-terminfo-terminal)
867 (format "COLUMNS=%d" (window-width)))
869 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width)))))
871 (defun comint-nonblank-p (str)
872 "Return non-nil if STR contains non-whitespace syntax."
873 (not (string-match "\\`\\s *\\'" str)))
875 (defun comint-insert-input (event)
876 "In a Comint buffer, set the current input to the previous input at point.
877 If there is no previous input at point, run the command specified
878 by the global keymap (usually `mouse-yank-at-click')."
880 ;; Don't set the mouse here, since it may otherwise change the behavior
881 ;; of the command on which we fallback if there's no field at point.
882 ;; (mouse-set-point event)
883 (let ((pos (posn-point (event-end event)))
885 (with-selected-window (posn-window (event-end event))
886 ;; If pos is at the very end of a field, the mouse-click was
887 ;; probably outside (to the right) of the field.
888 (and (< pos (field-end pos))
889 (< (field-end pos) (point-max))
890 (progn (setq field (field-at-pos pos))
891 (setq input (field-string-no-properties pos)))))
892 (if (or (null input) (null comint-accum-marker) field)
893 ;; Fall back to the global definition if (i) the selected
894 ;; buffer is not a comint buffer (which can happen if a
895 ;; non-comint window was selected and we clicked in a comint
896 ;; window), or (ii) there is no input at POS.
897 (let* ((keys (this-command-keys))
898 (last-key (and (vectorp keys) (aref keys (1- (length keys)))))
899 (fun (and last-key (lookup-key global-map (vector last-key)))))
900 (and fun (not (eq fun 'comint-insert-input))
901 (call-interactively fun)))
902 (with-selected-window (posn-window (event-end event))
903 ;; Otherwise, insert the previous input.
904 (goto-char (point-max))
905 ;; First delete any old unsent input at the end
907 (or (marker-position comint-accum-marker)
908 (process-mark (get-buffer-process (current-buffer))))
910 ;; Insert the input at point
913 ;; Input history processing in a buffer
914 ;; ===========================================================================
915 ;; Useful input history functions, courtesy of the Ergo group.
918 ;; comint-dynamic-list-input-ring List history in help buffer.
919 ;; comint-previous-input Previous input...
920 ;; comint-previous-matching-input ...matching a string.
921 ;; comint-previous-matching-input-from-input ... matching the current input.
922 ;; comint-next-input Next input...
923 ;; comint-next-matching-input ...matching a string.
924 ;; comint-next-matching-input-from-input ... matching the current input.
925 ;; comint-backward-matching-input Backwards input...
926 ;; comint-forward-matching-input ...matching a string.
927 ;; comint-replace-by-expanded-history Expand history at point;
928 ;; replace with expanded history.
929 ;; comint-magic-space Expand history and insert space.
932 ;; comint-read-input-ring Read into comint-input-ring...
933 ;; comint-write-input-ring Write to comint-input-ring-file-name.
934 ;; comint-replace-by-expanded-history-before-point Workhorse function.
936 (defun comint-read-input-ring (&optional silent)
937 "Set the buffer's `comint-input-ring' from a history file.
938 The name of the file is given by the variable `comint-input-ring-file-name'.
939 The history ring is of size `comint-input-ring-size', regardless of file size.
940 If `comint-input-ring-file-name' is nil this function does nothing.
942 If the optional argument SILENT is non-nil, we say nothing about a
943 failure to read the history file.
945 This function is useful for major mode commands and mode hooks.
947 The commands stored in the history file are separated by the
948 `comint-input-ring-separator', and entries that match
949 `comint-input-history-ignore' are ignored. The most recent command
952 See also `comint-input-ignoredups' and `comint-write-input-ring'."
953 (cond ((or (null comint-input-ring-file-name)
954 (equal comint-input-ring-file-name ""))
956 ((not (file-readable-p comint-input-ring-file-name))
958 (message "Cannot read history file %s"
959 comint-input-ring-file-name)))
961 (let* ((file comint-input-ring-file-name)
963 ;; Some users set HISTSIZE or `comint-input-ring-size'
964 ;; to huge numbers. Don't allocate a huge ring right
965 ;; away; there might not be that much history.
966 (ring-size (min 1500 comint-input-ring-size))
967 (ring (make-ring ring-size)))
969 (insert-file-contents file)
970 ;; Save restriction in case file is already visited...
971 ;; Watch for those date stamps in history files!
972 (goto-char (point-max))
973 (let (start end history)
974 (while (and (< count comint-input-ring-size)
975 (re-search-backward comint-input-ring-separator
977 (setq end (match-beginning 0)))
979 (if (re-search-backward comint-input-ring-separator
983 (setq history (buffer-substring start end))
985 (when (and (not (string-match comint-input-history-ignore
987 (or (null comint-input-ignoredups)
989 (not (string-equal (ring-ref ring 0)
991 (when (= count ring-size)
992 (ring-extend ring (min (- comint-input-ring-size ring-size)
994 (setq ring-size (ring-size ring)))
995 (ring-insert-at-beginning ring history)
996 (setq count (1+ count))))))
997 (setq comint-input-ring ring
998 comint-input-ring-index nil)))))
1000 (defun comint-write-input-ring ()
1001 "Writes the buffer's `comint-input-ring' to a history file.
1002 The name of the file is given by the variable `comint-input-ring-file-name'.
1003 The original contents of the file are lost if `comint-input-ring' is not empty.
1004 If `comint-input-ring-file-name' is nil this function does nothing.
1006 Useful within process sentinels.
1008 See also `comint-read-input-ring'."
1009 (cond ((or (null comint-input-ring-file-name)
1010 (equal comint-input-ring-file-name "")
1011 (null comint-input-ring) (ring-empty-p comint-input-ring))
1013 ((not (file-writable-p comint-input-ring-file-name))
1014 (message "Cannot write history file %s" comint-input-ring-file-name))
1016 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
1017 (ring comint-input-ring)
1018 (file comint-input-ring-file-name)
1019 (index (ring-length ring)))
1020 ;; Write it all out into a buffer first. Much faster, but messier,
1021 ;; than writing it one line at a time.
1022 (with-current-buffer history-buf
1025 (setq index (1- index))
1026 (insert (ring-ref ring index) comint-input-ring-separator))
1027 (write-region (buffer-string) nil file nil 'no-message)
1028 (kill-buffer nil))))))
1031 (defvar comint-dynamic-list-input-ring-window-conf)
1033 (defun comint-dynamic-list-input-ring-select ()
1034 "Choose the input history entry that point is in or next to."
1036 (let ((buffer completion-reference-buffer)
1038 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
1039 (setq end (point) beg (1+ (point))))
1040 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
1041 (setq end (1- (point)) beg (point)))
1043 (error "No history entry here"))
1044 (setq beg (previous-single-property-change beg 'mouse-face))
1045 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
1046 (setq completion (buffer-substring beg end))
1047 (set-window-configuration comint-dynamic-list-input-ring-window-conf)
1048 (choose-completion-string completion buffer)))
1050 (defun comint-dynamic-list-input-ring ()
1051 "Display a list of recent inputs entered into the current buffer."
1053 (if (or (not (ring-p comint-input-ring))
1054 (ring-empty-p comint-input-ring))
1055 (message "No history")
1057 (history-buffer " *Input History*")
1058 (conf (current-window-configuration)))
1059 ;; We have to build up a list ourselves from the ring vector.
1060 (dotimes (index (ring-length comint-input-ring))
1061 (push (ring-ref comint-input-ring index) history))
1062 ;; Show them most-recent-first.
1063 (setq history (nreverse history))
1064 ;; Change "completion" to "history reference"
1065 ;; to make the display accurate.
1066 (with-output-to-temp-buffer history-buffer
1067 (display-completion-list history)
1068 (set-buffer history-buffer)
1069 (let ((keymap (make-sparse-keymap)))
1070 (set-keymap-parent keymap (current-local-map))
1071 (define-key keymap "\C-m" 'comint-dynamic-list-input-ring-select)
1072 (use-local-map keymap))
1074 (while (search-backward "completion" nil 'move)
1075 (replace-match "history reference")))
1077 (message "Hit space to flush")
1078 (setq comint-dynamic-list-input-ring-window-conf conf)
1079 (let ((ch (read-event)))
1081 (set-window-configuration conf)
1082 (push ch unread-command-events))))))
1085 (defun comint-regexp-arg (prompt)
1086 "Return list of regexp and prefix arg using PROMPT."
1087 (let* (;; Don't clobber this.
1088 (last-command last-command)
1089 (regexp (read-from-minibuffer prompt nil nil nil
1090 'minibuffer-history-search-history)))
1091 ;; If the user didn't enter anything, nothing is added to m-h-s-h.
1092 ;; Use the previous search regexp, if there is one.
1093 (list (if (string-equal regexp "")
1094 (or (car minibuffer-history-search-history)
1097 (prefix-numeric-value current-prefix-arg))))
1099 (defun comint-search-arg (arg)
1100 ;; First make sure there is a ring and that we are after the process mark
1101 (cond ((not (comint-after-pmark-p))
1102 (user-error "Not at command line"))
1103 ((or (null comint-input-ring)
1104 (ring-empty-p comint-input-ring))
1105 (user-error "Empty input ring"))
1107 ;; arg of zero resets search from beginning, and uses arg of 1
1108 (setq comint-input-ring-index nil)
1113 (defun comint-restore-input ()
1114 "Restore unfinished input."
1116 (when comint-input-ring-index
1117 (comint-delete-input)
1118 (when (> (length comint-stored-incomplete-input) 0)
1119 (insert comint-stored-incomplete-input)
1120 (message "Input restored"))
1121 (setq comint-input-ring-index nil)))
1123 (defun comint-search-start (arg)
1124 "Index to start a directional search, starting at `comint-input-ring-index'."
1125 (if comint-input-ring-index
1126 ;; If a search is running, offset by 1 in direction of arg
1127 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
1128 (ring-length comint-input-ring))
1129 ;; For a new search, start from beginning or end, as appropriate
1131 0 ; First elt for forward search
1132 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
1134 (defun comint-previous-input-string (arg)
1135 "Return the string ARG places along the input ring.
1136 Moves relative to `comint-input-ring-index'."
1137 (ring-ref comint-input-ring (if comint-input-ring-index
1138 (mod (+ arg comint-input-ring-index)
1139 (ring-length comint-input-ring))
1142 (defun comint-previous-input (arg)
1143 "Cycle backwards through input history, saving input."
1145 (if (and comint-input-ring-index
1146 (or ;; leaving the "end" of the ring
1147 (and (< arg 0) ; going down
1148 (eq comint-input-ring-index 0))
1149 (and (> arg 0) ; going up
1150 (eq comint-input-ring-index
1151 (1- (ring-length comint-input-ring)))))
1152 comint-stored-incomplete-input)
1153 (comint-restore-input)
1154 (comint-previous-matching-input "." arg)))
1156 (defun comint-next-input (arg)
1157 "Cycle forwards through input history."
1159 (comint-previous-input (- arg)))
1161 (defun comint-previous-matching-input-string (regexp arg)
1162 "Return the string matching REGEXP ARG places along the input ring.
1163 Moves relative to `comint-input-ring-index'."
1164 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
1165 (if pos (ring-ref comint-input-ring pos))))
1167 (defun comint-previous-matching-input-string-position (regexp arg &optional start)
1168 "Return the index matching REGEXP ARG places along the input ring.
1169 Moves relative to START, or `comint-input-ring-index'."
1170 (if (or (not (ring-p comint-input-ring))
1171 (ring-empty-p comint-input-ring))
1172 (user-error "No history"))
1173 (let* ((len (ring-length comint-input-ring))
1174 (motion (if (> arg 0) 1 -1))
1175 (n (mod (- (or start (comint-search-start arg)) motion) len))
1176 (tried-each-ring-item nil)
1178 ;; Do the whole search as many times as the argument says.
1179 (while (and (/= arg 0) (not tried-each-ring-item))
1182 n (mod (+ n motion) len))
1183 ;; If we haven't reached a match, step some more.
1184 (while (and (< n len) (not tried-each-ring-item)
1185 (not (string-match regexp (ring-ref comint-input-ring n))))
1186 (setq n (mod (+ n motion) len)
1187 ;; If we have gone all the way around in this search.
1188 tried-each-ring-item (= n prev)))
1189 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1190 ;; Now that we know which ring element to use, if we found it, return that.
1191 (if (string-match regexp (ring-ref comint-input-ring n))
1194 (defun comint-delete-input ()
1195 "Delete all input between accumulation or process mark and point."
1197 ;; Can't use kill-region as it sets this-command
1198 (or (marker-position comint-accum-marker)
1199 (process-mark (get-buffer-process (current-buffer))))
1202 (defun comint-previous-matching-input (regexp n)
1203 "Search backwards through input history for match for REGEXP.
1204 \(Previous history elements are earlier commands.)
1205 With prefix argument N, search for Nth previous match.
1206 If N is negative, find the next or Nth next match."
1207 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1208 (setq n (comint-search-arg n))
1209 (let ((pos (comint-previous-matching-input-string-position regexp n)))
1210 ;; Has a match been found?
1212 (user-error "Not found")
1213 ;; If leaving the edit line, save partial input
1214 (if (null comint-input-ring-index) ;not yet on ring
1215 (setq comint-stored-incomplete-input
1216 (funcall comint-get-old-input)))
1217 (setq comint-input-ring-index pos)
1218 (unless isearch-mode
1219 (let ((message-log-max nil)) ; Do not write to *Messages*.
1220 (message "History item: %d" (1+ pos))))
1221 (comint-delete-input)
1222 (insert (ring-ref comint-input-ring pos)))))
1224 (defun comint-next-matching-input (regexp n)
1225 "Search forwards through input history for match for REGEXP.
1226 \(Later history elements are more recent commands.)
1227 With prefix argument N, search for Nth following match.
1228 If N is negative, find the previous or Nth previous match."
1229 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1230 (comint-previous-matching-input regexp (- n)))
1232 (defun comint-previous-matching-input-from-input (n)
1233 "Search backwards through input history for match for current input.
1234 \(Previous history elements are earlier commands.)
1235 With prefix argument N, search for Nth previous match.
1236 If N is negative, search forwards for the -Nth following match."
1238 (let ((opoint (point)))
1239 (unless (memq last-command '(comint-previous-matching-input-from-input
1240 comint-next-matching-input-from-input))
1241 ;; Starting a new search
1242 (setq comint-matching-input-from-input-string
1244 (or (marker-position comint-accum-marker)
1245 (process-mark (get-buffer-process (current-buffer))))
1247 comint-input-ring-index nil))
1248 (comint-previous-matching-input
1249 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1251 (when (eq comint-move-point-for-matching-input 'after-input)
1252 (goto-char opoint))))
1254 (defun comint-next-matching-input-from-input (n)
1255 "Search forwards through input history for match for current input.
1256 \(Following history elements are more recent commands.)
1257 With prefix argument N, search for Nth following match.
1258 If N is negative, search backwards for the -Nth previous match."
1260 (comint-previous-matching-input-from-input (- n)))
1263 (defun comint-replace-by-expanded-history (&optional silent start)
1264 "Expand input command history references before point.
1265 Expansion is dependent on the value of `comint-input-autoexpand'.
1267 This function depends on the buffer's idea of the input history, which may not
1268 match the command interpreter's idea, assuming it has one.
1270 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1271 cannot know the interpreter's idea of input line numbers, assuming it has one,
1272 it cannot expand absolute input line number references.
1274 If the optional argument SILENT is non-nil, never complain
1275 even if history reference seems erroneous.
1277 If the optional argument START is non-nil, that specifies the
1278 start of the text to scan for history references, rather
1279 than the logical beginning of line.
1281 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1283 Returns t if successful."
1285 (let ((f (comint-c-a-p-replace-by-expanded-history silent start)))
1286 (if f (funcall f))))
1288 (defun comint-c-a-p-replace-by-expanded-history (&optional silent start)
1289 "Expand input command history at point.
1290 For use on `completion-at-point-functions'."
1291 (if (and comint-input-autoexpand
1292 (if comint-use-prompt-regexp
1293 ;; Use comint-prompt-regexp
1296 (looking-at (concat comint-prompt-regexp "!\\|\\^")))
1297 ;; Use input fields. User input that hasn't been entered
1298 ;; yet, at the end of the buffer, has a nil `field' property.
1299 (and (null (get-char-property (point) 'field))
1300 (string-match "!\\|^\\^" (field-string))))
1302 (comint-replace-by-expanded-history-before-point
1303 silent start 'dry-run)))
1305 ;; Looks like there might be history references in the command.
1306 (let ((previous-modified-tick (buffer-modified-tick)))
1307 (comint-replace-by-expanded-history-before-point silent start)
1308 (/= previous-modified-tick (buffer-modified-tick))))))
1311 (defun comint-replace-by-expanded-history-before-point
1312 (silent &optional start dry-run)
1313 "Expand directory stack reference before point.
1314 See `comint-replace-by-expanded-history'. Returns t if successful.
1316 If the optional argument START is non-nil, that specifies the
1317 start of the text to scan for history references, rather
1318 than the logical beginning of line.
1320 If DRY-RUN is non-nil, throw to DRY-RUN before performing any
1321 actual side-effect."
1323 (let ((toend (- (line-end-position) (point)))
1324 (start (or start (comint-line-beginning-position))))
1327 (skip-chars-forward "^!^" (- (line-end-position) toend))
1328 (< (point) (- (line-end-position) toend)))
1329 ;; This seems a bit complex. We look for references such as !!, !-num,
1330 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1331 ;; If that wasn't enough, the plings can be suffixed with argument
1332 ;; range specifiers.
1333 ;; Argument ranges are complex too, so we hive off the input line,
1334 ;; referenced with plings, with the range string to `comint-args'.
1335 (setq comint-input-ring-index nil)
1336 (cond ((or (= (preceding-char) ?\\)
1337 (comint-within-quotes start (point)))
1338 ;; The history is quoted, or we're in quotes.
1339 (goto-char (1+ (point))))
1340 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1341 ;; We cannot know the interpreter's idea of input line numbers.
1342 (if dry-run (throw dry-run 'message))
1343 (goto-char (match-end 0))
1344 (message "Absolute reference cannot be expanded"))
1345 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1346 ;; Just a number of args from `number' lines backward.
1347 (if dry-run (throw dry-run 'history))
1348 (let ((number (1- (string-to-number
1349 (buffer-substring (match-beginning 1)
1351 (if (<= number (ring-length comint-input-ring))
1354 (comint-args (comint-previous-input-string number)
1355 (match-beginning 2) (match-end 2))
1357 (setq comint-input-ring-index number)
1358 (message "History item: %d" (1+ number)))
1359 (goto-char (match-end 0))
1360 (message "Relative reference exceeds input history size"))))
1361 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1362 ;; Just a number of args from the previous input line.
1363 (if dry-run (throw dry-run 'expand))
1364 (replace-match (comint-args (comint-previous-input-string 0)
1365 (match-beginning 1) (match-end 1))
1367 (message "History item: previous"))
1369 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1370 ;; Most recent input starting with or containing (possibly
1371 ;; protected) string, maybe just a number of args. Phew.
1372 (if dry-run (throw dry-run 'expand))
1373 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1374 (mb2 (match-beginning 2)) (me2 (match-end 2))
1375 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1376 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1377 (pos (save-match-data
1378 (comint-previous-matching-input-string-position
1379 (concat pref (regexp-quote exp)) 1))))
1382 (goto-char (match-end 0))
1384 (progn (message "Not found")
1386 (setq comint-input-ring-index pos)
1388 (comint-args (ring-ref comint-input-ring pos)
1389 (match-beginning 4) (match-end 4))
1391 (message "History item: %d" (1+ pos)))))
1392 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1393 ;; Quick substitution on the previous input line.
1394 (if dry-run (throw dry-run 'expand))
1395 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1396 (new (buffer-substring (match-beginning 2) (match-end 2)))
1398 (replace-match (comint-previous-input-string 0) t t)
1400 (goto-char (match-beginning 0))
1401 (if (not (search-forward old pos t))
1403 (user-error "Not found"))
1404 (replace-match new t t)
1405 (message "History item: substituted"))))
1407 (forward-char 1)))))
1411 (defun comint-magic-space (arg)
1412 "Expand input history references before point and insert ARG spaces.
1413 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1415 (comint-replace-by-expanded-history)
1416 (self-insert-command arg))
1418 ;; Isearch in comint input history
1420 (defcustom comint-history-isearch nil
1421 "Non-nil to Isearch in input history only, not in comint buffer output.
1422 If t, usual Isearch keys like `C-r' and `C-M-r' in comint mode search
1423 in the input history.
1424 If `dwim', Isearch keys search in the input history only when initial
1425 point position is at the comint command line. When starting Isearch
1426 from other parts of the comint buffer, they search in the comint buffer.
1427 If nil, Isearch operates on the whole comint buffer."
1428 :type '(choice (const :tag "Don't search in input history" nil)
1429 (const :tag "When point is on command line initially, search history" dwim)
1430 (const :tag "Always search in input history" t))
1434 (defun comint-history-isearch-backward ()
1435 "Search for a string backward in input history using Isearch."
1437 (setq comint-history-isearch t)
1438 (isearch-backward nil t))
1440 (defun comint-history-isearch-backward-regexp ()
1441 "Search for a regular expression backward in input history using Isearch."
1443 (setq comint-history-isearch t)
1444 (isearch-backward-regexp nil t))
1446 (defvar-local comint-history-isearch-message-overlay nil)
1448 (defun comint-history-isearch-setup ()
1449 "Set up a comint for using Isearch to search the input history.
1450 Intended to be added to `isearch-mode-hook' in `comint-mode'."
1451 (when (or (eq comint-history-isearch t)
1452 (and (eq comint-history-isearch 'dwim)
1453 ;; Point is at command line.
1454 (comint-after-pmark-p)))
1455 (setq isearch-message-prefix-add "history ")
1456 (setq-local isearch-search-fun-function
1457 #'comint-history-isearch-search)
1458 (setq-local isearch-message-function
1459 #'comint-history-isearch-message)
1460 (setq-local isearch-wrap-function
1461 #'comint-history-isearch-wrap)
1462 (setq-local isearch-push-state-function
1463 #'comint-history-isearch-push-state)
1464 (add-hook 'isearch-mode-end-hook 'comint-history-isearch-end nil t)))
1466 (defun comint-history-isearch-end ()
1467 "Clean up the comint after terminating Isearch in comint."
1468 (if comint-history-isearch-message-overlay
1469 (delete-overlay comint-history-isearch-message-overlay))
1470 (setq isearch-message-prefix-add nil)
1471 (setq isearch-search-fun-function 'isearch-search-fun-default)
1472 (setq isearch-message-function nil)
1473 (setq isearch-wrap-function nil)
1474 (setq isearch-push-state-function nil)
1475 (remove-hook 'isearch-mode-end-hook 'comint-history-isearch-end t)
1476 (unless isearch-suspended
1477 (custom-reevaluate-setting 'comint-history-isearch)))
1479 (defun comint-goto-input (pos)
1480 "Put input history item of the absolute history position POS."
1481 ;; If leaving the edit line, save partial unfinished input.
1482 (if (null comint-input-ring-index)
1483 (setq comint-stored-incomplete-input
1484 (funcall comint-get-old-input)))
1485 (setq comint-input-ring-index pos)
1486 (comint-delete-input)
1487 (if (and pos (not (ring-empty-p comint-input-ring)))
1488 (insert (ring-ref comint-input-ring pos))
1489 ;; Restore partial unfinished input.
1490 (when (> (length comint-stored-incomplete-input) 0)
1491 (insert comint-stored-incomplete-input))))
1493 (defun comint-history-isearch-search ()
1494 "Return the proper search function, for Isearch in input history."
1495 (lambda (string bound noerror)
1497 ;; Use standard functions to search within comint text
1498 (isearch-search-fun-default))
1500 ;; Avoid lazy-highlighting matches in the comint prompt and in the
1501 ;; output when searching forward. Lazy-highlight calls this lambda
1502 ;; with the bound arg, so skip the prompt and the output.
1503 (if (and bound isearch-forward (not (comint-after-pmark-p)))
1504 (goto-char (process-mark (get-buffer-process (current-buffer)))))
1506 ;; 1. First try searching in the initial comint text
1507 (funcall search-fun string
1508 (if isearch-forward bound (comint-line-beginning-position))
1510 ;; 2. If the above search fails, start putting next/prev history
1511 ;; elements in the comint successively, and search the string
1512 ;; in them. Do this only when bound is nil (i.e. not while
1513 ;; lazy-highlighting search strings in the current comint text).
1518 (cond (isearch-forward
1519 ;; Signal an error here explicitly, because
1520 ;; `comint-next-input' doesn't signal an error.
1521 (when (null comint-input-ring-index)
1522 (error "End of history; no next item"))
1523 (comint-next-input 1)
1524 (goto-char (comint-line-beginning-position)))
1526 ;; Signal an error here explicitly, because
1527 ;; `comint-previous-input' doesn't signal an error.
1528 (when (eq comint-input-ring-index
1529 (1- (ring-length comint-input-ring)))
1530 (error "Beginning of history; no preceding item"))
1531 (comint-previous-input 1)
1532 (goto-char (point-max))))
1533 (setq isearch-barrier (point) isearch-opoint (point))
1534 ;; After putting the next/prev history element, search
1535 ;; the string in them again, until comint-next-input
1536 ;; or comint-previous-input raises an error at the
1537 ;; beginning/end of history.
1538 (setq found (funcall search-fun string
1539 (unless isearch-forward
1540 ;; For backward search, don't search
1541 ;; in the comint prompt
1542 (comint-line-beginning-position))
1544 ;; Return point of the new search result
1546 ;; Return nil on the error "no next/preceding item"
1549 (defun comint-history-isearch-message (&optional c-q-hack ellipsis)
1550 "Display the input history search prompt.
1551 If there are no search errors, this function displays an overlay with
1552 the Isearch prompt which replaces the original comint prompt.
1553 Otherwise, it displays the standard Isearch message returned from
1554 the function `isearch-message'."
1555 (if (not (and isearch-success (not isearch-error)))
1556 ;; Use standard function `isearch-message' when not in comint prompt,
1557 ;; or search fails, or has an error (like incomplete regexp).
1558 ;; This function displays isearch message in the echo area,
1559 ;; so it's possible to see what is wrong in the search string.
1560 (isearch-message c-q-hack ellipsis)
1561 ;; Otherwise, put the overlay with the standard isearch prompt over
1562 ;; the initial comint prompt.
1563 (if (overlayp comint-history-isearch-message-overlay)
1564 (move-overlay comint-history-isearch-message-overlay
1566 (goto-char (comint-line-beginning-position))
1569 (comint-line-beginning-position))
1570 (setq comint-history-isearch-message-overlay
1571 (make-overlay (save-excursion
1572 (goto-char (comint-line-beginning-position))
1575 (comint-line-beginning-position)))
1576 (overlay-put comint-history-isearch-message-overlay 'evaporate t))
1577 (overlay-put comint-history-isearch-message-overlay
1578 'display (isearch-message-prefix ellipsis isearch-nonincremental))
1579 (if (and comint-input-ring-index (not ellipsis))
1580 ;; Display the current history index.
1581 (message "History item: %d" (1+ comint-input-ring-index))
1582 ;; Or clear a previous isearch message.
1585 (defun comint-history-isearch-wrap ()
1586 "Wrap the input history search when search fails.
1587 Move point to the first history element for a forward search,
1588 or to the last history element for a backward search."
1589 ;; When `comint-history-isearch-search' fails on reaching the
1590 ;; beginning/end of the history, wrap the search to the first/last
1591 ;; input history element.
1593 (comint-goto-input (1- (ring-length comint-input-ring)))
1594 (comint-goto-input nil))
1595 (setq isearch-success t)
1596 (goto-char (if isearch-forward (comint-line-beginning-position) (point-max))))
1598 (defun comint-history-isearch-push-state ()
1599 "Save a function restoring the state of input history search.
1600 Save `comint-input-ring-index' to the additional state parameter
1601 in the search status stack."
1602 (let ((index comint-input-ring-index))
1604 (comint-history-isearch-pop-state cmd index))))
1606 (defun comint-history-isearch-pop-state (_cmd hist-pos)
1607 "Restore the input history search state.
1608 Go to the history element by the absolute history position HIST-POS."
1609 (comint-goto-input hist-pos))
1612 (defun comint-within-quotes (beg end)
1613 "Return t if the number of quotes between BEG and END is odd.
1614 Quotes are single and double."
1615 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)'" beg end))
1616 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1617 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1619 (defun comint-how-many-region (regexp beg end)
1620 "Return number of matches for REGEXP from BEG to END."
1625 (while (re-search-forward regexp end t)
1626 (setq count (1+ count)))))
1629 (defun comint-args (string begin end)
1630 ;; From STRING, return the args depending on the range specified in the text
1631 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1632 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1635 (comint-arguments string 0 nil)
1636 (let* ((range (buffer-substring
1637 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1638 (nth (cond ((string-match "^[*^]" range) 1)
1639 ((string-match "^-" range) 0)
1640 ((string-equal range "$") nil)
1641 (t (string-to-number range))))
1642 (mth (cond ((string-match "[-*$]$" range) nil)
1643 ((string-match "-" range)
1644 (string-to-number (substring range (match-end 0))))
1646 (comint-arguments string nth mth)))))
1648 (defun comint-delim-arg (arg)
1649 "Return a list of arguments from ARG.
1650 Break it up at the delimiters in `comint-delimiter-argument-list'.
1651 Returned list is backwards.
1653 Characters with non-nil values of the text property `literal' are
1654 assumed to have literal values (e.g., backslash-escaped
1655 characters), and are not considered to be delimiters."
1656 (if (null comint-delimiter-argument-list)
1662 (let ((char (aref arg pos))
1664 (if (and (memq char comint-delimiter-argument-list)
1665 ;; Ignore backslash-escaped characters.
1666 (not (get-text-property pos 'literal arg)))
1667 (while (and (< pos len) (eq (aref arg pos) char))
1668 (setq pos (1+ pos)))
1669 (while (and (< pos len)
1670 (not (and (memq (aref arg pos)
1671 comint-delimiter-argument-list)
1672 (not (get-text-property
1673 pos 'literal arg)))))
1674 (setq pos (1+ pos))))
1675 (setq args (cons (substring arg start pos) args))))
1678 (defun comint-arguments (string nth mth)
1679 "Return from STRING the NTH to MTH arguments.
1680 NTH and/or MTH can be nil, which means the last argument.
1681 Returned arguments are separated by single spaces.
1682 We assume whitespace separates arguments, except within quotes
1683 and except for a space or tab that immediately follows a backslash.
1684 Also, a run of one or more of a single character
1685 in `comint-delimiter-argument-list' is a separate argument.
1686 Argument 0 is the command name."
1687 ;; The first line handles ordinary characters and backslash-sequences
1688 ;; (except with w32 msdos-like shells, where backslashes are valid).
1689 ;; The second matches "-quoted strings.
1690 ;; The third matches '-quoted strings.
1691 ;; The fourth matches `-quoted strings.
1692 ;; This seems to fit the syntax of BASH 2.0.
1693 (let* ((backslash-escape (not (and (fboundp 'w32-shell-dos-semantics)
1694 (w32-shell-dos-semantics))))
1695 (first (if backslash-escape
1696 "[^ \n\t\"'`\\]\\|\\(\\\\.\\)\\|"
1697 "[^ \n\t\"'`]+\\|"))
1698 (argpart (concat first
1699 "\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\
1702 (quote-subexpr (if backslash-escape 2 1))
1706 ;; Build a list of all the args until we have as many as we want.
1707 (while (and (or (null mth) (<= count mth))
1708 (string-match argpart string pos))
1709 ;; Apply the `literal' text property to backslash-escaped
1710 ;; characters, so that `comint-delim-arg' won't break them up.
1711 (and backslash-escape
1713 (put-text-property (match-beginning 1) (match-end 1)
1715 (if (and beg (= pos (match-beginning 0)))
1716 ;; It's contiguous, part of the same arg.
1717 (setq pos (match-end 0)
1718 quotes (or quotes (match-beginning quote-subexpr)))
1719 ;; It's a new separate arg.
1721 ;; Put the previous arg, if there was one, onto ARGS.
1722 (setq str (substring string beg pos)
1723 args (if quotes (cons str args)
1724 (nconc (comint-delim-arg str) args))))
1725 (setq count (length args))
1726 (setq quotes (match-beginning quote-subexpr))
1727 (setq beg (match-beginning 0))
1728 (setq pos (match-end 0))))
1730 (setq str (substring string beg pos)
1731 args (if quotes (cons str args)
1732 (nconc (comint-delim-arg str) args))))
1733 (setq count (length args))
1734 (let ((n (or nth (1- count)))
1735 (m (if mth (1- (- count mth)) 0)))
1737 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1740 ;; Input processing stuff
1742 (defun comint-add-to-input-history (cmd)
1743 "Add CMD to the input history.
1744 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1745 (when (and (funcall comint-input-filter cmd)
1746 (or (null comint-input-ignoredups)
1747 (not (ring-p comint-input-ring))
1748 (ring-empty-p comint-input-ring)
1749 (not (string-equal (ring-ref comint-input-ring 0) cmd))))
1750 ;; If `comint-input-ring' is full, maybe grow it.
1751 (let ((size (ring-size comint-input-ring)))
1752 (and (= size (ring-length comint-input-ring))
1753 (< size comint-input-ring-size)
1754 (ring-extend comint-input-ring
1755 (min size (- comint-input-ring-size size)))))
1756 (ring-insert comint-input-ring cmd)))
1758 (defun comint-send-input (&optional no-newline artificial)
1759 "Send input to process.
1760 After the process output mark, sends all text from the process mark to
1761 point as input to the process. Before the process output mark, calls
1762 value of variable `comint-get-old-input' to retrieve old input, copies
1763 it to the process mark, and sends it.
1765 This command also sends and inserts a final newline, unless
1766 NO-NEWLINE is non-nil.
1768 Any history reference may be expanded depending on the value of the variable
1769 `comint-input-autoexpand'. The list of function names contained in the value
1770 of `comint-input-filter-functions' is called on the input before sending it.
1771 The input is entered into the input history ring, if the value of variable
1772 `comint-input-filter' returns non-nil when called on the input.
1774 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1775 end of line before sending the input.
1777 After the input has been sent, if `comint-process-echoes' is non-nil,
1778 then `comint-send-input' waits to see if the process outputs a string
1779 matching the input, and if so, deletes that part of the output.
1780 If ARTIFICIAL is non-nil, it inhibits such deletion.
1781 Callers sending input not from the user should use ARTIFICIAL = t.
1783 The values of `comint-get-old-input', `comint-input-filter-functions', and
1784 `comint-input-filter' are chosen according to the command interpreter running
1785 in the buffer. E.g.,
1787 If the interpreter is the csh,
1788 `comint-get-old-input' is the default:
1789 If `comint-use-prompt-regexp' is nil, then
1790 either return the current input field, if point is on an input
1791 field, or the current line, if point is on an output field.
1792 If `comint-use-prompt-regexp' is non-nil, then
1793 return the current line with any initial string matching the
1794 regexp `comint-prompt-regexp' removed.
1795 `comint-input-filter-functions' monitors input for \"cd\", \"pushd\", and
1796 \"popd\" commands. When it sees one, it cd's the buffer.
1797 `comint-input-filter' is the default: returns t if the input isn't all white
1800 If the Comint is Lucid Common Lisp,
1801 `comint-get-old-input' snarfs the sexp ending at point.
1802 `comint-input-filter-functions' does nothing.
1803 `comint-input-filter' returns nil if the input matches input-filter-regexp,
1804 which matches (1) all whitespace (2) :a, :c, etc.
1806 Similarly for Soar, Scheme, etc."
1808 ;; If we're currently completing, stop. We're definitely done
1809 ;; completing, and by sending the input, we might cause side effects
1810 ;; that will confuse the code running in the completion
1811 ;; post-command-hook.
1812 (when completion-in-region-mode
1813 (completion-in-region-mode -1))
1814 ;; Note that the input string does not include its terminal newline.
1815 (let ((proc (get-buffer-process (current-buffer))))
1816 (if (not proc) (user-error "Current buffer has no process")
1818 (let* ((pmark (process-mark proc))
1819 (intxt (if (>= (point) (marker-position pmark))
1820 (progn (if comint-eol-on-send
1821 (if comint-use-prompt-regexp
1823 (goto-char (field-end))))
1824 (buffer-substring pmark (point)))
1825 (let ((copy (funcall comint-get-old-input)))
1829 (input (if (not (eq comint-input-autoexpand 'input))
1830 ;; Just whatever's already there.
1832 ;; Expand and leave it visible in buffer.
1833 (comint-replace-by-expanded-history t pmark)
1834 (buffer-substring pmark (point))))
1835 (history (if (not (eq comint-input-autoexpand 'history))
1837 ;; This is messy 'cos ultimately the original
1838 ;; functions used do insertion, rather than return
1839 ;; strings. We have to expand, then insert back.
1840 (comint-replace-by-expanded-history t pmark)
1841 (let ((copy (buffer-substring pmark (point)))
1844 (delete-region pmark start)
1850 (comint-add-to-input-history history)
1852 (run-hook-with-args 'comint-input-filter-functions
1853 (if no-newline input
1854 (concat input "\n")))
1856 (let ((beg (marker-position pmark))
1857 (end (if no-newline (point) (1- (point)))))
1858 (with-silent-modifications
1860 (add-text-properties beg end
1862 font-lock-face comint-highlight-input))
1863 (unless comint-use-prompt-regexp
1864 ;; Give old user input a field property of `input', to
1865 ;; distinguish it from both process output and unsent
1866 ;; input. The terminating newline is put into a special
1867 ;; `boundary' field to make cursor movement between input
1868 ;; and output fields smoother.
1869 (add-text-properties
1871 '(mouse-face highlight
1872 help-echo "mouse-2: insert after prompt as new input"))))
1873 (unless (or no-newline comint-use-prompt-regexp)
1874 ;; Cover the terminating newline
1875 (add-text-properties end (1+ end)
1878 inhibit-line-move-field-capture t)))))
1880 (comint-snapshot-last-prompt)
1882 (setq comint-save-input-ring-index comint-input-ring-index)
1883 (setq comint-input-ring-index nil)
1884 ;; Update the markers before we send the input
1885 ;; in case we get output amidst sending the input.
1886 (set-marker comint-last-input-start pmark)
1887 (set-marker comint-last-input-end (point))
1888 (set-marker (process-mark proc) (point))
1889 ;; clear the "accumulation" marker
1890 (set-marker comint-accum-marker nil)
1891 (let ((comint-input-sender-no-newline no-newline))
1892 (funcall comint-input-sender proc input))
1894 ;; Optionally delete echoed input (after checking it).
1895 (when (and comint-process-echoes (not artificial))
1896 (let ((echo-len (- comint-last-input-end
1897 comint-last-input-start)))
1898 ;; Wait for all input to be echoed:
1899 (while (and (> (+ comint-last-input-end echo-len)
1901 (accept-process-output proc)
1903 (compare-buffer-substrings
1904 nil comint-last-input-start
1905 (- (point-max) echo-len)
1906 ;; Above difference is equivalent to
1907 ;; (+ comint-last-input-start
1908 ;; (- (point-max) comint-last-input-end))
1909 nil comint-last-input-end (point-max)))))
1911 (<= (+ comint-last-input-end echo-len)
1914 (compare-buffer-substrings
1915 nil comint-last-input-start comint-last-input-end
1916 nil comint-last-input-end
1917 (+ comint-last-input-end echo-len))))
1918 ;; Certain parts of the text to be deleted may have
1919 ;; been mistaken for prompts. We have to prevent
1920 ;; problems when `comint-prompt-read-only' is non-nil.
1921 (let ((inhibit-read-only t))
1922 (delete-region comint-last-input-end
1923 (+ comint-last-input-end echo-len))
1924 (when comint-prompt-read-only
1926 (goto-char comint-last-input-end)
1927 (comint-update-fence)))))))
1929 ;; This used to call comint-output-filter-functions,
1930 ;; but that scrolled the buffer in undesirable ways.
1931 (run-hook-with-args 'comint-output-filter-functions "")))))
1933 (defvar comint-preoutput-filter-functions nil
1934 "List of functions to call before inserting Comint output into the buffer.
1935 Each function gets one argument, a string containing the text received
1936 from the subprocess. It should return the string to insert, perhaps
1937 the same string that was received, or perhaps a modified or transformed
1940 The functions on the list are called sequentially, and each one is
1941 given the string returned by the previous one. The string returned by
1942 the last function is the text that is actually inserted in the
1945 You can use `add-hook' to add functions to this list
1946 either globally or locally.")
1948 (defvar comint-inhibit-carriage-motion nil
1949 "If nil, Comint will interpret `carriage control' characters in output.
1950 See `comint-carriage-motion' for details.")
1952 (defvar comint-last-prompt nil
1953 "Markers pointing to the last prompt.
1954 If non-nil, a cons cell containing markers. The car points to
1955 the start, the cdr to the end of the last prompt recognized.")
1957 (defun comint-snapshot-last-prompt ()
1958 "Snapshot the current `comint-last-prompt'.
1959 Freezes the `font-lock-face' text property in place."
1960 (when comint-last-prompt
1961 (with-silent-modifications
1962 (font-lock-prepend-text-property
1963 (car comint-last-prompt)
1964 (cdr comint-last-prompt)
1965 'font-lock-face 'comint-highlight-prompt))
1966 ;; Reset comint-last-prompt so later on comint-output-filter does
1967 ;; not remove the font-lock-face text property of the previous
1969 (setq comint-last-prompt nil)))
1971 (defun comint-carriage-motion (start end)
1972 "Interpret carriage control characters in the region from START to END.
1973 Translate carriage return/linefeed sequences to linefeeds.
1974 Make single carriage returns delete to the beginning of the line.
1975 Make backspaces delete the previous character."
1977 ;; We used to check the existence of \b and \r at first to avoid
1978 ;; calling save-match-data and save-restriction. But, such a
1979 ;; check is not necessary now because we don't use regexp search
1980 ;; nor save-restriction. Note that the buffer is already widen,
1981 ;; and calling narrow-to-region and widen are not that heavy.
1983 (let* ((inhibit-field-text-motion t)
1984 (inhibit-read-only t)
1985 (lbeg (line-beginning-position))
1987 ;; If the preceding text is marked as "must-overwrite", record
1988 ;; it in delete-end.
1989 (when (and (> start (point-min))
1990 (get-text-property (1- start) 'comint-must-overwrite))
1991 (setq delete-end (point-marker))
1992 (remove-text-properties lbeg start '(comint-must-overwrite nil)))
1993 (narrow-to-region lbeg end)
1994 ;; Handle BS, LF, and CR specially.
1995 (while (and (skip-chars-forward "^\b\n\r") (not (eobp)))
1996 (setq ch (following-char))
1997 (cond ((= ch ?\b) ; CH = BS
1999 (if (> (point) lbeg)
2002 (when delete-end ; CH = LF
2003 (if (< delete-end (point))
2004 (delete-region lbeg delete-end))
2005 (set-marker delete-end nil)
2006 (setq delete-end nil))
2008 (setq lbeg (point)))
2012 (when (< delete-end (point))
2013 (delete-region lbeg delete-end)
2014 (move-marker delete-end (point)))
2015 (setq delete-end (point-marker))))))
2017 (if (< delete-end (point))
2018 ;; As there's a text after the last CR, make the current
2019 ;; line contain only that text.
2020 (delete-region lbeg delete-end)
2021 ;; Remember that the process output ends by CR, and thus we
2022 ;; must overwrite the contents of the current line next
2024 (put-text-property lbeg delete-end 'comint-must-overwrite t))
2025 (set-marker delete-end nil))
2028 ;; The purpose of using this filter for comint processes
2029 ;; is to keep comint-last-input-end from moving forward
2030 ;; when output is inserted.
2031 (defun comint-output-filter (process string)
2032 (let ((oprocbuf (process-buffer process)))
2033 ;; First check for killed buffer or no input.
2034 (when (and string oprocbuf (buffer-name oprocbuf))
2035 (with-current-buffer oprocbuf
2036 ;; Run preoutput filters
2037 (let ((functions comint-preoutput-filter-functions))
2038 (while (and functions string)
2039 (if (eq (car functions) t)
2041 (default-value 'comint-preoutput-filter-functions)))
2042 (while (and functions string)
2043 (setq string (funcall (car functions) string))
2044 (setq functions (cdr functions))))
2045 (setq string (funcall (car functions) string)))
2046 (setq functions (cdr functions))))
2049 (let ((inhibit-read-only t)
2050 ;; The point should float after any insertion we do.
2051 (saved-point (copy-marker (point) t)))
2053 ;; We temporarily remove any buffer narrowing, in case the
2054 ;; process mark is outside of the restriction
2058 (goto-char (process-mark process))
2059 (set-marker comint-last-output-start (point))
2061 ;; Try to skip repeated prompts, which can occur as a result of
2062 ;; commands sent without inserting them in the buffer.
2063 (let ((bol (save-excursion (forward-line 0) (point)))) ;No fields.
2064 (when (and (not (bolp))
2065 (looking-back comint-prompt-regexp bol))
2066 (let* ((prompt (buffer-substring bol (point)))
2067 (prompt-re (concat "\\`" (regexp-quote prompt))))
2068 (while (string-match prompt-re string)
2069 (setq string (substring string (match-end 0)))))))
2070 (while (string-match (concat "\\(^" comint-prompt-regexp
2073 (setq string (replace-match "\\1" nil nil string)))
2075 ;; insert-before-markers is a bad thing. XXX
2076 ;; Luckily we don't have to use it any more, we use
2077 ;; window-point-insertion-type instead.
2080 ;; Advance process-mark
2081 (set-marker (process-mark process) (point))
2083 (unless comint-inhibit-carriage-motion
2084 ;; Interpret any carriage motion characters (newline, backspace)
2085 (comint-carriage-motion comint-last-output-start (point)))
2087 ;; Run these hooks with point where the user had it.
2088 (goto-char saved-point)
2089 (run-hook-with-args 'comint-output-filter-functions string)
2090 (set-marker saved-point (point))
2092 (goto-char (process-mark process)) ; In case a filter moved it.
2094 (unless comint-use-prompt-regexp
2095 (with-silent-modifications
2096 (add-text-properties comint-last-output-start (point)
2098 (field inhibit-line-move-field-capture)
2101 inhibit-line-move-field-capture t))))
2103 ;; Highlight the prompt, where we define `prompt' to mean
2104 ;; the most recent output that doesn't end with a newline.
2105 (let ((prompt-start (save-excursion (forward-line 0) (point)))
2106 (inhibit-read-only t))
2107 (when comint-prompt-read-only
2108 (with-silent-modifications
2109 (or (= (point-min) prompt-start)
2110 (get-text-property (1- prompt-start) 'read-only)
2111 (put-text-property (1- prompt-start)
2112 prompt-start 'read-only 'fence))
2113 (add-text-properties prompt-start (point)
2114 '(read-only t front-sticky (read-only)))))
2115 (when comint-last-prompt
2116 ;; There might be some keywords here waiting for
2117 ;; fontification, so no `with-silent-modifications'.
2118 (font-lock--remove-face-from-text-property
2119 (car comint-last-prompt)
2120 (cdr comint-last-prompt)
2122 'comint-highlight-prompt))
2123 (setq comint-last-prompt
2124 (cons (copy-marker prompt-start) (point-marker)))
2125 (font-lock-prepend-text-property prompt-start (point)
2127 'comint-highlight-prompt)
2128 (add-text-properties prompt-start (point) '(rear-nonsticky t)))
2129 (goto-char saved-point)))))))
2131 (defun comint-preinput-scroll-to-bottom ()
2132 "Go to the end of buffer in all windows showing it.
2133 Movement occurs if point in the selected window is not after the process mark,
2134 and `this-command' is an insertion command. Insertion commands recognized
2135 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
2136 Depends on the value of `comint-scroll-to-bottom-on-input'.
2138 This function should be a pre-command hook."
2139 (if (and comint-scroll-to-bottom-on-input
2140 (memq this-command '(self-insert-command comint-magic-space yank
2142 (let* ((current (current-buffer))
2143 (process (get-buffer-process current))
2144 (scroll comint-scroll-to-bottom-on-input))
2145 (if (and process (< (point) (process-mark process)))
2146 (if (eq scroll 'this)
2147 (goto-char (point-max))
2150 (if (and (eq (window-buffer window) current)
2151 (or (eq scroll t) (eq scroll 'all)))
2152 (with-selected-window window
2153 (goto-char (point-max)))))
2156 (defvar follow-mode)
2157 (declare-function follow-comint-scroll-to-bottom "follow" (&optional window))
2159 (defun comint-postoutput-scroll-to-bottom (_string)
2160 "Go to the end of buffer in some or all windows showing it.
2161 Do not scroll if the current line is the last line in the buffer.
2162 Depends on the value of `comint-move-point-for-output' and
2163 `comint-scroll-show-maximum-output'.
2165 This function should be in the list `comint-output-filter-functions'."
2166 (let* ((current (current-buffer))
2167 (process (get-buffer-process current)))
2171 ((bound-and-true-p follow-mode)
2172 (follow-comint-scroll-to-bottom))
2174 (dolist (w (get-buffer-window-list current nil t))
2175 (comint-adjust-window-point w process)
2176 ;; Optionally scroll to the bottom of the window.
2177 (and comint-scroll-show-maximum-output
2178 (eq (window-point w) (point-max))
2179 (with-selected-window w
2180 (recenter (- -1 scroll-margin)))))))
2181 (set-buffer current))))
2184 (defun comint-adjust-window-point (window process)
2185 "Move point in WINDOW based on Comint settings.
2186 For point adjustment use the process-mark of PROCESS."
2187 (and (< (window-point window) (process-mark process))
2188 (or (memq comint-move-point-for-output '(t all))
2189 ;; Maybe user wants point to jump to end.
2190 (eq comint-move-point-for-output
2191 (if (eq (selected-window) window) 'this 'others))
2192 ;; If point was at the end, keep it at end.
2193 (and (marker-position comint-last-output-start)
2194 (>= (window-point window) comint-last-output-start)))
2195 (set-window-point window (process-mark process))))
2198 ;; this function is nowhere used
2199 (defun comint-adjust-point (selected)
2200 "Move point in the selected window based on Comint settings.
2201 SELECTED is the window that was originally selected."
2202 (let ((process (get-buffer-process (current-buffer))))
2203 (and (< (point) (process-mark process))
2204 (or (memq comint-move-point-for-output '(t all))
2205 ;; Maybe user wants point to jump to end.
2206 (eq comint-move-point-for-output
2207 (if (eq (selected-window) selected) 'this 'others))
2208 ;; If point was at the end, keep it at end.
2209 (and (marker-position comint-last-output-start)
2210 (>= (point) comint-last-output-start)))
2211 (goto-char (process-mark process)))))
2213 (defun comint-truncate-buffer (&optional _string)
2214 "Truncate the buffer to `comint-buffer-maximum-size'.
2215 This function could be on `comint-output-filter-functions' or bound to a key."
2218 (goto-char (process-mark (get-buffer-process (current-buffer))))
2219 (forward-line (- comint-buffer-maximum-size))
2221 (let ((inhibit-read-only t))
2222 (delete-region (point-min) (point)))))
2224 (defun comint-strip-ctrl-m (&optional _string)
2225 "Strip trailing `^M' characters from the current output group.
2226 This function could be on `comint-output-filter-functions' or bound to a key."
2228 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2232 (if (called-interactively-p 'interactive)
2233 comint-last-input-end comint-last-output-start))
2235 (while (re-search-forward "\r+$" pmark t)
2236 (replace-match "" t t)))))
2237 (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
2239 (defun comint-show-maximum-output ()
2240 "Put the end of the buffer at the bottom of the window."
2242 (goto-char (point-max))
2243 (recenter (- -1 scroll-margin)))
2245 (defun comint-get-old-input-default ()
2246 "Default for `comint-get-old-input'.
2247 If `comint-use-prompt-regexp' is nil, then either
2248 return the current input field, if point is on an input field, or the
2249 current line, if point is on an output field.
2250 If `comint-use-prompt-regexp' is non-nil, then return
2251 the current line with any initial string matching the regexp
2252 `comint-prompt-regexp' removed."
2254 (if (and (not comint-use-prompt-regexp)
2255 ;; Make sure we're in an input rather than output field.
2256 (null (get-char-property (setq bof (field-beginning)) 'field)))
2257 (field-string-no-properties bof)
2259 (buffer-substring-no-properties (point)
2260 (if comint-use-prompt-regexp
2264 (defun comint-copy-old-input ()
2265 "Insert after prompt old input at point as new input to be edited.
2266 Calls `comint-get-old-input' to get old input."
2268 (let ((input (funcall comint-get-old-input))
2269 (process (get-buffer-process (current-buffer))))
2271 (user-error "Current buffer has no process")
2272 (goto-char (process-mark process))
2275 (defun comint-skip-prompt ()
2276 "Skip past the text matching regexp `comint-prompt-regexp'.
2277 If this takes us past the end of the current line, don't skip at all."
2278 (if (and (looking-at comint-prompt-regexp)
2279 (<= (match-end 0) (line-end-position)))
2280 (goto-char (match-end 0))))
2282 (defun comint-after-pmark-p ()
2283 "Return t if point is after the process output marker."
2284 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2285 (<= (marker-position pmark) (point))))
2287 (defun comint-simple-send (proc string)
2288 "Default function for sending to PROC input STRING.
2289 This just sends STRING plus a newline. To override this,
2290 set the hook `comint-input-sender'."
2292 (if comint-input-sender-no-newline
2294 ;; Sending as two separate strings does not work
2295 ;; on Windows, so concat the \n before sending.
2296 (concat string "\n"))))
2297 (comint-send-string proc send-string))
2298 (if (and comint-input-sender-no-newline
2299 (not (string-equal string "")))
2300 (process-send-eof)))
2302 (defun comint-line-beginning-position ()
2303 "Return the buffer position of the beginning of the line, after any prompt.
2304 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done by
2305 skipping text matching the regular expression `comint-prompt-regexp',
2306 a buffer local variable."
2307 (if comint-use-prompt-regexp
2308 ;; Use comint-prompt-regexp
2311 (comint-skip-prompt)
2313 ;; Use input fields. Note that, unlike the behavior of
2314 ;; `line-beginning-position' inside a field, this function will
2315 ;; return the position of the end of a prompt, even if the point is
2316 ;; already inside the prompt. In order to do this, it assumes that
2317 ;; if there are two fields on a line, then the first one is the
2318 ;; prompt, and the second one is an input field, and is front-sticky
2319 ;; (as input fields should be).
2320 (constrain-to-field (if (eq (field-at-pos (point)) 'output)
2321 (line-beginning-position)
2323 (line-end-position))))
2325 (defun comint-bol (&optional arg)
2326 "Go to the beginning of line, then skip past the prompt, if any.
2327 If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
2328 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done
2329 by skipping text matching the regular expression `comint-prompt-regexp',
2330 a buffer local variable."
2333 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
2335 (goto-char (comint-line-beginning-position))))
2337 ;; For compatibility.
2338 (defun comint-read-noecho (prompt &optional _ignore)
2339 (read-passwd prompt))
2341 ;; These three functions are for entering text you don't want echoed or
2342 ;; saved -- typically passwords to ftp, telnet, or somesuch.
2343 ;; Just enter m-x send-invisible and type in your line.
2345 (defun send-invisible (&optional prompt)
2346 "Read a string without echoing.
2347 Then send it to the process running in the current buffer.
2348 The string is sent using `comint-input-sender'.
2349 Security bug: your string can still be temporarily recovered with
2350 \\[view-lossage]; `clear-this-command-keys' can fix that."
2351 (interactive "P") ; Defeat snooping via C-x ESC ESC
2352 (let ((proc (get-buffer-process (current-buffer)))
2354 (if (eq (window-buffer) (current-buffer))
2356 (format "(In buffer %s) "
2357 (current-buffer)))))
2359 (let ((str (read-passwd (concat prefix
2360 (or prompt "Non-echoed text: ")))))
2363 (comint-snapshot-last-prompt)
2364 (funcall comint-input-sender proc str))
2365 (message "Warning: text will be echoed")))
2366 (error "Buffer %s has no process" (current-buffer)))))
2368 (defun comint-watch-for-password-prompt (string)
2369 "Prompt in the minibuffer for password and send without echoing.
2370 This function uses `send-invisible' to read and send a password to the buffer's
2371 process if STRING contains a password prompt defined by
2372 `comint-password-prompt-regexp'.
2374 This function could be in the list `comint-output-filter-functions'."
2375 (when (let ((case-fold-search t))
2376 (string-match comint-password-prompt-regexp string))
2377 (when (string-match "^[ \n\r\t\v\f\b\a]+" string)
2378 (setq string (replace-match "" t t string)))
2379 (send-invisible string)))
2381 ;; Low-level process communication
2383 (defun comint-send-string (process string)
2384 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
2386 (with-current-buffer (if (processp process)
2387 (process-buffer process)
2388 (get-buffer process))
2389 (comint-snapshot-last-prompt))
2390 (comint-snapshot-last-prompt))
2391 (process-send-string process string))
2393 (defun comint-send-region (process start end)
2394 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
2396 (with-current-buffer (if (processp process)
2397 (process-buffer process)
2398 (get-buffer process))
2399 (comint-snapshot-last-prompt))
2400 (comint-snapshot-last-prompt))
2401 (process-send-region process start end))
2404 ;; Random input hackage
2406 (defun comint-delete-output ()
2407 "Delete all output from interpreter since last input.
2408 Does not delete the prompt."
2410 (let ((proc (get-buffer-process (current-buffer)))
2412 (inhibit-read-only t))
2414 (let ((pmark (progn (goto-char (process-mark proc))
2417 (delete-region comint-last-input-end pmark)
2418 (goto-char (process-mark proc))
2419 (setq replacement (concat "*** output flushed ***\n"
2420 (buffer-substring pmark (point))))
2421 (delete-region pmark (point))))
2422 ;; Output message and put back prompt
2423 (comint-output-filter proc replacement)))
2425 (defun comint-write-output (filename &optional append mustbenew)
2426 "Write output from interpreter since last input to FILENAME.
2427 Any prompt at the end of the output is not written.
2429 If the optional argument APPEND (the prefix argument when interactive)
2430 is non-nil, the output is appended to the file instead.
2432 If the optional argument MUSTBENEW is non-nil, check for an existing
2433 file with the same name. If MUSTBENEW is `excl', that means to get an
2434 error if the file already exists; never overwrite. If MUSTBENEW is
2435 neither nil nor `excl', that means ask for confirmation before
2436 overwriting, but do go ahead and overwrite the file if the user
2437 confirms. When interactive, MUSTBENEW is nil when appending, and t
2440 (list (read-file-name
2441 (if current-prefix-arg
2442 "Append output to file: "
2443 "Write output to file: "))
2445 (not current-prefix-arg)))
2447 (goto-char (process-mark (get-buffer-process (current-buffer))))
2449 (write-region comint-last-input-end (point) filename
2450 append nil nil mustbenew)))
2452 ;; This function exists for the benefit of the menu; from the keyboard,
2453 ;; users can just use `comint-write-output' with a prefix arg.
2454 (defun comint-append-output-to-file (filename)
2455 "Append output from interpreter since last input to FILENAME.
2456 Any prompt at the end of the output is not written."
2457 (interactive "fAppend output to file: ")
2458 (comint-write-output filename t))
2460 (defun comint-show-output ()
2461 "Display start of this batch of interpreter output at top of window.
2462 Sets mark to the value of point when this command is run."
2465 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
2466 (cond (comint-use-prompt-regexp
2468 (beginning-of-line 0)
2469 (set-window-start (selected-window) (point))
2470 (comint-skip-prompt))
2472 (goto-char (field-beginning pos))
2473 (set-window-start (selected-window) (point))))))
2475 (defun comint-clear-buffer ()
2476 "Clear the comint buffer."
2478 (let ((comint-buffer-maximum-size 0))
2479 (comint-truncate-buffer)))
2481 (defun comint-interrupt-subjob ()
2482 "Interrupt the current subjob."
2485 (interrupt-process nil comint-ptyp)
2486 ;; (process-send-string nil "\n")
2489 (defun comint-kill-subjob ()
2490 "Send kill signal to the current subjob."
2493 (kill-process nil comint-ptyp))
2495 (defun comint-quit-subjob ()
2496 "Send quit signal to the current subjob."
2499 (quit-process nil comint-ptyp))
2501 (defun comint-stop-subjob ()
2502 "Stop the current subjob.
2504 WARNING: if there is no current subjob, you can end up suspending
2505 the top-level process running in the buffer. If you accidentally do
2506 this, use \\[comint-continue-subjob] to resume the process. (This
2507 is not a problem with most shells, since they ignore this signal.)"
2510 (stop-process nil comint-ptyp))
2512 (defun comint-continue-subjob ()
2513 "Send CONT signal to process buffer's process group.
2514 Useful if you accidentally suspend the top-level process."
2516 (continue-process nil comint-ptyp))
2518 (defun comint-skip-input ()
2519 "Skip all pending input, from last stuff output by interpreter to point.
2520 This means mark it as if it had been sent as input, without sending it."
2521 (let ((comint-input-sender 'ignore)
2522 (comint-input-filter-functions nil))
2523 (comint-send-input t t))
2526 (marker (process-mark (get-buffer-process (current-buffer)))))
2527 (insert " " (key-description (this-command-keys)))
2529 (set-marker marker (point)))))
2531 (defun comint-kill-input ()
2532 "Kill all text from last stuff output by interpreter to point."
2534 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2535 (if (> (point) (marker-position pmark))
2536 (kill-region pmark (point)))))
2538 (defun comint-delchar-or-maybe-eof (arg)
2539 "Delete ARG characters forward or send an EOF to subprocess.
2540 Sends an EOF only if point is at the end of the buffer and there is no input."
2542 (let ((proc (get-buffer-process (current-buffer))))
2543 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
2545 (delete-char arg))))
2547 (defun comint-send-eof ()
2548 "Send an EOF to the current buffer's process."
2550 (comint-send-input t t)
2554 (defun comint-backward-matching-input (regexp n)
2555 "Search backward through buffer for input fields that match REGEXP.
2556 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2557 by lines that match `comint-prompt-regexp'.
2559 With prefix argument N, search for Nth previous match.
2560 If N is negative, find the next or Nth next match."
2561 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2562 (if comint-use-prompt-regexp
2563 ;; Use comint-prompt-regexp
2564 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2565 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2566 (if (re-search-backward re nil t n)
2569 (progn (message "Not found")
2574 (let* ((dir (if (< n 0) -1 1))
2578 (unless (re-search-backward regexp nil t dir)
2579 (user-error "Not found"))
2580 (unless (get-char-property (point) 'field)
2581 (setq n (- n dir))))
2582 (field-beginning))))
2586 (defun comint-forward-matching-input (regexp n)
2587 "Search forward through buffer for input fields that match REGEXP.
2588 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2589 by lines that match `comint-prompt-regexp'.
2591 With prefix argument N, search for Nth following match.
2592 If N is negative, find the previous or Nth previous match."
2593 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2594 (comint-backward-matching-input regexp (- n)))
2597 (defun comint-next-prompt (n)
2598 "Move to end of Nth next prompt in the buffer.
2599 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2600 the Nth next `input' field, otherwise, it means the Nth occurrence of
2601 text matching `comint-prompt-regexp'."
2603 (if comint-use-prompt-regexp
2604 ;; Use comint-prompt-regexp
2605 (let ((paragraph-start comint-prompt-regexp))
2606 (end-of-line (if (> n 0) 1 0))
2607 (forward-paragraph n)
2608 (comint-skip-prompt))
2617 (next-single-char-property-change pos 'field)
2618 (previous-single-char-property-change pos 'field)))
2619 (cond ((= pos prev-pos)
2620 ;; Ran off the end of the buffer.
2622 ;; There's always an input field at the end of the
2623 ;; buffer, but it has a `field' property of nil.
2624 (setq input-pos (point-max)))
2627 ((null (get-char-property pos 'field))
2628 (setq n (if (< n 0) (1+ n) (1- n)))
2629 (setq input-pos pos))))
2631 (goto-char input-pos)))))
2634 (defun comint-previous-prompt (n)
2635 "Move to end of Nth previous prompt in the buffer.
2636 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2637 the Nth previous `input' field, otherwise, it means the Nth occurrence of
2638 text matching `comint-prompt-regexp'."
2640 (comint-next-prompt (- n)))
2642 ;; State used by `comint-insert-previous-argument' when cycling.
2643 (defvar-local comint-insert-previous-argument-last-start-pos nil)
2644 (defvar-local comint-insert-previous-argument-last-index nil)
2647 ;; make comint-arguments understand negative indices as bash does
2648 (defun comint-insert-previous-argument (index)
2649 "Insert the INDEXth argument from the previous Comint command-line at point.
2650 Spaces are added at beginning and/or end of the inserted string if
2651 necessary to ensure that it's separated from adjacent arguments.
2652 Interactively, if no prefix argument is given, the last argument is inserted.
2653 Repeated interactive invocations will cycle through the same argument
2654 from progressively earlier commands (using the value of INDEX specified
2655 with the first command).
2656 This command is like `M-.' in bash."
2658 (unless (null index)
2659 (setq index (prefix-numeric-value index)))
2660 (cond ((eq last-command this-command)
2661 ;; Delete last input inserted by this command.
2662 (delete-region comint-insert-previous-argument-last-start-pos (point))
2663 (setq index comint-insert-previous-argument-last-index))
2665 ;; This is a non-repeat invocation, so initialize state.
2666 (setq comint-input-ring-index nil)
2667 (setq comint-insert-previous-argument-last-index index)
2668 (when (null comint-insert-previous-argument-last-start-pos)
2669 ;; First usage; initialize to a marker
2670 (setq comint-insert-previous-argument-last-start-pos
2672 ;; Make sure we're not in the prompt, and add a beginning space if necessary.
2673 (if (<= (point) (comint-line-beginning-position))
2676 ;; Remember the beginning of what we insert, so we can delete it if
2677 ;; the command is repeated.
2678 (set-marker comint-insert-previous-argument-last-start-pos (point))
2679 ;; Insert the argument.
2680 (let ((input-string (comint-previous-input-string 0)))
2681 (when (string-match "[ \t\n]*&" input-string)
2682 ;; strip terminating '&'
2683 (setq input-string (substring input-string 0 (match-beginning 0))))
2684 (insert (comint-arguments input-string index index)))
2685 ;; Make next invocation return arg from previous input
2686 (setq comint-input-ring-index (1+ (or comint-input-ring-index 0)))
2687 ;; Add a terminating space if necessary.
2692 ;; Support editing with `comint-prompt-read-only' set to t.
2694 (defun comint-update-fence ()
2695 "Update read-only status of newline before point.
2696 The `fence' read-only property is used to indicate that a newline
2697 is read-only for no other reason than to \"fence off\" a
2698 following front-sticky read-only region. This is used to
2699 implement comint read-only prompts. If the text after a newline
2700 changes, the read-only status of that newline may need updating.
2701 That is what this function does.
2703 This function does nothing if point is not at the beginning of a
2704 line, or is at the beginning of the accessible portion of the buffer.
2705 Otherwise, if the character after point has a front-sticky
2706 read-only property, then the preceding newline is given a
2707 read-only property of `fence', unless it already is read-only.
2708 If the character after point does not have a front-sticky
2709 read-only property, any read-only property of `fence' on the
2710 preceding newline is removed."
2711 (let* ((pt (point)) (lst (get-text-property pt 'front-sticky)))
2714 (with-silent-modifications
2715 (if (and (get-text-property pt 'read-only)
2716 (if (listp lst) (memq 'read-only lst) t))
2717 (unless (get-text-property (1- pt) 'read-only)
2718 (put-text-property (1- pt) pt 'read-only 'fence))
2719 (when (eq (get-text-property (1- pt) 'read-only) 'fence)
2720 (remove-list-of-text-properties (1- pt) pt '(read-only))))))))
2722 (defun comint-kill-whole-line (&optional count)
2723 "Kill current line, ignoring read-only and field properties.
2724 With prefix arg COUNT, kill that many lines starting from the current line.
2725 If COUNT is negative, kill backward. Also kill the preceding newline,
2726 instead of the trailing one. \(This is meant to make \\[repeat] work well
2727 with negative arguments.)
2728 If COUNT is zero, kill current line but exclude the trailing newline.
2729 The read-only status of newlines is updated with `comint-update-fence',
2732 (let ((inhibit-read-only t) (inhibit-field-text-motion t))
2733 (kill-whole-line count)
2734 (when (>= count 0) (comint-update-fence))))
2736 (defun comint-kill-region (beg end)
2737 "Like `kill-region', but ignores read-only properties, if safe.
2738 This command assumes that the buffer contains read-only
2739 \"prompts\" which are regions with front-sticky read-only
2740 properties at the beginning of a line, with the preceding newline
2741 being read-only to protect the prompt. This is true of the
2742 comint prompts if `comint-prompt-read-only' is non-nil. This
2743 command will not delete the region if this would create mutilated
2744 or out of place prompts. That is, if any part of a prompt is
2745 deleted, the entire prompt must be deleted and all remaining
2746 prompts should stay at the beginning of a line. If this is not
2747 the case, this command just calls `kill-region' with all
2748 read-only properties intact. The read-only status of newlines is
2749 updated using `comint-update-fence', if necessary."
2752 (let* ((true-beg (min beg end))
2753 (true-end (max beg end))
2754 (beg-bolp (progn (goto-char true-beg) (bolp)))
2755 (beg-lst (get-text-property true-beg 'front-sticky))
2756 (beg-bad (and (get-text-property true-beg 'read-only)
2757 (if (listp beg-lst) (memq 'read-only beg-lst) t)))
2758 (end-bolp (progn (goto-char true-end) (bolp)))
2759 (end-lst (get-text-property true-end 'front-sticky))
2760 (end-bad (and (get-text-property true-end 'read-only)
2761 (if (listp end-lst) (memq 'read-only end-lst) t))))
2762 (if (or (and (not beg-bolp) (or beg-bad end-bad))
2763 (and (not end-bolp) end-bad))
2764 (kill-region beg end)
2765 (let ((inhibit-read-only t))
2766 (kill-region beg end)
2767 (comint-update-fence))))))
2769 ;; Support for source-file processing commands.
2770 ;;============================================================================
2771 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2772 ;; commands that process files of source text (e.g. loading or compiling
2773 ;; files). So the corresponding process-in-a-buffer modes have commands
2774 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2775 ;; for defining these commands.
2777 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2778 ;; and Soar, in that they don't know anything about file extensions.
2779 ;; So the compile/load interface gets the wrong default occasionally.
2780 ;; The load-file/compile-file default mechanism could be smarter -- it
2781 ;; doesn't know about the relationship between filename extensions and
2782 ;; whether the file is source or executable. If you compile foo.lisp
2783 ;; with compile-file, then the next load-file should use foo.bin for
2784 ;; the default, not foo.lisp. This is tricky to do right, particularly
2785 ;; because the extension for executable files varies so much (.o, .bin,
2786 ;; .lbin, .mo, .vo, .ao, ...).
2789 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2792 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2793 ;; want to save the buffer before issuing any process requests to the command
2796 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2797 ;; for the file to process.
2799 (defun comint-source-default (previous-dir/file source-modes)
2800 "Compute the defaults for `load-file' and `compile-file' commands.
2802 PREVIOUS-DIR/FILE is a pair (DIRECTORY . FILENAME) from the last
2803 source-file processing command, or nil if there hasn't been one yet.
2804 SOURCE-MODES is a list used to determine what buffers contain source
2805 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2806 Typically, (lisp-mode) or (scheme-mode).
2808 If the command is given while the cursor is inside a string, *and*
2809 the string is an existing filename, *and* the filename is not a directory,
2810 then the string is taken as default. This allows you to just position
2811 your cursor over a string that's a filename and have it taken as default.
2813 If the command is given in a file buffer whose major mode is in
2814 SOURCE-MODES, then the filename is the default file, and the
2815 file's directory is the default directory.
2817 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2818 then the default directory & file are what was used in the last source-file
2819 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2820 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2821 is the cwd, with no default file. (\"no default file\" = nil)
2823 SOURCE-MODES is typically going to be something like (tea-mode)
2824 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2825 for Soar programs, etc.
2827 The function returns a pair: (default-directory . default-file)."
2828 (cond ((and buffer-file-name (memq major-mode source-modes))
2829 (cons (file-name-directory buffer-file-name)
2830 (file-name-nondirectory buffer-file-name)))
2833 (cons default-directory nil))))
2836 (defun comint-check-source (fname)
2837 "Check whether to save buffers visiting file FNAME.
2838 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2839 process-in-a-buffer modes), this function can be called on the filename.
2840 If the file is loaded into a buffer, and the buffer is modified, the user
2841 is queried to see if he wants to save the buffer before proceeding with
2842 the load or compile."
2843 (let ((buff (get-file-buffer fname)))
2845 (buffer-modified-p buff)
2846 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
2847 (with-current-buffer buff
2850 (defun comint-extract-string ()
2851 "Return string around point, or nil."
2852 (let ((syntax (syntax-ppss)))
2853 (when (nth 3 syntax)
2855 (buffer-substring-no-properties (1+ (nth 8 syntax))
2856 (progn (goto-char (nth 8 syntax))
2861 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2862 "Prompt for filenames in commands that process source files,
2863 e.g. loading or compiling a file.
2864 Provides a default, if there is one, and returns the result filename.
2866 See `comint-source-default' for more on determining defaults.
2868 PROMPT is the prompt string. PREV-DIR/FILE is the (DIRECTORY . FILE) pair
2869 from the last source processing command. SOURCE-MODES is a list of major
2870 modes used to determine what file buffers contain source files. (These
2871 two arguments are used for determining defaults.) If MUSTMATCH-P is true,
2872 then the filename reader will only accept a file that exists.
2875 (interactive (comint-get-source \"Compile file: \" prev-lisp-dir/file
2876 \\='(lisp-mode) t))"
2877 (let* ((def (comint-source-default prev-dir/file source-modes))
2878 (stringfile (comint-extract-string))
2879 (sfile-p (and stringfile
2881 (file-exists-p stringfile)
2883 (not (file-directory-p stringfile))))
2884 (defdir (if sfile-p (file-name-directory stringfile)
2886 (deffile (if sfile-p (file-name-nondirectory stringfile)
2888 (ans (read-file-name (if deffile (format "%s(default %s) "
2892 (concat defdir deffile)
2894 (list (expand-file-name (substitute-in-file-name ans)))))
2896 ;; I am somewhat divided on this string-default feature. It seems
2897 ;; to violate the principle-of-least-astonishment, in that it makes
2898 ;; the default harder to predict, so you actually have to look and see
2899 ;; what the default really is before choosing it. This can trip you up.
2900 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2905 ;; Simple process query facility.
2906 ;; ===========================================================================
2907 ;; This function is for commands that want to send a query to the process
2908 ;; and show the response to the user. For example, a command to get the
2909 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2910 ;; to an inferior Common Lisp process.
2912 ;; This simple facility just sends strings to the inferior process and pops
2913 ;; up a window for the process buffer so you can see what the process
2914 ;; responds with. We don't do anything fancy like try to intercept what the
2915 ;; process responds with and put it in a pop-up window or on the message
2916 ;; line. We just display the buffer. Low tech. Simple. Works good.
2918 (defun comint-proc-query (proc str)
2919 "Send to the inferior process PROC the string STR.
2920 Pop-up but do not select a window for the inferior process so that
2921 its response can be seen."
2922 (let* ((proc-buf (process-buffer proc))
2923 (proc-mark (process-mark proc)))
2924 (display-buffer proc-buf)
2925 (set-buffer proc-buf) ; but it's not the selected *window*
2926 (let ((proc-win (get-buffer-window proc-buf 0))
2927 (proc-pt (marker-position proc-mark)))
2928 (comint-send-string proc str) ; send the query
2929 (accept-process-output proc) ; wait for some output
2930 ;; Try to position the proc window so you can see the answer.
2931 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2932 ;; I don't know why. Wizards invited to improve it.
2933 (unless (pos-visible-in-window-p proc-pt proc-win)
2934 (let ((opoint (window-point proc-win)))
2935 (set-window-point proc-win proc-mark)
2937 (if (not (pos-visible-in-window-p opoint proc-win))
2939 (set-window-point proc-win opoint)))))))
2942 ;; Filename/command/history completion in a buffer
2943 ;; ===========================================================================
2944 ;; Useful completion functions, courtesy of the Ergo group.
2947 ;; completion-at-point Complete or expand command, filename,
2948 ;; history at point.
2949 ;; comint-dynamic-complete-filename Complete filename at point.
2950 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2951 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2952 ;; replace with expanded/completed name.
2954 ;; These are not installed in the comint-mode keymap. But they are
2955 ;; available for people who want them. Shell-mode installs them:
2956 ;; (define-key shell-mode-map "\t" 'completion-at-point)
2957 ;; (define-key shell-mode-map "\M-?"
2958 ;; 'comint-dynamic-list-filename-completions)))
2960 ;; Commands like this are fine things to put in load hooks if you
2961 ;; want them present in specific modes.
2963 (defcustom comint-completion-autolist nil
2964 "If non-nil, automatically list possibilities on partial completion.
2965 This mirrors the optional behavior of tcsh."
2967 :group 'comint-completion)
2969 (defcustom comint-completion-addsuffix t
2970 "If non-nil, add ` ' to file names.
2971 It can either be a string FILESUFFIX or a cons (DIRSUFFIX . FILESUFFIX)
2972 where DIRSUFFIX is ignored and FILESUFFIX is a string added on unambiguous
2973 or exact completion.
2974 This mirrors the optional behavior of tcsh."
2975 :type '(choice (const :tag "None" nil)
2976 (const :tag "Add SPC" t)
2977 (string :tag "File suffix")
2978 (cons :tag "Obsolete suffix pair"
2979 (string :tag "Ignored")
2980 (string :tag "File suffix")))
2981 :group 'comint-completion)
2983 (defcustom comint-completion-recexact nil
2984 "If non-nil, use shortest completion if characters cannot be added.
2985 This mirrors the optional behavior of tcsh.
2987 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2989 :group 'comint-completion)
2991 (defcustom comint-completion-fignore nil
2992 "List of suffixes to be disregarded during file completion.
2993 This mirrors the optional behavior of bash and tcsh.
2995 Note that this applies to `comint-dynamic-complete-filename' only."
2996 :type '(repeat (string :tag "Suffix"))
2997 :group 'comint-completion)
3000 (defvar comint-file-name-prefix (purecopy "")
3001 "Prefix prepended to absolute file names taken from process input.
3002 This is used by Comint's and shell's completion functions, and by shell's
3003 directory tracking functions.")
3005 (defvar comint-file-name-chars
3006 (if (memq system-type '(ms-dos windows-nt cygwin))
3007 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
3008 "[]~/A-Za-z0-9+@:_.$#%,={}-")
3009 "String of characters valid in a file name.
3010 Note that all non-ASCII characters are considered valid in a file name
3011 regardless of what this variable says.
3013 This is a good thing to set in mode hooks.")
3015 (defvar comint-file-name-quote-list nil
3016 "List of characters to quote with `\\' when in a file name.
3018 This is a good thing to set in mode hooks.")
3021 (defun comint-directory (directory)
3022 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
3023 (expand-file-name (if (file-name-absolute-p directory)
3024 (concat comint-file-name-prefix directory)
3028 (defun comint-word (word-chars)
3029 "Return the word of WORD-CHARS at point, or nil if none is found.
3030 Word constituents are considered to be those in WORD-CHARS, which is like the
3031 inside of a \"[...]\" (see `skip-chars-forward'), plus all non-ASCII characters."
3032 ;; FIXME: Need to handle "..." and '...' quoting in shell.el!
3033 ;; This should be combined with completion parsing somehow.
3035 (let ((here (point))
3038 (let ((startpoint (point)))
3039 (skip-chars-backward (concat "\\\\" word-chars))
3040 (if (and comint-file-name-quote-list
3041 (eq (char-before (1- (point))) ?\\))
3043 ;; FIXME: This isn't consistent with Bash, at least -- not
3044 ;; all non-ASCII chars should be word constituents.
3045 (if (and (not (bobp)) (>= (char-before) 128))
3047 (if (= (point) startpoint)
3049 ;; Set match-data to match the entire string.
3050 (when (< (point) here)
3051 (set-match-data (list (point) here))
3052 (match-string 0)))))
3054 (defun comint-substitute-in-file-name (filename)
3055 "Return FILENAME with environment variables substituted.
3056 Supports additional environment variable syntax of the command
3057 interpreter (e.g., the percent notation of cmd.exe on Windows)."
3058 (let ((name (substitute-in-file-name filename)))
3059 (if (memq system-type '(ms-dos windows-nt))
3063 (while (string-match "%\\([^\\\\/]*\\)%" name)
3064 (setq env-var-name (match-string 1 name))
3065 (setq env-var-val (or (getenv env-var-name) ""))
3066 (setq name (replace-match env-var-val t t name))))))
3069 (defun comint--match-partial-filename ()
3070 "Return the filename at point as-is, or nil if none is found.
3072 (comint-word comint-file-name-chars))
3074 (defun comint--unquote&requote-argument (qstr &optional upos)
3075 (unless upos (setq upos 0))
3079 "\\$\\(?:\\([[:alpha:]][[:alnum:]]*\\)"
3080 "\\|{\\(?1:[^{}]+\\)}\\)"
3081 (when (memq system-type '(ms-dos windows-nt))
3082 "\\|%\\(?1:[^\\\\/]*\\)%")
3083 (when comint-file-name-quote-list
3086 (push (lambda (str end)
3088 (setq upos (- upos (length str)))
3089 (unless (or qupos (> upos 0))
3090 (setq qupos (if (< end 0) (- end) (+ upos end))))))
3092 (while (setq match (string-match re qstr qpos))
3093 (funcall push (substring qstr qpos match) match)
3095 ((match-beginning 2) (funcall push (match-string 2 qstr) (match-end 0)))
3096 ((match-beginning 1) (funcall push (getenv (match-string 1 qstr))
3098 (t (error "Unexpected case in comint--unquote&requote-argument!")))
3099 (setq qpos (match-end 0)))
3100 (funcall push (substring qstr qpos) (length qstr))
3101 (list (mapconcat #'identity (nreverse ustrs) "")
3102 qupos #'comint-quote-filename)))
3104 (defun comint--unquote-argument (str)
3105 (car (comint--unquote&requote-argument str)))
3106 (define-obsolete-function-alias 'comint--unquote&expand-filename
3107 #'comint--unquote-argument "24.3")
3109 (defun comint-match-partial-filename ()
3110 "Return the unquoted&expanded filename at point, or nil if none is found.
3111 Environment variables are substituted. See `comint-word'."
3112 (let ((filename (comint--match-partial-filename)))
3113 (and filename (comint--unquote-argument filename))))
3115 (defun comint-quote-filename (filename)
3116 "Return FILENAME with magic characters quoted.
3117 Magic characters are those in `comint-file-name-quote-list'."
3118 (if (null comint-file-name-quote-list)
3120 (let ((regexp (regexp-opt-charset comint-file-name-quote-list)))
3123 (while (string-match regexp filename i)
3124 (setq filename (replace-match "\\\\\\&" nil nil filename))
3125 (setq i (1+ (match-end 0)))))
3128 (defun comint-unquote-filename (filename)
3129 "Return FILENAME with quoted characters unquoted."
3130 (declare (obsolete nil "24.3"))
3131 (if (null comint-file-name-quote-list)
3134 (replace-regexp-in-string "\\\\\\(.\\)" "\\1" filename t))))
3136 (defun comint--requote-argument (upos qstr)
3137 ;; See `completion-table-with-quoting'.
3138 (let ((res (comint--unquote&requote-argument qstr upos)))
3139 (cons (nth 1 res) (nth 2 res))))
3141 (defun comint-completion-at-point ()
3142 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
3144 (define-obsolete-function-alias
3145 'comint-dynamic-complete
3146 'completion-at-point "24.1")
3148 (defun comint-dynamic-complete-filename ()
3149 "Dynamically complete the filename at point.
3150 Completes if after a filename.
3151 This function is similar to `comint-replace-by-expanded-filename', except that
3152 it won't change parts of the filename already entered in the buffer; it just
3153 adds completion characters to the end of the filename. A completions listing
3154 may be shown in a separate buffer if completion is ambiguous.
3156 Completion is dependent on the value of `comint-completion-addsuffix',
3157 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
3158 completions listing is dependent on the value of `comint-completion-autolist'.
3160 Returns t if successful."
3162 (when (comint--match-partial-filename)
3163 (unless (window-minibuffer-p)
3164 (message "Completing file name..."))
3165 (let ((data (comint--complete-file-name-data)))
3166 (completion-in-region (nth 0 data) (nth 1 data) (nth 2 data)))))
3168 (defun comint-filename-completion ()
3169 "Return completion data for filename at point, if any."
3170 (when (comint--match-partial-filename)
3171 (comint--complete-file-name-data)))
3173 (defun comint-completion-file-name-table (string pred action)
3174 (if (not (file-name-absolute-p string))
3175 (completion-file-name-table string pred action)
3177 ((memq action '(t lambda))
3178 (completion-file-name-table
3179 (concat comint-file-name-prefix string) pred action))
3181 (let ((res (completion-file-name-table
3182 (concat comint-file-name-prefix string) pred action)))
3183 (if (and (stringp res)
3185 (concat "\\`" (regexp-quote comint-file-name-prefix))
3187 (substring res (match-end 0))
3189 (t (completion-file-name-table string pred action)))))
3191 (defvar comint-unquote-function #'comint--unquote-argument
3192 "Function to use for completion of quoted data.
3193 See `completion-table-with-quoting' and `comint-requote-function'.")
3194 (defvar comint-requote-function #'comint--requote-argument
3195 "Function to use for completion of quoted data.
3196 See `completion-table-with-quoting' and `comint-unquote-function'.")
3198 (defun comint--complete-file-name-data ()
3199 "Return the completion data for file name at point."
3200 (let* ((filesuffix (cond ((not comint-completion-addsuffix) "")
3201 ((stringp comint-completion-addsuffix)
3202 comint-completion-addsuffix)
3203 ((not (consp comint-completion-addsuffix)) " ")
3204 (t (cdr comint-completion-addsuffix))))
3205 (filename (comint--match-partial-filename))
3206 (filename-beg (if filename (match-beginning 0) (point)))
3207 (filename-end (if filename (match-end 0) (point)))
3209 (completion-table-with-quoting
3210 #'comint-completion-file-name-table
3211 comint-unquote-function
3212 comint-requote-function)))
3215 filename-beg filename-end
3216 (lambda (string pred action)
3217 (let ((completion-ignore-case read-file-name-completion-ignore-case)
3218 (completion-ignored-extensions comint-completion-fignore))
3219 (complete-with-action action table string pred))))
3220 (unless (zerop (length filesuffix))
3221 (list :exit-function
3223 (when (eq status 'finished)
3224 (if (looking-at (regexp-quote filesuffix))
3225 (goto-char (match-end 0))
3226 (insert filesuffix)))))))))
3228 (defun comint-dynamic-complete-as-filename ()
3229 "Dynamically complete at point as a filename.
3230 See `comint-dynamic-complete-filename'. Returns t if successful."
3231 (declare (obsolete comint-filename-completion "24.1"))
3232 (let ((data (comint--complete-file-name-data)))
3233 (completion-in-region (nth 0 data) (nth 1 data) (nth 2 data))))
3235 (defun comint-replace-by-expanded-filename ()
3236 "Dynamically expand and complete the filename at point.
3237 Replace the filename with an expanded, canonicalized and
3238 completed replacement, i.e. substituting environment
3239 variables (e.g. $HOME), `~'s, `..', and `.', and making the
3240 filename absolute. For expansion see `expand-file-name' and
3241 `substitute-in-file-name'. For completion see
3242 `comint-dynamic-complete-filename'."
3244 (let ((filename (comint-match-partial-filename)))
3246 (replace-match (expand-file-name filename) t t)
3247 (comint-dynamic-complete-filename))))
3250 (defun comint-dynamic-simple-complete (stub candidates)
3251 "Dynamically complete STUB from CANDIDATES list.
3252 This function inserts completion characters at point by
3253 completing STUB from the strings in CANDIDATES. If completion is
3254 ambiguous, possibly show a completions listing in a separate
3257 Return nil if no completion was inserted.
3258 Return `sole' if completed with the only completion match.
3259 Return `shortest' if completed with the shortest match.
3260 Return `partial' if completed as far as possible.
3261 Return `listed' if a completion listing was shown.
3263 See also `comint-dynamic-complete-filename'."
3264 (declare (obsolete completion-in-region "24.1"))
3265 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
3266 (minibuffer-p (window-minibuffer-p))
3267 (suffix (cond ((not comint-completion-addsuffix) "")
3268 ((not (consp comint-completion-addsuffix)) " ")
3269 (t (cdr comint-completion-addsuffix))))
3270 (completions (all-completions stub candidates)))
3271 (cond ((null completions)
3273 (minibuffer-message "No completions of %s" stub)
3274 (message "No completions of %s" stub))
3276 ((= 1 (length completions)) ; Gotcha!
3277 (let ((completion (car completions)))
3278 (if (string-equal completion stub)
3279 (unless minibuffer-p
3280 (message "Sole completion"))
3281 (insert (substring completion (length stub)))
3282 (unless minibuffer-p
3283 (message "Completed")))
3286 (t ; There's no unique completion.
3287 (let ((completion (try-completion stub candidates)))
3288 ;; Insert the longest substring.
3289 (insert (substring completion (length stub)))
3290 (cond ((and comint-completion-recexact comint-completion-addsuffix
3291 (string-equal stub completion)
3292 (member completion completions))
3293 ;; It's not unique, but user wants shortest match.
3295 (unless minibuffer-p
3296 (message "Completed shortest"))
3298 ((or comint-completion-autolist
3299 (string-equal stub completion))
3300 ;; It's not unique, list possible completions.
3301 (comint-dynamic-list-completions completions stub)
3304 (unless minibuffer-p
3305 (message "Partially completed"))
3308 (defun comint-dynamic-list-filename-completions ()
3309 "Display a list of possible completions for the filename at point."
3311 (let* ((data (comint--complete-file-name-data))
3312 (minibuffer-completion-table (nth 2 data))
3313 (minibuffer-completion-predicate nil)
3314 (ol (make-overlay (nth 0 data) (nth 1 data) nil nil t)))
3315 (overlay-put ol 'field 'completion)
3317 (call-interactively 'minibuffer-completion-help)
3318 (delete-overlay ol))))
3321 ;; This is bound locally in a *Completions* buffer to the list of
3322 ;; completions displayed, and is used to detect the case where the same
3323 ;; command is repeatedly used without the set of completions changing.
3324 (defvar comint-displayed-dynamic-completions nil)
3326 (defvar comint-dynamic-list-completions-config nil)
3328 (defun comint-dynamic-list-completions (completions &optional common-substring)
3329 "Display a list of sorted COMPLETIONS.
3330 Typing SPC flushes the completions buffer.
3332 The optional argument COMMON-SUBSTRING, if non-nil, should be a string
3333 specifying a common substring for adding the faces
3334 `completions-first-difference' and `completions-common-part' to
3336 (let ((window (get-buffer-window "*Completions*" 0)))
3337 (setq completions (sort completions 'string-lessp))
3338 (if (and (eq last-command this-command)
3339 window (window-live-p window) (window-buffer window)
3340 (buffer-name (window-buffer window))
3341 ;; The above tests are not sufficient to detect the case where we
3342 ;; should scroll, because the top-level interactive command may
3343 ;; not have displayed a completions window the last time it was
3344 ;; invoked, and there may be such a window left over from a
3345 ;; previous completion command with a different set of
3346 ;; completions. To detect that case, we also test that the set
3347 ;; of displayed completions is in fact the same as the previously
3350 (buffer-local-value 'comint-displayed-dynamic-completions
3351 (window-buffer window))))
3352 ;; If this command was repeated, and
3353 ;; there's a fresh completion window with a live buffer,
3354 ;; and this command is repeated, scroll that window.
3355 (with-current-buffer (window-buffer window)
3356 (if (pos-visible-in-window-p (point-max) window)
3357 (set-window-start window (point-min))
3358 (save-selected-window
3359 (select-window window)
3362 ;; Display a completion list for the first time.
3363 (setq comint-dynamic-list-completions-config
3364 (current-window-configuration))
3365 (with-output-to-temp-buffer "*Completions*"
3366 (display-completion-list
3367 (completion-hilit-commonality completions (length common-substring))))
3368 (if (window-minibuffer-p)
3369 (minibuffer-message "Type space to flush; repeat completion command to scroll")
3370 (message "Type space to flush; repeat completion command to scroll")))
3372 ;; Read the next key, to process SPC.
3374 (if (with-current-buffer (get-buffer "*Completions*")
3375 (setq-local comint-displayed-dynamic-completions
3377 (setq key (read-key-sequence nil)
3379 (and (consp first) (consp (event-start first))
3380 (eq (window-buffer (posn-window (event-start first)))
3381 (get-buffer "*Completions*"))
3382 (memq (key-binding key)
3383 '(mouse-choose-completion choose-completion))))
3384 ;; If the user does choose-completion with the mouse,
3385 ;; execute the command, then delete the completion window.
3387 (choose-completion first)
3388 (set-window-configuration comint-dynamic-list-completions-config))
3390 (set-window-configuration comint-dynamic-list-completions-config)
3391 (setq unread-command-events
3392 (nconc (listify-key-sequence key) unread-command-events)))))))
3394 (defun comint-get-next-from-history ()
3395 "After fetching a line from input history, this fetches the following line.
3396 In other words, this recalls the input line after the line you recalled last.
3397 You can use this to repeat a sequence of input lines."
3399 (if comint-save-input-ring-index
3401 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
3402 (comint-next-input 1))
3403 (message "No previous history command")))
3405 (defun comint-accumulate ()
3406 "Accumulate a line to send as input along with more lines.
3407 This inserts a newline so that you can enter more text
3408 to be sent along with this line. Use \\[comint-send-input]
3409 to send all the accumulated input, at once.
3410 The entire accumulated text becomes one item in the input history
3414 (set-marker comint-accum-marker (point))
3415 (if comint-input-ring-index
3416 (setq comint-save-input-ring-index
3417 (- comint-input-ring-index 1))))
3419 (defun comint-goto-process-mark ()
3420 "Move point to the process mark.
3421 The process mark separates output, and input already sent,
3422 from input that has not yet been sent."
3424 (let ((proc (or (get-buffer-process (current-buffer))
3425 (user-error "Current buffer has no process"))))
3426 (goto-char (process-mark proc))
3427 (when (called-interactively-p 'interactive)
3428 (message "Point is now at the process mark"))))
3430 (defun comint-bol-or-process-mark ()
3431 "Move point to beginning of line (after prompt) or to the process mark.
3432 The first time you use this command, it moves to the beginning of the line
3433 \(but after the prompt, if any). If you repeat it again immediately,
3434 it moves point to the process mark.
3436 The process mark separates the process output, along with input already sent,
3437 from input that has not yet been sent. Ordinarily, the process mark
3438 is at the beginning of the current input line; but if you have
3439 used \\[comint-accumulate] to send multiple lines at once,
3440 the process mark is at the beginning of the accumulated input."
3442 (if (not (eq last-command 'comint-bol-or-process-mark))
3444 (comint-goto-process-mark)))
3446 (defun comint-set-process-mark ()
3447 "Set the process mark at point."
3449 (let ((proc (or (get-buffer-process (current-buffer))
3450 (user-error "Current buffer has no process"))))
3451 (set-marker (process-mark proc) (point))
3452 (message "Process mark set")))
3455 ;; Author: Peter Breton <pbreton@cs.umb.edu>
3457 ;; This little add-on for comint is intended to make it easy to get
3458 ;; output from currently active comint buffers into another buffer,
3459 ;; or buffers, and then go back to using the comint shell.
3461 ;; My particular use is SQL interpreters; I want to be able to execute a
3462 ;; query using the process associated with a comint-buffer, and save that
3463 ;; somewhere else. Because the process might have state (for example, it
3464 ;; could be in an uncommitted transaction), just running starting a new
3465 ;; process and having it execute the query and then finish, would not
3466 ;; work. I'm sure there are other uses as well, although in many cases
3467 ;; starting a new process is the simpler, and thus preferable, approach.
3469 ;; The basic implementation is as follows: comint-redirect changes the
3470 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
3471 ;; its own filter. The filter puts the output into the designated buffer,
3472 ;; or buffers, until it sees a regexp that tells it to stop (by default,
3473 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
3474 ;; sees the stop regexp, it restores the old filter functions, and runs
3475 ;; `comint-redirect-hook'.
3477 ;; Each comint buffer may only use one redirection at a time, but any number
3478 ;; of different comint buffers may be simultaneously redirected.
3480 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
3481 ;; correct prompt for your interpreter, or that you supply a regexp that says
3482 ;; when the redirection is finished. Otherwise, redirection will continue
3483 ;; indefinitely. The code now does a sanity check to ensure that it can find
3484 ;; a prompt in the comint buffer; however, it is still important to ensure that
3485 ;; this prompt is set correctly.
3487 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
3488 ;; perhaps it should prompt for a terminating string (with an
3489 ;; appropriate magic default by examining what we think is the prompt)?
3491 ;; Fixme: look for appropriate fields, rather than regexp, if
3492 ;; `comint-use-prompt-regexp' is true.
3494 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3496 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3498 (defcustom comint-redirect-verbose nil
3499 "If non-nil, print messages each time the redirection filter is invoked.
3500 Also print a message when redirection is completed."
3504 ;; Directly analogous to comint-preoutput-filter-functions
3505 (defvar comint-redirect-filter-functions nil
3506 "List of functions to call before inserting redirected process output.
3507 Each function gets one argument, a string containing the text received
3508 from the subprocess. It should return the string to insert, perhaps
3509 the same string that was received, or perhaps a modified or transformed
3512 The functions on the list are called sequentially, and each one is given
3513 the string returned by the previous one. The string returned by the
3514 last function is the text that is actually inserted in the redirection buffer.
3516 You can use `add-hook' to add functions to this list
3517 either globally or locally.")
3519 ;; Internal variables
3521 (defvar comint-redirect-output-buffer nil
3522 "The buffer or list of buffers to put output into.")
3524 (defvar comint-redirect-finished-regexp nil
3525 "Regular expression that determines when to stop redirection in Comint.
3526 When the redirection filter function is given output that matches this regexp,
3527 the output is inserted as usual, and redirection is completed.")
3529 (defvar comint-redirect-insert-matching-regexp nil
3530 "If non-nil, the text that ends a redirection is included in it.
3531 More precisely, the text that matches `comint-redirect-finished-regexp'
3532 and therefore terminates an output redirection is inserted in the
3533 redirection target buffer, along with the preceding output.")
3535 (defvar comint-redirect-echo-input nil
3536 "Non-nil means echo input in the process buffer even during redirection.")
3538 (defvar comint-redirect-completed nil
3539 "Non-nil if redirection has completed in the current buffer.")
3541 (defvar comint-redirect-original-mode-line-process nil
3542 "Original mode line for redirected process.")
3544 (defvar comint-redirect-perform-sanity-check t
3545 "If non-nil, check that redirection is likely to complete successfully.
3546 More precisely, before starting a redirection, verify that the
3547 regular expression `comint-redirect-finished-regexp' that controls
3548 when to terminate it actually matches some text already in the process
3549 buffer. The idea is that this regular expression should match a prompt
3550 string, and that there ought to be at least one copy of your prompt string
3551 in the process buffer already.")
3553 (defvar comint-redirect-subvert-readonly nil
3554 "Non-nil means `comint-redirect' can insert into read-only buffers.
3555 This works by binding `inhibit-read-only' around the insertion.
3556 This is useful, for instance, for insertion into Help mode buffers.
3557 You probably want to set it locally to the output buffer.")
3559 (defvar comint-redirect-previous-input-string nil
3560 "Last redirected line of text.
3561 Allows detection of the end of the redirection in case the
3562 completion string is split between two output segments.")
3564 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3566 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3568 (defun comint-redirect-setup (output-buffer
3571 &optional echo-input)
3572 "Set up for output redirection.
3573 This function sets local variables that are used by `comint-redirect-filter'
3574 to perform redirection.
3576 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3577 in the output matches FINISHED-REGEXP.
3579 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3580 original Comint buffer.
3582 This function is called by `comint-redirect-send-command-to-process',
3583 and does not normally need to be invoked by the end user or programmer."
3584 (with-current-buffer comint-buffer
3586 (setq-local comint-redirect-original-mode-line-process mode-line-process)
3588 (setq-local comint-redirect-output-buffer output-buffer)
3590 (setq-local comint-redirect-finished-regexp finished-regexp)
3592 (setq-local comint-redirect-echo-input echo-input)
3594 (setq-local comint-redirect-completed nil)
3596 (setq-local comint-redirect-previous-input-string "")
3598 (setq mode-line-process
3599 (if mode-line-process
3600 (list (concat (elt mode-line-process 0) " Redirection"))
3601 (list ":%s Redirection")))))
3603 (defun comint-redirect-cleanup ()
3604 "End a Comint redirection. See `comint-redirect-send-command'."
3606 ;; Release the last redirected string
3607 (setq comint-redirect-previous-input-string nil)
3608 ;; Restore the process filter
3609 (remove-function (process-filter (get-buffer-process (current-buffer)))
3610 #'comint-redirect-filter)
3611 ;; Restore the mode line
3612 (setq mode-line-process comint-redirect-original-mode-line-process)
3613 ;; Set the completed flag
3614 (setq comint-redirect-completed t))
3616 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3617 ;; that it really occurs.
3618 (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
3620 (defun comint-redirect-filter (orig-filter process input-string)
3621 "Filter function which redirects output from PROCESS to a buffer or buffers.
3622 The variable `comint-redirect-output-buffer' says which buffer(s) to
3625 INPUT-STRING is the input from the Comint process.
3627 This function runs as a process filter, and does not need to be invoked by the
3630 (with-current-buffer (process-buffer process)
3631 (comint-redirect-preoutput-filter input-string)
3632 ;; If we have to echo output, give it to the original filter function
3633 (and comint-redirect-echo-input
3635 (funcall orig-filter process input-string)))))
3638 (defun comint-redirect-preoutput-filter (input-string)
3639 "Comint filter function which redirects Comint output to a buffer or buffers.
3640 The variable `comint-redirect-output-buffer' says which buffer(s) to
3643 INPUT-STRING is the input from the Comint process.
3645 This function does not need to be invoked by the end user."
3646 (let ((output-buffer-list
3647 (if (listp comint-redirect-output-buffer)
3648 comint-redirect-output-buffer
3649 (list comint-redirect-output-buffer)))
3650 (filtered-input-string input-string))
3652 ;; If there are any filter functions, give them a chance to modify
3654 (let ((functions comint-redirect-filter-functions))
3655 (while (and functions filtered-input-string)
3656 (if (eq (car functions) t)
3657 ;; If a local value says "use the default value too",
3660 (default-value 'comint-redirect-filter-functions)))
3661 (while (and functions filtered-input-string)
3662 (setq filtered-input-string
3663 (funcall (car functions) filtered-input-string))
3664 (setq functions (cdr functions))))
3665 (setq filtered-input-string
3666 (funcall (car functions) filtered-input-string)))
3667 (setq functions (cdr functions))))
3669 ;; Clobber `comint-redirect-finished-regexp'
3670 (or comint-redirect-insert-matching-regexp
3671 (and (string-match comint-redirect-finished-regexp filtered-input-string)
3672 (setq filtered-input-string
3673 (replace-match "" nil nil filtered-input-string))))
3675 ;; Send output to all registered buffers
3677 (dolist (buf output-buffer-list)
3678 ;; Set this buffer to the output buffer
3679 (set-buffer (get-buffer-create buf))
3680 ;; Go to the end of the buffer
3681 (goto-char (point-max))
3682 ;; Insert the output
3683 (let ((inhibit-read-only comint-redirect-subvert-readonly))
3684 (insert filtered-input-string))))
3687 (and comint-redirect-verbose
3688 (message "Redirected output to buffer(s) %s" output-buffer-list))
3690 ;; If we see the prompt, tidy up
3691 ;; We'll look for the prompt in the original string, so nobody can
3693 (and (string-match comint-redirect-finished-regexp
3694 (concat comint-redirect-previous-input-string
3697 (and comint-redirect-verbose
3698 (message "Redirection completed"))
3699 (comint-redirect-cleanup)
3700 (run-hooks 'comint-redirect-hook)))
3701 (setq comint-redirect-previous-input-string input-string)
3704 (if comint-redirect-echo-input
3705 filtered-input-string
3709 (defun comint-redirect-send-command (command output-buffer echo &optional no-display)
3710 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3711 With prefix arg ECHO, echo output in process buffer.
3713 If NO-DISPLAY is non-nil, do not show the output buffer."
3714 (interactive "sCommand: \nBOutput Buffer: \nP")
3715 (let ((process (get-buffer-process (current-buffer))))
3717 (comint-redirect-send-command-to-process
3718 command output-buffer (current-buffer) echo no-display)
3719 (error "No process for current buffer"))))
3722 (defun comint-redirect-send-command-to-process
3723 (command output-buffer process echo &optional no-display)
3724 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3725 With prefix arg, echo output in process buffer.
3727 If NO-DISPLAY is non-nil, do not show the output buffer."
3728 (interactive "sCommand: \nBOutput Buffer: \nbProcess Buffer: \nP")
3729 (let* (;; The process buffer
3730 (process-buffer (if (processp process)
3731 (process-buffer process)
3733 (proc (get-buffer-process process-buffer)))
3734 ;; Change to the process buffer
3735 (with-current-buffer process-buffer
3737 ;; Make sure there's a prompt in the current process buffer
3738 (and comint-redirect-perform-sanity-check
3740 (goto-char (point-max))
3741 (or (re-search-backward comint-prompt-regexp nil t)
3742 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3744 ;; Set up for redirection
3745 (comint-redirect-setup
3747 (current-buffer) ; Comint Buffer
3748 comint-prompt-regexp ; Finished Regexp
3752 (add-function :around (process-filter proc) #'comint-redirect-filter)
3755 (process-send-string (current-buffer) (concat command "\n"))
3761 (if (listp output-buffer)
3763 output-buffer)))))))
3766 (defun comint-redirect-results-list (command regexp regexp-group)
3767 "Send COMMAND to current process.
3768 Return a list of expressions in the output which match REGEXP.
3769 REGEXP-GROUP is the regular expression group in REGEXP to use."
3770 (comint-redirect-results-list-from-process
3771 (get-buffer-process (current-buffer))
3772 command regexp regexp-group))
3775 (defun comint-redirect-results-list-from-process (process command regexp regexp-group)
3776 "Send COMMAND to PROCESS.
3777 Return a list of expressions in the output which match REGEXP.
3778 REGEXP-GROUP is the regular expression group in REGEXP to use."
3779 (let ((output-buffer " *Comint Redirect Work Buffer*")
3781 (with-current-buffer (get-buffer-create output-buffer)
3783 (comint-redirect-send-command-to-process command
3784 output-buffer process nil t)
3785 ;; Wait for the process to complete
3786 (set-buffer (process-buffer process))
3787 (while (and (null comint-redirect-completed)
3788 (accept-process-output process)))
3789 ;; Collect the output
3790 (set-buffer output-buffer)
3791 (goto-char (point-min))
3792 ;; Skip past the command, if it was echoed
3793 (and (looking-at command)
3795 (while (and (not (eobp))
3796 (re-search-forward regexp nil t))
3797 (push (buffer-substring-no-properties
3798 (match-beginning regexp-group)
3799 (match-end regexp-group))
3801 (nreverse results))))
3803 ;; Converting process modes to use comint mode
3804 ;; ===========================================================================
3805 ;; The code in the Emacs 19 distribution has all been modified to use comint
3806 ;; where needed. However, there are `third-party' packages out there that
3807 ;; still use the old shell mode. Here's a guide to conversion.
3809 ;; Renaming variables
3810 ;; Most of the work is renaming variables and functions. These are the common
3813 ;; last-input-start comint-last-input-start
3814 ;; last-input-end comint-last-input-end
3815 ;; shell-prompt-pattern comint-prompt-regexp
3816 ;; shell-set-directory-error-hook <no equivalent>
3818 ;; shell-set-directory <unnecessary>
3819 ;; shell-mode-map comint-mode-map
3821 ;; shell-send-input comint-send-input
3822 ;; shell-send-eof comint-delchar-or-maybe-eof
3823 ;; kill-shell-input comint-kill-input
3824 ;; interrupt-shell-subjob comint-interrupt-subjob
3825 ;; stop-shell-subjob comint-stop-subjob
3826 ;; quit-shell-subjob comint-quit-subjob
3827 ;; kill-shell-subjob comint-kill-subjob
3828 ;; kill-output-from-shell comint-delete-output
3829 ;; show-output-from-shell comint-show-output
3830 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3832 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3833 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3834 ;; Comint mode does not provide functionality equivalent to
3835 ;; shell-set-directory-error-hook; it is gone.
3837 ;; comint-last-input-start is provided for modes which want to munge
3838 ;; the buffer after input is sent, perhaps because the inferior
3839 ;; insists on echoing the input. The LAST-INPUT-START variable in
3840 ;; the old shell package was used to implement a history mechanism,
3841 ;; but you should think twice before using comint-last-input-start
3842 ;; for this; the input history ring often does the job better.
3844 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3845 ;; *not* create the comint-mode local variables in your foo-mode function.
3846 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3847 ;; necessary comint-specific local variables. Then create the
3848 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3849 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3850 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3851 ;; get-old-input) that need to be different from the defaults. Call
3852 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3853 ;; comint-mode will take care of it. The following example, from shell.el,
3856 ;; (defvar shell-mode-map
3857 ;; (let ((map (make-sparse-keymap)))
3858 ;; (set-keymap-parent map comint-mode-map)
3859 ;; (define-key map "\C-c\C-f" 'shell-forward-command)
3860 ;; (define-key map "\C-c\C-b" 'shell-backward-command)
3861 ;; (define-key map "\t" 'completion-at-point)
3862 ;; (define-key map "\M-?"
3863 ;; 'comint-dynamic-list-filename-completions)
3866 ;; (define-derived-mode shell-mode comint-mode "Shell"
3868 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3869 ;; (setq-local shell-directory-stack nil)
3870 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker))
3873 ;; Completion for comint-mode users
3875 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3876 ;; hook to add completion functions to. Functions on this list should return
3877 ;; the completion data according to the documentation of
3878 ;; `completion-at-point-functions'
3883 ;;; comint.el ends here