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