1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 1990, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 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 3, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
30 ;; This file defines a general command-interpreter-in-a-buffer package
31 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
32 ;; modes on top of comint mode -- e.g., Lisp, shell, scheme, T, soar, ....
33 ;; This way, all these specific packages share a common base functionality,
34 ;; and a common set of bindings, which makes them easier to use (and
35 ;; saves code, implementation time, etc., etc.).
37 ;; Several packages are already defined using comint mode:
38 ;; - shell.el defines a shell-in-a-buffer mode.
39 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
41 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
42 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
43 ;; - The file soar.el tunes Lisp and inferior-lisp modes for Soar.
44 ;; - cmutex.el defines TeX and LaTeX modes that invoke TeX, LaTeX, BibTeX,
45 ;; previewers, and printers from within Emacs.
46 ;; - background.el allows csh-like job control inside Emacs.
47 ;; It is pretty easy to make new derived modes for other processes.
49 ;; For documentation on the functionality provided by Comint mode, and
50 ;; the hooks available for customising it, see the comments below.
51 ;; For further information on the standard derived modes (shell,
52 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
54 ;; For hints on converting existing process modes (e.g., tex-mode,
55 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
56 ;; instead of shell-mode, see the notes at the end of this file.
59 ;; Brief Command Documentation:
60 ;;============================================================================
61 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
64 ;; M-p comint-previous-input Cycle backwards in input history
65 ;; M-n comint-next-input Cycle forwards
66 ;; M-r comint-previous-matching-input Previous input matching a regexp
67 ;; M-s comint-next-matching-input Next input that matches
68 ;; M-C-l comint-show-output Show last batch of process output
69 ;; RET comint-send-input
70 ;; C-d comint-delchar-or-maybe-eof Delete char unless at end of buff
71 ;; C-c C-a comint-bol-or-process-mark First time, move point to bol;
72 ;; second time, move to process-mark.
73 ;; C-c C-u comint-kill-input ^u
74 ;; C-c C-w backward-kill-word ^w
75 ;; C-c C-c comint-interrupt-subjob ^c
76 ;; C-c C-z comint-stop-subjob ^z
77 ;; C-c C-\ comint-quit-subjob ^\
78 ;; C-c C-o comint-delete-output Delete last batch of process output
79 ;; C-c C-r comint-show-output Show last batch of process output
80 ;; C-c C-l comint-dynamic-list-input-ring List input history
82 ;; Not bound by default in comint-mode (some are in shell mode)
83 ;; comint-run Run a program under comint-mode
84 ;; send-invisible Read a line w/o echo, and send to proc
85 ;; comint-dynamic-complete-filename Complete filename at point.
86 ;; comint-dynamic-list-filename-completions List completions in help buffer.
87 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
88 ;; replace with expanded/completed name.
89 ;; comint-replace-by-expanded-history Expand history at point;
90 ;; replace with expanded name.
91 ;; comint-magic-space Expand history and add (a) space(s).
92 ;; comint-kill-subjob No mercy.
93 ;; comint-show-maximum-output Show as much output as possible.
94 ;; comint-continue-subjob Send CONT signal to buffer's process
95 ;; group. Useful if you accidentally
96 ;; suspend your process (with C-c C-z).
97 ;; comint-get-next-from-history Fetch successive input history lines
98 ;; comint-accumulate Combine lines to send them together
100 ;; comint-goto-process-mark Move point to where process-mark is.
101 ;; comint-set-process-mark Set process-mark to point.
103 ;; comint-mode-hook is the Comint mode hook. Basically for your keybindings.
109 ;; Buffer Local Variables:
110 ;;============================================================================
111 ;; Comint mode buffer local variables:
112 ;; comint-prompt-regexp string comint-bol uses to match prompt
113 ;; comint-delimiter-argument-list list For delimiters and arguments
114 ;; comint-last-input-start marker Handy if inferior always echoes
115 ;; comint-last-input-end marker For comint-delete-output command
116 ;; comint-input-ring-size integer For the input history
117 ;; comint-input-ring ring mechanism
118 ;; comint-input-ring-index number ...
119 ;; comint-save-input-ring-index number ...
120 ;; comint-input-autoexpand symbol ...
121 ;; comint-input-ignoredups boolean ...
122 ;; comint-dynamic-complete-functions hook For the completion mechanism
123 ;; comint-completion-fignore list ...
124 ;; comint-file-name-chars string ...
125 ;; comint-file-name-quote-list list ...
126 ;; comint-get-old-input function Hooks for specific
127 ;; comint-input-filter-functions hook process-in-a-buffer
128 ;; comint-output-filter-functions hook function modes.
129 ;; comint-preoutput-filter-functions hook
130 ;; comint-input-filter function ...
131 ;; comint-input-sender function ...
132 ;; comint-eol-on-send boolean ...
133 ;; comint-process-echoes boolean ...
134 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
135 ;; comint-move-point-for-output symbol ...
136 ;; comint-scroll-show-maximum-output boolean ...
137 ;; comint-accum-marker maker For comint-accumulate
139 ;; Comint mode non-buffer local variables:
140 ;; comint-completion-addsuffix boolean/cons For file name
141 ;; comint-completion-autolist boolean completion behavior
142 ;; comint-completion-recexact boolean ...
145 "General command interpreter in a window stuff."
148 (defgroup comint-completion nil
149 "Completion facilities in comint."
152 (defgroup comint-source nil
153 "Source finding facilities in comint."
157 (defvar comint-prompt-regexp
"^"
158 "Regexp to recognize prompts in the inferior process.
159 Defaults to \"^\", the null string at BOL.
161 This variable is only used if the variable
162 `comint-use-prompt-regexp' is non-nil.
165 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
166 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
167 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
169 shell: \"^[^#$%>\\n]*[#$%>] *\"
172 This is a good thing to set in mode hooks.")
174 (defcustom comint-prompt-read-only nil
175 "If non-nil, the comint prompt is read only.
176 The read only region includes the newline before the prompt.
177 This does not affect existing prompts.
178 Certain derived modes may override this option.
180 If you set this option to t, then the safe way to temporarily
181 override the read-only-ness of comint prompts is to call
182 `comint-kill-whole-line' or `comint-kill-region' with no
183 narrowing in effect. This way you will be certain that none of
184 the remaining prompts will be accidentally messed up. You may
185 wish to put something like the following in your `.emacs' file:
187 \(add-hook 'comint-mode-hook
189 (define-key comint-mode-map \"\\C-w\" 'comint-kill-region)
190 (define-key comint-mode-map [C-S-backspace]
191 'comint-kill-whole-line)))
193 If you sometimes use comint-mode on text-only terminals or with `emacs -nw',
194 you might wish to use another binding for `comint-kill-whole-line'."
199 (defvar comint-delimiter-argument-list
()
200 "List of characters to recognize as separate arguments in input.
201 Strings comprising a character in this list will separate the arguments
202 surrounding them, and also be regarded as arguments in their own right (unlike
203 whitespace). See `comint-arguments'.
204 Defaults to the empty list.
206 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
208 This is a good thing to set in mode hooks.")
210 (defcustom comint-input-autoexpand nil
211 "*If non-nil, expand input command history references on completion.
212 This mirrors the optional behavior of tcsh (its autoexpand and histlist).
214 If the value is `input', then the expansion is seen on input.
215 If the value is `history', then the expansion is only when inserting
216 into the buffer's input ring. See also `comint-magic-space' and
217 `comint-dynamic-complete'.
219 This variable is buffer-local."
220 :type
'(choice (const :tag
"off" nil
)
226 (defface comint-highlight-input
'((t (:weight bold
)))
227 "Face to use to highlight user input."
230 (defface comint-highlight-prompt
231 '((((min-colors 88) (background dark
)) (:foreground
"cyan1"))
232 (((background dark
)) (:foreground
"cyan"))
233 (t (:foreground
"dark blue")))
234 "Face to use to highlight prompts."
237 (defcustom comint-input-ignoredups nil
238 "*If non-nil, don't add input matching the last on the input ring.
239 This mirrors the optional behavior of bash.
241 This variable is buffer-local."
245 (defcustom comint-input-ring-file-name nil
246 "*If non-nil, name of the file to read/write input history.
247 See also `comint-read-input-ring' and `comint-write-input-ring'.
249 This variable is buffer-local, and is a good thing to set in mode hooks."
250 :type
'(choice (const :tag
"nil" nil
)
254 (defcustom comint-scroll-to-bottom-on-input nil
255 "*Controls whether input to interpreter causes window to scroll.
256 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
257 If `this', scroll only the selected window.
261 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
262 :type
'(choice (const :tag
"off" nil
)
268 (defcustom comint-move-point-for-output nil
269 "*Controls whether interpreter output moves point to the end of the output.
270 If nil, then output never moves point to the output.
271 (If the output occurs at point, it is inserted before point.)
272 If t or `all', move point in all windows showing the buffer.
273 If `this', move point only the selected window.
274 If `others', move point only in other windows, not in the selected window.
278 See the variable `comint-scroll-show-maximum-output' and the function
279 `comint-postoutput-scroll-to-bottom'.
280 This variable is buffer-local in all Comint buffers."
281 :type
'(choice (const :tag
"off" nil
)
288 (defvaralias 'comint-scroll-to-bottom-on-output
'comint-move-point-for-output
)
290 (defcustom comint-scroll-show-maximum-output t
291 "*Controls how to scroll due to interpreter output.
292 This variable applies when point is at the end of the buffer
293 \(either because it was originally there, or because
294 `comint-move-point-for-output' said to move it there)
295 and output from the subprocess is inserted.
297 Non-nil means scroll so that the window is full of text
298 and point is on the last line. A value of nil
299 means don't do anything special--scroll normally.
301 See also the variable `comint-move-point-for-output' and the function
302 `comint-postoutput-scroll-to-bottom'.
303 This variable is buffer-local in all Comint buffers."
307 (defcustom comint-buffer-maximum-size
1024
308 "*The maximum size in lines for Comint buffers.
309 Comint buffers are truncated from the top to be no greater than this number, if
310 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
314 (defvar comint-input-ring-size
150
315 "Size of input history ring.")
317 (defvar comint-input-ring-separator
"\n"
318 "Separator between commands in the history file.")
320 (defvar comint-input-history-ignore
"^#"
321 "Regexp for history entries that should be ignored when Comint initializes.")
323 (defcustom comint-process-echoes nil
324 "*If non-nil, assume that the subprocess echoes any input.
325 If so, delete one copy of the input so that only one copy eventually
326 appears in the buffer.
328 This variable is buffer-local."
332 ;; AIX puts the name of the person being su'd to in front of the prompt.
333 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
334 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
335 ;; ssh-add prints a prompt like `Enter passphrase: '.
336 ;; plink prints a prompt like `Passphrase for key "root@GNU.ORG": '.
337 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
338 (defcustom comint-password-prompt-regexp
339 "\\(\\([Oo]ld \\|[Nn]ew \\|'s \\|login \\|\
340 Kerberos \\|CVS \\|UNIX \\| SMB \\|LDAP \\|^\\)\
341 \[Pp]assword\\( (again)\\)?\\|\
342 pass phrase\\|\\(Enter \\|Repeat \\|Bad \\)?[Pp]assphrase\\)\
343 \\(?:, try again\\)?\\(?: for [^:]+\\)?:\\s *\\'"
344 "*Regexp matching prompts for passwords in the inferior process.
345 This is used by `comint-watch-for-password-prompt'."
349 ;; Here are the per-interpreter hooks.
350 (defvar comint-get-old-input
(function comint-get-old-input-default
)
351 "Function that returns old text in Comint mode.
352 This function is called when return is typed while the point is in old
353 text. It returns the text to be submitted as process input. The
354 default is `comint-get-old-input-default', which either grabs the
355 current input field or grabs the current line and strips off leading
356 text matching `comint-prompt-regexp', depending on the value of
357 `comint-use-prompt-regexp'.")
359 (defvar comint-dynamic-complete-functions
360 '(comint-replace-by-expanded-history comint-dynamic-complete-filename
)
361 "List of functions called to perform completion.
362 Functions should return non-nil if completion was performed.
363 See also `comint-dynamic-complete'.
365 This is a good thing to set in mode hooks.")
367 (defvar comint-input-filter
368 (function (lambda (str) (not (string-match "\\`\\s *\\'" str
))))
369 "Predicate for filtering additions to input history.
370 Takes one argument, the input. If non-nil, the input may be saved on the input
371 history list. Default is to save anything that isn't all whitespace.")
373 (defvar comint-input-filter-functions
'()
374 "Abnormal hook run before input is sent to the process.
375 These functions get one argument, a string containing the text to send.")
378 (defvar comint-output-filter-functions
'(comint-postoutput-scroll-to-bottom comint-watch-for-password-prompt
)
379 "Functions to call after output is inserted into the buffer.
380 One possible function is `comint-postoutput-scroll-to-bottom'.
381 These functions get one argument, a string containing the text as originally
382 inserted. Note that this might not be the same as the buffer contents between
383 `comint-last-output-start' and the buffer's `process-mark', if other filter
384 functions have already modified the buffer.
386 See also `comint-preoutput-filter-functions'.
388 You can use `add-hook' to add functions to this list
389 either globally or locally.")
391 (defvar comint-input-sender-no-newline nil
392 "Non-nil directs the `comint-input-sender' function not to send a newline.")
394 (defvar comint-input-sender
(function comint-simple-send
)
395 "Function to actually send to PROCESS the STRING submitted by user.
396 Usually this is just `comint-simple-send', but if your mode needs to
397 massage the input string, put a different function here.
398 `comint-simple-send' just sends the string plus a newline.
399 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
400 This is called from the user command `comint-send-input'.")
402 (defcustom comint-eol-on-send t
403 "*Non-nil means go to the end of the line before sending input.
404 See `comint-send-input'."
408 ;; Note: If it is decided to purge comint-prompt-regexp from the source
409 ;; entirely, searching for uses of this variable will help to identify
410 ;; places that need attention.
411 (defcustom comint-use-prompt-regexp nil
412 "*If non-nil, use `comint-prompt-regexp' to recognize prompts.
413 If nil, then program output and user-input are given different `field'
414 properties, which Emacs commands can use to distinguish them (in
415 particular, common movement commands such as `beginning-of-line'
416 respect field boundaries in a natural way)."
420 ;; Autoload is necessary for Custom to recognize old alias.
422 (define-obsolete-variable-alias 'comint-use-prompt-regexp-instead-of-fields
423 'comint-use-prompt-regexp
"22.1")
425 (defcustom comint-mode-hook nil
426 "Hook run upon entry to `comint-mode'.
427 This is run before the process is cranked up."
431 (defcustom comint-exec-hook
'()
432 "Hook run each time a process is exec'd by `comint-exec'.
433 This is called after the process is cranked up. It is useful for things that
434 must be done each time a process is executed in a Comint mode buffer (e.g.,
435 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
436 executed once when the buffer is created."
440 (defvar comint-mode-map
441 (let ((map (make-sparse-keymap)))
443 (define-key map
"\ep" 'comint-previous-input
)
444 (define-key map
"\en" 'comint-next-input
)
445 (define-key map
[C-up
] 'comint-previous-input
)
446 (define-key map
[C-down
] 'comint-next-input
)
447 (define-key map
"\er" 'comint-previous-matching-input
)
448 (define-key map
"\es" 'comint-next-matching-input
)
449 (define-key map
[?\C-c ?\M-r
] 'comint-previous-matching-input-from-input
)
450 (define-key map
[?\C-c ?\M-s
] 'comint-next-matching-input-from-input
)
451 (define-key map
"\e\C-l" 'comint-show-output
)
452 (define-key map
"\C-m" 'comint-send-input
)
453 (define-key map
"\C-d" 'comint-delchar-or-maybe-eof
)
454 (define-key map
"\C-c " 'comint-accumulate
)
455 (define-key map
"\C-c\C-x" 'comint-get-next-from-history
)
456 (define-key map
"\C-c\C-a" 'comint-bol-or-process-mark
)
457 (define-key map
"\C-c\C-u" 'comint-kill-input
)
458 (define-key map
"\C-c\C-w" 'backward-kill-word
)
459 (define-key map
"\C-c\C-c" 'comint-interrupt-subjob
)
460 (define-key map
"\C-c\C-z" 'comint-stop-subjob
)
461 (define-key map
"\C-c\C-\\" 'comint-quit-subjob
)
462 (define-key map
"\C-c\C-m" 'comint-copy-old-input
)
463 (define-key map
"\C-c\C-o" 'comint-delete-output
)
464 (define-key map
"\C-c\C-r" 'comint-show-output
)
465 (define-key map
"\C-c\C-e" 'comint-show-maximum-output
)
466 (define-key map
"\C-c\C-l" 'comint-dynamic-list-input-ring
)
467 (define-key map
"\C-c\C-n" 'comint-next-prompt
)
468 (define-key map
"\C-c\C-p" 'comint-previous-prompt
)
469 (define-key map
"\C-c\C-d" 'comint-send-eof
)
470 (define-key map
"\C-c\C-s" 'comint-write-output
)
471 (define-key map
"\C-c." 'comint-insert-previous-argument
)
473 (define-key map
[mouse-2
] 'comint-insert-input
)
476 (define-key map
[menu-bar completion
]
477 (cons "Complete" (make-sparse-keymap "Complete")))
478 (define-key map
[menu-bar completion complete-expand
]
479 '("Expand File Name" . comint-replace-by-expanded-filename
))
480 (define-key map
[menu-bar completion complete-listing
]
481 '("File Completion Listing" . comint-dynamic-list-filename-completions
))
482 (define-key map
[menu-bar completion complete-file
]
483 '("Complete File Name" . comint-dynamic-complete-filename
))
484 (define-key map
[menu-bar completion complete
]
485 '("Complete Before Point" . comint-dynamic-complete
))
487 (define-key map
[menu-bar inout
]
488 (cons "In/Out" (make-sparse-keymap "In/Out")))
489 (define-key map
[menu-bar inout delete-output
]
490 '("Delete Current Output Group" . comint-delete-output
))
491 (define-key map
[menu-bar inout append-output-to-file
]
492 '("Append Current Output Group to File" . comint-append-output-to-file
))
493 (define-key map
[menu-bar inout write-output
]
494 '("Write Current Output Group to File" . comint-write-output
))
495 (define-key map
[menu-bar inout next-prompt
]
496 '("Forward Output Group" . comint-next-prompt
))
497 (define-key map
[menu-bar inout previous-prompt
]
498 '("Backward Output Group" . comint-previous-prompt
))
499 (define-key map
[menu-bar inout show-maximum-output
]
500 '("Show Maximum Output" . comint-show-maximum-output
))
501 (define-key map
[menu-bar inout show-output
]
502 '("Show Current Output Group" . comint-show-output
))
503 (define-key map
[menu-bar inout kill-input
]
504 '("Kill Current Input" . comint-kill-input
))
505 (define-key map
[menu-bar inout copy-input
]
506 '("Copy Old Input" . comint-copy-old-input
))
507 (define-key map
[menu-bar inout forward-matching-history
]
508 '("Forward Matching Input..." . comint-forward-matching-input
))
509 (define-key map
[menu-bar inout backward-matching-history
]
510 '("Backward Matching Input..." . comint-backward-matching-input
))
511 (define-key map
[menu-bar inout next-matching-history
]
512 '("Next Matching Input..." . comint-next-matching-input
))
513 (define-key map
[menu-bar inout previous-matching-history
]
514 '("Previous Matching Input..." . comint-previous-matching-input
))
515 (define-key map
[menu-bar inout next-matching-history-from-input
]
516 '("Next Matching Current Input" . comint-next-matching-input-from-input
))
517 (define-key map
[menu-bar inout previous-matching-history-from-input
]
518 '("Previous Matching Current Input" . comint-previous-matching-input-from-input
))
519 (define-key map
[menu-bar inout next-history
]
520 '("Next Input" . comint-next-input
))
521 (define-key map
[menu-bar inout previous-history
]
522 '("Previous Input" . comint-previous-input
))
523 (define-key map
[menu-bar inout list-history
]
524 '("List Input History" . comint-dynamic-list-input-ring
))
525 (define-key map
[menu-bar inout expand-history
]
526 '("Expand History Before Point" . comint-replace-by-expanded-history
))
528 (let ((signals-map (make-sparse-keymap "Signals")))
529 (define-key map
[menu-bar signals
] (cons "Signals" signals-map
))
530 (define-key signals-map
[eof] '("EOF" . comint-send-eof))
531 (define-key signals-map [kill] '("KILL" . comint-kill-subjob))
532 (define-key signals-map [quit] '("QUIT" . comint-quit-subjob))
533 (define-key signals-map [cont] '("CONT" . comint-continue-subjob))
534 (define-key signals-map [stop] '("STOP" . comint-stop-subjob))
535 (define-key signals-map [break] '("BREAK" . comint-interrupt-subjob)))
536 ;; Put them in the menu bar:
537 (setq menu-bar-final-items (append '(completion inout signals)
538 menu-bar-final-items))
541 ;; Fixme: Is this still relevant?
542 (defvar comint-ptyp t
543 "Non-nil if communications via pty; false if by pipe. Buffer local.
544 This is to work around a bug in Emacs process signaling.")
546 (defvar comint-input-ring nil)
547 (defvar comint-last-input-start nil)
548 (defvar comint-last-input-end nil)
549 (defvar comint-last-output-start nil)
550 (defvar comint-input-ring-index nil
551 "Index of last matched history element.")
552 (defvar comint-matching-input-from-input-string ""
553 "Input previously used to match input history.")
554 (defvar comint-save-input-ring-index
555 "Last input ring index which you copied.
556 This is to support the command \\[comint-get-next-from-history].")
558 (defvar comint-accum-marker nil
559 "Non-nil if you are accumulating input lines to send as input together.
560 The command \\[comint-accumulate] sets this.")
562 (defvar comint-stored-incomplete-input nil
563 "Stored input for history cycling.")
565 (put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
566 (put 'comint-input-ring 'permanent-local t)
567 (put 'comint-input-ring-index 'permanent-local t)
568 (put 'comint-save-input-ring-index 'permanent-local t)
569 (put 'comint-input-autoexpand 'permanent-local t)
570 (put 'comint-input-filter-functions 'permanent-local t)
571 (put 'comint-output-filter-functions 'permanent-local t)
572 (put 'comint-preoutput-filter-functions 'permanent-local t)
573 (put 'comint-scroll-to-bottom-on-input 'permanent-local t)
574 (put 'comint-move-point-for-output 'permanent-local t)
575 (put 'comint-scroll-show-maximum-output 'permanent-local t)
576 (put 'comint-ptyp 'permanent-local t)
578 (put 'comint-mode 'mode-class 'special)
580 (define-derived-mode comint-mode fundamental-mode "Comint"
581 "Major mode for interacting with an inferior interpreter.
582 Interpreter name is same as buffer name, sans the asterisks.
583 Return at end of buffer sends line as input.
584 Return not at end copies rest of line to end and sends it.
585 Setting variable `comint-eol-on-send' means jump to the end of the line
586 before submitting new input.
588 This mode is customized to create major modes such as Inferior Lisp
589 mode, Shell mode, etc. This can be done by setting the hooks
590 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
591 and `comint-get-old-input' to appropriate functions, and the variable
592 `comint-prompt-regexp' to the appropriate regular expression.
594 An input history is maintained of size `comint-input-ring-size', and
595 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
596 Input ring history expansion can be achieved with the commands
597 \\[comint-replace-by-expanded-history] or \\[comint-magic-space].
598 Input ring expansion is controlled by the variable `comint-input-autoexpand',
599 and addition is controlled by the variable `comint-input-ignoredups'.
601 Commands with no default key bindings include `send-invisible',
602 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
603 `comint-magic-space'.
605 Input to, and output from, the subprocess can cause the window to scroll to
606 the end of the buffer. See variables `comint-output-filter-functions',
607 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
608 and `comint-move-point-for-output'.
610 If you accidentally suspend your process, use \\[comint-continue-subjob]
615 Entry to this mode runs the hooks on `comint-mode-hook'."
616 (setq mode-line-process '(":%s"))
617 (set (make-local-variable 'comint-last-input-start) (point-min-marker))
618 (set (make-local-variable 'comint-last-input-end) (point-min-marker))
619 (set (make-local-variable 'comint-last-output-start) (make-marker))
620 (make-local-variable 'comint-last-prompt-overlay)
621 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
622 (make-local-variable 'comint-input-ring-size) ; ...to global val.
623 (make-local-variable 'comint-input-ring)
624 (make-local-variable 'comint-input-ring-file-name)
625 (or (and (boundp 'comint-input-ring) comint-input-ring)
626 (setq comint-input-ring (make-ring comint-input-ring-size)))
627 (make-local-variable 'comint-input-ring-index)
628 (make-local-variable 'comint-save-input-ring-index)
629 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
630 (setq comint-input-ring-index nil))
631 (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
632 (setq comint-save-input-ring-index nil))
633 (make-local-variable 'comint-matching-input-from-input-string)
634 (make-local-variable 'comint-input-autoexpand)
635 (make-local-variable 'comint-input-ignoredups)
636 (make-local-variable 'comint-delimiter-argument-list)
637 (make-local-variable 'comint-completion-fignore)
638 (make-local-variable 'comint-get-old-input)
639 (make-local-variable 'comint-input-filter)
640 (make-local-variable 'comint-input-sender)
641 (make-local-variable 'comint-eol-on-send)
642 (make-local-variable 'comint-scroll-to-bottom-on-input)
643 (make-local-variable 'comint-move-point-for-output)
644 (make-local-variable 'comint-scroll-show-maximum-output)
645 (make-local-variable 'comint-stored-incomplete-input)
646 ;; Following disabled because it seems to break the case when
647 ;; comint-scroll-show-maximum-output is nil, and no-one can remember
648 ;; what the original problem was. If there are problems with point
649 ;; not going to the end, consider re-enabling this.
650 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00827.html
652 ;; This makes it really work to keep point at the bottom.
653 ;;; (make-local-variable 'scroll-conservatively)
654 ;;; (setq scroll-conservatively 10000)
655 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
656 (make-local-variable 'comint-ptyp)
657 (make-local-variable 'comint-process-echoes)
658 (make-local-variable 'comint-file-name-chars)
659 (make-local-variable 'comint-file-name-quote-list)
660 (make-local-variable 'comint-accum-marker)
661 (setq comint-accum-marker (make-marker))
662 (make-local-variable 'font-lock-defaults)
663 (setq font-lock-defaults '(nil t))
664 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
665 ;; This behavior is not useful in comint buffers, and is annoying
666 (set (make-local-variable 'next-line-add-newlines) nil))
668 (defun comint-check-proc (buffer)
669 "Return non-nil if there is a living process associated w/buffer BUFFER.
670 Living means the status is `open', `run', or `stop'.
671 BUFFER can be either a buffer or the name of one."
672 (let ((proc (get-buffer-process buffer)))
673 (and proc (memq (process-status proc) '(open run stop)))))
676 (defun make-comint-in-buffer (name buffer program &optional startfile &rest switches)
677 "Make a Comint process NAME in BUFFER, running PROGRAM.
678 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
679 PROGRAM should be either a string denoting an executable program to create
680 via `start-file-process', or a cons pair of the form (HOST . SERVICE) denoting
681 a TCP connection to be opened via `open-network-stream'. If there is already
682 a running process in that buffer, it is not restarted. Optional fourth arg
683 STARTFILE is the name of a file to send the contents of to the process.
685 If PROGRAM is a string, any more args are arguments to PROGRAM."
686 (or (fboundp 'start-file-process)
687 (error "Multi-processing is not supported for this system"))
688 (setq buffer (get-buffer-create (or buffer (concat "*" name "*"))))
689 ;; If no process, or nuked process, crank up a new one and put buffer in
690 ;; comint mode. Otherwise, leave buffer and existing process alone.
691 (unless (comint-check-proc buffer)
692 (with-current-buffer buffer
693 (unless (derived-mode-p 'comint-mode)
694 (comint-mode))) ; Install local vars, mode, keymap, ...
695 (comint-exec buffer name program startfile switches))
699 (defun make-comint (name program &optional startfile &rest switches)
700 "Make a Comint process NAME in a buffer, running PROGRAM.
701 The name of the buffer is made by surrounding NAME with `*'s.
702 PROGRAM should be either a string denoting an executable program to create
703 via `start-file-process', or a cons pair of the form (HOST . SERVICE) denoting
704 a TCP connection to be opened via `open-network-stream'. If there is already
705 a running process in that buffer, it is not restarted. Optional third arg
706 STARTFILE is the name of a file to send the contents of the process to.
708 If PROGRAM is a string, any more args are arguments to PROGRAM."
709 (apply #'make-comint-in-buffer name nil program startfile switches))
712 (defun comint-run (program)
713 "Run PROGRAM in a Comint buffer and switch to it.
714 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
715 The file name is used to make a symbol name, such as `comint-sh-hook', and any
716 hooks on this symbol are run in the buffer.
717 See `make-comint' and `comint-exec'."
718 (interactive "sRun program: ")
719 (let ((name (file-name-nondirectory program)))
720 (switch-to-buffer (make-comint name program))
721 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
723 (defun comint-exec (buffer name command startfile switches)
724 "Start up a process named NAME in buffer BUFFER for Comint modes.
725 Runs the given COMMAND with SWITCHES with output to STARTFILE.
726 Blasts any old process running in the buffer. Doesn't set the buffer mode.
727 You can use this to cheaply run a series of processes in the same Comint
728 buffer. The hook `comint-exec-hook' is run after each exec."
729 (with-current-buffer buffer
730 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
731 (if proc (delete-process proc)))
732 ;; Crank up a new process
735 (open-network-stream name buffer (car command) (cdr command))
736 (comint-exec-1 name buffer command switches))))
737 (set-process-filter proc 'comint-output-filter)
738 (make-local-variable 'comint-ptyp)
739 (setq comint-ptyp process-connection-type) ; t if pty, nil if pipe.
740 ;; Jump to the end, and set the process mark.
741 (goto-char (point-max))
742 (set-marker (process-mark proc) (point))
743 ;; Feed it the startfile.
745 ;;This is guaranteed to wait long enough
746 ;;but has bad results if the comint does not prompt at all
747 ;; (while (= size (buffer-size))
749 ;;I hope 1 second is enough!
751 (goto-char (point-max))
752 (insert-file-contents startfile)
753 (setq startfile (buffer-substring (point) (point-max)))
754 (delete-region (point) (point-max))
755 (comint-send-string proc startfile)))
756 (run-hooks 'comint-exec-hook)
759 ;; This auxiliary function cranks up the process for comint-exec in
760 ;; the appropriate environment.
762 (defun comint-exec-1 (name buffer command switches)
763 (let ((process-environment
765 ;; If using termcap, we specify `emacs' as the terminal type
766 ;; because that lets us specify a width.
767 ;; If using terminfo, we specify `dumb' because that is
768 ;; a defined terminal type. `emacs' is not a defined terminal type
769 ;; and there is no way for us to define it here.
770 ;; Some programs that use terminfo get very confused
771 ;; if TERM is not a valid terminal type.
772 ;; ;; There is similar code in compile.el.
773 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
774 (list "TERM=dumb" "TERMCAP="
775 (format "COLUMNS=%d" (window-width)))
777 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
778 (unless (getenv "EMACS")
780 (list (format "INSIDE_EMACS=%s,comint" emacs-version))
781 process-environment))
783 (if (file-accessible-directory-p default-directory)
786 proc decoding encoding changed)
787 (let ((exec-path (if (file-name-directory command)
788 ;; If the command has slashes, make sure we
789 ;; first look relative to the current directory.
790 (cons default-directory exec-path) exec-path)))
791 (setq proc (apply 'start-file-process name buffer command switches)))
792 ;; Some file name handler cannot start a process, fe ange-ftp.
793 (unless (processp proc) (error "No process started"))
794 (let ((coding-systems (process-coding-system proc)))
795 (setq decoding (car coding-systems)
796 encoding (cdr coding-systems)))
797 ;; If start-file-process decided to use some coding system for decoding
798 ;; data sent from the process and the coding system doesn't
799 ;; specify EOL conversion, we had better convert CRLF to LF.
800 (if (vectorp (coding-system-eol-type decoding))
801 (setq decoding (coding-system-change-eol-conversion decoding 'dos)
803 ;; Even if start-file-process left the coding system for encoding data
804 ;; sent from the process undecided, we had better use the same one
805 ;; as what we use for decoding. But, we should suppress EOL
807 (if (and decoding (not encoding))
808 (setq encoding (coding-system-change-eol-conversion decoding 'unix)
811 (set-process-coding-system proc decoding encoding))
814 (defun comint-insert-input (event)
815 "In a Comint buffer, set the current input to the previous input at point.
816 If there is no previous input at point, run the command specified
817 by the global keymap (usually `mouse-yank-at-point')."
819 (let ((pos (posn-point (event-end event)))
821 (with-selected-window (posn-window (event-end event))
822 (and (setq field (field-at-pos pos))
823 (setq input (field-string-no-properties pos))))
824 (if (or (null comint-accum-marker)
825 (not (eq field 'input)))
826 ;; Fall back to the global definition if (i) the selected
827 ;; buffer is not a comint buffer (which can happen if a
828 ;; non-comint window was selected and we clicked in a comint
829 ;; window), or (ii) there is no input at POS.
830 (let* ((keys (this-command-keys))
831 (last-key (and (vectorp keys) (aref keys (1- (length keys)))))
832 (fun (and last-key (lookup-key global-map (vector last-key)))))
833 (and fun (not (eq fun 'comint-insert-input))
834 (call-interactively fun)))
835 ;; Otherwise, insert the previous input.
836 (goto-char (point-max))
837 ;; First delete any old unsent input at the end
839 (or (marker-position comint-accum-marker)
840 (process-mark (get-buffer-process (current-buffer))))
842 ;; Insert the input at point
845 ;; Input history processing in a buffer
846 ;; ===========================================================================
847 ;; Useful input history functions, courtesy of the Ergo group.
850 ;; comint-dynamic-list-input-ring List history in help buffer.
851 ;; comint-previous-input Previous input...
852 ;; comint-previous-matching-input ...matching a string.
853 ;; comint-previous-matching-input-from-input ... matching the current input.
854 ;; comint-next-input Next input...
855 ;; comint-next-matching-input ...matching a string.
856 ;; comint-next-matching-input-from-input ... matching the current input.
857 ;; comint-backward-matching-input Backwards input...
858 ;; comint-forward-matching-input ...matching a string.
859 ;; comint-replace-by-expanded-history Expand history at point;
860 ;; replace with expanded history.
861 ;; comint-magic-space Expand history and insert space.
864 ;; comint-read-input-ring Read into comint-input-ring...
865 ;; comint-write-input-ring Write to comint-input-ring-file-name.
866 ;; comint-replace-by-expanded-history-before-point Workhorse function.
868 (defun comint-read-input-ring (&optional silent)
869 "Set the buffer's `comint-input-ring' from a history file.
870 The name of the file is given by the variable `comint-input-ring-file-name'.
871 The history ring is of size `comint-input-ring-size', regardless of file size.
872 If `comint-input-ring-file-name' is nil this function does nothing.
874 If the optional argument SILENT is non-nil, we say nothing about a
875 failure to read the history file.
877 This function is useful for major mode commands and mode hooks.
879 The commands stored in the history file are separated by the
880 `comint-input-ring-separator', and entries that match
881 `comint-input-history-ignore' are ignored. The most recent command
884 See also `comint-input-ignoredups' and `comint-write-input-ring'."
885 (cond ((or (null comint-input-ring-file-name)
886 (equal comint-input-ring-file-name ""))
888 ((not (file-readable-p comint-input-ring-file-name))
890 (message "Cannot read history file %s"
891 comint-input-ring-file-name)))
893 (let* ((history-buf (get-buffer-create " *temp*"))
894 (file comint-input-ring-file-name)
896 (size comint-input-ring-size)
897 (ring (make-ring size)))
900 (set-buffer history-buf)
903 (insert-file-contents file)
904 ;; Save restriction in case file is already visited...
905 ;; Watch for those date stamps in history files!
906 (goto-char (point-max))
907 (let (start end history)
908 (while (and (< count size)
909 (re-search-backward comint-input-ring-separator nil t)
910 (setq end (match-beginning 0)))
911 (if (re-search-backward comint-input-ring-separator nil t)
912 (setq start (match-end 0))
913 (setq start (point-min)))
914 (setq history (buffer-substring start end))
916 (if (and (not (string-match comint-input-history-ignore history))
917 (or (null comint-input-ignoredups)
919 (not (string-equal (ring-ref ring 0) history))))
921 (ring-insert-at-beginning ring history)
922 (setq count (1+ count)))))))
923 (kill-buffer history-buf))
924 (setq comint-input-ring ring
925 comint-input-ring-index nil)))))
927 (defun comint-write-input-ring ()
928 "Writes the buffer's `comint-input-ring' to a history file.
929 The name of the file is given by the variable `comint-input-ring-file-name'.
930 The original contents of the file are lost if `comint-input-ring' is not empty.
931 If `comint-input-ring-file-name' is nil this function does nothing.
933 Useful within process sentinels.
935 See also `comint-read-input-ring'."
936 (cond ((or (null comint-input-ring-file-name)
937 (equal comint-input-ring-file-name "")
938 (null comint-input-ring) (ring-empty-p comint-input-ring))
940 ((not (file-writable-p comint-input-ring-file-name))
941 (message "Cannot write history file %s" comint-input-ring-file-name))
943 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
944 (ring comint-input-ring)
945 (file comint-input-ring-file-name)
946 (index (ring-length ring)))
947 ;; Write it all out into a buffer first. Much faster, but messier,
948 ;; than writing it one line at a time.
950 (set-buffer history-buf)
953 (setq index (1- index))
954 (insert (ring-ref ring index) comint-input-ring-separator))
955 (write-region (buffer-string) nil file nil 'no-message)
956 (kill-buffer nil))))))
959 (defvar comint-dynamic-list-input-ring-window-conf)
961 (defun comint-dynamic-list-input-ring-select ()
962 "Choose the input history entry that point is in or next to."
964 (let (beg end completion (buffer completion-reference-buffer)
965 (base-size completion-base-size))
966 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
967 (setq end (point) beg (1+ (point))))
968 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
969 (setq end (1- (point)) beg (point)))
971 (error "No history entry here"))
972 (setq beg (previous-single-property-change beg 'mouse-face))
973 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
974 (setq completion (buffer-substring beg end))
975 (set-window-configuration comint-dynamic-list-input-ring-window-conf)
976 (choose-completion-string completion buffer base-size)))
978 (defun comint-dynamic-list-input-ring ()
979 "List in help buffer the buffer's input history."
981 (if (or (not (ring-p comint-input-ring))
982 (ring-empty-p comint-input-ring))
983 (message "No history")
985 (history-buffer " *Input History*")
986 (index (1- (ring-length comint-input-ring)))
987 (conf (current-window-configuration)))
988 ;; We have to build up a list ourselves from the ring vector.
990 (setq history (cons (ring-ref comint-input-ring index) history)
992 ;; Change "completion" to "history reference"
993 ;; to make the display accurate.
994 (with-output-to-temp-buffer history-buffer
995 (display-completion-list history)
996 (set-buffer history-buffer)
997 (let ((keymap (make-sparse-keymap)))
998 (set-keymap-parent keymap (current-local-map))
999 (define-key keymap "\C-m" 'comint-dynamic-list-input-ring-select)
1000 (use-local-map keymap))
1002 (while (search-backward "completion" nil 'move)
1003 (replace-match "history reference")))
1005 (message "Hit space to flush")
1006 (setq comint-dynamic-list-input-ring-window-conf conf)
1007 (let ((ch (read-event)))
1009 (set-window-configuration conf)
1010 (setq unread-command-events (list ch)))))))
1013 (defun comint-regexp-arg (prompt)
1014 "Return list of regexp and prefix arg using PROMPT."
1015 (let* (;; Don't clobber this.
1016 (last-command last-command)
1017 (regexp (read-from-minibuffer prompt nil nil nil
1018 'minibuffer-history-search-history)))
1019 (list (if (string-equal regexp "")
1020 (setcar minibuffer-history-search-history
1021 (nth 1 minibuffer-history-search-history))
1023 (prefix-numeric-value current-prefix-arg))))
1025 (defun comint-search-arg (arg)
1026 ;; First make sure there is a ring and that we are after the process mark
1027 (cond ((not (comint-after-pmark-p))
1028 (error "Not at command line"))
1029 ((or (null comint-input-ring)
1030 (ring-empty-p comint-input-ring))
1031 (error "Empty input ring"))
1033 ;; arg of zero resets search from beginning, and uses arg of 1
1034 (setq comint-input-ring-index nil)
1039 (defun comint-restore-input ()
1040 "Restore unfinished input."
1042 (when comint-input-ring-index
1043 (comint-delete-input)
1044 (when (> (length comint-stored-incomplete-input) 0)
1045 (insert comint-stored-incomplete-input)
1046 (message "Input restored"))
1047 (setq comint-input-ring-index nil)))
1049 (defun comint-search-start (arg)
1050 "Index to start a directional search, starting at `comint-input-ring-index'."
1051 (if comint-input-ring-index
1052 ;; If a search is running, offset by 1 in direction of arg
1053 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
1054 (ring-length comint-input-ring))
1055 ;; For a new search, start from beginning or end, as appropriate
1057 0 ; First elt for forward search
1058 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
1060 (defun comint-previous-input-string (arg)
1061 "Return the string ARG places along the input ring.
1062 Moves relative to `comint-input-ring-index'."
1063 (ring-ref comint-input-ring (if comint-input-ring-index
1064 (mod (+ arg comint-input-ring-index)
1065 (ring-length comint-input-ring))
1068 (defun comint-previous-input (arg)
1069 "Cycle backwards through input history, saving input."
1071 (if (and comint-input-ring-index
1072 (or ;; leaving the "end" of the ring
1073 (and (< arg 0) ; going down
1074 (eq comint-input-ring-index 0))
1075 (and (> arg 0) ; going up
1076 (eq comint-input-ring-index
1077 (1- (ring-length comint-input-ring)))))
1078 comint-stored-incomplete-input)
1079 (comint-restore-input)
1080 (comint-previous-matching-input "." arg)))
1082 (defun comint-next-input (arg)
1083 "Cycle forwards through input history."
1085 (comint-previous-input (- arg)))
1087 (defun comint-previous-matching-input-string (regexp arg)
1088 "Return the string matching REGEXP ARG places along the input ring.
1089 Moves relative to `comint-input-ring-index'."
1090 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
1091 (if pos (ring-ref comint-input-ring pos))))
1093 (defun comint-previous-matching-input-string-position (regexp arg &optional start)
1094 "Return the index matching REGEXP ARG places along the input ring.
1095 Moves relative to START, or `comint-input-ring-index'."
1096 (if (or (not (ring-p comint-input-ring))
1097 (ring-empty-p comint-input-ring))
1098 (error "No history"))
1099 (let* ((len (ring-length comint-input-ring))
1100 (motion (if (> arg 0) 1 -1))
1101 (n (mod (- (or start (comint-search-start arg)) motion) len))
1102 (tried-each-ring-item nil)
1104 ;; Do the whole search as many times as the argument says.
1105 (while (and (/= arg 0) (not tried-each-ring-item))
1108 n (mod (+ n motion) len))
1109 ;; If we haven't reached a match, step some more.
1110 (while (and (< n len) (not tried-each-ring-item)
1111 (not (string-match regexp (ring-ref comint-input-ring n))))
1112 (setq n (mod (+ n motion) len)
1113 ;; If we have gone all the way around in this search.
1114 tried-each-ring-item (= n prev)))
1115 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1116 ;; Now that we know which ring element to use, if we found it, return that.
1117 (if (string-match regexp (ring-ref comint-input-ring n))
1120 (defun comint-delete-input ()
1121 "Delete all input between accumulation or process mark and point."
1123 ;; Can't use kill-region as it sets this-command
1124 (or (marker-position comint-accum-marker)
1125 (process-mark (get-buffer-process (current-buffer))))
1128 (defun comint-previous-matching-input (regexp n)
1129 "Search backwards through input history for match for REGEXP.
1130 \(Previous history elements are earlier commands.)
1131 With prefix argument N, search for Nth previous match.
1132 If N is negative, find the next or Nth next match."
1133 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1134 (setq n (comint-search-arg n))
1135 (let ((pos (comint-previous-matching-input-string-position regexp n)))
1136 ;; Has a match been found?
1139 ;; If leaving the edit line, save partial input
1140 (if (null comint-input-ring-index) ;not yet on ring
1141 (setq comint-stored-incomplete-input
1142 (funcall comint-get-old-input)))
1143 (setq comint-input-ring-index pos)
1144 (message "History item: %d" (1+ pos))
1145 (comint-delete-input)
1146 (insert (ring-ref comint-input-ring pos)))))
1148 (defun comint-next-matching-input (regexp n)
1149 "Search forwards through input history for match for REGEXP.
1150 \(Later history elements are more recent commands.)
1151 With prefix argument N, search for Nth following match.
1152 If N is negative, find the previous or Nth previous match."
1153 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1154 (comint-previous-matching-input regexp (- n)))
1156 (defun comint-previous-matching-input-from-input (n)
1157 "Search backwards through input history for match for current input.
1158 \(Previous history elements are earlier commands.)
1159 With prefix argument N, search for Nth previous match.
1160 If N is negative, search forwards for the -Nth following match."
1162 (if (not (memq last-command '(comint-previous-matching-input-from-input
1163 comint-next-matching-input-from-input)))
1164 ;; Starting a new search
1165 (setq comint-matching-input-from-input-string
1167 (or (marker-position comint-accum-marker)
1168 (process-mark (get-buffer-process (current-buffer))))
1170 comint-input-ring-index nil))
1171 (comint-previous-matching-input
1172 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1175 (defun comint-next-matching-input-from-input (n)
1176 "Search forwards through input history for match for current input.
1177 \(Following history elements are more recent commands.)
1178 With prefix argument N, search for Nth following match.
1179 If N is negative, search backwards for the -Nth previous match."
1181 (comint-previous-matching-input-from-input (- n)))
1184 (defun comint-replace-by-expanded-history (&optional silent start)
1185 "Expand input command history references before point.
1186 Expansion is dependent on the value of `comint-input-autoexpand'.
1188 This function depends on the buffer's idea of the input history, which may not
1189 match the command interpreter's idea, assuming it has one.
1191 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1192 cannot know the interpreter's idea of input line numbers, assuming it has one,
1193 it cannot expand absolute input line number references.
1195 If the optional argument SILENT is non-nil, never complain
1196 even if history reference seems erroneous.
1198 If the optional argument START is non-nil, that specifies the
1199 start of the text to scan for history references, rather
1200 than the logical beginning of line.
1202 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1204 Returns t if successful."
1206 (if (and comint-input-autoexpand
1207 (if comint-use-prompt-regexp
1208 ;; Use comint-prompt-regexp
1211 (looking-at (concat comint-prompt-regexp "!\\|\\^")))
1212 ;; Use input fields. User input that hasn't been entered
1213 ;; yet, at the end of the buffer, has a nil `field' property.
1214 (and (null (get-char-property (point) 'field))
1215 (string-match "!\\|^\\^" (field-string)))))
1216 ;; Looks like there might be history references in the command.
1217 (let ((previous-modified-tick (buffer-modified-tick)))
1218 (comint-replace-by-expanded-history-before-point silent start)
1219 (/= previous-modified-tick (buffer-modified-tick)))))
1222 (defun comint-replace-by-expanded-history-before-point (silent &optional start)
1223 "Expand directory stack reference before point.
1224 See `comint-replace-by-expanded-history'. Returns t if successful.
1226 If the optional argument START is non-nil, that specifies the
1227 start of the text to scan for history references, rather
1228 than the logical beginning of line."
1230 (let ((toend (- (line-end-position) (point)))
1231 (start (or start (comint-line-beginning-position))))
1234 (skip-chars-forward "^!^" (- (line-end-position) toend))
1235 (< (point) (- (line-end-position) toend)))
1236 ;; This seems a bit complex. We look for references such as !!, !-num,
1237 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1238 ;; If that wasn't enough, the plings can be suffixed with argument
1239 ;; range specifiers.
1240 ;; Argument ranges are complex too, so we hive off the input line,
1241 ;; referenced with plings, with the range string to `comint-args'.
1242 (setq comint-input-ring-index nil)
1243 (cond ((or (= (preceding-char) ?\\)
1244 (comint-within-quotes start (point)))
1245 ;; The history is quoted, or we're in quotes.
1246 (goto-char (1+ (point))))
1247 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1248 ;; We cannot know the interpreter's idea of input line numbers.
1249 (goto-char (match-end 0))
1250 (message "Absolute reference cannot be expanded"))
1251 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1252 ;; Just a number of args from `number' lines backward.
1253 (let ((number (1- (string-to-number
1254 (buffer-substring (match-beginning 1)
1256 (if (<= number (ring-length comint-input-ring))
1259 (comint-args (comint-previous-input-string number)
1260 (match-beginning 2) (match-end 2))
1262 (setq comint-input-ring-index number)
1263 (message "History item: %d" (1+ number)))
1264 (goto-char (match-end 0))
1265 (message "Relative reference exceeds input history size"))))
1266 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1267 ;; Just a number of args from the previous input line.
1269 (comint-args (comint-previous-input-string 0)
1270 (match-beginning 1) (match-end 1))
1272 (message "History item: previous"))
1274 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1275 ;; Most recent input starting with or containing (possibly
1276 ;; protected) string, maybe just a number of args. Phew.
1277 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1278 (mb2 (match-beginning 2)) (me2 (match-end 2))
1279 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1280 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1281 (pos (save-match-data
1282 (comint-previous-matching-input-string-position
1283 (concat pref (regexp-quote exp)) 1))))
1286 (goto-char (match-end 0))
1288 (progn (message "Not found")
1290 (setq comint-input-ring-index pos)
1292 (comint-args (ring-ref comint-input-ring pos)
1293 (match-beginning 4) (match-end 4))
1295 (message "History item: %d" (1+ pos)))))
1296 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1297 ;; Quick substitution on the previous input line.
1298 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1299 (new (buffer-substring (match-beginning 2) (match-end 2)))
1301 (replace-match (comint-previous-input-string 0) t t)
1303 (goto-char (match-beginning 0))
1304 (if (not (search-forward old pos t))
1306 (error "Not found"))
1307 (replace-match new t t)
1308 (message "History item: substituted"))))
1310 (forward-char 1)))))))
1313 (defun comint-magic-space (arg)
1314 "Expand input history references before point and insert ARG spaces.
1315 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1317 (comint-replace-by-expanded-history)
1318 (self-insert-command arg))
1320 (defun comint-within-quotes (beg end)
1321 "Return t if the number of quotes between BEG and END is odd.
1322 Quotes are single and double."
1323 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1324 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1325 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1327 (defun comint-how-many-region (regexp beg end)
1328 "Return number of matches for REGEXP from BEG to END."
1333 (while (re-search-forward regexp end t)
1334 (setq count (1+ count)))))
1337 (defun comint-args (string begin end)
1338 ;; From STRING, return the args depending on the range specified in the text
1339 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1340 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1343 (comint-arguments string 0 nil)
1344 (let* ((range (buffer-substring
1345 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1346 (nth (cond ((string-match "^[*^]" range) 1)
1347 ((string-match "^-" range) 0)
1348 ((string-equal range "$") nil)
1349 (t (string-to-number range))))
1350 (mth (cond ((string-match "[-*$]$" range) nil)
1351 ((string-match "-" range)
1352 (string-to-number (substring range (match-end 0))))
1354 (comint-arguments string nth mth)))))
1356 (defun comint-delim-arg (arg)
1357 "Return a list of arguments from ARG.
1358 Break it up at the delimiters in `comint-delimiter-argument-list'.
1359 Returned list is backwards.
1361 Characters with non-nil values of the text property `literal' are
1362 assumed to have literal values (e.g., backslash-escaped
1363 characters), and are not considered to be delimiters."
1364 (if (null comint-delimiter-argument-list)
1370 (let ((char (aref arg pos))
1372 (if (and (memq char comint-delimiter-argument-list)
1373 ;; Ignore backslash-escaped characters.
1374 (not (get-text-property pos 'literal arg)))
1375 (while (and (< pos len) (eq (aref arg pos) char))
1376 (setq pos (1+ pos)))
1377 (while (and (< pos len)
1378 (not (and (memq (aref arg pos)
1379 comint-delimiter-argument-list)
1380 (not (get-text-property
1381 pos 'literal arg)))))
1382 (setq pos (1+ pos))))
1383 (setq args (cons (substring arg start pos) args))))
1386 (defun comint-arguments (string nth mth)
1387 "Return from STRING the NTH to MTH arguments.
1388 NTH and/or MTH can be nil, which means the last argument.
1389 Returned arguments are separated by single spaces.
1390 We assume whitespace separates arguments, except within quotes
1391 and except for a space or tab that immediately follows a backslash.
1392 Also, a run of one or more of a single character
1393 in `comint-delimiter-argument-list' is a separate argument.
1394 Argument 0 is the command name."
1395 ;; The first line handles ordinary characters and backslash-sequences
1396 ;; (except with w32 msdos-like shells, where backslashes are valid).
1397 ;; The second matches "-quoted strings.
1398 ;; The third matches '-quoted strings.
1399 ;; The fourth matches `-quoted strings.
1400 ;; This seems to fit the syntax of BASH 2.0.
1401 (let* ((backslash-escape (not (and (fboundp 'w32-shell-dos-semantics)
1402 (w32-shell-dos-semantics))))
1403 (first (if backslash-escape
1404 "[^ \n\t\"'`\\]\\|\\(\\\\.\\)\\|"
1405 "[^ \n\t\"'`]+\\|"))
1406 (argpart (concat first
1407 "\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\
1410 (quote-subexpr (if backslash-escape 2 1))
1414 ;; Build a list of all the args until we have as many as we want.
1415 (while (and (or (null mth) (<= count mth))
1416 (string-match argpart string pos))
1417 ;; Apply the `literal' text property to backslash-escaped
1418 ;; characters, so that `comint-delim-arg' won't break them up.
1419 (and backslash-escape
1421 (put-text-property (match-beginning 1) (match-end 1)
1423 (if (and beg (= pos (match-beginning 0)))
1424 ;; It's contiguous, part of the same arg.
1425 (setq pos (match-end 0)
1426 quotes (or quotes (match-beginning quote-subexpr)))
1427 ;; It's a new separate arg.
1429 ;; Put the previous arg, if there was one, onto ARGS.
1430 (setq str (substring string beg pos)
1431 args (if quotes (cons str args)
1432 (nconc (comint-delim-arg str) args))))
1433 (setq count (length args))
1434 (setq quotes (match-beginning quote-subexpr))
1435 (setq beg (match-beginning 0))
1436 (setq pos (match-end 0))))
1438 (setq str (substring string beg pos)
1439 args (if quotes (cons str args)
1440 (nconc (comint-delim-arg str) args))))
1441 (setq count (length args))
1442 (let ((n (or nth (1- count)))
1443 (m (if mth (1- (- count mth)) 0)))
1445 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1448 ;; Input processing stuff
1450 (defun comint-add-to-input-history (cmd)
1451 "Add CMD to the input history.
1452 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1453 (if (and (funcall comint-input-filter cmd)
1454 (or (null comint-input-ignoredups)
1455 (not (ring-p comint-input-ring))
1456 (ring-empty-p comint-input-ring)
1457 (not (string-equal (ring-ref comint-input-ring 0)
1459 (ring-insert comint-input-ring cmd)))
1461 (defun comint-send-input (&optional no-newline artificial)
1462 "Send input to process.
1463 After the process output mark, sends all text from the process mark to
1464 point as input to the process. Before the process output mark, calls
1465 value of variable `comint-get-old-input' to retrieve old input, copies
1466 it to the process mark, and sends it.
1468 This command also sends and inserts a final newline, unless
1469 NO-NEWLINE is non-nil.
1471 Any history reference may be expanded depending on the value of the variable
1472 `comint-input-autoexpand'. The list of function names contained in the value
1473 of `comint-input-filter-functions' is called on the input before sending it.
1474 The input is entered into the input history ring, if the value of variable
1475 `comint-input-filter' returns non-nil when called on the input.
1477 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1478 end of line before sending the input.
1480 After the input has been sent, if `comint-process-echoes' is non-nil,
1481 then `comint-send-input' waits to see if the process outputs a string
1482 matching the input, and if so, deletes that part of the output.
1483 If ARTIFICIAL is non-nil, it inhibits such deletion.
1484 Callers sending input not from the user should use ARTIFICIAL = t.
1486 The values of `comint-get-old-input', `comint-input-filter-functions', and
1487 `comint-input-filter' are chosen according to the command interpreter running
1488 in the buffer. E.g.,
1490 If the interpreter is the csh,
1491 `comint-get-old-input' is the default:
1492 If `comint-use-prompt-regexp' is nil, then
1493 either return the current input field, if point is on an input
1494 field, or the current line, if point is on an output field.
1495 If `comint-use-prompt-regexp' is non-nil, then
1496 return the current line with any initial string matching the
1497 regexp `comint-prompt-regexp' removed.
1498 `comint-input-filter-functions' monitors input for \"cd\", \"pushd\", and
1499 \"popd\" commands. When it sees one, it cd's the buffer.
1500 `comint-input-filter' is the default: returns t if the input isn't all white
1503 If the Comint is Lucid Common Lisp,
1504 `comint-get-old-input' snarfs the sexp ending at point.
1505 `comint-input-filter-functions' does nothing.
1506 `comint-input-filter' returns nil if the input matches input-filter-regexp,
1507 which matches (1) all whitespace (2) :a, :c, etc.
1509 Similarly for Soar, Scheme, etc."
1511 ;; Note that the input string does not include its terminal newline.
1512 (let ((proc (get-buffer-process (current-buffer))))
1513 (if (not proc) (error "Current buffer has no process")
1515 (let* ((pmark (process-mark proc))
1516 (intxt (if (>= (point) (marker-position pmark))
1517 (progn (if comint-eol-on-send (end-of-line))
1518 (buffer-substring pmark (point)))
1519 (let ((copy (funcall comint-get-old-input)))
1523 (input (if (not (eq comint-input-autoexpand 'input))
1524 ;; Just whatever's already there
1526 ;; Expand and leave it visible in buffer
1527 (comint-replace-by-expanded-history t pmark)
1528 (buffer-substring pmark (point))))
1529 (history (if (not (eq comint-input-autoexpand 'history))
1531 ;; This is messy 'cos ultimately the original
1532 ;; functions used do insertion, rather than return
1533 ;; strings. We have to expand, then insert back.
1534 (comint-replace-by-expanded-history t pmark)
1535 (let ((copy (buffer-substring pmark (point)))
1538 (delete-region pmark start)
1544 (comint-add-to-input-history history)
1546 (run-hook-with-args 'comint-input-filter-functions
1547 (if no-newline input
1548 (concat input "\n")))
1550 (let ((beg (marker-position pmark))
1551 (end (if no-newline (point) (1- (point))))
1552 (inhibit-modification-hooks t))
1554 (add-text-properties beg end
1556 font-lock-face comint-highlight-input))
1557 (unless comint-use-prompt-regexp
1558 ;; Give old user input a field property of `input', to
1559 ;; distinguish it from both process output and unsent
1560 ;; input. The terminating newline is put into a special
1561 ;; `boundary' field to make cursor movement between input
1562 ;; and output fields smoother.
1563 (add-text-properties
1565 '(mouse-face highlight
1566 help-echo "mouse-2: insert after prompt as new input"
1568 (unless (or no-newline comint-use-prompt-regexp)
1569 ;; Cover the terminating newline
1570 (add-text-properties end (1+ end)
1573 inhibit-line-move-field-capture t))))
1575 (comint-snapshot-last-prompt)
1577 (setq comint-save-input-ring-index comint-input-ring-index)
1578 (setq comint-input-ring-index nil)
1579 ;; Update the markers before we send the input
1580 ;; in case we get output amidst sending the input.
1581 (set-marker comint-last-input-start pmark)
1582 (set-marker comint-last-input-end (point))
1583 (set-marker (process-mark proc) (point))
1584 ;; clear the "accumulation" marker
1585 (set-marker comint-accum-marker nil)
1586 (let ((comint-input-sender-no-newline no-newline))
1587 (funcall comint-input-sender proc input))
1589 ;; Optionally delete echoed input (after checking it).
1590 (when (and comint-process-echoes (not artificial))
1591 (let ((echo-len (- comint-last-input-end
1592 comint-last-input-start)))
1593 ;; Wait for all input to be echoed:
1594 (while (and (accept-process-output proc)
1595 (> (+ comint-last-input-end echo-len)
1598 (compare-buffer-substrings
1599 nil comint-last-input-start
1600 (- (point-max) echo-len)
1601 ;; Above difference is equivalent to
1602 ;; (+ comint-last-input-start
1603 ;; (- (point-max) comint-last-input-end))
1604 nil comint-last-input-end (point-max)))))
1606 (<= (+ comint-last-input-end echo-len)
1609 (compare-buffer-substrings
1610 nil comint-last-input-start comint-last-input-end
1611 nil comint-last-input-end
1612 (+ comint-last-input-end echo-len))))
1613 ;; Certain parts of the text to be deleted may have
1614 ;; been mistaken for prompts. We have to prevent
1615 ;; problems when `comint-prompt-read-only' is non-nil.
1616 (let ((inhibit-read-only t))
1617 (delete-region comint-last-input-end
1618 (+ comint-last-input-end echo-len))
1619 (when comint-prompt-read-only
1621 (goto-char comint-last-input-end)
1622 (comint-update-fence)))))))
1624 ;; This used to call comint-output-filter-functions,
1625 ;; but that scrolled the buffer in undesirable ways.
1626 (run-hook-with-args 'comint-output-filter-functions "")))))
1628 (defvar comint-preoutput-filter-functions nil
1629 "List of functions to call before inserting Comint output into the buffer.
1630 Each function gets one argument, a string containing the text received
1631 from the subprocess. It should return the string to insert, perhaps
1632 the same string that was received, or perhaps a modified or transformed
1635 The functions on the list are called sequentially, and each one is
1636 given the string returned by the previous one. The string returned by
1637 the last function is the text that is actually inserted in the
1640 You can use `add-hook' to add functions to this list
1641 either globally or locally.")
1643 (defvar comint-inhibit-carriage-motion nil
1644 "If nil, Comint will interpret `carriage control' characters in output.
1645 See `comint-carriage-motion' for details.")
1647 ;; When non-nil, this is an overlay over the last recognized prompt in
1648 ;; the buffer; it is used when highlighting the prompt.
1649 (defvar comint-last-prompt-overlay nil)
1651 (defun comint-snapshot-last-prompt ()
1652 "`snapshot' any current `comint-last-prompt-overlay'.
1653 Freeze its attributes in place, even when more input comes along
1654 and moves the prompt overlay."
1655 (when comint-last-prompt-overlay
1656 (let ((inhibit-read-only t)
1657 (inhibit-modification-hooks t))
1658 (add-text-properties (overlay-start comint-last-prompt-overlay)
1659 (overlay-end comint-last-prompt-overlay)
1660 (overlay-properties comint-last-prompt-overlay)))))
1662 (defun comint-carriage-motion (start end)
1663 "Interpret carriage control characters in the region from START to END.
1664 Translate carriage return/linefeed sequences to linefeeds.
1665 Make single carriage returns delete to the beginning of the line.
1666 Make backspaces delete the previous character."
1668 ;; First do a quick check to see if there are any applicable
1669 ;; characters, so we can avoid calling save-match-data and
1670 ;; save-restriction if not.
1672 (when (< (skip-chars-forward "^\b\r" end) (- end start))
1676 (let ((inhibit-field-text-motion t)
1677 (inhibit-read-only t))
1679 ;; Note that this won't work properly when the CR and LF
1680 ;; are in different output chunks, but this is probably an
1681 ;; exceedingly rare case (because they are generally
1682 ;; written as a unit), and to delay interpretation of a
1683 ;; trailing CR in a chunk would result in odd interactive
1684 ;; behavior (and this case is probably far more common).
1685 (while (re-search-forward "\r$" end t)
1687 ;; bare CR -> delete preceding line
1689 (while (search-forward "\r" end t)
1690 (delete-region (point) (line-beginning-position)))
1691 ;; BS -> delete preceding character
1693 (while (search-forward "\b" end t)
1694 (delete-char -2))))))))
1696 ;; The purpose of using this filter for comint processes
1697 ;; is to keep comint-last-input-end from moving forward
1698 ;; when output is inserted.
1699 (defun comint-output-filter (process string)
1700 (let ((oprocbuf (process-buffer process)))
1701 ;; First check for killed buffer or no input.
1702 (when (and string oprocbuf (buffer-name oprocbuf))
1703 (with-current-buffer oprocbuf
1704 ;; Run preoutput filters
1705 (let ((functions comint-preoutput-filter-functions))
1706 (while (and functions string)
1707 (if (eq (car functions) t)
1708 (let ((functions (default-value 'comint-preoutput-filter-functions)))
1709 (while (and functions string)
1710 (setq string (funcall (car functions) string))
1711 (setq functions (cdr functions))))
1712 (setq string (funcall (car functions) string)))
1713 (setq functions (cdr functions))))
1716 (let ((inhibit-read-only t)
1717 ;; Avoid the overhead of save-excursion, since we just
1718 ;; fiddle with the point
1719 (saved-point (point-marker)))
1721 ;; The point should float after any insertion we do
1722 (set-marker-insertion-type saved-point t)
1724 ;; We temporarly remove any buffer narrowing, in case the
1725 ;; process mark is outside of the restriction
1729 (goto-char (process-mark process))
1730 (set-marker comint-last-output-start (point))
1732 ;; insert-before-markers is a bad thing. XXX
1734 ;; It is used here to force window-point markers (used to
1735 ;; store the value of point in non-selected windows) to
1736 ;; advance, but it also screws up any other markers that we
1737 ;; don't _want_ to advance, such as the start-marker of some
1738 ;; of the overlays we create.
1740 ;; We work around the problem with the overlays by
1741 ;; explicitly adjusting them after we do the insertion, but
1742 ;; in the future this problem should be solved correctly, by
1743 ;; using `insert', and making the insertion-type of
1744 ;; window-point markers settable (via a buffer-local
1745 ;; variable). In comint buffers, this variable would be set
1746 ;; to `t', to cause point in non-select windows to advance.
1747 (insert-before-markers string)
1748 ;; Fixup markers and overlays that got screwed up because we
1749 ;; used `insert-before-markers'.
1750 (let ((old-point (- (point) (length string))))
1751 ;; comint-last-output-start
1752 (set-marker comint-last-output-start old-point)
1753 ;; comint-last-input-end
1754 (when (and comint-last-input-end
1755 (equal (marker-position comint-last-input-end)
1757 (set-marker comint-last-input-end old-point))
1758 ;; No overlays we create are set to advance upon insertion
1759 ;; (at the start/end), so we assume that any overlay which
1760 ;; is at the current point was incorrectly advanced by
1761 ;; insert-before-markers. First fixup overlays that might
1763 (dolist (over (overlays-at (point)))
1764 (when (= (overlay-start over) (point))
1765 (let ((end (overlay-end over)))
1768 (if (= end (point)) old-point end)))))
1769 ;; Then do overlays that might end at point:
1770 (dolist (over (overlays-at (1- (point))))
1771 (when (= (overlay-end over) (point))
1773 (min (overlay-start over) old-point)
1776 ;; Advance process-mark
1777 (set-marker (process-mark process) (point))
1779 (unless comint-inhibit-carriage-motion
1780 ;; Interpret any carriage motion characters (newline, backspace)
1781 (comint-carriage-motion comint-last-output-start (point)))
1783 ;; Run these hooks with point where the user had it.
1784 (goto-char saved-point)
1785 (run-hook-with-args 'comint-output-filter-functions string)
1786 (set-marker saved-point (point))
1788 (goto-char (process-mark process)) ; in case a filter moved it
1790 (unless comint-use-prompt-regexp
1791 (let ((inhibit-read-only t)
1792 (inhibit-modification-hooks t))
1793 (add-text-properties comint-last-output-start (point)
1796 inhibit-line-move-field-capture t))))
1798 ;; Highlight the prompt, where we define `prompt' to mean
1799 ;; the most recent output that doesn't end with a newline.
1800 (let ((prompt-start (save-excursion (forward-line 0) (point)))
1801 (inhibit-read-only t)
1802 (inhibit-modification-hooks t))
1803 (when comint-prompt-read-only
1804 (or (= (point-min) prompt-start)
1805 (get-text-property (1- prompt-start) 'read-only)
1807 (1- prompt-start) prompt-start 'read-only 'fence))
1808 (add-text-properties
1809 prompt-start (point)
1810 '(read-only t rear-nonsticky t front-sticky (read-only))))
1811 (unless (and (bolp) (null comint-last-prompt-overlay))
1812 ;; Need to create or move the prompt overlay (in the case
1813 ;; where there is no prompt ((bolp) == t), we still do
1814 ;; this if there's already an existing overlay).
1815 (if comint-last-prompt-overlay
1816 ;; Just move an existing overlay
1817 (move-overlay comint-last-prompt-overlay
1818 prompt-start (point))
1819 ;; Need to create the overlay
1820 (setq comint-last-prompt-overlay
1821 (make-overlay prompt-start (point)))
1822 (overlay-put comint-last-prompt-overlay
1823 'font-lock-face 'comint-highlight-prompt))))
1825 (goto-char saved-point)))))))
1827 (defun comint-preinput-scroll-to-bottom ()
1828 "Go to the end of buffer in all windows showing it.
1829 Movement occurs if point in the selected window is not after the process mark,
1830 and `this-command' is an insertion command. Insertion commands recognized
1831 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1832 Depends on the value of `comint-scroll-to-bottom-on-input'.
1834 This function should be a pre-command hook."
1835 (if (and comint-scroll-to-bottom-on-input
1836 (memq this-command '(self-insert-command comint-magic-space yank
1838 (let* ((selected (selected-window))
1839 (current (current-buffer))
1840 (process (get-buffer-process current))
1841 (scroll comint-scroll-to-bottom-on-input))
1842 (if (and process (< (point) (process-mark process)))
1843 (if (eq scroll 'this)
1844 (goto-char (point-max))
1846 (function (lambda (window)
1847 (if (and (eq (window-buffer window) current)
1848 (or (eq scroll t) (eq scroll 'all)))
1850 (select-window window)
1851 (goto-char (point-max))
1852 (select-window selected)))))
1855 (defun comint-postoutput-scroll-to-bottom (string)
1856 "Go to the end of buffer in some or all windows showing it.
1857 Does not scroll if the current line is the last line in the buffer.
1858 Depends on the value of `comint-move-point-for-output' and
1859 `comint-scroll-show-maximum-output'.
1861 This function should be in the list `comint-output-filter-functions'."
1862 (let* ((selected (selected-window))
1863 (current (current-buffer))
1864 (process (get-buffer-process current))
1865 (scroll comint-move-point-for-output))
1869 (function (lambda (window)
1870 (if (eq (window-buffer window) current)
1872 (select-window window)
1873 (if (and (< (point) (process-mark process))
1874 (or (eq scroll t) (eq scroll 'all)
1875 ;; Maybe user wants point to jump to end.
1876 (and (eq scroll 'this) (eq selected window))
1877 (and (eq scroll 'others) (not (eq selected window)))
1878 ;; If point was at the end, keep it at end.
1879 (and (marker-position comint-last-output-start)
1880 (>= (point) comint-last-output-start))))
1881 (goto-char (process-mark process)))
1882 ;; Optionally scroll so that the text
1883 ;; ends at the bottom of the window.
1884 (if (and comint-scroll-show-maximum-output
1885 (= (point) (point-max)))
1887 (goto-char (point-max))
1888 (recenter (- -1 scroll-margin))))
1889 (select-window selected)))))
1891 (set-buffer current))))
1893 (defun comint-truncate-buffer (&optional string)
1894 "Truncate the buffer to `comint-buffer-maximum-size'.
1895 This function could be on `comint-output-filter-functions' or bound to a key."
1898 (goto-char (process-mark (get-buffer-process (current-buffer))))
1899 (forward-line (- comint-buffer-maximum-size))
1901 (let ((inhibit-read-only t))
1902 (delete-region (point-min) (point)))))
1904 (defun comint-strip-ctrl-m (&optional string)
1905 "Strip trailing `^M' characters from the current output group.
1906 This function could be on `comint-output-filter-functions' or bound to a key."
1908 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1912 (if (interactive-p) comint-last-input-end comint-last-output-start))
1914 (while (re-search-forward "\r+$" pmark t)
1915 (replace-match "" t t)))))
1916 (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
1918 (defun comint-show-maximum-output ()
1919 "Put the end of the buffer at the bottom of the window."
1921 (goto-char (point-max))
1922 (recenter (- -1 scroll-margin)))
1924 (defun comint-get-old-input-default ()
1925 "Default for `comint-get-old-input'.
1926 If `comint-use-prompt-regexp' is nil, then either
1927 return the current input field, if point is on an input field, or the
1928 current line, if point is on an output field.
1929 If `comint-use-prompt-regexp' is non-nil, then return
1930 the current line with any initial string matching the regexp
1931 `comint-prompt-regexp' removed."
1932 (let ((bof (field-beginning)))
1933 (if (eq (get-char-property bof 'field) 'input)
1934 (field-string-no-properties bof)
1936 (buffer-substring-no-properties (point) (line-end-position)))))
1938 (defun comint-copy-old-input ()
1939 "Insert after prompt old input at point as new input to be edited.
1940 Calls `comint-get-old-input' to get old input."
1942 (let ((input (funcall comint-get-old-input))
1943 (process (get-buffer-process (current-buffer))))
1945 (error "Current buffer has no process")
1946 (goto-char (process-mark process))
1949 (defun comint-skip-prompt ()
1950 "Skip past the text matching regexp `comint-prompt-regexp'.
1951 If this takes us past the end of the current line, don't skip at all."
1952 (if (and (looking-at comint-prompt-regexp)
1953 (<= (match-end 0) (line-end-position)))
1954 (goto-char (match-end 0))))
1956 (defun comint-after-pmark-p ()
1957 "Return t if point is after the process output marker."
1958 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1959 (<= (marker-position pmark) (point))))
1961 (defun comint-simple-send (proc string)
1962 "Default function for sending to PROC input STRING.
1963 This just sends STRING plus a newline. To override this,
1964 set the hook `comint-input-sender'."
1966 (if comint-input-sender-no-newline
1968 ;; Sending as two separate strings does not work
1969 ;; on Windows, so concat the \n before sending.
1970 (concat string "\n"))))
1971 (comint-send-string proc send-string))
1972 (if (and comint-input-sender-no-newline
1973 (not (string-equal string "")))
1974 (process-send-eof)))
1976 (defun comint-line-beginning-position ()
1977 "Return the buffer position of the beginning of the line, after any prompt.
1978 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done by
1979 skipping text matching the regular expression `comint-prompt-regexp',
1980 a buffer local variable."
1981 (if comint-use-prompt-regexp
1982 ;; Use comint-prompt-regexp
1985 (comint-skip-prompt)
1987 ;; Use input fields. Note that, unlike the behavior of
1988 ;; `line-beginning-position' inside a field, this function will
1989 ;; return the position of the end of a prompt, even if the point is
1990 ;; already inside the prompt. In order to do this, it assumes that
1991 ;; if there are two fields on a line, then the first one is the
1992 ;; prompt, and the second one is an input field, and is front-sticky
1993 ;; (as input fields should be).
1994 (constrain-to-field (line-beginning-position) (line-end-position))))
1996 (defun comint-bol (&optional arg)
1997 "Go to the beginning of line, then skip past the prompt, if any.
1998 If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
1999 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done
2000 by skipping text matching the regular expression `comint-prompt-regexp',
2001 a buffer local variable."
2004 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
2006 (goto-char (comint-line-beginning-position))))
2008 ;; For compatibility.
2009 (defun comint-read-noecho (prompt &optional ignore)
2010 (read-passwd prompt))
2012 ;; These three functions are for entering text you don't want echoed or
2013 ;; saved -- typically passwords to ftp, telnet, or somesuch.
2014 ;; Just enter m-x send-invisible and type in your line.
2016 (defun send-invisible (&optional prompt)
2017 "Read a string without echoing.
2018 Then send it to the process running in the current buffer.
2019 The string is sent using `comint-input-sender'.
2020 Security bug: your string can still be temporarily recovered with
2021 \\[view-lossage]; `clear-this-command-keys' can fix that."
2022 (interactive "P") ; Defeat snooping via C-x ESC ESC
2023 (let ((proc (get-buffer-process (current-buffer)))
2025 (if (eq (window-buffer (selected-window)) (current-buffer))
2027 (format "(In buffer %s) "
2028 (current-buffer)))))
2030 (let ((str (read-passwd (concat prefix
2031 (or prompt "Non-echoed text: ")))))
2034 (comint-snapshot-last-prompt)
2035 (funcall comint-input-sender proc str))
2036 (message "Warning: text will be echoed")))
2037 (error "Buffer %s has no process" (current-buffer)))))
2039 (defun comint-watch-for-password-prompt (string)
2040 "Prompt in the minibuffer for password and send without echoing.
2041 This function uses `send-invisible' to read and send a password to the buffer's
2042 process if STRING contains a password prompt defined by
2043 `comint-password-prompt-regexp'.
2045 This function could be in the list `comint-output-filter-functions'."
2046 (when (string-match comint-password-prompt-regexp string)
2047 (when (string-match "^[ \n\r\t\v\f\b\a]+" string)
2048 (setq string (replace-match "" t t string)))
2049 (send-invisible string)))
2051 ;; Low-level process communication
2053 (defun comint-send-string (process string)
2054 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
2056 (with-current-buffer (if (processp process)
2057 (process-buffer process)
2058 (get-buffer process))
2059 (comint-snapshot-last-prompt))
2060 (comint-snapshot-last-prompt))
2061 (process-send-string process string))
2063 (defun comint-send-region (process start end)
2064 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
2066 (with-current-buffer (if (processp process)
2067 (process-buffer process)
2068 (get-buffer process))
2069 (comint-snapshot-last-prompt))
2070 (comint-snapshot-last-prompt))
2071 (process-send-region process start end))
2074 ;; Random input hackage
2076 (defun comint-delete-output ()
2077 "Delete all output from interpreter since last input.
2078 Does not delete the prompt."
2080 (let ((proc (get-buffer-process (current-buffer)))
2082 (inhibit-read-only t))
2084 (let ((pmark (progn (goto-char (process-mark proc))
2087 (delete-region comint-last-input-end pmark)
2088 (goto-char (process-mark proc))
2089 (setq replacement (concat "*** output flushed ***\n"
2090 (buffer-substring pmark (point))))
2091 (delete-region pmark (point))))
2092 ;; Output message and put back prompt
2093 (comint-output-filter proc replacement)))
2094 (define-obsolete-function-alias 'comint-kill-output
2095 'comint-delete-output "21.1")
2097 (defun comint-write-output (filename &optional append mustbenew)
2098 "Write output from interpreter since last input to FILENAME.
2099 Any prompt at the end of the output is not written.
2101 If the optional argument APPEND (the prefix argument when interactive)
2102 is non-nil, the output is appended to the file instead.
2104 If the optional argument MUSTBENEW is non-nil, check for an existing
2105 file with the same name. If MUSTBENEW is `excl', that means to get an
2106 error if the file already exists; never overwrite. If MUSTBENEW is
2107 neither nil nor `excl', that means ask for confirmation before
2108 overwriting, but do go ahead and overwrite the file if the user
2109 confirms. When interactive, MUSTBENEW is nil when appending, and t
2112 (list (read-file-name
2113 (if current-prefix-arg
2114 "Append output to file: "
2115 "Write output to file: "))
2117 (not current-prefix-arg)))
2119 (goto-char (process-mark (get-buffer-process (current-buffer))))
2121 (write-region comint-last-input-end (point) filename
2122 append nil nil mustbenew)))
2124 ;; This function exists for the benefit of the menu; from the keyboard,
2125 ;; users can just use `comint-write-output' with a prefix arg.
2126 (defun comint-append-output-to-file (filename)
2127 "Append output from interpreter since last input to FILENAME.
2128 Any prompt at the end of the output is not written."
2129 (interactive "fAppend output to file: ")
2130 (comint-write-output filename t))
2132 (defun comint-show-output ()
2133 "Display start of this batch of interpreter output at top of window.
2134 Sets mark to the value of point when this command is run."
2137 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
2138 (cond (comint-use-prompt-regexp
2140 (beginning-of-line 0)
2141 (set-window-start (selected-window) (point))
2142 (comint-skip-prompt))
2144 (let* ((beg (field-beginning pos))
2145 (pt (if (= (point-min) beg)
2149 (set-window-start (selected-window) (point))))))
2152 (defun comint-interrupt-subjob ()
2153 "Interrupt the current subjob.
2154 This command also kills the pending input
2155 between the process mark and point."
2158 (interrupt-process nil comint-ptyp)
2159 ;; (process-send-string nil "\n")
2162 (defun comint-kill-subjob ()
2163 "Send kill signal to the current subjob.
2164 This command also kills the pending input
2165 between the process mark and point."
2168 (kill-process nil comint-ptyp))
2170 (defun comint-quit-subjob ()
2171 "Send quit signal to the current subjob.
2172 This command also kills the pending input
2173 between the process mark and point."
2176 (quit-process nil comint-ptyp))
2178 (defun comint-stop-subjob ()
2179 "Stop the current subjob.
2180 This command also kills the pending input
2181 between the process mark and point.
2183 WARNING: if there is no current subjob, you can end up suspending
2184 the top-level process running in the buffer. If you accidentally do
2185 this, use \\[comint-continue-subjob] to resume the process. (This
2186 is not a problem with most shells, since they ignore this signal.)"
2189 (stop-process nil comint-ptyp))
2191 (defun comint-continue-subjob ()
2192 "Send CONT signal to process buffer's process group.
2193 Useful if you accidentally suspend the top-level process."
2195 (continue-process nil comint-ptyp))
2197 (defun comint-skip-input ()
2198 "Skip all pending input, from last stuff output by interpreter to point.
2199 This means mark it as if it had been sent as input, without sending it."
2200 (let ((comint-input-sender 'ignore)
2201 (comint-input-filter-functions nil))
2202 (comint-send-input t t))
2205 (marker (process-mark (get-buffer-process (current-buffer)))))
2206 (insert " " (key-description (this-command-keys)))
2208 (set-marker marker (point)))))
2210 (defun comint-kill-input ()
2211 "Kill all text from last stuff output by interpreter to point."
2213 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2214 (if (> (point) (marker-position pmark))
2215 (kill-region pmark (point)))))
2217 (defun comint-delchar-or-maybe-eof (arg)
2218 "Delete ARG characters forward or send an EOF to subprocess.
2219 Sends an EOF only if point is at the end of the buffer and there is no input."
2221 (let ((proc (get-buffer-process (current-buffer))))
2222 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
2224 (delete-char arg))))
2226 (defun comint-send-eof ()
2227 "Send an EOF to the current buffer's process."
2229 (comint-send-input t t)
2233 (defun comint-backward-matching-input (regexp n)
2234 "Search backward through buffer for input fields that match REGEXP.
2235 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2236 by lines that match `comint-prompt-regexp'.
2238 With prefix argument N, search for Nth previous match.
2239 If N is negative, find the next or Nth next match."
2240 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2241 (if comint-use-prompt-regexp
2242 ;; Use comint-prompt-regexp
2243 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2244 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2245 (if (re-search-backward re nil t n)
2248 (progn (message "Not found")
2253 (let* ((dir (if (< n 0) -1 1))
2257 (unless (re-search-backward regexp nil t dir)
2258 (error "Not found"))
2259 (when (eq (get-char-property (point) 'field) 'input)
2260 (setq n (- n dir))))
2261 (field-beginning))))
2265 (defun comint-forward-matching-input (regexp n)
2266 "Search forward through buffer for input fields that match REGEXP.
2267 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2268 by lines that match `comint-prompt-regexp'.
2270 With prefix argument N, search for Nth following match.
2271 If N is negative, find the previous or Nth previous match."
2272 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2273 (comint-backward-matching-input regexp (- n)))
2276 (defun comint-next-prompt (n)
2277 "Move to end of Nth next prompt in the buffer.
2278 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2279 the Nth next `input' field, otherwise, it means the Nth occurrence of
2280 text matching `comint-prompt-regexp'."
2282 (if comint-use-prompt-regexp
2283 ;; Use comint-prompt-regexp
2284 (let ((paragraph-start comint-prompt-regexp))
2285 (end-of-line (if (> n 0) 1 0))
2286 (forward-paragraph n)
2287 (comint-skip-prompt))
2296 (next-single-char-property-change pos 'field)
2297 (previous-single-char-property-change pos 'field)))
2298 (cond ((or (null pos) (= pos prev-pos))
2299 ;; Ran off the end of the buffer.
2301 ;; There's always an input field at the end of the
2302 ;; buffer, but it has a `field' property of nil.
2303 (setq input-pos (point-max)))
2306 ((eq (get-char-property pos 'field) 'input)
2307 (setq n (if (< n 0) (1+ n) (1- n)))
2308 (setq input-pos pos))))
2310 (goto-char input-pos)))))
2313 (defun comint-previous-prompt (n)
2314 "Move to end of Nth previous prompt in the buffer.
2315 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2316 the Nth previous `input' field, otherwise, it means the Nth occurrence of
2317 text matching `comint-prompt-regexp'."
2319 (comint-next-prompt (- n)))
2321 ;; State used by `comint-insert-previous-argument' when cycling.
2322 (defvar comint-insert-previous-argument-last-start-pos nil)
2323 (make-variable-buffer-local 'comint-insert-previous-argument-last-start-pos)
2324 (defvar comint-insert-previous-argument-last-index nil)
2325 (make-variable-buffer-local 'comint-insert-previous-argument-last-index)
2328 ;; make comint-arguments understand negative indices as bash does
2329 (defun comint-insert-previous-argument (index)
2330 "Insert the INDEXth argument from the previous Comint command-line at point.
2331 Spaces are added at beginning and/or end of the inserted string if
2332 necessary to ensure that it's separated from adjacent arguments.
2333 Interactively, if no prefix argument is given, the last argument is inserted.
2334 Repeated interactive invocations will cycle through the same argument
2335 from progressively earlier commands (using the value of INDEX specified
2336 with the first command).
2337 This command is like `M-.' in bash."
2339 (unless (null index)
2340 (setq index (prefix-numeric-value index)))
2341 (cond ((eq last-command this-command)
2342 ;; Delete last input inserted by this command.
2343 (delete-region comint-insert-previous-argument-last-start-pos (point))
2344 (setq index comint-insert-previous-argument-last-index))
2346 ;; This is a non-repeat invocation, so initialize state.
2347 (setq comint-input-ring-index nil)
2348 (setq comint-insert-previous-argument-last-index index)
2349 (when (null comint-insert-previous-argument-last-start-pos)
2350 ;; First usage; initialize to a marker
2351 (setq comint-insert-previous-argument-last-start-pos
2353 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2354 (if (<= (point) (comint-line-beginning-position))
2357 ;; Remember the beginning of what we insert, so we can delete it if
2358 ;; the command is repeated.
2359 (set-marker comint-insert-previous-argument-last-start-pos (point))
2360 ;; Insert the argument.
2361 (let ((input-string (comint-previous-input-string 0)))
2362 (when (string-match "[ \t\n]*&" input-string)
2363 ;; strip terminating '&'
2364 (setq input-string (substring input-string 0 (match-beginning 0))))
2365 (insert (comint-arguments input-string index index)))
2366 ;; Make next invocation return arg from previous input
2367 (setq comint-input-ring-index (1+ (or comint-input-ring-index 0)))
2368 ;; Add a terminating space if necessary.
2373 ;; Support editing with `comint-prompt-read-only' set to t.
2375 (defun comint-update-fence ()
2376 "Update read-only status of newline before point.
2377 The `fence' read-only property is used to indicate that a newline
2378 is read-only for no other reason than to \"fence off\" a
2379 following front-sticky read-only region. This is used to
2380 implement comint read-only prompts. If the text after a newline
2381 changes, the read-only status of that newline may need updating.
2382 That is what this function does.
2384 This function does nothing if point is not at the beginning of a
2385 line, or is at the beginning of the accessible portion of the buffer.
2386 Otherwise, if the character after point has a front-sticky
2387 read-only property, then the preceding newline is given a
2388 read-only property of `fence', unless it already is read-only.
2389 If the character after point does not have a front-sticky
2390 read-only property, any read-only property of `fence' on the
2391 preceding newline is removed."
2392 (let* ((pt (point)) (lst (get-text-property pt 'front-sticky))
2393 (inhibit-modification-hooks t))
2396 (if (and (get-text-property pt 'read-only)
2397 (if (listp lst) (memq 'read-only lst) t))
2398 (unless (get-text-property (1- pt) 'read-only)
2399 (put-text-property (1- pt) pt 'read-only 'fence))
2400 (when (eq (get-text-property (1- pt) 'read-only) 'fence)
2401 (remove-list-of-text-properties (1- pt) pt '(read-only)))))))
2403 (defun comint-kill-whole-line (&optional count)
2404 "Kill current line, ignoring read-only and field properties.
2405 With prefix arg COUNT, kill that many lines starting from the current line.
2406 If COUNT is negative, kill backward. Also kill the preceding newline,
2407 instead of the trailing one. \(This is meant to make \\[repeat] work well
2408 with negative arguments.)
2409 If COUNT is zero, kill current line but exclude the trailing newline.
2410 The read-only status of newlines is updated with `comint-update-fence',
2413 (let ((inhibit-read-only t) (inhibit-field-text-motion t))
2414 (kill-whole-line count)
2415 (when (>= count 0) (comint-update-fence))))
2417 (defun comint-kill-region (beg end &optional yank-handler)
2418 "Like `kill-region', but ignores read-only properties, if safe.
2419 This command assumes that the buffer contains read-only
2420 \"prompts\" which are regions with front-sticky read-only
2421 properties at the beginning of a line, with the preceding newline
2422 being read-only to protect the prompt. This is true of the
2423 comint prompts if `comint-prompt-read-only' is non-nil. This
2424 command will not delete the region if this would create mutilated
2425 or out of place prompts. That is, if any part of a prompt is
2426 deleted, the entire prompt must be deleted and all remaining
2427 prompts should stay at the beginning of a line. If this is not
2428 the case, this command just calls `kill-region' with all
2429 read-only properties intact. The read-only status of newlines is
2430 updated using `comint-update-fence', if necessary."
2433 (let* ((true-beg (min beg end))
2434 (true-end (max beg end))
2435 (beg-bolp (progn (goto-char true-beg) (bolp)))
2436 (beg-lst (get-text-property true-beg 'front-sticky))
2437 (beg-bad (and (get-text-property true-beg 'read-only)
2438 (if (listp beg-lst) (memq 'read-only beg-lst) t)))
2439 (end-bolp (progn (goto-char true-end) (bolp)))
2440 (end-lst (get-text-property true-end 'front-sticky))
2441 (end-bad (and (get-text-property true-end 'read-only)
2442 (if (listp end-lst) (memq 'read-only end-lst) t))))
2443 (if (or (and (not beg-bolp) (or beg-bad end-bad))
2444 (and (not end-bolp) end-bad))
2445 (kill-region beg end yank-handler)
2446 (let ((inhibit-read-only t))
2447 (kill-region beg end yank-handler)
2448 (comint-update-fence))))))
2451 ;; Support for source-file processing commands.
2452 ;;============================================================================
2453 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2454 ;; commands that process files of source text (e.g. loading or compiling
2455 ;; files). So the corresponding process-in-a-buffer modes have commands
2456 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2457 ;; for defining these commands.
2459 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2460 ;; and Soar, in that they don't know anything about file extensions.
2461 ;; So the compile/load interface gets the wrong default occasionally.
2462 ;; The load-file/compile-file default mechanism could be smarter -- it
2463 ;; doesn't know about the relationship between filename extensions and
2464 ;; whether the file is source or executable. If you compile foo.lisp
2465 ;; with compile-file, then the next load-file should use foo.bin for
2466 ;; the default, not foo.lisp. This is tricky to do right, particularly
2467 ;; because the extension for executable files varies so much (.o, .bin,
2468 ;; .lbin, .mo, .vo, .ao, ...).
2471 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2474 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2475 ;; want to save the buffer before issuing any process requests to the command
2478 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2479 ;; for the file to process.
2481 (defun comint-source-default (previous-dir/file source-modes)
2482 "Compute the defaults for `load-file' and `compile-file' commands.
2484 PREVIOUS-DIR/FILE is a pair (DIRECTORY . FILENAME) from the last
2485 source-file processing command, or nil if there hasn't been one yet.
2486 SOURCE-MODES is a list used to determine what buffers contain source
2487 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2488 Typically, (lisp-mode) or (scheme-mode).
2490 If the command is given while the cursor is inside a string, *and*
2491 the string is an existing filename, *and* the filename is not a directory,
2492 then the string is taken as default. This allows you to just position
2493 your cursor over a string that's a filename and have it taken as default.
2495 If the command is given in a file buffer whose major mode is in
2496 SOURCE-MODES, then the filename is the default file, and the
2497 file's directory is the default directory.
2499 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2500 then the default directory & file are what was used in the last source-file
2501 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2502 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2503 is the cwd, with no default file. (\"no default file\" = nil)
2505 SOURCE-MODES is typically going to be something like (tea-mode)
2506 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2507 for Soar programs, etc.
2509 The function returns a pair: (default-directory . default-file)."
2510 (cond ((and buffer-file-name (memq major-mode source-modes))
2511 (cons (file-name-directory buffer-file-name)
2512 (file-name-nondirectory buffer-file-name)))
2515 (cons default-directory nil))))
2518 (defun comint-check-source (fname)
2519 "Check whether to save buffers visiting file FNAME.
2520 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2521 process-in-a-buffer modes), this function can be called on the filename.
2522 If the file is loaded into a buffer, and the buffer is modified, the user
2523 is queried to see if he wants to save the buffer before proceeding with
2524 the load or compile."
2525 (let ((buff (get-file-buffer fname)))
2527 (buffer-modified-p buff)
2528 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
2530 (let ((old-buffer (current-buffer)))
2533 (set-buffer old-buffer)))))
2535 (defun comint-extract-string ()
2536 "Return string around point, or nil."
2537 (let ((syntax (syntax-ppss)))
2538 (when (nth 3 syntax)
2540 (buffer-substring-no-properties (1+ (nth 8 syntax))
2541 (progn (goto-char (nth 8 syntax))
2546 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2547 "Prompt for filenames in commands that process source files,
2548 e.g. loading or compiling a file.
2549 Provides a default, if there is one, and returns the result filename.
2551 See `comint-source-default' for more on determining defaults.
2553 PROMPT is the prompt string. PREV-DIR/FILE is the (DIRECTORY . FILE) pair
2554 from the last source processing command. SOURCE-MODES is a list of major
2555 modes used to determine what file buffers contain source files. (These
2556 two arguments are used for determining defaults.) If MUSTMATCH-P is true,
2557 then the filename reader will only accept a file that exists.
2560 (interactive (comint-get-source \"Compile file: \" prev-lisp-dir/file
2562 (let* ((def (comint-source-default prev-dir/file source-modes))
2563 (stringfile (comint-extract-string))
2564 (sfile-p (and stringfile
2566 (file-exists-p stringfile)
2568 (not (file-directory-p stringfile))))
2569 (defdir (if sfile-p (file-name-directory stringfile)
2571 (deffile (if sfile-p (file-name-nondirectory stringfile)
2573 (ans (read-file-name (if deffile (format "%s(default %s) "
2577 (concat defdir deffile)
2579 (list (expand-file-name (substitute-in-file-name ans)))))
2581 ;; I am somewhat divided on this string-default feature. It seems
2582 ;; to violate the principle-of-least-astonishment, in that it makes
2583 ;; the default harder to predict, so you actually have to look and see
2584 ;; what the default really is before choosing it. This can trip you up.
2585 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2590 ;; Simple process query facility.
2591 ;; ===========================================================================
2592 ;; This function is for commands that want to send a query to the process
2593 ;; and show the response to the user. For example, a command to get the
2594 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2595 ;; to an inferior Common Lisp process.
2597 ;; This simple facility just sends strings to the inferior process and pops
2598 ;; up a window for the process buffer so you can see what the process
2599 ;; responds with. We don't do anything fancy like try to intercept what the
2600 ;; process responds with and put it in a pop-up window or on the message
2601 ;; line. We just display the buffer. Low tech. Simple. Works good.
2603 (defun comint-proc-query (proc str)
2604 "Send to the inferior process PROC the string STR.
2605 Pop-up but do not select a window for the inferior process so that
2606 its response can be seen."
2607 (let* ((proc-buf (process-buffer proc))
2608 (proc-mark (process-mark proc)))
2609 (display-buffer proc-buf)
2610 (set-buffer proc-buf) ; but it's not the selected *window*
2611 (let ((proc-win (get-buffer-window proc-buf 0))
2612 (proc-pt (marker-position proc-mark)))
2613 (comint-send-string proc str) ; send the query
2614 (accept-process-output proc) ; wait for some output
2615 ;; Try to position the proc window so you can see the answer.
2616 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2617 ;; I don't know why. Wizards invited to improve it.
2618 (unless (pos-visible-in-window-p proc-pt proc-win)
2619 (let ((opoint (window-point proc-win)))
2620 (set-window-point proc-win proc-mark)
2622 (if (not (pos-visible-in-window-p opoint proc-win))
2624 (set-window-point proc-win opoint)))))))
2627 ;; Filename/command/history completion in a buffer
2628 ;; ===========================================================================
2629 ;; Useful completion functions, courtesy of the Ergo group.
2632 ;; comint-dynamic-complete Complete or expand command, filename,
2633 ;; history at point.
2634 ;; comint-dynamic-complete-filename Complete filename at point.
2635 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2636 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2637 ;; replace with expanded/completed name.
2638 ;; comint-dynamic-simple-complete Complete stub given candidates.
2640 ;; These are not installed in the comint-mode keymap. But they are
2641 ;; available for people who want them. Shell-mode installs them:
2642 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2643 ;; (define-key shell-mode-map "\M-?"
2644 ;; 'comint-dynamic-list-filename-completions)))
2646 ;; Commands like this are fine things to put in load hooks if you
2647 ;; want them present in specific modes.
2649 (defcustom comint-completion-autolist nil
2650 "*If non-nil, automatically list possibilities on partial completion.
2651 This mirrors the optional behavior of tcsh."
2653 :group 'comint-completion)
2655 (defcustom comint-completion-addsuffix t
2656 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2657 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2658 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2659 This mirrors the optional behavior of tcsh."
2660 :type '(choice (const :tag "None" nil)
2661 (const :tag "Add /" t)
2662 (cons :tag "Suffix pair"
2663 (string :tag "Directory suffix")
2664 (string :tag "File suffix")))
2665 :group 'comint-completion)
2667 (defcustom comint-completion-recexact nil
2668 "*If non-nil, use shortest completion if characters cannot be added.
2669 This mirrors the optional behavior of tcsh.
2671 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2673 :group 'comint-completion)
2675 (defcustom comint-completion-fignore nil
2676 "*List of suffixes to be disregarded during file completion.
2677 This mirrors the optional behavior of bash and tcsh.
2679 Note that this applies to `comint-dynamic-complete-filename' only."
2680 :type '(repeat (string :tag "Suffix"))
2681 :group 'comint-completion)
2684 (defvar comint-file-name-prefix ""
2685 "Prefix prepended to absolute file names taken from process input.
2686 This is used by Comint's and shell's completion functions, and by shell's
2687 directory tracking functions.")
2689 (defvar comint-file-name-chars
2690 (if (memq system-type '(ms-dos windows-nt cygwin))
2691 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2692 "[]~/A-Za-z0-9+@:_.$#%,={}-")
2693 "String of characters valid in a file name.
2694 Note that all non-ASCII characters are considered valid in a file name
2695 regardless of what this variable says.
2697 This is a good thing to set in mode hooks.")
2699 (defvar comint-file-name-quote-list nil
2700 "List of characters to quote with `\\' when in a file name.
2702 This is a good thing to set in mode hooks.")
2705 (defun comint-directory (directory)
2706 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
2707 (expand-file-name (if (file-name-absolute-p directory)
2708 (concat comint-file-name-prefix directory)
2712 (defun comint-word (word-chars)
2713 "Return the word of WORD-CHARS at point, or nil if none is found.
2714 Word constituents are considered to be those in WORD-CHARS, which is like the
2715 inside of a \"[...]\" (see `skip-chars-forward'), plus all non-ASCII characters."
2717 (let ((here (point))
2720 (let ((startpoint (point)))
2721 (skip-chars-backward (concat "\\\\" word-chars))
2722 ;; Fixme: This isn't consistent with Bash, at least -- not
2723 ;; all non-ASCII chars should be word constituents.
2724 (if (and (> (- (point) 2) (point-min))
2725 (= (char-after (- (point) 2)) ?\\))
2727 (if (and (> (- (point) 1) (point-min))
2728 (>= (char-after (- (point) 1)) 128))
2730 (if (= (point) startpoint)
2732 ;; Set match-data to match the entire string.
2733 (when (< (point) here)
2734 (set-match-data (list (point) here))
2735 (match-string 0)))))
2737 (defun comint-substitute-in-file-name (filename)
2738 "Return FILENAME with environment variables substituted.
2739 Supports additional environment variable syntax of the command
2740 interpreter (e.g., the percent notation of cmd.exe on NT)."
2741 (let ((name (substitute-in-file-name filename)))
2742 (if (memq system-type '(ms-dos windows-nt))
2746 (while (string-match "%\\([^\\\\/]*\\)%" name)
2748 (substring name (match-beginning 1) (match-end 1)))
2749 (setq env-var-val (if (getenv env-var-name)
2750 (getenv env-var-name)
2752 (setq name (replace-match env-var-val t t name))))))
2755 (defun comint-match-partial-filename ()
2756 "Return the filename at point, or nil if none is found.
2757 Environment variables are substituted. See `comint-word'."
2758 (let ((filename (comint-word comint-file-name-chars)))
2759 (and filename (comint-substitute-in-file-name
2760 (comint-unquote-filename filename)))))
2763 (defun comint-quote-filename (filename)
2764 "Return FILENAME with magic characters quoted.
2765 Magic characters are those in `comint-file-name-quote-list'."
2766 (if (null comint-file-name-quote-list)
2770 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
2773 (while (string-match regexp filename i)
2774 (setq filename (replace-match "\\\\\\&" nil nil filename))
2775 (setq i (1+ (match-end 0)))))
2778 (defun comint-unquote-filename (filename)
2779 "Return FILENAME with quoted characters unquoted."
2780 (if (null comint-file-name-quote-list)
2784 (while (string-match "\\\\\\(.\\)" filename i)
2785 (setq filename (replace-match "\\1" nil nil filename))
2786 (setq i (+ 1 (match-beginning 0)))))
2790 (defun comint-dynamic-complete ()
2791 "Dynamically perform completion at point.
2792 Calls the functions in `comint-dynamic-complete-functions' to perform
2793 completion until a function returns non-nil, at which point completion is
2794 assumed to have occurred."
2796 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
2799 (defun comint-dynamic-complete-filename ()
2800 "Dynamically complete the filename at point.
2801 Completes if after a filename. See `comint-match-partial-filename' and
2802 `comint-dynamic-complete-as-filename'.
2803 This function is similar to `comint-replace-by-expanded-filename', except that
2804 it won't change parts of the filename already entered in the buffer; it just
2805 adds completion characters to the end of the filename. A completions listing
2806 may be shown in a help buffer if completion is ambiguous.
2808 Completion is dependent on the value of `comint-completion-addsuffix',
2809 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2810 completions listing is dependent on the value of `comint-completion-autolist'.
2812 Returns t if successful."
2814 (when (comint-match-partial-filename)
2815 (unless (window-minibuffer-p (selected-window))
2816 (message "Completing file name..."))
2817 (comint-dynamic-complete-as-filename)))
2819 (defun comint-dynamic-complete-as-filename ()
2820 "Dynamically complete at point as a filename.
2821 See `comint-dynamic-complete-filename'. Returns t if successful."
2822 (let* ((completion-ignore-case read-file-name-completion-ignore-case)
2823 (completion-ignored-extensions comint-completion-fignore)
2824 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2825 ;; I think it was originally bound to solve file completion problems,
2826 ;; but subsequent changes may have made this unnecessary. sm.
2827 ;;(file-name-handler-alist nil)
2828 (minibuffer-p (window-minibuffer-p (selected-window)))
2830 (dirsuffix (cond ((not comint-completion-addsuffix)
2832 ((not (consp comint-completion-addsuffix))
2835 (car comint-completion-addsuffix))))
2836 (filesuffix (cond ((not comint-completion-addsuffix)
2838 ((not (consp comint-completion-addsuffix))
2841 (cdr comint-completion-addsuffix))))
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 (completion (file-name-completion filenondir directory)))
2847 (cond ((null completion)
2848 (message "No completions of %s" filename)
2850 ((eq completion t) ; Means already completed "file".
2852 (unless minibuffer-p
2853 (message "Sole completion")))
2854 ((string-equal completion "") ; Means completion on "directory/".
2855 (comint-dynamic-list-filename-completions))
2856 (t ; Completion string returned.
2857 (let ((file (concat (file-name-as-directory directory) completion)))
2858 (insert (comint-quote-filename
2859 (substring (directory-file-name completion)
2860 (length filenondir))))
2861 (cond ((symbolp (file-name-completion completion directory))
2862 ;; We inserted a unique completion.
2863 (insert (if (file-directory-p file) dirsuffix filesuffix))
2864 (unless minibuffer-p
2865 (message "Completed")))
2866 ((and comint-completion-recexact comint-completion-addsuffix
2867 (string-equal filenondir completion)
2868 (file-exists-p file))
2869 ;; It's not unique, but user wants shortest match.
2870 (insert (if (file-directory-p file) dirsuffix filesuffix))
2871 (unless minibuffer-p
2872 (message "Completed shortest")))
2873 ((or comint-completion-autolist
2874 (string-equal filenondir completion))
2875 ;; It's not unique, list possible completions.
2876 (comint-dynamic-list-filename-completions))
2878 (unless minibuffer-p
2879 (message "Partially completed")))))))
2883 (defun comint-replace-by-expanded-filename ()
2884 "Dynamically expand and complete the filename at point.
2885 Replace the filename with an expanded, canonicalized and completed replacement.
2886 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
2887 with the corresponding directories. \"Canonicalized\" means `..' and `.' are
2888 removed, and the filename is made absolute instead of relative. For expansion
2889 see `expand-file-name' and `substitute-in-file-name'. For completion see
2890 `comint-dynamic-complete-filename'."
2892 (let ((filename (comint-match-partial-filename)))
2894 (replace-match (expand-file-name filename) t t)
2895 (comint-dynamic-complete-filename))))
2898 (defun comint-dynamic-simple-complete (stub candidates)
2899 "Dynamically complete STUB from CANDIDATES list.
2900 This function inserts completion characters at point by completing STUB from
2901 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2902 if completion is ambiguous.
2904 Returns nil if no completion was inserted.
2905 Returns `sole' if completed with the only completion match.
2906 Returns `shortest' if completed with the shortest of the completion matches.
2907 Returns `partial' if completed as far as possible with the completion matches.
2908 Returns `listed' if a completion listing was shown.
2910 See also `comint-dynamic-complete-filename'."
2911 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2912 (suffix (cond ((not comint-completion-addsuffix) "")
2913 ((not (consp comint-completion-addsuffix)) " ")
2914 (t (cdr comint-completion-addsuffix))))
2915 (completions (all-completions stub candidates)))
2916 (cond ((null completions)
2917 (message "No completions of %s" stub)
2919 ((= 1 (length completions)) ; Gotcha!
2920 (let ((completion (car completions)))
2921 (if (string-equal completion stub)
2922 (message "Sole completion")
2923 (insert (substring completion (length stub)))
2924 (message "Completed"))
2927 (t ; There's no unique completion.
2928 (let ((completion (try-completion stub candidates)))
2929 ;; Insert the longest substring.
2930 (insert (substring completion (length stub)))
2931 (cond ((and comint-completion-recexact comint-completion-addsuffix
2932 (string-equal stub completion)
2933 (member completion completions))
2934 ;; It's not unique, but user wants shortest match.
2936 (message "Completed shortest")
2938 ((or comint-completion-autolist
2939 (string-equal stub completion))
2940 ;; It's not unique, list possible completions.
2941 (comint-dynamic-list-completions completions)
2944 (message "Partially completed")
2948 (defun comint-dynamic-list-filename-completions ()
2949 "List in help buffer possible completions of the filename at point."
2951 (let* ((completion-ignore-case read-file-name-completion-ignore-case)
2952 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2953 ;; I think it was originally bound to solve file completion problems,
2954 ;; but subsequent changes may have made this unnecessary. sm.
2955 ;;(file-name-handler-alist nil)
2956 (filename (or (comint-match-partial-filename) ""))
2957 (filedir (file-name-directory filename))
2958 (filenondir (file-name-nondirectory filename))
2959 (directory (if filedir (comint-directory filedir) default-directory))
2960 (completions (file-name-all-completions filenondir directory)))
2961 (if (not completions)
2962 (message "No completions of %s" filename)
2963 (comint-dynamic-list-completions
2964 (mapcar 'comint-quote-filename completions)))))
2967 ;; This is bound locally in a *Completions* buffer to the list of
2968 ;; completions displayed, and is used to detect the case where the same
2969 ;; command is repeatedly used without the set of completions changing.
2970 (defvar comint-displayed-dynamic-completions nil)
2972 (defvar comint-dynamic-list-completions-config nil)
2974 (defun comint-dynamic-list-completions (completions)
2975 "List in help buffer sorted COMPLETIONS.
2976 Typing SPC flushes the help buffer."
2977 (let ((window (get-buffer-window "*Completions*" 0)))
2978 (setq completions (sort completions 'string-lessp))
2979 (if (and (eq last-command this-command)
2980 window (window-live-p window) (window-buffer window)
2981 (buffer-name (window-buffer window))
2982 ;; The above tests are not sufficient to detect the case where we
2983 ;; should scroll, because the top-level interactive command may
2984 ;; not have displayed a completions window the last time it was
2985 ;; invoked, and there may be such a window left over from a
2986 ;; previous completion command with a different set of
2987 ;; completions. To detect that case, we also test that the set
2988 ;; of displayed completions is in fact the same as the previously
2991 (buffer-local-value 'comint-displayed-dynamic-completions
2992 (window-buffer window))))
2993 ;; If this command was repeated, and
2994 ;; there's a fresh completion window with a live buffer,
2995 ;; and this command is repeated, scroll that window.
2996 (with-current-buffer (window-buffer window)
2997 (if (pos-visible-in-window-p (point-max) window)
2998 (set-window-start window (point-min))
2999 (save-selected-window
3000 (select-window window)
3003 ;; Display a completion list for the first time.
3004 (setq comint-dynamic-list-completions-config
3005 (current-window-configuration))
3006 (with-output-to-temp-buffer "*Completions*"
3007 (display-completion-list completions))
3008 (message "Type space to flush; repeat completion command to scroll"))
3010 ;; Read the next key, to process SPC.
3012 (if (with-current-buffer (get-buffer "*Completions*")
3013 (set (make-local-variable 'comint-displayed-dynamic-completions)
3015 (setq key (read-key-sequence nil)
3017 (and (consp first) (consp (event-start first))
3018 (eq (window-buffer (posn-window (event-start first)))
3019 (get-buffer "*Completions*"))
3020 (eq (key-binding key) 'mouse-choose-completion)))
3021 ;; If the user does mouse-choose-completion with the mouse,
3022 ;; execute the command, then delete the completion window.
3024 (mouse-choose-completion first)
3025 (set-window-configuration comint-dynamic-list-completions-config))
3027 (set-window-configuration comint-dynamic-list-completions-config)
3028 (setq unread-command-events (listify-key-sequence key)))))))
3031 (defun comint-get-next-from-history ()
3032 "After fetching a line from input history, this fetches the following line.
3033 In other words, this recalls the input line after the line you recalled last.
3034 You can use this to repeat a sequence of input lines."
3036 (if comint-save-input-ring-index
3038 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
3039 (comint-next-input 1))
3040 (message "No previous history command")))
3042 (defun comint-accumulate ()
3043 "Accumulate a line to send as input along with more lines.
3044 This inserts a newline so that you can enter more text
3045 to be sent along with this line. Use \\[comint-send-input]
3046 to send all the accumulated input, at once.
3047 The entire accumulated text becomes one item in the input history
3051 (set-marker comint-accum-marker (point))
3052 (if comint-input-ring-index
3053 (setq comint-save-input-ring-index
3054 (- comint-input-ring-index 1))))
3056 (defun comint-goto-process-mark ()
3057 "Move point to the process mark.
3058 The process mark separates output, and input already sent,
3059 from input that has not yet been sent."
3061 (let ((proc (or (get-buffer-process (current-buffer))
3062 (error "Current buffer has no process"))))
3063 (goto-char (process-mark proc))
3064 (when (interactive-p)
3065 (message "Point is now at the process mark"))))
3067 (defun comint-bol-or-process-mark ()
3068 "Move point to beginning of line (after prompt) or to the process mark.
3069 The first time you use this command, it moves to the beginning of the line
3070 \(but after the prompt, if any). If you repeat it again immediately,
3071 it moves point to the process mark.
3073 The process mark separates the process output, along with input already sent,
3074 from input that has not yet been sent. Ordinarily, the process mark
3075 is at the beginning of the current input line; but if you have
3076 used \\[comint-accumulate] to send multiple lines at once,
3077 the process mark is at the beginning of the accumulated input."
3079 (if (not (eq last-command 'comint-bol-or-process-mark))
3081 (comint-goto-process-mark)))
3083 (defun comint-set-process-mark ()
3084 "Set the process mark at point."
3086 (let ((proc (or (get-buffer-process (current-buffer))
3087 (error "Current buffer has no process"))))
3088 (set-marker (process-mark proc) (point))
3089 (message "Process mark set")))
3092 ;; Author: Peter Breton <pbreton@cs.umb.edu>
3094 ;; This little add-on for comint is intended to make it easy to get
3095 ;; output from currently active comint buffers into another buffer,
3096 ;; or buffers, and then go back to using the comint shell.
3098 ;; My particular use is SQL interpreters; I want to be able to execute a
3099 ;; query using the process associated with a comint-buffer, and save that
3100 ;; somewhere else. Because the process might have state (for example, it
3101 ;; could be in an uncommitted transaction), just running starting a new
3102 ;; process and having it execute the query and then finish, would not
3103 ;; work. I'm sure there are other uses as well, although in many cases
3104 ;; starting a new process is the simpler, and thus preferable, approach.
3106 ;; The basic implementation is as follows: comint-redirect changes the
3107 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
3108 ;; its own filter. The filter puts the output into the designated buffer,
3109 ;; or buffers, until it sees a regexp that tells it to stop (by default,
3110 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
3111 ;; sees the stop regexp, it restores the old filter functions, and runs
3112 ;; `comint-redirect-hook'.
3114 ;; Each comint buffer may only use one redirection at a time, but any number
3115 ;; of different comint buffers may be simultaneously redirected.
3117 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
3118 ;; correct prompt for your interpreter, or that you supply a regexp that says
3119 ;; when the redirection is finished. Otherwise, redirection will continue
3120 ;; indefinitely. The code now does a sanity check to ensure that it can find
3121 ;; a prompt in the comint buffer; however, it is still important to ensure that
3122 ;; this prompt is set correctly.
3124 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
3125 ;; perhaps it should prompt for a terminating string (with an
3126 ;; appropriate magic default by examining what we think is the prompt)?
3128 ;; Fixme: look for appropriate fields, rather than regexp, if
3129 ;; `comint-use-prompt-regexp' is true.
3131 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3133 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3135 (defcustom comint-redirect-verbose nil
3136 "*If non-nil, print messages each time the redirection filter is invoked.
3137 Also print a message when redirection is completed."
3141 ;; Directly analagous to comint-preoutput-filter-functions
3142 (defvar comint-redirect-filter-functions nil
3143 "List of functions to call before inserting redirected process output.
3144 Each function gets one argument, a string containing the text received
3145 from the subprocess. It should return the string to insert, perhaps
3146 the same string that was received, or perhaps a modified or transformed
3149 The functions on the list are called sequentially, and each one is given
3150 the string returned by the previous one. The string returned by the
3151 last function is the text that is actually inserted in the redirection buffer.
3153 You can use `add-hook' to add functions to this list
3154 either globally or locally.")
3156 ;; Internal variables
3158 (defvar comint-redirect-output-buffer nil
3159 "The buffer or list of buffers to put output into.")
3161 (defvar comint-redirect-finished-regexp nil
3162 "Regular expression that determines when to stop redirection in Comint.
3163 When the redirection filter function is given output that matches this regexp,
3164 the output is inserted as usual, and redirection is completed.")
3166 (defvar comint-redirect-insert-matching-regexp nil
3167 "If non-nil, the text that ends a redirection is included in it.
3168 More precisely, the text that matches `comint-redirect-finished-regexp'
3169 and therefore terminates an output redirection is inserted in the
3170 redirection target buffer, along with the preceding output.")
3172 (defvar comint-redirect-echo-input nil
3173 "Non-nil means echo input in the process buffer even during redirection.")
3175 (defvar comint-redirect-completed nil
3176 "Non-nil if redirection has completed in the current buffer.")
3178 (defvar comint-redirect-original-mode-line-process nil
3179 "Original mode line for redirected process.")
3181 (defvar comint-redirect-perform-sanity-check t
3182 "If non-nil, check that redirection is likely to complete successfully.
3183 More precisely, before starting a redirection, verify that the
3184 regular expression `comint-redirect-finished-regexp' that controls
3185 when to terminate it actually matches some text already in the process
3186 buffer. The idea is that this regular expression should match a prompt
3187 string, and that there ought to be at least one copy of your prompt string
3188 in the process buffer already.")
3190 (defvar comint-redirect-original-filter-function nil
3191 "The process filter that was in place when redirection is started.
3192 When redirection is completed, the process filter is restored to
3195 (defvar comint-redirect-subvert-readonly nil
3196 "Non-nil means `comint-redirect' can insert into read-only buffers.
3197 This works by binding `inhibit-read-only' around the insertion.
3198 This is useful, for instance, for insertion into Help mode buffers.
3199 You probably want to set it locally to the output buffer.")
3201 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3203 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3205 (defun comint-redirect-setup (output-buffer
3208 &optional echo-input)
3209 "Set up for output redirection.
3210 This function sets local variables that are used by `comint-redirect-filter'
3211 to perform redirection.
3213 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3214 in the output matches FINISHED-REGEXP.
3216 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3217 original Comint buffer.
3219 This function is called by `comint-redirect-send-command-to-process',
3220 and does not normally need to be invoked by the end user or programmer."
3221 (with-current-buffer comint-buffer
3223 (make-local-variable 'comint-redirect-original-mode-line-process)
3224 (setq comint-redirect-original-mode-line-process mode-line-process)
3226 (make-local-variable 'comint-redirect-output-buffer)
3227 (setq comint-redirect-output-buffer output-buffer)
3229 (make-local-variable 'comint-redirect-finished-regexp)
3230 (setq comint-redirect-finished-regexp finished-regexp)
3232 (make-local-variable 'comint-redirect-echo-input)
3233 (setq comint-redirect-echo-input echo-input)
3235 (make-local-variable 'comint-redirect-completed)
3236 (setq comint-redirect-completed nil)
3238 (setq mode-line-process
3239 (if mode-line-process
3240 (list (concat (elt mode-line-process 0) " Redirection"))
3241 (list ":%s Redirection")))))
3243 (defun comint-redirect-cleanup ()
3244 "End a Comint redirection. See `comint-redirect-send-command'."
3246 ;; Restore the process filter
3247 (set-process-filter (get-buffer-process (current-buffer))
3248 comint-redirect-original-filter-function)
3249 ;; Restore the mode line
3250 (setq mode-line-process comint-redirect-original-mode-line-process)
3251 ;; Set the completed flag
3252 (setq comint-redirect-completed t))
3254 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3255 ;; that it really occurs.
3256 (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
3258 (defun comint-redirect-filter (process input-string)
3259 "Filter function which redirects output from PROCESS to a buffer or buffers.
3260 The variable `comint-redirect-output-buffer' says which buffer(s) to
3263 INPUT-STRING is the input from the Comint process.
3265 This function runs as a process filter, and does not need to be invoked by the
3268 (with-current-buffer (process-buffer process)
3269 (comint-redirect-preoutput-filter input-string)
3270 ;; If we have to echo output, give it to the original filter function
3271 (and comint-redirect-echo-input
3272 comint-redirect-original-filter-function
3273 (funcall comint-redirect-original-filter-function
3274 process input-string)))))
3277 (defun comint-redirect-preoutput-filter (input-string)
3278 "Comint filter function which redirects Comint output to a buffer or buffers.
3279 The variable `comint-redirect-output-buffer' says which buffer(s) to
3282 INPUT-STRING is the input from the Comint process.
3284 This function does not need to be invoked by the end user."
3285 (let ((output-buffer-list
3286 (if (listp comint-redirect-output-buffer)
3287 comint-redirect-output-buffer
3288 (list comint-redirect-output-buffer)))
3289 (filtered-input-string input-string))
3291 ;; If there are any filter functions, give them a chance to modify the string
3292 (let ((functions comint-redirect-filter-functions))
3293 (while (and functions filtered-input-string)
3294 (if (eq (car functions) t)
3295 ;; If a local value says "use the default value too",
3297 (let ((functions (default-value 'comint-redirect-filter-functions)))
3298 (while (and functions filtered-input-string)
3299 (setq filtered-input-string
3300 (funcall (car functions) filtered-input-string))
3301 (setq functions (cdr functions))))
3302 (setq filtered-input-string
3303 (funcall (car functions) filtered-input-string)))
3304 (setq functions (cdr functions))))
3306 ;; Clobber `comint-redirect-finished-regexp'
3307 (or comint-redirect-insert-matching-regexp
3308 (and (string-match comint-redirect-finished-regexp filtered-input-string)
3309 (setq filtered-input-string
3310 (replace-match "" nil nil filtered-input-string))))
3312 ;; Send output to all registered buffers
3314 (dolist (buf output-buffer-list)
3315 ;; Set this buffer to the output buffer
3316 (set-buffer (get-buffer-create buf))
3317 ;; Go to the end of the buffer
3318 (goto-char (point-max))
3319 ;; Insert the output
3320 (let ((inhibit-read-only comint-redirect-subvert-readonly))
3321 (insert filtered-input-string))))
3324 (and comint-redirect-verbose
3325 (message "Redirected output to buffer(s) %s"
3326 (mapconcat 'identity output-buffer-list " ")))
3328 ;; If we see the prompt, tidy up
3329 ;; We'll look for the prompt in the original string, so nobody can
3331 (and (string-match comint-redirect-finished-regexp input-string)
3333 (and comint-redirect-verbose
3334 (message "Redirection completed"))
3335 (comint-redirect-cleanup)
3336 (run-hooks 'comint-redirect-hook)))
3338 (if comint-redirect-echo-input
3339 filtered-input-string
3343 (defun comint-redirect-send-command (command output-buffer echo &optional no-display)
3344 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3345 With prefix arg ECHO, echo output in process buffer.
3347 If NO-DISPLAY is non-nil, do not show the output buffer."
3348 (interactive "sCommand: \nBOutput Buffer: \nP")
3349 (let ((process (get-buffer-process (current-buffer))))
3351 (comint-redirect-send-command-to-process
3352 command output-buffer (current-buffer) echo no-display)
3353 (error "No process for current buffer"))))
3356 (defun comint-redirect-send-command-to-process
3357 (command output-buffer process echo &optional no-display)
3358 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3359 With prefix arg, echo output in process buffer.
3361 If NO-DISPLAY is non-nil, do not show the output buffer."
3362 (interactive "sCommand: \nBOutput Buffer: \nbProcess Buffer: \nP")
3363 (let* (;; The process buffer
3364 (process-buffer (if (processp process)
3365 (process-buffer process)
3367 (proc (get-buffer-process process-buffer)))
3368 ;; Change to the process buffer
3369 (with-current-buffer process-buffer
3371 ;; Make sure there's a prompt in the current process buffer
3372 (and comint-redirect-perform-sanity-check
3374 (goto-char (point-max))
3375 (or (re-search-backward comint-prompt-regexp nil t)
3376 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3378 ;;;;;;;;;;;;;;;;;;;;;
3379 ;; Set up for redirection
3380 ;;;;;;;;;;;;;;;;;;;;;
3381 (comint-redirect-setup
3387 comint-prompt-regexp
3391 ;;;;;;;;;;;;;;;;;;;;;
3393 ;;;;;;;;;;;;;;;;;;;;;
3394 ;; Save the old filter
3395 (setq comint-redirect-original-filter-function
3396 (process-filter proc))
3397 (set-process-filter proc 'comint-redirect-filter)
3399 ;;;;;;;;;;;;;;;;;;;;;
3401 ;;;;;;;;;;;;;;;;;;;;;
3402 (process-send-string
3404 (concat command "\n"))
3406 ;;;;;;;;;;;;;;;;;;;;;
3408 ;;;;;;;;;;;;;;;;;;;;;
3412 (if (listp output-buffer)
3414 output-buffer)))))))
3417 (defun comint-redirect-results-list (command regexp regexp-group)
3418 "Send COMMAND to current process.
3419 Return a list of expressions in the output which match REGEXP.
3420 REGEXP-GROUP is the regular expression group in REGEXP to use."
3421 (comint-redirect-results-list-from-process
3422 (get-buffer-process (current-buffer))
3423 command regexp regexp-group))
3426 (defun comint-redirect-results-list-from-process (process command regexp regexp-group)
3427 "Send COMMAND to PROCESS.
3428 Return a list of expressions in the output which match REGEXP.
3429 REGEXP-GROUP is the regular expression group in REGEXP to use."
3430 (let ((output-buffer " *Comint Redirect Work Buffer*")
3433 (set-buffer (get-buffer-create output-buffer))
3435 (comint-redirect-send-command-to-process command
3436 output-buffer process nil t)
3437 ;; Wait for the process to complete
3438 (set-buffer (process-buffer process))
3439 (while (null comint-redirect-completed)
3440 (accept-process-output nil 1))
3441 ;; Collect the output
3442 (set-buffer output-buffer)
3443 (goto-char (point-min))
3444 ;; Skip past the command, if it was echoed
3445 (and (looking-at command)
3447 (while (re-search-forward regexp nil t)
3449 (cons (buffer-substring-no-properties
3450 (match-beginning regexp-group)
3451 (match-end regexp-group))
3456 (add-to-list 'debug-ignored-errors x))
3457 '("^Not at command line$"
3458 "^Empty input ring$"
3460 "^Not found$" ; Too common?
3461 "^Current buffer has no process$"))
3464 ;; Converting process modes to use comint mode
3465 ;; ===========================================================================
3466 ;; The code in the Emacs 19 distribution has all been modified to use comint
3467 ;; where needed. However, there are `third-party' packages out there that
3468 ;; still use the old shell mode. Here's a guide to conversion.
3470 ;; Renaming variables
3471 ;; Most of the work is renaming variables and functions. These are the common
3474 ;; last-input-start comint-last-input-start
3475 ;; last-input-end comint-last-input-end
3476 ;; shell-prompt-pattern comint-prompt-regexp
3477 ;; shell-set-directory-error-hook <no equivalent>
3479 ;; shell-set-directory <unnecessary>
3480 ;; shell-mode-map comint-mode-map
3482 ;; shell-send-input comint-send-input
3483 ;; shell-send-eof comint-delchar-or-maybe-eof
3484 ;; kill-shell-input comint-kill-input
3485 ;; interrupt-shell-subjob comint-interrupt-subjob
3486 ;; stop-shell-subjob comint-stop-subjob
3487 ;; quit-shell-subjob comint-quit-subjob
3488 ;; kill-shell-subjob comint-kill-subjob
3489 ;; kill-output-from-shell comint-delete-output
3490 ;; show-output-from-shell comint-show-output
3491 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3493 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3494 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3495 ;; Comint mode does not provide functionality equivalent to
3496 ;; shell-set-directory-error-hook; it is gone.
3498 ;; comint-last-input-start is provided for modes which want to munge
3499 ;; the buffer after input is sent, perhaps because the inferior
3500 ;; insists on echoing the input. The LAST-INPUT-START variable in
3501 ;; the old shell package was used to implement a history mechanism,
3502 ;; but you should think twice before using comint-last-input-start
3503 ;; for this; the input history ring often does the job better.
3505 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3506 ;; *not* create the comint-mode local variables in your foo-mode function.
3507 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3508 ;; necessary comint-specific local variables. Then create the
3509 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3510 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3511 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3512 ;; get-old-input) that need to be different from the defaults. Call
3513 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3514 ;; comint-mode will take care of it. The following example, from shell.el,
3517 ;; (defvar shell-mode-map '())
3518 ;; (cond ((not shell-mode-map)
3519 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3520 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3521 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3522 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3523 ;; (define-key shell-mode-map "\M-?"
3524 ;; 'comint-dynamic-list-filename-completions)))
3526 ;; (defun shell-mode ()
3529 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3530 ;; (setq major-mode 'shell-mode)
3531 ;; (setq mode-name "Shell")
3532 ;; (use-local-map shell-mode-map)
3533 ;; (make-local-variable 'shell-directory-stack)
3534 ;; (setq shell-directory-stack nil)
3535 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3536 ;; (run-mode-hooks 'shell-mode-hook))
3539 ;; Completion for comint-mode users
3541 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3542 ;; hook to add completion functions to. Functions on this list should return
3543 ;; non-nil if completion occurs (i.e., further completion should not occur).
3544 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3550 ;; arch-tag: 1793314c-09db-40be-9549-9aeae3e75164
3551 ;;; comint.el ends here