*** empty log message ***
[emacs.git] / lisp / comint.el
blob921b567276fe1342c6f86e1946fa1302122b75ea
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001
4 ;; Free Software Foundation, Inc.
6 ;; Author: Olin Shivers <shivers@cs.cmu.edu> then
7 ;; Simon Marshall <simon@gnu.org>
8 ;; Maintainer: FSF
9 ;; Keywords: processes
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
28 ;;; Commentary:
30 ;; Please send me bug reports, bug fixes, and extensions, so that I can
31 ;; merge them into the master source.
32 ;; - Olin Shivers (shivers@cs.cmu.edu)
33 ;; - Simon Marshall (simon@gnu.org)
35 ;; This file defines a general command-interpreter-in-a-buffer package
36 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
37 ;; modes on top of comint mode -- e.g., lisp, shell, scheme, T, soar, ....
38 ;; This way, all these specific packages share a common base functionality,
39 ;; and a common set of bindings, which makes them easier to use (and
40 ;; saves code, implementation time, etc., etc.).
42 ;; Several packages are already defined using comint mode:
43 ;; - shell.el defines a shell-in-a-buffer mode.
44 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
46 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
47 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
48 ;; - The file soar.el tunes lisp and inferior-lisp modes for Soar.
49 ;; - cmutex.el defines tex and latex modes that invoke tex, latex, bibtex,
50 ;; previewers, and printers from within emacs.
51 ;; - background.el allows csh-like job control inside emacs.
52 ;; It is pretty easy to make new derived modes for other processes.
54 ;; For documentation on the functionality provided by comint mode, and
55 ;; the hooks available for customising it, see the comments below.
56 ;; For further information on the standard derived modes (shell,
57 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
59 ;; For hints on converting existing process modes (e.g., tex-mode,
60 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
61 ;; instead of shell-mode, see the notes at the end of this file.
64 ;; Brief Command Documentation:
65 ;;============================================================================
66 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
67 ;; mode)
69 ;; m-p comint-previous-input Cycle backwards in input history
70 ;; m-n comint-next-input Cycle forwards
71 ;; m-r comint-previous-matching-input Previous input matching a regexp
72 ;; m-s comint-next-matching-input Next input that matches
73 ;; m-c-l comint-show-output Show last batch of process output
74 ;; return comint-send-input
75 ;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff
76 ;; c-c c-a comint-bol-or-process-mark First time, move point to bol;
77 ;; second time, move to process-mark.
78 ;; c-c c-u comint-kill-input ^u
79 ;; c-c c-w backward-kill-word ^w
80 ;; c-c c-c comint-interrupt-subjob ^c
81 ;; c-c c-z comint-stop-subjob ^z
82 ;; c-c c-\ comint-quit-subjob ^\
83 ;; c-c c-o comint-delete-output Delete last batch of process output
84 ;; c-c c-r comint-show-output Show last batch of process output
85 ;; c-c c-l comint-dynamic-list-input-ring List input history
87 ;; Not bound by default in comint-mode (some are in shell mode)
88 ;; comint-run Run a program under comint-mode
89 ;; send-invisible Read a line w/o echo, and send to proc
90 ;; comint-dynamic-complete-filename Complete filename at point.
91 ;; comint-dynamic-complete-variable Complete variable name at point.
92 ;; comint-dynamic-list-filename-completions List completions in help buffer.
93 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
94 ;; replace with expanded/completed name.
95 ;; comint-replace-by-expanded-history Expand history at point;
96 ;; replace with expanded name.
97 ;; comint-magic-space Expand history and add (a) space(s).
98 ;; comint-kill-subjob No mercy.
99 ;; comint-show-maximum-output Show as much output as possible.
100 ;; comint-continue-subjob Send CONT signal to buffer's process
101 ;; group. Useful if you accidentally
102 ;; suspend your process (with C-c C-z).
103 ;; comint-get-next-from-history Fetch successive input history lines
104 ;; comint-accumulate Combine lines to send them together
105 ;; as input.
106 ;; comint-goto-process-mark Move point to where process-mark is.
107 ;; comint-set-process-mark Set process-mark to point.
109 ;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
111 ;;; Code:
113 (require 'ring)
115 ;; Buffer Local Variables:
116 ;;============================================================================
117 ;; Comint mode buffer local variables:
118 ;; comint-prompt-regexp string comint-bol uses to match prompt
119 ;; comint-delimiter-argument-list list For delimiters and arguments
120 ;; comint-last-input-start marker Handy if inferior always echoes
121 ;; comint-last-input-end marker For comint-delete-output command
122 ;; comint-input-ring-size integer For the input history
123 ;; comint-input-ring ring mechanism
124 ;; comint-input-ring-index number ...
125 ;; comint-save-input-ring-index number ...
126 ;; comint-input-autoexpand symbol ...
127 ;; comint-input-ignoredups boolean ...
128 ;; comint-dynamic-complete-functions hook For the completion mechanism
129 ;; comint-completion-fignore list ...
130 ;; comint-file-name-chars string ...
131 ;; comint-file-name-quote-list list ...
132 ;; comint-get-old-input function Hooks for specific
133 ;; comint-input-filter-functions hook process-in-a-buffer
134 ;; comint-output-filter-functions hook function modes.
135 ;; comint-preoutput-filter-functions hook
136 ;; comint-input-filter function ...
137 ;; comint-input-sender function ...
138 ;; comint-eol-on-send boolean ...
139 ;; comint-process-echoes boolean ...
140 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
141 ;; comint-scroll-to-bottom-on-output symbol ...
142 ;; comint-scroll-show-maximum-output boolean ...
143 ;; comint-accum-marker maker For comint-accumulate
144 ;; comint-last-output-overlay overlay
146 ;; Comint mode non-buffer local variables:
147 ;; comint-completion-addsuffix boolean/cons For file name
148 ;; comint-completion-autolist boolean completion behavior
149 ;; comint-completion-recexact boolean ...
151 (defgroup comint nil
152 "General command interpreter in a window stuff."
153 :group 'processes)
155 (defgroup comint-completion nil
156 "Completion facilities in comint"
157 :group 'comint)
159 (defgroup comint-source nil
160 "Source finding facilities in comint"
161 :prefix "comint-"
162 :group 'comint)
164 (defvar comint-prompt-regexp "^"
165 "Regexp to recognise prompts in the inferior process.
166 Defaults to \"^\", the null string at BOL.
168 This variable is only used if the variable
169 `comint-use-prompt-regexp-instead-of-fields' is non-nil.
171 Good choices:
172 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
173 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
174 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
175 kcl: \"^>+ *\"
176 shell: \"^[^#$%>\\n]*[#$%>] *\"
177 T: \"^>+ *\"
179 This is a good thing to set in mode hooks.")
181 (defvar comint-delimiter-argument-list ()
182 "List of characters to recognise as separate arguments in input.
183 Strings comprising a character in this list will separate the arguments
184 surrounding them, and also be regarded as arguments in their own right (unlike
185 whitespace). See `comint-arguments'.
186 Defaults to the empty list.
188 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
190 This is a good thing to set in mode hooks.")
192 (defcustom comint-input-autoexpand nil
193 "*If non-nil, expand input command history references on completion.
194 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
196 If the value is `input', then the expansion is seen on input.
197 If the value is `history', then the expansion is only when inserting
198 into the buffer's input ring. See also `comint-magic-space' and
199 `comint-dynamic-complete'.
201 This variable is buffer-local."
202 :type '(choice (const :tag "off" nil)
203 (const input)
204 (const history)
205 (other :tag "on" t))
206 :group 'comint)
208 (defcustom comint-highlight-input t
209 "*If non-nil, highlight input; also allow choosing previous input with a mouse.
210 The face used is `comint-highlight-input'."
211 :type 'boolean
212 :group 'comint)
214 (defface comint-highlight-input '((t (:bold t)))
215 "Face to use to highlight input when `comint-highlight-input' is non-nil."
216 :group 'comint)
218 (defcustom comint-highlight-prompt t
219 "*If non-nil, highlight program prompts.
220 The face used is `comint-highlight-prompt'."
221 :type 'boolean
222 :group 'comint)
224 (defface comint-highlight-prompt
225 '((((background dark)) (:foreground "cyan"))
226 (t (:foreground "dark blue")))
227 "Face to use to highlight prompt when `comint-highlight-prompt' is non-nil."
228 :group 'comint)
230 (defcustom comint-input-ignoredups nil
231 "*If non-nil, don't add input matching the last on the input ring.
232 This mirrors the optional behavior of bash.
234 This variable is buffer-local."
235 :type 'boolean
236 :group 'comint)
238 (defcustom comint-input-ring-file-name nil
239 "*If non-nil, name of the file to read/write input history.
240 See also `comint-read-input-ring' and `comint-write-input-ring'.
242 This variable is buffer-local, and is a good thing to set in mode hooks."
243 :type '(choice (const :tag "nil" nil)
244 file)
245 :group 'comint)
247 (defcustom comint-scroll-to-bottom-on-input nil
248 "*Controls whether input to interpreter causes window to scroll.
249 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
250 If `this', scroll only the selected window.
252 The default is nil.
254 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
255 :type '(choice (const :tag "off" nil)
256 (const t)
257 (const all)
258 (const this))
259 :group 'comint)
261 (defcustom comint-scroll-to-bottom-on-output nil
262 "*Controls whether interpreter output causes window to scroll.
263 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
264 If `this', scroll only the selected window.
265 If `others', scroll only those that are not the selected window.
267 The default is nil.
269 See variable `comint-scroll-show-maximum-output' and function
270 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
271 :type '(choice (const :tag "off" nil)
272 (const t)
273 (const all)
274 (const this)
275 (const others))
276 :group 'comint)
278 (defcustom comint-scroll-show-maximum-output nil
279 "*Controls how interpreter output causes window to scroll.
280 If non-nil, then show the maximum output when the window is scrolled.
282 See variable `comint-scroll-to-bottom-on-output' and function
283 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
284 :type 'boolean
285 :group 'comint)
287 (defcustom comint-buffer-maximum-size 1024
288 "*The maximum size in lines for comint buffers.
289 Comint buffers are truncated from the top to be no greater than this number, if
290 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
291 :type 'integer
292 :group 'comint)
294 (defvar comint-input-ring-size 32
295 "Size of input history ring.")
297 (defvar comint-input-ring-separator "\n"
298 "Separator between commands in the history file.")
300 (defvar comint-input-history-ignore "^#"
301 "Regexp for history entries that should be ignored when comint initializes.")
303 (defcustom comint-process-echoes nil
304 "*If non-nil, assume that the subprocess echoes any input.
305 If so, delete one copy of the input so that only one copy eventually
306 appears in the buffer.
308 This variable is buffer-local."
309 :type 'boolean
310 :group 'comint)
312 ;; AIX puts the name of the person being su'd to in front of the prompt.
313 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
314 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
315 ;; ssh-add prints a prompt like `Enter passphrase: '.
316 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
317 (defcustom comint-password-prompt-regexp
318 "\\(\\([Oo]ld \\|[Nn]ew \\|Kerberos \\|'s \\|login \\|CVS \\|^\\)\
319 [Pp]assword\\( (again)\\)?\\|pass phrase\\|Enter passphrase\\)\
320 \\( for [^@ \t\n]+@[^@ \t\n]+\\)?:\\s *\\'"
321 "*Regexp matching prompts for passwords in the inferior process.
322 This is used by `comint-watch-for-password-prompt'."
323 :type 'regexp
324 :group 'comint)
326 ;; Here are the per-interpreter hooks.
327 (defvar comint-get-old-input (function comint-get-old-input-default)
328 "Function that returns old text in comint mode.
329 This function is called when return is typed while the point is in old
330 text. It returns the text to be submitted as process input. The
331 default is `comint-get-old-input-default', which either grabs the
332 current input field or grabs the current line and strips off leading
333 text matching `comint-prompt-regexp', depending on the value of
334 `comint-use-prompt-regexp-instead-of-fields'.")
336 (defvar comint-dynamic-complete-functions
337 '(comint-replace-by-expanded-history comint-dynamic-complete-filename)
338 "List of functions called to perform completion.
339 Functions should return non-nil if completion was performed.
340 See also `comint-dynamic-complete'.
342 This is a good thing to set in mode hooks.")
344 (defvar comint-input-filter
345 (function (lambda (str) (not (string-match "\\`\\s *\\'" str))))
346 "Predicate for filtering additions to input history.
347 Takes one argument, the input. If non-nil, the input may be saved on the input
348 history list. Default is to save anything that isn't all whitespace.")
350 (defvar comint-input-filter-functions '()
351 "Functions to call before input is sent to the process.
352 These functions get one argument, a string containing the text to send.
354 This variable is buffer-local.")
356 (defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom)
357 "Functions to call after output is inserted into the buffer.
358 One possible function is `comint-postoutput-scroll-to-bottom'.
359 These functions get one argument, a string containing the text as originally
360 inserted. Note that this might not be the same as the buffer contents between
361 `comint-last-output-start' and the buffer's `process-mark', if other filter
362 functions have already modified the buffer.
364 See also `comint-preoutput-filter-functions'.
366 This variable is buffer-local.")
368 (defvar comint-input-sender (function comint-simple-send)
369 "Function to actually send to PROCESS the STRING submitted by user.
370 Usually this is just `comint-simple-send', but if your mode needs to
371 massage the input string, put a different function here.
372 `comint-simple-send' just sends the string plus a newline.
373 This is called from the user command `comint-send-input'.")
375 (defcustom comint-eol-on-send t
376 "*Non-nil means go to the end of the line before sending input.
377 See `comint-send-input'."
378 :type 'boolean
379 :group 'comint)
381 ;; Note: If it is decided to purge comint-prompt-regexp from the source
382 ;; entirely, searching for uses of this variable will help to identify
383 ;; places that need attention.
384 (defcustom comint-use-prompt-regexp-instead-of-fields nil
385 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
386 If nil, then program output and user-input are given different `field'
387 properties, which emacs commands can use to distinguish them (in
388 particular, common movement commands such as begining-of-line respect
389 field boundaries in a natural way)."
390 :type 'boolean
391 :group 'comint)
393 (defcustom comint-mode-hook '()
394 "Called upon entry into `comint-mode'
395 This is run before the process is cranked up."
396 :type 'hook
397 :group 'comint)
399 (defcustom comint-exec-hook '()
400 "Called each time a process is exec'd by `comint-exec'.
401 This is called after the process is cranked up. It is useful for things that
402 must be done each time a process is executed in a comint mode buffer (e.g.,
403 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
404 executed once when the buffer is created."
405 :type 'hook
406 :group 'comint)
408 (defvar comint-mode-map nil)
410 (defvar comint-ptyp t
411 "Non-nil if communications via pty; false if by pipe. Buffer local.
412 This is to work around a bug in Emacs process signaling.")
414 (defvar comint-input-ring nil)
415 (defvar comint-last-input-start)
416 (defvar comint-last-input-end)
417 (defvar comint-last-output-start)
418 (defvar comint-input-ring-index nil
419 "Index of last matched history element.")
420 (defvar comint-matching-input-from-input-string ""
421 "Input previously used to match input history.")
422 (defvar comint-save-input-ring-index
423 "Last input ring index which you copied.
424 This is to support the command \\[comint-get-next-from-history].")
426 (defvar comint-accum-marker nil
427 "Non-nil if you are accumulating input lines to send as input together.
428 The command \\[comint-accumulate] sets this.")
430 (put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
431 (put 'comint-input-ring 'permanent-local t)
432 (put 'comint-input-ring-index 'permanent-local t)
433 (put 'comint-save-input-ring-index 'permanent-local t)
434 (put 'comint-input-autoexpand 'permanent-local t)
435 (put 'comint-input-filter-functions 'permanent-local t)
436 (put 'comint-output-filter-functions 'permanent-local t)
437 (put 'comint-preoutput-filter-functions 'permanent-local t)
438 (put 'comint-scroll-to-bottom-on-input 'permanent-local t)
439 (put 'comint-scroll-to-bottom-on-output 'permanent-local t)
440 (put 'comint-scroll-show-maximum-output 'permanent-local t)
441 (put 'comint-ptyp 'permanent-local t)
443 (put 'comint-mode 'mode-class 'special)
445 (define-derived-mode comint-mode fundamental-mode "Comint"
446 "Major mode for interacting with an inferior interpreter.
447 Interpreter name is same as buffer name, sans the asterisks.
448 Return at end of buffer sends line as input.
449 Return not at end copies rest of line to end and sends it.
450 Setting variable `comint-eol-on-send' means jump to the end of the line
451 before submitting new input.
453 This mode is customised to create major modes such as Inferior Lisp
454 mode, Shell mode, etc. This can be done by setting the hooks
455 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
456 and `comint-get-old-input' to appropriate functions, and the variable
457 `comint-prompt-regexp' to the appropriate regular expression.
459 An input history is maintained of size `comint-input-ring-size', and
460 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
461 Input ring history expansion can be achieved with the commands
462 \\[comint-replace-by-expanded-history] or \\[comint-magic-space].
463 Input ring expansion is controlled by the variable `comint-input-autoexpand',
464 and addition is controlled by the variable `comint-input-ignoredups'.
466 Commands with no default key bindings include `send-invisible',
467 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
468 `comint-magic-space'.
470 Input to, and output from, the subprocess can cause the window to scroll to
471 the end of the buffer. See variables `comint-output-filter-functions',
472 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
473 and `comint-scroll-to-bottom-on-output'.
475 If you accidentally suspend your process, use \\[comint-continue-subjob]
476 to continue it.
478 \\{comint-mode-map}
480 Entry to this mode runs the hooks on `comint-mode-hook'."
481 (setq mode-line-process '(":%s"))
482 (make-local-variable 'comint-last-input-start)
483 (setq comint-last-input-start (make-marker))
484 (set-marker comint-last-input-start (point-min))
485 (make-local-variable 'comint-last-input-end)
486 (setq comint-last-input-end (make-marker))
487 (set-marker comint-last-input-end (point-min))
488 (make-local-variable 'comint-last-output-start)
489 (setq comint-last-output-start (make-marker))
490 (make-local-variable 'comint-last-output-overlay)
491 (make-local-variable 'comint-last-prompt-overlay)
492 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
493 (make-local-variable 'comint-input-ring-size) ; ...to global val.
494 (make-local-variable 'comint-input-ring)
495 (make-local-variable 'comint-input-ring-file-name)
496 (or (and (boundp 'comint-input-ring) comint-input-ring)
497 (setq comint-input-ring (make-ring comint-input-ring-size)))
498 (make-local-variable 'comint-input-ring-index)
499 (make-local-variable 'comint-save-input-ring-index)
500 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
501 (setq comint-input-ring-index nil))
502 (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
503 (setq comint-save-input-ring-index nil))
504 (make-local-variable 'comint-matching-input-from-input-string)
505 (make-local-variable 'comint-input-autoexpand)
506 (make-local-variable 'comint-input-ignoredups)
507 (make-local-variable 'comint-delimiter-argument-list)
508 (make-local-hook 'comint-dynamic-complete-functions)
509 (make-local-variable 'comint-completion-fignore)
510 (make-local-variable 'comint-get-old-input)
511 (make-local-hook 'comint-input-filter-functions)
512 (make-local-variable 'comint-input-filter)
513 (make-local-variable 'comint-input-sender)
514 (make-local-variable 'comint-eol-on-send)
515 (make-local-variable 'comint-scroll-to-bottom-on-input)
516 (make-local-variable 'comint-scroll-to-bottom-on-output)
517 (make-local-variable 'comint-scroll-show-maximum-output)
518 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
519 (make-local-hook 'comint-output-filter-functions)
520 (make-local-hook 'comint-exec-hook)
521 (make-local-variable 'comint-ptyp)
522 (make-local-variable 'comint-process-echoes)
523 (make-local-variable 'comint-file-name-chars)
524 (make-local-variable 'comint-file-name-quote-list)
525 (make-local-variable 'comint-accum-marker)
526 (setq comint-accum-marker (make-marker))
527 (set-marker comint-accum-marker nil)
528 ;; This behavior is not useful in comint buffers, and is annoying
529 (set (make-local-variable 'next-line-add-newlines) nil))
531 (if comint-mode-map
533 ;; Keys:
534 (setq comint-mode-map (make-sparse-keymap))
535 (define-key comint-mode-map "\ep" 'comint-previous-input)
536 (define-key comint-mode-map "\en" 'comint-next-input)
537 (define-key comint-mode-map [C-up] 'comint-previous-input)
538 (define-key comint-mode-map [C-down] 'comint-next-input)
539 (define-key comint-mode-map "\er" 'comint-previous-matching-input)
540 (define-key comint-mode-map "\es" 'comint-next-matching-input)
541 (define-key comint-mode-map [?\C-c ?\M-r] 'comint-previous-matching-input-from-input)
542 (define-key comint-mode-map [?\C-c ?\M-s] 'comint-next-matching-input-from-input)
543 (define-key comint-mode-map "\e\C-l" 'comint-show-output)
544 (define-key comint-mode-map "\C-m" 'comint-send-input)
545 (define-key comint-mode-map "\C-d" 'comint-delchar-or-maybe-eof)
546 (define-key comint-mode-map "\C-c " 'comint-accumulate)
547 (define-key comint-mode-map "\C-c\C-x" 'comint-get-next-from-history)
548 (define-key comint-mode-map "\C-c\C-a" 'comint-bol-or-process-mark)
549 (define-key comint-mode-map "\C-c\C-u" 'comint-kill-input)
550 (define-key comint-mode-map "\C-c\C-w" 'backward-kill-word)
551 (define-key comint-mode-map "\C-c\C-c" 'comint-interrupt-subjob)
552 (define-key comint-mode-map "\C-c\C-z" 'comint-stop-subjob)
553 (define-key comint-mode-map "\C-c\C-\\" 'comint-quit-subjob)
554 (define-key comint-mode-map "\C-c\C-m" 'comint-copy-old-input)
555 (define-key comint-mode-map "\C-c\C-o" 'comint-delete-output)
556 (define-key comint-mode-map "\C-c\C-r" 'comint-show-output)
557 (define-key comint-mode-map "\C-c\C-e" 'comint-show-maximum-output)
558 (define-key comint-mode-map "\C-c\C-l" 'comint-dynamic-list-input-ring)
559 (define-key comint-mode-map "\C-c\C-n" 'comint-next-prompt)
560 (define-key comint-mode-map "\C-c\C-p" 'comint-previous-prompt)
561 (define-key comint-mode-map "\C-c\C-d" 'comint-send-eof)
562 (define-key comint-mode-map "\C-c\C-s" 'comint-write-output)
563 ;; Mouse Buttons:
564 (define-key comint-mode-map [mouse-2] 'comint-insert-clicked-input)
565 ;; Menu bars:
566 ;; completion:
567 (define-key comint-mode-map [menu-bar completion]
568 (cons "Complete" (make-sparse-keymap "Complete")))
569 (define-key comint-mode-map [menu-bar completion complete-expand]
570 '("Expand File Name" . comint-replace-by-expanded-filename))
571 (define-key comint-mode-map [menu-bar completion complete-listing]
572 '("File Completion Listing" . comint-dynamic-list-filename-completions))
573 (define-key comint-mode-map [menu-bar completion complete-file]
574 '("Complete File Name" . comint-dynamic-complete-filename))
575 (define-key comint-mode-map [menu-bar completion complete]
576 '("Complete Before Point" . comint-dynamic-complete))
577 ;; Input history:
578 (define-key comint-mode-map [menu-bar inout]
579 (cons "In/Out" (make-sparse-keymap "In/Out")))
580 (define-key comint-mode-map [menu-bar inout delete-output]
581 '("Delete Current Output Group" . comint-delete-output))
582 (define-key comint-mode-map [menu-bar inout append-output-to-file]
583 '("Append Current Output Group to File" . comint-append-output-to-file))
584 (define-key comint-mode-map [menu-bar inout write-output]
585 '("Write Current Output Group to File" . comint-write-output))
586 (define-key comint-mode-map [menu-bar inout next-prompt]
587 '("Forward Output Group" . comint-next-prompt))
588 (define-key comint-mode-map [menu-bar inout previous-prompt]
589 '("Backward Output Group" . comint-previous-prompt))
590 (define-key comint-mode-map [menu-bar inout show-maximum-output]
591 '("Show Maximum Output" . comint-show-maximum-output))
592 (define-key comint-mode-map [menu-bar inout show-output]
593 '("Show Current Output Group" . comint-show-output))
594 (define-key comint-mode-map [menu-bar inout kill-input]
595 '("Kill Current Input" . comint-kill-input))
596 (define-key comint-mode-map [menu-bar inout copy-input]
597 '("Copy Old Input" . comint-copy-old-input))
598 (define-key comint-mode-map [menu-bar inout forward-matching-history]
599 '("Forward Matching Input..." . comint-forward-matching-input))
600 (define-key comint-mode-map [menu-bar inout backward-matching-history]
601 '("Backward Matching Input..." . comint-backward-matching-input))
602 (define-key comint-mode-map [menu-bar inout next-matching-history]
603 '("Next Matching Input..." . comint-next-matching-input))
604 (define-key comint-mode-map [menu-bar inout previous-matching-history]
605 '("Previous Matching Input..." . comint-previous-matching-input))
606 (define-key comint-mode-map [menu-bar inout next-matching-history-from-input]
607 '("Next Matching Current Input" . comint-next-matching-input-from-input))
608 (define-key comint-mode-map [menu-bar inout previous-matching-history-from-input]
609 '("Previous Matching Current Input" . comint-previous-matching-input-from-input))
610 (define-key comint-mode-map [menu-bar inout next-history]
611 '("Next Input" . comint-next-input))
612 (define-key comint-mode-map [menu-bar inout previous-history]
613 '("Previous Input" . comint-previous-input))
614 (define-key comint-mode-map [menu-bar inout list-history]
615 '("List Input History" . comint-dynamic-list-input-ring))
616 (define-key comint-mode-map [menu-bar inout expand-history]
617 '("Expand History Before Point" . comint-replace-by-expanded-history))
618 ;; Signals
619 (define-key comint-mode-map [menu-bar signals]
620 (cons "Signals" (make-sparse-keymap "Signals")))
621 (define-key comint-mode-map [menu-bar signals eof]
622 '("EOF" . comint-send-eof))
623 (define-key comint-mode-map [menu-bar signals kill]
624 '("KILL" . comint-kill-subjob))
625 (define-key comint-mode-map [menu-bar signals quit]
626 '("QUIT" . comint-quit-subjob))
627 (define-key comint-mode-map [menu-bar signals cont]
628 '("CONT" . comint-continue-subjob))
629 (define-key comint-mode-map [menu-bar signals stop]
630 '("STOP" . comint-stop-subjob))
631 (define-key comint-mode-map [menu-bar signals break]
632 '("BREAK" . comint-interrupt-subjob))
633 ;; Put them in the menu bar:
634 (setq menu-bar-final-items (append '(completion inout signals)
635 menu-bar-final-items))
638 (defun comint-check-proc (buffer)
639 "Return t if there is a living process associated w/buffer BUFFER.
640 Living means the status is `open', `run', or `stop'.
641 BUFFER can be either a buffer or the name of one."
642 (let ((proc (get-buffer-process buffer)))
643 (and proc (memq (process-status proc) '(open run stop)))))
645 ;;;###autoload
646 (defun make-comint-in-buffer (name buffer program &optional startfile &rest switches)
647 "Make a comint process NAME in BUFFER, running PROGRAM.
648 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
649 PROGRAM should be either a string denoting an executable program to create
650 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
651 connection to be opened via `open-network-stream'. If there is already a
652 running process in that buffer, it is not restarted. Optional third arg
653 STARTFILE is the name of a file to send the contents of to the process.
655 If PROGRAM is a string, any more args are arguments to PROGRAM."
656 (or (fboundp 'start-process)
657 (error "Multi-processing is not supported for this system"))
658 (setq buffer (get-buffer-create (or buffer (concat "*" name "*"))))
659 ;; If no process, or nuked process, crank up a new one and put buffer in
660 ;; comint mode. Otherwise, leave buffer and existing process alone.
661 (unless (comint-check-proc buffer)
662 (with-current-buffer buffer
663 (comint-mode)) ; Install local vars, mode, keymap, ...
664 (comint-exec buffer name program startfile switches))
665 buffer)
667 ;;;###autoload
668 (defun make-comint (name program &optional startfile &rest switches)
669 "Make a comint process NAME in a buffer, running PROGRAM.
670 The name of the buffer is made by surrounding NAME with `*'s.
671 PROGRAM should be either a string denoting an executable program to create
672 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
673 connection to be opened via `open-network-stream'. If there is already a
674 running process in that buffer, it is not restarted. Optional third arg
675 STARTFILE is the name of a file to send the contents of to the process.
677 If PROGRAM is a string, any more args are arguments to PROGRAM."
678 (apply #'make-comint-in-buffer name nil program startfile switches))
680 ;;;###autoload
681 (defun comint-run (program)
682 "Run PROGRAM in a comint buffer and switch to it.
683 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
684 The file name is used to make a symbol name, such as `comint-sh-hook', and any
685 hooks on this symbol are run in the buffer.
686 See `make-comint' and `comint-exec'."
687 (interactive "sRun program: ")
688 (let ((name (file-name-nondirectory program)))
689 (switch-to-buffer (make-comint name program))
690 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
692 (defun comint-exec (buffer name command startfile switches)
693 "Start up a process in buffer BUFFER for comint modes.
694 Blasts any old process running in the buffer. Doesn't set the buffer mode.
695 You can use this to cheaply run a series of processes in the same comint
696 buffer. The hook `comint-exec-hook' is run after each exec."
697 (save-excursion
698 (set-buffer buffer)
699 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
700 (if proc (delete-process proc)))
701 ;; Crank up a new process
702 (let ((proc
703 (if (consp command)
704 (open-network-stream name buffer (car command) (cdr command))
705 (comint-exec-1 name buffer command switches))))
706 (set-process-filter proc 'comint-output-filter)
707 (make-local-variable 'comint-ptyp)
708 (setq comint-ptyp process-connection-type) ; T if pty, NIL if pipe.
709 ;; Jump to the end, and set the process mark.
710 (goto-char (point-max))
711 (set-marker (process-mark proc) (point))
712 ;; Feed it the startfile.
713 (cond (startfile
714 ;;This is guaranteed to wait long enough
715 ;;but has bad results if the comint does not prompt at all
716 ;; (while (= size (buffer-size))
717 ;; (sleep-for 1))
718 ;;I hope 1 second is enough!
719 (sleep-for 1)
720 (goto-char (point-max))
721 (insert-file-contents startfile)
722 (setq startfile (buffer-substring (point) (point-max)))
723 (delete-region (point) (point-max))
724 (comint-send-string proc startfile)))
725 (run-hooks 'comint-exec-hook)
726 buffer)))
728 ;; This auxiliary function cranks up the process for comint-exec in
729 ;; the appropriate environment.
731 (defun comint-exec-1 (name buffer command switches)
732 (let ((process-environment
733 (nconc
734 ;; If using termcap, we specify `emacs' as the terminal type
735 ;; because that lets us specify a width.
736 ;; If using terminfo, we specify `dumb' because that is
737 ;; a defined terminal type. `emacs' is not a defined terminal type
738 ;; and there is no way for us to define it here.
739 ;; Some programs that use terminfo get very confused
740 ;; if TERM is not a valid terminal type.
741 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
742 (list "TERM=dumb" "TERMCAP="
743 (format "COLUMNS=%d" (frame-width)))
744 (list "TERM=emacs"
745 (format "TERMCAP=emacs:co#%d:tc=unknown:" (frame-width))))
746 (if (getenv "EMACS") nil (list "EMACS=t"))
747 process-environment))
748 (default-directory
749 (if (file-accessible-directory-p default-directory)
750 default-directory
751 (char-to-string directory-sep-char)))
752 proc decoding encoding changed)
753 (let ((exec-path (if (file-name-directory command)
754 ;; If the command has slashes, make sure we
755 ;; first look relative to the current directory.
756 (cons default-directory exec-path) exec-path)))
757 (setq proc (apply 'start-process name buffer command switches)))
758 (let ((coding-systems (process-coding-system proc)))
759 (setq decoding (car coding-systems)
760 encoding (cdr coding-systems)))
761 ;; If start-process decided to use some coding system for decoding
762 ;; data sent from the process and the coding system doesn't
763 ;; specify EOL conversion, we had better convert CRLF to LF.
764 (if (vectorp (coding-system-eol-type decoding))
765 (setq decoding (coding-system-change-eol-conversion decoding 'dos)
766 changed t))
767 ;; Even if start-process left the coding system for encoding data
768 ;; sent from the process undecided, we had better use the same one
769 ;; as what we use for decoding. But, we should suppress EOL
770 ;; conversion.
771 (if (and decoding (not encoding))
772 (setq encoding (coding-system-change-eol-conversion decoding 'unix)
773 changed t))
774 (if changed
775 (set-process-coding-system proc decoding encoding))
776 proc))
779 (defun comint-insert-clicked-input (event)
780 "In a comint buffer, set the current input to the clicked-on previous input."
781 (interactive "e")
782 (let ((over (catch 'found
783 ;; Ignore non-input overlays
784 (dolist (ov (overlays-at (posn-point (event-end event))))
785 (when (eq (overlay-get ov 'field) 'input)
786 (throw 'found ov))))))
787 ;; do we have input in this area?
788 (if over
789 (let ((input-str (buffer-substring (overlay-start over)
790 (overlay-end over))))
791 (delete-region
792 ;; Can't use kill-region as it sets this-command
793 (or (marker-position comint-accum-marker)
794 (process-mark (get-buffer-process (current-buffer))))
795 (point))
796 (insert input-str))
797 ;; fall back to the user's previous definition if we aren't
798 ;; on previous input region.
799 (let ((fun (lookup-key global-map (this-command-keys))))
800 (if fun (call-interactively fun))))))
803 ;; Input history processing in a buffer
804 ;; ===========================================================================
805 ;; Useful input history functions, courtesy of the Ergo group.
807 ;; Eleven commands:
808 ;; comint-dynamic-list-input-ring List history in help buffer.
809 ;; comint-previous-input Previous input...
810 ;; comint-previous-matching-input ...matching a string.
811 ;; comint-previous-matching-input-from-input ... matching the current input.
812 ;; comint-next-input Next input...
813 ;; comint-next-matching-input ...matching a string.
814 ;; comint-next-matching-input-from-input ... matching the current input.
815 ;; comint-backward-matching-input Backwards input...
816 ;; comint-forward-matching-input ...matching a string.
817 ;; comint-replace-by-expanded-history Expand history at point;
818 ;; replace with expanded history.
819 ;; comint-magic-space Expand history and insert space.
821 ;; Three functions:
822 ;; comint-read-input-ring Read into comint-input-ring...
823 ;; comint-write-input-ring Write to comint-input-ring-file-name.
824 ;; comint-replace-by-expanded-history-before-point Workhorse function.
826 (defun comint-read-input-ring (&optional silent)
827 "Sets the buffer's `comint-input-ring' from a history file.
828 The name of the file is given by the variable `comint-input-ring-file-name'.
829 The history ring is of size `comint-input-ring-size', regardless of file size.
830 If `comint-input-ring-file-name' is nil this function does nothing.
832 If the optional argument SILENT is non-nil, we say nothing about a
833 failure to read the history file.
835 This function is useful for major mode commands and mode hooks.
837 The commands stored in the history file are separated by the
838 `comint-input-ring-separator', and entries that match
839 `comint-input-history-ignore' are ignored. The most recent command
840 comes last.
842 See also `comint-input-ignoredups' and `comint-write-input-ring'."
843 (cond ((or (null comint-input-ring-file-name)
844 (equal comint-input-ring-file-name ""))
845 nil)
846 ((not (file-readable-p comint-input-ring-file-name))
847 (or silent
848 (message "Cannot read history file %s"
849 comint-input-ring-file-name)))
851 (let* ((history-buf (get-buffer-create " *temp*"))
852 (file comint-input-ring-file-name)
853 (count 0)
854 (size comint-input-ring-size)
855 (ring (make-ring size)))
856 (unwind-protect
857 (save-excursion
858 (set-buffer history-buf)
859 (widen)
860 (erase-buffer)
861 (insert-file-contents file)
862 ;; Save restriction in case file is already visited...
863 ;; Watch for those date stamps in history files!
864 (goto-char (point-max))
865 (let (start end history)
866 (while (and (< count comint-input-ring-size)
867 (re-search-backward comint-input-ring-separator nil t)
868 (setq end (match-beginning 0)))
869 (if (re-search-backward comint-input-ring-separator nil t)
870 (setq start (match-end 0))
871 (setq start (point-min)))
872 (setq history (buffer-substring start end))
873 (goto-char start)
874 (if (and (not (string-match comint-input-history-ignore history))
875 (or (null comint-input-ignoredups)
876 (ring-empty-p ring)
877 (not (string-equal (ring-ref ring 0) history))))
878 (progn
879 (ring-insert-at-beginning ring history)
880 (setq count (1+ count)))))))
881 (kill-buffer history-buf))
882 (setq comint-input-ring ring
883 comint-input-ring-index nil)))))
885 (defun comint-write-input-ring ()
886 "Writes the buffer's `comint-input-ring' to a history file.
887 The name of the file is given by the variable `comint-input-ring-file-name'.
888 The original contents of the file are lost if `comint-input-ring' is not empty.
889 If `comint-input-ring-file-name' is nil this function does nothing.
891 Useful within process sentinels.
893 See also `comint-read-input-ring'."
894 (cond ((or (null comint-input-ring-file-name)
895 (equal comint-input-ring-file-name "")
896 (null comint-input-ring) (ring-empty-p comint-input-ring))
897 nil)
898 ((not (file-writable-p comint-input-ring-file-name))
899 (message "Cannot write history file %s" comint-input-ring-file-name))
901 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
902 (ring comint-input-ring)
903 (file comint-input-ring-file-name)
904 (index (ring-length ring)))
905 ;; Write it all out into a buffer first. Much faster, but messier,
906 ;; than writing it one line at a time.
907 (save-excursion
908 (set-buffer history-buf)
909 (erase-buffer)
910 (while (> index 0)
911 (setq index (1- index))
912 (insert (ring-ref ring index) comint-input-ring-separator))
913 (write-region (buffer-string) nil file nil 'no-message)
914 (kill-buffer nil))))))
917 (defun comint-dynamic-list-input-ring ()
918 "List in help buffer the buffer's input history."
919 (interactive)
920 (if (or (not (ring-p comint-input-ring))
921 (ring-empty-p comint-input-ring))
922 (message "No history")
923 (let ((history nil)
924 (history-buffer " *Input History*")
925 (index (1- (ring-length comint-input-ring)))
926 (conf (current-window-configuration)))
927 ;; We have to build up a list ourselves from the ring vector.
928 (while (>= index 0)
929 (setq history (cons (ring-ref comint-input-ring index) history)
930 index (1- index)))
931 ;; Change "completion" to "history reference"
932 ;; to make the display accurate.
933 (with-output-to-temp-buffer history-buffer
934 (display-completion-list history)
935 (set-buffer history-buffer)
936 (forward-line 3)
937 (while (search-backward "completion" nil 'move)
938 (replace-match "history reference")))
939 (sit-for 0)
940 (message "Hit space to flush")
941 (let ((ch (read-event)))
942 (if (eq ch ?\ )
943 (set-window-configuration conf)
944 (setq unread-command-events (list ch)))))))
947 (defun comint-regexp-arg (prompt)
948 ;; Return list of regexp and prefix arg using PROMPT.
949 (let* (;; Don't clobber this.
950 (last-command last-command)
951 (regexp (read-from-minibuffer prompt nil nil nil
952 'minibuffer-history-search-history)))
953 (list (if (string-equal regexp "")
954 (setcar minibuffer-history-search-history
955 (nth 1 minibuffer-history-search-history))
956 regexp)
957 (prefix-numeric-value current-prefix-arg))))
959 (defun comint-search-arg (arg)
960 ;; First make sure there is a ring and that we are after the process mark
961 (cond ((not (comint-after-pmark-p))
962 (error "Not at command line"))
963 ((or (null comint-input-ring)
964 (ring-empty-p comint-input-ring))
965 (error "Empty input ring"))
966 ((zerop arg)
967 ;; arg of zero resets search from beginning, and uses arg of 1
968 (setq comint-input-ring-index nil)
971 arg)))
973 (defun comint-search-start (arg)
974 ;; Index to start a directional search, starting at comint-input-ring-index
975 (if comint-input-ring-index
976 ;; If a search is running, offset by 1 in direction of arg
977 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
978 (ring-length comint-input-ring))
979 ;; For a new search, start from beginning or end, as appropriate
980 (if (>= arg 0)
981 0 ; First elt for forward search
982 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
984 (defun comint-previous-input-string (arg)
985 "Return the string ARG places along the input ring.
986 Moves relative to `comint-input-ring-index'."
987 (ring-ref comint-input-ring (if comint-input-ring-index
988 (mod (+ arg comint-input-ring-index)
989 (ring-length comint-input-ring))
990 arg)))
992 (defun comint-previous-input (arg)
993 "Cycle backwards through input history."
994 (interactive "*p")
995 (comint-previous-matching-input "." arg))
997 (defun comint-next-input (arg)
998 "Cycle forwards through input history."
999 (interactive "*p")
1000 (comint-previous-input (- arg)))
1002 (defun comint-previous-matching-input-string (regexp arg)
1003 "Return the string matching REGEXP ARG places along the input ring.
1004 Moves relative to `comint-input-ring-index'."
1005 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
1006 (if pos (ring-ref comint-input-ring pos))))
1008 (defun comint-previous-matching-input-string-position (regexp arg &optional start)
1009 "Return the index matching REGEXP ARG places along the input ring.
1010 Moves relative to START, or `comint-input-ring-index'."
1011 (if (or (not (ring-p comint-input-ring))
1012 (ring-empty-p comint-input-ring))
1013 (error "No history"))
1014 (let* ((len (ring-length comint-input-ring))
1015 (motion (if (> arg 0) 1 -1))
1016 (n (mod (- (or start (comint-search-start arg)) motion) len))
1017 (tried-each-ring-item nil)
1018 (prev nil))
1019 ;; Do the whole search as many times as the argument says.
1020 (while (and (/= arg 0) (not tried-each-ring-item))
1021 ;; Step once.
1022 (setq prev n
1023 n (mod (+ n motion) len))
1024 ;; If we haven't reached a match, step some more.
1025 (while (and (< n len) (not tried-each-ring-item)
1026 (not (string-match regexp (ring-ref comint-input-ring n))))
1027 (setq n (mod (+ n motion) len)
1028 ;; If we have gone all the way around in this search.
1029 tried-each-ring-item (= n prev)))
1030 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1031 ;; Now that we know which ring element to use, if we found it, return that.
1032 (if (string-match regexp (ring-ref comint-input-ring n))
1033 n)))
1035 (defun comint-previous-matching-input (regexp arg)
1036 "Search backwards through input history for match for REGEXP.
1037 \(Previous history elements are earlier commands.)
1038 With prefix argument N, search for Nth previous match.
1039 If N is negative, find the next or Nth next match."
1040 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1041 (setq arg (comint-search-arg arg))
1042 (let ((pos (comint-previous-matching-input-string-position regexp arg)))
1043 ;; Has a match been found?
1044 (if (null pos)
1045 (error "Not found")
1046 (setq comint-input-ring-index pos)
1047 (message "History item: %d" (1+ pos))
1048 (delete-region
1049 ;; Can't use kill-region as it sets this-command
1050 (or (marker-position comint-accum-marker)
1051 (process-mark (get-buffer-process (current-buffer))))
1052 (point))
1053 (insert (ring-ref comint-input-ring pos)))))
1055 (defun comint-next-matching-input (regexp arg)
1056 "Search forwards through input history for match for REGEXP.
1057 \(Later history elements are more recent commands.)
1058 With prefix argument N, search for Nth following match.
1059 If N is negative, find the previous or Nth previous match."
1060 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1061 (comint-previous-matching-input regexp (- arg)))
1063 (defun comint-previous-matching-input-from-input (arg)
1064 "Search backwards through input history for match for current input.
1065 \(Previous history elements are earlier commands.)
1066 With prefix argument N, search for Nth previous match.
1067 If N is negative, search forwards for the -Nth following match."
1068 (interactive "p")
1069 (if (not (memq last-command '(comint-previous-matching-input-from-input
1070 comint-next-matching-input-from-input)))
1071 ;; Starting a new search
1072 (setq comint-matching-input-from-input-string
1073 (buffer-substring
1074 (or (marker-position comint-accum-marker)
1075 (process-mark (get-buffer-process (current-buffer))))
1076 (point))
1077 comint-input-ring-index nil))
1078 (comint-previous-matching-input
1079 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1080 arg))
1082 (defun comint-next-matching-input-from-input (arg)
1083 "Search forwards through input history for match for current input.
1084 \(Following history elements are more recent commands.)
1085 With prefix argument N, search for Nth following match.
1086 If N is negative, search backwards for the -Nth previous match."
1087 (interactive "p")
1088 (comint-previous-matching-input-from-input (- arg)))
1091 (defun comint-replace-by-expanded-history (&optional silent start)
1092 "Expand input command history references before point.
1093 Expansion is dependent on the value of `comint-input-autoexpand'.
1095 This function depends on the buffer's idea of the input history, which may not
1096 match the command interpreter's idea, assuming it has one.
1098 Assumes history syntax is like typical Un*x shells'. However, since emacs
1099 cannot know the interpreter's idea of input line numbers, assuming it has one,
1100 it cannot expand absolute input line number references.
1102 If the optional argument SILENT is non-nil, never complain
1103 even if history reference seems erroneous.
1105 If the optional argument START is non-nil, that specifies the
1106 start of the text to scan for history references, rather
1107 than the logical beginning of line.
1109 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1111 Returns t if successful."
1112 (interactive)
1113 (if (and comint-input-autoexpand
1114 (if comint-use-prompt-regexp-instead-of-fields
1115 ;; Use comint-prompt-regexp
1116 (save-excursion
1117 (beginning-of-line)
1118 (looking-at (concat comint-prompt-regexp "!\\|\\^")))
1119 ;; Use input fields. User input that hasn't been entered
1120 ;; yet, at the end of the buffer, has a nil `field' property.
1121 (and (null (get-char-property (point) 'field))
1122 (string-match "!\\|^\\^" (field-string)))))
1123 ;; Looks like there might be history references in the command.
1124 (let ((previous-modified-tick (buffer-modified-tick)))
1125 (comint-replace-by-expanded-history-before-point silent start)
1126 (/= previous-modified-tick (buffer-modified-tick)))))
1129 (defun comint-replace-by-expanded-history-before-point (silent &optional start)
1130 "Expand directory stack reference before point.
1131 See `comint-replace-by-expanded-history'. Returns t if successful.
1133 If the optional argument START is non-nil, that specifies the
1134 start of the text to scan for history references, rather
1135 than the logical beginning of line."
1136 (save-excursion
1137 (let ((toend (- (line-end-position) (point)))
1138 (start (comint-line-beginning-position)))
1139 (goto-char start)
1140 (while (progn
1141 (skip-chars-forward "^!^" (- (line-end-position) toend))
1142 (< (point) (- (line-end-position) toend)))
1143 ;; This seems a bit complex. We look for references such as !!, !-num,
1144 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1145 ;; If that wasn't enough, the plings can be suffixed with argument
1146 ;; range specifiers.
1147 ;; Argument ranges are complex too, so we hive off the input line,
1148 ;; referenced with plings, with the range string to `comint-args'.
1149 (setq comint-input-ring-index nil)
1150 (cond ((or (= (preceding-char) ?\\)
1151 (comint-within-quotes start (point)))
1152 ;; The history is quoted, or we're in quotes.
1153 (goto-char (1+ (point))))
1154 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1155 ;; We cannot know the interpreter's idea of input line numbers.
1156 (goto-char (match-end 0))
1157 (message "Absolute reference cannot be expanded"))
1158 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1159 ;; Just a number of args from `number' lines backward.
1160 (let ((number (1- (string-to-number
1161 (buffer-substring (match-beginning 1)
1162 (match-end 1))))))
1163 (if (<= number (ring-length comint-input-ring))
1164 (progn
1165 (replace-match
1166 (comint-args (comint-previous-input-string number)
1167 (match-beginning 2) (match-end 2))
1168 t t)
1169 (setq comint-input-ring-index number)
1170 (message "History item: %d" (1+ number)))
1171 (goto-char (match-end 0))
1172 (message "Relative reference exceeds input history size"))))
1173 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1174 ;; Just a number of args from the previous input line.
1175 (replace-match
1176 (comint-args (comint-previous-input-string 0)
1177 (match-beginning 1) (match-end 1))
1178 t t)
1179 (message "History item: previous"))
1180 ((looking-at
1181 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1182 ;; Most recent input starting with or containing (possibly
1183 ;; protected) string, maybe just a number of args. Phew.
1184 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1185 (mb2 (match-beginning 2)) (me2 (match-end 2))
1186 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1187 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1188 (pos (save-match-data
1189 (comint-previous-matching-input-string-position
1190 (concat pref (regexp-quote exp)) 1))))
1191 (if (null pos)
1192 (progn
1193 (goto-char (match-end 0))
1194 (or silent
1195 (progn (message "Not found")
1196 (ding))))
1197 (setq comint-input-ring-index pos)
1198 (replace-match
1199 (comint-args (ring-ref comint-input-ring pos)
1200 (match-beginning 4) (match-end 4))
1201 t t)
1202 (message "History item: %d" (1+ pos)))))
1203 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1204 ;; Quick substitution on the previous input line.
1205 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1206 (new (buffer-substring (match-beginning 2) (match-end 2)))
1207 (pos nil))
1208 (replace-match (comint-previous-input-string 0) t t)
1209 (setq pos (point))
1210 (goto-char (match-beginning 0))
1211 (if (not (search-forward old pos t))
1212 (or silent
1213 (error "Not found"))
1214 (replace-match new t t)
1215 (message "History item: substituted"))))
1217 (forward-char 1)))))))
1220 (defun comint-magic-space (arg)
1221 "Expand input history references before point and insert ARG spaces.
1222 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1223 (interactive "p")
1224 (comint-replace-by-expanded-history)
1225 (self-insert-command arg))
1227 (defun comint-within-quotes (beg end)
1228 "Return t if the number of quotes between BEG and END is odd.
1229 Quotes are single and double."
1230 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end))
1231 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end)))
1232 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1234 (defun comint-how-many-region (regexp beg end)
1235 "Return number of matches for REGEXP from BEG to END."
1236 (let ((count 0))
1237 (save-excursion
1238 (save-match-data
1239 (goto-char beg)
1240 (while (re-search-forward regexp end t)
1241 (setq count (1+ count)))))
1242 count))
1244 (defun comint-args (string begin end)
1245 ;; From STRING, return the args depending on the range specified in the text
1246 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1247 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1248 (save-match-data
1249 (if (null begin)
1250 (comint-arguments string 0 nil)
1251 (let* ((range (buffer-substring
1252 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1253 (nth (cond ((string-match "^[*^]" range) 1)
1254 ((string-match "^-" range) 0)
1255 ((string-equal range "$") nil)
1256 (t (string-to-number range))))
1257 (mth (cond ((string-match "[-*$]$" range) nil)
1258 ((string-match "-" range)
1259 (string-to-number (substring range (match-end 0))))
1260 (t nth))))
1261 (comint-arguments string nth mth)))))
1263 ;; Return a list of arguments from ARG. Break it up at the
1264 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1265 (defun comint-delim-arg (arg)
1266 (if (null comint-delimiter-argument-list)
1267 (list arg)
1268 (let ((args nil)
1269 (pos 0)
1270 (len (length arg)))
1271 (while (< pos len)
1272 (let ((char (aref arg pos))
1273 (start pos))
1274 (if (memq char comint-delimiter-argument-list)
1275 (while (and (< pos len) (eq (aref arg pos) char))
1276 (setq pos (1+ pos)))
1277 (while (and (< pos len)
1278 (not (memq (aref arg pos)
1279 comint-delimiter-argument-list)))
1280 (setq pos (1+ pos))))
1281 (setq args (cons (substring arg start pos) args))))
1282 args)))
1284 (defun comint-arguments (string nth mth)
1285 "Return from STRING the NTH to MTH arguments.
1286 NTH and/or MTH can be nil, which means the last argument.
1287 Returned arguments are separated by single spaces.
1288 We assume whitespace separates arguments, except within quotes
1289 and except for a space or tab that immediately follows a backslash.
1290 Also, a run of one or more of a single character
1291 in `comint-delimiter-argument-list' is a separate argument.
1292 Argument 0 is the command name."
1293 ;; The first line handles ordinary characters and backslash-sequences
1294 ;; (except with w32 msdos-like shells, where backslashes are valid).
1295 ;; The second matches "-quoted strings.
1296 ;; The third matches '-quoted strings.
1297 ;; The fourth matches `-quoted strings.
1298 ;; This seems to fit the syntax of BASH 2.0.
1299 (let* ((first (if (and (eq system-type 'windows-nt)
1300 (w32-shell-dos-semantics))
1301 "[^ \n\t\"'`]+\\|"
1302 "[^ \n\t\"'`\\]+\\|\\\\[\"'`\\ \t]+\\|"))
1303 (argpart (concat first
1304 "\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\
1305 '[^']*'\\|\
1306 `[^`]*`\\)"))
1307 (args ()) (pos 0)
1308 (count 0)
1309 beg str value quotes)
1310 ;; Build a list of all the args until we have as many as we want.
1311 (while (and (or (null mth) (<= count mth))
1312 (string-match argpart string pos))
1313 (if (and beg (= pos (match-beginning 0)))
1314 ;; It's contiguous, part of the same arg.
1315 (setq pos (match-end 0)
1316 quotes (or quotes (match-beginning 1)))
1317 ;; It's a new separate arg.
1318 (if beg
1319 ;; Put the previous arg, if there was one, onto ARGS.
1320 (setq str (substring string beg pos)
1321 args (if quotes (cons str args)
1322 (nconc (comint-delim-arg str) args))
1323 count (1+ count)))
1324 (setq quotes (match-beginning 1))
1325 (setq beg (match-beginning 0))
1326 (setq pos (match-end 0))))
1327 (if beg
1328 (setq str (substring string beg pos)
1329 args (if quotes (cons str args)
1330 (nconc (comint-delim-arg str) args))
1331 count (1+ count)))
1332 (let ((n (or nth (1- count)))
1333 (m (if mth (1- (- count mth)) 0)))
1334 (mapconcat
1335 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1338 ;; Input processing stuff
1340 (defun comint-add-to-input-history (cmd)
1341 "Add CMD to the input history.
1342 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1343 (if (and (funcall comint-input-filter cmd)
1344 (or (null comint-input-ignoredups)
1345 (not (ring-p comint-input-ring))
1346 (ring-empty-p comint-input-ring)
1347 (not (string-equal (ring-ref comint-input-ring 0)
1348 cmd))))
1349 (ring-insert comint-input-ring cmd)))
1351 (defun comint-send-input ()
1352 "Send input to process.
1353 After the process output mark, sends all text from the process mark to
1354 point as input to the process. Before the process output mark, calls value
1355 of variable `comint-get-old-input' to retrieve old input, copies it to the
1356 process mark, and sends it. If variable `comint-process-echoes' is nil,
1357 a terminal newline is also inserted into the buffer and sent to the process
1358 \(if it is non-nil, all text from the process mark to point is deleted,
1359 since it is assumed the remote process will re-echo it).
1361 Any history reference may be expanded depending on the value of the variable
1362 `comint-input-autoexpand'. The list of function names contained in the value
1363 of `comint-input-filter-functions' is called on the input before sending it.
1364 The input is entered into the input history ring, if the value of variable
1365 `comint-input-filter' returns non-nil when called on the input.
1367 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1368 end of line before sending the input.
1370 The values of `comint-get-old-input', `comint-input-filter-functions', and
1371 `comint-input-filter' are chosen according to the command interpreter running
1372 in the buffer. E.g.,
1374 If the interpreter is the csh,
1375 comint-get-old-input is the default: either return the current
1376 field, or take the current line and discard any
1377 initial string matching regexp `comint-prompt-regexp', depending
1378 on the value of `comint-use-prompt-regexp-instead-of-fields'.
1379 comint-input-filter-functions monitors input for \"cd\", \"pushd\", and
1380 \"popd\" commands. When it sees one, it cd's the buffer.
1381 comint-input-filter is the default: returns t if the input isn't all white
1382 space.
1384 If the comint is Lucid Common Lisp,
1385 comint-get-old-input snarfs the sexp ending at point.
1386 comint-input-filter-functions does nothing.
1387 comint-input-filter returns nil if the input matches input-filter-regexp,
1388 which matches (1) all whitespace (2) :a, :c, etc.
1390 Similarly for Soar, Scheme, etc."
1391 (interactive)
1392 ;; Note that the input string does not include its terminal newline.
1393 (let ((proc (get-buffer-process (current-buffer))))
1394 (if (not proc) (error "Current buffer has no process")
1395 (let* ((pmark (process-mark proc))
1396 (intxt (if (>= (point) (marker-position pmark))
1397 (progn (if comint-eol-on-send (end-of-line))
1398 (buffer-substring pmark (point)))
1399 (let ((copy (funcall comint-get-old-input)))
1400 (goto-char pmark)
1401 (insert copy)
1402 copy)))
1403 (input (if (not (eq comint-input-autoexpand 'input))
1404 ;; Just whatever's already there
1405 intxt
1406 ;; Expand and leave it visible in buffer
1407 (comint-replace-by-expanded-history t pmark)
1408 (buffer-substring pmark (point))))
1409 (history (if (not (eq comint-input-autoexpand 'history))
1410 input
1411 ;; This is messy 'cos ultimately the original
1412 ;; functions used do insertion, rather than return
1413 ;; strings. We have to expand, then insert back.
1414 (comint-replace-by-expanded-history t pmark)
1415 (let ((copy (buffer-substring pmark (point)))
1416 (start (point)))
1417 (insert input)
1418 (delete-region pmark start)
1419 copy))))
1421 (if comint-process-echoes
1422 (delete-region pmark (point))
1423 (insert ?\n))
1425 (comint-add-to-input-history history)
1427 (run-hook-with-args 'comint-input-filter-functions
1428 (concat input "\n"))
1430 (let ((beg (marker-position pmark))
1431 (end (1- (point))))
1432 (when (not (> beg end)) ; handle a special case
1433 ;; Make an overlay for the input field
1434 (let ((over (make-overlay beg end nil nil t)))
1435 (unless comint-use-prompt-regexp-instead-of-fields
1436 ;; Give old user input a field property of `input', to
1437 ;; distinguish it from both process output and unsent
1438 ;; input. The terminating newline is put into a special
1439 ;; `boundary' field to make cursor movement between input
1440 ;; and output fields smoother.
1441 (overlay-put over 'field 'input))
1442 (when comint-highlight-input
1443 (overlay-put over 'face 'comint-highlight-input)
1444 (overlay-put over 'mouse-face 'highlight)
1445 (overlay-put over 'evaporate t))))
1446 (unless comint-use-prompt-regexp-instead-of-fields
1447 ;; Make an overlay for the terminating newline
1448 (let ((over (make-overlay end (1+ end) nil t nil)))
1449 (overlay-put over 'field 'boundary)
1450 (overlay-put over 'evaporate t))))
1452 (comint-snapshot-last-prompt)
1454 (setq comint-save-input-ring-index comint-input-ring-index)
1455 (setq comint-input-ring-index nil)
1456 ;; Update the markers before we send the input
1457 ;; in case we get output amidst sending the input.
1458 (set-marker comint-last-input-start pmark)
1459 (set-marker comint-last-input-end (point))
1460 (set-marker (process-mark proc) (point))
1461 ;; clear the "accumulation" marker
1462 (set-marker comint-accum-marker nil)
1463 (funcall comint-input-sender proc input)
1464 ;; This used to call comint-output-filter-functions,
1465 ;; but that scrolled the buffer in undesirable ways.
1466 (run-hook-with-args 'comint-output-filter-functions "")))))
1468 (defvar comint-preoutput-filter-functions nil
1469 "List of functions to call before inserting Comint output into the buffer.
1470 Each function gets one argument, a string containing the text received
1471 from the subprocess. It should return the string to insert, perhaps
1472 the same string that was received, or perhaps a modified or transformed
1473 string.
1475 The functions on the list are called sequentially, and each one is
1476 given the string returned by the previous one. The string returned by
1477 the last function is the text that is actually inserted in the
1478 redirection buffer.
1480 This variable is permanent-local.")
1482 ;; When non-nil, this is the last overlay used for output.
1483 ;; It is kept around so that we can extend it instead of creating
1484 ;; multiple contiguous overlays for multiple contiguous output chunks.
1485 (defvar comint-last-output-overlay nil)
1487 ;; When non-nil, this is an overlay over the last recognized prompt in
1488 ;; the buffer; it is used when highlighting the prompt.
1489 (defvar comint-last-prompt-overlay nil)
1491 ;; `snapshot' any current comint-last-prompt-overlay, freezing it in place.
1492 ;; Any further output will then create a new comint-last-prompt-overlay.
1493 (defun comint-snapshot-last-prompt ()
1494 (when comint-last-prompt-overlay
1495 (overlay-put comint-last-prompt-overlay 'evaporate t)
1496 (setq comint-last-prompt-overlay nil)))
1498 ;; The purpose of using this filter for comint processes
1499 ;; is to keep comint-last-input-end from moving forward
1500 ;; when output is inserted.
1501 (defun comint-output-filter (process string)
1502 (let ((oprocbuf (process-buffer process)))
1503 ;; First check for killed buffer or no input.
1504 (when (and string oprocbuf (buffer-name oprocbuf))
1505 (with-current-buffer oprocbuf
1506 ;; Run preoutput filters
1507 (let ((functions comint-preoutput-filter-functions))
1508 (while (and functions string)
1509 (setq string (funcall (car functions) string))
1510 (setq functions (cdr functions))))
1512 ;; Insert STRING
1513 (let ((buffer-read-only nil)
1514 ;; Avoid the overhead of save-excursion, since we just
1515 ;; fiddle with the point
1516 (saved-point (point-marker)))
1518 ;; The point should float after any insertion we do
1519 (set-marker-insertion-type saved-point t)
1521 ;; We temporarly remove any buffer narrowing, in case the
1522 ;; process mark is outside of the restriction
1523 (save-restriction
1524 (widen)
1526 (goto-char (process-mark process))
1527 (set-marker comint-last-output-start (point))
1529 ;; insert-before-markers is a bad thing. XXX
1531 ;; It is used here to force window-point markers (used to
1532 ;; store the value of point in non-selected windows) to
1533 ;; advance, but it also screws up any other markers that we
1534 ;; don't _want_ to advance, such as the start-marker of some
1535 ;; of the overlays we create.
1537 ;; We work around the problem with the overlays by
1538 ;; explicitly adjusting them after we do the insertion, but
1539 ;; in the future this problem should be solved correctly, by
1540 ;; using `insert', and making the insertion-type of
1541 ;; window-point markers settable (via a buffer-local
1542 ;; variable). In comint buffers, this variable would be set
1543 ;; to `t', to cause point in non-select windows to advance.
1544 (insert-before-markers string)
1545 ;; Fixup markers and overlays that got screwed up because we
1546 ;; used `insert-before-markers'.
1547 (let ((old-point (- (point) (length string))))
1548 ;; comint-last-output-start
1549 (set-marker comint-last-output-start old-point)
1550 ;; comint-last-input-end
1551 (when (and comint-last-input-end
1552 (equal (marker-position comint-last-input-end)
1553 (point)))
1554 (set-marker comint-last-input-end old-point))
1555 ;; No overlays we create are set to advance upon insertion
1556 ;; (at the start/end), so we assume that any overlay which
1557 ;; is at the current point was incorrectly advanced by
1558 ;; insert-before-markers. First fixup overlays that might
1559 ;; start at point:
1560 (dolist (over (overlays-at (point)))
1561 (when (= (overlay-start over) (point))
1562 (let ((end (overlay-end over)))
1563 (move-overlay over
1564 old-point
1565 (if (= end (point)) old-point end)))))
1566 ;; Then do overlays that might end at point:
1567 (dolist (over (overlays-at (1- (point))))
1568 (when (= (overlay-end over) (point))
1569 (move-overlay over
1570 (min (overlay-start over) old-point)
1571 old-point))))
1573 ;; Advance process-mark
1574 (set-marker (process-mark process) (point))
1576 (unless comint-use-prompt-regexp-instead-of-fields
1577 ;; We check to see if the last overlay used for output is
1578 ;; adjacent to the new input, and if so, just extend it.
1579 (if (and comint-last-output-overlay
1580 (equal (overlay-end comint-last-output-overlay)
1581 (marker-position comint-last-output-start)))
1582 ;; Extend comint-last-output-overlay to include the
1583 ;; most recent output
1584 (move-overlay comint-last-output-overlay
1585 (overlay-start comint-last-output-overlay)
1586 (point))
1587 ;; Create a new overlay
1588 (let ((over (make-overlay comint-last-output-start (point))))
1589 (overlay-put over 'field 'output)
1590 (overlay-put over 'inhibit-line-move-field-capture t)
1591 (overlay-put over 'evaporate t)
1592 (setq comint-last-output-overlay over))))
1594 (when comint-highlight-prompt
1595 ;; Highlight the prompt, where we define `prompt' to mean
1596 ;; the most recent output that doesn't end with a newline.
1597 (unless (and (bolp) (null comint-last-prompt-overlay))
1598 ;; Need to create or move the prompt overlay (in the case
1599 ;; where there is no prompt ((bolp) == t), we still do
1600 ;; this if there's already an existing overlay).
1601 (let ((prompt-start (save-excursion (forward-line 0) (point))))
1602 (if comint-last-prompt-overlay
1603 ;; Just move an existing overlay
1604 (move-overlay comint-last-prompt-overlay
1605 prompt-start (point))
1606 ;; Need to create the overlay
1607 (setq comint-last-prompt-overlay
1608 (make-overlay prompt-start (point)))
1609 (overlay-put comint-last-prompt-overlay
1610 'face 'comint-highlight-prompt)))))
1612 (goto-char saved-point)
1614 (run-hook-with-args 'comint-output-filter-functions string)))))))
1616 (defun comint-preinput-scroll-to-bottom ()
1617 "Go to the end of buffer in all windows showing it.
1618 Movement occurs if point in the selected window is not after the process mark,
1619 and `this-command' is an insertion command. Insertion commands recognised
1620 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1621 Depends on the value of `comint-scroll-to-bottom-on-input'.
1623 This function should be a pre-command hook."
1624 (if (and comint-scroll-to-bottom-on-input
1625 (memq this-command '(self-insert-command comint-magic-space yank
1626 hilit-yank)))
1627 (let* ((selected (selected-window))
1628 (current (current-buffer))
1629 (process (get-buffer-process current))
1630 (scroll comint-scroll-to-bottom-on-input))
1631 (if (and process (< (point) (process-mark process)))
1632 (if (eq scroll 'this)
1633 (goto-char (point-max))
1634 (walk-windows
1635 (function (lambda (window)
1636 (if (and (eq (window-buffer window) current)
1637 (or (eq scroll t) (eq scroll 'all)))
1638 (progn
1639 (select-window window)
1640 (goto-char (point-max))
1641 (select-window selected)))))
1642 nil t))))))
1644 (defun comint-postoutput-scroll-to-bottom (string)
1645 "Go to the end of buffer in all windows showing it.
1646 Does not scroll if the current line is the last line in the buffer.
1647 Depends on the value of `comint-scroll-to-bottom-on-output' and
1648 `comint-scroll-show-maximum-output'.
1650 This function should be in the list `comint-output-filter-functions'."
1651 (let* ((selected (selected-window))
1652 (current (current-buffer))
1653 (process (get-buffer-process current))
1654 (scroll comint-scroll-to-bottom-on-output))
1655 (unwind-protect
1656 (if process
1657 (walk-windows
1658 (function (lambda (window)
1659 (if (eq (window-buffer window) current)
1660 (progn
1661 (select-window window)
1662 (if (and (< (point) (process-mark process))
1663 (or (eq scroll t) (eq scroll 'all)
1664 ;; Maybe user wants point to jump to end.
1665 (and (eq scroll 'this) (eq selected window))
1666 (and (eq scroll 'others) (not (eq selected window)))
1667 ;; If point was at the end, keep it at end.
1668 (and (marker-position comint-last-output-start)
1669 (>= (point) comint-last-output-start))))
1670 (goto-char (process-mark process)))
1671 ;; Optionally scroll so that the text
1672 ;; ends at the bottom of the window.
1673 (if (and comint-scroll-show-maximum-output
1674 (>= (point) (process-mark process)))
1675 (save-excursion
1676 (goto-char (point-max))
1677 (recenter -1)))
1678 (select-window selected)))))
1679 nil t))
1680 (set-buffer current))))
1682 (defun comint-truncate-buffer (&optional string)
1683 "Truncate the buffer to `comint-buffer-maximum-size'.
1684 This function could be on `comint-output-filter-functions' or bound to a key."
1685 (interactive)
1686 (save-excursion
1687 (goto-char (process-mark (get-buffer-process (current-buffer))))
1688 (forward-line (- comint-buffer-maximum-size))
1689 (beginning-of-line)
1690 (delete-region (point-min) (point))))
1692 (defun comint-strip-ctrl-m (&optional string)
1693 "Strip trailing `^M' characters from the current output group.
1694 This function could be on `comint-output-filter-functions' or bound to a key."
1695 (interactive)
1696 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1697 (save-excursion
1698 (condition-case nil
1699 (goto-char
1700 (if (interactive-p) comint-last-input-end comint-last-output-start))
1701 (error nil))
1702 (while (re-search-forward "\r+$" pmark t)
1703 (replace-match "" t t)))))
1704 (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
1706 (defun comint-show-maximum-output ()
1707 "Put the end of the buffer at the bottom of the window."
1708 (interactive)
1709 (goto-char (point-max))
1710 (recenter -1))
1712 (defun comint-get-old-input-default ()
1713 "Default for `comint-get-old-input'.
1714 Returns either the current field, or the current line with any initial
1715 text matching `comint-prompt-regexp' stripped off, depending on the
1716 value of `comint-use-prompt-regexp-instead-of-fields'."
1717 (if comint-use-prompt-regexp-instead-of-fields
1718 (save-excursion
1719 (beginning-of-line)
1720 (comint-skip-prompt)
1721 (let ((beg (point)))
1722 (end-of-line)
1723 (buffer-substring beg (point))))
1724 ;; Return the contents of the field at the current point.
1725 (let ((pos (field-beginning (point))))
1726 (unless (eq (get-char-property pos 'field) 'input)
1727 (error "Not an input field"))
1728 (field-string pos))))
1730 (defun comint-copy-old-input ()
1731 "Insert after prompt old input at point as new input to be edited.
1732 Calls `comint-get-old-input' to get old input."
1733 (interactive)
1734 (let ((input (funcall comint-get-old-input))
1735 (process (get-buffer-process (current-buffer))))
1736 (if (not process)
1737 (error "Current buffer has no process")
1738 (goto-char (process-mark process))
1739 (insert input))))
1741 (defun comint-skip-prompt ()
1742 "Skip past the text matching regexp `comint-prompt-regexp'.
1743 If this takes us past the end of the current line, don't skip at all."
1744 (let ((eol (save-excursion (end-of-line) (point))))
1745 (if (and (looking-at comint-prompt-regexp)
1746 (<= (match-end 0) eol))
1747 (goto-char (match-end 0)))))
1749 (defun comint-after-pmark-p ()
1750 "Return t if point is after the process output marker."
1751 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1752 (<= (marker-position pmark) (point))))
1754 (defun comint-simple-send (proc string)
1755 "Default function for sending to PROC input STRING.
1756 This just sends STRING plus a newline. To override this,
1757 set the hook `comint-input-sender'."
1758 (comint-send-string proc string)
1759 (comint-send-string proc "\n"))
1761 (defun comint-line-beginning-position ()
1762 "Returns the buffer position of the beginning of the line, after any prompt.
1763 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1764 prompt skip is done by skipping text matching the regular expression
1765 `comint-prompt-regexp', a buffer local variable."
1766 (if comint-use-prompt-regexp-instead-of-fields
1767 ;; Use comint-prompt-regexp
1768 (save-excursion
1769 (beginning-of-line)
1770 (comint-skip-prompt)
1771 (point))
1772 ;; Use input fields. Note that, unlike the behavior of
1773 ;; `line-beginning-position' inside a field, this function will
1774 ;; return the position of the end of a prompt, even if the point is
1775 ;; already inside the prompt. In order to do this, it assumes that
1776 ;; if there are two fields on a line, then the first one is the
1777 ;; prompt, and the second one is an input field, and is front-sticky
1778 ;; (as input fields should be).
1779 (constrain-to-field (line-beginning-position) (line-end-position))))
1781 (defun comint-bol (&optional arg)
1782 "Goes to the beginning of line, then skips past the prompt, if any.
1783 If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
1784 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1785 prompt skip is done by skipping text matching the regular expression
1786 `comint-prompt-regexp', a buffer local variable."
1787 (interactive "P")
1788 (if arg
1789 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1790 (forward-line 0)
1791 (goto-char (comint-line-beginning-position))))
1793 ;; These three functions are for entering text you don't want echoed or
1794 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1795 ;; Just enter m-x send-invisible and type in your line, or add
1796 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1798 (defun comint-read-noecho (prompt &optional stars)
1799 "Read a single line of text from user without echoing, and return it.
1800 Prompt with argument PROMPT, a string. Optional argument STARS causes
1801 input to be echoed with '*' characters on the prompt line. Input ends with
1802 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1803 `inhibit-quit' is set because e.g. this function was called from a process
1804 filter and C-g is pressed, this function returns nil rather than a string).
1806 Note that the keystrokes comprising the text can still be recovered
1807 \(temporarily) with \\[view-lossage]. Some people find this worrysome.
1808 Once the caller uses the password, it can erase the password
1809 by doing (fillarray STRING 0)."
1810 (let ((ans "")
1811 (newans nil)
1812 (c 0)
1813 (echo-keystrokes 0)
1814 (cursor-in-echo-area t)
1815 (message-log-max nil)
1816 (done nil))
1817 (while (not done)
1818 (if stars
1819 (message "%s%s" prompt (make-string (length ans) ?*))
1820 (message "%s" prompt))
1821 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1822 (setq c (read-char-exclusive))
1823 (cond ((= c ?\C-g)
1824 ;; This function may get called from a process filter, where
1825 ;; inhibit-quit is set. In later versions of emacs read-char
1826 ;; may clear quit-flag itself and return C-g. That would make
1827 ;; it impossible to quit this loop in a simple way, so
1828 ;; re-enable it here (for backward-compatibility the check for
1829 ;; quit-flag below would still be necessary, so this seems
1830 ;; like the simplest way to do things).
1831 (setq quit-flag t
1832 done t))
1833 ((or (= c ?\r) (= c ?\n) (= c ?\e))
1834 (setq done t))
1835 ((= c ?\C-u)
1836 (fillarray ans 0)
1837 (setq ans ""))
1838 ((and (/= c ?\b) (/= c ?\177))
1839 (setq newans (concat ans (char-to-string c)))
1840 (fillarray ans 0)
1841 (setq ans newans))
1842 ((> (length ans) 0)
1843 (aset ans (1- (length ans)) 0)
1844 (setq ans (substring ans 0 -1)))))
1845 (if quit-flag
1846 ;; Emulate a true quit, except that we have to return a value.
1847 (prog1
1848 (setq quit-flag nil)
1849 (message "Quit")
1850 (beep t))
1851 (message "")
1852 ans)))
1854 (defun send-invisible (str)
1855 "Read a string without echoing.
1856 Then send it to the process running in the current buffer.
1857 The string is sent using `comint-input-sender'.
1858 Security bug: your string can still be temporarily recovered with
1859 \\[view-lossage]."
1860 (interactive "P") ; Defeat snooping via C-x ESC ESC
1861 (let ((proc (get-buffer-process (current-buffer))))
1862 (cond ((not proc)
1863 (error "Current buffer has no process"))
1864 ((stringp str)
1865 (comint-snapshot-last-prompt)
1866 (funcall comint-input-sender proc str))
1868 (let ((str (comint-read-noecho "Non-echoed text: " t)))
1869 (if (stringp str)
1870 (send-invisible str)
1871 (message "Warning: text will be echoed")))))))
1873 (defun comint-watch-for-password-prompt (string)
1874 "Prompt in the minibuffer for password and send without echoing.
1875 This function uses `send-invisible' to read and send a password to the buffer's
1876 process if STRING contains a password prompt defined by
1877 `comint-password-prompt-regexp'.
1879 This function could be in the list `comint-output-filter-functions'."
1880 (when (string-match comint-password-prompt-regexp string)
1881 (let ((pw (comint-read-noecho string t)))
1882 (send-invisible pw))))
1884 ;; Low-level process communication
1886 (defun comint-send-string (process string)
1887 "Like `process-send-string', but also does extra bookkeeping for comint mode."
1888 (if process
1889 (with-current-buffer (if (processp process)
1890 (process-buffer process)
1891 (get-buffer process))
1892 (comint-snapshot-last-prompt))
1893 (comint-snapshot-last-prompt))
1894 (process-send-string process string))
1896 (defun comint-send-region (process start end)
1897 "Like `process-send-region', but also does extra bookkeeping for comint mode."
1898 (if process
1899 (with-current-buffer (if (processp process)
1900 (process-buffer process)
1901 (get-buffer process))
1902 (comint-snapshot-last-prompt))
1903 (comint-snapshot-last-prompt))
1904 (process-send-region process start end))
1906 ;; Random input hackage
1908 (defun comint-delete-output ()
1909 "Delete all output from interpreter since last input.
1910 Does not delete the prompt."
1911 (interactive)
1912 (let ((proc (get-buffer-process (current-buffer)))
1913 (replacement nil))
1914 (save-excursion
1915 (let ((pmark (progn (goto-char (process-mark proc))
1916 (forward-line 0)
1917 (point-marker))))
1918 (delete-region comint-last-input-end pmark)
1919 (goto-char (process-mark proc))
1920 (setq replacement (concat "*** output flushed ***\n"
1921 (buffer-substring pmark (point))))
1922 (delete-region pmark (point))))
1923 ;; Output message and put back prompt
1924 (comint-output-filter proc replacement)))
1925 (defalias 'comint-kill-output 'comint-delete-output)
1926 (make-obsolete 'comint-kill-output 'comint-delete-output "21.1")
1928 (defun comint-write-output (filename &optional append mustbenew)
1929 "Write output from interpreter since last input to FILENAME.
1930 Any prompt at the end of the output is not written.
1932 If the optional argument APPEND (the prefix argument when interactive)
1933 is non-nil, the output is appended to the file instead.
1935 If the optional argument MUSTBENEW is non-nil, check for an existing
1936 file with the same name. If MUSTBENEW is `excl', that means to get an
1937 error if the file already exists; never overwrite. If MUSTBENEW is
1938 neither nil nor `excl', that means ask for confirmation before
1939 overwriting, but do go ahead and overwrite the file if the user
1940 confirms. When interactive, MUSTBENEW is nil when appending, and t
1941 otherwise."
1942 (interactive
1943 (list (read-file-name
1944 (if current-prefix-arg
1945 "Append output to file: "
1946 "Write output to file: "))
1947 current-prefix-arg
1948 (not current-prefix-arg)))
1949 (save-excursion
1950 (goto-char (process-mark (get-buffer-process (current-buffer))))
1951 (forward-line 0)
1952 (write-region comint-last-input-end (point) filename
1953 append nil nil mustbenew)))
1955 ;; This function exists for the benefit of the menu; from the keyboard,
1956 ;; users can just use `comint-write-output' with a prefix arg.
1957 (defun comint-append-output-to-file (filename)
1958 "Append output from interpreter since last input to FILENAME.
1959 Any prompt at the end of the output is not written."
1960 (interactive "fAppend output to file: ")
1961 (comint-write-output filename t))
1963 (defun comint-show-output ()
1964 "Display start of this batch of interpreter output at top of window.
1965 Sets mark to the value of point when this command is run."
1966 (interactive)
1967 (push-mark)
1968 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
1969 (cond (comint-use-prompt-regexp-instead-of-fields
1970 (goto-char pos)
1971 (beginning-of-line 0)
1972 (set-window-start (selected-window) (point))
1973 (comint-skip-prompt))
1975 (goto-char (field-beginning pos))
1976 (set-window-start (selected-window) (point))))))
1979 (defun comint-interrupt-subjob ()
1980 "Interrupt the current subjob.
1981 This command also kills the pending input
1982 between the process-mark and point."
1983 (interactive)
1984 (comint-kill-input)
1985 (interrupt-process nil comint-ptyp))
1987 (defun comint-kill-subjob ()
1988 "Send kill signal to the current subjob.
1989 This command also kills the pending input
1990 between the process-mark and point."
1991 (interactive)
1992 (comint-kill-input)
1993 (kill-process nil comint-ptyp))
1995 (defun comint-quit-subjob ()
1996 "Send quit signal to the current subjob.
1997 This command also kills the pending input
1998 between the process-mark and point."
1999 (interactive)
2000 (comint-kill-input)
2001 (quit-process nil comint-ptyp))
2003 (defun comint-stop-subjob ()
2004 "Stop the current subjob.
2005 This command also kills the pending input
2006 between the process-mark and point.
2008 WARNING: if there is no current subjob, you can end up suspending
2009 the top-level process running in the buffer. If you accidentally do
2010 this, use \\[comint-continue-subjob] to resume the process. (This
2011 is not a problem with most shells, since they ignore this signal.)"
2012 (interactive)
2013 (comint-kill-input)
2014 (stop-process nil comint-ptyp))
2016 (defun comint-continue-subjob ()
2017 "Send CONT signal to process buffer's process group.
2018 Useful if you accidentally suspend the top-level process."
2019 (interactive)
2020 (continue-process nil comint-ptyp))
2022 (defun comint-kill-input ()
2023 "Kill all text from last stuff output by interpreter to point."
2024 (interactive)
2025 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2026 (if (> (point) (marker-position pmark))
2027 (kill-region pmark (point)))))
2029 (defun comint-delchar-or-maybe-eof (arg)
2030 "Delete ARG characters forward or send an EOF to subprocess.
2031 Sends an EOF only if point is at the end of the buffer and there is no input."
2032 (interactive "p")
2033 (let ((proc (get-buffer-process (current-buffer))))
2034 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
2035 (comint-send-eof)
2036 (delete-char arg))))
2038 (defun comint-send-eof ()
2039 "Send an EOF to the current buffer's process."
2040 (interactive)
2041 (comint-snapshot-last-prompt)
2042 (process-send-eof))
2045 (defun comint-backward-matching-input (regexp arg)
2046 "Search backward through buffer for input fields that match REGEXP.
2047 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2048 fields are identified by lines that match `comint-prompt-regexp'.
2050 With prefix argument N, search for Nth previous match.
2051 If N is negative, find the next or Nth next match."
2052 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2053 (if comint-use-prompt-regexp-instead-of-fields
2054 ;; Use comint-prompt-regexp
2055 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2056 (pos (save-excursion (end-of-line (if (> arg 0) 0 1))
2057 (if (re-search-backward re nil t arg)
2058 (point)))))
2059 (if (null pos)
2060 (progn (message "Not found")
2061 (ding))
2062 (goto-char pos)
2063 (comint-bol nil)))
2064 ;; Use input fields
2065 (let* ((dir (if (< arg 0) -1 1))
2066 (pos
2067 (save-excursion
2068 (while (/= arg 0)
2069 (unless (re-search-backward regexp nil t dir)
2070 (error "Not found"))
2071 (when (eq (get-char-property (point) 'field) 'input)
2072 (setq arg (- arg dir))))
2073 (field-beginning))))
2074 (goto-char pos))))
2077 (defun comint-forward-matching-input (regexp arg)
2078 "Search forward through buffer for input fields that match REGEXP.
2079 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2080 fields are identified by lines that match `comint-prompt-regexp'.
2082 With prefix argument N, search for Nth following match.
2083 If N is negative, find the previous or Nth previous match."
2084 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2085 (comint-backward-matching-input regexp (- arg)))
2088 (defun comint-next-prompt (n)
2089 "Move to end of Nth next prompt in the buffer.
2090 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2091 the beginning of the Nth next `input' field, otherwise, it means the Nth
2092 occurance of text matching `comint-prompt-regexp'."
2093 (interactive "p")
2094 (if comint-use-prompt-regexp-instead-of-fields
2095 ;; Use comint-prompt-regexp
2096 (let ((paragraph-start comint-prompt-regexp))
2097 (end-of-line (if (> n 0) 1 0))
2098 (forward-paragraph n)
2099 (comint-skip-prompt))
2100 ;; Use input fields
2101 (let ((pos (point))
2102 (input-pos nil))
2103 (while (/= n 0)
2104 (setq pos
2105 (if (> n 0)
2106 (next-single-char-property-change pos 'field)
2107 (previous-single-char-property-change pos 'field)))
2108 (cond ((null pos)
2109 ;; Ran off the end of the buffer.
2110 (setq n 0))
2111 ((eq (get-char-property pos 'field) 'input)
2112 (setq n (if (< n 0) (1+ n) (1- n)))
2113 (setq input-pos pos))))
2114 (when input-pos
2115 (goto-char input-pos)))))
2118 (defun comint-previous-prompt (n)
2119 "Move to end of Nth previous prompt in the buffer.
2120 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2121 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2122 occurance of text matching `comint-prompt-regexp'."
2123 (interactive "p")
2124 (comint-next-prompt (- n)))
2126 ;; Support for source-file processing commands.
2127 ;;============================================================================
2128 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2129 ;; commands that process files of source text (e.g. loading or compiling
2130 ;; files). So the corresponding process-in-a-buffer modes have commands
2131 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2132 ;; for defining these commands.
2134 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2135 ;; and Soar, in that they don't know anything about file extensions.
2136 ;; So the compile/load interface gets the wrong default occasionally.
2137 ;; The load-file/compile-file default mechanism could be smarter -- it
2138 ;; doesn't know about the relationship between filename extensions and
2139 ;; whether the file is source or executable. If you compile foo.lisp
2140 ;; with compile-file, then the next load-file should use foo.bin for
2141 ;; the default, not foo.lisp. This is tricky to do right, particularly
2142 ;; because the extension for executable files varies so much (.o, .bin,
2143 ;; .lbin, .mo, .vo, .ao, ...).
2146 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2147 ;; commands.
2149 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2150 ;; want to save the buffer before issuing any process requests to the command
2151 ;; interpreter.
2153 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2154 ;; for the file to process.
2156 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2157 ;;============================================================================
2158 ;; This function computes the defaults for the load-file and compile-file
2159 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2161 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2162 ;; source-file processing command. NIL if there hasn't been one yet.
2163 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2164 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2165 ;; Typically, (lisp-mode) or (scheme-mode).
2167 ;; If the command is given while the cursor is inside a string, *and*
2168 ;; the string is an existing filename, *and* the filename is not a directory,
2169 ;; then the string is taken as default. This allows you to just position
2170 ;; your cursor over a string that's a filename and have it taken as default.
2172 ;; If the command is given in a file buffer whose major mode is in
2173 ;; SOURCE-MODES, then the the filename is the default file, and the
2174 ;; file's directory is the default directory.
2176 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2177 ;; then the default directory & file are what was used in the last source-file
2178 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2179 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2180 ;; is the cwd, with no default file. (\"no default file\" = nil)
2182 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2183 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2184 ;; for Soar programs, etc.
2186 ;; The function returns a pair: (default-directory . default-file).
2188 (defun comint-source-default (previous-dir/file source-modes)
2189 (cond ((and buffer-file-name (memq major-mode source-modes))
2190 (cons (file-name-directory buffer-file-name)
2191 (file-name-nondirectory buffer-file-name)))
2192 (previous-dir/file)
2194 (cons default-directory nil))))
2197 ;; (COMINT-CHECK-SOURCE fname)
2198 ;;============================================================================
2199 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2200 ;; process-in-a-buffer modes), this function can be called on the filename.
2201 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2202 ;; is queried to see if he wants to save the buffer before proceeding with
2203 ;; the load or compile.
2205 (defun comint-check-source (fname)
2206 (let ((buff (get-file-buffer fname)))
2207 (if (and buff
2208 (buffer-modified-p buff)
2209 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
2210 ;; save BUFF.
2211 (let ((old-buffer (current-buffer)))
2212 (set-buffer buff)
2213 (save-buffer)
2214 (set-buffer old-buffer)))))
2217 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2218 ;;============================================================================
2219 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2220 ;; commands that process source files (like loading or compiling a file).
2221 ;; It prompts for the filename, provides a default, if there is one,
2222 ;; and returns the result filename.
2224 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
2226 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2227 ;; from the last source processing command. SOURCE-MODES is a list of major
2228 ;; modes used to determine what file buffers contain source files. (These
2229 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2230 ;; then the filename reader will only accept a file that exists.
2232 ;; A typical use:
2233 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2234 ;; '(lisp-mode) t))
2236 ;; This is pretty stupid about strings. It decides we're in a string
2237 ;; if there's a quote on both sides of point on the current line.
2238 (defun comint-extract-string ()
2239 "Return string around POINT that starts the current line, or nil."
2240 (save-excursion
2241 (let* ((point (point))
2242 (bol (progn (beginning-of-line) (point)))
2243 (eol (progn (end-of-line) (point)))
2244 (start (progn (goto-char point)
2245 (and (search-backward "\"" bol t)
2246 (1+ (point)))))
2247 (end (progn (goto-char point)
2248 (and (search-forward "\"" eol t)
2249 (1- (point))))))
2250 (and start end
2251 (buffer-substring start end)))))
2253 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2254 (let* ((def (comint-source-default prev-dir/file source-modes))
2255 (stringfile (comint-extract-string))
2256 (sfile-p (and stringfile
2257 (condition-case ()
2258 (file-exists-p stringfile)
2259 (error nil))
2260 (not (file-directory-p stringfile))))
2261 (defdir (if sfile-p (file-name-directory stringfile)
2262 (car def)))
2263 (deffile (if sfile-p (file-name-nondirectory stringfile)
2264 (cdr def)))
2265 (ans (read-file-name (if deffile (format "%s(default %s) "
2266 prompt deffile)
2267 prompt)
2268 defdir
2269 (concat defdir deffile)
2270 mustmatch-p)))
2271 (list (expand-file-name (substitute-in-file-name ans)))))
2273 ;; I am somewhat divided on this string-default feature. It seems
2274 ;; to violate the principle-of-least-astonishment, in that it makes
2275 ;; the default harder to predict, so you actually have to look and see
2276 ;; what the default really is before choosing it. This can trip you up.
2277 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2278 ;; on this.
2279 ;; -Olin
2282 ;; Simple process query facility.
2283 ;; ===========================================================================
2284 ;; This function is for commands that want to send a query to the process
2285 ;; and show the response to the user. For example, a command to get the
2286 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2287 ;; to an inferior Common Lisp process.
2289 ;; This simple facility just sends strings to the inferior process and pops
2290 ;; up a window for the process buffer so you can see what the process
2291 ;; responds with. We don't do anything fancy like try to intercept what the
2292 ;; process responds with and put it in a pop-up window or on the message
2293 ;; line. We just display the buffer. Low tech. Simple. Works good.
2295 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2296 ;; a window for the inferior process so that its response can be seen.
2297 (defun comint-proc-query (proc str)
2298 (let* ((proc-buf (process-buffer proc))
2299 (proc-mark (process-mark proc)))
2300 (display-buffer proc-buf)
2301 (set-buffer proc-buf) ; but it's not the selected *window*
2302 (let ((proc-win (get-buffer-window proc-buf))
2303 (proc-pt (marker-position proc-mark)))
2304 (comint-send-string proc str) ; send the query
2305 (accept-process-output proc) ; wait for some output
2306 ;; Try to position the proc window so you can see the answer.
2307 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2308 ;; I don't know why. Wizards invited to improve it.
2309 (unless (pos-visible-in-window-p proc-pt proc-win)
2310 (let ((opoint (window-point proc-win)))
2311 (set-window-point proc-win proc-mark)
2312 (sit-for 0)
2313 (if (not (pos-visible-in-window-p opoint proc-win))
2314 (push-mark opoint)
2315 (set-window-point proc-win opoint)))))))
2318 ;; Filename/command/history completion in a buffer
2319 ;; ===========================================================================
2320 ;; Useful completion functions, courtesy of the Ergo group.
2322 ;; Six commands:
2323 ;; comint-dynamic-complete Complete or expand command, filename,
2324 ;; history at point.
2325 ;; comint-dynamic-complete-filename Complete filename at point.
2326 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2327 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2328 ;; replace with expanded/completed name.
2329 ;; comint-dynamic-simple-complete Complete stub given candidates.
2331 ;; These are not installed in the comint-mode keymap. But they are
2332 ;; available for people who want them. Shell-mode installs them:
2333 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2334 ;; (define-key shell-mode-map "\M-?"
2335 ;; 'comint-dynamic-list-filename-completions)))
2337 ;; Commands like this are fine things to put in load hooks if you
2338 ;; want them present in specific modes.
2340 (defcustom comint-completion-autolist nil
2341 "*If non-nil, automatically list possibilities on partial completion.
2342 This mirrors the optional behavior of tcsh."
2343 :type 'boolean
2344 :group 'comint-completion)
2346 (defcustom comint-completion-addsuffix t
2347 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2348 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2349 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2350 This mirrors the optional behavior of tcsh."
2351 :type '(choice (const :tag "None" nil)
2352 (const :tag "Add /" t)
2353 (cons :tag "Suffix pair"
2354 (string :tag "Directory suffix")
2355 (string :tag "File suffix")))
2356 :group 'comint-completion)
2358 (defcustom comint-completion-recexact nil
2359 "*If non-nil, use shortest completion if characters cannot be added.
2360 This mirrors the optional behavior of tcsh.
2362 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2363 :type 'boolean
2364 :group 'comint-completion)
2366 (defcustom comint-completion-fignore nil
2367 "*List of suffixes to be disregarded during file completion.
2368 This mirrors the optional behavior of bash and tcsh.
2370 Note that this applies to `comint-dynamic-complete-filename' only."
2371 :type '(repeat (string :tag "Suffix"))
2372 :group 'comint-completion)
2374 (defvar comint-file-name-prefix ""
2375 "Prefix prepended to absolute file names taken from process input.
2376 This is used by comint's and shell's completion functions, and by shell's
2377 directory tracking functions.")
2379 (defvar comint-file-name-chars
2380 (if (memq system-type '(ms-dos windows-nt))
2381 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2382 "~/A-Za-z0-9+@:_.$#%,={}-")
2383 "String of characters valid in a file name.
2384 Note that all non-ASCII characters are considered valid in a file name
2385 regardless of what this variable says.
2387 This is a good thing to set in mode hooks.")
2389 (defvar comint-file-name-quote-list nil
2390 "List of characters to quote with `\\' when in a file name.
2392 This is a good thing to set in mode hooks.")
2395 (defun comint-directory (directory)
2396 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2397 (expand-file-name (if (file-name-absolute-p directory)
2398 (concat comint-file-name-prefix directory)
2399 directory)))
2402 (defun comint-word (word-chars)
2403 "Return the word of WORD-CHARS at point, or nil if non is found.
2404 Word constituents are considered to be those in WORD-CHARS, which is like the
2405 inside of a \"[...]\" (see `skip-chars-forward'),
2406 plus all non-ASCII characters."
2407 (save-excursion
2408 (let ((non-word-chars (concat "[^\\\\" word-chars "]")) (here (point)))
2409 (while (and (re-search-backward non-word-chars nil 'move)
2410 ;;(memq (char-after (point)) shell-file-name-quote-list)
2411 (or (>= (following-char) 128)
2412 (eq (preceding-char) ?\\)))
2413 (backward-char 1))
2414 ;; Don't go forward over a word-char (this can happen if we're at bob).
2415 (when (or (not (bobp)) (looking-at non-word-chars))
2416 (forward-char 1))
2417 ;; Set match-data to match the entire string.
2418 (when (< (point) here)
2419 (set-match-data (list (point) here))
2420 (match-string 0)))))
2422 (defun comint-substitute-in-file-name (filename)
2423 "Return FILENAME with environment variables substituted.
2424 Supports additional environment variable syntax of the command
2425 interpreter (e.g., the percent notation of cmd.exe on NT)."
2426 (let ((name (substitute-in-file-name filename)))
2427 (if (memq system-type '(ms-dos windows-nt))
2428 (let (env-var-name
2429 env-var-val)
2430 (save-match-data
2431 (while (string-match "%\\([^\\\\/]*\\)%" name)
2432 (setq env-var-name
2433 (substring name (match-beginning 1) (match-end 1)))
2434 (setq env-var-val (if (getenv env-var-name)
2435 (getenv env-var-name)
2436 ""))
2437 (setq name (replace-match env-var-val t t name))))))
2438 name))
2440 (defun comint-match-partial-filename ()
2441 "Return the filename at point, or nil if non is found.
2442 Environment variables are substituted. See `comint-word'."
2443 (let ((filename (comint-word comint-file-name-chars)))
2444 (and filename (comint-substitute-in-file-name
2445 (comint-unquote-filename filename)))))
2448 (defun comint-quote-filename (filename)
2449 "Return FILENAME with magic characters quoted.
2450 Magic characters are those in `comint-file-name-quote-list'."
2451 (if (null comint-file-name-quote-list)
2452 filename
2453 (let ((regexp
2454 (format "\\(^\\|[^\\]\\)\\([%s]\\)"
2455 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
2456 (save-match-data
2457 (while (string-match regexp filename)
2458 (setq filename (replace-match "\\1\\\\\\2" nil nil filename)))
2459 filename))))
2461 (defun comint-unquote-filename (filename)
2462 "Return FILENAME with quoted characters unquoted."
2463 (if (null comint-file-name-quote-list)
2464 filename
2465 (save-match-data
2466 (let ((i 0))
2467 (while (string-match "\\\\\\(.\\)" filename i)
2468 (setq filename (replace-match "\\1" nil nil filename))
2469 (setq i (+ 1 (match-beginning 0)))))
2470 filename)))
2473 (defun comint-dynamic-complete ()
2474 "Dynamically perform completion at point.
2475 Calls the functions in `comint-dynamic-complete-functions' to perform
2476 completion until a function returns non-nil, at which point completion is
2477 assumed to have occurred."
2478 (interactive)
2479 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
2482 (defun comint-dynamic-complete-filename ()
2483 "Dynamically complete the filename at point.
2484 Completes if after a filename. See `comint-match-partial-filename' and
2485 `comint-dynamic-complete-as-filename'.
2486 This function is similar to `comint-replace-by-expanded-filename', except that
2487 it won't change parts of the filename already entered in the buffer; it just
2488 adds completion characters to the end of the filename. A completions listing
2489 may be shown in a help buffer if completion is ambiguous.
2491 Completion is dependent on the value of `comint-completion-addsuffix',
2492 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2493 completions listing is dependent on the value of `comint-completion-autolist'.
2495 Returns t if successful."
2496 (interactive)
2497 (when (comint-match-partial-filename)
2498 (unless (window-minibuffer-p (selected-window))
2499 (message "Completing file name..."))
2500 (comint-dynamic-complete-as-filename)))
2502 (defun comint-dynamic-complete-as-filename ()
2503 "Dynamically complete at point as a filename.
2504 See `comint-dynamic-complete-filename'. Returns t if successful."
2505 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
2506 (completion-ignored-extensions comint-completion-fignore)
2507 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2508 ;; I think it was originally bound to solve file completion problems,
2509 ;; but subsequent changes may have made this unnecessary. sm.
2510 ;;(file-name-handler-alist nil)
2511 (minibuffer-p (window-minibuffer-p (selected-window)))
2512 (success t)
2513 (dirsuffix (cond ((not comint-completion-addsuffix)
2515 ((not (consp comint-completion-addsuffix))
2516 (char-to-string directory-sep-char))
2518 (car comint-completion-addsuffix))))
2519 (filesuffix (cond ((not comint-completion-addsuffix)
2521 ((not (consp comint-completion-addsuffix))
2522 " ")
2524 (cdr comint-completion-addsuffix))))
2525 (filename (or (comint-match-partial-filename) ""))
2526 (pathdir (file-name-directory filename))
2527 (pathnondir (file-name-nondirectory filename))
2528 (directory (if pathdir (comint-directory pathdir) default-directory))
2529 (completion (file-name-completion pathnondir directory)))
2530 (cond ((null completion)
2531 (message "No completions of %s" filename)
2532 (setq success nil))
2533 ((eq completion t) ; Means already completed "file".
2534 (insert filesuffix)
2535 (unless minibuffer-p
2536 (message "Sole completion")))
2537 ((string-equal completion "") ; Means completion on "directory/".
2538 (comint-dynamic-list-filename-completions))
2539 (t ; Completion string returned.
2540 (let ((file (concat (file-name-as-directory directory) completion)))
2541 (insert (comint-quote-filename
2542 (substring (directory-file-name completion)
2543 (length pathnondir))))
2544 (cond ((symbolp (file-name-completion completion directory))
2545 ;; We inserted a unique completion.
2546 (insert (if (file-directory-p file) dirsuffix filesuffix))
2547 (unless minibuffer-p
2548 (message "Completed")))
2549 ((and comint-completion-recexact comint-completion-addsuffix
2550 (string-equal pathnondir completion)
2551 (file-exists-p file))
2552 ;; It's not unique, but user wants shortest match.
2553 (insert (if (file-directory-p file) dirsuffix filesuffix))
2554 (unless minibuffer-p
2555 (message "Completed shortest")))
2556 ((or comint-completion-autolist
2557 (string-equal pathnondir completion))
2558 ;; It's not unique, list possible completions.
2559 (comint-dynamic-list-filename-completions))
2561 (unless minibuffer-p
2562 (message "Partially completed")))))))
2563 success))
2566 (defun comint-replace-by-expanded-filename ()
2567 "Dynamically expand and complete the filename at point.
2568 Replace the filename with an expanded, canonicalised and completed replacement.
2569 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
2570 with the corresponding directories. \"Canonicalised\" means `..' and `.' are
2571 removed, and the filename is made absolute instead of relative. For expansion
2572 see `expand-file-name' and `substitute-in-file-name'. For completion see
2573 `comint-dynamic-complete-filename'."
2574 (interactive)
2575 (replace-match (expand-file-name (comint-match-partial-filename)) t t)
2576 (comint-dynamic-complete-filename))
2579 (defun comint-dynamic-simple-complete (stub candidates)
2580 "Dynamically complete STUB from CANDIDATES list.
2581 This function inserts completion characters at point by completing STUB from
2582 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2583 if completion is ambiguous.
2585 Returns nil if no completion was inserted.
2586 Returns `sole' if completed with the only completion match.
2587 Returns `shortest' if completed with the shortest of the completion matches.
2588 Returns `partial' if completed as far as possible with the completion matches.
2589 Returns `listed' if a completion listing was shown.
2591 See also `comint-dynamic-complete-filename'."
2592 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
2593 (suffix (cond ((not comint-completion-addsuffix) "")
2594 ((not (consp comint-completion-addsuffix)) " ")
2595 (t (cdr comint-completion-addsuffix))))
2596 (candidates (mapcar (function (lambda (x) (list x))) candidates))
2597 (completions (all-completions stub candidates)))
2598 (cond ((null completions)
2599 (message "No completions of %s" stub)
2600 nil)
2601 ((= 1 (length completions)) ; Gotcha!
2602 (let ((completion (car completions)))
2603 (if (string-equal completion stub)
2604 (message "Sole completion")
2605 (insert (substring completion (length stub)))
2606 (message "Completed"))
2607 (insert suffix)
2608 'sole))
2609 (t ; There's no unique completion.
2610 (let ((completion (try-completion stub candidates)))
2611 ;; Insert the longest substring.
2612 (insert (substring completion (length stub)))
2613 (cond ((and comint-completion-recexact comint-completion-addsuffix
2614 (string-equal stub completion)
2615 (member completion completions))
2616 ;; It's not unique, but user wants shortest match.
2617 (insert suffix)
2618 (message "Completed shortest")
2619 'shortest)
2620 ((or comint-completion-autolist
2621 (string-equal stub completion))
2622 ;; It's not unique, list possible completions.
2623 (comint-dynamic-list-completions completions)
2624 'listed)
2626 (message "Partially completed")
2627 'partial)))))))
2630 (defun comint-dynamic-list-filename-completions ()
2631 "List in help buffer possible completions of the filename at point."
2632 (interactive)
2633 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt)))
2634 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2635 ;; I think it was originally bound to solve file completion problems,
2636 ;; but subsequent changes may have made this unnecessary. sm.
2637 ;;(file-name-handler-alist nil)
2638 (filename (or (comint-match-partial-filename) ""))
2639 (pathdir (file-name-directory filename))
2640 (pathnondir (file-name-nondirectory filename))
2641 (directory (if pathdir (comint-directory pathdir) default-directory))
2642 (completions (file-name-all-completions pathnondir directory)))
2643 (if (not completions)
2644 (message "No completions of %s" filename)
2645 (comint-dynamic-list-completions
2646 (mapcar 'comint-quote-filename completions)))))
2649 (defun comint-dynamic-list-completions (completions)
2650 "List in help buffer sorted COMPLETIONS.
2651 Typing SPC flushes the help buffer."
2652 (let ((conf (current-window-configuration)))
2653 (with-output-to-temp-buffer "*Completions*"
2654 (display-completion-list (sort completions 'string-lessp)))
2655 (message "Hit space to flush")
2656 (let (key first)
2657 (if (save-excursion
2658 (set-buffer (get-buffer "*Completions*"))
2659 (setq key (read-key-sequence nil)
2660 first (aref key 0))
2661 (and (consp first) (consp (event-start first))
2662 (eq (window-buffer (posn-window (event-start first)))
2663 (get-buffer "*Completions*"))
2664 (eq (key-binding key) 'mouse-choose-completion)))
2665 ;; If the user does mouse-choose-completion with the mouse,
2666 ;; execute the command, then delete the completion window.
2667 (progn
2668 (mouse-choose-completion first)
2669 (set-window-configuration conf))
2670 (if (eq first ?\ )
2671 (set-window-configuration conf)
2672 (setq unread-command-events (listify-key-sequence key)))))))
2674 (defun comint-get-next-from-history ()
2675 "After fetching a line from input history, this fetches the following line.
2676 In other words, this recalls the input line after the line you recalled last.
2677 You can use this to repeat a sequence of input lines."
2678 (interactive)
2679 (if comint-save-input-ring-index
2680 (progn
2681 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
2682 (comint-next-input 1))
2683 (message "No previous history command")))
2685 (defun comint-accumulate ()
2686 "Accumulate a line to send as input along with more lines.
2687 This inserts a newline so that you can enter more text
2688 to be sent along with this line. Use \\[comint-send-input]
2689 to send all the accumulated input, at once.
2690 The entire accumulated text becomes one item in the input history
2691 when you send it."
2692 (interactive)
2693 (insert "\n")
2694 (set-marker comint-accum-marker (point))
2695 (if comint-input-ring-index
2696 (setq comint-save-input-ring-index
2697 (- comint-input-ring-index 1))))
2699 (defun comint-goto-process-mark ()
2700 "Move point to the process mark.
2701 The process mark separates output, and input already sent,
2702 from input that has not yet been sent."
2703 (interactive)
2704 (let ((proc (or (get-buffer-process (current-buffer))
2705 (error "Current buffer has no process"))))
2706 (goto-char (process-mark proc))
2707 (when (interactive-p)
2708 (message "Point is now at the process mark"))))
2710 (defun comint-bol-or-process-mark ()
2711 "Move point to beginning of line (after prompt) or to the process mark.
2712 The first time you use this command, it moves to the beginning of the line
2713 \(but after the prompt, if any). If you repeat it again immediately,
2714 it moves point to the process mark.
2716 The process mark separates the process output, along with input already sent,
2717 from input that has not yet been sent. Ordinarily, the process mark
2718 is at the beginning of the current input line; but if you have
2719 used \\[comint-accumulate] to send multiple lines at once,
2720 the process mark is at the beginning of the accumulated input."
2721 (interactive)
2722 (if (not (eq last-command 'comint-bol-or-process-mark))
2723 (comint-bol nil)
2724 (comint-goto-process-mark)))
2726 (defun comint-set-process-mark ()
2727 "Set the process mark at point."
2728 (interactive)
2729 (let ((proc (or (get-buffer-process (current-buffer))
2730 (error "Current buffer has no process"))))
2731 (set-marker (process-mark proc) (point))
2732 (message "Process mark set")))
2735 ;; Author: Peter Breton <pbreton@ne.mediaone.net>
2737 ;; This little add-on for comint is intended to make it easy to get
2738 ;; output from currently active comint buffers into another buffer,
2739 ;; or buffers, and then go back to using the comint shell.
2741 ;; My particular use is SQL interpreters; I want to be able to execute a
2742 ;; query using the process associated with a comint-buffer, and save that
2743 ;; somewhere else. Because the process might have state (for example, it
2744 ;; could be in an uncommitted transaction), just running starting a new
2745 ;; process and having it execute the query and then finish, would not
2746 ;; work. I'm sure there are other uses as well, although in many cases
2747 ;; starting a new process is the simpler, and thus preferable, approach.
2749 ;; The basic implementation is as follows: comint-redirect changes the
2750 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2751 ;; its own filter. The filter puts the output into the designated buffer,
2752 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2753 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2754 ;; sees the stop regexp, it restores the old filter functions, and runs
2755 ;; comint-redirect-hook.
2757 ;; Each comint buffer may only use one redirection at a time, but any number
2758 ;; of different comint buffers may be simultaneously redirected.
2760 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2761 ;; correct prompt for your interpreter, or that you supply a regexp that says
2762 ;; when the redirection is finished. Otherwise, redirection will continue
2763 ;; indefinitely. The code now does a sanity check to ensure that it can find
2764 ;; a prompt in the comint buffer; however, it is still important to ensure that
2765 ;; this prompt is set correctly.
2767 ;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2768 ;; perhaps it should prompt for a terminating string (with an
2769 ;; appropriate magic default by examining what we think is the prompt)?
2772 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2773 ;; Variables
2774 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2776 (defcustom comint-redirect-verbose nil
2777 "*If non-nil, print messages each time the redirection filter is invoked.
2778 Also print a message when redirection is completed."
2779 :group 'comint
2780 :type 'boolean)
2782 ;; Directly analagous to comint-preoutput-filter-functions
2783 (defvar comint-redirect-filter-functions nil
2784 "List of functions to call before inserting redirected process output.
2785 Each function gets one argument, a string containing the text received
2786 from the subprocess. It should return the string to insert, perhaps
2787 the same string that was received, or perhaps a modified or transformed
2788 string.
2790 The functions on the list are called sequentially, and each one is given
2791 the string returned by the previous one. The string returned by the
2792 last function is the text that is actually inserted in the redirection buffer.")
2794 (make-variable-buffer-local 'comint-redirect-filter-functions)
2796 ;; Internal variables
2798 (defvar comint-redirect-output-buffer nil
2799 "The buffer or list of buffers to put output into.")
2801 (defvar comint-redirect-finished-regexp nil
2802 "Regular expression that determines when to stop redirection in Comint.
2803 When the redirection filter function is given output that matches this regexp,
2804 the output is inserted as usual, and redirection is completed.")
2806 (defvar comint-redirect-insert-matching-regexp nil
2807 "If non-nil, the text that ends a redirection is included in it.
2808 More precisely, the text that matches `comint-redirect-finished-regexp'
2809 and therefore terminates an output redirection is inserted in the
2810 redirection target buffer, along with the preceding output.")
2812 (defvar comint-redirect-echo-input nil
2813 "Non-nil means echo input in the process buffer even during redirection.")
2815 (defvar comint-redirect-completed nil
2816 "Non-nil if redirection has completed in the current buffer.")
2818 (defvar comint-redirect-original-mode-line-process nil
2819 "Original mode line for redirected process.")
2821 (defvar comint-redirect-perform-sanity-check t
2822 "If non-nil, check that redirection is likely to complete successfully.
2823 More precisely, before starting a redirection, verify that the
2824 regular expression `comint-redirect-finished-regexp' that controls
2825 when to terminate it actually matches some text already in the process
2826 buffer. The idea is that this regular expression should match a prompt
2827 string, and that there ought to be at least one copy of your prompt string
2828 in the process buffer already.")
2830 (defvar comint-redirect-original-filter-function nil
2831 "The process filter that was in place when redirection is started.
2832 When redirection is completed, the process filter is restored to
2833 this value.")
2835 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2836 ;; Functions
2837 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2839 (defun comint-redirect-setup (output-buffer
2840 comint-buffer
2841 finished-regexp
2842 &optional echo-input)
2843 "Set up for output redirection.
2844 This function sets local variables that are used by `comint-redirect-filter'
2845 to perform redirection.
2847 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
2848 in the output matches FINISHED-REGEXP.
2850 If optional argument ECHO-INPUT is non-nil, output is echoed to the
2851 original comint buffer.
2853 This function is called by `comint-redirect-send-command-to-process',
2854 and does not normally need to be invoked by the end user or programmer."
2855 (with-current-buffer comint-buffer
2857 (make-local-variable 'comint-redirect-original-mode-line-process)
2858 (setq comint-redirect-original-mode-line-process mode-line-process)
2860 (make-local-variable 'comint-redirect-output-buffer)
2861 (setq comint-redirect-output-buffer output-buffer)
2863 (make-local-variable 'comint-redirect-finished-regexp)
2864 (setq comint-redirect-finished-regexp finished-regexp)
2866 (make-local-variable 'comint-redirect-echo-input)
2867 (setq comint-redirect-echo-input echo-input)
2869 (make-local-variable 'comint-redirect-completed)
2870 (setq comint-redirect-completed nil)
2872 (setq mode-line-process
2873 (if mode-line-process
2874 (list (concat (elt mode-line-process 0) " Redirection"))
2875 (list ":%s Redirection")))))
2877 (defun comint-redirect-cleanup ()
2878 "End a Comint redirection. See `comint-redirect-send-command'."
2879 (interactive)
2880 ;; Restore the process filter
2881 (set-process-filter (get-buffer-process (current-buffer))
2882 comint-redirect-original-filter-function)
2883 ;; Restore the mode line
2884 (setq mode-line-process comint-redirect-original-mode-line-process)
2885 ;; Set the completed flag
2886 (setq comint-redirect-completed t))
2888 ;; Because the cleanup happens as a callback, it's not easy to guarantee
2889 ;; that it really occurs.
2890 (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
2892 (defun comint-redirect-filter (process input-string)
2893 "Filter function which redirects output from PROCESS to a buffer or buffers.
2894 The variable `comint-redirect-output-buffer' says which buffer(s) to
2895 place output in.
2897 INPUT-STRING is the input from the comint process.
2899 This function runs as a process filter, and does not need to be invoked by the
2900 end user."
2901 (and process
2902 (with-current-buffer (process-buffer process)
2903 (comint-redirect-preoutput-filter input-string)
2904 ;; If we have to echo output, give it to the original filter function
2905 (and comint-redirect-echo-input
2906 comint-redirect-original-filter-function
2907 (funcall comint-redirect-original-filter-function
2908 process input-string)))))
2911 (defun comint-redirect-preoutput-filter (input-string)
2912 "Comint filter function which redirects comint output to a buffer or buffers.
2913 The variable `comint-redirect-output-buffer' says which buffer(s) to
2914 place output in.
2916 INPUT-STRING is the input from the comint process.
2918 This function does not need to be invoked by the end user."
2919 (let ((output-buffer-list
2920 (if (listp comint-redirect-output-buffer)
2921 comint-redirect-output-buffer
2922 (list comint-redirect-output-buffer)))
2923 (filtered-input-string input-string))
2925 ;; If there are any filter functions, give them a chance to modify the string
2926 (let ((functions comint-redirect-filter-functions))
2927 (while (and functions filtered-input-string)
2928 (setq filtered-input-string
2929 (funcall (car functions) filtered-input-string))
2930 (setq functions (cdr functions))))
2932 ;; Clobber `comint-redirect-finished-regexp'
2933 (or comint-redirect-insert-matching-regexp
2934 (and (string-match comint-redirect-finished-regexp filtered-input-string)
2935 (setq filtered-input-string
2936 (replace-match "" nil nil filtered-input-string))))
2938 ;; Send output to all registered buffers
2939 (save-excursion
2940 (mapcar
2941 (function (lambda(buf)
2942 ;; Set this buffer to the output buffer
2943 (set-buffer (get-buffer-create buf))
2944 ;; Go to the end of the buffer
2945 (goto-char (point-max))
2946 ;; Insert the output
2947 (insert filtered-input-string)))
2948 output-buffer-list))
2950 ;; Message
2951 (and comint-redirect-verbose
2952 (message "Redirected output to buffer(s) %s"
2953 (mapconcat 'identity output-buffer-list " ")))
2955 ;; If we see the prompt, tidy up
2956 ;; We'll look for the prompt in the original string, so nobody can
2957 ;; clobber it
2958 (and (string-match comint-redirect-finished-regexp input-string)
2959 (progn
2960 (and comint-redirect-verbose
2961 (message "Redirection completed"))
2962 (comint-redirect-cleanup)
2963 (run-hooks 'comint-redirect-hook)))
2964 ;; Echo input?
2965 (if comint-redirect-echo-input
2966 filtered-input-string
2967 "")))
2969 ;;;###autoload
2970 (defun comint-redirect-send-command (command output-buffer echo &optional no-display)
2971 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
2972 With prefix arg, echo output in process buffer.
2974 If NO-DISPLAY is non-nil, do not show the output buffer."
2975 (interactive "sCommand: \nBOutput Buffer: \nP")
2976 (let ((process (get-buffer-process (current-buffer))))
2977 (if process
2978 (comint-redirect-send-command-to-process
2979 command output-buffer (current-buffer) echo no-display)
2980 (error "No process for current buffer"))))
2982 ;;;###autoload
2983 (defun comint-redirect-send-command-to-process
2984 (command output-buffer process echo &optional no-display)
2985 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
2986 With prefix arg, echo output in process buffer.
2988 If NO-DISPLAY is non-nil, do not show the output buffer."
2989 (interactive "sCommand: \nBOutput Buffer: \nbProcess Buffer: \nP")
2990 (let* (;; The process buffer
2991 (process-buffer (if (processp process)
2992 (process-buffer process)
2993 process))
2994 (proc (get-buffer-process process-buffer)))
2995 ;; Change to the process buffer
2996 (set-buffer process-buffer)
2998 ;; Make sure there's a prompt in the current process buffer
2999 (and comint-redirect-perform-sanity-check
3000 (save-excursion
3001 (goto-char (point-max))
3002 (or (re-search-backward comint-prompt-regexp nil t)
3003 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3005 ;;;;;;;;;;;;;;;;;;;;;
3006 ;; Set up for redirection
3007 ;;;;;;;;;;;;;;;;;;;;;
3008 (comint-redirect-setup
3009 ;; Output Buffer
3010 output-buffer
3011 ;; Comint Buffer
3012 (current-buffer)
3013 ;; Finished Regexp
3014 comint-prompt-regexp
3015 ;; Echo input
3016 echo)
3018 ;;;;;;;;;;;;;;;;;;;;;
3019 ;; Set the filter
3020 ;;;;;;;;;;;;;;;;;;;;;
3021 ;; Save the old filter
3022 (setq comint-redirect-original-filter-function
3023 (process-filter proc))
3024 (set-process-filter proc 'comint-redirect-filter)
3026 ;;;;;;;;;;;;;;;;;;;;;
3027 ;; Send the command
3028 ;;;;;;;;;;;;;;;;;;;;;
3029 (process-send-string
3030 (current-buffer)
3031 (concat command "\n"))
3033 ;;;;;;;;;;;;;;;;;;;;;
3034 ;; Show the output
3035 ;;;;;;;;;;;;;;;;;;;;;
3036 (or no-display
3037 (display-buffer
3038 (get-buffer-create
3039 (if (listp output-buffer)
3040 (car output-buffer)
3041 output-buffer))))))
3043 ;;;###autoload
3044 (defun comint-redirect-results-list (command regexp regexp-group)
3045 "Send COMMAND to current process.
3046 Return a list of expressions in the output which match REGEXP.
3047 REGEXP-GROUP is the regular expression group in REGEXP to use."
3048 (comint-redirect-results-list-from-process
3049 (get-buffer-process (current-buffer))
3050 command regexp regexp-group))
3052 ;;;###autoload
3053 (defun comint-redirect-results-list-from-process (process command regexp regexp-group)
3054 "Send COMMAND to PROCESS.
3055 Return a list of expressions in the output which match REGEXP.
3056 REGEXP-GROUP is the regular expression group in REGEXP to use."
3057 (let ((output-buffer " *Comint Redirect Work Buffer*")
3058 results)
3059 (save-excursion
3060 (set-buffer (get-buffer-create output-buffer))
3061 (erase-buffer)
3062 (comint-redirect-send-command-to-process command
3063 output-buffer process nil t)
3064 ;; Wait for the process to complete
3065 (set-buffer (process-buffer process))
3066 (while (null comint-redirect-completed)
3067 (accept-process-output nil 1))
3068 ;; Collect the output
3069 (set-buffer output-buffer)
3070 (goto-char (point-min))
3071 ;; Skip past the command, if it was echoed
3072 (and (looking-at command)
3073 (forward-line))
3074 (while (re-search-forward regexp nil t)
3075 (setq results
3076 (cons (buffer-substring-no-properties
3077 (match-beginning regexp-group)
3078 (match-end regexp-group))
3079 results)))
3080 results)))
3082 (mapc (lambda (x)
3083 (add-to-list 'debug-ignored-errors x))
3084 '("^Not at command line$"
3085 "^Empty input ring$"
3086 "^No history$"
3087 "^Not found$" ; Too common?
3088 "^Current buffer has no process$"))
3090 ;; Converting process modes to use comint mode
3091 ;; ===========================================================================
3092 ;; The code in the Emacs 19 distribution has all been modified to use comint
3093 ;; where needed. However, there are `third-party' packages out there that
3094 ;; still use the old shell mode. Here's a guide to conversion.
3096 ;; Renaming variables
3097 ;; Most of the work is renaming variables and functions. These are the common
3098 ;; ones:
3099 ;; Local variables:
3100 ;; last-input-start comint-last-input-start
3101 ;; last-input-end comint-last-input-end
3102 ;; shell-prompt-pattern comint-prompt-regexp
3103 ;; shell-set-directory-error-hook <no equivalent>
3104 ;; Miscellaneous:
3105 ;; shell-set-directory <unnecessary>
3106 ;; shell-mode-map comint-mode-map
3107 ;; Commands:
3108 ;; shell-send-input comint-send-input
3109 ;; shell-send-eof comint-delchar-or-maybe-eof
3110 ;; kill-shell-input comint-kill-input
3111 ;; interrupt-shell-subjob comint-interrupt-subjob
3112 ;; stop-shell-subjob comint-stop-subjob
3113 ;; quit-shell-subjob comint-quit-subjob
3114 ;; kill-shell-subjob comint-kill-subjob
3115 ;; kill-output-from-shell comint-delete-output
3116 ;; show-output-from-shell comint-show-output
3117 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3119 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3120 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3121 ;; Comint mode does not provide functionality equivalent to
3122 ;; shell-set-directory-error-hook; it is gone.
3124 ;; comint-last-input-start is provided for modes which want to munge
3125 ;; the buffer after input is sent, perhaps because the inferior
3126 ;; insists on echoing the input. The LAST-INPUT-START variable in
3127 ;; the old shell package was used to implement a history mechanism,
3128 ;; but you should think twice before using comint-last-input-start
3129 ;; for this; the input history ring often does the job better.
3131 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3132 ;; *not* create the comint-mode local variables in your foo-mode function.
3133 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3134 ;; necessary comint-specific local variables. Then create the
3135 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3136 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3137 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3138 ;; get-old-input) that need to be different from the defaults. Call
3139 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3140 ;; comint-mode will take care of it. The following example, from shell.el,
3141 ;; is typical:
3143 ;; (defvar shell-mode-map '())
3144 ;; (cond ((not shell-mode-map)
3145 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3146 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3147 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3148 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3149 ;; (define-key shell-mode-map "\M-?"
3150 ;; 'comint-dynamic-list-filename-completions)))
3152 ;; (defun shell-mode ()
3153 ;; (interactive)
3154 ;; (comint-mode)
3155 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3156 ;; (setq major-mode 'shell-mode)
3157 ;; (setq mode-name "Shell")
3158 ;; (use-local-map shell-mode-map)
3159 ;; (make-local-variable 'shell-directory-stack)
3160 ;; (setq shell-directory-stack nil)
3161 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3162 ;; (run-hooks 'shell-mode-hook))
3165 ;; Completion for comint-mode users
3167 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3168 ;; hook to add completion functions to. Functions on this list should return
3169 ;; non-nil if completion occurs (i.e., further completion should not occur).
3170 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3171 ;; completion job.
3173 (provide 'comint)
3175 ;; comint.el ends here