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