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>
7 ;; Simon Marshall <simon@gnu.org>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
30 ;; 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
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-list-filename-completions List completions in help buffer.
92 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
93 ;; replace with expanded/completed name.
94 ;; comint-replace-by-expanded-history Expand history at point;
95 ;; replace with expanded name.
96 ;; comint-magic-space Expand history and add (a) space(s).
97 ;; comint-kill-subjob No mercy.
98 ;; comint-show-maximum-output Show as much output as possible.
99 ;; comint-continue-subjob Send CONT signal to buffer's process
100 ;; group. Useful if you accidentally
101 ;; suspend your process (with C-c C-z).
102 ;; comint-get-next-from-history Fetch successive input history lines
103 ;; comint-accumulate Combine lines to send them together
105 ;; comint-goto-process-mark Move point to where process-mark is.
106 ;; comint-set-process-mark Set process-mark to point.
108 ;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
114 ;; Buffer Local Variables:
115 ;;============================================================================
116 ;; Comint mode buffer local variables:
117 ;; comint-prompt-regexp string comint-bol uses to match prompt
118 ;; comint-delimiter-argument-list list For delimiters and arguments
119 ;; comint-last-input-start marker Handy if inferior always echoes
120 ;; comint-last-input-end marker For comint-delete-output command
121 ;; comint-input-ring-size integer For the input history
122 ;; comint-input-ring ring mechanism
123 ;; comint-input-ring-index number ...
124 ;; comint-save-input-ring-index number ...
125 ;; comint-input-autoexpand symbol ...
126 ;; comint-input-ignoredups boolean ...
127 ;; comint-dynamic-complete-functions hook For the completion mechanism
128 ;; comint-completion-fignore list ...
129 ;; comint-file-name-chars string ...
130 ;; comint-file-name-quote-list list ...
131 ;; comint-get-old-input function Hooks for specific
132 ;; comint-input-filter-functions hook process-in-a-buffer
133 ;; comint-output-filter-functions hook function modes.
134 ;; comint-preoutput-filter-functions hook
135 ;; comint-input-filter function ...
136 ;; comint-input-sender function ...
137 ;; comint-eol-on-send boolean ...
138 ;; comint-process-echoes boolean ...
139 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
140 ;; comint-scroll-to-bottom-on-output symbol ...
141 ;; comint-scroll-show-maximum-output boolean ...
142 ;; comint-accum-marker maker For comint-accumulate
143 ;; comint-last-output-overlay overlay
145 ;; Comint mode non-buffer local variables:
146 ;; comint-completion-addsuffix boolean/cons For file name
147 ;; comint-completion-autolist boolean completion behavior
148 ;; comint-completion-recexact boolean ...
151 "General command interpreter in a window stuff."
154 (defgroup comint-completion nil
155 "Completion facilities in comint"
158 (defgroup comint-source nil
159 "Source finding facilities in comint"
163 (defvar comint-prompt-regexp
"^"
164 "Regexp to recognise prompts in the inferior process.
165 Defaults to \"^\", the null string at BOL.
167 This variable is only used if the variable
168 `comint-use-prompt-regexp-instead-of-fields' is non-nil.
171 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
172 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
173 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
175 shell: \"^[^#$%>\\n]*[#$%>] *\"
178 This is a good thing to set in mode hooks.")
180 (defvar comint-delimiter-argument-list
()
181 "List of characters to recognise as separate arguments in input.
182 Strings comprising a character in this list will separate the arguments
183 surrounding them, and also be regarded as arguments in their own right (unlike
184 whitespace). See `comint-arguments'.
185 Defaults to the empty list.
187 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
189 This is a good thing to set in mode hooks.")
191 (defcustom comint-input-autoexpand nil
192 "*If non-nil, expand input command history references on completion.
193 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
195 If the value is `input', then the expansion is seen on input.
196 If the value is `history', then the expansion is only when inserting
197 into the buffer's input ring. See also `comint-magic-space' and
198 `comint-dynamic-complete'.
200 This variable is buffer-local."
201 :type
'(choice (const :tag
"off" nil
)
207 (defcustom comint-highlight-input t
208 "*If non-nil, highlight input; also allow choosing previous input with a mouse.
209 The face used is `comint-highlight-input'."
213 (defface comint-highlight-input
'((t (:weight bold
)))
214 "Face to use to highlight input when `comint-highlight-input' is non-nil."
217 (defcustom comint-highlight-prompt t
218 "*If non-nil, highlight program prompts.
219 The face used is `comint-highlight-prompt'."
223 (defface comint-highlight-prompt
224 '((((background dark
)) (:foreground
"cyan"))
225 (t (:foreground
"dark blue")))
226 "Face to use to highlight prompt when `comint-highlight-prompt' is non-nil."
229 (defcustom comint-input-ignoredups nil
230 "*If non-nil, don't add input matching the last on the input ring.
231 This mirrors the optional behavior of bash.
233 This variable is buffer-local."
237 (defcustom comint-input-ring-file-name nil
238 "*If non-nil, name of the file to read/write input history.
239 See also `comint-read-input-ring' and `comint-write-input-ring'.
241 This variable is buffer-local, and is a good thing to set in mode hooks."
242 :type
'(choice (const :tag
"nil" nil
)
246 (defcustom comint-scroll-to-bottom-on-input nil
247 "*Controls whether input to interpreter causes window to scroll.
248 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
249 If `this', scroll only the selected window.
253 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
254 :type
'(choice (const :tag
"off" nil
)
260 (defcustom comint-scroll-to-bottom-on-output nil
261 "*Controls whether interpreter output causes window to scroll.
262 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
263 If `this', scroll only the selected window.
264 If `others', scroll only those that are not the selected window.
268 See variable `comint-scroll-show-maximum-output' and function
269 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
270 :type
'(choice (const :tag
"off" nil
)
277 (defcustom comint-scroll-show-maximum-output t
278 "*Controls how interpreter output causes window to scroll.
279 If non-nil, then show the maximum output when the window is scrolled.
281 See variable `comint-scroll-to-bottom-on-output' and function
282 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
286 (defcustom comint-buffer-maximum-size
1024
287 "*The maximum size in lines for comint buffers.
288 Comint buffers are truncated from the top to be no greater than this number, if
289 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
293 (defvar comint-input-ring-size
32
294 "Size of input history ring.")
296 (defvar comint-input-ring-separator
"\n"
297 "Separator between commands in the history file.")
299 (defvar comint-input-history-ignore
"^#"
300 "Regexp for history entries that should be ignored when comint initializes.")
302 (defcustom comint-process-echoes nil
303 "*If non-nil, assume that the subprocess echoes any input.
304 If so, delete one copy of the input so that only one copy eventually
305 appears in the buffer.
307 This variable is buffer-local."
311 ;; AIX puts the name of the person being su'd to in front of the prompt.
312 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
313 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
314 ;; ssh-add prints a prompt like `Enter passphrase: '.
315 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
316 (defcustom comint-password-prompt-regexp
317 "\\(\\([Oo]ld \\|[Nn]ew \\|'s \\|login \\|\
318 Kerberos \\|CVS \\|UNIX \\| SMB \\|^\\)\
319 [Pp]assword\\( (again)\\)?\\|\
320 pass phrase\\|\\(Enter\\|Repeat\\) passphrase\\)\
321 \\( for [^:]+\\)?:\\s *\\'"
322 "*Regexp matching prompts for passwords in the inferior process.
323 This is used by `comint-watch-for-password-prompt'."
327 ;; Here are the per-interpreter hooks.
328 (defvar comint-get-old-input
(function comint-get-old-input-default
)
329 "Function that returns old text in comint mode.
330 This function is called when return is typed while the point is in old
331 text. It returns the text to be submitted as process input. The
332 default is `comint-get-old-input-default', which either grabs the
333 current input field or grabs the current line and strips off leading
334 text matching `comint-prompt-regexp', depending on the value of
335 `comint-use-prompt-regexp-instead-of-fields'.")
337 (defvar comint-dynamic-complete-functions
338 '(comint-replace-by-expanded-history comint-dynamic-complete-filename
)
339 "List of functions called to perform completion.
340 Functions should return non-nil if completion was performed.
341 See also `comint-dynamic-complete'.
343 This is a good thing to set in mode hooks.")
345 (defvar comint-input-filter
346 (function (lambda (str) (not (string-match "\\`\\s *\\'" str
))))
347 "Predicate for filtering additions to input history.
348 Takes one argument, the input. If non-nil, the input may be saved on the input
349 history list. Default is to save anything that isn't all whitespace.")
351 (defvar comint-input-filter-functions
'()
352 "Functions to call before input is sent to the process.
353 These functions get one argument, a string containing the text to send.
355 You can use `add-hook' to add functions to this list
356 either globally or locally.")
358 (defvar comint-output-filter-functions
'(comint-postoutput-scroll-to-bottom)
359 "Functions to call after output is inserted into the buffer.
360 One possible function is `comint-postoutput-scroll-to-bottom'.
361 These functions get one argument, a string containing the text as originally
362 inserted. Note that this might not be the same as the buffer contents between
363 `comint-last-output-start' and the buffer's `process-mark', if other filter
364 functions have already modified the buffer.
366 See also `comint-preoutput-filter-functions'.
368 You can use `add-hook' to add functions to this list
369 either globally or locally.")
371 (defvar comint-input-sender-no-newline nil
372 "Non-nil directs the `comint-input-sender' function not to send a newline.")
374 (defvar comint-input-sender
(function comint-simple-send
)
375 "Function to actually send to PROCESS the STRING submitted by user.
376 Usually this is just `comint-simple-send', but if your mode needs to
377 massage the input string, put a different function here.
378 `comint-simple-send' just sends the string plus a newline.
379 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
380 This is called from the user command `comint-send-input'.")
382 (defcustom comint-eol-on-send t
383 "*Non-nil means go to the end of the line before sending input.
384 See `comint-send-input'."
388 ;; Note: If it is decided to purge comint-prompt-regexp from the source
389 ;; entirely, searching for uses of this variable will help to identify
390 ;; places that need attention.
391 (defcustom comint-use-prompt-regexp-instead-of-fields nil
392 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
393 If nil, then program output and user-input are given different `field'
394 properties, which emacs commands can use to distinguish them (in
395 particular, common movement commands such as begining-of-line respect
396 field boundaries in a natural way)."
400 (defcustom comint-mode-hook
'()
401 "Called upon entry into `comint-mode'
402 This is run before the process is cranked up."
406 (defcustom comint-exec-hook
'()
407 "Called each time a process is exec'd by `comint-exec'.
408 This is called after the process is cranked up. It is useful for things that
409 must be done each time a process is executed in a comint mode buffer (e.g.,
410 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
411 executed once when the buffer is created."
415 (defvar comint-mode-map nil
)
417 (defvar comint-ptyp t
418 "Non-nil if communications via pty; false if by pipe. Buffer local.
419 This is to work around a bug in Emacs process signaling.")
421 (defvar comint-input-ring nil
)
422 (defvar comint-last-input-start
)
423 (defvar comint-last-input-end
)
424 (defvar comint-last-output-start
)
425 (defvar comint-input-ring-index nil
426 "Index of last matched history element.")
427 (defvar comint-matching-input-from-input-string
""
428 "Input previously used to match input history.")
429 (defvar comint-save-input-ring-index
430 "Last input ring index which you copied.
431 This is to support the command \\[comint-get-next-from-history].")
433 (defvar comint-accum-marker nil
434 "Non-nil if you are accumulating input lines to send as input together.
435 The command \\[comint-accumulate] sets this.")
437 (put 'comint-replace-by-expanded-history
'menu-enable
'comint-input-autoexpand
)
438 (put 'comint-input-ring
'permanent-local t
)
439 (put 'comint-input-ring-index
'permanent-local t
)
440 (put 'comint-save-input-ring-index
'permanent-local t
)
441 (put 'comint-input-autoexpand
'permanent-local t
)
442 (put 'comint-input-filter-functions
'permanent-local t
)
443 (put 'comint-output-filter-functions
'permanent-local t
)
444 (put 'comint-preoutput-filter-functions
'permanent-local t
)
445 (put 'comint-scroll-to-bottom-on-input
'permanent-local t
)
446 (put 'comint-scroll-to-bottom-on-output
'permanent-local t
)
447 (put 'comint-scroll-show-maximum-output
'permanent-local t
)
448 (put 'comint-ptyp
'permanent-local t
)
450 (put 'comint-mode
'mode-class
'special
)
452 (define-derived-mode comint-mode fundamental-mode
"Comint"
453 "Major mode for interacting with an inferior interpreter.
454 Interpreter name is same as buffer name, sans the asterisks.
455 Return at end of buffer sends line as input.
456 Return not at end copies rest of line to end and sends it.
457 Setting variable `comint-eol-on-send' means jump to the end of the line
458 before submitting new input.
460 This mode is customised to create major modes such as Inferior Lisp
461 mode, Shell mode, etc. This can be done by setting the hooks
462 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
463 and `comint-get-old-input' to appropriate functions, and the variable
464 `comint-prompt-regexp' to the appropriate regular expression.
466 An input history is maintained of size `comint-input-ring-size', and
467 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
468 Input ring history expansion can be achieved with the commands
469 \\[comint-replace-by-expanded-history] or \\[comint-magic-space].
470 Input ring expansion is controlled by the variable `comint-input-autoexpand',
471 and addition is controlled by the variable `comint-input-ignoredups'.
473 Commands with no default key bindings include `send-invisible',
474 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
475 `comint-magic-space'.
477 Input to, and output from, the subprocess can cause the window to scroll to
478 the end of the buffer. See variables `comint-output-filter-functions',
479 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
480 and `comint-scroll-to-bottom-on-output'.
482 If you accidentally suspend your process, use \\[comint-continue-subjob]
487 Entry to this mode runs the hooks on `comint-mode-hook'."
488 (setq mode-line-process
'(":%s"))
489 (set (make-local-variable 'comint-last-input-start
) (point-min-marker))
490 (set (make-local-variable 'comint-last-input-end
) (point-min-marker))
491 (set (make-local-variable 'comint-last-output-start
) (make-marker))
492 (make-local-variable 'comint-last-output-overlay
)
493 (make-local-variable 'comint-last-prompt-overlay
)
494 (make-local-variable 'comint-prompt-regexp
) ; Don't set; default
495 (make-local-variable 'comint-input-ring-size
) ; ...to global val.
496 (make-local-variable 'comint-input-ring
)
497 (make-local-variable 'comint-input-ring-file-name
)
498 (or (and (boundp 'comint-input-ring
) comint-input-ring
)
499 (setq comint-input-ring
(make-ring comint-input-ring-size
)))
500 (make-local-variable 'comint-input-ring-index
)
501 (make-local-variable 'comint-save-input-ring-index
)
502 (or (and (boundp 'comint-input-ring-index
) comint-input-ring-index
)
503 (setq comint-input-ring-index nil
))
504 (or (and (boundp 'comint-save-input-ring-index
) comint-save-input-ring-index
)
505 (setq comint-save-input-ring-index nil
))
506 (make-local-variable 'comint-matching-input-from-input-string
)
507 (make-local-variable 'comint-input-autoexpand
)
508 (make-local-variable 'comint-input-ignoredups
)
509 (make-local-variable 'comint-delimiter-argument-list
)
510 (make-local-variable 'comint-completion-fignore
)
511 (make-local-variable 'comint-get-old-input
)
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-variable 'comint-ptyp
)
520 (make-local-variable 'comint-process-echoes
)
521 (make-local-variable 'comint-file-name-chars
)
522 (make-local-variable 'comint-file-name-quote-list
)
523 (set (make-local-variable 'comint-accum-marker
) (make-marker))
524 ;; This behavior is not useful in comint buffers, and is annoying
525 (set (make-local-variable 'next-line-add-newlines
) nil
))
530 (setq comint-mode-map
(make-sparse-keymap))
531 (define-key comint-mode-map
"\ep" 'comint-previous-input
)
532 (define-key comint-mode-map
"\en" 'comint-next-input
)
533 (define-key comint-mode-map
[C-up
] 'comint-previous-input
)
534 (define-key comint-mode-map
[C-down
] 'comint-next-input
)
535 (define-key comint-mode-map
"\er" 'comint-previous-matching-input
)
536 (define-key comint-mode-map
"\es" 'comint-next-matching-input
)
537 (define-key comint-mode-map
[?\C-c ?\M-r
] 'comint-previous-matching-input-from-input
)
538 (define-key comint-mode-map
[?\C-c ?\M-s
] 'comint-next-matching-input-from-input
)
539 (define-key comint-mode-map
"\e\C-l" 'comint-show-output
)
540 (define-key comint-mode-map
"\C-m" 'comint-send-input
)
541 (define-key comint-mode-map
"\C-d" 'comint-delchar-or-maybe-eof
)
542 (define-key comint-mode-map
"\C-c " 'comint-accumulate
)
543 (define-key comint-mode-map
"\C-c\C-x" 'comint-get-next-from-history
)
544 (define-key comint-mode-map
"\C-c\C-a" 'comint-bol-or-process-mark
)
545 (define-key comint-mode-map
"\C-c\C-u" 'comint-kill-input
)
546 (define-key comint-mode-map
"\C-c\C-w" 'backward-kill-word
)
547 (define-key comint-mode-map
"\C-c\C-c" 'comint-interrupt-subjob
)
548 (define-key comint-mode-map
"\C-c\C-z" 'comint-stop-subjob
)
549 (define-key comint-mode-map
"\C-c\C-\\" 'comint-quit-subjob
)
550 (define-key comint-mode-map
"\C-c\C-m" 'comint-copy-old-input
)
551 (define-key comint-mode-map
"\C-c\C-o" 'comint-delete-output
)
552 (define-key comint-mode-map
"\C-c\C-r" 'comint-show-output
)
553 (define-key comint-mode-map
"\C-c\C-e" 'comint-show-maximum-output
)
554 (define-key comint-mode-map
"\C-c\C-l" 'comint-dynamic-list-input-ring
)
555 (define-key comint-mode-map
"\C-c\C-n" 'comint-next-prompt
)
556 (define-key comint-mode-map
"\C-c\C-p" 'comint-previous-prompt
)
557 (define-key comint-mode-map
"\C-c\C-d" 'comint-send-eof
)
558 (define-key comint-mode-map
"\C-c\C-s" 'comint-write-output
)
559 (define-key comint-mode-map
"\C-c." 'comint-insert-previous-argument
)
561 (define-key comint-mode-map
[mouse-2
] 'comint-insert-clicked-input
)
564 (define-key comint-mode-map
[menu-bar completion
]
565 (cons "Complete" (make-sparse-keymap "Complete")))
566 (define-key comint-mode-map
[menu-bar completion complete-expand
]
567 '("Expand File Name" . comint-replace-by-expanded-filename
))
568 (define-key comint-mode-map
[menu-bar completion complete-listing
]
569 '("File Completion Listing" . comint-dynamic-list-filename-completions
))
570 (define-key comint-mode-map
[menu-bar completion complete-file
]
571 '("Complete File Name" . comint-dynamic-complete-filename
))
572 (define-key comint-mode-map
[menu-bar completion complete
]
573 '("Complete Before Point" . comint-dynamic-complete
))
575 (define-key comint-mode-map
[menu-bar inout
]
576 (cons "In/Out" (make-sparse-keymap "In/Out")))
577 (define-key comint-mode-map
[menu-bar inout delete-output
]
578 '("Delete Current Output Group" . comint-delete-output
))
579 (define-key comint-mode-map
[menu-bar inout append-output-to-file
]
580 '("Append Current Output Group to File" . comint-append-output-to-file
))
581 (define-key comint-mode-map
[menu-bar inout write-output
]
582 '("Write Current Output Group to File" . comint-write-output
))
583 (define-key comint-mode-map
[menu-bar inout next-prompt
]
584 '("Forward Output Group" . comint-next-prompt
))
585 (define-key comint-mode-map
[menu-bar inout previous-prompt
]
586 '("Backward Output Group" . comint-previous-prompt
))
587 (define-key comint-mode-map
[menu-bar inout show-maximum-output
]
588 '("Show Maximum Output" . comint-show-maximum-output
))
589 (define-key comint-mode-map
[menu-bar inout show-output
]
590 '("Show Current Output Group" . comint-show-output
))
591 (define-key comint-mode-map
[menu-bar inout kill-input
]
592 '("Kill Current Input" . comint-kill-input
))
593 (define-key comint-mode-map
[menu-bar inout copy-input
]
594 '("Copy Old Input" . comint-copy-old-input
))
595 (define-key comint-mode-map
[menu-bar inout forward-matching-history
]
596 '("Forward Matching Input..." . comint-forward-matching-input
))
597 (define-key comint-mode-map
[menu-bar inout backward-matching-history
]
598 '("Backward Matching Input..." . comint-backward-matching-input
))
599 (define-key comint-mode-map
[menu-bar inout next-matching-history
]
600 '("Next Matching Input..." . comint-next-matching-input
))
601 (define-key comint-mode-map
[menu-bar inout previous-matching-history
]
602 '("Previous Matching Input..." . comint-previous-matching-input
))
603 (define-key comint-mode-map
[menu-bar inout next-matching-history-from-input
]
604 '("Next Matching Current Input" . comint-next-matching-input-from-input
))
605 (define-key comint-mode-map
[menu-bar inout previous-matching-history-from-input
]
606 '("Previous Matching Current Input" . comint-previous-matching-input-from-input
))
607 (define-key comint-mode-map
[menu-bar inout next-history
]
608 '("Next Input" . comint-next-input
))
609 (define-key comint-mode-map
[menu-bar inout previous-history
]
610 '("Previous Input" . comint-previous-input
))
611 (define-key comint-mode-map
[menu-bar inout list-history
]
612 '("List Input History" . comint-dynamic-list-input-ring
))
613 (define-key comint-mode-map
[menu-bar inout expand-history
]
614 '("Expand History Before Point" . comint-replace-by-expanded-history
))
616 (define-key comint-mode-map
[menu-bar signals
]
617 (cons "Signals" (make-sparse-keymap "Signals")))
618 (define-key comint-mode-map
[menu-bar signals eof
]
619 '("EOF" . comint-send-eof
))
620 (define-key comint-mode-map
[menu-bar signals kill
]
621 '("KILL" . comint-kill-subjob
))
622 (define-key comint-mode-map
[menu-bar signals quit
]
623 '("QUIT" . comint-quit-subjob
))
624 (define-key comint-mode-map
[menu-bar signals cont
]
625 '("CONT" . comint-continue-subjob
))
626 (define-key comint-mode-map
[menu-bar signals stop
]
627 '("STOP" . comint-stop-subjob
))
628 (define-key comint-mode-map
[menu-bar signals break
]
629 '("BREAK" . comint-interrupt-subjob
))
630 ;; Put them in the menu bar:
631 (setq menu-bar-final-items
(append '(completion inout signals
)
632 menu-bar-final-items
))
635 (defun comint-check-proc (buffer)
636 "Return t if there is a living process associated w/buffer BUFFER.
637 Living means the status is `open', `run', or `stop'.
638 BUFFER can be either a buffer or the name of one."
639 (let ((proc (get-buffer-process buffer
)))
640 (and proc
(memq (process-status proc
) '(open run stop
)))))
643 (defun make-comint-in-buffer (name buffer program
&optional startfile
&rest switches
)
644 "Make a comint process NAME in BUFFER, running PROGRAM.
645 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
646 PROGRAM should be either a string denoting an executable program to create
647 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
648 connection to be opened via `open-network-stream'. If there is already a
649 running process in that buffer, it is not restarted. Optional third arg
650 STARTFILE is the name of a file to send the contents of to the process.
652 If PROGRAM is a string, any more args are arguments to PROGRAM."
653 (or (fboundp 'start-process
)
654 (error "Multi-processing is not supported for this system"))
655 (setq buffer
(get-buffer-create (or buffer
(concat "*" name
"*"))))
656 ;; If no process, or nuked process, crank up a new one and put buffer in
657 ;; comint mode. Otherwise, leave buffer and existing process alone.
658 (unless (comint-check-proc buffer
)
659 (with-current-buffer buffer
660 (unless (derived-mode-p 'comint-mode
)
661 (comint-mode))) ; Install local vars, mode, keymap, ...
662 (comint-exec buffer name program startfile switches
))
666 (defun make-comint (name program
&optional startfile
&rest switches
)
667 "Make a comint process NAME in a buffer, running PROGRAM.
668 The name of the buffer is made by surrounding NAME with `*'s.
669 PROGRAM should be either a string denoting an executable program to create
670 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
671 connection to be opened via `open-network-stream'. If there is already a
672 running process in that buffer, it is not restarted. Optional third arg
673 STARTFILE is the name of a file to send the contents of to the process.
675 If PROGRAM is a string, any more args are arguments to PROGRAM."
676 (apply #'make-comint-in-buffer name nil program startfile switches
))
679 (defun comint-run (program)
680 "Run PROGRAM in a comint buffer and switch to it.
681 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
682 The file name is used to make a symbol name, such as `comint-sh-hook', and any
683 hooks on this symbol are run in the buffer.
684 See `make-comint' and `comint-exec'."
685 (interactive "sRun program: ")
686 (let ((name (file-name-nondirectory program
)))
687 (switch-to-buffer (make-comint name program
))
688 (run-hooks (intern-soft (concat "comint-" name
"-hook")))))
690 (defun comint-exec (buffer name command startfile switches
)
691 "Start up a process in buffer BUFFER for comint modes.
692 Blasts any old process running in the buffer. Doesn't set the buffer mode.
693 You can use this to cheaply run a series of processes in the same comint
694 buffer. The hook `comint-exec-hook' is run after each exec."
697 (let ((proc (get-buffer-process buffer
))) ; Blast any old process.
698 (if proc
(delete-process proc
)))
699 ;; Crank up a new process
702 (open-network-stream name buffer
(car command
) (cdr command
))
703 (comint-exec-1 name buffer command switches
))))
704 (set-process-filter proc
'comint-output-filter
)
705 (make-local-variable 'comint-ptyp
)
706 (setq comint-ptyp process-connection-type
) ; t if pty, nil if pipe.
707 ;; Jump to the end, and set the process mark.
708 (goto-char (point-max))
709 (set-marker (process-mark proc
) (point))
710 ;; Feed it the startfile.
712 ;;This is guaranteed to wait long enough
713 ;;but has bad results if the comint does not prompt at all
714 ;; (while (= size (buffer-size))
716 ;;I hope 1 second is enough!
718 (goto-char (point-max))
719 (insert-file-contents startfile
)
720 (setq startfile
(buffer-substring (point) (point-max)))
721 (delete-region (point) (point-max))
722 (comint-send-string proc startfile
)))
723 (run-hooks 'comint-exec-hook
)
726 ;; This auxiliary function cranks up the process for comint-exec in
727 ;; the appropriate environment.
729 (defun comint-exec-1 (name buffer command switches
)
730 (let ((process-environment
732 ;; If using termcap, we specify `emacs' as the terminal type
733 ;; because that lets us specify a width.
734 ;; If using terminfo, we specify `dumb' because that is
735 ;; a defined terminal type. `emacs' is not a defined terminal type
736 ;; and there is no way for us to define it here.
737 ;; Some programs that use terminfo get very confused
738 ;; if TERM is not a valid terminal type.
739 ;; ;; There is similar code in compile.el.
740 (if (and (boundp 'system-uses-terminfo
) system-uses-terminfo
)
741 (list "TERM=dumb" "TERMCAP="
742 (format "COLUMNS=%d" (window-width)))
744 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
745 (if (getenv "EMACS") nil
(list "EMACS=t"))
746 process-environment
))
748 (if (file-accessible-directory-p default-directory
)
750 (char-to-string directory-sep-char
)))
751 proc decoding encoding changed
)
752 (let ((exec-path (if (file-name-directory command
)
753 ;; If the command has slashes, make sure we
754 ;; first look relative to the current directory.
755 (cons default-directory exec-path
) exec-path
)))
756 (setq proc
(apply 'start-process name buffer command switches
)))
757 (let ((coding-systems (process-coding-system proc
)))
758 (setq decoding
(car coding-systems
)
759 encoding
(cdr coding-systems
)))
760 ;; If start-process decided to use some coding system for decoding
761 ;; data sent from the process and the coding system doesn't
762 ;; specify EOL conversion, we had better convert CRLF to LF.
763 (if (vectorp (coding-system-eol-type decoding
))
764 (setq decoding
(coding-system-change-eol-conversion decoding
'dos
)
766 ;; Even if start-process left the coding system for encoding data
767 ;; sent from the process undecided, we had better use the same one
768 ;; as what we use for decoding. But, we should suppress EOL
770 (if (and decoding
(not encoding
))
771 (setq encoding
(coding-system-change-eol-conversion decoding
'unix
)
774 (set-process-coding-system proc decoding encoding
))
778 (defun comint-insert-clicked-input (event)
779 "In a comint buffer, set the current input to the clicked-on previous input."
781 (let ((over (catch 'found
782 ;; Ignore non-input overlays
783 (dolist (ov (overlays-at (posn-point (event-end event
))))
784 (when (eq (overlay-get ov
'field
) 'input
)
785 (throw 'found ov
))))))
786 ;; Do we have input in this area?
788 (let ((input-str (buffer-substring (overlay-start over
)
789 (overlay-end over
))))
790 (goto-char (point-max))
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))))
797 ;; Fall back to the global definition.
798 (let* ((keys (this-command-keys))
799 (last-key (and (vectorp keys
) (aref keys
(1- (length keys
)))))
800 (fun (and last-key
(lookup-key global-map
(vector last-key
)))))
801 (if fun
(call-interactively fun
))))))
804 ;; Input history processing in a buffer
805 ;; ===========================================================================
806 ;; Useful input history functions, courtesy of the Ergo group.
809 ;; comint-dynamic-list-input-ring List history in help buffer.
810 ;; comint-previous-input Previous input...
811 ;; comint-previous-matching-input ...matching a string.
812 ;; comint-previous-matching-input-from-input ... matching the current input.
813 ;; comint-next-input Next input...
814 ;; comint-next-matching-input ...matching a string.
815 ;; comint-next-matching-input-from-input ... matching the current input.
816 ;; comint-backward-matching-input Backwards input...
817 ;; comint-forward-matching-input ...matching a string.
818 ;; comint-replace-by-expanded-history Expand history at point;
819 ;; replace with expanded history.
820 ;; comint-magic-space Expand history and insert space.
823 ;; comint-read-input-ring Read into comint-input-ring...
824 ;; comint-write-input-ring Write to comint-input-ring-file-name.
825 ;; comint-replace-by-expanded-history-before-point Workhorse function.
827 (defun comint-read-input-ring (&optional silent
)
828 "Sets the buffer's `comint-input-ring' from a history file.
829 The name of the file is given by the variable `comint-input-ring-file-name'.
830 The history ring is of size `comint-input-ring-size', regardless of file size.
831 If `comint-input-ring-file-name' is nil this function does nothing.
833 If the optional argument SILENT is non-nil, we say nothing about a
834 failure to read the history file.
836 This function is useful for major mode commands and mode hooks.
838 The commands stored in the history file are separated by the
839 `comint-input-ring-separator', and entries that match
840 `comint-input-history-ignore' are ignored. The most recent command
843 See also `comint-input-ignoredups' and `comint-write-input-ring'."
844 (cond ((or (null comint-input-ring-file-name
)
845 (equal comint-input-ring-file-name
""))
847 ((not (file-readable-p comint-input-ring-file-name
))
849 (message "Cannot read history file %s"
850 comint-input-ring-file-name
)))
852 (let* ((history-buf (get-buffer-create " *temp*"))
853 (file comint-input-ring-file-name
)
855 (size comint-input-ring-size
)
856 (ring (make-ring size
)))
859 (set-buffer history-buf
)
862 (insert-file-contents file
)
863 ;; Save restriction in case file is already visited...
864 ;; Watch for those date stamps in history files!
865 (goto-char (point-max))
866 (let (start end history
)
867 (while (and (< count comint-input-ring-size
)
868 (re-search-backward comint-input-ring-separator nil t
)
869 (setq end
(match-beginning 0)))
870 (if (re-search-backward comint-input-ring-separator nil t
)
871 (setq start
(match-end 0))
872 (setq start
(point-min)))
873 (setq history
(buffer-substring start end
))
875 (if (and (not (string-match comint-input-history-ignore history
))
876 (or (null comint-input-ignoredups
)
878 (not (string-equal (ring-ref ring
0) history
))))
880 (ring-insert-at-beginning ring history
)
881 (setq count
(1+ count
)))))))
882 (kill-buffer history-buf
))
883 (setq comint-input-ring ring
884 comint-input-ring-index nil
)))))
886 (defun comint-write-input-ring ()
887 "Writes the buffer's `comint-input-ring' to a history file.
888 The name of the file is given by the variable `comint-input-ring-file-name'.
889 The original contents of the file are lost if `comint-input-ring' is not empty.
890 If `comint-input-ring-file-name' is nil this function does nothing.
892 Useful within process sentinels.
894 See also `comint-read-input-ring'."
895 (cond ((or (null comint-input-ring-file-name
)
896 (equal comint-input-ring-file-name
"")
897 (null comint-input-ring
) (ring-empty-p comint-input-ring
))
899 ((not (file-writable-p comint-input-ring-file-name
))
900 (message "Cannot write history file %s" comint-input-ring-file-name
))
902 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
903 (ring comint-input-ring
)
904 (file comint-input-ring-file-name
)
905 (index (ring-length ring
)))
906 ;; Write it all out into a buffer first. Much faster, but messier,
907 ;; than writing it one line at a time.
909 (set-buffer history-buf
)
912 (setq index
(1- index
))
913 (insert (ring-ref ring index
) comint-input-ring-separator
))
914 (write-region (buffer-string) nil file nil
'no-message
)
915 (kill-buffer nil
))))))
918 (defvar comint-dynamic-list-input-ring-window-conf
)
920 (defun comint-dynamic-list-input-ring-select ()
921 "Choose the input history entry that point is in or next to."
923 (let (beg end completion
(buffer completion-reference-buffer
)
924 (base-size completion-base-size
))
925 (if (and (not (eobp)) (get-text-property (point) 'mouse-face
))
926 (setq end
(point) beg
(1+ (point))))
927 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face
))
928 (setq end
(1- (point)) beg
(point)))
930 (error "No history entry here"))
931 (setq beg
(previous-single-property-change beg
'mouse-face
))
932 (setq end
(or (next-single-property-change end
'mouse-face
) (point-max)))
933 (setq completion
(buffer-substring beg end
))
934 (set-window-configuration comint-dynamic-list-input-ring-window-conf
)
935 (choose-completion-string completion buffer base-size
)))
937 (defun comint-dynamic-list-input-ring ()
938 "List in help buffer the buffer's input history."
940 (if (or (not (ring-p comint-input-ring
))
941 (ring-empty-p comint-input-ring
))
942 (message "No history")
944 (history-buffer " *Input History*")
945 (index (1- (ring-length comint-input-ring
)))
946 (conf (current-window-configuration)))
947 ;; We have to build up a list ourselves from the ring vector.
949 (setq history
(cons (ring-ref comint-input-ring index
) history
)
951 ;; Change "completion" to "history reference"
952 ;; to make the display accurate.
953 (with-output-to-temp-buffer history-buffer
954 (display-completion-list history
)
955 (set-buffer history-buffer
)
956 (let ((keymap (make-sparse-keymap)))
957 (set-keymap-parent keymap
(current-local-map))
958 (define-key keymap
"\C-m" 'comint-dynamic-list-input-ring-select
)
959 (use-local-map keymap
))
961 (while (search-backward "completion" nil
'move
)
962 (replace-match "history reference")))
964 (message "Hit space to flush")
965 (setq comint-dynamic-list-input-ring-window-conf conf
)
966 (let ((ch (read-event)))
968 (set-window-configuration conf
)
969 (setq unread-command-events
(list ch
)))))))
972 (defun comint-regexp-arg (prompt)
973 ;; Return list of regexp and prefix arg using PROMPT.
974 (let* (;; Don't clobber this.
975 (last-command last-command
)
976 (regexp (read-from-minibuffer prompt nil nil nil
977 'minibuffer-history-search-history
)))
978 (list (if (string-equal regexp
"")
979 (setcar minibuffer-history-search-history
980 (nth 1 minibuffer-history-search-history
))
982 (prefix-numeric-value current-prefix-arg
))))
984 (defun comint-search-arg (arg)
985 ;; First make sure there is a ring and that we are after the process mark
986 (cond ((not (comint-after-pmark-p))
987 (error "Not at command line"))
988 ((or (null comint-input-ring
)
989 (ring-empty-p comint-input-ring
))
990 (error "Empty input ring"))
992 ;; arg of zero resets search from beginning, and uses arg of 1
993 (setq comint-input-ring-index nil
)
998 (defun comint-search-start (arg)
999 ;; Index to start a directional search, starting at comint-input-ring-index
1000 (if comint-input-ring-index
1001 ;; If a search is running, offset by 1 in direction of arg
1002 (mod (+ comint-input-ring-index
(if (> arg
0) 1 -
1))
1003 (ring-length comint-input-ring
))
1004 ;; For a new search, start from beginning or end, as appropriate
1006 0 ; First elt for forward search
1007 (1- (ring-length comint-input-ring
))))) ; Last elt for backward search
1009 (defun comint-previous-input-string (arg)
1010 "Return the string ARG places along the input ring.
1011 Moves relative to `comint-input-ring-index'."
1012 (ring-ref comint-input-ring
(if comint-input-ring-index
1013 (mod (+ arg comint-input-ring-index
)
1014 (ring-length comint-input-ring
))
1017 (defun comint-previous-input (arg)
1018 "Cycle backwards through input history."
1020 (comint-previous-matching-input "." arg
))
1022 (defun comint-next-input (arg)
1023 "Cycle forwards through input history."
1025 (comint-previous-input (- arg
)))
1027 (defun comint-previous-matching-input-string (regexp arg
)
1028 "Return the string matching REGEXP ARG places along the input ring.
1029 Moves relative to `comint-input-ring-index'."
1030 (let* ((pos (comint-previous-matching-input-string-position regexp arg
)))
1031 (if pos
(ring-ref comint-input-ring pos
))))
1033 (defun comint-previous-matching-input-string-position (regexp arg
&optional start
)
1034 "Return the index matching REGEXP ARG places along the input ring.
1035 Moves relative to START, or `comint-input-ring-index'."
1036 (if (or (not (ring-p comint-input-ring
))
1037 (ring-empty-p comint-input-ring
))
1038 (error "No history"))
1039 (let* ((len (ring-length comint-input-ring
))
1040 (motion (if (> arg
0) 1 -
1))
1041 (n (mod (- (or start
(comint-search-start arg
)) motion
) len
))
1042 (tried-each-ring-item nil
)
1044 ;; Do the whole search as many times as the argument says.
1045 (while (and (/= arg
0) (not tried-each-ring-item
))
1048 n
(mod (+ n motion
) len
))
1049 ;; If we haven't reached a match, step some more.
1050 (while (and (< n len
) (not tried-each-ring-item
)
1051 (not (string-match regexp
(ring-ref comint-input-ring n
))))
1052 (setq n
(mod (+ n motion
) len
)
1053 ;; If we have gone all the way around in this search.
1054 tried-each-ring-item
(= n prev
)))
1055 (setq arg
(if (> arg
0) (1- arg
) (1+ arg
))))
1056 ;; Now that we know which ring element to use, if we found it, return that.
1057 (if (string-match regexp
(ring-ref comint-input-ring n
))
1060 (defun comint-previous-matching-input (regexp arg
)
1061 "Search backwards through input history for match for REGEXP.
1062 \(Previous history elements are earlier commands.)
1063 With prefix argument N, search for Nth previous match.
1064 If N is negative, find the next or Nth next match."
1065 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1066 (setq arg
(comint-search-arg arg
))
1067 (let ((pos (comint-previous-matching-input-string-position regexp arg
)))
1068 ;; Has a match been found?
1071 (setq comint-input-ring-index pos
)
1072 (message "History item: %d" (1+ pos
))
1074 ;; Can't use kill-region as it sets this-command
1075 (or (marker-position comint-accum-marker
)
1076 (process-mark (get-buffer-process (current-buffer))))
1078 (insert (ring-ref comint-input-ring pos
)))))
1080 (defun comint-next-matching-input (regexp arg
)
1081 "Search forwards through input history for match for REGEXP.
1082 \(Later history elements are more recent commands.)
1083 With prefix argument N, search for Nth following match.
1084 If N is negative, find the previous or Nth previous match."
1085 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1086 (comint-previous-matching-input regexp
(- arg
)))
1088 (defun comint-previous-matching-input-from-input (arg)
1089 "Search backwards through input history for match for current input.
1090 \(Previous history elements are earlier commands.)
1091 With prefix argument N, search for Nth previous match.
1092 If N is negative, search forwards for the -Nth following match."
1094 (if (not (memq last-command
'(comint-previous-matching-input-from-input
1095 comint-next-matching-input-from-input
)))
1096 ;; Starting a new search
1097 (setq comint-matching-input-from-input-string
1099 (or (marker-position comint-accum-marker
)
1100 (process-mark (get-buffer-process (current-buffer))))
1102 comint-input-ring-index nil
))
1103 (comint-previous-matching-input
1104 (concat "^" (regexp-quote comint-matching-input-from-input-string
))
1107 (defun comint-next-matching-input-from-input (arg)
1108 "Search forwards through input history for match for current input.
1109 \(Following history elements are more recent commands.)
1110 With prefix argument N, search for Nth following match.
1111 If N is negative, search backwards for the -Nth previous match."
1113 (comint-previous-matching-input-from-input (- arg
)))
1116 (defun comint-replace-by-expanded-history (&optional silent start
)
1117 "Expand input command history references before point.
1118 Expansion is dependent on the value of `comint-input-autoexpand'.
1120 This function depends on the buffer's idea of the input history, which may not
1121 match the command interpreter's idea, assuming it has one.
1123 Assumes history syntax is like typical Un*x shells'. However, since emacs
1124 cannot know the interpreter's idea of input line numbers, assuming it has one,
1125 it cannot expand absolute input line number references.
1127 If the optional argument SILENT is non-nil, never complain
1128 even if history reference seems erroneous.
1130 If the optional argument START is non-nil, that specifies the
1131 start of the text to scan for history references, rather
1132 than the logical beginning of line.
1134 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1136 Returns t if successful."
1138 (if (and comint-input-autoexpand
1139 (if comint-use-prompt-regexp-instead-of-fields
1140 ;; Use comint-prompt-regexp
1143 (looking-at (concat comint-prompt-regexp
"!\\|\\^")))
1144 ;; Use input fields. User input that hasn't been entered
1145 ;; yet, at the end of the buffer, has a nil `field' property.
1146 (and (null (get-char-property (point) 'field
))
1147 (string-match "!\\|^\\^" (field-string)))))
1148 ;; Looks like there might be history references in the command.
1149 (let ((previous-modified-tick (buffer-modified-tick)))
1150 (comint-replace-by-expanded-history-before-point silent start
)
1151 (/= previous-modified-tick
(buffer-modified-tick)))))
1154 (defun comint-replace-by-expanded-history-before-point (silent &optional start
)
1155 "Expand directory stack reference before point.
1156 See `comint-replace-by-expanded-history'. Returns t if successful.
1158 If the optional argument START is non-nil, that specifies the
1159 start of the text to scan for history references, rather
1160 than the logical beginning of line."
1162 (let ((toend (- (line-end-position) (point)))
1163 (start (comint-line-beginning-position)))
1166 (skip-chars-forward "^!^" (- (line-end-position) toend
))
1167 (< (point) (- (line-end-position) toend
)))
1168 ;; This seems a bit complex. We look for references such as !!, !-num,
1169 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1170 ;; If that wasn't enough, the plings can be suffixed with argument
1171 ;; range specifiers.
1172 ;; Argument ranges are complex too, so we hive off the input line,
1173 ;; referenced with plings, with the range string to `comint-args'.
1174 (setq comint-input-ring-index nil
)
1175 (cond ((or (= (preceding-char) ?
\\)
1176 (comint-within-quotes start
(point)))
1177 ;; The history is quoted, or we're in quotes.
1178 (goto-char (1+ (point))))
1179 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1180 ;; We cannot know the interpreter's idea of input line numbers.
1181 (goto-char (match-end 0))
1182 (message "Absolute reference cannot be expanded"))
1183 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1184 ;; Just a number of args from `number' lines backward.
1185 (let ((number (1- (string-to-number
1186 (buffer-substring (match-beginning 1)
1188 (if (<= number
(ring-length comint-input-ring
))
1191 (comint-args (comint-previous-input-string number
)
1192 (match-beginning 2) (match-end 2))
1194 (setq comint-input-ring-index number
)
1195 (message "History item: %d" (1+ number
)))
1196 (goto-char (match-end 0))
1197 (message "Relative reference exceeds input history size"))))
1198 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1199 ;; Just a number of args from the previous input line.
1201 (comint-args (comint-previous-input-string 0)
1202 (match-beginning 1) (match-end 1))
1204 (message "History item: previous"))
1206 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1207 ;; Most recent input starting with or containing (possibly
1208 ;; protected) string, maybe just a number of args. Phew.
1209 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1210 (mb2 (match-beginning 2)) (me2 (match-end 2))
1211 (exp (buffer-substring (or mb2 mb1
) (or me2 me1
)))
1212 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1213 (pos (save-match-data
1214 (comint-previous-matching-input-string-position
1215 (concat pref
(regexp-quote exp
)) 1))))
1218 (goto-char (match-end 0))
1220 (progn (message "Not found")
1222 (setq comint-input-ring-index pos
)
1224 (comint-args (ring-ref comint-input-ring pos
)
1225 (match-beginning 4) (match-end 4))
1227 (message "History item: %d" (1+ pos
)))))
1228 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1229 ;; Quick substitution on the previous input line.
1230 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1231 (new (buffer-substring (match-beginning 2) (match-end 2)))
1233 (replace-match (comint-previous-input-string 0) t t
)
1235 (goto-char (match-beginning 0))
1236 (if (not (search-forward old pos t
))
1238 (error "Not found"))
1239 (replace-match new t t
)
1240 (message "History item: substituted"))))
1242 (forward-char 1)))))))
1245 (defun comint-magic-space (arg)
1246 "Expand input history references before point and insert ARG spaces.
1247 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1249 (comint-replace-by-expanded-history)
1250 (self-insert-command arg
))
1252 (defun comint-within-quotes (beg end
)
1253 "Return t if the number of quotes between BEG and END is odd.
1254 Quotes are single and double."
1255 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end
))
1256 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end
)))
1257 (or (= (mod countsq
2) 1) (= (mod countdq
2) 1))))
1259 (defun comint-how-many-region (regexp beg end
)
1260 "Return number of matches for REGEXP from BEG to END."
1265 (while (re-search-forward regexp end t
)
1266 (setq count
(1+ count
)))))
1269 (defun comint-args (string begin end
)
1270 ;; From STRING, return the args depending on the range specified in the text
1271 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1272 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1275 (comint-arguments string
0 nil
)
1276 (let* ((range (buffer-substring
1277 (if (eq (char-after begin
) ?
:) (1+ begin
) begin
) end
))
1278 (nth (cond ((string-match "^[*^]" range
) 1)
1279 ((string-match "^-" range
) 0)
1280 ((string-equal range
"$") nil
)
1281 (t (string-to-number range
))))
1282 (mth (cond ((string-match "[-*$]$" range
) nil
)
1283 ((string-match "-" range
)
1284 (string-to-number (substring range
(match-end 0))))
1286 (comint-arguments string nth mth
)))))
1288 ;; Return a list of arguments from ARG. Break it up at the
1289 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1290 (defun comint-delim-arg (arg)
1291 (if (null comint-delimiter-argument-list
)
1297 (let ((char (aref arg pos
))
1299 (if (memq char comint-delimiter-argument-list
)
1300 (while (and (< pos len
) (eq (aref arg pos
) char
))
1301 (setq pos
(1+ pos
)))
1302 (while (and (< pos len
)
1303 (not (memq (aref arg pos
)
1304 comint-delimiter-argument-list
)))
1305 (setq pos
(1+ pos
))))
1306 (setq args
(cons (substring arg start pos
) args
))))
1309 (defun comint-arguments (string nth mth
)
1310 "Return from STRING the NTH to MTH arguments.
1311 NTH and/or MTH can be nil, which means the last argument.
1312 Returned arguments are separated by single spaces.
1313 We assume whitespace separates arguments, except within quotes
1314 and except for a space or tab that immediately follows a backslash.
1315 Also, a run of one or more of a single character
1316 in `comint-delimiter-argument-list' is a separate argument.
1317 Argument 0 is the command name."
1318 ;; The first line handles ordinary characters and backslash-sequences
1319 ;; (except with w32 msdos-like shells, where backslashes are valid).
1320 ;; The second matches "-quoted strings.
1321 ;; The third matches '-quoted strings.
1322 ;; The fourth matches `-quoted strings.
1323 ;; This seems to fit the syntax of BASH 2.0.
1324 (let* ((first (if (and (eq system-type
'windows-nt
)
1325 (w32-shell-dos-semantics))
1327 "[^ \n\t\"'`\\]+\\|\\\\[\"'`\\ \t]+\\|"))
1328 (argpart (concat first
1329 "\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\
1334 beg str value quotes
)
1335 ;; Build a list of all the args until we have as many as we want.
1336 (while (and (or (null mth
) (<= count mth
))
1337 (string-match argpart string pos
))
1338 (if (and beg
(= pos
(match-beginning 0)))
1339 ;; It's contiguous, part of the same arg.
1340 (setq pos
(match-end 0)
1341 quotes
(or quotes
(match-beginning 1)))
1342 ;; It's a new separate arg.
1344 ;; Put the previous arg, if there was one, onto ARGS.
1345 (setq str
(substring string beg pos
)
1346 args
(if quotes
(cons str args
)
1347 (nconc (comint-delim-arg str
) args
))
1349 (setq quotes
(match-beginning 1))
1350 (setq beg
(match-beginning 0))
1351 (setq pos
(match-end 0))))
1353 (setq str
(substring string beg pos
)
1354 args
(if quotes
(cons str args
)
1355 (nconc (comint-delim-arg str
) args
))
1357 (let ((n (or nth
(1- count
)))
1358 (m (if mth
(1- (- count mth
)) 0)))
1360 (function (lambda (a) a
)) (nthcdr n
(nreverse (nthcdr m args
))) " "))))
1363 ;; Input processing stuff
1365 (defun comint-add-to-input-history (cmd)
1366 "Add CMD to the input history.
1367 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1368 (if (and (funcall comint-input-filter cmd
)
1369 (or (null comint-input-ignoredups
)
1370 (not (ring-p comint-input-ring
))
1371 (ring-empty-p comint-input-ring
)
1372 (not (string-equal (ring-ref comint-input-ring
0)
1374 (ring-insert comint-input-ring cmd
)))
1376 (defun comint-send-input (&optional no-newline
)
1377 "Send input to process.
1378 After the process output mark, sends all text from the process mark to
1379 point as input to the process. Before the process output mark, calls
1380 value of variable `comint-get-old-input' to retrieve old input, copies
1381 it to the process mark, and sends it. A terminal newline is also
1382 inserted into the buffer and sent to the process.
1384 Any history reference may be expanded depending on the value of the variable
1385 `comint-input-autoexpand'. The list of function names contained in the value
1386 of `comint-input-filter-functions' is called on the input before sending it.
1387 The input is entered into the input history ring, if the value of variable
1388 `comint-input-filter' returns non-nil when called on the input.
1390 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1391 end of line before sending the input.
1393 After the input has been sent, if `comint-process-echoes' is non-nil,
1394 then comint-send-input waits to see if the process outputs a string
1395 matching the input, and if so, deletes that part of the output.
1397 The values of `comint-get-old-input', `comint-input-filter-functions', and
1398 `comint-input-filter' are chosen according to the command interpreter running
1399 in the buffer. E.g.,
1401 If the interpreter is the csh,
1402 comint-get-old-input is the default:
1403 If `comint-use-prompt-regexp-instead-of-fields' is nil, then
1404 either return the current input field, if point is on an input
1405 field, or the current line, if point is on an output field.
1406 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then
1407 return the current line with any initial string matching the
1408 regexp `comint-prompt-regexp' removed.
1409 comint-input-filter-functions monitors input for \"cd\", \"pushd\", and
1410 \"popd\" commands. When it sees one, it cd's the buffer.
1411 comint-input-filter is the default: returns t if the input isn't all white
1414 If the comint is Lucid Common Lisp,
1415 comint-get-old-input snarfs the sexp ending at point.
1416 comint-input-filter-functions does nothing.
1417 comint-input-filter returns nil if the input matches input-filter-regexp,
1418 which matches (1) all whitespace (2) :a, :c, etc.
1420 Similarly for Soar, Scheme, etc."
1422 ;; Note that the input string does not include its terminal newline.
1423 (let ((proc (get-buffer-process (current-buffer))))
1424 (if (not proc
) (error "Current buffer has no process")
1425 (let* ((pmark (process-mark proc
))
1426 (intxt (if (>= (point) (marker-position pmark
))
1427 (progn (if comint-eol-on-send
(end-of-line))
1428 (buffer-substring pmark
(point)))
1429 (let ((copy (funcall comint-get-old-input
)))
1433 (input (if (not (eq comint-input-autoexpand
'input
))
1434 ;; Just whatever's already there
1436 ;; Expand and leave it visible in buffer
1437 (comint-replace-by-expanded-history t pmark
)
1438 (buffer-substring pmark
(point))))
1439 (history (if (not (eq comint-input-autoexpand
'history
))
1441 ;; This is messy 'cos ultimately the original
1442 ;; functions used do insertion, rather than return
1443 ;; strings. We have to expand, then insert back.
1444 (comint-replace-by-expanded-history t pmark
)
1445 (let ((copy (buffer-substring pmark
(point)))
1448 (delete-region pmark start
)
1454 (comint-add-to-input-history history
)
1456 (run-hook-with-args 'comint-input-filter-functions
1457 (if no-newline input
1458 (concat input
"\n")))
1460 (let ((beg (marker-position pmark
))
1461 (end (if no-newline
(point) (1- (point)))))
1462 (when (not (> beg end
)) ; handle a special case
1463 ;; Make an overlay for the input field
1464 (let ((over (make-overlay beg end nil nil t
)))
1465 (unless comint-use-prompt-regexp-instead-of-fields
1466 ;; Give old user input a field property of `input', to
1467 ;; distinguish it from both process output and unsent
1468 ;; input. The terminating newline is put into a special
1469 ;; `boundary' field to make cursor movement between input
1470 ;; and output fields smoother.
1471 (overlay-put over
'field
'input
))
1472 (when comint-highlight-input
1473 (overlay-put over
'face
'comint-highlight-input
)
1474 (overlay-put over
'mouse-face
'highlight
)
1477 "mouse-2: insert after prompt as new input")
1478 (overlay-put over
'evaporate t
))))
1479 (unless comint-use-prompt-regexp-instead-of-fields
1480 ;; Make an overlay for the terminating newline
1481 (let ((over (make-overlay end
(1+ end
) nil t nil
)))
1482 (overlay-put over
'field
'boundary
)
1483 (overlay-put over
'inhibit-line-move-field-capture t
)
1484 (overlay-put over
'evaporate t
))))
1486 (comint-snapshot-last-prompt)
1488 (setq comint-save-input-ring-index comint-input-ring-index
)
1489 (setq comint-input-ring-index nil
)
1490 ;; Update the markers before we send the input
1491 ;; in case we get output amidst sending the input.
1492 (set-marker comint-last-input-start pmark
)
1493 (set-marker comint-last-input-end
(point))
1494 (set-marker (process-mark proc
) (point))
1495 ;; clear the "accumulation" marker
1496 (set-marker comint-accum-marker nil
)
1497 (let ((comint-input-sender-no-newline no-newline
))
1498 (funcall comint-input-sender proc input
))
1500 ;; Optionally delete echoed input (after checking it).
1501 (when comint-process-echoes
1502 (let ((echo-len (- comint-last-input-end
1503 comint-last-input-start
)))
1504 ;; Wait for all input to be echoed:
1505 (while (and (accept-process-output proc
)
1506 (> (+ comint-last-input-end echo-len
)
1509 (compare-buffer-substrings
1510 nil comint-last-input-start
1511 (- (point-max) echo-len
)
1512 ;; Above difference is equivalent to
1513 ;; (+ comint-last-input-start
1514 ;; (- (point-max) comint-last-input-end))
1515 nil comint-last-input-end
(point-max)))))
1517 (<= (+ comint-last-input-end echo-len
)
1520 (compare-buffer-substrings
1521 nil comint-last-input-start comint-last-input-end
1522 nil comint-last-input-end
1523 (+ comint-last-input-end echo-len
))))
1524 (delete-region comint-last-input-end
1525 (+ comint-last-input-end echo-len
)))))
1527 ;; This used to call comint-output-filter-functions,
1528 ;; but that scrolled the buffer in undesirable ways.
1529 (run-hook-with-args 'comint-output-filter-functions
"")))))
1531 (defvar comint-preoutput-filter-functions nil
1532 "List of functions to call before inserting Comint output into the buffer.
1533 Each function gets one argument, a string containing the text received
1534 from the subprocess. It should return the string to insert, perhaps
1535 the same string that was received, or perhaps a modified or transformed
1538 The functions on the list are called sequentially, and each one is
1539 given the string returned by the previous one. The string returned by
1540 the last function is the text that is actually inserted in the
1543 You can use `add-hook' to add functions to this list
1544 either globally or locally.")
1546 ;; When non-nil, this is the last overlay used for output.
1547 ;; It is kept around so that we can extend it instead of creating
1548 ;; multiple contiguous overlays for multiple contiguous output chunks.
1549 (defvar comint-last-output-overlay nil
)
1551 ;; When non-nil, this is an overlay over the last recognized prompt in
1552 ;; the buffer; it is used when highlighting the prompt.
1553 (defvar comint-last-prompt-overlay nil
)
1555 ;; `snapshot' any current comint-last-prompt-overlay, freezing it in place.
1556 ;; Any further output will then create a new comint-last-prompt-overlay.
1557 (defun comint-snapshot-last-prompt ()
1558 (when comint-last-prompt-overlay
1559 (overlay-put comint-last-prompt-overlay
'evaporate t
)
1560 (setq comint-last-prompt-overlay nil
)))
1562 (defun comint-carriage-motion (string)
1563 "Handle carriage control characters in comint output.
1564 Translate carriage return/linefeed sequences to linefeeds.
1565 Make single carriage returns delete to the beginning of the line.
1566 Make backspaces delete the previous character.
1568 This function should be in the list `comint-output-filter-functions'."
1570 ;; We first check to see if STRING contains any magic characters, to
1571 ;; avoid overhead in the common case where it does not
1572 (when (string-match "[\r\b]" string
)
1573 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1577 (let ((inhibit-field-text-motion t
)
1578 (buffer-read-only nil
))
1580 ;; Note that this won't work properly when the CR and LF
1581 ;; are in different output chunks, but this is probably an
1582 ;; exceedingly rare case (because they are generally
1583 ;; written as a unit), and to delay interpretation of a
1584 ;; trailing CR in a chunk would result in odd interactive
1585 ;; behavior (and this case is probably far more common).
1586 (goto-char comint-last-output-start
)
1587 (while (re-search-forward "\r$" pmark t
)
1589 ;; bare CR -> delete preceding line
1590 (goto-char comint-last-output-start
)
1591 (while (search-forward "\r" pmark t
)
1592 (delete-region (point) (line-beginning-position)))
1593 ;; BS -> delete preceding character
1594 (goto-char comint-last-output-start
)
1595 (while (search-forward "\b" pmark t
)
1596 (delete-char -
2)))))))))
1598 (add-hook 'comint-output-filter-functions
'comint-carriage-motion
)
1600 ;; The purpose of using this filter for comint processes
1601 ;; is to keep comint-last-input-end from moving forward
1602 ;; when output is inserted.
1603 (defun comint-output-filter (process string
)
1604 (let ((oprocbuf (process-buffer process
)))
1605 ;; First check for killed buffer or no input.
1606 (when (and string oprocbuf
(buffer-name oprocbuf
))
1607 (with-current-buffer oprocbuf
1608 ;; Run preoutput filters
1609 (let ((functions comint-preoutput-filter-functions
))
1610 (while (and functions string
)
1611 (if (eq (car functions
) t
)
1612 (let ((functions (default-value 'comint-preoutput-filter-functions
)))
1613 (while (and functions string
)
1614 (setq string
(funcall (car functions
) string
))
1615 (setq functions
(cdr functions
))))
1616 (setq string
(funcall (car functions
) string
)))
1617 (setq functions
(cdr functions
))))
1620 (let ((buffer-read-only nil
)
1621 ;; Avoid the overhead of save-excursion, since we just
1622 ;; fiddle with the point
1623 (saved-point (point-marker)))
1625 ;; The point should float after any insertion we do
1626 (set-marker-insertion-type saved-point t
)
1628 ;; We temporarly remove any buffer narrowing, in case the
1629 ;; process mark is outside of the restriction
1633 (goto-char (process-mark process
))
1634 (set-marker comint-last-output-start
(point))
1636 ;; insert-before-markers is a bad thing. XXX
1638 ;; It is used here to force window-point markers (used to
1639 ;; store the value of point in non-selected windows) to
1640 ;; advance, but it also screws up any other markers that we
1641 ;; don't _want_ to advance, such as the start-marker of some
1642 ;; of the overlays we create.
1644 ;; We work around the problem with the overlays by
1645 ;; explicitly adjusting them after we do the insertion, but
1646 ;; in the future this problem should be solved correctly, by
1647 ;; using `insert', and making the insertion-type of
1648 ;; window-point markers settable (via a buffer-local
1649 ;; variable). In comint buffers, this variable would be set
1650 ;; to `t', to cause point in non-select windows to advance.
1651 (insert-before-markers string
)
1652 ;; Fixup markers and overlays that got screwed up because we
1653 ;; used `insert-before-markers'.
1654 (let ((old-point (- (point) (length string
))))
1655 ;; comint-last-output-start
1656 (set-marker comint-last-output-start old-point
)
1657 ;; comint-last-input-end
1658 (when (and comint-last-input-end
1659 (equal (marker-position comint-last-input-end
)
1661 (set-marker comint-last-input-end old-point
))
1662 ;; No overlays we create are set to advance upon insertion
1663 ;; (at the start/end), so we assume that any overlay which
1664 ;; is at the current point was incorrectly advanced by
1665 ;; insert-before-markers. First fixup overlays that might
1667 (dolist (over (overlays-at (point)))
1668 (when (= (overlay-start over
) (point))
1669 (let ((end (overlay-end over
)))
1672 (if (= end
(point)) old-point end
)))))
1673 ;; Then do overlays that might end at point:
1674 (dolist (over (overlays-at (1- (point))))
1675 (when (= (overlay-end over
) (point))
1677 (min (overlay-start over
) old-point
)
1680 ;; Advance process-mark
1681 (set-marker (process-mark process
) (point))
1683 (unless comint-use-prompt-regexp-instead-of-fields
1684 ;; We check to see if the last overlay used for output is
1685 ;; adjacent to the new input, and if so, just extend it.
1686 (if (and comint-last-output-overlay
1687 (equal (overlay-end comint-last-output-overlay
)
1688 (marker-position comint-last-output-start
)))
1689 ;; Extend comint-last-output-overlay to include the
1690 ;; most recent output
1691 (move-overlay comint-last-output-overlay
1692 (overlay-start comint-last-output-overlay
)
1694 ;; Create a new overlay
1695 (let ((over (make-overlay comint-last-output-start
(point))))
1696 (overlay-put over
'field
'output
)
1697 (overlay-put over
'inhibit-line-move-field-capture t
)
1698 (overlay-put over
'evaporate t
)
1699 (setq comint-last-output-overlay over
))))
1701 (when comint-highlight-prompt
1702 ;; Highlight the prompt, where we define `prompt' to mean
1703 ;; the most recent output that doesn't end with a newline.
1704 (unless (and (bolp) (null comint-last-prompt-overlay
))
1705 ;; Need to create or move the prompt overlay (in the case
1706 ;; where there is no prompt ((bolp) == t), we still do
1707 ;; this if there's already an existing overlay).
1708 (let ((prompt-start (save-excursion (forward-line 0) (point))))
1709 (if comint-last-prompt-overlay
1710 ;; Just move an existing overlay
1711 (move-overlay comint-last-prompt-overlay
1712 prompt-start
(point))
1713 ;; Need to create the overlay
1714 (setq comint-last-prompt-overlay
1715 (make-overlay prompt-start
(point)))
1716 (overlay-put comint-last-prompt-overlay
1717 'face
'comint-highlight-prompt
)))))
1719 (goto-char saved-point
)
1721 (run-hook-with-args 'comint-output-filter-functions string
)))))))
1723 (defun comint-preinput-scroll-to-bottom ()
1724 "Go to the end of buffer in all windows showing it.
1725 Movement occurs if point in the selected window is not after the process mark,
1726 and `this-command' is an insertion command. Insertion commands recognised
1727 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1728 Depends on the value of `comint-scroll-to-bottom-on-input'.
1730 This function should be a pre-command hook."
1731 (if (and comint-scroll-to-bottom-on-input
1732 (memq this-command
'(self-insert-command comint-magic-space yank
1734 (let* ((selected (selected-window))
1735 (current (current-buffer))
1736 (process (get-buffer-process current
))
1737 (scroll comint-scroll-to-bottom-on-input
))
1738 (if (and process
(< (point) (process-mark process
)))
1739 (if (eq scroll
'this
)
1740 (goto-char (point-max))
1742 (function (lambda (window)
1743 (if (and (eq (window-buffer window
) current
)
1744 (or (eq scroll t
) (eq scroll
'all
)))
1746 (select-window window
)
1747 (goto-char (point-max))
1748 (select-window selected
)))))
1751 (defun comint-postoutput-scroll-to-bottom (string)
1752 "Go to the end of buffer in all windows showing it.
1753 Does not scroll if the current line is the last line in the buffer.
1754 Depends on the value of `comint-scroll-to-bottom-on-output' and
1755 `comint-scroll-show-maximum-output'.
1757 This function should be in the list `comint-output-filter-functions'."
1758 (let* ((selected (selected-window))
1759 (current (current-buffer))
1760 (process (get-buffer-process current
))
1761 (scroll comint-scroll-to-bottom-on-output
))
1765 (function (lambda (window)
1766 (if (eq (window-buffer window
) current
)
1768 (select-window window
)
1769 (if (and (< (point) (process-mark process
))
1770 (or (eq scroll t
) (eq scroll
'all
)
1771 ;; Maybe user wants point to jump to end.
1772 (and (eq scroll
'this
) (eq selected window
))
1773 (and (eq scroll
'others
) (not (eq selected window
)))
1774 ;; If point was at the end, keep it at end.
1775 (and (marker-position comint-last-output-start
)
1776 (>= (point) comint-last-output-start
))))
1777 (goto-char (process-mark process
)))
1778 ;; Optionally scroll so that the text
1779 ;; ends at the bottom of the window.
1780 (if (and comint-scroll-show-maximum-output
1781 (>= (point) (process-mark process
)))
1783 (goto-char (point-max))
1785 (select-window selected
)))))
1787 (set-buffer current
))))
1789 (defun comint-truncate-buffer (&optional string
)
1790 "Truncate the buffer to `comint-buffer-maximum-size'.
1791 This function could be on `comint-output-filter-functions' or bound to a key."
1794 (goto-char (process-mark (get-buffer-process (current-buffer))))
1795 (forward-line (- comint-buffer-maximum-size
))
1797 (delete-region (point-min) (point))))
1799 (defun comint-strip-ctrl-m (&optional string
)
1800 "Strip trailing `^M' characters from the current output group.
1801 This function could be on `comint-output-filter-functions' or bound to a key."
1803 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1807 (if (interactive-p) comint-last-input-end comint-last-output-start
))
1809 (while (re-search-forward "\r+$" pmark t
)
1810 (replace-match "" t t
)))))
1811 (defalias 'shell-strip-ctrl-m
'comint-strip-ctrl-m
)
1813 (defun comint-show-maximum-output ()
1814 "Put the end of the buffer at the bottom of the window."
1816 (goto-char (point-max))
1819 (defun comint-get-old-input-default ()
1820 "Default for `comint-get-old-input'.
1821 If `comint-use-prompt-regexp-instead-of-fields' is nil, then either
1822 return the current input field, if point is on an input field, or the
1823 current line, if point is on an output field.
1824 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then return
1825 the current line with any initial string matching the regexp
1826 `comint-prompt-regexp' removed."
1827 (let ((bof (field-beginning)))
1828 (if (eq (get-char-property bof
'field
) 'input
)
1831 (buffer-substring (point) (line-end-position)))))
1833 (defun comint-copy-old-input ()
1834 "Insert after prompt old input at point as new input to be edited.
1835 Calls `comint-get-old-input' to get old input."
1837 (let ((input (funcall comint-get-old-input
))
1838 (process (get-buffer-process (current-buffer))))
1840 (error "Current buffer has no process")
1841 (goto-char (process-mark process
))
1844 (defun comint-skip-prompt ()
1845 "Skip past the text matching regexp `comint-prompt-regexp'.
1846 If this takes us past the end of the current line, don't skip at all."
1847 (let ((eol (save-excursion (end-of-line) (point))))
1848 (if (and (looking-at comint-prompt-regexp
)
1849 (<= (match-end 0) eol
))
1850 (goto-char (match-end 0)))))
1852 (defun comint-after-pmark-p ()
1853 "Return t if point is after the process output marker."
1854 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1855 (<= (marker-position pmark
) (point))))
1857 (defun comint-simple-send (proc string
)
1858 "Default function for sending to PROC input STRING.
1859 This just sends STRING plus a newline. To override this,
1860 set the hook `comint-input-sender'."
1861 (comint-send-string proc string
)
1862 (if comint-input-sender-no-newline
1863 (if (not (string-equal string
""))
1865 (comint-send-string proc
"\n")))
1867 (defun comint-line-beginning-position ()
1868 "Returns the buffer position of the beginning of the line, after any prompt.
1869 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1870 prompt skip is done by skipping text matching the regular expression
1871 `comint-prompt-regexp', a buffer local variable."
1872 (if comint-use-prompt-regexp-instead-of-fields
1873 ;; Use comint-prompt-regexp
1876 (comint-skip-prompt)
1878 ;; Use input fields. Note that, unlike the behavior of
1879 ;; `line-beginning-position' inside a field, this function will
1880 ;; return the position of the end of a prompt, even if the point is
1881 ;; already inside the prompt. In order to do this, it assumes that
1882 ;; if there are two fields on a line, then the first one is the
1883 ;; prompt, and the second one is an input field, and is front-sticky
1884 ;; (as input fields should be).
1885 (constrain-to-field (line-beginning-position) (line-end-position))))
1887 (defun comint-bol (&optional arg
)
1888 "Goes to the beginning of line, then skips past the prompt, if any.
1889 If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
1890 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1891 prompt skip is done by skipping text matching the regular expression
1892 `comint-prompt-regexp', a buffer local variable."
1895 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1897 (goto-char (comint-line-beginning-position))))
1899 ;; These three functions are for entering text you don't want echoed or
1900 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1901 ;; Just enter m-x send-invisible and type in your line, or add
1902 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1904 (defun comint-read-noecho (prompt &optional stars
)
1905 "Read a single line of text from user without echoing, and return it.
1906 Prompt with argument PROMPT, a string. Optional argument STARS causes
1907 input to be echoed with '*' characters on the prompt line. Input ends with
1908 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1909 `inhibit-quit' is set because e.g. this function was called from a process
1910 filter and C-g is pressed, this function returns nil rather than a string).
1912 Note that the keystrokes comprising the text can still be recovered
1913 \(temporarily) with \\[view-lossage]. Some people find this worrysome.
1914 Once the caller uses the password, it can erase the password
1915 by doing (fillarray STRING 0)."
1920 (cursor-in-echo-area t
)
1921 (message-log-max nil
)
1925 (message "%s%s" prompt
(make-string (length ans
) ?
*))
1926 (message "%s" prompt
))
1927 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1928 (setq c
(read-char-exclusive))
1930 ;; This function may get called from a process filter, where
1931 ;; inhibit-quit is set. In later versions of emacs read-char
1932 ;; may clear quit-flag itself and return C-g. That would make
1933 ;; it impossible to quit this loop in a simple way, so
1934 ;; re-enable it here (for backward-compatibility the check for
1935 ;; quit-flag below would still be necessary, so this seems
1936 ;; like the simplest way to do things).
1939 ((or (= c ?
\r) (= c ?
\n) (= c ?\e
))
1944 ((and (/= c ?
\b) (/= c ?
\177))
1945 (setq newans
(concat ans
(char-to-string c
)))
1949 (aset ans
(1- (length ans
)) 0)
1950 (setq ans
(substring ans
0 -
1)))))
1952 ;; Emulate a true quit, except that we have to return a value.
1954 (setq quit-flag nil
)
1960 (defun send-invisible (str)
1961 "Read a string without echoing.
1962 Then send it to the process running in the current buffer.
1963 The string is sent using `comint-input-sender'.
1964 Security bug: your string can still be temporarily recovered with
1966 (interactive "P") ; Defeat snooping via C-x ESC ESC
1967 (let ((proc (get-buffer-process (current-buffer))))
1969 (error "Current buffer has no process"))
1971 (comint-snapshot-last-prompt)
1972 (funcall comint-input-sender proc str
))
1974 (let ((str (comint-read-noecho "Non-echoed text: " t
)))
1976 (send-invisible str
)
1977 (message "Warning: text will be echoed")))))))
1979 (defun comint-watch-for-password-prompt (string)
1980 "Prompt in the minibuffer for password and send without echoing.
1981 This function uses `send-invisible' to read and send a password to the buffer's
1982 process if STRING contains a password prompt defined by
1983 `comint-password-prompt-regexp'.
1985 This function could be in the list `comint-output-filter-functions'."
1986 (when (string-match comint-password-prompt-regexp string
)
1987 (let ((pw (comint-read-noecho string t
)))
1988 (send-invisible pw
))))
1990 ;; Low-level process communication
1992 (defun comint-send-string (process string
)
1993 "Like `process-send-string', but also does extra bookkeeping for comint mode."
1995 (with-current-buffer (if (processp process
)
1996 (process-buffer process
)
1997 (get-buffer process
))
1998 (comint-snapshot-last-prompt))
1999 (comint-snapshot-last-prompt))
2000 (process-send-string process string
))
2002 (defun comint-send-region (process start end
)
2003 "Like `process-send-region', but also does extra bookkeeping for comint mode."
2005 (with-current-buffer (if (processp process
)
2006 (process-buffer process
)
2007 (get-buffer process
))
2008 (comint-snapshot-last-prompt))
2009 (comint-snapshot-last-prompt))
2010 (process-send-region process start end
))
2013 ;; Random input hackage
2015 (defun comint-delete-output ()
2016 "Delete all output from interpreter since last input.
2017 Does not delete the prompt."
2019 (let ((proc (get-buffer-process (current-buffer)))
2022 (let ((pmark (progn (goto-char (process-mark proc
))
2025 (delete-region comint-last-input-end pmark
)
2026 (goto-char (process-mark proc
))
2027 (setq replacement
(concat "*** output flushed ***\n"
2028 (buffer-substring pmark
(point))))
2029 (delete-region pmark
(point))))
2030 ;; Output message and put back prompt
2031 (comint-output-filter proc replacement
)))
2032 (defalias 'comint-kill-output
'comint-delete-output
)
2033 (make-obsolete 'comint-kill-output
'comint-delete-output
"21.1")
2035 (defun comint-write-output (filename &optional append mustbenew
)
2036 "Write output from interpreter since last input to FILENAME.
2037 Any prompt at the end of the output is not written.
2039 If the optional argument APPEND (the prefix argument when interactive)
2040 is non-nil, the output is appended to the file instead.
2042 If the optional argument MUSTBENEW is non-nil, check for an existing
2043 file with the same name. If MUSTBENEW is `excl', that means to get an
2044 error if the file already exists; never overwrite. If MUSTBENEW is
2045 neither nil nor `excl', that means ask for confirmation before
2046 overwriting, but do go ahead and overwrite the file if the user
2047 confirms. When interactive, MUSTBENEW is nil when appending, and t
2050 (list (read-file-name
2051 (if current-prefix-arg
2052 "Append output to file: "
2053 "Write output to file: "))
2055 (not current-prefix-arg
)))
2057 (goto-char (process-mark (get-buffer-process (current-buffer))))
2059 (write-region comint-last-input-end
(point) filename
2060 append nil nil mustbenew
)))
2062 ;; This function exists for the benefit of the menu; from the keyboard,
2063 ;; users can just use `comint-write-output' with a prefix arg.
2064 (defun comint-append-output-to-file (filename)
2065 "Append output from interpreter since last input to FILENAME.
2066 Any prompt at the end of the output is not written."
2067 (interactive "fAppend output to file: ")
2068 (comint-write-output filename t
))
2070 (defun comint-show-output ()
2071 "Display start of this batch of interpreter output at top of window.
2072 Sets mark to the value of point when this command is run."
2075 (let ((pos (or (marker-position comint-last-input-end
) (point-max))))
2076 (cond (comint-use-prompt-regexp-instead-of-fields
2078 (beginning-of-line 0)
2079 (set-window-start (selected-window) (point))
2080 (comint-skip-prompt))
2082 (goto-char (field-beginning pos
))
2083 (set-window-start (selected-window) (point))))))
2086 (defun comint-interrupt-subjob ()
2087 "Interrupt the current subjob.
2088 This command also kills the pending input
2089 between the process-mark and point."
2092 (interrupt-process nil comint-ptyp
))
2094 (defun comint-kill-subjob ()
2095 "Send kill signal to the current subjob.
2096 This command also kills the pending input
2097 between the process-mark and point."
2100 (kill-process nil comint-ptyp
))
2102 (defun comint-quit-subjob ()
2103 "Send quit signal to the current subjob.
2104 This command also kills the pending input
2105 between the process-mark and point."
2108 (quit-process nil comint-ptyp
))
2110 (defun comint-stop-subjob ()
2111 "Stop the current subjob.
2112 This command also kills the pending input
2113 between the process-mark and point.
2115 WARNING: if there is no current subjob, you can end up suspending
2116 the top-level process running in the buffer. If you accidentally do
2117 this, use \\[comint-continue-subjob] to resume the process. (This
2118 is not a problem with most shells, since they ignore this signal.)"
2121 (stop-process nil comint-ptyp
))
2123 (defun comint-continue-subjob ()
2124 "Send CONT signal to process buffer's process group.
2125 Useful if you accidentally suspend the top-level process."
2127 (continue-process nil comint-ptyp
))
2129 (defun comint-kill-input ()
2130 "Kill all text from last stuff output by interpreter to point."
2132 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2133 (if (> (point) (marker-position pmark
))
2134 (kill-region pmark
(point)))))
2136 (defun comint-delchar-or-maybe-eof (arg)
2137 "Delete ARG characters forward or send an EOF to subprocess.
2138 Sends an EOF only if point is at the end of the buffer and there is no input."
2140 (let ((proc (get-buffer-process (current-buffer))))
2141 (if (and (eobp) proc
(= (point) (marker-position (process-mark proc
))))
2143 (delete-char arg
))))
2145 (defun comint-send-eof ()
2146 "Send an EOF to the current buffer's process."
2148 (comint-send-input t
)
2152 (defun comint-backward-matching-input (regexp arg
)
2153 "Search backward through buffer for input fields that match REGEXP.
2154 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2155 fields are identified by lines that match `comint-prompt-regexp'.
2157 With prefix argument N, search for Nth previous match.
2158 If N is negative, find the next or Nth next match."
2159 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2160 (if comint-use-prompt-regexp-instead-of-fields
2161 ;; Use comint-prompt-regexp
2162 (let* ((re (concat comint-prompt-regexp
".*" regexp
))
2163 (pos (save-excursion (end-of-line (if (> arg
0) 0 1))
2164 (if (re-search-backward re nil t arg
)
2167 (progn (message "Not found")
2172 (let* ((dir (if (< arg
0) -
1 1))
2176 (unless (re-search-backward regexp nil t dir
)
2177 (error "Not found"))
2178 (when (eq (get-char-property (point) 'field
) 'input
)
2179 (setq arg
(- arg dir
))))
2180 (field-beginning))))
2184 (defun comint-forward-matching-input (regexp arg
)
2185 "Search forward through buffer for input fields that match REGEXP.
2186 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2187 fields are identified by lines that match `comint-prompt-regexp'.
2189 With prefix argument N, search for Nth following match.
2190 If N is negative, find the previous or Nth previous match."
2191 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2192 (comint-backward-matching-input regexp
(- arg
)))
2195 (defun comint-next-prompt (n)
2196 "Move to end of Nth next prompt in the buffer.
2197 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2198 the beginning of the Nth next `input' field, otherwise, it means the Nth
2199 occurance of text matching `comint-prompt-regexp'."
2201 (if comint-use-prompt-regexp-instead-of-fields
2202 ;; Use comint-prompt-regexp
2203 (let ((paragraph-start comint-prompt-regexp
))
2204 (end-of-line (if (> n
0) 1 0))
2205 (forward-paragraph n
)
2206 (comint-skip-prompt))
2215 (next-single-char-property-change pos
'field
)
2216 (previous-single-char-property-change pos
'field
)))
2217 (cond ((or (null pos
) (= pos prev-pos
))
2218 ;; Ran off the end of the buffer.
2220 ;; There's always an input field at the end of the
2221 ;; buffer, but it has a `field' property of nil.
2222 (setq input-pos
(point-max)))
2225 ((eq (get-char-property pos
'field
) 'input
)
2226 (setq n
(if (< n
0) (1+ n
) (1- n
)))
2227 (setq input-pos pos
))))
2229 (goto-char input-pos
)))))
2232 (defun comint-previous-prompt (n)
2233 "Move to end of Nth previous prompt in the buffer.
2234 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2235 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2236 occurance of text matching `comint-prompt-regexp'."
2238 (comint-next-prompt (- n
)))
2240 ;; State used by `comint-insert-previous-argument' when cycling.
2241 (defvar comint-insert-previous-argument-last-start-pos nil
)
2242 (make-variable-buffer-local 'comint-insert-previous-argument-last-start-pos
)
2243 (defvar comint-insert-previous-argument-last-index nil
)
2244 (make-variable-buffer-local 'comint-insert-previous-argument-last-index
)
2247 ;; make comint-arguments understand negative indices as bash does
2248 (defun comint-insert-previous-argument (index)
2249 "Insert the INDEXth argument from the previous comint command-line at point.
2250 Spaces are added at beginning and/or end of the inserted string if
2251 necessary to ensure that it's separated from adjacent arguments.
2252 Interactively, if no prefix argument is given, the last argument is inserted.
2253 Repeated interactive invocations will cycle through the same argument
2254 from progressively earlier commands (using the value of INDEX specified
2255 with the first command).
2256 This command is like `M-.' in bash."
2258 (unless (null index
)
2259 (setq index
(prefix-numeric-value index
)))
2260 (cond ((eq last-command this-command
)
2261 ;; Delete last input inserted by this command.
2262 (delete-region comint-insert-previous-argument-last-start-pos
(point))
2263 (setq index comint-insert-previous-argument-last-index
))
2265 ;; This is a non-repeat invocation, so initialize state.
2266 (setq comint-input-ring-index nil
)
2267 (setq comint-insert-previous-argument-last-index index
)
2268 (when (null comint-insert-previous-argument-last-start-pos
)
2269 ;; First usage; initialize to a marker
2270 (setq comint-insert-previous-argument-last-start-pos
2272 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2273 (if (<= (point) (comint-line-beginning-position))
2276 ;; Remember the beginning of what we insert, so we can delete it if
2277 ;; the command is repeated.
2278 (set-marker comint-insert-previous-argument-last-start-pos
(point))
2279 ;; Insert the argument.
2280 (let ((input-string (comint-previous-input-string 0)))
2281 (when (string-match "[ \t\n]*&" input-string
)
2282 ;; strip terminating '&'
2283 (setq input-string
(substring input-string
0 (match-beginning 0))))
2284 (insert (comint-arguments input-string index index
)))
2285 ;; Make next invocation return arg from previous input
2286 (setq comint-input-ring-index
(1+ (or comint-input-ring-index
0)))
2287 ;; Add a terminating space if necessary.
2292 ;; Support for source-file processing commands.
2293 ;;============================================================================
2294 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2295 ;; commands that process files of source text (e.g. loading or compiling
2296 ;; files). So the corresponding process-in-a-buffer modes have commands
2297 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2298 ;; for defining these commands.
2300 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2301 ;; and Soar, in that they don't know anything about file extensions.
2302 ;; So the compile/load interface gets the wrong default occasionally.
2303 ;; The load-file/compile-file default mechanism could be smarter -- it
2304 ;; doesn't know about the relationship between filename extensions and
2305 ;; whether the file is source or executable. If you compile foo.lisp
2306 ;; with compile-file, then the next load-file should use foo.bin for
2307 ;; the default, not foo.lisp. This is tricky to do right, particularly
2308 ;; because the extension for executable files varies so much (.o, .bin,
2309 ;; .lbin, .mo, .vo, .ao, ...).
2312 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2315 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2316 ;; want to save the buffer before issuing any process requests to the command
2319 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2320 ;; for the file to process.
2322 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2323 ;;============================================================================
2324 ;; This function computes the defaults for the load-file and compile-file
2325 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2327 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2328 ;; source-file processing command. nil if there hasn't been one yet.
2329 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2330 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2331 ;; Typically, (lisp-mode) or (scheme-mode).
2333 ;; If the command is given while the cursor is inside a string, *and*
2334 ;; the string is an existing filename, *and* the filename is not a directory,
2335 ;; then the string is taken as default. This allows you to just position
2336 ;; your cursor over a string that's a filename and have it taken as default.
2338 ;; If the command is given in a file buffer whose major mode is in
2339 ;; SOURCE-MODES, then the filename is the default file, and the
2340 ;; file's directory is the default directory.
2342 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2343 ;; then the default directory & file are what was used in the last source-file
2344 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2345 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2346 ;; is the cwd, with no default file. (\"no default file\" = nil)
2348 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2349 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2350 ;; for Soar programs, etc.
2352 ;; The function returns a pair: (default-directory . default-file).
2354 (defun comint-source-default (previous-dir/file source-modes
)
2355 (cond ((and buffer-file-name
(memq major-mode source-modes
))
2356 (cons (file-name-directory buffer-file-name
)
2357 (file-name-nondirectory buffer-file-name
)))
2360 (cons default-directory nil
))))
2363 ;; (COMINT-CHECK-SOURCE fname)
2364 ;;============================================================================
2365 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2366 ;; process-in-a-buffer modes), this function can be called on the filename.
2367 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2368 ;; is queried to see if he wants to save the buffer before proceeding with
2369 ;; the load or compile.
2371 (defun comint-check-source (fname)
2372 (let ((buff (get-file-buffer fname
)))
2374 (buffer-modified-p buff
)
2375 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff
))))
2377 (let ((old-buffer (current-buffer)))
2380 (set-buffer old-buffer
)))))
2383 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2384 ;;============================================================================
2385 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2386 ;; commands that process source files (like loading or compiling a file).
2387 ;; It prompts for the filename, provides a default, if there is one,
2388 ;; and returns the result filename.
2390 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
2392 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2393 ;; from the last source processing command. SOURCE-MODES is a list of major
2394 ;; modes used to determine what file buffers contain source files. (These
2395 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2396 ;; then the filename reader will only accept a file that exists.
2399 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2402 ;; This is pretty stupid about strings. It decides we're in a string
2403 ;; if there's a quote on both sides of point on the current line.
2404 (defun comint-extract-string ()
2405 "Return string around POINT that starts the current line, or nil."
2407 (let* ((point (point))
2408 (bol (progn (beginning-of-line) (point)))
2409 (eol (progn (end-of-line) (point)))
2410 (start (progn (goto-char point
)
2411 (and (search-backward "\"" bol t
)
2413 (end (progn (goto-char point
)
2414 (and (search-forward "\"" eol t
)
2417 (buffer-substring start end
)))))
2419 (defun comint-get-source (prompt prev-dir
/file source-modes mustmatch-p
)
2420 (let* ((def (comint-source-default prev-dir
/file source-modes
))
2421 (stringfile (comint-extract-string))
2422 (sfile-p (and stringfile
2424 (file-exists-p stringfile
)
2426 (not (file-directory-p stringfile
))))
2427 (defdir (if sfile-p
(file-name-directory stringfile
)
2429 (deffile (if sfile-p
(file-name-nondirectory stringfile
)
2431 (ans (read-file-name (if deffile
(format "%s(default %s) "
2435 (concat defdir deffile
)
2437 (list (expand-file-name (substitute-in-file-name ans
)))))
2439 ;; I am somewhat divided on this string-default feature. It seems
2440 ;; to violate the principle-of-least-astonishment, in that it makes
2441 ;; the default harder to predict, so you actually have to look and see
2442 ;; what the default really is before choosing it. This can trip you up.
2443 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2448 ;; Simple process query facility.
2449 ;; ===========================================================================
2450 ;; This function is for commands that want to send a query to the process
2451 ;; and show the response to the user. For example, a command to get the
2452 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2453 ;; to an inferior Common Lisp process.
2455 ;; This simple facility just sends strings to the inferior process and pops
2456 ;; up a window for the process buffer so you can see what the process
2457 ;; responds with. We don't do anything fancy like try to intercept what the
2458 ;; process responds with and put it in a pop-up window or on the message
2459 ;; line. We just display the buffer. Low tech. Simple. Works good.
2461 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2462 ;; a window for the inferior process so that its response can be seen.
2463 (defun comint-proc-query (proc str
)
2464 (let* ((proc-buf (process-buffer proc
))
2465 (proc-mark (process-mark proc
)))
2466 (display-buffer proc-buf
)
2467 (set-buffer proc-buf
) ; but it's not the selected *window*
2468 (let ((proc-win (get-buffer-window proc-buf
))
2469 (proc-pt (marker-position proc-mark
)))
2470 (comint-send-string proc str
) ; send the query
2471 (accept-process-output proc
) ; wait for some output
2472 ;; Try to position the proc window so you can see the answer.
2473 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2474 ;; I don't know why. Wizards invited to improve it.
2475 (unless (pos-visible-in-window-p proc-pt proc-win
)
2476 (let ((opoint (window-point proc-win
)))
2477 (set-window-point proc-win proc-mark
)
2479 (if (not (pos-visible-in-window-p opoint proc-win
))
2481 (set-window-point proc-win opoint
)))))))
2484 ;; Filename/command/history completion in a buffer
2485 ;; ===========================================================================
2486 ;; Useful completion functions, courtesy of the Ergo group.
2489 ;; comint-dynamic-complete Complete or expand command, filename,
2490 ;; history at point.
2491 ;; comint-dynamic-complete-filename Complete filename at point.
2492 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2493 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2494 ;; replace with expanded/completed name.
2495 ;; comint-dynamic-simple-complete Complete stub given candidates.
2497 ;; These are not installed in the comint-mode keymap. But they are
2498 ;; available for people who want them. Shell-mode installs them:
2499 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2500 ;; (define-key shell-mode-map "\M-?"
2501 ;; 'comint-dynamic-list-filename-completions)))
2503 ;; Commands like this are fine things to put in load hooks if you
2504 ;; want them present in specific modes.
2506 (defcustom comint-completion-autolist nil
2507 "*If non-nil, automatically list possibilities on partial completion.
2508 This mirrors the optional behavior of tcsh."
2510 :group
'comint-completion
)
2512 (defcustom comint-completion-addsuffix t
2513 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2514 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2515 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2516 This mirrors the optional behavior of tcsh."
2517 :type
'(choice (const :tag
"None" nil
)
2518 (const :tag
"Add /" t
)
2519 (cons :tag
"Suffix pair"
2520 (string :tag
"Directory suffix")
2521 (string :tag
"File suffix")))
2522 :group
'comint-completion
)
2524 (defcustom comint-completion-recexact nil
2525 "*If non-nil, use shortest completion if characters cannot be added.
2526 This mirrors the optional behavior of tcsh.
2528 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2530 :group
'comint-completion
)
2532 (defcustom comint-completion-fignore nil
2533 "*List of suffixes to be disregarded during file completion.
2534 This mirrors the optional behavior of bash and tcsh.
2536 Note that this applies to `comint-dynamic-complete-filename' only."
2537 :type
'(repeat (string :tag
"Suffix"))
2538 :group
'comint-completion
)
2540 (defvar comint-file-name-prefix
""
2541 "Prefix prepended to absolute file names taken from process input.
2542 This is used by comint's and shell's completion functions, and by shell's
2543 directory tracking functions.")
2545 (defvar comint-file-name-chars
2546 (if (memq system-type
'(ms-dos windows-nt
))
2547 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2548 "~/A-Za-z0-9+@:_.$#%,={}-")
2549 "String of characters valid in a file name.
2550 Note that all non-ASCII characters are considered valid in a file name
2551 regardless of what this variable says.
2553 This is a good thing to set in mode hooks.")
2555 (defvar comint-file-name-quote-list nil
2556 "List of characters to quote with `\\' when in a file name.
2558 This is a good thing to set in mode hooks.")
2561 (defun comint-directory (directory)
2562 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2563 (expand-file-name (if (file-name-absolute-p directory
)
2564 (concat comint-file-name-prefix directory
)
2568 (defun comint-word (word-chars)
2569 "Return the word of WORD-CHARS at point, or nil if non is found.
2570 Word constituents are considered to be those in WORD-CHARS, which is like the
2571 inside of a \"[...]\" (see `skip-chars-forward'),
2572 plus all non-ASCII characters."
2574 (let ((non-word-chars (concat "[^\\\\" word-chars
"]")) (here (point)))
2575 (while (and (re-search-backward non-word-chars nil
'move
)
2576 ;;(memq (char-after (point)) shell-file-name-quote-list)
2577 (or (>= (following-char) 128)
2578 (eq (preceding-char) ?
\\)))
2580 ;; Don't go forward over a word-char (this can happen if we're at bob).
2581 (when (or (not (bobp)) (looking-at non-word-chars
))
2583 ;; Set match-data to match the entire string.
2584 (when (< (point) here
)
2585 (set-match-data (list (point) here
))
2586 (match-string 0)))))
2588 (defun comint-substitute-in-file-name (filename)
2589 "Return FILENAME with environment variables substituted.
2590 Supports additional environment variable syntax of the command
2591 interpreter (e.g., the percent notation of cmd.exe on NT)."
2592 (let ((name (substitute-in-file-name filename
)))
2593 (if (memq system-type
'(ms-dos windows-nt
))
2597 (while (string-match "%\\([^\\\\/]*\\)%" name
)
2599 (substring name
(match-beginning 1) (match-end 1)))
2600 (setq env-var-val
(if (getenv env-var-name
)
2601 (getenv env-var-name
)
2603 (setq name
(replace-match env-var-val t t name
))))))
2606 (defun comint-match-partial-filename ()
2607 "Return the filename at point, or nil if non is found.
2608 Environment variables are substituted. See `comint-word'."
2609 (let ((filename (comint-word comint-file-name-chars
)))
2610 (and filename
(comint-substitute-in-file-name
2611 (comint-unquote-filename filename
)))))
2614 (defun comint-quote-filename (filename)
2615 "Return FILENAME with magic characters quoted.
2616 Magic characters are those in `comint-file-name-quote-list'."
2617 (if (null comint-file-name-quote-list
)
2620 (format "\\(^\\|[^\\]\\)\\([%s]\\)"
2621 (mapconcat 'char-to-string comint-file-name-quote-list
""))))
2623 (while (string-match regexp filename
)
2624 (setq filename
(replace-match "\\1\\\\\\2" nil nil filename
)))
2627 (defun comint-unquote-filename (filename)
2628 "Return FILENAME with quoted characters unquoted."
2629 (if (null comint-file-name-quote-list
)
2633 (while (string-match "\\\\\\(.\\)" filename i
)
2634 (setq filename
(replace-match "\\1" nil nil filename
))
2635 (setq i
(+ 1 (match-beginning 0)))))
2639 (defun comint-dynamic-complete ()
2640 "Dynamically perform completion at point.
2641 Calls the functions in `comint-dynamic-complete-functions' to perform
2642 completion until a function returns non-nil, at which point completion is
2643 assumed to have occurred."
2645 (run-hook-with-args-until-success 'comint-dynamic-complete-functions
))
2648 (defun comint-dynamic-complete-filename ()
2649 "Dynamically complete the filename at point.
2650 Completes if after a filename. See `comint-match-partial-filename' and
2651 `comint-dynamic-complete-as-filename'.
2652 This function is similar to `comint-replace-by-expanded-filename', except that
2653 it won't change parts of the filename already entered in the buffer; it just
2654 adds completion characters to the end of the filename. A completions listing
2655 may be shown in a help buffer if completion is ambiguous.
2657 Completion is dependent on the value of `comint-completion-addsuffix',
2658 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2659 completions listing is dependent on the value of `comint-completion-autolist'.
2661 Returns t if successful."
2663 (when (comint-match-partial-filename)
2664 (unless (window-minibuffer-p (selected-window))
2665 (message "Completing file name..."))
2666 (comint-dynamic-complete-as-filename)))
2668 (defun comint-dynamic-complete-as-filename ()
2669 "Dynamically complete at point as a filename.
2670 See `comint-dynamic-complete-filename'. Returns t if successful."
2671 (let* ((completion-ignore-case (memq system-type
'(ms-dos windows-nt
)))
2672 (completion-ignored-extensions comint-completion-fignore
)
2673 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2674 ;; I think it was originally bound to solve file completion problems,
2675 ;; but subsequent changes may have made this unnecessary. sm.
2676 ;;(file-name-handler-alist nil)
2677 (minibuffer-p (window-minibuffer-p (selected-window)))
2679 (dirsuffix (cond ((not comint-completion-addsuffix
)
2681 ((not (consp comint-completion-addsuffix
))
2682 (char-to-string directory-sep-char
))
2684 (car comint-completion-addsuffix
))))
2685 (filesuffix (cond ((not comint-completion-addsuffix
)
2687 ((not (consp comint-completion-addsuffix
))
2690 (cdr comint-completion-addsuffix
))))
2691 (filename (or (comint-match-partial-filename) ""))
2692 (pathdir (file-name-directory filename
))
2693 (pathnondir (file-name-nondirectory filename
))
2694 (directory (if pathdir
(comint-directory pathdir
) default-directory
))
2695 (completion (file-name-completion pathnondir directory
)))
2696 (cond ((null completion
)
2697 (message "No completions of %s" filename
)
2699 ((eq completion t
) ; Means already completed "file".
2701 (unless minibuffer-p
2702 (message "Sole completion")))
2703 ((string-equal completion
"") ; Means completion on "directory/".
2704 (comint-dynamic-list-filename-completions))
2705 (t ; Completion string returned.
2706 (let ((file (concat (file-name-as-directory directory
) completion
)))
2707 (insert (comint-quote-filename
2708 (substring (directory-file-name completion
)
2709 (length pathnondir
))))
2710 (cond ((symbolp (file-name-completion completion directory
))
2711 ;; We inserted a unique completion.
2712 (insert (if (file-directory-p file
) dirsuffix filesuffix
))
2713 (unless minibuffer-p
2714 (message "Completed")))
2715 ((and comint-completion-recexact comint-completion-addsuffix
2716 (string-equal pathnondir completion
)
2717 (file-exists-p file
))
2718 ;; It's not unique, but user wants shortest match.
2719 (insert (if (file-directory-p file
) dirsuffix filesuffix
))
2720 (unless minibuffer-p
2721 (message "Completed shortest")))
2722 ((or comint-completion-autolist
2723 (string-equal pathnondir completion
))
2724 ;; It's not unique, list possible completions.
2725 (comint-dynamic-list-filename-completions))
2727 (unless minibuffer-p
2728 (message "Partially completed")))))))
2732 (defun comint-replace-by-expanded-filename ()
2733 "Dynamically expand and complete the filename at point.
2734 Replace the filename with an expanded, canonicalised and completed replacement.
2735 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
2736 with the corresponding directories. \"Canonicalised\" means `..' and `.' are
2737 removed, and the filename is made absolute instead of relative. For expansion
2738 see `expand-file-name' and `substitute-in-file-name'. For completion see
2739 `comint-dynamic-complete-filename'."
2741 (let ((filename (comint-match-partial-filename)))
2743 (replace-match (expand-file-name filename
) t t
)
2744 (comint-dynamic-complete-filename))))
2747 (defun comint-dynamic-simple-complete (stub candidates
)
2748 "Dynamically complete STUB from CANDIDATES list.
2749 This function inserts completion characters at point by completing STUB from
2750 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2751 if completion is ambiguous.
2753 Returns nil if no completion was inserted.
2754 Returns `sole' if completed with the only completion match.
2755 Returns `shortest' if completed with the shortest of the completion matches.
2756 Returns `partial' if completed as far as possible with the completion matches.
2757 Returns `listed' if a completion listing was shown.
2759 See also `comint-dynamic-complete-filename'."
2760 (let* ((completion-ignore-case (memq system-type
'(ms-dos windows-nt
)))
2761 (suffix (cond ((not comint-completion-addsuffix
) "")
2762 ((not (consp comint-completion-addsuffix
)) " ")
2763 (t (cdr comint-completion-addsuffix
))))
2764 (candidates (mapcar (function (lambda (x) (list x
))) candidates
))
2765 (completions (all-completions stub candidates
)))
2766 (cond ((null completions
)
2767 (message "No completions of %s" stub
)
2769 ((= 1 (length completions
)) ; Gotcha!
2770 (let ((completion (car completions
)))
2771 (if (string-equal completion stub
)
2772 (message "Sole completion")
2773 (insert (substring completion
(length stub
)))
2774 (message "Completed"))
2777 (t ; There's no unique completion.
2778 (let ((completion (try-completion stub candidates
)))
2779 ;; Insert the longest substring.
2780 (insert (substring completion
(length stub
)))
2781 (cond ((and comint-completion-recexact comint-completion-addsuffix
2782 (string-equal stub completion
)
2783 (member completion completions
))
2784 ;; It's not unique, but user wants shortest match.
2786 (message "Completed shortest")
2788 ((or comint-completion-autolist
2789 (string-equal stub completion
))
2790 ;; It's not unique, list possible completions.
2791 (comint-dynamic-list-completions completions
)
2794 (message "Partially completed")
2798 (defun comint-dynamic-list-filename-completions ()
2799 "List in help buffer possible completions of the filename at point."
2801 (let* ((completion-ignore-case (memq system-type
'(ms-dos windows-nt
)))
2802 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2803 ;; I think it was originally bound to solve file completion problems,
2804 ;; but subsequent changes may have made this unnecessary. sm.
2805 ;;(file-name-handler-alist nil)
2806 (filename (or (comint-match-partial-filename) ""))
2807 (pathdir (file-name-directory filename
))
2808 (pathnondir (file-name-nondirectory filename
))
2809 (directory (if pathdir
(comint-directory pathdir
) default-directory
))
2810 (completions (file-name-all-completions pathnondir directory
)))
2811 (if (not completions
)
2812 (message "No completions of %s" filename
)
2813 (comint-dynamic-list-completions
2814 (mapcar 'comint-quote-filename completions
)))))
2817 (defun comint-dynamic-list-completions (completions)
2818 "List in help buffer sorted COMPLETIONS.
2819 Typing SPC flushes the help buffer."
2820 (let ((window (get-buffer-window "*Completions*")))
2821 (if (and (eq last-command this-command
)
2822 window
(window-live-p window
) (window-buffer window
)
2823 (buffer-name (window-buffer window
)))
2824 ;; If this command was repeated, and
2825 ;; there's a fresh completion window with a live buffer,
2826 ;; and this command is repeated, scroll that window.
2827 (with-current-buffer (window-buffer window
)
2828 (if (pos-visible-in-window-p (point-max) window
)
2829 (set-window-start window
(point-min))
2830 (save-selected-window
2831 (select-window window
)
2834 (let ((conf (current-window-configuration)))
2835 (with-output-to-temp-buffer "*Completions*"
2836 (display-completion-list (sort completions
'string-lessp
)))
2837 (message "Type space to flush; repeat completion command to scroll")
2840 (set-buffer (get-buffer "*Completions*"))
2841 (setq key
(read-key-sequence nil
)
2843 (and (consp first
) (consp (event-start first
))
2844 (eq (window-buffer (posn-window (event-start first
)))
2845 (get-buffer "*Completions*"))
2846 (eq (key-binding key
) 'mouse-choose-completion
)))
2847 ;; If the user does mouse-choose-completion with the mouse,
2848 ;; execute the command, then delete the completion window.
2850 (mouse-choose-completion first
)
2851 (set-window-configuration conf
))
2853 (set-window-configuration conf
)
2854 (setq unread-command-events
(listify-key-sequence key
)))))))))
2857 (defun comint-get-next-from-history ()
2858 "After fetching a line from input history, this fetches the following line.
2859 In other words, this recalls the input line after the line you recalled last.
2860 You can use this to repeat a sequence of input lines."
2862 (if comint-save-input-ring-index
2864 (setq comint-input-ring-index
(1+ comint-save-input-ring-index
))
2865 (comint-next-input 1))
2866 (message "No previous history command")))
2868 (defun comint-accumulate ()
2869 "Accumulate a line to send as input along with more lines.
2870 This inserts a newline so that you can enter more text
2871 to be sent along with this line. Use \\[comint-send-input]
2872 to send all the accumulated input, at once.
2873 The entire accumulated text becomes one item in the input history
2877 (set-marker comint-accum-marker
(point))
2878 (if comint-input-ring-index
2879 (setq comint-save-input-ring-index
2880 (- comint-input-ring-index
1))))
2882 (defun comint-goto-process-mark ()
2883 "Move point to the process mark.
2884 The process mark separates output, and input already sent,
2885 from input that has not yet been sent."
2887 (let ((proc (or (get-buffer-process (current-buffer))
2888 (error "Current buffer has no process"))))
2889 (goto-char (process-mark proc
))
2890 (when (interactive-p)
2891 (message "Point is now at the process mark"))))
2893 (defun comint-bol-or-process-mark ()
2894 "Move point to beginning of line (after prompt) or to the process mark.
2895 The first time you use this command, it moves to the beginning of the line
2896 \(but after the prompt, if any). If you repeat it again immediately,
2897 it moves point to the process mark.
2899 The process mark separates the process output, along with input already sent,
2900 from input that has not yet been sent. Ordinarily, the process mark
2901 is at the beginning of the current input line; but if you have
2902 used \\[comint-accumulate] to send multiple lines at once,
2903 the process mark is at the beginning of the accumulated input."
2905 (if (not (eq last-command
'comint-bol-or-process-mark
))
2907 (comint-goto-process-mark)))
2909 (defun comint-set-process-mark ()
2910 "Set the process mark at point."
2912 (let ((proc (or (get-buffer-process (current-buffer))
2913 (error "Current buffer has no process"))))
2914 (set-marker (process-mark proc
) (point))
2915 (message "Process mark set")))
2918 ;; Author: Peter Breton <pbreton@cs.umb.edu>
2920 ;; This little add-on for comint is intended to make it easy to get
2921 ;; output from currently active comint buffers into another buffer,
2922 ;; or buffers, and then go back to using the comint shell.
2924 ;; My particular use is SQL interpreters; I want to be able to execute a
2925 ;; query using the process associated with a comint-buffer, and save that
2926 ;; somewhere else. Because the process might have state (for example, it
2927 ;; could be in an uncommitted transaction), just running starting a new
2928 ;; process and having it execute the query and then finish, would not
2929 ;; work. I'm sure there are other uses as well, although in many cases
2930 ;; starting a new process is the simpler, and thus preferable, approach.
2932 ;; The basic implementation is as follows: comint-redirect changes the
2933 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2934 ;; its own filter. The filter puts the output into the designated buffer,
2935 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2936 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2937 ;; sees the stop regexp, it restores the old filter functions, and runs
2938 ;; comint-redirect-hook.
2940 ;; Each comint buffer may only use one redirection at a time, but any number
2941 ;; of different comint buffers may be simultaneously redirected.
2943 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2944 ;; correct prompt for your interpreter, or that you supply a regexp that says
2945 ;; when the redirection is finished. Otherwise, redirection will continue
2946 ;; indefinitely. The code now does a sanity check to ensure that it can find
2947 ;; a prompt in the comint buffer; however, it is still important to ensure that
2948 ;; this prompt is set correctly.
2950 ;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2951 ;; perhaps it should prompt for a terminating string (with an
2952 ;; appropriate magic default by examining what we think is the prompt)?
2955 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2957 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2959 (defcustom comint-redirect-verbose nil
2960 "*If non-nil, print messages each time the redirection filter is invoked.
2961 Also print a message when redirection is completed."
2965 ;; Directly analagous to comint-preoutput-filter-functions
2966 (defvar comint-redirect-filter-functions nil
2967 "List of functions to call before inserting redirected process output.
2968 Each function gets one argument, a string containing the text received
2969 from the subprocess. It should return the string to insert, perhaps
2970 the same string that was received, or perhaps a modified or transformed
2973 The functions on the list are called sequentially, and each one is given
2974 the string returned by the previous one. The string returned by the
2975 last function is the text that is actually inserted in the redirection buffer.
2977 You can use `add-hook' to add functions to this list
2978 either globally or locally.")
2980 ;; Internal variables
2982 (defvar comint-redirect-output-buffer nil
2983 "The buffer or list of buffers to put output into.")
2985 (defvar comint-redirect-finished-regexp nil
2986 "Regular expression that determines when to stop redirection in Comint.
2987 When the redirection filter function is given output that matches this regexp,
2988 the output is inserted as usual, and redirection is completed.")
2990 (defvar comint-redirect-insert-matching-regexp nil
2991 "If non-nil, the text that ends a redirection is included in it.
2992 More precisely, the text that matches `comint-redirect-finished-regexp'
2993 and therefore terminates an output redirection is inserted in the
2994 redirection target buffer, along with the preceding output.")
2996 (defvar comint-redirect-echo-input nil
2997 "Non-nil means echo input in the process buffer even during redirection.")
2999 (defvar comint-redirect-completed nil
3000 "Non-nil if redirection has completed in the current buffer.")
3002 (defvar comint-redirect-original-mode-line-process nil
3003 "Original mode line for redirected process.")
3005 (defvar comint-redirect-perform-sanity-check t
3006 "If non-nil, check that redirection is likely to complete successfully.
3007 More precisely, before starting a redirection, verify that the
3008 regular expression `comint-redirect-finished-regexp' that controls
3009 when to terminate it actually matches some text already in the process
3010 buffer. The idea is that this regular expression should match a prompt
3011 string, and that there ought to be at least one copy of your prompt string
3012 in the process buffer already.")
3014 (defvar comint-redirect-original-filter-function nil
3015 "The process filter that was in place when redirection is started.
3016 When redirection is completed, the process filter is restored to
3019 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3021 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3023 (defun comint-redirect-setup (output-buffer
3026 &optional echo-input
)
3027 "Set up for output redirection.
3028 This function sets local variables that are used by `comint-redirect-filter'
3029 to perform redirection.
3031 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3032 in the output matches FINISHED-REGEXP.
3034 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3035 original comint buffer.
3037 This function is called by `comint-redirect-send-command-to-process',
3038 and does not normally need to be invoked by the end user or programmer."
3039 (with-current-buffer comint-buffer
3041 (make-local-variable 'comint-redirect-original-mode-line-process
)
3042 (setq comint-redirect-original-mode-line-process mode-line-process
)
3044 (make-local-variable 'comint-redirect-output-buffer
)
3045 (setq comint-redirect-output-buffer output-buffer
)
3047 (make-local-variable 'comint-redirect-finished-regexp
)
3048 (setq comint-redirect-finished-regexp finished-regexp
)
3050 (make-local-variable 'comint-redirect-echo-input
)
3051 (setq comint-redirect-echo-input echo-input
)
3053 (make-local-variable 'comint-redirect-completed
)
3054 (setq comint-redirect-completed nil
)
3056 (setq mode-line-process
3057 (if mode-line-process
3058 (list (concat (elt mode-line-process
0) " Redirection"))
3059 (list ":%s Redirection")))))
3061 (defun comint-redirect-cleanup ()
3062 "End a Comint redirection. See `comint-redirect-send-command'."
3064 ;; Restore the process filter
3065 (set-process-filter (get-buffer-process (current-buffer))
3066 comint-redirect-original-filter-function
)
3067 ;; Restore the mode line
3068 (setq mode-line-process comint-redirect-original-mode-line-process
)
3069 ;; Set the completed flag
3070 (setq comint-redirect-completed t
))
3072 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3073 ;; that it really occurs.
3074 (defalias 'comint-redirect-remove-redirection
'comint-redirect-cleanup
)
3076 (defun comint-redirect-filter (process input-string
)
3077 "Filter function which redirects output from PROCESS to a buffer or buffers.
3078 The variable `comint-redirect-output-buffer' says which buffer(s) to
3081 INPUT-STRING is the input from the comint process.
3083 This function runs as a process filter, and does not need to be invoked by the
3086 (with-current-buffer (process-buffer process
)
3087 (comint-redirect-preoutput-filter input-string
)
3088 ;; If we have to echo output, give it to the original filter function
3089 (and comint-redirect-echo-input
3090 comint-redirect-original-filter-function
3091 (funcall comint-redirect-original-filter-function
3092 process input-string
)))))
3095 (defun comint-redirect-preoutput-filter (input-string)
3096 "Comint filter function which redirects comint output to a buffer or buffers.
3097 The variable `comint-redirect-output-buffer' says which buffer(s) to
3100 INPUT-STRING is the input from the comint process.
3102 This function does not need to be invoked by the end user."
3103 (let ((output-buffer-list
3104 (if (listp comint-redirect-output-buffer
)
3105 comint-redirect-output-buffer
3106 (list comint-redirect-output-buffer
)))
3107 (filtered-input-string input-string
))
3109 ;; If there are any filter functions, give them a chance to modify the string
3110 (let ((functions comint-redirect-filter-functions
))
3111 (while (and functions filtered-input-string
)
3112 (if (eq (car functions
) t
)
3113 ;; If a local value says "use the default value too",
3115 (let ((functions (default-value 'comint-redirect-filter-functions
)))
3116 (while (and functions filtered-input-string
)
3117 (setq filtered-input-string
3118 (funcall (car functions
) filtered-input-string
))
3119 (setq functions
(cdr functions
))))
3120 (setq filtered-input-string
3121 (funcall (car functions
) filtered-input-string
)))
3122 (setq functions
(cdr functions
))))
3124 ;; Clobber `comint-redirect-finished-regexp'
3125 (or comint-redirect-insert-matching-regexp
3126 (and (string-match comint-redirect-finished-regexp filtered-input-string
)
3127 (setq filtered-input-string
3128 (replace-match "" nil nil filtered-input-string
))))
3130 ;; Send output to all registered buffers
3133 (function (lambda(buf)
3134 ;; Set this buffer to the output buffer
3135 (set-buffer (get-buffer-create buf
))
3136 ;; Go to the end of the buffer
3137 (goto-char (point-max))
3138 ;; Insert the output
3139 (insert filtered-input-string
)))
3140 output-buffer-list
))
3143 (and comint-redirect-verbose
3144 (message "Redirected output to buffer(s) %s"
3145 (mapconcat 'identity output-buffer-list
" ")))
3147 ;; If we see the prompt, tidy up
3148 ;; We'll look for the prompt in the original string, so nobody can
3150 (and (string-match comint-redirect-finished-regexp input-string
)
3152 (and comint-redirect-verbose
3153 (message "Redirection completed"))
3154 (comint-redirect-cleanup)
3155 (run-hooks 'comint-redirect-hook
)))
3157 (if comint-redirect-echo-input
3158 filtered-input-string
3162 (defun comint-redirect-send-command (command output-buffer echo
&optional no-display
)
3163 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3164 With prefix arg, echo output in process buffer.
3166 If NO-DISPLAY is non-nil, do not show the output buffer."
3167 (interactive "sCommand: \nBOutput Buffer: \nP")
3168 (let ((process (get-buffer-process (current-buffer))))
3170 (comint-redirect-send-command-to-process
3171 command output-buffer
(current-buffer) echo no-display
)
3172 (error "No process for current buffer"))))
3175 (defun comint-redirect-send-command-to-process
3176 (command output-buffer process echo
&optional no-display
)
3177 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3178 With prefix arg, echo output in process buffer.
3180 If NO-DISPLAY is non-nil, do not show the output buffer."
3181 (interactive "sCommand: \nBOutput Buffer: \nbProcess Buffer: \nP")
3182 (let* (;; The process buffer
3183 (process-buffer (if (processp process
)
3184 (process-buffer process
)
3186 (proc (get-buffer-process process-buffer
)))
3187 ;; Change to the process buffer
3188 (with-current-buffer process-buffer
3190 ;; Make sure there's a prompt in the current process buffer
3191 (and comint-redirect-perform-sanity-check
3193 (goto-char (point-max))
3194 (or (re-search-backward comint-prompt-regexp nil t
)
3195 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3197 ;;;;;;;;;;;;;;;;;;;;;
3198 ;; Set up for redirection
3199 ;;;;;;;;;;;;;;;;;;;;;
3200 (comint-redirect-setup
3206 comint-prompt-regexp
3210 ;;;;;;;;;;;;;;;;;;;;;
3212 ;;;;;;;;;;;;;;;;;;;;;
3213 ;; Save the old filter
3214 (setq comint-redirect-original-filter-function
3215 (process-filter proc
))
3216 (set-process-filter proc
'comint-redirect-filter
)
3218 ;;;;;;;;;;;;;;;;;;;;;
3220 ;;;;;;;;;;;;;;;;;;;;;
3221 (process-send-string
3223 (concat command
"\n"))
3225 ;;;;;;;;;;;;;;;;;;;;;
3227 ;;;;;;;;;;;;;;;;;;;;;
3231 (if (listp output-buffer
)
3233 output-buffer
)))))))
3236 (defun comint-redirect-results-list (command regexp regexp-group
)
3237 "Send COMMAND to current process.
3238 Return a list of expressions in the output which match REGEXP.
3239 REGEXP-GROUP is the regular expression group in REGEXP to use."
3240 (comint-redirect-results-list-from-process
3241 (get-buffer-process (current-buffer))
3242 command regexp regexp-group
))
3245 (defun comint-redirect-results-list-from-process (process command regexp regexp-group
)
3246 "Send COMMAND to PROCESS.
3247 Return a list of expressions in the output which match REGEXP.
3248 REGEXP-GROUP is the regular expression group in REGEXP to use."
3249 (let ((output-buffer " *Comint Redirect Work Buffer*")
3252 (set-buffer (get-buffer-create output-buffer
))
3254 (comint-redirect-send-command-to-process command
3255 output-buffer process nil t
)
3256 ;; Wait for the process to complete
3257 (set-buffer (process-buffer process
))
3258 (while (null comint-redirect-completed
)
3259 (accept-process-output nil
1))
3260 ;; Collect the output
3261 (set-buffer output-buffer
)
3262 (goto-char (point-min))
3263 ;; Skip past the command, if it was echoed
3264 (and (looking-at command
)
3266 (while (re-search-forward regexp nil t
)
3268 (cons (buffer-substring-no-properties
3269 (match-beginning regexp-group
)
3270 (match-end regexp-group
))
3275 (add-to-list 'debug-ignored-errors x
))
3276 '("^Not at command line$"
3277 "^Empty input ring$"
3279 "^Not found$" ; Too common?
3280 "^Current buffer has no process$"))
3283 ;; Converting process modes to use comint mode
3284 ;; ===========================================================================
3285 ;; The code in the Emacs 19 distribution has all been modified to use comint
3286 ;; where needed. However, there are `third-party' packages out there that
3287 ;; still use the old shell mode. Here's a guide to conversion.
3289 ;; Renaming variables
3290 ;; Most of the work is renaming variables and functions. These are the common
3293 ;; last-input-start comint-last-input-start
3294 ;; last-input-end comint-last-input-end
3295 ;; shell-prompt-pattern comint-prompt-regexp
3296 ;; shell-set-directory-error-hook <no equivalent>
3298 ;; shell-set-directory <unnecessary>
3299 ;; shell-mode-map comint-mode-map
3301 ;; shell-send-input comint-send-input
3302 ;; shell-send-eof comint-delchar-or-maybe-eof
3303 ;; kill-shell-input comint-kill-input
3304 ;; interrupt-shell-subjob comint-interrupt-subjob
3305 ;; stop-shell-subjob comint-stop-subjob
3306 ;; quit-shell-subjob comint-quit-subjob
3307 ;; kill-shell-subjob comint-kill-subjob
3308 ;; kill-output-from-shell comint-delete-output
3309 ;; show-output-from-shell comint-show-output
3310 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3312 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3313 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3314 ;; Comint mode does not provide functionality equivalent to
3315 ;; shell-set-directory-error-hook; it is gone.
3317 ;; comint-last-input-start is provided for modes which want to munge
3318 ;; the buffer after input is sent, perhaps because the inferior
3319 ;; insists on echoing the input. The LAST-INPUT-START variable in
3320 ;; the old shell package was used to implement a history mechanism,
3321 ;; but you should think twice before using comint-last-input-start
3322 ;; for this; the input history ring often does the job better.
3324 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3325 ;; *not* create the comint-mode local variables in your foo-mode function.
3326 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3327 ;; necessary comint-specific local variables. Then create the
3328 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3329 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3330 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3331 ;; get-old-input) that need to be different from the defaults. Call
3332 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3333 ;; comint-mode will take care of it. The following example, from shell.el,
3336 ;; (defvar shell-mode-map '())
3337 ;; (cond ((not shell-mode-map)
3338 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3339 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3340 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3341 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3342 ;; (define-key shell-mode-map "\M-?"
3343 ;; 'comint-dynamic-list-filename-completions)))
3345 ;; (defun shell-mode ()
3348 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3349 ;; (setq major-mode 'shell-mode)
3350 ;; (setq mode-name "Shell")
3351 ;; (use-local-map shell-mode-map)
3352 ;; (make-local-variable 'shell-directory-stack)
3353 ;; (setq shell-directory-stack nil)
3354 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3355 ;; (run-hooks 'shell-mode-hook))
3358 ;; Completion for comint-mode users
3360 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3361 ;; hook to add completion functions to. Functions on this list should return
3362 ;; non-nil if completion occurs (i.e., further completion should not occur).
3363 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3369 ;;; comint.el ends here
HCoop / bpt / emacs.git / blob