| blob | 1098167597154c85fcc663f53e62ad18352f936c |
1 ;;; comint.el --- general command interpreter in a window stuff -*- lexical-binding: t -*-
3 ;; Copyright (C) 1988, 1990, 1992-2012 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 `.emacs' 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 (error "Not at command line"))
1079 ((or (null comint-input-ring)
1080 (ring-empty-p comint-input-ring))
1081 (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 (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 (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 (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 nil)
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 (cond
1466 (isearch-word
1467 (if isearch-forward 'word-search-forward 'word-search-backward))
1468 (t
1469 (lambda (string bound noerror)
1470 (let ((search-fun
1471 ;; Use standard functions to search within comint text
1472 (cond
1473 (isearch-regexp
1474 (if isearch-forward 're-search-forward 're-search-backward))
1475 (t
1476 (if isearch-forward 'search-forward 'search-backward))))
1477 found)
1478 ;; Avoid lazy-highlighting matches in the comint prompt and in the
1479 ;; output when searching forward. Lazy-highlight calls this lambda
1480 ;; with the bound arg, so skip the prompt and the output.
1481 (if (and bound isearch-forward (not (comint-after-pmark-p)))
1482 (goto-char (process-mark (get-buffer-process (current-buffer)))))
1483 (or
1484 ;; 1. First try searching in the initial comint text
1485 (funcall search-fun string
1486 (if isearch-forward bound (comint-line-beginning-position))
1487 noerror)
1488 ;; 2. If the above search fails, start putting next/prev history
1489 ;; elements in the comint successively, and search the string
1490 ;; in them. Do this only when bound is nil (i.e. not while
1491 ;; lazy-highlighting search strings in the current comint text).
1492 (unless bound
1493 (condition-case nil
1494 (progn
1495 (while (not found)
1496 (cond (isearch-forward
1497 ;; Signal an error here explicitly, because
1498 ;; `comint-next-input' doesn't signal an error.
1499 (when (null comint-input-ring-index)
1500 (error "End of history; no next item"))
1501 (comint-next-input 1)
1502 (goto-char (comint-line-beginning-position)))
1503 (t
1504 ;; Signal an error here explicitly, because
1505 ;; `comint-previous-input' doesn't signal an error.
1506 (when (eq comint-input-ring-index
1507 (1- (ring-length comint-input-ring)))
1508 (error "Beginning of history; no preceding item"))
1509 (comint-previous-input 1)
1510 (goto-char (point-max))))
1511 (setq isearch-barrier (point) isearch-opoint (point))
1512 ;; After putting the next/prev history element, search
1513 ;; the string in them again, until comint-next-input
1514 ;; or comint-previous-input raises an error at the
1515 ;; beginning/end of history.
1516 (setq found (funcall search-fun string
1517 (unless isearch-forward
1518 ;; For backward search, don't search
1519 ;; in the comint prompt
1520 (comint-line-beginning-position))
1521 noerror)))
1522 ;; Return point of the new search result
1523 (point))
1524 ;; Return nil on the error "no next/preceding item"
1525 (error nil)))))))))
1527 (defun comint-history-isearch-message (&optional c-q-hack ellipsis)
1528 "Display the input history search prompt.
1529 If there are no search errors, this function displays an overlay with
1530 the Isearch prompt which replaces the original comint prompt.
1531 Otherwise, it displays the standard Isearch message returned from
1532 `isearch-message'."
1533 (if (not (and isearch-success (not isearch-error)))
1534 ;; Use standard function `isearch-message' when not in comint prompt,
1535 ;; or search fails, or has an error (like incomplete regexp).
1536 ;; This function displays isearch message in the echo area,
1537 ;; so it's possible to see what is wrong in the search string.
1538 (isearch-message c-q-hack ellipsis)
1539 ;; Otherwise, put the overlay with the standard isearch prompt over
1540 ;; the initial comint prompt.
1541 (if (overlayp comint-history-isearch-message-overlay)
1542 (move-overlay comint-history-isearch-message-overlay
1543 (save-excursion (forward-line 0) (point))
1544 (comint-line-beginning-position))
1545 (setq comint-history-isearch-message-overlay
1546 (make-overlay (save-excursion (forward-line 0) (point))
1547 (comint-line-beginning-position)))
1548 (overlay-put comint-history-isearch-message-overlay 'evaporate t))
1549 (overlay-put comint-history-isearch-message-overlay
1550 'display (isearch-message-prefix c-q-hack ellipsis))
1551 ;; And clear any previous isearch message.
1552 (message "")))
1554 (defun comint-history-isearch-wrap ()
1555 "Wrap the input history search when search fails.
1556 Move point to the first history element for a forward search,
1557 or to the last history element for a backward search."
1558 (unless isearch-word
1559 ;; When `comint-history-isearch-search' fails on reaching the
1560 ;; beginning/end of the history, wrap the search to the first/last
1561 ;; input history element.
1562 (if isearch-forward
1563 (comint-goto-input (1- (ring-length comint-input-ring)))
1564 (comint-goto-input nil))
1565 (setq isearch-success t))
1566 (goto-char (if isearch-forward (comint-line-beginning-position) (point-max))))
1568 (defun comint-history-isearch-push-state ()
1569 "Save a function restoring the state of input history search.
1570 Save `comint-input-ring-index' to the additional state parameter
1571 in the search status stack."
1572 `(lambda (cmd)
1573 (comint-history-isearch-pop-state cmd ,comint-input-ring-index)))
1575 (defun comint-history-isearch-pop-state (_cmd hist-pos)
1576 "Restore the input history search state.
1577 Go to the history element by the absolute history position HIST-POS."
1578 (comint-goto-input hist-pos))
1580 \f
1581 (defun comint-within-quotes (beg end)
1582 "Return t if the number of quotes between BEG and END is odd.
1583 Quotes are single and double."
1586 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1588 (defun comint-how-many-region (regexp beg end)
1589 "Return number of matches for REGEXP from BEG to END."
1590 (let ((count 0))
1591 (save-excursion
1592 (save-match-data
1593 (goto-char beg)
1594 (while (re-search-forward regexp end t)
1595 (setq count (1+ count)))))
1596 count))
1598 (defun comint-args (string begin end)
1599 ;; From STRING, return the args depending on the range specified in the text
1600 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1601 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1602 (save-match-data
1603 (if (null begin)
1604 (comint-arguments string 0 nil)
1605 (let* ((range (buffer-substring
1606 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1607 (nth (cond ((string-match "^[*^]" range) 1)
1608 ((string-match "^-" range) 0)
1609 ((string-equal range "$") nil)
1610 (t (string-to-number range))))
1611 (mth (cond ((string-match "[-*$]$" range) nil)
1612 ((string-match "-" range)
1613 (string-to-number (substring range (match-end 0))))
1614 (t nth))))
1615 (comint-arguments string nth mth)))))
1617 (defun comint-delim-arg (arg)
1618 "Return a list of arguments from ARG.
1619 Break it up at the delimiters in `comint-delimiter-argument-list'.
1620 Returned list is backwards.
1622 Characters with non-nil values of the text property `literal' are
1623 assumed to have literal values (e.g., backslash-escaped
1624 characters), and are not considered to be delimiters."
1625 (if (null comint-delimiter-argument-list)
1626 (list arg)
1627 (let ((args nil)
1628 (pos 0)
1629 (len (length arg)))
1630 (while (< pos len)
1631 (let ((char (aref arg pos))
1632 (start pos))
1633 (if (and (memq char comint-delimiter-argument-list)
1634 ;; Ignore backslash-escaped characters.
1635 (not (get-text-property pos 'literal arg)))
1636 (while (and (< pos len) (eq (aref arg pos) char))
1637 (setq pos (1+ pos)))
1638 (while (and (< pos len)
1639 (not (and (memq (aref arg pos)
1640 comint-delimiter-argument-list)
1641 (not (get-text-property
1642 pos 'literal arg)))))
1643 (setq pos (1+ pos))))
1644 (setq args (cons (substring arg start pos) args))))
1645 args)))
1647 (defun comint-arguments (string nth mth)
1648 "Return from STRING the NTH to MTH arguments.
1649 NTH and/or MTH can be nil, which means the last argument.
1650 Returned arguments are separated by single spaces.
1651 We assume whitespace separates arguments, except within quotes
1652 and except for a space or tab that immediately follows a backslash.
1653 Also, a run of one or more of a single character
1654 in `comint-delimiter-argument-list' is a separate argument.
1655 Argument 0 is the command name."
1656 ;; The first line handles ordinary characters and backslash-sequences
1657 ;; (except with w32 msdos-like shells, where backslashes are valid).
1658 ;; The second matches "-quoted strings.
1659 ;; The third matches '-quoted strings.
1660 ;; The fourth matches `-quoted strings.
1661 ;; This seems to fit the syntax of BASH 2.0.
1662 (let* ((backslash-escape (not (and (fboundp 'w32-shell-dos-semantics)
1663 (w32-shell-dos-semantics))))
1664 (first (if backslash-escape
1667 (argpart (concat first
1671 (quote-subexpr (if backslash-escape 2 1))
1672 (args ()) (pos 0)
1673 (count 0)
1674 beg str quotes)
1675 ;; Build a list of all the args until we have as many as we want.
1676 (while (and (or (null mth) (<= count mth))
1677 (string-match argpart string pos))
1678 ;; Apply the `literal' text property to backslash-escaped
1679 ;; characters, so that `comint-delim-arg' won't break them up.
1680 (and backslash-escape
1681 (match-beginning 1)
1682 (put-text-property (match-beginning 1) (match-end 1)
1683 'literal t string))
1684 (if (and beg (= pos (match-beginning 0)))
1685 ;; It's contiguous, part of the same arg.
1686 (setq pos (match-end 0)
1687 quotes (or quotes (match-beginning quote-subexpr)))
1688 ;; It's a new separate arg.
1689 (if beg
1690 ;; Put the previous arg, if there was one, onto ARGS.
1691 (setq str (substring string beg pos)
1692 args (if quotes (cons str args)
1693 (nconc (comint-delim-arg str) args))))
1694 (setq count (length args))
1695 (setq quotes (match-beginning quote-subexpr))
1696 (setq beg (match-beginning 0))
1697 (setq pos (match-end 0))))
1698 (if beg
1699 (setq str (substring string beg pos)
1700 args (if quotes (cons str args)
1701 (nconc (comint-delim-arg str) args))))
1702 (setq count (length args))
1703 (let ((n (or nth (1- count)))
1704 (m (if mth (1- (- count mth)) 0)))
1705 (mapconcat
1706 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1707 \f
1708 ;;
1709 ;; Input processing stuff
1710 ;;
1711 (defun comint-add-to-input-history (cmd)
1712 "Add CMD to the input history.
1713 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1714 (when (and (funcall comint-input-filter cmd)
1715 (or (null comint-input-ignoredups)
1716 (not (ring-p comint-input-ring))
1717 (ring-empty-p comint-input-ring)
1718 (not (string-equal (ring-ref comint-input-ring 0) cmd))))
1719 ;; If `comint-input-ring' is full, maybe grow it.
1720 (let ((size (ring-size comint-input-ring)))
1721 (and (= size (ring-length comint-input-ring))
1722 (< size comint-input-ring-size)
1723 (ring-extend comint-input-ring
1724 (min size (- comint-input-ring-size size)))))
1725 (ring-insert comint-input-ring cmd)))
1727 (defun comint-send-input (&optional no-newline artificial)
1728 "Send input to process.
1729 After the process output mark, sends all text from the process mark to
1730 point as input to the process. Before the process output mark, calls
1731 value of variable `comint-get-old-input' to retrieve old input, copies
1732 it to the process mark, and sends it.
1734 This command also sends and inserts a final newline, unless
1735 NO-NEWLINE is non-nil.
1737 Any history reference may be expanded depending on the value of the variable
1738 `comint-input-autoexpand'. The list of function names contained in the value
1739 of `comint-input-filter-functions' is called on the input before sending it.
1740 The input is entered into the input history ring, if the value of variable
1741 `comint-input-filter' returns non-nil when called on the input.
1743 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1744 end of line before sending the input.
1746 After the input has been sent, if `comint-process-echoes' is non-nil,
1747 then `comint-send-input' waits to see if the process outputs a string
1748 matching the input, and if so, deletes that part of the output.
1749 If ARTIFICIAL is non-nil, it inhibits such deletion.
1750 Callers sending input not from the user should use ARTIFICIAL = t.
1752 The values of `comint-get-old-input', `comint-input-filter-functions', and
1753 `comint-input-filter' are chosen according to the command interpreter running
1754 in the buffer. E.g.,
1756 If the interpreter is the csh,
1757 `comint-get-old-input' is the default:
1758 If `comint-use-prompt-regexp' is nil, then
1759 either return the current input field, if point is on an input
1760 field, or the current line, if point is on an output field.
1761 If `comint-use-prompt-regexp' is non-nil, then
1762 return the current line with any initial string matching the
1763 regexp `comint-prompt-regexp' removed.
1766 `comint-input-filter' is the default: returns t if the input isn't all white
1767 space.
1769 If the Comint is Lucid Common Lisp,
1770 `comint-get-old-input' snarfs the sexp ending at point.
1771 `comint-input-filter-functions' does nothing.
1772 `comint-input-filter' returns nil if the input matches input-filter-regexp,
1773 which matches (1) all whitespace (2) :a, :c, etc.
1775 Similarly for Soar, Scheme, etc."
1776 (interactive)
1777 ;; Note that the input string does not include its terminal newline.
1778 (let ((proc (get-buffer-process (current-buffer))))
1779 (if (not proc) (error "Current buffer has no process")
1780 (widen)
1781 (let* ((pmark (process-mark proc))
1782 (intxt (if (>= (point) (marker-position pmark))
1783 (progn (if comint-eol-on-send (end-of-line))
1784 (buffer-substring pmark (point)))
1785 (let ((copy (funcall comint-get-old-input)))
1786 (goto-char pmark)
1787 (insert copy)
1788 copy)))
1789 (input (if (not (eq comint-input-autoexpand 'input))
1790 ;; Just whatever's already there.
1791 intxt
1792 ;; Expand and leave it visible in buffer.
1793 (comint-replace-by-expanded-history t pmark)
1794 (buffer-substring pmark (point))))
1795 (history (if (not (eq comint-input-autoexpand 'history))
1796 input
1797 ;; This is messy 'cos ultimately the original
1798 ;; functions used do insertion, rather than return
1799 ;; strings. We have to expand, then insert back.
1800 (comint-replace-by-expanded-history t pmark)
1801 (let ((copy (buffer-substring pmark (point)))
1802 (start (point)))
1803 (insert input)
1804 (delete-region pmark start)
1805 copy))))
1807 (unless no-newline
1810 (comint-add-to-input-history history)
1812 (run-hook-with-args 'comint-input-filter-functions
1813 (if no-newline input
1816 (let ((beg (marker-position pmark))
1817 (end (if no-newline (point) (1- (point))))
1818 (inhibit-modification-hooks t))
1819 (when (> end beg)
1820 (add-text-properties beg end
1821 '(front-sticky t
1822 font-lock-face comint-highlight-input))
1823 (unless comint-use-prompt-regexp
1824 ;; Give old user input a field property of `input', to
1825 ;; distinguish it from both process output and unsent
1826 ;; input. The terminating newline is put into a special
1827 ;; `boundary' field to make cursor movement between input
1828 ;; and output fields smoother.
1829 (add-text-properties
1830 beg end
1831 '(mouse-face highlight
1832 help-echo "mouse-2: insert after prompt as new input"))))
1833 (unless (or no-newline comint-use-prompt-regexp)
1834 ;; Cover the terminating newline
1835 (add-text-properties end (1+ end)
1836 '(rear-nonsticky t
1837 field boundary
1838 inhibit-line-move-field-capture t))))
1840 (comint-snapshot-last-prompt)
1842 (setq comint-save-input-ring-index comint-input-ring-index)
1843 (setq comint-input-ring-index nil)
1844 ;; Update the markers before we send the input
1845 ;; in case we get output amidst sending the input.
1846 (set-marker comint-last-input-start pmark)
1847 (set-marker comint-last-input-end (point))
1848 (set-marker (process-mark proc) (point))
1849 ;; clear the "accumulation" marker
1850 (set-marker comint-accum-marker nil)
1851 (let ((comint-input-sender-no-newline no-newline))
1852 (funcall comint-input-sender proc input))
1854 ;; Optionally delete echoed input (after checking it).
1855 (when (and comint-process-echoes (not artificial))
1856 (let ((echo-len (- comint-last-input-end
1857 comint-last-input-start)))
1858 ;; Wait for all input to be echoed:
1859 (while (and (accept-process-output proc)
1860 (> (+ comint-last-input-end echo-len)
1861 (point-max))
1862 (zerop
1863 (compare-buffer-substrings
1864 nil comint-last-input-start
1865 (- (point-max) echo-len)
1866 ;; Above difference is equivalent to
1867 ;; (+ comint-last-input-start
1868 ;; (- (point-max) comint-last-input-end))
1869 nil comint-last-input-end (point-max)))))
1870 (if (and
1871 (<= (+ comint-last-input-end echo-len)
1872 (point-max))
1873 (zerop
1874 (compare-buffer-substrings
1875 nil comint-last-input-start comint-last-input-end
1876 nil comint-last-input-end
1877 (+ comint-last-input-end echo-len))))
1878 ;; Certain parts of the text to be deleted may have
1879 ;; been mistaken for prompts. We have to prevent
1880 ;; problems when `comint-prompt-read-only' is non-nil.
1881 (let ((inhibit-read-only t))
1882 (delete-region comint-last-input-end
1883 (+ comint-last-input-end echo-len))
1884 (when comint-prompt-read-only
1885 (save-excursion
1886 (goto-char comint-last-input-end)
1887 (comint-update-fence)))))))
1889 ;; This used to call comint-output-filter-functions,
1890 ;; but that scrolled the buffer in undesirable ways.
1891 (run-hook-with-args 'comint-output-filter-functions "")))))
1893 (defvar comint-preoutput-filter-functions nil
1894 "List of functions to call before inserting Comint output into the buffer.
1895 Each function gets one argument, a string containing the text received
1896 from the subprocess. It should return the string to insert, perhaps
1897 the same string that was received, or perhaps a modified or transformed
1898 string.
1900 The functions on the list are called sequentially, and each one is
1901 given the string returned by the previous one. The string returned by
1902 the last function is the text that is actually inserted in the
1903 redirection buffer.
1905 You can use `add-hook' to add functions to this list
1906 either globally or locally.")
1908 (defvar comint-inhibit-carriage-motion nil
1909 "If nil, Comint will interpret `carriage control' characters in output.
1910 See `comint-carriage-motion' for details.")
1912 ;; When non-nil, this is an overlay over the last recognized prompt in
1913 ;; the buffer; it is used when highlighting the prompt.
1914 (defvar comint-last-prompt-overlay nil)
1916 (defun comint-snapshot-last-prompt ()
1917 "`snapshot' any current `comint-last-prompt-overlay'.
1918 Freeze its attributes in place, even when more input comes along
1919 and moves the prompt overlay."
1920 (when comint-last-prompt-overlay
1921 (let ((inhibit-read-only t)
1922 (inhibit-modification-hooks t))
1923 (add-text-properties (overlay-start comint-last-prompt-overlay)
1924 (overlay-end comint-last-prompt-overlay)
1925 (overlay-properties comint-last-prompt-overlay)))))
1927 (defun comint-carriage-motion (start end)
1928 "Interpret carriage control characters in the region from START to END.
1929 Translate carriage return/linefeed sequences to linefeeds.
1930 Make single carriage returns delete to the beginning of the line.
1931 Make backspaces delete the previous character."
1932 (save-excursion
1934 ;; calling save-match-data and save-restriction. But, such a
1935 ;; check is not necessary now because we don't use regexp search
1936 ;; nor save-restriction. Note that the buffer is already widen,
1937 ;; and calling narrow-to-region and widen are not that heavy.
1938 (goto-char start)
1939 (let* ((inhibit-field-text-motion t)
1940 (inhibit-read-only t)
1941 (lbeg (line-beginning-position))
1942 delete-end ch)
1943 ;; If the preceding text is marked as "must-overwrite", record
1944 ;; it in delete-end.
1945 (when (and (> start (point-min))
1946 (get-text-property (1- start) 'comint-must-overwrite))
1947 (setq delete-end (point-marker))
1948 (remove-text-properties lbeg start '(comint-must-overwrite nil)))
1949 (narrow-to-region lbeg end)
1950 ;; Handle BS, LF, and CR specially.
1952 (setq ch (following-char))
1954 (delete-char 1)
1955 (if (> (point) lbeg)
1956 (delete-char -1)))
1958 (when delete-end ; CH = LF
1959 (if (< delete-end (point))
1960 (delete-region lbeg delete-end))
1961 (set-marker delete-end nil)
1962 (setq delete-end nil))
1963 (forward-char 1)
1964 (setq lbeg (point)))
1965 (t ; CH = CR
1966 (delete-char 1)
1967 (if delete-end
1968 (when (< delete-end (point))
1969 (delete-region lbeg delete-end)
1970 (move-marker delete-end (point)))
1971 (setq delete-end (point-marker))))))
1972 (when delete-end
1973 (if (< delete-end (point))
1974 ;; As there's a text after the last CR, make the current
1975 ;; line contain only that text.
1976 (delete-region lbeg delete-end)
1977 ;; Remember that the process output ends by CR, and thus we
1978 ;; must overwrite the contents of the current line next
1979 ;; time.
1980 (put-text-property lbeg delete-end 'comint-must-overwrite t))
1981 (set-marker delete-end nil))
1982 (widen))))
1984 ;; The purpose of using this filter for comint processes
1985 ;; is to keep comint-last-input-end from moving forward
1986 ;; when output is inserted.
1987 (defun comint-output-filter (process string)
1988 (let ((oprocbuf (process-buffer process)))
1989 ;; First check for killed buffer or no input.
1990 (when (and string oprocbuf (buffer-name oprocbuf))
1991 (with-current-buffer oprocbuf
1992 ;; Run preoutput filters
1993 (let ((functions comint-preoutput-filter-functions))
1994 (while (and functions string)
1995 (if (eq (car functions) t)
1996 (let ((functions
1997 (default-value 'comint-preoutput-filter-functions)))
1998 (while (and functions string)
1999 (setq string (funcall (car functions) string))
2000 (setq functions (cdr functions))))
2001 (setq string (funcall (car functions) string)))
2002 (setq functions (cdr functions))))
2004 ;; Insert STRING
2005 (let ((inhibit-read-only t)
2006 ;; The point should float after any insertion we do.
2007 (saved-point (copy-marker (point) t)))
2009 ;; We temporarily remove any buffer narrowing, in case the
2010 ;; process mark is outside of the restriction
2011 (save-restriction
2012 (widen)
2014 (goto-char (process-mark process))
2015 (set-marker comint-last-output-start (point))
2017 ;; insert-before-markers is a bad thing. XXX
2018 ;; Luckily we don't have to use it any more, we use
2019 ;; window-point-insertion-type instead.
2020 (insert string)
2022 ;; Advance process-mark
2023 (set-marker (process-mark process) (point))
2025 (unless comint-inhibit-carriage-motion
2026 ;; Interpret any carriage motion characters (newline, backspace)
2027 (comint-carriage-motion comint-last-output-start (point)))
2029 ;; Run these hooks with point where the user had it.
2030 (goto-char saved-point)
2031 (run-hook-with-args 'comint-output-filter-functions string)
2032 (set-marker saved-point (point))
2034 (goto-char (process-mark process)) ; in case a filter moved it
2036 (unless comint-use-prompt-regexp
2037 (let ((inhibit-read-only t)
2038 (inhibit-modification-hooks t))
2039 (add-text-properties comint-last-output-start (point)
2040 '(front-sticky
2041 (field inhibit-line-move-field-capture)
2042 rear-nonsticky t
2043 field output
2044 inhibit-line-move-field-capture t))))
2046 ;; Highlight the prompt, where we define `prompt' to mean
2047 ;; the most recent output that doesn't end with a newline.
2048 (let ((prompt-start (save-excursion (forward-line 0) (point)))
2049 (inhibit-read-only t)
2050 (inhibit-modification-hooks t))
2051 (when comint-prompt-read-only
2052 (or (= (point-min) prompt-start)
2053 (get-text-property (1- prompt-start) 'read-only)
2054 (put-text-property
2055 (1- prompt-start) prompt-start 'read-only 'fence))
2056 (add-text-properties
2057 prompt-start (point)
2058 '(read-only t rear-nonsticky t front-sticky (read-only))))
2059 (unless (and (bolp) (null comint-last-prompt-overlay))
2060 ;; Need to create or move the prompt overlay (in the case
2061 ;; where there is no prompt ((bolp) == t), we still do
2062 ;; this if there's already an existing overlay).
2063 (if comint-last-prompt-overlay
2064 ;; Just move an existing overlay
2065 (move-overlay comint-last-prompt-overlay
2066 prompt-start (point))
2067 ;; Need to create the overlay
2068 (setq comint-last-prompt-overlay
2069 (make-overlay prompt-start (point)))
2070 (overlay-put comint-last-prompt-overlay
2071 'font-lock-face 'comint-highlight-prompt))))
2073 (goto-char saved-point)))))))
2075 (defun comint-preinput-scroll-to-bottom ()
2076 "Go to the end of buffer in all windows showing it.
2077 Movement occurs if point in the selected window is not after the process mark,
2078 and `this-command' is an insertion command. Insertion commands recognized
2079 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
2080 Depends on the value of `comint-scroll-to-bottom-on-input'.
2082 This function should be a pre-command hook."
2083 (if (and comint-scroll-to-bottom-on-input
2084 (memq this-command '(self-insert-command comint-magic-space yank
2085 hilit-yank)))
2086 (let* ((selected (selected-window))
2087 (current (current-buffer))
2088 (process (get-buffer-process current))
2089 (scroll comint-scroll-to-bottom-on-input))
2090 (if (and process (< (point) (process-mark process)))
2091 (if (eq scroll 'this)
2092 (goto-char (point-max))
2093 (walk-windows
2094 (lambda (window)
2095 (if (and (eq (window-buffer window) current)
2096 (or (eq scroll t) (eq scroll 'all)))
2097 (progn
2098 (select-window window)
2099 (goto-char (point-max))
2100 (select-window selected))))
2101 nil t))))))
2103 (defun comint-postoutput-scroll-to-bottom (_string)
2104 "Go to the end of buffer in some or all windows showing it.
2105 Does not scroll if the current line is the last line in the buffer.
2106 Depends on the value of `comint-move-point-for-output' and
2107 `comint-scroll-show-maximum-output'.
2109 This function should be in the list `comint-output-filter-functions'."
2110 (let* ((selected (selected-window))
2111 (current (current-buffer))
2112 (process (get-buffer-process current))
2113 (scroll comint-move-point-for-output))
2114 (unwind-protect
2115 (if process
2116 (walk-windows
2117 (lambda (window)
2118 (when (eq (window-buffer window) current)
2119 (select-window window)
2120 (if (and (< (point) (process-mark process))
2121 (or (eq scroll t) (eq scroll 'all)
2122 ;; Maybe user wants point to jump to end.
2123 (and (eq scroll 'this) (eq selected window))
2124 (and (eq scroll 'others) (not (eq selected window)))
2125 ;; If point was at the end, keep it at end.
2126 (and (marker-position comint-last-output-start)
2127 (>= (point) comint-last-output-start))))
2128 (goto-char (process-mark process)))
2129 ;; Optionally scroll so that the text
2130 ;; ends at the bottom of the window.
2131 (if (and comint-scroll-show-maximum-output
2132 (= (point) (point-max)))
2133 (save-excursion
2134 (goto-char (point-max))
2135 (recenter (- -1 scroll-margin))))
2136 (select-window selected)))
2137 nil t))
2138 (set-buffer current))))
2140 (defun comint-truncate-buffer (&optional _string)
2141 "Truncate the buffer to `comint-buffer-maximum-size'.
2142 This function could be on `comint-output-filter-functions' or bound to a key."
2143 (interactive)
2144 (save-excursion
2145 (goto-char (process-mark (get-buffer-process (current-buffer))))
2146 (forward-line (- comint-buffer-maximum-size))
2147 (beginning-of-line)
2148 (let ((inhibit-read-only t))
2149 (delete-region (point-min) (point)))))
2151 (defun comint-strip-ctrl-m (&optional _string)
2152 "Strip trailing `^M' characters from the current output group.
2153 This function could be on `comint-output-filter-functions' or bound to a key."
2154 (interactive)
2155 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2156 (save-excursion
2157 (condition-case nil
2158 (goto-char
2159 (if (called-interactively-p 'interactive)
2160 comint-last-input-end comint-last-output-start))
2161 (error nil))
2163 (replace-match "" t t)))))
2164 (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
2166 (defun comint-show-maximum-output ()
2167 "Put the end of the buffer at the bottom of the window."
2168 (interactive)
2169 (goto-char (point-max))
2170 (recenter (- -1 scroll-margin)))
2172 (defun comint-get-old-input-default ()
2173 "Default for `comint-get-old-input'.
2174 If `comint-use-prompt-regexp' is nil, then either
2175 return the current input field, if point is on an input field, or the
2176 current line, if point is on an output field.
2177 If `comint-use-prompt-regexp' is non-nil, then return
2178 the current line with any initial string matching the regexp
2179 `comint-prompt-regexp' removed."
2180 (let (bof)
2181 (if (and (not comint-use-prompt-regexp)
2182 ;; Make sure we're in an input rather than output field.
2183 (null (get-char-property (setq bof (field-beginning)) 'field)))
2184 (field-string-no-properties bof)
2185 (comint-bol)
2186 (buffer-substring-no-properties (point) (line-end-position)))))
2188 (defun comint-copy-old-input ()
2189 "Insert after prompt old input at point as new input to be edited.
2190 Calls `comint-get-old-input' to get old input."
2191 (interactive)
2192 (let ((input (funcall comint-get-old-input))
2193 (process (get-buffer-process (current-buffer))))
2194 (if (not process)
2195 (error "Current buffer has no process")
2196 (goto-char (process-mark process))
2197 (insert input))))
2199 (defun comint-skip-prompt ()
2200 "Skip past the text matching regexp `comint-prompt-regexp'.
2201 If this takes us past the end of the current line, don't skip at all."
2202 (if (and (looking-at comint-prompt-regexp)
2203 (<= (match-end 0) (line-end-position)))
2204 (goto-char (match-end 0))))
2206 (defun comint-after-pmark-p ()
2207 "Return t if point is after the process output marker."
2208 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2209 (<= (marker-position pmark) (point))))
2211 (defun comint-simple-send (proc string)
2212 "Default function for sending to PROC input STRING.
2213 This just sends STRING plus a newline. To override this,
2214 set the hook `comint-input-sender'."
2215 (let ((send-string
2216 (if comint-input-sender-no-newline
2217 string
2218 ;; Sending as two separate strings does not work
2221 (comint-send-string proc send-string))
2222 (if (and comint-input-sender-no-newline
2223 (not (string-equal string "")))
2224 (process-send-eof)))
2226 (defun comint-line-beginning-position ()
2227 "Return the buffer position of the beginning of the line, after any prompt.
2228 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done by
2229 skipping text matching the regular expression `comint-prompt-regexp',
2230 a buffer local variable."
2231 (if comint-use-prompt-regexp
2232 ;; Use comint-prompt-regexp
2233 (save-excursion
2234 (beginning-of-line)
2235 (comint-skip-prompt)
2236 (point))
2237 ;; Use input fields. Note that, unlike the behavior of
2238 ;; `line-beginning-position' inside a field, this function will
2239 ;; return the position of the end of a prompt, even if the point is
2240 ;; already inside the prompt. In order to do this, it assumes that
2241 ;; if there are two fields on a line, then the first one is the
2242 ;; prompt, and the second one is an input field, and is front-sticky
2243 ;; (as input fields should be).
2244 (constrain-to-field (line-beginning-position) (line-end-position))))
2246 (defun comint-bol (&optional arg)
2247 "Go to the beginning of line, then skip past the prompt, if any.
2249 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done
2250 by skipping text matching the regular expression `comint-prompt-regexp',
2251 a buffer local variable."
2252 (interactive "P")
2253 (if arg
2254 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
2255 (forward-line 0)
2256 (goto-char (comint-line-beginning-position))))
2258 ;; For compatibility.
2259 (defun comint-read-noecho (prompt &optional _ignore)
2260 (read-passwd prompt))
2262 ;; These three functions are for entering text you don't want echoed or
2263 ;; saved -- typically passwords to ftp, telnet, or somesuch.
2264 ;; Just enter m-x send-invisible and type in your line.
2266 (defun send-invisible (&optional prompt)
2267 "Read a string without echoing.
2268 Then send it to the process running in the current buffer.
2269 The string is sent using `comint-input-sender'.
2270 Security bug: your string can still be temporarily recovered with
2272 (interactive "P") ; Defeat snooping via C-x ESC ESC
2273 (let ((proc (get-buffer-process (current-buffer)))
2274 (prefix
2275 (if (eq (window-buffer (selected-window)) (current-buffer))
2276 ""
2277 (format "(In buffer %s) "
2278 (current-buffer)))))
2279 (if proc
2280 (let ((str (read-passwd (concat prefix
2281 (or prompt "Non-echoed text: ")))))
2282 (if (stringp str)
2283 (progn
2284 (comint-snapshot-last-prompt)
2285 (funcall comint-input-sender proc str))
2286 (message "Warning: text will be echoed")))
2287 (error "Buffer %s has no process" (current-buffer)))))
2289 (defun comint-watch-for-password-prompt (string)
2290 "Prompt in the minibuffer for password and send without echoing.
2291 This function uses `send-invisible' to read and send a password to the buffer's
2292 process if STRING contains a password prompt defined by
2293 `comint-password-prompt-regexp'.
2295 This function could be in the list `comint-output-filter-functions'."
2296 (when (string-match comint-password-prompt-regexp string)
2298 (setq string (replace-match "" t t string)))
2299 (send-invisible string)))
2300 \f
2301 ;; Low-level process communication
2303 (defun comint-send-string (process string)
2304 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
2305 (if process
2306 (with-current-buffer (if (processp process)
2307 (process-buffer process)
2308 (get-buffer process))
2309 (comint-snapshot-last-prompt))
2310 (comint-snapshot-last-prompt))
2311 (process-send-string process string))
2313 (defun comint-send-region (process start end)
2314 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
2315 (if process
2316 (with-current-buffer (if (processp process)
2317 (process-buffer process)
2318 (get-buffer process))
2319 (comint-snapshot-last-prompt))
2320 (comint-snapshot-last-prompt))
2321 (process-send-region process start end))
2323 \f
2324 ;; Random input hackage
2326 (defun comint-delete-output ()
2327 "Delete all output from interpreter since last input.
2328 Does not delete the prompt."
2329 (interactive)
2330 (let ((proc (get-buffer-process (current-buffer)))
2331 (replacement nil)
2332 (inhibit-read-only t))
2333 (save-excursion
2334 (let ((pmark (progn (goto-char (process-mark proc))
2335 (forward-line 0)
2336 (point-marker))))
2337 (delete-region comint-last-input-end pmark)
2338 (goto-char (process-mark proc))
2340 (buffer-substring pmark (point))))
2341 (delete-region pmark (point))))
2342 ;; Output message and put back prompt
2343 (comint-output-filter proc replacement)))
2345 (defun comint-write-output (filename &optional append mustbenew)
2346 "Write output from interpreter since last input to FILENAME.
2347 Any prompt at the end of the output is not written.
2349 If the optional argument APPEND (the prefix argument when interactive)
2350 is non-nil, the output is appended to the file instead.
2352 If the optional argument MUSTBENEW is non-nil, check for an existing
2353 file with the same name. If MUSTBENEW is `excl', that means to get an
2354 error if the file already exists; never overwrite. If MUSTBENEW is
2355 neither nil nor `excl', that means ask for confirmation before
2356 overwriting, but do go ahead and overwrite the file if the user
2357 confirms. When interactive, MUSTBENEW is nil when appending, and t
2358 otherwise."
2359 (interactive
2360 (list (read-file-name
2361 (if current-prefix-arg
2362 "Append output to file: "
2363 "Write output to file: "))
2364 current-prefix-arg
2365 (not current-prefix-arg)))
2366 (save-excursion
2367 (goto-char (process-mark (get-buffer-process (current-buffer))))
2368 (forward-line 0)
2369 (write-region comint-last-input-end (point) filename
2370 append nil nil mustbenew)))
2372 ;; This function exists for the benefit of the menu; from the keyboard,
2373 ;; users can just use `comint-write-output' with a prefix arg.
2374 (defun comint-append-output-to-file (filename)
2375 "Append output from interpreter since last input to FILENAME.
2376 Any prompt at the end of the output is not written."
2377 (interactive "fAppend output to file: ")
2378 (comint-write-output filename t))
2380 (defun comint-show-output ()
2381 "Display start of this batch of interpreter output at top of window.
2382 Sets mark to the value of point when this command is run."
2383 (interactive)
2384 (push-mark)
2385 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
2386 (cond (comint-use-prompt-regexp
2387 (goto-char pos)
2388 (beginning-of-line 0)
2389 (set-window-start (selected-window) (point))
2390 (comint-skip-prompt))
2391 (t
2392 (goto-char (field-beginning pos))
2393 (set-window-start (selected-window) (point))))))
2396 (defun comint-interrupt-subjob ()
2397 "Interrupt the current subjob.
2398 This command also kills the pending input
2399 between the process mark and point."
2400 (interactive)
2401 (comint-skip-input)
2402 (interrupt-process nil comint-ptyp)
2404 )
2406 (defun comint-kill-subjob ()
2407 "Send kill signal to the current subjob.
2408 This command also kills the pending input
2409 between the process mark and point."
2410 (interactive)
2411 (comint-skip-input)
2412 (kill-process nil comint-ptyp))
2414 (defun comint-quit-subjob ()
2415 "Send quit signal to the current subjob.
2416 This command also kills the pending input
2417 between the process mark and point."
2418 (interactive)
2419 (comint-skip-input)
2420 (quit-process nil comint-ptyp))
2422 (defun comint-stop-subjob ()
2423 "Stop the current subjob.
2424 This command also kills the pending input
2425 between the process mark and point.
2427 WARNING: if there is no current subjob, you can end up suspending
2428 the top-level process running in the buffer. If you accidentally do
2430 is not a problem with most shells, since they ignore this signal.)"
2431 (interactive)
2432 (comint-skip-input)
2433 (stop-process nil comint-ptyp))
2435 (defun comint-continue-subjob ()
2436 "Send CONT signal to process buffer's process group.
2437 Useful if you accidentally suspend the top-level process."
2438 (interactive)
2439 (continue-process nil comint-ptyp))
2441 (defun comint-skip-input ()
2442 "Skip all pending input, from last stuff output by interpreter to point.
2443 This means mark it as if it had been sent as input, without sending it."
2444 (let ((comint-input-sender 'ignore)
2445 (comint-input-filter-functions nil))
2446 (comint-send-input t t))
2447 (end-of-line)
2448 (let ((pos (point))
2449 (marker (process-mark (get-buffer-process (current-buffer)))))
2450 (insert " " (key-description (this-command-keys)))
2451 (if (= marker pos)
2452 (set-marker marker (point)))))
2454 (defun comint-kill-input ()
2455 "Kill all text from last stuff output by interpreter to point."
2456 (interactive)
2457 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2458 (if (> (point) (marker-position pmark))
2459 (kill-region pmark (point)))))
2461 (defun comint-delchar-or-maybe-eof (arg)
2462 "Delete ARG characters forward or send an EOF to subprocess.
2463 Sends an EOF only if point is at the end of the buffer and there is no input."
2464 (interactive "p")
2465 (let ((proc (get-buffer-process (current-buffer))))
2466 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
2467 (comint-send-eof)
2468 (delete-char arg))))
2470 (defun comint-send-eof ()
2471 "Send an EOF to the current buffer's process."
2472 (interactive)
2473 (comint-send-input t t)
2474 (process-send-eof))
2477 (defun comint-backward-matching-input (regexp n)
2478 "Search backward through buffer for input fields that match REGEXP.
2479 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2480 by lines that match `comint-prompt-regexp'.
2482 With prefix argument N, search for Nth previous match.
2483 If N is negative, find the next or Nth next match."
2484 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2485 (if comint-use-prompt-regexp
2486 ;; Use comint-prompt-regexp
2487 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2488 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2489 (if (re-search-backward re nil t n)
2490 (point)))))
2491 (if (null pos)
2492 (progn (message "Not found")
2493 (ding))
2494 (goto-char pos)
2495 (comint-bol nil)))
2496 ;; Use input fields
2497 (let* ((dir (if (< n 0) -1 1))
2498 (pos
2499 (save-excursion
2500 (while (/= n 0)
2501 (unless (re-search-backward regexp nil t dir)
2502 (error "Not found"))
2503 (unless (get-char-property (point) 'field)
2504 (setq n (- n dir))))
2505 (field-beginning))))
2506 (goto-char pos))))
2509 (defun comint-forward-matching-input (regexp n)
2510 "Search forward through buffer for input fields that match REGEXP.
2511 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2512 by lines that match `comint-prompt-regexp'.
2514 With prefix argument N, search for Nth following match.
2515 If N is negative, find the previous or Nth previous match."
2516 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2517 (comint-backward-matching-input regexp (- n)))
2520 (defun comint-next-prompt (n)
2521 "Move to end of Nth next prompt in the buffer.
2522 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2523 the Nth next `input' field, otherwise, it means the Nth occurrence of
2524 text matching `comint-prompt-regexp'."
2525 (interactive "p")
2526 (if comint-use-prompt-regexp
2527 ;; Use comint-prompt-regexp
2528 (let ((paragraph-start comint-prompt-regexp))
2529 (end-of-line (if (> n 0) 1 0))
2530 (forward-paragraph n)
2531 (comint-skip-prompt))
2532 ;; Use input fields
2533 (let ((pos (point))
2534 (input-pos nil)
2535 prev-pos)
2536 (while (/= n 0)
2537 (setq prev-pos pos)
2538 (setq pos
2539 (if (> n 0)
2540 (next-single-char-property-change pos 'field)
2541 (previous-single-char-property-change pos 'field)))
2542 (cond ((= pos prev-pos)
2543 ;; Ran off the end of the buffer.
2544 (when (> n 0)
2545 ;; There's always an input field at the end of the
2546 ;; buffer, but it has a `field' property of nil.
2547 (setq input-pos (point-max)))
2548 ;; stop iterating
2549 (setq n 0))
2550 ((null (get-char-property pos 'field))
2551 (setq n (if (< n 0) (1+ n) (1- n)))
2552 (setq input-pos pos))))
2553 (when input-pos
2554 (goto-char input-pos)))))
2557 (defun comint-previous-prompt (n)
2558 "Move to end of Nth previous prompt in the buffer.
2559 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2560 the Nth previous `input' field, otherwise, it means the Nth occurrence of
2561 text matching `comint-prompt-regexp'."
2562 (interactive "p")
2563 (comint-next-prompt (- n)))
2565 ;; State used by `comint-insert-previous-argument' when cycling.
2566 (defvar comint-insert-previous-argument-last-start-pos nil)
2567 (make-variable-buffer-local 'comint-insert-previous-argument-last-start-pos)
2568 (defvar comint-insert-previous-argument-last-index nil)
2569 (make-variable-buffer-local 'comint-insert-previous-argument-last-index)
2571 ;; Needs fixing:
2572 ;; make comint-arguments understand negative indices as bash does
2573 (defun comint-insert-previous-argument (index)
2574 "Insert the INDEXth argument from the previous Comint command-line at point.
2575 Spaces are added at beginning and/or end of the inserted string if
2576 necessary to ensure that it's separated from adjacent arguments.
2577 Interactively, if no prefix argument is given, the last argument is inserted.
2578 Repeated interactive invocations will cycle through the same argument
2579 from progressively earlier commands (using the value of INDEX specified
2580 with the first command).
2581 This command is like `M-.' in bash."
2582 (interactive "P")
2583 (unless (null index)
2584 (setq index (prefix-numeric-value index)))
2585 (cond ((eq last-command this-command)
2586 ;; Delete last input inserted by this command.
2587 (delete-region comint-insert-previous-argument-last-start-pos (point))
2588 (setq index comint-insert-previous-argument-last-index))
2589 (t
2590 ;; This is a non-repeat invocation, so initialize state.
2591 (setq comint-input-ring-index nil)
2592 (setq comint-insert-previous-argument-last-index index)
2593 (when (null comint-insert-previous-argument-last-start-pos)
2594 ;; First usage; initialize to a marker
2595 (setq comint-insert-previous-argument-last-start-pos
2596 (make-marker)))))
2597 ;; Make sure we're not in the prompt, and add a beginning space if necessary.
2598 (if (<= (point) (comint-line-beginning-position))
2599 (comint-bol)
2600 (just-one-space))
2601 ;; Remember the beginning of what we insert, so we can delete it if
2602 ;; the command is repeated.
2603 (set-marker comint-insert-previous-argument-last-start-pos (point))
2604 ;; Insert the argument.
2605 (let ((input-string (comint-previous-input-string 0)))
2607 ;; strip terminating '&'
2608 (setq input-string (substring input-string 0 (match-beginning 0))))
2609 (insert (comint-arguments input-string index index)))
2610 ;; Make next invocation return arg from previous input
2611 (setq comint-input-ring-index (1+ (or comint-input-ring-index 0)))
2612 ;; Add a terminating space if necessary.
2613 (unless (eolp)
2614 (just-one-space)))
2616 \f
2617 ;; Support editing with `comint-prompt-read-only' set to t.
2619 (defun comint-update-fence ()
2620 "Update read-only status of newline before point.
2621 The `fence' read-only property is used to indicate that a newline
2623 following front-sticky read-only region. This is used to
2624 implement comint read-only prompts. If the text after a newline
2625 changes, the read-only status of that newline may need updating.
2626 That is what this function does.
2628 This function does nothing if point is not at the beginning of a
2629 line, or is at the beginning of the accessible portion of the buffer.
2630 Otherwise, if the character after point has a front-sticky
2631 read-only property, then the preceding newline is given a
2632 read-only property of `fence', unless it already is read-only.
2633 If the character after point does not have a front-sticky
2634 read-only property, any read-only property of `fence' on the
2635 preceding newline is removed."
2636 (let* ((pt (point)) (lst (get-text-property pt 'front-sticky))
2637 (inhibit-modification-hooks t))
2638 (and (bolp)
2639 (not (bobp))
2640 (if (and (get-text-property pt 'read-only)
2641 (if (listp lst) (memq 'read-only lst) t))
2642 (unless (get-text-property (1- pt) 'read-only)
2643 (put-text-property (1- pt) pt 'read-only 'fence))
2644 (when (eq (get-text-property (1- pt) 'read-only) 'fence)
2645 (remove-list-of-text-properties (1- pt) pt '(read-only)))))))
2647 (defun comint-kill-whole-line (&optional count)
2648 "Kill current line, ignoring read-only and field properties.
2649 With prefix arg COUNT, kill that many lines starting from the current line.
2650 If COUNT is negative, kill backward. Also kill the preceding newline,
2652 with negative arguments.)
2653 If COUNT is zero, kill current line but exclude the trailing newline.
2654 The read-only status of newlines is updated with `comint-update-fence',
2655 if necessary."
2656 (interactive "p")
2657 (let ((inhibit-read-only t) (inhibit-field-text-motion t))
2658 (kill-whole-line count)
2659 (when (>= count 0) (comint-update-fence))))
2661 (defun comint-kill-region (beg end &optional yank-handler)
2662 "Like `kill-region', but ignores read-only properties, if safe.
2663 This command assumes that the buffer contains read-only
2665 properties at the beginning of a line, with the preceding newline
2666 being read-only to protect the prompt. This is true of the
2667 comint prompts if `comint-prompt-read-only' is non-nil. This
2668 command will not delete the region if this would create mutilated
2669 or out of place prompts. That is, if any part of a prompt is
2670 deleted, the entire prompt must be deleted and all remaining
2671 prompts should stay at the beginning of a line. If this is not
2672 the case, this command just calls `kill-region' with all
2673 read-only properties intact. The read-only status of newlines is
2674 updated using `comint-update-fence', if necessary."
2675 (interactive "r")
2676 (save-excursion
2677 (let* ((true-beg (min beg end))
2678 (true-end (max beg end))
2679 (beg-bolp (progn (goto-char true-beg) (bolp)))
2680 (beg-lst (get-text-property true-beg 'front-sticky))
2681 (beg-bad (and (get-text-property true-beg 'read-only)
2682 (if (listp beg-lst) (memq 'read-only beg-lst) t)))
2683 (end-bolp (progn (goto-char true-end) (bolp)))
2684 (end-lst (get-text-property true-end 'front-sticky))
2685 (end-bad (and (get-text-property true-end 'read-only)
2686 (if (listp end-lst) (memq 'read-only end-lst) t))))
2687 (if (or (and (not beg-bolp) (or beg-bad end-bad))
2688 (and (not end-bolp) end-bad))
2689 (kill-region beg end yank-handler)
2690 (let ((inhibit-read-only t))
2691 (kill-region beg end yank-handler)
2692 (comint-update-fence))))))
2693 (set-advertised-calling-convention 'comint-kill-region '(beg end) "23.3")
2695 \f
2696 ;; Support for source-file processing commands.
2697 ;;============================================================================
2698 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2699 ;; commands that process files of source text (e.g. loading or compiling
2700 ;; files). So the corresponding process-in-a-buffer modes have commands
2701 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2702 ;; for defining these commands.
2703 ;;
2704 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2705 ;; and Soar, in that they don't know anything about file extensions.
2706 ;; So the compile/load interface gets the wrong default occasionally.
2707 ;; The load-file/compile-file default mechanism could be smarter -- it
2708 ;; doesn't know about the relationship between filename extensions and
2709 ;; whether the file is source or executable. If you compile foo.lisp
2710 ;; with compile-file, then the next load-file should use foo.bin for
2711 ;; the default, not foo.lisp. This is tricky to do right, particularly
2712 ;; because the extension for executable files varies so much (.o, .bin,
2713 ;; .lbin, .mo, .vo, .ao, ...).
2716 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2717 ;; commands.
2718 ;;
2719 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2720 ;; want to save the buffer before issuing any process requests to the command
2721 ;; interpreter.
2722 ;;
2723 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2724 ;; for the file to process.
2726 (defun comint-source-default (previous-dir/file source-modes)
2727 "Compute the defaults for `load-file' and `compile-file' commands.
2729 PREVIOUS-DIR/FILE is a pair (DIRECTORY . FILENAME) from the last
2730 source-file processing command, or nil if there hasn't been one yet.
2731 SOURCE-MODES is a list used to determine what buffers contain source
2732 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2733 Typically, (lisp-mode) or (scheme-mode).
2735 If the command is given while the cursor is inside a string, *and*
2736 the string is an existing filename, *and* the filename is not a directory,
2737 then the string is taken as default. This allows you to just position
2738 your cursor over a string that's a filename and have it taken as default.
2740 If the command is given in a file buffer whose major mode is in
2741 SOURCE-MODES, then the filename is the default file, and the
2742 file's directory is the default directory.
2744 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2745 then the default directory & file are what was used in the last source-file
2746 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2747 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2750 SOURCE-MODES is typically going to be something like (tea-mode)
2751 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2752 for Soar programs, etc.
2754 The function returns a pair: (default-directory . default-file)."
2755 (cond ((and buffer-file-name (memq major-mode source-modes))
2756 (cons (file-name-directory buffer-file-name)
2757 (file-name-nondirectory buffer-file-name)))
2758 (previous-dir/file)
2759 (t
2760 (cons default-directory nil))))
2763 (defun comint-check-source (fname)
2764 "Check whether to save buffers visiting file FNAME.
2765 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2766 process-in-a-buffer modes), this function can be called on the filename.
2767 If the file is loaded into a buffer, and the buffer is modified, the user
2768 is queried to see if he wants to save the buffer before proceeding with
2769 the load or compile."
2770 (let ((buff (get-file-buffer fname)))
2771 (if (and buff
2772 (buffer-modified-p buff)
2773 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
2774 ;; save BUFF.
2775 (let ((old-buffer (current-buffer)))
2776 (set-buffer buff)
2777 (save-buffer)
2778 (set-buffer old-buffer)))))
2780 (defun comint-extract-string ()
2781 "Return string around point, or nil."
2782 (let ((syntax (syntax-ppss)))
2783 (when (nth 3 syntax)
2784 (condition-case ()
2785 (buffer-substring-no-properties (1+ (nth 8 syntax))
2786 (progn (goto-char (nth 8 syntax))
2787 (forward-sexp)
2788 (1- (point))))
2789 (error nil)))))
2791 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2792 "Prompt for filenames in commands that process source files,
2793 e.g. loading or compiling a file.
2794 Provides a default, if there is one, and returns the result filename.
2796 See `comint-source-default' for more on determining defaults.
2798 PROMPT is the prompt string. PREV-DIR/FILE is the (DIRECTORY . FILE) pair
2799 from the last source processing command. SOURCE-MODES is a list of major
2800 modes used to determine what file buffers contain source files. (These
2801 two arguments are used for determining defaults.) If MUSTMATCH-P is true,
2802 then the filename reader will only accept a file that exists.
2804 A typical use:
2806 '(lisp-mode) t))"
2807 (let* ((def (comint-source-default prev-dir/file source-modes))
2808 (stringfile (comint-extract-string))
2809 (sfile-p (and stringfile
2810 (condition-case ()
2811 (file-exists-p stringfile)
2812 (error nil))
2813 (not (file-directory-p stringfile))))
2814 (defdir (if sfile-p (file-name-directory stringfile)
2815 (car def)))
2816 (deffile (if sfile-p (file-name-nondirectory stringfile)
2817 (cdr def)))
2818 (ans (read-file-name (if deffile (format "%s(default %s) "
2819 prompt deffile)
2820 prompt)
2821 defdir
2822 (concat defdir deffile)
2823 mustmatch-p)))
2824 (list (expand-file-name (substitute-in-file-name ans)))))
2826 ;; I am somewhat divided on this string-default feature. It seems
2827 ;; to violate the principle-of-least-astonishment, in that it makes
2828 ;; the default harder to predict, so you actually have to look and see
2829 ;; what the default really is before choosing it. This can trip you up.
2830 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2831 ;; on this.
2832 ;; -Olin
2834 \f
2835 ;; Simple process query facility.
2836 ;; ===========================================================================
2837 ;; This function is for commands that want to send a query to the process
2838 ;; and show the response to the user. For example, a command to get the
2839 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2840 ;; to an inferior Common Lisp process.
2841 ;;
2842 ;; This simple facility just sends strings to the inferior process and pops
2843 ;; up a window for the process buffer so you can see what the process
2844 ;; responds with. We don't do anything fancy like try to intercept what the
2845 ;; process responds with and put it in a pop-up window or on the message
2846 ;; line. We just display the buffer. Low tech. Simple. Works good.
2848 (defun comint-proc-query (proc str)
2849 "Send to the inferior process PROC the string STR.
2850 Pop-up but do not select a window for the inferior process so that
2851 its response can be seen."
2852 (let* ((proc-buf (process-buffer proc))
2853 (proc-mark (process-mark proc)))
2854 (display-buffer proc-buf)
2855 (set-buffer proc-buf) ; but it's not the selected *window*
2856 (let ((proc-win (get-buffer-window proc-buf 0))
2857 (proc-pt (marker-position proc-mark)))
2858 (comint-send-string proc str) ; send the query
2859 (accept-process-output proc) ; wait for some output
2860 ;; Try to position the proc window so you can see the answer.
2861 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2862 ;; I don't know why. Wizards invited to improve it.
2863 (unless (pos-visible-in-window-p proc-pt proc-win)
2864 (let ((opoint (window-point proc-win)))
2865 (set-window-point proc-win proc-mark)
2866 (sit-for 0)
2867 (if (not (pos-visible-in-window-p opoint proc-win))
2868 (push-mark opoint)
2869 (set-window-point proc-win opoint)))))))
2871 \f
2872 ;; Filename/command/history completion in a buffer
2873 ;; ===========================================================================
2874 ;; Useful completion functions, courtesy of the Ergo group.
2876 ;; Six commands:
2877 ;; comint-dynamic-complete Complete or expand command, filename,
2878 ;; history at point.
2879 ;; comint-dynamic-complete-filename Complete filename at point.
2880 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2881 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2882 ;; replace with expanded/completed name.
2884 ;; These are not installed in the comint-mode keymap. But they are
2885 ;; available for people who want them. Shell-mode installs them:
2887 ;; (define-key shell-mode-map "\M-?"
2888 ;; 'comint-dynamic-list-filename-completions)))
2889 ;;
2890 ;; Commands like this are fine things to put in load hooks if you
2891 ;; want them present in specific modes.
2893 (defcustom comint-completion-autolist nil
2894 "If non-nil, automatically list possibilities on partial completion.
2895 This mirrors the optional behavior of tcsh."
2896 :type 'boolean
2897 :group 'comint-completion)
2899 (defcustom comint-completion-addsuffix t
2900 "If non-nil, add ` ' to file names.
2901 It can either be a string FILESUFFIX or a cons (DIRSUFFIX . FILESUFFIX)
2902 where DIRSUFFIX is ignored and FILESUFFIX is a string added on unambiguous
2903 or exact completion.
2904 This mirrors the optional behavior of tcsh."
2905 :type '(choice (const :tag "None" nil)
2906 (const :tag "Add SPC" t)
2907 (string :tag "File suffix")
2908 (cons :tag "Obsolete suffix pair"
2909 (string :tag "Ignored")
2910 (string :tag "File suffix")))
2911 :group 'comint-completion)
2913 (defcustom comint-completion-recexact nil
2914 "If non-nil, use shortest completion if characters cannot be added.
2915 This mirrors the optional behavior of tcsh.
2917 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2918 :type 'boolean
2919 :group 'comint-completion)
2921 (defcustom comint-completion-fignore nil
2922 "List of suffixes to be disregarded during file completion.
2923 This mirrors the optional behavior of bash and tcsh.
2925 Note that this applies to `comint-dynamic-complete-filename' only."
2926 :type '(repeat (string :tag "Suffix"))
2927 :group 'comint-completion)
2929 ;;;###autoload
2930 (defvar comint-file-name-prefix (purecopy "")
2931 "Prefix prepended to absolute file names taken from process input.
2932 This is used by Comint's and shell's completion functions, and by shell's
2933 directory tracking functions.")
2935 (defvar comint-file-name-chars
2936 (if (memq system-type '(ms-dos windows-nt cygwin))
2937 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2938 "[]~/A-Za-z0-9+@:_.$#%,={}-")
2939 "String of characters valid in a file name.
2940 Note that all non-ASCII characters are considered valid in a file name
2941 regardless of what this variable says.
2943 This is a good thing to set in mode hooks.")
2945 (defvar comint-file-name-quote-list nil
2948 This is a good thing to set in mode hooks.")
2951 (defun comint-directory (directory)
2952 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
2953 (expand-file-name (if (file-name-absolute-p directory)
2954 (concat comint-file-name-prefix directory)
2955 directory)))
2958 (defun comint-word (word-chars)
2959 "Return the word of WORD-CHARS at point, or nil if none is found.
2960 Word constituents are considered to be those in WORD-CHARS, which is like the
2962 (save-excursion
2963 (let ((here (point))
2964 giveup)
2965 (while (not giveup)
2966 (let ((startpoint (point)))
2968 ;; Fixme: This isn't consistent with Bash, at least -- not
2969 ;; all non-ASCII chars should be word constituents.
2970 (if (and (> (- (point) 2) (point-min))
2972 (forward-char -2))
2973 (if (and (> (- (point) 1) (point-min))
2974 (>= (char-after (- (point) 1)) 128))
2975 (forward-char -1))
2976 (if (= (point) startpoint)
2977 (setq giveup t))))
2978 ;; Set match-data to match the entire string.
2979 (when (< (point) here)
2980 (set-match-data (list (point) here))
2981 (match-string 0)))))
2983 (defun comint-substitute-in-file-name (filename)
2984 "Return FILENAME with environment variables substituted.
2985 Supports additional environment variable syntax of the command
2986 interpreter (e.g., the percent notation of cmd.exe on Windows)."
2987 (let ((name (substitute-in-file-name filename)))
2988 (if (memq system-type '(ms-dos windows-nt))
2989 (let (env-var-name
2990 env-var-val)
2991 (save-match-data
2993 (setq env-var-name (match-string 1 name))
2994 (setq env-var-val (or (getenv env-var-name) ""))
2995 (setq name (replace-match env-var-val t t name))))))
2996 name))
2998 (defun comint--match-partial-filename ()
2999 "Return the filename at point as-is, or nil if none is found.
3000 See `comint-word'."
3001 (comint-word comint-file-name-chars))
3003 (defun comint--unquote&expand-filename (filename)
3005 ;; gets expanded to the same as "$HOME"
3006 (comint-substitute-in-file-name
3007 (comint-unquote-filename filename)))
3009 (defun comint-match-partial-filename ()
3010 "Return the unquoted&expanded filename at point, or nil if none is found.
3011 Environment variables are substituted. See `comint-word'."
3012 (let ((filename (comint--match-partial-filename)))
3013 (and filename (comint--unquote&expand-filename filename))))
3015 (defun comint-quote-filename (filename)
3016 "Return FILENAME with magic characters quoted.
3017 Magic characters are those in `comint-file-name-quote-list'."
3018 (if (null comint-file-name-quote-list)
3019 filename
3020 (let ((regexp
3021 (format "[%s]"
3022 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
3023 (save-match-data
3024 (let ((i 0))
3025 (while (string-match regexp filename i)
3027 (setq i (1+ (match-end 0)))))
3028 filename))))
3030 (defun comint-unquote-filename (filename)
3031 "Return FILENAME with quoted characters unquoted."
3032 (if (null comint-file-name-quote-list)
3033 filename
3034 (save-match-data
3037 (defun comint-completion-at-point ()
3038 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
3040 (define-obsolete-function-alias
3041 'comint-dynamic-complete
3042 'completion-at-point "24.1")
3044 (defun comint-dynamic-complete-filename ()
3045 "Dynamically complete the filename at point.
3046 Completes if after a filename.
3047 This function is similar to `comint-replace-by-expanded-filename', except that
3048 it won't change parts of the filename already entered in the buffer; it just
3049 adds completion characters to the end of the filename. A completions listing
3050 may be shown in a separate buffer if completion is ambiguous.
3052 Completion is dependent on the value of `comint-completion-addsuffix',
3053 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
3054 completions listing is dependent on the value of `comint-completion-autolist'.
3056 Returns t if successful."
3057 (interactive)
3058 (when (comint--match-partial-filename)
3059 (unless (window-minibuffer-p (selected-window))
3060 (message "Completing file name..."))
3061 (let ((data (comint--complete-file-name-data)))
3062 (completion-in-region (nth 0 data) (nth 1 data) (nth 2 data)))))
3064 (defun comint-filename-completion ()
3065 "Return completion data for filename at point, if any."
3066 (when (comint--match-partial-filename)
3067 (comint--complete-file-name-data)))
3069 ;; FIXME: comint--common-suffix, comint--common-quoted-suffix, and
3070 ;; comint--table-subvert don't fully solve the problem, since
3071 ;; selecting a file from *Completions* won't quote it, among several
3072 ;; other problems.
3074 (defun comint--common-suffix (s1 s2)
3076 ;; Since S2 is expected to be the "unquoted/expanded" version of S1,
3077 ;; there shouldn't be any case difference, even if the completion is
3078 ;; case-insensitive.
3079 (let ((case-fold-search nil))
3081 (- (match-end 1) (match-beginning 1))))
3083 (defun comint--common-quoted-suffix (s1 s2)
3084 ;; FIXME: Copied in pcomplete.el.
3085 "Find the common suffix between S1 and S2 where S1 is the expanded S2.
3086 S1 is expected to be the unquoted and expanded version of S2.
3087 Returns (PS1 . PS2), i.e. the shortest prefixes of S1 and S2, such that
3088 S1 = (concat PS1 SS1) and S2 = (concat PS2 SS2) and
3089 SS1 = (unquote SS2)."
3090 (let* ((cs (comint--common-suffix s1 s2))
3091 (ss1 (substring s1 (- (length s1) cs)))
3092 (qss1 (comint-quote-filename ss1))
3093 qc s2b)
3094 (if (and (not (equal ss1 qss1))
3095 (setq qc (comint-quote-filename (substring ss1 0 1)))
3096 (setq s2b (- (length s2) cs (length qc) -1))
3097 (>= s2b 0) ;bug#11158.
3098 (eq t (compare-strings s2 s2b (- (length s2) cs -1)
3099 qc nil nil)))
3100 ;; The difference found is just that one char is quoted in S2
3101 ;; but not in S1, keep looking before this difference.
3102 (comint--common-quoted-suffix
3103 (substring s1 0 (- (length s1) cs))
3104 (substring s2 0 s2b))
3105 (cons (substring s1 0 (- (length s1) cs))
3106 (substring s2 0 (- (length s2) cs))))))
3108 (defun comint--table-subvert (table s1 s2 &optional quote-fun unquote-fun)
3109 "Completion table that replaces the prefix S1 with S2 in STRING.
3110 The result is a completion table which completes strings of the
3111 form (concat S1 S) in the same way as TABLE completes strings of
3112 the form (concat S2 S)."
3113 (lambda (string pred action)
3114 (let* ((str (if (eq t (compare-strings string 0 (length s1) s1 nil nil
3115 completion-ignore-case))
3116 (let ((rest (substring string (length s1))))
3117 (concat s2 (if unquote-fun
3118 (funcall unquote-fun rest) rest)))))
3119 (res (if str (complete-with-action action table str pred))))
3120 (when res
3121 (cond
3122 ((and (eq (car-safe action) 'boundaries))
3123 (let ((beg (or (and (eq (car-safe res) 'boundaries) (cadr res)) 0)))
3124 (list* 'boundaries
3125 (max (length s1)
3126 ;; FIXME: Adjust because of quoting/unquoting.
3127 (+ beg (- (length s1) (length s2))))
3128 (and (eq (car-safe res) 'boundaries) (cddr res)))))
3129 ((stringp res)
3130 (if (eq t (compare-strings res 0 (length s2) s2 nil nil
3131 completion-ignore-case))
3132 (let ((rest (substring res (length s2))))
3133 (concat s1 (if quote-fun (funcall quote-fun rest) rest)))))
3134 ((eq action t)
3135 (let ((bounds (completion-boundaries str table pred "")))
3136 (if (>= (car bounds) (length s2))
3137 (if quote-fun (mapcar quote-fun res) res)
3139 (regexp-quote (substring s2 (car bounds))))))
3140 (delq nil
3141 (mapcar (lambda (c)
3142 (if (string-match re c)
3143 (let ((str (substring c (match-end 0))))
3144 (if quote-fun
3145 (funcall quote-fun str) str))))
3146 res))))))
3147 ;; E.g. action=nil and it's the only completion.
3148 (res))))))
3150 (defun comint-completion-file-name-table (string pred action)
3151 (if (not (file-name-absolute-p string))
3152 (completion-file-name-table string pred action)
3153 (cond
3154 ((memq action '(t lambda))
3155 (completion-file-name-table
3156 (concat comint-file-name-prefix string) pred action))
3157 ((null action)
3158 (let ((res (completion-file-name-table
3159 (concat comint-file-name-prefix string) pred action)))
3160 (if (and (stringp res)
3161 (string-match
3163 res))
3164 (substring res (match-end 0))
3165 res)))
3166 (t (completion-file-name-table string pred action)))))
3168 (defun comint--complete-file-name-data ()
3169 "Return the completion data for file name at point."
3170 (let* ((filesuffix (cond ((not comint-completion-addsuffix) "")
3171 ((stringp comint-completion-addsuffix)
3172 comint-completion-addsuffix)
3173 ((not (consp comint-completion-addsuffix)) " ")
3174 (t (cdr comint-completion-addsuffix))))
3175 (filename (comint--match-partial-filename))
3176 (filename-beg (if filename (match-beginning 0) (point)))
3177 (filename-end (if filename (match-end 0) (point)))
3178 (unquoted (if filename (comint--unquote&expand-filename filename) ""))
3179 (table
3180 (let ((prefixes (comint--common-quoted-suffix
3181 unquoted filename)))
3182 (comint--table-subvert
3183 #'comint-completion-file-name-table
3184 (cdr prefixes) (car prefixes)
3185 #'comint-quote-filename #'comint-unquote-filename))))
3186 (nconc
3187 (list
3188 filename-beg filename-end
3189 (lambda (string pred action)
3190 (let ((completion-ignore-case read-file-name-completion-ignore-case)
3191 (completion-ignored-extensions comint-completion-fignore))
3192 (complete-with-action action table string pred))))
3193 (unless (zerop (length filesuffix))
3194 (list :exit-function
3195 (lambda (_s finished)
3196 (when (memq finished '(sole finished))
3197 (if (looking-at (regexp-quote filesuffix))
3198 (goto-char (match-end 0))
3199 (insert filesuffix)))))))))
3201 (defun comint-dynamic-complete-as-filename ()
3202 "Dynamically complete at point as a filename.
3203 See `comint-dynamic-complete-filename'. Returns t if successful."
3204 (let ((data (comint--complete-file-name-data)))
3205 (completion-in-region (nth 0 data) (nth 1 data) (nth 2 data))))
3206 (make-obsolete 'comint-dynamic-complete-as-filename
3207 'comint-filename-completion "24.1")
3209 (defun comint-replace-by-expanded-filename ()
3210 "Dynamically expand and complete the filename at point.
3211 Replace the filename with an expanded, canonicalized and
3212 completed replacement, i.e. substituting environment
3213 variables (e.g. $HOME), `~'s, `..', and `.', and making the
3214 filename absolute. For expansion see `expand-file-name' and
3215 `substitute-in-file-name'. For completion see
3216 `comint-dynamic-complete-filename'."
3217 (interactive)
3218 (let ((filename (comint-match-partial-filename)))
3219 (when filename
3220 (replace-match (expand-file-name filename) t t)
3221 (comint-dynamic-complete-filename))))
3224 (defun comint-dynamic-simple-complete (stub candidates)
3225 "Dynamically complete STUB from CANDIDATES list.
3226 This function inserts completion characters at point by
3227 completing STUB from the strings in CANDIDATES. If completion is
3228 ambiguous, possibly show a completions listing in a separate
3229 buffer.
3231 Return nil if no completion was inserted.
3232 Return `sole' if completed with the only completion match.
3233 Return `shortest' if completed with the shortest match.
3234 Return `partial' if completed as far as possible.
3235 Return `listed' if a completion listing was shown.
3237 See also `comint-dynamic-complete-filename'."
3238 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
3239 (minibuffer-p (window-minibuffer-p (selected-window)))
3240 (suffix (cond ((not comint-completion-addsuffix) "")
3241 ((not (consp comint-completion-addsuffix)) " ")
3242 (t (cdr comint-completion-addsuffix))))
3243 (completions (all-completions stub candidates)))
3244 (cond ((null completions)
3245 (if minibuffer-p
3246 (minibuffer-message "No completions of %s" stub)
3247 (message "No completions of %s" stub))
3248 nil)
3249 ((= 1 (length completions)) ; Gotcha!
3250 (let ((completion (car completions)))
3251 (if (string-equal completion stub)
3252 (unless minibuffer-p
3253 (message "Sole completion"))
3254 (insert (substring completion (length stub)))
3255 (unless minibuffer-p
3256 (message "Completed")))
3257 (insert suffix)
3258 'sole))
3259 (t ; There's no unique completion.
3260 (let ((completion (try-completion stub candidates)))
3261 ;; Insert the longest substring.
3262 (insert (substring completion (length stub)))
3263 (cond ((and comint-completion-recexact comint-completion-addsuffix
3264 (string-equal stub completion)
3265 (member completion completions))
3266 ;; It's not unique, but user wants shortest match.
3267 (insert suffix)
3268 (unless minibuffer-p
3269 (message "Completed shortest"))
3270 'shortest)
3271 ((or comint-completion-autolist
3272 (string-equal stub completion))
3273 ;; It's not unique, list possible completions.
3274 (comint-dynamic-list-completions completions stub)
3275 'listed)
3276 (t
3277 (unless minibuffer-p
3278 (message "Partially completed"))
3279 'partial)))))))
3280 (make-obsolete 'comint-dynamic-simple-complete 'completion-in-region "24.1")
3283 (defun comint-dynamic-list-filename-completions ()
3284 "Display a list of possible completions for the filename at point."
3285 (interactive)
3286 (let* ((data (comint--complete-file-name-data))
3287 (minibuffer-completion-table (nth 2 data))
3288 (minibuffer-completion-predicate nil)
3289 (ol (make-overlay (nth 0 data) (nth 1 data) nil nil t)))
3290 (overlay-put ol 'field 'completion)
3291 (unwind-protect
3292 (call-interactively 'minibuffer-completion-help)
3293 (delete-overlay ol))))
3296 ;; This is bound locally in a *Completions* buffer to the list of
3297 ;; completions displayed, and is used to detect the case where the same
3298 ;; command is repeatedly used without the set of completions changing.
3299 (defvar comint-displayed-dynamic-completions nil)
3301 (defvar comint-dynamic-list-completions-config nil)
3303 (defun comint-dynamic-list-completions (completions &optional common-substring)
3304 "Display a list of sorted COMPLETIONS.
3305 The meaning of COMMON-SUBSTRING is the same as in `display-completion-list'.
3306 Typing SPC flushes the completions buffer."
3307 (let ((window (get-buffer-window "*Completions*" 0)))
3308 (setq completions (sort completions 'string-lessp))
3309 (if (and (eq last-command this-command)
3310 window (window-live-p window) (window-buffer window)
3311 (buffer-name (window-buffer window))
3312 ;; The above tests are not sufficient to detect the case where we
3313 ;; should scroll, because the top-level interactive command may
3314 ;; not have displayed a completions window the last time it was
3315 ;; invoked, and there may be such a window left over from a
3316 ;; previous completion command with a different set of
3317 ;; completions. To detect that case, we also test that the set
3318 ;; of displayed completions is in fact the same as the previously
3319 ;; displayed set.
3320 (equal completions
3321 (buffer-local-value 'comint-displayed-dynamic-completions
3322 (window-buffer window))))
3323 ;; If this command was repeated, and
3324 ;; there's a fresh completion window with a live buffer,
3325 ;; and this command is repeated, scroll that window.
3326 (with-current-buffer (window-buffer window)
3327 (if (pos-visible-in-window-p (point-max) window)
3328 (set-window-start window (point-min))
3329 (save-selected-window
3330 (select-window window)
3331 (scroll-up))))
3333 ;; Display a completion list for the first time.
3334 (setq comint-dynamic-list-completions-config
3335 (current-window-configuration))
3336 (with-output-to-temp-buffer "*Completions*"
3337 (display-completion-list completions common-substring))
3338 (if (window-minibuffer-p (selected-window))
3339 (minibuffer-message "Type space to flush; repeat completion command to scroll")
3340 (message "Type space to flush; repeat completion command to scroll")))
3342 ;; Read the next key, to process SPC.
3343 (let (key first)
3344 (if (with-current-buffer (get-buffer "*Completions*")
3345 (set (make-local-variable 'comint-displayed-dynamic-completions)
3346 completions)
3347 (setq key (read-key-sequence nil)
3348 first (aref key 0))
3349 (and (consp first) (consp (event-start first))
3350 (eq (window-buffer (posn-window (event-start first)))
3351 (get-buffer "*Completions*"))
3352 (eq (key-binding key) 'mouse-choose-completion)))
3353 ;; If the user does mouse-choose-completion with the mouse,
3354 ;; execute the command, then delete the completion window.
3355 (progn
3356 (choose-completion first)
3357 (set-window-configuration comint-dynamic-list-completions-config))
3358 (if (eq first ?\s)
3359 (set-window-configuration comint-dynamic-list-completions-config)
3360 (setq unread-command-events (listify-key-sequence key)))))))
3361 \f
3362 (defun comint-get-next-from-history ()
3363 "After fetching a line from input history, this fetches the following line.
3364 In other words, this recalls the input line after the line you recalled last.
3365 You can use this to repeat a sequence of input lines."
3366 (interactive)
3367 (if comint-save-input-ring-index
3368 (progn
3369 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
3370 (comint-next-input 1))
3371 (message "No previous history command")))
3373 (defun comint-accumulate ()
3374 "Accumulate a line to send as input along with more lines.
3375 This inserts a newline so that you can enter more text
3377 to send all the accumulated input, at once.
3378 The entire accumulated text becomes one item in the input history
3379 when you send it."
3380 (interactive)
3382 (set-marker comint-accum-marker (point))
3383 (if comint-input-ring-index
3384 (setq comint-save-input-ring-index
3385 (- comint-input-ring-index 1))))
3387 (defun comint-goto-process-mark ()
3388 "Move point to the process mark.
3389 The process mark separates output, and input already sent,
3390 from input that has not yet been sent."
3391 (interactive)
3392 (let ((proc (or (get-buffer-process (current-buffer))
3393 (error "Current buffer has no process"))))
3394 (goto-char (process-mark proc))
3395 (when (called-interactively-p 'interactive)
3396 (message "Point is now at the process mark"))))
3398 (defun comint-bol-or-process-mark ()
3399 "Move point to beginning of line (after prompt) or to the process mark.
3400 The first time you use this command, it moves to the beginning of the line
3401 \(but after the prompt, if any). If you repeat it again immediately,
3402 it moves point to the process mark.
3404 The process mark separates the process output, along with input already sent,
3405 from input that has not yet been sent. Ordinarily, the process mark
3406 is at the beginning of the current input line; but if you have
3408 the process mark is at the beginning of the accumulated input."
3409 (interactive)
3410 (if (not (eq last-command 'comint-bol-or-process-mark))
3411 (comint-bol nil)
3412 (comint-goto-process-mark)))
3414 (defun comint-set-process-mark ()
3415 "Set the process mark at point."
3416 (interactive)
3417 (let ((proc (or (get-buffer-process (current-buffer))
3418 (error "Current buffer has no process"))))
3419 (set-marker (process-mark proc) (point))
3420 (message "Process mark set")))
3422 \f
3423 ;; Author: Peter Breton <pbreton@cs.umb.edu>
3425 ;; This little add-on for comint is intended to make it easy to get
3426 ;; output from currently active comint buffers into another buffer,
3427 ;; or buffers, and then go back to using the comint shell.
3428 ;;
3429 ;; My particular use is SQL interpreters; I want to be able to execute a
3430 ;; query using the process associated with a comint-buffer, and save that
3431 ;; somewhere else. Because the process might have state (for example, it
3432 ;; could be in an uncommitted transaction), just running starting a new
3433 ;; process and having it execute the query and then finish, would not
3434 ;; work. I'm sure there are other uses as well, although in many cases
3435 ;; starting a new process is the simpler, and thus preferable, approach.
3436 ;;
3437 ;; The basic implementation is as follows: comint-redirect changes the
3438 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
3439 ;; its own filter. The filter puts the output into the designated buffer,
3440 ;; or buffers, until it sees a regexp that tells it to stop (by default,
3441 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
3442 ;; sees the stop regexp, it restores the old filter functions, and runs
3443 ;; `comint-redirect-hook'.
3444 ;;
3445 ;; Each comint buffer may only use one redirection at a time, but any number
3446 ;; of different comint buffers may be simultaneously redirected.
3447 ;;
3448 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
3449 ;; correct prompt for your interpreter, or that you supply a regexp that says
3450 ;; when the redirection is finished. Otherwise, redirection will continue
3451 ;; indefinitely. The code now does a sanity check to ensure that it can find
3452 ;; a prompt in the comint buffer; however, it is still important to ensure that
3453 ;; this prompt is set correctly.
3454 ;;
3455 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
3456 ;; perhaps it should prompt for a terminating string (with an
3457 ;; appropriate magic default by examining what we think is the prompt)?
3458 ;;
3459 ;; Fixme: look for appropriate fields, rather than regexp, if
3460 ;; `comint-use-prompt-regexp' is true.
3462 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3463 ;; Variables
3464 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3466 (defcustom comint-redirect-verbose nil
3467 "If non-nil, print messages each time the redirection filter is invoked.
3468 Also print a message when redirection is completed."
3469 :group 'comint
3470 :type 'boolean)
3472 ;; Directly analogous to comint-preoutput-filter-functions
3473 (defvar comint-redirect-filter-functions nil
3474 "List of functions to call before inserting redirected process output.
3475 Each function gets one argument, a string containing the text received
3476 from the subprocess. It should return the string to insert, perhaps
3477 the same string that was received, or perhaps a modified or transformed
3478 string.
3480 The functions on the list are called sequentially, and each one is given
3481 the string returned by the previous one. The string returned by the
3482 last function is the text that is actually inserted in the redirection buffer.
3484 You can use `add-hook' to add functions to this list
3485 either globally or locally.")
3487 ;; Internal variables
3489 (defvar comint-redirect-output-buffer nil
3490 "The buffer or list of buffers to put output into.")
3492 (defvar comint-redirect-finished-regexp nil
3493 "Regular expression that determines when to stop redirection in Comint.
3494 When the redirection filter function is given output that matches this regexp,
3495 the output is inserted as usual, and redirection is completed.")
3497 (defvar comint-redirect-insert-matching-regexp nil
3498 "If non-nil, the text that ends a redirection is included in it.
3499 More precisely, the text that matches `comint-redirect-finished-regexp'
3500 and therefore terminates an output redirection is inserted in the
3501 redirection target buffer, along with the preceding output.")
3503 (defvar comint-redirect-echo-input nil
3504 "Non-nil means echo input in the process buffer even during redirection.")
3506 (defvar comint-redirect-completed nil
3507 "Non-nil if redirection has completed in the current buffer.")
3509 (defvar comint-redirect-original-mode-line-process nil
3510 "Original mode line for redirected process.")
3512 (defvar comint-redirect-perform-sanity-check t
3513 "If non-nil, check that redirection is likely to complete successfully.
3514 More precisely, before starting a redirection, verify that the
3515 regular expression `comint-redirect-finished-regexp' that controls
3516 when to terminate it actually matches some text already in the process
3517 buffer. The idea is that this regular expression should match a prompt
3518 string, and that there ought to be at least one copy of your prompt string
3519 in the process buffer already.")
3521 (defvar comint-redirect-original-filter-function nil
3522 "The process filter that was in place when redirection is started.
3523 When redirection is completed, the process filter is restored to
3524 this value.")
3526 (defvar comint-redirect-subvert-readonly nil
3527 "Non-nil means `comint-redirect' can insert into read-only buffers.
3528 This works by binding `inhibit-read-only' around the insertion.
3529 This is useful, for instance, for insertion into Help mode buffers.
3530 You probably want to set it locally to the output buffer.")
3532 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3533 ;; Functions
3534 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3536 (defun comint-redirect-setup (output-buffer
3537 comint-buffer
3538 finished-regexp
3539 &optional echo-input)
3540 "Set up for output redirection.
3541 This function sets local variables that are used by `comint-redirect-filter'
3542 to perform redirection.
3544 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3545 in the output matches FINISHED-REGEXP.
3547 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3548 original Comint buffer.
3550 This function is called by `comint-redirect-send-command-to-process',
3551 and does not normally need to be invoked by the end user or programmer."
3552 (with-current-buffer comint-buffer
3554 (make-local-variable 'comint-redirect-original-mode-line-process)
3555 (setq comint-redirect-original-mode-line-process mode-line-process)
3557 (make-local-variable 'comint-redirect-output-buffer)
3558 (setq comint-redirect-output-buffer output-buffer)
3560 (make-local-variable 'comint-redirect-finished-regexp)
3561 (setq comint-redirect-finished-regexp finished-regexp)
3563 (make-local-variable 'comint-redirect-echo-input)
3564 (setq comint-redirect-echo-input echo-input)
3566 (make-local-variable 'comint-redirect-completed)
3567 (setq comint-redirect-completed nil)
3569 (setq mode-line-process
3570 (if mode-line-process
3571 (list (concat (elt mode-line-process 0) " Redirection"))
3572 (list ":%s Redirection")))))
3574 (defun comint-redirect-cleanup ()
3575 "End a Comint redirection. See `comint-redirect-send-command'."
3576 (interactive)
3577 ;; Restore the process filter
3578 (set-process-filter (get-buffer-process (current-buffer))
3579 comint-redirect-original-filter-function)
3580 ;; Restore the mode line
3581 (setq mode-line-process comint-redirect-original-mode-line-process)
3582 ;; Set the completed flag
3583 (setq comint-redirect-completed t))
3585 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3586 ;; that it really occurs.
3587 (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
3589 (defun comint-redirect-filter (process input-string)
3590 "Filter function which redirects output from PROCESS to a buffer or buffers.
3591 The variable `comint-redirect-output-buffer' says which buffer(s) to
3592 place output in.
3594 INPUT-STRING is the input from the Comint process.
3596 This function runs as a process filter, and does not need to be invoked by the
3597 end user."
3598 (and process
3599 (with-current-buffer (process-buffer process)
3600 (comint-redirect-preoutput-filter input-string)
3601 ;; If we have to echo output, give it to the original filter function
3602 (and comint-redirect-echo-input
3603 comint-redirect-original-filter-function
3604 (funcall comint-redirect-original-filter-function
3605 process input-string)))))
3608 (defun comint-redirect-preoutput-filter (input-string)
3609 "Comint filter function which redirects Comint output to a buffer or buffers.
3610 The variable `comint-redirect-output-buffer' says which buffer(s) to
3611 place output in.
3613 INPUT-STRING is the input from the Comint process.
3615 This function does not need to be invoked by the end user."
3616 (let ((output-buffer-list
3617 (if (listp comint-redirect-output-buffer)
3618 comint-redirect-output-buffer
3619 (list comint-redirect-output-buffer)))
3620 (filtered-input-string input-string))
3622 ;; If there are any filter functions, give them a chance to modify
3623 ;; the string.
3624 (let ((functions comint-redirect-filter-functions))
3625 (while (and functions filtered-input-string)
3626 (if (eq (car functions) t)
3627 ;; If a local value says "use the default value too",
3628 ;; do that.
3629 (let ((functions
3630 (default-value 'comint-redirect-filter-functions)))
3631 (while (and functions filtered-input-string)
3632 (setq filtered-input-string
3633 (funcall (car functions) filtered-input-string))
3634 (setq functions (cdr functions))))
3635 (setq filtered-input-string
3636 (funcall (car functions) filtered-input-string)))
3637 (setq functions (cdr functions))))
3639 ;; Clobber `comint-redirect-finished-regexp'
3640 (or comint-redirect-insert-matching-regexp
3641 (and (string-match comint-redirect-finished-regexp filtered-input-string)
3642 (setq filtered-input-string
3643 (replace-match "" nil nil filtered-input-string))))
3645 ;; Send output to all registered buffers
3646 (save-excursion
3647 (dolist (buf output-buffer-list)
3648 ;; Set this buffer to the output buffer
3649 (set-buffer (get-buffer-create buf))
3650 ;; Go to the end of the buffer
3651 (goto-char (point-max))
3652 ;; Insert the output
3653 (let ((inhibit-read-only comint-redirect-subvert-readonly))
3654 (insert filtered-input-string))))
3656 ;; Message
3657 (and comint-redirect-verbose
3658 (message "Redirected output to buffer(s) %s"
3659 (mapconcat 'identity output-buffer-list " ")))
3661 ;; If we see the prompt, tidy up
3662 ;; We'll look for the prompt in the original string, so nobody can
3663 ;; clobber it
3664 (and (string-match comint-redirect-finished-regexp input-string)
3665 (progn
3666 (and comint-redirect-verbose
3667 (message "Redirection completed"))
3668 (comint-redirect-cleanup)
3669 (run-hooks 'comint-redirect-hook)))
3670 ;; Echo input?
3671 (if comint-redirect-echo-input
3672 filtered-input-string
3673 "")))
3675 ;;;###autoload
3676 (defun comint-redirect-send-command (command output-buffer echo &optional no-display)
3677 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3678 With prefix arg ECHO, echo output in process buffer.
3680 If NO-DISPLAY is non-nil, do not show the output buffer."
3682 (let ((process (get-buffer-process (current-buffer))))
3683 (if process
3684 (comint-redirect-send-command-to-process
3685 command output-buffer (current-buffer) echo no-display)
3686 (error "No process for current buffer"))))
3688 ;;;###autoload
3689 (defun comint-redirect-send-command-to-process
3690 (command output-buffer process echo &optional no-display)
3691 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3692 With prefix arg, echo output in process buffer.
3694 If NO-DISPLAY is non-nil, do not show the output buffer."
3696 (let* (;; The process buffer
3697 (process-buffer (if (processp process)
3698 (process-buffer process)
3699 process))
3700 (proc (get-buffer-process process-buffer)))
3701 ;; Change to the process buffer
3702 (with-current-buffer process-buffer
3704 ;; Make sure there's a prompt in the current process buffer
3705 (and comint-redirect-perform-sanity-check
3706 (save-excursion
3707 (goto-char (point-max))
3708 (or (re-search-backward comint-prompt-regexp nil t)
3709 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3711 ;; Set up for redirection
3712 (comint-redirect-setup
3713 output-buffer
3714 (current-buffer) ; Comint Buffer
3715 comint-prompt-regexp ; Finished Regexp
3716 echo) ; Echo input
3718 ;; Set the filter
3719 (setq comint-redirect-original-filter-function ; Save the old filter
3720 (process-filter proc))
3721 (set-process-filter proc 'comint-redirect-filter)
3723 ;; Send the command
3726 ;; Show the output
3727 (or no-display
3728 (display-buffer
3729 (get-buffer-create
3730 (if (listp output-buffer)
3731 (car output-buffer)
3732 output-buffer)))))))
3734 ;;;###autoload
3735 (defun comint-redirect-results-list (command regexp regexp-group)
3736 "Send COMMAND to current process.
3737 Return a list of expressions in the output which match REGEXP.
3738 REGEXP-GROUP is the regular expression group in REGEXP to use."
3739 (comint-redirect-results-list-from-process
3740 (get-buffer-process (current-buffer))
3741 command regexp regexp-group))
3743 ;;;###autoload
3744 (defun comint-redirect-results-list-from-process (process command regexp regexp-group)
3745 "Send COMMAND to PROCESS.
3746 Return a list of expressions in the output which match REGEXP.
3747 REGEXP-GROUP is the regular expression group in REGEXP to use."
3748 (let ((output-buffer " *Comint Redirect Work Buffer*")
3749 results)
3750 (with-current-buffer (get-buffer-create output-buffer)
3751 (erase-buffer)
3752 (comint-redirect-send-command-to-process command
3753 output-buffer process nil t)
3754 ;; Wait for the process to complete
3755 (set-buffer (process-buffer process))
3756 (while (null comint-redirect-completed)
3757 (accept-process-output nil 1))
3758 ;; Collect the output
3759 (set-buffer output-buffer)
3760 (goto-char (point-min))
3761 ;; Skip past the command, if it was echoed
3762 (and (looking-at command)
3763 (forward-line))
3764 (while (re-search-forward regexp nil t)
3765 (push (buffer-substring-no-properties
3766 (match-beginning regexp-group)
3767 (match-end regexp-group))
3768 results))
3769 results)))
3771 (dolist (x '("^Not at command line$"
3772 "^Empty input ring$"
3773 "^No history$"
3774 "^Not found$" ; Too common?
3775 "^Current buffer has no process$"))
3776 (add-to-list 'debug-ignored-errors x))
3778 \f
3779 ;; Converting process modes to use comint mode
3780 ;; ===========================================================================
3781 ;; The code in the Emacs 19 distribution has all been modified to use comint
3782 ;; where needed. However, there are `third-party' packages out there that
3783 ;; still use the old shell mode. Here's a guide to conversion.
3784 ;;
3785 ;; Renaming variables
3786 ;; Most of the work is renaming variables and functions. These are the common
3787 ;; ones:
3788 ;; Local variables:
3789 ;; last-input-start comint-last-input-start
3790 ;; last-input-end comint-last-input-end
3791 ;; shell-prompt-pattern comint-prompt-regexp
3792 ;; shell-set-directory-error-hook <no equivalent>
3793 ;; Miscellaneous:
3794 ;; shell-set-directory <unnecessary>
3795 ;; shell-mode-map comint-mode-map
3796 ;; Commands:
3797 ;; shell-send-input comint-send-input
3798 ;; shell-send-eof comint-delchar-or-maybe-eof
3799 ;; kill-shell-input comint-kill-input
3800 ;; interrupt-shell-subjob comint-interrupt-subjob
3801 ;; stop-shell-subjob comint-stop-subjob
3802 ;; quit-shell-subjob comint-quit-subjob
3803 ;; kill-shell-subjob comint-kill-subjob
3804 ;; kill-output-from-shell comint-delete-output
3805 ;; show-output-from-shell comint-show-output
3806 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3807 ;;
3808 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3809 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3810 ;; Comint mode does not provide functionality equivalent to
3811 ;; shell-set-directory-error-hook; it is gone.
3812 ;;
3813 ;; comint-last-input-start is provided for modes which want to munge
3814 ;; the buffer after input is sent, perhaps because the inferior
3815 ;; insists on echoing the input. The LAST-INPUT-START variable in
3816 ;; the old shell package was used to implement a history mechanism,
3817 ;; but you should think twice before using comint-last-input-start
3818 ;; for this; the input history ring often does the job better.
3819 ;;
3820 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3821 ;; *not* create the comint-mode local variables in your foo-mode function.
3822 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3823 ;; necessary comint-specific local variables. Then create the
3824 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3825 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3826 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3827 ;; get-old-input) that need to be different from the defaults. Call
3828 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3829 ;; comint-mode will take care of it. The following example, from shell.el,
3830 ;; is typical:
3831 ;;
3832 ;; (defvar shell-mode-map '())
3833 ;; (cond ((not shell-mode-map)
3834 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3835 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3836 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3838 ;; (define-key shell-mode-map "\M-?"
3839 ;; 'comint-dynamic-list-filename-completions)))
3840 ;;
3841 ;; (defun shell-mode ()
3842 ;; (interactive)
3843 ;; (comint-mode)
3844 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3845 ;; (setq major-mode 'shell-mode)
3846 ;; (setq mode-name "Shell")
3847 ;; (use-local-map shell-mode-map)
3848 ;; (make-local-variable 'shell-directory-stack)
3849 ;; (setq shell-directory-stack nil)
3850 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3851 ;; (run-mode-hooks 'shell-mode-hook))
3852 ;;
3853 ;;
3854 ;; Completion for comint-mode users
3855 ;;
3856 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3857 ;; hook to add completion functions to. Functions on this list should return
3858 ;; the completion data according to the documentation of
3859 ;; `completion-at-point-functions'
3860 \f
3862 (provide 'comint)
3864 ;;; comint.el ends here