| blob | 0eee4128a2bae4e67e5d6a8786c19222fa0d2760 |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 1990, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
4 ;; 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
5 ;; 2010 Free Software Foundation, Inc.
7 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
8 ;; Simon Marshall <simon@gnu.org>
9 ;; Maintainer: FSF
10 ;; Keywords: processes
11 ;; Package: emacs
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation, either version 3 of the License, or
18 ;; (at your option) any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;;; Commentary:
30 ;; This file defines a general command-interpreter-in-a-buffer package
31 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
32 ;; modes on top of comint mode -- e.g., Lisp, shell, scheme, T, soar, ....
33 ;; This way, all these specific packages share a common base functionality,
34 ;; and a common set of bindings, which makes them easier to use (and
35 ;; saves code, implementation time, etc., etc.).
37 ;; Several packages are already defined using comint mode:
38 ;; - shell.el defines a shell-in-a-buffer mode.
39 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
40 ;;
41 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
42 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
43 ;; - The file soar.el tunes Lisp and inferior-lisp modes for Soar.
44 ;; - cmutex.el defines TeX and LaTeX modes that invoke TeX, LaTeX, BibTeX,
45 ;; previewers, and printers from within Emacs.
46 ;; - background.el allows csh-like job control inside Emacs.
47 ;; It is pretty easy to make new derived modes for other processes.
49 ;; For documentation on the functionality provided by Comint mode, and
50 ;; the hooks available for customising it, see the comments below.
51 ;; For further information on the standard derived modes (shell,
52 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
54 ;; For hints on converting existing process modes (e.g., tex-mode,
55 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
56 ;; instead of shell-mode, see the notes at the end of this file.
58 \f
59 ;; Brief Command Documentation:
60 ;;============================================================================
61 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
62 ;; mode)
63 ;;
64 ;; M-p comint-previous-input Cycle backwards in input history
65 ;; M-n comint-next-input Cycle forwards
66 ;; M-r comint-history-isearch-backward-regexp Isearch input regexp backward
67 ;; M-C-l comint-show-output Show last batch of process output
68 ;; RET comint-send-input
69 ;; C-d comint-delchar-or-maybe-eof Delete char unless at end of buff
70 ;; C-c C-a comint-bol-or-process-mark First time, move point to bol;
71 ;; second time, move to process-mark.
72 ;; C-c C-u comint-kill-input ^u
73 ;; C-c C-w backward-kill-word ^w
74 ;; C-c C-c comint-interrupt-subjob ^c
75 ;; C-c C-z comint-stop-subjob ^z
76 ;; C-c C-\ comint-quit-subjob ^\
77 ;; C-c C-o comint-delete-output Delete last batch of process output
78 ;; C-c C-r comint-show-output Show last batch of process output
79 ;; C-c C-l comint-dynamic-list-input-ring List input history
80 ;;
81 ;; Not bound by default in comint-mode (some are in shell mode)
82 ;; comint-run Run a program under comint-mode
83 ;; send-invisible Read a line w/o echo, and send to proc
84 ;; comint-dynamic-complete-filename Complete filename at point.
85 ;; comint-dynamic-list-filename-completions List completions in help buffer.
86 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
87 ;; replace with expanded/completed name.
88 ;; comint-replace-by-expanded-history Expand history at point;
89 ;; replace with expanded name.
90 ;; comint-magic-space Expand history and add (a) space(s).
91 ;; comint-kill-subjob No mercy.
92 ;; comint-show-maximum-output Show as much output as possible.
93 ;; comint-continue-subjob Send CONT signal to buffer's process
94 ;; group. Useful if you accidentally
95 ;; suspend your process (with C-c C-z).
96 ;; comint-get-next-from-history Fetch successive input history lines
97 ;; comint-accumulate Combine lines to send them together
98 ;; as input.
99 ;; comint-goto-process-mark Move point to where process-mark is.
100 ;; comint-set-process-mark Set process-mark to point.
102 ;; comint-mode-hook is the Comint mode hook. Basically for your keybindings.
104 ;;; 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."
233 "Face to use to highlight prompts."
237 "If non-nil, don't add input matching the last on the input ring.
238 This mirrors the optional behavior of bash.
240 This variable is buffer-local."
245 "If non-nil, name of the file to read/write input history.
246 See also `comint-read-input-ring' and `comint-write-input-ring'.
248 This variable is buffer-local, and is a good thing to set in mode hooks."
250 file)
254 "Controls whether input to interpreter causes window to scroll.
255 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
256 If `this', scroll only the selected window.
258 The default is nil.
260 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
268 "Controls whether interpreter output moves point to the end of the output.
269 If nil, then output never moves point to the output.
270 (If the output occurs at point, it is inserted before point.)
271 If t or `all', move point in all windows showing the buffer.
272 If `this', move point only the selected window.
273 If `others', move point only in other windows, not in the selected window.
275 The default is nil.
277 See the variable `comint-scroll-show-maximum-output' and the function
278 `comint-postoutput-scroll-to-bottom'.
279 This variable is buffer-local in all Comint buffers."
290 "Controls how to scroll due to interpreter output.
291 This variable applies when point is at the end of the buffer
292 \(either because it was originally there, or because
293 `comint-move-point-for-output' said to move it there)
294 and output from the subprocess is inserted.
296 Non-nil means scroll so that the window is full of text
297 and point is on the last line. A value of nil
298 means don't do anything special--scroll normally.
300 See also the variable `comint-move-point-for-output' and the function
301 `comint-postoutput-scroll-to-bottom'.
302 This variable is buffer-local in all Comint buffers."
307 "The maximum size in lines for Comint buffers.
308 Comint buffers are truncated from the top to be no greater than this number, if
309 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
314 "Size of the input history ring in `comint-mode'."
326 "If non-nil, assume that the subprocess echoes any input.
327 If so, delete one copy of the input so that only one copy eventually
328 appears in the buffer.
330 This variable is buffer-local."
334 ;; AIX puts the name of the person being su'd to in front of the prompt.
335 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
336 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
337 ;; ssh-add prints a prompt like `Enter passphrase: '.
338 ;; plink prints a prompt like `Passphrase for key "root@GNU.ORG": '.
339 ;; Ubuntu's sudo prompts like `[sudo] password for user:'
340 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
341 ;; Something called "perforce" uses "Enter password:".
342 ;; See M-x comint-testsuite--test-comint-password-prompt-regexp.
356 "Regexp matching prompts for passwords in the inferior process.
357 This is used by `comint-watch-for-password-prompt'."
362 ;; Here are the per-interpreter hooks.
364 "Function that returns old text in Comint mode.
365 This function is called when return is typed while the point is in old
366 text. It returns the text to be submitted as process input. The
367 default is `comint-get-old-input-default', which either grabs the
368 current input field or grabs the current line and strips off leading
369 text matching `comint-prompt-regexp', depending on the value of
374 "List of functions called to perform completion.
375 Functions should return non-nil if completion was performed.
376 See also `comint-dynamic-complete'.
382 "Predicate for filtering additions to input history.
383 Takes one argument, the input. If non-nil, the input may be saved on the input
387 "Abnormal hook run before input is sent to the process.
390 ;;;###autoload
391 (defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom comint-watch-for-password-prompt)
392 "Functions to call after output is inserted into the buffer.
393 One possible function is `comint-postoutput-scroll-to-bottom'.
394 These functions get one argument, a string containing the text as originally
395 inserted. Note that this might not be the same as the buffer contents between
396 `comint-last-output-start' and the buffer's `process-mark', if other filter
397 functions have already modified the buffer.
399 See also `comint-preoutput-filter-functions'.
401 You can use `add-hook' to add functions to this list
408 "Function to actually send to PROCESS the STRING submitted by user.
409 Usually this is just `comint-simple-send', but if your mode needs to
410 massage the input string, put a different function here.
411 `comint-simple-send' just sends the string plus a newline.
412 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
416 "Non-nil means go to the end of the line before sending input.
417 See `comint-send-input'."
424 ;; Note: If it is decided to purge comint-prompt-regexp from the source
425 ;; entirely, searching for uses of this variable will help to identify
426 ;; places that need attention.
428 "If non-nil, use `comint-prompt-regexp' to recognize prompts.
429 If nil, then program output and user-input are given different `field'
430 properties, which Emacs commands can use to distinguish them (in
431 particular, common movement commands such as `beginning-of-line'
432 respect field boundaries in a natural way)."
437 "Hook run upon entry to `comint-mode'.
438 This is run before the process is cranked up."
443 "Hook run each time a process is exec'd by `comint-exec'.
444 This is called after the process is cranked up. It is useful for things that
445 must be done each time a process is executed in a Comint mode buffer (e.g.,
446 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
447 executed once when the buffer is created."
453 ;; Keys:
464 ;; The following two are standardly aliased to C-d,
465 ;; but they should never do EOF, just delete.
467 (define-key map [kp-delete] 'delete-char)
468 (define-key map "\C-c " 'comint-accumulate)
469 (define-key map "\C-c\C-x" 'comint-get-next-from-history)
470 (define-key map "\C-c\C-a" 'comint-bol-or-process-mark)
471 (define-key map "\C-c\C-u" 'comint-kill-input)
472 (define-key map "\C-c\C-w" 'backward-kill-word)
473 (define-key map "\C-c\C-c" 'comint-interrupt-subjob)
474 (define-key map "\C-c\C-z" 'comint-stop-subjob)
476 (define-key map "\C-c\C-m" 'comint-copy-old-input)
477 (define-key map "\C-c\C-o" 'comint-delete-output)
478 (define-key map "\C-c\C-r" 'comint-show-output)
479 (define-key map "\C-c\C-e" 'comint-show-maximum-output)
480 (define-key map "\C-c\C-l" 'comint-dynamic-list-input-ring)
481 (define-key map "\C-c\C-n" 'comint-next-prompt)
482 (define-key map "\C-c\C-p" 'comint-previous-prompt)
483 (define-key map "\C-c\C-d" 'comint-send-eof)
484 (define-key map "\C-c\C-s" 'comint-write-output)
485 (define-key map "\C-c." 'comint-insert-previous-argument)
486 ;; Mouse Buttons:
487 (define-key map [mouse-2] 'comint-insert-input)
488 ;; Menu bars:
489 ;; completion:
490 (define-key map [menu-bar completion]
491 (cons "Complete" (make-sparse-keymap "Complete")))
492 (define-key map [menu-bar completion complete-expand]
493 '("Expand File Name" . comint-replace-by-expanded-filename))
494 (define-key map [menu-bar completion complete-listing]
495 '("File Completion Listing" . comint-dynamic-list-filename-completions))
496 (define-key map [menu-bar completion complete-file]
497 '("Complete File Name" . comint-dynamic-complete-filename))
498 (define-key map [menu-bar completion complete]
499 '("Complete Before Point" . comint-dynamic-complete))
500 ;; Input history:
501 (define-key map [menu-bar inout]
502 (cons "In/Out" (make-sparse-keymap "In/Out")))
503 (define-key map [menu-bar inout delete-output]
504 '("Delete Current Output Group" . comint-delete-output))
505 (define-key map [menu-bar inout append-output-to-file]
506 '("Append Current Output Group to File" . comint-append-output-to-file))
507 (define-key map [menu-bar inout write-output]
508 '("Write Current Output Group to File" . comint-write-output))
509 (define-key map [menu-bar inout next-prompt]
510 '("Forward Output Group" . comint-next-prompt))
511 (define-key map [menu-bar inout previous-prompt]
512 '("Backward Output Group" . comint-previous-prompt))
513 (define-key map [menu-bar inout show-maximum-output]
514 '("Show Maximum Output" . comint-show-maximum-output))
515 (define-key map [menu-bar inout show-output]
516 '("Show Current Output Group" . comint-show-output))
517 (define-key map [menu-bar inout kill-input]
518 '("Kill Current Input" . comint-kill-input))
519 (define-key map [menu-bar inout copy-input]
520 '("Copy Old Input" . comint-copy-old-input))
521 (define-key map [menu-bar inout history-isearch-backward-regexp]
522 '("Isearch Input Regexp Backward..." . comint-history-isearch-backward-regexp))
523 (define-key map [menu-bar inout history-isearch-backward]
524 '("Isearch Input String Backward..." . comint-history-isearch-backward))
525 (define-key map [menu-bar inout forward-matching-history]
526 '("Forward Matching Input..." . comint-forward-matching-input))
527 (define-key map [menu-bar inout backward-matching-history]
528 '("Backward Matching Input..." . comint-backward-matching-input))
529 (define-key map [menu-bar inout next-matching-history]
530 '("Next Matching Input..." . comint-next-matching-input))
531 (define-key map [menu-bar inout previous-matching-history]
532 '("Previous Matching Input..." . comint-previous-matching-input))
533 (define-key map [menu-bar inout next-matching-history-from-input]
534 '("Next Matching Current Input" . comint-next-matching-input-from-input))
535 (define-key map [menu-bar inout previous-matching-history-from-input]
536 '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
537 (define-key map [menu-bar inout next-history]
538 '("Next Input" . comint-next-input))
539 (define-key map [menu-bar inout previous-history]
540 '("Previous Input" . comint-previous-input))
541 (define-key map [menu-bar inout list-history]
542 '("List Input History" . comint-dynamic-list-input-ring))
543 (define-key map [menu-bar inout expand-history]
544 '("Expand History Before Point" . comint-replace-by-expanded-history))
545 ;; Signals
546 (let ((signals-map (make-sparse-keymap "Signals")))
547 (define-key map [menu-bar signals] (cons "Signals" signals-map))
548 (define-key signals-map [eof] '("EOF" . comint-send-eof))
549 (define-key signals-map [kill] '("KILL" . comint-kill-subjob))
550 (define-key signals-map [quit] '("QUIT" . comint-quit-subjob))
551 (define-key signals-map [cont] '("CONT" . comint-continue-subjob))
552 (define-key signals-map [stop] '("STOP" . comint-stop-subjob))
553 (define-key signals-map [break] '("BREAK" . comint-interrupt-subjob)))
554 ;; Put them in the menu bar:
555 (setq menu-bar-final-items (append '(completion inout signals)
556 menu-bar-final-items))
557 map))
559 ;; Fixme: Is this still relevant?
560 (defvar comint-ptyp t
561 "Non-nil if communications via pty; false if by pipe. Buffer local.
562 This is to work around a bug in Emacs process signaling.")
564 (defvar comint-input-ring nil)
565 (defvar comint-last-input-start nil)
566 (defvar comint-last-input-end nil)
567 (defvar comint-last-output-start nil)
568 (defvar comint-input-ring-index nil
569 "Index of last matched history element.")
570 (defvar comint-matching-input-from-input-string ""
571 "Input previously used to match input history.")
572 (defvar comint-save-input-ring-index nil
573 "Last input ring index which you copied.
576 (defvar comint-accum-marker nil
577 "Non-nil if you are accumulating input lines to send as input together.
580 (defvar comint-stored-incomplete-input nil
581 "Stored input for history cycling.")
583 (put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
584 (put 'comint-input-ring 'permanent-local t)
585 (put 'comint-input-ring-index 'permanent-local t)
586 (put 'comint-save-input-ring-index 'permanent-local t)
587 (put 'comint-input-autoexpand 'permanent-local t)
588 (put 'comint-input-filter-functions 'permanent-local t)
589 (put 'comint-output-filter-functions 'permanent-local t)
590 (put 'comint-preoutput-filter-functions 'permanent-local t)
591 (put 'comint-scroll-to-bottom-on-input 'permanent-local t)
592 (put 'comint-move-point-for-output 'permanent-local t)
593 (put 'comint-scroll-show-maximum-output 'permanent-local t)
594 (put 'comint-ptyp 'permanent-local t)
596 (put 'comint-mode 'mode-class 'special)
598 (define-derived-mode comint-mode fundamental-mode "Comint"
599 "Major mode for interacting with an inferior interpreter.
600 Interpreter name is same as buffer name, sans the asterisks.
601 Return at end of buffer sends line as input.
602 Return not at end copies rest of line to end and sends it.
603 Setting variable `comint-eol-on-send' means jump to the end of the line
604 before submitting new input.
606 This mode is customized to create major modes such as Inferior Lisp
607 mode, Shell mode, etc. This can be done by setting the hooks
608 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
609 and `comint-get-old-input' to appropriate functions, and the variable
610 `comint-prompt-regexp' to the appropriate regular expression.
612 An input history is maintained of size `comint-input-ring-size', and
613 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
614 Input ring history expansion can be achieved with the commands
616 Input ring expansion is controlled by the variable `comint-input-autoexpand',
617 and addition is controlled by the variable `comint-input-ignoredups'.
619 Commands with no default key bindings include `send-invisible',
620 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
621 `comint-magic-space'.
623 Input to, and output from, the subprocess can cause the window to scroll to
624 the end of the buffer. See variables `comint-output-filter-functions',
625 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
626 and `comint-move-point-for-output'.
629 to continue it.
633 Entry to this mode runs the hooks on `comint-mode-hook'."
634 (setq mode-line-process '(":%s"))
635 (set (make-local-variable 'window-point-insertion-type) t)
636 (set (make-local-variable 'comint-last-input-start) (point-min-marker))
637 (set (make-local-variable 'comint-last-input-end) (point-min-marker))
638 (set (make-local-variable 'comint-last-output-start) (make-marker))
639 (make-local-variable 'comint-last-prompt-overlay)
640 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
641 (make-local-variable 'comint-input-ring-size) ; ...to global val.
642 (make-local-variable 'comint-input-ring)
643 (make-local-variable 'comint-input-ring-file-name)
644 (or (and (boundp 'comint-input-ring) comint-input-ring)
645 (setq comint-input-ring (make-ring comint-input-ring-size)))
646 (make-local-variable 'comint-input-ring-index)
647 (make-local-variable 'comint-save-input-ring-index)
648 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
649 (setq comint-input-ring-index nil))
650 (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
651 (setq comint-save-input-ring-index nil))
652 (make-local-variable 'comint-matching-input-from-input-string)
653 (make-local-variable 'comint-input-autoexpand)
654 (make-local-variable 'comint-input-ignoredups)
655 (make-local-variable 'comint-delimiter-argument-list)
656 (make-local-variable 'comint-completion-fignore)
657 (make-local-variable 'comint-get-old-input)
658 (make-local-variable 'comint-input-filter)
659 (make-local-variable 'comint-input-sender)
660 (make-local-variable 'comint-eol-on-send)
661 (make-local-variable 'comint-scroll-to-bottom-on-input)
662 (make-local-variable 'comint-move-point-for-output)
663 (make-local-variable 'comint-scroll-show-maximum-output)
664 (make-local-variable 'comint-stored-incomplete-input)
665 ;; Following disabled because it seems to break the case when
666 ;; comint-scroll-show-maximum-output is nil, and no-one can remember
667 ;; what the original problem was. If there are problems with point
668 ;; not going to the end, consider re-enabling this.
669 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00827.html
670 ;;
671 ;; This makes it really work to keep point at the bottom.
672 ;; (make-local-variable 'scroll-conservatively)
673 ;; (setq scroll-conservatively 10000)
674 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
675 (make-local-variable 'comint-ptyp)
676 (make-local-variable 'comint-process-echoes)
677 (make-local-variable 'comint-file-name-chars)
678 (make-local-variable 'comint-file-name-quote-list)
679 ;; dir tracking on remote files
680 (set (make-local-variable 'comint-file-name-prefix)
681 (or (file-remote-p default-directory) ""))
682 (make-local-variable 'comint-accum-marker)
683 (setq comint-accum-marker (make-marker))
684 (make-local-variable 'font-lock-defaults)
685 (setq font-lock-defaults '(nil t))
686 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
687 (add-hook 'isearch-mode-hook 'comint-history-isearch-setup 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 PROGRAM should be either a string denoting an executable program to create
703 via `start-file-process', or a cons pair of the form (HOST . SERVICE) denoting
704 a TCP connection to be opened via `open-network-stream'. If there is already
705 a running process in that buffer, it is not restarted. Optional fourth arg
706 STARTFILE is the name of a file, whose contents are sent to the
707 process as its initial input.
709 If PROGRAM is a string, any more args are arguments to PROGRAM.
711 Returns the (possibly newly created) process buffer."
712 (or (fboundp 'start-file-process)
713 (error "Multi-processing is not supported for this system"))
714 (setq buffer (get-buffer-create (or buffer (concat "*" name "*"))))
715 ;; If no process, or nuked process, crank up a new one and put buffer in
716 ;; comint mode. Otherwise, leave buffer and existing process alone.
717 (unless (comint-check-proc buffer)
718 (with-current-buffer buffer
719 (unless (derived-mode-p 'comint-mode)
720 (comint-mode))) ; Install local vars, mode, keymap, ...
721 (comint-exec buffer name program startfile switches))
722 buffer)
724 ;;;###autoload
725 (defun make-comint (name program &optional startfile &rest switches)
726 "Make a Comint process NAME in a buffer, running PROGRAM.
727 The name of the buffer is made by surrounding NAME with `*'s.
728 PROGRAM should be either a string denoting an executable program to create
729 via `start-file-process', or a cons pair of the form (HOST . SERVICE) denoting
730 a TCP connection to be opened via `open-network-stream'. If there is already
731 a running process in that buffer, it is not restarted. Optional third arg
732 STARTFILE is the name of a file, whose contents are sent to the
733 process as its initial input.
735 If PROGRAM is a string, any more args are arguments to PROGRAM.
737 Returns the (possibly newly created) process buffer."
738 (apply #'make-comint-in-buffer name nil program startfile switches))
740 ;;;###autoload
741 (defun comint-run (program)
742 "Run PROGRAM in a Comint buffer and switch to it.
743 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
744 The file name is used to make a symbol name, such as `comint-sh-hook', and any
745 hooks on this symbol are run in the buffer.
746 See `make-comint' and `comint-exec'."
747 (interactive "sRun program: ")
748 (let ((name (file-name-nondirectory program)))
749 (switch-to-buffer (make-comint name program))
750 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
752 (defun comint-exec (buffer name command startfile switches)
753 "Start up a process named NAME in buffer BUFFER for Comint modes.
754 Runs the given COMMAND with SWITCHES, and initial input from STARTFILE.
755 Blasts any old process running in the buffer. Doesn't set the buffer mode.
756 You can use this to cheaply run a series of processes in the same Comint
757 buffer. The hook `comint-exec-hook' is run after each exec."
758 (with-current-buffer buffer
759 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
760 (if proc (delete-process proc)))
761 ;; Crank up a new process
762 (let ((proc
763 (if (consp command)
764 (open-network-stream name buffer (car command) (cdr command))
765 (comint-exec-1 name buffer command switches))))
766 (set-process-filter proc 'comint-output-filter)
767 (make-local-variable 'comint-ptyp)
768 (setq comint-ptyp process-connection-type) ; t if pty, nil if pipe.
769 ;; Jump to the end, and set the process mark.
770 (goto-char (point-max))
771 (set-marker (process-mark proc) (point))
772 ;; Feed it the startfile.
773 (cond (startfile
774 ;;This is guaranteed to wait long enough
775 ;;but has bad results if the comint does not prompt at all
776 ;; (while (= size (buffer-size))
777 ;; (sleep-for 1))
778 ;;I hope 1 second is enough!
779 (sleep-for 1)
780 (goto-char (point-max))
781 (insert-file-contents startfile)
782 (setq startfile (buffer-substring (point) (point-max)))
783 (delete-region (point) (point-max))
784 (comint-send-string proc startfile)))
785 (run-hooks 'comint-exec-hook)
786 buffer)))
788 ;; This auxiliary function cranks up the process for comint-exec in
789 ;; the appropriate environment.
791 (defun comint-exec-1 (name buffer command switches)
792 (let ((process-environment
793 (nconc
794 ;; If using termcap, we specify `emacs' as the terminal type
795 ;; because that lets us specify a width.
796 ;; If using terminfo, we specify `dumb' because that is
797 ;; a defined terminal type. `emacs' is not a defined terminal type
798 ;; and there is no way for us to define it here.
799 ;; Some programs that use terminfo get very confused
800 ;; if TERM is not a valid terminal type.
801 ;; ;; There is similar code in compile.el.
802 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
803 (list "TERM=dumb" "TERMCAP="
804 (format "COLUMNS=%d" (window-width)))
805 (list "TERM=emacs"
806 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
807 (unless (getenv "EMACS")
808 (list "EMACS=t"))
809 (list (format "INSIDE_EMACS=%s,comint" emacs-version))
810 process-environment))
811 (default-directory
812 (if (file-accessible-directory-p default-directory)
813 default-directory
814 "/"))
815 proc decoding encoding changed)
816 (let ((exec-path (if (and command (file-name-directory command))
817 ;; If the command has slashes, make sure we
818 ;; first look relative to the current directory.
819 (cons default-directory exec-path) exec-path)))
820 (setq proc (apply 'start-file-process name buffer command switches)))
821 ;; Some file name handler cannot start a process, fe ange-ftp.
822 (unless (processp proc) (error "No process started"))
823 (let ((coding-systems (process-coding-system proc)))
824 (setq decoding (car coding-systems)
825 encoding (cdr coding-systems)))
826 ;; Even if start-file-process left the coding system for encoding data
827 ;; sent from the process undecided, we had better use the same one
828 ;; as what we use for decoding. But, we should suppress EOL
829 ;; conversion.
830 (if (and decoding (not encoding))
831 (setq encoding (coding-system-change-eol-conversion decoding 'unix)
832 changed t))
833 (if changed
834 (set-process-coding-system proc decoding encoding))
835 proc))
837 (defun comint-insert-input (event)
838 "In a Comint buffer, set the current input to the previous input at point.
839 If there is no previous input at point, run the command specified
840 by the global keymap (usually `mouse-yank-at-click')."
841 (interactive "e")
842 ;; Don't set the mouse here, since it may otherwise change the behavior
843 ;; of the command on which we fallback if there's no field at point.
844 ;; (mouse-set-point event)
845 (let ((pos (posn-point (event-end event)))
846 field input)
847 (with-selected-window (posn-window (event-end event))
848 ;; If pos is at the very end of a field, the mouse-click was
849 ;; probably outside (to the right) of the field.
850 (and (< pos (field-end pos))
851 (setq field (field-at-pos pos))
852 (setq input (field-string-no-properties pos))))
853 (if (or (null comint-accum-marker)
854 (not (eq field 'input)))
855 ;; Fall back to the global definition if (i) the selected
856 ;; buffer is not a comint buffer (which can happen if a
857 ;; non-comint window was selected and we clicked in a comint
858 ;; window), or (ii) there is no input at POS.
859 (let* ((keys (this-command-keys))
860 (last-key (and (vectorp keys) (aref keys (1- (length keys)))))
861 (fun (and last-key (lookup-key global-map (vector last-key)))))
862 (and fun (not (eq fun 'comint-insert-input))
863 (call-interactively fun)))
864 (with-selected-window (posn-window (event-end event))
865 ;; Otherwise, insert the previous input.
866 (goto-char (point-max))
867 ;; First delete any old unsent input at the end
868 (delete-region
869 (or (marker-position comint-accum-marker)
870 (process-mark (get-buffer-process (current-buffer))))
871 (point))
872 ;; Insert the input at point
873 (insert input)))))
874 \f
875 ;; Input history processing in a buffer
876 ;; ===========================================================================
877 ;; Useful input history functions, courtesy of the Ergo group.
879 ;; Eleven commands:
880 ;; comint-dynamic-list-input-ring List history in help buffer.
881 ;; comint-previous-input Previous input...
882 ;; comint-previous-matching-input ...matching a string.
883 ;; comint-previous-matching-input-from-input ... matching the current input.
884 ;; comint-next-input Next input...
885 ;; comint-next-matching-input ...matching a string.
886 ;; comint-next-matching-input-from-input ... matching the current input.
887 ;; comint-backward-matching-input Backwards input...
888 ;; comint-forward-matching-input ...matching a string.
889 ;; comint-replace-by-expanded-history Expand history at point;
890 ;; replace with expanded history.
891 ;; comint-magic-space Expand history and insert space.
892 ;;
893 ;; Three functions:
894 ;; comint-read-input-ring Read into comint-input-ring...
895 ;; comint-write-input-ring Write to comint-input-ring-file-name.
896 ;; comint-replace-by-expanded-history-before-point Workhorse function.
898 (defun comint-read-input-ring (&optional silent)
899 "Set the buffer's `comint-input-ring' from a history file.
900 The name of the file is given by the variable `comint-input-ring-file-name'.
901 The history ring is of size `comint-input-ring-size', regardless of file size.
902 If `comint-input-ring-file-name' is nil this function does nothing.
904 If the optional argument SILENT is non-nil, we say nothing about a
905 failure to read the history file.
907 This function is useful for major mode commands and mode hooks.
909 The commands stored in the history file are separated by the
910 `comint-input-ring-separator', and entries that match
911 `comint-input-history-ignore' are ignored. The most recent command
912 comes last.
914 See also `comint-input-ignoredups' and `comint-write-input-ring'."
915 (cond ((or (null comint-input-ring-file-name)
916 (equal comint-input-ring-file-name ""))
917 nil)
918 ((not (file-readable-p comint-input-ring-file-name))
919 (or silent
920 (message "Cannot read history file %s"
921 comint-input-ring-file-name)))
922 (t
923 (let* ((history-buf (get-buffer-create " *temp*"))
924 (file comint-input-ring-file-name)
925 (count 0)
926 (size comint-input-ring-size)
927 (ring (make-ring size)))
928 (unwind-protect
929 (with-current-buffer history-buf
930 (widen)
931 (erase-buffer)
932 (insert-file-contents file)
933 ;; Save restriction in case file is already visited...
934 ;; Watch for those date stamps in history files!
935 (goto-char (point-max))
936 (let (start end history)
937 (while (and (< count size)
938 (re-search-backward comint-input-ring-separator
939 nil t)
940 (setq end (match-beginning 0)))
941 (setq start
942 (if (re-search-backward comint-input-ring-separator
943 nil t)
944 (match-end 0)
945 (point-min)))
946 (setq history (buffer-substring start end))
947 (goto-char start)
948 (if (and (not (string-match comint-input-history-ignore
949 history))
950 (or (null comint-input-ignoredups)
951 (ring-empty-p ring)
952 (not (string-equal (ring-ref ring 0)
953 history))))
954 (progn
955 (ring-insert-at-beginning ring history)
956 (setq count (1+ count)))))))
957 (kill-buffer history-buf))
958 (setq comint-input-ring ring
959 comint-input-ring-index nil)))))
961 (defun comint-write-input-ring ()
962 "Writes the buffer's `comint-input-ring' to a history file.
963 The name of the file is given by the variable `comint-input-ring-file-name'.
964 The original contents of the file are lost if `comint-input-ring' is not empty.
965 If `comint-input-ring-file-name' is nil this function does nothing.
967 Useful within process sentinels.
969 See also `comint-read-input-ring'."
970 (cond ((or (null comint-input-ring-file-name)
971 (equal comint-input-ring-file-name "")
972 (null comint-input-ring) (ring-empty-p comint-input-ring))
973 nil)
974 ((not (file-writable-p comint-input-ring-file-name))
975 (message "Cannot write history file %s" comint-input-ring-file-name))
976 (t
977 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
978 (ring comint-input-ring)
979 (file comint-input-ring-file-name)
980 (index (ring-length ring)))
981 ;; Write it all out into a buffer first. Much faster, but messier,
982 ;; than writing it one line at a time.
983 (with-current-buffer history-buf
984 (erase-buffer)
985 (while (> index 0)
986 (setq index (1- index))
987 (insert (ring-ref ring index) comint-input-ring-separator))
988 (write-region (buffer-string) nil file nil 'no-message)
989 (kill-buffer nil))))))
992 (defvar comint-dynamic-list-input-ring-window-conf)
994 (defun comint-dynamic-list-input-ring-select ()
995 "Choose the input history entry that point is in or next to."
996 (interactive)
997 (let ((buffer completion-reference-buffer)
998 beg end completion)
999 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
1000 (setq end (point) beg (1+ (point))))
1001 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
1002 (setq end (1- (point)) beg (point)))
1003 (if (null beg)
1004 (error "No history entry here"))
1005 (setq beg (previous-single-property-change beg 'mouse-face))
1006 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
1007 (setq completion (buffer-substring beg end))
1008 (set-window-configuration comint-dynamic-list-input-ring-window-conf)
1009 (choose-completion-string completion buffer)))
1011 (defun comint-dynamic-list-input-ring ()
1012 "List in help buffer the buffer's input history."
1013 (interactive)
1014 (if (or (not (ring-p comint-input-ring))
1015 (ring-empty-p comint-input-ring))
1016 (message "No history")
1017 (let ((history nil)
1018 (history-buffer " *Input History*")
1019 (index (1- (ring-length comint-input-ring)))
1020 (conf (current-window-configuration)))
1021 ;; We have to build up a list ourselves from the ring vector.
1022 (dotimes (index (ring-length comint-input-ring))
1023 (push (ring-ref comint-input-ring index) history))
1024 ;; Show them most-recent-first.
1025 (setq history (nreverse history))
1026 ;; Change "completion" to "history reference"
1027 ;; to make the display accurate.
1028 (with-output-to-temp-buffer history-buffer
1029 (display-completion-list history)
1030 (set-buffer history-buffer)
1031 (let ((keymap (make-sparse-keymap)))
1032 (set-keymap-parent keymap (current-local-map))
1033 (define-key keymap "\C-m" 'comint-dynamic-list-input-ring-select)
1034 (use-local-map keymap))
1035 (forward-line 3)
1036 (while (search-backward "completion" nil 'move)
1037 (replace-match "history reference")))
1038 (sit-for 0)
1039 (message "Hit space to flush")
1040 (setq comint-dynamic-list-input-ring-window-conf conf)
1041 (let ((ch (read-event)))
1042 (if (eq ch ?\s)
1043 (set-window-configuration conf)
1044 (setq unread-command-events (list ch)))))))
1047 (defun comint-regexp-arg (prompt)
1048 "Return list of regexp and prefix arg using PROMPT."
1049 (let* (;; Don't clobber this.
1050 (last-command last-command)
1051 (regexp (read-from-minibuffer prompt nil nil nil
1052 'minibuffer-history-search-history)))
1053 ;; If the user didn't enter anything, nothing is added to m-h-s-h.
1054 ;; Use the previous search regexp, if there is one.
1055 (list (if (string-equal regexp "")
1056 (or (car minibuffer-history-search-history)
1057 regexp)
1058 regexp)
1059 (prefix-numeric-value current-prefix-arg))))
1061 (defun comint-search-arg (arg)
1062 ;; First make sure there is a ring and that we are after the process mark
1063 (cond ((not (comint-after-pmark-p))
1064 (error "Not at command line"))
1065 ((or (null comint-input-ring)
1066 (ring-empty-p comint-input-ring))
1067 (error "Empty input ring"))
1068 ((zerop arg)
1069 ;; arg of zero resets search from beginning, and uses arg of 1
1070 (setq comint-input-ring-index nil)
1071 1)
1072 (t
1073 arg)))
1075 (defun comint-restore-input ()
1076 "Restore unfinished input."
1077 (interactive)
1078 (when comint-input-ring-index
1079 (comint-delete-input)
1080 (when (> (length comint-stored-incomplete-input) 0)
1081 (insert comint-stored-incomplete-input)
1082 (message "Input restored"))
1083 (setq comint-input-ring-index nil)))
1085 (defun comint-search-start (arg)
1086 "Index to start a directional search, starting at `comint-input-ring-index'."
1087 (if comint-input-ring-index
1088 ;; If a search is running, offset by 1 in direction of arg
1089 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
1090 (ring-length comint-input-ring))
1091 ;; For a new search, start from beginning or end, as appropriate
1092 (if (>= arg 0)
1093 0 ; First elt for forward search
1094 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
1096 (defun comint-previous-input-string (arg)
1097 "Return the string ARG places along the input ring.
1098 Moves relative to `comint-input-ring-index'."
1099 (ring-ref comint-input-ring (if comint-input-ring-index
1100 (mod (+ arg comint-input-ring-index)
1101 (ring-length comint-input-ring))
1102 arg)))
1104 (defun comint-previous-input (arg)
1105 "Cycle backwards through input history, saving input."
1106 (interactive "*p")
1107 (if (and comint-input-ring-index
1108 (or ;; leaving the "end" of the ring
1109 (and (< arg 0) ; going down
1110 (eq comint-input-ring-index 0))
1111 (and (> arg 0) ; going up
1112 (eq comint-input-ring-index
1113 (1- (ring-length comint-input-ring)))))
1114 comint-stored-incomplete-input)
1115 (comint-restore-input)
1116 (comint-previous-matching-input "." arg)))
1118 (defun comint-next-input (arg)
1119 "Cycle forwards through input history."
1120 (interactive "*p")
1121 (comint-previous-input (- arg)))
1123 (defun comint-previous-matching-input-string (regexp arg)
1124 "Return the string matching REGEXP ARG places along the input ring.
1125 Moves relative to `comint-input-ring-index'."
1126 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
1127 (if pos (ring-ref comint-input-ring pos))))
1129 (defun comint-previous-matching-input-string-position (regexp arg &optional start)
1130 "Return the index matching REGEXP ARG places along the input ring.
1131 Moves relative to START, or `comint-input-ring-index'."
1132 (if (or (not (ring-p comint-input-ring))
1133 (ring-empty-p comint-input-ring))
1134 (error "No history"))
1135 (let* ((len (ring-length comint-input-ring))
1136 (motion (if (> arg 0) 1 -1))
1137 (n (mod (- (or start (comint-search-start arg)) motion) len))
1138 (tried-each-ring-item nil)
1139 (prev nil))
1140 ;; Do the whole search as many times as the argument says.
1141 (while (and (/= arg 0) (not tried-each-ring-item))
1142 ;; Step once.
1143 (setq prev n
1144 n (mod (+ n motion) len))
1145 ;; If we haven't reached a match, step some more.
1146 (while (and (< n len) (not tried-each-ring-item)
1147 (not (string-match regexp (ring-ref comint-input-ring n))))
1148 (setq n (mod (+ n motion) len)
1149 ;; If we have gone all the way around in this search.
1150 tried-each-ring-item (= n prev)))
1151 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1152 ;; Now that we know which ring element to use, if we found it, return that.
1153 (if (string-match regexp (ring-ref comint-input-ring n))
1154 n)))
1156 (defun comint-delete-input ()
1157 "Delete all input between accumulation or process mark and point."
1158 (delete-region
1159 ;; Can't use kill-region as it sets this-command
1160 (or (marker-position comint-accum-marker)
1161 (process-mark (get-buffer-process (current-buffer))))
1162 (point-max)))
1164 (defun comint-previous-matching-input (regexp n)
1165 "Search backwards through input history for match for REGEXP.
1166 \(Previous history elements are earlier commands.)
1167 With prefix argument N, search for Nth previous match.
1168 If N is negative, find the next or Nth next match."
1169 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1170 (setq n (comint-search-arg n))
1171 (let ((pos (comint-previous-matching-input-string-position regexp n)))
1172 ;; Has a match been found?
1173 (if (null pos)
1174 (error "Not found")
1175 ;; If leaving the edit line, save partial input
1176 (if (null comint-input-ring-index) ;not yet on ring
1177 (setq comint-stored-incomplete-input
1178 (funcall comint-get-old-input)))
1179 (setq comint-input-ring-index pos)
1180 (message "History item: %d" (1+ pos))
1181 (comint-delete-input)
1182 (insert (ring-ref comint-input-ring pos)))))
1184 (defun comint-next-matching-input (regexp n)
1185 "Search forwards through input history for match for REGEXP.
1186 \(Later history elements are more recent commands.)
1187 With prefix argument N, search for Nth following match.
1188 If N is negative, find the previous or Nth previous match."
1189 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1190 (comint-previous-matching-input regexp (- n)))
1192 (defun comint-previous-matching-input-from-input (n)
1193 "Search backwards through input history for match for current input.
1194 \(Previous history elements are earlier commands.)
1195 With prefix argument N, search for Nth previous match.
1196 If N is negative, search forwards for the -Nth following match."
1197 (interactive "p")
1198 (if (not (memq last-command '(comint-previous-matching-input-from-input
1199 comint-next-matching-input-from-input)))
1200 ;; Starting a new search
1201 (setq comint-matching-input-from-input-string
1202 (buffer-substring
1203 (or (marker-position comint-accum-marker)
1204 (process-mark (get-buffer-process (current-buffer))))
1205 (point))
1206 comint-input-ring-index nil))
1207 (comint-previous-matching-input
1208 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1209 n))
1211 (defun comint-next-matching-input-from-input (n)
1212 "Search forwards through input history for match for current input.
1213 \(Following history elements are more recent commands.)
1214 With prefix argument N, search for Nth following match.
1215 If N is negative, search backwards for the -Nth previous match."
1216 (interactive "p")
1217 (comint-previous-matching-input-from-input (- n)))
1220 (defun comint-replace-by-expanded-history (&optional silent start)
1221 "Expand input command history references before point.
1222 Expansion is dependent on the value of `comint-input-autoexpand'.
1224 This function depends on the buffer's idea of the input history, which may not
1225 match the command interpreter's idea, assuming it has one.
1227 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1228 cannot know the interpreter's idea of input line numbers, assuming it has one,
1229 it cannot expand absolute input line number references.
1231 If the optional argument SILENT is non-nil, never complain
1232 even if history reference seems erroneous.
1234 If the optional argument START is non-nil, that specifies the
1235 start of the text to scan for history references, rather
1236 than the logical beginning of line.
1238 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1240 Returns t if successful."
1241 (interactive)
1242 (if (and comint-input-autoexpand
1243 (if comint-use-prompt-regexp
1244 ;; Use comint-prompt-regexp
1245 (save-excursion
1246 (beginning-of-line)
1248 ;; Use input fields. User input that hasn't been entered
1249 ;; yet, at the end of the buffer, has a nil `field' property.
1250 (and (null (get-char-property (point) 'field))
1252 ;; Looks like there might be history references in the command.
1253 (let ((previous-modified-tick (buffer-modified-tick)))
1254 (comint-replace-by-expanded-history-before-point silent start)
1255 (/= previous-modified-tick (buffer-modified-tick)))))
1258 (defun comint-replace-by-expanded-history-before-point (silent &optional start)
1259 "Expand directory stack reference before point.
1260 See `comint-replace-by-expanded-history'. Returns t if successful.
1262 If the optional argument START is non-nil, that specifies the
1263 start of the text to scan for history references, rather
1264 than the logical beginning of line."
1265 (save-excursion
1266 (let ((toend (- (line-end-position) (point)))
1267 (start (or start (comint-line-beginning-position))))
1268 (goto-char start)
1269 (while (progn
1270 (skip-chars-forward "^!^" (- (line-end-position) toend))
1271 (< (point) (- (line-end-position) toend)))
1272 ;; This seems a bit complex. We look for references such as !!, !-num,
1273 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1274 ;; If that wasn't enough, the plings can be suffixed with argument
1275 ;; range specifiers.
1276 ;; Argument ranges are complex too, so we hive off the input line,
1277 ;; referenced with plings, with the range string to `comint-args'.
1278 (setq comint-input-ring-index nil)
1280 (comint-within-quotes start (point)))
1281 ;; The history is quoted, or we're in quotes.
1282 (goto-char (1+ (point))))
1284 ;; We cannot know the interpreter's idea of input line numbers.
1285 (goto-char (match-end 0))
1286 (message "Absolute reference cannot be expanded"))
1288 ;; Just a number of args from `number' lines backward.
1289 (let ((number (1- (string-to-number
1290 (buffer-substring (match-beginning 1)
1291 (match-end 1))))))
1292 (if (<= number (ring-length comint-input-ring))
1293 (progn
1294 (replace-match
1295 (comint-args (comint-previous-input-string number)
1296 (match-beginning 2) (match-end 2))
1297 t t)
1298 (setq comint-input-ring-index number)
1299 (message "History item: %d" (1+ number)))
1300 (goto-char (match-end 0))
1301 (message "Relative reference exceeds input history size"))))
1303 ;; Just a number of args from the previous input line.
1304 (replace-match (comint-previous-input-string 0) t t)
1305 (message "History item: previous"))
1306 ((looking-at
1308 ;; Most recent input starting with or containing (possibly
1309 ;; protected) string, maybe just a number of args. Phew.
1310 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1311 (mb2 (match-beginning 2)) (me2 (match-end 2))
1312 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1314 (pos (save-match-data
1315 (comint-previous-matching-input-string-position
1316 (concat pref (regexp-quote exp)) 1))))
1317 (if (null pos)
1318 (progn
1319 (goto-char (match-end 0))
1320 (or silent
1321 (progn (message "Not found")
1322 (ding))))
1323 (setq comint-input-ring-index pos)
1324 (replace-match
1325 (comint-args (ring-ref comint-input-ring pos)
1326 (match-beginning 4) (match-end 4))
1327 t t)
1328 (message "History item: %d" (1+ pos)))))
1330 ;; Quick substitution on the previous input line.
1331 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1332 (new (buffer-substring (match-beginning 2) (match-end 2)))
1333 (pos nil))
1334 (replace-match (comint-previous-input-string 0) t t)
1335 (setq pos (point))
1336 (goto-char (match-beginning 0))
1337 (if (not (search-forward old pos t))
1338 (or silent
1339 (error "Not found"))
1340 (replace-match new t t)
1341 (message "History item: substituted"))))
1342 (t
1343 (forward-char 1)))))))
1346 (defun comint-magic-space (arg)
1347 "Expand input history references before point and insert ARG spaces.
1348 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1349 (interactive "p")
1350 (comint-replace-by-expanded-history)
1351 (self-insert-command arg))
1352 \f
1353 ;; Isearch in comint input history
1355 (defcustom comint-history-isearch nil
1356 "Non-nil to Isearch in input history only, not in comint buffer output.
1357 If t, usual Isearch keys like `C-r' and `C-M-r' in comint mode search
1358 in the input history.
1359 If `dwim', Isearch keys search in the input history only when initial
1360 point position is at the comint command line. When starting Isearch
1361 from other parts of the comint buffer, they search in the comint buffer.
1362 If nil, Isearch operates on the whole comint buffer."
1363 :type '(choice (const :tag "Don't search in input history" nil)
1364 (const :tag "When point is on command line initially, search history" dwim)
1365 (const :tag "Always search in input history" t))
1366 :group 'comint
1367 :version "23.2")
1369 (defun comint-history-isearch-backward ()
1370 "Search for a string backward in input history using Isearch."
1371 (interactive)
1372 (let ((comint-history-isearch t))
1373 (isearch-backward)))
1375 (defun comint-history-isearch-backward-regexp ()
1376 "Search for a regular expression backward in input history using Isearch."
1377 (interactive)
1378 (let ((comint-history-isearch t))
1379 (isearch-backward-regexp)))
1381 (defvar comint-history-isearch-message-overlay nil)
1382 (make-variable-buffer-local 'comint-history-isearch-message-overlay)
1384 (defun comint-history-isearch-setup ()
1385 "Set up a comint for using Isearch to search the input history.
1386 Intended to be added to `isearch-mode-hook' in `comint-mode'."
1387 (when (or (eq comint-history-isearch t)
1388 (and (eq comint-history-isearch 'dwim)
1389 ;; Point is at command line.
1390 (comint-after-pmark-p)))
1391 (setq isearch-message-prefix-add "history ")
1392 (set (make-local-variable 'isearch-search-fun-function)
1393 'comint-history-isearch-search)
1394 (set (make-local-variable 'isearch-message-function)
1395 'comint-history-isearch-message)
1396 (set (make-local-variable 'isearch-wrap-function)
1397 'comint-history-isearch-wrap)
1398 (set (make-local-variable 'isearch-push-state-function)
1399 'comint-history-isearch-push-state)
1400 (add-hook 'isearch-mode-end-hook 'comint-history-isearch-end nil t)))
1402 (defun comint-history-isearch-end ()
1403 "Clean up the comint after terminating Isearch in comint."
1404 (if comint-history-isearch-message-overlay
1405 (delete-overlay comint-history-isearch-message-overlay))
1406 (setq isearch-message-prefix-add nil)
1407 (setq isearch-search-fun-function nil)
1408 (setq isearch-message-function nil)
1409 (setq isearch-wrap-function nil)
1410 (setq isearch-push-state-function nil)
1411 (remove-hook 'isearch-mode-end-hook 'comint-history-isearch-end t))
1413 (defun comint-goto-input (pos)
1414 "Put input history item of the absolute history position POS."
1415 ;; If leaving the edit line, save partial unfinished input.
1416 (if (null comint-input-ring-index)
1417 (setq comint-stored-incomplete-input
1418 (funcall comint-get-old-input)))
1419 (setq comint-input-ring-index pos)
1420 (comint-delete-input)
1421 (if (and pos (not (ring-empty-p comint-input-ring)))
1422 (insert (ring-ref comint-input-ring pos))
1423 ;; Restore partial unfinished input.
1424 (when (> (length comint-stored-incomplete-input) 0)
1425 (insert comint-stored-incomplete-input))))
1427 (defun comint-history-isearch-search ()
1428 "Return the proper search function, for Isearch in input history."
1429 (cond
1430 (isearch-word
1431 (if isearch-forward 'word-search-forward 'word-search-backward))
1432 (t
1433 (lambda (string bound noerror)
1434 (let ((search-fun
1435 ;; Use standard functions to search within comint text
1436 (cond
1437 (isearch-regexp
1438 (if isearch-forward 're-search-forward 're-search-backward))
1439 (t
1440 (if isearch-forward 'search-forward 'search-backward))))
1441 found)
1442 ;; Avoid lazy-highlighting matches in the comint prompt and in the
1443 ;; output when searching forward. Lazy-highlight calls this lambda
1444 ;; with the bound arg, so skip the prompt and the output.
1445 (if (and bound isearch-forward (not (comint-after-pmark-p)))
1446 (goto-char (process-mark (get-buffer-process (current-buffer)))))
1447 (or
1448 ;; 1. First try searching in the initial comint text
1449 (funcall search-fun string
1450 (if isearch-forward bound (comint-line-beginning-position))
1451 noerror)
1452 ;; 2. If the above search fails, start putting next/prev history
1453 ;; elements in the comint successively, and search the string
1454 ;; in them. Do this only when bound is nil (i.e. not while
1455 ;; lazy-highlighting search strings in the current comint text).
1456 (unless bound
1457 (condition-case nil
1458 (progn
1459 (while (not found)
1460 (cond (isearch-forward
1461 ;; Signal an error here explicitly, because
1462 ;; `comint-next-input' doesn't signal an error.
1463 (when (null comint-input-ring-index)
1464 (error "End of history; no next item"))
1465 (comint-next-input 1)
1466 (goto-char (comint-line-beginning-position)))
1467 (t
1468 ;; Signal an error here explicitly, because
1469 ;; `comint-previous-input' doesn't signal an error.
1470 (when (eq comint-input-ring-index
1471 (1- (ring-length comint-input-ring)))
1472 (error "Beginning of history; no preceding item"))
1473 (comint-previous-input 1)
1474 (goto-char (point-max))))
1475 (setq isearch-barrier (point) isearch-opoint (point))
1476 ;; After putting the next/prev history element, search
1477 ;; the string in them again, until comint-next-input
1478 ;; or comint-previous-input raises an error at the
1479 ;; beginning/end of history.
1480 (setq found (funcall search-fun string
1481 (unless isearch-forward
1482 ;; For backward search, don't search
1483 ;; in the comint prompt
1484 (comint-line-beginning-position))
1485 noerror)))
1486 ;; Return point of the new search result
1487 (point))
1488 ;; Return nil on the error "no next/preceding item"
1489 (error nil)))))))))
1491 (defun comint-history-isearch-message (&optional c-q-hack ellipsis)
1492 "Display the input history search prompt.
1493 If there are no search errors, this function displays an overlay with
1494 the Isearch prompt which replaces the original comint prompt.
1495 Otherwise, it displays the standard Isearch message returned from
1496 `isearch-message'."
1497 (if (not (and isearch-success (not isearch-error)))
1498 ;; Use standard function `isearch-message' when not in comint prompt,
1499 ;; or search fails, or has an error (like incomplete regexp).
1500 ;; This function displays isearch message in the echo area,
1501 ;; so it's possible to see what is wrong in the search string.
1502 (isearch-message c-q-hack ellipsis)
1503 ;; Otherwise, put the overlay with the standard isearch prompt over
1504 ;; the initial comint prompt.
1505 (if (overlayp comint-history-isearch-message-overlay)
1506 (move-overlay comint-history-isearch-message-overlay
1507 (save-excursion (forward-line 0) (point))
1508 (comint-line-beginning-position))
1509 (setq comint-history-isearch-message-overlay
1510 (make-overlay (save-excursion (forward-line 0) (point))
1511 (comint-line-beginning-position)))
1512 (overlay-put comint-history-isearch-message-overlay 'evaporate t))
1513 (overlay-put comint-history-isearch-message-overlay
1514 'display (isearch-message-prefix c-q-hack ellipsis))
1515 ;; And clear any previous isearch message.
1516 (message "")))
1518 (defun comint-history-isearch-wrap ()
1519 "Wrap the input history search when search fails.
1520 Move point to the first history element for a forward search,
1521 or to the last history element for a backward search."
1522 (unless isearch-word
1523 ;; When `comint-history-isearch-search' fails on reaching the
1524 ;; beginning/end of the history, wrap the search to the first/last
1525 ;; input history element.
1526 (if isearch-forward
1527 (comint-goto-input (1- (ring-length comint-input-ring)))
1528 (comint-goto-input nil))
1529 (setq isearch-success t))
1530 (goto-char (if isearch-forward (comint-line-beginning-position) (point-max))))
1532 (defun comint-history-isearch-push-state ()
1533 "Save a function restoring the state of input history search.
1534 Save `comint-input-ring-index' to the additional state parameter
1535 in the search status stack."
1536 `(lambda (cmd)
1537 (comint-history-isearch-pop-state cmd ,comint-input-ring-index)))
1539 (defun comint-history-isearch-pop-state (cmd hist-pos)
1540 "Restore the input history search state.
1541 Go to the history element by the absolute history position HIST-POS."
1542 (comint-goto-input hist-pos))
1544 \f
1545 (defun comint-within-quotes (beg end)
1546 "Return t if the number of quotes between BEG and END is odd.
1547 Quotes are single and double."
1550 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1552 (defun comint-how-many-region (regexp beg end)
1553 "Return number of matches for REGEXP from BEG to END."
1554 (let ((count 0))
1555 (save-excursion
1556 (save-match-data
1557 (goto-char beg)
1558 (while (re-search-forward regexp end t)
1559 (setq count (1+ count)))))
1560 count))
1562 (defun comint-args (string begin end)
1563 ;; From STRING, return the args depending on the range specified in the text
1564 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1565 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1566 (save-match-data
1567 (if (null begin)
1568 (comint-arguments string 0 nil)
1569 (let* ((range (buffer-substring
1570 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1571 (nth (cond ((string-match "^[*^]" range) 1)
1572 ((string-match "^-" range) 0)
1573 ((string-equal range "$") nil)
1574 (t (string-to-number range))))
1575 (mth (cond ((string-match "[-*$]$" range) nil)
1576 ((string-match "-" range)
1577 (string-to-number (substring range (match-end 0))))
1578 (t nth))))
1579 (comint-arguments string nth mth)))))
1581 (defun comint-delim-arg (arg)
1582 "Return a list of arguments from ARG.
1583 Break it up at the delimiters in `comint-delimiter-argument-list'.
1584 Returned list is backwards.
1586 Characters with non-nil values of the text property `literal' are
1587 assumed to have literal values (e.g., backslash-escaped
1588 characters), and are not considered to be delimiters."
1589 (if (null comint-delimiter-argument-list)
1590 (list arg)
1591 (let ((args nil)
1592 (pos 0)
1593 (len (length arg)))
1594 (while (< pos len)
1595 (let ((char (aref arg pos))
1596 (start pos))
1597 (if (and (memq char comint-delimiter-argument-list)
1598 ;; Ignore backslash-escaped characters.
1599 (not (get-text-property pos 'literal arg)))
1600 (while (and (< pos len) (eq (aref arg pos) char))
1601 (setq pos (1+ pos)))
1602 (while (and (< pos len)
1603 (not (and (memq (aref arg pos)
1604 comint-delimiter-argument-list)
1605 (not (get-text-property
1606 pos 'literal arg)))))
1607 (setq pos (1+ pos))))
1608 (setq args (cons (substring arg start pos) args))))
1609 args)))
1611 (defun comint-arguments (string nth mth)
1612 "Return from STRING the NTH to MTH arguments.
1613 NTH and/or MTH can be nil, which means the last argument.
1614 Returned arguments are separated by single spaces.
1615 We assume whitespace separates arguments, except within quotes
1616 and except for a space or tab that immediately follows a backslash.
1617 Also, a run of one or more of a single character
1618 in `comint-delimiter-argument-list' is a separate argument.
1619 Argument 0 is the command name."
1620 ;; The first line handles ordinary characters and backslash-sequences
1621 ;; (except with w32 msdos-like shells, where backslashes are valid).
1622 ;; The second matches "-quoted strings.
1623 ;; The third matches '-quoted strings.
1624 ;; The fourth matches `-quoted strings.
1625 ;; This seems to fit the syntax of BASH 2.0.
1626 (let* ((backslash-escape (not (and (fboundp 'w32-shell-dos-semantics)
1627 (w32-shell-dos-semantics))))
1628 (first (if backslash-escape
1631 (argpart (concat first
1635 (quote-subexpr (if backslash-escape 2 1))
1636 (args ()) (pos 0)
1637 (count 0)
1638 beg str quotes)
1639 ;; Build a list of all the args until we have as many as we want.
1640 (while (and (or (null mth) (<= count mth))
1641 (string-match argpart string pos))
1642 ;; Apply the `literal' text property to backslash-escaped
1643 ;; characters, so that `comint-delim-arg' won't break them up.
1644 (and backslash-escape
1645 (match-beginning 1)
1646 (put-text-property (match-beginning 1) (match-end 1)
1647 'literal t string))
1648 (if (and beg (= pos (match-beginning 0)))
1649 ;; It's contiguous, part of the same arg.
1650 (setq pos (match-end 0)
1651 quotes (or quotes (match-beginning quote-subexpr)))
1652 ;; It's a new separate arg.
1653 (if beg
1654 ;; Put the previous arg, if there was one, onto ARGS.
1655 (setq str (substring string beg pos)
1656 args (if quotes (cons str args)
1657 (nconc (comint-delim-arg str) args))))
1658 (setq count (length args))
1659 (setq quotes (match-beginning quote-subexpr))
1660 (setq beg (match-beginning 0))
1661 (setq pos (match-end 0))))
1662 (if beg
1663 (setq str (substring string beg pos)
1664 args (if quotes (cons str args)
1665 (nconc (comint-delim-arg str) args))))
1666 (setq count (length args))
1667 (let ((n (or nth (1- count)))
1668 (m (if mth (1- (- count mth)) 0)))
1669 (mapconcat
1670 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1671 \f
1672 ;;
1673 ;; Input processing stuff
1674 ;;
1675 (defun comint-add-to-input-history (cmd)
1676 "Add CMD to the input history.
1677 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1678 (if (and (funcall comint-input-filter cmd)
1679 (or (null comint-input-ignoredups)
1680 (not (ring-p comint-input-ring))
1681 (ring-empty-p comint-input-ring)
1682 (not (string-equal (ring-ref comint-input-ring 0)
1683 cmd))))
1684 (ring-insert comint-input-ring cmd)))
1686 (defun comint-send-input (&optional no-newline artificial)
1687 "Send input to process.
1688 After the process output mark, sends all text from the process mark to
1689 point as input to the process. Before the process output mark, calls
1690 value of variable `comint-get-old-input' to retrieve old input, copies
1691 it to the process mark, and sends it.
1693 This command also sends and inserts a final newline, unless
1694 NO-NEWLINE is non-nil.
1696 Any history reference may be expanded depending on the value of the variable
1697 `comint-input-autoexpand'. The list of function names contained in the value
1698 of `comint-input-filter-functions' is called on the input before sending it.
1699 The input is entered into the input history ring, if the value of variable
1700 `comint-input-filter' returns non-nil when called on the input.
1702 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1703 end of line before sending the input.
1705 After the input has been sent, if `comint-process-echoes' is non-nil,
1706 then `comint-send-input' waits to see if the process outputs a string
1707 matching the input, and if so, deletes that part of the output.
1708 If ARTIFICIAL is non-nil, it inhibits such deletion.
1709 Callers sending input not from the user should use ARTIFICIAL = t.
1711 The values of `comint-get-old-input', `comint-input-filter-functions', and
1712 `comint-input-filter' are chosen according to the command interpreter running
1713 in the buffer. E.g.,
1715 If the interpreter is the csh,
1716 `comint-get-old-input' is the default:
1717 If `comint-use-prompt-regexp' is nil, then
1718 either return the current input field, if point is on an input
1719 field, or the current line, if point is on an output field.
1720 If `comint-use-prompt-regexp' is non-nil, then
1721 return the current line with any initial string matching the
1722 regexp `comint-prompt-regexp' removed.
1725 `comint-input-filter' is the default: returns t if the input isn't all white
1726 space.
1728 If the Comint is Lucid Common Lisp,
1729 `comint-get-old-input' snarfs the sexp ending at point.
1730 `comint-input-filter-functions' does nothing.
1731 `comint-input-filter' returns nil if the input matches input-filter-regexp,
1732 which matches (1) all whitespace (2) :a, :c, etc.
1734 Similarly for Soar, Scheme, etc."
1735 (interactive)
1736 ;; Note that the input string does not include its terminal newline.
1737 (let ((proc (get-buffer-process (current-buffer))))
1738 (if (not proc) (error "Current buffer has no process")
1739 (widen)
1740 (let* ((pmark (process-mark proc))
1741 (intxt (if (>= (point) (marker-position pmark))
1742 (progn (if comint-eol-on-send (end-of-line))
1743 (buffer-substring pmark (point)))
1744 (let ((copy (funcall comint-get-old-input)))
1745 (goto-char pmark)
1746 (insert copy)
1747 copy)))
1748 (input (if (not (eq comint-input-autoexpand 'input))
1749 ;; Just whatever's already there
1750 intxt
1751 ;; Expand and leave it visible in buffer
1752 (comint-replace-by-expanded-history t pmark)
1753 (buffer-substring pmark (point))))
1754 (history (if (not (eq comint-input-autoexpand 'history))
1755 input
1756 ;; This is messy 'cos ultimately the original
1757 ;; functions used do insertion, rather than return
1758 ;; strings. We have to expand, then insert back.
1759 (comint-replace-by-expanded-history t pmark)
1760 (let ((copy (buffer-substring pmark (point)))
1761 (start (point)))
1762 (insert input)
1763 (delete-region pmark start)
1764 copy))))
1766 (unless no-newline
1769 (comint-add-to-input-history history)
1771 (run-hook-with-args 'comint-input-filter-functions
1772 (if no-newline input
1775 (let ((beg (marker-position pmark))
1776 (end (if no-newline (point) (1- (point))))
1777 (inhibit-modification-hooks t))
1778 (when (> end beg)
1779 (add-text-properties beg end
1780 '(front-sticky t
1781 font-lock-face comint-highlight-input))
1782 (unless comint-use-prompt-regexp
1783 ;; Give old user input a field property of `input', to
1784 ;; distinguish it from both process output and unsent
1785 ;; input. The terminating newline is put into a special
1786 ;; `boundary' field to make cursor movement between input
1787 ;; and output fields smoother.
1788 (add-text-properties
1789 beg end
1790 '(mouse-face highlight
1791 help-echo "mouse-2: insert after prompt as new input"
1792 field input))))
1793 (unless (or no-newline comint-use-prompt-regexp)
1794 ;; Cover the terminating newline
1795 (add-text-properties end (1+ end)
1796 '(rear-nonsticky t
1797 field boundary
1798 inhibit-line-move-field-capture t))))
1800 (comint-snapshot-last-prompt)
1802 (setq comint-save-input-ring-index comint-input-ring-index)
1803 (setq comint-input-ring-index nil)
1804 ;; Update the markers before we send the input
1805 ;; in case we get output amidst sending the input.
1806 (set-marker comint-last-input-start pmark)
1807 (set-marker comint-last-input-end (point))
1808 (set-marker (process-mark proc) (point))
1809 ;; clear the "accumulation" marker
1810 (set-marker comint-accum-marker nil)
1811 (let ((comint-input-sender-no-newline no-newline))
1812 (funcall comint-input-sender proc input))
1814 ;; Optionally delete echoed input (after checking it).
1815 (when (and comint-process-echoes (not artificial))
1816 (let ((echo-len (- comint-last-input-end
1817 comint-last-input-start)))
1818 ;; Wait for all input to be echoed:
1819 (while (and (accept-process-output proc)
1820 (> (+ comint-last-input-end echo-len)
1821 (point-max))
1822 (zerop
1823 (compare-buffer-substrings
1824 nil comint-last-input-start
1825 (- (point-max) echo-len)
1826 ;; Above difference is equivalent to
1827 ;; (+ comint-last-input-start
1828 ;; (- (point-max) comint-last-input-end))
1829 nil comint-last-input-end (point-max)))))
1830 (if (and
1831 (<= (+ comint-last-input-end echo-len)
1832 (point-max))
1833 (zerop
1834 (compare-buffer-substrings
1835 nil comint-last-input-start comint-last-input-end
1836 nil comint-last-input-end
1837 (+ comint-last-input-end echo-len))))
1838 ;; Certain parts of the text to be deleted may have
1839 ;; been mistaken for prompts. We have to prevent
1840 ;; problems when `comint-prompt-read-only' is non-nil.
1841 (let ((inhibit-read-only t))
1842 (delete-region comint-last-input-end
1843 (+ comint-last-input-end echo-len))
1844 (when comint-prompt-read-only
1845 (save-excursion
1846 (goto-char comint-last-input-end)
1847 (comint-update-fence)))))))
1849 ;; This used to call comint-output-filter-functions,
1850 ;; but that scrolled the buffer in undesirable ways.
1851 (run-hook-with-args 'comint-output-filter-functions "")))))
1853 (defvar comint-preoutput-filter-functions nil
1854 "List of functions to call before inserting Comint output into the buffer.
1855 Each function gets one argument, a string containing the text received
1856 from the subprocess. It should return the string to insert, perhaps
1857 the same string that was received, or perhaps a modified or transformed
1858 string.
1860 The functions on the list are called sequentially, and each one is
1861 given the string returned by the previous one. The string returned by
1862 the last function is the text that is actually inserted in the
1863 redirection buffer.
1865 You can use `add-hook' to add functions to this list
1866 either globally or locally.")
1868 (defvar comint-inhibit-carriage-motion nil
1869 "If nil, Comint will interpret `carriage control' characters in output.
1870 See `comint-carriage-motion' for details.")
1872 ;; When non-nil, this is an overlay over the last recognized prompt in
1873 ;; the buffer; it is used when highlighting the prompt.
1874 (defvar comint-last-prompt-overlay nil)
1876 (defun comint-snapshot-last-prompt ()
1877 "`snapshot' any current `comint-last-prompt-overlay'.
1878 Freeze its attributes in place, even when more input comes along
1879 and moves the prompt overlay."
1880 (when comint-last-prompt-overlay
1881 (let ((inhibit-read-only t)
1882 (inhibit-modification-hooks t))
1883 (add-text-properties (overlay-start comint-last-prompt-overlay)
1884 (overlay-end comint-last-prompt-overlay)
1885 (overlay-properties comint-last-prompt-overlay)))))
1887 (defun comint-carriage-motion (start end)
1888 "Interpret carriage control characters in the region from START to END.
1889 Translate carriage return/linefeed sequences to linefeeds.
1890 Make single carriage returns delete to the beginning of the line.
1891 Make backspaces delete the previous character."
1892 (save-excursion
1894 ;; calling save-match-data and save-restriction. But, such a
1895 ;; check is not necessary now because we don't use regexp search
1896 ;; nor save-restriction. Note that the buffer is already widen,
1897 ;; and calling narrow-to-region and widen are not that heavy.
1898 (goto-char start)
1899 (let* ((inhibit-field-text-motion t)
1900 (inhibit-read-only t)
1901 (lbeg (line-beginning-position))
1902 delete-end ch)
1903 ;; If the preceding text is marked as "must-overwrite", record
1904 ;; it in delete-end.
1905 (when (and (> start (point-min))
1906 (get-text-property (1- start) 'comint-must-overwrite))
1907 (setq delete-end (point-marker))
1908 (remove-text-properties lbeg start '(comint-must-overwrite nil)))
1909 (narrow-to-region lbeg end)
1910 ;; Handle BS, LF, and CR specially.
1912 (setq ch (following-char))
1914 (delete-char 1)
1915 (if (> (point) lbeg)
1916 (delete-char -1)))
1918 (when delete-end ; CH = LF
1919 (if (< delete-end (point))
1920 (delete-region lbeg delete-end))
1921 (set-marker delete-end nil)
1922 (setq delete-end nil))
1923 (forward-char 1)
1924 (setq lbeg (point)))
1925 (t ; CH = CR
1926 (delete-char 1)
1927 (if delete-end
1928 (when (< delete-end (point))
1929 (delete-region lbeg delete-end)
1930 (move-marker delete-end (point)))
1931 (setq delete-end (point-marker))))))
1932 (when delete-end
1933 (if (< delete-end (point))
1934 ;; As there's a text after the last CR, make the current
1935 ;; line contain only that text.
1936 (delete-region lbeg delete-end)
1937 ;; Remember that the process output ends by CR, and thus we
1938 ;; must overwrite the contents of the current line next
1939 ;; time.
1940 (put-text-property lbeg delete-end 'comint-must-overwrite t))
1941 (set-marker delete-end nil))
1942 (widen))))
1944 ;; The purpose of using this filter for comint processes
1945 ;; is to keep comint-last-input-end from moving forward
1946 ;; when output is inserted.
1947 (defun comint-output-filter (process string)
1948 (let ((oprocbuf (process-buffer process)))
1949 ;; First check for killed buffer or no input.
1950 (when (and string oprocbuf (buffer-name oprocbuf))
1951 (with-current-buffer oprocbuf
1952 ;; Run preoutput filters
1953 (let ((functions comint-preoutput-filter-functions))
1954 (while (and functions string)
1955 (if (eq (car functions) t)
1956 (let ((functions
1957 (default-value 'comint-preoutput-filter-functions)))
1958 (while (and functions string)
1959 (setq string (funcall (car functions) string))
1960 (setq functions (cdr functions))))
1961 (setq string (funcall (car functions) string)))
1962 (setq functions (cdr functions))))
1964 ;; Insert STRING
1965 (let ((inhibit-read-only t)
1966 ;; The point should float after any insertion we do.
1967 (saved-point (copy-marker (point) t)))
1969 ;; We temporarly remove any buffer narrowing, in case the
1970 ;; process mark is outside of the restriction
1971 (save-restriction
1972 (widen)
1974 (goto-char (process-mark process))
1975 (set-marker comint-last-output-start (point))
1977 ;; insert-before-markers is a bad thing. XXX
1978 ;; Luckily we don't have to use it any more, we use
1979 ;; window-point-insertion-type instead.
1980 (insert string)
1982 ;; Advance process-mark
1983 (set-marker (process-mark process) (point))
1985 (unless comint-inhibit-carriage-motion
1986 ;; Interpret any carriage motion characters (newline, backspace)
1987 (comint-carriage-motion comint-last-output-start (point)))
1989 ;; Run these hooks with point where the user had it.
1990 (goto-char saved-point)
1991 (run-hook-with-args 'comint-output-filter-functions string)
1992 (set-marker saved-point (point))
1994 (goto-char (process-mark process)) ; in case a filter moved it
1996 (unless comint-use-prompt-regexp
1997 (let ((inhibit-read-only t)
1998 (inhibit-modification-hooks t))
1999 (add-text-properties comint-last-output-start (point)
2000 '(front-sticky
2001 (field inhibit-line-move-field-capture)
2002 rear-nonsticky t
2003 field output
2004 inhibit-line-move-field-capture t))))
2006 ;; Highlight the prompt, where we define `prompt' to mean
2007 ;; the most recent output that doesn't end with a newline.
2008 (let ((prompt-start (save-excursion (forward-line 0) (point)))
2009 (inhibit-read-only t)
2010 (inhibit-modification-hooks t))
2011 (when comint-prompt-read-only
2012 (or (= (point-min) prompt-start)
2013 (get-text-property (1- prompt-start) 'read-only)
2014 (put-text-property
2015 (1- prompt-start) prompt-start 'read-only 'fence))
2016 (add-text-properties
2017 prompt-start (point)
2018 '(read-only t rear-nonsticky t front-sticky (read-only))))
2019 (unless (and (bolp) (null comint-last-prompt-overlay))
2020 ;; Need to create or move the prompt overlay (in the case
2021 ;; where there is no prompt ((bolp) == t), we still do
2022 ;; this if there's already an existing overlay).
2023 (if comint-last-prompt-overlay
2024 ;; Just move an existing overlay
2025 (move-overlay comint-last-prompt-overlay
2026 prompt-start (point))
2027 ;; Need to create the overlay
2028 (setq comint-last-prompt-overlay
2029 (make-overlay prompt-start (point)))
2030 (overlay-put comint-last-prompt-overlay
2031 'font-lock-face 'comint-highlight-prompt))))
2033 (goto-char saved-point)))))))
2035 (defun comint-preinput-scroll-to-bottom ()
2036 "Go to the end of buffer in all windows showing it.
2037 Movement occurs if point in the selected window is not after the process mark,
2038 and `this-command' is an insertion command. Insertion commands recognized
2039 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
2040 Depends on the value of `comint-scroll-to-bottom-on-input'.
2042 This function should be a pre-command hook."
2043 (if (and comint-scroll-to-bottom-on-input
2044 (memq this-command '(self-insert-command comint-magic-space yank
2045 hilit-yank)))
2046 (let* ((selected (selected-window))
2047 (current (current-buffer))
2048 (process (get-buffer-process current))
2049 (scroll comint-scroll-to-bottom-on-input))
2050 (if (and process (< (point) (process-mark process)))
2051 (if (eq scroll 'this)
2052 (goto-char (point-max))
2053 (walk-windows
2054 (lambda (window)
2055 (if (and (eq (window-buffer window) current)
2056 (or (eq scroll t) (eq scroll 'all)))
2057 (progn
2058 (select-window window)
2059 (goto-char (point-max))
2060 (select-window selected))))
2061 nil t))))))
2063 (defun comint-postoutput-scroll-to-bottom (string)
2064 "Go to the end of buffer in some or all windows showing it.
2065 Does not scroll if the current line is the last line in the buffer.
2066 Depends on the value of `comint-move-point-for-output' and
2067 `comint-scroll-show-maximum-output'.
2069 This function should be in the list `comint-output-filter-functions'."
2070 (let* ((selected (selected-window))
2071 (current (current-buffer))
2072 (process (get-buffer-process current))
2073 (scroll comint-move-point-for-output))
2074 (unwind-protect
2075 (if process
2076 (walk-windows
2077 (lambda (window)
2078 (when (eq (window-buffer window) current)
2079 (select-window window)
2080 (if (and (< (point) (process-mark process))
2081 (or (eq scroll t) (eq scroll 'all)
2082 ;; Maybe user wants point to jump to end.
2083 (and (eq scroll 'this) (eq selected window))
2084 (and (eq scroll 'others) (not (eq selected window)))
2085 ;; If point was at the end, keep it at end.
2086 (and (marker-position comint-last-output-start)
2087 (>= (point) comint-last-output-start))))
2088 (goto-char (process-mark process)))
2089 ;; Optionally scroll so that the text
2090 ;; ends at the bottom of the window.
2091 (if (and comint-scroll-show-maximum-output
2092 (= (point) (point-max)))
2093 (save-excursion
2094 (goto-char (point-max))
2095 (recenter (- -1 scroll-margin))))
2096 (select-window selected)))
2097 nil t))
2098 (set-buffer current))))
2100 (defun comint-truncate-buffer (&optional string)
2101 "Truncate the buffer to `comint-buffer-maximum-size'.
2102 This function could be on `comint-output-filter-functions' or bound to a key."
2103 (interactive)
2104 (save-excursion
2105 (goto-char (process-mark (get-buffer-process (current-buffer))))
2106 (forward-line (- comint-buffer-maximum-size))
2107 (beginning-of-line)
2108 (let ((inhibit-read-only t))
2109 (delete-region (point-min) (point)))))
2111 (defun comint-strip-ctrl-m (&optional string)
2112 "Strip trailing `^M' characters from the current output group.
2113 This function could be on `comint-output-filter-functions' or bound to a key."
2114 (interactive)
2115 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2116 (save-excursion
2117 (condition-case nil
2118 (goto-char
2119 (if (called-interactively-p 'interactive)
2120 comint-last-input-end comint-last-output-start))
2121 (error nil))
2123 (replace-match "" t t)))))
2124 (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
2126 (defun comint-show-maximum-output ()
2127 "Put the end of the buffer at the bottom of the window."
2128 (interactive)
2129 (goto-char (point-max))
2130 (recenter (- -1 scroll-margin)))
2132 (defun comint-get-old-input-default ()
2133 "Default for `comint-get-old-input'.
2134 If `comint-use-prompt-regexp' is nil, then either
2135 return the current input field, if point is on an input field, or the
2136 current line, if point is on an output field.
2137 If `comint-use-prompt-regexp' is non-nil, then return
2138 the current line with any initial string matching the regexp
2139 `comint-prompt-regexp' removed."
2140 (let ((bof (field-beginning)))
2141 (if (eq (get-char-property bof 'field) 'input)
2142 (field-string-no-properties bof)
2143 (comint-bol)
2144 (buffer-substring-no-properties (point) (line-end-position)))))
2146 (defun comint-copy-old-input ()
2147 "Insert after prompt old input at point as new input to be edited.
2148 Calls `comint-get-old-input' to get old input."
2149 (interactive)
2150 (let ((input (funcall comint-get-old-input))
2151 (process (get-buffer-process (current-buffer))))
2152 (if (not process)
2153 (error "Current buffer has no process")
2154 (goto-char (process-mark process))
2155 (insert input))))
2157 (defun comint-skip-prompt ()
2158 "Skip past the text matching regexp `comint-prompt-regexp'.
2159 If this takes us past the end of the current line, don't skip at all."
2160 (if (and (looking-at comint-prompt-regexp)
2161 (<= (match-end 0) (line-end-position)))
2162 (goto-char (match-end 0))))
2164 (defun comint-after-pmark-p ()
2165 "Return t if point is after the process output marker."
2166 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2167 (<= (marker-position pmark) (point))))
2169 (defun comint-simple-send (proc string)
2170 "Default function for sending to PROC input STRING.
2171 This just sends STRING plus a newline. To override this,
2172 set the hook `comint-input-sender'."
2173 (let ((send-string
2174 (if comint-input-sender-no-newline
2175 string
2176 ;; Sending as two separate strings does not work
2179 (comint-send-string proc send-string))
2180 (if (and comint-input-sender-no-newline
2181 (not (string-equal string "")))
2182 (process-send-eof)))
2184 (defun comint-line-beginning-position ()
2185 "Return the buffer position of the beginning of the line, after any prompt.
2186 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done by
2187 skipping text matching the regular expression `comint-prompt-regexp',
2188 a buffer local variable."
2189 (if comint-use-prompt-regexp
2190 ;; Use comint-prompt-regexp
2191 (save-excursion
2192 (beginning-of-line)
2193 (comint-skip-prompt)
2194 (point))
2195 ;; Use input fields. Note that, unlike the behavior of
2196 ;; `line-beginning-position' inside a field, this function will
2197 ;; return the position of the end of a prompt, even if the point is
2198 ;; already inside the prompt. In order to do this, it assumes that
2199 ;; if there are two fields on a line, then the first one is the
2200 ;; prompt, and the second one is an input field, and is front-sticky
2201 ;; (as input fields should be).
2202 (constrain-to-field (line-beginning-position) (line-end-position))))
2204 (defun comint-bol (&optional arg)
2205 "Go to the beginning of line, then skip past the prompt, if any.
2207 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done
2208 by skipping text matching the regular expression `comint-prompt-regexp',
2209 a buffer local variable."
2210 (interactive "P")
2211 (if arg
2212 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
2213 (forward-line 0)
2214 (goto-char (comint-line-beginning-position))))
2216 ;; For compatibility.
2217 (defun comint-read-noecho (prompt &optional ignore)
2218 (read-passwd prompt))
2220 ;; These three functions are for entering text you don't want echoed or
2221 ;; saved -- typically passwords to ftp, telnet, or somesuch.
2222 ;; Just enter m-x send-invisible and type in your line.
2224 (defun send-invisible (&optional prompt)
2225 "Read a string without echoing.
2226 Then send it to the process running in the current buffer.
2227 The string is sent using `comint-input-sender'.
2228 Security bug: your string can still be temporarily recovered with
2230 (interactive "P") ; Defeat snooping via C-x ESC ESC
2231 (let ((proc (get-buffer-process (current-buffer)))
2232 (prefix
2233 (if (eq (window-buffer (selected-window)) (current-buffer))
2234 ""
2235 (format "(In buffer %s) "
2236 (current-buffer)))))
2237 (if proc
2238 (let ((str (read-passwd (concat prefix
2239 (or prompt "Non-echoed text: ")))))
2240 (if (stringp str)
2241 (progn
2242 (comint-snapshot-last-prompt)
2243 (funcall comint-input-sender proc str))
2244 (message "Warning: text will be echoed")))
2245 (error "Buffer %s has no process" (current-buffer)))))
2247 (defun comint-watch-for-password-prompt (string)
2248 "Prompt in the minibuffer for password and send without echoing.
2249 This function uses `send-invisible' to read and send a password to the buffer's
2250 process if STRING contains a password prompt defined by
2251 `comint-password-prompt-regexp'.
2253 This function could be in the list `comint-output-filter-functions'."
2254 (when (string-match comint-password-prompt-regexp string)
2256 (setq string (replace-match "" t t string)))
2257 (send-invisible string)))
2258 \f
2259 ;; Low-level process communication
2261 (defun comint-send-string (process string)
2262 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
2263 (if process
2264 (with-current-buffer (if (processp process)
2265 (process-buffer process)
2266 (get-buffer process))
2267 (comint-snapshot-last-prompt))
2268 (comint-snapshot-last-prompt))
2269 (process-send-string process string))
2271 (defun comint-send-region (process start end)
2272 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
2273 (if process
2274 (with-current-buffer (if (processp process)
2275 (process-buffer process)
2276 (get-buffer process))
2277 (comint-snapshot-last-prompt))
2278 (comint-snapshot-last-prompt))
2279 (process-send-region process start end))
2281 \f
2282 ;; Random input hackage
2284 (defun comint-delete-output ()
2285 "Delete all output from interpreter since last input.
2286 Does not delete the prompt."
2287 (interactive)
2288 (let ((proc (get-buffer-process (current-buffer)))
2289 (replacement nil)
2290 (inhibit-read-only t))
2291 (save-excursion
2292 (let ((pmark (progn (goto-char (process-mark proc))
2293 (forward-line 0)
2294 (point-marker))))
2295 (delete-region comint-last-input-end pmark)
2296 (goto-char (process-mark proc))
2298 (buffer-substring pmark (point))))
2299 (delete-region pmark (point))))
2300 ;; Output message and put back prompt
2301 (comint-output-filter proc replacement)))
2303 (defun comint-write-output (filename &optional append mustbenew)
2304 "Write output from interpreter since last input to FILENAME.
2305 Any prompt at the end of the output is not written.
2307 If the optional argument APPEND (the prefix argument when interactive)
2308 is non-nil, the output is appended to the file instead.
2310 If the optional argument MUSTBENEW is non-nil, check for an existing
2311 file with the same name. If MUSTBENEW is `excl', that means to get an
2312 error if the file already exists; never overwrite. If MUSTBENEW is
2313 neither nil nor `excl', that means ask for confirmation before
2314 overwriting, but do go ahead and overwrite the file if the user
2315 confirms. When interactive, MUSTBENEW is nil when appending, and t
2316 otherwise."
2317 (interactive
2318 (list (read-file-name
2319 (if current-prefix-arg
2320 "Append output to file: "
2321 "Write output to file: "))
2322 current-prefix-arg
2323 (not current-prefix-arg)))
2324 (save-excursion
2325 (goto-char (process-mark (get-buffer-process (current-buffer))))
2326 (forward-line 0)
2327 (write-region comint-last-input-end (point) filename
2328 append nil nil mustbenew)))
2330 ;; This function exists for the benefit of the menu; from the keyboard,
2331 ;; users can just use `comint-write-output' with a prefix arg.
2332 (defun comint-append-output-to-file (filename)
2333 "Append output from interpreter since last input to FILENAME.
2334 Any prompt at the end of the output is not written."
2335 (interactive "fAppend output to file: ")
2336 (comint-write-output filename t))
2338 (defun comint-show-output ()
2339 "Display start of this batch of interpreter output at top of window.
2340 Sets mark to the value of point when this command is run."
2341 (interactive)
2342 (push-mark)
2343 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
2344 (cond (comint-use-prompt-regexp
2345 (goto-char pos)
2346 (beginning-of-line 0)
2347 (set-window-start (selected-window) (point))
2348 (comint-skip-prompt))
2349 (t
2350 (goto-char (field-beginning pos))
2351 (set-window-start (selected-window) (point))))))
2354 (defun comint-interrupt-subjob ()
2355 "Interrupt the current subjob.
2356 This command also kills the pending input
2357 between the process mark and point."
2358 (interactive)
2359 (comint-skip-input)
2360 (interrupt-process nil comint-ptyp)
2362 )
2364 (defun comint-kill-subjob ()
2365 "Send kill signal to the current subjob.
2366 This command also kills the pending input
2367 between the process mark and point."
2368 (interactive)
2369 (comint-skip-input)
2370 (kill-process nil comint-ptyp))
2372 (defun comint-quit-subjob ()
2373 "Send quit signal to the current subjob.
2374 This command also kills the pending input
2375 between the process mark and point."
2376 (interactive)
2377 (comint-skip-input)
2378 (quit-process nil comint-ptyp))
2380 (defun comint-stop-subjob ()
2381 "Stop the current subjob.
2382 This command also kills the pending input
2383 between the process mark and point.
2385 WARNING: if there is no current subjob, you can end up suspending
2386 the top-level process running in the buffer. If you accidentally do
2388 is not a problem with most shells, since they ignore this signal.)"
2389 (interactive)
2390 (comint-skip-input)
2391 (stop-process nil comint-ptyp))
2393 (defun comint-continue-subjob ()
2394 "Send CONT signal to process buffer's process group.
2395 Useful if you accidentally suspend the top-level process."
2396 (interactive)
2397 (continue-process nil comint-ptyp))
2399 (defun comint-skip-input ()
2400 "Skip all pending input, from last stuff output by interpreter to point.
2401 This means mark it as if it had been sent as input, without sending it."
2402 (let ((comint-input-sender 'ignore)
2403 (comint-input-filter-functions nil))
2404 (comint-send-input t t))
2405 (end-of-line)
2406 (let ((pos (point))
2407 (marker (process-mark (get-buffer-process (current-buffer)))))
2408 (insert " " (key-description (this-command-keys)))
2409 (if (= marker pos)
2410 (set-marker marker (point)))))
2412 (defun comint-kill-input ()
2413 "Kill all text from last stuff output by interpreter to point."
2414 (interactive)
2415 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2416 (if (> (point) (marker-position pmark))
2417 (kill-region pmark (point)))))
2419 (defun comint-delchar-or-maybe-eof (arg)
2420 "Delete ARG characters forward or send an EOF to subprocess.
2421 Sends an EOF only if point is at the end of the buffer and there is no input."
2422 (interactive "p")
2423 (let ((proc (get-buffer-process (current-buffer))))
2424 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
2425 (comint-send-eof)
2426 (delete-char arg))))
2428 (defun comint-send-eof ()
2429 "Send an EOF to the current buffer's process."
2430 (interactive)
2431 (comint-send-input t t)
2432 (process-send-eof))
2435 (defun comint-backward-matching-input (regexp n)
2436 "Search backward through buffer for input fields that match REGEXP.
2437 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2438 by lines that match `comint-prompt-regexp'.
2440 With prefix argument N, search for Nth previous match.
2441 If N is negative, find the next or Nth next match."
2442 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2443 (if comint-use-prompt-regexp
2444 ;; Use comint-prompt-regexp
2445 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2446 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2447 (if (re-search-backward re nil t n)
2448 (point)))))
2449 (if (null pos)
2450 (progn (message "Not found")
2451 (ding))
2452 (goto-char pos)
2453 (comint-bol nil)))
2454 ;; Use input fields
2455 (let* ((dir (if (< n 0) -1 1))
2456 (pos
2457 (save-excursion
2458 (while (/= n 0)
2459 (unless (re-search-backward regexp nil t dir)
2460 (error "Not found"))
2461 (when (eq (get-char-property (point) 'field) 'input)
2462 (setq n (- n dir))))
2463 (field-beginning))))
2464 (goto-char pos))))
2467 (defun comint-forward-matching-input (regexp n)
2468 "Search forward through buffer for input fields that match REGEXP.
2469 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2470 by lines that match `comint-prompt-regexp'.
2472 With prefix argument N, search for Nth following match.
2473 If N is negative, find the previous or Nth previous match."
2474 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2475 (comint-backward-matching-input regexp (- n)))
2478 (defun comint-next-prompt (n)
2479 "Move to end of Nth next prompt in the buffer.
2480 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2481 the Nth next `input' field, otherwise, it means the Nth occurrence of
2482 text matching `comint-prompt-regexp'."
2483 (interactive "p")
2484 (if comint-use-prompt-regexp
2485 ;; Use comint-prompt-regexp
2486 (let ((paragraph-start comint-prompt-regexp))
2487 (end-of-line (if (> n 0) 1 0))
2488 (forward-paragraph n)
2489 (comint-skip-prompt))
2490 ;; Use input fields
2491 (let ((pos (point))
2492 (input-pos nil)
2493 prev-pos)
2494 (while (/= n 0)
2495 (setq prev-pos pos)
2496 (setq pos
2497 (if (> n 0)
2498 (next-single-char-property-change pos 'field)
2499 (previous-single-char-property-change pos 'field)))
2500 (cond ((or (null pos) (= pos prev-pos))
2501 ;; Ran off the end of the buffer.
2502 (when (> n 0)
2503 ;; There's always an input field at the end of the
2504 ;; buffer, but it has a `field' property of nil.
2505 (setq input-pos (point-max)))
2506 ;; stop iterating
2507 (setq n 0))
2508 ((eq (get-char-property pos 'field) 'input)
2509 (setq n (if (< n 0) (1+ n) (1- n)))
2510 (setq input-pos pos))))
2511 (when input-pos
2512 (goto-char input-pos)))))
2515 (defun comint-previous-prompt (n)
2516 "Move to end of Nth previous prompt in the buffer.
2517 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2518 the Nth previous `input' field, otherwise, it means the Nth occurrence of
2519 text matching `comint-prompt-regexp'."
2520 (interactive "p")
2521 (comint-next-prompt (- n)))
2523 ;; State used by `comint-insert-previous-argument' when cycling.
2524 (defvar comint-insert-previous-argument-last-start-pos nil)
2525 (make-variable-buffer-local 'comint-insert-previous-argument-last-start-pos)
2526 (defvar comint-insert-previous-argument-last-index nil)
2527 (make-variable-buffer-local 'comint-insert-previous-argument-last-index)
2529 ;; Needs fixing:
2530 ;; make comint-arguments understand negative indices as bash does
2531 (defun comint-insert-previous-argument (index)
2532 "Insert the INDEXth argument from the previous Comint command-line at point.
2533 Spaces are added at beginning and/or end of the inserted string if
2534 necessary to ensure that it's separated from adjacent arguments.
2535 Interactively, if no prefix argument is given, the last argument is inserted.
2536 Repeated interactive invocations will cycle through the same argument
2537 from progressively earlier commands (using the value of INDEX specified
2538 with the first command).
2539 This command is like `M-.' in bash."
2540 (interactive "P")
2541 (unless (null index)
2542 (setq index (prefix-numeric-value index)))
2543 (cond ((eq last-command this-command)
2544 ;; Delete last input inserted by this command.
2545 (delete-region comint-insert-previous-argument-last-start-pos (point))
2546 (setq index comint-insert-previous-argument-last-index))
2547 (t
2548 ;; This is a non-repeat invocation, so initialize state.
2549 (setq comint-input-ring-index nil)
2550 (setq comint-insert-previous-argument-last-index index)
2551 (when (null comint-insert-previous-argument-last-start-pos)
2552 ;; First usage; initialize to a marker
2553 (setq comint-insert-previous-argument-last-start-pos
2554 (make-marker)))))
2555 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2556 (if (<= (point) (comint-line-beginning-position))
2557 (comint-bol)
2558 (just-one-space))
2559 ;; Remember the beginning of what we insert, so we can delete it if
2560 ;; the command is repeated.
2561 (set-marker comint-insert-previous-argument-last-start-pos (point))
2562 ;; Insert the argument.
2563 (let ((input-string (comint-previous-input-string 0)))
2565 ;; strip terminating '&'
2566 (setq input-string (substring input-string 0 (match-beginning 0))))
2567 (insert (comint-arguments input-string index index)))
2568 ;; Make next invocation return arg from previous input
2569 (setq comint-input-ring-index (1+ (or comint-input-ring-index 0)))
2570 ;; Add a terminating space if necessary.
2571 (unless (eolp)
2572 (just-one-space)))
2574 \f
2575 ;; Support editing with `comint-prompt-read-only' set to t.
2577 (defun comint-update-fence ()
2578 "Update read-only status of newline before point.
2579 The `fence' read-only property is used to indicate that a newline
2581 following front-sticky read-only region. This is used to
2582 implement comint read-only prompts. If the text after a newline
2583 changes, the read-only status of that newline may need updating.
2584 That is what this function does.
2586 This function does nothing if point is not at the beginning of a
2587 line, or is at the beginning of the accessible portion of the buffer.
2588 Otherwise, if the character after point has a front-sticky
2589 read-only property, then the preceding newline is given a
2590 read-only property of `fence', unless it already is read-only.
2591 If the character after point does not have a front-sticky
2592 read-only property, any read-only property of `fence' on the
2593 preceding newline is removed."
2594 (let* ((pt (point)) (lst (get-text-property pt 'front-sticky))
2595 (inhibit-modification-hooks t))
2596 (and (bolp)
2597 (not (bobp))
2598 (if (and (get-text-property pt 'read-only)
2599 (if (listp lst) (memq 'read-only lst) t))
2600 (unless (get-text-property (1- pt) 'read-only)
2601 (put-text-property (1- pt) pt 'read-only 'fence))
2602 (when (eq (get-text-property (1- pt) 'read-only) 'fence)
2603 (remove-list-of-text-properties (1- pt) pt '(read-only)))))))
2605 (defun comint-kill-whole-line (&optional count)
2606 "Kill current line, ignoring read-only and field properties.
2607 With prefix arg COUNT, kill that many lines starting from the current line.
2608 If COUNT is negative, kill backward. Also kill the preceding newline,
2610 with negative arguments.)
2611 If COUNT is zero, kill current line but exclude the trailing newline.
2612 The read-only status of newlines is updated with `comint-update-fence',
2613 if necessary."
2614 (interactive "p")
2615 (let ((inhibit-read-only t) (inhibit-field-text-motion t))
2616 (kill-whole-line count)
2617 (when (>= count 0) (comint-update-fence))))
2619 (defun comint-kill-region (beg end &optional yank-handler)
2620 "Like `kill-region', but ignores read-only properties, if safe.
2621 This command assumes that the buffer contains read-only
2623 properties at the beginning of a line, with the preceding newline
2624 being read-only to protect the prompt. This is true of the
2625 comint prompts if `comint-prompt-read-only' is non-nil. This
2626 command will not delete the region if this would create mutilated
2627 or out of place prompts. That is, if any part of a prompt is
2628 deleted, the entire prompt must be deleted and all remaining
2629 prompts should stay at the beginning of a line. If this is not
2630 the case, this command just calls `kill-region' with all
2631 read-only properties intact. The read-only status of newlines is
2632 updated using `comint-update-fence', if necessary."
2633 (interactive "r")
2634 (save-excursion
2635 (let* ((true-beg (min beg end))
2636 (true-end (max beg end))
2637 (beg-bolp (progn (goto-char true-beg) (bolp)))
2638 (beg-lst (get-text-property true-beg 'front-sticky))
2639 (beg-bad (and (get-text-property true-beg 'read-only)
2640 (if (listp beg-lst) (memq 'read-only beg-lst) t)))
2641 (end-bolp (progn (goto-char true-end) (bolp)))
2642 (end-lst (get-text-property true-end 'front-sticky))
2643 (end-bad (and (get-text-property true-end 'read-only)
2644 (if (listp end-lst) (memq 'read-only end-lst) t))))
2645 (if (or (and (not beg-bolp) (or beg-bad end-bad))
2646 (and (not end-bolp) end-bad))
2647 (kill-region beg end yank-handler)
2648 (let ((inhibit-read-only t))
2649 (kill-region beg end yank-handler)
2650 (comint-update-fence))))))
2652 \f
2653 ;; Support for source-file processing commands.
2654 ;;============================================================================
2655 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2656 ;; commands that process files of source text (e.g. loading or compiling
2657 ;; files). So the corresponding process-in-a-buffer modes have commands
2658 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2659 ;; for defining these commands.
2660 ;;
2661 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2662 ;; and Soar, in that they don't know anything about file extensions.
2663 ;; So the compile/load interface gets the wrong default occasionally.
2664 ;; The load-file/compile-file default mechanism could be smarter -- it
2665 ;; doesn't know about the relationship between filename extensions and
2666 ;; whether the file is source or executable. If you compile foo.lisp
2667 ;; with compile-file, then the next load-file should use foo.bin for
2668 ;; the default, not foo.lisp. This is tricky to do right, particularly
2669 ;; because the extension for executable files varies so much (.o, .bin,
2670 ;; .lbin, .mo, .vo, .ao, ...).
2673 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2674 ;; commands.
2675 ;;
2676 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2677 ;; want to save the buffer before issuing any process requests to the command
2678 ;; interpreter.
2679 ;;
2680 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2681 ;; for the file to process.
2683 (defun comint-source-default (previous-dir/file source-modes)
2684 "Compute the defaults for `load-file' and `compile-file' commands.
2686 PREVIOUS-DIR/FILE is a pair (DIRECTORY . FILENAME) from the last
2687 source-file processing command, or nil if there hasn't been one yet.
2688 SOURCE-MODES is a list used to determine what buffers contain source
2689 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2690 Typically, (lisp-mode) or (scheme-mode).
2692 If the command is given while the cursor is inside a string, *and*
2693 the string is an existing filename, *and* the filename is not a directory,
2694 then the string is taken as default. This allows you to just position
2695 your cursor over a string that's a filename and have it taken as default.
2697 If the command is given in a file buffer whose major mode is in
2698 SOURCE-MODES, then the filename is the default file, and the
2699 file's directory is the default directory.
2701 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2702 then the default directory & file are what was used in the last source-file
2703 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2704 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2707 SOURCE-MODES is typically going to be something like (tea-mode)
2708 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2709 for Soar programs, etc.
2711 The function returns a pair: (default-directory . default-file)."
2712 (cond ((and buffer-file-name (memq major-mode source-modes))
2713 (cons (file-name-directory buffer-file-name)
2714 (file-name-nondirectory buffer-file-name)))
2715 (previous-dir/file)
2716 (t
2717 (cons default-directory nil))))
2720 (defun comint-check-source (fname)
2721 "Check whether to save buffers visiting file FNAME.
2722 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2723 process-in-a-buffer modes), this function can be called on the filename.
2724 If the file is loaded into a buffer, and the buffer is modified, the user
2725 is queried to see if he wants to save the buffer before proceeding with
2726 the load or compile."
2727 (let ((buff (get-file-buffer fname)))
2728 (if (and buff
2729 (buffer-modified-p buff)
2730 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
2731 ;; save BUFF.
2732 (let ((old-buffer (current-buffer)))
2733 (set-buffer buff)
2734 (save-buffer)
2735 (set-buffer old-buffer)))))
2737 (defun comint-extract-string ()
2738 "Return string around point, or nil."
2739 (let ((syntax (syntax-ppss)))
2740 (when (nth 3 syntax)
2741 (condition-case ()
2742 (buffer-substring-no-properties (1+ (nth 8 syntax))
2743 (progn (goto-char (nth 8 syntax))
2744 (forward-sexp)
2745 (1- (point))))
2746 (error nil)))))
2748 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2749 "Prompt for filenames in commands that process source files,
2750 e.g. loading or compiling a file.
2751 Provides a default, if there is one, and returns the result filename.
2753 See `comint-source-default' for more on determining defaults.
2755 PROMPT is the prompt string. PREV-DIR/FILE is the (DIRECTORY . FILE) pair
2756 from the last source processing command. SOURCE-MODES is a list of major
2757 modes used to determine what file buffers contain source files. (These
2758 two arguments are used for determining defaults.) If MUSTMATCH-P is true,
2759 then the filename reader will only accept a file that exists.
2761 A typical use:
2763 '(lisp-mode) t))"
2764 (let* ((def (comint-source-default prev-dir/file source-modes))
2765 (stringfile (comint-extract-string))
2766 (sfile-p (and stringfile
2767 (condition-case ()
2768 (file-exists-p stringfile)
2769 (error nil))
2770 (not (file-directory-p stringfile))))
2771 (defdir (if sfile-p (file-name-directory stringfile)
2772 (car def)))
2773 (deffile (if sfile-p (file-name-nondirectory stringfile)
2774 (cdr def)))
2775 (ans (read-file-name (if deffile (format "%s(default %s) "
2776 prompt deffile)
2777 prompt)
2778 defdir
2779 (concat defdir deffile)
2780 mustmatch-p)))
2781 (list (expand-file-name (substitute-in-file-name ans)))))
2783 ;; I am somewhat divided on this string-default feature. It seems
2784 ;; to violate the principle-of-least-astonishment, in that it makes
2785 ;; the default harder to predict, so you actually have to look and see
2786 ;; what the default really is before choosing it. This can trip you up.
2787 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2788 ;; on this.
2789 ;; -Olin
2791 \f
2792 ;; Simple process query facility.
2793 ;; ===========================================================================
2794 ;; This function is for commands that want to send a query to the process
2795 ;; and show the response to the user. For example, a command to get the
2796 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2797 ;; to an inferior Common Lisp process.
2798 ;;
2799 ;; This simple facility just sends strings to the inferior process and pops
2800 ;; up a window for the process buffer so you can see what the process
2801 ;; responds with. We don't do anything fancy like try to intercept what the
2802 ;; process responds with and put it in a pop-up window or on the message
2803 ;; line. We just display the buffer. Low tech. Simple. Works good.
2805 (defun comint-proc-query (proc str)
2806 "Send to the inferior process PROC the string STR.
2807 Pop-up but do not select a window for the inferior process so that
2808 its response can be seen."
2809 (let* ((proc-buf (process-buffer proc))
2810 (proc-mark (process-mark proc)))
2811 (display-buffer proc-buf)
2812 (set-buffer proc-buf) ; but it's not the selected *window*
2813 (let ((proc-win (get-buffer-window proc-buf 0))
2814 (proc-pt (marker-position proc-mark)))
2815 (comint-send-string proc str) ; send the query
2816 (accept-process-output proc) ; wait for some output
2817 ;; Try to position the proc window so you can see the answer.
2818 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2819 ;; I don't know why. Wizards invited to improve it.
2820 (unless (pos-visible-in-window-p proc-pt proc-win)
2821 (let ((opoint (window-point proc-win)))
2822 (set-window-point proc-win proc-mark)
2823 (sit-for 0)
2824 (if (not (pos-visible-in-window-p opoint proc-win))
2825 (push-mark opoint)
2826 (set-window-point proc-win opoint)))))))
2828 \f
2829 ;; Filename/command/history completion in a buffer
2830 ;; ===========================================================================
2831 ;; Useful completion functions, courtesy of the Ergo group.
2833 ;; Six commands:
2834 ;; comint-dynamic-complete Complete or expand command, filename,
2835 ;; history at point.
2836 ;; comint-dynamic-complete-filename Complete filename at point.
2837 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2838 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2839 ;; replace with expanded/completed name.
2840 ;; comint-dynamic-simple-complete Complete stub given candidates.
2842 ;; These are not installed in the comint-mode keymap. But they are
2843 ;; available for people who want them. Shell-mode installs them:
2845 ;; (define-key shell-mode-map "\M-?"
2846 ;; 'comint-dynamic-list-filename-completions)))
2847 ;;
2848 ;; Commands like this are fine things to put in load hooks if you
2849 ;; want them present in specific modes.
2851 (defcustom comint-completion-autolist nil
2852 "If non-nil, automatically list possibilities on partial completion.
2853 This mirrors the optional behavior of tcsh."
2854 :type 'boolean
2855 :group 'comint-completion)
2857 (defcustom comint-completion-addsuffix t
2858 "If non-nil, add a `/' to completed directories, ` ' to file names.
2859 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2860 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2861 This mirrors the optional behavior of tcsh."
2862 :type '(choice (const :tag "None" nil)
2863 (const :tag "Add /" t)
2864 (cons :tag "Suffix pair"
2865 (string :tag "Directory suffix")
2866 (string :tag "File suffix")))
2867 :group 'comint-completion)
2869 (defcustom comint-completion-recexact nil
2870 "If non-nil, use shortest completion if characters cannot be added.
2871 This mirrors the optional behavior of tcsh.
2873 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2874 :type 'boolean
2875 :group 'comint-completion)
2877 (defcustom comint-completion-fignore nil
2878 "List of suffixes to be disregarded during file completion.
2879 This mirrors the optional behavior of bash and tcsh.
2881 Note that this applies to `comint-dynamic-complete-filename' only."
2882 :type '(repeat (string :tag "Suffix"))
2883 :group 'comint-completion)
2885 ;;;###autoload
2886 (defvar comint-file-name-prefix (purecopy "")
2887 "Prefix prepended to absolute file names taken from process input.
2888 This is used by Comint's and shell's completion functions, and by shell's
2889 directory tracking functions.")
2891 (defvar comint-file-name-chars
2892 (if (memq system-type '(ms-dos windows-nt cygwin))
2893 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2894 "[]~/A-Za-z0-9+@:_.$#%,={}-")
2895 "String of characters valid in a file name.
2896 Note that all non-ASCII characters are considered valid in a file name
2897 regardless of what this variable says.
2899 This is a good thing to set in mode hooks.")
2901 (defvar comint-file-name-quote-list nil
2904 This is a good thing to set in mode hooks.")
2907 (defun comint-directory (directory)
2908 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
2909 (expand-file-name (if (file-name-absolute-p directory)
2910 (concat comint-file-name-prefix directory)
2911 directory)))
2914 (defun comint-word (word-chars)
2915 "Return the word of WORD-CHARS at point, or nil if none is found.
2916 Word constituents are considered to be those in WORD-CHARS, which is like the
2918 (save-excursion
2919 (let ((here (point))
2920 giveup)
2921 (while (not giveup)
2922 (let ((startpoint (point)))
2924 ;; Fixme: This isn't consistent with Bash, at least -- not
2925 ;; all non-ASCII chars should be word constituents.
2926 (if (and (> (- (point) 2) (point-min))
2928 (forward-char -2))
2929 (if (and (> (- (point) 1) (point-min))
2930 (>= (char-after (- (point) 1)) 128))
2931 (forward-char -1))
2932 (if (= (point) startpoint)
2933 (setq giveup t))))
2934 ;; Set match-data to match the entire string.
2935 (when (< (point) here)
2936 (set-match-data (list (point) here))
2937 (match-string 0)))))
2939 (defun comint-substitute-in-file-name (filename)
2940 "Return FILENAME with environment variables substituted.
2941 Supports additional environment variable syntax of the command
2942 interpreter (e.g., the percent notation of cmd.exe on NT)."
2943 (let ((name (substitute-in-file-name filename)))
2944 (if (memq system-type '(ms-dos windows-nt))
2945 (let (env-var-name
2946 env-var-val)
2947 (save-match-data
2949 (setq env-var-name (match-string 1 name))
2950 (setq env-var-val (or (getenv env-var-name) ""))
2951 (setq name (replace-match env-var-val t t name))))))
2952 name))
2954 (defun comint-match-partial-filename ()
2955 "Return the filename at point, or nil if none is found.
2956 Environment variables are substituted. See `comint-word'."
2957 (let ((filename (comint-word comint-file-name-chars)))
2958 (and filename (comint-substitute-in-file-name
2959 (comint-unquote-filename filename)))))
2962 (defun comint-quote-filename (filename)
2963 "Return FILENAME with magic characters quoted.
2964 Magic characters are those in `comint-file-name-quote-list'."
2965 (if (null comint-file-name-quote-list)
2966 filename
2967 (let ((regexp
2968 (format "[%s]"
2969 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
2970 (save-match-data
2971 (let ((i 0))
2972 (while (string-match regexp filename i)
2974 (setq i (1+ (match-end 0)))))
2975 filename))))
2977 (defun comint-unquote-filename (filename)
2978 "Return FILENAME with quoted characters unquoted."
2979 (if (null comint-file-name-quote-list)
2980 filename
2981 (save-match-data
2982 (let ((i 0))
2985 (setq i (+ 1 (match-beginning 0)))))
2986 filename)))
2989 (defun comint-dynamic-complete ()
2990 "Dynamically perform completion at point.
2991 Calls the functions in `comint-dynamic-complete-functions' to perform
2992 completion until a function returns non-nil, at which point completion is
2993 assumed to have occurred."
2994 (interactive)
2995 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
2998 (defun comint-dynamic-complete-filename ()
2999 "Dynamically complete the filename at point.
3000 Completes if after a filename. See `comint-match-partial-filename' and
3001 `comint-dynamic-complete-as-filename'.
3002 This function is similar to `comint-replace-by-expanded-filename', except that
3003 it won't change parts of the filename already entered in the buffer; it just
3004 adds completion characters to the end of the filename. A completions listing
3005 may be shown in a help buffer if completion is ambiguous.
3007 Completion is dependent on the value of `comint-completion-addsuffix',
3008 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
3009 completions listing is dependent on the value of `comint-completion-autolist'.
3011 Returns t if successful."
3012 (interactive)
3013 (when (comint-match-partial-filename)
3014 (unless (window-minibuffer-p (selected-window))
3015 (message "Completing file name..."))
3016 (comint-dynamic-complete-as-filename)))
3018 (defun comint-dynamic-complete-as-filename ()
3019 "Dynamically complete at point as a filename.
3020 See `comint-dynamic-complete-filename'. Returns t if successful."
3021 (let* ((completion-ignore-case read-file-name-completion-ignore-case)
3022 (completion-ignored-extensions comint-completion-fignore)
3023 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
3024 ;; I think it was originally bound to solve file completion problems,
3025 ;; but subsequent changes may have made this unnecessary. sm.
3026 ;;(file-name-handler-alist nil)
3027 (minibuffer-p (window-minibuffer-p (selected-window)))
3028 (success t)
3029 (dirsuffix (cond ((not comint-completion-addsuffix)
3030 "")
3031 ((not (consp comint-completion-addsuffix))
3032 "/")
3033 (t
3034 (car comint-completion-addsuffix))))
3035 (filesuffix (cond ((not comint-completion-addsuffix)
3036 "")
3037 ((not (consp comint-completion-addsuffix))
3038 " ")
3039 (t
3040 (cdr comint-completion-addsuffix))))
3041 (filename (comint-match-partial-filename))
3042 (filename-beg (if filename (match-beginning 0) (point)))
3043 (filename-end (if filename (match-end 0) (point)))
3044 (filename (or filename ""))
3045 (filedir (file-name-directory filename))
3046 (filenondir (file-name-nondirectory filename))
3047 (directory (if filedir (comint-directory filedir) default-directory))
3048 (completion (file-name-completion filenondir directory)))
3049 (cond ((null completion)
3050 (if minibuffer-p
3051 (minibuffer-message "No completions of %s" filename)
3052 (message "No completions of %s" filename))
3053 (setq success nil))
3054 ((eq completion t) ; Means already completed "file".
3055 (insert filesuffix)
3056 (unless minibuffer-p
3057 (message "Sole completion")))
3058 ((string-equal completion "") ; Means completion on "directory/".
3059 (comint-dynamic-list-filename-completions))
3060 (t ; Completion string returned.
3061 (let ((file (concat (file-name-as-directory directory) completion)))
3062 ;; Insert completion. Note that the completion string
3063 ;; may have a different case than what's in the prompt,
3064 ;; if read-file-name-completion-ignore-case is non-nil,
3065 (delete-region filename-beg filename-end)
3066 (if filedir (insert (comint-quote-filename filedir)))
3067 (insert (comint-quote-filename (directory-file-name completion)))
3068 (cond ((symbolp (file-name-completion completion directory))
3069 ;; We inserted a unique completion.
3070 (insert (if (file-directory-p file) dirsuffix filesuffix))
3071 (unless minibuffer-p
3072 (message "Completed")))
3073 ((and comint-completion-recexact comint-completion-addsuffix
3074 (string-equal filenondir completion)
3075 (file-exists-p file))
3076 ;; It's not unique, but user wants shortest match.
3077 (insert (if (file-directory-p file) dirsuffix filesuffix))
3078 (unless minibuffer-p
3079 (message "Completed shortest")))
3080 ((or comint-completion-autolist
3081 (string-equal filenondir completion))
3082 ;; It's not unique, list possible completions.
3083 (comint-dynamic-list-filename-completions))
3084 (t
3085 (unless minibuffer-p
3086 (message "Partially completed")))))))
3087 success))
3090 (defun comint-replace-by-expanded-filename ()
3091 "Dynamically expand and complete the filename at point.
3092 Replace the filename with an expanded, canonicalized and completed replacement.
3095 removed, and the filename is made absolute instead of relative. For expansion
3096 see `expand-file-name' and `substitute-in-file-name'. For completion see
3097 `comint-dynamic-complete-filename'."
3098 (interactive)
3099 (let ((filename (comint-match-partial-filename)))
3100 (when filename
3101 (replace-match (expand-file-name filename) t t)
3102 (comint-dynamic-complete-filename))))
3105 (defun comint-dynamic-simple-complete (stub candidates)
3106 "Dynamically complete STUB from CANDIDATES list.
3107 This function inserts completion characters at point by completing STUB from
3108 the strings in CANDIDATES. A completions listing may be shown in a help buffer
3109 if completion is ambiguous.
3111 Returns nil if no completion was inserted.
3112 Returns `sole' if completed with the only completion match.
3113 Returns `shortest' if completed with the shortest of the completion matches.
3114 Returns `partial' if completed as far as possible with the completion matches.
3115 Returns `listed' if a completion listing was shown.
3117 See also `comint-dynamic-complete-filename'."
3118 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
3119 (minibuffer-p (window-minibuffer-p (selected-window)))
3120 (suffix (cond ((not comint-completion-addsuffix) "")
3121 ((not (consp comint-completion-addsuffix)) " ")
3122 (t (cdr comint-completion-addsuffix))))
3123 (completions (all-completions stub candidates)))
3124 (cond ((null completions)
3125 (if minibuffer-p
3126 (minibuffer-message "No completions of %s" stub)
3127 (message "No completions of %s" stub))
3128 nil)
3129 ((= 1 (length completions)) ; Gotcha!
3130 (let ((completion (car completions)))
3131 (if (string-equal completion stub)
3132 (unless minibuffer-p
3133 (message "Sole completion"))
3134 (insert (substring completion (length stub)))
3135 (unless minibuffer-p
3136 (message "Completed")))
3137 (insert suffix)
3138 'sole))
3139 (t ; There's no unique completion.
3140 (let ((completion (try-completion stub candidates)))
3141 ;; Insert the longest substring.
3142 (insert (substring completion (length stub)))
3143 (cond ((and comint-completion-recexact comint-completion-addsuffix
3144 (string-equal stub completion)
3145 (member completion completions))
3146 ;; It's not unique, but user wants shortest match.
3147 (insert suffix)
3148 (unless minibuffer-p
3149 (message "Completed shortest"))
3150 'shortest)
3151 ((or comint-completion-autolist
3152 (string-equal stub completion))
3153 ;; It's not unique, list possible completions.
3154 (comint-dynamic-list-completions completions stub)
3155 'listed)
3156 (t
3157 (unless minibuffer-p
3158 (message "Partially completed"))
3159 'partial)))))))
3162 (defun comint-dynamic-list-filename-completions ()
3163 "List in help buffer possible completions of the filename at point."
3164 (interactive)
3165 (let* ((completion-ignore-case read-file-name-completion-ignore-case)
3166 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
3167 ;; I think it was originally bound to solve file completion problems,
3168 ;; but subsequent changes may have made this unnecessary. sm.
3169 ;;(file-name-handler-alist nil)
3170 (filename (or (comint-match-partial-filename) ""))
3171 (filedir (file-name-directory filename))
3172 (filenondir (file-name-nondirectory filename))
3173 (directory (if filedir (comint-directory filedir) default-directory))
3174 (completions (file-name-all-completions filenondir directory)))
3175 (if (not completions)
3176 (if (window-minibuffer-p (selected-window))
3177 (minibuffer-message "No completions of %s" filename)
3178 (message "No completions of %s" filename))
3179 (comint-dynamic-list-completions
3180 (mapcar 'comint-quote-filename completions)
3181 (comint-quote-filename filenondir)))))
3184 ;; This is bound locally in a *Completions* buffer to the list of
3185 ;; completions displayed, and is used to detect the case where the same
3186 ;; command is repeatedly used without the set of completions changing.
3187 (defvar comint-displayed-dynamic-completions nil)
3189 (defvar comint-dynamic-list-completions-config nil)
3191 (defun comint-dynamic-list-completions (completions &optional common-substring)
3192 "List in help buffer sorted COMPLETIONS.
3193 The meaning of COMMON-SUBSTRING is the same as in `display-completion-list'.
3194 Typing SPC flushes the help buffer."
3195 (let ((window (get-buffer-window "*Completions*" 0)))
3196 (setq completions (sort completions 'string-lessp))
3197 (if (and (eq last-command this-command)
3198 window (window-live-p window) (window-buffer window)
3199 (buffer-name (window-buffer window))
3200 ;; The above tests are not sufficient to detect the case where we
3201 ;; should scroll, because the top-level interactive command may
3202 ;; not have displayed a completions window the last time it was
3203 ;; invoked, and there may be such a window left over from a
3204 ;; previous completion command with a different set of
3205 ;; completions. To detect that case, we also test that the set
3206 ;; of displayed completions is in fact the same as the previously
3207 ;; displayed set.
3208 (equal completions
3209 (buffer-local-value 'comint-displayed-dynamic-completions
3210 (window-buffer window))))
3211 ;; If this command was repeated, and
3212 ;; there's a fresh completion window with a live buffer,
3213 ;; and this command is repeated, scroll that window.
3214 (with-current-buffer (window-buffer window)
3215 (if (pos-visible-in-window-p (point-max) window)
3216 (set-window-start window (point-min))
3217 (save-selected-window
3218 (select-window window)
3219 (scroll-up))))
3221 ;; Display a completion list for the first time.
3222 (setq comint-dynamic-list-completions-config
3223 (current-window-configuration))
3224 (with-output-to-temp-buffer "*Completions*"
3225 (display-completion-list completions common-substring))
3226 (if (window-minibuffer-p (selected-window))
3227 (minibuffer-message "Type space to flush; repeat completion command to scroll")
3228 (message "Type space to flush; repeat completion command to scroll")))
3230 ;; Read the next key, to process SPC.
3231 (let (key first)
3232 (if (with-current-buffer (get-buffer "*Completions*")
3233 (set (make-local-variable 'comint-displayed-dynamic-completions)
3234 completions)
3235 (setq key (read-key-sequence nil)
3236 first (aref key 0))
3237 (and (consp first) (consp (event-start first))
3238 (eq (window-buffer (posn-window (event-start first)))
3239 (get-buffer "*Completions*"))
3240 (eq (key-binding key) 'mouse-choose-completion)))
3241 ;; If the user does mouse-choose-completion with the mouse,
3242 ;; execute the command, then delete the completion window.
3243 (progn
3244 (choose-completion first)
3245 (set-window-configuration comint-dynamic-list-completions-config))
3246 (if (eq first ?\s)
3247 (set-window-configuration comint-dynamic-list-completions-config)
3248 (setq unread-command-events (listify-key-sequence key)))))))
3250 \f
3251 (defun comint-get-next-from-history ()
3252 "After fetching a line from input history, this fetches the following line.
3253 In other words, this recalls the input line after the line you recalled last.
3254 You can use this to repeat a sequence of input lines."
3255 (interactive)
3256 (if comint-save-input-ring-index
3257 (progn
3258 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
3259 (comint-next-input 1))
3260 (message "No previous history command")))
3262 (defun comint-accumulate ()
3263 "Accumulate a line to send as input along with more lines.
3264 This inserts a newline so that you can enter more text
3266 to send all the accumulated input, at once.
3267 The entire accumulated text becomes one item in the input history
3268 when you send it."
3269 (interactive)
3271 (set-marker comint-accum-marker (point))
3272 (if comint-input-ring-index
3273 (setq comint-save-input-ring-index
3274 (- comint-input-ring-index 1))))
3276 (defun comint-goto-process-mark ()
3277 "Move point to the process mark.
3278 The process mark separates output, and input already sent,
3279 from input that has not yet been sent."
3280 (interactive)
3281 (let ((proc (or (get-buffer-process (current-buffer))
3282 (error "Current buffer has no process"))))
3283 (goto-char (process-mark proc))
3284 (when (called-interactively-p 'interactive)
3285 (message "Point is now at the process mark"))))
3287 (defun comint-bol-or-process-mark ()
3288 "Move point to beginning of line (after prompt) or to the process mark.
3289 The first time you use this command, it moves to the beginning of the line
3290 \(but after the prompt, if any). If you repeat it again immediately,
3291 it moves point to the process mark.
3293 The process mark separates the process output, along with input already sent,
3294 from input that has not yet been sent. Ordinarily, the process mark
3295 is at the beginning of the current input line; but if you have
3297 the process mark is at the beginning of the accumulated input."
3298 (interactive)
3299 (if (not (eq last-command 'comint-bol-or-process-mark))
3300 (comint-bol nil)
3301 (comint-goto-process-mark)))
3303 (defun comint-set-process-mark ()
3304 "Set the process mark at point."
3305 (interactive)
3306 (let ((proc (or (get-buffer-process (current-buffer))
3307 (error "Current buffer has no process"))))
3308 (set-marker (process-mark proc) (point))
3309 (message "Process mark set")))
3311 \f
3312 ;; Author: Peter Breton <pbreton@cs.umb.edu>
3314 ;; This little add-on for comint is intended to make it easy to get
3315 ;; output from currently active comint buffers into another buffer,
3316 ;; or buffers, and then go back to using the comint shell.
3317 ;;
3318 ;; My particular use is SQL interpreters; I want to be able to execute a
3319 ;; query using the process associated with a comint-buffer, and save that
3320 ;; somewhere else. Because the process might have state (for example, it
3321 ;; could be in an uncommitted transaction), just running starting a new
3322 ;; process and having it execute the query and then finish, would not
3323 ;; work. I'm sure there are other uses as well, although in many cases
3324 ;; starting a new process is the simpler, and thus preferable, approach.
3325 ;;
3326 ;; The basic implementation is as follows: comint-redirect changes the
3327 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
3328 ;; its own filter. The filter puts the output into the designated buffer,
3329 ;; or buffers, until it sees a regexp that tells it to stop (by default,
3330 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
3331 ;; sees the stop regexp, it restores the old filter functions, and runs
3332 ;; `comint-redirect-hook'.
3333 ;;
3334 ;; Each comint buffer may only use one redirection at a time, but any number
3335 ;; of different comint buffers may be simultaneously redirected.
3336 ;;
3337 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
3338 ;; correct prompt for your interpreter, or that you supply a regexp that says
3339 ;; when the redirection is finished. Otherwise, redirection will continue
3340 ;; indefinitely. The code now does a sanity check to ensure that it can find
3341 ;; a prompt in the comint buffer; however, it is still important to ensure that
3342 ;; this prompt is set correctly.
3343 ;;
3344 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
3345 ;; perhaps it should prompt for a terminating string (with an
3346 ;; appropriate magic default by examining what we think is the prompt)?
3347 ;;
3348 ;; Fixme: look for appropriate fields, rather than regexp, if
3349 ;; `comint-use-prompt-regexp' is true.
3351 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3352 ;; Variables
3353 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3355 (defcustom comint-redirect-verbose nil
3356 "If non-nil, print messages each time the redirection filter is invoked.
3357 Also print a message when redirection is completed."
3358 :group 'comint
3359 :type 'boolean)
3361 ;; Directly analagous to comint-preoutput-filter-functions
3362 (defvar comint-redirect-filter-functions nil
3363 "List of functions to call before inserting redirected process output.
3364 Each function gets one argument, a string containing the text received
3365 from the subprocess. It should return the string to insert, perhaps
3366 the same string that was received, or perhaps a modified or transformed
3367 string.
3369 The functions on the list are called sequentially, and each one is given
3370 the string returned by the previous one. The string returned by the
3371 last function is the text that is actually inserted in the redirection buffer.
3373 You can use `add-hook' to add functions to this list
3374 either globally or locally.")
3376 ;; Internal variables
3378 (defvar comint-redirect-output-buffer nil
3379 "The buffer or list of buffers to put output into.")
3381 (defvar comint-redirect-finished-regexp nil
3382 "Regular expression that determines when to stop redirection in Comint.
3383 When the redirection filter function is given output that matches this regexp,
3384 the output is inserted as usual, and redirection is completed.")
3386 (defvar comint-redirect-insert-matching-regexp nil
3387 "If non-nil, the text that ends a redirection is included in it.
3388 More precisely, the text that matches `comint-redirect-finished-regexp'
3389 and therefore terminates an output redirection is inserted in the
3390 redirection target buffer, along with the preceding output.")
3392 (defvar comint-redirect-echo-input nil
3393 "Non-nil means echo input in the process buffer even during redirection.")
3395 (defvar comint-redirect-completed nil
3396 "Non-nil if redirection has completed in the current buffer.")
3398 (defvar comint-redirect-original-mode-line-process nil
3399 "Original mode line for redirected process.")
3401 (defvar comint-redirect-perform-sanity-check t
3402 "If non-nil, check that redirection is likely to complete successfully.
3403 More precisely, before starting a redirection, verify that the
3404 regular expression `comint-redirect-finished-regexp' that controls
3405 when to terminate it actually matches some text already in the process
3406 buffer. The idea is that this regular expression should match a prompt
3407 string, and that there ought to be at least one copy of your prompt string
3408 in the process buffer already.")
3410 (defvar comint-redirect-original-filter-function nil
3411 "The process filter that was in place when redirection is started.
3412 When redirection is completed, the process filter is restored to
3413 this value.")
3415 (defvar comint-redirect-subvert-readonly nil
3416 "Non-nil means `comint-redirect' can insert into read-only buffers.
3417 This works by binding `inhibit-read-only' around the insertion.
3418 This is useful, for instance, for insertion into Help mode buffers.
3419 You probably want to set it locally to the output buffer.")
3421 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3422 ;; Functions
3423 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3425 (defun comint-redirect-setup (output-buffer
3426 comint-buffer
3427 finished-regexp
3428 &optional echo-input)
3429 "Set up for output redirection.
3430 This function sets local variables that are used by `comint-redirect-filter'
3431 to perform redirection.
3433 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3434 in the output matches FINISHED-REGEXP.
3436 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3437 original Comint buffer.
3439 This function is called by `comint-redirect-send-command-to-process',
3440 and does not normally need to be invoked by the end user or programmer."
3441 (with-current-buffer comint-buffer
3443 (make-local-variable 'comint-redirect-original-mode-line-process)
3444 (setq comint-redirect-original-mode-line-process mode-line-process)
3446 (make-local-variable 'comint-redirect-output-buffer)
3447 (setq comint-redirect-output-buffer output-buffer)
3449 (make-local-variable 'comint-redirect-finished-regexp)
3450 (setq comint-redirect-finished-regexp finished-regexp)
3452 (make-local-variable 'comint-redirect-echo-input)
3453 (setq comint-redirect-echo-input echo-input)
3455 (make-local-variable 'comint-redirect-completed)
3456 (setq comint-redirect-completed nil)
3458 (setq mode-line-process
3459 (if mode-line-process
3460 (list (concat (elt mode-line-process 0) " Redirection"))
3461 (list ":%s Redirection")))))
3463 (defun comint-redirect-cleanup ()
3464 "End a Comint redirection. See `comint-redirect-send-command'."
3465 (interactive)
3466 ;; Restore the process filter
3467 (set-process-filter (get-buffer-process (current-buffer))
3468 comint-redirect-original-filter-function)
3469 ;; Restore the mode line
3470 (setq mode-line-process comint-redirect-original-mode-line-process)
3471 ;; Set the completed flag
3472 (setq comint-redirect-completed t))
3474 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3475 ;; that it really occurs.
3476 (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
3478 (defun comint-redirect-filter (process input-string)
3479 "Filter function which redirects output from PROCESS to a buffer or buffers.
3480 The variable `comint-redirect-output-buffer' says which buffer(s) to
3481 place output in.
3483 INPUT-STRING is the input from the Comint process.
3485 This function runs as a process filter, and does not need to be invoked by the
3486 end user."
3487 (and process
3488 (with-current-buffer (process-buffer process)
3489 (comint-redirect-preoutput-filter input-string)
3490 ;; If we have to echo output, give it to the original filter function
3491 (and comint-redirect-echo-input
3492 comint-redirect-original-filter-function
3493 (funcall comint-redirect-original-filter-function
3494 process input-string)))))
3497 (defun comint-redirect-preoutput-filter (input-string)
3498 "Comint filter function which redirects Comint output to a buffer or buffers.
3499 The variable `comint-redirect-output-buffer' says which buffer(s) to
3500 place output in.
3502 INPUT-STRING is the input from the Comint process.
3504 This function does not need to be invoked by the end user."
3505 (let ((output-buffer-list
3506 (if (listp comint-redirect-output-buffer)
3507 comint-redirect-output-buffer
3508 (list comint-redirect-output-buffer)))
3509 (filtered-input-string input-string))
3511 ;; If there are any filter functions, give them a chance to modify
3512 ;; the string.
3513 (let ((functions comint-redirect-filter-functions))
3514 (while (and functions filtered-input-string)
3515 (if (eq (car functions) t)
3516 ;; If a local value says "use the default value too",
3517 ;; do that.
3518 (let ((functions
3519 (default-value 'comint-redirect-filter-functions)))
3520 (while (and functions filtered-input-string)
3521 (setq filtered-input-string
3522 (funcall (car functions) filtered-input-string))
3523 (setq functions (cdr functions))))
3524 (setq filtered-input-string
3525 (funcall (car functions) filtered-input-string)))
3526 (setq functions (cdr functions))))
3528 ;; Clobber `comint-redirect-finished-regexp'
3529 (or comint-redirect-insert-matching-regexp
3530 (and (string-match comint-redirect-finished-regexp filtered-input-string)
3531 (setq filtered-input-string
3532 (replace-match "" nil nil filtered-input-string))))
3534 ;; Send output to all registered buffers
3535 (save-excursion
3536 (dolist (buf output-buffer-list)
3537 ;; Set this buffer to the output buffer
3538 (set-buffer (get-buffer-create buf))
3539 ;; Go to the end of the buffer
3540 (goto-char (point-max))
3541 ;; Insert the output
3542 (let ((inhibit-read-only comint-redirect-subvert-readonly))
3543 (insert filtered-input-string))))
3545 ;; Message
3546 (and comint-redirect-verbose
3547 (message "Redirected output to buffer(s) %s"
3548 (mapconcat 'identity output-buffer-list " ")))
3550 ;; If we see the prompt, tidy up
3551 ;; We'll look for the prompt in the original string, so nobody can
3552 ;; clobber it
3553 (and (string-match comint-redirect-finished-regexp input-string)
3554 (progn
3555 (and comint-redirect-verbose
3556 (message "Redirection completed"))
3557 (comint-redirect-cleanup)
3558 (run-hooks 'comint-redirect-hook)))
3559 ;; Echo input?
3560 (if comint-redirect-echo-input
3561 filtered-input-string
3562 "")))
3564 ;;;###autoload
3565 (defun comint-redirect-send-command (command output-buffer echo &optional no-display)
3566 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3567 With prefix arg ECHO, echo output in process buffer.
3569 If NO-DISPLAY is non-nil, do not show the output buffer."
3571 (let ((process (get-buffer-process (current-buffer))))
3572 (if process
3573 (comint-redirect-send-command-to-process
3574 command output-buffer (current-buffer) echo no-display)
3575 (error "No process for current buffer"))))
3577 ;;;###autoload
3578 (defun comint-redirect-send-command-to-process
3579 (command output-buffer process echo &optional no-display)
3580 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3581 With prefix arg, echo output in process buffer.
3583 If NO-DISPLAY is non-nil, do not show the output buffer."
3585 (let* (;; The process buffer
3586 (process-buffer (if (processp process)
3587 (process-buffer process)
3588 process))
3589 (proc (get-buffer-process process-buffer)))
3590 ;; Change to the process buffer
3591 (with-current-buffer process-buffer
3593 ;; Make sure there's a prompt in the current process buffer
3594 (and comint-redirect-perform-sanity-check
3595 (save-excursion
3596 (goto-char (point-max))
3597 (or (re-search-backward comint-prompt-regexp nil t)
3598 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3600 ;; Set up for redirection
3601 (comint-redirect-setup
3602 output-buffer
3603 (current-buffer) ; Comint Buffer
3604 comint-prompt-regexp ; Finished Regexp
3605 echo) ; Echo input
3607 ;; Set the filter
3608 (setq comint-redirect-original-filter-function ; Save the old filter
3609 (process-filter proc))
3610 (set-process-filter proc 'comint-redirect-filter)
3612 ;; Send the command
3615 ;; Show the output
3616 (or no-display
3617 (display-buffer
3618 (get-buffer-create
3619 (if (listp output-buffer)
3620 (car output-buffer)
3621 output-buffer)))))))
3623 ;;;###autoload
3624 (defun comint-redirect-results-list (command regexp regexp-group)
3625 "Send COMMAND to current process.
3626 Return a list of expressions in the output which match REGEXP.
3627 REGEXP-GROUP is the regular expression group in REGEXP to use."
3628 (comint-redirect-results-list-from-process
3629 (get-buffer-process (current-buffer))
3630 command regexp regexp-group))
3632 ;;;###autoload
3633 (defun comint-redirect-results-list-from-process (process command regexp regexp-group)
3634 "Send COMMAND to PROCESS.
3635 Return a list of expressions in the output which match REGEXP.
3636 REGEXP-GROUP is the regular expression group in REGEXP to use."
3637 (let ((output-buffer " *Comint Redirect Work Buffer*")
3638 results)
3639 (with-current-buffer (get-buffer-create output-buffer)
3640 (erase-buffer)
3641 (comint-redirect-send-command-to-process command
3642 output-buffer process nil t)
3643 ;; Wait for the process to complete
3644 (set-buffer (process-buffer process))
3645 (while (null comint-redirect-completed)
3646 (accept-process-output nil 1))
3647 ;; Collect the output
3648 (set-buffer output-buffer)
3649 (goto-char (point-min))
3650 ;; Skip past the command, if it was echoed
3651 (and (looking-at command)
3652 (forward-line))
3653 (while (re-search-forward regexp nil t)
3654 (push (buffer-substring-no-properties
3655 (match-beginning regexp-group)
3656 (match-end regexp-group))
3657 results))
3658 results)))
3660 (dolist (x '("^Not at command line$"
3661 "^Empty input ring$"
3662 "^No history$"
3663 "^Not found$" ; Too common?
3664 "^Current buffer has no process$"))
3665 (add-to-list 'debug-ignored-errors x))
3667 \f
3668 ;; Converting process modes to use comint mode
3669 ;; ===========================================================================
3670 ;; The code in the Emacs 19 distribution has all been modified to use comint
3671 ;; where needed. However, there are `third-party' packages out there that
3672 ;; still use the old shell mode. Here's a guide to conversion.
3673 ;;
3674 ;; Renaming variables
3675 ;; Most of the work is renaming variables and functions. These are the common
3676 ;; ones:
3677 ;; Local variables:
3678 ;; last-input-start comint-last-input-start
3679 ;; last-input-end comint-last-input-end
3680 ;; shell-prompt-pattern comint-prompt-regexp
3681 ;; shell-set-directory-error-hook <no equivalent>
3682 ;; Miscellaneous:
3683 ;; shell-set-directory <unnecessary>
3684 ;; shell-mode-map comint-mode-map
3685 ;; Commands:
3686 ;; shell-send-input comint-send-input
3687 ;; shell-send-eof comint-delchar-or-maybe-eof
3688 ;; kill-shell-input comint-kill-input
3689 ;; interrupt-shell-subjob comint-interrupt-subjob
3690 ;; stop-shell-subjob comint-stop-subjob
3691 ;; quit-shell-subjob comint-quit-subjob
3692 ;; kill-shell-subjob comint-kill-subjob
3693 ;; kill-output-from-shell comint-delete-output
3694 ;; show-output-from-shell comint-show-output
3695 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3696 ;;
3697 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3698 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3699 ;; Comint mode does not provide functionality equivalent to
3700 ;; shell-set-directory-error-hook; it is gone.
3701 ;;
3702 ;; comint-last-input-start is provided for modes which want to munge
3703 ;; the buffer after input is sent, perhaps because the inferior
3704 ;; insists on echoing the input. The LAST-INPUT-START variable in
3705 ;; the old shell package was used to implement a history mechanism,
3706 ;; but you should think twice before using comint-last-input-start
3707 ;; for this; the input history ring often does the job better.
3708 ;;
3709 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3710 ;; *not* create the comint-mode local variables in your foo-mode function.
3711 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3712 ;; necessary comint-specific local variables. Then create the
3713 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3714 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3715 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3716 ;; get-old-input) that need to be different from the defaults. Call
3717 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3718 ;; comint-mode will take care of it. The following example, from shell.el,
3719 ;; is typical:
3720 ;;
3721 ;; (defvar shell-mode-map '())
3722 ;; (cond ((not shell-mode-map)
3723 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3724 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3725 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3727 ;; (define-key shell-mode-map "\M-?"
3728 ;; 'comint-dynamic-list-filename-completions)))
3729 ;;
3730 ;; (defun shell-mode ()
3731 ;; (interactive)
3732 ;; (comint-mode)
3733 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3734 ;; (setq major-mode 'shell-mode)
3735 ;; (setq mode-name "Shell")
3736 ;; (use-local-map shell-mode-map)
3737 ;; (make-local-variable 'shell-directory-stack)
3738 ;; (setq shell-directory-stack nil)
3739 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3740 ;; (run-mode-hooks 'shell-mode-hook))
3741 ;;
3742 ;;
3743 ;; Completion for comint-mode users
3744 ;;
3745 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3746 ;; hook to add completion functions to. Functions on this list should return
3747 ;; non-nil if completion occurs (i.e., further completion should not occur).
3748 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3749 ;; completion job.
3750 \f
3752 (provide 'comint)
3754 ;;; comint.el ends here