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