| blob | 5bff98689444e9611ffe31c3cad6486ef26f61c6 |
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 to send the contents of to the process.
691 If PROGRAM is a string, any more args are arguments to PROGRAM."
692 (or (fboundp 'start-file-process)
693 (error "Multi-processing is not supported for this system"))
694 (setq buffer (get-buffer-create (or buffer (concat "*" name "*"))))
695 ;; If no process, or nuked process, crank up a new one and put buffer in
696 ;; comint mode. Otherwise, leave buffer and existing process alone.
697 (unless (comint-check-proc buffer)
698 (with-current-buffer buffer
699 (unless (derived-mode-p 'comint-mode)
700 (comint-mode))) ; Install local vars, mode, keymap, ...
701 (comint-exec buffer name program startfile switches))
702 buffer)
704 ;;;###autoload
705 (defun make-comint (name program &optional startfile &rest switches)
706 "Make a Comint process NAME in a buffer, running PROGRAM.
707 The name of the buffer is made by surrounding NAME with `*'s.
708 PROGRAM should be either a string denoting an executable program to create
709 via `start-file-process', or a cons pair of the form (HOST . SERVICE) denoting
710 a TCP connection to be opened via `open-network-stream'. If there is already
711 a running process in that buffer, it is not restarted. Optional third arg
712 STARTFILE is the name of a file to send the contents of the process to.
714 If PROGRAM is a string, any more args are arguments to PROGRAM."
715 (apply #'make-comint-in-buffer name nil program startfile switches))
717 ;;;###autoload
718 (defun comint-run (program)
719 "Run PROGRAM in a Comint buffer and switch to it.
720 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
721 The file name is used to make a symbol name, such as `comint-sh-hook', and any
722 hooks on this symbol are run in the buffer.
723 See `make-comint' and `comint-exec'."
724 (interactive "sRun program: ")
725 (let ((name (file-name-nondirectory program)))
726 (switch-to-buffer (make-comint name program))
727 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
729 (defun comint-exec (buffer name command startfile switches)
730 "Start up a process named NAME in buffer BUFFER for Comint modes.
731 Runs the given COMMAND with SWITCHES with output to STARTFILE.
732 Blasts any old process running in the buffer. Doesn't set the buffer mode.
733 You can use this to cheaply run a series of processes in the same Comint
734 buffer. The hook `comint-exec-hook' is run after each exec."
735 (with-current-buffer buffer
736 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
737 (if proc (delete-process proc)))
738 ;; Crank up a new process
739 (let ((proc
740 (if (consp command)
741 (open-network-stream name buffer (car command) (cdr command))
742 (comint-exec-1 name buffer command switches))))
743 (set-process-filter proc 'comint-output-filter)
744 (make-local-variable 'comint-ptyp)
745 (setq comint-ptyp process-connection-type) ; t if pty, nil if pipe.
746 ;; Jump to the end, and set the process mark.
747 (goto-char (point-max))
748 (set-marker (process-mark proc) (point))
749 ;; Feed it the startfile.
750 (cond (startfile
751 ;;This is guaranteed to wait long enough
752 ;;but has bad results if the comint does not prompt at all
753 ;; (while (= size (buffer-size))
754 ;; (sleep-for 1))
755 ;;I hope 1 second is enough!
756 (sleep-for 1)
757 (goto-char (point-max))
758 (insert-file-contents startfile)
759 (setq startfile (buffer-substring (point) (point-max)))
760 (delete-region (point) (point-max))
761 (comint-send-string proc startfile)))
762 (run-hooks 'comint-exec-hook)
763 buffer)))
765 ;; This auxiliary function cranks up the process for comint-exec in
766 ;; the appropriate environment.
768 (defun comint-exec-1 (name buffer command switches)
769 (let ((process-environment
770 (nconc
771 ;; If using termcap, we specify `emacs' as the terminal type
772 ;; because that lets us specify a width.
773 ;; If using terminfo, we specify `dumb' because that is
774 ;; a defined terminal type. `emacs' is not a defined terminal type
775 ;; and there is no way for us to define it here.
776 ;; Some programs that use terminfo get very confused
777 ;; if TERM is not a valid terminal type.
778 ;; ;; There is similar code in compile.el.
779 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
780 (list "TERM=dumb" "TERMCAP="
781 (format "COLUMNS=%d" (window-width)))
782 (list "TERM=emacs"
783 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
784 (unless (getenv "EMACS")
785 (list "EMACS=t"))
786 (list (format "INSIDE_EMACS=%s,comint" emacs-version))
787 process-environment))
788 (default-directory
789 (if (file-accessible-directory-p default-directory)
790 default-directory
791 "/"))
792 proc decoding encoding changed)
793 (let ((exec-path (if (file-name-directory command)
794 ;; If the command has slashes, make sure we
795 ;; first look relative to the current directory.
796 (cons default-directory exec-path) exec-path)))
797 (setq proc (apply 'start-file-process name buffer command switches)))
798 ;; Some file name handler cannot start a process, fe ange-ftp.
799 (unless (processp proc) (error "No process started"))
800 (let ((coding-systems (process-coding-system proc)))
801 (setq decoding (car coding-systems)
802 encoding (cdr coding-systems)))
803 ;; Even if start-file-process left the coding system for encoding data
804 ;; sent from the process undecided, we had better use the same one
805 ;; as what we use for decoding. But, we should suppress EOL
806 ;; conversion.
807 (if (and decoding (not encoding))
808 (setq encoding (coding-system-change-eol-conversion decoding 'unix)
809 changed t))
810 (if changed
811 (set-process-coding-system proc decoding encoding))
812 proc))
814 (defun comint-insert-input (event)
815 "In a Comint buffer, set the current input to the previous input at point.
816 If there is no previous input at point, run the command specified
817 by the global keymap (usually `mouse-yank-at-point')."
818 (interactive "e")
819 (mouse-set-point event)
820 (let ((pos (posn-point (event-end event)))
821 field input)
822 (with-selected-window (posn-window (event-end event))
823 (and (setq field (field-at-pos pos))
824 (setq input (field-string-no-properties pos))))
825 (if (or (null comint-accum-marker)
826 (not (eq field 'input)))
827 ;; Fall back to the global definition if (i) the selected
828 ;; buffer is not a comint buffer (which can happen if a
829 ;; non-comint window was selected and we clicked in a comint
830 ;; window), or (ii) there is no input at POS.
831 (let* ((keys (this-command-keys))
832 (last-key (and (vectorp keys) (aref keys (1- (length keys)))))
833 (fun (and last-key (lookup-key global-map (vector last-key)))))
834 (and fun (not (eq fun 'comint-insert-input))
835 (call-interactively fun)))
836 ;; Otherwise, insert the previous input.
837 (goto-char (point-max))
838 ;; First delete any old unsent input at the end
839 (delete-region
840 (or (marker-position comint-accum-marker)
841 (process-mark (get-buffer-process (current-buffer))))
842 (point))
843 ;; Insert the input at point
844 (insert input))))
845 \f
846 ;; Input history processing in a buffer
847 ;; ===========================================================================
848 ;; Useful input history functions, courtesy of the Ergo group.
850 ;; Eleven commands:
851 ;; comint-dynamic-list-input-ring List history in help buffer.
852 ;; comint-previous-input Previous input...
853 ;; comint-previous-matching-input ...matching a string.
854 ;; comint-previous-matching-input-from-input ... matching the current input.
855 ;; comint-next-input Next input...
856 ;; comint-next-matching-input ...matching a string.
857 ;; comint-next-matching-input-from-input ... matching the current input.
858 ;; comint-backward-matching-input Backwards input...
859 ;; comint-forward-matching-input ...matching a string.
860 ;; comint-replace-by-expanded-history Expand history at point;
861 ;; replace with expanded history.
862 ;; comint-magic-space Expand history and insert space.
863 ;;
864 ;; Three functions:
865 ;; comint-read-input-ring Read into comint-input-ring...
866 ;; comint-write-input-ring Write to comint-input-ring-file-name.
867 ;; comint-replace-by-expanded-history-before-point Workhorse function.
869 (defun comint-read-input-ring (&optional silent)
870 "Set the buffer's `comint-input-ring' from a history file.
871 The name of the file is given by the variable `comint-input-ring-file-name'.
872 The history ring is of size `comint-input-ring-size', regardless of file size.
873 If `comint-input-ring-file-name' is nil this function does nothing.
875 If the optional argument SILENT is non-nil, we say nothing about a
876 failure to read the history file.
878 This function is useful for major mode commands and mode hooks.
880 The commands stored in the history file are separated by the
881 `comint-input-ring-separator', and entries that match
882 `comint-input-history-ignore' are ignored. The most recent command
883 comes last.
885 See also `comint-input-ignoredups' and `comint-write-input-ring'."
886 (cond ((or (null comint-input-ring-file-name)
887 (equal comint-input-ring-file-name ""))
888 nil)
889 ((not (file-readable-p comint-input-ring-file-name))
890 (or silent
891 (message "Cannot read history file %s"
892 comint-input-ring-file-name)))
893 (t
894 (let* ((history-buf (get-buffer-create " *temp*"))
895 (file comint-input-ring-file-name)
896 (count 0)
897 (size comint-input-ring-size)
898 (ring (make-ring size)))
899 (unwind-protect
900 (save-excursion
901 (set-buffer history-buf)
902 (widen)
903 (erase-buffer)
904 (insert-file-contents file)
905 ;; Save restriction in case file is already visited...
906 ;; Watch for those date stamps in history files!
907 (goto-char (point-max))
908 (let (start end history)
909 (while (and (< count size)
910 (re-search-backward comint-input-ring-separator nil t)
911 (setq end (match-beginning 0)))
912 (if (re-search-backward comint-input-ring-separator nil t)
913 (setq start (match-end 0))
914 (setq start (point-min)))
915 (setq history (buffer-substring start end))
916 (goto-char start)
917 (if (and (not (string-match comint-input-history-ignore history))
918 (or (null comint-input-ignoredups)
919 (ring-empty-p ring)
920 (not (string-equal (ring-ref ring 0) history))))
921 (progn
922 (ring-insert-at-beginning ring history)
923 (setq count (1+ count)))))))
924 (kill-buffer history-buf))
925 (setq comint-input-ring ring
926 comint-input-ring-index nil)))))
928 (defun comint-write-input-ring ()
929 "Writes the buffer's `comint-input-ring' to a history file.
930 The name of the file is given by the variable `comint-input-ring-file-name'.
931 The original contents of the file are lost if `comint-input-ring' is not empty.
932 If `comint-input-ring-file-name' is nil this function does nothing.
934 Useful within process sentinels.
936 See also `comint-read-input-ring'."
937 (cond ((or (null comint-input-ring-file-name)
938 (equal comint-input-ring-file-name "")
939 (null comint-input-ring) (ring-empty-p comint-input-ring))
940 nil)
941 ((not (file-writable-p comint-input-ring-file-name))
942 (message "Cannot write history file %s" comint-input-ring-file-name))
943 (t
944 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
945 (ring comint-input-ring)
946 (file comint-input-ring-file-name)
947 (index (ring-length ring)))
948 ;; Write it all out into a buffer first. Much faster, but messier,
949 ;; than writing it one line at a time.
950 (save-excursion
951 (set-buffer history-buf)
952 (erase-buffer)
953 (while (> index 0)
954 (setq index (1- index))
955 (insert (ring-ref ring index) comint-input-ring-separator))
956 (write-region (buffer-string) nil file nil 'no-message)
957 (kill-buffer nil))))))
960 (defvar comint-dynamic-list-input-ring-window-conf)
962 (defun comint-dynamic-list-input-ring-select ()
963 "Choose the input history entry that point is in or next to."
964 (interactive)
965 (let ((buffer completion-reference-buffer)
966 (base-size completion-base-size)
967 beg end completion)
968 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
969 (setq end (point) beg (1+ (point))))
970 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
971 (setq end (1- (point)) beg (point)))
972 (if (null beg)
973 (error "No history entry here"))
974 (setq beg (previous-single-property-change beg 'mouse-face))
975 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
976 (setq completion (buffer-substring beg end))
977 (set-window-configuration comint-dynamic-list-input-ring-window-conf)
978 (choose-completion-string completion buffer base-size)))
980 (defun comint-dynamic-list-input-ring ()
981 "List in help buffer the buffer's input history."
982 (interactive)
983 (if (or (not (ring-p comint-input-ring))
984 (ring-empty-p comint-input-ring))
985 (message "No history")
986 (let ((history nil)
987 (history-buffer " *Input History*")
988 (index (1- (ring-length comint-input-ring)))
989 (conf (current-window-configuration)))
990 ;; We have to build up a list ourselves from the ring vector.
991 (while (>= index 0)
992 (setq history (cons (ring-ref comint-input-ring index) history)
993 index (1- index)))
994 ;; Change "completion" to "history reference"
995 ;; to make the display accurate.
996 (with-output-to-temp-buffer history-buffer
997 (display-completion-list history)
998 (set-buffer history-buffer)
999 (let ((keymap (make-sparse-keymap)))
1000 (set-keymap-parent keymap (current-local-map))
1001 (define-key keymap "\C-m" 'comint-dynamic-list-input-ring-select)
1002 (use-local-map keymap))
1003 (forward-line 3)
1004 (while (search-backward "completion" nil 'move)
1005 (replace-match "history reference")))
1006 (sit-for 0)
1007 (message "Hit space to flush")
1008 (setq comint-dynamic-list-input-ring-window-conf conf)
1009 (let ((ch (read-event)))
1010 (if (eq ch ?\s)
1011 (set-window-configuration conf)
1012 (setq unread-command-events (list ch)))))))
1015 (defun comint-regexp-arg (prompt)
1016 "Return list of regexp and prefix arg using PROMPT."
1017 (let* (;; Don't clobber this.
1018 (last-command last-command)
1019 (regexp (read-from-minibuffer prompt nil nil nil
1020 'minibuffer-history-search-history)))
1021 ;; If the user didn't enter anything, nothing is added to m-h-s-h.
1022 ;; Use the previous search regexp, if there is one.
1023 (list (if (string-equal regexp "")
1024 (or (car minibuffer-history-search-history)
1025 regexp)
1026 regexp)
1027 (prefix-numeric-value current-prefix-arg))))
1029 (defun comint-search-arg (arg)
1030 ;; First make sure there is a ring and that we are after the process mark
1031 (cond ((not (comint-after-pmark-p))
1032 (error "Not at command line"))
1033 ((or (null comint-input-ring)
1034 (ring-empty-p comint-input-ring))
1035 (error "Empty input ring"))
1036 ((zerop arg)
1037 ;; arg of zero resets search from beginning, and uses arg of 1
1038 (setq comint-input-ring-index nil)
1039 1)
1040 (t
1041 arg)))
1043 (defun comint-restore-input ()
1044 "Restore unfinished input."
1045 (interactive)
1046 (when comint-input-ring-index
1047 (comint-delete-input)
1048 (when (> (length comint-stored-incomplete-input) 0)
1049 (insert comint-stored-incomplete-input)
1050 (message "Input restored"))
1051 (setq comint-input-ring-index nil)))
1053 (defun comint-search-start (arg)
1054 "Index to start a directional search, starting at `comint-input-ring-index'."
1055 (if comint-input-ring-index
1056 ;; If a search is running, offset by 1 in direction of arg
1057 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
1058 (ring-length comint-input-ring))
1059 ;; For a new search, start from beginning or end, as appropriate
1060 (if (>= arg 0)
1061 0 ; First elt for forward search
1062 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
1064 (defun comint-previous-input-string (arg)
1065 "Return the string ARG places along the input ring.
1066 Moves relative to `comint-input-ring-index'."
1067 (ring-ref comint-input-ring (if comint-input-ring-index
1068 (mod (+ arg comint-input-ring-index)
1069 (ring-length comint-input-ring))
1070 arg)))
1072 (defun comint-previous-input (arg)
1073 "Cycle backwards through input history, saving input."
1074 (interactive "*p")
1075 (if (and comint-input-ring-index
1076 (or ;; leaving the "end" of the ring
1077 (and (< arg 0) ; going down
1078 (eq comint-input-ring-index 0))
1079 (and (> arg 0) ; going up
1080 (eq comint-input-ring-index
1081 (1- (ring-length comint-input-ring)))))
1082 comint-stored-incomplete-input)
1083 (comint-restore-input)
1084 (comint-previous-matching-input "." arg)))
1086 (defun comint-next-input (arg)
1087 "Cycle forwards through input history."
1088 (interactive "*p")
1089 (comint-previous-input (- arg)))
1091 (defun comint-previous-matching-input-string (regexp arg)
1092 "Return the string matching REGEXP ARG places along the input ring.
1093 Moves relative to `comint-input-ring-index'."
1094 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
1095 (if pos (ring-ref comint-input-ring pos))))
1097 (defun comint-previous-matching-input-string-position (regexp arg &optional start)
1098 "Return the index matching REGEXP ARG places along the input ring.
1099 Moves relative to START, or `comint-input-ring-index'."
1100 (if (or (not (ring-p comint-input-ring))
1101 (ring-empty-p comint-input-ring))
1102 (error "No history"))
1103 (let* ((len (ring-length comint-input-ring))
1104 (motion (if (> arg 0) 1 -1))
1105 (n (mod (- (or start (comint-search-start arg)) motion) len))
1106 (tried-each-ring-item nil)
1107 (prev nil))
1108 ;; Do the whole search as many times as the argument says.
1109 (while (and (/= arg 0) (not tried-each-ring-item))
1110 ;; Step once.
1111 (setq prev n
1112 n (mod (+ n motion) len))
1113 ;; If we haven't reached a match, step some more.
1114 (while (and (< n len) (not tried-each-ring-item)
1115 (not (string-match regexp (ring-ref comint-input-ring n))))
1116 (setq n (mod (+ n motion) len)
1117 ;; If we have gone all the way around in this search.
1118 tried-each-ring-item (= n prev)))
1119 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1120 ;; Now that we know which ring element to use, if we found it, return that.
1121 (if (string-match regexp (ring-ref comint-input-ring n))
1122 n)))
1124 (defun comint-delete-input ()
1125 "Delete all input between accumulation or process mark and point."
1126 (delete-region
1127 ;; Can't use kill-region as it sets this-command
1128 (or (marker-position comint-accum-marker)
1129 (process-mark (get-buffer-process (current-buffer))))
1130 (point-max)))
1132 (defun comint-previous-matching-input (regexp n)
1133 "Search backwards through input history for match for REGEXP.
1134 \(Previous history elements are earlier commands.)
1135 With prefix argument N, search for Nth previous match.
1136 If N is negative, find the next or Nth next match."
1137 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1138 (setq n (comint-search-arg n))
1139 (let ((pos (comint-previous-matching-input-string-position regexp n)))
1140 ;; Has a match been found?
1141 (if (null pos)
1142 (error "Not found")
1143 ;; If leaving the edit line, save partial input
1144 (if (null comint-input-ring-index) ;not yet on ring
1145 (setq comint-stored-incomplete-input
1146 (funcall comint-get-old-input)))
1147 (setq comint-input-ring-index pos)
1148 (message "History item: %d" (1+ pos))
1149 (comint-delete-input)
1150 (insert (ring-ref comint-input-ring pos)))))
1152 (defun comint-next-matching-input (regexp n)
1153 "Search forwards through input history for match for REGEXP.
1154 \(Later history elements are more recent commands.)
1155 With prefix argument N, search for Nth following match.
1156 If N is negative, find the previous or Nth previous match."
1157 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1158 (comint-previous-matching-input regexp (- n)))
1160 (defun comint-previous-matching-input-from-input (n)
1161 "Search backwards through input history for match for current input.
1162 \(Previous history elements are earlier commands.)
1163 With prefix argument N, search for Nth previous match.
1164 If N is negative, search forwards for the -Nth following match."
1165 (interactive "p")
1166 (if (not (memq last-command '(comint-previous-matching-input-from-input
1167 comint-next-matching-input-from-input)))
1168 ;; Starting a new search
1169 (setq comint-matching-input-from-input-string
1170 (buffer-substring
1171 (or (marker-position comint-accum-marker)
1172 (process-mark (get-buffer-process (current-buffer))))
1173 (point))
1174 comint-input-ring-index nil))
1175 (comint-previous-matching-input
1176 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1177 n))
1179 (defun comint-next-matching-input-from-input (n)
1180 "Search forwards through input history for match for current input.
1181 \(Following history elements are more recent commands.)
1182 With prefix argument N, search for Nth following match.
1183 If N is negative, search backwards for the -Nth previous match."
1184 (interactive "p")
1185 (comint-previous-matching-input-from-input (- n)))
1188 (defun comint-replace-by-expanded-history (&optional silent start)
1189 "Expand input command history references before point.
1190 Expansion is dependent on the value of `comint-input-autoexpand'.
1192 This function depends on the buffer's idea of the input history, which may not
1193 match the command interpreter's idea, assuming it has one.
1195 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1196 cannot know the interpreter's idea of input line numbers, assuming it has one,
1197 it cannot expand absolute input line number references.
1199 If the optional argument SILENT is non-nil, never complain
1200 even if history reference seems erroneous.
1202 If the optional argument START is non-nil, that specifies the
1203 start of the text to scan for history references, rather
1204 than the logical beginning of line.
1206 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1208 Returns t if successful."
1209 (interactive)
1210 (if (and comint-input-autoexpand
1211 (if comint-use-prompt-regexp
1212 ;; Use comint-prompt-regexp
1213 (save-excursion
1214 (beginning-of-line)
1216 ;; Use input fields. User input that hasn't been entered
1217 ;; yet, at the end of the buffer, has a nil `field' property.
1218 (and (null (get-char-property (point) 'field))
1220 ;; Looks like there might be history references in the command.
1221 (let ((previous-modified-tick (buffer-modified-tick)))
1222 (comint-replace-by-expanded-history-before-point silent start)
1223 (/= previous-modified-tick (buffer-modified-tick)))))
1226 (defun comint-replace-by-expanded-history-before-point (silent &optional start)
1227 "Expand directory stack reference before point.
1228 See `comint-replace-by-expanded-history'. Returns t if successful.
1230 If the optional argument START is non-nil, that specifies the
1231 start of the text to scan for history references, rather
1232 than the logical beginning of line."
1233 (save-excursion
1234 (let ((toend (- (line-end-position) (point)))
1235 (start (or start (comint-line-beginning-position))))
1236 (goto-char start)
1237 (while (progn
1238 (skip-chars-forward "^!^" (- (line-end-position) toend))
1239 (< (point) (- (line-end-position) toend)))
1240 ;; This seems a bit complex. We look for references such as !!, !-num,
1241 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1242 ;; If that wasn't enough, the plings can be suffixed with argument
1243 ;; range specifiers.
1244 ;; Argument ranges are complex too, so we hive off the input line,
1245 ;; referenced with plings, with the range string to `comint-args'.
1246 (setq comint-input-ring-index nil)
1248 (comint-within-quotes start (point)))
1249 ;; The history is quoted, or we're in quotes.
1250 (goto-char (1+ (point))))
1252 ;; We cannot know the interpreter's idea of input line numbers.
1253 (goto-char (match-end 0))
1254 (message "Absolute reference cannot be expanded"))
1256 ;; Just a number of args from `number' lines backward.
1257 (let ((number (1- (string-to-number
1258 (buffer-substring (match-beginning 1)
1259 (match-end 1))))))
1260 (if (<= number (ring-length comint-input-ring))
1261 (progn
1262 (replace-match
1263 (comint-args (comint-previous-input-string number)
1264 (match-beginning 2) (match-end 2))
1265 t t)
1266 (setq comint-input-ring-index number)
1267 (message "History item: %d" (1+ number)))
1268 (goto-char (match-end 0))
1269 (message "Relative reference exceeds input history size"))))
1271 ;; Just a number of args from the previous input line.
1272 (replace-match
1273 (comint-args (comint-previous-input-string 0)
1274 (match-beginning 1) (match-end 1))
1275 t t)
1276 (message "History item: previous"))
1277 ((looking-at
1279 ;; Most recent input starting with or containing (possibly
1280 ;; protected) string, maybe just a number of args. Phew.
1281 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1282 (mb2 (match-beginning 2)) (me2 (match-end 2))
1283 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1285 (pos (save-match-data
1286 (comint-previous-matching-input-string-position
1287 (concat pref (regexp-quote exp)) 1))))
1288 (if (null pos)
1289 (progn
1290 (goto-char (match-end 0))
1291 (or silent
1292 (progn (message "Not found")
1293 (ding))))
1294 (setq comint-input-ring-index pos)
1295 (replace-match
1296 (comint-args (ring-ref comint-input-ring pos)
1297 (match-beginning 4) (match-end 4))
1298 t t)
1299 (message "History item: %d" (1+ pos)))))
1301 ;; Quick substitution on the previous input line.
1302 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1303 (new (buffer-substring (match-beginning 2) (match-end 2)))
1304 (pos nil))
1305 (replace-match (comint-previous-input-string 0) t t)
1306 (setq pos (point))
1307 (goto-char (match-beginning 0))
1308 (if (not (search-forward old pos t))
1309 (or silent
1310 (error "Not found"))
1311 (replace-match new t t)
1312 (message "History item: substituted"))))
1313 (t
1314 (forward-char 1)))))))
1317 (defun comint-magic-space (arg)
1318 "Expand input history references before point and insert ARG spaces.
1319 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1320 (interactive "p")
1321 (comint-replace-by-expanded-history)
1322 (self-insert-command arg))
1323 \f
1324 (defun comint-within-quotes (beg end)
1325 "Return t if the number of quotes between BEG and END is odd.
1326 Quotes are single and double."
1329 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1331 (defun comint-how-many-region (regexp beg end)
1332 "Return number of matches for REGEXP from BEG to END."
1333 (let ((count 0))
1334 (save-excursion
1335 (save-match-data
1336 (goto-char beg)
1337 (while (re-search-forward regexp end t)
1338 (setq count (1+ count)))))
1339 count))
1341 (defun comint-args (string begin end)
1342 ;; From STRING, return the args depending on the range specified in the text
1343 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1344 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1345 (save-match-data
1346 (if (null begin)
1347 (comint-arguments string 0 nil)
1348 (let* ((range (buffer-substring
1349 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1350 (nth (cond ((string-match "^[*^]" range) 1)
1351 ((string-match "^-" range) 0)
1352 ((string-equal range "$") nil)
1353 (t (string-to-number range))))
1354 (mth (cond ((string-match "[-*$]$" range) nil)
1355 ((string-match "-" range)
1356 (string-to-number (substring range (match-end 0))))
1357 (t nth))))
1358 (comint-arguments string nth mth)))))
1360 (defun comint-delim-arg (arg)
1361 "Return a list of arguments from ARG.
1362 Break it up at the delimiters in `comint-delimiter-argument-list'.
1363 Returned list is backwards.
1365 Characters with non-nil values of the text property `literal' are
1366 assumed to have literal values (e.g., backslash-escaped
1367 characters), and are not considered to be delimiters."
1368 (if (null comint-delimiter-argument-list)
1369 (list arg)
1370 (let ((args nil)
1371 (pos 0)
1372 (len (length arg)))
1373 (while (< pos len)
1374 (let ((char (aref arg pos))
1375 (start pos))
1376 (if (and (memq char comint-delimiter-argument-list)
1377 ;; Ignore backslash-escaped characters.
1378 (not (get-text-property pos 'literal arg)))
1379 (while (and (< pos len) (eq (aref arg pos) char))
1380 (setq pos (1+ pos)))
1381 (while (and (< pos len)
1382 (not (and (memq (aref arg pos)
1383 comint-delimiter-argument-list)
1384 (not (get-text-property
1385 pos 'literal arg)))))
1386 (setq pos (1+ pos))))
1387 (setq args (cons (substring arg start pos) args))))
1388 args)))
1390 (defun comint-arguments (string nth mth)
1391 "Return from STRING the NTH to MTH arguments.
1392 NTH and/or MTH can be nil, which means the last argument.
1393 Returned arguments are separated by single spaces.
1394 We assume whitespace separates arguments, except within quotes
1395 and except for a space or tab that immediately follows a backslash.
1396 Also, a run of one or more of a single character
1397 in `comint-delimiter-argument-list' is a separate argument.
1398 Argument 0 is the command name."
1399 ;; The first line handles ordinary characters and backslash-sequences
1400 ;; (except with w32 msdos-like shells, where backslashes are valid).
1401 ;; The second matches "-quoted strings.
1402 ;; The third matches '-quoted strings.
1403 ;; The fourth matches `-quoted strings.
1404 ;; This seems to fit the syntax of BASH 2.0.
1405 (let* ((backslash-escape (not (and (fboundp 'w32-shell-dos-semantics)
1406 (w32-shell-dos-semantics))))
1407 (first (if backslash-escape
1410 (argpart (concat first
1414 (quote-subexpr (if backslash-escape 2 1))
1415 (args ()) (pos 0)
1416 (count 0)
1417 beg str quotes)
1418 ;; Build a list of all the args until we have as many as we want.
1419 (while (and (or (null mth) (<= count mth))
1420 (string-match argpart string pos))
1421 ;; Apply the `literal' text property to backslash-escaped
1422 ;; characters, so that `comint-delim-arg' won't break them up.
1423 (and backslash-escape
1424 (match-beginning 1)
1425 (put-text-property (match-beginning 1) (match-end 1)
1426 'literal t string))
1427 (if (and beg (= pos (match-beginning 0)))
1428 ;; It's contiguous, part of the same arg.
1429 (setq pos (match-end 0)
1430 quotes (or quotes (match-beginning quote-subexpr)))
1431 ;; It's a new separate arg.
1432 (if beg
1433 ;; Put the previous arg, if there was one, onto ARGS.
1434 (setq str (substring string beg pos)
1435 args (if quotes (cons str args)
1436 (nconc (comint-delim-arg str) args))))
1437 (setq count (length args))
1438 (setq quotes (match-beginning quote-subexpr))
1439 (setq beg (match-beginning 0))
1440 (setq pos (match-end 0))))
1441 (if beg
1442 (setq str (substring string beg pos)
1443 args (if quotes (cons str args)
1444 (nconc (comint-delim-arg str) args))))
1445 (setq count (length args))
1446 (let ((n (or nth (1- count)))
1447 (m (if mth (1- (- count mth)) 0)))
1448 (mapconcat
1449 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1450 \f
1451 ;;
1452 ;; Input processing stuff
1453 ;;
1454 (defun comint-add-to-input-history (cmd)
1455 "Add CMD to the input history.
1456 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1457 (if (and (funcall comint-input-filter cmd)
1458 (or (null comint-input-ignoredups)
1459 (not (ring-p comint-input-ring))
1460 (ring-empty-p comint-input-ring)
1461 (not (string-equal (ring-ref comint-input-ring 0)
1462 cmd))))
1463 (ring-insert comint-input-ring cmd)))
1465 (defun comint-send-input (&optional no-newline artificial)
1466 "Send input to process.
1467 After the process output mark, sends all text from the process mark to
1468 point as input to the process. Before the process output mark, calls
1469 value of variable `comint-get-old-input' to retrieve old input, copies
1470 it to the process mark, and sends it.
1472 This command also sends and inserts a final newline, unless
1473 NO-NEWLINE is non-nil.
1475 Any history reference may be expanded depending on the value of the variable
1476 `comint-input-autoexpand'. The list of function names contained in the value
1477 of `comint-input-filter-functions' is called on the input before sending it.
1478 The input is entered into the input history ring, if the value of variable
1479 `comint-input-filter' returns non-nil when called on the input.
1481 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1482 end of line before sending the input.
1484 After the input has been sent, if `comint-process-echoes' is non-nil,
1485 then `comint-send-input' waits to see if the process outputs a string
1486 matching the input, and if so, deletes that part of the output.
1487 If ARTIFICIAL is non-nil, it inhibits such deletion.
1488 Callers sending input not from the user should use ARTIFICIAL = t.
1490 The values of `comint-get-old-input', `comint-input-filter-functions', and
1491 `comint-input-filter' are chosen according to the command interpreter running
1492 in the buffer. E.g.,
1494 If the interpreter is the csh,
1495 `comint-get-old-input' is the default:
1496 If `comint-use-prompt-regexp' is nil, then
1497 either return the current input field, if point is on an input
1498 field, or the current line, if point is on an output field.
1499 If `comint-use-prompt-regexp' is non-nil, then
1500 return the current line with any initial string matching the
1501 regexp `comint-prompt-regexp' removed.
1504 `comint-input-filter' is the default: returns t if the input isn't all white
1505 space.
1507 If the Comint is Lucid Common Lisp,
1508 `comint-get-old-input' snarfs the sexp ending at point.
1509 `comint-input-filter-functions' does nothing.
1510 `comint-input-filter' returns nil if the input matches input-filter-regexp,
1511 which matches (1) all whitespace (2) :a, :c, etc.
1513 Similarly for Soar, Scheme, etc."
1514 (interactive)
1515 ;; Note that the input string does not include its terminal newline.
1516 (let ((proc (get-buffer-process (current-buffer))))
1517 (if (not proc) (error "Current buffer has no process")
1518 (widen)
1519 (let* ((pmark (process-mark proc))
1520 (intxt (if (>= (point) (marker-position pmark))
1521 (progn (if comint-eol-on-send (end-of-line))
1522 (buffer-substring pmark (point)))
1523 (let ((copy (funcall comint-get-old-input)))
1524 (goto-char pmark)
1525 (insert copy)
1526 copy)))
1527 (input (if (not (eq comint-input-autoexpand 'input))
1528 ;; Just whatever's already there
1529 intxt
1530 ;; Expand and leave it visible in buffer
1531 (comint-replace-by-expanded-history t pmark)
1532 (buffer-substring pmark (point))))
1533 (history (if (not (eq comint-input-autoexpand 'history))
1534 input
1535 ;; This is messy 'cos ultimately the original
1536 ;; functions used do insertion, rather than return
1537 ;; strings. We have to expand, then insert back.
1538 (comint-replace-by-expanded-history t pmark)
1539 (let ((copy (buffer-substring pmark (point)))
1540 (start (point)))
1541 (insert input)
1542 (delete-region pmark start)
1543 copy))))
1545 (unless no-newline
1548 (comint-add-to-input-history history)
1550 (run-hook-with-args 'comint-input-filter-functions
1551 (if no-newline input
1554 (let ((beg (marker-position pmark))
1555 (end (if no-newline (point) (1- (point))))
1556 (inhibit-modification-hooks t))
1557 (when (> end beg)
1558 (add-text-properties beg end
1559 '(front-sticky t
1560 font-lock-face comint-highlight-input))
1561 (unless comint-use-prompt-regexp
1562 ;; Give old user input a field property of `input', to
1563 ;; distinguish it from both process output and unsent
1564 ;; input. The terminating newline is put into a special
1565 ;; `boundary' field to make cursor movement between input
1566 ;; and output fields smoother.
1567 (add-text-properties
1568 beg end
1569 '(mouse-face highlight
1570 help-echo "mouse-2: insert after prompt as new input"
1571 field input))))
1572 (unless (or no-newline comint-use-prompt-regexp)
1573 ;; Cover the terminating newline
1574 (add-text-properties end (1+ end)
1575 '(rear-nonsticky t
1576 field boundary
1577 inhibit-line-move-field-capture t))))
1579 (comint-snapshot-last-prompt)
1581 (setq comint-save-input-ring-index comint-input-ring-index)
1582 (setq comint-input-ring-index nil)
1583 ;; Update the markers before we send the input
1584 ;; in case we get output amidst sending the input.
1585 (set-marker comint-last-input-start pmark)
1586 (set-marker comint-last-input-end (point))
1587 (set-marker (process-mark proc) (point))
1588 ;; clear the "accumulation" marker
1589 (set-marker comint-accum-marker nil)
1590 (let ((comint-input-sender-no-newline no-newline))
1591 (funcall comint-input-sender proc input))
1593 ;; Optionally delete echoed input (after checking it).
1594 (when (and comint-process-echoes (not artificial))
1595 (let ((echo-len (- comint-last-input-end
1596 comint-last-input-start)))
1597 ;; Wait for all input to be echoed:
1598 (while (and (accept-process-output proc)
1599 (> (+ comint-last-input-end echo-len)
1600 (point-max))
1601 (zerop
1602 (compare-buffer-substrings
1603 nil comint-last-input-start
1604 (- (point-max) echo-len)
1605 ;; Above difference is equivalent to
1606 ;; (+ comint-last-input-start
1607 ;; (- (point-max) comint-last-input-end))
1608 nil comint-last-input-end (point-max)))))
1609 (if (and
1610 (<= (+ comint-last-input-end echo-len)
1611 (point-max))
1612 (zerop
1613 (compare-buffer-substrings
1614 nil comint-last-input-start comint-last-input-end
1615 nil comint-last-input-end
1616 (+ comint-last-input-end echo-len))))
1617 ;; Certain parts of the text to be deleted may have
1618 ;; been mistaken for prompts. We have to prevent
1619 ;; problems when `comint-prompt-read-only' is non-nil.
1620 (let ((inhibit-read-only t))
1621 (delete-region comint-last-input-end
1622 (+ comint-last-input-end echo-len))
1623 (when comint-prompt-read-only
1624 (save-excursion
1625 (goto-char comint-last-input-end)
1626 (comint-update-fence)))))))
1628 ;; This used to call comint-output-filter-functions,
1629 ;; but that scrolled the buffer in undesirable ways.
1630 (run-hook-with-args 'comint-output-filter-functions "")))))
1632 (defvar comint-preoutput-filter-functions nil
1633 "List of functions to call before inserting Comint output into the buffer.
1634 Each function gets one argument, a string containing the text received
1635 from the subprocess. It should return the string to insert, perhaps
1636 the same string that was received, or perhaps a modified or transformed
1637 string.
1639 The functions on the list are called sequentially, and each one is
1640 given the string returned by the previous one. The string returned by
1641 the last function is the text that is actually inserted in the
1642 redirection buffer.
1644 You can use `add-hook' to add functions to this list
1645 either globally or locally.")
1647 (defvar comint-inhibit-carriage-motion nil
1648 "If nil, Comint will interpret `carriage control' characters in output.
1649 See `comint-carriage-motion' for details.")
1651 ;; When non-nil, this is an overlay over the last recognized prompt in
1652 ;; the buffer; it is used when highlighting the prompt.
1653 (defvar comint-last-prompt-overlay nil)
1655 (defun comint-snapshot-last-prompt ()
1656 "`snapshot' any current `comint-last-prompt-overlay'.
1657 Freeze its attributes in place, even when more input comes along
1658 and moves the prompt overlay."
1659 (when comint-last-prompt-overlay
1660 (let ((inhibit-read-only t)
1661 (inhibit-modification-hooks t))
1662 (add-text-properties (overlay-start comint-last-prompt-overlay)
1663 (overlay-end comint-last-prompt-overlay)
1664 (overlay-properties comint-last-prompt-overlay)))))
1666 (defun comint-carriage-motion (start end)
1667 "Interpret carriage control characters in the region from START to END.
1668 Translate carriage return/linefeed sequences to linefeeds.
1669 Make single carriage returns delete to the beginning of the line.
1670 Make backspaces delete the previous character."
1671 (save-excursion
1673 ;; calling save-match-data and save-restriction. But, such a
1674 ;; check is not necessary now because we don't use regexp search
1675 ;; nor save-restriction. Note that the buffer is already widen,
1676 ;; and calling narrow-to-region and widen are not that heavy.
1677 (goto-char start)
1678 (let* ((inhibit-field-text-motion t)
1679 (inhibit-read-only t)
1680 (lbeg (line-beginning-position))
1681 delete-end ch)
1682 ;; If the preceding text is marked as "must-overwrite", record
1683 ;; it in delete-end.
1684 (when (and (> start (point-min))
1685 (get-text-property (1- start) 'comint-must-overwrite))
1686 (setq delete-end (point-marker))
1687 (remove-text-properties lbeg start '(comint-must-overwrite nil)))
1688 (narrow-to-region lbeg end)
1689 ;; Handle BS, LF, and CR specially.
1691 (setq ch (following-char))
1693 (delete-char 1)
1694 (if (> (point) lbeg)
1695 (delete-char -1)))
1697 (when delete-end ; CH = LF
1698 (if (< delete-end (point))
1699 (delete-region lbeg delete-end))
1700 (set-marker delete-end nil)
1701 (setq delete-end nil))
1702 (forward-char 1)
1703 (setq lbeg (point)))
1704 (t ; CH = CR
1705 (delete-char 1)
1706 (if delete-end
1707 (when (< delete-end (point))
1708 (delete-region lbeg delete-end)
1709 (move-marker delete-end (point)))
1710 (setq delete-end (point-marker))))))
1711 (when delete-end
1712 (if (< delete-end (point))
1713 ;; As there's a text after the last CR, make the current
1714 ;; line contain only that text.
1715 (delete-region lbeg delete-end)
1716 ;; Remember that the process output ends by CR, and thus we
1717 ;; must overwrite the contents of the current line next
1718 ;; time.
1719 (put-text-property lbeg delete-end 'comint-must-overwrite t))
1720 (set-marker delete-end nil))
1721 (widen))))
1723 ;; The purpose of using this filter for comint processes
1724 ;; is to keep comint-last-input-end from moving forward
1725 ;; when output is inserted.
1726 (defun comint-output-filter (process string)
1727 (let ((oprocbuf (process-buffer process)))
1728 ;; First check for killed buffer or no input.
1729 (when (and string oprocbuf (buffer-name oprocbuf))
1730 (with-current-buffer oprocbuf
1731 ;; Run preoutput filters
1732 (let ((functions comint-preoutput-filter-functions))
1733 (while (and functions string)
1734 (if (eq (car functions) t)
1735 (let ((functions (default-value 'comint-preoutput-filter-functions)))
1736 (while (and functions string)
1737 (setq string (funcall (car functions) string))
1738 (setq functions (cdr functions))))
1739 (setq string (funcall (car functions) string)))
1740 (setq functions (cdr functions))))
1742 ;; Insert STRING
1743 (let ((inhibit-read-only t)
1744 ;; The point should float after any insertion we do.
1745 (saved-point (copy-marker (point) t)))
1747 ;; We temporarly remove any buffer narrowing, in case the
1748 ;; process mark is outside of the restriction
1749 (save-restriction
1750 (widen)
1752 (goto-char (process-mark process))
1753 (set-marker comint-last-output-start (point))
1755 ;; insert-before-markers is a bad thing. XXX
1756 ;; Luckily we don't have to use it any more, we use
1757 ;; window-point-insertion-type instead.
1758 (insert string)
1760 ;; Advance process-mark
1761 (set-marker (process-mark process) (point))
1763 (unless comint-inhibit-carriage-motion
1764 ;; Interpret any carriage motion characters (newline, backspace)
1765 (comint-carriage-motion comint-last-output-start (point)))
1767 ;; Run these hooks with point where the user had it.
1768 (goto-char saved-point)
1769 (run-hook-with-args 'comint-output-filter-functions string)
1770 (set-marker saved-point (point))
1772 (goto-char (process-mark process)) ; in case a filter moved it
1774 (unless comint-use-prompt-regexp
1775 (let ((inhibit-read-only t)
1776 (inhibit-modification-hooks t))
1777 (add-text-properties comint-last-output-start (point)
1778 '(front-sticky
1779 (field inhibit-line-move-field-capture)
1780 rear-nonsticky t
1781 field output
1782 inhibit-line-move-field-capture t))))
1784 ;; Highlight the prompt, where we define `prompt' to mean
1785 ;; the most recent output that doesn't end with a newline.
1786 (let ((prompt-start (save-excursion (forward-line 0) (point)))
1787 (inhibit-read-only t)
1788 (inhibit-modification-hooks t))
1789 (when comint-prompt-read-only
1790 (or (= (point-min) prompt-start)
1791 (get-text-property (1- prompt-start) 'read-only)
1792 (put-text-property
1793 (1- prompt-start) prompt-start 'read-only 'fence))
1794 (add-text-properties
1795 prompt-start (point)
1796 '(read-only t rear-nonsticky t front-sticky (read-only))))
1797 (unless (and (bolp) (null comint-last-prompt-overlay))
1798 ;; Need to create or move the prompt overlay (in the case
1799 ;; where there is no prompt ((bolp) == t), we still do
1800 ;; this if there's already an existing overlay).
1801 (if comint-last-prompt-overlay
1802 ;; Just move an existing overlay
1803 (move-overlay comint-last-prompt-overlay
1804 prompt-start (point))
1805 ;; Need to create the overlay
1806 (setq comint-last-prompt-overlay
1807 (make-overlay prompt-start (point)))
1808 (overlay-put comint-last-prompt-overlay
1809 'font-lock-face 'comint-highlight-prompt))))
1811 (goto-char saved-point)))))))
1813 (defun comint-preinput-scroll-to-bottom ()
1814 "Go to the end of buffer in all windows showing it.
1815 Movement occurs if point in the selected window is not after the process mark,
1816 and `this-command' is an insertion command. Insertion commands recognized
1817 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1818 Depends on the value of `comint-scroll-to-bottom-on-input'.
1820 This function should be a pre-command hook."
1821 (if (and comint-scroll-to-bottom-on-input
1822 (memq this-command '(self-insert-command comint-magic-space yank
1823 hilit-yank)))
1824 (let* ((selected (selected-window))
1825 (current (current-buffer))
1826 (process (get-buffer-process current))
1827 (scroll comint-scroll-to-bottom-on-input))
1828 (if (and process (< (point) (process-mark process)))
1829 (if (eq scroll 'this)
1830 (goto-char (point-max))
1831 (walk-windows
1832 (lambda (window)
1833 (if (and (eq (window-buffer window) current)
1834 (or (eq scroll t) (eq scroll 'all)))
1835 (progn
1836 (select-window window)
1837 (goto-char (point-max))
1838 (select-window selected))))
1839 nil t))))))
1841 (defun comint-postoutput-scroll-to-bottom (string)
1842 "Go to the end of buffer in some or all windows showing it.
1843 Does not scroll if the current line is the last line in the buffer.
1844 Depends on the value of `comint-move-point-for-output' and
1845 `comint-scroll-show-maximum-output'.
1847 This function should be in the list `comint-output-filter-functions'."
1848 (let* ((selected (selected-window))
1849 (current (current-buffer))
1850 (process (get-buffer-process current))
1851 (scroll comint-move-point-for-output))
1852 (unwind-protect
1853 (if process
1854 (walk-windows
1855 (lambda (window)
1856 (when (eq (window-buffer window) current)
1857 (select-window window)
1858 (if (and (< (point) (process-mark process))
1859 (or (eq scroll t) (eq scroll 'all)
1860 ;; Maybe user wants point to jump to end.
1861 (and (eq scroll 'this) (eq selected window))
1862 (and (eq scroll 'others) (not (eq selected window)))
1863 ;; If point was at the end, keep it at end.
1864 (and (marker-position comint-last-output-start)
1865 (>= (point) comint-last-output-start))))
1866 (goto-char (process-mark process)))
1867 ;; Optionally scroll so that the text
1868 ;; ends at the bottom of the window.
1869 (if (and comint-scroll-show-maximum-output
1870 (= (point) (point-max)))
1871 (save-excursion
1872 (goto-char (point-max))
1873 (recenter (- -1 scroll-margin))))
1874 (select-window selected)))
1875 nil t))
1876 (set-buffer current))))
1878 (defun comint-truncate-buffer (&optional string)
1879 "Truncate the buffer to `comint-buffer-maximum-size'.
1880 This function could be on `comint-output-filter-functions' or bound to a key."
1881 (interactive)
1882 (save-excursion
1883 (goto-char (process-mark (get-buffer-process (current-buffer))))
1884 (forward-line (- comint-buffer-maximum-size))
1885 (beginning-of-line)
1886 (let ((inhibit-read-only t))
1887 (delete-region (point-min) (point)))))
1889 (defun comint-strip-ctrl-m (&optional string)
1890 "Strip trailing `^M' characters from the current output group.
1891 This function could be on `comint-output-filter-functions' or bound to a key."
1892 (interactive)
1893 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1894 (save-excursion
1895 (condition-case nil
1896 (goto-char
1897 (if (interactive-p) comint-last-input-end comint-last-output-start))
1898 (error nil))
1900 (replace-match "" t t)))))
1901 (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
1903 (defun comint-show-maximum-output ()
1904 "Put the end of the buffer at the bottom of the window."
1905 (interactive)
1906 (goto-char (point-max))
1907 (recenter (- -1 scroll-margin)))
1909 (defun comint-get-old-input-default ()
1910 "Default for `comint-get-old-input'.
1911 If `comint-use-prompt-regexp' is nil, then either
1912 return the current input field, if point is on an input field, or the
1913 current line, if point is on an output field.
1914 If `comint-use-prompt-regexp' is non-nil, then return
1915 the current line with any initial string matching the regexp
1916 `comint-prompt-regexp' removed."
1917 (let ((bof (field-beginning)))
1918 (if (eq (get-char-property bof 'field) 'input)
1919 (field-string-no-properties bof)
1920 (comint-bol)
1921 (buffer-substring-no-properties (point) (line-end-position)))))
1923 (defun comint-copy-old-input ()
1924 "Insert after prompt old input at point as new input to be edited.
1925 Calls `comint-get-old-input' to get old input."
1926 (interactive)
1927 (let ((input (funcall comint-get-old-input))
1928 (process (get-buffer-process (current-buffer))))
1929 (if (not process)
1930 (error "Current buffer has no process")
1931 (goto-char (process-mark process))
1932 (insert input))))
1934 (defun comint-skip-prompt ()
1935 "Skip past the text matching regexp `comint-prompt-regexp'.
1936 If this takes us past the end of the current line, don't skip at all."
1937 (if (and (looking-at comint-prompt-regexp)
1938 (<= (match-end 0) (line-end-position)))
1939 (goto-char (match-end 0))))
1941 (defun comint-after-pmark-p ()
1942 "Return t if point is after the process output marker."
1943 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1944 (<= (marker-position pmark) (point))))
1946 (defun comint-simple-send (proc string)
1947 "Default function for sending to PROC input STRING.
1948 This just sends STRING plus a newline. To override this,
1949 set the hook `comint-input-sender'."
1950 (let ((send-string
1951 (if comint-input-sender-no-newline
1952 string
1953 ;; Sending as two separate strings does not work
1956 (comint-send-string proc send-string))
1957 (if (and comint-input-sender-no-newline
1958 (not (string-equal string "")))
1959 (process-send-eof)))
1961 (defun comint-line-beginning-position ()
1962 "Return the buffer position of the beginning of the line, after any prompt.
1963 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done by
1964 skipping text matching the regular expression `comint-prompt-regexp',
1965 a buffer local variable."
1966 (if comint-use-prompt-regexp
1967 ;; Use comint-prompt-regexp
1968 (save-excursion
1969 (beginning-of-line)
1970 (comint-skip-prompt)
1971 (point))
1972 ;; Use input fields. Note that, unlike the behavior of
1973 ;; `line-beginning-position' inside a field, this function will
1974 ;; return the position of the end of a prompt, even if the point is
1975 ;; already inside the prompt. In order to do this, it assumes that
1976 ;; if there are two fields on a line, then the first one is the
1977 ;; prompt, and the second one is an input field, and is front-sticky
1978 ;; (as input fields should be).
1979 (constrain-to-field (line-beginning-position) (line-end-position))))
1981 (defun comint-bol (&optional arg)
1982 "Go to the beginning of line, then skip past the prompt, if any.
1984 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done
1985 by skipping text matching the regular expression `comint-prompt-regexp',
1986 a buffer local variable."
1987 (interactive "P")
1988 (if arg
1989 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1990 (forward-line 0)
1991 (goto-char (comint-line-beginning-position))))
1993 ;; For compatibility.
1994 (defun comint-read-noecho (prompt &optional ignore)
1995 (read-passwd prompt))
1997 ;; These three functions are for entering text you don't want echoed or
1998 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1999 ;; Just enter m-x send-invisible and type in your line.
2001 (defun send-invisible (&optional prompt)
2002 "Read a string without echoing.
2003 Then send it to the process running in the current buffer.
2004 The string is sent using `comint-input-sender'.
2005 Security bug: your string can still be temporarily recovered with
2007 (interactive "P") ; Defeat snooping via C-x ESC ESC
2008 (let ((proc (get-buffer-process (current-buffer)))
2009 (prefix
2010 (if (eq (window-buffer (selected-window)) (current-buffer))
2011 ""
2012 (format "(In buffer %s) "
2013 (current-buffer)))))
2014 (if proc
2015 (let ((str (read-passwd (concat prefix
2016 (or prompt "Non-echoed text: ")))))
2017 (if (stringp str)
2018 (progn
2019 (comint-snapshot-last-prompt)
2020 (funcall comint-input-sender proc str))
2021 (message "Warning: text will be echoed")))
2022 (error "Buffer %s has no process" (current-buffer)))))
2024 (defun comint-watch-for-password-prompt (string)
2025 "Prompt in the minibuffer for password and send without echoing.
2026 This function uses `send-invisible' to read and send a password to the buffer's
2027 process if STRING contains a password prompt defined by
2028 `comint-password-prompt-regexp'.
2030 This function could be in the list `comint-output-filter-functions'."
2031 (when (string-match comint-password-prompt-regexp string)
2033 (setq string (replace-match "" t t string)))
2034 (send-invisible string)))
2035 \f
2036 ;; Low-level process communication
2038 (defun comint-send-string (process string)
2039 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
2040 (if process
2041 (with-current-buffer (if (processp process)
2042 (process-buffer process)
2043 (get-buffer process))
2044 (comint-snapshot-last-prompt))
2045 (comint-snapshot-last-prompt))
2046 (process-send-string process string))
2048 (defun comint-send-region (process start end)
2049 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
2050 (if process
2051 (with-current-buffer (if (processp process)
2052 (process-buffer process)
2053 (get-buffer process))
2054 (comint-snapshot-last-prompt))
2055 (comint-snapshot-last-prompt))
2056 (process-send-region process start end))
2058 \f
2059 ;; Random input hackage
2061 (defun comint-delete-output ()
2062 "Delete all output from interpreter since last input.
2063 Does not delete the prompt."
2064 (interactive)
2065 (let ((proc (get-buffer-process (current-buffer)))
2066 (replacement nil)
2067 (inhibit-read-only t))
2068 (save-excursion
2069 (let ((pmark (progn (goto-char (process-mark proc))
2070 (forward-line 0)
2071 (point-marker))))
2072 (delete-region comint-last-input-end pmark)
2073 (goto-char (process-mark proc))
2075 (buffer-substring pmark (point))))
2076 (delete-region pmark (point))))
2077 ;; Output message and put back prompt
2078 (comint-output-filter proc replacement)))
2079 (define-obsolete-function-alias 'comint-kill-output
2080 'comint-delete-output "21.1")
2082 (defun comint-write-output (filename &optional append mustbenew)
2083 "Write output from interpreter since last input to FILENAME.
2084 Any prompt at the end of the output is not written.
2086 If the optional argument APPEND (the prefix argument when interactive)
2087 is non-nil, the output is appended to the file instead.
2089 If the optional argument MUSTBENEW is non-nil, check for an existing
2090 file with the same name. If MUSTBENEW is `excl', that means to get an
2091 error if the file already exists; never overwrite. If MUSTBENEW is
2092 neither nil nor `excl', that means ask for confirmation before
2093 overwriting, but do go ahead and overwrite the file if the user
2094 confirms. When interactive, MUSTBENEW is nil when appending, and t
2095 otherwise."
2096 (interactive
2097 (list (read-file-name
2098 (if current-prefix-arg
2099 "Append output to file: "
2100 "Write output to file: "))
2101 current-prefix-arg
2102 (not current-prefix-arg)))
2103 (save-excursion
2104 (goto-char (process-mark (get-buffer-process (current-buffer))))
2105 (forward-line 0)
2106 (write-region comint-last-input-end (point) filename
2107 append nil nil mustbenew)))
2109 ;; This function exists for the benefit of the menu; from the keyboard,
2110 ;; users can just use `comint-write-output' with a prefix arg.
2111 (defun comint-append-output-to-file (filename)
2112 "Append output from interpreter since last input to FILENAME.
2113 Any prompt at the end of the output is not written."
2114 (interactive "fAppend output to file: ")
2115 (comint-write-output filename t))
2117 (defun comint-show-output ()
2118 "Display start of this batch of interpreter output at top of window.
2119 Sets mark to the value of point when this command is run."
2120 (interactive)
2121 (push-mark)
2122 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
2123 (cond (comint-use-prompt-regexp
2124 (goto-char pos)
2125 (beginning-of-line 0)
2126 (set-window-start (selected-window) (point))
2127 (comint-skip-prompt))
2128 (t
2129 (goto-char (field-beginning pos))
2130 (set-window-start (selected-window) (point))))))
2133 (defun comint-interrupt-subjob ()
2134 "Interrupt the current subjob.
2135 This command also kills the pending input
2136 between the process mark and point."
2137 (interactive)
2138 (comint-skip-input)
2139 (interrupt-process nil comint-ptyp)
2141 )
2143 (defun comint-kill-subjob ()
2144 "Send kill signal to the current subjob.
2145 This command also kills the pending input
2146 between the process mark and point."
2147 (interactive)
2148 (comint-skip-input)
2149 (kill-process nil comint-ptyp))
2151 (defun comint-quit-subjob ()
2152 "Send quit signal to the current subjob.
2153 This command also kills the pending input
2154 between the process mark and point."
2155 (interactive)
2156 (comint-skip-input)
2157 (quit-process nil comint-ptyp))
2159 (defun comint-stop-subjob ()
2160 "Stop the current subjob.
2161 This command also kills the pending input
2162 between the process mark and point.
2164 WARNING: if there is no current subjob, you can end up suspending
2165 the top-level process running in the buffer. If you accidentally do
2167 is not a problem with most shells, since they ignore this signal.)"
2168 (interactive)
2169 (comint-skip-input)
2170 (stop-process nil comint-ptyp))
2172 (defun comint-continue-subjob ()
2173 "Send CONT signal to process buffer's process group.
2174 Useful if you accidentally suspend the top-level process."
2175 (interactive)
2176 (continue-process nil comint-ptyp))
2178 (defun comint-skip-input ()
2179 "Skip all pending input, from last stuff output by interpreter to point.
2180 This means mark it as if it had been sent as input, without sending it."
2181 (let ((comint-input-sender 'ignore)
2182 (comint-input-filter-functions nil))
2183 (comint-send-input t t))
2184 (end-of-line)
2185 (let ((pos (point))
2186 (marker (process-mark (get-buffer-process (current-buffer)))))
2187 (insert " " (key-description (this-command-keys)))
2188 (if (= marker pos)
2189 (set-marker marker (point)))))
2191 (defun comint-kill-input ()
2192 "Kill all text from last stuff output by interpreter to point."
2193 (interactive)
2194 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2195 (if (> (point) (marker-position pmark))
2196 (kill-region pmark (point)))))
2198 (defun comint-delchar-or-maybe-eof (arg)
2199 "Delete ARG characters forward or send an EOF to subprocess.
2200 Sends an EOF only if point is at the end of the buffer and there is no input."
2201 (interactive "p")
2202 (let ((proc (get-buffer-process (current-buffer))))
2203 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
2204 (comint-send-eof)
2205 (delete-char arg))))
2207 (defun comint-send-eof ()
2208 "Send an EOF to the current buffer's process."
2209 (interactive)
2210 (comint-send-input t t)
2211 (process-send-eof))
2214 (defun comint-backward-matching-input (regexp n)
2215 "Search backward through buffer for input fields that match REGEXP.
2216 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2217 by lines that match `comint-prompt-regexp'.
2219 With prefix argument N, search for Nth previous match.
2220 If N is negative, find the next or Nth next match."
2221 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2222 (if comint-use-prompt-regexp
2223 ;; Use comint-prompt-regexp
2224 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2225 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2226 (if (re-search-backward re nil t n)
2227 (point)))))
2228 (if (null pos)
2229 (progn (message "Not found")
2230 (ding))
2231 (goto-char pos)
2232 (comint-bol nil)))
2233 ;; Use input fields
2234 (let* ((dir (if (< n 0) -1 1))
2235 (pos
2236 (save-excursion
2237 (while (/= n 0)
2238 (unless (re-search-backward regexp nil t dir)
2239 (error "Not found"))
2240 (when (eq (get-char-property (point) 'field) 'input)
2241 (setq n (- n dir))))
2242 (field-beginning))))
2243 (goto-char pos))))
2246 (defun comint-forward-matching-input (regexp n)
2247 "Search forward through buffer for input fields that match REGEXP.
2248 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2249 by lines that match `comint-prompt-regexp'.
2251 With prefix argument N, search for Nth following match.
2252 If N is negative, find the previous or Nth previous match."
2253 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2254 (comint-backward-matching-input regexp (- n)))
2257 (defun comint-next-prompt (n)
2258 "Move to end of Nth next prompt in the buffer.
2259 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2260 the Nth next `input' field, otherwise, it means the Nth occurrence of
2261 text matching `comint-prompt-regexp'."
2262 (interactive "p")
2263 (if comint-use-prompt-regexp
2264 ;; Use comint-prompt-regexp
2265 (let ((paragraph-start comint-prompt-regexp))
2266 (end-of-line (if (> n 0) 1 0))
2267 (forward-paragraph n)
2268 (comint-skip-prompt))
2269 ;; Use input fields
2270 (let ((pos (point))
2271 (input-pos nil)
2272 prev-pos)
2273 (while (/= n 0)
2274 (setq prev-pos pos)
2275 (setq pos
2276 (if (> n 0)
2277 (next-single-char-property-change pos 'field)
2278 (previous-single-char-property-change pos 'field)))
2279 (cond ((or (null pos) (= pos prev-pos))
2280 ;; Ran off the end of the buffer.
2281 (when (> n 0)
2282 ;; There's always an input field at the end of the
2283 ;; buffer, but it has a `field' property of nil.
2284 (setq input-pos (point-max)))
2285 ;; stop iterating
2286 (setq n 0))
2287 ((eq (get-char-property pos 'field) 'input)
2288 (setq n (if (< n 0) (1+ n) (1- n)))
2289 (setq input-pos pos))))
2290 (when input-pos
2291 (goto-char input-pos)))))
2294 (defun comint-previous-prompt (n)
2295 "Move to end of Nth previous prompt in the buffer.
2296 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2297 the Nth previous `input' field, otherwise, it means the Nth occurrence of
2298 text matching `comint-prompt-regexp'."
2299 (interactive "p")
2300 (comint-next-prompt (- n)))
2302 ;; State used by `comint-insert-previous-argument' when cycling.
2303 (defvar comint-insert-previous-argument-last-start-pos nil)
2304 (make-variable-buffer-local 'comint-insert-previous-argument-last-start-pos)
2305 (defvar comint-insert-previous-argument-last-index nil)
2306 (make-variable-buffer-local 'comint-insert-previous-argument-last-index)
2308 ;; Needs fixing:
2309 ;; make comint-arguments understand negative indices as bash does
2310 (defun comint-insert-previous-argument (index)
2311 "Insert the INDEXth argument from the previous Comint command-line at point.
2312 Spaces are added at beginning and/or end of the inserted string if
2313 necessary to ensure that it's separated from adjacent arguments.
2314 Interactively, if no prefix argument is given, the last argument is inserted.
2315 Repeated interactive invocations will cycle through the same argument
2316 from progressively earlier commands (using the value of INDEX specified
2317 with the first command).
2318 This command is like `M-.' in bash."
2319 (interactive "P")
2320 (unless (null index)
2321 (setq index (prefix-numeric-value index)))
2322 (cond ((eq last-command this-command)
2323 ;; Delete last input inserted by this command.
2324 (delete-region comint-insert-previous-argument-last-start-pos (point))
2325 (setq index comint-insert-previous-argument-last-index))
2326 (t
2327 ;; This is a non-repeat invocation, so initialize state.
2328 (setq comint-input-ring-index nil)
2329 (setq comint-insert-previous-argument-last-index index)
2330 (when (null comint-insert-previous-argument-last-start-pos)
2331 ;; First usage; initialize to a marker
2332 (setq comint-insert-previous-argument-last-start-pos
2333 (make-marker)))))
2334 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2335 (if (<= (point) (comint-line-beginning-position))
2336 (comint-bol)
2337 (just-one-space))
2338 ;; Remember the beginning of what we insert, so we can delete it if
2339 ;; the command is repeated.
2340 (set-marker comint-insert-previous-argument-last-start-pos (point))
2341 ;; Insert the argument.
2342 (let ((input-string (comint-previous-input-string 0)))
2344 ;; strip terminating '&'
2345 (setq input-string (substring input-string 0 (match-beginning 0))))
2346 (insert (comint-arguments input-string index index)))
2347 ;; Make next invocation return arg from previous input
2348 (setq comint-input-ring-index (1+ (or comint-input-ring-index 0)))
2349 ;; Add a terminating space if necessary.
2350 (unless (eolp)
2351 (just-one-space)))
2353 \f
2354 ;; Support editing with `comint-prompt-read-only' set to t.
2356 (defun comint-update-fence ()
2357 "Update read-only status of newline before point.
2358 The `fence' read-only property is used to indicate that a newline
2360 following front-sticky read-only region. This is used to
2361 implement comint read-only prompts. If the text after a newline
2362 changes, the read-only status of that newline may need updating.
2363 That is what this function does.
2365 This function does nothing if point is not at the beginning of a
2366 line, or is at the beginning of the accessible portion of the buffer.
2367 Otherwise, if the character after point has a front-sticky
2368 read-only property, then the preceding newline is given a
2369 read-only property of `fence', unless it already is read-only.
2370 If the character after point does not have a front-sticky
2371 read-only property, any read-only property of `fence' on the
2372 preceding newline is removed."
2373 (let* ((pt (point)) (lst (get-text-property pt 'front-sticky))
2374 (inhibit-modification-hooks t))
2375 (and (bolp)
2376 (not (bobp))
2377 (if (and (get-text-property pt 'read-only)
2378 (if (listp lst) (memq 'read-only lst) t))
2379 (unless (get-text-property (1- pt) 'read-only)
2380 (put-text-property (1- pt) pt 'read-only 'fence))
2381 (when (eq (get-text-property (1- pt) 'read-only) 'fence)
2382 (remove-list-of-text-properties (1- pt) pt '(read-only)))))))
2384 (defun comint-kill-whole-line (&optional count)
2385 "Kill current line, ignoring read-only and field properties.
2386 With prefix arg COUNT, kill that many lines starting from the current line.
2387 If COUNT is negative, kill backward. Also kill the preceding newline,
2389 with negative arguments.)
2390 If COUNT is zero, kill current line but exclude the trailing newline.
2391 The read-only status of newlines is updated with `comint-update-fence',
2392 if necessary."
2393 (interactive "p")
2394 (let ((inhibit-read-only t) (inhibit-field-text-motion t))
2395 (kill-whole-line count)
2396 (when (>= count 0) (comint-update-fence))))
2398 (defun comint-kill-region (beg end &optional yank-handler)
2399 "Like `kill-region', but ignores read-only properties, if safe.
2400 This command assumes that the buffer contains read-only
2402 properties at the beginning of a line, with the preceding newline
2403 being read-only to protect the prompt. This is true of the
2404 comint prompts if `comint-prompt-read-only' is non-nil. This
2405 command will not delete the region if this would create mutilated
2406 or out of place prompts. That is, if any part of a prompt is
2407 deleted, the entire prompt must be deleted and all remaining
2408 prompts should stay at the beginning of a line. If this is not
2409 the case, this command just calls `kill-region' with all
2410 read-only properties intact. The read-only status of newlines is
2411 updated using `comint-update-fence', if necessary."
2412 (interactive "r")
2413 (save-excursion
2414 (let* ((true-beg (min beg end))
2415 (true-end (max beg end))
2416 (beg-bolp (progn (goto-char true-beg) (bolp)))
2417 (beg-lst (get-text-property true-beg 'front-sticky))
2418 (beg-bad (and (get-text-property true-beg 'read-only)
2419 (if (listp beg-lst) (memq 'read-only beg-lst) t)))
2420 (end-bolp (progn (goto-char true-end) (bolp)))
2421 (end-lst (get-text-property true-end 'front-sticky))
2422 (end-bad (and (get-text-property true-end 'read-only)
2423 (if (listp end-lst) (memq 'read-only end-lst) t))))
2424 (if (or (and (not beg-bolp) (or beg-bad end-bad))
2425 (and (not end-bolp) end-bad))
2426 (kill-region beg end yank-handler)
2427 (let ((inhibit-read-only t))
2428 (kill-region beg end yank-handler)
2429 (comint-update-fence))))))
2431 \f
2432 ;; Support for source-file processing commands.
2433 ;;============================================================================
2434 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2435 ;; commands that process files of source text (e.g. loading or compiling
2436 ;; files). So the corresponding process-in-a-buffer modes have commands
2437 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2438 ;; for defining these commands.
2439 ;;
2440 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2441 ;; and Soar, in that they don't know anything about file extensions.
2442 ;; So the compile/load interface gets the wrong default occasionally.
2443 ;; The load-file/compile-file default mechanism could be smarter -- it
2444 ;; doesn't know about the relationship between filename extensions and
2445 ;; whether the file is source or executable. If you compile foo.lisp
2446 ;; with compile-file, then the next load-file should use foo.bin for
2447 ;; the default, not foo.lisp. This is tricky to do right, particularly
2448 ;; because the extension for executable files varies so much (.o, .bin,
2449 ;; .lbin, .mo, .vo, .ao, ...).
2452 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2453 ;; commands.
2454 ;;
2455 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2456 ;; want to save the buffer before issuing any process requests to the command
2457 ;; interpreter.
2458 ;;
2459 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2460 ;; for the file to process.
2462 (defun comint-source-default (previous-dir/file source-modes)
2463 "Compute the defaults for `load-file' and `compile-file' commands.
2465 PREVIOUS-DIR/FILE is a pair (DIRECTORY . FILENAME) from the last
2466 source-file processing command, or nil if there hasn't been one yet.
2467 SOURCE-MODES is a list used to determine what buffers contain source
2468 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2469 Typically, (lisp-mode) or (scheme-mode).
2471 If the command is given while the cursor is inside a string, *and*
2472 the string is an existing filename, *and* the filename is not a directory,
2473 then the string is taken as default. This allows you to just position
2474 your cursor over a string that's a filename and have it taken as default.
2476 If the command is given in a file buffer whose major mode is in
2477 SOURCE-MODES, then the filename is the default file, and the
2478 file's directory is the default directory.
2480 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2481 then the default directory & file are what was used in the last source-file
2482 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2483 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2486 SOURCE-MODES is typically going to be something like (tea-mode)
2487 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2488 for Soar programs, etc.
2490 The function returns a pair: (default-directory . default-file)."
2491 (cond ((and buffer-file-name (memq major-mode source-modes))
2492 (cons (file-name-directory buffer-file-name)
2493 (file-name-nondirectory buffer-file-name)))
2494 (previous-dir/file)
2495 (t
2496 (cons default-directory nil))))
2499 (defun comint-check-source (fname)
2500 "Check whether to save buffers visiting file FNAME.
2501 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2502 process-in-a-buffer modes), this function can be called on the filename.
2503 If the file is loaded into a buffer, and the buffer is modified, the user
2504 is queried to see if he wants to save the buffer before proceeding with
2505 the load or compile."
2506 (let ((buff (get-file-buffer fname)))
2507 (if (and buff
2508 (buffer-modified-p buff)
2509 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
2510 ;; save BUFF.
2511 (let ((old-buffer (current-buffer)))
2512 (set-buffer buff)
2513 (save-buffer)
2514 (set-buffer old-buffer)))))
2516 (defun comint-extract-string ()
2517 "Return string around point, or nil."
2518 (let ((syntax (syntax-ppss)))
2519 (when (nth 3 syntax)
2520 (condition-case ()
2521 (buffer-substring-no-properties (1+ (nth 8 syntax))
2522 (progn (goto-char (nth 8 syntax))
2523 (forward-sexp)
2524 (1- (point))))
2525 (error nil)))))
2527 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2528 "Prompt for filenames in commands that process source files,
2529 e.g. loading or compiling a file.
2530 Provides a default, if there is one, and returns the result filename.
2532 See `comint-source-default' for more on determining defaults.
2534 PROMPT is the prompt string. PREV-DIR/FILE is the (DIRECTORY . FILE) pair
2535 from the last source processing command. SOURCE-MODES is a list of major
2536 modes used to determine what file buffers contain source files. (These
2537 two arguments are used for determining defaults.) If MUSTMATCH-P is true,
2538 then the filename reader will only accept a file that exists.
2540 A typical use:
2542 '(lisp-mode) t))"
2543 (let* ((def (comint-source-default prev-dir/file source-modes))
2544 (stringfile (comint-extract-string))
2545 (sfile-p (and stringfile
2546 (condition-case ()
2547 (file-exists-p stringfile)
2548 (error nil))
2549 (not (file-directory-p stringfile))))
2550 (defdir (if sfile-p (file-name-directory stringfile)
2551 (car def)))
2552 (deffile (if sfile-p (file-name-nondirectory stringfile)
2553 (cdr def)))
2554 (ans (read-file-name (if deffile (format "%s(default %s) "
2555 prompt deffile)
2556 prompt)
2557 defdir
2558 (concat defdir deffile)
2559 mustmatch-p)))
2560 (list (expand-file-name (substitute-in-file-name ans)))))
2562 ;; I am somewhat divided on this string-default feature. It seems
2563 ;; to violate the principle-of-least-astonishment, in that it makes
2564 ;; the default harder to predict, so you actually have to look and see
2565 ;; what the default really is before choosing it. This can trip you up.
2566 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2567 ;; on this.
2568 ;; -Olin
2570 \f
2571 ;; Simple process query facility.
2572 ;; ===========================================================================
2573 ;; This function is for commands that want to send a query to the process
2574 ;; and show the response to the user. For example, a command to get the
2575 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2576 ;; to an inferior Common Lisp process.
2577 ;;
2578 ;; This simple facility just sends strings to the inferior process and pops
2579 ;; up a window for the process buffer so you can see what the process
2580 ;; responds with. We don't do anything fancy like try to intercept what the
2581 ;; process responds with and put it in a pop-up window or on the message
2582 ;; line. We just display the buffer. Low tech. Simple. Works good.
2584 (defun comint-proc-query (proc str)
2585 "Send to the inferior process PROC the string STR.
2586 Pop-up but do not select a window for the inferior process so that
2587 its response can be seen."
2588 (let* ((proc-buf (process-buffer proc))
2589 (proc-mark (process-mark proc)))
2590 (display-buffer proc-buf)
2591 (set-buffer proc-buf) ; but it's not the selected *window*
2592 (let ((proc-win (get-buffer-window proc-buf 0))
2593 (proc-pt (marker-position proc-mark)))
2594 (comint-send-string proc str) ; send the query
2595 (accept-process-output proc) ; wait for some output
2596 ;; Try to position the proc window so you can see the answer.
2597 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2598 ;; I don't know why. Wizards invited to improve it.
2599 (unless (pos-visible-in-window-p proc-pt proc-win)
2600 (let ((opoint (window-point proc-win)))
2601 (set-window-point proc-win proc-mark)
2602 (sit-for 0)
2603 (if (not (pos-visible-in-window-p opoint proc-win))
2604 (push-mark opoint)
2605 (set-window-point proc-win opoint)))))))
2607 \f
2608 ;; Filename/command/history completion in a buffer
2609 ;; ===========================================================================
2610 ;; Useful completion functions, courtesy of the Ergo group.
2612 ;; Six commands:
2613 ;; comint-dynamic-complete Complete or expand command, filename,
2614 ;; history at point.
2615 ;; comint-dynamic-complete-filename Complete filename at point.
2616 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2617 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2618 ;; replace with expanded/completed name.
2619 ;; comint-dynamic-simple-complete Complete stub given candidates.
2621 ;; These are not installed in the comint-mode keymap. But they are
2622 ;; available for people who want them. Shell-mode installs them:
2624 ;; (define-key shell-mode-map "\M-?"
2625 ;; 'comint-dynamic-list-filename-completions)))
2626 ;;
2627 ;; Commands like this are fine things to put in load hooks if you
2628 ;; want them present in specific modes.
2630 (defcustom comint-completion-autolist nil
2631 "If non-nil, automatically list possibilities on partial completion.
2632 This mirrors the optional behavior of tcsh."
2633 :type 'boolean
2634 :group 'comint-completion)
2636 (defcustom comint-completion-addsuffix t
2637 "If non-nil, add a `/' to completed directories, ` ' to file names.
2638 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2639 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2640 This mirrors the optional behavior of tcsh."
2641 :type '(choice (const :tag "None" nil)
2642 (const :tag "Add /" t)
2643 (cons :tag "Suffix pair"
2644 (string :tag "Directory suffix")
2645 (string :tag "File suffix")))
2646 :group 'comint-completion)
2648 (defcustom comint-completion-recexact nil
2649 "If non-nil, use shortest completion if characters cannot be added.
2650 This mirrors the optional behavior of tcsh.
2652 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2653 :type 'boolean
2654 :group 'comint-completion)
2656 (defcustom comint-completion-fignore nil
2657 "List of suffixes to be disregarded during file completion.
2658 This mirrors the optional behavior of bash and tcsh.
2660 Note that this applies to `comint-dynamic-complete-filename' only."
2661 :type '(repeat (string :tag "Suffix"))
2662 :group 'comint-completion)
2664 ;;;###autoload
2665 (defvar comint-file-name-prefix ""
2666 "Prefix prepended to absolute file names taken from process input.
2667 This is used by Comint's and shell's completion functions, and by shell's
2668 directory tracking functions.")
2670 (defvar comint-file-name-chars
2671 (if (memq system-type '(ms-dos windows-nt cygwin))
2672 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2673 "[]~/A-Za-z0-9+@:_.$#%,={}-")
2674 "String of characters valid in a file name.
2675 Note that all non-ASCII characters are considered valid in a file name
2676 regardless of what this variable says.
2678 This is a good thing to set in mode hooks.")
2680 (defvar comint-file-name-quote-list nil
2683 This is a good thing to set in mode hooks.")
2686 (defun comint-directory (directory)
2687 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
2688 (expand-file-name (if (file-name-absolute-p directory)
2689 (concat comint-file-name-prefix directory)
2690 directory)))
2693 (defun comint-word (word-chars)
2694 "Return the word of WORD-CHARS at point, or nil if none is found.
2695 Word constituents are considered to be those in WORD-CHARS, which is like the
2697 (save-excursion
2698 (let ((here (point))
2699 giveup)
2700 (while (not giveup)
2701 (let ((startpoint (point)))
2703 ;; Fixme: This isn't consistent with Bash, at least -- not
2704 ;; all non-ASCII chars should be word constituents.
2705 (if (and (> (- (point) 2) (point-min))
2707 (forward-char -2))
2708 (if (and (> (- (point) 1) (point-min))
2709 (>= (char-after (- (point) 1)) 128))
2710 (forward-char -1))
2711 (if (= (point) startpoint)
2712 (setq giveup t))))
2713 ;; Set match-data to match the entire string.
2714 (when (< (point) here)
2715 (set-match-data (list (point) here))
2716 (match-string 0)))))
2718 (defun comint-substitute-in-file-name (filename)
2719 "Return FILENAME with environment variables substituted.
2720 Supports additional environment variable syntax of the command
2721 interpreter (e.g., the percent notation of cmd.exe on NT)."
2722 (let ((name (substitute-in-file-name filename)))
2723 (if (memq system-type '(ms-dos windows-nt))
2724 (let (env-var-name
2725 env-var-val)
2726 (save-match-data
2728 (setq env-var-name
2729 (substring name (match-beginning 1) (match-end 1)))
2730 (setq env-var-val (if (getenv env-var-name)
2731 (getenv env-var-name)
2732 ""))
2733 (setq name (replace-match env-var-val t t name))))))
2734 name))
2736 (defun comint-match-partial-filename ()
2737 "Return the filename at point, or nil if none is found.
2738 Environment variables are substituted. See `comint-word'."
2739 (let ((filename (comint-word comint-file-name-chars)))
2740 (and filename (comint-substitute-in-file-name
2741 (comint-unquote-filename filename)))))
2744 (defun comint-quote-filename (filename)
2745 "Return FILENAME with magic characters quoted.
2746 Magic characters are those in `comint-file-name-quote-list'."
2747 (if (null comint-file-name-quote-list)
2748 filename
2749 (let ((regexp
2750 (format "[%s]"
2751 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
2752 (save-match-data
2753 (let ((i 0))
2754 (while (string-match regexp filename i)
2756 (setq i (1+ (match-end 0)))))
2757 filename))))
2759 (defun comint-unquote-filename (filename)
2760 "Return FILENAME with quoted characters unquoted."
2761 (if (null comint-file-name-quote-list)
2762 filename
2763 (save-match-data
2764 (let ((i 0))
2767 (setq i (+ 1 (match-beginning 0)))))
2768 filename)))
2771 (defun comint-dynamic-complete ()
2772 "Dynamically perform completion at point.
2773 Calls the functions in `comint-dynamic-complete-functions' to perform
2774 completion until a function returns non-nil, at which point completion is
2775 assumed to have occurred."
2776 (interactive)
2777 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
2780 (defun comint-dynamic-complete-filename ()
2781 "Dynamically complete the filename at point.
2782 Completes if after a filename. See `comint-match-partial-filename' and
2783 `comint-dynamic-complete-as-filename'.
2784 This function is similar to `comint-replace-by-expanded-filename', except that
2785 it won't change parts of the filename already entered in the buffer; it just
2786 adds completion characters to the end of the filename. A completions listing
2787 may be shown in a help buffer if completion is ambiguous.
2789 Completion is dependent on the value of `comint-completion-addsuffix',
2790 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2791 completions listing is dependent on the value of `comint-completion-autolist'.
2793 Returns t if successful."
2794 (interactive)
2795 (when (comint-match-partial-filename)
2796 (unless (window-minibuffer-p (selected-window))
2797 (message "Completing file name..."))
2798 (comint-dynamic-complete-as-filename)))
2800 (defun comint-dynamic-complete-as-filename ()
2801 "Dynamically complete at point as a filename.
2802 See `comint-dynamic-complete-filename'. Returns t if successful."
2803 (let* ((completion-ignore-case read-file-name-completion-ignore-case)
2804 (completion-ignored-extensions comint-completion-fignore)
2805 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2806 ;; I think it was originally bound to solve file completion problems,
2807 ;; but subsequent changes may have made this unnecessary. sm.
2808 ;;(file-name-handler-alist nil)
2809 (minibuffer-p (window-minibuffer-p (selected-window)))
2810 (success t)
2811 (dirsuffix (cond ((not comint-completion-addsuffix)
2812 "")
2813 ((not (consp comint-completion-addsuffix))
2814 "/")
2815 (t
2816 (car comint-completion-addsuffix))))
2817 (filesuffix (cond ((not comint-completion-addsuffix)
2818 "")
2819 ((not (consp comint-completion-addsuffix))
2820 " ")
2821 (t
2822 (cdr comint-completion-addsuffix))))
2823 (filename (comint-match-partial-filename))
2824 (filename-beg (if filename (match-beginning 0) (point)))
2825 (filename-end (if filename (match-end 0) (point)))
2826 (filename (or filename ""))
2827 (filedir (file-name-directory filename))
2828 (filenondir (file-name-nondirectory filename))
2829 (directory (if filedir (comint-directory filedir) default-directory))
2830 (completion (file-name-completion filenondir directory)))
2831 (cond ((null completion)
2832 (if minibuffer-p
2833 (minibuffer-message (format " [No completions of %s]" filename))
2834 (message "No completions of %s" filename))
2835 (setq success nil))
2836 ((eq completion t) ; Means already completed "file".
2837 (insert filesuffix)
2838 (unless minibuffer-p
2839 (message "Sole completion")))
2840 ((string-equal completion "") ; Means completion on "directory/".
2841 (comint-dynamic-list-filename-completions))
2842 (t ; Completion string returned.
2843 (let ((file (concat (file-name-as-directory directory) completion)))
2844 ;; Insert completion. Note that the completion string
2845 ;; may have a different case than what's in the prompt,
2846 ;; if read-file-name-completion-ignore-case is non-nil,
2847 (delete-region filename-beg filename-end)
2848 (if filedir (insert (comint-quote-filename filedir)))
2849 (insert (comint-quote-filename (directory-file-name completion)))
2850 (cond ((symbolp (file-name-completion completion directory))
2851 ;; We inserted a unique completion.
2852 (insert (if (file-directory-p file) dirsuffix filesuffix))
2853 (unless minibuffer-p
2854 (message "Completed")))
2855 ((and comint-completion-recexact comint-completion-addsuffix
2856 (string-equal filenondir completion)
2857 (file-exists-p file))
2858 ;; It's not unique, but user wants shortest match.
2859 (insert (if (file-directory-p file) dirsuffix filesuffix))
2860 (unless minibuffer-p
2861 (message "Completed shortest")))
2862 ((or comint-completion-autolist
2863 (string-equal filenondir completion))
2864 ;; It's not unique, list possible completions.
2865 (comint-dynamic-list-filename-completions))
2866 (t
2867 (unless minibuffer-p
2868 (message "Partially completed")))))))
2869 success))
2872 (defun comint-replace-by-expanded-filename ()
2873 "Dynamically expand and complete the filename at point.
2874 Replace the filename with an expanded, canonicalized and completed replacement.
2877 removed, and the filename is made absolute instead of relative. For expansion
2878 see `expand-file-name' and `substitute-in-file-name'. For completion see
2879 `comint-dynamic-complete-filename'."
2880 (interactive)
2881 (let ((filename (comint-match-partial-filename)))
2882 (when filename
2883 (replace-match (expand-file-name filename) t t)
2884 (comint-dynamic-complete-filename))))
2887 (defun comint-dynamic-simple-complete (stub candidates)
2888 "Dynamically complete STUB from CANDIDATES list.
2889 This function inserts completion characters at point by completing STUB from
2890 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2891 if completion is ambiguous.
2893 Returns nil if no completion was inserted.
2894 Returns `sole' if completed with the only completion match.
2895 Returns `shortest' if completed with the shortest of the completion matches.
2896 Returns `partial' if completed as far as possible with the completion matches.
2897 Returns `listed' if a completion listing was shown.
2899 See also `comint-dynamic-complete-filename'."
2900 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2901 (minibuffer-p (window-minibuffer-p (selected-window)))
2902 (suffix (cond ((not comint-completion-addsuffix) "")
2903 ((not (consp comint-completion-addsuffix)) " ")
2904 (t (cdr comint-completion-addsuffix))))
2905 (completions (all-completions stub candidates)))
2906 (cond ((null completions)
2907 (if minibuffer-p
2908 (minibuffer-message (format " [No completions of %s]" stub))
2909 (message "No completions of %s" stub))
2910 nil)
2911 ((= 1 (length completions)) ; Gotcha!
2912 (let ((completion (car completions)))
2913 (if (string-equal completion stub)
2914 (unless minibuffer-p
2915 (message "Sole completion"))
2916 (insert (substring completion (length stub)))
2917 (unless minibuffer-p
2918 (message "Completed")))
2919 (insert suffix)
2920 'sole))
2921 (t ; There's no unique completion.
2922 (let ((completion (try-completion stub candidates)))
2923 ;; Insert the longest substring.
2924 (insert (substring completion (length stub)))
2925 (cond ((and comint-completion-recexact comint-completion-addsuffix
2926 (string-equal stub completion)
2927 (member completion completions))
2928 ;; It's not unique, but user wants shortest match.
2929 (insert suffix)
2930 (unless minibuffer-p
2931 (message "Completed shortest"))
2932 'shortest)
2933 ((or comint-completion-autolist
2934 (string-equal stub completion))
2935 ;; It's not unique, list possible completions.
2936 (comint-dynamic-list-completions completions stub)
2937 'listed)
2938 (t
2939 (unless minibuffer-p
2940 (message "Partially completed"))
2941 'partial)))))))
2944 (defun comint-dynamic-list-filename-completions ()
2945 "List in help buffer possible completions of the filename at point."
2946 (interactive)
2947 (let* ((completion-ignore-case read-file-name-completion-ignore-case)
2948 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2949 ;; I think it was originally bound to solve file completion problems,
2950 ;; but subsequent changes may have made this unnecessary. sm.
2951 ;;(file-name-handler-alist nil)
2952 (filename (or (comint-match-partial-filename) ""))
2953 (filedir (file-name-directory filename))
2954 (filenondir (file-name-nondirectory filename))
2955 (directory (if filedir (comint-directory filedir) default-directory))
2956 (completions (file-name-all-completions filenondir directory)))
2957 (if (not completions)
2958 (if (window-minibuffer-p (selected-window))
2959 (minibuffer-message (format " [No completions of %s]" filename))
2960 (message "No completions of %s" filename))
2961 (comint-dynamic-list-completions
2962 (mapcar 'comint-quote-filename completions)
2963 (comint-quote-filename filenondir)))))
2966 ;; This is bound locally in a *Completions* buffer to the list of
2967 ;; completions displayed, and is used to detect the case where the same
2968 ;; command is repeatedly used without the set of completions changing.
2969 (defvar comint-displayed-dynamic-completions nil)
2971 (defvar comint-dynamic-list-completions-config nil)
2973 (defun comint-dynamic-list-completions (completions &optional common-substring)
2974 "List in help buffer sorted COMPLETIONS.
2975 The meaning of COMMON-SUBSTRING is the same as in `display-completion-list'.
2976 Typing SPC flushes the help buffer."
2977 (let ((window (get-buffer-window "*Completions*" 0)))
2978 (setq completions (sort completions 'string-lessp))
2979 (if (and (eq last-command this-command)
2980 window (window-live-p window) (window-buffer window)
2981 (buffer-name (window-buffer window))
2982 ;; The above tests are not sufficient to detect the case where we
2983 ;; should scroll, because the top-level interactive command may
2984 ;; not have displayed a completions window the last time it was
2985 ;; invoked, and there may be such a window left over from a
2986 ;; previous completion command with a different set of
2987 ;; completions. To detect that case, we also test that the set
2988 ;; of displayed completions is in fact the same as the previously
2989 ;; displayed set.
2990 (equal completions
2991 (buffer-local-value 'comint-displayed-dynamic-completions
2992 (window-buffer window))))
2993 ;; If this command was repeated, and
2994 ;; there's a fresh completion window with a live buffer,
2995 ;; and this command is repeated, scroll that window.
2996 (with-current-buffer (window-buffer window)
2997 (if (pos-visible-in-window-p (point-max) window)
2998 (set-window-start window (point-min))
2999 (save-selected-window
3000 (select-window window)
3001 (scroll-up))))
3003 ;; Display a completion list for the first time.
3004 (setq comint-dynamic-list-completions-config
3005 (current-window-configuration))
3006 (with-output-to-temp-buffer "*Completions*"
3007 (display-completion-list completions common-substring))
3008 (if (window-minibuffer-p (selected-window))
3009 (minibuffer-message " [Type space to flush; repeat completion command to scroll]")
3010 (message "Type space to flush; repeat completion command to scroll")))
3012 ;; Read the next key, to process SPC.
3013 (let (key first)
3014 (if (with-current-buffer (get-buffer "*Completions*")
3015 (set (make-local-variable 'comint-displayed-dynamic-completions)
3016 completions)
3017 (setq key (read-key-sequence nil)
3018 first (aref key 0))
3019 (and (consp first) (consp (event-start first))
3020 (eq (window-buffer (posn-window (event-start first)))
3021 (get-buffer "*Completions*"))
3022 (eq (key-binding key) 'mouse-choose-completion)))
3023 ;; If the user does mouse-choose-completion with the mouse,
3024 ;; execute the command, then delete the completion window.
3025 (progn
3026 (mouse-choose-completion first)
3027 (set-window-configuration comint-dynamic-list-completions-config))
3028 (if (eq first ?\s)
3029 (set-window-configuration comint-dynamic-list-completions-config)
3030 (setq unread-command-events (listify-key-sequence key)))))))
3032 \f
3033 (defun comint-get-next-from-history ()
3034 "After fetching a line from input history, this fetches the following line.
3035 In other words, this recalls the input line after the line you recalled last.
3036 You can use this to repeat a sequence of input lines."
3037 (interactive)
3038 (if comint-save-input-ring-index
3039 (progn
3040 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
3041 (comint-next-input 1))
3042 (message "No previous history command")))
3044 (defun comint-accumulate ()
3045 "Accumulate a line to send as input along with more lines.
3046 This inserts a newline so that you can enter more text
3048 to send all the accumulated input, at once.
3049 The entire accumulated text becomes one item in the input history
3050 when you send it."
3051 (interactive)
3053 (set-marker comint-accum-marker (point))
3054 (if comint-input-ring-index
3055 (setq comint-save-input-ring-index
3056 (- comint-input-ring-index 1))))
3058 (defun comint-goto-process-mark ()
3059 "Move point to the process mark.
3060 The process mark separates output, and input already sent,
3061 from input that has not yet been sent."
3062 (interactive)
3063 (let ((proc (or (get-buffer-process (current-buffer))
3064 (error "Current buffer has no process"))))
3065 (goto-char (process-mark proc))
3066 (when (interactive-p)
3067 (message "Point is now at the process mark"))))
3069 (defun comint-bol-or-process-mark ()
3070 "Move point to beginning of line (after prompt) or to the process mark.
3071 The first time you use this command, it moves to the beginning of the line
3072 \(but after the prompt, if any). If you repeat it again immediately,
3073 it moves point to the process mark.
3075 The process mark separates the process output, along with input already sent,
3076 from input that has not yet been sent. Ordinarily, the process mark
3077 is at the beginning of the current input line; but if you have
3079 the process mark is at the beginning of the accumulated input."
3080 (interactive)
3081 (if (not (eq last-command 'comint-bol-or-process-mark))
3082 (comint-bol nil)
3083 (comint-goto-process-mark)))
3085 (defun comint-set-process-mark ()
3086 "Set the process mark at point."
3087 (interactive)
3088 (let ((proc (or (get-buffer-process (current-buffer))
3089 (error "Current buffer has no process"))))
3090 (set-marker (process-mark proc) (point))
3091 (message "Process mark set")))
3093 \f
3094 ;; Author: Peter Breton <pbreton@cs.umb.edu>
3096 ;; This little add-on for comint is intended to make it easy to get
3097 ;; output from currently active comint buffers into another buffer,
3098 ;; or buffers, and then go back to using the comint shell.
3099 ;;
3100 ;; My particular use is SQL interpreters; I want to be able to execute a
3101 ;; query using the process associated with a comint-buffer, and save that
3102 ;; somewhere else. Because the process might have state (for example, it
3103 ;; could be in an uncommitted transaction), just running starting a new
3104 ;; process and having it execute the query and then finish, would not
3105 ;; work. I'm sure there are other uses as well, although in many cases
3106 ;; starting a new process is the simpler, and thus preferable, approach.
3107 ;;
3108 ;; The basic implementation is as follows: comint-redirect changes the
3109 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
3110 ;; its own filter. The filter puts the output into the designated buffer,
3111 ;; or buffers, until it sees a regexp that tells it to stop (by default,
3112 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
3113 ;; sees the stop regexp, it restores the old filter functions, and runs
3114 ;; `comint-redirect-hook'.
3115 ;;
3116 ;; Each comint buffer may only use one redirection at a time, but any number
3117 ;; of different comint buffers may be simultaneously redirected.
3118 ;;
3119 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
3120 ;; correct prompt for your interpreter, or that you supply a regexp that says
3121 ;; when the redirection is finished. Otherwise, redirection will continue
3122 ;; indefinitely. The code now does a sanity check to ensure that it can find
3123 ;; a prompt in the comint buffer; however, it is still important to ensure that
3124 ;; this prompt is set correctly.
3125 ;;
3126 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
3127 ;; perhaps it should prompt for a terminating string (with an
3128 ;; appropriate magic default by examining what we think is the prompt)?
3129 ;;
3130 ;; Fixme: look for appropriate fields, rather than regexp, if
3131 ;; `comint-use-prompt-regexp' is true.
3133 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3134 ;; Variables
3135 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3137 (defcustom comint-redirect-verbose nil
3138 "If non-nil, print messages each time the redirection filter is invoked.
3139 Also print a message when redirection is completed."
3140 :group 'comint
3141 :type 'boolean)
3143 ;; Directly analagous to comint-preoutput-filter-functions
3144 (defvar comint-redirect-filter-functions nil
3145 "List of functions to call before inserting redirected process output.
3146 Each function gets one argument, a string containing the text received
3147 from the subprocess. It should return the string to insert, perhaps
3148 the same string that was received, or perhaps a modified or transformed
3149 string.
3151 The functions on the list are called sequentially, and each one is given
3152 the string returned by the previous one. The string returned by the
3153 last function is the text that is actually inserted in the redirection buffer.
3155 You can use `add-hook' to add functions to this list
3156 either globally or locally.")
3158 ;; Internal variables
3160 (defvar comint-redirect-output-buffer nil
3161 "The buffer or list of buffers to put output into.")
3163 (defvar comint-redirect-finished-regexp nil
3164 "Regular expression that determines when to stop redirection in Comint.
3165 When the redirection filter function is given output that matches this regexp,
3166 the output is inserted as usual, and redirection is completed.")
3168 (defvar comint-redirect-insert-matching-regexp nil
3169 "If non-nil, the text that ends a redirection is included in it.
3170 More precisely, the text that matches `comint-redirect-finished-regexp'
3171 and therefore terminates an output redirection is inserted in the
3172 redirection target buffer, along with the preceding output.")
3174 (defvar comint-redirect-echo-input nil
3175 "Non-nil means echo input in the process buffer even during redirection.")
3177 (defvar comint-redirect-completed nil
3178 "Non-nil if redirection has completed in the current buffer.")
3180 (defvar comint-redirect-original-mode-line-process nil
3181 "Original mode line for redirected process.")
3183 (defvar comint-redirect-perform-sanity-check t
3184 "If non-nil, check that redirection is likely to complete successfully.
3185 More precisely, before starting a redirection, verify that the
3186 regular expression `comint-redirect-finished-regexp' that controls
3187 when to terminate it actually matches some text already in the process
3188 buffer. The idea is that this regular expression should match a prompt
3189 string, and that there ought to be at least one copy of your prompt string
3190 in the process buffer already.")
3192 (defvar comint-redirect-original-filter-function nil
3193 "The process filter that was in place when redirection is started.
3194 When redirection is completed, the process filter is restored to
3195 this value.")
3197 (defvar comint-redirect-subvert-readonly nil
3198 "Non-nil means `comint-redirect' can insert into read-only buffers.
3199 This works by binding `inhibit-read-only' around the insertion.
3200 This is useful, for instance, for insertion into Help mode buffers.
3201 You probably want to set it locally to the output buffer.")
3203 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3204 ;; Functions
3205 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3207 (defun comint-redirect-setup (output-buffer
3208 comint-buffer
3209 finished-regexp
3210 &optional echo-input)
3211 "Set up for output redirection.
3212 This function sets local variables that are used by `comint-redirect-filter'
3213 to perform redirection.
3215 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3216 in the output matches FINISHED-REGEXP.
3218 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3219 original Comint buffer.
3221 This function is called by `comint-redirect-send-command-to-process',
3222 and does not normally need to be invoked by the end user or programmer."
3223 (with-current-buffer comint-buffer
3225 (make-local-variable 'comint-redirect-original-mode-line-process)
3226 (setq comint-redirect-original-mode-line-process mode-line-process)
3228 (make-local-variable 'comint-redirect-output-buffer)
3229 (setq comint-redirect-output-buffer output-buffer)
3231 (make-local-variable 'comint-redirect-finished-regexp)
3232 (setq comint-redirect-finished-regexp finished-regexp)
3234 (make-local-variable 'comint-redirect-echo-input)
3235 (setq comint-redirect-echo-input echo-input)
3237 (make-local-variable 'comint-redirect-completed)
3238 (setq comint-redirect-completed nil)
3240 (setq mode-line-process
3241 (if mode-line-process
3242 (list (concat (elt mode-line-process 0) " Redirection"))
3243 (list ":%s Redirection")))))
3245 (defun comint-redirect-cleanup ()
3246 "End a Comint redirection. See `comint-redirect-send-command'."
3247 (interactive)
3248 ;; Restore the process filter
3249 (set-process-filter (get-buffer-process (current-buffer))
3250 comint-redirect-original-filter-function)
3251 ;; Restore the mode line
3252 (setq mode-line-process comint-redirect-original-mode-line-process)
3253 ;; Set the completed flag
3254 (setq comint-redirect-completed t))
3256 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3257 ;; that it really occurs.
3258 (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
3260 (defun comint-redirect-filter (process input-string)
3261 "Filter function which redirects output from PROCESS to a buffer or buffers.
3262 The variable `comint-redirect-output-buffer' says which buffer(s) to
3263 place output in.
3265 INPUT-STRING is the input from the Comint process.
3267 This function runs as a process filter, and does not need to be invoked by the
3268 end user."
3269 (and process
3270 (with-current-buffer (process-buffer process)
3271 (comint-redirect-preoutput-filter input-string)
3272 ;; If we have to echo output, give it to the original filter function
3273 (and comint-redirect-echo-input
3274 comint-redirect-original-filter-function
3275 (funcall comint-redirect-original-filter-function
3276 process input-string)))))
3279 (defun comint-redirect-preoutput-filter (input-string)
3280 "Comint filter function which redirects Comint output to a buffer or buffers.
3281 The variable `comint-redirect-output-buffer' says which buffer(s) to
3282 place output in.
3284 INPUT-STRING is the input from the Comint process.
3286 This function does not need to be invoked by the end user."
3287 (let ((output-buffer-list
3288 (if (listp comint-redirect-output-buffer)
3289 comint-redirect-output-buffer
3290 (list comint-redirect-output-buffer)))
3291 (filtered-input-string input-string))
3293 ;; If there are any filter functions, give them a chance to modify the string
3294 (let ((functions comint-redirect-filter-functions))
3295 (while (and functions filtered-input-string)
3296 (if (eq (car functions) t)
3297 ;; If a local value says "use the default value too",
3298 ;; do that.
3299 (let ((functions (default-value 'comint-redirect-filter-functions)))
3300 (while (and functions filtered-input-string)
3301 (setq filtered-input-string
3302 (funcall (car functions) filtered-input-string))
3303 (setq functions (cdr functions))))
3304 (setq filtered-input-string
3305 (funcall (car functions) filtered-input-string)))
3306 (setq functions (cdr functions))))
3308 ;; Clobber `comint-redirect-finished-regexp'
3309 (or comint-redirect-insert-matching-regexp
3310 (and (string-match comint-redirect-finished-regexp filtered-input-string)
3311 (setq filtered-input-string
3312 (replace-match "" nil nil filtered-input-string))))
3314 ;; Send output to all registered buffers
3315 (save-excursion
3316 (dolist (buf output-buffer-list)
3317 ;; Set this buffer to the output buffer
3318 (set-buffer (get-buffer-create buf))
3319 ;; Go to the end of the buffer
3320 (goto-char (point-max))
3321 ;; Insert the output
3322 (let ((inhibit-read-only comint-redirect-subvert-readonly))
3323 (insert filtered-input-string))))
3325 ;; Message
3326 (and comint-redirect-verbose
3327 (message "Redirected output to buffer(s) %s"
3328 (mapconcat 'identity output-buffer-list " ")))
3330 ;; If we see the prompt, tidy up
3331 ;; We'll look for the prompt in the original string, so nobody can
3332 ;; clobber it
3333 (and (string-match comint-redirect-finished-regexp input-string)
3334 (progn
3335 (and comint-redirect-verbose
3336 (message "Redirection completed"))
3337 (comint-redirect-cleanup)
3338 (run-hooks 'comint-redirect-hook)))
3339 ;; Echo input?
3340 (if comint-redirect-echo-input
3341 filtered-input-string
3342 "")))
3344 ;;;###autoload
3345 (defun comint-redirect-send-command (command output-buffer echo &optional no-display)
3346 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3347 With prefix arg ECHO, echo output in process buffer.
3349 If NO-DISPLAY is non-nil, do not show the output buffer."
3351 (let ((process (get-buffer-process (current-buffer))))
3352 (if process
3353 (comint-redirect-send-command-to-process
3354 command output-buffer (current-buffer) echo no-display)
3355 (error "No process for current buffer"))))
3357 ;;;###autoload
3358 (defun comint-redirect-send-command-to-process
3359 (command output-buffer process echo &optional no-display)
3360 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3361 With prefix arg, echo output in process buffer.
3363 If NO-DISPLAY is non-nil, do not show the output buffer."
3365 (let* (;; The process buffer
3366 (process-buffer (if (processp process)
3367 (process-buffer process)
3368 process))
3369 (proc (get-buffer-process process-buffer)))
3370 ;; Change to the process buffer
3371 (with-current-buffer process-buffer
3373 ;; Make sure there's a prompt in the current process buffer
3374 (and comint-redirect-perform-sanity-check
3375 (save-excursion
3376 (goto-char (point-max))
3377 (or (re-search-backward comint-prompt-regexp nil t)
3378 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3380 ;; Set up for redirection
3381 (comint-redirect-setup
3382 output-buffer
3383 (current-buffer) ; Comint Buffer
3384 comint-prompt-regexp ; Finished Regexp
3385 echo) ; Echo input
3387 ;; Set the filter
3388 (setq comint-redirect-original-filter-function ; Save the old filter
3389 (process-filter proc))
3390 (set-process-filter proc 'comint-redirect-filter)
3392 ;; Send the command
3395 ;; Show the output
3396 (or no-display
3397 (display-buffer
3398 (get-buffer-create
3399 (if (listp output-buffer)
3400 (car output-buffer)
3401 output-buffer)))))))
3403 ;;;###autoload
3404 (defun comint-redirect-results-list (command regexp regexp-group)
3405 "Send COMMAND to current process.
3406 Return a list of expressions in the output which match REGEXP.
3407 REGEXP-GROUP is the regular expression group in REGEXP to use."
3408 (comint-redirect-results-list-from-process
3409 (get-buffer-process (current-buffer))
3410 command regexp regexp-group))
3412 ;;;###autoload
3413 (defun comint-redirect-results-list-from-process (process command regexp regexp-group)
3414 "Send COMMAND to PROCESS.
3415 Return a list of expressions in the output which match REGEXP.
3416 REGEXP-GROUP is the regular expression group in REGEXP to use."
3417 (let ((output-buffer " *Comint Redirect Work Buffer*")
3418 results)
3419 (save-excursion
3420 (set-buffer (get-buffer-create output-buffer))
3421 (erase-buffer)
3422 (comint-redirect-send-command-to-process command
3423 output-buffer process nil t)
3424 ;; Wait for the process to complete
3425 (set-buffer (process-buffer process))
3426 (while (null comint-redirect-completed)
3427 (accept-process-output nil 1))
3428 ;; Collect the output
3429 (set-buffer output-buffer)
3430 (goto-char (point-min))
3431 ;; Skip past the command, if it was echoed
3432 (and (looking-at command)
3433 (forward-line))
3434 (while (re-search-forward regexp nil t)
3435 (setq results
3436 (cons (buffer-substring-no-properties
3437 (match-beginning regexp-group)
3438 (match-end regexp-group))
3439 results)))
3440 results)))
3442 (dolist (x '("^Not at command line$"
3443 "^Empty input ring$"
3444 "^No history$"
3445 "^Not found$" ; Too common?
3446 "^Current buffer has no process$"))
3447 (add-to-list 'debug-ignored-errors x))
3449 \f
3450 ;; Converting process modes to use comint mode
3451 ;; ===========================================================================
3452 ;; The code in the Emacs 19 distribution has all been modified to use comint
3453 ;; where needed. However, there are `third-party' packages out there that
3454 ;; still use the old shell mode. Here's a guide to conversion.
3455 ;;
3456 ;; Renaming variables
3457 ;; Most of the work is renaming variables and functions. These are the common
3458 ;; ones:
3459 ;; Local variables:
3460 ;; last-input-start comint-last-input-start
3461 ;; last-input-end comint-last-input-end
3462 ;; shell-prompt-pattern comint-prompt-regexp
3463 ;; shell-set-directory-error-hook <no equivalent>
3464 ;; Miscellaneous:
3465 ;; shell-set-directory <unnecessary>
3466 ;; shell-mode-map comint-mode-map
3467 ;; Commands:
3468 ;; shell-send-input comint-send-input
3469 ;; shell-send-eof comint-delchar-or-maybe-eof
3470 ;; kill-shell-input comint-kill-input
3471 ;; interrupt-shell-subjob comint-interrupt-subjob
3472 ;; stop-shell-subjob comint-stop-subjob
3473 ;; quit-shell-subjob comint-quit-subjob
3474 ;; kill-shell-subjob comint-kill-subjob
3475 ;; kill-output-from-shell comint-delete-output
3476 ;; show-output-from-shell comint-show-output
3477 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3478 ;;
3479 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3480 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3481 ;; Comint mode does not provide functionality equivalent to
3482 ;; shell-set-directory-error-hook; it is gone.
3483 ;;
3484 ;; comint-last-input-start is provided for modes which want to munge
3485 ;; the buffer after input is sent, perhaps because the inferior
3486 ;; insists on echoing the input. The LAST-INPUT-START variable in
3487 ;; the old shell package was used to implement a history mechanism,
3488 ;; but you should think twice before using comint-last-input-start
3489 ;; for this; the input history ring often does the job better.
3490 ;;
3491 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3492 ;; *not* create the comint-mode local variables in your foo-mode function.
3493 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3494 ;; necessary comint-specific local variables. Then create the
3495 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3496 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3497 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3498 ;; get-old-input) that need to be different from the defaults. Call
3499 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3500 ;; comint-mode will take care of it. The following example, from shell.el,
3501 ;; is typical:
3502 ;;
3503 ;; (defvar shell-mode-map '())
3504 ;; (cond ((not shell-mode-map)
3505 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3506 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3507 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3509 ;; (define-key shell-mode-map "\M-?"
3510 ;; 'comint-dynamic-list-filename-completions)))
3511 ;;
3512 ;; (defun shell-mode ()
3513 ;; (interactive)
3514 ;; (comint-mode)
3515 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3516 ;; (setq major-mode 'shell-mode)
3517 ;; (setq mode-name "Shell")
3518 ;; (use-local-map shell-mode-map)
3519 ;; (make-local-variable 'shell-directory-stack)
3520 ;; (setq shell-directory-stack nil)
3521 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3522 ;; (run-mode-hooks 'shell-mode-hook))
3523 ;;
3524 ;;
3525 ;; Completion for comint-mode users
3526 ;;
3527 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3528 ;; hook to add completion functions to. Functions on this list should return
3529 ;; non-nil if completion occurs (i.e., further completion should not occur).
3530 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3531 ;; completion job.
3532 \f
3534 (provide 'comint)
3536 ;; arch-tag: 1793314c-09db-40be-9549-9aeae3e75164
3537 ;;; comint.el ends here