| blob | 3163afeff40c3439d20cab7dda34354a0ad40174 |
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
8 ;; Keywords: processes
9 ;; Package: emacs
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/>.
26 ;;; Commentary:
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.
38 ;;
39 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
40 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
41 ;; - The file soar.el tunes Lisp and inferior-lisp modes for Soar.
42 ;; - cmutex.el defines TeX and LaTeX modes that invoke TeX, LaTeX, BibTeX,
43 ;; previewers, and printers from within Emacs.
44 ;; - background.el allows csh-like job control inside Emacs.
45 ;; It is pretty easy to make new derived modes for other processes.
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.
56 \f
57 ;; Brief Command Documentation:
58 ;;============================================================================
59 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
60 ;; mode)
61 ;;
62 ;; M-p comint-previous-input Cycle backwards in input history
63 ;; M-n comint-next-input Cycle forwards
64 ;; M-r comint-history-isearch-backward-regexp Isearch input regexp backward
65 ;; M-C-l comint-show-output Show last batch of process output
66 ;; RET comint-send-input
67 ;; C-d comint-delchar-or-maybe-eof Delete char unless at end of buff
68 ;; C-c C-a comint-bol-or-process-mark First time, move point to bol;
69 ;; second time, move to process-mark.
70 ;; C-c C-u comint-kill-input ^u
71 ;; C-c C-w backward-kill-word ^w
72 ;; C-c C-c comint-interrupt-subjob ^c
73 ;; C-c C-z comint-stop-subjob ^z
74 ;; C-c C-\ comint-quit-subjob ^\
75 ;; C-c C-o comint-delete-output Delete last batch of process output
76 ;; C-c C-r comint-show-output Show last batch of process output
77 ;; C-c C-l comint-dynamic-list-input-ring List input history
78 ;;
79 ;; Not bound by default in comint-mode (some are in shell mode)
80 ;; comint-run Run a program under comint-mode
81 ;; send-invisible Read a line w/o echo, and send to proc
82 ;; comint-dynamic-complete-filename Complete filename at point.
83 ;; comint-dynamic-list-filename-completions List completions in help buffer.
84 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
85 ;; replace with expanded/completed name.
86 ;; comint-replace-by-expanded-history Expand history at point;
87 ;; replace with expanded name.
88 ;; comint-magic-space Expand history and add (a) space(s).
89 ;; comint-kill-subjob No mercy.
90 ;; comint-show-maximum-output Show as much output as possible.
91 ;; comint-continue-subjob Send CONT signal to buffer's process
92 ;; group. Useful if you accidentally
93 ;; suspend your process (with C-c C-z).
94 ;; comint-get-next-from-history Fetch successive input history lines
95 ;; comint-accumulate Combine lines to send them together
96 ;; as input.
97 ;; comint-goto-process-mark Move point to where process-mark is.
98 ;; comint-set-process-mark Set process-mark to point.
100 ;; comint-mode-hook is the Comint mode hook. Basically for your keybindings.
102 ;;; Code:
107 \f
108 ;; Buffer Local Variables:
109 ;;============================================================================
110 ;; Comint mode buffer local variables:
111 ;; comint-prompt-regexp string comint-bol uses to match prompt
112 ;; comint-delimiter-argument-list list For delimiters and arguments
113 ;; comint-last-input-start marker Handy if inferior always echoes
114 ;; comint-last-input-end marker For comint-delete-output command
115 ;; comint-input-ring-size integer For the input history
116 ;; comint-input-ring ring mechanism
117 ;; comint-input-ring-index number ...
118 ;; comint-save-input-ring-index number ...
119 ;; comint-input-autoexpand symbol ...
120 ;; comint-input-ignoredups boolean ...
121 ;; comint-dynamic-complete-functions hook For the completion mechanism
122 ;; comint-completion-fignore list ...
123 ;; comint-file-name-chars string ...
124 ;; comint-file-name-quote-list list ...
125 ;; comint-get-old-input function Hooks for specific
126 ;; comint-input-filter-functions hook process-in-a-buffer
127 ;; comint-output-filter-functions hook function modes.
128 ;; comint-preoutput-filter-functions hook
129 ;; comint-input-filter function ...
130 ;; comint-input-sender function ...
131 ;; comint-eol-on-send boolean ...
132 ;; comint-process-echoes boolean ...
133 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
134 ;; comint-move-point-for-output symbol ...
135 ;; comint-scroll-show-maximum-output boolean ...
136 ;; comint-accum-marker maker For comint-accumulate
137 ;;
138 ;; Comint mode non-buffer local variables:
139 ;; comint-completion-addsuffix boolean/cons For file name
140 ;; comint-completion-autolist boolean completion behavior
141 ;; comint-completion-recexact boolean ...
144 "General command interpreter in a window stuff."
148 "Completion facilities in comint."
151 ;; Unused.
152 ;;; (defgroup comint-source nil
153 ;;; "Source finding facilities in comint."
154 ;;; :prefix "comint-"
155 ;;; :group 'comint)
158 "Regexp to recognize prompts in the inferior process.
161 This variable is only used if the variable
162 `comint-use-prompt-regexp' is non-nil.
164 Good choices:
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:
188 (lambda ()
190 (define-key comint-mode-map [remap 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'."
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.
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."
227 "Face to use to highlight user input."
232 "Face to use to highlight prompts."
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."
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."
249 file)
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.
257 The default is nil.
259 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
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.
274 The default is nil.
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."
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."
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."
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'."
325 "Size of the input history ring in `comint-mode'."
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.
362 t)
366 ;; "[[:alpha:]]" used to be "for", which fails to match non-English.
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.
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
386 "List of functions called to perform completion.
387 Works like `completion-at-point-functions'.
388 See also `completion-at-point'.
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
398 "Abnormal hook run before input is sent to the process.
401 ;;;###autoload
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
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.)
427 "Non-nil means go to the end of the line before sending input.
428 See `comint-send-input'."
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.
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)."
448 "Hook run upon entry to `comint-mode'.
449 This is run before the process is cranked up."
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."
463 "Value to use for TERM when the system uses terminfo."
470 ;; Keys:
481 ;; The following two are standardly bound to delete-forward-char,
482 ;; but they should never do EOF, just delete.
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)
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)
504 ;; Mouse Buttons:
505 (define-key map [mouse-2] 'comint-insert-input)
506 ;; Menu bars:
507 ;; completion:
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))
518 ;; Input history:
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))
563 ;; Signals
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))
575 map))
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.
594 (defvar comint-accum-marker nil
595 "Non-nil if you are accumulating input lines to send as input together.
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'.
633 Input ring history expansion can be achieved with the commands
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'.
648 to continue it.
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
689 ;;
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)))))
716 ;;;###autoload
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
724 `start-file-process'
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))
745 buffer)
747 ;;;###autoload
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))
763 ;;;###autoload
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
782 `start-file-process'
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
795 (let ((proc
796 (if (consp command)
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.
805 (cond (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))
809 ;; (sleep-for 1))
810 ;;I hope 1 second is enough!
811 (sleep-for 1)
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)
818 buffer)))
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
825 (nconc
826 (comint-term-environment)
827 (list (format "INSIDE_EMACS=%s,comint" emacs-version))
828 process-environment))
829 (default-directory
830 (if (file-accessible-directory-p default-directory)
831 default-directory
832 "/"))
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
847 ;; conversion.
848 (if (and decoding (not encoding))
849 (setq encoding (coding-system-change-eol-conversion decoding 'unix)
850 changed t))
851 (if changed
852 (set-process-coding-system proc decoding encoding))
853 proc))
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)
866 "TERMCAP="
867 (format "COLUMNS=%d" (window-width)))
868 (list "TERM=emacs"
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."
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')."
879 (interactive "e")
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)))
884 field input)
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
906 (delete-region
907 (or (marker-position comint-accum-marker)
908 (process-mark (get-buffer-process (current-buffer))))
909 (point))
910 ;; Insert the input at point
911 (insert input)))))
912 \f
913 ;; Input history processing in a buffer
914 ;; ===========================================================================
915 ;; Useful input history functions, courtesy of the Ergo group.
917 ;; Eleven commands:
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.
930 ;;
931 ;; Three functions:
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
950 comes last.
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 ""))
955 nil)
956 ((not (file-readable-p comint-input-ring-file-name))
957 (or silent
958 (message "Cannot read history file %s"
959 comint-input-ring-file-name)))
960 (t
961 (let* ((file comint-input-ring-file-name)
962 (count 0)
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)))
968 (with-temp-buffer
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
976 nil t)
977 (setq end (match-beginning 0)))
978 (setq start
979 (if (re-search-backward comint-input-ring-separator
980 nil t)
981 (match-end 0)
982 (point-min)))
983 (setq history (buffer-substring start end))
984 (goto-char start)
985 (when (and (not (string-match comint-input-history-ignore
986 history))
987 (or (null comint-input-ignoredups)
988 (ring-empty-p ring)
989 (not (string-equal (ring-ref ring 0)
990 history))))
991 (when (= count ring-size)
992 (ring-extend ring (min (- comint-input-ring-size ring-size)
993 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))
1012 nil)
1013 ((not (file-writable-p comint-input-ring-file-name))
1014 (message "Cannot write history file %s" comint-input-ring-file-name))
1015 (t
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
1023 (erase-buffer)
1024 (while (> index 0)
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."
1035 (interactive)
1036 (let ((buffer completion-reference-buffer)
1037 beg end completion)
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)))
1042 (if (null beg)
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."
1052 (interactive)
1053 (if (or (not (ring-p comint-input-ring))
1054 (ring-empty-p comint-input-ring))
1055 (message "No history")
1056 (let ((history nil)
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))
1073 (forward-line 3)
1074 (while (search-backward "completion" nil 'move)
1075 (replace-match "history reference")))
1076 (sit-for 0)
1077 (message "Hit space to flush")
1078 (setq comint-dynamic-list-input-ring-window-conf conf)
1079 (let ((ch (read-event)))
1080 (if (eq ch ?\s)
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)
1095 regexp)
1096 regexp)
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"))
1106 ((zerop arg)
1107 ;; arg of zero resets search from beginning, and uses arg of 1
1108 (setq comint-input-ring-index nil)
1109 1)
1110 (t
1111 arg)))
1113 (defun comint-restore-input ()
1114 "Restore unfinished input."
1115 (interactive)
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
1130 (if (>= arg 0)
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))
1140 arg)))
1142 (defun comint-previous-input (arg)
1143 "Cycle backwards through input history, saving input."
1144 (interactive "*p")
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."
1158 (interactive "*p")
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)
1177 (prev nil))
1178 ;; Do the whole search as many times as the argument says.
1179 (while (and (/= arg 0) (not tried-each-ring-item))
1180 ;; Step once.
1181 (setq prev n
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))
1192 n)))
1194 (defun comint-delete-input ()
1195 "Delete all input between accumulation or process mark and point."
1196 (delete-region
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))))
1200 (point-max)))
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?
1211 (if (null pos)
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."
1237 (interactive "p")
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
1243 (buffer-substring
1244 (or (marker-position comint-accum-marker)
1245 (process-mark (get-buffer-process (current-buffer))))
1246 (point))
1247 comint-input-ring-index nil))
1248 (comint-previous-matching-input
1249 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1250 n)
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."
1259 (interactive "p")
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."
1284 (interactive)
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
1294 (save-excursion
1295 (beginning-of-line)
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))
1301 (catch 'dry-run
1302 (comint-replace-by-expanded-history-before-point
1303 silent start 'dry-run)))
1304 (lambda ()
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."
1322 (save-excursion
1323 (let ((toend (- (line-end-position) (point)))
1324 (start (or start (comint-line-beginning-position))))
1325 (goto-char start)
1326 (while (progn
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)
1337 (comint-within-quotes start (point)))
1338 ;; The history is quoted, or we're in quotes.
1339 (goto-char (1+ (point))))
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"))
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)
1350 (match-end 1))))))
1351 (if (<= number (ring-length comint-input-ring))
1352 (progn
1353 (replace-match
1354 (comint-args (comint-previous-input-string number)
1355 (match-beginning 2) (match-end 2))
1356 t t)
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"))))
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))
1366 t t)
1367 (message "History item: previous"))
1368 ((looking-at
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)))
1377 (pos (save-match-data
1378 (comint-previous-matching-input-string-position
1379 (concat pref (regexp-quote exp)) 1))))
1380 (if (null pos)
1381 (progn
1382 (goto-char (match-end 0))
1383 (or silent
1384 (progn (message "Not found")
1385 (ding))))
1386 (setq comint-input-ring-index pos)
1387 (replace-match
1388 (comint-args (ring-ref comint-input-ring pos)
1389 (match-beginning 4) (match-end 4))
1390 t t)
1391 (message "History item: %d" (1+ pos)))))
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)))
1397 (pos nil))
1398 (replace-match (comint-previous-input-string 0) t t)
1399 (setq pos (point))
1400 (goto-char (match-beginning 0))
1401 (if (not (search-forward old pos t))
1402 (or silent
1403 (user-error "Not found"))
1404 (replace-match new t t)
1405 (message "History item: substituted"))))
1406 (t
1407 (forward-char 1)))))
1408 nil))
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'."
1414 (interactive "p")
1415 (comint-replace-by-expanded-history)
1416 (self-insert-command arg))
1417 \f
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))
1431 :group 'comint
1432 :version "23.2")
1434 (defun comint-history-isearch-backward ()
1435 "Search for a string backward in input history using Isearch."
1436 (interactive)
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."
1442 (interactive)
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 (and
1452 ;; Prompt is not empty like in Async Shell Command buffers
1453 ;; or in finished shell buffers
1454 (not (eq (save-excursion
1455 (goto-char (comint-line-beginning-position))
1456 (forward-line 0)
1457 (point))
1458 (comint-line-beginning-position)))
1459 (or (eq comint-history-isearch t)
1460 (and (eq comint-history-isearch 'dwim)
1461 ;; Point is at command line.
1462 (comint-after-pmark-p))))
1463 (setq isearch-message-prefix-add "history ")
1464 (setq-local isearch-search-fun-function
1465 #'comint-history-isearch-search)
1466 (setq-local isearch-message-function
1467 #'comint-history-isearch-message)
1468 (setq-local isearch-wrap-function
1469 #'comint-history-isearch-wrap)
1470 (setq-local isearch-push-state-function
1471 #'comint-history-isearch-push-state)
1472 (add-hook 'isearch-mode-end-hook 'comint-history-isearch-end nil t)))
1474 (defun comint-history-isearch-end ()
1475 "Clean up the comint after terminating Isearch in comint."
1476 (if comint-history-isearch-message-overlay
1477 (delete-overlay comint-history-isearch-message-overlay))
1478 (setq isearch-message-prefix-add nil)
1479 (setq isearch-search-fun-function 'isearch-search-fun-default)
1480 (setq isearch-message-function nil)
1481 (setq isearch-wrap-function nil)
1482 (setq isearch-push-state-function nil)
1483 (remove-hook 'isearch-mode-end-hook 'comint-history-isearch-end t)
1484 (unless isearch-suspended
1485 (custom-reevaluate-setting 'comint-history-isearch)))
1487 (defun comint-goto-input (pos)
1488 "Put input history item of the absolute history position POS."
1489 ;; If leaving the edit line, save partial unfinished input.
1490 (if (null comint-input-ring-index)
1491 (setq comint-stored-incomplete-input
1492 (funcall comint-get-old-input)))
1493 (setq comint-input-ring-index pos)
1494 (comint-delete-input)
1495 (if (and pos (not (ring-empty-p comint-input-ring)))
1496 (insert (ring-ref comint-input-ring pos))
1497 ;; Restore partial unfinished input.
1498 (when (> (length comint-stored-incomplete-input) 0)
1499 (insert comint-stored-incomplete-input))))
1501 (defun comint-history-isearch-search ()
1502 "Return the proper search function, for Isearch in input history."
1503 (lambda (string bound noerror)
1504 (let ((search-fun
1505 ;; Use standard functions to search within comint text
1506 (isearch-search-fun-default))
1507 found)
1508 ;; Avoid lazy-highlighting matches in the comint prompt and in the
1509 ;; output when searching forward. Lazy-highlight calls this lambda
1510 ;; with the bound arg, so skip the prompt and the output.
1511 (if (and bound isearch-forward (not (comint-after-pmark-p)))
1512 (goto-char (process-mark (get-buffer-process (current-buffer)))))
1513 (or
1514 ;; 1. First try searching in the initial comint text
1515 (funcall search-fun string
1516 (if isearch-forward bound (comint-line-beginning-position))
1517 noerror)
1518 ;; 2. If the above search fails, start putting next/prev history
1519 ;; elements in the comint successively, and search the string
1520 ;; in them. Do this only when bound is nil (i.e. not while
1521 ;; lazy-highlighting search strings in the current comint text).
1522 (unless bound
1523 (condition-case nil
1524 (progn
1525 (while (not found)
1526 (cond (isearch-forward
1527 ;; Signal an error here explicitly, because
1528 ;; `comint-next-input' doesn't signal an error.
1529 (when (null comint-input-ring-index)
1530 (error "End of history; no next item"))
1531 (comint-next-input 1)
1532 (goto-char (comint-line-beginning-position)))
1533 (t
1534 ;; Signal an error here explicitly, because
1535 ;; `comint-previous-input' doesn't signal an error.
1536 (when (eq comint-input-ring-index
1537 (1- (ring-length comint-input-ring)))
1538 (error "Beginning of history; no preceding item"))
1539 (comint-previous-input 1)
1540 (goto-char (point-max))))
1541 (setq isearch-barrier (point) isearch-opoint (point))
1542 ;; After putting the next/prev history element, search
1543 ;; the string in them again, until comint-next-input
1544 ;; or comint-previous-input raises an error at the
1545 ;; beginning/end of history.
1546 (setq found (funcall search-fun string
1547 (unless isearch-forward
1548 ;; For backward search, don't search
1549 ;; in the comint prompt
1550 (comint-line-beginning-position))
1551 noerror)))
1552 ;; Return point of the new search result
1553 (point))
1554 ;; Return nil on the error "no next/preceding item"
1555 (error nil)))))))
1557 (defun comint-history-isearch-message (&optional c-q-hack ellipsis)
1558 "Display the input history search prompt.
1559 If there are no search errors, this function displays an overlay with
1560 the Isearch prompt which replaces the original comint prompt.
1561 Otherwise, it displays the standard Isearch message returned from
1562 the function `isearch-message'."
1563 (if (not (and isearch-success (not isearch-error)))
1564 ;; Use standard function `isearch-message' when not in comint prompt,
1565 ;; or search fails, or has an error (like incomplete regexp).
1566 ;; This function displays isearch message in the echo area,
1567 ;; so it's possible to see what is wrong in the search string.
1568 (isearch-message c-q-hack ellipsis)
1569 ;; Otherwise, put the overlay with the standard isearch prompt over
1570 ;; the initial comint prompt.
1571 (if (overlayp comint-history-isearch-message-overlay)
1572 (move-overlay comint-history-isearch-message-overlay
1573 (save-excursion
1574 (goto-char (comint-line-beginning-position))
1575 (forward-line 0)
1576 (point))
1577 (comint-line-beginning-position))
1578 (setq comint-history-isearch-message-overlay
1579 (make-overlay (save-excursion
1580 (goto-char (comint-line-beginning-position))
1581 (forward-line 0)
1582 (point))
1583 (comint-line-beginning-position)))
1584 (overlay-put comint-history-isearch-message-overlay 'evaporate t))
1585 (overlay-put comint-history-isearch-message-overlay
1586 'display (isearch-message-prefix ellipsis isearch-nonincremental))
1587 (if (and comint-input-ring-index (not ellipsis))
1588 ;; Display the current history index.
1589 (message "History item: %d" (1+ comint-input-ring-index))
1590 ;; Or clear a previous isearch message.
1591 (message ""))))
1593 (defun comint-history-isearch-wrap ()
1594 "Wrap the input history search when search fails.
1595 Move point to the first history element for a forward search,
1596 or to the last history element for a backward search."
1597 ;; When `comint-history-isearch-search' fails on reaching the
1598 ;; beginning/end of the history, wrap the search to the first/last
1599 ;; input history element.
1600 (if isearch-forward
1601 (comint-goto-input (1- (ring-length comint-input-ring)))
1602 (comint-goto-input nil))
1603 (setq isearch-success t)
1604 (goto-char (if isearch-forward (comint-line-beginning-position) (point-max))))
1606 (defun comint-history-isearch-push-state ()
1607 "Save a function restoring the state of input history search.
1608 Save `comint-input-ring-index' to the additional state parameter
1609 in the search status stack."
1610 (let ((index comint-input-ring-index))
1611 (lambda (cmd)
1612 (comint-history-isearch-pop-state cmd index))))
1614 (defun comint-history-isearch-pop-state (_cmd hist-pos)
1615 "Restore the input history search state.
1616 Go to the history element by the absolute history position HIST-POS."
1617 (comint-goto-input hist-pos))
1619 \f
1620 (defun comint-within-quotes (beg end)
1621 "Return t if the number of quotes between BEG and END is odd.
1622 Quotes are single and double."
1625 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1627 (defun comint-how-many-region (regexp beg end)
1628 "Return number of matches for REGEXP from BEG to END."
1629 (let ((count 0))
1630 (save-excursion
1631 (save-match-data
1632 (goto-char beg)
1633 (while (re-search-forward regexp end t)
1634 (setq count (1+ count)))))
1635 count))
1637 (defun comint-args (string begin end)
1638 ;; From STRING, return the args depending on the range specified in the text
1639 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1640 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1641 (save-match-data
1642 (if (null begin)
1643 (comint-arguments string 0 nil)
1644 (let* ((range (buffer-substring
1645 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1646 (nth (cond ((string-match "^[*^]" range) 1)
1647 ((string-match "^-" range) 0)
1648 ((string-equal range "$") nil)
1649 (t (string-to-number range))))
1650 (mth (cond ((string-match "[-*$]$" range) nil)
1651 ((string-match "-" range)
1652 (string-to-number (substring range (match-end 0))))
1653 (t nth))))
1654 (comint-arguments string nth mth)))))
1656 (defun comint-delim-arg (arg)
1657 "Return a list of arguments from ARG.
1658 Break it up at the delimiters in `comint-delimiter-argument-list'.
1659 Returned list is backwards.
1661 Characters with non-nil values of the text property `literal' are
1662 assumed to have literal values (e.g., backslash-escaped
1663 characters), and are not considered to be delimiters."
1664 (if (null comint-delimiter-argument-list)
1665 (list arg)
1666 (let ((args nil)
1667 (pos 0)
1668 (len (length arg)))
1669 (while (< pos len)
1670 (let ((char (aref arg pos))
1671 (start pos))
1672 (if (and (memq char comint-delimiter-argument-list)
1673 ;; Ignore backslash-escaped characters.
1674 (not (get-text-property pos 'literal arg)))
1675 (while (and (< pos len) (eq (aref arg pos) char))
1676 (setq pos (1+ pos)))
1677 (while (and (< pos len)
1678 (not (and (memq (aref arg pos)
1679 comint-delimiter-argument-list)
1680 (not (get-text-property
1681 pos 'literal arg)))))
1682 (setq pos (1+ pos))))
1683 (setq args (cons (substring arg start pos) args))))
1684 args)))
1686 (defun comint-arguments (string nth mth)
1687 "Return from STRING the NTH to MTH arguments.
1688 NTH and/or MTH can be nil, which means the last argument.
1689 Returned arguments are separated by single spaces.
1690 We assume whitespace separates arguments, except within quotes
1691 and except for a space or tab that immediately follows a backslash.
1692 Also, a run of one or more of a single character
1693 in `comint-delimiter-argument-list' is a separate argument.
1694 Argument 0 is the command name."
1695 ;; The first line handles ordinary characters and backslash-sequences
1696 ;; (except with w32 msdos-like shells, where backslashes are valid).
1697 ;; The second matches "-quoted strings.
1698 ;; The third matches '-quoted strings.
1699 ;; The fourth matches `-quoted strings.
1700 ;; This seems to fit the syntax of BASH 2.0.
1701 (let* ((backslash-escape (not (and (fboundp 'w32-shell-dos-semantics)
1702 (w32-shell-dos-semantics))))
1703 (first (if backslash-escape
1706 (argpart (concat first
1710 (quote-subexpr (if backslash-escape 2 1))
1711 (args ()) (pos 0)
1712 (count 0)
1713 beg str quotes)
1714 ;; Build a list of all the args until we have as many as we want.
1715 (while (and (or (null mth) (<= count mth))
1716 (string-match argpart string pos))
1717 ;; Apply the `literal' text property to backslash-escaped
1718 ;; characters, so that `comint-delim-arg' won't break them up.
1719 (and backslash-escape
1720 (match-beginning 1)
1721 (put-text-property (match-beginning 1) (match-end 1)
1722 'literal t string))
1723 (if (and beg (= pos (match-beginning 0)))
1724 ;; It's contiguous, part of the same arg.
1725 (setq pos (match-end 0)
1726 quotes (or quotes (match-beginning quote-subexpr)))
1727 ;; It's a new separate arg.
1728 (if beg
1729 ;; Put the previous arg, if there was one, onto ARGS.
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 (setq quotes (match-beginning quote-subexpr))
1735 (setq beg (match-beginning 0))
1736 (setq pos (match-end 0))))
1737 (if beg
1738 (setq str (substring string beg pos)
1739 args (if quotes (cons str args)
1740 (nconc (comint-delim-arg str) args))))
1741 (setq count (length args))
1742 (let ((n (or nth (1- count)))
1743 (m (if mth (1- (- count mth)) 0)))
1744 (mapconcat
1745 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1746 \f
1747 ;;
1748 ;; Input processing stuff
1749 ;;
1750 (defun comint-add-to-input-history (cmd)
1751 "Add CMD to the input history.
1752 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1753 (when (and (funcall comint-input-filter cmd)
1754 (or (null comint-input-ignoredups)
1755 (not (ring-p comint-input-ring))
1756 (ring-empty-p comint-input-ring)
1757 (not (string-equal (ring-ref comint-input-ring 0) cmd))))
1758 ;; If `comint-input-ring' is full, maybe grow it.
1759 (let ((size (ring-size comint-input-ring)))
1760 (and (= size (ring-length comint-input-ring))
1761 (< size comint-input-ring-size)
1762 (ring-extend comint-input-ring
1763 (min size (- comint-input-ring-size size)))))
1764 (ring-insert comint-input-ring cmd)))
1766 (defun comint-send-input (&optional no-newline artificial)
1767 "Send input to process.
1768 After the process output mark, sends all text from the process mark to
1769 point as input to the process. Before the process output mark, calls
1770 value of variable `comint-get-old-input' to retrieve old input, copies
1771 it to the process mark, and sends it.
1773 This command also sends and inserts a final newline, unless
1774 NO-NEWLINE is non-nil.
1776 Any history reference may be expanded depending on the value of the variable
1777 `comint-input-autoexpand'. The list of function names contained in the value
1778 of `comint-input-filter-functions' is called on the input before sending it.
1779 The input is entered into the input history ring, if the value of variable
1780 `comint-input-filter' returns non-nil when called on the input.
1782 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1783 end of line before sending the input.
1785 After the input has been sent, if `comint-process-echoes' is non-nil,
1786 then `comint-send-input' waits to see if the process outputs a string
1787 matching the input, and if so, deletes that part of the output.
1788 If ARTIFICIAL is non-nil, it inhibits such deletion.
1789 Callers sending input not from the user should use ARTIFICIAL = t.
1791 The values of `comint-get-old-input', `comint-input-filter-functions', and
1792 `comint-input-filter' are chosen according to the command interpreter running
1793 in the buffer. E.g.,
1795 If the interpreter is the csh,
1796 `comint-get-old-input' is the default:
1797 If `comint-use-prompt-regexp' is nil, then
1798 either return the current input field, if point is on an input
1799 field, or the current line, if point is on an output field.
1800 If `comint-use-prompt-regexp' is non-nil, then
1801 return the current line with any initial string matching the
1802 regexp `comint-prompt-regexp' removed.
1805 `comint-input-filter' is the default: returns t if the input isn't all white
1806 space.
1808 If the Comint is Lucid Common Lisp,
1809 `comint-get-old-input' snarfs the sexp ending at point.
1810 `comint-input-filter-functions' does nothing.
1811 `comint-input-filter' returns nil if the input matches input-filter-regexp,
1812 which matches (1) all whitespace (2) :a, :c, etc.
1814 Similarly for Soar, Scheme, etc."
1815 (interactive)
1816 ;; If we're currently completing, stop. We're definitely done
1817 ;; completing, and by sending the input, we might cause side effects
1818 ;; that will confuse the code running in the completion
1819 ;; post-command-hook.
1820 (when completion-in-region-mode
1821 (completion-in-region-mode -1))
1822 ;; Note that the input string does not include its terminal newline.
1823 (let ((proc (get-buffer-process (current-buffer))))
1824 (if (not proc) (user-error "Current buffer has no process")
1825 (widen)
1826 (let* ((pmark (process-mark proc))
1827 (intxt (if (>= (point) (marker-position pmark))
1828 (progn (if comint-eol-on-send
1829 (if comint-use-prompt-regexp
1830 (end-of-line)
1831 (goto-char (field-end))))
1832 (buffer-substring pmark (point)))
1833 (let ((copy (funcall comint-get-old-input)))
1834 (goto-char pmark)
1835 (insert copy)
1836 copy)))
1837 (input (if (not (eq comint-input-autoexpand 'input))
1838 ;; Just whatever's already there.
1839 intxt
1840 ;; Expand and leave it visible in buffer.
1841 (comint-replace-by-expanded-history t pmark)
1842 (buffer-substring pmark (point))))
1843 (history (if (not (eq comint-input-autoexpand 'history))
1844 input
1845 ;; This is messy 'cos ultimately the original
1846 ;; functions used do insertion, rather than return
1847 ;; strings. We have to expand, then insert back.
1848 (comint-replace-by-expanded-history t pmark)
1849 (let ((copy (buffer-substring pmark (point)))
1850 (start (point)))
1851 (insert input)
1852 (delete-region pmark start)
1853 copy))))
1855 (unless no-newline
1858 (comint-add-to-input-history history)
1860 (run-hook-with-args 'comint-input-filter-functions
1861 (if no-newline input
1864 (let ((beg (marker-position pmark))
1865 (end (if no-newline (point) (1- (point)))))
1866 (with-silent-modifications
1867 (when (> end beg)
1868 (add-text-properties beg end
1869 '(front-sticky t
1870 font-lock-face comint-highlight-input))
1871 (unless comint-use-prompt-regexp
1872 ;; Give old user input a field property of `input', to
1873 ;; distinguish it from both process output and unsent
1874 ;; input. The terminating newline is put into a special
1875 ;; `boundary' field to make cursor movement between input
1876 ;; and output fields smoother.
1877 (add-text-properties
1878 beg end
1879 '(mouse-face highlight
1880 help-echo "mouse-2: insert after prompt as new input"))))
1881 (unless (or no-newline comint-use-prompt-regexp)
1882 ;; Cover the terminating newline
1883 (add-text-properties end (1+ end)
1884 '(rear-nonsticky t
1885 field boundary
1886 inhibit-line-move-field-capture t)))))
1888 (comint-snapshot-last-prompt)
1890 (setq comint-save-input-ring-index comint-input-ring-index)
1891 (setq comint-input-ring-index nil)
1892 ;; Update the markers before we send the input
1893 ;; in case we get output amidst sending the input.
1894 (set-marker comint-last-input-start pmark)
1895 (set-marker comint-last-input-end (point))
1896 (set-marker (process-mark proc) (point))
1897 ;; clear the "accumulation" marker
1898 (set-marker comint-accum-marker nil)
1899 (let ((comint-input-sender-no-newline no-newline))
1900 (funcall comint-input-sender proc input))
1902 ;; Optionally delete echoed input (after checking it).
1903 (when (and comint-process-echoes (not artificial))
1904 (let ((echo-len (- comint-last-input-end
1905 comint-last-input-start)))
1906 ;; Wait for all input to be echoed:
1907 (while (and (> (+ comint-last-input-end echo-len)
1908 (point-max))
1909 (accept-process-output proc)
1910 (zerop
1911 (compare-buffer-substrings
1912 nil comint-last-input-start
1913 (- (point-max) echo-len)
1914 ;; Above difference is equivalent to
1915 ;; (+ comint-last-input-start
1916 ;; (- (point-max) comint-last-input-end))
1917 nil comint-last-input-end (point-max)))))
1918 (if (and
1919 (<= (+ comint-last-input-end echo-len)
1920 (point-max))
1921 (zerop
1922 (compare-buffer-substrings
1923 nil comint-last-input-start comint-last-input-end
1924 nil comint-last-input-end
1925 (+ comint-last-input-end echo-len))))
1926 ;; Certain parts of the text to be deleted may have
1927 ;; been mistaken for prompts. We have to prevent
1928 ;; problems when `comint-prompt-read-only' is non-nil.
1929 (let ((inhibit-read-only t))
1930 (delete-region comint-last-input-end
1931 (+ comint-last-input-end echo-len))
1932 (when comint-prompt-read-only
1933 (save-excursion
1934 (goto-char comint-last-input-end)
1935 (comint-update-fence)))))))
1937 ;; This used to call comint-output-filter-functions,
1938 ;; but that scrolled the buffer in undesirable ways.
1939 (run-hook-with-args 'comint-output-filter-functions "")))))
1941 (defvar comint-preoutput-filter-functions nil
1942 "List of functions to call before inserting Comint output into the buffer.
1943 Each function gets one argument, a string containing the text received
1944 from the subprocess. It should return the string to insert, perhaps
1945 the same string that was received, or perhaps a modified or transformed
1946 string.
1948 The functions on the list are called sequentially, and each one is
1949 given the string returned by the previous one. The string returned by
1950 the last function is the text that is actually inserted in the
1951 redirection buffer.
1953 You can use `add-hook' to add functions to this list
1954 either globally or locally.")
1956 (defvar comint-inhibit-carriage-motion nil
1957 "If nil, Comint will interpret `carriage control' characters in output.
1958 See `comint-carriage-motion' for details.")
1960 (defvar comint-last-prompt nil
1961 "Markers pointing to the last prompt.
1962 If non-nil, a cons cell containing markers. The car points to
1963 the start, the cdr to the end of the last prompt recognized.")
1965 (defun comint-snapshot-last-prompt ()
1966 "Snapshot the current `comint-last-prompt'.
1967 Freezes the `font-lock-face' text property in place."
1968 (when comint-last-prompt
1969 (with-silent-modifications
1970 (font-lock-prepend-text-property
1971 (car comint-last-prompt)
1972 (cdr comint-last-prompt)
1973 'font-lock-face 'comint-highlight-prompt))
1974 ;; Reset comint-last-prompt so later on comint-output-filter does
1975 ;; not remove the font-lock-face text property of the previous
1976 ;; (this) prompt.
1977 (setq comint-last-prompt nil)))
1979 (defun comint-carriage-motion (start end)
1980 "Interpret carriage control characters in the region from START to END.
1981 Translate carriage return/linefeed sequences to linefeeds.
1982 Make single carriage returns delete to the beginning of the line.
1983 Make backspaces delete the previous character."
1984 (save-excursion
1986 ;; calling save-match-data and save-restriction. But, such a
1987 ;; check is not necessary now because we don't use regexp search
1988 ;; nor save-restriction. Note that the buffer is already widen,
1989 ;; and calling narrow-to-region and widen are not that heavy.
1990 (goto-char start)
1991 (let* ((inhibit-field-text-motion t)
1992 (inhibit-read-only t)
1993 (lbeg (line-beginning-position))
1994 delete-end ch)
1995 ;; If the preceding text is marked as "must-overwrite", record
1996 ;; it in delete-end.
1997 (when (and (> start (point-min))
1998 (get-text-property (1- start) 'comint-must-overwrite))
1999 (setq delete-end (point-marker))
2000 (remove-text-properties lbeg start '(comint-must-overwrite nil)))
2001 (narrow-to-region lbeg end)
2002 ;; Handle BS, LF, and CR specially.
2004 (setq ch (following-char))
2006 (delete-char 1)
2007 (if (> (point) lbeg)
2008 (delete-char -1)))
2010 (when delete-end ; CH = LF
2011 (if (< delete-end (point))
2012 (delete-region lbeg delete-end))
2013 (set-marker delete-end nil)
2014 (setq delete-end nil))
2015 (forward-char 1)
2016 (setq lbeg (point)))
2017 (t ; CH = CR
2018 (delete-char 1)
2019 (if delete-end
2020 (when (< delete-end (point))
2021 (delete-region lbeg delete-end)
2022 (move-marker delete-end (point)))
2023 (setq delete-end (point-marker))))))
2024 (when delete-end
2025 (if (< delete-end (point))
2026 ;; As there's a text after the last CR, make the current
2027 ;; line contain only that text.
2028 (delete-region lbeg delete-end)
2029 ;; Remember that the process output ends by CR, and thus we
2030 ;; must overwrite the contents of the current line next
2031 ;; time.
2032 (put-text-property lbeg delete-end 'comint-must-overwrite t))
2033 (set-marker delete-end nil))
2034 (widen))))
2036 ;; The purpose of using this filter for comint processes
2037 ;; is to keep comint-last-input-end from moving forward
2038 ;; when output is inserted.
2039 (defun comint-output-filter (process string)
2040 (let ((oprocbuf (process-buffer process)))
2041 ;; First check for killed buffer or no input.
2042 (when (and string oprocbuf (buffer-name oprocbuf))
2043 (with-current-buffer oprocbuf
2044 ;; Run preoutput filters
2045 (let ((functions comint-preoutput-filter-functions))
2046 (while (and functions string)
2047 (if (eq (car functions) t)
2048 (let ((functions
2049 (default-value 'comint-preoutput-filter-functions)))
2050 (while (and functions string)
2051 (setq string (funcall (car functions) string))
2052 (setq functions (cdr functions))))
2053 (setq string (funcall (car functions) string)))
2054 (setq functions (cdr functions))))
2056 ;; Insert STRING
2057 (let ((inhibit-read-only t)
2058 ;; The point should float after any insertion we do.
2059 (saved-point (copy-marker (point) t)))
2061 ;; We temporarily remove any buffer narrowing, in case the
2062 ;; process mark is outside of the restriction
2063 (save-restriction
2064 (widen)
2066 (goto-char (process-mark process))
2067 (set-marker comint-last-output-start (point))
2069 ;; Try to skip repeated prompts, which can occur as a result of
2070 ;; commands sent without inserting them in the buffer.
2071 (let ((bol (save-excursion (forward-line 0) (point)))) ;No fields.
2072 (when (and (not (bolp))
2073 (looking-back comint-prompt-regexp bol))
2074 (let* ((prompt (buffer-substring bol (point)))
2076 (while (string-match prompt-re string)
2077 (setq string (substring string (match-end 0)))))))
2080 string)
2083 ;; insert-before-markers is a bad thing. XXX
2084 ;; Luckily we don't have to use it any more, we use
2085 ;; window-point-insertion-type instead.
2086 (insert string)
2088 ;; Advance process-mark
2089 (set-marker (process-mark process) (point))
2091 (unless comint-inhibit-carriage-motion
2092 ;; Interpret any carriage motion characters (newline, backspace)
2093 (comint-carriage-motion comint-last-output-start (point)))
2095 ;; Run these hooks with point where the user had it.
2096 (goto-char saved-point)
2097 (run-hook-with-args 'comint-output-filter-functions string)
2098 (set-marker saved-point (point))
2100 (goto-char (process-mark process)) ; In case a filter moved it.
2102 (unless comint-use-prompt-regexp
2103 (with-silent-modifications
2104 (add-text-properties comint-last-output-start (point)
2105 '(front-sticky
2106 (field inhibit-line-move-field-capture)
2107 rear-nonsticky t
2108 field output
2109 inhibit-line-move-field-capture t))))
2111 ;; Highlight the prompt, where we define `prompt' to mean
2112 ;; the most recent output that doesn't end with a newline.
2113 (let ((prompt-start (save-excursion (forward-line 0) (point)))
2114 (inhibit-read-only t))
2115 (when comint-prompt-read-only
2116 (with-silent-modifications
2117 (or (= (point-min) prompt-start)
2118 (get-text-property (1- prompt-start) 'read-only)
2119 (put-text-property (1- prompt-start)
2120 prompt-start 'read-only 'fence))
2121 (add-text-properties prompt-start (point)
2122 '(read-only t front-sticky (read-only)))))
2123 (when comint-last-prompt
2124 ;; There might be some keywords here waiting for
2125 ;; fontification, so no `with-silent-modifications'.
2126 (font-lock--remove-face-from-text-property
2127 (car comint-last-prompt)
2128 (cdr comint-last-prompt)
2129 'font-lock-face
2130 'comint-highlight-prompt))
2131 (setq comint-last-prompt
2132 (cons (copy-marker prompt-start) (point-marker)))
2133 (font-lock-prepend-text-property prompt-start (point)
2134 'font-lock-face
2135 'comint-highlight-prompt)
2136 (add-text-properties prompt-start (point) '(rear-nonsticky t)))
2137 (goto-char saved-point)))))))
2139 (defun comint-preinput-scroll-to-bottom ()
2140 "Go to the end of buffer in all windows showing it.
2141 Movement occurs if point in the selected window is not after the process mark,
2142 and `this-command' is an insertion command. Insertion commands recognized
2143 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
2144 Depends on the value of `comint-scroll-to-bottom-on-input'.
2146 This function should be a pre-command hook."
2147 (if (and comint-scroll-to-bottom-on-input
2148 (memq this-command '(self-insert-command comint-magic-space yank
2149 hilit-yank)))
2150 (let* ((current (current-buffer))
2151 (process (get-buffer-process current))
2152 (scroll comint-scroll-to-bottom-on-input))
2153 (if (and process (< (point) (process-mark process)))
2154 (if (eq scroll 'this)
2155 (goto-char (point-max))
2156 (walk-windows
2157 (lambda (window)
2158 (if (and (eq (window-buffer window) current)
2159 (or (eq scroll t) (eq scroll 'all)))
2160 (with-selected-window window
2161 (goto-char (point-max)))))
2162 nil t))))))
2164 (defvar follow-mode)
2165 (declare-function follow-comint-scroll-to-bottom "follow" (&optional window))
2167 (defun comint-postoutput-scroll-to-bottom (_string)
2168 "Go to the end of buffer in some or all windows showing it.
2169 Do not scroll if the current line is the last line in the buffer.
2170 Depends on the value of `comint-move-point-for-output' and
2171 `comint-scroll-show-maximum-output'.
2173 This function should be in the list `comint-output-filter-functions'."
2174 (let* ((current (current-buffer))
2175 (process (get-buffer-process current)))
2176 (unwind-protect
2177 (cond
2178 ((null process))
2179 ((bound-and-true-p follow-mode)
2180 (follow-comint-scroll-to-bottom))
2181 (t
2182 (dolist (w (get-buffer-window-list current nil t))
2183 (comint-adjust-window-point w process)
2184 ;; Optionally scroll to the bottom of the window.
2185 (and comint-scroll-show-maximum-output
2186 (eq (window-point w) (point-max))
2187 (with-selected-window w
2188 (recenter (- -1 scroll-margin)))))))
2189 (set-buffer current))))
2192 (defun comint-adjust-window-point (window process)
2193 "Move point in WINDOW based on Comint settings.
2194 For point adjustment use the process-mark of PROCESS."
2195 (and (< (window-point window) (process-mark process))
2196 (or (memq comint-move-point-for-output '(t all))
2197 ;; Maybe user wants point to jump to end.
2198 (eq comint-move-point-for-output
2199 (if (eq (selected-window) window) 'this 'others))
2200 ;; If point was at the end, keep it at end.
2201 (and (marker-position comint-last-output-start)
2202 (>= (window-point window) comint-last-output-start)))
2203 (set-window-point window (process-mark process))))
2206 ;; this function is nowhere used
2207 (defun comint-adjust-point (selected)
2208 "Move point in the selected window based on Comint settings.
2209 SELECTED is the window that was originally selected."
2210 (let ((process (get-buffer-process (current-buffer))))
2211 (and (< (point) (process-mark process))
2212 (or (memq comint-move-point-for-output '(t all))
2213 ;; Maybe user wants point to jump to end.
2214 (eq comint-move-point-for-output
2215 (if (eq (selected-window) selected) 'this 'others))
2216 ;; If point was at the end, keep it at end.
2217 (and (marker-position comint-last-output-start)
2218 (>= (point) comint-last-output-start)))
2219 (goto-char (process-mark process)))))
2221 (defun comint-truncate-buffer (&optional _string)
2222 "Truncate the buffer to `comint-buffer-maximum-size'.
2223 This function could be on `comint-output-filter-functions' or bound to a key."
2224 (interactive)
2225 (save-excursion
2226 (goto-char (process-mark (get-buffer-process (current-buffer))))
2227 (forward-line (- comint-buffer-maximum-size))
2228 (beginning-of-line)
2229 (let ((inhibit-read-only t))
2230 (delete-region (point-min) (point)))))
2232 (defun comint-strip-ctrl-m (&optional _string)
2233 "Strip trailing `^M' characters from the current output group.
2234 This function could be on `comint-output-filter-functions' or bound to a key."
2235 (interactive)
2236 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2237 (save-excursion
2238 (condition-case nil
2239 (goto-char
2240 (if (called-interactively-p 'interactive)
2241 comint-last-input-end comint-last-output-start))
2242 (error nil))
2244 (replace-match "" t t)))))
2245 (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
2247 (defun comint-show-maximum-output ()
2248 "Put the end of the buffer at the bottom of the window."
2249 (interactive)
2250 (goto-char (point-max))
2251 (recenter (- -1 scroll-margin)))
2253 (defun comint-get-old-input-default ()
2254 "Default for `comint-get-old-input'.
2255 If `comint-use-prompt-regexp' is nil, then either
2256 return the current input field, if point is on an input field, or the
2257 current line, if point is on an output field.
2258 If `comint-use-prompt-regexp' is non-nil, then return
2259 the current line with any initial string matching the regexp
2260 `comint-prompt-regexp' removed."
2261 (let (bof)
2262 (if (and (not comint-use-prompt-regexp)
2263 ;; Make sure we're in an input rather than output field.
2264 (null (get-char-property (setq bof (field-beginning)) 'field)))
2265 (field-string-no-properties bof)
2266 (comint-bol)
2267 (buffer-substring-no-properties (point)
2268 (if comint-use-prompt-regexp
2269 (line-end-position)
2270 (field-end))))))
2272 (defun comint-copy-old-input ()
2273 "Insert after prompt old input at point as new input to be edited.
2274 Calls `comint-get-old-input' to get old input."
2275 (interactive)
2276 (let ((input (funcall comint-get-old-input))
2277 (process (get-buffer-process (current-buffer))))
2278 (if (not process)
2279 (user-error "Current buffer has no process")
2280 (goto-char (process-mark process))
2281 (insert input))))
2283 (defun comint-skip-prompt ()
2284 "Skip past the text matching regexp `comint-prompt-regexp'.
2285 If this takes us past the end of the current line, don't skip at all."
2286 (if (and (looking-at comint-prompt-regexp)
2287 (<= (match-end 0) (line-end-position)))
2288 (goto-char (match-end 0))))
2290 (defun comint-after-pmark-p ()
2291 "Return t if point is after the process output marker."
2292 (let ((process (get-buffer-process (current-buffer))))
2293 (when process
2294 (let ((pmark (process-mark process)))
2295 (<= (marker-position pmark) (point))))))
2297 (defun comint-simple-send (proc string)
2298 "Default function for sending to PROC input STRING.
2299 This just sends STRING plus a newline. To override this,
2300 set the hook `comint-input-sender'."
2301 (let ((send-string
2302 (if comint-input-sender-no-newline
2303 string
2304 ;; Sending as two separate strings does not work
2307 (comint-send-string proc send-string))
2308 (if (and comint-input-sender-no-newline
2309 (not (string-equal string "")))
2310 (process-send-eof)))
2312 (defun comint-line-beginning-position ()
2313 "Return the buffer position of the beginning of the line, after any prompt.
2314 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done by
2315 skipping text matching the regular expression `comint-prompt-regexp',
2316 a buffer local variable."
2317 (if comint-use-prompt-regexp
2318 ;; Use comint-prompt-regexp
2319 (save-excursion
2320 (beginning-of-line)
2321 (comint-skip-prompt)
2322 (point))
2323 ;; Use input fields. Note that, unlike the behavior of
2324 ;; `line-beginning-position' inside a field, this function will
2325 ;; return the position of the end of a prompt, even if the point is
2326 ;; already inside the prompt. In order to do this, it assumes that
2327 ;; if there are two fields on a line, then the first one is the
2328 ;; prompt, and the second one is an input field, and is front-sticky
2329 ;; (as input fields should be).
2330 (constrain-to-field (if (eq (field-at-pos (point)) 'output)
2331 (line-beginning-position)
2332 (field-beginning))
2333 (line-end-position))))
2335 (defun comint-bol (&optional arg)
2336 "Go to the beginning of line, then skip past the prompt, if any.
2338 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done
2339 by skipping text matching the regular expression `comint-prompt-regexp',
2340 a buffer local variable."
2341 (interactive "P")
2342 (if arg
2343 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
2344 (forward-line 0)
2345 (goto-char (comint-line-beginning-position))))
2347 ;; For compatibility.
2348 (defun comint-read-noecho (prompt &optional _ignore)
2349 (read-passwd prompt))
2351 ;; These three functions are for entering text you don't want echoed or
2352 ;; saved -- typically passwords to ftp, telnet, or somesuch.
2353 ;; Just enter m-x send-invisible and type in your line.
2355 (defun send-invisible (&optional prompt)
2356 "Read a string without echoing.
2357 Then send it to the process running in the current buffer.
2358 The string is sent using `comint-input-sender'.
2359 Security bug: your string can still be temporarily recovered with
2361 (interactive "P") ; Defeat snooping via C-x ESC ESC
2362 (let ((proc (get-buffer-process (current-buffer)))
2363 (prefix
2364 (if (eq (window-buffer) (current-buffer))
2365 ""
2366 (format "(In buffer %s) "
2367 (current-buffer)))))
2368 (if proc
2369 (let ((str (read-passwd (concat prefix
2370 (or prompt "Non-echoed text: ")))))
2371 (if (stringp str)
2372 (progn
2373 (comint-snapshot-last-prompt)
2374 (funcall comint-input-sender proc str))
2375 (message "Warning: text will be echoed")))
2376 (error "Buffer %s has no process" (current-buffer)))))
2378 (defun comint-watch-for-password-prompt (string)
2379 "Prompt in the minibuffer for password and send without echoing.
2380 This function uses `send-invisible' to read and send a password to the buffer's
2381 process if STRING contains a password prompt defined by
2382 `comint-password-prompt-regexp'.
2384 This function could be in the list `comint-output-filter-functions'."
2385 (when (let ((case-fold-search t))
2386 (string-match comint-password-prompt-regexp string))
2388 (setq string (replace-match "" t t string)))
2389 (send-invisible string)))
2390 \f
2391 ;; Low-level process communication
2393 (defun comint-send-string (process string)
2394 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
2395 (if process
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-string process string))
2403 (defun comint-send-region (process start end)
2404 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
2405 (if process
2406 (with-current-buffer (if (processp process)
2407 (process-buffer process)
2408 (get-buffer process))
2409 (comint-snapshot-last-prompt))
2410 (comint-snapshot-last-prompt))
2411 (process-send-region process start end))
2413 \f
2414 ;; Random input hackage
2416 (defun comint-delete-output ()
2417 "Delete all output from interpreter since last input.
2418 Does not delete the prompt."
2419 (interactive)
2420 (let ((proc (get-buffer-process (current-buffer)))
2421 (replacement nil)
2422 (inhibit-read-only t))
2423 (save-excursion
2424 (let ((pmark (progn (goto-char (process-mark proc))
2425 (forward-line 0)
2426 (point-marker))))
2427 (delete-region comint-last-input-end pmark)
2428 (goto-char (process-mark proc))
2430 (buffer-substring pmark (point))))
2431 (delete-region pmark (point))))
2432 ;; Output message and put back prompt
2433 (comint-output-filter proc replacement)))
2435 (defun comint-write-output (filename &optional append mustbenew)
2436 "Write output from interpreter since last input to FILENAME.
2437 Any prompt at the end of the output is not written.
2439 If the optional argument APPEND (the prefix argument when interactive)
2440 is non-nil, the output is appended to the file instead.
2442 If the optional argument MUSTBENEW is non-nil, check for an existing
2443 file with the same name. If MUSTBENEW is `excl', that means to get an
2444 error if the file already exists; never overwrite. If MUSTBENEW is
2445 neither nil nor `excl', that means ask for confirmation before
2446 overwriting, but do go ahead and overwrite the file if the user
2447 confirms. When interactive, MUSTBENEW is nil when appending, and t
2448 otherwise."
2449 (interactive
2450 (list (read-file-name
2451 (if current-prefix-arg
2452 "Append output to file: "
2453 "Write output to file: "))
2454 current-prefix-arg
2455 (not current-prefix-arg)))
2456 (save-excursion
2457 (goto-char (process-mark (get-buffer-process (current-buffer))))
2458 (forward-line 0)
2459 (write-region comint-last-input-end (point) filename
2460 append nil nil mustbenew)))
2462 ;; This function exists for the benefit of the menu; from the keyboard,
2463 ;; users can just use `comint-write-output' with a prefix arg.
2464 (defun comint-append-output-to-file (filename)
2465 "Append output from interpreter since last input to FILENAME.
2466 Any prompt at the end of the output is not written."
2467 (interactive "fAppend output to file: ")
2468 (comint-write-output filename t))
2470 (defun comint-show-output ()
2471 "Display start of this batch of interpreter output at top of window.
2472 Sets mark to the value of point when this command is run."
2473 (interactive)
2474 (push-mark)
2475 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
2476 (cond (comint-use-prompt-regexp
2477 (goto-char pos)
2478 (beginning-of-line 0)
2479 (set-window-start (selected-window) (point))
2480 (comint-skip-prompt))
2481 (t
2482 (goto-char (field-beginning pos))
2483 (set-window-start (selected-window) (point))))))
2485 (defun comint-clear-buffer ()
2486 "Clear the comint buffer."
2487 (interactive)
2488 (let ((comint-buffer-maximum-size 0))
2489 (comint-truncate-buffer)))
2491 (defun comint-interrupt-subjob ()
2492 "Interrupt the current subjob."
2493 (interactive)
2494 (comint-skip-input)
2495 (interrupt-process nil comint-ptyp)
2497 )
2499 (defun comint-kill-subjob ()
2500 "Send kill signal to the current subjob."
2501 (interactive)
2502 (comint-skip-input)
2503 (kill-process nil comint-ptyp))
2505 (defun comint-quit-subjob ()
2506 "Send quit signal to the current subjob."
2507 (interactive)
2508 (comint-skip-input)
2509 (quit-process nil comint-ptyp))
2511 (defun comint-stop-subjob ()
2512 "Stop the current subjob.
2514 WARNING: if there is no current subjob, you can end up suspending
2515 the top-level process running in the buffer. If you accidentally do
2517 is not a problem with most shells, since they ignore this signal.)"
2518 (interactive)
2519 (comint-skip-input)
2520 (stop-process nil comint-ptyp))
2522 (defun comint-continue-subjob ()
2523 "Send CONT signal to process buffer's process group.
2524 Useful if you accidentally suspend the top-level process."
2525 (interactive)
2526 (continue-process nil comint-ptyp))
2528 (defun comint-skip-input ()
2529 "Skip all pending input, from last stuff output by interpreter to point.
2530 This means mark it as if it had been sent as input, without sending it."
2531 (let ((comint-input-sender 'ignore)
2532 (comint-input-filter-functions nil))
2533 (comint-send-input t t))
2534 (end-of-line)
2535 (let ((pos (point))
2536 (marker (process-mark (get-buffer-process (current-buffer)))))
2537 (insert " " (key-description (this-command-keys)))
2538 (if (= marker pos)
2539 (set-marker marker (point)))))
2541 (defun comint-kill-input ()
2542 "Kill all text from last stuff output by interpreter to point."
2543 (interactive)
2544 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2545 (if (> (point) (marker-position pmark))
2546 (kill-region pmark (point)))))
2548 (defun comint-delchar-or-maybe-eof (arg)
2549 "Delete ARG characters forward or send an EOF to subprocess.
2550 Sends an EOF only if point is at the end of the buffer and there is no input."
2551 (interactive "p")
2552 (let ((proc (get-buffer-process (current-buffer))))
2553 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
2554 (comint-send-eof)
2555 (delete-char arg))))
2557 (defun comint-send-eof ()
2558 "Send an EOF to the current buffer's process."
2559 (interactive)
2560 (comint-send-input t t)
2561 (process-send-eof))
2564 (defun comint-backward-matching-input (regexp n)
2565 "Search backward through buffer for input fields that match REGEXP.
2566 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2567 by lines that match `comint-prompt-regexp'.
2569 With prefix argument N, search for Nth previous match.
2570 If N is negative, find the next or Nth next match."
2571 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2572 (if comint-use-prompt-regexp
2573 ;; Use comint-prompt-regexp
2574 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2575 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2576 (if (re-search-backward re nil t n)
2577 (point)))))
2578 (if (null pos)
2579 (progn (message "Not found")
2580 (ding))
2581 (goto-char pos)
2582 (comint-bol nil)))
2583 ;; Use input fields
2584 (let* ((dir (if (< n 0) -1 1))
2585 (pos
2586 (save-excursion
2587 (while (/= n 0)
2588 (unless (re-search-backward regexp nil t dir)
2589 (user-error "Not found"))
2590 (unless (get-char-property (point) 'field)
2591 (setq n (- n dir))))
2592 (field-beginning))))
2593 (goto-char pos))))
2596 (defun comint-forward-matching-input (regexp n)
2597 "Search forward through buffer for input fields that match REGEXP.
2598 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2599 by lines that match `comint-prompt-regexp'.
2601 With prefix argument N, search for Nth following match.
2602 If N is negative, find the previous or Nth previous match."
2603 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2604 (comint-backward-matching-input regexp (- n)))
2607 (defun comint-next-prompt (n)
2608 "Move to end of Nth next prompt in the buffer.
2609 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2610 the Nth next `input' field, otherwise, it means the Nth occurrence of
2611 text matching `comint-prompt-regexp'."
2612 (interactive "p")
2613 (if comint-use-prompt-regexp
2614 ;; Use comint-prompt-regexp
2615 (let ((paragraph-start comint-prompt-regexp))
2616 (end-of-line (if (> n 0) 1 0))
2617 (forward-paragraph n)
2618 (comint-skip-prompt))
2619 ;; Use input fields
2620 (let ((pos (point))
2621 (input-pos nil)
2622 prev-pos)
2623 (while (/= n 0)
2624 (setq prev-pos pos)
2625 (setq pos
2626 (if (> n 0)
2627 (next-single-char-property-change pos 'field)
2628 (previous-single-char-property-change pos 'field)))
2629 (cond ((= pos prev-pos)
2630 ;; Ran off the end of the buffer.
2631 (when (> n 0)
2632 ;; There's always an input field at the end of the
2633 ;; buffer, but it has a `field' property of nil.
2634 (setq input-pos (point-max)))
2635 ;; stop iterating
2636 (setq n 0))
2637 ((null (get-char-property pos 'field))
2638 (setq n (if (< n 0) (1+ n) (1- n)))
2639 (setq input-pos pos))))
2640 (when input-pos
2641 (goto-char input-pos)))))
2644 (defun comint-previous-prompt (n)
2645 "Move to end of Nth previous prompt in the buffer.
2646 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2647 the Nth previous `input' field, otherwise, it means the Nth occurrence of
2648 text matching `comint-prompt-regexp'."
2649 (interactive "p")
2650 (comint-next-prompt (- n)))
2652 ;; State used by `comint-insert-previous-argument' when cycling.
2653 (defvar-local comint-insert-previous-argument-last-start-pos nil)
2654 (defvar-local comint-insert-previous-argument-last-index nil)
2656 ;; Needs fixing:
2657 ;; make comint-arguments understand negative indices as bash does
2658 (defun comint-insert-previous-argument (index)
2659 "Insert the INDEXth argument from the previous Comint command-line at point.
2660 Spaces are added at beginning and/or end of the inserted string if
2661 necessary to ensure that it's separated from adjacent arguments.
2662 Interactively, if no prefix argument is given, the last argument is inserted.
2663 Repeated interactive invocations will cycle through the same argument
2664 from progressively earlier commands (using the value of INDEX specified
2665 with the first command).
2666 This command is like `M-.' in bash."
2667 (interactive "P")
2668 (unless (null index)
2669 (setq index (prefix-numeric-value index)))
2670 (cond ((eq last-command this-command)
2671 ;; Delete last input inserted by this command.
2672 (delete-region comint-insert-previous-argument-last-start-pos (point))
2673 (setq index comint-insert-previous-argument-last-index))
2674 (t
2675 ;; This is a non-repeat invocation, so initialize state.
2676 (setq comint-input-ring-index nil)
2677 (setq comint-insert-previous-argument-last-index index)
2678 (when (null comint-insert-previous-argument-last-start-pos)
2679 ;; First usage; initialize to a marker
2680 (setq comint-insert-previous-argument-last-start-pos
2681 (make-marker)))))
2682 ;; Make sure we're not in the prompt, and add a beginning space if necessary.
2683 (if (<= (point) (comint-line-beginning-position))
2684 (comint-bol)
2685 (just-one-space))
2686 ;; Remember the beginning of what we insert, so we can delete it if
2687 ;; the command is repeated.
2688 (set-marker comint-insert-previous-argument-last-start-pos (point))
2689 ;; Insert the argument.
2690 (let ((input-string (comint-previous-input-string 0)))
2692 ;; strip terminating '&'
2693 (setq input-string (substring input-string 0 (match-beginning 0))))
2694 (insert (comint-arguments input-string index index)))
2695 ;; Make next invocation return arg from previous input
2696 (setq comint-input-ring-index (1+ (or comint-input-ring-index 0)))
2697 ;; Add a terminating space if necessary.
2698 (unless (eolp)
2699 (just-one-space)))
2701 \f
2702 ;; Support editing with `comint-prompt-read-only' set to t.
2704 (defun comint-update-fence ()
2705 "Update read-only status of newline before point.
2706 The `fence' read-only property is used to indicate that a newline
2708 following front-sticky read-only region. This is used to
2709 implement comint read-only prompts. If the text after a newline
2710 changes, the read-only status of that newline may need updating.
2711 That is what this function does.
2713 This function does nothing if point is not at the beginning of a
2714 line, or is at the beginning of the accessible portion of the buffer.
2715 Otherwise, if the character after point has a front-sticky
2716 read-only property, then the preceding newline is given a
2717 read-only property of `fence', unless it already is read-only.
2718 If the character after point does not have a front-sticky
2719 read-only property, any read-only property of `fence' on the
2720 preceding newline is removed."
2721 (let* ((pt (point)) (lst (get-text-property pt 'front-sticky)))
2722 (and (bolp)
2723 (not (bobp))
2724 (with-silent-modifications
2725 (if (and (get-text-property pt 'read-only)
2726 (if (listp lst) (memq 'read-only lst) t))
2727 (unless (get-text-property (1- pt) 'read-only)
2728 (put-text-property (1- pt) pt 'read-only 'fence))
2729 (when (eq (get-text-property (1- pt) 'read-only) 'fence)
2730 (remove-list-of-text-properties (1- pt) pt '(read-only))))))))
2732 (defun comint-kill-whole-line (&optional count)
2733 "Kill current line, ignoring read-only and field properties.
2734 With prefix arg COUNT, kill that many lines starting from the current line.
2735 If COUNT is negative, kill backward. Also kill the preceding newline,
2737 with negative arguments.)
2738 If COUNT is zero, kill current line but exclude the trailing newline.
2739 The read-only status of newlines is updated with `comint-update-fence',
2740 if necessary."
2741 (interactive "p")
2742 (let ((inhibit-read-only t) (inhibit-field-text-motion t))
2743 (kill-whole-line count)
2744 (when (>= count 0) (comint-update-fence))))
2746 (defun comint-kill-region (beg end)
2747 "Like `kill-region', but ignores read-only properties, if safe.
2748 This command assumes that the buffer contains read-only
2750 properties at the beginning of a line, with the preceding newline
2751 being read-only to protect the prompt. This is true of the
2752 comint prompts if `comint-prompt-read-only' is non-nil. This
2753 command will not delete the region if this would create mutilated
2754 or out of place prompts. That is, if any part of a prompt is
2755 deleted, the entire prompt must be deleted and all remaining
2756 prompts should stay at the beginning of a line. If this is not
2757 the case, this command just calls `kill-region' with all
2758 read-only properties intact. The read-only status of newlines is
2759 updated using `comint-update-fence', if necessary."
2760 (interactive "r")
2761 (save-excursion
2762 (let* ((true-beg (min beg end))
2763 (true-end (max beg end))
2764 (beg-bolp (progn (goto-char true-beg) (bolp)))
2765 (beg-lst (get-text-property true-beg 'front-sticky))
2766 (beg-bad (and (get-text-property true-beg 'read-only)
2767 (if (listp beg-lst) (memq 'read-only beg-lst) t)))
2768 (end-bolp (progn (goto-char true-end) (bolp)))
2769 (end-lst (get-text-property true-end 'front-sticky))
2770 (end-bad (and (get-text-property true-end 'read-only)
2771 (if (listp end-lst) (memq 'read-only end-lst) t))))
2772 (if (or (and (not beg-bolp) (or beg-bad end-bad))
2773 (and (not end-bolp) end-bad))
2774 (kill-region beg end)
2775 (let ((inhibit-read-only t))
2776 (kill-region beg end)
2777 (comint-update-fence))))))
2778 \f
2779 ;; Support for source-file processing commands.
2780 ;;============================================================================
2781 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2782 ;; commands that process files of source text (e.g. loading or compiling
2783 ;; files). So the corresponding process-in-a-buffer modes have commands
2784 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2785 ;; for defining these commands.
2786 ;;
2787 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2788 ;; and Soar, in that they don't know anything about file extensions.
2789 ;; So the compile/load interface gets the wrong default occasionally.
2790 ;; The load-file/compile-file default mechanism could be smarter -- it
2791 ;; doesn't know about the relationship between filename extensions and
2792 ;; whether the file is source or executable. If you compile foo.lisp
2793 ;; with compile-file, then the next load-file should use foo.bin for
2794 ;; the default, not foo.lisp. This is tricky to do right, particularly
2795 ;; because the extension for executable files varies so much (.o, .bin,
2796 ;; .lbin, .mo, .vo, .ao, ...).
2799 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2800 ;; commands.
2801 ;;
2802 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2803 ;; want to save the buffer before issuing any process requests to the command
2804 ;; interpreter.
2805 ;;
2806 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2807 ;; for the file to process.
2809 (defun comint-source-default (previous-dir/file source-modes)
2810 "Compute the defaults for `load-file' and `compile-file' commands.
2812 PREVIOUS-DIR/FILE is a pair (DIRECTORY . FILENAME) from the last
2813 source-file processing command, or nil if there hasn't been one yet.
2814 SOURCE-MODES is a list used to determine what buffers contain source
2815 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2816 Typically, (lisp-mode) or (scheme-mode).
2818 If the command is given while the cursor is inside a string, *and*
2819 the string is an existing filename, *and* the filename is not a directory,
2820 then the string is taken as default. This allows you to just position
2821 your cursor over a string that's a filename and have it taken as default.
2823 If the command is given in a file buffer whose major mode is in
2824 SOURCE-MODES, then the filename is the default file, and the
2825 file's directory is the default directory.
2827 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2828 then the default directory & file are what was used in the last source-file
2829 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2830 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2833 SOURCE-MODES is typically going to be something like (tea-mode)
2834 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2835 for Soar programs, etc.
2837 The function returns a pair: (default-directory . default-file)."
2838 (cond ((and buffer-file-name (memq major-mode source-modes))
2839 (cons (file-name-directory buffer-file-name)
2840 (file-name-nondirectory buffer-file-name)))
2841 (previous-dir/file)
2842 (t
2843 (cons default-directory nil))))
2846 (defun comint-check-source (fname)
2847 "Check whether to save buffers visiting file FNAME.
2848 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2849 process-in-a-buffer modes), this function can be called on the filename.
2850 If the file is loaded into a buffer, and the buffer is modified, the user
2851 is queried to see if he wants to save the buffer before proceeding with
2852 the load or compile."
2853 (let ((buff (get-file-buffer fname)))
2854 (if (and buff
2855 (buffer-modified-p buff)
2856 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
2857 (with-current-buffer buff
2858 (save-buffer)))))
2860 (defun comint-extract-string ()
2861 "Return string around point, or nil."
2862 (let ((syntax (syntax-ppss)))
2863 (when (nth 3 syntax)
2864 (condition-case ()
2865 (buffer-substring-no-properties (1+ (nth 8 syntax))
2866 (progn (goto-char (nth 8 syntax))
2867 (forward-sexp)
2868 (1- (point))))
2869 (error nil)))))
2871 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2872 "Prompt for filenames in commands that process source files,
2873 e.g. loading or compiling a file.
2874 Provides a default, if there is one, and returns the result filename.
2876 See `comint-source-default' for more on determining defaults.
2878 PROMPT is the prompt string. PREV-DIR/FILE is the (DIRECTORY . FILE) pair
2879 from the last source processing command. SOURCE-MODES is a list of major
2880 modes used to determine what file buffers contain source files. (These
2881 two arguments are used for determining defaults.) If MUSTMATCH-P is true,
2882 then the filename reader will only accept a file that exists.
2884 A typical use:
2887 (let* ((def (comint-source-default prev-dir/file source-modes))
2888 (stringfile (comint-extract-string))
2889 (sfile-p (and stringfile
2890 (condition-case ()
2891 (file-exists-p stringfile)
2892 (error nil))
2893 (not (file-directory-p stringfile))))
2894 (defdir (if sfile-p (file-name-directory stringfile)
2895 (car def)))
2896 (deffile (if sfile-p (file-name-nondirectory stringfile)
2897 (cdr def)))
2898 (ans (read-file-name (if deffile (format "%s(default %s) "
2899 prompt deffile)
2900 prompt)
2901 defdir
2902 (concat defdir deffile)
2903 mustmatch-p)))
2904 (list (expand-file-name (substitute-in-file-name ans)))))
2906 ;; I am somewhat divided on this string-default feature. It seems
2907 ;; to violate the principle-of-least-astonishment, in that it makes
2908 ;; the default harder to predict, so you actually have to look and see
2909 ;; what the default really is before choosing it. This can trip you up.
2910 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2911 ;; on this.
2912 ;; -Olin
2914 \f
2915 ;; Simple process query facility.
2916 ;; ===========================================================================
2917 ;; This function is for commands that want to send a query to the process
2918 ;; and show the response to the user. For example, a command to get the
2919 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2920 ;; to an inferior Common Lisp process.
2921 ;;
2922 ;; This simple facility just sends strings to the inferior process and pops
2923 ;; up a window for the process buffer so you can see what the process
2924 ;; responds with. We don't do anything fancy like try to intercept what the
2925 ;; process responds with and put it in a pop-up window or on the message
2926 ;; line. We just display the buffer. Low tech. Simple. Works good.
2928 (defun comint-proc-query (proc str)
2929 "Send to the inferior process PROC the string STR.
2930 Pop-up but do not select a window for the inferior process so that
2931 its response can be seen."
2932 (let* ((proc-buf (process-buffer proc))
2933 (proc-mark (process-mark proc)))
2934 (display-buffer proc-buf)
2935 (set-buffer proc-buf) ; but it's not the selected *window*
2936 (let ((proc-win (get-buffer-window proc-buf 0))
2937 (proc-pt (marker-position proc-mark)))
2938 (comint-send-string proc str) ; send the query
2939 (accept-process-output proc) ; wait for some output
2940 ;; Try to position the proc window so you can see the answer.
2941 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2942 ;; I don't know why. Wizards invited to improve it.
2943 (unless (pos-visible-in-window-p proc-pt proc-win)
2944 (let ((opoint (window-point proc-win)))
2945 (set-window-point proc-win proc-mark)
2946 (sit-for 0)
2947 (if (not (pos-visible-in-window-p opoint proc-win))
2948 (push-mark opoint)
2949 (set-window-point proc-win opoint)))))))
2951 \f
2952 ;; Filename/command/history completion in a buffer
2953 ;; ===========================================================================
2954 ;; Useful completion functions, courtesy of the Ergo group.
2956 ;; Six commands:
2957 ;; completion-at-point Complete or expand command, filename,
2958 ;; history at point.
2959 ;; comint-dynamic-complete-filename Complete filename at point.
2960 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2961 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2962 ;; replace with expanded/completed name.
2964 ;; These are not installed in the comint-mode keymap. But they are
2965 ;; available for people who want them. Shell-mode installs them:
2967 ;; (define-key shell-mode-map "\M-?"
2968 ;; 'comint-dynamic-list-filename-completions)))
2969 ;;
2970 ;; Commands like this are fine things to put in load hooks if you
2971 ;; want them present in specific modes.
2973 (defcustom comint-completion-autolist nil
2974 "If non-nil, automatically list possibilities on partial completion.
2975 This mirrors the optional behavior of tcsh."
2976 :type 'boolean
2977 :group 'comint-completion)
2979 (defcustom comint-completion-addsuffix t
2980 "If non-nil, add ` ' to file names.
2981 It can either be a string FILESUFFIX or a cons (DIRSUFFIX . FILESUFFIX)
2982 where DIRSUFFIX is ignored and FILESUFFIX is a string added on unambiguous
2983 or exact completion.
2984 This mirrors the optional behavior of tcsh."
2985 :type '(choice (const :tag "None" nil)
2986 (const :tag "Add SPC" t)
2987 (string :tag "File suffix")
2988 (cons :tag "Obsolete suffix pair"
2989 (string :tag "Ignored")
2990 (string :tag "File suffix")))
2991 :group 'comint-completion)
2993 (defcustom comint-completion-recexact nil
2994 "If non-nil, use shortest completion if characters cannot be added.
2995 This mirrors the optional behavior of tcsh.
2997 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2998 :type 'boolean
2999 :group 'comint-completion)
3001 (defcustom comint-completion-fignore nil
3002 "List of suffixes to be disregarded during file completion.
3003 This mirrors the optional behavior of bash and tcsh.
3005 Note that this applies to `comint-dynamic-complete-filename' only."
3006 :type '(repeat (string :tag "Suffix"))
3007 :group 'comint-completion)
3009 ;;;###autoload
3010 (defvar comint-file-name-prefix (purecopy "")
3011 "Prefix prepended to absolute file names taken from process input.
3012 This is used by Comint's and shell's completion functions, and by shell's
3013 directory tracking functions.")
3015 (defvar comint-file-name-chars
3016 (if (memq system-type '(ms-dos windows-nt cygwin))
3017 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
3018 "[]~/A-Za-z0-9+@:_.$#%,={}-")
3019 "String of characters valid in a file name.
3020 Note that all non-ASCII characters are considered valid in a file name
3021 regardless of what this variable says.
3023 This is a good thing to set in mode hooks.")
3025 (defvar comint-file-name-quote-list nil
3028 This is a good thing to set in mode hooks.")
3031 (defun comint-directory (directory)
3032 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
3033 (expand-file-name (if (file-name-absolute-p directory)
3034 (concat comint-file-name-prefix directory)
3035 directory)))
3038 (defun comint-word (word-chars)
3039 "Return the word of WORD-CHARS at point, or nil if none is found.
3040 Word constituents are considered to be those in WORD-CHARS, which is like the
3042 ;; FIXME: Need to handle "..." and '...' quoting in shell.el!
3043 ;; This should be combined with completion parsing somehow.
3044 (save-excursion
3045 (let ((here (point))
3046 giveup)
3047 (while (not giveup)
3048 (let ((startpoint (point)))
3050 (if (and comint-file-name-quote-list
3052 (forward-char -2))
3053 ;; FIXME: This isn't consistent with Bash, at least -- not
3054 ;; all non-ASCII chars should be word constituents.
3055 (if (and (not (bobp)) (>= (char-before) 128))
3056 (forward-char -1))
3057 (if (= (point) startpoint)
3058 (setq giveup t))))
3059 ;; Set match-data to match the entire string.
3060 (when (< (point) here)
3061 (set-match-data (list (point) here))
3062 (match-string 0)))))
3064 (defun comint-substitute-in-file-name (filename)
3065 "Return FILENAME with environment variables substituted.
3066 Supports additional environment variable syntax of the command
3067 interpreter (e.g., the percent notation of cmd.exe on Windows)."
3068 (let ((name (substitute-in-file-name filename)))
3069 (if (memq system-type '(ms-dos windows-nt))
3070 (let (env-var-name
3071 env-var-val)
3072 (save-match-data
3074 (setq env-var-name (match-string 1 name))
3075 (setq env-var-val (or (getenv env-var-name) ""))
3076 (setq name (replace-match env-var-val t t name))))))
3077 name))
3079 (defun comint--match-partial-filename ()
3080 "Return the filename at point as-is, or nil if none is found.
3081 See `comint-word'."
3082 (comint-word comint-file-name-chars))
3084 (defun comint--unquote&requote-argument (qstr &optional upos)
3085 (unless upos (setq upos 0))
3086 (let* ((qpos 0)
3087 (ustrs '())
3088 (re (concat
3091 (when (memq system-type '(ms-dos windows-nt))
3093 (when comint-file-name-quote-list
3095 (qupos nil)
3096 (push (lambda (str end)
3097 (push str ustrs)
3098 (setq upos (- upos (length str)))
3099 (unless (or qupos (> upos 0))
3100 (setq qupos (if (< end 0) (- end) (+ upos end))))))
3101 match)
3102 (while (setq match (string-match re qstr qpos))
3103 (funcall push (substring qstr qpos match) match)
3104 (cond
3105 ((match-beginning 2) (funcall push (match-string 2 qstr) (match-end 0)))
3106 ((match-beginning 1) (funcall push (getenv (match-string 1 qstr))
3107 (- (match-end 0))))
3108 (t (error "Unexpected case in comint--unquote&requote-argument!")))
3109 (setq qpos (match-end 0)))
3110 (funcall push (substring qstr qpos) (length qstr))
3111 (list (mapconcat #'identity (nreverse ustrs) "")
3112 qupos #'comint-quote-filename)))
3114 (defun comint--unquote-argument (str)
3115 (car (comint--unquote&requote-argument str)))
3116 (define-obsolete-function-alias 'comint--unquote&expand-filename
3117 #'comint--unquote-argument "24.3")
3119 (defun comint-match-partial-filename ()
3120 "Return the unquoted&expanded filename at point, or nil if none is found.
3121 Environment variables are substituted. See `comint-word'."
3122 (let ((filename (comint--match-partial-filename)))
3123 (and filename (comint--unquote-argument filename))))
3125 (defun comint-quote-filename (filename)
3126 "Return FILENAME with magic characters quoted.
3127 Magic characters are those in `comint-file-name-quote-list'."
3128 (if (null comint-file-name-quote-list)
3129 filename
3130 (let ((regexp (regexp-opt-charset comint-file-name-quote-list)))
3131 (save-match-data
3132 (let ((i 0))
3133 (while (string-match regexp filename i)
3135 (setq i (1+ (match-end 0)))))
3136 filename))))
3138 (defun comint-unquote-filename (filename)
3139 "Return FILENAME with quoted characters unquoted."
3140 (declare (obsolete nil "24.3"))
3141 (if (null comint-file-name-quote-list)
3142 filename
3143 (save-match-data
3146 (defun comint--requote-argument (upos qstr)
3147 ;; See `completion-table-with-quoting'.
3148 (let ((res (comint--unquote&requote-argument qstr upos)))
3149 (cons (nth 1 res) (nth 2 res))))
3151 (defun comint-completion-at-point ()
3152 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
3154 (define-obsolete-function-alias
3155 'comint-dynamic-complete
3156 'completion-at-point "24.1")
3158 (defun comint-dynamic-complete-filename ()
3159 "Dynamically complete the filename at point.
3160 Completes if after a filename.
3161 This function is similar to `comint-replace-by-expanded-filename', except that
3162 it won't change parts of the filename already entered in the buffer; it just
3163 adds completion characters to the end of the filename. A completions listing
3164 may be shown in a separate buffer if completion is ambiguous.
3166 Completion is dependent on the value of `comint-completion-addsuffix',
3167 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
3168 completions listing is dependent on the value of `comint-completion-autolist'.
3170 Returns t if successful."
3171 (interactive)
3172 (when (comint--match-partial-filename)
3173 (unless (window-minibuffer-p)
3174 (message "Completing file name..."))
3175 (let ((data (comint--complete-file-name-data)))
3176 (completion-in-region (nth 0 data) (nth 1 data) (nth 2 data)))))
3178 (defun comint-filename-completion ()
3179 "Return completion data for filename at point, if any."
3180 (when (comint--match-partial-filename)
3181 (comint--complete-file-name-data)))
3183 (defun comint-completion-file-name-table (string pred action)
3184 (if (not (file-name-absolute-p string))
3185 (completion-file-name-table string pred action)
3186 (cond
3187 ((memq action '(t lambda))
3188 (completion-file-name-table
3189 (concat comint-file-name-prefix string) pred action))
3190 ((null action)
3191 (let ((res (completion-file-name-table
3192 (concat comint-file-name-prefix string) pred action)))
3193 (if (and (stringp res)
3194 (string-match
3196 res))
3197 (substring res (match-end 0))
3198 res)))
3199 (t (completion-file-name-table string pred action)))))
3201 (defvar comint-unquote-function #'comint--unquote-argument
3202 "Function to use for completion of quoted data.
3203 See `completion-table-with-quoting' and `comint-requote-function'.")
3204 (defvar comint-requote-function #'comint--requote-argument
3205 "Function to use for completion of quoted data.
3206 See `completion-table-with-quoting' and `comint-unquote-function'.")
3208 (defun comint--complete-file-name-data ()
3209 "Return the completion data for file name at point."
3210 (let* ((filesuffix (cond ((not comint-completion-addsuffix) "")
3211 ((stringp comint-completion-addsuffix)
3212 comint-completion-addsuffix)
3213 ((not (consp comint-completion-addsuffix)) " ")
3214 (t (cdr comint-completion-addsuffix))))
3215 (filename (comint--match-partial-filename))
3216 (filename-beg (if filename (match-beginning 0) (point)))
3217 (filename-end (if filename (match-end 0) (point)))
3218 (table
3219 (completion-table-with-quoting
3220 #'comint-completion-file-name-table
3221 comint-unquote-function
3222 comint-requote-function)))
3223 (nconc
3224 (list
3225 filename-beg filename-end
3226 (lambda (string pred action)
3227 (let ((completion-ignore-case read-file-name-completion-ignore-case)
3228 (completion-ignored-extensions comint-completion-fignore))
3229 (complete-with-action action table string pred))))
3230 (unless (zerop (length filesuffix))
3231 (list :exit-function
3232 (lambda (_s status)
3233 (when (eq status 'finished)
3234 (if (looking-at (regexp-quote filesuffix))
3235 (goto-char (match-end 0))
3236 (insert filesuffix)))))))))
3238 (defun comint-dynamic-complete-as-filename ()
3239 "Dynamically complete at point as a filename.
3240 See `comint-dynamic-complete-filename'. Returns t if successful."
3241 (declare (obsolete comint-filename-completion "24.1"))
3242 (let ((data (comint--complete-file-name-data)))
3243 (completion-in-region (nth 0 data) (nth 1 data) (nth 2 data))))
3245 (defun comint-replace-by-expanded-filename ()
3246 "Dynamically expand and complete the filename at point.
3247 Replace the filename with an expanded, canonicalized and
3248 completed replacement, i.e. substituting environment
3249 variables (e.g. $HOME), `~'s, `..', and `.', and making the
3250 filename absolute. For expansion see `expand-file-name' and
3251 `substitute-in-file-name'. For completion see
3252 `comint-dynamic-complete-filename'."
3253 (interactive)
3254 (let ((filename (comint-match-partial-filename)))
3255 (when filename
3256 (replace-match (expand-file-name filename) t t)
3257 (comint-dynamic-complete-filename))))
3260 (defun comint-dynamic-simple-complete (stub candidates)
3261 "Dynamically complete STUB from CANDIDATES list.
3262 This function inserts completion characters at point by
3263 completing STUB from the strings in CANDIDATES. If completion is
3264 ambiguous, possibly show a completions listing in a separate
3265 buffer.
3267 Return nil if no completion was inserted.
3268 Return `sole' if completed with the only completion match.
3269 Return `shortest' if completed with the shortest match.
3270 Return `partial' if completed as far as possible.
3271 Return `listed' if a completion listing was shown.
3273 See also `comint-dynamic-complete-filename'."
3274 (declare (obsolete completion-in-region "24.1"))
3275 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
3276 (minibuffer-p (window-minibuffer-p))
3277 (suffix (cond ((not comint-completion-addsuffix) "")
3278 ((not (consp comint-completion-addsuffix)) " ")
3279 (t (cdr comint-completion-addsuffix))))
3280 (completions (all-completions stub candidates)))
3281 (cond ((null completions)
3282 (if minibuffer-p
3283 (minibuffer-message "No completions of %s" stub)
3284 (message "No completions of %s" stub))
3285 nil)
3286 ((= 1 (length completions)) ; Gotcha!
3287 (let ((completion (car completions)))
3288 (if (string-equal completion stub)
3289 (unless minibuffer-p
3290 (message "Sole completion"))
3291 (insert (substring completion (length stub)))
3292 (unless minibuffer-p
3293 (message "Completed")))
3294 (insert suffix)
3295 'sole))
3296 (t ; There's no unique completion.
3297 (let ((completion (try-completion stub candidates)))
3298 ;; Insert the longest substring.
3299 (insert (substring completion (length stub)))
3300 (cond ((and comint-completion-recexact comint-completion-addsuffix
3301 (string-equal stub completion)
3302 (member completion completions))
3303 ;; It's not unique, but user wants shortest match.
3304 (insert suffix)
3305 (unless minibuffer-p
3306 (message "Completed shortest"))
3307 'shortest)
3308 ((or comint-completion-autolist
3309 (string-equal stub completion))
3310 ;; It's not unique, list possible completions.
3311 (comint-dynamic-list-completions completions stub)
3312 'listed)
3313 (t
3314 (unless minibuffer-p
3315 (message "Partially completed"))
3316 'partial)))))))
3318 (defun comint-dynamic-list-filename-completions ()
3319 "Display a list of possible completions for the filename at point."
3320 (interactive)
3321 (let* ((data (comint--complete-file-name-data))
3322 (minibuffer-completion-table (nth 2 data))
3323 (minibuffer-completion-predicate nil)
3324 (ol (make-overlay (nth 0 data) (nth 1 data) nil nil t)))
3325 (overlay-put ol 'field 'completion)
3326 (unwind-protect
3327 (call-interactively 'minibuffer-completion-help)
3328 (delete-overlay ol))))
3331 ;; This is bound locally in a *Completions* buffer to the list of
3332 ;; completions displayed, and is used to detect the case where the same
3333 ;; command is repeatedly used without the set of completions changing.
3334 (defvar comint-displayed-dynamic-completions nil)
3336 (defvar comint-dynamic-list-completions-config nil)
3338 (defun comint-dynamic-list-completions (completions &optional common-substring)
3339 "Display a list of sorted COMPLETIONS.
3340 Typing SPC flushes the completions buffer.
3342 The optional argument COMMON-SUBSTRING, if non-nil, should be a string
3343 specifying a common substring for adding the faces
3344 `completions-first-difference' and `completions-common-part' to
3345 the completions."
3346 (let ((window (get-buffer-window "*Completions*" 0)))
3347 (setq completions (sort completions 'string-lessp))
3348 (if (and (eq last-command this-command)
3349 window (window-live-p window) (window-buffer window)
3350 (buffer-name (window-buffer window))
3351 ;; The above tests are not sufficient to detect the case where we
3352 ;; should scroll, because the top-level interactive command may
3353 ;; not have displayed a completions window the last time it was
3354 ;; invoked, and there may be such a window left over from a
3355 ;; previous completion command with a different set of
3356 ;; completions. To detect that case, we also test that the set
3357 ;; of displayed completions is in fact the same as the previously
3358 ;; displayed set.
3359 (equal completions
3360 (buffer-local-value 'comint-displayed-dynamic-completions
3361 (window-buffer window))))
3362 ;; If this command was repeated, and
3363 ;; there's a fresh completion window with a live buffer,
3364 ;; and this command is repeated, scroll that window.
3365 (with-current-buffer (window-buffer window)
3366 (if (pos-visible-in-window-p (point-max) window)
3367 (set-window-start window (point-min))
3368 (save-selected-window
3369 (select-window window)
3370 (scroll-up))))
3372 ;; Display a completion list for the first time.
3373 (setq comint-dynamic-list-completions-config
3374 (current-window-configuration))
3375 (with-output-to-temp-buffer "*Completions*"
3376 (display-completion-list
3377 (completion-hilit-commonality completions (length common-substring))))
3378 (if (window-minibuffer-p)
3379 (minibuffer-message "Type space to flush; repeat completion command to scroll")
3380 (message "Type space to flush; repeat completion command to scroll")))
3382 ;; Read the next key, to process SPC.
3383 (let (key first)
3384 (if (with-current-buffer (get-buffer "*Completions*")
3385 (setq-local comint-displayed-dynamic-completions
3386 completions)
3387 (setq key (read-key-sequence nil)
3388 first (aref key 0))
3389 (and (consp first) (consp (event-start first))
3390 (eq (window-buffer (posn-window (event-start first)))
3391 (get-buffer "*Completions*"))
3392 (memq (key-binding key)
3393 '(mouse-choose-completion choose-completion))))
3394 ;; If the user does choose-completion with the mouse,
3395 ;; execute the command, then delete the completion window.
3396 (progn
3397 (choose-completion first)
3398 (set-window-configuration comint-dynamic-list-completions-config))
3399 (if (eq first ?\s)
3400 (set-window-configuration comint-dynamic-list-completions-config)
3401 (setq unread-command-events
3402 (nconc (listify-key-sequence key) unread-command-events)))))))
3403 \f
3404 (defun comint-get-next-from-history ()
3405 "After fetching a line from input history, this fetches the following line.
3406 In other words, this recalls the input line after the line you recalled last.
3407 You can use this to repeat a sequence of input lines."
3408 (interactive)
3409 (if comint-save-input-ring-index
3410 (progn
3411 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
3412 (comint-next-input 1))
3413 (message "No previous history command")))
3415 (defun comint-accumulate ()
3416 "Accumulate a line to send as input along with more lines.
3417 This inserts a newline so that you can enter more text
3419 to send all the accumulated input, at once.
3420 The entire accumulated text becomes one item in the input history
3421 when you send it."
3422 (interactive)
3424 (set-marker comint-accum-marker (point))
3425 (if comint-input-ring-index
3426 (setq comint-save-input-ring-index
3427 (- comint-input-ring-index 1))))
3429 (defun comint-goto-process-mark ()
3430 "Move point to the process mark.
3431 The process mark separates output, and input already sent,
3432 from input that has not yet been sent."
3433 (interactive)
3434 (let ((proc (or (get-buffer-process (current-buffer))
3435 (user-error "Current buffer has no process"))))
3436 (goto-char (process-mark proc))
3437 (when (called-interactively-p 'interactive)
3438 (message "Point is now at the process mark"))))
3440 (defun comint-bol-or-process-mark ()
3441 "Move point to beginning of line (after prompt) or to the process mark.
3442 The first time you use this command, it moves to the beginning of the line
3443 \(but after the prompt, if any). If you repeat it again immediately,
3444 it moves point to the process mark.
3446 The process mark separates the process output, along with input already sent,
3447 from input that has not yet been sent. Ordinarily, the process mark
3448 is at the beginning of the current input line; but if you have
3450 the process mark is at the beginning of the accumulated input."
3451 (interactive)
3452 (if (not (eq last-command 'comint-bol-or-process-mark))
3453 (comint-bol nil)
3454 (comint-goto-process-mark)))
3456 (defun comint-set-process-mark ()
3457 "Set the process mark at point."
3458 (interactive)
3459 (let ((proc (or (get-buffer-process (current-buffer))
3460 (user-error "Current buffer has no process"))))
3461 (set-marker (process-mark proc) (point))
3462 (message "Process mark set")))
3464 \f
3465 ;; Author: Peter Breton <pbreton@cs.umb.edu>
3467 ;; This little add-on for comint is intended to make it easy to get
3468 ;; output from currently active comint buffers into another buffer,
3469 ;; or buffers, and then go back to using the comint shell.
3470 ;;
3471 ;; My particular use is SQL interpreters; I want to be able to execute a
3472 ;; query using the process associated with a comint-buffer, and save that
3473 ;; somewhere else. Because the process might have state (for example, it
3474 ;; could be in an uncommitted transaction), just running starting a new
3475 ;; process and having it execute the query and then finish, would not
3476 ;; work. I'm sure there are other uses as well, although in many cases
3477 ;; starting a new process is the simpler, and thus preferable, approach.
3478 ;;
3479 ;; The basic implementation is as follows: comint-redirect changes the
3480 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
3481 ;; its own filter. The filter puts the output into the designated buffer,
3482 ;; or buffers, until it sees a regexp that tells it to stop (by default,
3483 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
3484 ;; sees the stop regexp, it restores the old filter functions, and runs
3485 ;; `comint-redirect-hook'.
3486 ;;
3487 ;; Each comint buffer may only use one redirection at a time, but any number
3488 ;; of different comint buffers may be simultaneously redirected.
3489 ;;
3490 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
3491 ;; correct prompt for your interpreter, or that you supply a regexp that says
3492 ;; when the redirection is finished. Otherwise, redirection will continue
3493 ;; indefinitely. The code now does a sanity check to ensure that it can find
3494 ;; a prompt in the comint buffer; however, it is still important to ensure that
3495 ;; this prompt is set correctly.
3496 ;;
3497 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
3498 ;; perhaps it should prompt for a terminating string (with an
3499 ;; appropriate magic default by examining what we think is the prompt)?
3500 ;;
3501 ;; Fixme: look for appropriate fields, rather than regexp, if
3502 ;; `comint-use-prompt-regexp' is true.
3504 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3505 ;; Variables
3506 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3508 (defcustom comint-redirect-verbose nil
3509 "If non-nil, print messages each time the redirection filter is invoked.
3510 Also print a message when redirection is completed."
3511 :group 'comint
3512 :type 'boolean)
3514 ;; Directly analogous to comint-preoutput-filter-functions
3515 (defvar comint-redirect-filter-functions nil
3516 "List of functions to call before inserting redirected process output.
3517 Each function gets one argument, a string containing the text received
3518 from the subprocess. It should return the string to insert, perhaps
3519 the same string that was received, or perhaps a modified or transformed
3520 string.
3522 The functions on the list are called sequentially, and each one is given
3523 the string returned by the previous one. The string returned by the
3524 last function is the text that is actually inserted in the redirection buffer.
3526 You can use `add-hook' to add functions to this list
3527 either globally or locally.")
3529 ;; Internal variables
3531 (defvar comint-redirect-output-buffer nil
3532 "The buffer or list of buffers to put output into.")
3534 (defvar comint-redirect-finished-regexp nil
3535 "Regular expression that determines when to stop redirection in Comint.
3536 When the redirection filter function is given output that matches this regexp,
3537 the output is inserted as usual, and redirection is completed.")
3539 (defvar comint-redirect-insert-matching-regexp nil
3540 "If non-nil, the text that ends a redirection is included in it.
3541 More precisely, the text that matches `comint-redirect-finished-regexp'
3542 and therefore terminates an output redirection is inserted in the
3543 redirection target buffer, along with the preceding output.")
3545 (defvar comint-redirect-echo-input nil
3546 "Non-nil means echo input in the process buffer even during redirection.")
3548 (defvar comint-redirect-completed nil
3549 "Non-nil if redirection has completed in the current buffer.")
3551 (defvar comint-redirect-original-mode-line-process nil
3552 "Original mode line for redirected process.")
3554 (defvar comint-redirect-perform-sanity-check t
3555 "If non-nil, check that redirection is likely to complete successfully.
3556 More precisely, before starting a redirection, verify that the
3557 regular expression `comint-redirect-finished-regexp' that controls
3558 when to terminate it actually matches some text already in the process
3559 buffer. The idea is that this regular expression should match a prompt
3560 string, and that there ought to be at least one copy of your prompt string
3561 in the process buffer already.")
3563 (defvar comint-redirect-subvert-readonly nil
3564 "Non-nil means `comint-redirect' can insert into read-only buffers.
3565 This works by binding `inhibit-read-only' around the insertion.
3566 This is useful, for instance, for insertion into Help mode buffers.
3567 You probably want to set it locally to the output buffer.")
3569 (defvar comint-redirect-previous-input-string nil
3570 "Last redirected line of text.
3571 Allows detection of the end of the redirection in case the
3572 completion string is split between two output segments.")
3574 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3575 ;; Functions
3576 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3578 (defun comint-redirect-setup (output-buffer
3579 comint-buffer
3580 finished-regexp
3581 &optional echo-input)
3582 "Set up for output redirection.
3583 This function sets local variables that are used by `comint-redirect-filter'
3584 to perform redirection.
3586 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3587 in the output matches FINISHED-REGEXP.
3589 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3590 original Comint buffer.
3592 This function is called by `comint-redirect-send-command-to-process',
3593 and does not normally need to be invoked by the end user or programmer."
3594 (with-current-buffer comint-buffer
3596 (setq-local comint-redirect-original-mode-line-process mode-line-process)
3598 (setq-local comint-redirect-output-buffer output-buffer)
3600 (setq-local comint-redirect-finished-regexp finished-regexp)
3602 (setq-local comint-redirect-echo-input echo-input)
3604 (setq-local comint-redirect-completed nil)
3606 (setq-local comint-redirect-previous-input-string "")
3608 (setq mode-line-process
3609 (if mode-line-process
3610 (list (concat (elt mode-line-process 0) " Redirection"))
3611 (list ":%s Redirection")))))
3613 (defun comint-redirect-cleanup ()
3614 "End a Comint redirection. See `comint-redirect-send-command'."
3615 (interactive)
3616 ;; Release the last redirected string
3617 (setq comint-redirect-previous-input-string nil)
3618 ;; Restore the process filter
3619 (remove-function (process-filter (get-buffer-process (current-buffer)))
3620 #'comint-redirect-filter)
3621 ;; Restore the mode line
3622 (setq mode-line-process comint-redirect-original-mode-line-process)
3623 ;; Set the completed flag
3624 (setq comint-redirect-completed t))
3626 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3627 ;; that it really occurs.
3628 (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
3630 (defun comint-redirect-filter (orig-filter process input-string)
3631 "Filter function which redirects output from PROCESS to a buffer or buffers.
3632 The variable `comint-redirect-output-buffer' says which buffer(s) to
3633 place output in.
3635 INPUT-STRING is the input from the Comint process.
3637 This function runs as a process filter, and does not need to be invoked by the
3638 end user."
3639 (and process
3640 (with-current-buffer (process-buffer process)
3641 (comint-redirect-preoutput-filter input-string)
3642 ;; If we have to echo output, give it to the original filter function
3643 (and comint-redirect-echo-input
3644 orig-filter
3645 (funcall orig-filter process input-string)))))
3648 (defun comint-redirect-preoutput-filter (input-string)
3649 "Comint filter function which redirects Comint output to a buffer or buffers.
3650 The variable `comint-redirect-output-buffer' says which buffer(s) to
3651 place output in.
3653 INPUT-STRING is the input from the Comint process.
3655 This function does not need to be invoked by the end user."
3656 (let ((output-buffer-list
3657 (if (listp comint-redirect-output-buffer)
3658 comint-redirect-output-buffer
3659 (list comint-redirect-output-buffer)))
3660 (filtered-input-string input-string))
3662 ;; If there are any filter functions, give them a chance to modify
3663 ;; the string.
3664 (let ((functions comint-redirect-filter-functions))
3665 (while (and functions filtered-input-string)
3666 (if (eq (car functions) t)
3667 ;; If a local value says "use the default value too",
3668 ;; do that.
3669 (let ((functions
3670 (default-value 'comint-redirect-filter-functions)))
3671 (while (and functions filtered-input-string)
3672 (setq filtered-input-string
3673 (funcall (car functions) filtered-input-string))
3674 (setq functions (cdr functions))))
3675 (setq filtered-input-string
3676 (funcall (car functions) filtered-input-string)))
3677 (setq functions (cdr functions))))
3679 ;; Clobber `comint-redirect-finished-regexp'
3680 (or comint-redirect-insert-matching-regexp
3681 (and (string-match comint-redirect-finished-regexp filtered-input-string)
3682 (setq filtered-input-string
3683 (replace-match "" nil nil filtered-input-string))))
3685 ;; Send output to all registered buffers
3686 (save-excursion
3687 (dolist (buf output-buffer-list)
3688 ;; Set this buffer to the output buffer
3689 (set-buffer (get-buffer-create buf))
3690 ;; Go to the end of the buffer
3691 (goto-char (point-max))
3692 ;; Insert the output
3693 (let ((inhibit-read-only comint-redirect-subvert-readonly))
3694 (insert filtered-input-string))))
3696 ;; Message
3697 (and comint-redirect-verbose
3698 (message "Redirected output to buffer(s) %s" output-buffer-list))
3700 ;; If we see the prompt, tidy up
3701 ;; We'll look for the prompt in the original string, so nobody can
3702 ;; clobber it
3703 (and (string-match comint-redirect-finished-regexp
3704 (concat comint-redirect-previous-input-string
3705 input-string))
3706 (progn
3707 (and comint-redirect-verbose
3708 (message "Redirection completed"))
3709 (comint-redirect-cleanup)
3710 (run-hooks 'comint-redirect-hook)))
3711 (setq comint-redirect-previous-input-string input-string)
3713 ;; Echo input?
3714 (if comint-redirect-echo-input
3715 filtered-input-string
3716 "")))
3718 ;;;###autoload
3719 (defun comint-redirect-send-command (command output-buffer echo &optional no-display)
3720 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3721 With prefix arg ECHO, echo output in process buffer.
3723 If NO-DISPLAY is non-nil, do not show the output buffer."
3725 (let ((process (get-buffer-process (current-buffer))))
3726 (if process
3727 (comint-redirect-send-command-to-process
3728 command output-buffer (current-buffer) echo no-display)
3729 (error "No process for current buffer"))))
3731 ;;;###autoload
3732 (defun comint-redirect-send-command-to-process
3733 (command output-buffer process echo &optional no-display)
3734 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3735 With prefix arg, echo output in process buffer.
3737 If NO-DISPLAY is non-nil, do not show the output buffer."
3739 (let* (;; The process buffer
3740 (process-buffer (if (processp process)
3741 (process-buffer process)
3742 process))
3743 (proc (get-buffer-process process-buffer)))
3744 ;; Change to the process buffer
3745 (with-current-buffer process-buffer
3747 ;; Make sure there's a prompt in the current process buffer
3748 (and comint-redirect-perform-sanity-check
3749 (save-excursion
3750 (goto-char (point-max))
3751 (or (re-search-backward comint-prompt-regexp nil t)
3752 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3754 ;; Set up for redirection
3755 (comint-redirect-setup
3756 output-buffer
3757 (current-buffer) ; Comint Buffer
3758 comint-prompt-regexp ; Finished Regexp
3759 echo) ; Echo input
3761 ;; Set the filter.
3762 (add-function :around (process-filter proc) #'comint-redirect-filter)
3764 ;; Send the command
3767 ;; Show the output
3768 (or no-display
3769 (display-buffer
3770 (get-buffer-create
3771 (if (listp output-buffer)
3772 (car output-buffer)
3773 output-buffer)))))))
3775 ;;;###autoload
3776 (defun comint-redirect-results-list (command regexp regexp-group)
3777 "Send COMMAND to current process.
3778 Return a list of expressions in the output which match REGEXP.
3779 REGEXP-GROUP is the regular expression group in REGEXP to use."
3780 (comint-redirect-results-list-from-process
3781 (get-buffer-process (current-buffer))
3782 command regexp regexp-group))
3784 ;;;###autoload
3785 (defun comint-redirect-results-list-from-process (process command regexp regexp-group)
3786 "Send COMMAND to PROCESS.
3787 Return a list of expressions in the output which match REGEXP.
3788 REGEXP-GROUP is the regular expression group in REGEXP to use."
3789 (let ((output-buffer " *Comint Redirect Work Buffer*")
3790 results)
3791 (with-current-buffer (get-buffer-create output-buffer)
3792 (erase-buffer)
3793 (comint-redirect-send-command-to-process command
3794 output-buffer process nil t)
3795 ;; Wait for the process to complete
3796 (set-buffer (process-buffer process))
3797 (while (and (null comint-redirect-completed)
3798 (accept-process-output process)))
3799 ;; Collect the output
3800 (set-buffer output-buffer)
3801 (goto-char (point-min))
3802 ;; Skip past the command, if it was echoed
3803 (and (looking-at command)
3804 (forward-line))
3805 (while (and (not (eobp))
3806 (re-search-forward regexp nil t))
3807 (push (buffer-substring-no-properties
3808 (match-beginning regexp-group)
3809 (match-end regexp-group))
3810 results))
3811 (nreverse results))))
3812 \f
3813 ;; Converting process modes to use comint mode
3814 ;; ===========================================================================
3815 ;; The code in the Emacs 19 distribution has all been modified to use comint
3816 ;; where needed. However, there are `third-party' packages out there that
3817 ;; still use the old shell mode. Here's a guide to conversion.
3818 ;;
3819 ;; Renaming variables
3820 ;; Most of the work is renaming variables and functions. These are the common
3821 ;; ones:
3822 ;; Local variables:
3823 ;; last-input-start comint-last-input-start
3824 ;; last-input-end comint-last-input-end
3825 ;; shell-prompt-pattern comint-prompt-regexp
3826 ;; shell-set-directory-error-hook <no equivalent>
3827 ;; Miscellaneous:
3828 ;; shell-set-directory <unnecessary>
3829 ;; shell-mode-map comint-mode-map
3830 ;; Commands:
3831 ;; shell-send-input comint-send-input
3832 ;; shell-send-eof comint-delchar-or-maybe-eof
3833 ;; kill-shell-input comint-kill-input
3834 ;; interrupt-shell-subjob comint-interrupt-subjob
3835 ;; stop-shell-subjob comint-stop-subjob
3836 ;; quit-shell-subjob comint-quit-subjob
3837 ;; kill-shell-subjob comint-kill-subjob
3838 ;; kill-output-from-shell comint-delete-output
3839 ;; show-output-from-shell comint-show-output
3840 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3841 ;;
3842 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3843 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3844 ;; Comint mode does not provide functionality equivalent to
3845 ;; shell-set-directory-error-hook; it is gone.
3846 ;;
3847 ;; comint-last-input-start is provided for modes which want to munge
3848 ;; the buffer after input is sent, perhaps because the inferior
3849 ;; insists on echoing the input. The LAST-INPUT-START variable in
3850 ;; the old shell package was used to implement a history mechanism,
3851 ;; but you should think twice before using comint-last-input-start
3852 ;; for this; the input history ring often does the job better.
3853 ;;
3854 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3855 ;; *not* create the comint-mode local variables in your foo-mode function.
3856 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3857 ;; necessary comint-specific local variables. Then create the
3858 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3859 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3860 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3861 ;; get-old-input) that need to be different from the defaults. Call
3862 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3863 ;; comint-mode will take care of it. The following example, from shell.el,
3864 ;; is typical:
3865 ;;
3866 ;; (defvar shell-mode-map
3867 ;; (let ((map (make-sparse-keymap)))
3868 ;; (set-keymap-parent map comint-mode-map)
3869 ;; (define-key map "\C-c\C-f" 'shell-forward-command)
3870 ;; (define-key map "\C-c\C-b" 'shell-backward-command)
3872 ;; (define-key map "\M-?"
3873 ;; 'comint-dynamic-list-filename-completions)
3874 ;; map))
3875 ;;
3876 ;; (define-derived-mode shell-mode comint-mode "Shell"
3877 ;; "Doc."
3878 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3879 ;; (setq-local shell-directory-stack nil)
3880 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker))
3881 ;;
3882 ;;
3883 ;; Completion for comint-mode users
3884 ;;
3885 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3886 ;; hook to add completion functions to. Functions on this list should return
3887 ;; the completion data according to the documentation of
3888 ;; `completion-at-point-functions'
3889 \f
3891 (provide 'comint)
3893 ;;; comint.el ends here