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