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