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 Free Software Foundation, Inc.
6 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
7 ;; Simon Marshall <simon@gnu.org>
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 2, or (at your option)
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.
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.
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.
59 ;; Brief Command Documentation:
60 ;;============================================================================
61 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
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
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
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.
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-scroll-to-bottom-on-output symbol ...
136 ;; comint-scroll-show-maximum-output boolean ...
137 ;; comint-accum-marker maker For comint-accumulate
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."
148 (defgroup comint-completion nil
149 "Completion facilities in comint."
152 (defgroup comint-source nil
153 "Source finding facilities in comint."
157 (defvar comint-prompt-regexp "^"
158 "Regexp to recognize prompts in the inferior process.
159 Defaults to \"^\", the null string at BOL.
161 This variable is only used if the variable
162 `comint-use-prompt-regexp' is non-nil.
165 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
166 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
167 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
169 shell: \"^[^#$%>\\n]*[#$%>] *\"
172 This is a good thing to set in mode hooks.")
174 (defcustom comint-prompt-read-only nil
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
189 (define-key comint-mode-map \"\\C-w\" 'comint-kill-region)
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'."
199 (defvar comint-delimiter-argument-list ()
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.
206 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
208 This is a good thing to set in mode hooks.")
210 (defcustom comint-input-autoexpand nil
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."
220 :type '(choice (const :tag "off" nil)
226 (defface comint-highlight-input '((t (:weight bold)))
227 "Face to use to highlight user input."
230 (defface comint-highlight-prompt
231 '((((min-colors 88) (background dark)) (:foreground "cyan1"))
232 (((background dark)) (:foreground "cyan"))
233 (t (:foreground "dark blue")))
234 "Face to use to highlight prompts."
237 (defcustom comint-input-ignoredups nil
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."
245 (defcustom comint-input-ring-file-name nil
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."
250 :type '(choice (const :tag "nil" nil)
254 (defcustom comint-scroll-to-bottom-on-input nil
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.
261 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
262 :type '(choice (const :tag "off" nil)
268 (defcustom comint-move-point-for-output nil
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.
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."
281 :type '(choice (const :tag "off" nil)
288 (defvaralias 'comint-scroll-to-bottom-on-output 'comint-move-point-for-output)
290 (defcustom comint-scroll-show-maximum-output t
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."
307 (defcustom comint-buffer-maximum-size 1024
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'."
314 (defvar comint-input-ring-size 150
315 "Size of input history ring.")
317 (defvar comint-input-ring-separator "\n"
318 "Separator between commands in the history file.")
320 (defvar comint-input-history-ignore "^#"
321 "Regexp for history entries that should be ignored when Comint initializes.")
323 (defcustom comint-process-echoes nil
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 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
337 (defcustom comint-password-prompt-regexp
338 "\\(\\([Oo]ld \\|[Nn]ew \\|'s \\|login \\|\
339 Kerberos \\|CVS \\|UNIX \\| SMB \\|^\\)\
340 \[Pp]assword\\( (again)\\)?\\|\
341 pass phrase\\|\\(Enter\\|Repeat\\|Bad\\) passphrase\\)\
342 \\(?:, try again\\)?\\(?: for [^:]+\\)?:\\s *\\'"
343 "*Regexp matching prompts for passwords in the inferior process.
344 This is used by `comint-watch-for-password-prompt'."
348 ;; Here are the per-interpreter hooks.
349 (defvar comint-get-old-input (function comint-get-old-input-default)
350 "Function that returns old text in Comint mode.
351 This function is called when return is typed while the point is in old
352 text. It returns the text to be submitted as process input. The
353 default is `comint-get-old-input-default', which either grabs the
354 current input field or grabs the current line and strips off leading
355 text matching `comint-prompt-regexp', depending on the value of
356 `comint-use-prompt-regexp'.")
358 (defvar comint-dynamic-complete-functions
359 '(comint-replace-by-expanded-history comint-dynamic-complete-filename)
360 "List of functions called to perform completion.
361 Functions should return non-nil if completion was performed.
362 See also `comint-dynamic-complete'.
364 This is a good thing to set in mode hooks.")
366 (defvar comint-input-filter
367 (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
368 "Predicate for filtering additions to input history.
369 Takes one argument, the input. If non-nil, the input may be saved on the input
370 history list. Default is to save anything that isn't all whitespace.")
372 (defvar comint-input-filter-functions '()
373 "Abnormal hook run before input is sent to the process.
374 These functions get one argument, a string containing the text to send.")
377 (defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom comint-watch-for-password-prompt)
378 "Functions to call after output is inserted into the buffer.
379 One possible function is `comint-postoutput-scroll-to-bottom'.
380 These functions get one argument, a string containing the text as originally
381 inserted. Note that this might not be the same as the buffer contents between
382 `comint-last-output-start' and the buffer's `process-mark', if other filter
383 functions have already modified the buffer.
385 See also `comint-preoutput-filter-functions'.
387 You can use `add-hook' to add functions to this list
388 either globally or locally.")
390 (defvar comint-input-sender-no-newline nil
391 "Non-nil directs the `comint-input-sender' function not to send a newline.")
393 (defvar comint-input-sender (function comint-simple-send)
394 "Function to actually send to PROCESS the STRING submitted by user.
395 Usually this is just `comint-simple-send', but if your mode needs to
396 massage the input string, put a different function here.
397 `comint-simple-send' just sends the string plus a newline.
398 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
399 This is called from the user command `comint-send-input'.")
401 (defcustom comint-eol-on-send t
402 "*Non-nil means go to the end of the line before sending input.
403 See `comint-send-input'."
407 ;; Note: If it is decided to purge comint-prompt-regexp from the source
408 ;; entirely, searching for uses of this variable will help to identify
409 ;; places that need attention.
410 (defcustom comint-use-prompt-regexp nil
411 "*If non-nil, use `comint-prompt-regexp' to recognize prompts.
412 If nil, then program output and user-input are given different `field'
413 properties, which Emacs commands can use to distinguish them (in
414 particular, common movement commands such as `beginning-of-line'
415 respect field boundaries in a natural way)."
419 ;; Autoload is necessary for Custom to recognize old alias.
421 (define-obsolete-variable-alias 'comint-use-prompt-regexp-instead-of-fields
422 'comint-use-prompt-regexp "22.1")
424 (defcustom comint-mode-hook nil
425 "Hook run upon entry to `comint-mode'.
426 This is run before the process is cranked up."
430 (defcustom comint-exec-hook '()
431 "Hook run each time a process is exec'd by `comint-exec'.
432 This is called after the process is cranked up. It is useful for things that
433 must be done each time a process is executed in a Comint mode buffer (e.g.,
434 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
435 executed once when the buffer is created."
439 (defvar comint-mode-map
440 (let ((map (make-sparse-keymap)))
442 (define-key map "\ep" 'comint-previous-input)
443 (define-key map "\en" 'comint-next-input)
444 (define-key map [C-up] 'comint-previous-input)
445 (define-key map [C-down] 'comint-next-input)
446 (define-key map "\er" 'comint-previous-matching-input)
447 (define-key map "\es" 'comint-next-matching-input)
448 (define-key map [?\C-c ?\M-r] 'comint-previous-matching-input-from-input)
449 (define-key map [?\C-c ?\M-s] 'comint-next-matching-input-from-input)
450 (define-key map "\e\C-l" 'comint-show-output)
451 (define-key map "\C-m" 'comint-send-input)
452 (define-key map "\C-d" 'comint-delchar-or-maybe-eof)
453 (define-key map "\C-c " 'comint-accumulate)
454 (define-key map "\C-c\C-x" 'comint-get-next-from-history)
455 (define-key map "\C-c\C-a" 'comint-bol-or-process-mark)
456 (define-key map "\C-c\C-u" 'comint-kill-input)
457 (define-key map "\C-c\C-w" 'backward-kill-word)
458 (define-key map "\C-c\C-c" 'comint-interrupt-subjob)
459 (define-key map "\C-c\C-z" 'comint-stop-subjob)
460 (define-key map "\C-c\C-\\" 'comint-quit-subjob)
461 (define-key map "\C-c\C-m" 'comint-insert-input)
462 (define-key map "\C-c\C-o" 'comint-delete-output)
463 (define-key map "\C-c\C-r" 'comint-show-output)
464 (define-key map "\C-c\C-e" 'comint-show-maximum-output)
465 (define-key map "\C-c\C-l" 'comint-dynamic-list-input-ring)
466 (define-key map "\C-c\C-n" 'comint-next-prompt)
467 (define-key map "\C-c\C-p" 'comint-previous-prompt)
468 (define-key map "\C-c\C-d" 'comint-send-eof)
469 (define-key map "\C-c\C-s" 'comint-write-output)
470 (define-key map "\C-c." 'comint-insert-previous-argument)
472 (define-key map [mouse-2] 'comint-insert-input)
475 (define-key map [menu-bar completion]
476 (cons "Complete" (make-sparse-keymap "Complete")))
477 (define-key map [menu-bar completion complete-expand]
478 '("Expand File Name" . comint-replace-by-expanded-filename))
479 (define-key map [menu-bar completion complete-listing]
480 '("File Completion Listing" . comint-dynamic-list-filename-completions))
481 (define-key map [menu-bar completion complete-file]
482 '("Complete File Name" . comint-dynamic-complete-filename))
483 (define-key map [menu-bar completion complete]
484 '("Complete Before Point" . comint-dynamic-complete))
486 (define-key map [menu-bar inout]
487 (cons "In/Out" (make-sparse-keymap "In/Out")))
488 (define-key map [menu-bar inout delete-output]
489 '("Delete Current Output Group" . comint-delete-output))
490 (define-key map [menu-bar inout append-output-to-file]
491 '("Append Current Output Group to File" . comint-append-output-to-file))
492 (define-key map [menu-bar inout write-output]
493 '("Write Current Output Group to File" . comint-write-output))
494 (define-key map [menu-bar inout next-prompt]
495 '("Forward Output Group" . comint-next-prompt))
496 (define-key map [menu-bar inout previous-prompt]
497 '("Backward Output Group" . comint-previous-prompt))
498 (define-key map [menu-bar inout show-maximum-output]
499 '("Show Maximum Output" . comint-show-maximum-output))
500 (define-key map [menu-bar inout show-output]
501 '("Show Current Output Group" . comint-show-output))
502 (define-key map [menu-bar inout kill-input]
503 '("Kill Current Input" . comint-kill-input))
504 (define-key map [menu-bar inout copy-input]
505 '("Copy Old Input" . comint-insert-input))
506 (define-key map [menu-bar inout forward-matching-history]
507 '("Forward Matching Input..." . comint-forward-matching-input))
508 (define-key map [menu-bar inout backward-matching-history]
509 '("Backward Matching Input..." . comint-backward-matching-input))
510 (define-key map [menu-bar inout next-matching-history]
511 '("Next Matching Input..." . comint-next-matching-input))
512 (define-key map [menu-bar inout previous-matching-history]
513 '("Previous Matching Input..." . comint-previous-matching-input))
514 (define-key map [menu-bar inout next-matching-history-from-input]
515 '("Next Matching Current Input" . comint-next-matching-input-from-input))
516 (define-key map [menu-bar inout previous-matching-history-from-input]
517 '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
518 (define-key map [menu-bar inout next-history]
519 '("Next Input" . comint-next-input))
520 (define-key map [menu-bar inout previous-history]
521 '("Previous Input" . comint-previous-input))
522 (define-key map [menu-bar inout list-history]
523 '("List Input History" . comint-dynamic-list-input-ring))
524 (define-key map [menu-bar inout expand-history]
525 '("Expand History Before Point" . comint-replace-by-expanded-history))
527 (let ((signals-map (make-sparse-keymap "Signals")))
528 (define-key map [menu-bar signals] (cons "Signals" signals-map))
529 (define-key signals-map [eof] '("EOF" . comint-send-eof))
530 (define-key signals-map [kill] '("KILL" . comint-kill-subjob))
531 (define-key signals-map [quit] '("QUIT" . comint-quit-subjob))
532 (define-key signals-map [cont] '("CONT" . comint-continue-subjob))
533 (define-key signals-map [stop] '("STOP" . comint-stop-subjob))
534 (define-key signals-map [break] '("BREAK" . comint-interrupt-subjob)))
535 ;; Put them in the menu bar:
536 (setq menu-bar-final-items (append '(completion inout signals)
537 menu-bar-final-items))
540 ;; Fixme: Is this still relevant?
541 (defvar comint-ptyp t
542 "Non-nil if communications via pty; false if by pipe. Buffer local.
543 This is to work around a bug in Emacs process signaling.")
545 (defvar comint-input-ring nil)
546 (defvar comint-last-input-start nil)
547 (defvar comint-last-input-end nil)
548 (defvar comint-last-output-start nil)
549 (defvar comint-input-ring-index nil
550 "Index of last matched history element.")
551 (defvar comint-matching-input-from-input-string ""
552 "Input previously used to match input history.")
553 (defvar comint-save-input-ring-index
554 "Last input ring index which you copied.
555 This is to support the command \\[comint-get-next-from-history].")
557 (defvar comint-accum-marker nil
558 "Non-nil if you are accumulating input lines to send as input together.
559 The command \\[comint-accumulate] sets this.")
561 (put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
562 (put 'comint-input-ring 'permanent-local t)
563 (put 'comint-input-ring-index 'permanent-local t)
564 (put 'comint-save-input-ring-index 'permanent-local t)
565 (put 'comint-input-autoexpand 'permanent-local t)
566 (put 'comint-input-filter-functions 'permanent-local t)
567 (put 'comint-output-filter-functions 'permanent-local t)
568 (put 'comint-preoutput-filter-functions 'permanent-local t)
569 (put 'comint-scroll-to-bottom-on-input 'permanent-local t)
570 (put 'comint-move-point-for-output 'permanent-local t)
571 (put 'comint-scroll-show-maximum-output 'permanent-local t)
572 (put 'comint-ptyp 'permanent-local t)
574 (put 'comint-mode 'mode-class 'special)
576 (define-derived-mode comint-mode fundamental-mode "Comint"
577 "Major mode for interacting with an inferior interpreter.
578 Interpreter name is same as buffer name, sans the asterisks.
579 Return at end of buffer sends line as input.
580 Return not at end copies rest of line to end and sends it.
581 Setting variable `comint-eol-on-send' means jump to the end of the line
582 before submitting new input.
584 This mode is customized to create major modes such as Inferior Lisp
585 mode, Shell mode, etc. This can be done by setting the hooks
586 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
587 and `comint-get-old-input' to appropriate functions, and the variable
588 `comint-prompt-regexp' to the appropriate regular expression.
590 An input history is maintained of size `comint-input-ring-size', and
591 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
592 Input ring history expansion can be achieved with the commands
593 \\[comint-replace-by-expanded-history] or \\[comint-magic-space].
594 Input ring expansion is controlled by the variable `comint-input-autoexpand',
595 and addition is controlled by the variable `comint-input-ignoredups'.
597 Commands with no default key bindings include `send-invisible',
598 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
599 `comint-magic-space'.
601 Input to, and output from, the subprocess can cause the window to scroll to
602 the end of the buffer. See variables `comint-output-filter-functions',
603 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
604 and `comint-move-point-for-output'.
606 If you accidentally suspend your process, use \\[comint-continue-subjob]
611 Entry to this mode runs the hooks on `comint-mode-hook'."
612 (setq mode-line-process '(":%s"))
613 (set (make-local-variable 'comint-last-input-start) (point-min-marker))
614 (set (make-local-variable 'comint-last-input-end) (point-min-marker))
615 (set (make-local-variable 'comint-last-output-start) (make-marker))
616 (make-local-variable 'comint-last-prompt-overlay)
617 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
618 (make-local-variable 'comint-input-ring-size) ; ...to global val.
619 (make-local-variable 'comint-input-ring)
620 (make-local-variable 'comint-input-ring-file-name)
621 (or (and (boundp 'comint-input-ring) comint-input-ring)
622 (setq comint-input-ring (make-ring comint-input-ring-size)))
623 (make-local-variable 'comint-input-ring-index)
624 (make-local-variable 'comint-save-input-ring-index)
625 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
626 (setq comint-input-ring-index nil))
627 (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
628 (setq comint-save-input-ring-index nil))
629 (make-local-variable 'comint-matching-input-from-input-string)
630 (make-local-variable 'comint-input-autoexpand)
631 (make-local-variable 'comint-input-ignoredups)
632 (make-local-variable 'comint-delimiter-argument-list)
633 (make-local-variable 'comint-completion-fignore)
634 (make-local-variable 'comint-get-old-input)
635 (make-local-variable 'comint-input-filter)
636 (make-local-variable 'comint-input-sender)
637 (make-local-variable 'comint-eol-on-send)
638 (make-local-variable 'comint-scroll-to-bottom-on-input)
639 (make-local-variable 'comint-move-point-for-output)
640 (make-local-variable 'comint-scroll-show-maximum-output)
641 ;; This makes it really work to keep point at the bottom.
642 (make-local-variable 'scroll-conservatively)
643 (setq scroll-conservatively 10000)
644 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
645 (make-local-variable 'comint-ptyp)
646 (make-local-variable 'comint-process-echoes)
647 (make-local-variable 'comint-file-name-chars)
648 (make-local-variable 'comint-file-name-quote-list)
649 (set (make-local-variable 'comint-accum-marker) (make-marker))
650 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
651 ;; This behavior is not useful in comint buffers, and is annoying
652 (set (make-local-variable 'next-line-add-newlines) nil))
654 (defun comint-check-proc (buffer)
655 "Return non-nil if there is a living process associated w/buffer BUFFER.
656 Living means the status is `open', `run', or `stop'.
657 BUFFER can be either a buffer or the name of one."
658 (let ((proc (get-buffer-process buffer)))
659 (and proc (memq (process-status proc) '(open run stop)))))
662 (defun make-comint-in-buffer (name buffer program &optional startfile &rest switches)
663 "Make a Comint process NAME in BUFFER, running PROGRAM.
664 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
665 PROGRAM should be either a string denoting an executable program to create
666 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
667 connection to be opened via `open-network-stream'. If there is already a
668 running process in that buffer, it is not restarted. Optional fourth arg
669 STARTFILE is the name of a file to send the contents of to the process.
671 If PROGRAM is a string, any more args are arguments to PROGRAM."
672 (or (fboundp 'start-process)
673 (error "Multi-processing is not supported for this system"))
674 (setq buffer (get-buffer-create (or buffer (concat "*" name "*"))))
675 ;; If no process, or nuked process, crank up a new one and put buffer in
676 ;; comint mode. Otherwise, leave buffer and existing process alone.
677 (unless (comint-check-proc buffer)
678 (with-current-buffer buffer
679 (unless (derived-mode-p 'comint-mode)
680 (comint-mode))) ; Install local vars, mode, keymap, ...
681 (comint-exec buffer name program startfile switches))
685 (defun make-comint (name program &optional startfile &rest switches)
686 "Make a Comint process NAME in a buffer, running PROGRAM.
687 The name of the buffer is made by surrounding NAME with `*'s.
688 PROGRAM should be either a string denoting an executable program to create
689 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
690 connection to be opened via `open-network-stream'. If there is already a
691 running process in that buffer, it is not restarted. Optional third arg
692 STARTFILE is the name of a file to send the contents of the process to.
694 If PROGRAM is a string, any more args are arguments to PROGRAM."
695 (apply #'make-comint-in-buffer name nil program startfile switches))
698 (defun comint-run (program)
699 "Run PROGRAM in a Comint buffer and switch to it.
700 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
701 The file name is used to make a symbol name, such as `comint-sh-hook', and any
702 hooks on this symbol are run in the buffer.
703 See `make-comint' and `comint-exec'."
704 (interactive "sRun program: ")
705 (let ((name (file-name-nondirectory program)))
706 (switch-to-buffer (make-comint name program))
707 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
709 (defun comint-exec (buffer name command startfile switches)
710 "Start up a process named NAME in buffer BUFFER for Comint modes.
711 Runs the given COMMAND with SWITCHES with output to STARTFILE.
712 Blasts any old process running in the buffer. Doesn't set the buffer mode.
713 You can use this to cheaply run a series of processes in the same Comint
714 buffer. The hook `comint-exec-hook' is run after each exec."
715 (with-current-buffer buffer
716 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
717 (if proc (delete-process proc)))
718 ;; Crank up a new process
721 (open-network-stream name buffer (car command) (cdr command))
722 (comint-exec-1 name buffer command switches))))
723 (set-process-filter proc 'comint-output-filter)
724 (make-local-variable 'comint-ptyp)
725 (setq comint-ptyp process-connection-type) ; t if pty, nil if pipe.
726 ;; Jump to the end, and set the process mark.
727 (goto-char (point-max))
728 (set-marker (process-mark proc) (point))
729 ;; Feed it the startfile.
731 ;;This is guaranteed to wait long enough
732 ;;but has bad results if the comint does not prompt at all
733 ;; (while (= size (buffer-size))
735 ;;I hope 1 second is enough!
737 (goto-char (point-max))
738 (insert-file-contents startfile)
739 (setq startfile (buffer-substring (point) (point-max)))
740 (delete-region (point) (point-max))
741 (comint-send-string proc startfile)))
742 (run-hooks 'comint-exec-hook)
745 ;; This auxiliary function cranks up the process for comint-exec in
746 ;; the appropriate environment.
748 (defun comint-exec-1 (name buffer command switches)
749 (let ((process-environment
751 ;; If using termcap, we specify `emacs' as the terminal type
752 ;; because that lets us specify a width.
753 ;; If using terminfo, we specify `dumb' because that is
754 ;; a defined terminal type. `emacs' is not a defined terminal type
755 ;; and there is no way for us to define it here.
756 ;; Some programs that use terminfo get very confused
757 ;; if TERM is not a valid terminal type.
758 ;; ;; There is similar code in compile.el.
759 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
760 (list "TERM=dumb" "TERMCAP="
761 (format "COLUMNS=%d" (window-width)))
763 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
764 (if (getenv "EMACS") nil (list "EMACS=t"))
765 process-environment))
767 (if (file-accessible-directory-p default-directory)
770 proc decoding encoding changed)
771 (let ((exec-path (if (file-name-directory command)
772 ;; If the command has slashes, make sure we
773 ;; first look relative to the current directory.
774 (cons default-directory exec-path) exec-path)))
775 (setq proc (apply 'start-process name buffer command switches)))
776 (let ((coding-systems (process-coding-system proc)))
777 (setq decoding (car coding-systems)
778 encoding (cdr coding-systems)))
779 ;; If start-process decided to use some coding system for decoding
780 ;; data sent from the process and the coding system doesn't
781 ;; specify EOL conversion, we had better convert CRLF to LF.
782 (if (vectorp (coding-system-eol-type decoding))
783 (setq decoding (coding-system-change-eol-conversion decoding 'dos)
785 ;; Even if start-process left the coding system for encoding data
786 ;; sent from the process undecided, we had better use the same one
787 ;; as what we use for decoding. But, we should suppress EOL
789 (if (and decoding (not encoding))
790 (setq encoding (coding-system-change-eol-conversion decoding 'unix)
793 (set-process-coding-system proc decoding encoding))
796 (defun comint-insert-input (&optional event)
797 "In a Comint buffer, set the current input to the previous input at point."
798 ;; This doesn't use "e" because it is supposed to work
799 ;; for events without parameters.
800 (interactive (list last-input-event))
802 (if event (mouse-set-point event))
803 (if (not (eq (get-char-property (point) 'field) 'input))
804 ;; No input at POS, fall back to the global definition.
805 (let* ((keys (this-command-keys))
806 (last-key (and (vectorp keys) (aref keys (1- (length keys)))))
807 (fun (and last-key (lookup-key global-map (vector last-key)))))
809 (and fun (call-interactively fun)))
811 ;; There's previous input at POS, insert it at the end of the buffer.
812 (goto-char (point-max))
813 ;; First delete any old unsent input at the end
815 (or (marker-position comint-accum-marker)
816 (process-mark (get-buffer-process (current-buffer))))
818 ;; Insert the input at point
819 (insert (buffer-substring-no-properties
820 (previous-single-char-property-change (1+ pos) 'field)
821 (next-single-char-property-change pos 'field))))))
824 ;; Input history processing in a buffer
825 ;; ===========================================================================
826 ;; Useful input history functions, courtesy of the Ergo group.
829 ;; comint-dynamic-list-input-ring List history in help buffer.
830 ;; comint-previous-input Previous input...
831 ;; comint-previous-matching-input ...matching a string.
832 ;; comint-previous-matching-input-from-input ... matching the current input.
833 ;; comint-next-input Next input...
834 ;; comint-next-matching-input ...matching a string.
835 ;; comint-next-matching-input-from-input ... matching the current input.
836 ;; comint-backward-matching-input Backwards input...
837 ;; comint-forward-matching-input ...matching a string.
838 ;; comint-replace-by-expanded-history Expand history at point;
839 ;; replace with expanded history.
840 ;; comint-magic-space Expand history and insert space.
843 ;; comint-read-input-ring Read into comint-input-ring...
844 ;; comint-write-input-ring Write to comint-input-ring-file-name.
845 ;; comint-replace-by-expanded-history-before-point Workhorse function.
847 (defun comint-read-input-ring (&optional silent)
848 "Set the buffer's `comint-input-ring' from a history file.
849 The name of the file is given by the variable `comint-input-ring-file-name'.
850 The history ring is of size `comint-input-ring-size', regardless of file size.
851 If `comint-input-ring-file-name' is nil this function does nothing.
853 If the optional argument SILENT is non-nil, we say nothing about a
854 failure to read the history file.
856 This function is useful for major mode commands and mode hooks.
858 The commands stored in the history file are separated by the
859 `comint-input-ring-separator', and entries that match
860 `comint-input-history-ignore' are ignored. The most recent command
863 See also `comint-input-ignoredups' and `comint-write-input-ring'."
864 (cond ((or (null comint-input-ring-file-name)
865 (equal comint-input-ring-file-name ""))
867 ((not (file-readable-p comint-input-ring-file-name))
869 (message "Cannot read history file %s"
870 comint-input-ring-file-name)))
872 (let* ((history-buf (get-buffer-create " *temp*"))
873 (file comint-input-ring-file-name)
875 (size comint-input-ring-size)
876 (ring (make-ring size)))
879 (set-buffer history-buf)
882 (insert-file-contents file)
883 ;; Save restriction in case file is already visited...
884 ;; Watch for those date stamps in history files!
885 (goto-char (point-max))
886 (let (start end history)
887 (while (and (< count comint-input-ring-size)
888 (re-search-backward comint-input-ring-separator nil t)
889 (setq end (match-beginning 0)))
890 (if (re-search-backward comint-input-ring-separator nil t)
891 (setq start (match-end 0))
892 (setq start (point-min)))
893 (setq history (buffer-substring start end))
895 (if (and (not (string-match comint-input-history-ignore history))
896 (or (null comint-input-ignoredups)
898 (not (string-equal (ring-ref ring 0) history))))
900 (ring-insert-at-beginning ring history)
901 (setq count (1+ count)))))))
902 (kill-buffer history-buf))
903 (setq comint-input-ring ring
904 comint-input-ring-index nil)))))
906 (defun comint-write-input-ring ()
907 "Writes the buffer's `comint-input-ring' to a history file.
908 The name of the file is given by the variable `comint-input-ring-file-name'.
909 The original contents of the file are lost if `comint-input-ring' is not empty.
910 If `comint-input-ring-file-name' is nil this function does nothing.
912 Useful within process sentinels.
914 See also `comint-read-input-ring'."
915 (cond ((or (null comint-input-ring-file-name)
916 (equal comint-input-ring-file-name "")
917 (null comint-input-ring) (ring-empty-p comint-input-ring))
919 ((not (file-writable-p comint-input-ring-file-name))
920 (message "Cannot write history file %s" comint-input-ring-file-name))
922 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
923 (ring comint-input-ring)
924 (file comint-input-ring-file-name)
925 (index (ring-length ring)))
926 ;; Write it all out into a buffer first. Much faster, but messier,
927 ;; than writing it one line at a time.
929 (set-buffer history-buf)
932 (setq index (1- index))
933 (insert (ring-ref ring index) comint-input-ring-separator))
934 (write-region (buffer-string) nil file nil 'no-message)
935 (kill-buffer nil))))))
938 (defvar comint-dynamic-list-input-ring-window-conf)
940 (defun comint-dynamic-list-input-ring-select ()
941 "Choose the input history entry that point is in or next to."
943 (let (beg end completion (buffer completion-reference-buffer)
944 (base-size completion-base-size))
945 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
946 (setq end (point) beg (1+ (point))))
947 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
948 (setq end (1- (point)) beg (point)))
950 (error "No history entry here"))
951 (setq beg (previous-single-property-change beg 'mouse-face))
952 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
953 (setq completion (buffer-substring beg end))
954 (set-window-configuration comint-dynamic-list-input-ring-window-conf)
955 (choose-completion-string completion buffer base-size)))
957 (defun comint-dynamic-list-input-ring ()
958 "List in help buffer the buffer's input history."
960 (if (or (not (ring-p comint-input-ring))
961 (ring-empty-p comint-input-ring))
962 (message "No history")
964 (history-buffer " *Input History*")
965 (index (1- (ring-length comint-input-ring)))
966 (conf (current-window-configuration)))
967 ;; We have to build up a list ourselves from the ring vector.
969 (setq history (cons (ring-ref comint-input-ring index) history)
971 ;; Change "completion" to "history reference"
972 ;; to make the display accurate.
973 (with-output-to-temp-buffer history-buffer
974 (display-completion-list history)
975 (set-buffer history-buffer)
976 (let ((keymap (make-sparse-keymap)))
977 (set-keymap-parent keymap (current-local-map))
978 (define-key keymap "\C-m" 'comint-dynamic-list-input-ring-select)
979 (use-local-map keymap))
981 (while (search-backward "completion" nil 'move)
982 (replace-match "history reference")))
984 (message "Hit space to flush")
985 (setq comint-dynamic-list-input-ring-window-conf conf)
986 (let ((ch (read-event)))
988 (set-window-configuration conf)
989 (setq unread-command-events (list ch)))))))
992 (defun comint-regexp-arg (prompt)
993 "Return list of regexp and prefix arg using PROMPT."
994 (let* (;; Don't clobber this.
995 (last-command last-command)
996 (regexp (read-from-minibuffer prompt nil nil nil
997 'minibuffer-history-search-history)))
998 (list (if (string-equal regexp "")
999 (setcar minibuffer-history-search-history
1000 (nth 1 minibuffer-history-search-history))
1002 (prefix-numeric-value current-prefix-arg))))
1004 (defun comint-search-arg (arg)
1005 ;; First make sure there is a ring and that we are after the process mark
1006 (cond ((not (comint-after-pmark-p))
1007 (error "Not at command line"))
1008 ((or (null comint-input-ring)
1009 (ring-empty-p comint-input-ring))
1010 (error "Empty input ring"))
1012 ;; arg of zero resets search from beginning, and uses arg of 1
1013 (setq comint-input-ring-index nil)
1018 (defun comint-search-start (arg)
1019 "Index to start a directional search, starting at `comint-input-ring-index'."
1020 (if comint-input-ring-index
1021 ;; If a search is running, offset by 1 in direction of arg
1022 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
1023 (ring-length comint-input-ring))
1024 ;; For a new search, start from beginning or end, as appropriate
1026 0 ; First elt for forward search
1027 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
1029 (defun comint-previous-input-string (arg)
1030 "Return the string ARG places along the input ring.
1031 Moves relative to `comint-input-ring-index'."
1032 (ring-ref comint-input-ring (if comint-input-ring-index
1033 (mod (+ arg comint-input-ring-index)
1034 (ring-length comint-input-ring))
1037 (defun comint-previous-input (arg)
1038 "Cycle backwards through input history."
1040 (comint-previous-matching-input "." arg))
1042 (defun comint-next-input (arg)
1043 "Cycle forwards through input history."
1045 (comint-previous-input (- arg)))
1047 (defun comint-previous-matching-input-string (regexp arg)
1048 "Return the string matching REGEXP ARG places along the input ring.
1049 Moves relative to `comint-input-ring-index'."
1050 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
1051 (if pos (ring-ref comint-input-ring pos))))
1053 (defun comint-previous-matching-input-string-position (regexp arg &optional start)
1054 "Return the index matching REGEXP ARG places along the input ring.
1055 Moves relative to START, or `comint-input-ring-index'."
1056 (if (or (not (ring-p comint-input-ring))
1057 (ring-empty-p comint-input-ring))
1058 (error "No history"))
1059 (let* ((len (ring-length comint-input-ring))
1060 (motion (if (> arg 0) 1 -1))
1061 (n (mod (- (or start (comint-search-start arg)) motion) len))
1062 (tried-each-ring-item nil)
1064 ;; Do the whole search as many times as the argument says.
1065 (while (and (/= arg 0) (not tried-each-ring-item))
1068 n (mod (+ n motion) len))
1069 ;; If we haven't reached a match, step some more.
1070 (while (and (< n len) (not tried-each-ring-item)
1071 (not (string-match regexp (ring-ref comint-input-ring n))))
1072 (setq n (mod (+ n motion) len)
1073 ;; If we have gone all the way around in this search.
1074 tried-each-ring-item (= n prev)))
1075 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1076 ;; Now that we know which ring element to use, if we found it, return that.
1077 (if (string-match regexp (ring-ref comint-input-ring n))
1080 (defun comint-previous-matching-input (regexp n)
1081 "Search backwards through input history for match for REGEXP.
1082 \(Previous history elements are earlier commands.)
1083 With prefix argument N, search for Nth previous match.
1084 If N is negative, find the next or Nth next match."
1085 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1086 (setq n (comint-search-arg n))
1087 (let ((pos (comint-previous-matching-input-string-position regexp n)))
1088 ;; Has a match been found?
1091 (setq comint-input-ring-index pos)
1092 (message "History item: %d" (1+ pos))
1094 ;; Can't use kill-region as it sets this-command
1095 (or (marker-position comint-accum-marker)
1096 (process-mark (get-buffer-process (current-buffer))))
1098 (insert (ring-ref comint-input-ring pos)))))
1100 (defun comint-next-matching-input (regexp n)
1101 "Search forwards through input history for match for REGEXP.
1102 \(Later history elements are more recent commands.)
1103 With prefix argument N, search for Nth following match.
1104 If N is negative, find the previous or Nth previous match."
1105 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1106 (comint-previous-matching-input regexp (- n)))
1108 (defun comint-previous-matching-input-from-input (n)
1109 "Search backwards through input history for match for current input.
1110 \(Previous history elements are earlier commands.)
1111 With prefix argument N, search for Nth previous match.
1112 If N is negative, search forwards for the -Nth following match."
1114 (if (not (memq last-command '(comint-previous-matching-input-from-input
1115 comint-next-matching-input-from-input)))
1116 ;; Starting a new search
1117 (setq comint-matching-input-from-input-string
1119 (or (marker-position comint-accum-marker)
1120 (process-mark (get-buffer-process (current-buffer))))
1122 comint-input-ring-index nil))
1123 (comint-previous-matching-input
1124 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1127 (defun comint-next-matching-input-from-input (n)
1128 "Search forwards through input history for match for current input.
1129 \(Following history elements are more recent commands.)
1130 With prefix argument N, search for Nth following match.
1131 If N is negative, search backwards for the -Nth previous match."
1133 (comint-previous-matching-input-from-input (- n)))
1136 (defun comint-replace-by-expanded-history (&optional silent start)
1137 "Expand input command history references before point.
1138 Expansion is dependent on the value of `comint-input-autoexpand'.
1140 This function depends on the buffer's idea of the input history, which may not
1141 match the command interpreter's idea, assuming it has one.
1143 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1144 cannot know the interpreter's idea of input line numbers, assuming it has one,
1145 it cannot expand absolute input line number references.
1147 If the optional argument SILENT is non-nil, never complain
1148 even if history reference seems erroneous.
1150 If the optional argument START is non-nil, that specifies the
1151 start of the text to scan for history references, rather
1152 than the logical beginning of line.
1154 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1156 Returns t if successful."
1158 (if (and comint-input-autoexpand
1159 (if comint-use-prompt-regexp
1160 ;; Use comint-prompt-regexp
1163 (looking-at (concat comint-prompt-regexp "!\\|\\^")))
1164 ;; Use input fields. User input that hasn't been entered
1165 ;; yet, at the end of the buffer, has a nil `field' property.
1166 (and (null (get-char-property (point) 'field))
1167 (string-match "!\\|^\\^" (field-string)))))
1168 ;; Looks like there might be history references in the command.
1169 (let ((previous-modified-tick (buffer-modified-tick)))
1170 (comint-replace-by-expanded-history-before-point silent start)
1171 (/= previous-modified-tick (buffer-modified-tick)))))
1174 (defun comint-replace-by-expanded-history-before-point (silent &optional start)
1175 "Expand directory stack reference before point.
1176 See `comint-replace-by-expanded-history'. Returns t if successful.
1178 If the optional argument START is non-nil, that specifies the
1179 start of the text to scan for history references, rather
1180 than the logical beginning of line."
1182 (let ((toend (- (line-end-position) (point)))
1183 (start (or start (comint-line-beginning-position))))
1186 (skip-chars-forward "^!^" (- (line-end-position) toend))
1187 (< (point) (- (line-end-position) toend)))
1188 ;; This seems a bit complex. We look for references such as !!, !-num,
1189 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1190 ;; If that wasn't enough, the plings can be suffixed with argument
1191 ;; range specifiers.
1192 ;; Argument ranges are complex too, so we hive off the input line,
1193 ;; referenced with plings, with the range string to `comint-args'.
1194 (setq comint-input-ring-index nil)
1195 (cond ((or (= (preceding-char) ?\\)
1196 (comint-within-quotes start (point)))
1197 ;; The history is quoted, or we're in quotes.
1198 (goto-char (1+ (point))))
1199 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1200 ;; We cannot know the interpreter's idea of input line numbers.
1201 (goto-char (match-end 0))
1202 (message "Absolute reference cannot be expanded"))
1203 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1204 ;; Just a number of args from `number' lines backward.
1205 (let ((number (1- (string-to-number
1206 (buffer-substring (match-beginning 1)
1208 (if (<= number (ring-length comint-input-ring))
1211 (comint-args (comint-previous-input-string number)
1212 (match-beginning 2) (match-end 2))
1214 (setq comint-input-ring-index number)
1215 (message "History item: %d" (1+ number)))
1216 (goto-char (match-end 0))
1217 (message "Relative reference exceeds input history size"))))
1218 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1219 ;; Just a number of args from the previous input line.
1221 (comint-args (comint-previous-input-string 0)
1222 (match-beginning 1) (match-end 1))
1224 (message "History item: previous"))
1226 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1227 ;; Most recent input starting with or containing (possibly
1228 ;; protected) string, maybe just a number of args. Phew.
1229 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1230 (mb2 (match-beginning 2)) (me2 (match-end 2))
1231 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1232 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1233 (pos (save-match-data
1234 (comint-previous-matching-input-string-position
1235 (concat pref (regexp-quote exp)) 1))))
1238 (goto-char (match-end 0))
1240 (progn (message "Not found")
1242 (setq comint-input-ring-index pos)
1244 (comint-args (ring-ref comint-input-ring pos)
1245 (match-beginning 4) (match-end 4))
1247 (message "History item: %d" (1+ pos)))))
1248 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1249 ;; Quick substitution on the previous input line.
1250 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1251 (new (buffer-substring (match-beginning 2) (match-end 2)))
1253 (replace-match (comint-previous-input-string 0) t t)
1255 (goto-char (match-beginning 0))
1256 (if (not (search-forward old pos t))
1258 (error "Not found"))
1259 (replace-match new t t)
1260 (message "History item: substituted"))))
1262 (forward-char 1)))))))
1265 (defun comint-magic-space (arg)
1266 "Expand input history references before point and insert ARG spaces.
1267 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1269 (comint-replace-by-expanded-history)
1270 (self-insert-command arg))
1272 (defun comint-within-quotes (beg end)
1273 "Return t if the number of quotes between BEG and END is odd.
1274 Quotes are single and double."
1275 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1276 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1277 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1279 (defun comint-how-many-region (regexp beg end)
1280 "Return number of matches for REGEXP from BEG to END."
1285 (while (re-search-forward regexp end t)
1286 (setq count (1+ count)))))
1289 (defun comint-args (string begin end)
1290 ;; From STRING, return the args depending on the range specified in the text
1291 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1292 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1295 (comint-arguments string 0 nil)
1296 (let* ((range (buffer-substring
1297 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1298 (nth (cond ((string-match "^[*^]" range) 1)
1299 ((string-match "^-" range) 0)
1300 ((string-equal range "$") nil)
1301 (t (string-to-number range))))
1302 (mth (cond ((string-match "[-*$]$" range) nil)
1303 ((string-match "-" range)
1304 (string-to-number (substring range (match-end 0))))
1306 (comint-arguments string nth mth)))))
1308 (defun comint-delim-arg (arg)
1309 "Return a list of arguments from ARG.
1310 Break it up at the delimiters in `comint-delimiter-argument-list'.
1311 Returned list is backwards."
1312 (if (null comint-delimiter-argument-list)
1318 (let ((char (aref arg pos))
1320 (if (memq char comint-delimiter-argument-list)
1321 (while (and (< pos len) (eq (aref arg pos) char))
1322 (setq pos (1+ pos)))
1323 (while (and (< pos len)
1324 (not (memq (aref arg pos)
1325 comint-delimiter-argument-list)))
1326 (setq pos (1+ pos))))
1327 (setq args (cons (substring arg start pos) args))))
1330 (defun comint-arguments (string nth mth)
1331 "Return from STRING the NTH to MTH arguments.
1332 NTH and/or MTH can be nil, which means the last argument.
1333 Returned arguments are separated by single spaces.
1334 We assume whitespace separates arguments, except within quotes
1335 and except for a space or tab that immediately follows a backslash.
1336 Also, a run of one or more of a single character
1337 in `comint-delimiter-argument-list' is a separate argument.
1338 Argument 0 is the command name."
1339 ;; The first line handles ordinary characters and backslash-sequences
1340 ;; (except with w32 msdos-like shells, where backslashes are valid).
1341 ;; The second matches "-quoted strings.
1342 ;; The third matches '-quoted strings.
1343 ;; The fourth matches `-quoted strings.
1344 ;; This seems to fit the syntax of BASH 2.0.
1345 (let* ((first (if (if (fboundp 'w32-shell-dos-semantics)
1346 (w32-shell-dos-semantics))
1348 "[^ \n\t\"'`\\]+\\|\\\\[\"'`\\ \t]+\\|"))
1349 (argpart (concat first
1350 "\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\
1356 ;; Build a list of all the args until we have as many as we want.
1357 (while (and (or (null mth) (<= count mth))
1358 (string-match argpart string pos))
1359 (if (and beg (= pos (match-beginning 0)))
1360 ;; It's contiguous, part of the same arg.
1361 (setq pos (match-end 0)
1362 quotes (or quotes (match-beginning 1)))
1363 ;; It's a new separate arg.
1365 ;; Put the previous arg, if there was one, onto ARGS.
1366 (setq str (substring string beg pos)
1367 args (if quotes (cons str args)
1368 (nconc (comint-delim-arg str) args))))
1369 (setq count (length args))
1370 (setq quotes (match-beginning 1))
1371 (setq beg (match-beginning 0))
1372 (setq pos (match-end 0))))
1374 (setq str (substring string beg pos)
1375 args (if quotes (cons str args)
1376 (nconc (comint-delim-arg str) args))))
1377 (setq count (length args))
1378 (let ((n (or nth (1- count)))
1379 (m (if mth (1- (- count mth)) 0)))
1381 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1384 ;; Input processing stuff
1386 (defun comint-add-to-input-history (cmd)
1387 "Add CMD to the input history.
1388 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1389 (if (and (funcall comint-input-filter cmd)
1390 (or (null comint-input-ignoredups)
1391 (not (ring-p comint-input-ring))
1392 (ring-empty-p comint-input-ring)
1393 (not (string-equal (ring-ref comint-input-ring 0)
1395 (ring-insert comint-input-ring cmd)))
1397 (defun comint-send-input (&optional no-newline artificial)
1398 "Send input to process.
1399 After the process output mark, sends all text from the process mark to
1400 point as input to the process. Before the process output mark, calls
1401 value of variable `comint-get-old-input' to retrieve old input, copies
1402 it to the process mark, and sends it.
1404 This command also sends and inserts a final newline, unless
1405 NO-NEWLINE is non-nil.
1407 Any history reference may be expanded depending on the value of the variable
1408 `comint-input-autoexpand'. The list of function names contained in the value
1409 of `comint-input-filter-functions' is called on the input before sending it.
1410 The input is entered into the input history ring, if the value of variable
1411 `comint-input-filter' returns non-nil when called on the input.
1413 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1414 end of line before sending the input.
1416 After the input has been sent, if `comint-process-echoes' is non-nil,
1417 then `comint-send-input' waits to see if the process outputs a string
1418 matching the input, and if so, deletes that part of the output.
1419 If ARTIFICIAL is non-nil, it inhibits such deletion.
1420 Callers sending input not from the user should use ARTIFICIAL = t.
1422 The values of `comint-get-old-input', `comint-input-filter-functions', and
1423 `comint-input-filter' are chosen according to the command interpreter running
1424 in the buffer. E.g.,
1426 If the interpreter is the csh,
1427 `comint-get-old-input' is the default:
1428 If `comint-use-prompt-regexp' is nil, then
1429 either return the current input field, if point is on an input
1430 field, or the current line, if point is on an output field.
1431 If `comint-use-prompt-regexp' is non-nil, then
1432 return the current line with any initial string matching the
1433 regexp `comint-prompt-regexp' removed.
1434 `comint-input-filter-functions' monitors input for \"cd\", \"pushd\", and
1435 \"popd\" commands. When it sees one, it cd's the buffer.
1436 `comint-input-filter' is the default: returns t if the input isn't all white
1439 If the Comint is Lucid Common Lisp,
1440 `comint-get-old-input' snarfs the sexp ending at point.
1441 `comint-input-filter-functions' does nothing.
1442 `comint-input-filter' returns nil if the input matches input-filter-regexp,
1443 which matches (1) all whitespace (2) :a, :c, etc.
1445 Similarly for Soar, Scheme, etc."
1447 ;; Note that the input string does not include its terminal newline.
1448 (let ((proc (get-buffer-process (current-buffer))))
1449 (if (not proc) (error "Current buffer has no process")
1450 (let* ((pmark (process-mark proc))
1451 (intxt (if (>= (point) (marker-position pmark))
1452 (progn (if comint-eol-on-send (end-of-line))
1453 (buffer-substring pmark (point)))
1454 (let ((copy (funcall comint-get-old-input)))
1458 (input (if (not (eq comint-input-autoexpand 'input))
1459 ;; Just whatever's already there
1461 ;; Expand and leave it visible in buffer
1462 (comint-replace-by-expanded-history t pmark)
1463 (buffer-substring pmark (point))))
1464 (history (if (not (eq comint-input-autoexpand 'history))
1466 ;; This is messy 'cos ultimately the original
1467 ;; functions used do insertion, rather than return
1468 ;; strings. We have to expand, then insert back.
1469 (comint-replace-by-expanded-history t pmark)
1470 (let ((copy (buffer-substring pmark (point)))
1473 (delete-region pmark start)
1479 (comint-add-to-input-history history)
1481 (run-hook-with-args 'comint-input-filter-functions
1482 (if no-newline input
1483 (concat input "\n")))
1485 (let ((beg (marker-position pmark))
1486 (end (if no-newline (point) (1- (point))))
1487 (inhibit-modification-hooks t))
1489 ;; Set text-properties for the input field
1490 (add-text-properties
1493 font-lock-face comint-highlight-input
1494 mouse-face highlight
1495 help-echo "mouse-2: insert after prompt as new input"))
1496 (unless comint-use-prompt-regexp
1497 ;; Give old user input a field property of `input', to
1498 ;; distinguish it from both process output and unsent
1499 ;; input. The terminating newline is put into a special
1500 ;; `boundary' field to make cursor movement between input
1501 ;; and output fields smoother.
1502 (put-text-property beg end 'field 'input)))
1503 (unless (or no-newline comint-use-prompt-regexp)
1504 ;; Cover the terminating newline
1505 (add-text-properties end (1+ end)
1508 inhibit-line-move-field-capture t))))
1510 (comint-snapshot-last-prompt)
1512 (setq comint-save-input-ring-index comint-input-ring-index)
1513 (setq comint-input-ring-index nil)
1514 ;; Update the markers before we send the input
1515 ;; in case we get output amidst sending the input.
1516 (set-marker comint-last-input-start pmark)
1517 (set-marker comint-last-input-end (point))
1518 (set-marker (process-mark proc) (point))
1519 ;; clear the "accumulation" marker
1520 (set-marker comint-accum-marker nil)
1521 (let ((comint-input-sender-no-newline no-newline))
1522 (funcall comint-input-sender proc input))
1524 ;; Optionally delete echoed input (after checking it).
1525 (when (and comint-process-echoes (not artificial))
1526 (let ((echo-len (- comint-last-input-end
1527 comint-last-input-start)))
1528 ;; Wait for all input to be echoed:
1529 (while (and (accept-process-output proc)
1530 (> (+ comint-last-input-end echo-len)
1533 (compare-buffer-substrings
1534 nil comint-last-input-start
1535 (- (point-max) echo-len)
1536 ;; Above difference is equivalent to
1537 ;; (+ comint-last-input-start
1538 ;; (- (point-max) comint-last-input-end))
1539 nil comint-last-input-end (point-max)))))
1541 (<= (+ comint-last-input-end echo-len)
1544 (compare-buffer-substrings
1545 nil comint-last-input-start comint-last-input-end
1546 nil comint-last-input-end
1547 (+ comint-last-input-end echo-len))))
1548 ;; Certain parts of the text to be deleted may have
1549 ;; been mistaken for prompts. We have to prevent
1550 ;; problems when `comint-prompt-read-only' is non-nil.
1551 (let ((inhibit-read-only t))
1552 (delete-region comint-last-input-end
1553 (+ comint-last-input-end echo-len))))))
1555 ;; This used to call comint-output-filter-functions,
1556 ;; but that scrolled the buffer in undesirable ways.
1557 (run-hook-with-args 'comint-output-filter-functions "")))))
1559 (defvar comint-preoutput-filter-functions nil
1560 "List of functions to call before inserting Comint output into the buffer.
1561 Each function gets one argument, a string containing the text received
1562 from the subprocess. It should return the string to insert, perhaps
1563 the same string that was received, or perhaps a modified or transformed
1566 The functions on the list are called sequentially, and each one is
1567 given the string returned by the previous one. The string returned by
1568 the last function is the text that is actually inserted in the
1571 You can use `add-hook' to add functions to this list
1572 either globally or locally.")
1574 (defvar comint-inhibit-carriage-motion nil
1575 "If nil, Comint will interpret `carriage control' characters in output.
1576 See `comint-carriage-motion' for details.")
1578 ;; When non-nil, this is an overlay over the last recognized prompt in
1579 ;; the buffer; it is used when highlighting the prompt.
1580 (defvar comint-last-prompt-overlay nil)
1582 (defun comint-snapshot-last-prompt ()
1583 "`snapshot' any current `comint-last-prompt-overlay'.
1584 Freeze its attributes in place, even when more input comes along
1585 and moves the prompt overlay."
1586 (when comint-last-prompt-overlay
1587 (let ((inhibit-read-only t)
1588 (inhibit-modification-hooks t))
1589 (add-text-properties (overlay-start comint-last-prompt-overlay)
1590 (overlay-end comint-last-prompt-overlay)
1591 (overlay-properties comint-last-prompt-overlay)))))
1593 (defun comint-carriage-motion (start end)
1594 "Interpret carriage control characters in the region from START to END.
1595 Translate carriage return/linefeed sequences to linefeeds.
1596 Make single carriage returns delete to the beginning of the line.
1597 Make backspaces delete the previous character."
1599 ;; First do a quick check to see if there are any applicable
1600 ;; characters, so we can avoid calling save-match-data and
1601 ;; save-restriction if not.
1603 (when (< (skip-chars-forward "^\b\r" end) (- end start))
1607 (let ((inhibit-field-text-motion t)
1608 (inhibit-read-only t))
1610 ;; Note that this won't work properly when the CR and LF
1611 ;; are in different output chunks, but this is probably an
1612 ;; exceedingly rare case (because they are generally
1613 ;; written as a unit), and to delay interpretation of a
1614 ;; trailing CR in a chunk would result in odd interactive
1615 ;; behavior (and this case is probably far more common).
1616 (while (re-search-forward "\r$" end t)
1618 ;; bare CR -> delete preceding line
1620 (while (search-forward "\r" end t)
1621 (delete-region (point) (line-beginning-position)))
1622 ;; BS -> delete preceding character
1624 (while (search-forward "\b" end t)
1625 (delete-char -2))))))))
1627 ;; The purpose of using this filter for comint processes
1628 ;; is to keep comint-last-input-end from moving forward
1629 ;; when output is inserted.
1630 (defun comint-output-filter (process string)
1631 (let ((oprocbuf (process-buffer process)))
1632 ;; First check for killed buffer or no input.
1633 (when (and string oprocbuf (buffer-name oprocbuf))
1634 (with-current-buffer oprocbuf
1635 ;; Run preoutput filters
1636 (let ((functions comint-preoutput-filter-functions))
1637 (while (and functions string)
1638 (if (eq (car functions) t)
1639 (let ((functions (default-value 'comint-preoutput-filter-functions)))
1640 (while (and functions string)
1641 (setq string (funcall (car functions) string))
1642 (setq functions (cdr functions))))
1643 (setq string (funcall (car functions) string)))
1644 (setq functions (cdr functions))))
1647 (let ((inhibit-read-only t)
1648 ;; Avoid the overhead of save-excursion, since we just
1649 ;; fiddle with the point
1650 (saved-point (point-marker)))
1652 ;; The point should float after any insertion we do
1653 (set-marker-insertion-type saved-point t)
1655 ;; We temporarly remove any buffer narrowing, in case the
1656 ;; process mark is outside of the restriction
1660 (goto-char (process-mark process))
1661 (set-marker comint-last-output-start (point))
1663 ;; insert-before-markers is a bad thing. XXX
1665 ;; It is used here to force window-point markers (used to
1666 ;; store the value of point in non-selected windows) to
1667 ;; advance, but it also screws up any other markers that we
1668 ;; don't _want_ to advance, such as the start-marker of some
1669 ;; of the overlays we create.
1671 ;; We work around the problem with the overlays by
1672 ;; explicitly adjusting them after we do the insertion, but
1673 ;; in the future this problem should be solved correctly, by
1674 ;; using `insert', and making the insertion-type of
1675 ;; window-point markers settable (via a buffer-local
1676 ;; variable). In comint buffers, this variable would be set
1677 ;; to `t', to cause point in non-select windows to advance.
1678 (insert-before-markers string)
1679 ;; Fixup markers and overlays that got screwed up because we
1680 ;; used `insert-before-markers'.
1681 (let ((old-point (- (point) (length string))))
1682 ;; comint-last-output-start
1683 (set-marker comint-last-output-start old-point)
1684 ;; comint-last-input-end
1685 (when (and comint-last-input-end
1686 (equal (marker-position comint-last-input-end)
1688 (set-marker comint-last-input-end old-point))
1689 ;; No overlays we create are set to advance upon insertion
1690 ;; (at the start/end), so we assume that any overlay which
1691 ;; is at the current point was incorrectly advanced by
1692 ;; insert-before-markers. First fixup overlays that might
1694 (dolist (over (overlays-at (point)))
1695 (when (= (overlay-start over) (point))
1696 (let ((end (overlay-end over)))
1699 (if (= end (point)) old-point end)))))
1700 ;; Then do overlays that might end at point:
1701 (dolist (over (overlays-at (1- (point))))
1702 (when (= (overlay-end over) (point))
1704 (min (overlay-start over) old-point)
1707 ;; Advance process-mark
1708 (set-marker (process-mark process) (point))
1710 (unless comint-inhibit-carriage-motion
1711 ;; Interpret any carriage motion characters (newline, backspace)
1712 (comint-carriage-motion comint-last-output-start (point)))
1714 ;; Run these hooks with point where the user had it.
1715 (goto-char saved-point)
1716 (run-hook-with-args 'comint-output-filter-functions string)
1717 (set-marker saved-point (point))
1719 (goto-char (process-mark process)) ; in case a filter moved it
1721 (unless comint-use-prompt-regexp
1722 (let ((inhibit-read-only t)
1723 (inhibit-modification-hooks t))
1724 (add-text-properties comint-last-output-start (point)
1727 inhibit-line-move-field-capture t))))
1729 ;; Highlight the prompt, where we define `prompt' to mean
1730 ;; the most recent output that doesn't end with a newline.
1731 (let ((prompt-start (save-excursion (forward-line 0) (point)))
1732 (inhibit-read-only t)
1733 (inhibit-modification-hooks t))
1734 (when comint-prompt-read-only
1735 (or (= (point-min) prompt-start)
1736 (get-text-property (1- prompt-start) 'read-only)
1738 (1- prompt-start) prompt-start 'read-only 'fence))
1739 (add-text-properties
1740 prompt-start (point)
1741 '(read-only t rear-nonsticky t front-sticky (read-only))))
1742 (unless (and (bolp) (null comint-last-prompt-overlay))
1743 ;; Need to create or move the prompt overlay (in the case
1744 ;; where there is no prompt ((bolp) == t), we still do
1745 ;; this if there's already an existing overlay).
1746 (if comint-last-prompt-overlay
1747 ;; Just move an existing overlay
1748 (move-overlay comint-last-prompt-overlay
1749 prompt-start (point))
1750 ;; Need to create the overlay
1751 (setq comint-last-prompt-overlay
1752 (make-overlay prompt-start (point)))
1753 (overlay-put comint-last-prompt-overlay
1754 'font-lock-face 'comint-highlight-prompt))))
1756 (goto-char saved-point)))))))
1758 (defun comint-preinput-scroll-to-bottom ()
1759 "Go to the end of buffer in all windows showing it.
1760 Movement occurs if point in the selected window is not after the process mark,
1761 and `this-command' is an insertion command. Insertion commands recognized
1762 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1763 Depends on the value of `comint-scroll-to-bottom-on-input'.
1765 This function should be a pre-command hook."
1766 (if (and comint-scroll-to-bottom-on-input
1767 (memq this-command '(self-insert-command comint-magic-space yank
1769 (let* ((selected (selected-window))
1770 (current (current-buffer))
1771 (process (get-buffer-process current))
1772 (scroll comint-scroll-to-bottom-on-input))
1773 (if (and process (< (point) (process-mark process)))
1774 (if (eq scroll 'this)
1775 (goto-char (point-max))
1777 (function (lambda (window)
1778 (if (and (eq (window-buffer window) current)
1779 (or (eq scroll t) (eq scroll 'all)))
1781 (select-window window)
1782 (goto-char (point-max))
1783 (select-window selected)))))
1786 (defun comint-postoutput-scroll-to-bottom (string)
1787 "Go to the end of buffer in some or all windows showing it.
1788 Does not scroll if the current line is the last line in the buffer.
1789 Depends on the value of `comint-move-point-for-output' and
1790 `comint-scroll-show-maximum-output'.
1792 This function should be in the list `comint-output-filter-functions'."
1793 (let* ((selected (selected-window))
1794 (current (current-buffer))
1795 (process (get-buffer-process current))
1796 (scroll comint-move-point-for-output))
1800 (function (lambda (window)
1801 (if (eq (window-buffer window) current)
1803 (select-window window)
1804 (if (and (< (point) (process-mark process))
1805 (or (eq scroll t) (eq scroll 'all)
1806 ;; Maybe user wants point to jump to end.
1807 (and (eq scroll 'this) (eq selected window))
1808 (and (eq scroll 'others) (not (eq selected window)))
1809 ;; If point was at the end, keep it at end.
1810 (and (marker-position comint-last-output-start)
1811 (>= (point) comint-last-output-start))))
1812 (goto-char (process-mark process)))
1813 ;; Optionally scroll so that the text
1814 ;; ends at the bottom of the window.
1815 (if (and comint-scroll-show-maximum-output
1816 (= (point) (point-max)))
1818 (goto-char (point-max))
1819 (recenter (- -1 scroll-margin))))
1820 (select-window selected)))))
1822 (set-buffer current))))
1824 (defun comint-truncate-buffer (&optional string)
1825 "Truncate the buffer to `comint-buffer-maximum-size'.
1826 This function could be on `comint-output-filter-functions' or bound to a key."
1829 (goto-char (process-mark (get-buffer-process (current-buffer))))
1830 (forward-line (- comint-buffer-maximum-size))
1832 (let ((inhibit-read-only t))
1833 (delete-region (point-min) (point)))))
1835 (defun comint-strip-ctrl-m (&optional string)
1836 "Strip trailing `^M' characters from the current output group.
1837 This function could be on `comint-output-filter-functions' or bound to a key."
1839 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1843 (if (interactive-p) comint-last-input-end comint-last-output-start))
1845 (while (re-search-forward "\r+$" pmark t)
1846 (replace-match "" t t)))))
1847 (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
1849 (defun comint-show-maximum-output ()
1850 "Put the end of the buffer at the bottom of the window."
1852 (goto-char (point-max))
1853 (recenter (- -1 scroll-margin)))
1855 (defun comint-get-old-input-default ()
1856 "Default for `comint-get-old-input'.
1857 If `comint-use-prompt-regexp' is nil, then either
1858 return the current input field, if point is on an input field, or the
1859 current line, if point is on an output field.
1860 If `comint-use-prompt-regexp' is non-nil, then return
1861 the current line with any initial string matching the regexp
1862 `comint-prompt-regexp' removed."
1863 (let ((bof (field-beginning)))
1864 (if (eq (get-char-property bof 'field) 'input)
1865 (field-string-no-properties bof)
1867 (buffer-substring-no-properties (point) (line-end-position)))))
1869 (defun comint-skip-prompt ()
1870 "Skip past the text matching regexp `comint-prompt-regexp'.
1871 If this takes us past the end of the current line, don't skip at all."
1872 (if (and (looking-at comint-prompt-regexp)
1873 (<= (match-end 0) (line-end-position)))
1874 (goto-char (match-end 0))))
1876 (defun comint-after-pmark-p ()
1877 "Return t if point is after the process output marker."
1878 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1879 (<= (marker-position pmark) (point))))
1881 (defun comint-simple-send (proc string)
1882 "Default function for sending to PROC input STRING.
1883 This just sends STRING plus a newline. To override this,
1884 set the hook `comint-input-sender'."
1885 (comint-send-string proc string)
1886 (if comint-input-sender-no-newline
1887 (if (not (string-equal string ""))
1889 (comint-send-string proc "\n")))
1891 (defun comint-line-beginning-position ()
1892 "Return the buffer position of the beginning of the line, after any prompt.
1893 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done by
1894 skipping text matching the regular expression `comint-prompt-regexp',
1895 a buffer local variable."
1896 (if comint-use-prompt-regexp
1897 ;; Use comint-prompt-regexp
1900 (comint-skip-prompt)
1902 ;; Use input fields. Note that, unlike the behavior of
1903 ;; `line-beginning-position' inside a field, this function will
1904 ;; return the position of the end of a prompt, even if the point is
1905 ;; already inside the prompt. In order to do this, it assumes that
1906 ;; if there are two fields on a line, then the first one is the
1907 ;; prompt, and the second one is an input field, and is front-sticky
1908 ;; (as input fields should be).
1909 (constrain-to-field (line-beginning-position) (line-end-position))))
1911 (defun comint-bol (&optional arg)
1912 "Go to the beginning of line, then skip past the prompt, if any.
1913 If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
1914 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done
1915 by skipping text matching the regular expression `comint-prompt-regexp',
1916 a buffer local variable."
1919 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1921 (goto-char (comint-line-beginning-position))))
1923 ;; For compatibility.
1924 (defun comint-read-noecho (prompt &optional ignore)
1925 (read-passwd prompt))
1927 ;; These three functions are for entering text you don't want echoed or
1928 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1929 ;; Just enter m-x send-invisible and type in your line.
1931 (defun send-invisible (&optional prompt)
1932 "Read a string without echoing.
1933 Then send it to the process running in the current buffer.
1934 The string is sent using `comint-input-sender'.
1935 Security bug: your string can still be temporarily recovered with
1936 \\[view-lossage]; `clear-this-command-keys' can fix that."
1937 (interactive "P") ; Defeat snooping via C-x ESC ESC
1938 (let ((proc (get-buffer-process (current-buffer)))
1940 (if (eq (window-buffer (selected-window)) (current-buffer))
1942 (format "(In buffer %s) "
1943 (current-buffer)))))
1945 (let ((str (read-passwd (concat prefix
1946 (or prompt "Non-echoed text: ")))))
1949 (comint-snapshot-last-prompt)
1950 (funcall comint-input-sender proc str))
1951 (message "Warning: text will be echoed")))
1952 (error "Buffer %s has no process" (current-buffer)))))
1954 (defun comint-watch-for-password-prompt (string)
1955 "Prompt in the minibuffer for password and send without echoing.
1956 This function uses `send-invisible' to read and send a password to the buffer's
1957 process if STRING contains a password prompt defined by
1958 `comint-password-prompt-regexp'.
1960 This function could be in the list `comint-output-filter-functions'."
1961 (when (string-match comint-password-prompt-regexp string)
1962 (when (string-match "^[ \n\r\t\v\f\b\a]+" string)
1963 (setq string (replace-match "" t t string)))
1964 (send-invisible string)))
1966 ;; Low-level process communication
1968 (defun comint-send-string (process string)
1969 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
1971 (with-current-buffer (if (processp process)
1972 (process-buffer process)
1973 (get-buffer process))
1974 (comint-snapshot-last-prompt))
1975 (comint-snapshot-last-prompt))
1976 (process-send-string process string))
1978 (defun comint-send-region (process start end)
1979 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
1981 (with-current-buffer (if (processp process)
1982 (process-buffer process)
1983 (get-buffer process))
1984 (comint-snapshot-last-prompt))
1985 (comint-snapshot-last-prompt))
1986 (process-send-region process start end))
1989 ;; Random input hackage
1991 (defun comint-delete-output ()
1992 "Delete all output from interpreter since last input.
1993 Does not delete the prompt."
1995 (let ((proc (get-buffer-process (current-buffer)))
1997 (inhibit-read-only t))
1999 (let ((pmark (progn (goto-char (process-mark proc))
2002 (delete-region comint-last-input-end pmark)
2003 (goto-char (process-mark proc))
2004 (setq replacement (concat "*** output flushed ***\n"
2005 (buffer-substring pmark (point))))
2006 (delete-region pmark (point))))
2007 ;; Output message and put back prompt
2008 (comint-output-filter proc replacement)))
2009 (define-obsolete-function-alias 'comint-kill-output
2010 'comint-delete-output "21.1")
2012 (defun comint-write-output (filename &optional append mustbenew)
2013 "Write output from interpreter since last input to FILENAME.
2014 Any prompt at the end of the output is not written.
2016 If the optional argument APPEND (the prefix argument when interactive)
2017 is non-nil, the output is appended to the file instead.
2019 If the optional argument MUSTBENEW is non-nil, check for an existing
2020 file with the same name. If MUSTBENEW is `excl', that means to get an
2021 error if the file already exists; never overwrite. If MUSTBENEW is
2022 neither nil nor `excl', that means ask for confirmation before
2023 overwriting, but do go ahead and overwrite the file if the user
2024 confirms. When interactive, MUSTBENEW is nil when appending, and t
2027 (list (read-file-name
2028 (if current-prefix-arg
2029 "Append output to file: "
2030 "Write output to file: "))
2032 (not current-prefix-arg)))
2034 (goto-char (process-mark (get-buffer-process (current-buffer))))
2036 (write-region comint-last-input-end (point) filename
2037 append nil nil mustbenew)))
2039 ;; This function exists for the benefit of the menu; from the keyboard,
2040 ;; users can just use `comint-write-output' with a prefix arg.
2041 (defun comint-append-output-to-file (filename)
2042 "Append output from interpreter since last input to FILENAME.
2043 Any prompt at the end of the output is not written."
2044 (interactive "fAppend output to file: ")
2045 (comint-write-output filename t))
2047 (defun comint-show-output ()
2048 "Display start of this batch of interpreter output at top of window.
2049 Sets mark to the value of point when this command is run."
2052 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
2053 (cond (comint-use-prompt-regexp
2055 (beginning-of-line 0)
2056 (set-window-start (selected-window) (point))
2057 (comint-skip-prompt))
2059 (goto-char (field-beginning pos))
2060 (set-window-start (selected-window) (point))))))
2063 (defun comint-interrupt-subjob ()
2064 "Interrupt the current subjob.
2065 This command also kills the pending input
2066 between the process mark and point."
2069 (interrupt-process nil comint-ptyp)
2070 ;; (process-send-string nil "\n")
2073 (defun comint-kill-subjob ()
2074 "Send kill signal to the current subjob.
2075 This command also kills the pending input
2076 between the process mark and point."
2079 (kill-process nil comint-ptyp))
2081 (defun comint-quit-subjob ()
2082 "Send quit signal to the current subjob.
2083 This command also kills the pending input
2084 between the process mark and point."
2087 (quit-process nil comint-ptyp))
2089 (defun comint-stop-subjob ()
2090 "Stop the current subjob.
2091 This command also kills the pending input
2092 between the process mark and point.
2094 WARNING: if there is no current subjob, you can end up suspending
2095 the top-level process running in the buffer. If you accidentally do
2096 this, use \\[comint-continue-subjob] to resume the process. (This
2097 is not a problem with most shells, since they ignore this signal.)"
2100 (stop-process nil comint-ptyp))
2102 (defun comint-continue-subjob ()
2103 "Send CONT signal to process buffer's process group.
2104 Useful if you accidentally suspend the top-level process."
2106 (continue-process nil comint-ptyp))
2108 (defun comint-skip-input ()
2109 "Skip all pending input, from last stuff output by interpreter to point.
2110 This means mark it as if it had been sent as input, without sending it."
2111 (let ((comint-input-sender 'ignore)
2112 (comint-input-filter-functions nil))
2113 (comint-send-input t t))
2116 (marker (process-mark (get-buffer-process (current-buffer)))))
2117 (insert " " (key-description (this-command-keys)))
2119 (set-marker marker (point)))))
2121 (defun comint-kill-input ()
2122 "Kill all text from last stuff output by interpreter to point."
2124 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2125 (if (> (point) (marker-position pmark))
2126 (kill-region pmark (point)))))
2128 (defun comint-delchar-or-maybe-eof (arg)
2129 "Delete ARG characters forward or send an EOF to subprocess.
2130 Sends an EOF only if point is at the end of the buffer and there is no input."
2132 (let ((proc (get-buffer-process (current-buffer))))
2133 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
2135 (delete-char arg))))
2137 (defun comint-send-eof ()
2138 "Send an EOF to the current buffer's process."
2140 (comint-send-input t t)
2144 (defun comint-backward-matching-input (regexp n)
2145 "Search backward through buffer for input fields that match REGEXP.
2146 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2147 by lines that match `comint-prompt-regexp'.
2149 With prefix argument N, search for Nth previous match.
2150 If N is negative, find the next or Nth next match."
2151 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2152 (if comint-use-prompt-regexp
2153 ;; Use comint-prompt-regexp
2154 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2155 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2156 (if (re-search-backward re nil t n)
2159 (progn (message "Not found")
2164 (let* ((dir (if (< n 0) -1 1))
2168 (unless (re-search-backward regexp nil t dir)
2169 (error "Not found"))
2170 (when (eq (get-char-property (point) 'field) 'input)
2171 (setq n (- n dir))))
2172 (field-beginning))))
2176 (defun comint-forward-matching-input (regexp n)
2177 "Search forward through buffer for input fields that match REGEXP.
2178 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2179 by lines that match `comint-prompt-regexp'.
2181 With prefix argument N, search for Nth following match.
2182 If N is negative, find the previous or Nth previous match."
2183 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2184 (comint-backward-matching-input regexp (- n)))
2187 (defun comint-next-prompt (n)
2188 "Move to end of Nth next prompt in the buffer.
2189 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2190 the Nth next `input' field, otherwise, it means the Nth occurrence of
2191 text matching `comint-prompt-regexp'."
2193 (if comint-use-prompt-regexp
2194 ;; Use comint-prompt-regexp
2195 (let ((paragraph-start comint-prompt-regexp))
2196 (end-of-line (if (> n 0) 1 0))
2197 (forward-paragraph n)
2198 (comint-skip-prompt))
2207 (next-single-char-property-change pos 'field)
2208 (previous-single-char-property-change pos 'field)))
2209 (cond ((or (null pos) (= pos prev-pos))
2210 ;; Ran off the end of the buffer.
2212 ;; There's always an input field at the end of the
2213 ;; buffer, but it has a `field' property of nil.
2214 (setq input-pos (point-max)))
2217 ((eq (get-char-property pos 'field) 'input)
2218 (setq n (if (< n 0) (1+ n) (1- n)))
2219 (setq input-pos pos))))
2221 (goto-char input-pos)))))
2224 (defun comint-previous-prompt (n)
2225 "Move to end of Nth previous prompt in the buffer.
2226 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2227 the Nth previous `input' field, otherwise, it means the Nth occurrence of
2228 text matching `comint-prompt-regexp'."
2230 (comint-next-prompt (- n)))
2232 ;; State used by `comint-insert-previous-argument' when cycling.
2233 (defvar comint-insert-previous-argument-last-start-pos nil)
2234 (make-variable-buffer-local 'comint-insert-previous-argument-last-start-pos)
2235 (defvar comint-insert-previous-argument-last-index nil)
2236 (make-variable-buffer-local 'comint-insert-previous-argument-last-index)
2239 ;; make comint-arguments understand negative indices as bash does
2240 (defun comint-insert-previous-argument (index)
2241 "Insert the INDEXth argument from the previous Comint command-line at point.
2242 Spaces are added at beginning and/or end of the inserted string if
2243 necessary to ensure that it's separated from adjacent arguments.
2244 Interactively, if no prefix argument is given, the last argument is inserted.
2245 Repeated interactive invocations will cycle through the same argument
2246 from progressively earlier commands (using the value of INDEX specified
2247 with the first command).
2248 This command is like `M-.' in bash."
2250 (unless (null index)
2251 (setq index (prefix-numeric-value index)))
2252 (cond ((eq last-command this-command)
2253 ;; Delete last input inserted by this command.
2254 (delete-region comint-insert-previous-argument-last-start-pos (point))
2255 (setq index comint-insert-previous-argument-last-index))
2257 ;; This is a non-repeat invocation, so initialize state.
2258 (setq comint-input-ring-index nil)
2259 (setq comint-insert-previous-argument-last-index index)
2260 (when (null comint-insert-previous-argument-last-start-pos)
2261 ;; First usage; initialize to a marker
2262 (setq comint-insert-previous-argument-last-start-pos
2264 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2265 (if (<= (point) (comint-line-beginning-position))
2268 ;; Remember the beginning of what we insert, so we can delete it if
2269 ;; the command is repeated.
2270 (set-marker comint-insert-previous-argument-last-start-pos (point))
2271 ;; Insert the argument.
2272 (let ((input-string (comint-previous-input-string 0)))
2273 (when (string-match "[ \t\n]*&" input-string)
2274 ;; strip terminating '&'
2275 (setq input-string (substring input-string 0 (match-beginning 0))))
2276 (insert (comint-arguments input-string index index)))
2277 ;; Make next invocation return arg from previous input
2278 (setq comint-input-ring-index (1+ (or comint-input-ring-index 0)))
2279 ;; Add a terminating space if necessary.
2284 ;; Support editing with `comint-prompt-read-only' set to t.
2286 (defun comint-update-fence ()
2287 "Update read-only status of newline before point.
2288 The `fence' read-only property is used to indicate that a newline
2289 is read-only for no other reason than to \"fence off\" a
2290 following front-sticky read-only region. This is used to
2291 implement comint read-only prompts. If the text after a newline
2292 changes, the read-only status of that newline may need updating.
2293 That is what this function does.
2295 This function does nothing if point is not at the beginning of a
2296 line, or is at the beginning of the accessible portion of the buffer.
2297 Otherwise, if the character after point has a front-sticky
2298 read-only property, then the preceding newline is given a
2299 read-only property of `fence', unless it already is read-only.
2300 If the character after point does not have a front-sticky
2301 read-only property, any read-only property of `fence' on the
2302 preceding newline is removed."
2303 (let* ((pt (point)) (lst (get-text-property pt 'front-sticky))
2304 (inhibit-modification-hooks t))
2307 (if (and (get-text-property pt 'read-only)
2308 (if (listp lst) (memq 'read-only lst) t))
2309 (unless (get-text-property (1- pt) 'read-only)
2310 (put-text-property (1- pt) pt 'read-only 'fence))
2311 (when (eq (get-text-property (1- pt) 'read-only) 'fence)
2312 (remove-list-of-text-properties (1- pt) pt '(read-only)))))))
2314 (defun comint-kill-whole-line (&optional arg)
2315 "Kill current line, ignoring read-only and field properties.
2316 With prefix arg, kill that many lines starting from the current line.
2317 If arg is negative, kill backward. Also kill the preceding newline,
2318 instead of the trailing one. \(This is meant to make \\[repeat] work well
2319 with negative arguments.)
2320 If arg is zero, kill current line but exclude the trailing newline.
2321 The read-only status of newlines is updated with `comint-update-fence',
2324 (let ((inhibit-read-only t) (inhibit-field-text-motion t))
2325 (kill-whole-line arg)
2326 (when (>= arg 0) (comint-update-fence))))
2328 (defun comint-kill-region (beg end &optional yank-handler)
2329 "Like `kill-region', but ignores read-only properties, if safe.
2330 This command assumes that the buffer contains read-only
2331 \"prompts\" which are regions with front-sticky read-only
2332 properties at the beginning of a line, with the preceding newline
2333 being read-only to protect the prompt. This is true of the
2334 comint prompts if `comint-prompt-read-only' is non-nil. This
2335 command will not delete the region if this would create mutilated
2336 or out of place prompts. That is, if any part of a prompt is
2337 deleted, the entire prompt must be deleted and all remaining
2338 prompts should stay at the beginning of a line. If this is not
2339 the case, this command just calls `kill-region' with all
2340 read-only properties intact. The read-only status of newlines is
2341 updated using `comint-update-fence', if necessary."
2344 (let* ((true-beg (min beg end))
2345 (true-end (max beg end))
2346 (beg-bolp (progn (goto-char true-beg) (bolp)))
2347 (beg-lst (get-text-property true-beg 'front-sticky))
2348 (beg-bad (and (get-text-property true-beg 'read-only)
2349 (if (listp beg-lst) (memq 'read-only beg-lst) t)))
2350 (end-bolp (progn (goto-char true-end) (bolp)))
2351 (end-lst (get-text-property true-end 'front-sticky))
2352 (end-bad (and (get-text-property true-end 'read-only)
2353 (if (listp end-lst) (memq 'read-only end-lst) t))))
2354 (if (or (and (not beg-bolp) (or beg-bad end-bad))
2355 (and (not end-bolp) end-bad))
2356 (kill-region beg end yank-handler)
2357 (let ((inhibit-read-only t))
2358 (kill-region beg end yank-handler)
2359 (comint-update-fence))))))
2362 ;; Support for source-file processing commands.
2363 ;;============================================================================
2364 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2365 ;; commands that process files of source text (e.g. loading or compiling
2366 ;; files). So the corresponding process-in-a-buffer modes have commands
2367 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2368 ;; for defining these commands.
2370 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2371 ;; and Soar, in that they don't know anything about file extensions.
2372 ;; So the compile/load interface gets the wrong default occasionally.
2373 ;; The load-file/compile-file default mechanism could be smarter -- it
2374 ;; doesn't know about the relationship between filename extensions and
2375 ;; whether the file is source or executable. If you compile foo.lisp
2376 ;; with compile-file, then the next load-file should use foo.bin for
2377 ;; the default, not foo.lisp. This is tricky to do right, particularly
2378 ;; because the extension for executable files varies so much (.o, .bin,
2379 ;; .lbin, .mo, .vo, .ao, ...).
2382 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2385 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2386 ;; want to save the buffer before issuing any process requests to the command
2389 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2390 ;; for the file to process.
2392 (defun comint-source-default (previous-dir/file source-modes)
2393 "Compute the defaults for `load-file' and `compile-file' commands.
2395 PREVIOUS-DIR/FILE is a pair (DIRECTORY . FILENAME) from the last
2396 source-file processing command, or nil if there hasn't been one yet.
2397 SOURCE-MODES is a list used to determine what buffers contain source
2398 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2399 Typically, (lisp-mode) or (scheme-mode).
2401 If the command is given while the cursor is inside a string, *and*
2402 the string is an existing filename, *and* the filename is not a directory,
2403 then the string is taken as default. This allows you to just position
2404 your cursor over a string that's a filename and have it taken as default.
2406 If the command is given in a file buffer whose major mode is in
2407 SOURCE-MODES, then the filename is the default file, and the
2408 file's directory is the default directory.
2410 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2411 then the default directory & file are what was used in the last source-file
2412 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2413 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2414 is the cwd, with no default file. (\"no default file\" = nil)
2416 SOURCE-MODES is typically going to be something like (tea-mode)
2417 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2418 for Soar programs, etc.
2420 The function returns a pair: (default-directory . default-file)."
2421 (cond ((and buffer-file-name (memq major-mode source-modes))
2422 (cons (file-name-directory buffer-file-name)
2423 (file-name-nondirectory buffer-file-name)))
2426 (cons default-directory nil))))
2429 (defun comint-check-source (fname)
2430 "Check whether to save buffers visiting file FNAME.
2431 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2432 process-in-a-buffer modes), this function can be called on the filename.
2433 If the file is loaded into a buffer, and the buffer is modified, the user
2434 is queried to see if he wants to save the buffer before proceeding with
2435 the load or compile."
2436 (let ((buff (get-file-buffer fname)))
2438 (buffer-modified-p buff)
2439 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
2441 (let ((old-buffer (current-buffer)))
2444 (set-buffer old-buffer)))))
2446 (defun comint-extract-string ()
2447 "Return string around point, or nil."
2448 (let ((syntax (syntax-ppss)))
2449 (when (nth 3 syntax)
2451 (buffer-substring-no-properties (1+ (nth 8 syntax))
2452 (progn (goto-char (nth 8 syntax))
2457 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2458 "Prompt for filenames in commands that process source files,
2459 e.g. loading or compiling a file.
2460 Provides a default, if there is one, and returns the result filename.
2462 See `comint-source-default' for more on determining defaults.
2464 PROMPT is the prompt string. PREV-DIR/FILE is the (DIRECTORY . FILE) pair
2465 from the last source processing command. SOURCE-MODES is a list of major
2466 modes used to determine what file buffers contain source files. (These
2467 two arguments are used for determining defaults.) If MUSTMATCH-P is true,
2468 then the filename reader will only accept a file that exists.
2471 (interactive (comint-get-source \"Compile file: \" prev-lisp-dir/file
2473 (let* ((def (comint-source-default prev-dir/file source-modes))
2474 (stringfile (comint-extract-string))
2475 (sfile-p (and stringfile
2477 (file-exists-p stringfile)
2479 (not (file-directory-p stringfile))))
2480 (defdir (if sfile-p (file-name-directory stringfile)
2482 (deffile (if sfile-p (file-name-nondirectory stringfile)
2484 (ans (read-file-name (if deffile (format "%s(default %s) "
2488 (concat defdir deffile)
2490 (list (expand-file-name (substitute-in-file-name ans)))))
2492 ;; I am somewhat divided on this string-default feature. It seems
2493 ;; to violate the principle-of-least-astonishment, in that it makes
2494 ;; the default harder to predict, so you actually have to look and see
2495 ;; what the default really is before choosing it. This can trip you up.
2496 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2501 ;; Simple process query facility.
2502 ;; ===========================================================================
2503 ;; This function is for commands that want to send a query to the process
2504 ;; and show the response to the user. For example, a command to get the
2505 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2506 ;; to an inferior Common Lisp process.
2508 ;; This simple facility just sends strings to the inferior process and pops
2509 ;; up a window for the process buffer so you can see what the process
2510 ;; responds with. We don't do anything fancy like try to intercept what the
2511 ;; process responds with and put it in a pop-up window or on the message
2512 ;; line. We just display the buffer. Low tech. Simple. Works good.
2514 (defun comint-proc-query (proc str)
2515 "Send to the inferior process PROC the string STR.
2516 Pop-up but do not select a window for the inferior process so that
2517 its response can be seen."
2518 (let* ((proc-buf (process-buffer proc))
2519 (proc-mark (process-mark proc)))
2520 (display-buffer proc-buf)
2521 (set-buffer proc-buf) ; but it's not the selected *window*
2522 (let ((proc-win (get-buffer-window proc-buf))
2523 (proc-pt (marker-position proc-mark)))
2524 (comint-send-string proc str) ; send the query
2525 (accept-process-output proc) ; wait for some output
2526 ;; Try to position the proc window so you can see the answer.
2527 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2528 ;; I don't know why. Wizards invited to improve it.
2529 (unless (pos-visible-in-window-p proc-pt proc-win)
2530 (let ((opoint (window-point proc-win)))
2531 (set-window-point proc-win proc-mark)
2533 (if (not (pos-visible-in-window-p opoint proc-win))
2535 (set-window-point proc-win opoint)))))))
2538 ;; Filename/command/history completion in a buffer
2539 ;; ===========================================================================
2540 ;; Useful completion functions, courtesy of the Ergo group.
2543 ;; comint-dynamic-complete Complete or expand command, filename,
2544 ;; history at point.
2545 ;; comint-dynamic-complete-filename Complete filename at point.
2546 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2547 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2548 ;; replace with expanded/completed name.
2549 ;; comint-dynamic-simple-complete Complete stub given candidates.
2551 ;; These are not installed in the comint-mode keymap. But they are
2552 ;; available for people who want them. Shell-mode installs them:
2553 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2554 ;; (define-key shell-mode-map "\M-?"
2555 ;; 'comint-dynamic-list-filename-completions)))
2557 ;; Commands like this are fine things to put in load hooks if you
2558 ;; want them present in specific modes.
2560 (defcustom comint-completion-autolist nil
2561 "*If non-nil, automatically list possibilities on partial completion.
2562 This mirrors the optional behavior of tcsh."
2564 :group 'comint-completion)
2566 (defcustom comint-completion-addsuffix t
2567 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2568 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2569 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2570 This mirrors the optional behavior of tcsh."
2571 :type '(choice (const :tag "None" nil)
2572 (const :tag "Add /" t)
2573 (cons :tag "Suffix pair"
2574 (string :tag "Directory suffix")
2575 (string :tag "File suffix")))
2576 :group 'comint-completion)
2578 (defcustom comint-completion-recexact nil
2579 "*If non-nil, use shortest completion if characters cannot be added.
2580 This mirrors the optional behavior of tcsh.
2582 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2584 :group 'comint-completion)
2586 (defcustom comint-completion-fignore nil
2587 "*List of suffixes to be disregarded during file completion.
2588 This mirrors the optional behavior of bash and tcsh.
2590 Note that this applies to `comint-dynamic-complete-filename' only."
2591 :type '(repeat (string :tag "Suffix"))
2592 :group 'comint-completion)
2595 (defvar comint-file-name-prefix ""
2596 "Prefix prepended to absolute file names taken from process input.
2597 This is used by Comint's and shell's completion functions, and by shell's
2598 directory tracking functions.")
2600 (defvar comint-file-name-chars
2601 (if (memq system-type '(ms-dos windows-nt cygwin))
2602 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2603 "[]~/A-Za-z0-9+@:_.$#%,={}-")
2604 "String of characters valid in a file name.
2605 Note that all non-ASCII characters are considered valid in a file name
2606 regardless of what this variable says.
2608 This is a good thing to set in mode hooks.")
2610 (defvar comint-file-name-quote-list nil
2611 "List of characters to quote with `\\' when in a file name.
2613 This is a good thing to set in mode hooks.")
2616 (defun comint-directory (directory)
2617 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
2618 (expand-file-name (if (file-name-absolute-p directory)
2619 (concat comint-file-name-prefix directory)
2623 (defun comint-word (word-chars)
2624 "Return the word of WORD-CHARS at point, or nil if none is found.
2625 Word constituents are considered to be those in WORD-CHARS, which is like the
2626 inside of a \"[...]\" (see `skip-chars-forward'), plus all non-ASCII characters."
2628 (let ((here (point))
2631 (let ((startpoint (point)))
2632 (skip-chars-backward (concat "\\\\" word-chars))
2633 ;; Fixme: This isn't consistent with Bash, at least -- not
2634 ;; all non-ASCII chars should be word constituents.
2635 (if (and (> (- (point) 2) (point-min))
2636 (= (char-after (- (point) 2)) ?\\))
2638 (if (and (> (- (point) 1) (point-min))
2639 (>= (char-after (- (point) 1)) 128))
2641 (if (= (point) startpoint)
2643 ;; Set match-data to match the entire string.
2644 (when (< (point) here)
2645 (set-match-data (list (point) here))
2646 (match-string 0)))))
2648 (defun comint-substitute-in-file-name (filename)
2649 "Return FILENAME with environment variables substituted.
2650 Supports additional environment variable syntax of the command
2651 interpreter (e.g., the percent notation of cmd.exe on NT)."
2652 (let ((name (substitute-in-file-name filename)))
2653 (if (memq system-type '(ms-dos windows-nt))
2657 (while (string-match "%\\([^\\\\/]*\\)%" name)
2659 (substring name (match-beginning 1) (match-end 1)))
2660 (setq env-var-val (if (getenv env-var-name)
2661 (getenv env-var-name)
2663 (setq name (replace-match env-var-val t t name))))))
2666 (defun comint-match-partial-filename ()
2667 "Return the filename at point, or nil if non is found.
2668 Environment variables are substituted. See `comint-word'."
2669 (let ((filename (comint-word comint-file-name-chars)))
2670 (and filename (comint-substitute-in-file-name
2671 (comint-unquote-filename filename)))))
2674 (defun comint-quote-filename (filename)
2675 "Return FILENAME with magic characters quoted.
2676 Magic characters are those in `comint-file-name-quote-list'."
2677 (if (null comint-file-name-quote-list)
2681 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
2684 (while (string-match regexp filename i)
2685 (setq filename (replace-match "\\\\\\&" nil nil filename))
2686 (setq i (1+ (match-end 0)))))
2689 (defun comint-unquote-filename (filename)
2690 "Return FILENAME with quoted characters unquoted."
2691 (if (null comint-file-name-quote-list)
2695 (while (string-match "\\\\\\(.\\)" filename i)
2696 (setq filename (replace-match "\\1" nil nil filename))
2697 (setq i (+ 1 (match-beginning 0)))))
2701 (defun comint-dynamic-complete ()
2702 "Dynamically perform completion at point.
2703 Calls the functions in `comint-dynamic-complete-functions' to perform
2704 completion until a function returns non-nil, at which point completion is
2705 assumed to have occurred."
2707 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
2710 (defun comint-dynamic-complete-filename ()
2711 "Dynamically complete the filename at point.
2712 Completes if after a filename. See `comint-match-partial-filename' and
2713 `comint-dynamic-complete-as-filename'.
2714 This function is similar to `comint-replace-by-expanded-filename', except that
2715 it won't change parts of the filename already entered in the buffer; it just
2716 adds completion characters to the end of the filename. A completions listing
2717 may be shown in a help buffer if completion is ambiguous.
2719 Completion is dependent on the value of `comint-completion-addsuffix',
2720 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2721 completions listing is dependent on the value of `comint-completion-autolist'.
2723 Returns t if successful."
2725 (when (comint-match-partial-filename)
2726 (unless (window-minibuffer-p (selected-window))
2727 (message "Completing file name..."))
2728 (comint-dynamic-complete-as-filename)))
2730 (defun comint-dynamic-complete-as-filename ()
2731 "Dynamically complete at point as a filename.
2732 See `comint-dynamic-complete-filename'. Returns t if successful."
2733 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2734 (completion-ignored-extensions comint-completion-fignore)
2735 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2736 ;; I think it was originally bound to solve file completion problems,
2737 ;; but subsequent changes may have made this unnecessary. sm.
2738 ;;(file-name-handler-alist nil)
2739 (minibuffer-p (window-minibuffer-p (selected-window)))
2741 (dirsuffix (cond ((not comint-completion-addsuffix)
2743 ((not (consp comint-completion-addsuffix))
2746 (car comint-completion-addsuffix))))
2747 (filesuffix (cond ((not comint-completion-addsuffix)
2749 ((not (consp comint-completion-addsuffix))
2752 (cdr comint-completion-addsuffix))))
2753 (filename (or (comint-match-partial-filename) ""))
2754 (filedir (file-name-directory filename))
2755 (filenondir (file-name-nondirectory filename))
2756 (directory (if filedir (comint-directory filedir) default-directory))
2757 (completion (file-name-completion filenondir directory)))
2758 (cond ((null completion)
2759 (message "No completions of %s" filename)
2761 ((eq completion t) ; Means already completed "file".
2763 (unless minibuffer-p
2764 (message "Sole completion")))
2765 ((string-equal completion "") ; Means completion on "directory/".
2766 (comint-dynamic-list-filename-completions))
2767 (t ; Completion string returned.
2768 (let ((file (concat (file-name-as-directory directory) completion)))
2769 (insert (comint-quote-filename
2770 (substring (directory-file-name completion)
2771 (length filenondir))))
2772 (cond ((symbolp (file-name-completion completion directory))
2773 ;; We inserted a unique completion.
2774 (insert (if (file-directory-p file) dirsuffix filesuffix))
2775 (unless minibuffer-p
2776 (message "Completed")))
2777 ((and comint-completion-recexact comint-completion-addsuffix
2778 (string-equal filenondir completion)
2779 (file-exists-p file))
2780 ;; It's not unique, but user wants shortest match.
2781 (insert (if (file-directory-p file) dirsuffix filesuffix))
2782 (unless minibuffer-p
2783 (message "Completed shortest")))
2784 ((or comint-completion-autolist
2785 (string-equal filenondir completion))
2786 ;; It's not unique, list possible completions.
2787 (comint-dynamic-list-filename-completions))
2789 (unless minibuffer-p
2790 (message "Partially completed")))))))
2794 (defun comint-replace-by-expanded-filename ()
2795 "Dynamically expand and complete the filename at point.
2796 Replace the filename with an expanded, canonicalized and completed replacement.
2797 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
2798 with the corresponding directories. \"Canonicalized\" means `..' and `.' are
2799 removed, and the filename is made absolute instead of relative. For expansion
2800 see `expand-file-name' and `substitute-in-file-name'. For completion see
2801 `comint-dynamic-complete-filename'."
2803 (let ((filename (comint-match-partial-filename)))
2805 (replace-match (expand-file-name filename) t t)
2806 (comint-dynamic-complete-filename))))
2809 (defun comint-dynamic-simple-complete (stub candidates)
2810 "Dynamically complete STUB from CANDIDATES list.
2811 This function inserts completion characters at point by completing STUB from
2812 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2813 if completion is ambiguous.
2815 Returns nil if no completion was inserted.
2816 Returns `sole' if completed with the only completion match.
2817 Returns `shortest' if completed with the shortest of the completion matches.
2818 Returns `partial' if completed as far as possible with the completion matches.
2819 Returns `listed' if a completion listing was shown.
2821 See also `comint-dynamic-complete-filename'."
2822 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2823 (suffix (cond ((not comint-completion-addsuffix) "")
2824 ((not (consp comint-completion-addsuffix)) " ")
2825 (t (cdr comint-completion-addsuffix))))
2826 (completions (all-completions stub candidates)))
2827 (cond ((null completions)
2828 (message "No completions of %s" stub)
2830 ((= 1 (length completions)) ; Gotcha!
2831 (let ((completion (car completions)))
2832 (if (string-equal completion stub)
2833 (message "Sole completion")
2834 (insert (substring completion (length stub)))
2835 (message "Completed"))
2838 (t ; There's no unique completion.
2839 (let ((completion (try-completion stub candidates)))
2840 ;; Insert the longest substring.
2841 (insert (substring completion (length stub)))
2842 (cond ((and comint-completion-recexact comint-completion-addsuffix
2843 (string-equal stub completion)
2844 (member completion completions))
2845 ;; It's not unique, but user wants shortest match.
2847 (message "Completed shortest")
2849 ((or comint-completion-autolist
2850 (string-equal stub completion))
2851 ;; It's not unique, list possible completions.
2852 (comint-dynamic-list-completions completions)
2855 (message "Partially completed")
2859 (defun comint-dynamic-list-filename-completions ()
2860 "List in help buffer possible completions of the filename at point."
2862 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2863 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2864 ;; I think it was originally bound to solve file completion problems,
2865 ;; but subsequent changes may have made this unnecessary. sm.
2866 ;;(file-name-handler-alist nil)
2867 (filename (or (comint-match-partial-filename) ""))
2868 (filedir (file-name-directory filename))
2869 (filenondir (file-name-nondirectory filename))
2870 (directory (if filedir (comint-directory filedir) default-directory))
2871 (completions (file-name-all-completions filenondir directory)))
2872 (if (not completions)
2873 (message "No completions of %s" filename)
2874 (comint-dynamic-list-completions
2875 (mapcar 'comint-quote-filename completions)))))
2878 ;; This is bound locally in a *Completions* buffer to the list of
2879 ;; completions displayed, and is used to detect the case where the same
2880 ;; command is repeatedly used without the set of completions changing.
2881 (defvar comint-displayed-dynamic-completions nil)
2883 (defvar comint-dynamic-list-completions-config nil)
2885 (defun comint-dynamic-list-completions (completions)
2886 "List in help buffer sorted COMPLETIONS.
2887 Typing SPC flushes the help buffer."
2888 (let ((window (get-buffer-window "*Completions*")))
2889 (setq completions (sort completions 'string-lessp))
2890 (if (and (eq last-command this-command)
2891 window (window-live-p window) (window-buffer window)
2892 (buffer-name (window-buffer window))
2893 ;; The above tests are not sufficient to detect the case where we
2894 ;; should scroll, because the top-level interactive command may
2895 ;; not have displayed a completions window the last time it was
2896 ;; invoked, and there may be such a window left over from a
2897 ;; previous completion command with a different set of
2898 ;; completions. To detect that case, we also test that the set
2899 ;; of displayed completions is in fact the same as the previously
2902 (buffer-local-value 'comint-displayed-dynamic-completions
2903 (window-buffer window))))
2904 ;; If this command was repeated, and
2905 ;; there's a fresh completion window with a live buffer,
2906 ;; and this command is repeated, scroll that window.
2907 (with-current-buffer (window-buffer window)
2908 (if (pos-visible-in-window-p (point-max) window)
2909 (set-window-start window (point-min))
2910 (save-selected-window
2911 (select-window window)
2914 ;; Display a completion list for the first time.
2915 (setq comint-dynamic-list-completions-config
2916 (current-window-configuration))
2917 (with-output-to-temp-buffer "*Completions*"
2918 (display-completion-list completions))
2919 (message "Type space to flush; repeat completion command to scroll"))
2921 ;; Read the next key, to process SPC.
2923 (if (with-current-buffer (get-buffer "*Completions*")
2924 (set (make-local-variable 'comint-displayed-dynamic-completions)
2926 (setq key (read-key-sequence nil)
2928 (and (consp first) (consp (event-start first))
2929 (eq (window-buffer (posn-window (event-start first)))
2930 (get-buffer "*Completions*"))
2931 (eq (key-binding key) 'mouse-choose-completion)))
2932 ;; If the user does mouse-choose-completion with the mouse,
2933 ;; execute the command, then delete the completion window.
2935 (mouse-choose-completion first)
2936 (set-window-configuration comint-dynamic-list-completions-config))
2937 (unless (eq first ?\s)
2938 (setq unread-command-events (listify-key-sequence key)))
2939 (unless (eq first ?\t)
2940 (set-window-configuration comint-dynamic-list-completions-config))))))
2943 (defun comint-get-next-from-history ()
2944 "After fetching a line from input history, this fetches the following line.
2945 In other words, this recalls the input line after the line you recalled last.
2946 You can use this to repeat a sequence of input lines."
2948 (if comint-save-input-ring-index
2950 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
2951 (comint-next-input 1))
2952 (message "No previous history command")))
2954 (defun comint-accumulate ()
2955 "Accumulate a line to send as input along with more lines.
2956 This inserts a newline so that you can enter more text
2957 to be sent along with this line. Use \\[comint-send-input]
2958 to send all the accumulated input, at once.
2959 The entire accumulated text becomes one item in the input history
2963 (set-marker comint-accum-marker (point))
2964 (if comint-input-ring-index
2965 (setq comint-save-input-ring-index
2966 (- comint-input-ring-index 1))))
2968 (defun comint-goto-process-mark ()
2969 "Move point to the process mark.
2970 The process mark separates output, and input already sent,
2971 from input that has not yet been sent."
2973 (let ((proc (or (get-buffer-process (current-buffer))
2974 (error "Current buffer has no process"))))
2975 (goto-char (process-mark proc))
2976 (when (interactive-p)
2977 (message "Point is now at the process mark"))))
2979 (defun comint-bol-or-process-mark ()
2980 "Move point to beginning of line (after prompt) or to the process mark.
2981 The first time you use this command, it moves to the beginning of the line
2982 \(but after the prompt, if any). If you repeat it again immediately,
2983 it moves point to the process mark.
2985 The process mark separates the process output, along with input already sent,
2986 from input that has not yet been sent. Ordinarily, the process mark
2987 is at the beginning of the current input line; but if you have
2988 used \\[comint-accumulate] to send multiple lines at once,
2989 the process mark is at the beginning of the accumulated input."
2991 (if (not (eq last-command 'comint-bol-or-process-mark))
2993 (comint-goto-process-mark)))
2995 (defun comint-set-process-mark ()
2996 "Set the process mark at point."
2998 (let ((proc (or (get-buffer-process (current-buffer))
2999 (error "Current buffer has no process"))))
3000 (set-marker (process-mark proc) (point))
3001 (message "Process mark set")))
3004 ;; Author: Peter Breton <pbreton@cs.umb.edu>
3006 ;; This little add-on for comint is intended to make it easy to get
3007 ;; output from currently active comint buffers into another buffer,
3008 ;; or buffers, and then go back to using the comint shell.
3010 ;; My particular use is SQL interpreters; I want to be able to execute a
3011 ;; query using the process associated with a comint-buffer, and save that
3012 ;; somewhere else. Because the process might have state (for example, it
3013 ;; could be in an uncommitted transaction), just running starting a new
3014 ;; process and having it execute the query and then finish, would not
3015 ;; work. I'm sure there are other uses as well, although in many cases
3016 ;; starting a new process is the simpler, and thus preferable, approach.
3018 ;; The basic implementation is as follows: comint-redirect changes the
3019 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
3020 ;; its own filter. The filter puts the output into the designated buffer,
3021 ;; or buffers, until it sees a regexp that tells it to stop (by default,
3022 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
3023 ;; sees the stop regexp, it restores the old filter functions, and runs
3024 ;; `comint-redirect-hook'.
3026 ;; Each comint buffer may only use one redirection at a time, but any number
3027 ;; of different comint buffers may be simultaneously redirected.
3029 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
3030 ;; correct prompt for your interpreter, or that you supply a regexp that says
3031 ;; when the redirection is finished. Otherwise, redirection will continue
3032 ;; indefinitely. The code now does a sanity check to ensure that it can find
3033 ;; a prompt in the comint buffer; however, it is still important to ensure that
3034 ;; this prompt is set correctly.
3036 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
3037 ;; perhaps it should prompt for a terminating string (with an
3038 ;; appropriate magic default by examining what we think is the prompt)?
3040 ;; Fixme: look for appropriate fields, rather than regexp, if
3041 ;; `comint-use-prompt-regexp' is true.
3043 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3045 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3047 (defcustom comint-redirect-verbose nil
3048 "*If non-nil, print messages each time the redirection filter is invoked.
3049 Also print a message when redirection is completed."
3053 ;; Directly analagous to comint-preoutput-filter-functions
3054 (defvar comint-redirect-filter-functions nil
3055 "List of functions to call before inserting redirected process output.
3056 Each function gets one argument, a string containing the text received
3057 from the subprocess. It should return the string to insert, perhaps
3058 the same string that was received, or perhaps a modified or transformed
3061 The functions on the list are called sequentially, and each one is given
3062 the string returned by the previous one. The string returned by the
3063 last function is the text that is actually inserted in the redirection buffer.
3065 You can use `add-hook' to add functions to this list
3066 either globally or locally.")
3068 ;; Internal variables
3070 (defvar comint-redirect-output-buffer nil
3071 "The buffer or list of buffers to put output into.")
3073 (defvar comint-redirect-finished-regexp nil
3074 "Regular expression that determines when to stop redirection in Comint.
3075 When the redirection filter function is given output that matches this regexp,
3076 the output is inserted as usual, and redirection is completed.")
3078 (defvar comint-redirect-insert-matching-regexp nil
3079 "If non-nil, the text that ends a redirection is included in it.
3080 More precisely, the text that matches `comint-redirect-finished-regexp'
3081 and therefore terminates an output redirection is inserted in the
3082 redirection target buffer, along with the preceding output.")
3084 (defvar comint-redirect-echo-input nil
3085 "Non-nil means echo input in the process buffer even during redirection.")
3087 (defvar comint-redirect-completed nil
3088 "Non-nil if redirection has completed in the current buffer.")
3090 (defvar comint-redirect-original-mode-line-process nil
3091 "Original mode line for redirected process.")
3093 (defvar comint-redirect-perform-sanity-check t
3094 "If non-nil, check that redirection is likely to complete successfully.
3095 More precisely, before starting a redirection, verify that the
3096 regular expression `comint-redirect-finished-regexp' that controls
3097 when to terminate it actually matches some text already in the process
3098 buffer. The idea is that this regular expression should match a prompt
3099 string, and that there ought to be at least one copy of your prompt string
3100 in the process buffer already.")
3102 (defvar comint-redirect-original-filter-function nil
3103 "The process filter that was in place when redirection is started.
3104 When redirection is completed, the process filter is restored to
3107 (defvar comint-redirect-subvert-readonly nil
3108 "Non-nil means comint-redirect can insert into otherwise-readonly buffers.
3109 The readonly status is toggled around insertion.
3110 This is useful, for instance, for insertion into Help mode buffers.
3111 You probably want to set it locally to the output buffer.")
3113 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3115 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3117 (defun comint-redirect-setup (output-buffer
3120 &optional echo-input)
3121 "Set up for output redirection.
3122 This function sets local variables that are used by `comint-redirect-filter'
3123 to perform redirection.
3125 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3126 in the output matches FINISHED-REGEXP.
3128 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3129 original Comint buffer.
3131 This function is called by `comint-redirect-send-command-to-process',
3132 and does not normally need to be invoked by the end user or programmer."
3133 (with-current-buffer comint-buffer
3135 (make-local-variable 'comint-redirect-original-mode-line-process)
3136 (setq comint-redirect-original-mode-line-process mode-line-process)
3138 (make-local-variable 'comint-redirect-output-buffer)
3139 (setq comint-redirect-output-buffer output-buffer)
3141 (make-local-variable 'comint-redirect-finished-regexp)
3142 (setq comint-redirect-finished-regexp finished-regexp)
3144 (make-local-variable 'comint-redirect-echo-input)
3145 (setq comint-redirect-echo-input echo-input)
3147 (make-local-variable 'comint-redirect-completed)
3148 (setq comint-redirect-completed nil)
3150 (setq mode-line-process
3151 (if mode-line-process
3152 (list (concat (elt mode-line-process 0) " Redirection"))
3153 (list ":%s Redirection")))))
3155 (defun comint-redirect-cleanup ()
3156 "End a Comint redirection. See `comint-redirect-send-command'."
3158 ;; Restore the process filter
3159 (set-process-filter (get-buffer-process (current-buffer))
3160 comint-redirect-original-filter-function)
3161 ;; Restore the mode line
3162 (setq mode-line-process comint-redirect-original-mode-line-process)
3163 ;; Set the completed flag
3164 (setq comint-redirect-completed t))
3166 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3167 ;; that it really occurs.
3168 (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
3170 (defun comint-redirect-filter (process input-string)
3171 "Filter function which redirects output from PROCESS to a buffer or buffers.
3172 The variable `comint-redirect-output-buffer' says which buffer(s) to
3175 INPUT-STRING is the input from the Comint process.
3177 This function runs as a process filter, and does not need to be invoked by the
3180 (with-current-buffer (process-buffer process)
3181 (comint-redirect-preoutput-filter input-string)
3182 ;; If we have to echo output, give it to the original filter function
3183 (and comint-redirect-echo-input
3184 comint-redirect-original-filter-function
3185 (funcall comint-redirect-original-filter-function
3186 process input-string)))))
3189 (defun comint-redirect-preoutput-filter (input-string)
3190 "Comint filter function which redirects Comint output to a buffer or buffers.
3191 The variable `comint-redirect-output-buffer' says which buffer(s) to
3194 INPUT-STRING is the input from the Comint process.
3196 This function does not need to be invoked by the end user."
3197 (let ((output-buffer-list
3198 (if (listp comint-redirect-output-buffer)
3199 comint-redirect-output-buffer
3200 (list comint-redirect-output-buffer)))
3201 (filtered-input-string input-string))
3203 ;; If there are any filter functions, give them a chance to modify the string
3204 (let ((functions comint-redirect-filter-functions))
3205 (while (and functions filtered-input-string)
3206 (if (eq (car functions) t)
3207 ;; If a local value says "use the default value too",
3209 (let ((functions (default-value 'comint-redirect-filter-functions)))
3210 (while (and functions filtered-input-string)
3211 (setq filtered-input-string
3212 (funcall (car functions) filtered-input-string))
3213 (setq functions (cdr functions))))
3214 (setq filtered-input-string
3215 (funcall (car functions) filtered-input-string)))
3216 (setq functions (cdr functions))))
3218 ;; Clobber `comint-redirect-finished-regexp'
3219 (or comint-redirect-insert-matching-regexp
3220 (and (string-match comint-redirect-finished-regexp filtered-input-string)
3221 (setq filtered-input-string
3222 (replace-match "" nil nil filtered-input-string))))
3224 ;; Send output to all registered buffers
3226 (dolist (buf output-buffer-list)
3227 ;; Set this buffer to the output buffer
3228 (set-buffer (get-buffer-create buf))
3229 ;; Go to the end of the buffer
3230 (goto-char (point-max))
3231 ;; Insert the output
3232 (let ((inhibit-read-only comint-redirect-subvert-readonly))
3233 (insert filtered-input-string))))
3236 (and comint-redirect-verbose
3237 (message "Redirected output to buffer(s) %s"
3238 (mapconcat 'identity output-buffer-list " ")))
3240 ;; If we see the prompt, tidy up
3241 ;; We'll look for the prompt in the original string, so nobody can
3243 (and (string-match comint-redirect-finished-regexp input-string)
3245 (and comint-redirect-verbose
3246 (message "Redirection completed"))
3247 (comint-redirect-cleanup)
3248 (run-hooks 'comint-redirect-hook)))
3250 (if comint-redirect-echo-input
3251 filtered-input-string
3255 (defun comint-redirect-send-command (command output-buffer echo &optional no-display)
3256 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3257 With prefix arg ECHO, echo output in process buffer.
3259 If NO-DISPLAY is non-nil, do not show the output buffer."
3260 (interactive "sCommand: \nBOutput Buffer: \nP")
3261 (let ((process (get-buffer-process (current-buffer))))
3263 (comint-redirect-send-command-to-process
3264 command output-buffer (current-buffer) echo no-display)
3265 (error "No process for current buffer"))))
3268 (defun comint-redirect-send-command-to-process
3269 (command output-buffer process echo &optional no-display)
3270 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3271 With prefix arg, echo output in process buffer.
3273 If NO-DISPLAY is non-nil, do not show the output buffer."
3274 (interactive "sCommand: \nBOutput Buffer: \nbProcess Buffer: \nP")
3275 (let* (;; The process buffer
3276 (process-buffer (if (processp process)
3277 (process-buffer process)
3279 (proc (get-buffer-process process-buffer)))
3280 ;; Change to the process buffer
3281 (with-current-buffer process-buffer
3283 ;; Make sure there's a prompt in the current process buffer
3284 (and comint-redirect-perform-sanity-check
3286 (goto-char (point-max))
3287 (or (re-search-backward comint-prompt-regexp nil t)
3288 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3290 ;;;;;;;;;;;;;;;;;;;;;
3291 ;; Set up for redirection
3292 ;;;;;;;;;;;;;;;;;;;;;
3293 (comint-redirect-setup
3299 comint-prompt-regexp
3303 ;;;;;;;;;;;;;;;;;;;;;
3305 ;;;;;;;;;;;;;;;;;;;;;
3306 ;; Save the old filter
3307 (setq comint-redirect-original-filter-function
3308 (process-filter proc))
3309 (set-process-filter proc 'comint-redirect-filter)
3311 ;;;;;;;;;;;;;;;;;;;;;
3313 ;;;;;;;;;;;;;;;;;;;;;
3314 (process-send-string
3316 (concat command "\n"))
3318 ;;;;;;;;;;;;;;;;;;;;;
3320 ;;;;;;;;;;;;;;;;;;;;;
3324 (if (listp output-buffer)
3326 output-buffer)))))))
3329 (defun comint-redirect-results-list (command regexp regexp-group)
3330 "Send COMMAND to current process.
3331 Return a list of expressions in the output which match REGEXP.
3332 REGEXP-GROUP is the regular expression group in REGEXP to use."
3333 (comint-redirect-results-list-from-process
3334 (get-buffer-process (current-buffer))
3335 command regexp regexp-group))
3338 (defun comint-redirect-results-list-from-process (process command regexp regexp-group)
3339 "Send COMMAND to PROCESS.
3340 Return a list of expressions in the output which match REGEXP.
3341 REGEXP-GROUP is the regular expression group in REGEXP to use."
3342 (let ((output-buffer " *Comint Redirect Work Buffer*")
3345 (set-buffer (get-buffer-create output-buffer))
3347 (comint-redirect-send-command-to-process command
3348 output-buffer process nil t)
3349 ;; Wait for the process to complete
3350 (set-buffer (process-buffer process))
3351 (while (null comint-redirect-completed)
3352 (accept-process-output nil 1))
3353 ;; Collect the output
3354 (set-buffer output-buffer)
3355 (goto-char (point-min))
3356 ;; Skip past the command, if it was echoed
3357 (and (looking-at command)
3359 (while (re-search-forward regexp nil t)
3361 (cons (buffer-substring-no-properties
3362 (match-beginning regexp-group)
3363 (match-end regexp-group))
3368 (add-to-list 'debug-ignored-errors x))
3369 '("^Not at command line$"
3370 "^Empty input ring$"
3372 "^Not found$" ; Too common?
3373 "^Current buffer has no process$"))
3376 ;; Converting process modes to use comint mode
3377 ;; ===========================================================================
3378 ;; The code in the Emacs 19 distribution has all been modified to use comint
3379 ;; where needed. However, there are `third-party' packages out there that
3380 ;; still use the old shell mode. Here's a guide to conversion.
3382 ;; Renaming variables
3383 ;; Most of the work is renaming variables and functions. These are the common
3386 ;; last-input-start comint-last-input-start
3387 ;; last-input-end comint-last-input-end
3388 ;; shell-prompt-pattern comint-prompt-regexp
3389 ;; shell-set-directory-error-hook <no equivalent>
3391 ;; shell-set-directory <unnecessary>
3392 ;; shell-mode-map comint-mode-map
3394 ;; shell-send-input comint-send-input
3395 ;; shell-send-eof comint-delchar-or-maybe-eof
3396 ;; kill-shell-input comint-kill-input
3397 ;; interrupt-shell-subjob comint-interrupt-subjob
3398 ;; stop-shell-subjob comint-stop-subjob
3399 ;; quit-shell-subjob comint-quit-subjob
3400 ;; kill-shell-subjob comint-kill-subjob
3401 ;; kill-output-from-shell comint-delete-output
3402 ;; show-output-from-shell comint-show-output
3403 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3405 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3406 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3407 ;; Comint mode does not provide functionality equivalent to
3408 ;; shell-set-directory-error-hook; it is gone.
3410 ;; comint-last-input-start is provided for modes which want to munge
3411 ;; the buffer after input is sent, perhaps because the inferior
3412 ;; insists on echoing the input. The LAST-INPUT-START variable in
3413 ;; the old shell package was used to implement a history mechanism,
3414 ;; but you should think twice before using comint-last-input-start
3415 ;; for this; the input history ring often does the job better.
3417 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3418 ;; *not* create the comint-mode local variables in your foo-mode function.
3419 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3420 ;; necessary comint-specific local variables. Then create the
3421 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3422 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3423 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3424 ;; get-old-input) that need to be different from the defaults. Call
3425 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3426 ;; comint-mode will take care of it. The following example, from shell.el,
3429 ;; (defvar shell-mode-map '())
3430 ;; (cond ((not shell-mode-map)
3431 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3432 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3433 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3434 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3435 ;; (define-key shell-mode-map "\M-?"
3436 ;; 'comint-dynamic-list-filename-completions)))
3438 ;; (defun shell-mode ()
3441 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3442 ;; (setq major-mode 'shell-mode)
3443 ;; (setq mode-name "Shell")
3444 ;; (use-local-map shell-mode-map)
3445 ;; (make-local-variable 'shell-directory-stack)
3446 ;; (setq shell-directory-stack nil)
3447 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3448 ;; (run-mode-hooks 'shell-mode-hook))
3451 ;; Completion for comint-mode users
3453 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3454 ;; hook to add completion functions to. Functions on this list should return
3455 ;; non-nil if completion occurs (i.e., further completion should not occur).
3456 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3462 ;; arch-tag: 1793314c-09db-40be-9549-9aeae3e75164
3463 ;;; comint.el ends here