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