| blob | 5fd6d8f23a901a6c3b5686f58632be5fc2737eff |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 1990, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
5 ;; Free Software Foundation, Inc.
7 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
8 ;; Simon Marshall <simon@gnu.org>
9 ;; Maintainer: FSF
10 ;; Keywords: processes
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;; This file defines a general command-interpreter-in-a-buffer package
30 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
31 ;; modes on top of comint mode -- e.g., Lisp, shell, scheme, T, soar, ....
32 ;; This way, all these specific packages share a common base functionality,
33 ;; and a common set of bindings, which makes them easier to use (and
34 ;; saves code, implementation time, etc., etc.).
36 ;; Several packages are already defined using comint mode:
37 ;; - shell.el defines a shell-in-a-buffer mode.
38 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
39 ;;
40 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
41 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
42 ;; - The file soar.el tunes Lisp and inferior-lisp modes for Soar.
43 ;; - cmutex.el defines TeX and LaTeX modes that invoke TeX, LaTeX, BibTeX,
44 ;; previewers, and printers from within Emacs.
45 ;; - background.el allows csh-like job control inside Emacs.
46 ;; It is pretty easy to make new derived modes for other processes.
48 ;; For documentation on the functionality provided by Comint mode, and
49 ;; the hooks available for customising it, see the comments below.
50 ;; For further information on the standard derived modes (shell,
51 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
53 ;; For hints on converting existing process modes (e.g., tex-mode,
54 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
55 ;; instead of shell-mode, see the notes at the end of this file.
57 \f
58 ;; Brief Command Documentation:
59 ;;============================================================================
60 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
61 ;; mode)
62 ;;
63 ;; M-p comint-previous-input Cycle backwards in input history
64 ;; M-n comint-next-input Cycle forwards
65 ;; M-r comint-previous-matching-input Previous input matching a regexp
66 ;; M-s comint-next-matching-input Next input that matches
67 ;; M-C-l comint-show-output Show last batch of process output
68 ;; RET comint-send-input
69 ;; C-d comint-delchar-or-maybe-eof Delete char unless at end of buff
70 ;; C-c C-a comint-bol-or-process-mark First time, move point to bol;
71 ;; second time, move to process-mark.
72 ;; C-c C-u comint-kill-input ^u
73 ;; C-c C-w backward-kill-word ^w
74 ;; C-c C-c comint-interrupt-subjob ^c
75 ;; C-c C-z comint-stop-subjob ^z
76 ;; C-c C-\ comint-quit-subjob ^\
77 ;; C-c C-o comint-delete-output Delete last batch of process output
78 ;; C-c C-r comint-show-output Show last batch of process output
79 ;; C-c C-l comint-dynamic-list-input-ring List input history
80 ;;
81 ;; Not bound by default in comint-mode (some are in shell mode)
82 ;; comint-run Run a program under comint-mode
83 ;; send-invisible Read a line w/o echo, and send to proc
84 ;; comint-dynamic-complete-filename Complete filename at point.
85 ;; comint-dynamic-list-filename-completions List completions in help buffer.
86 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
87 ;; replace with expanded/completed name.
88 ;; comint-replace-by-expanded-history Expand history at point;
89 ;; replace with expanded name.
90 ;; comint-magic-space Expand history and add (a) space(s).
91 ;; comint-kill-subjob No mercy.
92 ;; comint-show-maximum-output Show as much output as possible.
93 ;; comint-continue-subjob Send CONT signal to buffer's process
94 ;; group. Useful if you accidentally
95 ;; suspend your process (with C-c C-z).
96 ;; comint-get-next-from-history Fetch successive input history lines
97 ;; comint-accumulate Combine lines to send them together
98 ;; as input.
99 ;; comint-goto-process-mark Move point to where process-mark is.
100 ;; comint-set-process-mark Set process-mark to point.
102 ;; comint-mode-hook is the Comint mode hook. Basically for your keybindings.
104 ;;; Code:
107 \f
108 ;; Buffer Local Variables:
109 ;;============================================================================
110 ;; Comint mode buffer local variables:
111 ;; comint-prompt-regexp string comint-bol uses to match prompt
112 ;; comint-delimiter-argument-list list For delimiters and arguments
113 ;; comint-last-input-start marker Handy if inferior always echoes
114 ;; comint-last-input-end marker For comint-delete-output command
115 ;; comint-input-ring-size integer For the input history
116 ;; comint-input-ring ring mechanism
117 ;; comint-input-ring-index number ...
118 ;; comint-save-input-ring-index number ...
119 ;; comint-input-autoexpand symbol ...
120 ;; comint-input-ignoredups boolean ...
121 ;; comint-dynamic-complete-functions hook For the completion mechanism
122 ;; comint-completion-fignore list ...
123 ;; comint-file-name-chars string ...
124 ;; comint-file-name-quote-list list ...
125 ;; comint-get-old-input function Hooks for specific
126 ;; comint-input-filter-functions hook process-in-a-buffer
127 ;; comint-output-filter-functions hook function modes.
128 ;; comint-preoutput-filter-functions hook
129 ;; comint-input-filter function ...
130 ;; comint-input-sender function ...
131 ;; comint-eol-on-send boolean ...
132 ;; comint-process-echoes boolean ...
133 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
134 ;; comint-move-point-for-output symbol ...
135 ;; comint-scroll-show-maximum-output boolean ...
136 ;; comint-accum-marker maker For comint-accumulate
137 ;;
138 ;; Comint mode non-buffer local variables:
139 ;; comint-completion-addsuffix boolean/cons For file name
140 ;; comint-completion-autolist boolean completion behavior
141 ;; comint-completion-recexact boolean ...
144 "General command interpreter in a window stuff."
148 "Completion facilities in comint."
152 "Source finding facilities in comint."
157 "Regexp to recognize prompts in the inferior process.
160 This variable is only used if the variable
161 `comint-use-prompt-regexp' is non-nil.
163 Good choices:
174 "If non-nil, the comint prompt is read only.
175 The read only region includes the newline before the prompt.
176 This does not affect existing prompts.
177 Certain derived modes may override this option.
179 If you set this option to t, then the safe way to temporarily
180 override the read-only-ness of comint prompts is to call
181 `comint-kill-whole-line' or `comint-kill-region' with no
182 narrowing in effect. This way you will be certain that none of
183 the remaining prompts will be accidentally messed up. You may
184 wish to put something like the following in your `.emacs' file:
186 \(add-hook 'comint-mode-hook
187 (lambda ()
189 (define-key comint-mode-map [C-S-backspace]
190 'comint-kill-whole-line)))
192 If you sometimes use comint-mode on text-only terminals or with `emacs -nw',
193 you might wish to use another binding for `comint-kill-whole-line'."
199 "List of characters to recognize as separate arguments in input.
200 Strings comprising a character in this list will separate the arguments
201 surrounding them, and also be regarded as arguments in their own right (unlike
202 whitespace). See `comint-arguments'.
203 Defaults to the empty list.
210 "If non-nil, expand input command history references on completion.
211 This mirrors the optional behavior of tcsh (its autoexpand and histlist).
213 If the value is `input', then the expansion is seen on input.
214 If the value is `history', then the expansion is only when inserting
215 into the buffer's input ring. See also `comint-magic-space' and
216 `comint-dynamic-complete'.
218 This variable is buffer-local."
226 "Face to use to highlight user input."
233 "Face to use to highlight prompts."
237 "If non-nil, don't add input matching the last on the input ring.
238 This mirrors the optional behavior of bash.
240 This variable is buffer-local."
245 "If non-nil, name of the file to read/write input history.
246 See also `comint-read-input-ring' and `comint-write-input-ring'.
248 This variable is buffer-local, and is a good thing to set in mode hooks."
250 file)
254 "Controls whether input to interpreter causes window to scroll.
255 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
256 If `this', scroll only the selected window.
258 The default is nil.
260 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
268 "Controls whether interpreter output moves point to the end of the output.
269 If nil, then output never moves point to the output.
270 (If the output occurs at point, it is inserted before point.)
271 If t or `all', move point in all windows showing the buffer.
272 If `this', move point only the selected window.
273 If `others', move point only in other windows, not in the selected window.
275 The default is nil.
277 See the variable `comint-scroll-show-maximum-output' and the function
278 `comint-postoutput-scroll-to-bottom'.
279 This variable is buffer-local in all Comint buffers."
290 "Controls how to scroll due to interpreter output.
291 This variable applies when point is at the end of the buffer
292 \(either because it was originally there, or because
293 `comint-move-point-for-output' said to move it there)
294 and output from the subprocess is inserted.
296 Non-nil means scroll so that the window is full of text
297 and point is on the last line. A value of nil
298 means don't do anything special--scroll normally.
300 See also the variable `comint-move-point-for-output' and the function
301 `comint-postoutput-scroll-to-bottom'.
302 This variable is buffer-local in all Comint buffers."
307 "The maximum size in lines for Comint buffers.
308 Comint buffers are truncated from the top to be no greater than this number, if
309 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
323 "If non-nil, assume that the subprocess echoes any input.
324 If so, delete one copy of the input so that only one copy eventually
325 appears in the buffer.
327 This variable is buffer-local."
331 ;; AIX puts the name of the person being su'd to in front of the prompt.
332 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
333 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
334 ;; ssh-add prints a prompt like `Enter passphrase: '.
335 ;; plink prints a prompt like `Passphrase for key "root@GNU.ORG": '.
336 ;; Ubuntu's sudo prompts like `[sudo] password for user:'
337 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
338 ;; Something called "perforce" uses "Enter password:".
345 "Regexp matching prompts for passwords in the inferior process.
346 This is used by `comint-watch-for-password-prompt'."
350 ;; Here are the per-interpreter hooks.
352 "Function that returns old text in Comint mode.
353 This function is called when return is typed while the point is in old
354 text. It returns the text to be submitted as process input. The
355 default is `comint-get-old-input-default', which either grabs the
356 current input field or grabs the current line and strips off leading
357 text matching `comint-prompt-regexp', depending on the value of
362 "List of functions called to perform completion.
363 Functions should return non-nil if completion was performed.
364 See also `comint-dynamic-complete'.
370 "Predicate for filtering additions to input history.
371 Takes one argument, the input. If non-nil, the input may be saved on the input
375 "Abnormal hook run before input is sent to the process.
378 ;;;###autoload
379 (defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom comint-watch-for-password-prompt)
380 "Functions to call after output is inserted into the buffer.
381 One possible function is `comint-postoutput-scroll-to-bottom'.
382 These functions get one argument, a string containing the text as originally
383 inserted. Note that this might not be the same as the buffer contents between
384 `comint-last-output-start' and the buffer's `process-mark', if other filter
385 functions have already modified the buffer.
387 See also `comint-preoutput-filter-functions'.
389 You can use `add-hook' to add functions to this list
396 "Function to actually send to PROCESS the STRING submitted by user.
397 Usually this is just `comint-simple-send', but if your mode needs to
398 massage the input string, put a different function here.
399 `comint-simple-send' just sends the string plus a newline.
400 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
404 "Non-nil means go to the end of the line before sending input.
405 See `comint-send-input'."
409 ;; Note: If it is decided to purge comint-prompt-regexp from the source
410 ;; entirely, searching for uses of this variable will help to identify
411 ;; places that need attention.
413 "If non-nil, use `comint-prompt-regexp' to recognize prompts.
414 If nil, then program output and user-input are given different `field'
415 properties, which Emacs commands can use to distinguish them (in
416 particular, common movement commands such as `beginning-of-line'
417 respect field boundaries in a natural way)."
421 ;; Autoload is necessary for Custom to recognize old alias.
422 ;;;###autoload
427 "Hook run upon entry to `comint-mode'.
428 This is run before the process is cranked up."
433 "Hook run each time a process is exec'd by `comint-exec'.
434 This is called after the process is cranked up. It is useful for things that
435 must be done each time a process is executed in a Comint mode buffer (e.g.,
436 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
437 executed once when the buffer is created."
443 ;; Keys:
455 ;; The following two are standardly aliased to C-d,
456 ;; but they should never do EOF, just delete.
458 (define-key map [kp-delete] 'delete-char)
459 (define-key map "\C-c " 'comint-accumulate)
460 (define-key map "\C-c\C-x" 'comint-get-next-from-history)
461 (define-key map "\C-c\C-a" 'comint-bol-or-process-mark)
462 (define-key map "\C-c\C-u" 'comint-kill-input)
463 (define-key map "\C-c\C-w" 'backward-kill-word)
464 (define-key map "\C-c\C-c" 'comint-interrupt-subjob)
465 (define-key map "\C-c\C-z" 'comint-stop-subjob)
467 (define-key map "\C-c\C-m" 'comint-copy-old-input)
468 (define-key map "\C-c\C-o" 'comint-delete-output)
469 (define-key map "\C-c\C-r" 'comint-show-output)
470 (define-key map "\C-c\C-e" 'comint-show-maximum-output)
471 (define-key map "\C-c\C-l" 'comint-dynamic-list-input-ring)
472 (define-key map "\C-c\C-n" 'comint-next-prompt)
473 (define-key map "\C-c\C-p" 'comint-previous-prompt)
474 (define-key map "\C-c\C-d" 'comint-send-eof)
475 (define-key map "\C-c\C-s" 'comint-write-output)
476 (define-key map "\C-c." 'comint-insert-previous-argument)
477 ;; Mouse Buttons:
478 (define-key map [mouse-2] 'comint-insert-input)
479 ;; Menu bars:
480 ;; completion:
481 (define-key map [menu-bar completion]
482 (cons "Complete" (make-sparse-keymap "Complete")))
483 (define-key map [menu-bar completion complete-expand]
484 '("Expand File Name" . comint-replace-by-expanded-filename))
485 (define-key map [menu-bar completion complete-listing]
486 '("File Completion Listing" . comint-dynamic-list-filename-completions))
487 (define-key map [menu-bar completion complete-file]
488 '("Complete File Name" . comint-dynamic-complete-filename))
489 (define-key map [menu-bar completion complete]
490 '("Complete Before Point" . comint-dynamic-complete))
491 ;; Input history:
492 (define-key map [menu-bar inout]
493 (cons "In/Out" (make-sparse-keymap "In/Out")))
494 (define-key map [menu-bar inout delete-output]
495 '("Delete Current Output Group" . comint-delete-output))
496 (define-key map [menu-bar inout append-output-to-file]
497 '("Append Current Output Group to File" . comint-append-output-to-file))
498 (define-key map [menu-bar inout write-output]
499 '("Write Current Output Group to File" . comint-write-output))
500 (define-key map [menu-bar inout next-prompt]
501 '("Forward Output Group" . comint-next-prompt))
502 (define-key map [menu-bar inout previous-prompt]
503 '("Backward Output Group" . comint-previous-prompt))
504 (define-key map [menu-bar inout show-maximum-output]
505 '("Show Maximum Output" . comint-show-maximum-output))
506 (define-key map [menu-bar inout show-output]
507 '("Show Current Output Group" . comint-show-output))
508 (define-key map [menu-bar inout kill-input]
509 '("Kill Current Input" . comint-kill-input))
510 (define-key map [menu-bar inout copy-input]
511 '("Copy Old Input" . comint-copy-old-input))
512 (define-key map [menu-bar inout forward-matching-history]
513 '("Forward Matching Input..." . comint-forward-matching-input))
514 (define-key map [menu-bar inout backward-matching-history]
515 '("Backward Matching Input..." . comint-backward-matching-input))
516 (define-key map [menu-bar inout next-matching-history]
517 '("Next Matching Input..." . comint-next-matching-input))
518 (define-key map [menu-bar inout previous-matching-history]
519 '("Previous Matching Input..." . comint-previous-matching-input))
520 (define-key map [menu-bar inout next-matching-history-from-input]
521 '("Next Matching Current Input" . comint-next-matching-input-from-input))
522 (define-key map [menu-bar inout previous-matching-history-from-input]
523 '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
524 (define-key map [menu-bar inout next-history]
525 '("Next Input" . comint-next-input))
526 (define-key map [menu-bar inout previous-history]
527 '("Previous Input" . comint-previous-input))
528 (define-key map [menu-bar inout list-history]
529 '("List Input History" . comint-dynamic-list-input-ring))
530 (define-key map [menu-bar inout expand-history]
531 '("Expand History Before Point" . comint-replace-by-expanded-history))
532 ;; Signals
533 (let ((signals-map (make-sparse-keymap "Signals")))
534 (define-key map [menu-bar signals] (cons "Signals" signals-map))
535 (define-key signals-map [eof] '("EOF" . comint-send-eof))
536 (define-key signals-map [kill] '("KILL" . comint-kill-subjob))
537 (define-key signals-map [quit] '("QUIT" . comint-quit-subjob))
538 (define-key signals-map [cont] '("CONT" . comint-continue-subjob))
539 (define-key signals-map [stop] '("STOP" . comint-stop-subjob))
540 (define-key signals-map [break] '("BREAK" . comint-interrupt-subjob)))
541 ;; Put them in the menu bar:
542 (setq menu-bar-final-items (append '(completion inout signals)
543 menu-bar-final-items))
544 map))
546 ;; Fixme: Is this still relevant?
547 (defvar comint-ptyp t
548 "Non-nil if communications via pty; false if by pipe. Buffer local.
549 This is to work around a bug in Emacs process signaling.")
551 (defvar comint-input-ring nil)
552 (defvar comint-last-input-start nil)
553 (defvar comint-last-input-end nil)
554 (defvar comint-last-output-start nil)
555 (defvar comint-input-ring-index nil
556 "Index of last matched history element.")
557 (defvar comint-matching-input-from-input-string ""
558 "Input previously used to match input history.")
559 (defvar comint-save-input-ring-index nil
560 "Last input ring index which you copied.
563 (defvar comint-accum-marker nil
564 "Non-nil if you are accumulating input lines to send as input together.
567 (defvar comint-stored-incomplete-input nil
568 "Stored input for history cycling.")
570 (put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
571 (put 'comint-input-ring 'permanent-local t)
572 (put 'comint-input-ring-index 'permanent-local t)
573 (put 'comint-save-input-ring-index 'permanent-local t)
574 (put 'comint-input-autoexpand 'permanent-local t)
575 (put 'comint-input-filter-functions 'permanent-local t)
576 (put 'comint-output-filter-functions 'permanent-local t)
577 (put 'comint-preoutput-filter-functions 'permanent-local t)
578 (put 'comint-scroll-to-bottom-on-input 'permanent-local t)
579 (put 'comint-move-point-for-output 'permanent-local t)
580 (put 'comint-scroll-show-maximum-output 'permanent-local t)
581 (put 'comint-ptyp 'permanent-local t)
583 (put 'comint-mode 'mode-class 'special)
585 (define-derived-mode comint-mode fundamental-mode "Comint"
586 "Major mode for interacting with an inferior interpreter.
587 Interpreter name is same as buffer name, sans the asterisks.
588 Return at end of buffer sends line as input.
589 Return not at end copies rest of line to end and sends it.
590 Setting variable `comint-eol-on-send' means jump to the end of the line
591 before submitting new input.
593 This mode is customized to create major modes such as Inferior Lisp
594 mode, Shell mode, etc. This can be done by setting the hooks
595 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
596 and `comint-get-old-input' to appropriate functions, and the variable
597 `comint-prompt-regexp' to the appropriate regular expression.
599 An input history is maintained of size `comint-input-ring-size', and
600 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
601 Input ring history expansion can be achieved with the commands
603 Input ring expansion is controlled by the variable `comint-input-autoexpand',
604 and addition is controlled by the variable `comint-input-ignoredups'.
606 Commands with no default key bindings include `send-invisible',
607 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
608 `comint-magic-space'.
610 Input to, and output from, the subprocess can cause the window to scroll to
611 the end of the buffer. See variables `comint-output-filter-functions',
612 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
613 and `comint-move-point-for-output'.
616 to continue it.
620 Entry to this mode runs the hooks on `comint-mode-hook'."
621 (setq mode-line-process '(":%s"))
622 (set (make-local-variable 'window-point-insertion-type) t)
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, whose contents are sent to the
690 process as its initial input.
692 If PROGRAM is a string, any more args are arguments to PROGRAM."
693 (or (fboundp 'start-file-process)
694 (error "Multi-processing is not supported for this system"))
695 (setq buffer (get-buffer-create (or buffer (concat "*" name "*"))))
696 ;; If no process, or nuked process, crank up a new one and put buffer in
697 ;; comint mode. Otherwise, leave buffer and existing process alone.
698 (unless (comint-check-proc buffer)
699 (with-current-buffer buffer
700 (unless (derived-mode-p 'comint-mode)
701 (comint-mode))) ; Install local vars, mode, keymap, ...
702 (comint-exec buffer name program startfile switches))
703 buffer)
705 ;;;###autoload
706 (defun make-comint (name program &optional startfile &rest switches)
707 "Make a Comint process NAME in a buffer, running PROGRAM.
708 The name of the buffer is made by surrounding NAME with `*'s.
709 PROGRAM should be either a string denoting an executable program to create
710 via `start-file-process', or a cons pair of the form (HOST . SERVICE) denoting
711 a TCP connection to be opened via `open-network-stream'. If there is already
712 a running process in that buffer, it is not restarted. Optional third arg
713 STARTFILE is the name of a file, whose contents are sent to the
714 process as its initial input.
716 If PROGRAM is a string, any more args are arguments to PROGRAM."
717 (apply #'make-comint-in-buffer name nil program startfile switches))
719 ;;;###autoload
720 (defun comint-run (program)
721 "Run PROGRAM in a Comint buffer and switch to it.
722 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
723 The file name is used to make a symbol name, such as `comint-sh-hook', and any
724 hooks on this symbol are run in the buffer.
725 See `make-comint' and `comint-exec'."
726 (interactive "sRun program: ")
727 (let ((name (file-name-nondirectory program)))
728 (switch-to-buffer (make-comint name program))
729 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
731 (defun comint-exec (buffer name command startfile switches)
732 "Start up a process named NAME in buffer BUFFER for Comint modes.
733 Runs the given COMMAND with SWITCHES, and initial input from STARTFILE.
734 Blasts any old process running in the buffer. Doesn't set the buffer mode.
735 You can use this to cheaply run a series of processes in the same Comint
736 buffer. The hook `comint-exec-hook' is run after each exec."
737 (with-current-buffer buffer
738 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
739 (if proc (delete-process proc)))
740 ;; Crank up a new process
741 (let ((proc
742 (if (consp command)
743 (open-network-stream name buffer (car command) (cdr command))
744 (comint-exec-1 name buffer command switches))))
745 (set-process-filter proc 'comint-output-filter)
746 (make-local-variable 'comint-ptyp)
747 (setq comint-ptyp process-connection-type) ; t if pty, nil if pipe.
748 ;; Jump to the end, and set the process mark.
749 (goto-char (point-max))
750 (set-marker (process-mark proc) (point))
751 ;; Feed it the startfile.
752 (cond (startfile
753 ;;This is guaranteed to wait long enough
754 ;;but has bad results if the comint does not prompt at all
755 ;; (while (= size (buffer-size))
756 ;; (sleep-for 1))
757 ;;I hope 1 second is enough!
758 (sleep-for 1)
759 (goto-char (point-max))
760 (insert-file-contents startfile)
761 (setq startfile (buffer-substring (point) (point-max)))
762 (delete-region (point) (point-max))
763 (comint-send-string proc startfile)))
764 (run-hooks 'comint-exec-hook)
765 buffer)))
767 ;; This auxiliary function cranks up the process for comint-exec in
768 ;; the appropriate environment.
770 (defun comint-exec-1 (name buffer command switches)
771 (let ((process-environment
772 (nconc
773 ;; If using termcap, we specify `emacs' as the terminal type
774 ;; because that lets us specify a width.
775 ;; If using terminfo, we specify `dumb' because that is
776 ;; a defined terminal type. `emacs' is not a defined terminal type
777 ;; and there is no way for us to define it here.
778 ;; Some programs that use terminfo get very confused
779 ;; if TERM is not a valid terminal type.
780 ;; ;; There is similar code in compile.el.
781 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
782 (list "TERM=dumb" "TERMCAP="
783 (format "COLUMNS=%d" (window-width)))
784 (list "TERM=emacs"
785 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
786 (unless (getenv "EMACS")
787 (list "EMACS=t"))
788 (list (format "INSIDE_EMACS=%s,comint" emacs-version))
789 process-environment))
790 (default-directory
791 (if (file-accessible-directory-p default-directory)
792 default-directory
793 "/"))
794 proc decoding encoding changed)
795 (let ((exec-path (if (and command (file-name-directory command))
796 ;; If the command has slashes, make sure we
797 ;; first look relative to the current directory.
798 (cons default-directory exec-path) exec-path)))
799 (setq proc (apply 'start-file-process name buffer command switches)))
800 ;; Some file name handler cannot start a process, fe ange-ftp.
801 (unless (processp proc) (error "No process started"))
802 (let ((coding-systems (process-coding-system proc)))
803 (setq decoding (car coding-systems)
804 encoding (cdr coding-systems)))
805 ;; Even if start-file-process left the coding system for encoding data
806 ;; sent from the process undecided, we had better use the same one
807 ;; as what we use for decoding. But, we should suppress EOL
808 ;; conversion.
809 (if (and decoding (not encoding))
810 (setq encoding (coding-system-change-eol-conversion decoding 'unix)
811 changed t))
812 (if changed
813 (set-process-coding-system proc decoding encoding))
814 proc))
816 (defun comint-insert-input (event)
817 "In a Comint buffer, set the current input to the previous input at point.
818 If there is no previous input at point, run the command specified
819 by the global keymap (usually `mouse-yank-at-click')."
820 (interactive "e")
821 ;; Don't set the mouse here, since it may otherwise change the behavior
822 ;; of the command on which we fallback if there's no field at point.
823 ;; (mouse-set-point event)
824 (let ((pos (posn-point (event-end event)))
825 field input)
826 (with-selected-window (posn-window (event-end event))
827 (and (setq field (field-at-pos pos))
828 (setq input (field-string-no-properties pos))))
829 (if (or (null comint-accum-marker)
830 (not (eq field 'input)))
831 ;; Fall back to the global definition if (i) the selected
832 ;; buffer is not a comint buffer (which can happen if a
833 ;; non-comint window was selected and we clicked in a comint
834 ;; window), or (ii) there is no input at POS.
835 (let* ((keys (this-command-keys))
836 (last-key (and (vectorp keys) (aref keys (1- (length keys)))))
837 (fun (and last-key (lookup-key global-map (vector last-key)))))
838 (and fun (not (eq fun 'comint-insert-input))
839 (call-interactively fun)))
840 (with-selected-window (posn-window (event-end event))
841 ;; Otherwise, insert the previous input.
842 (goto-char (point-max))
843 ;; First delete any old unsent input at the end
844 (delete-region
845 (or (marker-position comint-accum-marker)
846 (process-mark (get-buffer-process (current-buffer))))
847 (point))
848 ;; Insert the input at point
849 (insert input)))))
850 \f
851 ;; Input history processing in a buffer
852 ;; ===========================================================================
853 ;; Useful input history functions, courtesy of the Ergo group.
855 ;; Eleven commands:
856 ;; comint-dynamic-list-input-ring List history in help buffer.
857 ;; comint-previous-input Previous input...
858 ;; comint-previous-matching-input ...matching a string.
859 ;; comint-previous-matching-input-from-input ... matching the current input.
860 ;; comint-next-input Next input...
861 ;; comint-next-matching-input ...matching a string.
862 ;; comint-next-matching-input-from-input ... matching the current input.
863 ;; comint-backward-matching-input Backwards input...
864 ;; comint-forward-matching-input ...matching a string.
865 ;; comint-replace-by-expanded-history Expand history at point;
866 ;; replace with expanded history.
867 ;; comint-magic-space Expand history and insert space.
868 ;;
869 ;; Three functions:
870 ;; comint-read-input-ring Read into comint-input-ring...
871 ;; comint-write-input-ring Write to comint-input-ring-file-name.
872 ;; comint-replace-by-expanded-history-before-point Workhorse function.
874 (defun comint-read-input-ring (&optional silent)
875 "Set the buffer's `comint-input-ring' from a history file.
876 The name of the file is given by the variable `comint-input-ring-file-name'.
877 The history ring is of size `comint-input-ring-size', regardless of file size.
878 If `comint-input-ring-file-name' is nil this function does nothing.
880 If the optional argument SILENT is non-nil, we say nothing about a
881 failure to read the history file.
883 This function is useful for major mode commands and mode hooks.
885 The commands stored in the history file are separated by the
886 `comint-input-ring-separator', and entries that match
887 `comint-input-history-ignore' are ignored. The most recent command
888 comes last.
890 See also `comint-input-ignoredups' and `comint-write-input-ring'."
891 (cond ((or (null comint-input-ring-file-name)
892 (equal comint-input-ring-file-name ""))
893 nil)
894 ((not (file-readable-p comint-input-ring-file-name))
895 (or silent
896 (message "Cannot read history file %s"
897 comint-input-ring-file-name)))
898 (t
899 (let* ((history-buf (get-buffer-create " *temp*"))
900 (file comint-input-ring-file-name)
901 (count 0)
902 (size comint-input-ring-size)
903 (ring (make-ring size)))
904 (unwind-protect
905 (with-current-buffer history-buf
906 (widen)
907 (erase-buffer)
908 (insert-file-contents file)
909 ;; Save restriction in case file is already visited...
910 ;; Watch for those date stamps in history files!
911 (goto-char (point-max))
912 (let (start end history)
913 (while (and (< count size)
914 (re-search-backward comint-input-ring-separator
915 nil t)
916 (setq end (match-beginning 0)))
917 (setq start
918 (if (re-search-backward comint-input-ring-separator
919 nil t)
920 (match-end 0)
921 (point-min)))
922 (setq history (buffer-substring start end))
923 (goto-char start)
924 (if (and (not (string-match comint-input-history-ignore
925 history))
926 (or (null comint-input-ignoredups)
927 (ring-empty-p ring)
928 (not (string-equal (ring-ref ring 0)
929 history))))
930 (progn
931 (ring-insert-at-beginning ring history)
932 (setq count (1+ count)))))))
933 (kill-buffer history-buf))
934 (setq comint-input-ring ring
935 comint-input-ring-index nil)))))
937 (defun comint-write-input-ring ()
938 "Writes the buffer's `comint-input-ring' to a history file.
939 The name of the file is given by the variable `comint-input-ring-file-name'.
940 The original contents of the file are lost if `comint-input-ring' is not empty.
941 If `comint-input-ring-file-name' is nil this function does nothing.
943 Useful within process sentinels.
945 See also `comint-read-input-ring'."
946 (cond ((or (null comint-input-ring-file-name)
947 (equal comint-input-ring-file-name "")
948 (null comint-input-ring) (ring-empty-p comint-input-ring))
949 nil)
950 ((not (file-writable-p comint-input-ring-file-name))
951 (message "Cannot write history file %s" comint-input-ring-file-name))
952 (t
953 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
954 (ring comint-input-ring)
955 (file comint-input-ring-file-name)
956 (index (ring-length ring)))
957 ;; Write it all out into a buffer first. Much faster, but messier,
958 ;; than writing it one line at a time.
959 (with-current-buffer history-buf
960 (erase-buffer)
961 (while (> index 0)
962 (setq index (1- index))
963 (insert (ring-ref ring index) comint-input-ring-separator))
964 (write-region (buffer-string) nil file nil 'no-message)
965 (kill-buffer nil))))))
968 (defvar comint-dynamic-list-input-ring-window-conf)
970 (defun comint-dynamic-list-input-ring-select ()
971 "Choose the input history entry that point is in or next to."
972 (interactive)
973 (let ((buffer completion-reference-buffer)
974 beg end completion)
975 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
976 (setq end (point) beg (1+ (point))))
977 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
978 (setq end (1- (point)) beg (point)))
979 (if (null beg)
980 (error "No history entry here"))
981 (setq beg (previous-single-property-change beg 'mouse-face))
982 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
983 (setq completion (buffer-substring beg end))
984 (set-window-configuration comint-dynamic-list-input-ring-window-conf)
985 (choose-completion-string completion buffer)))
987 (defun comint-dynamic-list-input-ring ()
988 "List in help buffer the buffer's input history."
989 (interactive)
990 (if (or (not (ring-p comint-input-ring))
991 (ring-empty-p comint-input-ring))
992 (message "No history")
993 (let ((history nil)
994 (history-buffer " *Input History*")
995 (index (1- (ring-length comint-input-ring)))
996 (conf (current-window-configuration)))
997 ;; We have to build up a list ourselves from the ring vector.
998 (dotimes (index (ring-length comint-input-ring))
999 (push (ring-ref comint-input-ring index) history))
1000 ;; Show them most-recent-first.
1001 (setq history (nreverse history))
1002 ;; Change "completion" to "history reference"
1003 ;; to make the display accurate.
1004 (with-output-to-temp-buffer history-buffer
1005 (display-completion-list history)
1006 (set-buffer history-buffer)
1007 (let ((keymap (make-sparse-keymap)))
1008 (set-keymap-parent keymap (current-local-map))
1009 (define-key keymap "\C-m" 'comint-dynamic-list-input-ring-select)
1010 (use-local-map keymap))
1011 (forward-line 3)
1012 (while (search-backward "completion" nil 'move)
1013 (replace-match "history reference")))
1014 (sit-for 0)
1015 (message "Hit space to flush")
1016 (setq comint-dynamic-list-input-ring-window-conf conf)
1017 (let ((ch (read-event)))
1018 (if (eq ch ?\s)
1019 (set-window-configuration conf)
1020 (setq unread-command-events (list ch)))))))
1023 (defun comint-regexp-arg (prompt)
1024 "Return list of regexp and prefix arg using PROMPT."
1025 (let* (;; Don't clobber this.
1026 (last-command last-command)
1027 (regexp (read-from-minibuffer prompt nil nil nil
1028 'minibuffer-history-search-history)))
1029 ;; If the user didn't enter anything, nothing is added to m-h-s-h.
1030 ;; Use the previous search regexp, if there is one.
1031 (list (if (string-equal regexp "")
1032 (or (car minibuffer-history-search-history)
1033 regexp)
1034 regexp)
1035 (prefix-numeric-value current-prefix-arg))))
1037 (defun comint-search-arg (arg)
1038 ;; First make sure there is a ring and that we are after the process mark
1039 (cond ((not (comint-after-pmark-p))
1040 (error "Not at command line"))
1041 ((or (null comint-input-ring)
1042 (ring-empty-p comint-input-ring))
1043 (error "Empty input ring"))
1044 ((zerop arg)
1045 ;; arg of zero resets search from beginning, and uses arg of 1
1046 (setq comint-input-ring-index nil)
1047 1)
1048 (t
1049 arg)))
1051 (defun comint-restore-input ()
1052 "Restore unfinished input."
1053 (interactive)
1054 (when comint-input-ring-index
1055 (comint-delete-input)
1056 (when (> (length comint-stored-incomplete-input) 0)
1057 (insert comint-stored-incomplete-input)
1058 (message "Input restored"))
1059 (setq comint-input-ring-index nil)))
1061 (defun comint-search-start (arg)
1062 "Index to start a directional search, starting at `comint-input-ring-index'."
1063 (if comint-input-ring-index
1064 ;; If a search is running, offset by 1 in direction of arg
1065 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
1066 (ring-length comint-input-ring))
1067 ;; For a new search, start from beginning or end, as appropriate
1068 (if (>= arg 0)
1069 0 ; First elt for forward search
1070 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
1072 (defun comint-previous-input-string (arg)
1073 "Return the string ARG places along the input ring.
1074 Moves relative to `comint-input-ring-index'."
1075 (ring-ref comint-input-ring (if comint-input-ring-index
1076 (mod (+ arg comint-input-ring-index)
1077 (ring-length comint-input-ring))
1078 arg)))
1080 (defun comint-previous-input (arg)
1081 "Cycle backwards through input history, saving input."
1082 (interactive "*p")
1083 (if (and comint-input-ring-index
1084 (or ;; leaving the "end" of the ring
1085 (and (< arg 0) ; going down
1086 (eq comint-input-ring-index 0))
1087 (and (> arg 0) ; going up
1088 (eq comint-input-ring-index
1089 (1- (ring-length comint-input-ring)))))
1090 comint-stored-incomplete-input)
1091 (comint-restore-input)
1092 (comint-previous-matching-input "." arg)))
1094 (defun comint-next-input (arg)
1095 "Cycle forwards through input history."
1096 (interactive "*p")
1097 (comint-previous-input (- arg)))
1099 (defun comint-previous-matching-input-string (regexp arg)
1100 "Return the string matching REGEXP ARG places along the input ring.
1101 Moves relative to `comint-input-ring-index'."
1102 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
1103 (if pos (ring-ref comint-input-ring pos))))
1105 (defun comint-previous-matching-input-string-position (regexp arg &optional start)
1106 "Return the index matching REGEXP ARG places along the input ring.
1107 Moves relative to START, or `comint-input-ring-index'."
1108 (if (or (not (ring-p comint-input-ring))
1109 (ring-empty-p comint-input-ring))
1110 (error "No history"))
1111 (let* ((len (ring-length comint-input-ring))
1112 (motion (if (> arg 0) 1 -1))
1113 (n (mod (- (or start (comint-search-start arg)) motion) len))
1114 (tried-each-ring-item nil)
1115 (prev nil))
1116 ;; Do the whole search as many times as the argument says.
1117 (while (and (/= arg 0) (not tried-each-ring-item))
1118 ;; Step once.
1119 (setq prev n
1120 n (mod (+ n motion) len))
1121 ;; If we haven't reached a match, step some more.
1122 (while (and (< n len) (not tried-each-ring-item)
1123 (not (string-match regexp (ring-ref comint-input-ring n))))
1124 (setq n (mod (+ n motion) len)
1125 ;; If we have gone all the way around in this search.
1126 tried-each-ring-item (= n prev)))
1127 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1128 ;; Now that we know which ring element to use, if we found it, return that.
1129 (if (string-match regexp (ring-ref comint-input-ring n))
1130 n)))
1132 (defun comint-delete-input ()
1133 "Delete all input between accumulation or process mark and point."
1134 (delete-region
1135 ;; Can't use kill-region as it sets this-command
1136 (or (marker-position comint-accum-marker)
1137 (process-mark (get-buffer-process (current-buffer))))
1138 (point-max)))
1140 (defun comint-previous-matching-input (regexp n)
1141 "Search backwards through input history for match for REGEXP.
1142 \(Previous history elements are earlier commands.)
1143 With prefix argument N, search for Nth previous match.
1144 If N is negative, find the next or Nth next match."
1145 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1146 (setq n (comint-search-arg n))
1147 (let ((pos (comint-previous-matching-input-string-position regexp n)))
1148 ;; Has a match been found?
1149 (if (null pos)
1150 (error "Not found")
1151 ;; If leaving the edit line, save partial input
1152 (if (null comint-input-ring-index) ;not yet on ring
1153 (setq comint-stored-incomplete-input
1154 (funcall comint-get-old-input)))
1155 (setq comint-input-ring-index pos)
1156 (message "History item: %d" (1+ pos))
1157 (comint-delete-input)
1158 (insert (ring-ref comint-input-ring pos)))))
1160 (defun comint-next-matching-input (regexp n)
1161 "Search forwards through input history for match for REGEXP.
1162 \(Later history elements are more recent commands.)
1163 With prefix argument N, search for Nth following match.
1164 If N is negative, find the previous or Nth previous match."
1165 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1166 (comint-previous-matching-input regexp (- n)))
1168 (defun comint-previous-matching-input-from-input (n)
1169 "Search backwards through input history for match for current input.
1170 \(Previous history elements are earlier commands.)
1171 With prefix argument N, search for Nth previous match.
1172 If N is negative, search forwards for the -Nth following match."
1173 (interactive "p")
1174 (if (not (memq last-command '(comint-previous-matching-input-from-input
1175 comint-next-matching-input-from-input)))
1176 ;; Starting a new search
1177 (setq comint-matching-input-from-input-string
1178 (buffer-substring
1179 (or (marker-position comint-accum-marker)
1180 (process-mark (get-buffer-process (current-buffer))))
1181 (point))
1182 comint-input-ring-index nil))
1183 (comint-previous-matching-input
1184 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1185 n))
1187 (defun comint-next-matching-input-from-input (n)
1188 "Search forwards through input history for match for current input.
1189 \(Following history elements are more recent commands.)
1190 With prefix argument N, search for Nth following match.
1191 If N is negative, search backwards for the -Nth previous match."
1192 (interactive "p")
1193 (comint-previous-matching-input-from-input (- n)))
1196 (defun comint-replace-by-expanded-history (&optional silent start)
1197 "Expand input command history references before point.
1198 Expansion is dependent on the value of `comint-input-autoexpand'.
1200 This function depends on the buffer's idea of the input history, which may not
1201 match the command interpreter's idea, assuming it has one.
1203 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1204 cannot know the interpreter's idea of input line numbers, assuming it has one,
1205 it cannot expand absolute input line number references.
1207 If the optional argument SILENT is non-nil, never complain
1208 even if history reference seems erroneous.
1210 If the optional argument START is non-nil, that specifies the
1211 start of the text to scan for history references, rather
1212 than the logical beginning of line.
1214 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1216 Returns t if successful."
1217 (interactive)
1218 (if (and comint-input-autoexpand
1219 (if comint-use-prompt-regexp
1220 ;; Use comint-prompt-regexp
1221 (save-excursion
1222 (beginning-of-line)
1224 ;; Use input fields. User input that hasn't been entered
1225 ;; yet, at the end of the buffer, has a nil `field' property.
1226 (and (null (get-char-property (point) 'field))
1228 ;; Looks like there might be history references in the command.
1229 (let ((previous-modified-tick (buffer-modified-tick)))
1230 (comint-replace-by-expanded-history-before-point silent start)
1231 (/= previous-modified-tick (buffer-modified-tick)))))
1234 (defun comint-replace-by-expanded-history-before-point (silent &optional start)
1235 "Expand directory stack reference before point.
1236 See `comint-replace-by-expanded-history'. Returns t if successful.
1238 If the optional argument START is non-nil, that specifies the
1239 start of the text to scan for history references, rather
1240 than the logical beginning of line."
1241 (save-excursion
1242 (let ((toend (- (line-end-position) (point)))
1243 (start (or start (comint-line-beginning-position))))
1244 (goto-char start)
1245 (while (progn
1246 (skip-chars-forward "^!^" (- (line-end-position) toend))
1247 (< (point) (- (line-end-position) toend)))
1248 ;; This seems a bit complex. We look for references such as !!, !-num,
1249 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1250 ;; If that wasn't enough, the plings can be suffixed with argument
1251 ;; range specifiers.
1252 ;; Argument ranges are complex too, so we hive off the input line,
1253 ;; referenced with plings, with the range string to `comint-args'.
1254 (setq comint-input-ring-index nil)
1256 (comint-within-quotes start (point)))
1257 ;; The history is quoted, or we're in quotes.
1258 (goto-char (1+ (point))))
1260 ;; We cannot know the interpreter's idea of input line numbers.
1261 (goto-char (match-end 0))
1262 (message "Absolute reference cannot be expanded"))
1264 ;; Just a number of args from `number' lines backward.
1265 (let ((number (1- (string-to-number
1266 (buffer-substring (match-beginning 1)
1267 (match-end 1))))))
1268 (if (<= number (ring-length comint-input-ring))
1269 (progn
1270 (replace-match
1271 (comint-args (comint-previous-input-string number)
1272 (match-beginning 2) (match-end 2))
1273 t t)
1274 (setq comint-input-ring-index number)
1275 (message "History item: %d" (1+ number)))
1276 (goto-char (match-end 0))
1277 (message "Relative reference exceeds input history size"))))
1279 ;; Just a number of args from the previous input line.
1280 (replace-match (comint-previous-input-string 0) 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
1678 ;; calling save-match-data and save-restriction. But, such a
1679 ;; check is not necessary now because we don't use regexp search
1680 ;; nor save-restriction. Note that the buffer is already widen,
1681 ;; and calling narrow-to-region and widen are not that heavy.
1682 (goto-char start)
1683 (let* ((inhibit-field-text-motion t)
1684 (inhibit-read-only t)
1685 (lbeg (line-beginning-position))
1686 delete-end ch)
1687 ;; If the preceding text is marked as "must-overwrite", record
1688 ;; it in delete-end.
1689 (when (and (> start (point-min))
1690 (get-text-property (1- start) 'comint-must-overwrite))
1691 (setq delete-end (point-marker))
1692 (remove-text-properties lbeg start '(comint-must-overwrite nil)))
1693 (narrow-to-region lbeg end)
1694 ;; Handle BS, LF, and CR specially.
1696 (setq ch (following-char))
1698 (delete-char 1)
1699 (if (> (point) lbeg)
1700 (delete-char -1)))
1702 (when delete-end ; CH = LF
1703 (if (< delete-end (point))
1704 (delete-region lbeg delete-end))
1705 (set-marker delete-end nil)
1706 (setq delete-end nil))
1707 (forward-char 1)
1708 (setq lbeg (point)))
1709 (t ; CH = CR
1710 (delete-char 1)
1711 (if delete-end
1712 (when (< delete-end (point))
1713 (delete-region lbeg delete-end)
1714 (move-marker delete-end (point)))
1715 (setq delete-end (point-marker))))))
1716 (when delete-end
1717 (if (< delete-end (point))
1718 ;; As there's a text after the last CR, make the current
1719 ;; line contain only that text.
1720 (delete-region lbeg delete-end)
1721 ;; Remember that the process output ends by CR, and thus we
1722 ;; must overwrite the contents of the current line next
1723 ;; time.
1724 (put-text-property lbeg delete-end 'comint-must-overwrite t))
1725 (set-marker delete-end nil))
1726 (widen))))
1728 ;; The purpose of using this filter for comint processes
1729 ;; is to keep comint-last-input-end from moving forward
1730 ;; when output is inserted.
1731 (defun comint-output-filter (process string)
1732 (let ((oprocbuf (process-buffer process)))
1733 ;; First check for killed buffer or no input.
1734 (when (and string oprocbuf (buffer-name oprocbuf))
1735 (with-current-buffer oprocbuf
1736 ;; Run preoutput filters
1737 (let ((functions comint-preoutput-filter-functions))
1738 (while (and functions string)
1739 (if (eq (car functions) t)
1740 (let ((functions
1741 (default-value 'comint-preoutput-filter-functions)))
1742 (while (and functions string)
1743 (setq string (funcall (car functions) string))
1744 (setq functions (cdr functions))))
1745 (setq string (funcall (car functions) string)))
1746 (setq functions (cdr functions))))
1748 ;; Insert STRING
1749 (let ((inhibit-read-only t)
1750 ;; The point should float after any insertion we do.
1751 (saved-point (copy-marker (point) t)))
1753 ;; We temporarly remove any buffer narrowing, in case the
1754 ;; process mark is outside of the restriction
1755 (save-restriction
1756 (widen)
1758 (goto-char (process-mark process))
1759 (set-marker comint-last-output-start (point))
1761 ;; insert-before-markers is a bad thing. XXX
1762 ;; Luckily we don't have to use it any more, we use
1763 ;; window-point-insertion-type instead.
1764 (insert string)
1766 ;; Advance process-mark
1767 (set-marker (process-mark process) (point))
1769 (unless comint-inhibit-carriage-motion
1770 ;; Interpret any carriage motion characters (newline, backspace)
1771 (comint-carriage-motion comint-last-output-start (point)))
1773 ;; Run these hooks with point where the user had it.
1774 (goto-char saved-point)
1775 (run-hook-with-args 'comint-output-filter-functions string)
1776 (set-marker saved-point (point))
1778 (goto-char (process-mark process)) ; in case a filter moved it
1780 (unless comint-use-prompt-regexp
1781 (let ((inhibit-read-only t)
1782 (inhibit-modification-hooks t))
1783 (add-text-properties comint-last-output-start (point)
1784 '(front-sticky
1785 (field inhibit-line-move-field-capture)
1786 rear-nonsticky t
1787 field output
1788 inhibit-line-move-field-capture t))))
1790 ;; Highlight the prompt, where we define `prompt' to mean
1791 ;; the most recent output that doesn't end with a newline.
1792 (let ((prompt-start (save-excursion (forward-line 0) (point)))
1793 (inhibit-read-only t)
1794 (inhibit-modification-hooks t))
1795 (when comint-prompt-read-only
1796 (or (= (point-min) prompt-start)
1797 (get-text-property (1- prompt-start) 'read-only)
1798 (put-text-property
1799 (1- prompt-start) prompt-start 'read-only 'fence))
1800 (add-text-properties
1801 prompt-start (point)
1802 '(read-only t rear-nonsticky t front-sticky (read-only))))
1803 (unless (and (bolp) (null comint-last-prompt-overlay))
1804 ;; Need to create or move the prompt overlay (in the case
1805 ;; where there is no prompt ((bolp) == t), we still do
1806 ;; this if there's already an existing overlay).
1807 (if comint-last-prompt-overlay
1808 ;; Just move an existing overlay
1809 (move-overlay comint-last-prompt-overlay
1810 prompt-start (point))
1811 ;; Need to create the overlay
1812 (setq comint-last-prompt-overlay
1813 (make-overlay prompt-start (point)))
1814 (overlay-put comint-last-prompt-overlay
1815 'font-lock-face 'comint-highlight-prompt))))
1817 (goto-char saved-point)))))))
1819 (defun comint-preinput-scroll-to-bottom ()
1820 "Go to the end of buffer in all windows showing it.
1821 Movement occurs if point in the selected window is not after the process mark,
1822 and `this-command' is an insertion command. Insertion commands recognized
1823 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1824 Depends on the value of `comint-scroll-to-bottom-on-input'.
1826 This function should be a pre-command hook."
1827 (if (and comint-scroll-to-bottom-on-input
1828 (memq this-command '(self-insert-command comint-magic-space yank
1829 hilit-yank)))
1830 (let* ((selected (selected-window))
1831 (current (current-buffer))
1832 (process (get-buffer-process current))
1833 (scroll comint-scroll-to-bottom-on-input))
1834 (if (and process (< (point) (process-mark process)))
1835 (if (eq scroll 'this)
1836 (goto-char (point-max))
1837 (walk-windows
1838 (lambda (window)
1839 (if (and (eq (window-buffer window) current)
1840 (or (eq scroll t) (eq scroll 'all)))
1841 (progn
1842 (select-window window)
1843 (goto-char (point-max))
1844 (select-window selected))))
1845 nil t))))))
1847 (defun comint-postoutput-scroll-to-bottom (string)
1848 "Go to the end of buffer in some or all windows showing it.
1849 Does not scroll if the current line is the last line in the buffer.
1850 Depends on the value of `comint-move-point-for-output' and
1851 `comint-scroll-show-maximum-output'.
1853 This function should be in the list `comint-output-filter-functions'."
1854 (let* ((selected (selected-window))
1855 (current (current-buffer))
1856 (process (get-buffer-process current))
1857 (scroll comint-move-point-for-output))
1858 (unwind-protect
1859 (if process
1860 (walk-windows
1861 (lambda (window)
1862 (when (eq (window-buffer window) current)
1863 (select-window window)
1864 (if (and (< (point) (process-mark process))
1865 (or (eq scroll t) (eq scroll 'all)
1866 ;; Maybe user wants point to jump to end.
1867 (and (eq scroll 'this) (eq selected window))
1868 (and (eq scroll 'others) (not (eq selected window)))
1869 ;; If point was at the end, keep it at end.
1870 (and (marker-position comint-last-output-start)
1871 (>= (point) comint-last-output-start))))
1872 (goto-char (process-mark process)))
1873 ;; Optionally scroll so that the text
1874 ;; ends at the bottom of the window.
1875 (if (and comint-scroll-show-maximum-output
1876 (= (point) (point-max)))
1877 (save-excursion
1878 (goto-char (point-max))
1879 (recenter (- -1 scroll-margin))))
1880 (select-window selected)))
1881 nil t))
1882 (set-buffer current))))
1884 (defun comint-truncate-buffer (&optional string)
1885 "Truncate the buffer to `comint-buffer-maximum-size'.
1886 This function could be on `comint-output-filter-functions' or bound to a key."
1887 (interactive)
1888 (save-excursion
1889 (goto-char (process-mark (get-buffer-process (current-buffer))))
1890 (forward-line (- comint-buffer-maximum-size))
1891 (beginning-of-line)
1892 (let ((inhibit-read-only t))
1893 (delete-region (point-min) (point)))))
1895 (defun comint-strip-ctrl-m (&optional string)
1896 "Strip trailing `^M' characters from the current output group.
1897 This function could be on `comint-output-filter-functions' or bound to a key."
1898 (interactive)
1899 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1900 (save-excursion
1901 (condition-case nil
1902 (goto-char
1903 (if (called-interactively-p 'interactive)
1904 comint-last-input-end comint-last-output-start))
1905 (error nil))
1907 (replace-match "" t t)))))
1908 (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
1910 (defun comint-show-maximum-output ()
1911 "Put the end of the buffer at the bottom of the window."
1912 (interactive)
1913 (goto-char (point-max))
1914 (recenter (- -1 scroll-margin)))
1916 (defun comint-get-old-input-default ()
1917 "Default for `comint-get-old-input'.
1918 If `comint-use-prompt-regexp' is nil, then either
1919 return the current input field, if point is on an input field, or the
1920 current line, if point is on an output field.
1921 If `comint-use-prompt-regexp' is non-nil, then return
1922 the current line with any initial string matching the regexp
1923 `comint-prompt-regexp' removed."
1924 (let ((bof (field-beginning)))
1925 (if (eq (get-char-property bof 'field) 'input)
1926 (field-string-no-properties bof)
1927 (comint-bol)
1928 (buffer-substring-no-properties (point) (line-end-position)))))
1930 (defun comint-copy-old-input ()
1931 "Insert after prompt old input at point as new input to be edited.
1932 Calls `comint-get-old-input' to get old input."
1933 (interactive)
1934 (let ((input (funcall comint-get-old-input))
1935 (process (get-buffer-process (current-buffer))))
1936 (if (not process)
1937 (error "Current buffer has no process")
1938 (goto-char (process-mark process))
1939 (insert input))))
1941 (defun comint-skip-prompt ()
1942 "Skip past the text matching regexp `comint-prompt-regexp'.
1943 If this takes us past the end of the current line, don't skip at all."
1944 (if (and (looking-at comint-prompt-regexp)
1945 (<= (match-end 0) (line-end-position)))
1946 (goto-char (match-end 0))))
1948 (defun comint-after-pmark-p ()
1949 "Return t if point is after the process output marker."
1950 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1951 (<= (marker-position pmark) (point))))
1953 (defun comint-simple-send (proc string)
1954 "Default function for sending to PROC input STRING.
1955 This just sends STRING plus a newline. To override this,
1956 set the hook `comint-input-sender'."
1957 (let ((send-string
1958 (if comint-input-sender-no-newline
1959 string
1960 ;; Sending as two separate strings does not work
1963 (comint-send-string proc send-string))
1964 (if (and comint-input-sender-no-newline
1965 (not (string-equal string "")))
1966 (process-send-eof)))
1968 (defun comint-line-beginning-position ()
1969 "Return the buffer position of the beginning of the line, after any prompt.
1970 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done by
1971 skipping text matching the regular expression `comint-prompt-regexp',
1972 a buffer local variable."
1973 (if comint-use-prompt-regexp
1974 ;; Use comint-prompt-regexp
1975 (save-excursion
1976 (beginning-of-line)
1977 (comint-skip-prompt)
1978 (point))
1979 ;; Use input fields. Note that, unlike the behavior of
1980 ;; `line-beginning-position' inside a field, this function will
1981 ;; return the position of the end of a prompt, even if the point is
1982 ;; already inside the prompt. In order to do this, it assumes that
1983 ;; if there are two fields on a line, then the first one is the
1984 ;; prompt, and the second one is an input field, and is front-sticky
1985 ;; (as input fields should be).
1986 (constrain-to-field (line-beginning-position) (line-end-position))))
1988 (defun comint-bol (&optional arg)
1989 "Go to the beginning of line, then skip past the prompt, if any.
1991 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done
1992 by skipping text matching the regular expression `comint-prompt-regexp',
1993 a buffer local variable."
1994 (interactive "P")
1995 (if arg
1996 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1997 (forward-line 0)
1998 (goto-char (comint-line-beginning-position))))
2000 ;; For compatibility.
2001 (defun comint-read-noecho (prompt &optional ignore)
2002 (read-passwd prompt))
2004 ;; These three functions are for entering text you don't want echoed or
2005 ;; saved -- typically passwords to ftp, telnet, or somesuch.
2006 ;; Just enter m-x send-invisible and type in your line.
2008 (defun send-invisible (&optional prompt)
2009 "Read a string without echoing.
2010 Then send it to the process running in the current buffer.
2011 The string is sent using `comint-input-sender'.
2012 Security bug: your string can still be temporarily recovered with
2014 (interactive "P") ; Defeat snooping via C-x ESC ESC
2015 (let ((proc (get-buffer-process (current-buffer)))
2016 (prefix
2017 (if (eq (window-buffer (selected-window)) (current-buffer))
2018 ""
2019 (format "(In buffer %s) "
2020 (current-buffer)))))
2021 (if proc
2022 (let ((str (read-passwd (concat prefix
2023 (or prompt "Non-echoed text: ")))))
2024 (if (stringp str)
2025 (progn
2026 (comint-snapshot-last-prompt)
2027 (funcall comint-input-sender proc str))
2028 (message "Warning: text will be echoed")))
2029 (error "Buffer %s has no process" (current-buffer)))))
2031 (defun comint-watch-for-password-prompt (string)
2032 "Prompt in the minibuffer for password and send without echoing.
2033 This function uses `send-invisible' to read and send a password to the buffer's
2034 process if STRING contains a password prompt defined by
2035 `comint-password-prompt-regexp'.
2037 This function could be in the list `comint-output-filter-functions'."
2038 (when (string-match comint-password-prompt-regexp string)
2040 (setq string (replace-match "" t t string)))
2041 (send-invisible string)))
2042 \f
2043 ;; Low-level process communication
2045 (defun comint-send-string (process string)
2046 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
2047 (if process
2048 (with-current-buffer (if (processp process)
2049 (process-buffer process)
2050 (get-buffer process))
2051 (comint-snapshot-last-prompt))
2052 (comint-snapshot-last-prompt))
2053 (process-send-string process string))
2055 (defun comint-send-region (process start end)
2056 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
2057 (if process
2058 (with-current-buffer (if (processp process)
2059 (process-buffer process)
2060 (get-buffer process))
2061 (comint-snapshot-last-prompt))
2062 (comint-snapshot-last-prompt))
2063 (process-send-region process start end))
2065 \f
2066 ;; Random input hackage
2068 (defun comint-delete-output ()
2069 "Delete all output from interpreter since last input.
2070 Does not delete the prompt."
2071 (interactive)
2072 (let ((proc (get-buffer-process (current-buffer)))
2073 (replacement nil)
2074 (inhibit-read-only t))
2075 (save-excursion
2076 (let ((pmark (progn (goto-char (process-mark proc))
2077 (forward-line 0)
2078 (point-marker))))
2079 (delete-region comint-last-input-end pmark)
2080 (goto-char (process-mark proc))
2082 (buffer-substring pmark (point))))
2083 (delete-region pmark (point))))
2084 ;; Output message and put back prompt
2085 (comint-output-filter proc replacement)))
2086 (define-obsolete-function-alias 'comint-kill-output
2087 'comint-delete-output "21.1")
2089 (defun comint-write-output (filename &optional append mustbenew)
2090 "Write output from interpreter since last input to FILENAME.
2091 Any prompt at the end of the output is not written.
2093 If the optional argument APPEND (the prefix argument when interactive)
2094 is non-nil, the output is appended to the file instead.
2096 If the optional argument MUSTBENEW is non-nil, check for an existing
2097 file with the same name. If MUSTBENEW is `excl', that means to get an
2098 error if the file already exists; never overwrite. If MUSTBENEW is
2099 neither nil nor `excl', that means ask for confirmation before
2100 overwriting, but do go ahead and overwrite the file if the user
2101 confirms. When interactive, MUSTBENEW is nil when appending, and t
2102 otherwise."
2103 (interactive
2104 (list (read-file-name
2105 (if current-prefix-arg
2106 "Append output to file: "
2107 "Write output to file: "))
2108 current-prefix-arg
2109 (not current-prefix-arg)))
2110 (save-excursion
2111 (goto-char (process-mark (get-buffer-process (current-buffer))))
2112 (forward-line 0)
2113 (write-region comint-last-input-end (point) filename
2114 append nil nil mustbenew)))
2116 ;; This function exists for the benefit of the menu; from the keyboard,
2117 ;; users can just use `comint-write-output' with a prefix arg.
2118 (defun comint-append-output-to-file (filename)
2119 "Append output from interpreter since last input to FILENAME.
2120 Any prompt at the end of the output is not written."
2121 (interactive "fAppend output to file: ")
2122 (comint-write-output filename t))
2124 (defun comint-show-output ()
2125 "Display start of this batch of interpreter output at top of window.
2126 Sets mark to the value of point when this command is run."
2127 (interactive)
2128 (push-mark)
2129 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
2130 (cond (comint-use-prompt-regexp
2131 (goto-char pos)
2132 (beginning-of-line 0)
2133 (set-window-start (selected-window) (point))
2134 (comint-skip-prompt))
2135 (t
2136 (goto-char (field-beginning pos))
2137 (set-window-start (selected-window) (point))))))
2140 (defun comint-interrupt-subjob ()
2141 "Interrupt the current subjob.
2142 This command also kills the pending input
2143 between the process mark and point."
2144 (interactive)
2145 (comint-skip-input)
2146 (interrupt-process nil comint-ptyp)
2148 )
2150 (defun comint-kill-subjob ()
2151 "Send kill signal to the current subjob.
2152 This command also kills the pending input
2153 between the process mark and point."
2154 (interactive)
2155 (comint-skip-input)
2156 (kill-process nil comint-ptyp))
2158 (defun comint-quit-subjob ()
2159 "Send quit signal to the current subjob.
2160 This command also kills the pending input
2161 between the process mark and point."
2162 (interactive)
2163 (comint-skip-input)
2164 (quit-process nil comint-ptyp))
2166 (defun comint-stop-subjob ()
2167 "Stop the current subjob.
2168 This command also kills the pending input
2169 between the process mark and point.
2171 WARNING: if there is no current subjob, you can end up suspending
2172 the top-level process running in the buffer. If you accidentally do
2174 is not a problem with most shells, since they ignore this signal.)"
2175 (interactive)
2176 (comint-skip-input)
2177 (stop-process nil comint-ptyp))
2179 (defun comint-continue-subjob ()
2180 "Send CONT signal to process buffer's process group.
2181 Useful if you accidentally suspend the top-level process."
2182 (interactive)
2183 (continue-process nil comint-ptyp))
2185 (defun comint-skip-input ()
2186 "Skip all pending input, from last stuff output by interpreter to point.
2187 This means mark it as if it had been sent as input, without sending it."
2188 (let ((comint-input-sender 'ignore)
2189 (comint-input-filter-functions nil))
2190 (comint-send-input t t))
2191 (end-of-line)
2192 (let ((pos (point))
2193 (marker (process-mark (get-buffer-process (current-buffer)))))
2194 (insert " " (key-description (this-command-keys)))
2195 (if (= marker pos)
2196 (set-marker marker (point)))))
2198 (defun comint-kill-input ()
2199 "Kill all text from last stuff output by interpreter to point."
2200 (interactive)
2201 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2202 (if (> (point) (marker-position pmark))
2203 (kill-region pmark (point)))))
2205 (defun comint-delchar-or-maybe-eof (arg)
2206 "Delete ARG characters forward or send an EOF to subprocess.
2207 Sends an EOF only if point is at the end of the buffer and there is no input."
2208 (interactive "p")
2209 (let ((proc (get-buffer-process (current-buffer))))
2210 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
2211 (comint-send-eof)
2212 (delete-char arg))))
2214 (defun comint-send-eof ()
2215 "Send an EOF to the current buffer's process."
2216 (interactive)
2217 (comint-send-input t t)
2218 (process-send-eof))
2221 (defun comint-backward-matching-input (regexp n)
2222 "Search backward through buffer for input fields that match REGEXP.
2223 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2224 by lines that match `comint-prompt-regexp'.
2226 With prefix argument N, search for Nth previous match.
2227 If N is negative, find the next or Nth next match."
2228 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2229 (if comint-use-prompt-regexp
2230 ;; Use comint-prompt-regexp
2231 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2232 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2233 (if (re-search-backward re nil t n)
2234 (point)))))
2235 (if (null pos)
2236 (progn (message "Not found")
2237 (ding))
2238 (goto-char pos)
2239 (comint-bol nil)))
2240 ;; Use input fields
2241 (let* ((dir (if (< n 0) -1 1))
2242 (pos
2243 (save-excursion
2244 (while (/= n 0)
2245 (unless (re-search-backward regexp nil t dir)
2246 (error "Not found"))
2247 (when (eq (get-char-property (point) 'field) 'input)
2248 (setq n (- n dir))))
2249 (field-beginning))))
2250 (goto-char pos))))
2253 (defun comint-forward-matching-input (regexp n)
2254 "Search forward through buffer for input fields that match REGEXP.
2255 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2256 by lines that match `comint-prompt-regexp'.
2258 With prefix argument N, search for Nth following match.
2259 If N is negative, find the previous or Nth previous match."
2260 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2261 (comint-backward-matching-input regexp (- n)))
2264 (defun comint-next-prompt (n)
2265 "Move to end of Nth next prompt in the buffer.
2266 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2267 the Nth next `input' field, otherwise, it means the Nth occurrence of
2268 text matching `comint-prompt-regexp'."
2269 (interactive "p")
2270 (if comint-use-prompt-regexp
2271 ;; Use comint-prompt-regexp
2272 (let ((paragraph-start comint-prompt-regexp))
2273 (end-of-line (if (> n 0) 1 0))
2274 (forward-paragraph n)
2275 (comint-skip-prompt))
2276 ;; Use input fields
2277 (let ((pos (point))
2278 (input-pos nil)
2279 prev-pos)
2280 (while (/= n 0)
2281 (setq prev-pos pos)
2282 (setq pos
2283 (if (> n 0)
2284 (next-single-char-property-change pos 'field)
2285 (previous-single-char-property-change pos 'field)))
2286 (cond ((or (null pos) (= pos prev-pos))
2287 ;; Ran off the end of the buffer.
2288 (when (> n 0)
2289 ;; There's always an input field at the end of the
2290 ;; buffer, but it has a `field' property of nil.
2291 (setq input-pos (point-max)))
2292 ;; stop iterating
2293 (setq n 0))
2294 ((eq (get-char-property pos 'field) 'input)
2295 (setq n (if (< n 0) (1+ n) (1- n)))
2296 (setq input-pos pos))))
2297 (when input-pos
2298 (goto-char input-pos)))))
2301 (defun comint-previous-prompt (n)
2302 "Move to end of Nth previous prompt in the buffer.
2303 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2304 the Nth previous `input' field, otherwise, it means the Nth occurrence of
2305 text matching `comint-prompt-regexp'."
2306 (interactive "p")
2307 (comint-next-prompt (- n)))
2309 ;; State used by `comint-insert-previous-argument' when cycling.
2310 (defvar comint-insert-previous-argument-last-start-pos nil)
2311 (make-variable-buffer-local 'comint-insert-previous-argument-last-start-pos)
2312 (defvar comint-insert-previous-argument-last-index nil)
2313 (make-variable-buffer-local 'comint-insert-previous-argument-last-index)
2315 ;; Needs fixing:
2316 ;; make comint-arguments understand negative indices as bash does
2317 (defun comint-insert-previous-argument (index)
2318 "Insert the INDEXth argument from the previous Comint command-line at point.
2319 Spaces are added at beginning and/or end of the inserted string if
2320 necessary to ensure that it's separated from adjacent arguments.
2321 Interactively, if no prefix argument is given, the last argument is inserted.
2322 Repeated interactive invocations will cycle through the same argument
2323 from progressively earlier commands (using the value of INDEX specified
2324 with the first command).
2325 This command is like `M-.' in bash."
2326 (interactive "P")
2327 (unless (null index)
2328 (setq index (prefix-numeric-value index)))
2329 (cond ((eq last-command this-command)
2330 ;; Delete last input inserted by this command.
2331 (delete-region comint-insert-previous-argument-last-start-pos (point))
2332 (setq index comint-insert-previous-argument-last-index))
2333 (t
2334 ;; This is a non-repeat invocation, so initialize state.
2335 (setq comint-input-ring-index nil)
2336 (setq comint-insert-previous-argument-last-index index)
2337 (when (null comint-insert-previous-argument-last-start-pos)
2338 ;; First usage; initialize to a marker
2339 (setq comint-insert-previous-argument-last-start-pos
2340 (make-marker)))))
2341 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2342 (if (<= (point) (comint-line-beginning-position))
2343 (comint-bol)
2344 (just-one-space))
2345 ;; Remember the beginning of what we insert, so we can delete it if
2346 ;; the command is repeated.
2347 (set-marker comint-insert-previous-argument-last-start-pos (point))
2348 ;; Insert the argument.
2349 (let ((input-string (comint-previous-input-string 0)))
2351 ;; strip terminating '&'
2352 (setq input-string (substring input-string 0 (match-beginning 0))))
2353 (insert (comint-arguments input-string index index)))
2354 ;; Make next invocation return arg from previous input
2355 (setq comint-input-ring-index (1+ (or comint-input-ring-index 0)))
2356 ;; Add a terminating space if necessary.
2357 (unless (eolp)
2358 (just-one-space)))
2360 \f
2361 ;; Support editing with `comint-prompt-read-only' set to t.
2363 (defun comint-update-fence ()
2364 "Update read-only status of newline before point.
2365 The `fence' read-only property is used to indicate that a newline
2367 following front-sticky read-only region. This is used to
2368 implement comint read-only prompts. If the text after a newline
2369 changes, the read-only status of that newline may need updating.
2370 That is what this function does.
2372 This function does nothing if point is not at the beginning of a
2373 line, or is at the beginning of the accessible portion of the buffer.
2374 Otherwise, if the character after point has a front-sticky
2375 read-only property, then the preceding newline is given a
2376 read-only property of `fence', unless it already is read-only.
2377 If the character after point does not have a front-sticky
2378 read-only property, any read-only property of `fence' on the
2379 preceding newline is removed."
2380 (let* ((pt (point)) (lst (get-text-property pt 'front-sticky))
2381 (inhibit-modification-hooks t))
2382 (and (bolp)
2383 (not (bobp))
2384 (if (and (get-text-property pt 'read-only)
2385 (if (listp lst) (memq 'read-only lst) t))
2386 (unless (get-text-property (1- pt) 'read-only)
2387 (put-text-property (1- pt) pt 'read-only 'fence))
2388 (when (eq (get-text-property (1- pt) 'read-only) 'fence)
2389 (remove-list-of-text-properties (1- pt) pt '(read-only)))))))
2391 (defun comint-kill-whole-line (&optional count)
2392 "Kill current line, ignoring read-only and field properties.
2393 With prefix arg COUNT, kill that many lines starting from the current line.
2394 If COUNT is negative, kill backward. Also kill the preceding newline,
2396 with negative arguments.)
2397 If COUNT is zero, kill current line but exclude the trailing newline.
2398 The read-only status of newlines is updated with `comint-update-fence',
2399 if necessary."
2400 (interactive "p")
2401 (let ((inhibit-read-only t) (inhibit-field-text-motion t))
2402 (kill-whole-line count)
2403 (when (>= count 0) (comint-update-fence))))
2405 (defun comint-kill-region (beg end &optional yank-handler)
2406 "Like `kill-region', but ignores read-only properties, if safe.
2407 This command assumes that the buffer contains read-only
2409 properties at the beginning of a line, with the preceding newline
2410 being read-only to protect the prompt. This is true of the
2411 comint prompts if `comint-prompt-read-only' is non-nil. This
2412 command will not delete the region if this would create mutilated
2413 or out of place prompts. That is, if any part of a prompt is
2414 deleted, the entire prompt must be deleted and all remaining
2415 prompts should stay at the beginning of a line. If this is not
2416 the case, this command just calls `kill-region' with all
2417 read-only properties intact. The read-only status of newlines is
2418 updated using `comint-update-fence', if necessary."
2419 (interactive "r")
2420 (save-excursion
2421 (let* ((true-beg (min beg end))
2422 (true-end (max beg end))
2423 (beg-bolp (progn (goto-char true-beg) (bolp)))
2424 (beg-lst (get-text-property true-beg 'front-sticky))
2425 (beg-bad (and (get-text-property true-beg 'read-only)
2426 (if (listp beg-lst) (memq 'read-only beg-lst) t)))
2427 (end-bolp (progn (goto-char true-end) (bolp)))
2428 (end-lst (get-text-property true-end 'front-sticky))
2429 (end-bad (and (get-text-property true-end 'read-only)
2430 (if (listp end-lst) (memq 'read-only end-lst) t))))
2431 (if (or (and (not beg-bolp) (or beg-bad end-bad))
2432 (and (not end-bolp) end-bad))
2433 (kill-region beg end yank-handler)
2434 (let ((inhibit-read-only t))
2435 (kill-region beg end yank-handler)
2436 (comint-update-fence))))))
2438 \f
2439 ;; Support for source-file processing commands.
2440 ;;============================================================================
2441 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2442 ;; commands that process files of source text (e.g. loading or compiling
2443 ;; files). So the corresponding process-in-a-buffer modes have commands
2444 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2445 ;; for defining these commands.
2446 ;;
2447 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2448 ;; and Soar, in that they don't know anything about file extensions.
2449 ;; So the compile/load interface gets the wrong default occasionally.
2450 ;; The load-file/compile-file default mechanism could be smarter -- it
2451 ;; doesn't know about the relationship between filename extensions and
2452 ;; whether the file is source or executable. If you compile foo.lisp
2453 ;; with compile-file, then the next load-file should use foo.bin for
2454 ;; the default, not foo.lisp. This is tricky to do right, particularly
2455 ;; because the extension for executable files varies so much (.o, .bin,
2456 ;; .lbin, .mo, .vo, .ao, ...).
2459 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2460 ;; commands.
2461 ;;
2462 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2463 ;; want to save the buffer before issuing any process requests to the command
2464 ;; interpreter.
2465 ;;
2466 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2467 ;; for the file to process.
2469 (defun comint-source-default (previous-dir/file source-modes)
2470 "Compute the defaults for `load-file' and `compile-file' commands.
2472 PREVIOUS-DIR/FILE is a pair (DIRECTORY . FILENAME) from the last
2473 source-file processing command, or nil if there hasn't been one yet.
2474 SOURCE-MODES is a list used to determine what buffers contain source
2475 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2476 Typically, (lisp-mode) or (scheme-mode).
2478 If the command is given while the cursor is inside a string, *and*
2479 the string is an existing filename, *and* the filename is not a directory,
2480 then the string is taken as default. This allows you to just position
2481 your cursor over a string that's a filename and have it taken as default.
2483 If the command is given in a file buffer whose major mode is in
2484 SOURCE-MODES, then the filename is the default file, and the
2485 file's directory is the default directory.
2487 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2488 then the default directory & file are what was used in the last source-file
2489 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2490 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2493 SOURCE-MODES is typically going to be something like (tea-mode)
2494 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2495 for Soar programs, etc.
2497 The function returns a pair: (default-directory . default-file)."
2498 (cond ((and buffer-file-name (memq major-mode source-modes))
2499 (cons (file-name-directory buffer-file-name)
2500 (file-name-nondirectory buffer-file-name)))
2501 (previous-dir/file)
2502 (t
2503 (cons default-directory nil))))
2506 (defun comint-check-source (fname)
2507 "Check whether to save buffers visiting file FNAME.
2508 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2509 process-in-a-buffer modes), this function can be called on the filename.
2510 If the file is loaded into a buffer, and the buffer is modified, the user
2511 is queried to see if he wants to save the buffer before proceeding with
2512 the load or compile."
2513 (let ((buff (get-file-buffer fname)))
2514 (if (and buff
2515 (buffer-modified-p buff)
2516 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
2517 ;; save BUFF.
2518 (let ((old-buffer (current-buffer)))
2519 (set-buffer buff)
2520 (save-buffer)
2521 (set-buffer old-buffer)))))
2523 (defun comint-extract-string ()
2524 "Return string around point, or nil."
2525 (let ((syntax (syntax-ppss)))
2526 (when (nth 3 syntax)
2527 (condition-case ()
2528 (buffer-substring-no-properties (1+ (nth 8 syntax))
2529 (progn (goto-char (nth 8 syntax))
2530 (forward-sexp)
2531 (1- (point))))
2532 (error nil)))))
2534 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2535 "Prompt for filenames in commands that process source files,
2536 e.g. loading or compiling a file.
2537 Provides a default, if there is one, and returns the result filename.
2539 See `comint-source-default' for more on determining defaults.
2541 PROMPT is the prompt string. PREV-DIR/FILE is the (DIRECTORY . FILE) pair
2542 from the last source processing command. SOURCE-MODES is a list of major
2543 modes used to determine what file buffers contain source files. (These
2544 two arguments are used for determining defaults.) If MUSTMATCH-P is true,
2545 then the filename reader will only accept a file that exists.
2547 A typical use:
2549 '(lisp-mode) t))"
2550 (let* ((def (comint-source-default prev-dir/file source-modes))
2551 (stringfile (comint-extract-string))
2552 (sfile-p (and stringfile
2553 (condition-case ()
2554 (file-exists-p stringfile)
2555 (error nil))
2556 (not (file-directory-p stringfile))))
2557 (defdir (if sfile-p (file-name-directory stringfile)
2558 (car def)))
2559 (deffile (if sfile-p (file-name-nondirectory stringfile)
2560 (cdr def)))
2561 (ans (read-file-name (if deffile (format "%s(default %s) "
2562 prompt deffile)
2563 prompt)
2564 defdir
2565 (concat defdir deffile)
2566 mustmatch-p)))
2567 (list (expand-file-name (substitute-in-file-name ans)))))
2569 ;; I am somewhat divided on this string-default feature. It seems
2570 ;; to violate the principle-of-least-astonishment, in that it makes
2571 ;; the default harder to predict, so you actually have to look and see
2572 ;; what the default really is before choosing it. This can trip you up.
2573 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2574 ;; on this.
2575 ;; -Olin
2577 \f
2578 ;; Simple process query facility.
2579 ;; ===========================================================================
2580 ;; This function is for commands that want to send a query to the process
2581 ;; and show the response to the user. For example, a command to get the
2582 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2583 ;; to an inferior Common Lisp process.
2584 ;;
2585 ;; This simple facility just sends strings to the inferior process and pops
2586 ;; up a window for the process buffer so you can see what the process
2587 ;; responds with. We don't do anything fancy like try to intercept what the
2588 ;; process responds with and put it in a pop-up window or on the message
2589 ;; line. We just display the buffer. Low tech. Simple. Works good.
2591 (defun comint-proc-query (proc str)
2592 "Send to the inferior process PROC the string STR.
2593 Pop-up but do not select a window for the inferior process so that
2594 its response can be seen."
2595 (let* ((proc-buf (process-buffer proc))
2596 (proc-mark (process-mark proc)))
2597 (display-buffer proc-buf)
2598 (set-buffer proc-buf) ; but it's not the selected *window*
2599 (let ((proc-win (get-buffer-window proc-buf 0))
2600 (proc-pt (marker-position proc-mark)))
2601 (comint-send-string proc str) ; send the query
2602 (accept-process-output proc) ; wait for some output
2603 ;; Try to position the proc window so you can see the answer.
2604 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2605 ;; I don't know why. Wizards invited to improve it.
2606 (unless (pos-visible-in-window-p proc-pt proc-win)
2607 (let ((opoint (window-point proc-win)))
2608 (set-window-point proc-win proc-mark)
2609 (sit-for 0)
2610 (if (not (pos-visible-in-window-p opoint proc-win))
2611 (push-mark opoint)
2612 (set-window-point proc-win opoint)))))))
2614 \f
2615 ;; Filename/command/history completion in a buffer
2616 ;; ===========================================================================
2617 ;; Useful completion functions, courtesy of the Ergo group.
2619 ;; Six commands:
2620 ;; comint-dynamic-complete Complete or expand command, filename,
2621 ;; history at point.
2622 ;; comint-dynamic-complete-filename Complete filename at point.
2623 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2624 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2625 ;; replace with expanded/completed name.
2626 ;; comint-dynamic-simple-complete Complete stub given candidates.
2628 ;; These are not installed in the comint-mode keymap. But they are
2629 ;; available for people who want them. Shell-mode installs them:
2631 ;; (define-key shell-mode-map "\M-?"
2632 ;; 'comint-dynamic-list-filename-completions)))
2633 ;;
2634 ;; Commands like this are fine things to put in load hooks if you
2635 ;; want them present in specific modes.
2637 (defcustom comint-completion-autolist nil
2638 "If non-nil, automatically list possibilities on partial completion.
2639 This mirrors the optional behavior of tcsh."
2640 :type 'boolean
2641 :group 'comint-completion)
2643 (defcustom comint-completion-addsuffix t
2644 "If non-nil, add a `/' to completed directories, ` ' to file names.
2645 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2646 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2647 This mirrors the optional behavior of tcsh."
2648 :type '(choice (const :tag "None" nil)
2649 (const :tag "Add /" t)
2650 (cons :tag "Suffix pair"
2651 (string :tag "Directory suffix")
2652 (string :tag "File suffix")))
2653 :group 'comint-completion)
2655 (defcustom comint-completion-recexact nil
2656 "If non-nil, use shortest completion if characters cannot be added.
2657 This mirrors the optional behavior of tcsh.
2659 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2660 :type 'boolean
2661 :group 'comint-completion)
2663 (defcustom comint-completion-fignore nil
2664 "List of suffixes to be disregarded during file completion.
2665 This mirrors the optional behavior of bash and tcsh.
2667 Note that this applies to `comint-dynamic-complete-filename' only."
2668 :type '(repeat (string :tag "Suffix"))
2669 :group 'comint-completion)
2671 ;;;###autoload
2672 (defvar comint-file-name-prefix ""
2673 "Prefix prepended to absolute file names taken from process input.
2674 This is used by Comint's and shell's completion functions, and by shell's
2675 directory tracking functions.")
2677 (defvar comint-file-name-chars
2678 (if (memq system-type '(ms-dos windows-nt cygwin))
2679 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2680 "[]~/A-Za-z0-9+@:_.$#%,={}-")
2681 "String of characters valid in a file name.
2682 Note that all non-ASCII characters are considered valid in a file name
2683 regardless of what this variable says.
2685 This is a good thing to set in mode hooks.")
2687 (defvar comint-file-name-quote-list nil
2690 This is a good thing to set in mode hooks.")
2693 (defun comint-directory (directory)
2694 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
2695 (expand-file-name (if (file-name-absolute-p directory)
2696 (concat comint-file-name-prefix directory)
2697 directory)))
2700 (defun comint-word (word-chars)
2701 "Return the word of WORD-CHARS at point, or nil if none is found.
2702 Word constituents are considered to be those in WORD-CHARS, which is like the
2704 (save-excursion
2705 (let ((here (point))
2706 giveup)
2707 (while (not giveup)
2708 (let ((startpoint (point)))
2710 ;; Fixme: This isn't consistent with Bash, at least -- not
2711 ;; all non-ASCII chars should be word constituents.
2712 (if (and (> (- (point) 2) (point-min))
2714 (forward-char -2))
2715 (if (and (> (- (point) 1) (point-min))
2716 (>= (char-after (- (point) 1)) 128))
2717 (forward-char -1))
2718 (if (= (point) startpoint)
2719 (setq giveup t))))
2720 ;; Set match-data to match the entire string.
2721 (when (< (point) here)
2722 (set-match-data (list (point) here))
2723 (match-string 0)))))
2725 (defun comint-substitute-in-file-name (filename)
2726 "Return FILENAME with environment variables substituted.
2727 Supports additional environment variable syntax of the command
2728 interpreter (e.g., the percent notation of cmd.exe on NT)."
2729 (let ((name (substitute-in-file-name filename)))
2730 (if (memq system-type '(ms-dos windows-nt))
2731 (let (env-var-name
2732 env-var-val)
2733 (save-match-data
2735 (setq env-var-name (match-string 1 name))
2736 (setq env-var-val (or (getenv env-var-name) ""))
2737 (setq name (replace-match env-var-val t t name))))))
2738 name))
2740 (defun comint-match-partial-filename ()
2741 "Return the filename at point, or nil if none is found.
2742 Environment variables are substituted. See `comint-word'."
2743 (let ((filename (comint-word comint-file-name-chars)))
2744 (and filename (comint-substitute-in-file-name
2745 (comint-unquote-filename filename)))))
2748 (defun comint-quote-filename (filename)
2749 "Return FILENAME with magic characters quoted.
2750 Magic characters are those in `comint-file-name-quote-list'."
2751 (if (null comint-file-name-quote-list)
2752 filename
2753 (let ((regexp
2754 (format "[%s]"
2755 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
2756 (save-match-data
2757 (let ((i 0))
2758 (while (string-match regexp filename i)
2760 (setq i (1+ (match-end 0)))))
2761 filename))))
2763 (defun comint-unquote-filename (filename)
2764 "Return FILENAME with quoted characters unquoted."
2765 (if (null comint-file-name-quote-list)
2766 filename
2767 (save-match-data
2768 (let ((i 0))
2771 (setq i (+ 1 (match-beginning 0)))))
2772 filename)))
2775 (defun comint-dynamic-complete ()
2776 "Dynamically perform completion at point.
2777 Calls the functions in `comint-dynamic-complete-functions' to perform
2778 completion until a function returns non-nil, at which point completion is
2779 assumed to have occurred."
2780 (interactive)
2781 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
2784 (defun comint-dynamic-complete-filename ()
2785 "Dynamically complete the filename at point.
2786 Completes if after a filename. See `comint-match-partial-filename' and
2787 `comint-dynamic-complete-as-filename'.
2788 This function is similar to `comint-replace-by-expanded-filename', except that
2789 it won't change parts of the filename already entered in the buffer; it just
2790 adds completion characters to the end of the filename. A completions listing
2791 may be shown in a help buffer if completion is ambiguous.
2793 Completion is dependent on the value of `comint-completion-addsuffix',
2794 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2795 completions listing is dependent on the value of `comint-completion-autolist'.
2797 Returns t if successful."
2798 (interactive)
2799 (when (comint-match-partial-filename)
2800 (unless (window-minibuffer-p (selected-window))
2801 (message "Completing file name..."))
2802 (comint-dynamic-complete-as-filename)))
2804 (defun comint-dynamic-complete-as-filename ()
2805 "Dynamically complete at point as a filename.
2806 See `comint-dynamic-complete-filename'. Returns t if successful."
2807 (let* ((completion-ignore-case read-file-name-completion-ignore-case)
2808 (completion-ignored-extensions comint-completion-fignore)
2809 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2810 ;; I think it was originally bound to solve file completion problems,
2811 ;; but subsequent changes may have made this unnecessary. sm.
2812 ;;(file-name-handler-alist nil)
2813 (minibuffer-p (window-minibuffer-p (selected-window)))
2814 (success t)
2815 (dirsuffix (cond ((not comint-completion-addsuffix)
2816 "")
2817 ((not (consp comint-completion-addsuffix))
2818 "/")
2819 (t
2820 (car comint-completion-addsuffix))))
2821 (filesuffix (cond ((not comint-completion-addsuffix)
2822 "")
2823 ((not (consp comint-completion-addsuffix))
2824 " ")
2825 (t
2826 (cdr comint-completion-addsuffix))))
2827 (filename (comint-match-partial-filename))
2828 (filename-beg (if filename (match-beginning 0) (point)))
2829 (filename-end (if filename (match-end 0) (point)))
2830 (filename (or filename ""))
2831 (filedir (file-name-directory filename))
2832 (filenondir (file-name-nondirectory filename))
2833 (directory (if filedir (comint-directory filedir) default-directory))
2834 (completion (file-name-completion filenondir directory)))
2835 (cond ((null completion)
2836 (if minibuffer-p
2837 (minibuffer-message "No completions of %s" filename)
2838 (message "No completions of %s" filename))
2839 (setq success nil))
2840 ((eq completion t) ; Means already completed "file".
2841 (insert filesuffix)
2842 (unless minibuffer-p
2843 (message "Sole completion")))
2844 ((string-equal completion "") ; Means completion on "directory/".
2845 (comint-dynamic-list-filename-completions))
2846 (t ; Completion string returned.
2847 (let ((file (concat (file-name-as-directory directory) completion)))
2848 ;; Insert completion. Note that the completion string
2849 ;; may have a different case than what's in the prompt,
2850 ;; if read-file-name-completion-ignore-case is non-nil,
2851 (delete-region filename-beg filename-end)
2852 (if filedir (insert (comint-quote-filename filedir)))
2853 (insert (comint-quote-filename (directory-file-name completion)))
2854 (cond ((symbolp (file-name-completion completion directory))
2855 ;; We inserted a unique completion.
2856 (insert (if (file-directory-p file) dirsuffix filesuffix))
2857 (unless minibuffer-p
2858 (message "Completed")))
2859 ((and comint-completion-recexact comint-completion-addsuffix
2860 (string-equal filenondir completion)
2861 (file-exists-p file))
2862 ;; It's not unique, but user wants shortest match.
2863 (insert (if (file-directory-p file) dirsuffix filesuffix))
2864 (unless minibuffer-p
2865 (message "Completed shortest")))
2866 ((or comint-completion-autolist
2867 (string-equal filenondir completion))
2868 ;; It's not unique, list possible completions.
2869 (comint-dynamic-list-filename-completions))
2870 (t
2871 (unless minibuffer-p
2872 (message "Partially completed")))))))
2873 success))
2876 (defun comint-replace-by-expanded-filename ()
2877 "Dynamically expand and complete the filename at point.
2878 Replace the filename with an expanded, canonicalized and completed replacement.
2881 removed, and the filename is made absolute instead of relative. For expansion
2882 see `expand-file-name' and `substitute-in-file-name'. For completion see
2883 `comint-dynamic-complete-filename'."
2884 (interactive)
2885 (let ((filename (comint-match-partial-filename)))
2886 (when filename
2887 (replace-match (expand-file-name filename) t t)
2888 (comint-dynamic-complete-filename))))
2891 (defun comint-dynamic-simple-complete (stub candidates)
2892 "Dynamically complete STUB from CANDIDATES list.
2893 This function inserts completion characters at point by completing STUB from
2894 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2895 if completion is ambiguous.
2897 Returns nil if no completion was inserted.
2898 Returns `sole' if completed with the only completion match.
2899 Returns `shortest' if completed with the shortest of the completion matches.
2900 Returns `partial' if completed as far as possible with the completion matches.
2901 Returns `listed' if a completion listing was shown.
2903 See also `comint-dynamic-complete-filename'."
2904 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2905 (minibuffer-p (window-minibuffer-p (selected-window)))
2906 (suffix (cond ((not comint-completion-addsuffix) "")
2907 ((not (consp comint-completion-addsuffix)) " ")
2908 (t (cdr comint-completion-addsuffix))))
2909 (completions (all-completions stub candidates)))
2910 (cond ((null completions)
2911 (if minibuffer-p
2912 (minibuffer-message "No completions of %s" stub)
2913 (message "No completions of %s" stub))
2914 nil)
2915 ((= 1 (length completions)) ; Gotcha!
2916 (let ((completion (car completions)))
2917 (if (string-equal completion stub)
2918 (unless minibuffer-p
2919 (message "Sole completion"))
2920 (insert (substring completion (length stub)))
2921 (unless minibuffer-p
2922 (message "Completed")))
2923 (insert suffix)
2924 'sole))
2925 (t ; There's no unique completion.
2926 (let ((completion (try-completion stub candidates)))
2927 ;; Insert the longest substring.
2928 (insert (substring completion (length stub)))
2929 (cond ((and comint-completion-recexact comint-completion-addsuffix
2930 (string-equal stub completion)
2931 (member completion completions))
2932 ;; It's not unique, but user wants shortest match.
2933 (insert suffix)
2934 (unless minibuffer-p
2935 (message "Completed shortest"))
2936 'shortest)
2937 ((or comint-completion-autolist
2938 (string-equal stub completion))
2939 ;; It's not unique, list possible completions.
2940 (comint-dynamic-list-completions completions stub)
2941 'listed)
2942 (t
2943 (unless minibuffer-p
2944 (message "Partially completed"))
2945 'partial)))))))
2948 (defun comint-dynamic-list-filename-completions ()
2949 "List in help buffer possible completions of the filename at point."
2950 (interactive)
2951 (let* ((completion-ignore-case read-file-name-completion-ignore-case)
2952 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2953 ;; I think it was originally bound to solve file completion problems,
2954 ;; but subsequent changes may have made this unnecessary. sm.
2955 ;;(file-name-handler-alist nil)
2956 (filename (or (comint-match-partial-filename) ""))
2957 (filedir (file-name-directory filename))
2958 (filenondir (file-name-nondirectory filename))
2959 (directory (if filedir (comint-directory filedir) default-directory))
2960 (completions (file-name-all-completions filenondir directory)))
2961 (if (not completions)
2962 (if (window-minibuffer-p (selected-window))
2963 (minibuffer-message "No completions of %s" filename)
2964 (message "No completions of %s" filename))
2965 (comint-dynamic-list-completions
2966 (mapcar 'comint-quote-filename completions)
2967 (comint-quote-filename filenondir)))))
2970 ;; This is bound locally in a *Completions* buffer to the list of
2971 ;; completions displayed, and is used to detect the case where the same
2972 ;; command is repeatedly used without the set of completions changing.
2973 (defvar comint-displayed-dynamic-completions nil)
2975 (defvar comint-dynamic-list-completions-config nil)
2977 (defun comint-dynamic-list-completions (completions &optional common-substring)
2978 "List in help buffer sorted COMPLETIONS.
2979 The meaning of COMMON-SUBSTRING is the same as in `display-completion-list'.
2980 Typing SPC flushes the help buffer."
2981 (let ((window (get-buffer-window "*Completions*" 0)))
2982 (setq completions (sort completions 'string-lessp))
2983 (if (and (eq last-command this-command)
2984 window (window-live-p window) (window-buffer window)
2985 (buffer-name (window-buffer window))
2986 ;; The above tests are not sufficient to detect the case where we
2987 ;; should scroll, because the top-level interactive command may
2988 ;; not have displayed a completions window the last time it was
2989 ;; invoked, and there may be such a window left over from a
2990 ;; previous completion command with a different set of
2991 ;; completions. To detect that case, we also test that the set
2992 ;; of displayed completions is in fact the same as the previously
2993 ;; displayed set.
2994 (equal completions
2995 (buffer-local-value 'comint-displayed-dynamic-completions
2996 (window-buffer window))))
2997 ;; If this command was repeated, and
2998 ;; there's a fresh completion window with a live buffer,
2999 ;; and this command is repeated, scroll that window.
3000 (with-current-buffer (window-buffer window)
3001 (if (pos-visible-in-window-p (point-max) window)
3002 (set-window-start window (point-min))
3003 (save-selected-window
3004 (select-window window)
3005 (scroll-up))))
3007 ;; Display a completion list for the first time.
3008 (setq comint-dynamic-list-completions-config
3009 (current-window-configuration))
3010 (with-output-to-temp-buffer "*Completions*"
3011 (display-completion-list completions common-substring))
3012 (if (window-minibuffer-p (selected-window))
3013 (minibuffer-message "Type space to flush; repeat completion command to scroll")
3014 (message "Type space to flush; repeat completion command to scroll")))
3016 ;; Read the next key, to process SPC.
3017 (let (key first)
3018 (if (with-current-buffer (get-buffer "*Completions*")
3019 (set (make-local-variable 'comint-displayed-dynamic-completions)
3020 completions)
3021 (setq key (read-key-sequence nil)
3022 first (aref key 0))
3023 (and (consp first) (consp (event-start first))
3024 (eq (window-buffer (posn-window (event-start first)))
3025 (get-buffer "*Completions*"))
3026 (eq (key-binding key) 'mouse-choose-completion)))
3027 ;; If the user does mouse-choose-completion with the mouse,
3028 ;; execute the command, then delete the completion window.
3029 (progn
3030 (choose-completion first)
3031 (set-window-configuration comint-dynamic-list-completions-config))
3032 (if (eq first ?\s)
3033 (set-window-configuration comint-dynamic-list-completions-config)
3034 (setq unread-command-events (listify-key-sequence key)))))))
3036 \f
3037 (defun comint-get-next-from-history ()
3038 "After fetching a line from input history, this fetches the following line.
3039 In other words, this recalls the input line after the line you recalled last.
3040 You can use this to repeat a sequence of input lines."
3041 (interactive)
3042 (if comint-save-input-ring-index
3043 (progn
3044 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
3045 (comint-next-input 1))
3046 (message "No previous history command")))
3048 (defun comint-accumulate ()
3049 "Accumulate a line to send as input along with more lines.
3050 This inserts a newline so that you can enter more text
3052 to send all the accumulated input, at once.
3053 The entire accumulated text becomes one item in the input history
3054 when you send it."
3055 (interactive)
3057 (set-marker comint-accum-marker (point))
3058 (if comint-input-ring-index
3059 (setq comint-save-input-ring-index
3060 (- comint-input-ring-index 1))))
3062 (defun comint-goto-process-mark ()
3063 "Move point to the process mark.
3064 The process mark separates output, and input already sent,
3065 from input that has not yet been sent."
3066 (interactive)
3067 (let ((proc (or (get-buffer-process (current-buffer))
3068 (error "Current buffer has no process"))))
3069 (goto-char (process-mark proc))
3070 (when (called-interactively-p 'interactive)
3071 (message "Point is now at the process mark"))))
3073 (defun comint-bol-or-process-mark ()
3074 "Move point to beginning of line (after prompt) or to the process mark.
3075 The first time you use this command, it moves to the beginning of the line
3076 \(but after the prompt, if any). If you repeat it again immediately,
3077 it moves point to the process mark.
3079 The process mark separates the process output, along with input already sent,
3080 from input that has not yet been sent. Ordinarily, the process mark
3081 is at the beginning of the current input line; but if you have
3083 the process mark is at the beginning of the accumulated input."
3084 (interactive)
3085 (if (not (eq last-command 'comint-bol-or-process-mark))
3086 (comint-bol nil)
3087 (comint-goto-process-mark)))
3089 (defun comint-set-process-mark ()
3090 "Set the process mark at point."
3091 (interactive)
3092 (let ((proc (or (get-buffer-process (current-buffer))
3093 (error "Current buffer has no process"))))
3094 (set-marker (process-mark proc) (point))
3095 (message "Process mark set")))
3097 \f
3098 ;; Author: Peter Breton <pbreton@cs.umb.edu>
3100 ;; This little add-on for comint is intended to make it easy to get
3101 ;; output from currently active comint buffers into another buffer,
3102 ;; or buffers, and then go back to using the comint shell.
3103 ;;
3104 ;; My particular use is SQL interpreters; I want to be able to execute a
3105 ;; query using the process associated with a comint-buffer, and save that
3106 ;; somewhere else. Because the process might have state (for example, it
3107 ;; could be in an uncommitted transaction), just running starting a new
3108 ;; process and having it execute the query and then finish, would not
3109 ;; work. I'm sure there are other uses as well, although in many cases
3110 ;; starting a new process is the simpler, and thus preferable, approach.
3111 ;;
3112 ;; The basic implementation is as follows: comint-redirect changes the
3113 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
3114 ;; its own filter. The filter puts the output into the designated buffer,
3115 ;; or buffers, until it sees a regexp that tells it to stop (by default,
3116 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
3117 ;; sees the stop regexp, it restores the old filter functions, and runs
3118 ;; `comint-redirect-hook'.
3119 ;;
3120 ;; Each comint buffer may only use one redirection at a time, but any number
3121 ;; of different comint buffers may be simultaneously redirected.
3122 ;;
3123 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
3124 ;; correct prompt for your interpreter, or that you supply a regexp that says
3125 ;; when the redirection is finished. Otherwise, redirection will continue
3126 ;; indefinitely. The code now does a sanity check to ensure that it can find
3127 ;; a prompt in the comint buffer; however, it is still important to ensure that
3128 ;; this prompt is set correctly.
3129 ;;
3130 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
3131 ;; perhaps it should prompt for a terminating string (with an
3132 ;; appropriate magic default by examining what we think is the prompt)?
3133 ;;
3134 ;; Fixme: look for appropriate fields, rather than regexp, if
3135 ;; `comint-use-prompt-regexp' is true.
3137 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3138 ;; Variables
3139 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3141 (defcustom comint-redirect-verbose nil
3142 "If non-nil, print messages each time the redirection filter is invoked.
3143 Also print a message when redirection is completed."
3144 :group 'comint
3145 :type 'boolean)
3147 ;; Directly analagous to comint-preoutput-filter-functions
3148 (defvar comint-redirect-filter-functions nil
3149 "List of functions to call before inserting redirected process output.
3150 Each function gets one argument, a string containing the text received
3151 from the subprocess. It should return the string to insert, perhaps
3152 the same string that was received, or perhaps a modified or transformed
3153 string.
3155 The functions on the list are called sequentially, and each one is given
3156 the string returned by the previous one. The string returned by the
3157 last function is the text that is actually inserted in the redirection buffer.
3159 You can use `add-hook' to add functions to this list
3160 either globally or locally.")
3162 ;; Internal variables
3164 (defvar comint-redirect-output-buffer nil
3165 "The buffer or list of buffers to put output into.")
3167 (defvar comint-redirect-finished-regexp nil
3168 "Regular expression that determines when to stop redirection in Comint.
3169 When the redirection filter function is given output that matches this regexp,
3170 the output is inserted as usual, and redirection is completed.")
3172 (defvar comint-redirect-insert-matching-regexp nil
3173 "If non-nil, the text that ends a redirection is included in it.
3174 More precisely, the text that matches `comint-redirect-finished-regexp'
3175 and therefore terminates an output redirection is inserted in the
3176 redirection target buffer, along with the preceding output.")
3178 (defvar comint-redirect-echo-input nil
3179 "Non-nil means echo input in the process buffer even during redirection.")
3181 (defvar comint-redirect-completed nil
3182 "Non-nil if redirection has completed in the current buffer.")
3184 (defvar comint-redirect-original-mode-line-process nil
3185 "Original mode line for redirected process.")
3187 (defvar comint-redirect-perform-sanity-check t
3188 "If non-nil, check that redirection is likely to complete successfully.
3189 More precisely, before starting a redirection, verify that the
3190 regular expression `comint-redirect-finished-regexp' that controls
3191 when to terminate it actually matches some text already in the process
3192 buffer. The idea is that this regular expression should match a prompt
3193 string, and that there ought to be at least one copy of your prompt string
3194 in the process buffer already.")
3196 (defvar comint-redirect-original-filter-function nil
3197 "The process filter that was in place when redirection is started.
3198 When redirection is completed, the process filter is restored to
3199 this value.")
3201 (defvar comint-redirect-subvert-readonly nil
3202 "Non-nil means `comint-redirect' can insert into read-only buffers.
3203 This works by binding `inhibit-read-only' around the insertion.
3204 This is useful, for instance, for insertion into Help mode buffers.
3205 You probably want to set it locally to the output buffer.")
3207 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3208 ;; Functions
3209 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3211 (defun comint-redirect-setup (output-buffer
3212 comint-buffer
3213 finished-regexp
3214 &optional echo-input)
3215 "Set up for output redirection.
3216 This function sets local variables that are used by `comint-redirect-filter'
3217 to perform redirection.
3219 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3220 in the output matches FINISHED-REGEXP.
3222 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3223 original Comint buffer.
3225 This function is called by `comint-redirect-send-command-to-process',
3226 and does not normally need to be invoked by the end user or programmer."
3227 (with-current-buffer comint-buffer
3229 (make-local-variable 'comint-redirect-original-mode-line-process)
3230 (setq comint-redirect-original-mode-line-process mode-line-process)
3232 (make-local-variable 'comint-redirect-output-buffer)
3233 (setq comint-redirect-output-buffer output-buffer)
3235 (make-local-variable 'comint-redirect-finished-regexp)
3236 (setq comint-redirect-finished-regexp finished-regexp)
3238 (make-local-variable 'comint-redirect-echo-input)
3239 (setq comint-redirect-echo-input echo-input)
3241 (make-local-variable 'comint-redirect-completed)
3242 (setq comint-redirect-completed nil)
3244 (setq mode-line-process
3245 (if mode-line-process
3246 (list (concat (elt mode-line-process 0) " Redirection"))
3247 (list ":%s Redirection")))))
3249 (defun comint-redirect-cleanup ()
3250 "End a Comint redirection. See `comint-redirect-send-command'."
3251 (interactive)
3252 ;; Restore the process filter
3253 (set-process-filter (get-buffer-process (current-buffer))
3254 comint-redirect-original-filter-function)
3255 ;; Restore the mode line
3256 (setq mode-line-process comint-redirect-original-mode-line-process)
3257 ;; Set the completed flag
3258 (setq comint-redirect-completed t))
3260 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3261 ;; that it really occurs.
3262 (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
3264 (defun comint-redirect-filter (process input-string)
3265 "Filter function which redirects output from PROCESS to a buffer or buffers.
3266 The variable `comint-redirect-output-buffer' says which buffer(s) to
3267 place output in.
3269 INPUT-STRING is the input from the Comint process.
3271 This function runs as a process filter, and does not need to be invoked by the
3272 end user."
3273 (and process
3274 (with-current-buffer (process-buffer process)
3275 (comint-redirect-preoutput-filter input-string)
3276 ;; If we have to echo output, give it to the original filter function
3277 (and comint-redirect-echo-input
3278 comint-redirect-original-filter-function
3279 (funcall comint-redirect-original-filter-function
3280 process input-string)))))
3283 (defun comint-redirect-preoutput-filter (input-string)
3284 "Comint filter function which redirects Comint output to a buffer or buffers.
3285 The variable `comint-redirect-output-buffer' says which buffer(s) to
3286 place output in.
3288 INPUT-STRING is the input from the Comint process.
3290 This function does not need to be invoked by the end user."
3291 (let ((output-buffer-list
3292 (if (listp comint-redirect-output-buffer)
3293 comint-redirect-output-buffer
3294 (list comint-redirect-output-buffer)))
3295 (filtered-input-string input-string))
3297 ;; If there are any filter functions, give them a chance to modify
3298 ;; the string.
3299 (let ((functions comint-redirect-filter-functions))
3300 (while (and functions filtered-input-string)
3301 (if (eq (car functions) t)
3302 ;; If a local value says "use the default value too",
3303 ;; do that.
3304 (let ((functions
3305 (default-value 'comint-redirect-filter-functions)))
3306 (while (and functions filtered-input-string)
3307 (setq filtered-input-string
3308 (funcall (car functions) filtered-input-string))
3309 (setq functions (cdr functions))))
3310 (setq filtered-input-string
3311 (funcall (car functions) filtered-input-string)))
3312 (setq functions (cdr functions))))
3314 ;; Clobber `comint-redirect-finished-regexp'
3315 (or comint-redirect-insert-matching-regexp
3316 (and (string-match comint-redirect-finished-regexp filtered-input-string)
3317 (setq filtered-input-string
3318 (replace-match "" nil nil filtered-input-string))))
3320 ;; Send output to all registered buffers
3321 (save-excursion
3322 (dolist (buf output-buffer-list)
3323 ;; Set this buffer to the output buffer
3324 (set-buffer (get-buffer-create buf))
3325 ;; Go to the end of the buffer
3326 (goto-char (point-max))
3327 ;; Insert the output
3328 (let ((inhibit-read-only comint-redirect-subvert-readonly))
3329 (insert filtered-input-string))))
3331 ;; Message
3332 (and comint-redirect-verbose
3333 (message "Redirected output to buffer(s) %s"
3334 (mapconcat 'identity output-buffer-list " ")))
3336 ;; If we see the prompt, tidy up
3337 ;; We'll look for the prompt in the original string, so nobody can
3338 ;; clobber it
3339 (and (string-match comint-redirect-finished-regexp input-string)
3340 (progn
3341 (and comint-redirect-verbose
3342 (message "Redirection completed"))
3343 (comint-redirect-cleanup)
3344 (run-hooks 'comint-redirect-hook)))
3345 ;; Echo input?
3346 (if comint-redirect-echo-input
3347 filtered-input-string
3348 "")))
3350 ;;;###autoload
3351 (defun comint-redirect-send-command (command output-buffer echo &optional no-display)
3352 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3353 With prefix arg ECHO, echo output in process buffer.
3355 If NO-DISPLAY is non-nil, do not show the output buffer."
3357 (let ((process (get-buffer-process (current-buffer))))
3358 (if process
3359 (comint-redirect-send-command-to-process
3360 command output-buffer (current-buffer) echo no-display)
3361 (error "No process for current buffer"))))
3363 ;;;###autoload
3364 (defun comint-redirect-send-command-to-process
3365 (command output-buffer process echo &optional no-display)
3366 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3367 With prefix arg, echo output in process buffer.
3369 If NO-DISPLAY is non-nil, do not show the output buffer."
3371 (let* (;; The process buffer
3372 (process-buffer (if (processp process)
3373 (process-buffer process)
3374 process))
3375 (proc (get-buffer-process process-buffer)))
3376 ;; Change to the process buffer
3377 (with-current-buffer process-buffer
3379 ;; Make sure there's a prompt in the current process buffer
3380 (and comint-redirect-perform-sanity-check
3381 (save-excursion
3382 (goto-char (point-max))
3383 (or (re-search-backward comint-prompt-regexp nil t)
3384 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3386 ;; Set up for redirection
3387 (comint-redirect-setup
3388 output-buffer
3389 (current-buffer) ; Comint Buffer
3390 comint-prompt-regexp ; Finished Regexp
3391 echo) ; Echo input
3393 ;; Set the filter
3394 (setq comint-redirect-original-filter-function ; Save the old filter
3395 (process-filter proc))
3396 (set-process-filter proc 'comint-redirect-filter)
3398 ;; Send the command
3401 ;; Show the output
3402 (or no-display
3403 (display-buffer
3404 (get-buffer-create
3405 (if (listp output-buffer)
3406 (car output-buffer)
3407 output-buffer)))))))
3409 ;;;###autoload
3410 (defun comint-redirect-results-list (command regexp regexp-group)
3411 "Send COMMAND to current process.
3412 Return a list of expressions in the output which match REGEXP.
3413 REGEXP-GROUP is the regular expression group in REGEXP to use."
3414 (comint-redirect-results-list-from-process
3415 (get-buffer-process (current-buffer))
3416 command regexp regexp-group))
3418 ;;;###autoload
3419 (defun comint-redirect-results-list-from-process (process command regexp regexp-group)
3420 "Send COMMAND to PROCESS.
3421 Return a list of expressions in the output which match REGEXP.
3422 REGEXP-GROUP is the regular expression group in REGEXP to use."
3423 (let ((output-buffer " *Comint Redirect Work Buffer*")
3424 results)
3425 (with-current-buffer (get-buffer-create output-buffer)
3426 (erase-buffer)
3427 (comint-redirect-send-command-to-process command
3428 output-buffer process nil t)
3429 ;; Wait for the process to complete
3430 (set-buffer (process-buffer process))
3431 (while (null comint-redirect-completed)
3432 (accept-process-output nil 1))
3433 ;; Collect the output
3434 (set-buffer output-buffer)
3435 (goto-char (point-min))
3436 ;; Skip past the command, if it was echoed
3437 (and (looking-at command)
3438 (forward-line))
3439 (while (re-search-forward regexp nil t)
3440 (push (buffer-substring-no-properties
3441 (match-beginning regexp-group)
3442 (match-end regexp-group))
3443 results))
3444 results)))
3446 (dolist (x '("^Not at command line$"
3447 "^Empty input ring$"
3448 "^No history$"
3449 "^Not found$" ; Too common?
3450 "^Current buffer has no process$"))
3451 (add-to-list 'debug-ignored-errors x))
3453 \f
3454 ;; Converting process modes to use comint mode
3455 ;; ===========================================================================
3456 ;; The code in the Emacs 19 distribution has all been modified to use comint
3457 ;; where needed. However, there are `third-party' packages out there that
3458 ;; still use the old shell mode. Here's a guide to conversion.
3459 ;;
3460 ;; Renaming variables
3461 ;; Most of the work is renaming variables and functions. These are the common
3462 ;; ones:
3463 ;; Local variables:
3464 ;; last-input-start comint-last-input-start
3465 ;; last-input-end comint-last-input-end
3466 ;; shell-prompt-pattern comint-prompt-regexp
3467 ;; shell-set-directory-error-hook <no equivalent>
3468 ;; Miscellaneous:
3469 ;; shell-set-directory <unnecessary>
3470 ;; shell-mode-map comint-mode-map
3471 ;; Commands:
3472 ;; shell-send-input comint-send-input
3473 ;; shell-send-eof comint-delchar-or-maybe-eof
3474 ;; kill-shell-input comint-kill-input
3475 ;; interrupt-shell-subjob comint-interrupt-subjob
3476 ;; stop-shell-subjob comint-stop-subjob
3477 ;; quit-shell-subjob comint-quit-subjob
3478 ;; kill-shell-subjob comint-kill-subjob
3479 ;; kill-output-from-shell comint-delete-output
3480 ;; show-output-from-shell comint-show-output
3481 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3482 ;;
3483 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3484 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3485 ;; Comint mode does not provide functionality equivalent to
3486 ;; shell-set-directory-error-hook; it is gone.
3487 ;;
3488 ;; comint-last-input-start is provided for modes which want to munge
3489 ;; the buffer after input is sent, perhaps because the inferior
3490 ;; insists on echoing the input. The LAST-INPUT-START variable in
3491 ;; the old shell package was used to implement a history mechanism,
3492 ;; but you should think twice before using comint-last-input-start
3493 ;; for this; the input history ring often does the job better.
3494 ;;
3495 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3496 ;; *not* create the comint-mode local variables in your foo-mode function.
3497 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3498 ;; necessary comint-specific local variables. Then create the
3499 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3500 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3501 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3502 ;; get-old-input) that need to be different from the defaults. Call
3503 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3504 ;; comint-mode will take care of it. The following example, from shell.el,
3505 ;; is typical:
3506 ;;
3507 ;; (defvar shell-mode-map '())
3508 ;; (cond ((not shell-mode-map)
3509 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3510 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3511 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3513 ;; (define-key shell-mode-map "\M-?"
3514 ;; 'comint-dynamic-list-filename-completions)))
3515 ;;
3516 ;; (defun shell-mode ()
3517 ;; (interactive)
3518 ;; (comint-mode)
3519 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3520 ;; (setq major-mode 'shell-mode)
3521 ;; (setq mode-name "Shell")
3522 ;; (use-local-map shell-mode-map)
3523 ;; (make-local-variable 'shell-directory-stack)
3524 ;; (setq shell-directory-stack nil)
3525 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3526 ;; (run-mode-hooks 'shell-mode-hook))
3527 ;;
3528 ;;
3529 ;; Completion for comint-mode users
3530 ;;
3531 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3532 ;; hook to add completion functions to. Functions on this list should return
3533 ;; non-nil if completion occurs (i.e., further completion should not occur).
3534 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3535 ;; completion job.
3536 \f
3538 (provide 'comint)
3540 ;; arch-tag: 1793314c-09db-40be-9549-9aeae3e75164
3541 ;;; comint.el ends here