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