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., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, 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 recognise 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-instead-of-fields' 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 recognise 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\\) passphrase\\)\
342 \\( 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-instead-of-fields'.")
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.")
376 (defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom comint-watch-for-password-prompt)
377 "Functions to call after output is inserted into the buffer.
378 One possible function is `comint-postoutput-scroll-to-bottom'.
379 These functions get one argument, a string containing the text as originally
380 inserted. Note that this might not be the same as the buffer contents between
381 `comint-last-output-start' and the buffer's `process-mark', if other filter
382 functions have already modified the buffer.
384 See also `comint-preoutput-filter-functions'.
386 You can use `add-hook' to add functions to this list
387 either globally or locally.")
389 (defvar comint-input-sender-no-newline nil
390 "Non-nil directs the `comint-input-sender' function not to send a newline.")
392 (defvar comint-input-sender (function comint-simple-send)
393 "Function to actually send to PROCESS the STRING submitted by user.
394 Usually this is just `comint-simple-send', but if your mode needs to
395 massage the input string, put a different function here.
396 `comint-simple-send' just sends the string plus a newline.
397 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
398 This is called from the user command `comint-send-input'.")
400 (defcustom comint-eol-on-send t
401 "*Non-nil means go to the end of the line before sending input.
402 See `comint-send-input'."
406 ;; Note: If it is decided to purge comint-prompt-regexp from the source
407 ;; entirely, searching for uses of this variable will help to identify
408 ;; places that need attention.
409 (defcustom comint-use-prompt-regexp-instead-of-fields nil
410 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
411 If nil, then program output and user-input are given different `field'
412 properties, which Emacs commands can use to distinguish them (in
413 particular, common movement commands such as begining-of-line respect
414 field boundaries in a natural way)."
418 (defcustom comint-mode-hook '(turn-on-font-lock)
419 "Hook run upon entry to `comint-mode'.
420 This is run before the process is cranked up."
424 (defcustom comint-exec-hook '()
425 "Hook run each time a process is exec'd by `comint-exec'.
426 This is called after the process is cranked up. It is useful for things that
427 must be done each time a process is executed in a Comint mode buffer (e.g.,
428 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
429 executed once when the buffer is created."
433 (defvar comint-mode-map
434 (let ((map (make-sparse-keymap)))
436 (define-key map "\ep" 'comint-previous-input)
437 (define-key map "\en" 'comint-next-input)
438 (define-key map [C-up] 'comint-previous-input)
439 (define-key map [C-down] 'comint-next-input)
440 (define-key map "\er" 'comint-previous-matching-input)
441 (define-key map "\es" 'comint-next-matching-input)
442 (define-key map [?\C-c ?\M-r] 'comint-previous-matching-input-from-input)
443 (define-key map [?\C-c ?\M-s] 'comint-next-matching-input-from-input)
444 (define-key map "\e\C-l" 'comint-show-output)
445 (define-key map "\C-m" 'comint-send-input)
446 (define-key map "\C-d" 'comint-delchar-or-maybe-eof)
447 (define-key map "\C-c " 'comint-accumulate)
448 (define-key map "\C-c\C-x" 'comint-get-next-from-history)
449 (define-key map "\C-c\C-a" 'comint-bol-or-process-mark)
450 (define-key map "\C-c\C-u" 'comint-kill-input)
451 (define-key map "\C-c\C-w" 'backward-kill-word)
452 (define-key map "\C-c\C-c" 'comint-interrupt-subjob)
453 (define-key map "\C-c\C-z" 'comint-stop-subjob)
454 (define-key map "\C-c\C-\\" 'comint-quit-subjob)
455 (define-key map "\C-c\C-m" 'comint-insert-input)
456 (define-key map "\C-c\C-o" 'comint-delete-output)
457 (define-key map "\C-c\C-r" 'comint-show-output)
458 (define-key map "\C-c\C-e" 'comint-show-maximum-output)
459 (define-key map "\C-c\C-l" 'comint-dynamic-list-input-ring)
460 (define-key map "\C-c\C-n" 'comint-next-prompt)
461 (define-key map "\C-c\C-p" 'comint-previous-prompt)
462 (define-key map "\C-c\C-d" 'comint-send-eof)
463 (define-key map "\C-c\C-s" 'comint-write-output)
464 (define-key map "\C-c." 'comint-insert-previous-argument)
466 (define-key map [mouse-2] 'comint-insert-input)
469 (define-key map [menu-bar completion]
470 (cons "Complete" (make-sparse-keymap "Complete")))
471 (define-key map [menu-bar completion complete-expand]
472 '("Expand File Name" . comint-replace-by-expanded-filename))
473 (define-key map [menu-bar completion complete-listing]
474 '("File Completion Listing" . comint-dynamic-list-filename-completions))
475 (define-key map [menu-bar completion complete-file]
476 '("Complete File Name" . comint-dynamic-complete-filename))
477 (define-key map [menu-bar completion complete]
478 '("Complete Before Point" . comint-dynamic-complete))
480 (define-key map [menu-bar inout]
481 (cons "In/Out" (make-sparse-keymap "In/Out")))
482 (define-key map [menu-bar inout delete-output]
483 '("Delete Current Output Group" . comint-delete-output))
484 (define-key map [menu-bar inout append-output-to-file]
485 '("Append Current Output Group to File" . comint-append-output-to-file))
486 (define-key map [menu-bar inout write-output]
487 '("Write Current Output Group to File" . comint-write-output))
488 (define-key map [menu-bar inout next-prompt]
489 '("Forward Output Group" . comint-next-prompt))
490 (define-key map [menu-bar inout previous-prompt]
491 '("Backward Output Group" . comint-previous-prompt))
492 (define-key map [menu-bar inout show-maximum-output]
493 '("Show Maximum Output" . comint-show-maximum-output))
494 (define-key map [menu-bar inout show-output]
495 '("Show Current Output Group" . comint-show-output))
496 (define-key map [menu-bar inout kill-input]
497 '("Kill Current Input" . comint-kill-input))
498 (define-key map [menu-bar inout copy-input]
499 '("Copy Old Input" . comint-insert-input))
500 (define-key map [menu-bar inout forward-matching-history]
501 '("Forward Matching Input..." . comint-forward-matching-input))
502 (define-key map [menu-bar inout backward-matching-history]
503 '("Backward Matching Input..." . comint-backward-matching-input))
504 (define-key map [menu-bar inout next-matching-history]
505 '("Next Matching Input..." . comint-next-matching-input))
506 (define-key map [menu-bar inout previous-matching-history]
507 '("Previous Matching Input..." . comint-previous-matching-input))
508 (define-key map [menu-bar inout next-matching-history-from-input]
509 '("Next Matching Current Input" . comint-next-matching-input-from-input))
510 (define-key map [menu-bar inout previous-matching-history-from-input]
511 '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
512 (define-key map [menu-bar inout next-history]
513 '("Next Input" . comint-next-input))
514 (define-key map [menu-bar inout previous-history]
515 '("Previous Input" . comint-previous-input))
516 (define-key map [menu-bar inout list-history]
517 '("List Input History" . comint-dynamic-list-input-ring))
518 (define-key map [menu-bar inout expand-history]
519 '("Expand History Before Point" . comint-replace-by-expanded-history))
521 (let ((signals-map (make-sparse-keymap "Signals")))
522 (define-key map [menu-bar signals] (cons "Signals" signals-map))
523 (define-key signals-map [eof] '("EOF" . comint-send-eof))
524 (define-key signals-map [kill] '("KILL" . comint-kill-subjob))
525 (define-key signals-map [quit] '("QUIT" . comint-quit-subjob))
526 (define-key signals-map [cont] '("CONT" . comint-continue-subjob))
527 (define-key signals-map [stop] '("STOP" . comint-stop-subjob))
528 (define-key signals-map [break] '("BREAK" . comint-interrupt-subjob)))
529 ;; Put them in the menu bar:
530 (setq menu-bar-final-items (append '(completion inout signals)
531 menu-bar-final-items))
534 ;; Fixme: Is this still relevant?
535 (defvar comint-ptyp t
536 "Non-nil if communications via pty; false if by pipe. Buffer local.
537 This is to work around a bug in Emacs process signaling.")
539 (defvar comint-input-ring nil)
540 (defvar comint-last-input-start nil)
541 (defvar comint-last-input-end nil)
542 (defvar comint-last-output-start nil)
543 (defvar comint-input-ring-index nil
544 "Index of last matched history element.")
545 (defvar comint-matching-input-from-input-string ""
546 "Input previously used to match input history.")
547 (defvar comint-save-input-ring-index
548 "Last input ring index which you copied.
549 This is to support the command \\[comint-get-next-from-history].")
551 (defvar comint-accum-marker nil
552 "Non-nil if you are accumulating input lines to send as input together.
553 The command \\[comint-accumulate] sets this.")
555 (put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
556 (put 'comint-input-ring 'permanent-local t)
557 (put 'comint-input-ring-index 'permanent-local t)
558 (put 'comint-save-input-ring-index 'permanent-local t)
559 (put 'comint-input-autoexpand 'permanent-local t)
560 (put 'comint-input-filter-functions 'permanent-local t)
561 (put 'comint-output-filter-functions 'permanent-local t)
562 (put 'comint-preoutput-filter-functions 'permanent-local t)
563 (put 'comint-scroll-to-bottom-on-input 'permanent-local t)
564 (put 'comint-move-point-for-output 'permanent-local t)
565 (put 'comint-scroll-show-maximum-output 'permanent-local t)
566 (put 'comint-ptyp 'permanent-local t)
568 (put 'comint-mode 'mode-class 'special)
570 (define-derived-mode comint-mode fundamental-mode "Comint"
571 "Major mode for interacting with an inferior interpreter.
572 Interpreter name is same as buffer name, sans the asterisks.
573 Return at end of buffer sends line as input.
574 Return not at end copies rest of line to end and sends it.
575 Setting variable `comint-eol-on-send' means jump to the end of the line
576 before submitting new input.
578 This mode is customised to create major modes such as Inferior Lisp
579 mode, Shell mode, etc. This can be done by setting the hooks
580 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
581 and `comint-get-old-input' to appropriate functions, and the variable
582 `comint-prompt-regexp' to the appropriate regular expression.
584 An input history is maintained of size `comint-input-ring-size', and
585 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
586 Input ring history expansion can be achieved with the commands
587 \\[comint-replace-by-expanded-history] or \\[comint-magic-space].
588 Input ring expansion is controlled by the variable `comint-input-autoexpand',
589 and addition is controlled by the variable `comint-input-ignoredups'.
591 Commands with no default key bindings include `send-invisible',
592 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
593 `comint-magic-space'.
595 Input to, and output from, the subprocess can cause the window to scroll to
596 the end of the buffer. See variables `comint-output-filter-functions',
597 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
598 and `comint-move-point-for-output'.
600 If you accidentally suspend your process, use \\[comint-continue-subjob]
605 Entry to this mode runs the hooks on `comint-mode-hook'."
606 (setq mode-line-process '(":%s"))
607 (set (make-local-variable 'comint-last-input-start) (point-min-marker))
608 (set (make-local-variable 'comint-last-input-end) (point-min-marker))
609 (set (make-local-variable 'comint-last-output-start) (make-marker))
610 (make-local-variable 'comint-last-prompt-overlay)
611 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
612 (make-local-variable 'comint-input-ring-size) ; ...to global val.
613 (make-local-variable 'comint-input-ring)
614 (make-local-variable 'comint-input-ring-file-name)
615 (or (and (boundp 'comint-input-ring) comint-input-ring)
616 (setq comint-input-ring (make-ring comint-input-ring-size)))
617 (make-local-variable 'comint-input-ring-index)
618 (make-local-variable 'comint-save-input-ring-index)
619 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
620 (setq comint-input-ring-index nil))
621 (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
622 (setq comint-save-input-ring-index nil))
623 (make-local-variable 'comint-matching-input-from-input-string)
624 (make-local-variable 'comint-input-autoexpand)
625 (make-local-variable 'comint-input-ignoredups)
626 (make-local-variable 'comint-delimiter-argument-list)
627 (make-local-variable 'comint-completion-fignore)
628 (make-local-variable 'comint-get-old-input)
629 (make-local-variable 'comint-input-filter)
630 (make-local-variable 'comint-input-sender)
631 (make-local-variable 'comint-eol-on-send)
632 (make-local-variable 'comint-scroll-to-bottom-on-input)
633 (make-local-variable 'comint-move-point-for-output)
634 (make-local-variable 'comint-scroll-show-maximum-output)
635 ;; This makes it really work to keep point at the bottom.
636 (make-local-variable 'scroll-conservatively)
637 (setq scroll-conservatively 10000)
638 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
639 (make-local-variable 'comint-ptyp)
640 (make-local-variable 'comint-process-echoes)
641 (make-local-variable 'comint-file-name-chars)
642 (make-local-variable 'comint-file-name-quote-list)
643 (set (make-local-variable 'comint-accum-marker) (make-marker))
644 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
645 ;; This behavior is not useful in comint buffers, and is annoying
646 (set (make-local-variable 'next-line-add-newlines) nil))
648 (defun comint-check-proc (buffer)
649 "Return t if there is a living process associated w/buffer BUFFER.
650 Living means the status is `open', `run', or `stop'.
651 BUFFER can be either a buffer or the name of one."
652 (let ((proc (get-buffer-process buffer)))
653 (and proc (memq (process-status proc) '(open run stop)))))
656 (defun make-comint-in-buffer (name buffer program &optional startfile &rest switches)
657 "Make a Comint process NAME in BUFFER, running PROGRAM.
658 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
659 PROGRAM should be either a string denoting an executable program to create
660 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
661 connection to be opened via `open-network-stream'. If there is already a
662 running process in that buffer, it is not restarted. Optional third arg
663 STARTFILE is the name of a file to send the contents of to the process.
665 If PROGRAM is a string, any more args are arguments to PROGRAM."
666 (or (fboundp 'start-process)
667 (error "Multi-processing is not supported for this system"))
668 (setq buffer (get-buffer-create (or buffer (concat "*" name "*"))))
669 ;; If no process, or nuked process, crank up a new one and put buffer in
670 ;; comint mode. Otherwise, leave buffer and existing process alone.
671 (unless (comint-check-proc buffer)
672 (with-current-buffer buffer
673 (unless (derived-mode-p 'comint-mode)
674 (comint-mode))) ; Install local vars, mode, keymap, ...
675 (comint-exec buffer name program startfile switches))
679 (defun make-comint (name program &optional startfile &rest switches)
680 "Make a Comint process NAME in a buffer, running PROGRAM.
681 The name of the buffer is made by surrounding NAME with `*'s.
682 PROGRAM should be either a string denoting an executable program to create
683 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
684 connection to be opened via `open-network-stream'. If there is already a
685 running process in that buffer, it is not restarted. Optional third arg
686 STARTFILE is the name of a file to send the contents of the process to.
688 If PROGRAM is a string, any more args are arguments to PROGRAM."
689 (apply #'make-comint-in-buffer name nil program startfile switches))
692 (defun comint-run (program)
693 "Run PROGRAM in a Comint buffer and switch to it.
694 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
695 The file name is used to make a symbol name, such as `comint-sh-hook', and any
696 hooks on this symbol are run in the buffer.
697 See `make-comint' and `comint-exec'."
698 (interactive "sRun program: ")
699 (let ((name (file-name-nondirectory program)))
700 (switch-to-buffer (make-comint name program))
701 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
703 (defun comint-exec (buffer name command startfile switches)
704 "Start up a process named NAME in buffer BUFFER for Comint modes.
705 Runs the given COMMAND with SWITCHES with output to STARTFILE.
706 Blasts any old process running in the buffer. Doesn't set the buffer mode.
707 You can use this to cheaply run a series of processes in the same Comint
708 buffer. The hook `comint-exec-hook' is run after each exec."
709 (with-current-buffer buffer
710 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
711 (if proc (delete-process proc)))
712 ;; Crank up a new process
715 (open-network-stream name buffer (car command) (cdr command))
716 (comint-exec-1 name buffer command switches))))
717 (set-process-filter proc 'comint-output-filter)
718 (make-local-variable 'comint-ptyp)
719 (setq comint-ptyp process-connection-type) ; t if pty, nil if pipe.
720 ;; Jump to the end, and set the process mark.
721 (goto-char (point-max))
722 (set-marker (process-mark proc) (point))
723 ;; Feed it the startfile.
725 ;;This is guaranteed to wait long enough
726 ;;but has bad results if the comint does not prompt at all
727 ;; (while (= size (buffer-size))
729 ;;I hope 1 second is enough!
731 (goto-char (point-max))
732 (insert-file-contents startfile)
733 (setq startfile (buffer-substring (point) (point-max)))
734 (delete-region (point) (point-max))
735 (comint-send-string proc startfile)))
736 (run-hooks 'comint-exec-hook)
739 ;; This auxiliary function cranks up the process for comint-exec in
740 ;; the appropriate environment.
742 (defun comint-exec-1 (name buffer command switches)
743 (let ((process-environment
745 ;; If using termcap, we specify `emacs' as the terminal type
746 ;; because that lets us specify a width.
747 ;; If using terminfo, we specify `dumb' because that is
748 ;; a defined terminal type. `emacs' is not a defined terminal type
749 ;; and there is no way for us to define it here.
750 ;; Some programs that use terminfo get very confused
751 ;; if TERM is not a valid terminal type.
752 ;; ;; There is similar code in compile.el.
753 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
754 (list "TERM=dumb" "TERMCAP="
755 (format "COLUMNS=%d" (window-width)))
757 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
758 (if (getenv "EMACS") nil (list "EMACS=t"))
759 process-environment))
761 (if (file-accessible-directory-p default-directory)
764 proc decoding encoding changed)
765 (let ((exec-path (if (file-name-directory command)
766 ;; If the command has slashes, make sure we
767 ;; first look relative to the current directory.
768 (cons default-directory exec-path) exec-path)))
769 (setq proc (apply 'start-process name buffer command switches)))
770 (let ((coding-systems (process-coding-system proc)))
771 (setq decoding (car coding-systems)
772 encoding (cdr coding-systems)))
773 ;; If start-process decided to use some coding system for decoding
774 ;; data sent from the process and the coding system doesn't
775 ;; specify EOL conversion, we had better convert CRLF to LF.
776 (if (vectorp (coding-system-eol-type decoding))
777 (setq decoding (coding-system-change-eol-conversion decoding 'dos)
779 ;; Even if start-process left the coding system for encoding data
780 ;; sent from the process undecided, we had better use the same one
781 ;; as what we use for decoding. But, we should suppress EOL
783 (if (and decoding (not encoding))
784 (setq encoding (coding-system-change-eol-conversion decoding 'unix)
787 (set-process-coding-system proc decoding encoding))
790 (defun comint-insert-input (&optional event)
791 "In a Comint buffer, set the current input to the previous input at point."
792 ;; This doesn't use "e" because it is supposed to work
793 ;; for events without parameters.
794 (interactive (list last-input-event))
796 (if event (mouse-set-point event))
797 (if (not (eq (get-char-property (point) 'field) 'input))
798 ;; No input at POS, fall back to the global definition.
799 (let* ((keys (this-command-keys))
800 (last-key (and (vectorp keys) (aref keys (1- (length keys)))))
801 (fun (and last-key (lookup-key global-map (vector last-key)))))
803 (and fun (call-interactively fun)))
805 ;; There's previous input at POS, insert it at the end of the buffer.
806 (goto-char (point-max))
807 ;; First delete any old unsent input at the end
809 (or (marker-position comint-accum-marker)
810 (process-mark (get-buffer-process (current-buffer))))
812 ;; Insert the input at point
813 (insert (buffer-substring-no-properties
814 (previous-single-char-property-change (1+ pos) 'field)
815 (next-single-char-property-change pos 'field))))))
818 ;; Input history processing in a buffer
819 ;; ===========================================================================
820 ;; Useful input history functions, courtesy of the Ergo group.
823 ;; comint-dynamic-list-input-ring List history in help buffer.
824 ;; comint-previous-input Previous input...
825 ;; comint-previous-matching-input ...matching a string.
826 ;; comint-previous-matching-input-from-input ... matching the current input.
827 ;; comint-next-input Next input...
828 ;; comint-next-matching-input ...matching a string.
829 ;; comint-next-matching-input-from-input ... matching the current input.
830 ;; comint-backward-matching-input Backwards input...
831 ;; comint-forward-matching-input ...matching a string.
832 ;; comint-replace-by-expanded-history Expand history at point;
833 ;; replace with expanded history.
834 ;; comint-magic-space Expand history and insert space.
837 ;; comint-read-input-ring Read into comint-input-ring...
838 ;; comint-write-input-ring Write to comint-input-ring-file-name.
839 ;; comint-replace-by-expanded-history-before-point Workhorse function.
841 (defun comint-read-input-ring (&optional silent)
842 "Set the buffer's `comint-input-ring' from a history file.
843 The name of the file is given by the variable `comint-input-ring-file-name'.
844 The history ring is of size `comint-input-ring-size', regardless of file size.
845 If `comint-input-ring-file-name' is nil this function does nothing.
847 If the optional argument SILENT is non-nil, we say nothing about a
848 failure to read the history file.
850 This function is useful for major mode commands and mode hooks.
852 The commands stored in the history file are separated by the
853 `comint-input-ring-separator', and entries that match
854 `comint-input-history-ignore' are ignored. The most recent command
857 See also `comint-input-ignoredups' and `comint-write-input-ring'."
858 (cond ((or (null comint-input-ring-file-name)
859 (equal comint-input-ring-file-name ""))
861 ((not (file-readable-p comint-input-ring-file-name))
863 (message "Cannot read history file %s"
864 comint-input-ring-file-name)))
866 (let* ((history-buf (get-buffer-create " *temp*"))
867 (file comint-input-ring-file-name)
869 (size comint-input-ring-size)
870 (ring (make-ring size)))
873 (set-buffer history-buf)
876 (insert-file-contents file)
877 ;; Save restriction in case file is already visited...
878 ;; Watch for those date stamps in history files!
879 (goto-char (point-max))
880 (let (start end history)
881 (while (and (< count comint-input-ring-size)
882 (re-search-backward comint-input-ring-separator nil t)
883 (setq end (match-beginning 0)))
884 (if (re-search-backward comint-input-ring-separator nil t)
885 (setq start (match-end 0))
886 (setq start (point-min)))
887 (setq history (buffer-substring start end))
889 (if (and (not (string-match comint-input-history-ignore history))
890 (or (null comint-input-ignoredups)
892 (not (string-equal (ring-ref ring 0) history))))
894 (ring-insert-at-beginning ring history)
895 (setq count (1+ count)))))))
896 (kill-buffer history-buf))
897 (setq comint-input-ring ring
898 comint-input-ring-index nil)))))
900 (defun comint-write-input-ring ()
901 "Writes the buffer's `comint-input-ring' to a history file.
902 The name of the file is given by the variable `comint-input-ring-file-name'.
903 The original contents of the file are lost if `comint-input-ring' is not empty.
904 If `comint-input-ring-file-name' is nil this function does nothing.
906 Useful within process sentinels.
908 See also `comint-read-input-ring'."
909 (cond ((or (null comint-input-ring-file-name)
910 (equal comint-input-ring-file-name "")
911 (null comint-input-ring) (ring-empty-p comint-input-ring))
913 ((not (file-writable-p comint-input-ring-file-name))
914 (message "Cannot write history file %s" comint-input-ring-file-name))
916 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
917 (ring comint-input-ring)
918 (file comint-input-ring-file-name)
919 (index (ring-length ring)))
920 ;; Write it all out into a buffer first. Much faster, but messier,
921 ;; than writing it one line at a time.
923 (set-buffer history-buf)
926 (setq index (1- index))
927 (insert (ring-ref ring index) comint-input-ring-separator))
928 (write-region (buffer-string) nil file nil 'no-message)
929 (kill-buffer nil))))))
932 (defvar comint-dynamic-list-input-ring-window-conf)
934 (defun comint-dynamic-list-input-ring-select ()
935 "Choose the input history entry that point is in or next to."
937 (let (beg end completion (buffer completion-reference-buffer)
938 (base-size completion-base-size))
939 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
940 (setq end (point) beg (1+ (point))))
941 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
942 (setq end (1- (point)) beg (point)))
944 (error "No history entry here"))
945 (setq beg (previous-single-property-change beg 'mouse-face))
946 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
947 (setq completion (buffer-substring beg end))
948 (set-window-configuration comint-dynamic-list-input-ring-window-conf)
949 (choose-completion-string completion buffer base-size)))
951 (defun comint-dynamic-list-input-ring ()
952 "List in help buffer the buffer's input history."
954 (if (or (not (ring-p comint-input-ring))
955 (ring-empty-p comint-input-ring))
956 (message "No history")
958 (history-buffer " *Input History*")
959 (index (1- (ring-length comint-input-ring)))
960 (conf (current-window-configuration)))
961 ;; We have to build up a list ourselves from the ring vector.
963 (setq history (cons (ring-ref comint-input-ring index) history)
965 ;; Change "completion" to "history reference"
966 ;; to make the display accurate.
967 (with-output-to-temp-buffer history-buffer
968 (display-completion-list history)
969 (set-buffer history-buffer)
970 (let ((keymap (make-sparse-keymap)))
971 (set-keymap-parent keymap (current-local-map))
972 (define-key keymap "\C-m" 'comint-dynamic-list-input-ring-select)
973 (use-local-map keymap))
975 (while (search-backward "completion" nil 'move)
976 (replace-match "history reference")))
978 (message "Hit space to flush")
979 (setq comint-dynamic-list-input-ring-window-conf conf)
980 (let ((ch (read-event)))
982 (set-window-configuration conf)
983 (setq unread-command-events (list ch)))))))
986 (defun comint-regexp-arg (prompt)
987 "Return list of regexp and prefix arg using PROMPT."
988 (let* (;; Don't clobber this.
989 (last-command last-command)
990 (regexp (read-from-minibuffer prompt nil nil nil
991 'minibuffer-history-search-history)))
992 (list (if (string-equal regexp "")
993 (setcar minibuffer-history-search-history
994 (nth 1 minibuffer-history-search-history))
996 (prefix-numeric-value current-prefix-arg))))
998 (defun comint-search-arg (arg)
999 ;; First make sure there is a ring and that we are after the process mark
1000 (cond ((not (comint-after-pmark-p))
1001 (error "Not at command line"))
1002 ((or (null comint-input-ring)
1003 (ring-empty-p comint-input-ring))
1004 (error "Empty input ring"))
1006 ;; arg of zero resets search from beginning, and uses arg of 1
1007 (setq comint-input-ring-index nil)
1012 (defun comint-search-start (arg)
1013 "Index to start a directional search, starting at `comint-input-ring-index'."
1014 (if comint-input-ring-index
1015 ;; If a search is running, offset by 1 in direction of arg
1016 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
1017 (ring-length comint-input-ring))
1018 ;; For a new search, start from beginning or end, as appropriate
1020 0 ; First elt for forward search
1021 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
1023 (defun comint-previous-input-string (arg)
1024 "Return the string ARG places along the input ring.
1025 Moves relative to `comint-input-ring-index'."
1026 (ring-ref comint-input-ring (if comint-input-ring-index
1027 (mod (+ arg comint-input-ring-index)
1028 (ring-length comint-input-ring))
1031 (defun comint-previous-input (arg)
1032 "Cycle backwards through input history."
1034 (comint-previous-matching-input "." arg))
1036 (defun comint-next-input (arg)
1037 "Cycle forwards through input history."
1039 (comint-previous-input (- arg)))
1041 (defun comint-previous-matching-input-string (regexp arg)
1042 "Return the string matching REGEXP ARG places along the input ring.
1043 Moves relative to `comint-input-ring-index'."
1044 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
1045 (if pos (ring-ref comint-input-ring pos))))
1047 (defun comint-previous-matching-input-string-position (regexp arg &optional start)
1048 "Return the index matching REGEXP ARG places along the input ring.
1049 Moves relative to START, or `comint-input-ring-index'."
1050 (if (or (not (ring-p comint-input-ring))
1051 (ring-empty-p comint-input-ring))
1052 (error "No history"))
1053 (let* ((len (ring-length comint-input-ring))
1054 (motion (if (> arg 0) 1 -1))
1055 (n (mod (- (or start (comint-search-start arg)) motion) len))
1056 (tried-each-ring-item nil)
1058 ;; Do the whole search as many times as the argument says.
1059 (while (and (/= arg 0) (not tried-each-ring-item))
1062 n (mod (+ n motion) len))
1063 ;; If we haven't reached a match, step some more.
1064 (while (and (< n len) (not tried-each-ring-item)
1065 (not (string-match regexp (ring-ref comint-input-ring n))))
1066 (setq n (mod (+ n motion) len)
1067 ;; If we have gone all the way around in this search.
1068 tried-each-ring-item (= n prev)))
1069 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1070 ;; Now that we know which ring element to use, if we found it, return that.
1071 (if (string-match regexp (ring-ref comint-input-ring n))
1074 (defun comint-previous-matching-input (regexp arg)
1075 "Search backwards through input history for match for REGEXP.
1076 \(Previous history elements are earlier commands.)
1077 With prefix argument N, search for Nth previous match.
1078 If N is negative, find the next or Nth next match."
1079 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1080 (setq arg (comint-search-arg arg))
1081 (let ((pos (comint-previous-matching-input-string-position regexp arg)))
1082 ;; Has a match been found?
1085 (setq comint-input-ring-index pos)
1086 (message "History item: %d" (1+ pos))
1088 ;; Can't use kill-region as it sets this-command
1089 (or (marker-position comint-accum-marker)
1090 (process-mark (get-buffer-process (current-buffer))))
1092 (insert (ring-ref comint-input-ring pos)))))
1094 (defun comint-next-matching-input (regexp arg)
1095 "Search forwards through input history for match for REGEXP.
1096 \(Later history elements are more recent commands.)
1097 With prefix argument N, search for Nth following match.
1098 If N is negative, find the previous or Nth previous match."
1099 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1100 (comint-previous-matching-input regexp (- arg)))
1102 (defun comint-previous-matching-input-from-input (arg)
1103 "Search backwards through input history for match for current input.
1104 \(Previous history elements are earlier commands.)
1105 With prefix argument N, search for Nth previous match.
1106 If N is negative, search forwards for the -Nth following match."
1108 (if (not (memq last-command '(comint-previous-matching-input-from-input
1109 comint-next-matching-input-from-input)))
1110 ;; Starting a new search
1111 (setq comint-matching-input-from-input-string
1113 (or (marker-position comint-accum-marker)
1114 (process-mark (get-buffer-process (current-buffer))))
1116 comint-input-ring-index nil))
1117 (comint-previous-matching-input
1118 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1121 (defun comint-next-matching-input-from-input (arg)
1122 "Search forwards through input history for match for current input.
1123 \(Following history elements are more recent commands.)
1124 With prefix argument N, search for Nth following match.
1125 If N is negative, search backwards for the -Nth previous match."
1127 (comint-previous-matching-input-from-input (- arg)))
1130 (defun comint-replace-by-expanded-history (&optional silent start)
1131 "Expand input command history references before point.
1132 Expansion is dependent on the value of `comint-input-autoexpand'.
1134 This function depends on the buffer's idea of the input history, which may not
1135 match the command interpreter's idea, assuming it has one.
1137 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1138 cannot know the interpreter's idea of input line numbers, assuming it has one,
1139 it cannot expand absolute input line number references.
1141 If the optional argument SILENT is non-nil, never complain
1142 even if history reference seems erroneous.
1144 If the optional argument START is non-nil, that specifies the
1145 start of the text to scan for history references, rather
1146 than the logical beginning of line.
1148 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1150 Returns t if successful."
1152 (if (and comint-input-autoexpand
1153 (if comint-use-prompt-regexp-instead-of-fields
1154 ;; Use comint-prompt-regexp
1157 (looking-at (concat comint-prompt-regexp "!\\|\\^")))
1158 ;; Use input fields. User input that hasn't been entered
1159 ;; yet, at the end of the buffer, has a nil `field' property.
1160 (and (null (get-char-property (point) 'field))
1161 (string-match "!\\|^\\^" (field-string)))))
1162 ;; Looks like there might be history references in the command.
1163 (let ((previous-modified-tick (buffer-modified-tick)))
1164 (comint-replace-by-expanded-history-before-point silent start)
1165 (/= previous-modified-tick (buffer-modified-tick)))))
1168 (defun comint-replace-by-expanded-history-before-point (silent &optional start)
1169 "Expand directory stack reference before point.
1170 See `comint-replace-by-expanded-history'. Returns t if successful.
1172 If the optional argument START is non-nil, that specifies the
1173 start of the text to scan for history references, rather
1174 than the logical beginning of line."
1176 (let ((toend (- (line-end-position) (point)))
1177 (start (or start (comint-line-beginning-position))))
1180 (skip-chars-forward "^!^" (- (line-end-position) toend))
1181 (< (point) (- (line-end-position) toend)))
1182 ;; This seems a bit complex. We look for references such as !!, !-num,
1183 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1184 ;; If that wasn't enough, the plings can be suffixed with argument
1185 ;; range specifiers.
1186 ;; Argument ranges are complex too, so we hive off the input line,
1187 ;; referenced with plings, with the range string to `comint-args'.
1188 (setq comint-input-ring-index nil)
1189 (cond ((or (= (preceding-char) ?\\)
1190 (comint-within-quotes start (point)))
1191 ;; The history is quoted, or we're in quotes.
1192 (goto-char (1+ (point))))
1193 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1194 ;; We cannot know the interpreter's idea of input line numbers.
1195 (goto-char (match-end 0))
1196 (message "Absolute reference cannot be expanded"))
1197 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1198 ;; Just a number of args from `number' lines backward.
1199 (let ((number (1- (string-to-number
1200 (buffer-substring (match-beginning 1)
1202 (if (<= number (ring-length comint-input-ring))
1205 (comint-args (comint-previous-input-string number)
1206 (match-beginning 2) (match-end 2))
1208 (setq comint-input-ring-index number)
1209 (message "History item: %d" (1+ number)))
1210 (goto-char (match-end 0))
1211 (message "Relative reference exceeds input history size"))))
1212 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1213 ;; Just a number of args from the previous input line.
1215 (comint-args (comint-previous-input-string 0)
1216 (match-beginning 1) (match-end 1))
1218 (message "History item: previous"))
1220 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1221 ;; Most recent input starting with or containing (possibly
1222 ;; protected) string, maybe just a number of args. Phew.
1223 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1224 (mb2 (match-beginning 2)) (me2 (match-end 2))
1225 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1226 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1227 (pos (save-match-data
1228 (comint-previous-matching-input-string-position
1229 (concat pref (regexp-quote exp)) 1))))
1232 (goto-char (match-end 0))
1234 (progn (message "Not found")
1236 (setq comint-input-ring-index pos)
1238 (comint-args (ring-ref comint-input-ring pos)
1239 (match-beginning 4) (match-end 4))
1241 (message "History item: %d" (1+ pos)))))
1242 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1243 ;; Quick substitution on the previous input line.
1244 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1245 (new (buffer-substring (match-beginning 2) (match-end 2)))
1247 (replace-match (comint-previous-input-string 0) t t)
1249 (goto-char (match-beginning 0))
1250 (if (not (search-forward old pos t))
1252 (error "Not found"))
1253 (replace-match new t t)
1254 (message "History item: substituted"))))
1256 (forward-char 1)))))))
1259 (defun comint-magic-space (arg)
1260 "Expand input history references before point and insert ARG spaces.
1261 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1263 (comint-replace-by-expanded-history)
1264 (self-insert-command arg))
1266 (defun comint-within-quotes (beg end)
1267 "Return t if the number of quotes between BEG and END is odd.
1268 Quotes are single and double."
1269 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1270 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1271 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1273 (defun comint-how-many-region (regexp beg end)
1274 "Return number of matches for REGEXP from BEG to END."
1279 (while (re-search-forward regexp end t)
1280 (setq count (1+ count)))))
1283 (defun comint-args (string begin end)
1284 ;; From STRING, return the args depending on the range specified in the text
1285 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1286 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1289 (comint-arguments string 0 nil)
1290 (let* ((range (buffer-substring
1291 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1292 (nth (cond ((string-match "^[*^]" range) 1)
1293 ((string-match "^-" range) 0)
1294 ((string-equal range "$") nil)
1295 (t (string-to-number range))))
1296 (mth (cond ((string-match "[-*$]$" range) nil)
1297 ((string-match "-" range)
1298 (string-to-number (substring range (match-end 0))))
1300 (comint-arguments string nth mth)))))
1302 (defun comint-delim-arg (arg)
1303 "Return a list of arguments from ARG.
1304 Break it up at the delimiters in `comint-delimiter-argument-list'.
1305 Returned list is backwards."
1306 (if (null comint-delimiter-argument-list)
1312 (let ((char (aref arg pos))
1314 (if (memq char comint-delimiter-argument-list)
1315 (while (and (< pos len) (eq (aref arg pos) char))
1316 (setq pos (1+ pos)))
1317 (while (and (< pos len)
1318 (not (memq (aref arg pos)
1319 comint-delimiter-argument-list)))
1320 (setq pos (1+ pos))))
1321 (setq args (cons (substring arg start pos) args))))
1324 (defun comint-arguments (string nth mth)
1325 "Return from STRING the NTH to MTH arguments.
1326 NTH and/or MTH can be nil, which means the last argument.
1327 Returned arguments are separated by single spaces.
1328 We assume whitespace separates arguments, except within quotes
1329 and except for a space or tab that immediately follows a backslash.
1330 Also, a run of one or more of a single character
1331 in `comint-delimiter-argument-list' is a separate argument.
1332 Argument 0 is the command name."
1333 ;; The first line handles ordinary characters and backslash-sequences
1334 ;; (except with w32 msdos-like shells, where backslashes are valid).
1335 ;; The second matches "-quoted strings.
1336 ;; The third matches '-quoted strings.
1337 ;; The fourth matches `-quoted strings.
1338 ;; This seems to fit the syntax of BASH 2.0.
1339 (let* ((first (if (if (fboundp 'w32-shell-dos-semantics)
1340 (w32-shell-dos-semantics))
1342 "[^ \n\t\"'`\\]+\\|\\\\[\"'`\\ \t]+\\|"))
1343 (argpart (concat first
1344 "\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\
1350 ;; Build a list of all the args until we have as many as we want.
1351 (while (and (or (null mth) (<= count mth))
1352 (string-match argpart string pos))
1353 (if (and beg (= pos (match-beginning 0)))
1354 ;; It's contiguous, part of the same arg.
1355 (setq pos (match-end 0)
1356 quotes (or quotes (match-beginning 1)))
1357 ;; It's a new separate arg.
1359 ;; Put the previous arg, if there was one, onto ARGS.
1360 (setq str (substring string beg pos)
1361 args (if quotes (cons str args)
1362 (nconc (comint-delim-arg str) args))))
1363 (setq count (length args))
1364 (setq quotes (match-beginning 1))
1365 (setq beg (match-beginning 0))
1366 (setq pos (match-end 0))))
1368 (setq str (substring string beg pos)
1369 args (if quotes (cons str args)
1370 (nconc (comint-delim-arg str) args))))
1371 (setq count (length args))
1372 (let ((n (or nth (1- count)))
1373 (m (if mth (1- (- count mth)) 0)))
1375 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1378 ;; Input processing stuff
1380 (defun comint-add-to-input-history (cmd)
1381 "Add CMD to the input history.
1382 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1383 (if (and (funcall comint-input-filter cmd)
1384 (or (null comint-input-ignoredups)
1385 (not (ring-p comint-input-ring))
1386 (ring-empty-p comint-input-ring)
1387 (not (string-equal (ring-ref comint-input-ring 0)
1389 (ring-insert comint-input-ring cmd)))
1391 (defun comint-send-input (&optional no-newline artificial)
1392 "Send input to process.
1393 After the process output mark, sends all text from the process mark to
1394 point as input to the process. Before the process output mark, calls
1395 value of variable `comint-get-old-input' to retrieve old input, copies
1396 it to the process mark, and sends it.
1398 This command also sends and inserts a final newline, unless
1399 NO-NEWLINE is non-nil.
1401 Any history reference may be expanded depending on the value of the variable
1402 `comint-input-autoexpand'. The list of function names contained in the value
1403 of `comint-input-filter-functions' is called on the input before sending it.
1404 The input is entered into the input history ring, if the value of variable
1405 `comint-input-filter' returns non-nil when called on the input.
1407 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1408 end of line before sending the input.
1410 After the input has been sent, if `comint-process-echoes' is non-nil,
1411 then `comint-send-input' waits to see if the process outputs a string
1412 matching the input, and if so, deletes that part of the output.
1413 If ARTIFICIAL is non-nil, it inhibits such deletion.
1414 Callers sending input not from the user should use ARTIFICIAL = t.
1416 The values of `comint-get-old-input', `comint-input-filter-functions', and
1417 `comint-input-filter' are chosen according to the command interpreter running
1418 in the buffer. E.g.,
1420 If the interpreter is the csh,
1421 `comint-get-old-input' is the default:
1422 If `comint-use-prompt-regexp-instead-of-fields' is nil, then
1423 either return the current input field, if point is on an input
1424 field, or the current line, if point is on an output field.
1425 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then
1426 return the current line with any initial string matching the
1427 regexp `comint-prompt-regexp' removed.
1428 `comint-input-filter-functions' monitors input for \"cd\", \"pushd\", and
1429 \"popd\" commands. When it sees one, it cd's the buffer.
1430 comint-input-filter is the default: returns t if the input isn't all white
1433 If the Comint is Lucid Common Lisp,
1434 comint-get-old-input snarfs the sexp ending at point.
1435 comint-input-filter-functions does nothing.
1436 comint-input-filter returns nil if the input matches input-filter-regexp,
1437 which matches (1) all whitespace (2) :a, :c, etc.
1439 Similarly for Soar, Scheme, etc."
1441 ;; Note that the input string does not include its terminal newline.
1442 (let ((proc (get-buffer-process (current-buffer))))
1443 (if (not proc) (error "Current buffer has no process")
1444 (let* ((pmark (process-mark proc))
1445 (intxt (if (>= (point) (marker-position pmark))
1446 (progn (if comint-eol-on-send (end-of-line))
1447 (buffer-substring pmark (point)))
1448 (let ((copy (funcall comint-get-old-input)))
1452 (input (if (not (eq comint-input-autoexpand 'input))
1453 ;; Just whatever's already there
1455 ;; Expand and leave it visible in buffer
1456 (comint-replace-by-expanded-history t pmark)
1457 (buffer-substring pmark (point))))
1458 (history (if (not (eq comint-input-autoexpand 'history))
1460 ;; This is messy 'cos ultimately the original
1461 ;; functions used do insertion, rather than return
1462 ;; strings. We have to expand, then insert back.
1463 (comint-replace-by-expanded-history t pmark)
1464 (let ((copy (buffer-substring pmark (point)))
1467 (delete-region pmark start)
1473 (comint-add-to-input-history history)
1475 (run-hook-with-args 'comint-input-filter-functions
1476 (if no-newline input
1477 (concat input "\n")))
1479 (let ((beg (marker-position pmark))
1480 (end (if no-newline (point) (1- (point))))
1481 (inhibit-modification-hooks t))
1483 ;; Set text-properties for the input field
1484 (add-text-properties
1487 font-lock-face comint-highlight-input
1488 mouse-face highlight
1489 help-echo "mouse-2: insert after prompt as new input"))
1490 (unless comint-use-prompt-regexp-instead-of-fields
1491 ;; Give old user input a field property of `input', to
1492 ;; distinguish it from both process output and unsent
1493 ;; input. The terminating newline is put into a special
1494 ;; `boundary' field to make cursor movement between input
1495 ;; and output fields smoother.
1496 (put-text-property beg end 'field 'input)))
1497 (unless (or no-newline comint-use-prompt-regexp-instead-of-fields)
1498 ;; Cover the terminating newline
1499 (add-text-properties end (1+ end)
1502 inhibit-line-move-field-capture t))))
1504 (comint-snapshot-last-prompt)
1506 (setq comint-save-input-ring-index comint-input-ring-index)
1507 (setq comint-input-ring-index nil)
1508 ;; Update the markers before we send the input
1509 ;; in case we get output amidst sending the input.
1510 (set-marker comint-last-input-start pmark)
1511 (set-marker comint-last-input-end (point))
1512 (set-marker (process-mark proc) (point))
1513 ;; clear the "accumulation" marker
1514 (set-marker comint-accum-marker nil)
1515 (let ((comint-input-sender-no-newline no-newline))
1516 (funcall comint-input-sender proc input))
1518 ;; Optionally delete echoed input (after checking it).
1519 (when (and comint-process-echoes (not artificial))
1520 (let ((echo-len (- comint-last-input-end
1521 comint-last-input-start)))
1522 ;; Wait for all input to be echoed:
1523 (while (and (accept-process-output proc)
1524 (> (+ comint-last-input-end echo-len)
1527 (compare-buffer-substrings
1528 nil comint-last-input-start
1529 (- (point-max) echo-len)
1530 ;; Above difference is equivalent to
1531 ;; (+ comint-last-input-start
1532 ;; (- (point-max) comint-last-input-end))
1533 nil comint-last-input-end (point-max)))))
1535 (<= (+ comint-last-input-end echo-len)
1538 (compare-buffer-substrings
1539 nil comint-last-input-start comint-last-input-end
1540 nil comint-last-input-end
1541 (+ comint-last-input-end echo-len))))
1542 (delete-region comint-last-input-end
1543 (+ comint-last-input-end echo-len)))))
1545 ;; This used to call comint-output-filter-functions,
1546 ;; but that scrolled the buffer in undesirable ways.
1547 (run-hook-with-args 'comint-output-filter-functions "")))))
1549 (defvar comint-preoutput-filter-functions nil
1550 "List of functions to call before inserting Comint output into the buffer.
1551 Each function gets one argument, a string containing the text received
1552 from the subprocess. It should return the string to insert, perhaps
1553 the same string that was received, or perhaps a modified or transformed
1556 The functions on the list are called sequentially, and each one is
1557 given the string returned by the previous one. The string returned by
1558 the last function is the text that is actually inserted in the
1561 You can use `add-hook' to add functions to this list
1562 either globally or locally.")
1564 (defvar comint-inhibit-carriage-motion nil
1565 "If nil, Comint will interpret `carriage control' characters in output.
1566 See `comint-carriage-motion' for details.")
1568 ;; When non-nil, this is an overlay over the last recognized prompt in
1569 ;; the buffer; it is used when highlighting the prompt.
1570 (defvar comint-last-prompt-overlay nil)
1572 (defun comint-snapshot-last-prompt ()
1573 "`snapshot' any current `comint-last-prompt-overlay'.
1574 freeze its attributes in place, even when more input comes a long
1575 and moves the prompt overlay."
1576 (when comint-last-prompt-overlay
1577 (let ((inhibit-read-only t)
1578 (inhibit-modification-hooks t))
1579 (add-text-properties (overlay-start comint-last-prompt-overlay)
1580 (overlay-end comint-last-prompt-overlay)
1581 (overlay-properties comint-last-prompt-overlay)))))
1583 (defun comint-carriage-motion (start end)
1584 "Interpret carriage control characters in the region from START to END.
1585 Translate carriage return/linefeed sequences to linefeeds.
1586 Make single carriage returns delete to the beginning of the line.
1587 Make backspaces delete the previous character."
1589 ;; First do a quick check to see if there are any applicable
1590 ;; characters, so we can avoid calling save-match-data and
1591 ;; save-restriction if not.
1593 (when (< (skip-chars-forward "^\b\r" end) (- end start))
1597 (let ((inhibit-field-text-motion t)
1598 (inhibit-read-only t))
1600 ;; Note that this won't work properly when the CR and LF
1601 ;; are in different output chunks, but this is probably an
1602 ;; exceedingly rare case (because they are generally
1603 ;; written as a unit), and to delay interpretation of a
1604 ;; trailing CR in a chunk would result in odd interactive
1605 ;; behavior (and this case is probably far more common).
1606 (while (re-search-forward "\r$" end t)
1608 ;; bare CR -> delete preceding line
1610 (while (search-forward "\r" end t)
1611 (delete-region (point) (line-beginning-position)))
1612 ;; BS -> delete preceding character
1614 (while (search-forward "\b" end t)
1615 (delete-char -2))))))))
1617 ;; The purpose of using this filter for comint processes
1618 ;; is to keep comint-last-input-end from moving forward
1619 ;; when output is inserted.
1620 (defun comint-output-filter (process string)
1621 (let ((oprocbuf (process-buffer process)))
1622 ;; First check for killed buffer or no input.
1623 (when (and string oprocbuf (buffer-name oprocbuf))
1624 (with-current-buffer oprocbuf
1625 ;; Run preoutput filters
1626 (let ((functions comint-preoutput-filter-functions))
1627 (while (and functions string)
1628 (if (eq (car functions) t)
1629 (let ((functions (default-value 'comint-preoutput-filter-functions)))
1630 (while (and functions string)
1631 (setq string (funcall (car functions) string))
1632 (setq functions (cdr functions))))
1633 (setq string (funcall (car functions) string)))
1634 (setq functions (cdr functions))))
1637 (let ((inhibit-read-only t)
1638 ;; Avoid the overhead of save-excursion, since we just
1639 ;; fiddle with the point
1640 (saved-point (point-marker)))
1642 ;; The point should float after any insertion we do
1643 (set-marker-insertion-type saved-point t)
1645 ;; We temporarly remove any buffer narrowing, in case the
1646 ;; process mark is outside of the restriction
1650 (goto-char (process-mark process))
1651 (set-marker comint-last-output-start (point))
1653 ;; insert-before-markers is a bad thing. XXX
1655 ;; It is used here to force window-point markers (used to
1656 ;; store the value of point in non-selected windows) to
1657 ;; advance, but it also screws up any other markers that we
1658 ;; don't _want_ to advance, such as the start-marker of some
1659 ;; of the overlays we create.
1661 ;; We work around the problem with the overlays by
1662 ;; explicitly adjusting them after we do the insertion, but
1663 ;; in the future this problem should be solved correctly, by
1664 ;; using `insert', and making the insertion-type of
1665 ;; window-point markers settable (via a buffer-local
1666 ;; variable). In comint buffers, this variable would be set
1667 ;; to `t', to cause point in non-select windows to advance.
1668 (insert-before-markers string)
1669 ;; Fixup markers and overlays that got screwed up because we
1670 ;; used `insert-before-markers'.
1671 (let ((old-point (- (point) (length string))))
1672 ;; comint-last-output-start
1673 (set-marker comint-last-output-start old-point)
1674 ;; comint-last-input-end
1675 (when (and comint-last-input-end
1676 (equal (marker-position comint-last-input-end)
1678 (set-marker comint-last-input-end old-point))
1679 ;; No overlays we create are set to advance upon insertion
1680 ;; (at the start/end), so we assume that any overlay which
1681 ;; is at the current point was incorrectly advanced by
1682 ;; insert-before-markers. First fixup overlays that might
1684 (dolist (over (overlays-at (point)))
1685 (when (= (overlay-start over) (point))
1686 (let ((end (overlay-end over)))
1689 (if (= end (point)) old-point end)))))
1690 ;; Then do overlays that might end at point:
1691 (dolist (over (overlays-at (1- (point))))
1692 (when (= (overlay-end over) (point))
1694 (min (overlay-start over) old-point)
1697 ;; Advance process-mark
1698 (set-marker (process-mark process) (point))
1700 (unless comint-inhibit-carriage-motion
1701 ;; Interpret any carriage motion characters (newline, backspace)
1702 (comint-carriage-motion comint-last-output-start (point)))
1704 (run-hook-with-args 'comint-output-filter-functions string)
1706 (goto-char (process-mark process)) ; in case a filter moved it
1708 (unless comint-use-prompt-regexp-instead-of-fields
1709 (let ((inhibit-read-only t)
1710 (inhibit-modification-hooks t))
1711 (add-text-properties comint-last-output-start (point)
1714 inhibit-line-move-field-capture t))))
1716 ;; Highlight the prompt, where we define `prompt' to mean
1717 ;; the most recent output that doesn't end with a newline.
1718 (let ((prompt-start (save-excursion (forward-line 0) (point)))
1719 (inhibit-read-only t)
1720 (inhibit-modification-hooks t))
1721 (when comint-prompt-read-only
1722 (or (= (point-min) prompt-start)
1723 (get-text-property (1- prompt-start) 'read-only)
1725 (1- prompt-start) prompt-start 'read-only 'fence))
1726 (add-text-properties
1727 prompt-start (point)
1728 '(read-only t rear-nonsticky t front-sticky (read-only))))
1729 (unless (and (bolp) (null comint-last-prompt-overlay))
1730 ;; Need to create or move the prompt overlay (in the case
1731 ;; where there is no prompt ((bolp) == t), we still do
1732 ;; this if there's already an existing overlay).
1733 (if comint-last-prompt-overlay
1734 ;; Just move an existing overlay
1735 (move-overlay comint-last-prompt-overlay
1736 prompt-start (point))
1737 ;; Need to create the overlay
1738 (setq comint-last-prompt-overlay
1739 (make-overlay prompt-start (point)))
1740 (overlay-put comint-last-prompt-overlay
1741 'font-lock-face 'comint-highlight-prompt))))
1743 (goto-char saved-point)))))))
1745 (defun comint-preinput-scroll-to-bottom ()
1746 "Go to the end of buffer in all windows showing it.
1747 Movement occurs if point in the selected window is not after the process mark,
1748 and `this-command' is an insertion command. Insertion commands recognised
1749 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1750 Depends on the value of `comint-scroll-to-bottom-on-input'.
1752 This function should be a pre-command hook."
1753 (if (and comint-scroll-to-bottom-on-input
1754 (memq this-command '(self-insert-command comint-magic-space yank
1756 (let* ((selected (selected-window))
1757 (current (current-buffer))
1758 (process (get-buffer-process current))
1759 (scroll comint-scroll-to-bottom-on-input))
1760 (if (and process (< (point) (process-mark process)))
1761 (if (eq scroll 'this)
1762 (goto-char (point-max))
1764 (function (lambda (window)
1765 (if (and (eq (window-buffer window) current)
1766 (or (eq scroll t) (eq scroll 'all)))
1768 (select-window window)
1769 (goto-char (point-max))
1770 (select-window selected)))))
1773 (defun comint-postoutput-scroll-to-bottom (string)
1774 "Go to the end of buffer in some or all windows showing it.
1775 Does not scroll if the current line is the last line in the buffer.
1776 Depends on the value of `comint-move-point-for-output' and
1777 `comint-scroll-show-maximum-output'.
1779 This function should be in the list `comint-output-filter-functions'."
1780 (let* ((selected (selected-window))
1781 (current (current-buffer))
1782 (process (get-buffer-process current))
1783 (scroll comint-move-point-for-output))
1787 (function (lambda (window)
1788 (if (eq (window-buffer window) current)
1790 (select-window window)
1791 (if (and (< (point) (process-mark process))
1792 (or (eq scroll t) (eq scroll 'all)
1793 ;; Maybe user wants point to jump to end.
1794 (and (eq scroll 'this) (eq selected window))
1795 (and (eq scroll 'others) (not (eq selected window)))
1796 ;; If point was at the end, keep it at end.
1797 (and (marker-position comint-last-output-start)
1798 (>= (point) comint-last-output-start))))
1799 (goto-char (process-mark process)))
1800 ;; Optionally scroll so that the text
1801 ;; ends at the bottom of the window.
1802 (if (and comint-scroll-show-maximum-output
1803 (= (point) (point-max)))
1805 (goto-char (point-max))
1807 (select-window selected)))))
1809 (set-buffer current))))
1811 (defun comint-truncate-buffer (&optional string)
1812 "Truncate the buffer to `comint-buffer-maximum-size'.
1813 This function could be on `comint-output-filter-functions' or bound to a key."
1816 (goto-char (process-mark (get-buffer-process (current-buffer))))
1817 (forward-line (- comint-buffer-maximum-size))
1819 (let ((inhibit-read-only t))
1820 (delete-region (point-min) (point)))))
1822 (defun comint-strip-ctrl-m (&optional string)
1823 "Strip trailing `^M' characters from the current output group.
1824 This function could be on `comint-output-filter-functions' or bound to a key."
1826 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1830 (if (interactive-p) comint-last-input-end comint-last-output-start))
1832 (while (re-search-forward "\r+$" pmark t)
1833 (replace-match "" t t)))))
1834 (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
1836 (defun comint-show-maximum-output ()
1837 "Put the end of the buffer at the bottom of the window."
1839 (goto-char (point-max))
1842 (defun comint-get-old-input-default ()
1843 "Default for `comint-get-old-input'.
1844 If `comint-use-prompt-regexp-instead-of-fields' is nil, then either
1845 return the current input field, if point is on an input field, or the
1846 current line, if point is on an output field.
1847 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then return
1848 the current line with any initial string matching the regexp
1849 `comint-prompt-regexp' removed."
1850 (let ((bof (field-beginning)))
1851 (if (eq (get-char-property bof 'field) 'input)
1852 (field-string-no-properties bof)
1854 (buffer-substring-no-properties (point) (line-end-position)))))
1856 (defun comint-skip-prompt ()
1857 "Skip past the text matching regexp `comint-prompt-regexp'.
1858 If this takes us past the end of the current line, don't skip at all."
1859 (if (and (looking-at comint-prompt-regexp)
1860 (<= (match-end 0) (line-end-position)))
1861 (goto-char (match-end 0))))
1863 (defun comint-after-pmark-p ()
1864 "Return t if point is after the process output marker."
1865 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1866 (<= (marker-position pmark) (point))))
1868 (defun comint-simple-send (proc string)
1869 "Default function for sending to PROC input STRING.
1870 This just sends STRING plus a newline. To override this,
1871 set the hook `comint-input-sender'."
1872 (comint-send-string proc string)
1873 (if comint-input-sender-no-newline
1874 (if (not (string-equal string ""))
1876 (comint-send-string proc "\n")))
1878 (defun comint-line-beginning-position ()
1879 "Return the buffer position of the beginning of the line, after any prompt.
1880 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1881 prompt skip is done by skipping text matching the regular expression
1882 `comint-prompt-regexp', a buffer local variable."
1883 (if comint-use-prompt-regexp-instead-of-fields
1884 ;; Use comint-prompt-regexp
1887 (comint-skip-prompt)
1889 ;; Use input fields. Note that, unlike the behavior of
1890 ;; `line-beginning-position' inside a field, this function will
1891 ;; return the position of the end of a prompt, even if the point is
1892 ;; already inside the prompt. In order to do this, it assumes that
1893 ;; if there are two fields on a line, then the first one is the
1894 ;; prompt, and the second one is an input field, and is front-sticky
1895 ;; (as input fields should be).
1896 (constrain-to-field (line-beginning-position) (line-end-position))))
1898 (defun comint-bol (&optional arg)
1899 "Go to the beginning of line, then skip past the prompt, if any.
1900 If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
1901 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1902 prompt skip is done by skipping text matching the regular expression
1903 `comint-prompt-regexp', a buffer local variable."
1906 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1908 (goto-char (comint-line-beginning-position))))
1910 ;; For compatibility.
1911 (defun comint-read-noecho (prompt &optional ignore)
1912 (read-passwd prompt))
1914 ;; These three functions are for entering text you don't want echoed or
1915 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1916 ;; Just enter m-x send-invisible and type in your line.
1918 (defun send-invisible (&optional prompt)
1919 "Read a string without echoing.
1920 Then send it to the process running in the current buffer.
1921 The string is sent using `comint-input-sender'.
1922 Security bug: your string can still be temporarily recovered with
1923 \\[view-lossage]; `clear-this-command-keys' can fix that."
1924 (interactive "P") ; Defeat snooping via C-x ESC ESC
1925 (let ((proc (get-buffer-process (current-buffer))))
1927 (let ((str (read-passwd (or prompt "Non-echoed text: "))))
1930 (comint-snapshot-last-prompt)
1931 (funcall comint-input-sender proc str))
1932 (message "Warning: text will be echoed")))
1933 (error "Current buffer has no process"))))
1935 (defun comint-watch-for-password-prompt (string)
1936 "Prompt in the minibuffer for password and send without echoing.
1937 This function uses `send-invisible' to read and send a password to the buffer's
1938 process if STRING contains a password prompt defined by
1939 `comint-password-prompt-regexp'.
1941 This function could be in the list `comint-output-filter-functions'."
1942 (when (string-match comint-password-prompt-regexp string)
1943 (when (string-match "^[ \n\r\t\v\f\b\a]+" string)
1944 (setq string (replace-match "" t t string)))
1945 (send-invisible string)))
1947 ;; Low-level process communication
1949 (defun comint-send-string (process string)
1950 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
1952 (with-current-buffer (if (processp process)
1953 (process-buffer process)
1954 (get-buffer process))
1955 (comint-snapshot-last-prompt))
1956 (comint-snapshot-last-prompt))
1957 (process-send-string process string))
1959 (defun comint-send-region (process start end)
1960 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
1962 (with-current-buffer (if (processp process)
1963 (process-buffer process)
1964 (get-buffer process))
1965 (comint-snapshot-last-prompt))
1966 (comint-snapshot-last-prompt))
1967 (process-send-region process start end))
1970 ;; Random input hackage
1972 (defun comint-delete-output ()
1973 "Delete all output from interpreter since last input.
1974 Does not delete the prompt."
1976 (let ((proc (get-buffer-process (current-buffer)))
1978 (inhibit-read-only t))
1980 (let ((pmark (progn (goto-char (process-mark proc))
1983 (delete-region comint-last-input-end pmark)
1984 (goto-char (process-mark proc))
1985 (setq replacement (concat "*** output flushed ***\n"
1986 (buffer-substring pmark (point))))
1987 (delete-region pmark (point))))
1988 ;; Output message and put back prompt
1989 (comint-output-filter proc replacement)))
1990 (defalias 'comint-kill-output 'comint-delete-output)
1991 (make-obsolete 'comint-kill-output 'comint-delete-output "21.1")
1993 (defun comint-write-output (filename &optional append mustbenew)
1994 "Write output from interpreter since last input to FILENAME.
1995 Any prompt at the end of the output is not written.
1997 If the optional argument APPEND (the prefix argument when interactive)
1998 is non-nil, the output is appended to the file instead.
2000 If the optional argument MUSTBENEW is non-nil, check for an existing
2001 file with the same name. If MUSTBENEW is `excl', that means to get an
2002 error if the file already exists; never overwrite. If MUSTBENEW is
2003 neither nil nor `excl', that means ask for confirmation before
2004 overwriting, but do go ahead and overwrite the file if the user
2005 confirms. When interactive, MUSTBENEW is nil when appending, and t
2008 (list (read-file-name
2009 (if current-prefix-arg
2010 "Append output to file: "
2011 "Write output to file: "))
2013 (not current-prefix-arg)))
2015 (goto-char (process-mark (get-buffer-process (current-buffer))))
2017 (write-region comint-last-input-end (point) filename
2018 append nil nil mustbenew)))
2020 ;; This function exists for the benefit of the menu; from the keyboard,
2021 ;; users can just use `comint-write-output' with a prefix arg.
2022 (defun comint-append-output-to-file (filename)
2023 "Append output from interpreter since last input to FILENAME.
2024 Any prompt at the end of the output is not written."
2025 (interactive "fAppend output to file: ")
2026 (comint-write-output filename t))
2028 (defun comint-show-output ()
2029 "Display start of this batch of interpreter output at top of window.
2030 Sets mark to the value of point when this command is run."
2033 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
2034 (cond (comint-use-prompt-regexp-instead-of-fields
2036 (beginning-of-line 0)
2037 (set-window-start (selected-window) (point))
2038 (comint-skip-prompt))
2040 (goto-char (field-beginning pos))
2041 (set-window-start (selected-window) (point))))))
2044 (defun comint-interrupt-subjob ()
2045 "Interrupt the current subjob.
2046 This command also kills the pending input
2047 between the process mark and point."
2050 (interrupt-process nil comint-ptyp)
2051 ;; (process-send-string nil "\n")
2054 (defun comint-kill-subjob ()
2055 "Send kill signal to the current subjob.
2056 This command also kills the pending input
2057 between the process mark and point."
2060 (kill-process nil comint-ptyp))
2062 (defun comint-quit-subjob ()
2063 "Send quit signal to the current subjob.
2064 This command also kills the pending input
2065 between the process mark and point."
2068 (quit-process nil comint-ptyp))
2070 (defun comint-stop-subjob ()
2071 "Stop the current subjob.
2072 This command also kills the pending input
2073 between the process mark and point.
2075 WARNING: if there is no current subjob, you can end up suspending
2076 the top-level process running in the buffer. If you accidentally do
2077 this, use \\[comint-continue-subjob] to resume the process. (This
2078 is not a problem with most shells, since they ignore this signal.)"
2081 (stop-process nil comint-ptyp))
2083 (defun comint-continue-subjob ()
2084 "Send CONT signal to process buffer's process group.
2085 Useful if you accidentally suspend the top-level process."
2087 (continue-process nil comint-ptyp))
2089 (defun comint-skip-input ()
2090 "Skip all pending input, from last stuff output by interpreter to point.
2091 This means mark it as if it had been sent as input, without sending it."
2092 (let ((comint-input-sender 'ignore)
2093 (comint-input-filter-functions nil))
2094 (comint-send-input t t))
2097 (marker (process-mark (get-buffer-process (current-buffer)))))
2098 (insert " " (key-description (this-command-keys)))
2100 (set-marker marker (point)))))
2102 (defun comint-kill-input ()
2103 "Kill all text from last stuff output by interpreter to point."
2105 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2106 (if (> (point) (marker-position pmark))
2107 (kill-region pmark (point)))))
2109 (defun comint-delchar-or-maybe-eof (arg)
2110 "Delete ARG characters forward or send an EOF to subprocess.
2111 Sends an EOF only if point is at the end of the buffer and there is no input."
2113 (let ((proc (get-buffer-process (current-buffer))))
2114 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
2116 (delete-char arg))))
2118 (defun comint-send-eof ()
2119 "Send an EOF to the current buffer's process."
2121 (comint-send-input t t)
2125 (defun comint-backward-matching-input (regexp n)
2126 "Search backward through buffer for input fields that match REGEXP.
2127 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2128 fields are identified by lines that match `comint-prompt-regexp'.
2130 With prefix argument N, search for Nth previous match.
2131 If N is negative, find the next or Nth next match."
2132 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2133 (if comint-use-prompt-regexp-instead-of-fields
2134 ;; Use comint-prompt-regexp
2135 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2136 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2137 (if (re-search-backward re nil t n)
2140 (progn (message "Not found")
2145 (let* ((dir (if (< n 0) -1 1))
2149 (unless (re-search-backward regexp nil t dir)
2150 (error "Not found"))
2151 (when (eq (get-char-property (point) 'field) 'input)
2152 (setq n (- n dir))))
2153 (field-beginning))))
2157 (defun comint-forward-matching-input (regexp arg)
2158 "Search forward through buffer for input fields that match REGEXP.
2159 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2160 fields are identified by lines that match `comint-prompt-regexp'.
2162 With prefix argument N, search for Nth following match.
2163 If N is negative, find the previous or Nth previous match."
2164 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2165 (comint-backward-matching-input regexp (- arg)))
2168 (defun comint-next-prompt (n)
2169 "Move to end of Nth next prompt in the buffer.
2170 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2171 the beginning of the Nth next `input' field, otherwise, it means the Nth
2172 occurrence of text matching `comint-prompt-regexp'."
2174 (if comint-use-prompt-regexp-instead-of-fields
2175 ;; Use comint-prompt-regexp
2176 (let ((paragraph-start comint-prompt-regexp))
2177 (end-of-line (if (> n 0) 1 0))
2178 (forward-paragraph n)
2179 (comint-skip-prompt))
2188 (next-single-char-property-change pos 'field)
2189 (previous-single-char-property-change pos 'field)))
2190 (cond ((or (null pos) (= pos prev-pos))
2191 ;; Ran off the end of the buffer.
2193 ;; There's always an input field at the end of the
2194 ;; buffer, but it has a `field' property of nil.
2195 (setq input-pos (point-max)))
2198 ((eq (get-char-property pos 'field) 'input)
2199 (setq n (if (< n 0) (1+ n) (1- n)))
2200 (setq input-pos pos))))
2202 (goto-char input-pos)))))
2205 (defun comint-previous-prompt (n)
2206 "Move to end of Nth previous prompt in the buffer.
2207 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2208 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2209 occurrence of text matching `comint-prompt-regexp'."
2211 (comint-next-prompt (- n)))
2213 ;; State used by `comint-insert-previous-argument' when cycling.
2214 (defvar comint-insert-previous-argument-last-start-pos nil)
2215 (make-variable-buffer-local 'comint-insert-previous-argument-last-start-pos)
2216 (defvar comint-insert-previous-argument-last-index nil)
2217 (make-variable-buffer-local 'comint-insert-previous-argument-last-index)
2220 ;; make comint-arguments understand negative indices as bash does
2221 (defun comint-insert-previous-argument (index)
2222 "Insert the INDEXth argument from the previous Comint command-line at point.
2223 Spaces are added at beginning and/or end of the inserted string if
2224 necessary to ensure that it's separated from adjacent arguments.
2225 Interactively, if no prefix argument is given, the last argument is inserted.
2226 Repeated interactive invocations will cycle through the same argument
2227 from progressively earlier commands (using the value of INDEX specified
2228 with the first command).
2229 This command is like `M-.' in bash."
2231 (unless (null index)
2232 (setq index (prefix-numeric-value index)))
2233 (cond ((eq last-command this-command)
2234 ;; Delete last input inserted by this command.
2235 (delete-region comint-insert-previous-argument-last-start-pos (point))
2236 (setq index comint-insert-previous-argument-last-index))
2238 ;; This is a non-repeat invocation, so initialize state.
2239 (setq comint-input-ring-index nil)
2240 (setq comint-insert-previous-argument-last-index index)
2241 (when (null comint-insert-previous-argument-last-start-pos)
2242 ;; First usage; initialize to a marker
2243 (setq comint-insert-previous-argument-last-start-pos
2245 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2246 (if (<= (point) (comint-line-beginning-position))
2249 ;; Remember the beginning of what we insert, so we can delete it if
2250 ;; the command is repeated.
2251 (set-marker comint-insert-previous-argument-last-start-pos (point))
2252 ;; Insert the argument.
2253 (let ((input-string (comint-previous-input-string 0)))
2254 (when (string-match "[ \t\n]*&" input-string)
2255 ;; strip terminating '&'
2256 (setq input-string (substring input-string 0 (match-beginning 0))))
2257 (insert (comint-arguments input-string index index)))
2258 ;; Make next invocation return arg from previous input
2259 (setq comint-input-ring-index (1+ (or comint-input-ring-index 0)))
2260 ;; Add a terminating space if necessary.
2265 ;; Support editing with `comint-prompt-read-only' set to t.
2267 (defun comint-update-fence ()
2268 "Update read-only status of newline before point.
2269 The `fence' read-only property is used to indicate that a newline
2270 is read-only for no other reason than to \"fence off\" a
2271 following front-sticky read-only region. This is used to
2272 implement comint read-only prompts. If the text after a newline
2273 changes, the read-only status of that newline may need updating.
2274 That is what this function does.
2276 This function does nothing if point is not at the beginning of a
2277 line, or is at the beginning of the accessible portion of the buffer.
2278 Otherwise, if the character after point has a front-sticky
2279 read-only property, then the preceding newline is given a
2280 read-only property of `fence', unless it already is read-only.
2281 If the character after point does not have a front-sticky
2282 read-only property, any read-only property of `fence' on the
2283 preceding newline is removed."
2284 (let* ((pt (point)) (lst (get-text-property pt 'front-sticky))
2285 (inhibit-modification-hooks t))
2288 (if (and (get-text-property pt 'read-only)
2289 (if (listp lst) (memq 'read-only lst) t))
2290 (unless (get-text-property (1- pt) 'read-only)
2291 (put-text-property (1- pt) pt 'read-only 'fence))
2292 (when (eq (get-text-property (1- pt) 'read-only) 'fence)
2293 (remove-list-of-text-properties (1- pt) pt '(read-only)))))))
2295 (defun comint-kill-whole-line (&optional arg)
2296 "Kill current line, ignoring read-only and field properties.
2297 With prefix arg, kill that many lines starting from the current line.
2298 If arg is negative, kill backward. Also kill the preceding newline,
2299 instead of the trailing one. \(This is meant to make \\[repeat] work well
2300 with negative arguments.)
2301 If arg is zero, kill current line but exclude the trailing newline.
2302 The read-only status of newlines is updated with `comint-update-fence',
2305 (let ((inhibit-read-only t) (inhibit-field-text-motion t))
2306 (kill-whole-line arg)
2307 (when (>= arg 0) (comint-update-fence))))
2309 (defun comint-kill-region (beg end &optional yank-handler)
2310 "Like `kill-region', but ignores read-only properties, if safe.
2311 This command assumes that the buffer contains read-only
2312 \"prompts\" which are regions with front-sticky read-only
2313 properties at the beginning of a line, with the preceding newline
2314 being read-only to protect the prompt. This is true of the
2315 comint prompts if `comint-prompt-read-only' is non-nil. This
2316 command will not delete the region if this would create mutilated
2317 or out of place prompts. That is, if any part of a prompt is
2318 deleted, the entire prompt must be deleted and all remaining
2319 prompts should stay at the beginning of a line. If this is not
2320 the case, this command just calls `kill-region' with all
2321 read-only properties intact. The read-only status of newlines is
2322 updated using `comint-update-fence', if necessary."
2325 (let* ((true-beg (min beg end))
2326 (true-end (max beg end))
2327 (beg-bolp (progn (goto-char true-beg) (bolp)))
2328 (beg-lst (get-text-property true-beg 'front-sticky))
2329 (beg-bad (and (get-text-property true-beg 'read-only)
2330 (if (listp beg-lst) (memq 'read-only beg-lst) t)))
2331 (end-bolp (progn (goto-char true-end) (bolp)))
2332 (end-lst (get-text-property true-end 'front-sticky))
2333 (end-bad (and (get-text-property true-end 'read-only)
2334 (if (listp end-lst) (memq 'read-only end-lst) t))))
2335 (if (or (and (not beg-bolp) (or beg-bad end-bad))
2336 (and (not end-bolp) end-bad))
2337 (kill-region beg end yank-handler)
2338 (let ((inhibit-read-only t))
2339 (kill-region beg end yank-handler)
2340 (comint-update-fence))))))
2343 ;; Support for source-file processing commands.
2344 ;;============================================================================
2345 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2346 ;; commands that process files of source text (e.g. loading or compiling
2347 ;; files). So the corresponding process-in-a-buffer modes have commands
2348 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2349 ;; for defining these commands.
2351 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2352 ;; and Soar, in that they don't know anything about file extensions.
2353 ;; So the compile/load interface gets the wrong default occasionally.
2354 ;; The load-file/compile-file default mechanism could be smarter -- it
2355 ;; doesn't know about the relationship between filename extensions and
2356 ;; whether the file is source or executable. If you compile foo.lisp
2357 ;; with compile-file, then the next load-file should use foo.bin for
2358 ;; the default, not foo.lisp. This is tricky to do right, particularly
2359 ;; because the extension for executable files varies so much (.o, .bin,
2360 ;; .lbin, .mo, .vo, .ao, ...).
2363 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2366 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2367 ;; want to save the buffer before issuing any process requests to the command
2370 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2371 ;; for the file to process.
2373 (defun comint-source-default (previous-dir/file source-modes)
2374 "Compute the defaults for `load-file' and `compile-file' commands.
2376 PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2377 source-file processing command. nil if there hasn't been one yet.
2378 SOURCE-MODES is a list used to determine what buffers contain source
2379 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2380 Typically, (lisp-mode) or (scheme-mode).
2382 If the command is given while the cursor is inside a string, *and*
2383 the string is an existing filename, *and* the filename is not a directory,
2384 then the string is taken as default. This allows you to just position
2385 your cursor over a string that's a filename and have it taken as default.
2387 If the command is given in a file buffer whose major mode is in
2388 SOURCE-MODES, then the filename is the default file, and the
2389 file's directory is the default directory.
2391 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2392 then the default directory & file are what was used in the last source-file
2393 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2394 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2395 is the cwd, with no default file. (\"no default file\" = nil)
2397 SOURCE-REGEXP is typically going to be something like (tea-mode)
2398 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2399 for Soar programs, etc.
2401 The function returns a pair: (default-directory . default-file)."
2402 (cond ((and buffer-file-name (memq major-mode source-modes))
2403 (cons (file-name-directory buffer-file-name)
2404 (file-name-nondirectory buffer-file-name)))
2407 (cons default-directory nil))))
2410 (defun comint-check-source (fname)
2411 "Check whether to save buffers visiting file FNAME.
2412 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2413 process-in-a-buffer modes), this function can be called on the filename.
2414 If the file is loaded into a buffer, and the buffer is modified, the user
2415 is queried to see if he wants to save the buffer before proceeding with
2416 the load or compile."
2417 (let ((buff (get-file-buffer fname)))
2419 (buffer-modified-p buff)
2420 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
2422 (let ((old-buffer (current-buffer)))
2425 (set-buffer old-buffer)))))
2427 (defun comint-extract-string ()
2428 "Return string around POINT, or nil."
2429 (let ((syntax (syntax-ppss)))
2430 (when (nth 3 syntax)
2432 (buffer-substring-no-properties (1+ (nth 8 syntax))
2433 (progn (goto-char (nth 8 syntax))
2438 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2439 "Prompt for filenames in commands that process source files,
2440 e.g. loading or compiling a file.
2441 Provides a default, if there is one, and returns the result filename.
2443 See `comint-source-default' for more on determining defaults.
2445 PROMPT is the prompt string. PREV-DIR/FILE is the (DIRECTORY . FILE) pair
2446 from the last source processing command. SOURCE-MODES is a list of major
2447 modes used to determine what file buffers contain source files. (These
2448 two arguments are used for determining defaults). If MUSTMATCH-P is true,
2449 then the filename reader will only accept a file that exists.
2452 (interactive (comint-get-source \"Compile file: \" prev-lisp-dir/file
2454 (let* ((def (comint-source-default prev-dir/file source-modes))
2455 (stringfile (comint-extract-string))
2456 (sfile-p (and stringfile
2458 (file-exists-p stringfile)
2460 (not (file-directory-p stringfile))))
2461 (defdir (if sfile-p (file-name-directory stringfile)
2463 (deffile (if sfile-p (file-name-nondirectory stringfile)
2465 (ans (read-file-name (if deffile (format "%s(default %s) "
2469 (concat defdir deffile)
2471 (list (expand-file-name (substitute-in-file-name ans)))))
2473 ;; I am somewhat divided on this string-default feature. It seems
2474 ;; to violate the principle-of-least-astonishment, in that it makes
2475 ;; the default harder to predict, so you actually have to look and see
2476 ;; what the default really is before choosing it. This can trip you up.
2477 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2482 ;; Simple process query facility.
2483 ;; ===========================================================================
2484 ;; This function is for commands that want to send a query to the process
2485 ;; and show the response to the user. For example, a command to get the
2486 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2487 ;; to an inferior Common Lisp process.
2489 ;; This simple facility just sends strings to the inferior process and pops
2490 ;; up a window for the process buffer so you can see what the process
2491 ;; responds with. We don't do anything fancy like try to intercept what the
2492 ;; process responds with and put it in a pop-up window or on the message
2493 ;; line. We just display the buffer. Low tech. Simple. Works good.
2495 (defun comint-proc-query (proc str)
2496 "Send to the inferior process PROC the string STR.
2497 Pop-up but do not select a window for the inferior process so that
2498 its response can be seen."
2499 (let* ((proc-buf (process-buffer proc))
2500 (proc-mark (process-mark proc)))
2501 (display-buffer proc-buf)
2502 (set-buffer proc-buf) ; but it's not the selected *window*
2503 (let ((proc-win (get-buffer-window proc-buf))
2504 (proc-pt (marker-position proc-mark)))
2505 (comint-send-string proc str) ; send the query
2506 (accept-process-output proc) ; wait for some output
2507 ;; Try to position the proc window so you can see the answer.
2508 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2509 ;; I don't know why. Wizards invited to improve it.
2510 (unless (pos-visible-in-window-p proc-pt proc-win)
2511 (let ((opoint (window-point proc-win)))
2512 (set-window-point proc-win proc-mark)
2514 (if (not (pos-visible-in-window-p opoint proc-win))
2516 (set-window-point proc-win opoint)))))))
2519 ;; Filename/command/history completion in a buffer
2520 ;; ===========================================================================
2521 ;; Useful completion functions, courtesy of the Ergo group.
2524 ;; comint-dynamic-complete Complete or expand command, filename,
2525 ;; history at point.
2526 ;; comint-dynamic-complete-filename Complete filename at point.
2527 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2528 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2529 ;; replace with expanded/completed name.
2530 ;; comint-dynamic-simple-complete Complete stub given candidates.
2532 ;; These are not installed in the comint-mode keymap. But they are
2533 ;; available for people who want them. Shell-mode installs them:
2534 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2535 ;; (define-key shell-mode-map "\M-?"
2536 ;; 'comint-dynamic-list-filename-completions)))
2538 ;; Commands like this are fine things to put in load hooks if you
2539 ;; want them present in specific modes.
2541 (defcustom comint-completion-autolist nil
2542 "*If non-nil, automatically list possibilities on partial completion.
2543 This mirrors the optional behavior of tcsh."
2545 :group 'comint-completion)
2547 (defcustom comint-completion-addsuffix t
2548 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2549 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2550 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2551 This mirrors the optional behavior of tcsh."
2552 :type '(choice (const :tag "None" nil)
2553 (const :tag "Add /" t)
2554 (cons :tag "Suffix pair"
2555 (string :tag "Directory suffix")
2556 (string :tag "File suffix")))
2557 :group 'comint-completion)
2559 (defcustom comint-completion-recexact nil
2560 "*If non-nil, use shortest completion if characters cannot be added.
2561 This mirrors the optional behavior of tcsh.
2563 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2565 :group 'comint-completion)
2567 (defcustom comint-completion-fignore nil
2568 "*List of suffixes to be disregarded during file completion.
2569 This mirrors the optional behavior of bash and tcsh.
2571 Note that this applies to `comint-dynamic-complete-filename' only."
2572 :type '(repeat (string :tag "Suffix"))
2573 :group 'comint-completion)
2575 (defvar comint-file-name-prefix ""
2576 "Prefix prepended to absolute file names taken from process input.
2577 This is used by Comint's and shell's completion functions, and by shell's
2578 directory tracking functions.")
2580 (defvar comint-file-name-chars
2581 (if (memq system-type '(ms-dos windows-nt cygwin))
2582 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2583 "[]~/A-Za-z0-9+@:_.$#%,={}-")
2584 "String of characters valid in a file name.
2585 Note that all non-ASCII characters are considered valid in a file name
2586 regardless of what this variable says.
2588 This is a good thing to set in mode hooks.")
2590 (defvar comint-file-name-quote-list nil
2591 "List of characters to quote with `\\' when in a file name.
2593 This is a good thing to set in mode hooks.")
2596 (defun comint-directory (directory)
2597 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
2598 (expand-file-name (if (file-name-absolute-p directory)
2599 (concat comint-file-name-prefix directory)
2603 (defun comint-word (word-chars)
2604 "Return the word of WORD-CHARS at point, or nil if none is found.
2605 Word constituents are considered to be those in WORD-CHARS, which is like the
2606 inside of a \"[...]\" (see `skip-chars-forward'),
2607 plus all non-ASCII characters."
2609 (let ((here (point))
2612 (let ((startpoint (point)))
2613 (skip-chars-backward (concat "\\\\" word-chars))
2614 ;; Fixme: This isn't consistent with Bash, at least -- not
2615 ;; all non-ASCII chars should be word constituents.
2616 (if (and (> (- (point) 2) (point-min))
2617 (= (char-after (- (point) 2)) ?\\))
2619 (if (and (> (- (point) 1) (point-min))
2620 (>= (char-after (- (point) 1)) 128))
2622 (if (= (point) startpoint)
2624 ;; Set match-data to match the entire string.
2625 (when (< (point) here)
2626 (set-match-data (list (point) here))
2627 (match-string 0)))))
2629 (defun comint-substitute-in-file-name (filename)
2630 "Return FILENAME with environment variables substituted.
2631 Supports additional environment variable syntax of the command
2632 interpreter (e.g., the percent notation of cmd.exe on NT)."
2633 (let ((name (substitute-in-file-name filename)))
2634 (if (memq system-type '(ms-dos windows-nt))
2638 (while (string-match "%\\([^\\\\/]*\\)%" name)
2640 (substring name (match-beginning 1) (match-end 1)))
2641 (setq env-var-val (if (getenv env-var-name)
2642 (getenv env-var-name)
2644 (setq name (replace-match env-var-val t t name))))))
2647 (defun comint-match-partial-filename ()
2648 "Return the filename at point, or nil if non is found.
2649 Environment variables are substituted. See `comint-word'."
2650 (let ((filename (comint-word comint-file-name-chars)))
2651 (and filename (comint-substitute-in-file-name
2652 (comint-unquote-filename filename)))))
2655 (defun comint-quote-filename (filename)
2656 "Return FILENAME with magic characters quoted.
2657 Magic characters are those in `comint-file-name-quote-list'."
2658 (if (null comint-file-name-quote-list)
2662 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
2665 (while (string-match regexp filename i)
2666 (setq filename (replace-match "\\\\\\&" nil nil filename))
2667 (setq i (1+ (match-end 0)))))
2670 (defun comint-unquote-filename (filename)
2671 "Return FILENAME with quoted characters unquoted."
2672 (if (null comint-file-name-quote-list)
2676 (while (string-match "\\\\\\(.\\)" filename i)
2677 (setq filename (replace-match "\\1" nil nil filename))
2678 (setq i (+ 1 (match-beginning 0)))))
2682 (defun comint-dynamic-complete ()
2683 "Dynamically perform completion at point.
2684 Calls the functions in `comint-dynamic-complete-functions' to perform
2685 completion until a function returns non-nil, at which point completion is
2686 assumed to have occurred."
2688 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
2691 (defun comint-dynamic-complete-filename ()
2692 "Dynamically complete the filename at point.
2693 Completes if after a filename. See `comint-match-partial-filename' and
2694 `comint-dynamic-complete-as-filename'.
2695 This function is similar to `comint-replace-by-expanded-filename', except that
2696 it won't change parts of the filename already entered in the buffer; it just
2697 adds completion characters to the end of the filename. A completions listing
2698 may be shown in a help buffer if completion is ambiguous.
2700 Completion is dependent on the value of `comint-completion-addsuffix',
2701 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2702 completions listing is dependent on the value of `comint-completion-autolist'.
2704 Returns t if successful."
2706 (when (comint-match-partial-filename)
2707 (unless (window-minibuffer-p (selected-window))
2708 (message "Completing file name..."))
2709 (comint-dynamic-complete-as-filename)))
2711 (defun comint-dynamic-complete-as-filename ()
2712 "Dynamically complete at point as a filename.
2713 See `comint-dynamic-complete-filename'. Returns t if successful."
2714 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2715 (completion-ignored-extensions comint-completion-fignore)
2716 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2717 ;; I think it was originally bound to solve file completion problems,
2718 ;; but subsequent changes may have made this unnecessary. sm.
2719 ;;(file-name-handler-alist nil)
2720 (minibuffer-p (window-minibuffer-p (selected-window)))
2722 (dirsuffix (cond ((not comint-completion-addsuffix)
2724 ((not (consp comint-completion-addsuffix))
2727 (car comint-completion-addsuffix))))
2728 (filesuffix (cond ((not comint-completion-addsuffix)
2730 ((not (consp comint-completion-addsuffix))
2733 (cdr comint-completion-addsuffix))))
2734 (filename (or (comint-match-partial-filename) ""))
2735 (filedir (file-name-directory filename))
2736 (filenondir (file-name-nondirectory filename))
2737 (directory (if filedir (comint-directory filedir) default-directory))
2738 (completion (file-name-completion filenondir directory)))
2739 (cond ((null completion)
2740 (message "No completions of %s" filename)
2742 ((eq completion t) ; Means already completed "file".
2744 (unless minibuffer-p
2745 (message "Sole completion")))
2746 ((string-equal completion "") ; Means completion on "directory/".
2747 (comint-dynamic-list-filename-completions))
2748 (t ; Completion string returned.
2749 (let ((file (concat (file-name-as-directory directory) completion)))
2750 (insert (comint-quote-filename
2751 (substring (directory-file-name completion)
2752 (length filenondir))))
2753 (cond ((symbolp (file-name-completion completion directory))
2754 ;; We inserted a unique completion.
2755 (insert (if (file-directory-p file) dirsuffix filesuffix))
2756 (unless minibuffer-p
2757 (message "Completed")))
2758 ((and comint-completion-recexact comint-completion-addsuffix
2759 (string-equal filenondir completion)
2760 (file-exists-p file))
2761 ;; It's not unique, but user wants shortest match.
2762 (insert (if (file-directory-p file) dirsuffix filesuffix))
2763 (unless minibuffer-p
2764 (message "Completed shortest")))
2765 ((or comint-completion-autolist
2766 (string-equal filenondir completion))
2767 ;; It's not unique, list possible completions.
2768 (comint-dynamic-list-filename-completions))
2770 (unless minibuffer-p
2771 (message "Partially completed")))))))
2775 (defun comint-replace-by-expanded-filename ()
2776 "Dynamically expand and complete the filename at point.
2777 Replace the filename with an expanded, canonicalised and completed replacement.
2778 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
2779 with the corresponding directories. \"Canonicalised\" means `..' and `.' are
2780 removed, and the filename is made absolute instead of relative. For expansion
2781 see `expand-file-name' and `substitute-in-file-name'. For completion see
2782 `comint-dynamic-complete-filename'."
2784 (let ((filename (comint-match-partial-filename)))
2786 (replace-match (expand-file-name filename) t t)
2787 (comint-dynamic-complete-filename))))
2790 (defun comint-dynamic-simple-complete (stub candidates)
2791 "Dynamically complete STUB from CANDIDATES list.
2792 This function inserts completion characters at point by completing STUB from
2793 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2794 if completion is ambiguous.
2796 Returns nil if no completion was inserted.
2797 Returns `sole' if completed with the only completion match.
2798 Returns `shortest' if completed with the shortest of the completion matches.
2799 Returns `partial' if completed as far as possible with the completion matches.
2800 Returns `listed' if a completion listing was shown.
2802 See also `comint-dynamic-complete-filename'."
2803 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2804 (suffix (cond ((not comint-completion-addsuffix) "")
2805 ((not (consp comint-completion-addsuffix)) " ")
2806 (t (cdr comint-completion-addsuffix))))
2807 (completions (all-completions stub candidates)))
2808 (cond ((null completions)
2809 (message "No completions of %s" stub)
2811 ((= 1 (length completions)) ; Gotcha!
2812 (let ((completion (car completions)))
2813 (if (string-equal completion stub)
2814 (message "Sole completion")
2815 (insert (substring completion (length stub)))
2816 (message "Completed"))
2819 (t ; There's no unique completion.
2820 (let ((completion (try-completion stub candidates)))
2821 ;; Insert the longest substring.
2822 (insert (substring completion (length stub)))
2823 (cond ((and comint-completion-recexact comint-completion-addsuffix
2824 (string-equal stub completion)
2825 (member completion completions))
2826 ;; It's not unique, but user wants shortest match.
2828 (message "Completed shortest")
2830 ((or comint-completion-autolist
2831 (string-equal stub completion))
2832 ;; It's not unique, list possible completions.
2833 (comint-dynamic-list-completions completions)
2836 (message "Partially completed")
2840 (defun comint-dynamic-list-filename-completions ()
2841 "List in help buffer possible completions of the filename at point."
2843 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2844 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2845 ;; I think it was originally bound to solve file completion problems,
2846 ;; but subsequent changes may have made this unnecessary. sm.
2847 ;;(file-name-handler-alist nil)
2848 (filename (or (comint-match-partial-filename) ""))
2849 (filedir (file-name-directory filename))
2850 (filenondir (file-name-nondirectory filename))
2851 (directory (if filedir (comint-directory filedir) default-directory))
2852 (completions (file-name-all-completions filenondir directory)))
2853 (if (not completions)
2854 (message "No completions of %s" filename)
2855 (comint-dynamic-list-completions
2856 (mapcar 'comint-quote-filename completions)))))
2859 ;; This is bound locally in a *Completions* buffer to the list of
2860 ;; completions displayed, and is used to detect the case where the same
2861 ;; command is repeatedly used without the set of completions changing.
2862 (defvar comint-displayed-dynamic-completions nil)
2864 (defvar comint-dynamic-list-completions-config nil)
2866 (defun comint-dynamic-list-completions (completions)
2867 "List in help buffer sorted COMPLETIONS.
2868 Typing SPC flushes the help buffer."
2869 (let ((window (get-buffer-window "*Completions*")))
2870 (setq completions (sort completions 'string-lessp))
2871 (if (and (eq last-command this-command)
2872 window (window-live-p window) (window-buffer window)
2873 (buffer-name (window-buffer window))
2874 ;; The above tests are not sufficient to detect the case where we
2875 ;; should scroll, because the top-level interactive command may
2876 ;; not have displayed a completions window the last time it was
2877 ;; invoked, and there may be such a window left over from a
2878 ;; previous completion command with a different set of
2879 ;; completions. To detect that case, we also test that the set
2880 ;; of displayed completions is in fact the same as the previously
2883 (buffer-local-value 'comint-displayed-dynamic-completions
2884 (window-buffer window))))
2885 ;; If this command was repeated, and
2886 ;; there's a fresh completion window with a live buffer,
2887 ;; and this command is repeated, scroll that window.
2888 (with-current-buffer (window-buffer window)
2889 (if (pos-visible-in-window-p (point-max) window)
2890 (set-window-start window (point-min))
2891 (save-selected-window
2892 (select-window window)
2895 ;; Display a completion list for the first time.
2896 (setq comint-dynamic-list-completions-config
2897 (current-window-configuration))
2898 (with-output-to-temp-buffer "*Completions*"
2899 (display-completion-list completions))
2900 (message "Type space to flush; repeat completion command to scroll"))
2902 ;; Read the next key, to process SPC.
2904 (if (with-current-buffer (get-buffer "*Completions*")
2905 (set (make-local-variable 'comint-displayed-dynamic-completions)
2907 (setq key (read-key-sequence nil)
2909 (and (consp first) (consp (event-start first))
2910 (eq (window-buffer (posn-window (event-start first)))
2911 (get-buffer "*Completions*"))
2912 (eq (key-binding key) 'mouse-choose-completion)))
2913 ;; If the user does mouse-choose-completion with the mouse,
2914 ;; execute the command, then delete the completion window.
2916 (mouse-choose-completion first)
2917 (set-window-configuration comint-dynamic-list-completions-config))
2918 (unless (eq first ?\ )
2919 (setq unread-command-events (listify-key-sequence key)))
2920 (unless (eq first ?\t)
2921 (set-window-configuration comint-dynamic-list-completions-config))))))
2924 (defun comint-get-next-from-history ()
2925 "After fetching a line from input history, this fetches the following line.
2926 In other words, this recalls the input line after the line you recalled last.
2927 You can use this to repeat a sequence of input lines."
2929 (if comint-save-input-ring-index
2931 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
2932 (comint-next-input 1))
2933 (message "No previous history command")))
2935 (defun comint-accumulate ()
2936 "Accumulate a line to send as input along with more lines.
2937 This inserts a newline so that you can enter more text
2938 to be sent along with this line. Use \\[comint-send-input]
2939 to send all the accumulated input, at once.
2940 The entire accumulated text becomes one item in the input history
2944 (set-marker comint-accum-marker (point))
2945 (if comint-input-ring-index
2946 (setq comint-save-input-ring-index
2947 (- comint-input-ring-index 1))))
2949 (defun comint-goto-process-mark ()
2950 "Move point to the process mark.
2951 The process mark separates output, and input already sent,
2952 from input that has not yet been sent."
2954 (let ((proc (or (get-buffer-process (current-buffer))
2955 (error "Current buffer has no process"))))
2956 (goto-char (process-mark proc))
2957 (when (interactive-p)
2958 (message "Point is now at the process mark"))))
2960 (defun comint-bol-or-process-mark ()
2961 "Move point to beginning of line (after prompt) or to the process mark.
2962 The first time you use this command, it moves to the beginning of the line
2963 \(but after the prompt, if any). If you repeat it again immediately,
2964 it moves point to the process mark.
2966 The process mark separates the process output, along with input already sent,
2967 from input that has not yet been sent. Ordinarily, the process mark
2968 is at the beginning of the current input line; but if you have
2969 used \\[comint-accumulate] to send multiple lines at once,
2970 the process mark is at the beginning of the accumulated input."
2972 (if (not (eq last-command 'comint-bol-or-process-mark))
2974 (comint-goto-process-mark)))
2976 (defun comint-set-process-mark ()
2977 "Set the process mark at point."
2979 (let ((proc (or (get-buffer-process (current-buffer))
2980 (error "Current buffer has no process"))))
2981 (set-marker (process-mark proc) (point))
2982 (message "Process mark set")))
2985 ;; Author: Peter Breton <pbreton@cs.umb.edu>
2987 ;; This little add-on for comint is intended to make it easy to get
2988 ;; output from currently active comint buffers into another buffer,
2989 ;; or buffers, and then go back to using the comint shell.
2991 ;; My particular use is SQL interpreters; I want to be able to execute a
2992 ;; query using the process associated with a comint-buffer, and save that
2993 ;; somewhere else. Because the process might have state (for example, it
2994 ;; could be in an uncommitted transaction), just running starting a new
2995 ;; process and having it execute the query and then finish, would not
2996 ;; work. I'm sure there are other uses as well, although in many cases
2997 ;; starting a new process is the simpler, and thus preferable, approach.
2999 ;; The basic implementation is as follows: comint-redirect changes the
3000 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
3001 ;; its own filter. The filter puts the output into the designated buffer,
3002 ;; or buffers, until it sees a regexp that tells it to stop (by default,
3003 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
3004 ;; sees the stop regexp, it restores the old filter functions, and runs
3005 ;; `comint-redirect-hook'.
3007 ;; Each comint buffer may only use one redirection at a time, but any number
3008 ;; of different comint buffers may be simultaneously redirected.
3010 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
3011 ;; correct prompt for your interpreter, or that you supply a regexp that says
3012 ;; when the redirection is finished. Otherwise, redirection will continue
3013 ;; indefinitely. The code now does a sanity check to ensure that it can find
3014 ;; a prompt in the comint buffer; however, it is still important to ensure that
3015 ;; this prompt is set correctly.
3017 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
3018 ;; perhaps it should prompt for a terminating string (with an
3019 ;; appropriate magic default by examining what we think is the prompt)?
3021 ;; Fixme: look for appropriate fields, rather than regexp, if
3022 ;; `comint-use-prompt-regexp-instead-of-fields' is true.
3024 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3026 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3028 (defcustom comint-redirect-verbose nil
3029 "*If non-nil, print messages each time the redirection filter is invoked.
3030 Also print a message when redirection is completed."
3034 ;; Directly analagous to comint-preoutput-filter-functions
3035 (defvar comint-redirect-filter-functions nil
3036 "List of functions to call before inserting redirected process output.
3037 Each function gets one argument, a string containing the text received
3038 from the subprocess. It should return the string to insert, perhaps
3039 the same string that was received, or perhaps a modified or transformed
3042 The functions on the list are called sequentially, and each one is given
3043 the string returned by the previous one. The string returned by the
3044 last function is the text that is actually inserted in the redirection buffer.
3046 You can use `add-hook' to add functions to this list
3047 either globally or locally.")
3049 ;; Internal variables
3051 (defvar comint-redirect-output-buffer nil
3052 "The buffer or list of buffers to put output into.")
3054 (defvar comint-redirect-finished-regexp nil
3055 "Regular expression that determines when to stop redirection in Comint.
3056 When the redirection filter function is given output that matches this regexp,
3057 the output is inserted as usual, and redirection is completed.")
3059 (defvar comint-redirect-insert-matching-regexp nil
3060 "If non-nil, the text that ends a redirection is included in it.
3061 More precisely, the text that matches `comint-redirect-finished-regexp'
3062 and therefore terminates an output redirection is inserted in the
3063 redirection target buffer, along with the preceding output.")
3065 (defvar comint-redirect-echo-input nil
3066 "Non-nil means echo input in the process buffer even during redirection.")
3068 (defvar comint-redirect-completed nil
3069 "Non-nil if redirection has completed in the current buffer.")
3071 (defvar comint-redirect-original-mode-line-process nil
3072 "Original mode line for redirected process.")
3074 (defvar comint-redirect-perform-sanity-check t
3075 "If non-nil, check that redirection is likely to complete successfully.
3076 More precisely, before starting a redirection, verify that the
3077 regular expression `comint-redirect-finished-regexp' that controls
3078 when to terminate it actually matches some text already in the process
3079 buffer. The idea is that this regular expression should match a prompt
3080 string, and that there ought to be at least one copy of your prompt string
3081 in the process buffer already.")
3083 (defvar comint-redirect-original-filter-function nil
3084 "The process filter that was in place when redirection is started.
3085 When redirection is completed, the process filter is restored to
3088 (defvar comint-redirect-subvert-readonly nil
3089 "Non-nil means comint-redirect can insert into otherwise-readonly buffers.
3090 The readonly status is toggled around insertion.
3091 This is useful, for instance, for insertion into Help mode buffers.
3092 You probably want to set it locally to the output buffer.")
3094 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3096 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3098 (defun comint-redirect-setup (output-buffer
3101 &optional echo-input)
3102 "Set up for output redirection.
3103 This function sets local variables that are used by `comint-redirect-filter'
3104 to perform redirection.
3106 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3107 in the output matches FINISHED-REGEXP.
3109 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3110 original Comint buffer.
3112 This function is called by `comint-redirect-send-command-to-process',
3113 and does not normally need to be invoked by the end user or programmer."
3114 (with-current-buffer comint-buffer
3116 (make-local-variable 'comint-redirect-original-mode-line-process)
3117 (setq comint-redirect-original-mode-line-process mode-line-process)
3119 (make-local-variable 'comint-redirect-output-buffer)
3120 (setq comint-redirect-output-buffer output-buffer)
3122 (make-local-variable 'comint-redirect-finished-regexp)
3123 (setq comint-redirect-finished-regexp finished-regexp)
3125 (make-local-variable 'comint-redirect-echo-input)
3126 (setq comint-redirect-echo-input echo-input)
3128 (make-local-variable 'comint-redirect-completed)
3129 (setq comint-redirect-completed nil)
3131 (setq mode-line-process
3132 (if mode-line-process
3133 (list (concat (elt mode-line-process 0) " Redirection"))
3134 (list ":%s Redirection")))))
3136 (defun comint-redirect-cleanup ()
3137 "End a Comint redirection. See `comint-redirect-send-command'."
3139 ;; Restore the process filter
3140 (set-process-filter (get-buffer-process (current-buffer))
3141 comint-redirect-original-filter-function)
3142 ;; Restore the mode line
3143 (setq mode-line-process comint-redirect-original-mode-line-process)
3144 ;; Set the completed flag
3145 (setq comint-redirect-completed t))
3147 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3148 ;; that it really occurs.
3149 (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
3151 (defun comint-redirect-filter (process input-string)
3152 "Filter function which redirects output from PROCESS to a buffer or buffers.
3153 The variable `comint-redirect-output-buffer' says which buffer(s) to
3156 INPUT-STRING is the input from the Comint process.
3158 This function runs as a process filter, and does not need to be invoked by the
3161 (with-current-buffer (process-buffer process)
3162 (comint-redirect-preoutput-filter input-string)
3163 ;; If we have to echo output, give it to the original filter function
3164 (and comint-redirect-echo-input
3165 comint-redirect-original-filter-function
3166 (funcall comint-redirect-original-filter-function
3167 process input-string)))))
3170 (defun comint-redirect-preoutput-filter (input-string)
3171 "Comint filter function which redirects Comint output 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 does not need to be invoked by the end user."
3178 (let ((output-buffer-list
3179 (if (listp comint-redirect-output-buffer)
3180 comint-redirect-output-buffer
3181 (list comint-redirect-output-buffer)))
3182 (filtered-input-string input-string))
3184 ;; If there are any filter functions, give them a chance to modify the string
3185 (let ((functions comint-redirect-filter-functions))
3186 (while (and functions filtered-input-string)
3187 (if (eq (car functions) t)
3188 ;; If a local value says "use the default value too",
3190 (let ((functions (default-value 'comint-redirect-filter-functions)))
3191 (while (and functions filtered-input-string)
3192 (setq filtered-input-string
3193 (funcall (car functions) filtered-input-string))
3194 (setq functions (cdr functions))))
3195 (setq filtered-input-string
3196 (funcall (car functions) filtered-input-string)))
3197 (setq functions (cdr functions))))
3199 ;; Clobber `comint-redirect-finished-regexp'
3200 (or comint-redirect-insert-matching-regexp
3201 (and (string-match comint-redirect-finished-regexp filtered-input-string)
3202 (setq filtered-input-string
3203 (replace-match "" nil nil filtered-input-string))))
3205 ;; Send output to all registered buffers
3207 (dolist (buf output-buffer-list)
3208 ;; Set this buffer to the output buffer
3209 (set-buffer (get-buffer-create buf))
3210 ;; Go to the end of the buffer
3211 (goto-char (point-max))
3212 ;; Insert the output
3213 (let ((inhibit-read-only comint-redirect-subvert-readonly))
3214 (insert filtered-input-string))))
3217 (and comint-redirect-verbose
3218 (message "Redirected output to buffer(s) %s"
3219 (mapconcat 'identity output-buffer-list " ")))
3221 ;; If we see the prompt, tidy up
3222 ;; We'll look for the prompt in the original string, so nobody can
3224 (and (string-match comint-redirect-finished-regexp input-string)
3226 (and comint-redirect-verbose
3227 (message "Redirection completed"))
3228 (comint-redirect-cleanup)
3229 (run-hooks 'comint-redirect-hook)))
3231 (if comint-redirect-echo-input
3232 filtered-input-string
3236 (defun comint-redirect-send-command (command output-buffer echo &optional no-display)
3237 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3238 With prefix arg ECHO, echo output in process buffer.
3240 If NO-DISPLAY is non-nil, do not show the output buffer."
3241 (interactive "sCommand: \nBOutput Buffer: \nP")
3242 (let ((process (get-buffer-process (current-buffer))))
3244 (comint-redirect-send-command-to-process
3245 command output-buffer (current-buffer) echo no-display)
3246 (error "No process for current buffer"))))
3249 (defun comint-redirect-send-command-to-process
3250 (command output-buffer process echo &optional no-display)
3251 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3252 With prefix arg, echo output in process buffer.
3254 If NO-DISPLAY is non-nil, do not show the output buffer."
3255 (interactive "sCommand: \nBOutput Buffer: \nbProcess Buffer: \nP")
3256 (let* (;; The process buffer
3257 (process-buffer (if (processp process)
3258 (process-buffer process)
3260 (proc (get-buffer-process process-buffer)))
3261 ;; Change to the process buffer
3262 (with-current-buffer process-buffer
3264 ;; Make sure there's a prompt in the current process buffer
3265 (and comint-redirect-perform-sanity-check
3267 (goto-char (point-max))
3268 (or (re-search-backward comint-prompt-regexp nil t)
3269 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3271 ;;;;;;;;;;;;;;;;;;;;;
3272 ;; Set up for redirection
3273 ;;;;;;;;;;;;;;;;;;;;;
3274 (comint-redirect-setup
3280 comint-prompt-regexp
3284 ;;;;;;;;;;;;;;;;;;;;;
3286 ;;;;;;;;;;;;;;;;;;;;;
3287 ;; Save the old filter
3288 (setq comint-redirect-original-filter-function
3289 (process-filter proc))
3290 (set-process-filter proc 'comint-redirect-filter)
3292 ;;;;;;;;;;;;;;;;;;;;;
3294 ;;;;;;;;;;;;;;;;;;;;;
3295 (process-send-string
3297 (concat command "\n"))
3299 ;;;;;;;;;;;;;;;;;;;;;
3301 ;;;;;;;;;;;;;;;;;;;;;
3305 (if (listp output-buffer)
3307 output-buffer)))))))
3310 (defun comint-redirect-results-list (command regexp regexp-group)
3311 "Send COMMAND to current process.
3312 Return a list of expressions in the output which match REGEXP.
3313 REGEXP-GROUP is the regular expression group in REGEXP to use."
3314 (comint-redirect-results-list-from-process
3315 (get-buffer-process (current-buffer))
3316 command regexp regexp-group))
3319 (defun comint-redirect-results-list-from-process (process command regexp regexp-group)
3320 "Send COMMAND to PROCESS.
3321 Return a list of expressions in the output which match REGEXP.
3322 REGEXP-GROUP is the regular expression group in REGEXP to use."
3323 (let ((output-buffer " *Comint Redirect Work Buffer*")
3326 (set-buffer (get-buffer-create output-buffer))
3328 (comint-redirect-send-command-to-process command
3329 output-buffer process nil t)
3330 ;; Wait for the process to complete
3331 (set-buffer (process-buffer process))
3332 (while (null comint-redirect-completed)
3333 (accept-process-output nil 1))
3334 ;; Collect the output
3335 (set-buffer output-buffer)
3336 (goto-char (point-min))
3337 ;; Skip past the command, if it was echoed
3338 (and (looking-at command)
3340 (while (re-search-forward regexp nil t)
3342 (cons (buffer-substring-no-properties
3343 (match-beginning regexp-group)
3344 (match-end regexp-group))
3349 (add-to-list 'debug-ignored-errors x))
3350 '("^Not at command line$"
3351 "^Empty input ring$"
3353 "^Not found$" ; Too common?
3354 "^Current buffer has no process$"))
3357 ;; Converting process modes to use comint mode
3358 ;; ===========================================================================
3359 ;; The code in the Emacs 19 distribution has all been modified to use comint
3360 ;; where needed. However, there are `third-party' packages out there that
3361 ;; still use the old shell mode. Here's a guide to conversion.
3363 ;; Renaming variables
3364 ;; Most of the work is renaming variables and functions. These are the common
3367 ;; last-input-start comint-last-input-start
3368 ;; last-input-end comint-last-input-end
3369 ;; shell-prompt-pattern comint-prompt-regexp
3370 ;; shell-set-directory-error-hook <no equivalent>
3372 ;; shell-set-directory <unnecessary>
3373 ;; shell-mode-map comint-mode-map
3375 ;; shell-send-input comint-send-input
3376 ;; shell-send-eof comint-delchar-or-maybe-eof
3377 ;; kill-shell-input comint-kill-input
3378 ;; interrupt-shell-subjob comint-interrupt-subjob
3379 ;; stop-shell-subjob comint-stop-subjob
3380 ;; quit-shell-subjob comint-quit-subjob
3381 ;; kill-shell-subjob comint-kill-subjob
3382 ;; kill-output-from-shell comint-delete-output
3383 ;; show-output-from-shell comint-show-output
3384 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3386 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3387 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3388 ;; Comint mode does not provide functionality equivalent to
3389 ;; shell-set-directory-error-hook; it is gone.
3391 ;; comint-last-input-start is provided for modes which want to munge
3392 ;; the buffer after input is sent, perhaps because the inferior
3393 ;; insists on echoing the input. The LAST-INPUT-START variable in
3394 ;; the old shell package was used to implement a history mechanism,
3395 ;; but you should think twice before using comint-last-input-start
3396 ;; for this; the input history ring often does the job better.
3398 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3399 ;; *not* create the comint-mode local variables in your foo-mode function.
3400 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3401 ;; necessary comint-specific local variables. Then create the
3402 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3403 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3404 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3405 ;; get-old-input) that need to be different from the defaults. Call
3406 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3407 ;; comint-mode will take care of it. The following example, from shell.el,
3410 ;; (defvar shell-mode-map '())
3411 ;; (cond ((not shell-mode-map)
3412 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3413 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3414 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3415 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3416 ;; (define-key shell-mode-map "\M-?"
3417 ;; 'comint-dynamic-list-filename-completions)))
3419 ;; (defun shell-mode ()
3422 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3423 ;; (setq major-mode 'shell-mode)
3424 ;; (setq mode-name "Shell")
3425 ;; (use-local-map shell-mode-map)
3426 ;; (make-local-variable 'shell-directory-stack)
3427 ;; (setq shell-directory-stack nil)
3428 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3429 ;; (run-hooks 'shell-mode-hook))
3432 ;; Completion for comint-mode users
3434 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3435 ;; hook to add completion functions to. Functions on this list should return
3436 ;; non-nil if completion occurs (i.e., further completion should not occur).
3437 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3443 ;; arch-tag: 1793314c-09db-40be-9549-9aeae3e75164
3444 ;;; comint.el ends here