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 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 '((((background dark
)) (:foreground
"cyan"))
232 (t (:foreground
"dark blue")))
233 "Face to use to highlight prompts."
236 (defcustom comint-input-ignoredups nil
237 "*If non-nil, don't add input matching the last on the input ring.
238 This mirrors the optional behavior of bash.
240 This variable is buffer-local."
244 (defcustom comint-input-ring-file-name nil
245 "*If non-nil, name of the file to read/write input history.
246 See also `comint-read-input-ring' and `comint-write-input-ring'.
248 This variable is buffer-local, and is a good thing to set in mode hooks."
249 :type
'(choice (const :tag
"nil" nil
)
253 (defcustom comint-scroll-to-bottom-on-input nil
254 "*Controls whether input to interpreter causes window to scroll.
255 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
256 If `this', scroll only the selected window.
260 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
261 :type
'(choice (const :tag
"off" nil
)
267 (defcustom comint-move-point-for-output nil
268 "*Controls whether interpreter output moves point to the end of the output.
269 If nil, then output never moves point to the output.
270 (If the output occurs at point, it is inserted before point.)
271 If t or `all', move point in all windows showing the buffer.
272 If `this', move point only the selected window.
273 If `others', move point only in other windows, not in the selected window.
277 See the variable `comint-scroll-show-maximum-output' and the function
278 `comint-postoutput-scroll-to-bottom'.
279 This variable is buffer-local in all Comint buffers."
280 :type
'(choice (const :tag
"off" nil
)
287 (defvaralias 'comint-scroll-to-bottom-on-output
'comint-move-point-for-output
)
289 (defcustom comint-scroll-show-maximum-output t
290 "*Controls how to scroll due to interpreter output.
291 This variable applies when point is at the end of the buffer
292 \(either because it was originally there, or because
293 `comint-move-point-for-output' said to move it there)
294 and output from the subprocess is inserted.
296 Non-nil means scroll so that the window is full of text
297 and point is on the last line. A value of nil
298 means don't do anything special--scroll normally.
300 See also the variable `comint-move-point-for-output' and the function
301 `comint-postoutput-scroll-to-bottom'.
302 This variable is buffer-local in all Comint buffers."
306 (defcustom comint-buffer-maximum-size
1024
307 "*The maximum size in lines for Comint buffers.
308 Comint buffers are truncated from the top to be no greater than this number, if
309 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
313 (defvar comint-input-ring-size
150
314 "Size of input history ring.")
316 (defvar comint-input-ring-separator
"\n"
317 "Separator between commands in the history file.")
319 (defvar comint-input-history-ignore
"^#"
320 "Regexp for history entries that should be ignored when Comint initializes.")
322 (defcustom comint-process-echoes nil
323 "*If non-nil, assume that the subprocess echoes any input.
324 If so, delete one copy of the input so that only one copy eventually
325 appears in the buffer.
327 This variable is buffer-local."
331 ;; AIX puts the name of the person being su'd to in front of the prompt.
332 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
333 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
334 ;; ssh-add prints a prompt like `Enter passphrase: '.
335 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
336 (defcustom comint-password-prompt-regexp
337 "\\(\\([Oo]ld \\|[Nn]ew \\|'s \\|login \\|\
338 Kerberos \\|CVS \\|UNIX \\| SMB \\|^\\)\
339 \[Pp]assword\\( (again)\\)?\\|\
340 pass phrase\\|\\(Enter\\|Repeat\\) passphrase\\)\
341 \\( for [^:]+\\)?:\\s *\\'"
342 "*Regexp matching prompts for passwords in the inferior process.
343 This is used by `comint-watch-for-password-prompt'."
347 ;; Here are the per-interpreter hooks.
348 (defvar comint-get-old-input
(function comint-get-old-input-default
)
349 "Function that returns old text in Comint mode.
350 This function is called when return is typed while the point is in old
351 text. It returns the text to be submitted as process input. The
352 default is `comint-get-old-input-default', which either grabs the
353 current input field or grabs the current line and strips off leading
354 text matching `comint-prompt-regexp', depending on the value of
355 `comint-use-prompt-regexp-instead-of-fields'.")
357 (defvar comint-dynamic-complete-functions
358 '(comint-replace-by-expanded-history comint-dynamic-complete-filename
)
359 "List of functions called to perform completion.
360 Functions should return non-nil if completion was performed.
361 See also `comint-dynamic-complete'.
363 This is a good thing to set in mode hooks.")
365 (defvar comint-input-filter
366 (function (lambda (str) (not (string-match "\\`\\s *\\'" str
))))
367 "Predicate for filtering additions to input history.
368 Takes one argument, the input. If non-nil, the input may be saved on the input
369 history list. Default is to save anything that isn't all whitespace.")
371 (defvar comint-input-filter-functions
'()
372 "Abnormal hook run before input is sent to the process.
373 These functions get one argument, a string containing the text to send.")
375 (defvar comint-output-filter-functions
'(comint-postoutput-scroll-to-bottom comint-watch-for-password-prompt
)
376 "Functions to call after output is inserted into the buffer.
377 One possible function is `comint-postoutput-scroll-to-bottom'.
378 These functions get one argument, a string containing the text as originally
379 inserted. Note that this might not be the same as the buffer contents between
380 `comint-last-output-start' and the buffer's `process-mark', if other filter
381 functions have already modified the buffer.
383 See also `comint-preoutput-filter-functions'.
385 You can use `add-hook' to add functions to this list
386 either globally or locally.")
388 (defvar comint-input-sender-no-newline nil
389 "Non-nil directs the `comint-input-sender' function not to send a newline.")
391 (defvar comint-input-sender
(function comint-simple-send
)
392 "Function to actually send to PROCESS the STRING submitted by user.
393 Usually this is just `comint-simple-send', but if your mode needs to
394 massage the input string, put a different function here.
395 `comint-simple-send' just sends the string plus a newline.
396 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
397 This is called from the user command `comint-send-input'.")
399 (defcustom comint-eol-on-send t
400 "*Non-nil means go to the end of the line before sending input.
401 See `comint-send-input'."
405 ;; Note: If it is decided to purge comint-prompt-regexp from the source
406 ;; entirely, searching for uses of this variable will help to identify
407 ;; places that need attention.
408 (defcustom comint-use-prompt-regexp-instead-of-fields nil
409 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
410 If nil, then program output and user-input are given different `field'
411 properties, which Emacs commands can use to distinguish them (in
412 particular, common movement commands such as begining-of-line respect
413 field boundaries in a natural way)."
417 (defcustom comint-mode-hook
'(turn-on-font-lock)
418 "Hook run upon entry to `comint-mode'.
419 This is run before the process is cranked up."
423 (defcustom comint-exec-hook
'()
424 "Hook run each time a process is exec'd by `comint-exec'.
425 This is called after the process is cranked up. It is useful for things that
426 must be done each time a process is executed in a Comint mode buffer (e.g.,
427 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
428 executed once when the buffer is created."
432 (defvar comint-mode-map
433 (let ((map (make-sparse-keymap)))
435 (define-key map
"\ep" 'comint-previous-input
)
436 (define-key map
"\en" 'comint-next-input
)
437 (define-key map
[C-up
] 'comint-previous-input
)
438 (define-key map
[C-down
] 'comint-next-input
)
439 (define-key map
"\er" 'comint-previous-matching-input
)
440 (define-key map
"\es" 'comint-next-matching-input
)
441 (define-key map
[?\C-c ?\M-r
] 'comint-previous-matching-input-from-input
)
442 (define-key map
[?\C-c ?\M-s
] 'comint-next-matching-input-from-input
)
443 (define-key map
"\e\C-l" 'comint-show-output
)
444 (define-key map
"\C-m" 'comint-send-input
)
445 (define-key map
"\C-d" 'comint-delchar-or-maybe-eof
)
446 (define-key map
"\C-c " 'comint-accumulate
)
447 (define-key map
"\C-c\C-x" 'comint-get-next-from-history
)
448 (define-key map
"\C-c\C-a" 'comint-bol-or-process-mark
)
449 (define-key map
"\C-c\C-u" 'comint-kill-input
)
450 (define-key map
"\C-c\C-w" 'backward-kill-word
)
451 (define-key map
"\C-c\C-c" 'comint-interrupt-subjob
)
452 (define-key map
"\C-c\C-z" 'comint-stop-subjob
)
453 (define-key map
"\C-c\C-\\" 'comint-quit-subjob
)
454 (define-key map
"\C-c\C-m" 'comint-insert-input
)
455 (define-key map
"\C-c\C-o" 'comint-delete-output
)
456 (define-key map
"\C-c\C-r" 'comint-show-output
)
457 (define-key map
"\C-c\C-e" 'comint-show-maximum-output
)
458 (define-key map
"\C-c\C-l" 'comint-dynamic-list-input-ring
)
459 (define-key map
"\C-c\C-n" 'comint-next-prompt
)
460 (define-key map
"\C-c\C-p" 'comint-previous-prompt
)
461 (define-key map
"\C-c\C-d" 'comint-send-eof
)
462 (define-key map
"\C-c\C-s" 'comint-write-output
)
463 (define-key map
"\C-c." 'comint-insert-previous-argument
)
465 (define-key map
[mouse-2
] 'comint-insert-input
)
468 (define-key map
[menu-bar completion
]
469 (cons "Complete" (make-sparse-keymap "Complete")))
470 (define-key map
[menu-bar completion complete-expand
]
471 '("Expand File Name" . comint-replace-by-expanded-filename
))
472 (define-key map
[menu-bar completion complete-listing
]
473 '("File Completion Listing" . comint-dynamic-list-filename-completions
))
474 (define-key map
[menu-bar completion complete-file
]
475 '("Complete File Name" . comint-dynamic-complete-filename
))
476 (define-key map
[menu-bar completion complete
]
477 '("Complete Before Point" . comint-dynamic-complete
))
479 (define-key map
[menu-bar inout
]
480 (cons "In/Out" (make-sparse-keymap "In/Out")))
481 (define-key map
[menu-bar inout delete-output
]
482 '("Delete Current Output Group" . comint-delete-output
))
483 (define-key map
[menu-bar inout append-output-to-file
]
484 '("Append Current Output Group to File" . comint-append-output-to-file
))
485 (define-key map
[menu-bar inout write-output
]
486 '("Write Current Output Group to File" . comint-write-output
))
487 (define-key map
[menu-bar inout next-prompt
]
488 '("Forward Output Group" . comint-next-prompt
))
489 (define-key map
[menu-bar inout previous-prompt
]
490 '("Backward Output Group" . comint-previous-prompt
))
491 (define-key map
[menu-bar inout show-maximum-output
]
492 '("Show Maximum Output" . comint-show-maximum-output
))
493 (define-key map
[menu-bar inout show-output
]
494 '("Show Current Output Group" . comint-show-output
))
495 (define-key map
[menu-bar inout kill-input
]
496 '("Kill Current Input" . comint-kill-input
))
497 (define-key map
[menu-bar inout copy-input
]
498 '("Copy Old Input" . comint-insert-input
))
499 (define-key map
[menu-bar inout forward-matching-history
]
500 '("Forward Matching Input..." . comint-forward-matching-input
))
501 (define-key map
[menu-bar inout backward-matching-history
]
502 '("Backward Matching Input..." . comint-backward-matching-input
))
503 (define-key map
[menu-bar inout next-matching-history
]
504 '("Next Matching Input..." . comint-next-matching-input
))
505 (define-key map
[menu-bar inout previous-matching-history
]
506 '("Previous Matching Input..." . comint-previous-matching-input
))
507 (define-key map
[menu-bar inout next-matching-history-from-input
]
508 '("Next Matching Current Input" . comint-next-matching-input-from-input
))
509 (define-key map
[menu-bar inout previous-matching-history-from-input
]
510 '("Previous Matching Current Input" . comint-previous-matching-input-from-input
))
511 (define-key map
[menu-bar inout next-history
]
512 '("Next Input" . comint-next-input
))
513 (define-key map
[menu-bar inout previous-history
]
514 '("Previous Input" . comint-previous-input
))
515 (define-key map
[menu-bar inout list-history
]
516 '("List Input History" . comint-dynamic-list-input-ring
))
517 (define-key map
[menu-bar inout expand-history
]
518 '("Expand History Before Point" . comint-replace-by-expanded-history
))
520 (let ((signals-map (make-sparse-keymap "Signals")))
521 (define-key map
[menu-bar signals
] (cons "Signals" signals-map
))
522 (define-key signals-map
[eof] '("EOF" . comint-send-eof))
523 (define-key signals-map [kill] '("KILL" . comint-kill-subjob))
524 (define-key signals-map [quit] '("QUIT" . comint-quit-subjob))
525 (define-key signals-map [cont] '("CONT" . comint-continue-subjob))
526 (define-key signals-map [stop] '("STOP" . comint-stop-subjob))
527 (define-key signals-map [break] '("BREAK" . comint-interrupt-subjob)))
528 ;; Put them in the menu bar:
529 (setq menu-bar-final-items (append '(completion inout signals)
530 menu-bar-final-items))
533 ;; Fixme: Is this still relevant?
534 (defvar comint-ptyp t
535 "Non-nil if communications via pty; false if by pipe. Buffer local.
536 This is to work around a bug in Emacs process signaling.")
538 (defvar comint-input-ring nil)
539 (defvar comint-last-input-start nil)
540 (defvar comint-last-input-end nil)
541 (defvar comint-last-output-start nil)
542 (defvar comint-input-ring-index nil
543 "Index of last matched history element.")
544 (defvar comint-matching-input-from-input-string ""
545 "Input previously used to match input history.")
546 (defvar comint-save-input-ring-index
547 "Last input ring index which you copied.
548 This is to support the command \\[comint-get-next-from-history].")
550 (defvar comint-accum-marker nil
551 "Non-nil if you are accumulating input lines to send as input together.
552 The command \\[comint-accumulate] sets this.")
554 (put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
555 (put 'comint-input-ring 'permanent-local t)
556 (put 'comint-input-ring-index 'permanent-local t)
557 (put 'comint-save-input-ring-index 'permanent-local t)
558 (put 'comint-input-autoexpand 'permanent-local t)
559 (put 'comint-input-filter-functions 'permanent-local t)
560 (put 'comint-output-filter-functions 'permanent-local t)
561 (put 'comint-preoutput-filter-functions 'permanent-local t)
562 (put 'comint-scroll-to-bottom-on-input 'permanent-local t)
563 (put 'comint-move-point-for-output 'permanent-local t)
564 (put 'comint-scroll-show-maximum-output 'permanent-local t)
565 (put 'comint-ptyp 'permanent-local t)
567 (put 'comint-mode 'mode-class 'special)
569 (define-derived-mode comint-mode fundamental-mode "Comint"
570 "Major mode for interacting with an inferior interpreter.
571 Interpreter name is same as buffer name, sans the asterisks.
572 Return at end of buffer sends line as input.
573 Return not at end copies rest of line to end and sends it.
574 Setting variable `comint-eol-on-send' means jump to the end of the line
575 before submitting new input.
577 This mode is customised to create major modes such as Inferior Lisp
578 mode, Shell mode, etc. This can be done by setting the hooks
579 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
580 and `comint-get-old-input' to appropriate functions, and the variable
581 `comint-prompt-regexp' to the appropriate regular expression.
583 An input history is maintained of size `comint-input-ring-size', and
584 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
585 Input ring history expansion can be achieved with the commands
586 \\[comint-replace-by-expanded-history] or \\[comint-magic-space].
587 Input ring expansion is controlled by the variable `comint-input-autoexpand',
588 and addition is controlled by the variable `comint-input-ignoredups'.
590 Commands with no default key bindings include `send-invisible',
591 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
592 `comint-magic-space'.
594 Input to, and output from, the subprocess can cause the window to scroll to
595 the end of the buffer. See variables `comint-output-filter-functions',
596 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
597 and `comint-move-point-for-output'.
599 If you accidentally suspend your process, use \\[comint-continue-subjob]
604 Entry to this mode runs the hooks on `comint-mode-hook'."
605 (setq mode-line-process '(":%s"))
606 (set (make-local-variable 'comint-last-input-start) (point-min-marker))
607 (set (make-local-variable 'comint-last-input-end) (point-min-marker))
608 (set (make-local-variable 'comint-last-output-start) (make-marker))
609 (make-local-variable 'comint-last-prompt-overlay)
610 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
611 (make-local-variable 'comint-input-ring-size) ; ...to global val.
612 (make-local-variable 'comint-input-ring)
613 (make-local-variable 'comint-input-ring-file-name)
614 (or (and (boundp 'comint-input-ring) comint-input-ring)
615 (setq comint-input-ring (make-ring comint-input-ring-size)))
616 (make-local-variable 'comint-input-ring-index)
617 (make-local-variable 'comint-save-input-ring-index)
618 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
619 (setq comint-input-ring-index nil))
620 (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
621 (setq comint-save-input-ring-index nil))
622 (make-local-variable 'comint-matching-input-from-input-string)
623 (make-local-variable 'comint-input-autoexpand)
624 (make-local-variable 'comint-input-ignoredups)
625 (make-local-variable 'comint-delimiter-argument-list)
626 (make-local-variable 'comint-completion-fignore)
627 (make-local-variable 'comint-get-old-input)
628 (make-local-variable 'comint-input-filter)
629 (make-local-variable 'comint-input-sender)
630 (make-local-variable 'comint-eol-on-send)
631 (make-local-variable 'comint-scroll-to-bottom-on-input)
632 (make-local-variable 'comint-move-point-for-output)
633 (make-local-variable 'comint-scroll-show-maximum-output)
634 ;; This makes it really work to keep point at the bottom.
635 (make-local-variable 'scroll-conservatively)
636 (setq scroll-conservatively 10000)
637 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
638 (make-local-variable 'comint-ptyp)
639 (make-local-variable 'comint-process-echoes)
640 (make-local-variable 'comint-file-name-chars)
641 (make-local-variable 'comint-file-name-quote-list)
642 (set (make-local-variable 'comint-accum-marker) (make-marker))
643 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
644 ;; This behavior is not useful in comint buffers, and is annoying
645 (set (make-local-variable 'next-line-add-newlines) nil))
647 (defun comint-check-proc (buffer)
648 "Return t if there is a living process associated w/buffer BUFFER.
649 Living means the status is `open', `run', or `stop'.
650 BUFFER can be either a buffer or the name of one."
651 (let ((proc (get-buffer-process buffer)))
652 (and proc (memq (process-status proc) '(open run stop)))))
655 (defun make-comint-in-buffer (name buffer program &optional startfile &rest switches)
656 "Make a Comint process NAME in BUFFER, running PROGRAM.
657 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
658 PROGRAM should be either a string denoting an executable program to create
659 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
660 connection to be opened via `open-network-stream'. If there is already a
661 running process in that buffer, it is not restarted. Optional third arg
662 STARTFILE is the name of a file to send the contents of to the process.
664 If PROGRAM is a string, any more args are arguments to PROGRAM."
665 (or (fboundp 'start-process)
666 (error "Multi-processing is not supported for this system"))
667 (setq buffer (get-buffer-create (or buffer (concat "*" name "*"))))
668 ;; If no process, or nuked process, crank up a new one and put buffer in
669 ;; comint mode. Otherwise, leave buffer and existing process alone.
670 (unless (comint-check-proc buffer)
671 (with-current-buffer buffer
672 (unless (derived-mode-p 'comint-mode)
673 (comint-mode))) ; Install local vars, mode, keymap, ...
674 (comint-exec buffer name program startfile switches))
678 (defun make-comint (name program &optional startfile &rest switches)
679 "Make a Comint process NAME in a buffer, running PROGRAM.
680 The name of the buffer is made by surrounding NAME with `*'s.
681 PROGRAM should be either a string denoting an executable program to create
682 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
683 connection to be opened via `open-network-stream'. If there is already a
684 running process in that buffer, it is not restarted. Optional third arg
685 STARTFILE is the name of a file to send the contents of the process to.
687 If PROGRAM is a string, any more args are arguments to PROGRAM."
688 (apply #'make-comint-in-buffer name nil program startfile switches))
691 (defun comint-run (program)
692 "Run PROGRAM in a Comint buffer and switch to it.
693 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
694 The file name is used to make a symbol name, such as `comint-sh-hook', and any
695 hooks on this symbol are run in the buffer.
696 See `make-comint' and `comint-exec'."
697 (interactive "sRun program: ")
698 (let ((name (file-name-nondirectory program)))
699 (switch-to-buffer (make-comint name program))
700 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
702 (defun comint-exec (buffer name command startfile switches)
703 "Start up a process named NAME in buffer BUFFER for Comint modes.
704 Runs the given COMMAND with SWITCHES with output to STARTFILE.
705 Blasts any old process running in the buffer. Doesn't set the buffer mode.
706 You can use this to cheaply run a series of processes in the same Comint
707 buffer. The hook `comint-exec-hook' is run after each exec."
708 (with-current-buffer buffer
709 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
710 (if proc (delete-process proc)))
711 ;; Crank up a new process
714 (open-network-stream name buffer (car command) (cdr command))
715 (comint-exec-1 name buffer command switches))))
716 (set-process-filter proc 'comint-output-filter)
717 (make-local-variable 'comint-ptyp)
718 (setq comint-ptyp process-connection-type) ; t if pty, nil if pipe.
719 ;; Jump to the end, and set the process mark.
720 (goto-char (point-max))
721 (set-marker (process-mark proc) (point))
722 ;; Feed it the startfile.
724 ;;This is guaranteed to wait long enough
725 ;;but has bad results if the comint does not prompt at all
726 ;; (while (= size (buffer-size))
728 ;;I hope 1 second is enough!
730 (goto-char (point-max))
731 (insert-file-contents startfile)
732 (setq startfile (buffer-substring (point) (point-max)))
733 (delete-region (point) (point-max))
734 (comint-send-string proc startfile)))
735 (run-hooks 'comint-exec-hook)
738 ;; This auxiliary function cranks up the process for comint-exec in
739 ;; the appropriate environment.
741 (defun comint-exec-1 (name buffer command switches)
742 (let ((process-environment
744 ;; If using termcap, we specify `emacs' as the terminal type
745 ;; because that lets us specify a width.
746 ;; If using terminfo, we specify `dumb' because that is
747 ;; a defined terminal type. `emacs' is not a defined terminal type
748 ;; and there is no way for us to define it here.
749 ;; Some programs that use terminfo get very confused
750 ;; if TERM is not a valid terminal type.
751 ;; ;; There is similar code in compile.el.
752 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
753 (list "TERM=dumb" "TERMCAP="
754 (format "COLUMNS=%d" (window-width)))
756 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
757 (if (getenv "EMACS") nil (list "EMACS=t"))
758 process-environment))
760 (if (file-accessible-directory-p default-directory)
763 proc decoding encoding changed)
764 (let ((exec-path (if (file-name-directory command)
765 ;; If the command has slashes, make sure we
766 ;; first look relative to the current directory.
767 (cons default-directory exec-path) exec-path)))
768 (setq proc (apply 'start-process name buffer command switches)))
769 (let ((coding-systems (process-coding-system proc)))
770 (setq decoding (car coding-systems)
771 encoding (cdr coding-systems)))
772 ;; If start-process decided to use some coding system for decoding
773 ;; data sent from the process and the coding system doesn't
774 ;; specify EOL conversion, we had better convert CRLF to LF.
775 (if (vectorp (coding-system-eol-type decoding))
776 (setq decoding (coding-system-change-eol-conversion decoding 'dos)
778 ;; Even if start-process left the coding system for encoding data
779 ;; sent from the process undecided, we had better use the same one
780 ;; as what we use for decoding. But, we should suppress EOL
782 (if (and decoding (not encoding))
783 (setq encoding (coding-system-change-eol-conversion decoding 'unix)
786 (set-process-coding-system proc decoding encoding))
789 (defun comint-insert-input (&optional event)
790 "In a Comint buffer, set the current input to the previous input at point."
791 ;; This doesn't use "e" because it is supposed to work
792 ;; for events without parameters.
793 (interactive (list last-input-event))
794 (if event (mouse-set-point event))
796 (if (not (eq (get-char-property pos 'field) 'input))
797 ;; No input at POS, fall back to the global definition.
798 (let* ((keys (this-command-keys))
799 (last-key (and (vectorp keys) (aref keys (1- (length keys)))))
800 (fun (and last-key (lookup-key global-map (vector last-key)))))
801 (and fun (call-interactively fun)))
802 ;; There's previous input at POS, insert it at the end of the buffer.
803 (goto-char (point-max))
804 ;; First delete any old unsent input at the end
806 (or (marker-position comint-accum-marker)
807 (process-mark (get-buffer-process (current-buffer))))
809 ;; Insert the input at point
810 (insert (buffer-substring-no-properties
811 (previous-single-char-property-change (1+ pos) 'field)
812 (next-single-char-property-change pos 'field))))))
815 ;; Input history processing in a buffer
816 ;; ===========================================================================
817 ;; Useful input history functions, courtesy of the Ergo group.
820 ;; comint-dynamic-list-input-ring List history in help buffer.
821 ;; comint-previous-input Previous input...
822 ;; comint-previous-matching-input ...matching a string.
823 ;; comint-previous-matching-input-from-input ... matching the current input.
824 ;; comint-next-input Next input...
825 ;; comint-next-matching-input ...matching a string.
826 ;; comint-next-matching-input-from-input ... matching the current input.
827 ;; comint-backward-matching-input Backwards input...
828 ;; comint-forward-matching-input ...matching a string.
829 ;; comint-replace-by-expanded-history Expand history at point;
830 ;; replace with expanded history.
831 ;; comint-magic-space Expand history and insert space.
834 ;; comint-read-input-ring Read into comint-input-ring...
835 ;; comint-write-input-ring Write to comint-input-ring-file-name.
836 ;; comint-replace-by-expanded-history-before-point Workhorse function.
838 (defun comint-read-input-ring (&optional silent)
839 "Set the buffer's `comint-input-ring' from a history file.
840 The name of the file is given by the variable `comint-input-ring-file-name'.
841 The history ring is of size `comint-input-ring-size', regardless of file size.
842 If `comint-input-ring-file-name' is nil this function does nothing.
844 If the optional argument SILENT is non-nil, we say nothing about a
845 failure to read the history file.
847 This function is useful for major mode commands and mode hooks.
849 The commands stored in the history file are separated by the
850 `comint-input-ring-separator', and entries that match
851 `comint-input-history-ignore' are ignored. The most recent command
854 See also `comint-input-ignoredups' and `comint-write-input-ring'."
855 (cond ((or (null comint-input-ring-file-name)
856 (equal comint-input-ring-file-name ""))
858 ((not (file-readable-p comint-input-ring-file-name))
860 (message "Cannot read history file %s"
861 comint-input-ring-file-name)))
863 (let* ((history-buf (get-buffer-create " *temp*"))
864 (file comint-input-ring-file-name)
866 (size comint-input-ring-size)
867 (ring (make-ring size)))
870 (set-buffer history-buf)
873 (insert-file-contents file)
874 ;; Save restriction in case file is already visited...
875 ;; Watch for those date stamps in history files!
876 (goto-char (point-max))
877 (let (start end history)
878 (while (and (< count comint-input-ring-size)
879 (re-search-backward comint-input-ring-separator nil t)
880 (setq end (match-beginning 0)))
881 (if (re-search-backward comint-input-ring-separator nil t)
882 (setq start (match-end 0))
883 (setq start (point-min)))
884 (setq history (buffer-substring start end))
886 (if (and (not (string-match comint-input-history-ignore history))
887 (or (null comint-input-ignoredups)
889 (not (string-equal (ring-ref ring 0) history))))
891 (ring-insert-at-beginning ring history)
892 (setq count (1+ count)))))))
893 (kill-buffer history-buf))
894 (setq comint-input-ring ring
895 comint-input-ring-index nil)))))
897 (defun comint-write-input-ring ()
898 "Writes the buffer's `comint-input-ring' to a history file.
899 The name of the file is given by the variable `comint-input-ring-file-name'.
900 The original contents of the file are lost if `comint-input-ring' is not empty.
901 If `comint-input-ring-file-name' is nil this function does nothing.
903 Useful within process sentinels.
905 See also `comint-read-input-ring'."
906 (cond ((or (null comint-input-ring-file-name)
907 (equal comint-input-ring-file-name "")
908 (null comint-input-ring) (ring-empty-p comint-input-ring))
910 ((not (file-writable-p comint-input-ring-file-name))
911 (message "Cannot write history file %s" comint-input-ring-file-name))
913 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
914 (ring comint-input-ring)
915 (file comint-input-ring-file-name)
916 (index (ring-length ring)))
917 ;; Write it all out into a buffer first. Much faster, but messier,
918 ;; than writing it one line at a time.
920 (set-buffer history-buf)
923 (setq index (1- index))
924 (insert (ring-ref ring index) comint-input-ring-separator))
925 (write-region (buffer-string) nil file nil 'no-message)
926 (kill-buffer nil))))))
929 (defvar comint-dynamic-list-input-ring-window-conf)
931 (defun comint-dynamic-list-input-ring-select ()
932 "Choose the input history entry that point is in or next to."
934 (let (beg end completion (buffer completion-reference-buffer)
935 (base-size completion-base-size))
936 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
937 (setq end (point) beg (1+ (point))))
938 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
939 (setq end (1- (point)) beg (point)))
941 (error "No history entry here"))
942 (setq beg (previous-single-property-change beg 'mouse-face))
943 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
944 (setq completion (buffer-substring beg end))
945 (set-window-configuration comint-dynamic-list-input-ring-window-conf)
946 (choose-completion-string completion buffer base-size)))
948 (defun comint-dynamic-list-input-ring ()
949 "List in help buffer the buffer's input history."
951 (if (or (not (ring-p comint-input-ring))
952 (ring-empty-p comint-input-ring))
953 (message "No history")
955 (history-buffer " *Input History*")
956 (index (1- (ring-length comint-input-ring)))
957 (conf (current-window-configuration)))
958 ;; We have to build up a list ourselves from the ring vector.
960 (setq history (cons (ring-ref comint-input-ring index) history)
962 ;; Change "completion" to "history reference"
963 ;; to make the display accurate.
964 (with-output-to-temp-buffer history-buffer
965 (display-completion-list history)
966 (set-buffer history-buffer)
967 (let ((keymap (make-sparse-keymap)))
968 (set-keymap-parent keymap (current-local-map))
969 (define-key keymap "\C-m" 'comint-dynamic-list-input-ring-select)
970 (use-local-map keymap))
972 (while (search-backward "completion" nil 'move)
973 (replace-match "history reference")))
975 (message "Hit space to flush")
976 (setq comint-dynamic-list-input-ring-window-conf conf)
977 (let ((ch (read-event)))
979 (set-window-configuration conf)
980 (setq unread-command-events (list ch)))))))
983 (defun comint-regexp-arg (prompt)
984 "Return list of regexp and prefix arg using PROMPT."
985 (let* (;; Don't clobber this.
986 (last-command last-command)
987 (regexp (read-from-minibuffer prompt nil nil nil
988 'minibuffer-history-search-history)))
989 (list (if (string-equal regexp "")
990 (setcar minibuffer-history-search-history
991 (nth 1 minibuffer-history-search-history))
993 (prefix-numeric-value current-prefix-arg))))
995 (defun comint-search-arg (arg)
996 ;; First make sure there is a ring and that we are after the process mark
997 (cond ((not (comint-after-pmark-p))
998 (error "Not at command line"))
999 ((or (null comint-input-ring)
1000 (ring-empty-p comint-input-ring))
1001 (error "Empty input ring"))
1003 ;; arg of zero resets search from beginning, and uses arg of 1
1004 (setq comint-input-ring-index nil)
1009 (defun comint-search-start (arg)
1010 "Index to start a directional search, starting at `comint-input-ring-index'."
1011 (if comint-input-ring-index
1012 ;; If a search is running, offset by 1 in direction of arg
1013 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
1014 (ring-length comint-input-ring))
1015 ;; For a new search, start from beginning or end, as appropriate
1017 0 ; First elt for forward search
1018 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
1020 (defun comint-previous-input-string (arg)
1021 "Return the string ARG places along the input ring.
1022 Moves relative to `comint-input-ring-index'."
1023 (ring-ref comint-input-ring (if comint-input-ring-index
1024 (mod (+ arg comint-input-ring-index)
1025 (ring-length comint-input-ring))
1028 (defun comint-previous-input (arg)
1029 "Cycle backwards through input history."
1031 (comint-previous-matching-input "." arg))
1033 (defun comint-next-input (arg)
1034 "Cycle forwards through input history."
1036 (comint-previous-input (- arg)))
1038 (defun comint-previous-matching-input-string (regexp arg)
1039 "Return the string matching REGEXP ARG places along the input ring.
1040 Moves relative to `comint-input-ring-index'."
1041 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
1042 (if pos (ring-ref comint-input-ring pos))))
1044 (defun comint-previous-matching-input-string-position (regexp arg &optional start)
1045 "Return the index matching REGEXP ARG places along the input ring.
1046 Moves relative to START, or `comint-input-ring-index'."
1047 (if (or (not (ring-p comint-input-ring))
1048 (ring-empty-p comint-input-ring))
1049 (error "No history"))
1050 (let* ((len (ring-length comint-input-ring))
1051 (motion (if (> arg 0) 1 -1))
1052 (n (mod (- (or start (comint-search-start arg)) motion) len))
1053 (tried-each-ring-item nil)
1055 ;; Do the whole search as many times as the argument says.
1056 (while (and (/= arg 0) (not tried-each-ring-item))
1059 n (mod (+ n motion) len))
1060 ;; If we haven't reached a match, step some more.
1061 (while (and (< n len) (not tried-each-ring-item)
1062 (not (string-match regexp (ring-ref comint-input-ring n))))
1063 (setq n (mod (+ n motion) len)
1064 ;; If we have gone all the way around in this search.
1065 tried-each-ring-item (= n prev)))
1066 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1067 ;; Now that we know which ring element to use, if we found it, return that.
1068 (if (string-match regexp (ring-ref comint-input-ring n))
1071 (defun comint-previous-matching-input (regexp arg)
1072 "Search backwards through input history for match for REGEXP.
1073 \(Previous history elements are earlier commands.)
1074 With prefix argument N, search for Nth previous match.
1075 If N is negative, find the next or Nth next match."
1076 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1077 (setq arg (comint-search-arg arg))
1078 (let ((pos (comint-previous-matching-input-string-position regexp arg)))
1079 ;; Has a match been found?
1082 (setq comint-input-ring-index pos)
1083 (message "History item: %d" (1+ pos))
1085 ;; Can't use kill-region as it sets this-command
1086 (or (marker-position comint-accum-marker)
1087 (process-mark (get-buffer-process (current-buffer))))
1089 (insert (ring-ref comint-input-ring pos)))))
1091 (defun comint-next-matching-input (regexp arg)
1092 "Search forwards through input history for match for REGEXP.
1093 \(Later history elements are more recent commands.)
1094 With prefix argument N, search for Nth following match.
1095 If N is negative, find the previous or Nth previous match."
1096 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1097 (comint-previous-matching-input regexp (- arg)))
1099 (defun comint-previous-matching-input-from-input (arg)
1100 "Search backwards through input history for match for current input.
1101 \(Previous history elements are earlier commands.)
1102 With prefix argument N, search for Nth previous match.
1103 If N is negative, search forwards for the -Nth following match."
1105 (if (not (memq last-command '(comint-previous-matching-input-from-input
1106 comint-next-matching-input-from-input)))
1107 ;; Starting a new search
1108 (setq comint-matching-input-from-input-string
1110 (or (marker-position comint-accum-marker)
1111 (process-mark (get-buffer-process (current-buffer))))
1113 comint-input-ring-index nil))
1114 (comint-previous-matching-input
1115 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1118 (defun comint-next-matching-input-from-input (arg)
1119 "Search forwards through input history for match for current input.
1120 \(Following history elements are more recent commands.)
1121 With prefix argument N, search for Nth following match.
1122 If N is negative, search backwards for the -Nth previous match."
1124 (comint-previous-matching-input-from-input (- arg)))
1127 (defun comint-replace-by-expanded-history (&optional silent start)
1128 "Expand input command history references before point.
1129 Expansion is dependent on the value of `comint-input-autoexpand'.
1131 This function depends on the buffer's idea of the input history, which may not
1132 match the command interpreter's idea, assuming it has one.
1134 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1135 cannot know the interpreter's idea of input line numbers, assuming it has one,
1136 it cannot expand absolute input line number references.
1138 If the optional argument SILENT is non-nil, never complain
1139 even if history reference seems erroneous.
1141 If the optional argument START is non-nil, that specifies the
1142 start of the text to scan for history references, rather
1143 than the logical beginning of line.
1145 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1147 Returns t if successful."
1149 (if (and comint-input-autoexpand
1150 (if comint-use-prompt-regexp-instead-of-fields
1151 ;; Use comint-prompt-regexp
1154 (looking-at (concat comint-prompt-regexp "!\\|\\^")))
1155 ;; Use input fields. User input that hasn't been entered
1156 ;; yet, at the end of the buffer, has a nil `field' property.
1157 (and (null (get-char-property (point) 'field))
1158 (string-match "!\\|^\\^" (field-string)))))
1159 ;; Looks like there might be history references in the command.
1160 (let ((previous-modified-tick (buffer-modified-tick)))
1161 (comint-replace-by-expanded-history-before-point silent start)
1162 (/= previous-modified-tick (buffer-modified-tick)))))
1165 (defun comint-replace-by-expanded-history-before-point (silent &optional start)
1166 "Expand directory stack reference before point.
1167 See `comint-replace-by-expanded-history'. Returns t if successful.
1169 If the optional argument START is non-nil, that specifies the
1170 start of the text to scan for history references, rather
1171 than the logical beginning of line."
1173 (let ((toend (- (line-end-position) (point)))
1174 (start (or start (comint-line-beginning-position))))
1177 (skip-chars-forward "^!^" (- (line-end-position) toend))
1178 (< (point) (- (line-end-position) toend)))
1179 ;; This seems a bit complex. We look for references such as !!, !-num,
1180 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1181 ;; If that wasn't enough, the plings can be suffixed with argument
1182 ;; range specifiers.
1183 ;; Argument ranges are complex too, so we hive off the input line,
1184 ;; referenced with plings, with the range string to `comint-args'.
1185 (setq comint-input-ring-index nil)
1186 (cond ((or (= (preceding-char) ?\\)
1187 (comint-within-quotes start (point)))
1188 ;; The history is quoted, or we're in quotes.
1189 (goto-char (1+ (point))))
1190 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1191 ;; We cannot know the interpreter's idea of input line numbers.
1192 (goto-char (match-end 0))
1193 (message "Absolute reference cannot be expanded"))
1194 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1195 ;; Just a number of args from `number' lines backward.
1196 (let ((number (1- (string-to-number
1197 (buffer-substring (match-beginning 1)
1199 (if (<= number (ring-length comint-input-ring))
1202 (comint-args (comint-previous-input-string number)
1203 (match-beginning 2) (match-end 2))
1205 (setq comint-input-ring-index number)
1206 (message "History item: %d" (1+ number)))
1207 (goto-char (match-end 0))
1208 (message "Relative reference exceeds input history size"))))
1209 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1210 ;; Just a number of args from the previous input line.
1212 (comint-args (comint-previous-input-string 0)
1213 (match-beginning 1) (match-end 1))
1215 (message "History item: previous"))
1217 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1218 ;; Most recent input starting with or containing (possibly
1219 ;; protected) string, maybe just a number of args. Phew.
1220 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1221 (mb2 (match-beginning 2)) (me2 (match-end 2))
1222 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1223 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1224 (pos (save-match-data
1225 (comint-previous-matching-input-string-position
1226 (concat pref (regexp-quote exp)) 1))))
1229 (goto-char (match-end 0))
1231 (progn (message "Not found")
1233 (setq comint-input-ring-index pos)
1235 (comint-args (ring-ref comint-input-ring pos)
1236 (match-beginning 4) (match-end 4))
1238 (message "History item: %d" (1+ pos)))))
1239 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1240 ;; Quick substitution on the previous input line.
1241 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1242 (new (buffer-substring (match-beginning 2) (match-end 2)))
1244 (replace-match (comint-previous-input-string 0) t t)
1246 (goto-char (match-beginning 0))
1247 (if (not (search-forward old pos t))
1249 (error "Not found"))
1250 (replace-match new t t)
1251 (message "History item: substituted"))))
1253 (forward-char 1)))))))
1256 (defun comint-magic-space (arg)
1257 "Expand input history references before point and insert ARG spaces.
1258 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1260 (comint-replace-by-expanded-history)
1261 (self-insert-command arg))
1263 (defun comint-within-quotes (beg end)
1264 "Return t if the number of quotes between BEG and END is odd.
1265 Quotes are single and double."
1266 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1267 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1268 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1270 (defun comint-how-many-region (regexp beg end)
1271 "Return number of matches for REGEXP from BEG to END."
1276 (while (re-search-forward regexp end t)
1277 (setq count (1+ count)))))
1280 (defun comint-args (string begin end)
1281 ;; From STRING, return the args depending on the range specified in the text
1282 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1283 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1286 (comint-arguments string 0 nil)
1287 (let* ((range (buffer-substring
1288 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1289 (nth (cond ((string-match "^[*^]" range) 1)
1290 ((string-match "^-" range) 0)
1291 ((string-equal range "$") nil)
1292 (t (string-to-number range))))
1293 (mth (cond ((string-match "[-*$]$" range) nil)
1294 ((string-match "-" range)
1295 (string-to-number (substring range (match-end 0))))
1297 (comint-arguments string nth mth)))))
1299 (defun comint-delim-arg (arg)
1300 "Return a list of arguments from ARG.
1301 Break it up at the delimiters in `comint-delimiter-argument-list'.
1302 Returned list is backwards."
1303 (if (null comint-delimiter-argument-list)
1309 (let ((char (aref arg pos))
1311 (if (memq char comint-delimiter-argument-list)
1312 (while (and (< pos len) (eq (aref arg pos) char))
1313 (setq pos (1+ pos)))
1314 (while (and (< pos len)
1315 (not (memq (aref arg pos)
1316 comint-delimiter-argument-list)))
1317 (setq pos (1+ pos))))
1318 (setq args (cons (substring arg start pos) args))))
1321 (defun comint-arguments (string nth mth)
1322 "Return from STRING the NTH to MTH arguments.
1323 NTH and/or MTH can be nil, which means the last argument.
1324 Returned arguments are separated by single spaces.
1325 We assume whitespace separates arguments, except within quotes
1326 and except for a space or tab that immediately follows a backslash.
1327 Also, a run of one or more of a single character
1328 in `comint-delimiter-argument-list' is a separate argument.
1329 Argument 0 is the command name."
1330 ;; The first line handles ordinary characters and backslash-sequences
1331 ;; (except with w32 msdos-like shells, where backslashes are valid).
1332 ;; The second matches "-quoted strings.
1333 ;; The third matches '-quoted strings.
1334 ;; The fourth matches `-quoted strings.
1335 ;; This seems to fit the syntax of BASH 2.0.
1336 (let* ((first (if (if (fboundp 'w32-shell-dos-semantics)
1337 (w32-shell-dos-semantics))
1339 "[^ \n\t\"'`\\]+\\|\\\\[\"'`\\ \t]+\\|"))
1340 (argpart (concat first
1341 "\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\
1347 ;; Build a list of all the args until we have as many as we want.
1348 (while (and (or (null mth) (<= count mth))
1349 (string-match argpart string pos))
1350 (if (and beg (= pos (match-beginning 0)))
1351 ;; It's contiguous, part of the same arg.
1352 (setq pos (match-end 0)
1353 quotes (or quotes (match-beginning 1)))
1354 ;; It's a new separate arg.
1356 ;; Put the previous arg, if there was one, onto ARGS.
1357 (setq str (substring string beg pos)
1358 args (if quotes (cons str args)
1359 (nconc (comint-delim-arg str) args))))
1360 (setq count (length args))
1361 (setq quotes (match-beginning 1))
1362 (setq beg (match-beginning 0))
1363 (setq pos (match-end 0))))
1365 (setq str (substring string beg pos)
1366 args (if quotes (cons str args)
1367 (nconc (comint-delim-arg str) args))))
1368 (setq count (length args))
1369 (let ((n (or nth (1- count)))
1370 (m (if mth (1- (- count mth)) 0)))
1372 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1375 ;; Input processing stuff
1377 (defun comint-add-to-input-history (cmd)
1378 "Add CMD to the input history.
1379 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1380 (if (and (funcall comint-input-filter cmd)
1381 (or (null comint-input-ignoredups)
1382 (not (ring-p comint-input-ring))
1383 (ring-empty-p comint-input-ring)
1384 (not (string-equal (ring-ref comint-input-ring 0)
1386 (ring-insert comint-input-ring cmd)))
1388 (defun comint-send-input (&optional no-newline)
1389 "Send input to process.
1390 After the process output mark, sends all text from the process mark to
1391 point as input to the process. Before the process output mark, calls
1392 value of variable `comint-get-old-input' to retrieve old input, copies
1393 it to the process mark, and sends it. A terminal newline is also
1394 inserted into the buffer and sent to the process unless NO-NEWLINE is
1397 Any history reference may be expanded depending on the value of the variable
1398 `comint-input-autoexpand'. The list of function names contained in the value
1399 of `comint-input-filter-functions' is called on the input before sending it.
1400 The input is entered into the input history ring, if the value of variable
1401 `comint-input-filter' returns non-nil when called on the input.
1403 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1404 end of line before sending the input.
1406 After the input has been sent, if `comint-process-echoes' is non-nil,
1407 then `comint-send-input' waits to see if the process outputs a string
1408 matching the input, and if so, deletes that part of the output.
1410 The values of `comint-get-old-input', `comint-input-filter-functions', and
1411 `comint-input-filter' are chosen according to the command interpreter running
1412 in the buffer. E.g.,
1414 If the interpreter is the csh,
1415 `comint-get-old-input' is the default:
1416 If `comint-use-prompt-regexp-instead-of-fields' is nil, then
1417 either return the current input field, if point is on an input
1418 field, or the current line, if point is on an output field.
1419 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then
1420 return the current line with any initial string matching the
1421 regexp `comint-prompt-regexp' removed.
1422 `comint-input-filter-functions' monitors input for \"cd\", \"pushd\", and
1423 \"popd\" commands. When it sees one, it cd's the buffer.
1424 comint-input-filter is the default: returns t if the input isn't all white
1427 If the Comint is Lucid Common Lisp,
1428 comint-get-old-input snarfs the sexp ending at point.
1429 comint-input-filter-functions does nothing.
1430 comint-input-filter returns nil if the input matches input-filter-regexp,
1431 which matches (1) all whitespace (2) :a, :c, etc.
1433 Similarly for Soar, Scheme, etc."
1435 ;; Note that the input string does not include its terminal newline.
1436 (let ((proc (get-buffer-process (current-buffer))))
1437 (if (not proc) (error "Current buffer has no process")
1438 (let* ((pmark (process-mark proc))
1439 (intxt (if (>= (point) (marker-position pmark))
1440 (progn (if comint-eol-on-send (end-of-line))
1441 (buffer-substring pmark (point)))
1442 (let ((copy (funcall comint-get-old-input)))
1446 (input (if (not (eq comint-input-autoexpand 'input))
1447 ;; Just whatever's already there
1449 ;; Expand and leave it visible in buffer
1450 (comint-replace-by-expanded-history t pmark)
1451 (buffer-substring pmark (point))))
1452 (history (if (not (eq comint-input-autoexpand 'history))
1454 ;; This is messy 'cos ultimately the original
1455 ;; functions used do insertion, rather than return
1456 ;; strings. We have to expand, then insert back.
1457 (comint-replace-by-expanded-history t pmark)
1458 (let ((copy (buffer-substring pmark (point)))
1461 (delete-region pmark start)
1467 (comint-add-to-input-history history)
1469 (run-hook-with-args 'comint-input-filter-functions
1470 (if no-newline input
1471 (concat input "\n")))
1473 (let ((beg (marker-position pmark))
1474 (end (if no-newline (point) (1- (point))))
1475 (inhibit-modification-hooks t))
1477 ;; Set text-properties for the input field
1478 (add-text-properties
1481 font-lock-face comint-highlight-input
1482 mouse-face highlight
1483 help-echo "mouse-2: insert after prompt as new input"))
1484 (unless comint-use-prompt-regexp-instead-of-fields
1485 ;; Give old user input a field property of `input', to
1486 ;; distinguish it from both process output and unsent
1487 ;; input. The terminating newline is put into a special
1488 ;; `boundary' field to make cursor movement between input
1489 ;; and output fields smoother.
1490 (put-text-property beg end 'field 'input)))
1491 (unless (or no-newline comint-use-prompt-regexp-instead-of-fields)
1492 ;; Cover the terminating newline
1493 (add-text-properties end (1+ end)
1496 inhibit-line-move-field-capture t))))
1498 (comint-snapshot-last-prompt)
1500 (setq comint-save-input-ring-index comint-input-ring-index)
1501 (setq comint-input-ring-index nil)
1502 ;; Update the markers before we send the input
1503 ;; in case we get output amidst sending the input.
1504 (set-marker comint-last-input-start pmark)
1505 (set-marker comint-last-input-end (point))
1506 (set-marker (process-mark proc) (point))
1507 ;; clear the "accumulation" marker
1508 (set-marker comint-accum-marker nil)
1509 (let ((comint-input-sender-no-newline no-newline))
1510 (funcall comint-input-sender proc input))
1512 ;; Optionally delete echoed input (after checking it).
1513 (when comint-process-echoes
1514 (let ((echo-len (- comint-last-input-end
1515 comint-last-input-start)))
1516 ;; Wait for all input to be echoed:
1517 (while (and (accept-process-output proc)
1518 (> (+ comint-last-input-end echo-len)
1521 (compare-buffer-substrings
1522 nil comint-last-input-start
1523 (- (point-max) echo-len)
1524 ;; Above difference is equivalent to
1525 ;; (+ comint-last-input-start
1526 ;; (- (point-max) comint-last-input-end))
1527 nil comint-last-input-end (point-max)))))
1529 (<= (+ comint-last-input-end echo-len)
1532 (compare-buffer-substrings
1533 nil comint-last-input-start comint-last-input-end
1534 nil comint-last-input-end
1535 (+ comint-last-input-end echo-len))))
1536 (delete-region comint-last-input-end
1537 (+ comint-last-input-end echo-len)))))
1539 ;; This used to call comint-output-filter-functions,
1540 ;; but that scrolled the buffer in undesirable ways.
1541 (run-hook-with-args 'comint-output-filter-functions "")))))
1543 (defvar comint-preoutput-filter-functions nil
1544 "List of functions to call before inserting Comint output into the buffer.
1545 Each function gets one argument, a string containing the text received
1546 from the subprocess. It should return the string to insert, perhaps
1547 the same string that was received, or perhaps a modified or transformed
1550 The functions on the list are called sequentially, and each one is
1551 given the string returned by the previous one. The string returned by
1552 the last function is the text that is actually inserted in the
1555 You can use `add-hook' to add functions to this list
1556 either globally or locally.")
1558 (defvar comint-inhibit-carriage-motion nil
1559 "If nil, Comint will interpret `carriage control' characters in output.
1560 See `comint-carriage-motion' for details.")
1562 ;; When non-nil, this is an overlay over the last recognized prompt in
1563 ;; the buffer; it is used when highlighting the prompt.
1564 (defvar comint-last-prompt-overlay nil)
1566 (defun comint-snapshot-last-prompt ()
1567 "`snapshot' any current `comint-last-prompt-overlay'.
1568 freeze its attributes in place, even when more input comes a long
1569 and moves the prompt overlay."
1570 (when comint-last-prompt-overlay
1571 (let ((inhibit-read-only t)
1572 (inhibit-modification-hooks t))
1573 (add-text-properties (overlay-start comint-last-prompt-overlay)
1574 (overlay-end comint-last-prompt-overlay)
1575 (overlay-properties comint-last-prompt-overlay)))))
1577 (defun comint-carriage-motion (start end)
1578 "Interpret carriage control characters in the region from START to END.
1579 Translate carriage return/linefeed sequences to linefeeds.
1580 Make single carriage returns delete to the beginning of the line.
1581 Make backspaces delete the previous character."
1583 ;; First do a quick check to see if there are any applicable
1584 ;; characters, so we can avoid calling save-match-data and
1585 ;; save-restriction if not.
1587 (when (< (skip-chars-forward "^\b\r" end) (- end start))
1591 (let ((inhibit-field-text-motion t)
1592 (inhibit-read-only t))
1594 ;; Note that this won't work properly when the CR and LF
1595 ;; are in different output chunks, but this is probably an
1596 ;; exceedingly rare case (because they are generally
1597 ;; written as a unit), and to delay interpretation of a
1598 ;; trailing CR in a chunk would result in odd interactive
1599 ;; behavior (and this case is probably far more common).
1600 (while (re-search-forward "\r$" end t)
1602 ;; bare CR -> delete preceding line
1604 (while (search-forward "\r" end t)
1605 (delete-region (point) (line-beginning-position)))
1606 ;; BS -> delete preceding character
1608 (while (search-forward "\b" end t)
1609 (delete-char -2))))))))
1611 ;; The purpose of using this filter for comint processes
1612 ;; is to keep comint-last-input-end from moving forward
1613 ;; when output is inserted.
1614 (defun comint-output-filter (process string)
1615 (let ((oprocbuf (process-buffer process)))
1616 ;; First check for killed buffer or no input.
1617 (when (and string oprocbuf (buffer-name oprocbuf))
1618 (with-current-buffer oprocbuf
1619 ;; Run preoutput filters
1620 (let ((functions comint-preoutput-filter-functions))
1621 (while (and functions string)
1622 (if (eq (car functions) t)
1623 (let ((functions (default-value 'comint-preoutput-filter-functions)))
1624 (while (and functions string)
1625 (setq string (funcall (car functions) string))
1626 (setq functions (cdr functions))))
1627 (setq string (funcall (car functions) string)))
1628 (setq functions (cdr functions))))
1631 (let ((inhibit-read-only t)
1632 ;; Avoid the overhead of save-excursion, since we just
1633 ;; fiddle with the point
1634 (saved-point (point-marker)))
1636 ;; The point should float after any insertion we do
1637 (set-marker-insertion-type saved-point t)
1639 ;; We temporarly remove any buffer narrowing, in case the
1640 ;; process mark is outside of the restriction
1644 (goto-char (process-mark process))
1645 (set-marker comint-last-output-start (point))
1647 ;; insert-before-markers is a bad thing. XXX
1649 ;; It is used here to force window-point markers (used to
1650 ;; store the value of point in non-selected windows) to
1651 ;; advance, but it also screws up any other markers that we
1652 ;; don't _want_ to advance, such as the start-marker of some
1653 ;; of the overlays we create.
1655 ;; We work around the problem with the overlays by
1656 ;; explicitly adjusting them after we do the insertion, but
1657 ;; in the future this problem should be solved correctly, by
1658 ;; using `insert', and making the insertion-type of
1659 ;; window-point markers settable (via a buffer-local
1660 ;; variable). In comint buffers, this variable would be set
1661 ;; to `t', to cause point in non-select windows to advance.
1662 (insert-before-markers string)
1663 ;; Fixup markers and overlays that got screwed up because we
1664 ;; used `insert-before-markers'.
1665 (let ((old-point (- (point) (length string))))
1666 ;; comint-last-output-start
1667 (set-marker comint-last-output-start old-point)
1668 ;; comint-last-input-end
1669 (when (and comint-last-input-end
1670 (equal (marker-position comint-last-input-end)
1672 (set-marker comint-last-input-end old-point))
1673 ;; No overlays we create are set to advance upon insertion
1674 ;; (at the start/end), so we assume that any overlay which
1675 ;; is at the current point was incorrectly advanced by
1676 ;; insert-before-markers. First fixup overlays that might
1678 (dolist (over (overlays-at (point)))
1679 (when (= (overlay-start over) (point))
1680 (let ((end (overlay-end over)))
1683 (if (= end (point)) old-point end)))))
1684 ;; Then do overlays that might end at point:
1685 (dolist (over (overlays-at (1- (point))))
1686 (when (= (overlay-end over) (point))
1688 (min (overlay-start over) old-point)
1691 ;; Advance process-mark
1692 (set-marker (process-mark process) (point))
1694 (unless comint-inhibit-carriage-motion
1695 ;; Interpret any carriage motion characters (newline, backspace)
1696 (comint-carriage-motion comint-last-output-start (point)))
1698 (run-hook-with-args 'comint-output-filter-functions string)
1700 (goto-char (process-mark process)) ; in case a filter moved it
1702 (unless comint-use-prompt-regexp-instead-of-fields
1703 (let ((inhibit-read-only t)
1704 (inhibit-modification-hooks t))
1705 (add-text-properties comint-last-output-start (point)
1708 inhibit-line-move-field-capture t))))
1710 ;; Highlight the prompt, where we define `prompt' to mean
1711 ;; the most recent output that doesn't end with a newline.
1712 (let ((prompt-start (save-excursion (forward-line 0) (point)))
1713 (inhibit-read-only t)
1714 (inhibit-modification-hooks t))
1715 (when comint-prompt-read-only
1716 (or (= (point-min) prompt-start)
1717 (get-text-property (1- prompt-start) 'read-only)
1719 (1- prompt-start) prompt-start 'read-only 'fence))
1720 (add-text-properties
1721 prompt-start (point)
1722 '(read-only t rear-nonsticky t front-sticky (read-only))))
1723 (unless (and (bolp) (null comint-last-prompt-overlay))
1724 ;; Need to create or move the prompt overlay (in the case
1725 ;; where there is no prompt ((bolp) == t), we still do
1726 ;; this if there's already an existing overlay).
1727 (if comint-last-prompt-overlay
1728 ;; Just move an existing overlay
1729 (move-overlay comint-last-prompt-overlay
1730 prompt-start (point))
1731 ;; Need to create the overlay
1732 (setq comint-last-prompt-overlay
1733 (make-overlay prompt-start (point)))
1734 (overlay-put comint-last-prompt-overlay
1735 'font-lock-face 'comint-highlight-prompt))))
1737 (goto-char saved-point)))))))
1739 (defun comint-preinput-scroll-to-bottom ()
1740 "Go to the end of buffer in all windows showing it.
1741 Movement occurs if point in the selected window is not after the process mark,
1742 and `this-command' is an insertion command. Insertion commands recognised
1743 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1744 Depends on the value of `comint-scroll-to-bottom-on-input'.
1746 This function should be a pre-command hook."
1747 (if (and comint-scroll-to-bottom-on-input
1748 (memq this-command '(self-insert-command comint-magic-space yank
1750 (let* ((selected (selected-window))
1751 (current (current-buffer))
1752 (process (get-buffer-process current))
1753 (scroll comint-scroll-to-bottom-on-input))
1754 (if (and process (< (point) (process-mark process)))
1755 (if (eq scroll 'this)
1756 (goto-char (point-max))
1758 (function (lambda (window)
1759 (if (and (eq (window-buffer window) current)
1760 (or (eq scroll t) (eq scroll 'all)))
1762 (select-window window)
1763 (goto-char (point-max))
1764 (select-window selected)))))
1767 (defun comint-postoutput-scroll-to-bottom (string)
1768 "Go to the end of buffer in some or all windows showing it.
1769 Does not scroll if the current line is the last line in the buffer.
1770 Depends on the value of `comint-move-point-for-output' and
1771 `comint-scroll-show-maximum-output'.
1773 This function should be in the list `comint-output-filter-functions'."
1774 (let* ((selected (selected-window))
1775 (current (current-buffer))
1776 (process (get-buffer-process current))
1777 (scroll comint-move-point-for-output))
1781 (function (lambda (window)
1782 (if (eq (window-buffer window) current)
1784 (select-window window)
1785 (if (and (< (point) (process-mark process))
1786 (or (eq scroll t) (eq scroll 'all)
1787 ;; Maybe user wants point to jump to end.
1788 (and (eq scroll 'this) (eq selected window))
1789 (and (eq scroll 'others) (not (eq selected window)))
1790 ;; If point was at the end, keep it at end.
1791 (and (marker-position comint-last-output-start)
1792 (>= (point) comint-last-output-start))))
1793 (goto-char (process-mark process)))
1794 ;; Optionally scroll so that the text
1795 ;; ends at the bottom of the window.
1796 (if (and comint-scroll-show-maximum-output
1797 (= (point) (point-max)))
1799 (goto-char (point-max))
1801 (select-window selected)))))
1803 (set-buffer current))))
1805 (defun comint-truncate-buffer (&optional string)
1806 "Truncate the buffer to `comint-buffer-maximum-size'.
1807 This function could be on `comint-output-filter-functions' or bound to a key."
1810 (goto-char (process-mark (get-buffer-process (current-buffer))))
1811 (forward-line (- comint-buffer-maximum-size))
1813 (let ((inhibit-read-only t))
1814 (delete-region (point-min) (point)))))
1816 (defun comint-strip-ctrl-m (&optional string)
1817 "Strip trailing `^M' characters from the current output group.
1818 This function could be on `comint-output-filter-functions' or bound to a key."
1820 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1824 (if (interactive-p) comint-last-input-end comint-last-output-start))
1826 (while (re-search-forward "\r+$" pmark t)
1827 (replace-match "" t t)))))
1828 (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
1830 (defun comint-show-maximum-output ()
1831 "Put the end of the buffer at the bottom of the window."
1833 (goto-char (point-max))
1836 (defun comint-get-old-input-default ()
1837 "Default for `comint-get-old-input'.
1838 If `comint-use-prompt-regexp-instead-of-fields' is nil, then either
1839 return the current input field, if point is on an input field, or the
1840 current line, if point is on an output field.
1841 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then return
1842 the current line with any initial string matching the regexp
1843 `comint-prompt-regexp' removed."
1844 (let ((bof (field-beginning)))
1845 (if (eq (get-char-property bof 'field) 'input)
1846 (field-string-no-properties bof)
1848 (buffer-substring-no-properties (point) (line-end-position)))))
1850 (defun comint-skip-prompt ()
1851 "Skip past the text matching regexp `comint-prompt-regexp'.
1852 If this takes us past the end of the current line, don't skip at all."
1853 (if (and (looking-at comint-prompt-regexp)
1854 (<= (match-end 0) (line-end-position)))
1855 (goto-char (match-end 0))))
1857 (defun comint-after-pmark-p ()
1858 "Return t if point is after the process output marker."
1859 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1860 (<= (marker-position pmark) (point))))
1862 (defun comint-simple-send (proc string)
1863 "Default function for sending to PROC input STRING.
1864 This just sends STRING plus a newline. To override this,
1865 set the hook `comint-input-sender'."
1866 (comint-send-string proc string)
1867 (if comint-input-sender-no-newline
1868 (if (not (string-equal string ""))
1870 (comint-send-string proc "\n")))
1872 (defun comint-line-beginning-position ()
1873 "Return the buffer position of the beginning of the line, after any prompt.
1874 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1875 prompt skip is done by skipping text matching the regular expression
1876 `comint-prompt-regexp', a buffer local variable."
1877 (if comint-use-prompt-regexp-instead-of-fields
1878 ;; Use comint-prompt-regexp
1881 (comint-skip-prompt)
1883 ;; Use input fields. Note that, unlike the behavior of
1884 ;; `line-beginning-position' inside a field, this function will
1885 ;; return the position of the end of a prompt, even if the point is
1886 ;; already inside the prompt. In order to do this, it assumes that
1887 ;; if there are two fields on a line, then the first one is the
1888 ;; prompt, and the second one is an input field, and is front-sticky
1889 ;; (as input fields should be).
1890 (constrain-to-field (line-beginning-position) (line-end-position))))
1892 (defun comint-bol (&optional arg)
1893 "Go to the beginning of line, then skip past the prompt, if any.
1894 If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
1895 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1896 prompt skip is done by skipping text matching the regular expression
1897 `comint-prompt-regexp', a buffer local variable."
1900 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1902 (goto-char (comint-line-beginning-position))))
1904 ;; For compatibility.
1905 (defun comint-read-noecho (prompt &optional ignore)
1906 (read-passwd prompt))
1908 ;; These three functions are for entering text you don't want echoed or
1909 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1910 ;; Just enter m-x send-invisible and type in your line.
1912 (defun send-invisible (&optional prompt)
1913 "Read a string without echoing.
1914 Then send it to the process running in the current buffer.
1915 The string is sent using `comint-input-sender'.
1916 Security bug: your string can still be temporarily recovered with
1917 \\[view-lossage]; `clear-this-command-keys' can fix that."
1918 (interactive "P") ; Defeat snooping via C-x ESC ESC
1919 (let ((proc (get-buffer-process (current-buffer))))
1921 (let ((str (read-passwd (or prompt "Non-echoed text: "))))
1924 (comint-snapshot-last-prompt)
1925 (funcall comint-input-sender proc str))
1926 (message "Warning: text will be echoed")))
1927 (error "Current buffer has no process"))))
1929 (defun comint-watch-for-password-prompt (string)
1930 "Prompt in the minibuffer for password and send without echoing.
1931 This function uses `send-invisible' to read and send a password to the buffer's
1932 process if STRING contains a password prompt defined by
1933 `comint-password-prompt-regexp'.
1935 This function could be in the list `comint-output-filter-functions'."
1936 (when (string-match comint-password-prompt-regexp string)
1937 (when (string-match "^[ \n\r\t\v\f\b\a]+" string)
1938 (setq string (replace-match "" t t string)))
1939 (send-invisible string)))
1941 ;; Low-level process communication
1943 (defun comint-send-string (process string)
1944 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
1946 (with-current-buffer (if (processp process)
1947 (process-buffer process)
1948 (get-buffer process))
1949 (comint-snapshot-last-prompt))
1950 (comint-snapshot-last-prompt))
1951 (process-send-string process string))
1953 (defun comint-send-region (process start end)
1954 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
1956 (with-current-buffer (if (processp process)
1957 (process-buffer process)
1958 (get-buffer process))
1959 (comint-snapshot-last-prompt))
1960 (comint-snapshot-last-prompt))
1961 (process-send-region process start end))
1964 ;; Random input hackage
1966 (defun comint-delete-output ()
1967 "Delete all output from interpreter since last input.
1968 Does not delete the prompt."
1970 (let ((proc (get-buffer-process (current-buffer)))
1972 (inhibit-read-only t))
1974 (let ((pmark (progn (goto-char (process-mark proc))
1977 (delete-region comint-last-input-end pmark)
1978 (goto-char (process-mark proc))
1979 (setq replacement (concat "*** output flushed ***\n"
1980 (buffer-substring pmark (point))))
1981 (delete-region pmark (point))))
1982 ;; Output message and put back prompt
1983 (comint-output-filter proc replacement)))
1984 (defalias 'comint-kill-output 'comint-delete-output)
1985 (make-obsolete 'comint-kill-output 'comint-delete-output "21.1")
1987 (defun comint-write-output (filename &optional append mustbenew)
1988 "Write output from interpreter since last input to FILENAME.
1989 Any prompt at the end of the output is not written.
1991 If the optional argument APPEND (the prefix argument when interactive)
1992 is non-nil, the output is appended to the file instead.
1994 If the optional argument MUSTBENEW is non-nil, check for an existing
1995 file with the same name. If MUSTBENEW is `excl', that means to get an
1996 error if the file already exists; never overwrite. If MUSTBENEW is
1997 neither nil nor `excl', that means ask for confirmation before
1998 overwriting, but do go ahead and overwrite the file if the user
1999 confirms. When interactive, MUSTBENEW is nil when appending, and t
2002 (list (read-file-name
2003 (if current-prefix-arg
2004 "Append output to file: "
2005 "Write output to file: "))
2007 (not current-prefix-arg)))
2009 (goto-char (process-mark (get-buffer-process (current-buffer))))
2011 (write-region comint-last-input-end (point) filename
2012 append nil nil mustbenew)))
2014 ;; This function exists for the benefit of the menu; from the keyboard,
2015 ;; users can just use `comint-write-output' with a prefix arg.
2016 (defun comint-append-output-to-file (filename)
2017 "Append output from interpreter since last input to FILENAME.
2018 Any prompt at the end of the output is not written."
2019 (interactive "fAppend output to file: ")
2020 (comint-write-output filename t))
2022 (defun comint-show-output ()
2023 "Display start of this batch of interpreter output at top of window.
2024 Sets mark to the value of point when this command is run."
2027 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
2028 (cond (comint-use-prompt-regexp-instead-of-fields
2030 (beginning-of-line 0)
2031 (set-window-start (selected-window) (point))
2032 (comint-skip-prompt))
2034 (goto-char (field-beginning pos))
2035 (set-window-start (selected-window) (point))))))
2038 (defun comint-interrupt-subjob ()
2039 "Interrupt the current subjob.
2040 This command also kills the pending input
2041 between the process mark and point."
2044 (interrupt-process nil comint-ptyp)
2045 ;; (process-send-string nil "\n")
2048 (defun comint-kill-subjob ()
2049 "Send kill signal to the current subjob.
2050 This command also kills the pending input
2051 between the process mark and point."
2054 (kill-process nil comint-ptyp))
2056 (defun comint-quit-subjob ()
2057 "Send quit signal to the current subjob.
2058 This command also kills the pending input
2059 between the process mark and point."
2062 (quit-process nil comint-ptyp))
2064 (defun comint-stop-subjob ()
2065 "Stop the current subjob.
2066 This command also kills the pending input
2067 between the process mark and point.
2069 WARNING: if there is no current subjob, you can end up suspending
2070 the top-level process running in the buffer. If you accidentally do
2071 this, use \\[comint-continue-subjob] to resume the process. (This
2072 is not a problem with most shells, since they ignore this signal.)"
2075 (stop-process nil comint-ptyp))
2077 (defun comint-continue-subjob ()
2078 "Send CONT signal to process buffer's process group.
2079 Useful if you accidentally suspend the top-level process."
2081 (continue-process nil comint-ptyp))
2083 (defun comint-skip-input ()
2084 "Skip all pending input, from last stuff output by interpreter to point.
2085 This means mark it as if it had been sent as input, without sending it."
2086 (let ((comint-input-sender 'ignore)
2087 (comint-input-filter-functions nil))
2088 (comint-send-input t))
2091 (marker (process-mark (get-buffer-process (current-buffer)))))
2092 (insert " " (key-description (this-command-keys)))
2094 (set-marker marker (point)))))
2096 (defun comint-kill-input ()
2097 "Kill all text from last stuff output by interpreter to point."
2099 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2100 (if (> (point) (marker-position pmark))
2101 (kill-region pmark (point)))))
2103 (defun comint-delchar-or-maybe-eof (arg)
2104 "Delete ARG characters forward or send an EOF to subprocess.
2105 Sends an EOF only if point is at the end of the buffer and there is no input."
2107 (let ((proc (get-buffer-process (current-buffer))))
2108 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
2110 (delete-char arg))))
2112 (defun comint-send-eof ()
2113 "Send an EOF to the current buffer's process."
2115 (comint-send-input t)
2119 (defun comint-backward-matching-input (regexp n)
2120 "Search backward through buffer for input fields that match REGEXP.
2121 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2122 fields are identified by lines that match `comint-prompt-regexp'.
2124 With prefix argument N, search for Nth previous match.
2125 If N is negative, find the next or Nth next match."
2126 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2127 (if comint-use-prompt-regexp-instead-of-fields
2128 ;; Use comint-prompt-regexp
2129 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2130 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2131 (if (re-search-backward re nil t n)
2134 (progn (message "Not found")
2139 (let* ((dir (if (< n 0) -1 1))
2143 (unless (re-search-backward regexp nil t dir)
2144 (error "Not found"))
2145 (when (eq (get-char-property (point) 'field) 'input)
2146 (setq n (- n dir))))
2147 (field-beginning))))
2151 (defun comint-forward-matching-input (regexp arg)
2152 "Search forward through buffer for input fields that match REGEXP.
2153 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2154 fields are identified by lines that match `comint-prompt-regexp'.
2156 With prefix argument N, search for Nth following match.
2157 If N is negative, find the previous or Nth previous match."
2158 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2159 (comint-backward-matching-input regexp (- arg)))
2162 (defun comint-next-prompt (n)
2163 "Move to end of Nth next prompt in the buffer.
2164 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2165 the beginning of the Nth next `input' field, otherwise, it means the Nth
2166 occurrence of text matching `comint-prompt-regexp'."
2168 (if comint-use-prompt-regexp-instead-of-fields
2169 ;; Use comint-prompt-regexp
2170 (let ((paragraph-start comint-prompt-regexp))
2171 (end-of-line (if (> n 0) 1 0))
2172 (forward-paragraph n)
2173 (comint-skip-prompt))
2182 (next-single-char-property-change pos 'field)
2183 (previous-single-char-property-change pos 'field)))
2184 (cond ((or (null pos) (= pos prev-pos))
2185 ;; Ran off the end of the buffer.
2187 ;; There's always an input field at the end of the
2188 ;; buffer, but it has a `field' property of nil.
2189 (setq input-pos (point-max)))
2192 ((eq (get-char-property pos 'field) 'input)
2193 (setq n (if (< n 0) (1+ n) (1- n)))
2194 (setq input-pos pos))))
2196 (goto-char input-pos)))))
2199 (defun comint-previous-prompt (n)
2200 "Move to end of Nth previous prompt in the buffer.
2201 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2202 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2203 occurrence of text matching `comint-prompt-regexp'."
2205 (comint-next-prompt (- n)))
2207 ;; State used by `comint-insert-previous-argument' when cycling.
2208 (defvar comint-insert-previous-argument-last-start-pos nil)
2209 (make-variable-buffer-local 'comint-insert-previous-argument-last-start-pos)
2210 (defvar comint-insert-previous-argument-last-index nil)
2211 (make-variable-buffer-local 'comint-insert-previous-argument-last-index)
2214 ;; make comint-arguments understand negative indices as bash does
2215 (defun comint-insert-previous-argument (index)
2216 "Insert the INDEXth argument from the previous Comint command-line at point.
2217 Spaces are added at beginning and/or end of the inserted string if
2218 necessary to ensure that it's separated from adjacent arguments.
2219 Interactively, if no prefix argument is given, the last argument is inserted.
2220 Repeated interactive invocations will cycle through the same argument
2221 from progressively earlier commands (using the value of INDEX specified
2222 with the first command).
2223 This command is like `M-.' in bash."
2225 (unless (null index)
2226 (setq index (prefix-numeric-value index)))
2227 (cond ((eq last-command this-command)
2228 ;; Delete last input inserted by this command.
2229 (delete-region comint-insert-previous-argument-last-start-pos (point))
2230 (setq index comint-insert-previous-argument-last-index))
2232 ;; This is a non-repeat invocation, so initialize state.
2233 (setq comint-input-ring-index nil)
2234 (setq comint-insert-previous-argument-last-index index)
2235 (when (null comint-insert-previous-argument-last-start-pos)
2236 ;; First usage; initialize to a marker
2237 (setq comint-insert-previous-argument-last-start-pos
2239 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2240 (if (<= (point) (comint-line-beginning-position))
2243 ;; Remember the beginning of what we insert, so we can delete it if
2244 ;; the command is repeated.
2245 (set-marker comint-insert-previous-argument-last-start-pos (point))
2246 ;; Insert the argument.
2247 (let ((input-string (comint-previous-input-string 0)))
2248 (when (string-match "[ \t\n]*&" input-string)
2249 ;; strip terminating '&'
2250 (setq input-string (substring input-string 0 (match-beginning 0))))
2251 (insert (comint-arguments input-string index index)))
2252 ;; Make next invocation return arg from previous input
2253 (setq comint-input-ring-index (1+ (or comint-input-ring-index 0)))
2254 ;; Add a terminating space if necessary.
2259 ;; Support editing with `comint-prompt-read-only' set to t.
2261 (defun comint-update-fence ()
2262 "Update read-only status of newline before point.
2263 The `fence' read-only property is used to indicate that a newline
2264 is read-only for no other reason than to \"fence off\" a
2265 following front-sticky read-only region. This is used to
2266 implement comint read-only prompts. If the text after a newline
2267 changes, the read-only status of that newline may need updating.
2268 That is what this function does.
2270 This function does nothing if point is not at the beginning of a
2271 line, or is at the beginning of the accessible portion of the buffer.
2272 Otherwise, if the character after point has a front-sticky
2273 read-only property, then the preceding newline is given a
2274 read-only property of `fence', unless it already is read-only.
2275 If the character after point does not have a front-sticky
2276 read-only property, any read-only property of `fence' on the
2277 preceding newline is removed."
2278 (let* ((pt (point)) (lst (get-text-property pt 'front-sticky))
2279 (inhibit-modification-hooks t))
2282 (if (and (get-text-property pt 'read-only)
2283 (if (listp lst) (memq 'read-only lst) t))
2284 (unless (get-text-property (1- pt) 'read-only)
2285 (put-text-property (1- pt) pt 'read-only 'fence))
2286 (when (eq (get-text-property (1- pt) 'read-only) 'fence)
2287 (remove-list-of-text-properties (1- pt) pt '(read-only)))))))
2289 (defun comint-kill-whole-line (&optional arg)
2290 "Kill current line, ignoring read-only and field properties.
2291 With prefix arg, kill that many lines starting from the current line.
2292 If arg is negative, kill backward. Also kill the preceding newline,
2293 instead of the trailing one. \(This is meant to make \\[repeat] work well
2294 with negative arguments.)
2295 If arg is zero, kill current line but exclude the trailing newline.
2296 The read-only status of newlines is updated with `comint-update-fence',
2299 (let ((inhibit-read-only t) (inhibit-field-text-motion t))
2300 (kill-whole-line arg)
2301 (when (>= arg 0) (comint-update-fence))))
2303 (defun comint-kill-region (beg end &optional yank-handler)
2304 "Like `kill-region', but ignores read-only properties, if safe.
2305 This command assumes that the buffer contains read-only
2306 \"prompts\" which are regions with front-sticky read-only
2307 properties at the beginning of a line, with the preceding newline
2308 being read-only to protect the prompt. This is true of the
2309 comint prompts if `comint-prompt-read-only' is non-nil. This
2310 command will not delete the region if this would create mutilated
2311 or out of place prompts. That is, if any part of a prompt is
2312 deleted, the entire prompt must be deleted and all remaining
2313 prompts should stay at the beginning of a line. If this is not
2314 the case, this command just calls `kill-region' with all
2315 read-only properties intact. The read-only status of newlines is
2316 updated using `comint-update-fence', if necessary."
2319 (let* ((true-beg (min beg end))
2320 (true-end (max beg end))
2321 (beg-bolp (progn (goto-char true-beg) (bolp)))
2322 (beg-lst (get-text-property true-beg 'front-sticky))
2323 (beg-bad (and (get-text-property true-beg 'read-only)
2324 (if (listp beg-lst) (memq 'read-only beg-lst) t)))
2325 (end-bolp (progn (goto-char true-end) (bolp)))
2326 (end-lst (get-text-property true-end 'front-sticky))
2327 (end-bad (and (get-text-property true-end 'read-only)
2328 (if (listp end-lst) (memq 'read-only end-lst) t))))
2329 (if (or (and (not beg-bolp) (or beg-bad end-bad))
2330 (and (not end-bolp) end-bad))
2331 (kill-region beg end yank-handler)
2332 (let ((inhibit-read-only t))
2333 (kill-region beg end yank-handler)
2334 (comint-update-fence))))))
2337 ;; Support for source-file processing commands.
2338 ;;============================================================================
2339 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2340 ;; commands that process files of source text (e.g. loading or compiling
2341 ;; files). So the corresponding process-in-a-buffer modes have commands
2342 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2343 ;; for defining these commands.
2345 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2346 ;; and Soar, in that they don't know anything about file extensions.
2347 ;; So the compile/load interface gets the wrong default occasionally.
2348 ;; The load-file/compile-file default mechanism could be smarter -- it
2349 ;; doesn't know about the relationship between filename extensions and
2350 ;; whether the file is source or executable. If you compile foo.lisp
2351 ;; with compile-file, then the next load-file should use foo.bin for
2352 ;; the default, not foo.lisp. This is tricky to do right, particularly
2353 ;; because the extension for executable files varies so much (.o, .bin,
2354 ;; .lbin, .mo, .vo, .ao, ...).
2357 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2360 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2361 ;; want to save the buffer before issuing any process requests to the command
2364 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2365 ;; for the file to process.
2367 (defun comint-source-default (previous-dir/file source-modes)
2368 "Compute the defaults for `load-file' and `compile-file' commands.
2370 PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2371 source-file processing command. nil if there hasn't been one yet.
2372 SOURCE-MODES is a list used to determine what buffers contain source
2373 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2374 Typically, (lisp-mode) or (scheme-mode).
2376 If the command is given while the cursor is inside a string, *and*
2377 the string is an existing filename, *and* the filename is not a directory,
2378 then the string is taken as default. This allows you to just position
2379 your cursor over a string that's a filename and have it taken as default.
2381 If the command is given in a file buffer whose major mode is in
2382 SOURCE-MODES, then the filename is the default file, and the
2383 file's directory is the default directory.
2385 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2386 then the default directory & file are what was used in the last source-file
2387 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2388 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2389 is the cwd, with no default file. (\"no default file\" = nil)
2391 SOURCE-REGEXP is typically going to be something like (tea-mode)
2392 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2393 for Soar programs, etc.
2395 The function returns a pair: (default-directory . default-file)."
2396 (cond ((and buffer-file-name (memq major-mode source-modes))
2397 (cons (file-name-directory buffer-file-name)
2398 (file-name-nondirectory buffer-file-name)))
2401 (cons default-directory nil))))
2404 (defun comint-check-source (fname)
2405 "Check whether to save buffers visiting file FNAME.
2406 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2407 process-in-a-buffer modes), this function can be called on the filename.
2408 If the file is loaded into a buffer, and the buffer is modified, the user
2409 is queried to see if he wants to save the buffer before proceeding with
2410 the load or compile."
2411 (let ((buff (get-file-buffer fname)))
2413 (buffer-modified-p buff)
2414 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
2416 (let ((old-buffer (current-buffer)))
2419 (set-buffer old-buffer)))))
2421 (defun comint-extract-string ()
2422 "Return string around POINT, or nil."
2423 (let ((syntax (syntax-ppss)))
2424 (when (nth 3 syntax)
2426 (buffer-substring-no-properties (1+ (nth 8 syntax))
2427 (progn (goto-char (nth 8 syntax))
2432 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2433 "Prompt for filenames in commands that process source files,
2434 e.g. loading or compiling a file.
2435 Provides a default, if there is one, and returns the result filename.
2437 See `comint-source-default' for more on determining defaults.
2439 PROMPT is the prompt string. PREV-DIR/FILE is the (DIRECTORY . FILE) pair
2440 from the last source processing command. SOURCE-MODES is a list of major
2441 modes used to determine what file buffers contain source files. (These
2442 two arguments are used for determining defaults). If MUSTMATCH-P is true,
2443 then the filename reader will only accept a file that exists.
2446 (interactive (comint-get-source \"Compile file: \" prev-lisp-dir/file
2448 (let* ((def (comint-source-default prev-dir/file source-modes))
2449 (stringfile (comint-extract-string))
2450 (sfile-p (and stringfile
2452 (file-exists-p stringfile)
2454 (not (file-directory-p stringfile))))
2455 (defdir (if sfile-p (file-name-directory stringfile)
2457 (deffile (if sfile-p (file-name-nondirectory stringfile)
2459 (ans (read-file-name (if deffile (format "%s(default %s) "
2463 (concat defdir deffile)
2465 (list (expand-file-name (substitute-in-file-name ans)))))
2467 ;; I am somewhat divided on this string-default feature. It seems
2468 ;; to violate the principle-of-least-astonishment, in that it makes
2469 ;; the default harder to predict, so you actually have to look and see
2470 ;; what the default really is before choosing it. This can trip you up.
2471 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2476 ;; Simple process query facility.
2477 ;; ===========================================================================
2478 ;; This function is for commands that want to send a query to the process
2479 ;; and show the response to the user. For example, a command to get the
2480 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2481 ;; to an inferior Common Lisp process.
2483 ;; This simple facility just sends strings to the inferior process and pops
2484 ;; up a window for the process buffer so you can see what the process
2485 ;; responds with. We don't do anything fancy like try to intercept what the
2486 ;; process responds with and put it in a pop-up window or on the message
2487 ;; line. We just display the buffer. Low tech. Simple. Works good.
2489 (defun comint-proc-query (proc str)
2490 "Send to the inferior process PROC the string STR.
2491 Pop-up but do not select a window for the inferior process so that
2492 its response can be seen."
2493 (let* ((proc-buf (process-buffer proc))
2494 (proc-mark (process-mark proc)))
2495 (display-buffer proc-buf)
2496 (set-buffer proc-buf) ; but it's not the selected *window*
2497 (let ((proc-win (get-buffer-window proc-buf))
2498 (proc-pt (marker-position proc-mark)))
2499 (comint-send-string proc str) ; send the query
2500 (accept-process-output proc) ; wait for some output
2501 ;; Try to position the proc window so you can see the answer.
2502 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2503 ;; I don't know why. Wizards invited to improve it.
2504 (unless (pos-visible-in-window-p proc-pt proc-win)
2505 (let ((opoint (window-point proc-win)))
2506 (set-window-point proc-win proc-mark)
2508 (if (not (pos-visible-in-window-p opoint proc-win))
2510 (set-window-point proc-win opoint)))))))
2513 ;; Filename/command/history completion in a buffer
2514 ;; ===========================================================================
2515 ;; Useful completion functions, courtesy of the Ergo group.
2518 ;; comint-dynamic-complete Complete or expand command, filename,
2519 ;; history at point.
2520 ;; comint-dynamic-complete-filename Complete filename at point.
2521 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2522 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2523 ;; replace with expanded/completed name.
2524 ;; comint-dynamic-simple-complete Complete stub given candidates.
2526 ;; These are not installed in the comint-mode keymap. But they are
2527 ;; available for people who want them. Shell-mode installs them:
2528 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2529 ;; (define-key shell-mode-map "\M-?"
2530 ;; 'comint-dynamic-list-filename-completions)))
2532 ;; Commands like this are fine things to put in load hooks if you
2533 ;; want them present in specific modes.
2535 (defcustom comint-completion-autolist nil
2536 "*If non-nil, automatically list possibilities on partial completion.
2537 This mirrors the optional behavior of tcsh."
2539 :group 'comint-completion)
2541 (defcustom comint-completion-addsuffix t
2542 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2543 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2544 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2545 This mirrors the optional behavior of tcsh."
2546 :type '(choice (const :tag "None" nil)
2547 (const :tag "Add /" t)
2548 (cons :tag "Suffix pair"
2549 (string :tag "Directory suffix")
2550 (string :tag "File suffix")))
2551 :group 'comint-completion)
2553 (defcustom comint-completion-recexact nil
2554 "*If non-nil, use shortest completion if characters cannot be added.
2555 This mirrors the optional behavior of tcsh.
2557 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2559 :group 'comint-completion)
2561 (defcustom comint-completion-fignore nil
2562 "*List of suffixes to be disregarded during file completion.
2563 This mirrors the optional behavior of bash and tcsh.
2565 Note that this applies to `comint-dynamic-complete-filename' only."
2566 :type '(repeat (string :tag "Suffix"))
2567 :group 'comint-completion)
2569 (defvar comint-file-name-prefix ""
2570 "Prefix prepended to absolute file names taken from process input.
2571 This is used by Comint's and shell's completion functions, and by shell's
2572 directory tracking functions.")
2574 (defvar comint-file-name-chars
2575 (if (memq system-type '(ms-dos windows-nt cygwin))
2576 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2577 "[]~/A-Za-z0-9+@:_.$#%,={}-")
2578 "String of characters valid in a file name.
2579 Note that all non-ASCII characters are considered valid in a file name
2580 regardless of what this variable says.
2582 This is a good thing to set in mode hooks.")
2584 (defvar comint-file-name-quote-list nil
2585 "List of characters to quote with `\\' when in a file name.
2587 This is a good thing to set in mode hooks.")
2590 (defun comint-directory (directory)
2591 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
2592 (expand-file-name (if (file-name-absolute-p directory)
2593 (concat comint-file-name-prefix directory)
2597 (defun comint-word (word-chars)
2598 "Return the word of WORD-CHARS at point, or nil if none is found.
2599 Word constituents are considered to be those in WORD-CHARS, which is like the
2600 inside of a \"[...]\" (see `skip-chars-forward'),
2601 plus all non-ASCII characters."
2603 (let ((here (point))
2606 (let ((startpoint (point)))
2607 (skip-chars-backward (concat "\\\\" word-chars))
2608 ;; Fixme: This isn't consistent with Bash, at least -- not
2609 ;; all non-ASCII chars should be word constituents.
2610 (if (and (> (- (point) 2) (point-min))
2611 (= (char-after (- (point) 2)) ?\\))
2613 (if (and (> (- (point) 1) (point-min))
2614 (>= (char-after (- (point) 1)) 128))
2616 (if (= (point) startpoint)
2618 ;; Set match-data to match the entire string.
2619 (when (< (point) here)
2620 (set-match-data (list (point) here))
2621 (match-string 0)))))
2623 (defun comint-substitute-in-file-name (filename)
2624 "Return FILENAME with environment variables substituted.
2625 Supports additional environment variable syntax of the command
2626 interpreter (e.g., the percent notation of cmd.exe on NT)."
2627 (let ((name (substitute-in-file-name filename)))
2628 (if (memq system-type '(ms-dos windows-nt))
2632 (while (string-match "%\\([^\\\\/]*\\)%" name)
2634 (substring name (match-beginning 1) (match-end 1)))
2635 (setq env-var-val (if (getenv env-var-name)
2636 (getenv env-var-name)
2638 (setq name (replace-match env-var-val t t name))))))
2641 (defun comint-match-partial-filename ()
2642 "Return the filename at point, or nil if non is found.
2643 Environment variables are substituted. See `comint-word'."
2644 (let ((filename (comint-word comint-file-name-chars)))
2645 (and filename (comint-substitute-in-file-name
2646 (comint-unquote-filename filename)))))
2649 (defun comint-quote-filename (filename)
2650 "Return FILENAME with magic characters quoted.
2651 Magic characters are those in `comint-file-name-quote-list'."
2652 (if (null comint-file-name-quote-list)
2656 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
2659 (while (string-match regexp filename i)
2660 (setq filename (replace-match "\\\\\\&" nil nil filename))
2661 (setq i (1+ (match-end 0)))))
2664 (defun comint-unquote-filename (filename)
2665 "Return FILENAME with quoted characters unquoted."
2666 (if (null comint-file-name-quote-list)
2670 (while (string-match "\\\\\\(.\\)" filename i)
2671 (setq filename (replace-match "\\1" nil nil filename))
2672 (setq i (+ 1 (match-beginning 0)))))
2676 (defun comint-dynamic-complete ()
2677 "Dynamically perform completion at point.
2678 Calls the functions in `comint-dynamic-complete-functions' to perform
2679 completion until a function returns non-nil, at which point completion is
2680 assumed to have occurred."
2682 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
2685 (defun comint-dynamic-complete-filename ()
2686 "Dynamically complete the filename at point.
2687 Completes if after a filename. See `comint-match-partial-filename' and
2688 `comint-dynamic-complete-as-filename'.
2689 This function is similar to `comint-replace-by-expanded-filename', except that
2690 it won't change parts of the filename already entered in the buffer; it just
2691 adds completion characters to the end of the filename. A completions listing
2692 may be shown in a help buffer if completion is ambiguous.
2694 Completion is dependent on the value of `comint-completion-addsuffix',
2695 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2696 completions listing is dependent on the value of `comint-completion-autolist'.
2698 Returns t if successful."
2700 (when (comint-match-partial-filename)
2701 (unless (window-minibuffer-p (selected-window))
2702 (message "Completing file name..."))
2703 (comint-dynamic-complete-as-filename)))
2705 (defun comint-dynamic-complete-as-filename ()
2706 "Dynamically complete at point as a filename.
2707 See `comint-dynamic-complete-filename'. Returns t if successful."
2708 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2709 (completion-ignored-extensions comint-completion-fignore)
2710 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2711 ;; I think it was originally bound to solve file completion problems,
2712 ;; but subsequent changes may have made this unnecessary. sm.
2713 ;;(file-name-handler-alist nil)
2714 (minibuffer-p (window-minibuffer-p (selected-window)))
2716 (dirsuffix (cond ((not comint-completion-addsuffix)
2718 ((not (consp comint-completion-addsuffix))
2721 (car comint-completion-addsuffix))))
2722 (filesuffix (cond ((not comint-completion-addsuffix)
2724 ((not (consp comint-completion-addsuffix))
2727 (cdr comint-completion-addsuffix))))
2728 (filename (or (comint-match-partial-filename) ""))
2729 (filedir (file-name-directory filename))
2730 (filenondir (file-name-nondirectory filename))
2731 (directory (if filedir (comint-directory filedir) default-directory))
2732 (completion (file-name-completion filenondir directory)))
2733 (cond ((null completion)
2734 (message "No completions of %s" filename)
2736 ((eq completion t) ; Means already completed "file".
2738 (unless minibuffer-p
2739 (message "Sole completion")))
2740 ((string-equal completion "") ; Means completion on "directory/".
2741 (comint-dynamic-list-filename-completions))
2742 (t ; Completion string returned.
2743 (let ((file (concat (file-name-as-directory directory) completion)))
2744 (insert (comint-quote-filename
2745 (substring (directory-file-name completion)
2746 (length filenondir))))
2747 (cond ((symbolp (file-name-completion completion directory))
2748 ;; We inserted a unique completion.
2749 (insert (if (file-directory-p file) dirsuffix filesuffix))
2750 (unless minibuffer-p
2751 (message "Completed")))
2752 ((and comint-completion-recexact comint-completion-addsuffix
2753 (string-equal filenondir completion)
2754 (file-exists-p file))
2755 ;; It's not unique, but user wants shortest match.
2756 (insert (if (file-directory-p file) dirsuffix filesuffix))
2757 (unless minibuffer-p
2758 (message "Completed shortest")))
2759 ((or comint-completion-autolist
2760 (string-equal filenondir completion))
2761 ;; It's not unique, list possible completions.
2762 (comint-dynamic-list-filename-completions))
2764 (unless minibuffer-p
2765 (message "Partially completed")))))))
2769 (defun comint-replace-by-expanded-filename ()
2770 "Dynamically expand and complete the filename at point.
2771 Replace the filename with an expanded, canonicalised and completed replacement.
2772 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
2773 with the corresponding directories. \"Canonicalised\" means `..' and `.' are
2774 removed, and the filename is made absolute instead of relative. For expansion
2775 see `expand-file-name' and `substitute-in-file-name'. For completion see
2776 `comint-dynamic-complete-filename'."
2778 (let ((filename (comint-match-partial-filename)))
2780 (replace-match (expand-file-name filename) t t)
2781 (comint-dynamic-complete-filename))))
2784 (defun comint-dynamic-simple-complete (stub candidates)
2785 "Dynamically complete STUB from CANDIDATES list.
2786 This function inserts completion characters at point by completing STUB from
2787 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2788 if completion is ambiguous.
2790 Returns nil if no completion was inserted.
2791 Returns `sole' if completed with the only completion match.
2792 Returns `shortest' if completed with the shortest of the completion matches.
2793 Returns `partial' if completed as far as possible with the completion matches.
2794 Returns `listed' if a completion listing was shown.
2796 See also `comint-dynamic-complete-filename'."
2797 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2798 (suffix (cond ((not comint-completion-addsuffix) "")
2799 ((not (consp comint-completion-addsuffix)) " ")
2800 (t (cdr comint-completion-addsuffix))))
2801 (completions (all-completions stub candidates)))
2802 (cond ((null completions)
2803 (message "No completions of %s" stub)
2805 ((= 1 (length completions)) ; Gotcha!
2806 (let ((completion (car completions)))
2807 (if (string-equal completion stub)
2808 (message "Sole completion")
2809 (insert (substring completion (length stub)))
2810 (message "Completed"))
2813 (t ; There's no unique completion.
2814 (let ((completion (try-completion stub candidates)))
2815 ;; Insert the longest substring.
2816 (insert (substring completion (length stub)))
2817 (cond ((and comint-completion-recexact comint-completion-addsuffix
2818 (string-equal stub completion)
2819 (member completion completions))
2820 ;; It's not unique, but user wants shortest match.
2822 (message "Completed shortest")
2824 ((or comint-completion-autolist
2825 (string-equal stub completion))
2826 ;; It's not unique, list possible completions.
2827 (comint-dynamic-list-completions completions)
2830 (message "Partially completed")
2834 (defun comint-dynamic-list-filename-completions ()
2835 "List in help buffer possible completions of the filename at point."
2837 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2838 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2839 ;; I think it was originally bound to solve file completion problems,
2840 ;; but subsequent changes may have made this unnecessary. sm.
2841 ;;(file-name-handler-alist nil)
2842 (filename (or (comint-match-partial-filename) ""))
2843 (filedir (file-name-directory filename))
2844 (filenondir (file-name-nondirectory filename))
2845 (directory (if filedir (comint-directory filedir) default-directory))
2846 (completions (file-name-all-completions filenondir directory)))
2847 (if (not completions)
2848 (message "No completions of %s" filename)
2849 (comint-dynamic-list-completions
2850 (mapcar 'comint-quote-filename completions)))))
2853 ;; This is bound locally in a *Completions* buffer to the list of
2854 ;; completions displayed, and is used to detect the case where the same
2855 ;; command is repeatedly used without the set of completions changing.
2856 (defvar comint-displayed-dynamic-completions nil)
2858 (defvar comint-dynamic-list-completions-config nil)
2860 (defun comint-dynamic-list-completions (completions)
2861 "List in help buffer sorted COMPLETIONS.
2862 Typing SPC flushes the help buffer."
2863 (let ((window (get-buffer-window "*Completions*")))
2864 (setq completions (sort completions 'string-lessp))
2865 (if (and (eq last-command this-command)
2866 window (window-live-p window) (window-buffer window)
2867 (buffer-name (window-buffer window))
2868 ;; The above tests are not sufficient to detect the case where we
2869 ;; should scroll, because the top-level interactive command may
2870 ;; not have displayed a completions window the last time it was
2871 ;; invoked, and there may be such a window left over from a
2872 ;; previous completion command with a different set of
2873 ;; completions. To detect that case, we also test that the set
2874 ;; of displayed completions is in fact the same as the previously
2877 (buffer-local-value 'comint-displayed-dynamic-completions
2878 (window-buffer window))))
2879 ;; If this command was repeated, and
2880 ;; there's a fresh completion window with a live buffer,
2881 ;; and this command is repeated, scroll that window.
2882 (with-current-buffer (window-buffer window)
2883 (if (pos-visible-in-window-p (point-max) window)
2884 (set-window-start window (point-min))
2885 (save-selected-window
2886 (select-window window)
2889 ;; Display a completion list for the first time.
2890 (setq comint-dynamic-list-completions-config
2891 (current-window-configuration))
2892 (with-output-to-temp-buffer "*Completions*"
2893 (display-completion-list completions))
2894 (message "Type space to flush; repeat completion command to scroll"))
2896 ;; Read the next key, to process SPC.
2898 (if (with-current-buffer (get-buffer "*Completions*")
2899 (set (make-local-variable 'comint-displayed-dynamic-completions)
2901 (setq key (read-key-sequence nil)
2903 (and (consp first) (consp (event-start first))
2904 (eq (window-buffer (posn-window (event-start first)))
2905 (get-buffer "*Completions*"))
2906 (eq (key-binding key) 'mouse-choose-completion)))
2907 ;; If the user does mouse-choose-completion with the mouse,
2908 ;; execute the command, then delete the completion window.
2910 (mouse-choose-completion first)
2911 (set-window-configuration comint-dynamic-list-completions-config))
2912 (unless (eq first ?\ )
2913 (setq unread-command-events (listify-key-sequence key)))
2914 (unless (eq first ?\t)
2915 (set-window-configuration comint-dynamic-list-completions-config))))))
2918 (defun comint-get-next-from-history ()
2919 "After fetching a line from input history, this fetches the following line.
2920 In other words, this recalls the input line after the line you recalled last.
2921 You can use this to repeat a sequence of input lines."
2923 (if comint-save-input-ring-index
2925 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
2926 (comint-next-input 1))
2927 (message "No previous history command")))
2929 (defun comint-accumulate ()
2930 "Accumulate a line to send as input along with more lines.
2931 This inserts a newline so that you can enter more text
2932 to be sent along with this line. Use \\[comint-send-input]
2933 to send all the accumulated input, at once.
2934 The entire accumulated text becomes one item in the input history
2938 (set-marker comint-accum-marker (point))
2939 (if comint-input-ring-index
2940 (setq comint-save-input-ring-index
2941 (- comint-input-ring-index 1))))
2943 (defun comint-goto-process-mark ()
2944 "Move point to the process mark.
2945 The process mark separates output, and input already sent,
2946 from input that has not yet been sent."
2948 (let ((proc (or (get-buffer-process (current-buffer))
2949 (error "Current buffer has no process"))))
2950 (goto-char (process-mark proc))
2951 (when (interactive-p)
2952 (message "Point is now at the process mark"))))
2954 (defun comint-bol-or-process-mark ()
2955 "Move point to beginning of line (after prompt) or to the process mark.
2956 The first time you use this command, it moves to the beginning of the line
2957 \(but after the prompt, if any). If you repeat it again immediately,
2958 it moves point to the process mark.
2960 The process mark separates the process output, along with input already sent,
2961 from input that has not yet been sent. Ordinarily, the process mark
2962 is at the beginning of the current input line; but if you have
2963 used \\[comint-accumulate] to send multiple lines at once,
2964 the process mark is at the beginning of the accumulated input."
2966 (if (not (eq last-command 'comint-bol-or-process-mark))
2968 (comint-goto-process-mark)))
2970 (defun comint-set-process-mark ()
2971 "Set the process mark at point."
2973 (let ((proc (or (get-buffer-process (current-buffer))
2974 (error "Current buffer has no process"))))
2975 (set-marker (process-mark proc) (point))
2976 (message "Process mark set")))
2979 ;; Author: Peter Breton <pbreton@cs.umb.edu>
2981 ;; This little add-on for comint is intended to make it easy to get
2982 ;; output from currently active comint buffers into another buffer,
2983 ;; or buffers, and then go back to using the comint shell.
2985 ;; My particular use is SQL interpreters; I want to be able to execute a
2986 ;; query using the process associated with a comint-buffer, and save that
2987 ;; somewhere else. Because the process might have state (for example, it
2988 ;; could be in an uncommitted transaction), just running starting a new
2989 ;; process and having it execute the query and then finish, would not
2990 ;; work. I'm sure there are other uses as well, although in many cases
2991 ;; starting a new process is the simpler, and thus preferable, approach.
2993 ;; The basic implementation is as follows: comint-redirect changes the
2994 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
2995 ;; its own filter. The filter puts the output into the designated buffer,
2996 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2997 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
2998 ;; sees the stop regexp, it restores the old filter functions, and runs
2999 ;; `comint-redirect-hook'.
3001 ;; Each comint buffer may only use one redirection at a time, but any number
3002 ;; of different comint buffers may be simultaneously redirected.
3004 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
3005 ;; correct prompt for your interpreter, or that you supply a regexp that says
3006 ;; when the redirection is finished. Otherwise, redirection will continue
3007 ;; indefinitely. The code now does a sanity check to ensure that it can find
3008 ;; a prompt in the comint buffer; however, it is still important to ensure that
3009 ;; this prompt is set correctly.
3011 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
3012 ;; perhaps it should prompt for a terminating string (with an
3013 ;; appropriate magic default by examining what we think is the prompt)?
3015 ;; Fixme: look for appropriate fields, rather than regexp, if
3016 ;; `comint-use-prompt-regexp-instead-of-fields' is true.
3018 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3020 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3022 (defcustom comint-redirect-verbose nil
3023 "*If non-nil, print messages each time the redirection filter is invoked.
3024 Also print a message when redirection is completed."
3028 ;; Directly analagous to comint-preoutput-filter-functions
3029 (defvar comint-redirect-filter-functions nil
3030 "List of functions to call before inserting redirected process output.
3031 Each function gets one argument, a string containing the text received
3032 from the subprocess. It should return the string to insert, perhaps
3033 the same string that was received, or perhaps a modified or transformed
3036 The functions on the list are called sequentially, and each one is given
3037 the string returned by the previous one. The string returned by the
3038 last function is the text that is actually inserted in the redirection buffer.
3040 You can use `add-hook' to add functions to this list
3041 either globally or locally.")
3043 ;; Internal variables
3045 (defvar comint-redirect-output-buffer nil
3046 "The buffer or list of buffers to put output into.")
3048 (defvar comint-redirect-finished-regexp nil
3049 "Regular expression that determines when to stop redirection in Comint.
3050 When the redirection filter function is given output that matches this regexp,
3051 the output is inserted as usual, and redirection is completed.")
3053 (defvar comint-redirect-insert-matching-regexp nil
3054 "If non-nil, the text that ends a redirection is included in it.
3055 More precisely, the text that matches `comint-redirect-finished-regexp'
3056 and therefore terminates an output redirection is inserted in the
3057 redirection target buffer, along with the preceding output.")
3059 (defvar comint-redirect-echo-input nil
3060 "Non-nil means echo input in the process buffer even during redirection.")
3062 (defvar comint-redirect-completed nil
3063 "Non-nil if redirection has completed in the current buffer.")
3065 (defvar comint-redirect-original-mode-line-process nil
3066 "Original mode line for redirected process.")
3068 (defvar comint-redirect-perform-sanity-check t
3069 "If non-nil, check that redirection is likely to complete successfully.
3070 More precisely, before starting a redirection, verify that the
3071 regular expression `comint-redirect-finished-regexp' that controls
3072 when to terminate it actually matches some text already in the process
3073 buffer. The idea is that this regular expression should match a prompt
3074 string, and that there ought to be at least one copy of your prompt string
3075 in the process buffer already.")
3077 (defvar comint-redirect-original-filter-function nil
3078 "The process filter that was in place when redirection is started.
3079 When redirection is completed, the process filter is restored to
3082 (defvar comint-redirect-subvert-readonly nil
3083 "Non-nil means comint-redirect can insert into otherwise-readonly buffers.
3084 The readonly status is toggled around insertion.
3085 This is useful, for instance, for insertion into Help mode buffers.
3086 You probably want to set it locally to the output buffer.")
3088 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3090 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3092 (defun comint-redirect-setup (output-buffer
3095 &optional echo-input)
3096 "Set up for output redirection.
3097 This function sets local variables that are used by `comint-redirect-filter'
3098 to perform redirection.
3100 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3101 in the output matches FINISHED-REGEXP.
3103 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3104 original Comint buffer.
3106 This function is called by `comint-redirect-send-command-to-process',
3107 and does not normally need to be invoked by the end user or programmer."
3108 (with-current-buffer comint-buffer
3110 (make-local-variable 'comint-redirect-original-mode-line-process)
3111 (setq comint-redirect-original-mode-line-process mode-line-process)
3113 (make-local-variable 'comint-redirect-output-buffer)
3114 (setq comint-redirect-output-buffer output-buffer)
3116 (make-local-variable 'comint-redirect-finished-regexp)
3117 (setq comint-redirect-finished-regexp finished-regexp)
3119 (make-local-variable 'comint-redirect-echo-input)
3120 (setq comint-redirect-echo-input echo-input)
3122 (make-local-variable 'comint-redirect-completed)
3123 (setq comint-redirect-completed nil)
3125 (setq mode-line-process
3126 (if mode-line-process
3127 (list (concat (elt mode-line-process 0) " Redirection"))
3128 (list ":%s Redirection")))))
3130 (defun comint-redirect-cleanup ()
3131 "End a Comint redirection. See `comint-redirect-send-command'."
3133 ;; Restore the process filter
3134 (set-process-filter (get-buffer-process (current-buffer))
3135 comint-redirect-original-filter-function)
3136 ;; Restore the mode line
3137 (setq mode-line-process comint-redirect-original-mode-line-process)
3138 ;; Set the completed flag
3139 (setq comint-redirect-completed t))
3141 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3142 ;; that it really occurs.
3143 (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
3145 (defun comint-redirect-filter (process input-string)
3146 "Filter function which redirects output from PROCESS to a buffer or buffers.
3147 The variable `comint-redirect-output-buffer' says which buffer(s) to
3150 INPUT-STRING is the input from the Comint process.
3152 This function runs as a process filter, and does not need to be invoked by the
3155 (with-current-buffer (process-buffer process)
3156 (comint-redirect-preoutput-filter input-string)
3157 ;; If we have to echo output, give it to the original filter function
3158 (and comint-redirect-echo-input
3159 comint-redirect-original-filter-function
3160 (funcall comint-redirect-original-filter-function
3161 process input-string)))))
3164 (defun comint-redirect-preoutput-filter (input-string)
3165 "Comint filter function which redirects Comint output to a buffer or buffers.
3166 The variable `comint-redirect-output-buffer' says which buffer(s) to
3169 INPUT-STRING is the input from the Comint process.
3171 This function does not need to be invoked by the end user."
3172 (let ((output-buffer-list
3173 (if (listp comint-redirect-output-buffer)
3174 comint-redirect-output-buffer
3175 (list comint-redirect-output-buffer)))
3176 (filtered-input-string input-string))
3178 ;; If there are any filter functions, give them a chance to modify the string
3179 (let ((functions comint-redirect-filter-functions))
3180 (while (and functions filtered-input-string)
3181 (if (eq (car functions) t)
3182 ;; If a local value says "use the default value too",
3184 (let ((functions (default-value 'comint-redirect-filter-functions)))
3185 (while (and functions filtered-input-string)
3186 (setq filtered-input-string
3187 (funcall (car functions) filtered-input-string))
3188 (setq functions (cdr functions))))
3189 (setq filtered-input-string
3190 (funcall (car functions) filtered-input-string)))
3191 (setq functions (cdr functions))))
3193 ;; Clobber `comint-redirect-finished-regexp'
3194 (or comint-redirect-insert-matching-regexp
3195 (and (string-match comint-redirect-finished-regexp filtered-input-string)
3196 (setq filtered-input-string
3197 (replace-match "" nil nil filtered-input-string))))
3199 ;; Send output to all registered buffers
3201 (dolist (buf output-buffer-list)
3202 ;; Set this buffer to the output buffer
3203 (set-buffer (get-buffer-create buf))
3204 ;; Go to the end of the buffer
3205 (goto-char (point-max))
3206 ;; Insert the output
3207 (let ((inhibit-read-only comint-redirect-subvert-readonly))
3208 (insert filtered-input-string))))
3211 (and comint-redirect-verbose
3212 (message "Redirected output to buffer(s) %s"
3213 (mapconcat 'identity output-buffer-list " ")))
3215 ;; If we see the prompt, tidy up
3216 ;; We'll look for the prompt in the original string, so nobody can
3218 (and (string-match comint-redirect-finished-regexp input-string)
3220 (and comint-redirect-verbose
3221 (message "Redirection completed"))
3222 (comint-redirect-cleanup)
3223 (run-hooks 'comint-redirect-hook)))
3225 (if comint-redirect-echo-input
3226 filtered-input-string
3230 (defun comint-redirect-send-command (command output-buffer echo &optional no-display)
3231 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3232 With prefix arg ECHO, echo output in process buffer.
3234 If NO-DISPLAY is non-nil, do not show the output buffer."
3235 (interactive "sCommand: \nBOutput Buffer: \nP")
3236 (let ((process (get-buffer-process (current-buffer))))
3238 (comint-redirect-send-command-to-process
3239 command output-buffer (current-buffer) echo no-display)
3240 (error "No process for current buffer"))))
3243 (defun comint-redirect-send-command-to-process
3244 (command output-buffer process echo &optional no-display)
3245 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3246 With prefix arg, echo output in process buffer.
3248 If NO-DISPLAY is non-nil, do not show the output buffer."
3249 (interactive "sCommand: \nBOutput Buffer: \nbProcess Buffer: \nP")
3250 (let* (;; The process buffer
3251 (process-buffer (if (processp process)
3252 (process-buffer process)
3254 (proc (get-buffer-process process-buffer)))
3255 ;; Change to the process buffer
3256 (with-current-buffer process-buffer
3258 ;; Make sure there's a prompt in the current process buffer
3259 (and comint-redirect-perform-sanity-check
3261 (goto-char (point-max))
3262 (or (re-search-backward comint-prompt-regexp nil t)
3263 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3265 ;;;;;;;;;;;;;;;;;;;;;
3266 ;; Set up for redirection
3267 ;;;;;;;;;;;;;;;;;;;;;
3268 (comint-redirect-setup
3274 comint-prompt-regexp
3278 ;;;;;;;;;;;;;;;;;;;;;
3280 ;;;;;;;;;;;;;;;;;;;;;
3281 ;; Save the old filter
3282 (setq comint-redirect-original-filter-function
3283 (process-filter proc))
3284 (set-process-filter proc 'comint-redirect-filter)
3286 ;;;;;;;;;;;;;;;;;;;;;
3288 ;;;;;;;;;;;;;;;;;;;;;
3289 (process-send-string
3291 (concat command "\n"))
3293 ;;;;;;;;;;;;;;;;;;;;;
3295 ;;;;;;;;;;;;;;;;;;;;;
3299 (if (listp output-buffer)
3301 output-buffer)))))))
3304 (defun comint-redirect-results-list (command regexp regexp-group)
3305 "Send COMMAND to current process.
3306 Return a list of expressions in the output which match REGEXP.
3307 REGEXP-GROUP is the regular expression group in REGEXP to use."
3308 (comint-redirect-results-list-from-process
3309 (get-buffer-process (current-buffer))
3310 command regexp regexp-group))
3313 (defun comint-redirect-results-list-from-process (process command regexp regexp-group)
3314 "Send COMMAND to PROCESS.
3315 Return a list of expressions in the output which match REGEXP.
3316 REGEXP-GROUP is the regular expression group in REGEXP to use."
3317 (let ((output-buffer " *Comint Redirect Work Buffer*")
3320 (set-buffer (get-buffer-create output-buffer))
3322 (comint-redirect-send-command-to-process command
3323 output-buffer process nil t)
3324 ;; Wait for the process to complete
3325 (set-buffer (process-buffer process))
3326 (while (null comint-redirect-completed)
3327 (accept-process-output nil 1))
3328 ;; Collect the output
3329 (set-buffer output-buffer)
3330 (goto-char (point-min))
3331 ;; Skip past the command, if it was echoed
3332 (and (looking-at command)
3334 (while (re-search-forward regexp nil t)
3336 (cons (buffer-substring-no-properties
3337 (match-beginning regexp-group)
3338 (match-end regexp-group))
3343 (add-to-list 'debug-ignored-errors x))
3344 '("^Not at command line$"
3345 "^Empty input ring$"
3347 "^Not found$" ; Too common?
3348 "^Current buffer has no process$"))
3351 ;; Converting process modes to use comint mode
3352 ;; ===========================================================================
3353 ;; The code in the Emacs 19 distribution has all been modified to use comint
3354 ;; where needed. However, there are `third-party' packages out there that
3355 ;; still use the old shell mode. Here's a guide to conversion.
3357 ;; Renaming variables
3358 ;; Most of the work is renaming variables and functions. These are the common
3361 ;; last-input-start comint-last-input-start
3362 ;; last-input-end comint-last-input-end
3363 ;; shell-prompt-pattern comint-prompt-regexp
3364 ;; shell-set-directory-error-hook <no equivalent>
3366 ;; shell-set-directory <unnecessary>
3367 ;; shell-mode-map comint-mode-map
3369 ;; shell-send-input comint-send-input
3370 ;; shell-send-eof comint-delchar-or-maybe-eof
3371 ;; kill-shell-input comint-kill-input
3372 ;; interrupt-shell-subjob comint-interrupt-subjob
3373 ;; stop-shell-subjob comint-stop-subjob
3374 ;; quit-shell-subjob comint-quit-subjob
3375 ;; kill-shell-subjob comint-kill-subjob
3376 ;; kill-output-from-shell comint-delete-output
3377 ;; show-output-from-shell comint-show-output
3378 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3380 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3381 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3382 ;; Comint mode does not provide functionality equivalent to
3383 ;; shell-set-directory-error-hook; it is gone.
3385 ;; comint-last-input-start is provided for modes which want to munge
3386 ;; the buffer after input is sent, perhaps because the inferior
3387 ;; insists on echoing the input. The LAST-INPUT-START variable in
3388 ;; the old shell package was used to implement a history mechanism,
3389 ;; but you should think twice before using comint-last-input-start
3390 ;; for this; the input history ring often does the job better.
3392 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3393 ;; *not* create the comint-mode local variables in your foo-mode function.
3394 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3395 ;; necessary comint-specific local variables. Then create the
3396 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3397 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3398 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3399 ;; get-old-input) that need to be different from the defaults. Call
3400 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3401 ;; comint-mode will take care of it. The following example, from shell.el,
3404 ;; (defvar shell-mode-map '())
3405 ;; (cond ((not shell-mode-map)
3406 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3407 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3408 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3409 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3410 ;; (define-key shell-mode-map "\M-?"
3411 ;; 'comint-dynamic-list-filename-completions)))
3413 ;; (defun shell-mode ()
3416 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3417 ;; (setq major-mode 'shell-mode)
3418 ;; (setq mode-name "Shell")
3419 ;; (use-local-map shell-mode-map)
3420 ;; (make-local-variable 'shell-directory-stack)
3421 ;; (setq shell-directory-stack nil)
3422 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3423 ;; (run-hooks 'shell-mode-hook))
3426 ;; Completion for comint-mode users
3428 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3429 ;; hook to add completion functions to. Functions on this list should return
3430 ;; non-nil if completion occurs (i.e., further completion should not occur).
3431 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3437 ;; arch-tag: 1793314c-09db-40be-9549-9aeae3e75164
3438 ;;; comint.el ends here
HCoop / bpt / emacs.git / blob