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