| blob | e4ee37c50f9504aa28abfbeb04f22fe083c84727 |
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 Free Software Foundation, Inc.
6 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
7 ;; Simon Marshall <simon@gnu.org>
8 ;; Maintainer: FSF
9 ;; Keywords: processes
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 3, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
28 ;;; Commentary:
30 ;; This file defines a general command-interpreter-in-a-buffer package
31 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
32 ;; modes on top of comint mode -- e.g., Lisp, shell, scheme, T, soar, ....
33 ;; This way, all these specific packages share a common base functionality,
34 ;; and a common set of bindings, which makes them easier to use (and
35 ;; saves code, implementation time, etc., etc.).
37 ;; Several packages are already defined using comint mode:
38 ;; - shell.el defines a shell-in-a-buffer mode.
39 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
40 ;;
41 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
42 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
43 ;; - The file soar.el tunes Lisp and inferior-lisp modes for Soar.
44 ;; - cmutex.el defines TeX and LaTeX modes that invoke TeX, LaTeX, BibTeX,
45 ;; previewers, and printers from within Emacs.
46 ;; - background.el allows csh-like job control inside Emacs.
47 ;; It is pretty easy to make new derived modes for other processes.
49 ;; For documentation on the functionality provided by Comint mode, and
50 ;; the hooks available for customising it, see the comments below.
51 ;; For further information on the standard derived modes (shell,
52 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
54 ;; For hints on converting existing process modes (e.g., tex-mode,
55 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
56 ;; instead of shell-mode, see the notes at the end of this file.
58 \f
59 ;; Brief Command Documentation:
60 ;;============================================================================
61 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
62 ;; mode)
63 ;;
64 ;; M-p comint-previous-input Cycle backwards in input history
65 ;; M-n comint-next-input Cycle forwards
66 ;; M-r comint-previous-matching-input Previous input matching a regexp
67 ;; M-s comint-next-matching-input Next input that matches
68 ;; M-C-l comint-show-output Show last batch of process output
69 ;; RET comint-send-input
70 ;; C-d comint-delchar-or-maybe-eof Delete char unless at end of buff
71 ;; C-c C-a comint-bol-or-process-mark First time, move point to bol;
72 ;; second time, move to process-mark.
73 ;; C-c C-u comint-kill-input ^u
74 ;; C-c C-w backward-kill-word ^w
75 ;; C-c C-c comint-interrupt-subjob ^c
76 ;; C-c C-z comint-stop-subjob ^z
77 ;; C-c C-\ comint-quit-subjob ^\
78 ;; C-c C-o comint-delete-output Delete last batch of process output
79 ;; C-c C-r comint-show-output Show last batch of process output
80 ;; C-c C-l comint-dynamic-list-input-ring List input history
81 ;;
82 ;; Not bound by default in comint-mode (some are in shell mode)
83 ;; comint-run Run a program under comint-mode
84 ;; send-invisible Read a line w/o echo, and send to proc
85 ;; comint-dynamic-complete-filename Complete filename at point.
86 ;; comint-dynamic-list-filename-completions List completions in help buffer.
87 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
88 ;; replace with expanded/completed name.
89 ;; comint-replace-by-expanded-history Expand history at point;
90 ;; replace with expanded name.
91 ;; comint-magic-space Expand history and add (a) space(s).
92 ;; comint-kill-subjob No mercy.
93 ;; comint-show-maximum-output Show as much output as possible.
94 ;; comint-continue-subjob Send CONT signal to buffer's process
95 ;; group. Useful if you accidentally
96 ;; suspend your process (with C-c C-z).
97 ;; comint-get-next-from-history Fetch successive input history lines
98 ;; comint-accumulate Combine lines to send them together
99 ;; as input.
100 ;; comint-goto-process-mark Move point to where process-mark is.
101 ;; comint-set-process-mark Set process-mark to point.
103 ;; comint-mode-hook is the Comint mode hook. Basically for your keybindings.
105 ;;; Code:
108 \f
109 ;; Buffer Local Variables:
110 ;;============================================================================
111 ;; Comint mode buffer local variables:
112 ;; comint-prompt-regexp string comint-bol uses to match prompt
113 ;; comint-delimiter-argument-list list For delimiters and arguments
114 ;; comint-last-input-start marker Handy if inferior always echoes
115 ;; comint-last-input-end marker For comint-delete-output command
116 ;; comint-input-ring-size integer For the input history
117 ;; comint-input-ring ring mechanism
118 ;; comint-input-ring-index number ...
119 ;; comint-save-input-ring-index number ...
120 ;; comint-input-autoexpand symbol ...
121 ;; comint-input-ignoredups boolean ...
122 ;; comint-dynamic-complete-functions hook For the completion mechanism
123 ;; comint-completion-fignore list ...
124 ;; comint-file-name-chars string ...
125 ;; comint-file-name-quote-list list ...
126 ;; comint-get-old-input function Hooks for specific
127 ;; comint-input-filter-functions hook process-in-a-buffer
128 ;; comint-output-filter-functions hook function modes.
129 ;; comint-preoutput-filter-functions hook
130 ;; comint-input-filter function ...
131 ;; comint-input-sender function ...
132 ;; comint-eol-on-send boolean ...
133 ;; comint-process-echoes boolean ...
134 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
135 ;; comint-move-point-for-output symbol ...
136 ;; comint-scroll-show-maximum-output boolean ...
137 ;; comint-accum-marker maker For comint-accumulate
138 ;;
139 ;; Comint mode non-buffer local variables:
140 ;; comint-completion-addsuffix boolean/cons For file name
141 ;; comint-completion-autolist boolean completion behavior
142 ;; comint-completion-recexact boolean ...
145 "General command interpreter in a window stuff."
149 "Completion facilities in comint."
153 "Source finding facilities in comint."
158 "Regexp to recognize prompts in the inferior process.
161 This variable is only used if the variable
162 `comint-use-prompt-regexp' is non-nil.
164 Good choices:
175 "If non-nil, the comint prompt is read only.
176 The read only region includes the newline before the prompt.
177 This does not affect existing prompts.
178 Certain derived modes may override this option.
180 If you set this option to t, then the safe way to temporarily
181 override the read-only-ness of comint prompts is to call
182 `comint-kill-whole-line' or `comint-kill-region' with no
183 narrowing in effect. This way you will be certain that none of
184 the remaining prompts will be accidentally messed up. You may
185 wish to put something like the following in your `.emacs' file:
187 \(add-hook 'comint-mode-hook
188 (lambda ()
190 (define-key comint-mode-map [C-S-backspace]
191 'comint-kill-whole-line)))
193 If you sometimes use comint-mode on text-only terminals or with `emacs -nw',
194 you might wish to use another binding for `comint-kill-whole-line'."
200 "List of characters to recognize as separate arguments in input.
201 Strings comprising a character in this list will separate the arguments
202 surrounding them, and also be regarded as arguments in their own right (unlike
203 whitespace). See `comint-arguments'.
204 Defaults to the empty list.
211 "*If non-nil, expand input command history references on completion.
212 This mirrors the optional behavior of tcsh (its autoexpand and histlist).
214 If the value is `input', then the expansion is seen on input.
215 If the value is `history', then the expansion is only when inserting
216 into the buffer's input ring. See also `comint-magic-space' and
217 `comint-dynamic-complete'.
219 This variable is buffer-local."
227 "Face to use to highlight user input."
234 "Face to use to highlight prompts."
238 "*If non-nil, don't add input matching the last on the input ring.
239 This mirrors the optional behavior of bash.
241 This variable is buffer-local."
246 "*If non-nil, name of the file to read/write input history.
247 See also `comint-read-input-ring' and `comint-write-input-ring'.
249 This variable is buffer-local, and is a good thing to set in mode hooks."
251 file)
255 "*Controls whether input to interpreter causes window to scroll.
256 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
257 If `this', scroll only the selected window.
259 The default is nil.
261 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
269 "*Controls whether interpreter output moves point to the end of the output.
270 If nil, then output never moves point to the output.
271 (If the output occurs at point, it is inserted before point.)
272 If t or `all', move point in all windows showing the buffer.
273 If `this', move point only the selected window.
274 If `others', move point only in other windows, not in the selected window.
276 The default is nil.
278 See the variable `comint-scroll-show-maximum-output' and the function
279 `comint-postoutput-scroll-to-bottom'.
280 This variable is buffer-local in all Comint buffers."
291 "*Controls how to scroll due to interpreter output.
292 This variable applies when point is at the end of the buffer
293 \(either because it was originally there, or because
294 `comint-move-point-for-output' said to move it there)
295 and output from the subprocess is inserted.
297 Non-nil means scroll so that the window is full of text
298 and point is on the last line. A value of nil
299 means don't do anything special--scroll normally.
301 See also the variable `comint-move-point-for-output' and the function
302 `comint-postoutput-scroll-to-bottom'.
303 This variable is buffer-local in all Comint buffers."
308 "*The maximum size in lines for Comint buffers.
309 Comint buffers are truncated from the top to be no greater than this number, if
310 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
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:
456 ;; The following two are standardly aliased to C-d,
457 ;; but they should never do EOF, just delete.
459 (define-key map [kp-delete] 'delete-char)
460 (define-key map "\C-c " 'comint-accumulate)
461 (define-key map "\C-c\C-x" 'comint-get-next-from-history)
462 (define-key map "\C-c\C-a" 'comint-bol-or-process-mark)
463 (define-key map "\C-c\C-u" 'comint-kill-input)
464 (define-key map "\C-c\C-w" 'backward-kill-word)
465 (define-key map "\C-c\C-c" 'comint-interrupt-subjob)
466 (define-key map "\C-c\C-z" 'comint-stop-subjob)
468 (define-key map "\C-c\C-m" 'comint-copy-old-input)
469 (define-key map "\C-c\C-o" 'comint-delete-output)
470 (define-key map "\C-c\C-r" 'comint-show-output)
471 (define-key map "\C-c\C-e" 'comint-show-maximum-output)
472 (define-key map "\C-c\C-l" 'comint-dynamic-list-input-ring)
473 (define-key map "\C-c\C-n" 'comint-next-prompt)
474 (define-key map "\C-c\C-p" 'comint-previous-prompt)
475 (define-key map "\C-c\C-d" 'comint-send-eof)
476 (define-key map "\C-c\C-s" 'comint-write-output)
477 (define-key map "\C-c." 'comint-insert-previous-argument)
478 ;; Mouse Buttons:
479 (define-key map [mouse-2] 'comint-insert-input)
480 ;; Menu bars:
481 ;; completion:
482 (define-key map [menu-bar completion]
483 (cons "Complete" (make-sparse-keymap "Complete")))
484 (define-key map [menu-bar completion complete-expand]
485 '("Expand File Name" . comint-replace-by-expanded-filename))
486 (define-key map [menu-bar completion complete-listing]
487 '("File Completion Listing" . comint-dynamic-list-filename-completions))
488 (define-key map [menu-bar completion complete-file]
489 '("Complete File Name" . comint-dynamic-complete-filename))
490 (define-key map [menu-bar completion complete]
491 '("Complete Before Point" . comint-dynamic-complete))
492 ;; Input history:
493 (define-key map [menu-bar inout]
494 (cons "In/Out" (make-sparse-keymap "In/Out")))
495 (define-key map [menu-bar inout delete-output]
496 '("Delete Current Output Group" . comint-delete-output))
497 (define-key map [menu-bar inout append-output-to-file]
498 '("Append Current Output Group to File" . comint-append-output-to-file))
499 (define-key map [menu-bar inout write-output]
500 '("Write Current Output Group to File" . comint-write-output))
501 (define-key map [menu-bar inout next-prompt]
502 '("Forward Output Group" . comint-next-prompt))
503 (define-key map [menu-bar inout previous-prompt]
504 '("Backward Output Group" . comint-previous-prompt))
505 (define-key map [menu-bar inout show-maximum-output]
506 '("Show Maximum Output" . comint-show-maximum-output))
507 (define-key map [menu-bar inout show-output]
508 '("Show Current Output Group" . comint-show-output))
509 (define-key map [menu-bar inout kill-input]
510 '("Kill Current Input" . comint-kill-input))
511 (define-key map [menu-bar inout copy-input]
512 '("Copy Old Input" . comint-copy-old-input))
513 (define-key map [menu-bar inout forward-matching-history]
514 '("Forward Matching Input..." . comint-forward-matching-input))
515 (define-key map [menu-bar inout backward-matching-history]
516 '("Backward Matching Input..." . comint-backward-matching-input))
517 (define-key map [menu-bar inout next-matching-history]
518 '("Next Matching Input..." . comint-next-matching-input))
519 (define-key map [menu-bar inout previous-matching-history]
520 '("Previous Matching Input..." . comint-previous-matching-input))
521 (define-key map [menu-bar inout next-matching-history-from-input]
522 '("Next Matching Current Input" . comint-next-matching-input-from-input))
523 (define-key map [menu-bar inout previous-matching-history-from-input]
524 '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
525 (define-key map [menu-bar inout next-history]
526 '("Next Input" . comint-next-input))
527 (define-key map [menu-bar inout previous-history]
528 '("Previous Input" . comint-previous-input))
529 (define-key map [menu-bar inout list-history]
530 '("List Input History" . comint-dynamic-list-input-ring))
531 (define-key map [menu-bar inout expand-history]
532 '("Expand History Before Point" . comint-replace-by-expanded-history))
533 ;; Signals
534 (let ((signals-map (make-sparse-keymap "Signals")))
535 (define-key map [menu-bar signals] (cons "Signals" signals-map))
536 (define-key signals-map [eof] '("EOF" . comint-send-eof))
537 (define-key signals-map [kill] '("KILL" . comint-kill-subjob))
538 (define-key signals-map [quit] '("QUIT" . comint-quit-subjob))
539 (define-key signals-map [cont] '("CONT" . comint-continue-subjob))
540 (define-key signals-map [stop] '("STOP" . comint-stop-subjob))
541 (define-key signals-map [break] '("BREAK" . comint-interrupt-subjob)))
542 ;; Put them in the menu bar:
543 (setq menu-bar-final-items (append '(completion inout signals)
544 menu-bar-final-items))
545 map))
547 ;; Fixme: Is this still relevant?
548 (defvar comint-ptyp t
549 "Non-nil if communications via pty; false if by pipe. Buffer local.
550 This is to work around a bug in Emacs process signaling.")
552 (defvar comint-input-ring nil)
553 (defvar comint-last-input-start nil)
554 (defvar comint-last-input-end nil)
555 (defvar comint-last-output-start nil)
556 (defvar comint-input-ring-index nil
557 "Index of last matched history element.")
558 (defvar comint-matching-input-from-input-string ""
559 "Input previously used to match input history.")
560 (defvar comint-save-input-ring-index
561 "Last input ring index which you copied.
564 (defvar comint-accum-marker nil
565 "Non-nil if you are accumulating input lines to send as input together.
568 (defvar comint-stored-incomplete-input nil
569 "Stored input for history cycling.")
571 (put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
572 (put 'comint-input-ring 'permanent-local t)
573 (put 'comint-input-ring-index 'permanent-local t)
574 (put 'comint-save-input-ring-index 'permanent-local t)
575 (put 'comint-input-autoexpand 'permanent-local t)
576 (put 'comint-input-filter-functions 'permanent-local t)
577 (put 'comint-output-filter-functions 'permanent-local t)
578 (put 'comint-preoutput-filter-functions 'permanent-local t)
579 (put 'comint-scroll-to-bottom-on-input 'permanent-local t)
580 (put 'comint-move-point-for-output 'permanent-local t)
581 (put 'comint-scroll-show-maximum-output 'permanent-local t)
582 (put 'comint-ptyp 'permanent-local t)
584 (put 'comint-mode 'mode-class 'special)
586 (define-derived-mode comint-mode fundamental-mode "Comint"
587 "Major mode for interacting with an inferior interpreter.
588 Interpreter name is same as buffer name, sans the asterisks.
589 Return at end of buffer sends line as input.
590 Return not at end copies rest of line to end and sends it.
591 Setting variable `comint-eol-on-send' means jump to the end of the line
592 before submitting new input.
594 This mode is customized to create major modes such as Inferior Lisp
595 mode, Shell mode, etc. This can be done by setting the hooks
596 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
597 and `comint-get-old-input' to appropriate functions, and the variable
598 `comint-prompt-regexp' to the appropriate regular expression.
600 An input history is maintained of size `comint-input-ring-size', and
601 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
602 Input ring history expansion can be achieved with the commands
604 Input ring expansion is controlled by the variable `comint-input-autoexpand',
605 and addition is controlled by the variable `comint-input-ignoredups'.
607 Commands with no default key bindings include `send-invisible',
608 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
609 `comint-magic-space'.
611 Input to, and output from, the subprocess can cause the window to scroll to
612 the end of the buffer. See variables `comint-output-filter-functions',
613 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
614 and `comint-move-point-for-output'.
617 to continue it.
621 Entry to this mode runs the hooks on `comint-mode-hook'."
622 (setq mode-line-process '(":%s"))
623 (set (make-local-variable 'comint-last-input-start) (point-min-marker))
624 (set (make-local-variable 'comint-last-input-end) (point-min-marker))
625 (set (make-local-variable 'comint-last-output-start) (make-marker))
626 (make-local-variable 'comint-last-prompt-overlay)
627 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
628 (make-local-variable 'comint-input-ring-size) ; ...to global val.
629 (make-local-variable 'comint-input-ring)
630 (make-local-variable 'comint-input-ring-file-name)
631 (or (and (boundp 'comint-input-ring) comint-input-ring)
632 (setq comint-input-ring (make-ring comint-input-ring-size)))
633 (make-local-variable 'comint-input-ring-index)
634 (make-local-variable 'comint-save-input-ring-index)
635 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
636 (setq comint-input-ring-index nil))
637 (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
638 (setq comint-save-input-ring-index nil))
639 (make-local-variable 'comint-matching-input-from-input-string)
640 (make-local-variable 'comint-input-autoexpand)
641 (make-local-variable 'comint-input-ignoredups)
642 (make-local-variable 'comint-delimiter-argument-list)
643 (make-local-variable 'comint-completion-fignore)
644 (make-local-variable 'comint-get-old-input)
645 (make-local-variable 'comint-input-filter)
646 (make-local-variable 'comint-input-sender)
647 (make-local-variable 'comint-eol-on-send)
648 (make-local-variable 'comint-scroll-to-bottom-on-input)
649 (make-local-variable 'comint-move-point-for-output)
650 (make-local-variable 'comint-scroll-show-maximum-output)
651 (make-local-variable 'comint-stored-incomplete-input)
652 ;; Following disabled because it seems to break the case when
653 ;; comint-scroll-show-maximum-output is nil, and no-one can remember
654 ;; what the original problem was. If there are problems with point
655 ;; not going to the end, consider re-enabling this.
656 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00827.html
657 ;;
658 ;; This makes it really work to keep point at the bottom.
659 ;;; (make-local-variable 'scroll-conservatively)
660 ;;; (setq scroll-conservatively 10000)
661 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
662 (make-local-variable 'comint-ptyp)
663 (make-local-variable 'comint-process-echoes)
664 (make-local-variable 'comint-file-name-chars)
665 (make-local-variable 'comint-file-name-quote-list)
666 (make-local-variable 'comint-accum-marker)
667 (setq comint-accum-marker (make-marker))
668 (make-local-variable 'font-lock-defaults)
669 (setq font-lock-defaults '(nil t))
670 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
671 ;; This behavior is not useful in comint buffers, and is annoying
672 (set (make-local-variable 'next-line-add-newlines) nil))
674 (defun comint-check-proc (buffer)
675 "Return non-nil if there is a living process associated w/buffer BUFFER.
676 Living means the status is `open', `run', or `stop'.
677 BUFFER can be either a buffer or the name of one."
678 (let ((proc (get-buffer-process buffer)))
679 (and proc (memq (process-status proc) '(open run stop)))))
681 ;;;###autoload
682 (defun make-comint-in-buffer (name buffer program &optional startfile &rest switches)
683 "Make a Comint process NAME in BUFFER, running PROGRAM.
684 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
685 PROGRAM should be either a string denoting an executable program to create
686 via `start-file-process', or a cons pair of the form (HOST . SERVICE) denoting
687 a TCP connection to be opened via `open-network-stream'. If there is already
688 a running process in that buffer, it is not restarted. Optional fourth arg
689 STARTFILE is the name of a file to send the contents of to the process.
691 If PROGRAM is a string, any more args are arguments to PROGRAM."
692 (or (fboundp 'start-file-process)
693 (error "Multi-processing is not supported for this system"))
694 (setq buffer (get-buffer-create (or buffer (concat "*" name "*"))))
695 ;; If no process, or nuked process, crank up a new one and put buffer in
696 ;; comint mode. Otherwise, leave buffer and existing process alone.
697 (unless (comint-check-proc buffer)
698 (with-current-buffer buffer
699 (unless (derived-mode-p 'comint-mode)
700 (comint-mode))) ; Install local vars, mode, keymap, ...
701 (comint-exec buffer name program startfile switches))
702 buffer)
704 ;;;###autoload
705 (defun make-comint (name program &optional startfile &rest switches)
706 "Make a Comint process NAME in a buffer, running PROGRAM.
707 The name of the buffer is made by surrounding NAME with `*'s.
708 PROGRAM should be either a string denoting an executable program to create
709 via `start-file-process', or a cons pair of the form (HOST . SERVICE) denoting
710 a TCP connection to be opened via `open-network-stream'. If there is already
711 a running process in that buffer, it is not restarted. Optional third arg
712 STARTFILE is the name of a file to send the contents of the process to.
714 If PROGRAM is a string, any more args are arguments to PROGRAM."
715 (apply #'make-comint-in-buffer name nil program startfile switches))
717 ;;;###autoload
718 (defun comint-run (program)
719 "Run PROGRAM in a Comint buffer and switch to it.
720 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
721 The file name is used to make a symbol name, such as `comint-sh-hook', and any
722 hooks on this symbol are run in the buffer.
723 See `make-comint' and `comint-exec'."
724 (interactive "sRun program: ")
725 (let ((name (file-name-nondirectory program)))
726 (switch-to-buffer (make-comint name program))
727 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
729 (defun comint-exec (buffer name command startfile switches)
730 "Start up a process named NAME in buffer BUFFER for Comint modes.
731 Runs the given COMMAND with SWITCHES with output to STARTFILE.
732 Blasts any old process running in the buffer. Doesn't set the buffer mode.
733 You can use this to cheaply run a series of processes in the same Comint
734 buffer. The hook `comint-exec-hook' is run after each exec."
735 (with-current-buffer buffer
736 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
737 (if proc (delete-process proc)))
738 ;; Crank up a new process
739 (let ((proc
740 (if (consp command)
741 (open-network-stream name buffer (car command) (cdr command))
742 (comint-exec-1 name buffer command switches))))
743 (set-process-filter proc 'comint-output-filter)
744 (make-local-variable 'comint-ptyp)
745 (setq comint-ptyp process-connection-type) ; t if pty, nil if pipe.
746 ;; Jump to the end, and set the process mark.
747 (goto-char (point-max))
748 (set-marker (process-mark proc) (point))
749 ;; Feed it the startfile.
750 (cond (startfile
751 ;;This is guaranteed to wait long enough
752 ;;but has bad results if the comint does not prompt at all
753 ;; (while (= size (buffer-size))
754 ;; (sleep-for 1))
755 ;;I hope 1 second is enough!
756 (sleep-for 1)
757 (goto-char (point-max))
758 (insert-file-contents startfile)
759 (setq startfile (buffer-substring (point) (point-max)))
760 (delete-region (point) (point-max))
761 (comint-send-string proc startfile)))
762 (run-hooks 'comint-exec-hook)
763 buffer)))
765 ;; This auxiliary function cranks up the process for comint-exec in
766 ;; the appropriate environment.
768 (defun comint-exec-1 (name buffer command switches)
769 (let ((process-environment
770 (nconc
771 ;; If using termcap, we specify `emacs' as the terminal type
772 ;; because that lets us specify a width.
773 ;; If using terminfo, we specify `dumb' because that is
774 ;; a defined terminal type. `emacs' is not a defined terminal type
775 ;; and there is no way for us to define it here.
776 ;; Some programs that use terminfo get very confused
777 ;; if TERM is not a valid terminal type.
778 ;; ;; There is similar code in compile.el.
779 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
780 (list "TERM=dumb" "TERMCAP="
781 (format "COLUMNS=%d" (window-width)))
782 (list "TERM=emacs"
783 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
784 (unless (getenv "EMACS")
785 (list "EMACS=t"))
786 (list (format "INSIDE_EMACS=%s,comint" emacs-version))
787 process-environment))
788 (default-directory
789 (if (file-accessible-directory-p default-directory)
790 default-directory
791 "/"))
792 proc decoding encoding changed)
793 (let ((exec-path (if (file-name-directory command)
794 ;; If the command has slashes, make sure we
795 ;; first look relative to the current directory.
796 (cons default-directory exec-path) exec-path)))
797 (setq proc (apply 'start-file-process name buffer command switches)))
798 ;; Some file name handler cannot start a process, fe ange-ftp.
799 (unless (processp proc) (error "No process started"))
800 (let ((coding-systems (process-coding-system proc)))
801 (setq decoding (car coding-systems)
802 encoding (cdr coding-systems)))
803 ;; If start-file-process decided to use some coding system for decoding
804 ;; data sent from the process and the coding system doesn't
805 ;; specify EOL conversion, we had better convert CRLF to LF.
806 (if (vectorp (coding-system-eol-type decoding))
807 (setq decoding (coding-system-change-eol-conversion decoding 'dos)
808 changed t))
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-point')."
824 (interactive "e")
825 (mouse-set-point event)
826 (let ((pos (posn-point (event-end event)))
827 field input)
828 (with-selected-window (posn-window (event-end event))
829 (and (setq field (field-at-pos pos))
830 (setq input (field-string-no-properties pos))))
831 (if (or (null comint-accum-marker)
832 (not (eq field 'input)))
833 ;; Fall back to the global definition if (i) the selected
834 ;; buffer is not a comint buffer (which can happen if a
835 ;; non-comint window was selected and we clicked in a comint
836 ;; window), or (ii) there is no input at POS.
837 (let* ((keys (this-command-keys))
838 (last-key (and (vectorp keys) (aref keys (1- (length keys)))))
839 (fun (and last-key (lookup-key global-map (vector last-key)))))
840 (and fun (not (eq fun 'comint-insert-input))
841 (call-interactively fun)))
842 ;; Otherwise, insert the previous input.
843 (goto-char (point-max))
844 ;; First delete any old unsent input at the end
845 (delete-region
846 (or (marker-position comint-accum-marker)
847 (process-mark (get-buffer-process (current-buffer))))
848 (point))
849 ;; Insert the input at point
850 (insert input))))
851 \f
852 ;; Input history processing in a buffer
853 ;; ===========================================================================
854 ;; Useful input history functions, courtesy of the Ergo group.
856 ;; Eleven commands:
857 ;; comint-dynamic-list-input-ring List history in help buffer.
858 ;; comint-previous-input Previous input...
859 ;; comint-previous-matching-input ...matching a string.
860 ;; comint-previous-matching-input-from-input ... matching the current input.
861 ;; comint-next-input Next input...
862 ;; comint-next-matching-input ...matching a string.
863 ;; comint-next-matching-input-from-input ... matching the current input.
864 ;; comint-backward-matching-input Backwards input...
865 ;; comint-forward-matching-input ...matching a string.
866 ;; comint-replace-by-expanded-history Expand history at point;
867 ;; replace with expanded history.
868 ;; comint-magic-space Expand history and insert space.
869 ;;
870 ;; Three functions:
871 ;; comint-read-input-ring Read into comint-input-ring...
872 ;; comint-write-input-ring Write to comint-input-ring-file-name.
873 ;; comint-replace-by-expanded-history-before-point Workhorse function.
875 (defun comint-read-input-ring (&optional silent)
876 "Set the buffer's `comint-input-ring' from a history file.
877 The name of the file is given by the variable `comint-input-ring-file-name'.
878 The history ring is of size `comint-input-ring-size', regardless of file size.
879 If `comint-input-ring-file-name' is nil this function does nothing.
881 If the optional argument SILENT is non-nil, we say nothing about a
882 failure to read the history file.
884 This function is useful for major mode commands and mode hooks.
886 The commands stored in the history file are separated by the
887 `comint-input-ring-separator', and entries that match
888 `comint-input-history-ignore' are ignored. The most recent command
889 comes last.
891 See also `comint-input-ignoredups' and `comint-write-input-ring'."
892 (cond ((or (null comint-input-ring-file-name)
893 (equal comint-input-ring-file-name ""))
894 nil)
895 ((not (file-readable-p comint-input-ring-file-name))
896 (or silent
897 (message "Cannot read history file %s"
898 comint-input-ring-file-name)))
899 (t
900 (let* ((history-buf (get-buffer-create " *temp*"))
901 (file comint-input-ring-file-name)
902 (count 0)
903 (size comint-input-ring-size)
904 (ring (make-ring size)))
905 (unwind-protect
906 (save-excursion
907 (set-buffer history-buf)
908 (widen)
909 (erase-buffer)
910 (insert-file-contents file)
911 ;; Save restriction in case file is already visited...
912 ;; Watch for those date stamps in history files!
913 (goto-char (point-max))
914 (let (start end history)
915 (while (and (< count size)
916 (re-search-backward comint-input-ring-separator nil t)
917 (setq end (match-beginning 0)))
918 (if (re-search-backward comint-input-ring-separator nil t)
919 (setq start (match-end 0))
920 (setq start (point-min)))
921 (setq history (buffer-substring start end))
922 (goto-char start)
923 (if (and (not (string-match comint-input-history-ignore history))
924 (or (null comint-input-ignoredups)
925 (ring-empty-p ring)
926 (not (string-equal (ring-ref ring 0) history))))
927 (progn
928 (ring-insert-at-beginning ring history)
929 (setq count (1+ count)))))))
930 (kill-buffer history-buf))
931 (setq comint-input-ring ring
932 comint-input-ring-index nil)))))
934 (defun comint-write-input-ring ()
935 "Writes the buffer's `comint-input-ring' to a history file.
936 The name of the file is given by the variable `comint-input-ring-file-name'.
937 The original contents of the file are lost if `comint-input-ring' is not empty.
938 If `comint-input-ring-file-name' is nil this function does nothing.
940 Useful within process sentinels.
942 See also `comint-read-input-ring'."
943 (cond ((or (null comint-input-ring-file-name)
944 (equal comint-input-ring-file-name "")
945 (null comint-input-ring) (ring-empty-p comint-input-ring))
946 nil)
947 ((not (file-writable-p comint-input-ring-file-name))
948 (message "Cannot write history file %s" comint-input-ring-file-name))
949 (t
950 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
951 (ring comint-input-ring)
952 (file comint-input-ring-file-name)
953 (index (ring-length ring)))
954 ;; Write it all out into a buffer first. Much faster, but messier,
955 ;; than writing it one line at a time.
956 (save-excursion
957 (set-buffer history-buf)
958 (erase-buffer)
959 (while (> index 0)
960 (setq index (1- index))
961 (insert (ring-ref ring index) comint-input-ring-separator))
962 (write-region (buffer-string) nil file nil 'no-message)
963 (kill-buffer nil))))))
966 (defvar comint-dynamic-list-input-ring-window-conf)
968 (defun comint-dynamic-list-input-ring-select ()
969 "Choose the input history entry that point is in or next to."
970 (interactive)
971 (let (beg end completion (buffer completion-reference-buffer)
972 (base-size completion-base-size))
973 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
974 (setq end (point) beg (1+ (point))))
975 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
976 (setq end (1- (point)) beg (point)))
977 (if (null beg)
978 (error "No history entry here"))
979 (setq beg (previous-single-property-change beg 'mouse-face))
980 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
981 (setq completion (buffer-substring beg end))
982 (set-window-configuration comint-dynamic-list-input-ring-window-conf)
983 (choose-completion-string completion buffer base-size)))
985 (defun comint-dynamic-list-input-ring ()
986 "List in help buffer the buffer's input history."
987 (interactive)
988 (if (or (not (ring-p comint-input-ring))
989 (ring-empty-p comint-input-ring))
990 (message "No history")
991 (let ((history nil)
992 (history-buffer " *Input History*")
993 (index (1- (ring-length comint-input-ring)))
994 (conf (current-window-configuration)))
995 ;; We have to build up a list ourselves from the ring vector.
996 (while (>= index 0)
997 (setq history (cons (ring-ref comint-input-ring index) history)
998 index (1- index)))
999 ;; Change "completion" to "history reference"
1000 ;; to make the display accurate.
1001 (with-output-to-temp-buffer history-buffer
1002 (display-completion-list history)
1003 (set-buffer history-buffer)
1004 (let ((keymap (make-sparse-keymap)))
1005 (set-keymap-parent keymap (current-local-map))
1006 (define-key keymap "\C-m" 'comint-dynamic-list-input-ring-select)
1007 (use-local-map keymap))
1008 (forward-line 3)
1009 (while (search-backward "completion" nil 'move)
1010 (replace-match "history reference")))
1011 (sit-for 0)
1012 (message "Hit space to flush")
1013 (setq comint-dynamic-list-input-ring-window-conf conf)
1014 (let ((ch (read-event)))
1015 (if (eq ch ?\s)
1016 (set-window-configuration conf)
1017 (setq unread-command-events (list ch)))))))
1020 (defun comint-regexp-arg (prompt)
1021 "Return list of regexp and prefix arg using PROMPT."
1022 (let* (;; Don't clobber this.
1023 (last-command last-command)
1024 (regexp (read-from-minibuffer prompt nil nil nil
1025 'minibuffer-history-search-history)))
1026 ;; If the user didn't enter anything, nothing is added to m-h-s-h.
1027 ;; Use the previous search regexp, if there is one.
1028 (list (if (string-equal regexp "")
1029 (or (car minibuffer-history-search-history)
1030 regexp)
1031 regexp)
1032 (prefix-numeric-value current-prefix-arg))))
1034 (defun comint-search-arg (arg)
1035 ;; First make sure there is a ring and that we are after the process mark
1036 (cond ((not (comint-after-pmark-p))
1037 (error "Not at command line"))
1038 ((or (null comint-input-ring)
1039 (ring-empty-p comint-input-ring))
1040 (error "Empty input ring"))
1041 ((zerop arg)
1042 ;; arg of zero resets search from beginning, and uses arg of 1
1043 (setq comint-input-ring-index nil)
1044 1)
1045 (t
1046 arg)))
1048 (defun comint-restore-input ()
1049 "Restore unfinished input."
1050 (interactive)
1051 (when comint-input-ring-index
1052 (comint-delete-input)
1053 (when (> (length comint-stored-incomplete-input) 0)
1054 (insert comint-stored-incomplete-input)
1055 (message "Input restored"))
1056 (setq comint-input-ring-index nil)))
1058 (defun comint-search-start (arg)
1059 "Index to start a directional search, starting at `comint-input-ring-index'."
1060 (if comint-input-ring-index
1061 ;; If a search is running, offset by 1 in direction of arg
1062 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
1063 (ring-length comint-input-ring))
1064 ;; For a new search, start from beginning or end, as appropriate
1065 (if (>= arg 0)
1066 0 ; First elt for forward search
1067 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
1069 (defun comint-previous-input-string (arg)
1070 "Return the string ARG places along the input ring.
1071 Moves relative to `comint-input-ring-index'."
1072 (ring-ref comint-input-ring (if comint-input-ring-index
1073 (mod (+ arg comint-input-ring-index)
1074 (ring-length comint-input-ring))
1075 arg)))
1077 (defun comint-previous-input (arg)
1078 "Cycle backwards through input history, saving input."
1079 (interactive "*p")
1080 (if (and comint-input-ring-index
1081 (or ;; leaving the "end" of the ring
1082 (and (< arg 0) ; going down
1083 (eq comint-input-ring-index 0))
1084 (and (> arg 0) ; going up
1085 (eq comint-input-ring-index
1086 (1- (ring-length comint-input-ring)))))
1087 comint-stored-incomplete-input)
1088 (comint-restore-input)
1089 (comint-previous-matching-input "." arg)))
1091 (defun comint-next-input (arg)
1092 "Cycle forwards through input history."
1093 (interactive "*p")
1094 (comint-previous-input (- arg)))
1096 (defun comint-previous-matching-input-string (regexp arg)
1097 "Return the string matching REGEXP ARG places along the input ring.
1098 Moves relative to `comint-input-ring-index'."
1099 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
1100 (if pos (ring-ref comint-input-ring pos))))
1102 (defun comint-previous-matching-input-string-position (regexp arg &optional start)
1103 "Return the index matching REGEXP ARG places along the input ring.
1104 Moves relative to START, or `comint-input-ring-index'."
1105 (if (or (not (ring-p comint-input-ring))
1106 (ring-empty-p comint-input-ring))
1107 (error "No history"))
1108 (let* ((len (ring-length comint-input-ring))
1109 (motion (if (> arg 0) 1 -1))
1110 (n (mod (- (or start (comint-search-start arg)) motion) len))
1111 (tried-each-ring-item nil)
1112 (prev nil))
1113 ;; Do the whole search as many times as the argument says.
1114 (while (and (/= arg 0) (not tried-each-ring-item))
1115 ;; Step once.
1116 (setq prev n
1117 n (mod (+ n motion) len))
1118 ;; If we haven't reached a match, step some more.
1119 (while (and (< n len) (not tried-each-ring-item)
1120 (not (string-match regexp (ring-ref comint-input-ring n))))
1121 (setq n (mod (+ n motion) len)
1122 ;; If we have gone all the way around in this search.
1123 tried-each-ring-item (= n prev)))
1124 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1125 ;; Now that we know which ring element to use, if we found it, return that.
1126 (if (string-match regexp (ring-ref comint-input-ring n))
1127 n)))
1129 (defun comint-delete-input ()
1130 "Delete all input between accumulation or process mark and point."
1131 (delete-region
1132 ;; Can't use kill-region as it sets this-command
1133 (or (marker-position comint-accum-marker)
1134 (process-mark (get-buffer-process (current-buffer))))
1135 (point-max)))
1137 (defun comint-previous-matching-input (regexp n)
1138 "Search backwards through input history for match for REGEXP.
1139 \(Previous history elements are earlier commands.)
1140 With prefix argument N, search for Nth previous match.
1141 If N is negative, find the next or Nth next match."
1142 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1143 (setq n (comint-search-arg n))
1144 (let ((pos (comint-previous-matching-input-string-position regexp n)))
1145 ;; Has a match been found?
1146 (if (null pos)
1147 (error "Not found")
1148 ;; If leaving the edit line, save partial input
1149 (if (null comint-input-ring-index) ;not yet on ring
1150 (setq comint-stored-incomplete-input
1151 (funcall comint-get-old-input)))
1152 (setq comint-input-ring-index pos)
1153 (message "History item: %d" (1+ pos))
1154 (comint-delete-input)
1155 (insert (ring-ref comint-input-ring pos)))))
1157 (defun comint-next-matching-input (regexp n)
1158 "Search forwards through input history for match for REGEXP.
1159 \(Later history elements are more recent commands.)
1160 With prefix argument N, search for Nth following match.
1161 If N is negative, find the previous or Nth previous match."
1162 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1163 (comint-previous-matching-input regexp (- n)))
1165 (defun comint-previous-matching-input-from-input (n)
1166 "Search backwards through input history for match for current input.
1167 \(Previous history elements are earlier commands.)
1168 With prefix argument N, search for Nth previous match.
1169 If N is negative, search forwards for the -Nth following match."
1170 (interactive "p")
1171 (if (not (memq last-command '(comint-previous-matching-input-from-input
1172 comint-next-matching-input-from-input)))
1173 ;; Starting a new search
1174 (setq comint-matching-input-from-input-string
1175 (buffer-substring
1176 (or (marker-position comint-accum-marker)
1177 (process-mark (get-buffer-process (current-buffer))))
1178 (point))
1179 comint-input-ring-index nil))
1180 (comint-previous-matching-input
1181 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1182 n))
1184 (defun comint-next-matching-input-from-input (n)
1185 "Search forwards through input history for match for current input.
1186 \(Following history elements are more recent commands.)
1187 With prefix argument N, search for Nth following match.
1188 If N is negative, search backwards for the -Nth previous match."
1189 (interactive "p")
1190 (comint-previous-matching-input-from-input (- n)))
1193 (defun comint-replace-by-expanded-history (&optional silent start)
1194 "Expand input command history references before point.
1195 Expansion is dependent on the value of `comint-input-autoexpand'.
1197 This function depends on the buffer's idea of the input history, which may not
1198 match the command interpreter's idea, assuming it has one.
1200 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1201 cannot know the interpreter's idea of input line numbers, assuming it has one,
1202 it cannot expand absolute input line number references.
1204 If the optional argument SILENT is non-nil, never complain
1205 even if history reference seems erroneous.
1207 If the optional argument START is non-nil, that specifies the
1208 start of the text to scan for history references, rather
1209 than the logical beginning of line.
1211 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1213 Returns t if successful."
1214 (interactive)
1215 (if (and comint-input-autoexpand
1216 (if comint-use-prompt-regexp
1217 ;; Use comint-prompt-regexp
1218 (save-excursion
1219 (beginning-of-line)
1221 ;; Use input fields. User input that hasn't been entered
1222 ;; yet, at the end of the buffer, has a nil `field' property.
1223 (and (null (get-char-property (point) 'field))
1225 ;; Looks like there might be history references in the command.
1226 (let ((previous-modified-tick (buffer-modified-tick)))
1227 (comint-replace-by-expanded-history-before-point silent start)
1228 (/= previous-modified-tick (buffer-modified-tick)))))
1231 (defun comint-replace-by-expanded-history-before-point (silent &optional start)
1232 "Expand directory stack reference before point.
1233 See `comint-replace-by-expanded-history'. Returns t if successful.
1235 If the optional argument START is non-nil, that specifies the
1236 start of the text to scan for history references, rather
1237 than the logical beginning of line."
1238 (save-excursion
1239 (let ((toend (- (line-end-position) (point)))
1240 (start (or start (comint-line-beginning-position))))
1241 (goto-char start)
1242 (while (progn
1243 (skip-chars-forward "^!^" (- (line-end-position) toend))
1244 (< (point) (- (line-end-position) toend)))
1245 ;; This seems a bit complex. We look for references such as !!, !-num,
1246 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1247 ;; If that wasn't enough, the plings can be suffixed with argument
1248 ;; range specifiers.
1249 ;; Argument ranges are complex too, so we hive off the input line,
1250 ;; referenced with plings, with the range string to `comint-args'.
1251 (setq comint-input-ring-index nil)
1253 (comint-within-quotes start (point)))
1254 ;; The history is quoted, or we're in quotes.
1255 (goto-char (1+ (point))))
1257 ;; We cannot know the interpreter's idea of input line numbers.
1258 (goto-char (match-end 0))
1259 (message "Absolute reference cannot be expanded"))
1261 ;; Just a number of args from `number' lines backward.
1262 (let ((number (1- (string-to-number
1263 (buffer-substring (match-beginning 1)
1264 (match-end 1))))))
1265 (if (<= number (ring-length comint-input-ring))
1266 (progn
1267 (replace-match
1268 (comint-args (comint-previous-input-string number)
1269 (match-beginning 2) (match-end 2))
1270 t t)
1271 (setq comint-input-ring-index number)
1272 (message "History item: %d" (1+ number)))
1273 (goto-char (match-end 0))
1274 (message "Relative reference exceeds input history size"))))
1276 ;; Just a number of args from the previous input line.
1277 (replace-match
1278 (comint-args (comint-previous-input-string 0)
1279 (match-beginning 1) (match-end 1))
1280 t t)
1281 (message "History item: previous"))
1282 ((looking-at
1284 ;; Most recent input starting with or containing (possibly
1285 ;; protected) string, maybe just a number of args. Phew.
1286 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1287 (mb2 (match-beginning 2)) (me2 (match-end 2))
1288 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1290 (pos (save-match-data
1291 (comint-previous-matching-input-string-position
1292 (concat pref (regexp-quote exp)) 1))))
1293 (if (null pos)
1294 (progn
1295 (goto-char (match-end 0))
1296 (or silent
1297 (progn (message "Not found")
1298 (ding))))
1299 (setq comint-input-ring-index pos)
1300 (replace-match
1301 (comint-args (ring-ref comint-input-ring pos)
1302 (match-beginning 4) (match-end 4))
1303 t t)
1304 (message "History item: %d" (1+ pos)))))
1306 ;; Quick substitution on the previous input line.
1307 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1308 (new (buffer-substring (match-beginning 2) (match-end 2)))
1309 (pos nil))
1310 (replace-match (comint-previous-input-string 0) t t)
1311 (setq pos (point))
1312 (goto-char (match-beginning 0))
1313 (if (not (search-forward old pos t))
1314 (or silent
1315 (error "Not found"))
1316 (replace-match new t t)
1317 (message "History item: substituted"))))
1318 (t
1319 (forward-char 1)))))))
1322 (defun comint-magic-space (arg)
1323 "Expand input history references before point and insert ARG spaces.
1324 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1325 (interactive "p")
1326 (comint-replace-by-expanded-history)
1327 (self-insert-command arg))
1328 \f
1329 (defun comint-within-quotes (beg end)
1330 "Return t if the number of quotes between BEG and END is odd.
1331 Quotes are single and double."
1334 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1336 (defun comint-how-many-region (regexp beg end)
1337 "Return number of matches for REGEXP from BEG to END."
1338 (let ((count 0))
1339 (save-excursion
1340 (save-match-data
1341 (goto-char beg)
1342 (while (re-search-forward regexp end t)
1343 (setq count (1+ count)))))
1344 count))
1346 (defun comint-args (string begin end)
1347 ;; From STRING, return the args depending on the range specified in the text
1348 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1349 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1350 (save-match-data
1351 (if (null begin)
1352 (comint-arguments string 0 nil)
1353 (let* ((range (buffer-substring
1354 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1355 (nth (cond ((string-match "^[*^]" range) 1)
1356 ((string-match "^-" range) 0)
1357 ((string-equal range "$") nil)
1358 (t (string-to-number range))))
1359 (mth (cond ((string-match "[-*$]$" range) nil)
1360 ((string-match "-" range)
1361 (string-to-number (substring range (match-end 0))))
1362 (t nth))))
1363 (comint-arguments string nth mth)))))
1365 (defun comint-delim-arg (arg)
1366 "Return a list of arguments from ARG.
1367 Break it up at the delimiters in `comint-delimiter-argument-list'.
1368 Returned list is backwards.
1370 Characters with non-nil values of the text property `literal' are
1371 assumed to have literal values (e.g., backslash-escaped
1372 characters), and are not considered to be delimiters."
1373 (if (null comint-delimiter-argument-list)
1374 (list arg)
1375 (let ((args nil)
1376 (pos 0)
1377 (len (length arg)))
1378 (while (< pos len)
1379 (let ((char (aref arg pos))
1380 (start pos))
1381 (if (and (memq char comint-delimiter-argument-list)
1382 ;; Ignore backslash-escaped characters.
1383 (not (get-text-property pos 'literal arg)))
1384 (while (and (< pos len) (eq (aref arg pos) char))
1385 (setq pos (1+ pos)))
1386 (while (and (< pos len)
1387 (not (and (memq (aref arg pos)
1388 comint-delimiter-argument-list)
1389 (not (get-text-property
1390 pos 'literal arg)))))
1391 (setq pos (1+ pos))))
1392 (setq args (cons (substring arg start pos) args))))
1393 args)))
1395 (defun comint-arguments (string nth mth)
1396 "Return from STRING the NTH to MTH arguments.
1397 NTH and/or MTH can be nil, which means the last argument.
1398 Returned arguments are separated by single spaces.
1399 We assume whitespace separates arguments, except within quotes
1400 and except for a space or tab that immediately follows a backslash.
1401 Also, a run of one or more of a single character
1402 in `comint-delimiter-argument-list' is a separate argument.
1403 Argument 0 is the command name."
1404 ;; The first line handles ordinary characters and backslash-sequences
1405 ;; (except with w32 msdos-like shells, where backslashes are valid).
1406 ;; The second matches "-quoted strings.
1407 ;; The third matches '-quoted strings.
1408 ;; The fourth matches `-quoted strings.
1409 ;; This seems to fit the syntax of BASH 2.0.
1410 (let* ((backslash-escape (not (and (fboundp 'w32-shell-dos-semantics)
1411 (w32-shell-dos-semantics))))
1412 (first (if backslash-escape
1415 (argpart (concat first
1419 (quote-subexpr (if backslash-escape 2 1))
1420 (args ()) (pos 0)
1421 (count 0)
1422 beg str quotes)
1423 ;; Build a list of all the args until we have as many as we want.
1424 (while (and (or (null mth) (<= count mth))
1425 (string-match argpart string pos))
1426 ;; Apply the `literal' text property to backslash-escaped
1427 ;; characters, so that `comint-delim-arg' won't break them up.
1428 (and backslash-escape
1429 (match-beginning 1)
1430 (put-text-property (match-beginning 1) (match-end 1)
1431 'literal t string))
1432 (if (and beg (= pos (match-beginning 0)))
1433 ;; It's contiguous, part of the same arg.
1434 (setq pos (match-end 0)
1435 quotes (or quotes (match-beginning quote-subexpr)))
1436 ;; It's a new separate arg.
1437 (if beg
1438 ;; Put the previous arg, if there was one, onto ARGS.
1439 (setq str (substring string beg pos)
1440 args (if quotes (cons str args)
1441 (nconc (comint-delim-arg str) args))))
1442 (setq count (length args))
1443 (setq quotes (match-beginning quote-subexpr))
1444 (setq beg (match-beginning 0))
1445 (setq pos (match-end 0))))
1446 (if beg
1447 (setq str (substring string beg pos)
1448 args (if quotes (cons str args)
1449 (nconc (comint-delim-arg str) args))))
1450 (setq count (length args))
1451 (let ((n (or nth (1- count)))
1452 (m (if mth (1- (- count mth)) 0)))
1453 (mapconcat
1454 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1455 \f
1456 ;;
1457 ;; Input processing stuff
1458 ;;
1459 (defun comint-add-to-input-history (cmd)
1460 "Add CMD to the input history.
1461 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1462 (if (and (funcall comint-input-filter cmd)
1463 (or (null comint-input-ignoredups)
1464 (not (ring-p comint-input-ring))
1465 (ring-empty-p comint-input-ring)
1466 (not (string-equal (ring-ref comint-input-ring 0)
1467 cmd))))
1468 (ring-insert comint-input-ring cmd)))
1470 (defun comint-send-input (&optional no-newline artificial)
1471 "Send input to process.
1472 After the process output mark, sends all text from the process mark to
1473 point as input to the process. Before the process output mark, calls
1474 value of variable `comint-get-old-input' to retrieve old input, copies
1475 it to the process mark, and sends it.
1477 This command also sends and inserts a final newline, unless
1478 NO-NEWLINE is non-nil.
1480 Any history reference may be expanded depending on the value of the variable
1481 `comint-input-autoexpand'. The list of function names contained in the value
1482 of `comint-input-filter-functions' is called on the input before sending it.
1483 The input is entered into the input history ring, if the value of variable
1484 `comint-input-filter' returns non-nil when called on the input.
1486 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1487 end of line before sending the input.
1489 After the input has been sent, if `comint-process-echoes' is non-nil,
1490 then `comint-send-input' waits to see if the process outputs a string
1491 matching the input, and if so, deletes that part of the output.
1492 If ARTIFICIAL is non-nil, it inhibits such deletion.
1493 Callers sending input not from the user should use ARTIFICIAL = t.
1495 The values of `comint-get-old-input', `comint-input-filter-functions', and
1496 `comint-input-filter' are chosen according to the command interpreter running
1497 in the buffer. E.g.,
1499 If the interpreter is the csh,
1500 `comint-get-old-input' is the default:
1501 If `comint-use-prompt-regexp' is nil, then
1502 either return the current input field, if point is on an input
1503 field, or the current line, if point is on an output field.
1504 If `comint-use-prompt-regexp' is non-nil, then
1505 return the current line with any initial string matching the
1506 regexp `comint-prompt-regexp' removed.
1509 `comint-input-filter' is the default: returns t if the input isn't all white
1510 space.
1512 If the Comint is Lucid Common Lisp,
1513 `comint-get-old-input' snarfs the sexp ending at point.
1514 `comint-input-filter-functions' does nothing.
1515 `comint-input-filter' returns nil if the input matches input-filter-regexp,
1516 which matches (1) all whitespace (2) :a, :c, etc.
1518 Similarly for Soar, Scheme, etc."
1519 (interactive)
1520 ;; Note that the input string does not include its terminal newline.
1521 (let ((proc (get-buffer-process (current-buffer))))
1522 (if (not proc) (error "Current buffer has no process")
1523 (widen)
1524 (let* ((pmark (process-mark proc))
1525 (intxt (if (>= (point) (marker-position pmark))
1526 (progn (if comint-eol-on-send (end-of-line))
1527 (buffer-substring pmark (point)))
1528 (let ((copy (funcall comint-get-old-input)))
1529 (goto-char pmark)
1530 (insert copy)
1531 copy)))
1532 (input (if (not (eq comint-input-autoexpand 'input))
1533 ;; Just whatever's already there
1534 intxt
1535 ;; Expand and leave it visible in buffer
1536 (comint-replace-by-expanded-history t pmark)
1537 (buffer-substring pmark (point))))
1538 (history (if (not (eq comint-input-autoexpand 'history))
1539 input
1540 ;; This is messy 'cos ultimately the original
1541 ;; functions used do insertion, rather than return
1542 ;; strings. We have to expand, then insert back.
1543 (comint-replace-by-expanded-history t pmark)
1544 (let ((copy (buffer-substring pmark (point)))
1545 (start (point)))
1546 (insert input)
1547 (delete-region pmark start)
1548 copy))))
1550 (unless no-newline
1553 (comint-add-to-input-history history)
1555 (run-hook-with-args 'comint-input-filter-functions
1556 (if no-newline input
1559 (let ((beg (marker-position pmark))
1560 (end (if no-newline (point) (1- (point))))
1561 (inhibit-modification-hooks t))
1562 (when (> end beg)
1563 (add-text-properties beg end
1564 '(front-sticky t
1565 font-lock-face comint-highlight-input))
1566 (unless comint-use-prompt-regexp
1567 ;; Give old user input a field property of `input', to
1568 ;; distinguish it from both process output and unsent
1569 ;; input. The terminating newline is put into a special
1570 ;; `boundary' field to make cursor movement between input
1571 ;; and output fields smoother.
1572 (add-text-properties
1573 beg end
1574 '(mouse-face highlight
1575 help-echo "mouse-2: insert after prompt as new input"
1576 field input))))
1577 (unless (or no-newline comint-use-prompt-regexp)
1578 ;; Cover the terminating newline
1579 (add-text-properties end (1+ end)
1580 '(rear-nonsticky t
1581 field boundary
1582 inhibit-line-move-field-capture t))))
1584 (comint-snapshot-last-prompt)
1586 (setq comint-save-input-ring-index comint-input-ring-index)
1587 (setq comint-input-ring-index nil)
1588 ;; Update the markers before we send the input
1589 ;; in case we get output amidst sending the input.
1590 (set-marker comint-last-input-start pmark)
1591 (set-marker comint-last-input-end (point))
1592 (set-marker (process-mark proc) (point))
1593 ;; clear the "accumulation" marker
1594 (set-marker comint-accum-marker nil)
1595 (let ((comint-input-sender-no-newline no-newline))
1596 (funcall comint-input-sender proc input))
1598 ;; Optionally delete echoed input (after checking it).
1599 (when (and comint-process-echoes (not artificial))
1600 (let ((echo-len (- comint-last-input-end
1601 comint-last-input-start)))
1602 ;; Wait for all input to be echoed:
1603 (while (and (accept-process-output proc)
1604 (> (+ comint-last-input-end echo-len)
1605 (point-max))
1606 (zerop
1607 (compare-buffer-substrings
1608 nil comint-last-input-start
1609 (- (point-max) echo-len)
1610 ;; Above difference is equivalent to
1611 ;; (+ comint-last-input-start
1612 ;; (- (point-max) comint-last-input-end))
1613 nil comint-last-input-end (point-max)))))
1614 (if (and
1615 (<= (+ comint-last-input-end echo-len)
1616 (point-max))
1617 (zerop
1618 (compare-buffer-substrings
1619 nil comint-last-input-start comint-last-input-end
1620 nil comint-last-input-end
1621 (+ comint-last-input-end echo-len))))
1622 ;; Certain parts of the text to be deleted may have
1623 ;; been mistaken for prompts. We have to prevent
1624 ;; problems when `comint-prompt-read-only' is non-nil.
1625 (let ((inhibit-read-only t))
1626 (delete-region comint-last-input-end
1627 (+ comint-last-input-end echo-len))
1628 (when comint-prompt-read-only
1629 (save-excursion
1630 (goto-char comint-last-input-end)
1631 (comint-update-fence)))))))
1633 ;; This used to call comint-output-filter-functions,
1634 ;; but that scrolled the buffer in undesirable ways.
1635 (run-hook-with-args 'comint-output-filter-functions "")))))
1637 (defvar comint-preoutput-filter-functions nil
1638 "List of functions to call before inserting Comint output into the buffer.
1639 Each function gets one argument, a string containing the text received
1640 from the subprocess. It should return the string to insert, perhaps
1641 the same string that was received, or perhaps a modified or transformed
1642 string.
1644 The functions on the list are called sequentially, and each one is
1645 given the string returned by the previous one. The string returned by
1646 the last function is the text that is actually inserted in the
1647 redirection buffer.
1649 You can use `add-hook' to add functions to this list
1650 either globally or locally.")
1652 (defvar comint-inhibit-carriage-motion nil
1653 "If nil, Comint will interpret `carriage control' characters in output.
1654 See `comint-carriage-motion' for details.")
1656 ;; When non-nil, this is an overlay over the last recognized prompt in
1657 ;; the buffer; it is used when highlighting the prompt.
1658 (defvar comint-last-prompt-overlay nil)
1660 (defun comint-snapshot-last-prompt ()
1661 "`snapshot' any current `comint-last-prompt-overlay'.
1662 Freeze its attributes in place, even when more input comes along
1663 and moves the prompt overlay."
1664 (when comint-last-prompt-overlay
1665 (let ((inhibit-read-only t)
1666 (inhibit-modification-hooks t))
1667 (add-text-properties (overlay-start comint-last-prompt-overlay)
1668 (overlay-end comint-last-prompt-overlay)
1669 (overlay-properties comint-last-prompt-overlay)))))
1671 (defun comint-carriage-motion (start end)
1672 "Interpret carriage control characters in the region from START to END.
1673 Translate carriage return/linefeed sequences to linefeeds.
1674 Make single carriage returns delete to the beginning of the line.
1675 Make backspaces delete the previous character."
1676 (save-excursion
1677 ;; First do a quick check to see if there are any applicable
1678 ;; characters, so we can avoid calling save-match-data and
1679 ;; save-restriction if not.
1680 (goto-char start)
1682 (save-match-data
1683 (save-restriction
1684 (widen)
1685 (let ((inhibit-field-text-motion t)
1686 (inhibit-read-only t))
1687 ;; CR LF -> LF
1688 ;; Note that this won't work properly when the CR and LF
1689 ;; are in different output chunks, but this is probably an
1690 ;; exceedingly rare case (because they are generally
1691 ;; written as a unit), and to delay interpretation of a
1692 ;; trailing CR in a chunk would result in odd interactive
1693 ;; behavior (and this case is probably far more common).
1695 (delete-char -1))
1696 ;; bare CR -> delete preceding line
1697 (goto-char start)
1699 (delete-region (point) (line-beginning-position)))
1700 ;; BS -> delete preceding character
1701 (goto-char start)
1703 (delete-char -2))))))))
1705 ;; The purpose of using this filter for comint processes
1706 ;; is to keep comint-last-input-end from moving forward
1707 ;; when output is inserted.
1708 (defun comint-output-filter (process string)
1709 (let ((oprocbuf (process-buffer process)))
1710 ;; First check for killed buffer or no input.
1711 (when (and string oprocbuf (buffer-name oprocbuf))
1712 (with-current-buffer oprocbuf
1713 ;; Run preoutput filters
1714 (let ((functions comint-preoutput-filter-functions))
1715 (while (and functions string)
1716 (if (eq (car functions) t)
1717 (let ((functions (default-value 'comint-preoutput-filter-functions)))
1718 (while (and functions string)
1719 (setq string (funcall (car functions) string))
1720 (setq functions (cdr functions))))
1721 (setq string (funcall (car functions) string)))
1722 (setq functions (cdr functions))))
1724 ;; Insert STRING
1725 (let ((inhibit-read-only t)
1726 ;; Avoid the overhead of save-excursion, since we just
1727 ;; fiddle with the point
1728 (saved-point (point-marker)))
1730 ;; The point should float after any insertion we do
1731 (set-marker-insertion-type saved-point t)
1733 ;; We temporarly remove any buffer narrowing, in case the
1734 ;; process mark is outside of the restriction
1735 (save-restriction
1736 (widen)
1738 (goto-char (process-mark process))
1739 (set-marker comint-last-output-start (point))
1741 ;; insert-before-markers is a bad thing. XXX
1742 ;;
1743 ;; It is used here to force window-point markers (used to
1744 ;; store the value of point in non-selected windows) to
1745 ;; advance, but it also screws up any other markers that we
1746 ;; don't _want_ to advance, such as the start-marker of some
1747 ;; of the overlays we create.
1748 ;;
1749 ;; We work around the problem with the overlays by
1750 ;; explicitly adjusting them after we do the insertion, but
1751 ;; in the future this problem should be solved correctly, by
1752 ;; using `insert', and making the insertion-type of
1753 ;; window-point markers settable (via a buffer-local
1754 ;; variable). In comint buffers, this variable would be set
1755 ;; to `t', to cause point in non-select windows to advance.
1756 (insert-before-markers string)
1757 ;; Fixup markers and overlays that got screwed up because we
1758 ;; used `insert-before-markers'.
1759 (let ((old-point (- (point) (length string))))
1760 ;; comint-last-output-start
1761 (set-marker comint-last-output-start old-point)
1762 ;; comint-last-input-end
1763 (when (and comint-last-input-end
1764 (equal (marker-position comint-last-input-end)
1765 (point)))
1766 (set-marker comint-last-input-end old-point))
1767 ;; No overlays we create are set to advance upon insertion
1768 ;; (at the start/end), so we assume that any overlay which
1769 ;; is at the current point was incorrectly advanced by
1770 ;; insert-before-markers. First fixup overlays that might
1771 ;; start at point:
1772 (dolist (over (overlays-at (point)))
1773 (when (= (overlay-start over) (point))
1774 (let ((end (overlay-end over)))
1775 (move-overlay over
1776 old-point
1777 (if (= end (point)) old-point end)))))
1778 ;; Then do overlays that might end at point:
1779 (dolist (over (overlays-at (1- (point))))
1780 (when (= (overlay-end over) (point))
1781 (move-overlay over
1782 (min (overlay-start over) old-point)
1783 old-point))))
1785 ;; Advance process-mark
1786 (set-marker (process-mark process) (point))
1788 (unless comint-inhibit-carriage-motion
1789 ;; Interpret any carriage motion characters (newline, backspace)
1790 (comint-carriage-motion comint-last-output-start (point)))
1792 ;; Run these hooks with point where the user had it.
1793 (goto-char saved-point)
1794 (run-hook-with-args 'comint-output-filter-functions string)
1795 (set-marker saved-point (point))
1797 (goto-char (process-mark process)) ; in case a filter moved it
1799 (unless comint-use-prompt-regexp
1800 (let ((inhibit-read-only t)
1801 (inhibit-modification-hooks t))
1802 (add-text-properties comint-last-output-start (point)
1803 '(rear-nonsticky t
1804 field output
1805 inhibit-line-move-field-capture t))))
1807 ;; Highlight the prompt, where we define `prompt' to mean
1808 ;; the most recent output that doesn't end with a newline.
1809 (let ((prompt-start (save-excursion (forward-line 0) (point)))
1810 (inhibit-read-only t)
1811 (inhibit-modification-hooks t))
1812 (when comint-prompt-read-only
1813 (or (= (point-min) prompt-start)
1814 (get-text-property (1- prompt-start) 'read-only)
1815 (put-text-property
1816 (1- prompt-start) prompt-start 'read-only 'fence))
1817 (add-text-properties
1818 prompt-start (point)
1819 '(read-only t rear-nonsticky t front-sticky (read-only))))
1820 (unless (and (bolp) (null comint-last-prompt-overlay))
1821 ;; Need to create or move the prompt overlay (in the case
1822 ;; where there is no prompt ((bolp) == t), we still do
1823 ;; this if there's already an existing overlay).
1824 (if comint-last-prompt-overlay
1825 ;; Just move an existing overlay
1826 (move-overlay comint-last-prompt-overlay
1827 prompt-start (point))
1828 ;; Need to create the overlay
1829 (setq comint-last-prompt-overlay
1830 (make-overlay prompt-start (point)))
1831 (overlay-put comint-last-prompt-overlay
1832 'font-lock-face 'comint-highlight-prompt))))
1834 (goto-char saved-point)))))))
1836 (defun comint-preinput-scroll-to-bottom ()
1837 "Go to the end of buffer in all windows showing it.
1838 Movement occurs if point in the selected window is not after the process mark,
1839 and `this-command' is an insertion command. Insertion commands recognized
1840 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1841 Depends on the value of `comint-scroll-to-bottom-on-input'.
1843 This function should be a pre-command hook."
1844 (if (and comint-scroll-to-bottom-on-input
1845 (memq this-command '(self-insert-command comint-magic-space yank
1846 hilit-yank)))
1847 (let* ((selected (selected-window))
1848 (current (current-buffer))
1849 (process (get-buffer-process current))
1850 (scroll comint-scroll-to-bottom-on-input))
1851 (if (and process (< (point) (process-mark process)))
1852 (if (eq scroll 'this)
1853 (goto-char (point-max))
1854 (walk-windows
1855 (function (lambda (window)
1856 (if (and (eq (window-buffer window) current)
1857 (or (eq scroll t) (eq scroll 'all)))
1858 (progn
1859 (select-window window)
1860 (goto-char (point-max))
1861 (select-window selected)))))
1862 nil t))))))
1864 (defun comint-postoutput-scroll-to-bottom (string)
1865 "Go to the end of buffer in some or all windows showing it.
1866 Does not scroll if the current line is the last line in the buffer.
1867 Depends on the value of `comint-move-point-for-output' and
1868 `comint-scroll-show-maximum-output'.
1870 This function should be in the list `comint-output-filter-functions'."
1871 (let* ((selected (selected-window))
1872 (current (current-buffer))
1873 (process (get-buffer-process current))
1874 (scroll comint-move-point-for-output))
1875 (unwind-protect
1876 (if process
1877 (walk-windows
1878 (function (lambda (window)
1879 (if (eq (window-buffer window) current)
1880 (progn
1881 (select-window window)
1882 (if (and (< (point) (process-mark process))
1883 (or (eq scroll t) (eq scroll 'all)
1884 ;; Maybe user wants point to jump to end.
1885 (and (eq scroll 'this) (eq selected window))
1886 (and (eq scroll 'others) (not (eq selected window)))
1887 ;; If point was at the end, keep it at end.
1888 (and (marker-position comint-last-output-start)
1889 (>= (point) comint-last-output-start))))
1890 (goto-char (process-mark process)))
1891 ;; Optionally scroll so that the text
1892 ;; ends at the bottom of the window.
1893 (if (and comint-scroll-show-maximum-output
1894 (= (point) (point-max)))
1895 (save-excursion
1896 (goto-char (point-max))
1897 (recenter (- -1 scroll-margin))))
1898 (select-window selected)))))
1899 nil t))
1900 (set-buffer current))))
1902 (defun comint-truncate-buffer (&optional string)
1903 "Truncate the buffer to `comint-buffer-maximum-size'.
1904 This function could be on `comint-output-filter-functions' or bound to a key."
1905 (interactive)
1906 (save-excursion
1907 (goto-char (process-mark (get-buffer-process (current-buffer))))
1908 (forward-line (- comint-buffer-maximum-size))
1909 (beginning-of-line)
1910 (let ((inhibit-read-only t))
1911 (delete-region (point-min) (point)))))
1913 (defun comint-strip-ctrl-m (&optional string)
1914 "Strip trailing `^M' characters from the current output group.
1915 This function could be on `comint-output-filter-functions' or bound to a key."
1916 (interactive)
1917 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1918 (save-excursion
1919 (condition-case nil
1920 (goto-char
1921 (if (interactive-p) comint-last-input-end comint-last-output-start))
1922 (error nil))
1924 (replace-match "" t t)))))
1925 (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
1927 (defun comint-show-maximum-output ()
1928 "Put the end of the buffer at the bottom of the window."
1929 (interactive)
1930 (goto-char (point-max))
1931 (recenter (- -1 scroll-margin)))
1933 (defun comint-get-old-input-default ()
1934 "Default for `comint-get-old-input'.
1935 If `comint-use-prompt-regexp' is nil, then either
1936 return the current input field, if point is on an input field, or the
1937 current line, if point is on an output field.
1938 If `comint-use-prompt-regexp' is non-nil, then return
1939 the current line with any initial string matching the regexp
1940 `comint-prompt-regexp' removed."
1941 (let ((bof (field-beginning)))
1942 (if (eq (get-char-property bof 'field) 'input)
1943 (field-string-no-properties bof)
1944 (comint-bol)
1945 (buffer-substring-no-properties (point) (line-end-position)))))
1947 (defun comint-copy-old-input ()
1948 "Insert after prompt old input at point as new input to be edited.
1949 Calls `comint-get-old-input' to get old input."
1950 (interactive)
1951 (let ((input (funcall comint-get-old-input))
1952 (process (get-buffer-process (current-buffer))))
1953 (if (not process)
1954 (error "Current buffer has no process")
1955 (goto-char (process-mark process))
1956 (insert input))))
1958 (defun comint-skip-prompt ()
1959 "Skip past the text matching regexp `comint-prompt-regexp'.
1960 If this takes us past the end of the current line, don't skip at all."
1961 (if (and (looking-at comint-prompt-regexp)
1962 (<= (match-end 0) (line-end-position)))
1963 (goto-char (match-end 0))))
1965 (defun comint-after-pmark-p ()
1966 "Return t if point is after the process output marker."
1967 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1968 (<= (marker-position pmark) (point))))
1970 (defun comint-simple-send (proc string)
1971 "Default function for sending to PROC input STRING.
1972 This just sends STRING plus a newline. To override this,
1973 set the hook `comint-input-sender'."
1974 (let ((send-string
1975 (if comint-input-sender-no-newline
1976 string
1977 ;; Sending as two separate strings does not work
1980 (comint-send-string proc send-string))
1981 (if (and comint-input-sender-no-newline
1982 (not (string-equal string "")))
1983 (process-send-eof)))
1985 (defun comint-line-beginning-position ()
1986 "Return the buffer position of the beginning of the line, after any prompt.
1987 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done by
1988 skipping text matching the regular expression `comint-prompt-regexp',
1989 a buffer local variable."
1990 (if comint-use-prompt-regexp
1991 ;; Use comint-prompt-regexp
1992 (save-excursion
1993 (beginning-of-line)
1994 (comint-skip-prompt)
1995 (point))
1996 ;; Use input fields. Note that, unlike the behavior of
1997 ;; `line-beginning-position' inside a field, this function will
1998 ;; return the position of the end of a prompt, even if the point is
1999 ;; already inside the prompt. In order to do this, it assumes that
2000 ;; if there are two fields on a line, then the first one is the
2001 ;; prompt, and the second one is an input field, and is front-sticky
2002 ;; (as input fields should be).
2003 (constrain-to-field (line-beginning-position) (line-end-position))))
2005 (defun comint-bol (&optional arg)
2006 "Go to the beginning of line, then skip past the prompt, if any.
2008 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done
2009 by skipping text matching the regular expression `comint-prompt-regexp',
2010 a buffer local variable."
2011 (interactive "P")
2012 (if arg
2013 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
2014 (forward-line 0)
2015 (goto-char (comint-line-beginning-position))))
2017 ;; For compatibility.
2018 (defun comint-read-noecho (prompt &optional ignore)
2019 (read-passwd prompt))
2021 ;; These three functions are for entering text you don't want echoed or
2022 ;; saved -- typically passwords to ftp, telnet, or somesuch.
2023 ;; Just enter m-x send-invisible and type in your line.
2025 (defun send-invisible (&optional prompt)
2026 "Read a string without echoing.
2027 Then send it to the process running in the current buffer.
2028 The string is sent using `comint-input-sender'.
2029 Security bug: your string can still be temporarily recovered with
2031 (interactive "P") ; Defeat snooping via C-x ESC ESC
2032 (let ((proc (get-buffer-process (current-buffer)))
2033 (prefix
2034 (if (eq (window-buffer (selected-window)) (current-buffer))
2035 ""
2036 (format "(In buffer %s) "
2037 (current-buffer)))))
2038 (if proc
2039 (let ((str (read-passwd (concat prefix
2040 (or prompt "Non-echoed text: ")))))
2041 (if (stringp str)
2042 (progn
2043 (comint-snapshot-last-prompt)
2044 (funcall comint-input-sender proc str))
2045 (message "Warning: text will be echoed")))
2046 (error "Buffer %s has no process" (current-buffer)))))
2048 (defun comint-watch-for-password-prompt (string)
2049 "Prompt in the minibuffer for password and send without echoing.
2050 This function uses `send-invisible' to read and send a password to the buffer's
2051 process if STRING contains a password prompt defined by
2052 `comint-password-prompt-regexp'.
2054 This function could be in the list `comint-output-filter-functions'."
2055 (when (string-match comint-password-prompt-regexp string)
2057 (setq string (replace-match "" t t string)))
2058 (send-invisible string)))
2059 \f
2060 ;; Low-level process communication
2062 (defun comint-send-string (process string)
2063 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
2064 (if process
2065 (with-current-buffer (if (processp process)
2066 (process-buffer process)
2067 (get-buffer process))
2068 (comint-snapshot-last-prompt))
2069 (comint-snapshot-last-prompt))
2070 (process-send-string process string))
2072 (defun comint-send-region (process start end)
2073 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
2074 (if process
2075 (with-current-buffer (if (processp process)
2076 (process-buffer process)
2077 (get-buffer process))
2078 (comint-snapshot-last-prompt))
2079 (comint-snapshot-last-prompt))
2080 (process-send-region process start end))
2082 \f
2083 ;; Random input hackage
2085 (defun comint-delete-output ()
2086 "Delete all output from interpreter since last input.
2087 Does not delete the prompt."
2088 (interactive)
2089 (let ((proc (get-buffer-process (current-buffer)))
2090 (replacement nil)
2091 (inhibit-read-only t))
2092 (save-excursion
2093 (let ((pmark (progn (goto-char (process-mark proc))
2094 (forward-line 0)
2095 (point-marker))))
2096 (delete-region comint-last-input-end pmark)
2097 (goto-char (process-mark proc))
2099 (buffer-substring pmark (point))))
2100 (delete-region pmark (point))))
2101 ;; Output message and put back prompt
2102 (comint-output-filter proc replacement)))
2103 (define-obsolete-function-alias 'comint-kill-output
2104 'comint-delete-output "21.1")
2106 (defun comint-write-output (filename &optional append mustbenew)
2107 "Write output from interpreter since last input to FILENAME.
2108 Any prompt at the end of the output is not written.
2110 If the optional argument APPEND (the prefix argument when interactive)
2111 is non-nil, the output is appended to the file instead.
2113 If the optional argument MUSTBENEW is non-nil, check for an existing
2114 file with the same name. If MUSTBENEW is `excl', that means to get an
2115 error if the file already exists; never overwrite. If MUSTBENEW is
2116 neither nil nor `excl', that means ask for confirmation before
2117 overwriting, but do go ahead and overwrite the file if the user
2118 confirms. When interactive, MUSTBENEW is nil when appending, and t
2119 otherwise."
2120 (interactive
2121 (list (read-file-name
2122 (if current-prefix-arg
2123 "Append output to file: "
2124 "Write output to file: "))
2125 current-prefix-arg
2126 (not current-prefix-arg)))
2127 (save-excursion
2128 (goto-char (process-mark (get-buffer-process (current-buffer))))
2129 (forward-line 0)
2130 (write-region comint-last-input-end (point) filename
2131 append nil nil mustbenew)))
2133 ;; This function exists for the benefit of the menu; from the keyboard,
2134 ;; users can just use `comint-write-output' with a prefix arg.
2135 (defun comint-append-output-to-file (filename)
2136 "Append output from interpreter since last input to FILENAME.
2137 Any prompt at the end of the output is not written."
2138 (interactive "fAppend output to file: ")
2139 (comint-write-output filename t))
2141 (defun comint-show-output ()
2142 "Display start of this batch of interpreter output at top of window.
2143 Sets mark to the value of point when this command is run."
2144 (interactive)
2145 (push-mark)
2146 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
2147 (cond (comint-use-prompt-regexp
2148 (goto-char pos)
2149 (beginning-of-line 0)
2150 (set-window-start (selected-window) (point))
2151 (comint-skip-prompt))
2152 (t
2153 (let* ((beg (field-beginning pos))
2154 (pt (if (= (point-min) beg)
2155 (point-min)
2156 (1+ beg))))
2157 (goto-char pt))
2158 (set-window-start (selected-window) (point))))))
2161 (defun comint-interrupt-subjob ()
2162 "Interrupt the current subjob.
2163 This command also kills the pending input
2164 between the process mark and point."
2165 (interactive)
2166 (comint-skip-input)
2167 (interrupt-process nil comint-ptyp)
2169 )
2171 (defun comint-kill-subjob ()
2172 "Send kill signal to the current subjob.
2173 This command also kills the pending input
2174 between the process mark and point."
2175 (interactive)
2176 (comint-skip-input)
2177 (kill-process nil comint-ptyp))
2179 (defun comint-quit-subjob ()
2180 "Send quit signal to the current subjob.
2181 This command also kills the pending input
2182 between the process mark and point."
2183 (interactive)
2184 (comint-skip-input)
2185 (quit-process nil comint-ptyp))
2187 (defun comint-stop-subjob ()
2188 "Stop the current subjob.
2189 This command also kills the pending input
2190 between the process mark and point.
2192 WARNING: if there is no current subjob, you can end up suspending
2193 the top-level process running in the buffer. If you accidentally do
2195 is not a problem with most shells, since they ignore this signal.)"
2196 (interactive)
2197 (comint-skip-input)
2198 (stop-process nil comint-ptyp))
2200 (defun comint-continue-subjob ()
2201 "Send CONT signal to process buffer's process group.
2202 Useful if you accidentally suspend the top-level process."
2203 (interactive)
2204 (continue-process nil comint-ptyp))
2206 (defun comint-skip-input ()
2207 "Skip all pending input, from last stuff output by interpreter to point.
2208 This means mark it as if it had been sent as input, without sending it."
2209 (let ((comint-input-sender 'ignore)
2210 (comint-input-filter-functions nil))
2211 (comint-send-input t t))
2212 (end-of-line)
2213 (let ((pos (point))
2214 (marker (process-mark (get-buffer-process (current-buffer)))))
2215 (insert " " (key-description (this-command-keys)))
2216 (if (= marker pos)
2217 (set-marker marker (point)))))
2219 (defun comint-kill-input ()
2220 "Kill all text from last stuff output by interpreter to point."
2221 (interactive)
2222 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2223 (if (> (point) (marker-position pmark))
2224 (kill-region pmark (point)))))
2226 (defun comint-delchar-or-maybe-eof (arg)
2227 "Delete ARG characters forward or send an EOF to subprocess.
2228 Sends an EOF only if point is at the end of the buffer and there is no input."
2229 (interactive "p")
2230 (let ((proc (get-buffer-process (current-buffer))))
2231 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
2232 (comint-send-eof)
2233 (delete-char arg))))
2235 (defun comint-send-eof ()
2236 "Send an EOF to the current buffer's process."
2237 (interactive)
2238 (comint-send-input t t)
2239 (process-send-eof))
2242 (defun comint-backward-matching-input (regexp n)
2243 "Search backward through buffer for input fields that match REGEXP.
2244 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2245 by lines that match `comint-prompt-regexp'.
2247 With prefix argument N, search for Nth previous match.
2248 If N is negative, find the next or Nth next match."
2249 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2250 (if comint-use-prompt-regexp
2251 ;; Use comint-prompt-regexp
2252 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2253 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2254 (if (re-search-backward re nil t n)
2255 (point)))))
2256 (if (null pos)
2257 (progn (message "Not found")
2258 (ding))
2259 (goto-char pos)
2260 (comint-bol nil)))
2261 ;; Use input fields
2262 (let* ((dir (if (< n 0) -1 1))
2263 (pos
2264 (save-excursion
2265 (while (/= n 0)
2266 (unless (re-search-backward regexp nil t dir)
2267 (error "Not found"))
2268 (when (eq (get-char-property (point) 'field) 'input)
2269 (setq n (- n dir))))
2270 (field-beginning))))
2271 (goto-char pos))))
2274 (defun comint-forward-matching-input (regexp n)
2275 "Search forward through buffer for input fields that match REGEXP.
2276 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2277 by lines that match `comint-prompt-regexp'.
2279 With prefix argument N, search for Nth following match.
2280 If N is negative, find the previous or Nth previous match."
2281 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2282 (comint-backward-matching-input regexp (- n)))
2285 (defun comint-next-prompt (n)
2286 "Move to end of Nth next prompt in the buffer.
2287 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2288 the Nth next `input' field, otherwise, it means the Nth occurrence of
2289 text matching `comint-prompt-regexp'."
2290 (interactive "p")
2291 (if comint-use-prompt-regexp
2292 ;; Use comint-prompt-regexp
2293 (let ((paragraph-start comint-prompt-regexp))
2294 (end-of-line (if (> n 0) 1 0))
2295 (forward-paragraph n)
2296 (comint-skip-prompt))
2297 ;; Use input fields
2298 (let ((pos (point))
2299 (input-pos nil)
2300 prev-pos)
2301 (while (/= n 0)
2302 (setq prev-pos pos)
2303 (setq pos
2304 (if (> n 0)
2305 (next-single-char-property-change pos 'field)
2306 (previous-single-char-property-change pos 'field)))
2307 (cond ((or (null pos) (= pos prev-pos))
2308 ;; Ran off the end of the buffer.
2309 (when (> n 0)
2310 ;; There's always an input field at the end of the
2311 ;; buffer, but it has a `field' property of nil.
2312 (setq input-pos (point-max)))
2313 ;; stop iterating
2314 (setq n 0))
2315 ((eq (get-char-property pos 'field) 'input)
2316 (setq n (if (< n 0) (1+ n) (1- n)))
2317 (setq input-pos pos))))
2318 (when input-pos
2319 (goto-char input-pos)))))
2322 (defun comint-previous-prompt (n)
2323 "Move to end of Nth previous prompt in the buffer.
2324 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2325 the Nth previous `input' field, otherwise, it means the Nth occurrence of
2326 text matching `comint-prompt-regexp'."
2327 (interactive "p")
2328 (comint-next-prompt (- n)))
2330 ;; State used by `comint-insert-previous-argument' when cycling.
2331 (defvar comint-insert-previous-argument-last-start-pos nil)
2332 (make-variable-buffer-local 'comint-insert-previous-argument-last-start-pos)
2333 (defvar comint-insert-previous-argument-last-index nil)
2334 (make-variable-buffer-local 'comint-insert-previous-argument-last-index)
2336 ;; Needs fixing:
2337 ;; make comint-arguments understand negative indices as bash does
2338 (defun comint-insert-previous-argument (index)
2339 "Insert the INDEXth argument from the previous Comint command-line at point.
2340 Spaces are added at beginning and/or end of the inserted string if
2341 necessary to ensure that it's separated from adjacent arguments.
2342 Interactively, if no prefix argument is given, the last argument is inserted.
2343 Repeated interactive invocations will cycle through the same argument
2344 from progressively earlier commands (using the value of INDEX specified
2345 with the first command).
2346 This command is like `M-.' in bash."
2347 (interactive "P")
2348 (unless (null index)
2349 (setq index (prefix-numeric-value index)))
2350 (cond ((eq last-command this-command)
2351 ;; Delete last input inserted by this command.
2352 (delete-region comint-insert-previous-argument-last-start-pos (point))
2353 (setq index comint-insert-previous-argument-last-index))
2354 (t
2355 ;; This is a non-repeat invocation, so initialize state.
2356 (setq comint-input-ring-index nil)
2357 (setq comint-insert-previous-argument-last-index index)
2358 (when (null comint-insert-previous-argument-last-start-pos)
2359 ;; First usage; initialize to a marker
2360 (setq comint-insert-previous-argument-last-start-pos
2361 (make-marker)))))
2362 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2363 (if (<= (point) (comint-line-beginning-position))
2364 (comint-bol)
2365 (just-one-space))
2366 ;; Remember the beginning of what we insert, so we can delete it if
2367 ;; the command is repeated.
2368 (set-marker comint-insert-previous-argument-last-start-pos (point))
2369 ;; Insert the argument.
2370 (let ((input-string (comint-previous-input-string 0)))
2372 ;; strip terminating '&'
2373 (setq input-string (substring input-string 0 (match-beginning 0))))
2374 (insert (comint-arguments input-string index index)))
2375 ;; Make next invocation return arg from previous input
2376 (setq comint-input-ring-index (1+ (or comint-input-ring-index 0)))
2377 ;; Add a terminating space if necessary.
2378 (unless (eolp)
2379 (just-one-space)))
2381 \f
2382 ;; Support editing with `comint-prompt-read-only' set to t.
2384 (defun comint-update-fence ()
2385 "Update read-only status of newline before point.
2386 The `fence' read-only property is used to indicate that a newline
2388 following front-sticky read-only region. This is used to
2389 implement comint read-only prompts. If the text after a newline
2390 changes, the read-only status of that newline may need updating.
2391 That is what this function does.
2393 This function does nothing if point is not at the beginning of a
2394 line, or is at the beginning of the accessible portion of the buffer.
2395 Otherwise, if the character after point has a front-sticky
2396 read-only property, then the preceding newline is given a
2397 read-only property of `fence', unless it already is read-only.
2398 If the character after point does not have a front-sticky
2399 read-only property, any read-only property of `fence' on the
2400 preceding newline is removed."
2401 (let* ((pt (point)) (lst (get-text-property pt 'front-sticky))
2402 (inhibit-modification-hooks t))
2403 (and (bolp)
2404 (not (bobp))
2405 (if (and (get-text-property pt 'read-only)
2406 (if (listp lst) (memq 'read-only lst) t))
2407 (unless (get-text-property (1- pt) 'read-only)
2408 (put-text-property (1- pt) pt 'read-only 'fence))
2409 (when (eq (get-text-property (1- pt) 'read-only) 'fence)
2410 (remove-list-of-text-properties (1- pt) pt '(read-only)))))))
2412 (defun comint-kill-whole-line (&optional count)
2413 "Kill current line, ignoring read-only and field properties.
2414 With prefix arg COUNT, kill that many lines starting from the current line.
2415 If COUNT is negative, kill backward. Also kill the preceding newline,
2417 with negative arguments.)
2418 If COUNT is zero, kill current line but exclude the trailing newline.
2419 The read-only status of newlines is updated with `comint-update-fence',
2420 if necessary."
2421 (interactive "p")
2422 (let ((inhibit-read-only t) (inhibit-field-text-motion t))
2423 (kill-whole-line count)
2424 (when (>= count 0) (comint-update-fence))))
2426 (defun comint-kill-region (beg end &optional yank-handler)
2427 "Like `kill-region', but ignores read-only properties, if safe.
2428 This command assumes that the buffer contains read-only
2430 properties at the beginning of a line, with the preceding newline
2431 being read-only to protect the prompt. This is true of the
2432 comint prompts if `comint-prompt-read-only' is non-nil. This
2433 command will not delete the region if this would create mutilated
2434 or out of place prompts. That is, if any part of a prompt is
2435 deleted, the entire prompt must be deleted and all remaining
2436 prompts should stay at the beginning of a line. If this is not
2437 the case, this command just calls `kill-region' with all
2438 read-only properties intact. The read-only status of newlines is
2439 updated using `comint-update-fence', if necessary."
2440 (interactive "r")
2441 (save-excursion
2442 (let* ((true-beg (min beg end))
2443 (true-end (max beg end))
2444 (beg-bolp (progn (goto-char true-beg) (bolp)))
2445 (beg-lst (get-text-property true-beg 'front-sticky))
2446 (beg-bad (and (get-text-property true-beg 'read-only)
2447 (if (listp beg-lst) (memq 'read-only beg-lst) t)))
2448 (end-bolp (progn (goto-char true-end) (bolp)))
2449 (end-lst (get-text-property true-end 'front-sticky))
2450 (end-bad (and (get-text-property true-end 'read-only)
2451 (if (listp end-lst) (memq 'read-only end-lst) t))))
2452 (if (or (and (not beg-bolp) (or beg-bad end-bad))
2453 (and (not end-bolp) end-bad))
2454 (kill-region beg end yank-handler)
2455 (let ((inhibit-read-only t))
2456 (kill-region beg end yank-handler)
2457 (comint-update-fence))))))
2459 \f
2460 ;; Support for source-file processing commands.
2461 ;;============================================================================
2462 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2463 ;; commands that process files of source text (e.g. loading or compiling
2464 ;; files). So the corresponding process-in-a-buffer modes have commands
2465 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2466 ;; for defining these commands.
2467 ;;
2468 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2469 ;; and Soar, in that they don't know anything about file extensions.
2470 ;; So the compile/load interface gets the wrong default occasionally.
2471 ;; The load-file/compile-file default mechanism could be smarter -- it
2472 ;; doesn't know about the relationship between filename extensions and
2473 ;; whether the file is source or executable. If you compile foo.lisp
2474 ;; with compile-file, then the next load-file should use foo.bin for
2475 ;; the default, not foo.lisp. This is tricky to do right, particularly
2476 ;; because the extension for executable files varies so much (.o, .bin,
2477 ;; .lbin, .mo, .vo, .ao, ...).
2480 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2481 ;; commands.
2482 ;;
2483 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2484 ;; want to save the buffer before issuing any process requests to the command
2485 ;; interpreter.
2486 ;;
2487 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2488 ;; for the file to process.
2490 (defun comint-source-default (previous-dir/file source-modes)
2491 "Compute the defaults for `load-file' and `compile-file' commands.
2493 PREVIOUS-DIR/FILE is a pair (DIRECTORY . FILENAME) from the last
2494 source-file processing command, or nil if there hasn't been one yet.
2495 SOURCE-MODES is a list used to determine what buffers contain source
2496 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2497 Typically, (lisp-mode) or (scheme-mode).
2499 If the command is given while the cursor is inside a string, *and*
2500 the string is an existing filename, *and* the filename is not a directory,
2501 then the string is taken as default. This allows you to just position
2502 your cursor over a string that's a filename and have it taken as default.
2504 If the command is given in a file buffer whose major mode is in
2505 SOURCE-MODES, then the filename is the default file, and the
2506 file's directory is the default directory.
2508 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2509 then the default directory & file are what was used in the last source-file
2510 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2511 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2514 SOURCE-MODES is typically going to be something like (tea-mode)
2515 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2516 for Soar programs, etc.
2518 The function returns a pair: (default-directory . default-file)."
2519 (cond ((and buffer-file-name (memq major-mode source-modes))
2520 (cons (file-name-directory buffer-file-name)
2521 (file-name-nondirectory buffer-file-name)))
2522 (previous-dir/file)
2523 (t
2524 (cons default-directory nil))))
2527 (defun comint-check-source (fname)
2528 "Check whether to save buffers visiting file FNAME.
2529 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2530 process-in-a-buffer modes), this function can be called on the filename.
2531 If the file is loaded into a buffer, and the buffer is modified, the user
2532 is queried to see if he wants to save the buffer before proceeding with
2533 the load or compile."
2534 (let ((buff (get-file-buffer fname)))
2535 (if (and buff
2536 (buffer-modified-p buff)
2537 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
2538 ;; save BUFF.
2539 (let ((old-buffer (current-buffer)))
2540 (set-buffer buff)
2541 (save-buffer)
2542 (set-buffer old-buffer)))))
2544 (defun comint-extract-string ()
2545 "Return string around point, or nil."
2546 (let ((syntax (syntax-ppss)))
2547 (when (nth 3 syntax)
2548 (condition-case ()
2549 (buffer-substring-no-properties (1+ (nth 8 syntax))
2550 (progn (goto-char (nth 8 syntax))
2551 (forward-sexp)
2552 (1- (point))))
2553 (error nil)))))
2555 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2556 "Prompt for filenames in commands that process source files,
2557 e.g. loading or compiling a file.
2558 Provides a default, if there is one, and returns the result filename.
2560 See `comint-source-default' for more on determining defaults.
2562 PROMPT is the prompt string. PREV-DIR/FILE is the (DIRECTORY . FILE) pair
2563 from the last source processing command. SOURCE-MODES is a list of major
2564 modes used to determine what file buffers contain source files. (These
2565 two arguments are used for determining defaults.) If MUSTMATCH-P is true,
2566 then the filename reader will only accept a file that exists.
2568 A typical use:
2570 '(lisp-mode) t))"
2571 (let* ((def (comint-source-default prev-dir/file source-modes))
2572 (stringfile (comint-extract-string))
2573 (sfile-p (and stringfile
2574 (condition-case ()
2575 (file-exists-p stringfile)
2576 (error nil))
2577 (not (file-directory-p stringfile))))
2578 (defdir (if sfile-p (file-name-directory stringfile)
2579 (car def)))
2580 (deffile (if sfile-p (file-name-nondirectory stringfile)
2581 (cdr def)))
2582 (ans (read-file-name (if deffile (format "%s(default %s) "
2583 prompt deffile)
2584 prompt)
2585 defdir
2586 (concat defdir deffile)
2587 mustmatch-p)))
2588 (list (expand-file-name (substitute-in-file-name ans)))))
2590 ;; I am somewhat divided on this string-default feature. It seems
2591 ;; to violate the principle-of-least-astonishment, in that it makes
2592 ;; the default harder to predict, so you actually have to look and see
2593 ;; what the default really is before choosing it. This can trip you up.
2594 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2595 ;; on this.
2596 ;; -Olin
2598 \f
2599 ;; Simple process query facility.
2600 ;; ===========================================================================
2601 ;; This function is for commands that want to send a query to the process
2602 ;; and show the response to the user. For example, a command to get the
2603 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2604 ;; to an inferior Common Lisp process.
2605 ;;
2606 ;; This simple facility just sends strings to the inferior process and pops
2607 ;; up a window for the process buffer so you can see what the process
2608 ;; responds with. We don't do anything fancy like try to intercept what the
2609 ;; process responds with and put it in a pop-up window or on the message
2610 ;; line. We just display the buffer. Low tech. Simple. Works good.
2612 (defun comint-proc-query (proc str)
2613 "Send to the inferior process PROC the string STR.
2614 Pop-up but do not select a window for the inferior process so that
2615 its response can be seen."
2616 (let* ((proc-buf (process-buffer proc))
2617 (proc-mark (process-mark proc)))
2618 (display-buffer proc-buf)
2619 (set-buffer proc-buf) ; but it's not the selected *window*
2620 (let ((proc-win (get-buffer-window proc-buf 0))
2621 (proc-pt (marker-position proc-mark)))
2622 (comint-send-string proc str) ; send the query
2623 (accept-process-output proc) ; wait for some output
2624 ;; Try to position the proc window so you can see the answer.
2625 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2626 ;; I don't know why. Wizards invited to improve it.
2627 (unless (pos-visible-in-window-p proc-pt proc-win)
2628 (let ((opoint (window-point proc-win)))
2629 (set-window-point proc-win proc-mark)
2630 (sit-for 0)
2631 (if (not (pos-visible-in-window-p opoint proc-win))
2632 (push-mark opoint)
2633 (set-window-point proc-win opoint)))))))
2635 \f
2636 ;; Filename/command/history completion in a buffer
2637 ;; ===========================================================================
2638 ;; Useful completion functions, courtesy of the Ergo group.
2640 ;; Six commands:
2641 ;; comint-dynamic-complete Complete or expand command, filename,
2642 ;; history at point.
2643 ;; comint-dynamic-complete-filename Complete filename at point.
2644 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2645 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2646 ;; replace with expanded/completed name.
2647 ;; comint-dynamic-simple-complete Complete stub given candidates.
2649 ;; These are not installed in the comint-mode keymap. But they are
2650 ;; available for people who want them. Shell-mode installs them:
2652 ;; (define-key shell-mode-map "\M-?"
2653 ;; 'comint-dynamic-list-filename-completions)))
2654 ;;
2655 ;; Commands like this are fine things to put in load hooks if you
2656 ;; want them present in specific modes.
2658 (defcustom comint-completion-autolist nil
2659 "*If non-nil, automatically list possibilities on partial completion.
2660 This mirrors the optional behavior of tcsh."
2661 :type 'boolean
2662 :group 'comint-completion)
2664 (defcustom comint-completion-addsuffix t
2665 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2666 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2667 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2668 This mirrors the optional behavior of tcsh."
2669 :type '(choice (const :tag "None" nil)
2670 (const :tag "Add /" t)
2671 (cons :tag "Suffix pair"
2672 (string :tag "Directory suffix")
2673 (string :tag "File suffix")))
2674 :group 'comint-completion)
2676 (defcustom comint-completion-recexact nil
2677 "*If non-nil, use shortest completion if characters cannot be added.
2678 This mirrors the optional behavior of tcsh.
2680 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2681 :type 'boolean
2682 :group 'comint-completion)
2684 (defcustom comint-completion-fignore nil
2685 "*List of suffixes to be disregarded during file completion.
2686 This mirrors the optional behavior of bash and tcsh.
2688 Note that this applies to `comint-dynamic-complete-filename' only."
2689 :type '(repeat (string :tag "Suffix"))
2690 :group 'comint-completion)
2692 ;;;###autoload
2693 (defvar comint-file-name-prefix ""
2694 "Prefix prepended to absolute file names taken from process input.
2695 This is used by Comint's and shell's completion functions, and by shell's
2696 directory tracking functions.")
2698 (defvar comint-file-name-chars
2699 (if (memq system-type '(ms-dos windows-nt cygwin))
2700 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2701 "[]~/A-Za-z0-9+@:_.$#%,={}-")
2702 "String of characters valid in a file name.
2703 Note that all non-ASCII characters are considered valid in a file name
2704 regardless of what this variable says.
2706 This is a good thing to set in mode hooks.")
2708 (defvar comint-file-name-quote-list nil
2711 This is a good thing to set in mode hooks.")
2714 (defun comint-directory (directory)
2715 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
2716 (expand-file-name (if (file-name-absolute-p directory)
2717 (concat comint-file-name-prefix directory)
2718 directory)))
2721 (defun comint-word (word-chars)
2722 "Return the word of WORD-CHARS at point, or nil if none is found.
2723 Word constituents are considered to be those in WORD-CHARS, which is like the
2725 (save-excursion
2726 (let ((here (point))
2727 giveup)
2728 (while (not giveup)
2729 (let ((startpoint (point)))
2731 ;; Fixme: This isn't consistent with Bash, at least -- not
2732 ;; all non-ASCII chars should be word constituents.
2733 (if (and (> (- (point) 2) (point-min))
2735 (forward-char -2))
2736 (if (and (> (- (point) 1) (point-min))
2737 (>= (char-after (- (point) 1)) 128))
2738 (forward-char -1))
2739 (if (= (point) startpoint)
2740 (setq giveup t))))
2741 ;; Set match-data to match the entire string.
2742 (when (< (point) here)
2743 (set-match-data (list (point) here))
2744 (match-string 0)))))
2746 (defun comint-substitute-in-file-name (filename)
2747 "Return FILENAME with environment variables substituted.
2748 Supports additional environment variable syntax of the command
2749 interpreter (e.g., the percent notation of cmd.exe on NT)."
2750 (let ((name (substitute-in-file-name filename)))
2751 (if (memq system-type '(ms-dos windows-nt))
2752 (let (env-var-name
2753 env-var-val)
2754 (save-match-data
2756 (setq env-var-name
2757 (substring name (match-beginning 1) (match-end 1)))
2758 (setq env-var-val (if (getenv env-var-name)
2759 (getenv env-var-name)
2760 ""))
2761 (setq name (replace-match env-var-val t t name))))))
2762 name))
2764 (defun comint-match-partial-filename ()
2765 "Return the filename at point, or nil if none is found.
2766 Environment variables are substituted. See `comint-word'."
2767 (let ((filename (comint-word comint-file-name-chars)))
2768 (and filename (comint-substitute-in-file-name
2769 (comint-unquote-filename filename)))))
2772 (defun comint-quote-filename (filename)
2773 "Return FILENAME with magic characters quoted.
2774 Magic characters are those in `comint-file-name-quote-list'."
2775 (if (null comint-file-name-quote-list)
2776 filename
2777 (let ((regexp
2778 (format "[%s]"
2779 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
2780 (save-match-data
2781 (let ((i 0))
2782 (while (string-match regexp filename i)
2784 (setq i (1+ (match-end 0)))))
2785 filename))))
2787 (defun comint-unquote-filename (filename)
2788 "Return FILENAME with quoted characters unquoted."
2789 (if (null comint-file-name-quote-list)
2790 filename
2791 (save-match-data
2792 (let ((i 0))
2795 (setq i (+ 1 (match-beginning 0)))))
2796 filename)))
2799 (defun comint-dynamic-complete ()
2800 "Dynamically perform completion at point.
2801 Calls the functions in `comint-dynamic-complete-functions' to perform
2802 completion until a function returns non-nil, at which point completion is
2803 assumed to have occurred."
2804 (interactive)
2805 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
2808 (defun comint-dynamic-complete-filename ()
2809 "Dynamically complete the filename at point.
2810 Completes if after a filename. See `comint-match-partial-filename' and
2811 `comint-dynamic-complete-as-filename'.
2812 This function is similar to `comint-replace-by-expanded-filename', except that
2813 it won't change parts of the filename already entered in the buffer; it just
2814 adds completion characters to the end of the filename. A completions listing
2815 may be shown in a help buffer if completion is ambiguous.
2817 Completion is dependent on the value of `comint-completion-addsuffix',
2818 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2819 completions listing is dependent on the value of `comint-completion-autolist'.
2821 Returns t if successful."
2822 (interactive)
2823 (when (comint-match-partial-filename)
2824 (unless (window-minibuffer-p (selected-window))
2825 (message "Completing file name..."))
2826 (comint-dynamic-complete-as-filename)))
2828 (defun comint-dynamic-complete-as-filename ()
2829 "Dynamically complete at point as a filename.
2830 See `comint-dynamic-complete-filename'. Returns t if successful."
2831 (let* ((completion-ignore-case read-file-name-completion-ignore-case)
2832 (completion-ignored-extensions comint-completion-fignore)
2833 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2834 ;; I think it was originally bound to solve file completion problems,
2835 ;; but subsequent changes may have made this unnecessary. sm.
2836 ;;(file-name-handler-alist nil)
2837 (minibuffer-p (window-minibuffer-p (selected-window)))
2838 (success t)
2839 (dirsuffix (cond ((not comint-completion-addsuffix)
2840 "")
2841 ((not (consp comint-completion-addsuffix))
2842 "/")
2843 (t
2844 (car comint-completion-addsuffix))))
2845 (filesuffix (cond ((not comint-completion-addsuffix)
2846 "")
2847 ((not (consp comint-completion-addsuffix))
2848 " ")
2849 (t
2850 (cdr comint-completion-addsuffix))))
2851 (filename (or (comint-match-partial-filename) ""))
2852 (filedir (file-name-directory filename))
2853 (filenondir (file-name-nondirectory filename))
2854 (directory (if filedir (comint-directory filedir) default-directory))
2855 (completion (file-name-completion filenondir directory)))
2856 (cond ((null completion)
2857 (message "No completions of %s" filename)
2858 (setq success nil))
2859 ((eq completion t) ; Means already completed "file".
2860 (insert filesuffix)
2861 (unless minibuffer-p
2862 (message "Sole completion")))
2863 ((string-equal completion "") ; Means completion on "directory/".
2864 (comint-dynamic-list-filename-completions))
2865 (t ; Completion string returned.
2866 (let ((file (concat (file-name-as-directory directory) completion)))
2867 (insert (comint-quote-filename
2868 (substring (directory-file-name completion)
2869 (length filenondir))))
2870 (cond ((symbolp (file-name-completion completion directory))
2871 ;; We inserted a unique completion.
2872 (insert (if (file-directory-p file) dirsuffix filesuffix))
2873 (unless minibuffer-p
2874 (message "Completed")))
2875 ((and comint-completion-recexact comint-completion-addsuffix
2876 (string-equal filenondir completion)
2877 (file-exists-p file))
2878 ;; It's not unique, but user wants shortest match.
2879 (insert (if (file-directory-p file) dirsuffix filesuffix))
2880 (unless minibuffer-p
2881 (message "Completed shortest")))
2882 ((or comint-completion-autolist
2883 (string-equal filenondir completion))
2884 ;; It's not unique, list possible completions.
2885 (comint-dynamic-list-filename-completions))
2886 (t
2887 (unless minibuffer-p
2888 (message "Partially completed")))))))
2889 success))
2892 (defun comint-replace-by-expanded-filename ()
2893 "Dynamically expand and complete the filename at point.
2894 Replace the filename with an expanded, canonicalized and completed replacement.
2897 removed, and the filename is made absolute instead of relative. For expansion
2898 see `expand-file-name' and `substitute-in-file-name'. For completion see
2899 `comint-dynamic-complete-filename'."
2900 (interactive)
2901 (let ((filename (comint-match-partial-filename)))
2902 (when filename
2903 (replace-match (expand-file-name filename) t t)
2904 (comint-dynamic-complete-filename))))
2907 (defun comint-dynamic-simple-complete (stub candidates)
2908 "Dynamically complete STUB from CANDIDATES list.
2909 This function inserts completion characters at point by completing STUB from
2910 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2911 if completion is ambiguous.
2913 Returns nil if no completion was inserted.
2914 Returns `sole' if completed with the only completion match.
2915 Returns `shortest' if completed with the shortest of the completion matches.
2916 Returns `partial' if completed as far as possible with the completion matches.
2917 Returns `listed' if a completion listing was shown.
2919 See also `comint-dynamic-complete-filename'."
2920 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2921 (suffix (cond ((not comint-completion-addsuffix) "")
2922 ((not (consp comint-completion-addsuffix)) " ")
2923 (t (cdr comint-completion-addsuffix))))
2924 (completions (all-completions stub candidates)))
2925 (cond ((null completions)
2926 (message "No completions of %s" stub)
2927 nil)
2928 ((= 1 (length completions)) ; Gotcha!
2929 (let ((completion (car completions)))
2930 (if (string-equal completion stub)
2931 (message "Sole completion")
2932 (insert (substring completion (length stub)))
2933 (message "Completed"))
2934 (insert suffix)
2935 'sole))
2936 (t ; There's no unique completion.
2937 (let ((completion (try-completion stub candidates)))
2938 ;; Insert the longest substring.
2939 (insert (substring completion (length stub)))
2940 (cond ((and comint-completion-recexact comint-completion-addsuffix
2941 (string-equal stub completion)
2942 (member completion completions))
2943 ;; It's not unique, but user wants shortest match.
2944 (insert suffix)
2945 (message "Completed shortest")
2946 'shortest)
2947 ((or comint-completion-autolist
2948 (string-equal stub completion))
2949 ;; It's not unique, list possible completions.
2950 (comint-dynamic-list-completions completions)
2951 'listed)
2952 (t
2953 (message "Partially completed")
2954 'partial)))))))
2957 (defun comint-dynamic-list-filename-completions ()
2958 "List in help buffer possible completions of the filename at point."
2959 (interactive)
2960 (let* ((completion-ignore-case read-file-name-completion-ignore-case)
2961 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2962 ;; I think it was originally bound to solve file completion problems,
2963 ;; but subsequent changes may have made this unnecessary. sm.
2964 ;;(file-name-handler-alist nil)
2965 (filename (or (comint-match-partial-filename) ""))
2966 (filedir (file-name-directory filename))
2967 (filenondir (file-name-nondirectory filename))
2968 (directory (if filedir (comint-directory filedir) default-directory))
2969 (completions (file-name-all-completions filenondir directory)))
2970 (if (not completions)
2971 (message "No completions of %s" filename)
2972 (comint-dynamic-list-completions
2973 (mapcar 'comint-quote-filename completions)))))
2976 ;; This is bound locally in a *Completions* buffer to the list of
2977 ;; completions displayed, and is used to detect the case where the same
2978 ;; command is repeatedly used without the set of completions changing.
2979 (defvar comint-displayed-dynamic-completions nil)
2981 (defvar comint-dynamic-list-completions-config nil)
2983 (defun comint-dynamic-list-completions (completions)
2984 "List in help buffer sorted COMPLETIONS.
2985 Typing SPC flushes the help buffer."
2986 (let ((window (get-buffer-window "*Completions*" 0)))
2987 (setq completions (sort completions 'string-lessp))
2988 (if (and (eq last-command this-command)
2989 window (window-live-p window) (window-buffer window)
2990 (buffer-name (window-buffer window))
2991 ;; The above tests are not sufficient to detect the case where we
2992 ;; should scroll, because the top-level interactive command may
2993 ;; not have displayed a completions window the last time it was
2994 ;; invoked, and there may be such a window left over from a
2995 ;; previous completion command with a different set of
2996 ;; completions. To detect that case, we also test that the set
2997 ;; of displayed completions is in fact the same as the previously
2998 ;; displayed set.
2999 (equal completions
3000 (buffer-local-value 'comint-displayed-dynamic-completions
3001 (window-buffer window))))
3002 ;; If this command was repeated, and
3003 ;; there's a fresh completion window with a live buffer,
3004 ;; and this command is repeated, scroll that window.
3005 (with-current-buffer (window-buffer window)
3006 (if (pos-visible-in-window-p (point-max) window)
3007 (set-window-start window (point-min))
3008 (save-selected-window
3009 (select-window window)
3010 (scroll-up))))
3012 ;; Display a completion list for the first time.
3013 (setq comint-dynamic-list-completions-config
3014 (current-window-configuration))
3015 (with-output-to-temp-buffer "*Completions*"
3016 (display-completion-list completions))
3017 (message "Type space to flush; repeat completion command to scroll"))
3019 ;; Read the next key, to process SPC.
3020 (let (key first)
3021 (if (with-current-buffer (get-buffer "*Completions*")
3022 (set (make-local-variable 'comint-displayed-dynamic-completions)
3023 completions)
3024 (setq key (read-key-sequence nil)
3025 first (aref key 0))
3026 (and (consp first) (consp (event-start first))
3027 (eq (window-buffer (posn-window (event-start first)))
3028 (get-buffer "*Completions*"))
3029 (eq (key-binding key) 'mouse-choose-completion)))
3030 ;; If the user does mouse-choose-completion with the mouse,
3031 ;; execute the command, then delete the completion window.
3032 (progn
3033 (mouse-choose-completion first)
3034 (set-window-configuration comint-dynamic-list-completions-config))
3035 (if (eq first ?\s)
3036 (set-window-configuration comint-dynamic-list-completions-config)
3037 (setq unread-command-events (listify-key-sequence key)))))))
3039 \f
3040 (defun comint-get-next-from-history ()
3041 "After fetching a line from input history, this fetches the following line.
3042 In other words, this recalls the input line after the line you recalled last.
3043 You can use this to repeat a sequence of input lines."
3044 (interactive)
3045 (if comint-save-input-ring-index
3046 (progn
3047 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
3048 (comint-next-input 1))
3049 (message "No previous history command")))
3051 (defun comint-accumulate ()
3052 "Accumulate a line to send as input along with more lines.
3053 This inserts a newline so that you can enter more text
3055 to send all the accumulated input, at once.
3056 The entire accumulated text becomes one item in the input history
3057 when you send it."
3058 (interactive)
3060 (set-marker comint-accum-marker (point))
3061 (if comint-input-ring-index
3062 (setq comint-save-input-ring-index
3063 (- comint-input-ring-index 1))))
3065 (defun comint-goto-process-mark ()
3066 "Move point to the process mark.
3067 The process mark separates output, and input already sent,
3068 from input that has not yet been sent."
3069 (interactive)
3070 (let ((proc (or (get-buffer-process (current-buffer))
3071 (error "Current buffer has no process"))))
3072 (goto-char (process-mark proc))
3073 (when (interactive-p)
3074 (message "Point is now at the process mark"))))
3076 (defun comint-bol-or-process-mark ()
3077 "Move point to beginning of line (after prompt) or to the process mark.
3078 The first time you use this command, it moves to the beginning of the line
3079 \(but after the prompt, if any). If you repeat it again immediately,
3080 it moves point to the process mark.
3082 The process mark separates the process output, along with input already sent,
3083 from input that has not yet been sent. Ordinarily, the process mark
3084 is at the beginning of the current input line; but if you have
3086 the process mark is at the beginning of the accumulated input."
3087 (interactive)
3088 (if (not (eq last-command 'comint-bol-or-process-mark))
3089 (comint-bol nil)
3090 (comint-goto-process-mark)))
3092 (defun comint-set-process-mark ()
3093 "Set the process mark at point."
3094 (interactive)
3095 (let ((proc (or (get-buffer-process (current-buffer))
3096 (error "Current buffer has no process"))))
3097 (set-marker (process-mark proc) (point))
3098 (message "Process mark set")))
3100 \f
3101 ;; Author: Peter Breton <pbreton@cs.umb.edu>
3103 ;; This little add-on for comint is intended to make it easy to get
3104 ;; output from currently active comint buffers into another buffer,
3105 ;; or buffers, and then go back to using the comint shell.
3106 ;;
3107 ;; My particular use is SQL interpreters; I want to be able to execute a
3108 ;; query using the process associated with a comint-buffer, and save that
3109 ;; somewhere else. Because the process might have state (for example, it
3110 ;; could be in an uncommitted transaction), just running starting a new
3111 ;; process and having it execute the query and then finish, would not
3112 ;; work. I'm sure there are other uses as well, although in many cases
3113 ;; starting a new process is the simpler, and thus preferable, approach.
3114 ;;
3115 ;; The basic implementation is as follows: comint-redirect changes the
3116 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
3117 ;; its own filter. The filter puts the output into the designated buffer,
3118 ;; or buffers, until it sees a regexp that tells it to stop (by default,
3119 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
3120 ;; sees the stop regexp, it restores the old filter functions, and runs
3121 ;; `comint-redirect-hook'.
3122 ;;
3123 ;; Each comint buffer may only use one redirection at a time, but any number
3124 ;; of different comint buffers may be simultaneously redirected.
3125 ;;
3126 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
3127 ;; correct prompt for your interpreter, or that you supply a regexp that says
3128 ;; when the redirection is finished. Otherwise, redirection will continue
3129 ;; indefinitely. The code now does a sanity check to ensure that it can find
3130 ;; a prompt in the comint buffer; however, it is still important to ensure that
3131 ;; this prompt is set correctly.
3132 ;;
3133 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
3134 ;; perhaps it should prompt for a terminating string (with an
3135 ;; appropriate magic default by examining what we think is the prompt)?
3136 ;;
3137 ;; Fixme: look for appropriate fields, rather than regexp, if
3138 ;; `comint-use-prompt-regexp' is true.
3140 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3141 ;; Variables
3142 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3144 (defcustom comint-redirect-verbose nil
3145 "*If non-nil, print messages each time the redirection filter is invoked.
3146 Also print a message when redirection is completed."
3147 :group 'comint
3148 :type 'boolean)
3150 ;; Directly analagous to comint-preoutput-filter-functions
3151 (defvar comint-redirect-filter-functions nil
3152 "List of functions to call before inserting redirected process output.
3153 Each function gets one argument, a string containing the text received
3154 from the subprocess. It should return the string to insert, perhaps
3155 the same string that was received, or perhaps a modified or transformed
3156 string.
3158 The functions on the list are called sequentially, and each one is given
3159 the string returned by the previous one. The string returned by the
3160 last function is the text that is actually inserted in the redirection buffer.
3162 You can use `add-hook' to add functions to this list
3163 either globally or locally.")
3165 ;; Internal variables
3167 (defvar comint-redirect-output-buffer nil
3168 "The buffer or list of buffers to put output into.")
3170 (defvar comint-redirect-finished-regexp nil
3171 "Regular expression that determines when to stop redirection in Comint.
3172 When the redirection filter function is given output that matches this regexp,
3173 the output is inserted as usual, and redirection is completed.")
3175 (defvar comint-redirect-insert-matching-regexp nil
3176 "If non-nil, the text that ends a redirection is included in it.
3177 More precisely, the text that matches `comint-redirect-finished-regexp'
3178 and therefore terminates an output redirection is inserted in the
3179 redirection target buffer, along with the preceding output.")
3181 (defvar comint-redirect-echo-input nil
3182 "Non-nil means echo input in the process buffer even during redirection.")
3184 (defvar comint-redirect-completed nil
3185 "Non-nil if redirection has completed in the current buffer.")
3187 (defvar comint-redirect-original-mode-line-process nil
3188 "Original mode line for redirected process.")
3190 (defvar comint-redirect-perform-sanity-check t
3191 "If non-nil, check that redirection is likely to complete successfully.
3192 More precisely, before starting a redirection, verify that the
3193 regular expression `comint-redirect-finished-regexp' that controls
3194 when to terminate it actually matches some text already in the process
3195 buffer. The idea is that this regular expression should match a prompt
3196 string, and that there ought to be at least one copy of your prompt string
3197 in the process buffer already.")
3199 (defvar comint-redirect-original-filter-function nil
3200 "The process filter that was in place when redirection is started.
3201 When redirection is completed, the process filter is restored to
3202 this value.")
3204 (defvar comint-redirect-subvert-readonly nil
3205 "Non-nil means `comint-redirect' can insert into read-only buffers.
3206 This works by binding `inhibit-read-only' around the insertion.
3207 This is useful, for instance, for insertion into Help mode buffers.
3208 You probably want to set it locally to the output buffer.")
3210 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3211 ;; Functions
3212 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3214 (defun comint-redirect-setup (output-buffer
3215 comint-buffer
3216 finished-regexp
3217 &optional echo-input)
3218 "Set up for output redirection.
3219 This function sets local variables that are used by `comint-redirect-filter'
3220 to perform redirection.
3222 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3223 in the output matches FINISHED-REGEXP.
3225 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3226 original Comint buffer.
3228 This function is called by `comint-redirect-send-command-to-process',
3229 and does not normally need to be invoked by the end user or programmer."
3230 (with-current-buffer comint-buffer
3232 (make-local-variable 'comint-redirect-original-mode-line-process)
3233 (setq comint-redirect-original-mode-line-process mode-line-process)
3235 (make-local-variable 'comint-redirect-output-buffer)
3236 (setq comint-redirect-output-buffer output-buffer)
3238 (make-local-variable 'comint-redirect-finished-regexp)
3239 (setq comint-redirect-finished-regexp finished-regexp)
3241 (make-local-variable 'comint-redirect-echo-input)
3242 (setq comint-redirect-echo-input echo-input)
3244 (make-local-variable 'comint-redirect-completed)
3245 (setq comint-redirect-completed nil)
3247 (setq mode-line-process
3248 (if mode-line-process
3249 (list (concat (elt mode-line-process 0) " Redirection"))
3250 (list ":%s Redirection")))))
3252 (defun comint-redirect-cleanup ()
3253 "End a Comint redirection. See `comint-redirect-send-command'."
3254 (interactive)
3255 ;; Restore the process filter
3256 (set-process-filter (get-buffer-process (current-buffer))
3257 comint-redirect-original-filter-function)
3258 ;; Restore the mode line
3259 (setq mode-line-process comint-redirect-original-mode-line-process)
3260 ;; Set the completed flag
3261 (setq comint-redirect-completed t))
3263 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3264 ;; that it really occurs.
3265 (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
3267 (defun comint-redirect-filter (process input-string)
3268 "Filter function which redirects output from PROCESS to a buffer or buffers.
3269 The variable `comint-redirect-output-buffer' says which buffer(s) to
3270 place output in.
3272 INPUT-STRING is the input from the Comint process.
3274 This function runs as a process filter, and does not need to be invoked by the
3275 end user."
3276 (and process
3277 (with-current-buffer (process-buffer process)
3278 (comint-redirect-preoutput-filter input-string)
3279 ;; If we have to echo output, give it to the original filter function
3280 (and comint-redirect-echo-input
3281 comint-redirect-original-filter-function
3282 (funcall comint-redirect-original-filter-function
3283 process input-string)))))
3286 (defun comint-redirect-preoutput-filter (input-string)
3287 "Comint filter function which redirects Comint output to a buffer or buffers.
3288 The variable `comint-redirect-output-buffer' says which buffer(s) to
3289 place output in.
3291 INPUT-STRING is the input from the Comint process.
3293 This function does not need to be invoked by the end user."
3294 (let ((output-buffer-list
3295 (if (listp comint-redirect-output-buffer)
3296 comint-redirect-output-buffer
3297 (list comint-redirect-output-buffer)))
3298 (filtered-input-string input-string))
3300 ;; If there are any filter functions, give them a chance to modify the string
3301 (let ((functions comint-redirect-filter-functions))
3302 (while (and functions filtered-input-string)
3303 (if (eq (car functions) t)
3304 ;; If a local value says "use the default value too",
3305 ;; do that.
3306 (let ((functions (default-value 'comint-redirect-filter-functions)))
3307 (while (and functions filtered-input-string)
3308 (setq filtered-input-string
3309 (funcall (car functions) filtered-input-string))
3310 (setq functions (cdr functions))))
3311 (setq filtered-input-string
3312 (funcall (car functions) filtered-input-string)))
3313 (setq functions (cdr functions))))
3315 ;; Clobber `comint-redirect-finished-regexp'
3316 (or comint-redirect-insert-matching-regexp
3317 (and (string-match comint-redirect-finished-regexp filtered-input-string)
3318 (setq filtered-input-string
3319 (replace-match "" nil nil filtered-input-string))))
3321 ;; Send output to all registered buffers
3322 (save-excursion
3323 (dolist (buf output-buffer-list)
3324 ;; Set this buffer to the output buffer
3325 (set-buffer (get-buffer-create buf))
3326 ;; Go to the end of the buffer
3327 (goto-char (point-max))
3328 ;; Insert the output
3329 (let ((inhibit-read-only comint-redirect-subvert-readonly))
3330 (insert filtered-input-string))))
3332 ;; Message
3333 (and comint-redirect-verbose
3334 (message "Redirected output to buffer(s) %s"
3335 (mapconcat 'identity output-buffer-list " ")))
3337 ;; If we see the prompt, tidy up
3338 ;; We'll look for the prompt in the original string, so nobody can
3339 ;; clobber it
3340 (and (string-match comint-redirect-finished-regexp input-string)
3341 (progn
3342 (and comint-redirect-verbose
3343 (message "Redirection completed"))
3344 (comint-redirect-cleanup)
3345 (run-hooks 'comint-redirect-hook)))
3346 ;; Echo input?
3347 (if comint-redirect-echo-input
3348 filtered-input-string
3349 "")))
3351 ;;;###autoload
3352 (defun comint-redirect-send-command (command output-buffer echo &optional no-display)
3353 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3354 With prefix arg ECHO, echo output in process buffer.
3356 If NO-DISPLAY is non-nil, do not show the output buffer."
3358 (let ((process (get-buffer-process (current-buffer))))
3359 (if process
3360 (comint-redirect-send-command-to-process
3361 command output-buffer (current-buffer) echo no-display)
3362 (error "No process for current buffer"))))
3364 ;;;###autoload
3365 (defun comint-redirect-send-command-to-process
3366 (command output-buffer process echo &optional no-display)
3367 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3368 With prefix arg, echo output in process buffer.
3370 If NO-DISPLAY is non-nil, do not show the output buffer."
3372 (let* (;; The process buffer
3373 (process-buffer (if (processp process)
3374 (process-buffer process)
3375 process))
3376 (proc (get-buffer-process process-buffer)))
3377 ;; Change to the process buffer
3378 (with-current-buffer process-buffer
3380 ;; Make sure there's a prompt in the current process buffer
3381 (and comint-redirect-perform-sanity-check
3382 (save-excursion
3383 (goto-char (point-max))
3384 (or (re-search-backward comint-prompt-regexp nil t)
3385 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3387 ;;;;;;;;;;;;;;;;;;;;;
3388 ;; Set up for redirection
3389 ;;;;;;;;;;;;;;;;;;;;;
3390 (comint-redirect-setup
3391 ;; Output Buffer
3392 output-buffer
3393 ;; Comint Buffer
3394 (current-buffer)
3395 ;; Finished Regexp
3396 comint-prompt-regexp
3397 ;; Echo input
3398 echo)
3400 ;;;;;;;;;;;;;;;;;;;;;
3401 ;; Set the filter
3402 ;;;;;;;;;;;;;;;;;;;;;
3403 ;; Save the old filter
3404 (setq comint-redirect-original-filter-function
3405 (process-filter proc))
3406 (set-process-filter proc 'comint-redirect-filter)
3408 ;;;;;;;;;;;;;;;;;;;;;
3409 ;; Send the command
3410 ;;;;;;;;;;;;;;;;;;;;;
3411 (process-send-string
3412 (current-buffer)
3415 ;;;;;;;;;;;;;;;;;;;;;
3416 ;; Show the output
3417 ;;;;;;;;;;;;;;;;;;;;;
3418 (or no-display
3419 (display-buffer
3420 (get-buffer-create
3421 (if (listp output-buffer)
3422 (car output-buffer)
3423 output-buffer)))))))
3425 ;;;###autoload
3426 (defun comint-redirect-results-list (command regexp regexp-group)
3427 "Send COMMAND to current process.
3428 Return a list of expressions in the output which match REGEXP.
3429 REGEXP-GROUP is the regular expression group in REGEXP to use."
3430 (comint-redirect-results-list-from-process
3431 (get-buffer-process (current-buffer))
3432 command regexp regexp-group))
3434 ;;;###autoload
3435 (defun comint-redirect-results-list-from-process (process command regexp regexp-group)
3436 "Send COMMAND to PROCESS.
3437 Return a list of expressions in the output which match REGEXP.
3438 REGEXP-GROUP is the regular expression group in REGEXP to use."
3439 (let ((output-buffer " *Comint Redirect Work Buffer*")
3440 results)
3441 (save-excursion
3442 (set-buffer (get-buffer-create output-buffer))
3443 (erase-buffer)
3444 (comint-redirect-send-command-to-process command
3445 output-buffer process nil t)
3446 ;; Wait for the process to complete
3447 (set-buffer (process-buffer process))
3448 (while (null comint-redirect-completed)
3449 (accept-process-output nil 1))
3450 ;; Collect the output
3451 (set-buffer output-buffer)
3452 (goto-char (point-min))
3453 ;; Skip past the command, if it was echoed
3454 (and (looking-at command)
3455 (forward-line))
3456 (while (re-search-forward regexp nil t)
3457 (setq results
3458 (cons (buffer-substring-no-properties
3459 (match-beginning regexp-group)
3460 (match-end regexp-group))
3461 results)))
3462 results)))
3464 (mapc (lambda (x)
3465 (add-to-list 'debug-ignored-errors x))
3466 '("^Not at command line$"
3467 "^Empty input ring$"
3468 "^No history$"
3469 "^Not found$" ; Too common?
3470 "^Current buffer has no process$"))
3472 \f
3473 ;; Converting process modes to use comint mode
3474 ;; ===========================================================================
3475 ;; The code in the Emacs 19 distribution has all been modified to use comint
3476 ;; where needed. However, there are `third-party' packages out there that
3477 ;; still use the old shell mode. Here's a guide to conversion.
3478 ;;
3479 ;; Renaming variables
3480 ;; Most of the work is renaming variables and functions. These are the common
3481 ;; ones:
3482 ;; Local variables:
3483 ;; last-input-start comint-last-input-start
3484 ;; last-input-end comint-last-input-end
3485 ;; shell-prompt-pattern comint-prompt-regexp
3486 ;; shell-set-directory-error-hook <no equivalent>
3487 ;; Miscellaneous:
3488 ;; shell-set-directory <unnecessary>
3489 ;; shell-mode-map comint-mode-map
3490 ;; Commands:
3491 ;; shell-send-input comint-send-input
3492 ;; shell-send-eof comint-delchar-or-maybe-eof
3493 ;; kill-shell-input comint-kill-input
3494 ;; interrupt-shell-subjob comint-interrupt-subjob
3495 ;; stop-shell-subjob comint-stop-subjob
3496 ;; quit-shell-subjob comint-quit-subjob
3497 ;; kill-shell-subjob comint-kill-subjob
3498 ;; kill-output-from-shell comint-delete-output
3499 ;; show-output-from-shell comint-show-output
3500 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3501 ;;
3502 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3503 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3504 ;; Comint mode does not provide functionality equivalent to
3505 ;; shell-set-directory-error-hook; it is gone.
3506 ;;
3507 ;; comint-last-input-start is provided for modes which want to munge
3508 ;; the buffer after input is sent, perhaps because the inferior
3509 ;; insists on echoing the input. The LAST-INPUT-START variable in
3510 ;; the old shell package was used to implement a history mechanism,
3511 ;; but you should think twice before using comint-last-input-start
3512 ;; for this; the input history ring often does the job better.
3513 ;;
3514 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3515 ;; *not* create the comint-mode local variables in your foo-mode function.
3516 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3517 ;; necessary comint-specific local variables. Then create the
3518 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3519 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3520 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3521 ;; get-old-input) that need to be different from the defaults. Call
3522 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3523 ;; comint-mode will take care of it. The following example, from shell.el,
3524 ;; is typical:
3525 ;;
3526 ;; (defvar shell-mode-map '())
3527 ;; (cond ((not shell-mode-map)
3528 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3529 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3530 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3532 ;; (define-key shell-mode-map "\M-?"
3533 ;; 'comint-dynamic-list-filename-completions)))
3534 ;;
3535 ;; (defun shell-mode ()
3536 ;; (interactive)
3537 ;; (comint-mode)
3538 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3539 ;; (setq major-mode 'shell-mode)
3540 ;; (setq mode-name "Shell")
3541 ;; (use-local-map shell-mode-map)
3542 ;; (make-local-variable 'shell-directory-stack)
3543 ;; (setq shell-directory-stack nil)
3544 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3545 ;; (run-mode-hooks 'shell-mode-hook))
3546 ;;
3547 ;;
3548 ;; Completion for comint-mode users
3549 ;;
3550 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3551 ;; hook to add completion functions to. Functions on this list should return
3552 ;; non-nil if completion occurs (i.e., further completion should not occur).
3553 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3554 ;; completion job.
3555 \f
3557 (provide 'comint)
3559 ;; arch-tag: 1793314c-09db-40be-9549-9aeae3e75164
3560 ;;; comint.el ends here