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