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