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 nil
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 \\|Kerberos \\|'s \\|login \\|CVS \\|UNIX \\|^\\)\
318 [Pp]assword\\( (again)\\)?\\|pass phrase\\|Enter passphrase\\)\
319 \\( for [^:]+\\)?:\\s *\\'"
320 "*Regexp matching prompts for passwords in the inferior process.
321 This is used by `comint-watch-for-password-prompt'."
325 ;; Here are the per-interpreter hooks.
326 (defvar comint-get-old-input
(function comint-get-old-input-default
)
327 "Function that returns old text in comint mode.
328 This function is called when return is typed while the point is in old
329 text. It returns the text to be submitted as process input. The
330 default is `comint-get-old-input-default', which either grabs the
331 current input field or grabs the current line and strips off leading
332 text matching `comint-prompt-regexp', depending on the value of
333 `comint-use-prompt-regexp-instead-of-fields'.")
335 (defvar comint-dynamic-complete-functions
336 '(comint-replace-by-expanded-history comint-dynamic-complete-filename
)
337 "List of functions called to perform completion.
338 Functions should return non-nil if completion was performed.
339 See also `comint-dynamic-complete'.
341 This is a good thing to set in mode hooks.")
343 (defvar comint-input-filter
344 (function (lambda (str) (not (string-match "\\`\\s *\\'" str
))))
345 "Predicate for filtering additions to input history.
346 Takes one argument, the input. If non-nil, the input may be saved on the input
347 history list. Default is to save anything that isn't all whitespace.")
349 (defvar comint-input-filter-functions
'()
350 "Functions to call before input is sent to the process.
351 These functions get one argument, a string containing the text to send.
353 This variable is buffer-local.")
355 (defvar comint-output-filter-functions
'(comint-postoutput-scroll-to-bottom)
356 "Functions to call after output is inserted into the buffer.
357 One possible function is `comint-postoutput-scroll-to-bottom'.
358 These functions get one argument, a string containing the text as originally
359 inserted. Note that this might not be the same as the buffer contents between
360 `comint-last-output-start' and the buffer's `process-mark', if other filter
361 functions have already modified the buffer.
363 See also `comint-preoutput-filter-functions'.
365 This variable is buffer-local.")
367 (defvar comint-input-sender-no-newline nil
368 "Non-nil directs the `comint-input-sender' function not to send a newline.")
370 (defvar comint-input-sender
(function comint-simple-send
)
371 "Function to actually send to PROCESS the STRING submitted by user.
372 Usually this is just `comint-simple-send', but if your mode needs to
373 massage the input string, put a different function here.
374 `comint-simple-send' just sends the string plus a newline.
375 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
376 This is called from the user command `comint-send-input'.")
378 (defcustom comint-eol-on-send t
379 "*Non-nil means go to the end of the line before sending input.
380 See `comint-send-input'."
384 ;; Note: If it is decided to purge comint-prompt-regexp from the source
385 ;; entirely, searching for uses of this variable will help to identify
386 ;; places that need attention.
387 (defcustom comint-use-prompt-regexp-instead-of-fields nil
388 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
389 If nil, then program output and user-input are given different `field'
390 properties, which emacs commands can use to distinguish them (in
391 particular, common movement commands such as begining-of-line respect
392 field boundaries in a natural way)."
396 (defcustom comint-mode-hook
'()
397 "Called upon entry into `comint-mode'
398 This is run before the process is cranked up."
402 (defcustom comint-exec-hook
'()
403 "Called each time a process is exec'd by `comint-exec'.
404 This is called after the process is cranked up. It is useful for things that
405 must be done each time a process is executed in a comint mode buffer (e.g.,
406 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
407 executed once when the buffer is created."
411 (defvar comint-mode-map nil
)
413 (defvar comint-ptyp t
414 "Non-nil if communications via pty; false if by pipe. Buffer local.
415 This is to work around a bug in Emacs process signaling.")
417 (defvar comint-input-ring nil
)
418 (defvar comint-last-input-start
)
419 (defvar comint-last-input-end
)
420 (defvar comint-last-output-start
)
421 (defvar comint-input-ring-index nil
422 "Index of last matched history element.")
423 (defvar comint-matching-input-from-input-string
""
424 "Input previously used to match input history.")
425 (defvar comint-save-input-ring-index
426 "Last input ring index which you copied.
427 This is to support the command \\[comint-get-next-from-history].")
429 (defvar comint-accum-marker nil
430 "Non-nil if you are accumulating input lines to send as input together.
431 The command \\[comint-accumulate] sets this.")
433 (put 'comint-replace-by-expanded-history
'menu-enable
'comint-input-autoexpand
)
434 (put 'comint-input-ring
'permanent-local t
)
435 (put 'comint-input-ring-index
'permanent-local t
)
436 (put 'comint-save-input-ring-index
'permanent-local t
)
437 (put 'comint-input-autoexpand
'permanent-local t
)
438 (put 'comint-input-filter-functions
'permanent-local t
)
439 (put 'comint-output-filter-functions
'permanent-local t
)
440 (put 'comint-preoutput-filter-functions
'permanent-local t
)
441 (put 'comint-scroll-to-bottom-on-input
'permanent-local t
)
442 (put 'comint-scroll-to-bottom-on-output
'permanent-local t
)
443 (put 'comint-scroll-show-maximum-output
'permanent-local t
)
444 (put 'comint-ptyp
'permanent-local t
)
446 (put 'comint-mode
'mode-class
'special
)
448 (define-derived-mode comint-mode fundamental-mode
"Comint"
449 "Major mode for interacting with an inferior interpreter.
450 Interpreter name is same as buffer name, sans the asterisks.
451 Return at end of buffer sends line as input.
452 Return not at end copies rest of line to end and sends it.
453 Setting variable `comint-eol-on-send' means jump to the end of the line
454 before submitting new input.
456 This mode is customised to create major modes such as Inferior Lisp
457 mode, Shell mode, etc. This can be done by setting the hooks
458 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
459 and `comint-get-old-input' to appropriate functions, and the variable
460 `comint-prompt-regexp' to the appropriate regular expression.
462 An input history is maintained of size `comint-input-ring-size', and
463 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
464 Input ring history expansion can be achieved with the commands
465 \\[comint-replace-by-expanded-history] or \\[comint-magic-space].
466 Input ring expansion is controlled by the variable `comint-input-autoexpand',
467 and addition is controlled by the variable `comint-input-ignoredups'.
469 Commands with no default key bindings include `send-invisible',
470 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
471 `comint-magic-space'.
473 Input to, and output from, the subprocess can cause the window to scroll to
474 the end of the buffer. See variables `comint-output-filter-functions',
475 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
476 and `comint-scroll-to-bottom-on-output'.
478 If you accidentally suspend your process, use \\[comint-continue-subjob]
483 Entry to this mode runs the hooks on `comint-mode-hook'."
484 (setq mode-line-process
'(":%s"))
485 (set (make-local-variable 'comint-last-input-start
) (point-min-marker))
486 (set (make-local-variable 'comint-last-input-end
) (point-min-marker))
487 (set (make-local-variable 'comint-last-output-start
) (make-marker))
488 (make-local-variable 'comint-last-output-overlay
)
489 (make-local-variable 'comint-last-prompt-overlay
)
490 (make-local-variable 'comint-prompt-regexp
) ; Don't set; default
491 (make-local-variable 'comint-input-ring-size
) ; ...to global val.
492 (make-local-variable 'comint-input-ring
)
493 (make-local-variable 'comint-input-ring-file-name
)
494 (or (and (boundp 'comint-input-ring
) comint-input-ring
)
495 (setq comint-input-ring
(make-ring comint-input-ring-size
)))
496 (make-local-variable 'comint-input-ring-index
)
497 (make-local-variable 'comint-save-input-ring-index
)
498 (or (and (boundp 'comint-input-ring-index
) comint-input-ring-index
)
499 (setq comint-input-ring-index nil
))
500 (or (and (boundp 'comint-save-input-ring-index
) comint-save-input-ring-index
)
501 (setq comint-save-input-ring-index nil
))
502 (make-local-variable 'comint-matching-input-from-input-string
)
503 (make-local-variable 'comint-input-autoexpand
)
504 (make-local-variable 'comint-input-ignoredups
)
505 (make-local-variable 'comint-delimiter-argument-list
)
506 (make-local-variable 'comint-completion-fignore
)
507 (make-local-variable 'comint-get-old-input
)
508 (make-local-variable 'comint-input-filter
)
509 (make-local-variable 'comint-input-sender
)
510 (make-local-variable 'comint-eol-on-send
)
511 (make-local-variable 'comint-scroll-to-bottom-on-input
)
512 (make-local-variable 'comint-scroll-to-bottom-on-output
)
513 (make-local-variable 'comint-scroll-show-maximum-output
)
514 (add-hook 'pre-command-hook
'comint-preinput-scroll-to-bottom t t
)
515 (make-local-variable 'comint-ptyp
)
516 (make-local-variable 'comint-process-echoes
)
517 (make-local-variable 'comint-file-name-chars
)
518 (make-local-variable 'comint-file-name-quote-list
)
519 (set (make-local-variable 'comint-accum-marker
) (make-marker))
520 ;; This behavior is not useful in comint buffers, and is annoying
521 (set (make-local-variable 'next-line-add-newlines
) nil
))
526 (setq comint-mode-map
(make-sparse-keymap))
527 (define-key comint-mode-map
"\ep" 'comint-previous-input
)
528 (define-key comint-mode-map
"\en" 'comint-next-input
)
529 (define-key comint-mode-map
[C-up
] 'comint-previous-input
)
530 (define-key comint-mode-map
[C-down
] 'comint-next-input
)
531 (define-key comint-mode-map
"\er" 'comint-previous-matching-input
)
532 (define-key comint-mode-map
"\es" 'comint-next-matching-input
)
533 (define-key comint-mode-map
[?\C-c ?\M-r
] 'comint-previous-matching-input-from-input
)
534 (define-key comint-mode-map
[?\C-c ?\M-s
] 'comint-next-matching-input-from-input
)
535 (define-key comint-mode-map
"\e\C-l" 'comint-show-output
)
536 (define-key comint-mode-map
"\C-m" 'comint-send-input
)
537 (define-key comint-mode-map
"\C-d" 'comint-delchar-or-maybe-eof
)
538 (define-key comint-mode-map
"\C-c " 'comint-accumulate
)
539 (define-key comint-mode-map
"\C-c\C-x" 'comint-get-next-from-history
)
540 (define-key comint-mode-map
"\C-c\C-a" 'comint-bol-or-process-mark
)
541 (define-key comint-mode-map
"\C-c\C-u" 'comint-kill-input
)
542 (define-key comint-mode-map
"\C-c\C-w" 'backward-kill-word
)
543 (define-key comint-mode-map
"\C-c\C-c" 'comint-interrupt-subjob
)
544 (define-key comint-mode-map
"\C-c\C-z" 'comint-stop-subjob
)
545 (define-key comint-mode-map
"\C-c\C-\\" 'comint-quit-subjob
)
546 (define-key comint-mode-map
"\C-c\C-m" 'comint-copy-old-input
)
547 (define-key comint-mode-map
"\C-c\C-o" 'comint-delete-output
)
548 (define-key comint-mode-map
"\C-c\C-r" 'comint-show-output
)
549 (define-key comint-mode-map
"\C-c\C-e" 'comint-show-maximum-output
)
550 (define-key comint-mode-map
"\C-c\C-l" 'comint-dynamic-list-input-ring
)
551 (define-key comint-mode-map
"\C-c\C-n" 'comint-next-prompt
)
552 (define-key comint-mode-map
"\C-c\C-p" 'comint-previous-prompt
)
553 (define-key comint-mode-map
"\C-c\C-d" 'comint-send-eof
)
554 (define-key comint-mode-map
"\C-c\C-s" 'comint-write-output
)
555 (define-key comint-mode-map
"\C-c." 'comint-insert-previous-argument
)
557 (define-key comint-mode-map
[mouse-2
] 'comint-insert-clicked-input
)
560 (define-key comint-mode-map
[menu-bar completion
]
561 (cons "Complete" (make-sparse-keymap "Complete")))
562 (define-key comint-mode-map
[menu-bar completion complete-expand
]
563 '("Expand File Name" . comint-replace-by-expanded-filename
))
564 (define-key comint-mode-map
[menu-bar completion complete-listing
]
565 '("File Completion Listing" . comint-dynamic-list-filename-completions
))
566 (define-key comint-mode-map
[menu-bar completion complete-file
]
567 '("Complete File Name" . comint-dynamic-complete-filename
))
568 (define-key comint-mode-map
[menu-bar completion complete
]
569 '("Complete Before Point" . comint-dynamic-complete
))
571 (define-key comint-mode-map
[menu-bar inout
]
572 (cons "In/Out" (make-sparse-keymap "In/Out")))
573 (define-key comint-mode-map
[menu-bar inout delete-output
]
574 '("Delete Current Output Group" . comint-delete-output
))
575 (define-key comint-mode-map
[menu-bar inout append-output-to-file
]
576 '("Append Current Output Group to File" . comint-append-output-to-file
))
577 (define-key comint-mode-map
[menu-bar inout write-output
]
578 '("Write Current Output Group to File" . comint-write-output
))
579 (define-key comint-mode-map
[menu-bar inout next-prompt
]
580 '("Forward Output Group" . comint-next-prompt
))
581 (define-key comint-mode-map
[menu-bar inout previous-prompt
]
582 '("Backward Output Group" . comint-previous-prompt
))
583 (define-key comint-mode-map
[menu-bar inout show-maximum-output
]
584 '("Show Maximum Output" . comint-show-maximum-output
))
585 (define-key comint-mode-map
[menu-bar inout show-output
]
586 '("Show Current Output Group" . comint-show-output
))
587 (define-key comint-mode-map
[menu-bar inout kill-input
]
588 '("Kill Current Input" . comint-kill-input
))
589 (define-key comint-mode-map
[menu-bar inout copy-input
]
590 '("Copy Old Input" . comint-copy-old-input
))
591 (define-key comint-mode-map
[menu-bar inout forward-matching-history
]
592 '("Forward Matching Input..." . comint-forward-matching-input
))
593 (define-key comint-mode-map
[menu-bar inout backward-matching-history
]
594 '("Backward Matching Input..." . comint-backward-matching-input
))
595 (define-key comint-mode-map
[menu-bar inout next-matching-history
]
596 '("Next Matching Input..." . comint-next-matching-input
))
597 (define-key comint-mode-map
[menu-bar inout previous-matching-history
]
598 '("Previous Matching Input..." . comint-previous-matching-input
))
599 (define-key comint-mode-map
[menu-bar inout next-matching-history-from-input
]
600 '("Next Matching Current Input" . comint-next-matching-input-from-input
))
601 (define-key comint-mode-map
[menu-bar inout previous-matching-history-from-input
]
602 '("Previous Matching Current Input" . comint-previous-matching-input-from-input
))
603 (define-key comint-mode-map
[menu-bar inout next-history
]
604 '("Next Input" . comint-next-input
))
605 (define-key comint-mode-map
[menu-bar inout previous-history
]
606 '("Previous Input" . comint-previous-input
))
607 (define-key comint-mode-map
[menu-bar inout list-history
]
608 '("List Input History" . comint-dynamic-list-input-ring
))
609 (define-key comint-mode-map
[menu-bar inout expand-history
]
610 '("Expand History Before Point" . comint-replace-by-expanded-history
))
612 (define-key comint-mode-map
[menu-bar signals
]
613 (cons "Signals" (make-sparse-keymap "Signals")))
614 (define-key comint-mode-map
[menu-bar signals eof
]
615 '("EOF" . comint-send-eof
))
616 (define-key comint-mode-map
[menu-bar signals kill
]
617 '("KILL" . comint-kill-subjob
))
618 (define-key comint-mode-map
[menu-bar signals quit
]
619 '("QUIT" . comint-quit-subjob
))
620 (define-key comint-mode-map
[menu-bar signals cont
]
621 '("CONT" . comint-continue-subjob
))
622 (define-key comint-mode-map
[menu-bar signals stop
]
623 '("STOP" . comint-stop-subjob
))
624 (define-key comint-mode-map
[menu-bar signals break
]
625 '("BREAK" . comint-interrupt-subjob
))
626 ;; Put them in the menu bar:
627 (setq menu-bar-final-items
(append '(completion inout signals
)
628 menu-bar-final-items
))
631 (defun comint-check-proc (buffer)
632 "Return t if there is a living process associated w/buffer BUFFER.
633 Living means the status is `open', `run', or `stop'.
634 BUFFER can be either a buffer or the name of one."
635 (let ((proc (get-buffer-process buffer
)))
636 (and proc
(memq (process-status proc
) '(open run stop
)))))
639 (defun make-comint-in-buffer (name buffer program
&optional startfile
&rest switches
)
640 "Make a comint process NAME in BUFFER, running PROGRAM.
641 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
642 PROGRAM should be either a string denoting an executable program to create
643 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
644 connection to be opened via `open-network-stream'. If there is already a
645 running process in that buffer, it is not restarted. Optional third arg
646 STARTFILE is the name of a file to send the contents of to the process.
648 If PROGRAM is a string, any more args are arguments to PROGRAM."
649 (or (fboundp 'start-process
)
650 (error "Multi-processing is not supported for this system"))
651 (setq buffer
(get-buffer-create (or buffer
(concat "*" name
"*"))))
652 ;; If no process, or nuked process, crank up a new one and put buffer in
653 ;; comint mode. Otherwise, leave buffer and existing process alone.
654 (unless (comint-check-proc buffer
)
655 (with-current-buffer buffer
656 (unless (derived-mode-p 'comint-mode
)
657 (comint-mode))) ; Install local vars, mode, keymap, ...
658 (comint-exec buffer name program startfile switches
))
662 (defun make-comint (name program
&optional startfile
&rest switches
)
663 "Make a comint process NAME in a buffer, running PROGRAM.
664 The name of the buffer is made by surrounding NAME with `*'s.
665 PROGRAM should be either a string denoting an executable program to create
666 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
667 connection to be opened via `open-network-stream'. If there is already a
668 running process in that buffer, it is not restarted. Optional third arg
669 STARTFILE is the name of a file to send the contents of to the process.
671 If PROGRAM is a string, any more args are arguments to PROGRAM."
672 (apply #'make-comint-in-buffer name nil program startfile switches
))
675 (defun comint-run (program)
676 "Run PROGRAM in a comint buffer and switch to it.
677 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
678 The file name is used to make a symbol name, such as `comint-sh-hook', and any
679 hooks on this symbol are run in the buffer.
680 See `make-comint' and `comint-exec'."
681 (interactive "sRun program: ")
682 (let ((name (file-name-nondirectory program
)))
683 (switch-to-buffer (make-comint name program
))
684 (run-hooks (intern-soft (concat "comint-" name
"-hook")))))
686 (defun comint-exec (buffer name command startfile switches
)
687 "Start up a process in buffer BUFFER for comint modes.
688 Blasts any old process running in the buffer. Doesn't set the buffer mode.
689 You can use this to cheaply run a series of processes in the same comint
690 buffer. The hook `comint-exec-hook' is run after each exec."
693 (let ((proc (get-buffer-process buffer
))) ; Blast any old process.
694 (if proc
(delete-process proc
)))
695 ;; Crank up a new process
698 (open-network-stream name buffer
(car command
) (cdr command
))
699 (comint-exec-1 name buffer command switches
))))
700 (set-process-filter proc
'comint-output-filter
)
701 (make-local-variable 'comint-ptyp
)
702 (setq comint-ptyp process-connection-type
) ; t if pty, nil if pipe.
703 ;; Jump to the end, and set the process mark.
704 (goto-char (point-max))
705 (set-marker (process-mark proc
) (point))
706 ;; Feed it the startfile.
708 ;;This is guaranteed to wait long enough
709 ;;but has bad results if the comint does not prompt at all
710 ;; (while (= size (buffer-size))
712 ;;I hope 1 second is enough!
714 (goto-char (point-max))
715 (insert-file-contents startfile
)
716 (setq startfile
(buffer-substring (point) (point-max)))
717 (delete-region (point) (point-max))
718 (comint-send-string proc startfile
)))
719 (run-hooks 'comint-exec-hook
)
722 ;; This auxiliary function cranks up the process for comint-exec in
723 ;; the appropriate environment.
725 (defun comint-exec-1 (name buffer command switches
)
726 (let ((process-environment
728 ;; If using termcap, we specify `emacs' as the terminal type
729 ;; because that lets us specify a width.
730 ;; If using terminfo, we specify `dumb' because that is
731 ;; a defined terminal type. `emacs' is not a defined terminal type
732 ;; and there is no way for us to define it here.
733 ;; Some programs that use terminfo get very confused
734 ;; if TERM is not a valid terminal type.
735 ;; ;; There is similar code in compile.el.
736 (if (and (boundp 'system-uses-terminfo
) system-uses-terminfo
)
737 (list "TERM=dumb" "TERMCAP="
738 (format "COLUMNS=%d" (window-width)))
740 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
741 (if (getenv "EMACS") nil
(list "EMACS=t"))
742 process-environment
))
744 (if (file-accessible-directory-p default-directory
)
746 (char-to-string directory-sep-char
)))
747 proc decoding encoding changed
)
748 (let ((exec-path (if (file-name-directory command
)
749 ;; If the command has slashes, make sure we
750 ;; first look relative to the current directory.
751 (cons default-directory exec-path
) exec-path
)))
752 (setq proc
(apply 'start-process name buffer command switches
)))
753 (let ((coding-systems (process-coding-system proc
)))
754 (setq decoding
(car coding-systems
)
755 encoding
(cdr coding-systems
)))
756 ;; If start-process decided to use some coding system for decoding
757 ;; data sent from the process and the coding system doesn't
758 ;; specify EOL conversion, we had better convert CRLF to LF.
759 (if (vectorp (coding-system-eol-type decoding
))
760 (setq decoding
(coding-system-change-eol-conversion decoding
'dos
)
762 ;; Even if start-process left the coding system for encoding data
763 ;; sent from the process undecided, we had better use the same one
764 ;; as what we use for decoding. But, we should suppress EOL
766 (if (and decoding
(not encoding
))
767 (setq encoding
(coding-system-change-eol-conversion decoding
'unix
)
770 (set-process-coding-system proc decoding encoding
))
774 (defun comint-insert-clicked-input (event)
775 "In a comint buffer, set the current input to the clicked-on previous input."
777 (let ((over (catch 'found
778 ;; Ignore non-input overlays
779 (dolist (ov (overlays-at (posn-point (event-end event
))))
780 (when (eq (overlay-get ov
'field
) 'input
)
781 (throw 'found ov
))))))
782 ;; Do we have input in this area?
784 (let ((input-str (buffer-substring (overlay-start over
)
785 (overlay-end over
))))
786 (goto-char (point-max))
788 ;; Can't use kill-region as it sets this-command
789 (or (marker-position comint-accum-marker
)
790 (process-mark (get-buffer-process (current-buffer))))
793 ;; Fall back to the global definition.
794 (let* ((keys (this-command-keys))
795 (last-key (and (vectorp keys
) (aref keys
(1- (length keys
)))))
796 (fun (and last-key
(lookup-key global-map
(vector last-key
)))))
797 (if fun
(call-interactively fun
))))))
800 ;; Input history processing in a buffer
801 ;; ===========================================================================
802 ;; Useful input history functions, courtesy of the Ergo group.
805 ;; comint-dynamic-list-input-ring List history in help buffer.
806 ;; comint-previous-input Previous input...
807 ;; comint-previous-matching-input ...matching a string.
808 ;; comint-previous-matching-input-from-input ... matching the current input.
809 ;; comint-next-input Next input...
810 ;; comint-next-matching-input ...matching a string.
811 ;; comint-next-matching-input-from-input ... matching the current input.
812 ;; comint-backward-matching-input Backwards input...
813 ;; comint-forward-matching-input ...matching a string.
814 ;; comint-replace-by-expanded-history Expand history at point;
815 ;; replace with expanded history.
816 ;; comint-magic-space Expand history and insert space.
819 ;; comint-read-input-ring Read into comint-input-ring...
820 ;; comint-write-input-ring Write to comint-input-ring-file-name.
821 ;; comint-replace-by-expanded-history-before-point Workhorse function.
823 (defun comint-read-input-ring (&optional silent
)
824 "Sets the buffer's `comint-input-ring' from a history file.
825 The name of the file is given by the variable `comint-input-ring-file-name'.
826 The history ring is of size `comint-input-ring-size', regardless of file size.
827 If `comint-input-ring-file-name' is nil this function does nothing.
829 If the optional argument SILENT is non-nil, we say nothing about a
830 failure to read the history file.
832 This function is useful for major mode commands and mode hooks.
834 The commands stored in the history file are separated by the
835 `comint-input-ring-separator', and entries that match
836 `comint-input-history-ignore' are ignored. The most recent command
839 See also `comint-input-ignoredups' and `comint-write-input-ring'."
840 (cond ((or (null comint-input-ring-file-name
)
841 (equal comint-input-ring-file-name
""))
843 ((not (file-readable-p comint-input-ring-file-name
))
845 (message "Cannot read history file %s"
846 comint-input-ring-file-name
)))
848 (let* ((history-buf (get-buffer-create " *temp*"))
849 (file comint-input-ring-file-name
)
851 (size comint-input-ring-size
)
852 (ring (make-ring size
)))
855 (set-buffer history-buf
)
858 (insert-file-contents file
)
859 ;; Save restriction in case file is already visited...
860 ;; Watch for those date stamps in history files!
861 (goto-char (point-max))
862 (let (start end history
)
863 (while (and (< count comint-input-ring-size
)
864 (re-search-backward comint-input-ring-separator nil t
)
865 (setq end
(match-beginning 0)))
866 (if (re-search-backward comint-input-ring-separator nil t
)
867 (setq start
(match-end 0))
868 (setq start
(point-min)))
869 (setq history
(buffer-substring start end
))
871 (if (and (not (string-match comint-input-history-ignore history
))
872 (or (null comint-input-ignoredups
)
874 (not (string-equal (ring-ref ring
0) history
))))
876 (ring-insert-at-beginning ring history
)
877 (setq count
(1+ count
)))))))
878 (kill-buffer history-buf
))
879 (setq comint-input-ring ring
880 comint-input-ring-index nil
)))))
882 (defun comint-write-input-ring ()
883 "Writes the buffer's `comint-input-ring' to a history file.
884 The name of the file is given by the variable `comint-input-ring-file-name'.
885 The original contents of the file are lost if `comint-input-ring' is not empty.
886 If `comint-input-ring-file-name' is nil this function does nothing.
888 Useful within process sentinels.
890 See also `comint-read-input-ring'."
891 (cond ((or (null comint-input-ring-file-name
)
892 (equal comint-input-ring-file-name
"")
893 (null comint-input-ring
) (ring-empty-p comint-input-ring
))
895 ((not (file-writable-p comint-input-ring-file-name
))
896 (message "Cannot write history file %s" comint-input-ring-file-name
))
898 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
899 (ring comint-input-ring
)
900 (file comint-input-ring-file-name
)
901 (index (ring-length ring
)))
902 ;; Write it all out into a buffer first. Much faster, but messier,
903 ;; than writing it one line at a time.
905 (set-buffer history-buf
)
908 (setq index
(1- index
))
909 (insert (ring-ref ring index
) comint-input-ring-separator
))
910 (write-region (buffer-string) nil file nil
'no-message
)
911 (kill-buffer nil
))))))
914 (defvar comint-dynamic-list-input-ring-window-conf
)
916 (defun comint-dynamic-list-input-ring-select ()
917 "Choose the input history entry that point is in or next to."
919 (let (beg end completion
(buffer completion-reference-buffer
)
920 (base-size completion-base-size
))
921 (if (and (not (eobp)) (get-text-property (point) 'mouse-face
))
922 (setq end
(point) beg
(1+ (point))))
923 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face
))
924 (setq end
(1- (point)) beg
(point)))
926 (error "No history entry here"))
927 (setq beg
(previous-single-property-change beg
'mouse-face
))
928 (setq end
(or (next-single-property-change end
'mouse-face
) (point-max)))
929 (setq completion
(buffer-substring beg end
))
930 (set-window-configuration comint-dynamic-list-input-ring-window-conf
)
931 (choose-completion-string completion buffer base-size
)))
933 (defun comint-dynamic-list-input-ring ()
934 "List in help buffer the buffer's input history."
936 (if (or (not (ring-p comint-input-ring
))
937 (ring-empty-p comint-input-ring
))
938 (message "No history")
940 (history-buffer " *Input History*")
941 (index (1- (ring-length comint-input-ring
)))
942 (conf (current-window-configuration)))
943 ;; We have to build up a list ourselves from the ring vector.
945 (setq history
(cons (ring-ref comint-input-ring index
) history
)
947 ;; Change "completion" to "history reference"
948 ;; to make the display accurate.
949 (with-output-to-temp-buffer history-buffer
950 (display-completion-list history
)
951 (set-buffer history-buffer
)
952 (let ((keymap (make-sparse-keymap)))
953 (set-keymap-parent keymap
(current-local-map))
954 (define-key keymap
"\C-m" 'comint-dynamic-list-input-ring-select
)
955 (use-local-map keymap
))
957 (while (search-backward "completion" nil
'move
)
958 (replace-match "history reference")))
960 (message "Hit space to flush")
961 (setq comint-dynamic-list-input-ring-window-conf conf
)
962 (let ((ch (read-event)))
964 (set-window-configuration conf
)
965 (setq unread-command-events
(list ch
)))))))
968 (defun comint-regexp-arg (prompt)
969 ;; Return list of regexp and prefix arg using PROMPT.
970 (let* (;; Don't clobber this.
971 (last-command last-command
)
972 (regexp (read-from-minibuffer prompt nil nil nil
973 'minibuffer-history-search-history
)))
974 (list (if (string-equal regexp
"")
975 (setcar minibuffer-history-search-history
976 (nth 1 minibuffer-history-search-history
))
978 (prefix-numeric-value current-prefix-arg
))))
980 (defun comint-search-arg (arg)
981 ;; First make sure there is a ring and that we are after the process mark
982 (cond ((not (comint-after-pmark-p))
983 (error "Not at command line"))
984 ((or (null comint-input-ring
)
985 (ring-empty-p comint-input-ring
))
986 (error "Empty input ring"))
988 ;; arg of zero resets search from beginning, and uses arg of 1
989 (setq comint-input-ring-index nil
)
994 (defun comint-search-start (arg)
995 ;; Index to start a directional search, starting at comint-input-ring-index
996 (if comint-input-ring-index
997 ;; If a search is running, offset by 1 in direction of arg
998 (mod (+ comint-input-ring-index
(if (> arg
0) 1 -
1))
999 (ring-length comint-input-ring
))
1000 ;; For a new search, start from beginning or end, as appropriate
1002 0 ; First elt for forward search
1003 (1- (ring-length comint-input-ring
))))) ; Last elt for backward search
1005 (defun comint-previous-input-string (arg)
1006 "Return the string ARG places along the input ring.
1007 Moves relative to `comint-input-ring-index'."
1008 (ring-ref comint-input-ring
(if comint-input-ring-index
1009 (mod (+ arg comint-input-ring-index
)
1010 (ring-length comint-input-ring
))
1013 (defun comint-previous-input (arg)
1014 "Cycle backwards through input history."
1016 (comint-previous-matching-input "." arg
))
1018 (defun comint-next-input (arg)
1019 "Cycle forwards through input history."
1021 (comint-previous-input (- arg
)))
1023 (defun comint-previous-matching-input-string (regexp arg
)
1024 "Return the string matching REGEXP ARG places along the input ring.
1025 Moves relative to `comint-input-ring-index'."
1026 (let* ((pos (comint-previous-matching-input-string-position regexp arg
)))
1027 (if pos
(ring-ref comint-input-ring pos
))))
1029 (defun comint-previous-matching-input-string-position (regexp arg
&optional start
)
1030 "Return the index matching REGEXP ARG places along the input ring.
1031 Moves relative to START, or `comint-input-ring-index'."
1032 (if (or (not (ring-p comint-input-ring
))
1033 (ring-empty-p comint-input-ring
))
1034 (error "No history"))
1035 (let* ((len (ring-length comint-input-ring
))
1036 (motion (if (> arg
0) 1 -
1))
1037 (n (mod (- (or start
(comint-search-start arg
)) motion
) len
))
1038 (tried-each-ring-item nil
)
1040 ;; Do the whole search as many times as the argument says.
1041 (while (and (/= arg
0) (not tried-each-ring-item
))
1044 n
(mod (+ n motion
) len
))
1045 ;; If we haven't reached a match, step some more.
1046 (while (and (< n len
) (not tried-each-ring-item
)
1047 (not (string-match regexp
(ring-ref comint-input-ring n
))))
1048 (setq n
(mod (+ n motion
) len
)
1049 ;; If we have gone all the way around in this search.
1050 tried-each-ring-item
(= n prev
)))
1051 (setq arg
(if (> arg
0) (1- arg
) (1+ arg
))))
1052 ;; Now that we know which ring element to use, if we found it, return that.
1053 (if (string-match regexp
(ring-ref comint-input-ring n
))
1056 (defun comint-previous-matching-input (regexp arg
)
1057 "Search backwards through input history for match for REGEXP.
1058 \(Previous history elements are earlier commands.)
1059 With prefix argument N, search for Nth previous match.
1060 If N is negative, find the next or Nth next match."
1061 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1062 (setq arg
(comint-search-arg arg
))
1063 (let ((pos (comint-previous-matching-input-string-position regexp arg
)))
1064 ;; Has a match been found?
1067 (setq comint-input-ring-index pos
)
1068 (message "History item: %d" (1+ pos
))
1070 ;; Can't use kill-region as it sets this-command
1071 (or (marker-position comint-accum-marker
)
1072 (process-mark (get-buffer-process (current-buffer))))
1074 (insert (ring-ref comint-input-ring pos
)))))
1076 (defun comint-next-matching-input (regexp arg
)
1077 "Search forwards through input history for match for REGEXP.
1078 \(Later history elements are more recent commands.)
1079 With prefix argument N, search for Nth following match.
1080 If N is negative, find the previous or Nth previous match."
1081 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1082 (comint-previous-matching-input regexp
(- arg
)))
1084 (defun comint-previous-matching-input-from-input (arg)
1085 "Search backwards through input history for match for current input.
1086 \(Previous history elements are earlier commands.)
1087 With prefix argument N, search for Nth previous match.
1088 If N is negative, search forwards for the -Nth following match."
1090 (if (not (memq last-command
'(comint-previous-matching-input-from-input
1091 comint-next-matching-input-from-input
)))
1092 ;; Starting a new search
1093 (setq comint-matching-input-from-input-string
1095 (or (marker-position comint-accum-marker
)
1096 (process-mark (get-buffer-process (current-buffer))))
1098 comint-input-ring-index nil
))
1099 (comint-previous-matching-input
1100 (concat "^" (regexp-quote comint-matching-input-from-input-string
))
1103 (defun comint-next-matching-input-from-input (arg)
1104 "Search forwards through input history for match for current input.
1105 \(Following history elements are more recent commands.)
1106 With prefix argument N, search for Nth following match.
1107 If N is negative, search backwards for the -Nth previous match."
1109 (comint-previous-matching-input-from-input (- arg
)))
1112 (defun comint-replace-by-expanded-history (&optional silent start
)
1113 "Expand input command history references before point.
1114 Expansion is dependent on the value of `comint-input-autoexpand'.
1116 This function depends on the buffer's idea of the input history, which may not
1117 match the command interpreter's idea, assuming it has one.
1119 Assumes history syntax is like typical Un*x shells'. However, since emacs
1120 cannot know the interpreter's idea of input line numbers, assuming it has one,
1121 it cannot expand absolute input line number references.
1123 If the optional argument SILENT is non-nil, never complain
1124 even if history reference seems erroneous.
1126 If the optional argument START is non-nil, that specifies the
1127 start of the text to scan for history references, rather
1128 than the logical beginning of line.
1130 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1132 Returns t if successful."
1134 (if (and comint-input-autoexpand
1135 (if comint-use-prompt-regexp-instead-of-fields
1136 ;; Use comint-prompt-regexp
1139 (looking-at (concat comint-prompt-regexp
"!\\|\\^")))
1140 ;; Use input fields. User input that hasn't been entered
1141 ;; yet, at the end of the buffer, has a nil `field' property.
1142 (and (null (get-char-property (point) 'field
))
1143 (string-match "!\\|^\\^" (field-string)))))
1144 ;; Looks like there might be history references in the command.
1145 (let ((previous-modified-tick (buffer-modified-tick)))
1146 (comint-replace-by-expanded-history-before-point silent start
)
1147 (/= previous-modified-tick
(buffer-modified-tick)))))
1150 (defun comint-replace-by-expanded-history-before-point (silent &optional start
)
1151 "Expand directory stack reference before point.
1152 See `comint-replace-by-expanded-history'. Returns t if successful.
1154 If the optional argument START is non-nil, that specifies the
1155 start of the text to scan for history references, rather
1156 than the logical beginning of line."
1158 (let ((toend (- (line-end-position) (point)))
1159 (start (comint-line-beginning-position)))
1162 (skip-chars-forward "^!^" (- (line-end-position) toend
))
1163 (< (point) (- (line-end-position) toend
)))
1164 ;; This seems a bit complex. We look for references such as !!, !-num,
1165 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1166 ;; If that wasn't enough, the plings can be suffixed with argument
1167 ;; range specifiers.
1168 ;; Argument ranges are complex too, so we hive off the input line,
1169 ;; referenced with plings, with the range string to `comint-args'.
1170 (setq comint-input-ring-index nil
)
1171 (cond ((or (= (preceding-char) ?
\\)
1172 (comint-within-quotes start
(point)))
1173 ;; The history is quoted, or we're in quotes.
1174 (goto-char (1+ (point))))
1175 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1176 ;; We cannot know the interpreter's idea of input line numbers.
1177 (goto-char (match-end 0))
1178 (message "Absolute reference cannot be expanded"))
1179 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1180 ;; Just a number of args from `number' lines backward.
1181 (let ((number (1- (string-to-number
1182 (buffer-substring (match-beginning 1)
1184 (if (<= number
(ring-length comint-input-ring
))
1187 (comint-args (comint-previous-input-string number
)
1188 (match-beginning 2) (match-end 2))
1190 (setq comint-input-ring-index number
)
1191 (message "History item: %d" (1+ number
)))
1192 (goto-char (match-end 0))
1193 (message "Relative reference exceeds input history size"))))
1194 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1195 ;; Just a number of args from the previous input line.
1197 (comint-args (comint-previous-input-string 0)
1198 (match-beginning 1) (match-end 1))
1200 (message "History item: previous"))
1202 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1203 ;; Most recent input starting with or containing (possibly
1204 ;; protected) string, maybe just a number of args. Phew.
1205 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1206 (mb2 (match-beginning 2)) (me2 (match-end 2))
1207 (exp (buffer-substring (or mb2 mb1
) (or me2 me1
)))
1208 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1209 (pos (save-match-data
1210 (comint-previous-matching-input-string-position
1211 (concat pref
(regexp-quote exp
)) 1))))
1214 (goto-char (match-end 0))
1216 (progn (message "Not found")
1218 (setq comint-input-ring-index pos
)
1220 (comint-args (ring-ref comint-input-ring pos
)
1221 (match-beginning 4) (match-end 4))
1223 (message "History item: %d" (1+ pos
)))))
1224 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1225 ;; Quick substitution on the previous input line.
1226 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1227 (new (buffer-substring (match-beginning 2) (match-end 2)))
1229 (replace-match (comint-previous-input-string 0) t t
)
1231 (goto-char (match-beginning 0))
1232 (if (not (search-forward old pos t
))
1234 (error "Not found"))
1235 (replace-match new t t
)
1236 (message "History item: substituted"))))
1238 (forward-char 1)))))))
1241 (defun comint-magic-space (arg)
1242 "Expand input history references before point and insert ARG spaces.
1243 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1245 (comint-replace-by-expanded-history)
1246 (self-insert-command arg
))
1248 (defun comint-within-quotes (beg end
)
1249 "Return t if the number of quotes between BEG and END is odd.
1250 Quotes are single and double."
1251 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end
))
1252 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end
)))
1253 (or (= (mod countsq
2) 1) (= (mod countdq
2) 1))))
1255 (defun comint-how-many-region (regexp beg end
)
1256 "Return number of matches for REGEXP from BEG to END."
1261 (while (re-search-forward regexp end t
)
1262 (setq count
(1+ count
)))))
1265 (defun comint-args (string begin end
)
1266 ;; From STRING, return the args depending on the range specified in the text
1267 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1268 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1271 (comint-arguments string
0 nil
)
1272 (let* ((range (buffer-substring
1273 (if (eq (char-after begin
) ?
:) (1+ begin
) begin
) end
))
1274 (nth (cond ((string-match "^[*^]" range
) 1)
1275 ((string-match "^-" range
) 0)
1276 ((string-equal range
"$") nil
)
1277 (t (string-to-number range
))))
1278 (mth (cond ((string-match "[-*$]$" range
) nil
)
1279 ((string-match "-" range
)
1280 (string-to-number (substring range
(match-end 0))))
1282 (comint-arguments string nth mth
)))))
1284 ;; Return a list of arguments from ARG. Break it up at the
1285 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1286 (defun comint-delim-arg (arg)
1287 (if (null comint-delimiter-argument-list
)
1293 (let ((char (aref arg pos
))
1295 (if (memq char comint-delimiter-argument-list
)
1296 (while (and (< pos len
) (eq (aref arg pos
) char
))
1297 (setq pos
(1+ pos
)))
1298 (while (and (< pos len
)
1299 (not (memq (aref arg pos
)
1300 comint-delimiter-argument-list
)))
1301 (setq pos
(1+ pos
))))
1302 (setq args
(cons (substring arg start pos
) args
))))
1305 (defun comint-arguments (string nth mth
)
1306 "Return from STRING the NTH to MTH arguments.
1307 NTH and/or MTH can be nil, which means the last argument.
1308 Returned arguments are separated by single spaces.
1309 We assume whitespace separates arguments, except within quotes
1310 and except for a space or tab that immediately follows a backslash.
1311 Also, a run of one or more of a single character
1312 in `comint-delimiter-argument-list' is a separate argument.
1313 Argument 0 is the command name."
1314 ;; The first line handles ordinary characters and backslash-sequences
1315 ;; (except with w32 msdos-like shells, where backslashes are valid).
1316 ;; The second matches "-quoted strings.
1317 ;; The third matches '-quoted strings.
1318 ;; The fourth matches `-quoted strings.
1319 ;; This seems to fit the syntax of BASH 2.0.
1320 (let* ((first (if (and (eq system-type
'windows-nt
)
1321 (w32-shell-dos-semantics))
1323 "[^ \n\t\"'`\\]+\\|\\\\[\"'`\\ \t]+\\|"))
1324 (argpart (concat first
1325 "\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\
1330 beg str value quotes
)
1331 ;; Build a list of all the args until we have as many as we want.
1332 (while (and (or (null mth
) (<= count mth
))
1333 (string-match argpart string pos
))
1334 (if (and beg
(= pos
(match-beginning 0)))
1335 ;; It's contiguous, part of the same arg.
1336 (setq pos
(match-end 0)
1337 quotes
(or quotes
(match-beginning 1)))
1338 ;; It's a new separate arg.
1340 ;; Put the previous arg, if there was one, onto ARGS.
1341 (setq str
(substring string beg pos
)
1342 args
(if quotes
(cons str args
)
1343 (nconc (comint-delim-arg str
) args
))
1345 (setq quotes
(match-beginning 1))
1346 (setq beg
(match-beginning 0))
1347 (setq pos
(match-end 0))))
1349 (setq str
(substring string beg pos
)
1350 args
(if quotes
(cons str args
)
1351 (nconc (comint-delim-arg str
) args
))
1353 (let ((n (or nth
(1- count
)))
1354 (m (if mth
(1- (- count mth
)) 0)))
1356 (function (lambda (a) a
)) (nthcdr n
(nreverse (nthcdr m args
))) " "))))
1359 ;; Input processing stuff
1361 (defun comint-add-to-input-history (cmd)
1362 "Add CMD to the input history.
1363 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1364 (if (and (funcall comint-input-filter cmd
)
1365 (or (null comint-input-ignoredups
)
1366 (not (ring-p comint-input-ring
))
1367 (ring-empty-p comint-input-ring
)
1368 (not (string-equal (ring-ref comint-input-ring
0)
1370 (ring-insert comint-input-ring cmd
)))
1372 (defun comint-send-input (&optional no-newline
)
1373 "Send input to process.
1374 After the process output mark, sends all text from the process mark to
1375 point as input to the process. Before the process output mark, calls
1376 value of variable `comint-get-old-input' to retrieve old input, copies
1377 it to the process mark, and sends it. A terminal newline is also
1378 inserted into the buffer and sent to the process.
1380 Any history reference may be expanded depending on the value of the variable
1381 `comint-input-autoexpand'. The list of function names contained in the value
1382 of `comint-input-filter-functions' is called on the input before sending it.
1383 The input is entered into the input history ring, if the value of variable
1384 `comint-input-filter' returns non-nil when called on the input.
1386 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1387 end of line before sending the input.
1389 After the input has been sent, if `comint-process-echoes' is non-nil,
1390 then comint-send-input waits to see if the process outputs a string
1391 matching the input, and if so, deletes that part of the output.
1393 The values of `comint-get-old-input', `comint-input-filter-functions', and
1394 `comint-input-filter' are chosen according to the command interpreter running
1395 in the buffer. E.g.,
1397 If the interpreter is the csh,
1398 comint-get-old-input is the default:
1399 If `comint-use-prompt-regexp-instead-of-fields' is nil, then
1400 either return the current input field, if point is on an input
1401 field, or the current line, if point is on an output field.
1402 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then
1403 return the current line with any initial string matching the
1404 regexp `comint-prompt-regexp' removed.
1405 comint-input-filter-functions monitors input for \"cd\", \"pushd\", and
1406 \"popd\" commands. When it sees one, it cd's the buffer.
1407 comint-input-filter is the default: returns t if the input isn't all white
1410 If the comint is Lucid Common Lisp,
1411 comint-get-old-input snarfs the sexp ending at point.
1412 comint-input-filter-functions does nothing.
1413 comint-input-filter returns nil if the input matches input-filter-regexp,
1414 which matches (1) all whitespace (2) :a, :c, etc.
1416 Similarly for Soar, Scheme, etc."
1418 ;; Note that the input string does not include its terminal newline.
1419 (let ((proc (get-buffer-process (current-buffer))))
1420 (if (not proc
) (error "Current buffer has no process")
1421 (let* ((pmark (process-mark proc
))
1422 (intxt (if (>= (point) (marker-position pmark
))
1423 (progn (if comint-eol-on-send
(end-of-line))
1424 (buffer-substring pmark
(point)))
1425 (let ((copy (funcall comint-get-old-input
)))
1429 (input (if (not (eq comint-input-autoexpand
'input
))
1430 ;; Just whatever's already there
1432 ;; Expand and leave it visible in buffer
1433 (comint-replace-by-expanded-history t pmark
)
1434 (buffer-substring pmark
(point))))
1435 (history (if (not (eq comint-input-autoexpand
'history
))
1437 ;; This is messy 'cos ultimately the original
1438 ;; functions used do insertion, rather than return
1439 ;; strings. We have to expand, then insert back.
1440 (comint-replace-by-expanded-history t pmark
)
1441 (let ((copy (buffer-substring pmark
(point)))
1444 (delete-region pmark start
)
1450 (comint-add-to-input-history history
)
1452 (run-hook-with-args 'comint-input-filter-functions
1453 (if no-newline input
1454 (concat input
"\n")))
1456 (let ((beg (marker-position pmark
))
1457 (end (if no-newline
(point) (1- (point)))))
1458 (when (not (> beg end
)) ; handle a special case
1459 ;; Make an overlay for the input field
1460 (let ((over (make-overlay beg end nil nil t
)))
1461 (unless comint-use-prompt-regexp-instead-of-fields
1462 ;; Give old user input a field property of `input', to
1463 ;; distinguish it from both process output and unsent
1464 ;; input. The terminating newline is put into a special
1465 ;; `boundary' field to make cursor movement between input
1466 ;; and output fields smoother.
1467 (overlay-put over
'field
'input
))
1468 (when comint-highlight-input
1469 (overlay-put over
'face
'comint-highlight-input
)
1470 (overlay-put over
'mouse-face
'highlight
)
1473 "mouse-2: insert after prompt as new input")
1474 (overlay-put over
'evaporate t
))))
1475 (unless comint-use-prompt-regexp-instead-of-fields
1476 ;; Make an overlay for the terminating newline
1477 (let ((over (make-overlay end
(1+ end
) nil t nil
)))
1478 (overlay-put over
'field
'boundary
)
1479 (overlay-put over
'inhibit-line-move-field-capture t
)
1480 (overlay-put over
'evaporate t
))))
1482 (comint-snapshot-last-prompt)
1484 (setq comint-save-input-ring-index comint-input-ring-index
)
1485 (setq comint-input-ring-index nil
)
1486 ;; Update the markers before we send the input
1487 ;; in case we get output amidst sending the input.
1488 (set-marker comint-last-input-start pmark
)
1489 (set-marker comint-last-input-end
(point))
1490 (set-marker (process-mark proc
) (point))
1491 ;; clear the "accumulation" marker
1492 (set-marker comint-accum-marker nil
)
1493 (let ((comint-input-sender-no-newline no-newline
))
1494 (funcall comint-input-sender proc input
))
1496 ;; Optionally delete echoed input (after checking it).
1497 (when comint-process-echoes
1498 (let ((echo-len (- comint-last-input-end
1499 comint-last-input-start
)))
1500 ;; Wait for all input to be echoed:
1501 (while (and (accept-process-output proc
)
1502 (> (+ comint-last-input-end echo-len
)
1505 (compare-buffer-substrings
1506 nil comint-last-input-start
1507 (- (point-max) echo-len
)
1508 ;; Above difference is equivalent to
1509 ;; (+ comint-last-input-start
1510 ;; (- (point-max) comint-last-input-end))
1511 nil comint-last-input-end
(point-max)))))
1513 (<= (+ comint-last-input-end echo-len
)
1516 (compare-buffer-substrings
1517 nil comint-last-input-start comint-last-input-end
1518 nil comint-last-input-end
1519 (+ comint-last-input-end echo-len
))))
1520 (delete-region comint-last-input-end
1521 (+ comint-last-input-end echo-len
)))))
1523 ;; This used to call comint-output-filter-functions,
1524 ;; but that scrolled the buffer in undesirable ways.
1525 (run-hook-with-args 'comint-output-filter-functions
"")))))
1527 (defvar comint-preoutput-filter-functions nil
1528 "List of functions to call before inserting Comint output into the buffer.
1529 Each function gets one argument, a string containing the text received
1530 from the subprocess. It should return the string to insert, perhaps
1531 the same string that was received, or perhaps a modified or transformed
1534 The functions on the list are called sequentially, and each one is
1535 given the string returned by the previous one. The string returned by
1536 the last function is the text that is actually inserted in the
1539 This variable is permanent-local.")
1541 ;; When non-nil, this is the last overlay used for output.
1542 ;; It is kept around so that we can extend it instead of creating
1543 ;; multiple contiguous overlays for multiple contiguous output chunks.
1544 (defvar comint-last-output-overlay nil
)
1546 ;; When non-nil, this is an overlay over the last recognized prompt in
1547 ;; the buffer; it is used when highlighting the prompt.
1548 (defvar comint-last-prompt-overlay nil
)
1550 ;; `snapshot' any current comint-last-prompt-overlay, freezing it in place.
1551 ;; Any further output will then create a new comint-last-prompt-overlay.
1552 (defun comint-snapshot-last-prompt ()
1553 (when comint-last-prompt-overlay
1554 (overlay-put comint-last-prompt-overlay
'evaporate t
)
1555 (setq comint-last-prompt-overlay nil
)))
1557 (defun comint-carriage-motion (string)
1558 "Handle carriage control characters in comint output.
1559 Translate carriage return/linefeed sequences to linefeeds.
1560 Make single carriage returns delete to the beginning of the line.
1561 Make backspaces delete the previous character.
1563 This function should be in the list `comint-output-filter-functions'."
1565 ;; We first check to see if STRING contains any magic characters, to
1566 ;; avoid overhead in the common case where it does not
1567 (when (string-match "[\r\b]" string
)
1568 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1572 (let ((inhibit-field-text-motion t
)
1573 (buffer-read-only nil
))
1575 ;; Note that this won't work properly when the CR and LF
1576 ;; are in different output chunks, but this is probably an
1577 ;; exceedingly rare case (because they are generally
1578 ;; written as a unit), and to delay interpretation of a
1579 ;; trailing CR in a chunk would result in odd interactive
1580 ;; behavior (and this case is probably far more common).
1581 (goto-char comint-last-output-start
)
1582 (while (re-search-forward "\r$" pmark t
)
1584 ;; bare CR -> delete preceding line
1585 (goto-char comint-last-output-start
)
1586 (while (search-forward "\r" pmark t
)
1587 (delete-region (point) (line-beginning-position)))
1588 ;; BS -> delete preceding character
1589 (goto-char comint-last-output-start
)
1590 (while (search-forward "\b" pmark t
)
1591 (delete-char -
2)))))))))
1593 (add-hook 'comint-output-filter-functions
'comint-carriage-motion
)
1595 ;; The purpose of using this filter for comint processes
1596 ;; is to keep comint-last-input-end from moving forward
1597 ;; when output is inserted.
1598 (defun comint-output-filter (process string
)
1599 (let ((oprocbuf (process-buffer process
)))
1600 ;; First check for killed buffer or no input.
1601 (when (and string oprocbuf
(buffer-name oprocbuf
))
1602 (with-current-buffer oprocbuf
1603 ;; Run preoutput filters
1604 (let ((functions comint-preoutput-filter-functions
))
1605 (while (and functions string
)
1606 (setq string
(funcall (car functions
) string
))
1607 (setq functions
(cdr functions
))))
1610 (let ((buffer-read-only nil
)
1611 ;; Avoid the overhead of save-excursion, since we just
1612 ;; fiddle with the point
1613 (saved-point (point-marker)))
1615 ;; The point should float after any insertion we do
1616 (set-marker-insertion-type saved-point t
)
1618 ;; We temporarly remove any buffer narrowing, in case the
1619 ;; process mark is outside of the restriction
1623 (goto-char (process-mark process
))
1624 (set-marker comint-last-output-start
(point))
1626 ;; insert-before-markers is a bad thing. XXX
1628 ;; It is used here to force window-point markers (used to
1629 ;; store the value of point in non-selected windows) to
1630 ;; advance, but it also screws up any other markers that we
1631 ;; don't _want_ to advance, such as the start-marker of some
1632 ;; of the overlays we create.
1634 ;; We work around the problem with the overlays by
1635 ;; explicitly adjusting them after we do the insertion, but
1636 ;; in the future this problem should be solved correctly, by
1637 ;; using `insert', and making the insertion-type of
1638 ;; window-point markers settable (via a buffer-local
1639 ;; variable). In comint buffers, this variable would be set
1640 ;; to `t', to cause point in non-select windows to advance.
1641 (insert-before-markers string
)
1642 ;; Fixup markers and overlays that got screwed up because we
1643 ;; used `insert-before-markers'.
1644 (let ((old-point (- (point) (length string
))))
1645 ;; comint-last-output-start
1646 (set-marker comint-last-output-start old-point
)
1647 ;; comint-last-input-end
1648 (when (and comint-last-input-end
1649 (equal (marker-position comint-last-input-end
)
1651 (set-marker comint-last-input-end old-point
))
1652 ;; No overlays we create are set to advance upon insertion
1653 ;; (at the start/end), so we assume that any overlay which
1654 ;; is at the current point was incorrectly advanced by
1655 ;; insert-before-markers. First fixup overlays that might
1657 (dolist (over (overlays-at (point)))
1658 (when (= (overlay-start over
) (point))
1659 (let ((end (overlay-end over
)))
1662 (if (= end
(point)) old-point end
)))))
1663 ;; Then do overlays that might end at point:
1664 (dolist (over (overlays-at (1- (point))))
1665 (when (= (overlay-end over
) (point))
1667 (min (overlay-start over
) old-point
)
1670 ;; Advance process-mark
1671 (set-marker (process-mark process
) (point))
1673 (unless comint-use-prompt-regexp-instead-of-fields
1674 ;; We check to see if the last overlay used for output is
1675 ;; adjacent to the new input, and if so, just extend it.
1676 (if (and comint-last-output-overlay
1677 (equal (overlay-end comint-last-output-overlay
)
1678 (marker-position comint-last-output-start
)))
1679 ;; Extend comint-last-output-overlay to include the
1680 ;; most recent output
1681 (move-overlay comint-last-output-overlay
1682 (overlay-start comint-last-output-overlay
)
1684 ;; Create a new overlay
1685 (let ((over (make-overlay comint-last-output-start
(point))))
1686 (overlay-put over
'field
'output
)
1687 (overlay-put over
'inhibit-line-move-field-capture t
)
1688 (overlay-put over
'evaporate t
)
1689 (setq comint-last-output-overlay over
))))
1691 (when comint-highlight-prompt
1692 ;; Highlight the prompt, where we define `prompt' to mean
1693 ;; the most recent output that doesn't end with a newline.
1694 (unless (and (bolp) (null comint-last-prompt-overlay
))
1695 ;; Need to create or move the prompt overlay (in the case
1696 ;; where there is no prompt ((bolp) == t), we still do
1697 ;; this if there's already an existing overlay).
1698 (let ((prompt-start (save-excursion (forward-line 0) (point))))
1699 (if comint-last-prompt-overlay
1700 ;; Just move an existing overlay
1701 (move-overlay comint-last-prompt-overlay
1702 prompt-start
(point))
1703 ;; Need to create the overlay
1704 (setq comint-last-prompt-overlay
1705 (make-overlay prompt-start
(point)))
1706 (overlay-put comint-last-prompt-overlay
1707 'face
'comint-highlight-prompt
)))))
1709 (goto-char saved-point
)
1711 (run-hook-with-args 'comint-output-filter-functions string
)))))))
1713 (defun comint-preinput-scroll-to-bottom ()
1714 "Go to the end of buffer in all windows showing it.
1715 Movement occurs if point in the selected window is not after the process mark,
1716 and `this-command' is an insertion command. Insertion commands recognised
1717 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1718 Depends on the value of `comint-scroll-to-bottom-on-input'.
1720 This function should be a pre-command hook."
1721 (if (and comint-scroll-to-bottom-on-input
1722 (memq this-command
'(self-insert-command comint-magic-space yank
1724 (let* ((selected (selected-window))
1725 (current (current-buffer))
1726 (process (get-buffer-process current
))
1727 (scroll comint-scroll-to-bottom-on-input
))
1728 (if (and process
(< (point) (process-mark process
)))
1729 (if (eq scroll
'this
)
1730 (goto-char (point-max))
1732 (function (lambda (window)
1733 (if (and (eq (window-buffer window
) current
)
1734 (or (eq scroll t
) (eq scroll
'all
)))
1736 (select-window window
)
1737 (goto-char (point-max))
1738 (select-window selected
)))))
1741 (defun comint-postoutput-scroll-to-bottom (string)
1742 "Go to the end of buffer in all windows showing it.
1743 Does not scroll if the current line is the last line in the buffer.
1744 Depends on the value of `comint-scroll-to-bottom-on-output' and
1745 `comint-scroll-show-maximum-output'.
1747 This function should be in the list `comint-output-filter-functions'."
1748 (let* ((selected (selected-window))
1749 (current (current-buffer))
1750 (process (get-buffer-process current
))
1751 (scroll comint-scroll-to-bottom-on-output
))
1755 (function (lambda (window)
1756 (if (eq (window-buffer window
) current
)
1758 (select-window window
)
1759 (if (and (< (point) (process-mark process
))
1760 (or (eq scroll t
) (eq scroll
'all
)
1761 ;; Maybe user wants point to jump to end.
1762 (and (eq scroll
'this
) (eq selected window
))
1763 (and (eq scroll
'others
) (not (eq selected window
)))
1764 ;; If point was at the end, keep it at end.
1765 (and (marker-position comint-last-output-start
)
1766 (>= (point) comint-last-output-start
))))
1767 (goto-char (process-mark process
)))
1768 ;; Optionally scroll so that the text
1769 ;; ends at the bottom of the window.
1770 (if (and comint-scroll-show-maximum-output
1771 (>= (point) (process-mark process
)))
1773 (goto-char (point-max))
1775 (select-window selected
)))))
1777 (set-buffer current
))))
1779 (defun comint-truncate-buffer (&optional string
)
1780 "Truncate the buffer to `comint-buffer-maximum-size'.
1781 This function could be on `comint-output-filter-functions' or bound to a key."
1784 (goto-char (process-mark (get-buffer-process (current-buffer))))
1785 (forward-line (- comint-buffer-maximum-size
))
1787 (delete-region (point-min) (point))))
1789 (defun comint-strip-ctrl-m (&optional string
)
1790 "Strip trailing `^M' characters from the current output group.
1791 This function could be on `comint-output-filter-functions' or bound to a key."
1793 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1797 (if (interactive-p) comint-last-input-end comint-last-output-start
))
1799 (while (re-search-forward "\r+$" pmark t
)
1800 (replace-match "" t t
)))))
1801 (defalias 'shell-strip-ctrl-m
'comint-strip-ctrl-m
)
1803 (defun comint-show-maximum-output ()
1804 "Put the end of the buffer at the bottom of the window."
1806 (goto-char (point-max))
1809 (defun comint-get-old-input-default ()
1810 "Default for `comint-get-old-input'.
1811 If `comint-use-prompt-regexp-instead-of-fields' is nil, then either
1812 return the current input field, if point is on an input field, or the
1813 current line, if point is on an output field.
1814 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then return
1815 the current line with any initial string matching the regexp
1816 `comint-prompt-regexp' removed."
1817 (let ((bof (field-beginning)))
1818 (if (eq (get-char-property bof
'field
) 'input
)
1821 (buffer-substring (point) (line-end-position)))))
1823 (defun comint-copy-old-input ()
1824 "Insert after prompt old input at point as new input to be edited.
1825 Calls `comint-get-old-input' to get old input."
1827 (let ((input (funcall comint-get-old-input
))
1828 (process (get-buffer-process (current-buffer))))
1830 (error "Current buffer has no process")
1831 (goto-char (process-mark process
))
1834 (defun comint-skip-prompt ()
1835 "Skip past the text matching regexp `comint-prompt-regexp'.
1836 If this takes us past the end of the current line, don't skip at all."
1837 (let ((eol (save-excursion (end-of-line) (point))))
1838 (if (and (looking-at comint-prompt-regexp
)
1839 (<= (match-end 0) eol
))
1840 (goto-char (match-end 0)))))
1842 (defun comint-after-pmark-p ()
1843 "Return t if point is after the process output marker."
1844 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1845 (<= (marker-position pmark
) (point))))
1847 (defun comint-simple-send (proc string
)
1848 "Default function for sending to PROC input STRING.
1849 This just sends STRING plus a newline. To override this,
1850 set the hook `comint-input-sender'."
1851 (comint-send-string proc string
)
1852 (if comint-input-sender-no-newline
1853 (if (not (string-equal string
""))
1855 (comint-send-string proc
"\n")))
1857 (defun comint-line-beginning-position ()
1858 "Returns the buffer position of the beginning of the line, after any prompt.
1859 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1860 prompt skip is done by skipping text matching the regular expression
1861 `comint-prompt-regexp', a buffer local variable."
1862 (if comint-use-prompt-regexp-instead-of-fields
1863 ;; Use comint-prompt-regexp
1866 (comint-skip-prompt)
1868 ;; Use input fields. Note that, unlike the behavior of
1869 ;; `line-beginning-position' inside a field, this function will
1870 ;; return the position of the end of a prompt, even if the point is
1871 ;; already inside the prompt. In order to do this, it assumes that
1872 ;; if there are two fields on a line, then the first one is the
1873 ;; prompt, and the second one is an input field, and is front-sticky
1874 ;; (as input fields should be).
1875 (constrain-to-field (line-beginning-position) (line-end-position))))
1877 (defun comint-bol (&optional arg
)
1878 "Goes to the beginning of line, then skips past the prompt, if any.
1879 If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
1880 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1881 prompt skip is done by skipping text matching the regular expression
1882 `comint-prompt-regexp', a buffer local variable."
1885 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1887 (goto-char (comint-line-beginning-position))))
1889 ;; These three functions are for entering text you don't want echoed or
1890 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1891 ;; Just enter m-x send-invisible and type in your line, or add
1892 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1894 (defun comint-read-noecho (prompt &optional stars
)
1895 "Read a single line of text from user without echoing, and return it.
1896 Prompt with argument PROMPT, a string. Optional argument STARS causes
1897 input to be echoed with '*' characters on the prompt line. Input ends with
1898 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1899 `inhibit-quit' is set because e.g. this function was called from a process
1900 filter and C-g is pressed, this function returns nil rather than a string).
1902 Note that the keystrokes comprising the text can still be recovered
1903 \(temporarily) with \\[view-lossage]. Some people find this worrysome.
1904 Once the caller uses the password, it can erase the password
1905 by doing (fillarray STRING 0)."
1910 (cursor-in-echo-area t
)
1911 (message-log-max nil
)
1915 (message "%s%s" prompt
(make-string (length ans
) ?
*))
1916 (message "%s" prompt
))
1917 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1918 (setq c
(read-char-exclusive))
1920 ;; This function may get called from a process filter, where
1921 ;; inhibit-quit is set. In later versions of emacs read-char
1922 ;; may clear quit-flag itself and return C-g. That would make
1923 ;; it impossible to quit this loop in a simple way, so
1924 ;; re-enable it here (for backward-compatibility the check for
1925 ;; quit-flag below would still be necessary, so this seems
1926 ;; like the simplest way to do things).
1929 ((or (= c ?
\r) (= c ?
\n) (= c ?\e
))
1934 ((and (/= c ?
\b) (/= c ?
\177))
1935 (setq newans
(concat ans
(char-to-string c
)))
1939 (aset ans
(1- (length ans
)) 0)
1940 (setq ans
(substring ans
0 -
1)))))
1942 ;; Emulate a true quit, except that we have to return a value.
1944 (setq quit-flag nil
)
1950 (defun send-invisible (str)
1951 "Read a string without echoing.
1952 Then send it to the process running in the current buffer.
1953 The string is sent using `comint-input-sender'.
1954 Security bug: your string can still be temporarily recovered with
1956 (interactive "P") ; Defeat snooping via C-x ESC ESC
1957 (let ((proc (get-buffer-process (current-buffer))))
1959 (error "Current buffer has no process"))
1961 (comint-snapshot-last-prompt)
1962 (funcall comint-input-sender proc str
))
1964 (let ((str (comint-read-noecho "Non-echoed text: " t
)))
1966 (send-invisible str
)
1967 (message "Warning: text will be echoed")))))))
1969 (defun comint-watch-for-password-prompt (string)
1970 "Prompt in the minibuffer for password and send without echoing.
1971 This function uses `send-invisible' to read and send a password to the buffer's
1972 process if STRING contains a password prompt defined by
1973 `comint-password-prompt-regexp'.
1975 This function could be in the list `comint-output-filter-functions'."
1976 (when (string-match comint-password-prompt-regexp string
)
1977 (let ((pw (comint-read-noecho string t
)))
1978 (send-invisible pw
))))
1980 ;; Low-level process communication
1982 (defun comint-send-string (process string
)
1983 "Like `process-send-string', but also does extra bookkeeping for comint mode."
1985 (with-current-buffer (if (processp process
)
1986 (process-buffer process
)
1987 (get-buffer process
))
1988 (comint-snapshot-last-prompt))
1989 (comint-snapshot-last-prompt))
1990 (process-send-string process string
))
1992 (defun comint-send-region (process start end
)
1993 "Like `process-send-region', 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-region process start end
))
2003 ;; Random input hackage
2005 (defun comint-delete-output ()
2006 "Delete all output from interpreter since last input.
2007 Does not delete the prompt."
2009 (let ((proc (get-buffer-process (current-buffer)))
2012 (let ((pmark (progn (goto-char (process-mark proc
))
2015 (delete-region comint-last-input-end pmark
)
2016 (goto-char (process-mark proc
))
2017 (setq replacement
(concat "*** output flushed ***\n"
2018 (buffer-substring pmark
(point))))
2019 (delete-region pmark
(point))))
2020 ;; Output message and put back prompt
2021 (comint-output-filter proc replacement
)))
2022 (defalias 'comint-kill-output
'comint-delete-output
)
2023 (make-obsolete 'comint-kill-output
'comint-delete-output
"21.1")
2025 (defun comint-write-output (filename &optional append mustbenew
)
2026 "Write output from interpreter since last input to FILENAME.
2027 Any prompt at the end of the output is not written.
2029 If the optional argument APPEND (the prefix argument when interactive)
2030 is non-nil, the output is appended to the file instead.
2032 If the optional argument MUSTBENEW is non-nil, check for an existing
2033 file with the same name. If MUSTBENEW is `excl', that means to get an
2034 error if the file already exists; never overwrite. If MUSTBENEW is
2035 neither nil nor `excl', that means ask for confirmation before
2036 overwriting, but do go ahead and overwrite the file if the user
2037 confirms. When interactive, MUSTBENEW is nil when appending, and t
2040 (list (read-file-name
2041 (if current-prefix-arg
2042 "Append output to file: "
2043 "Write output to file: "))
2045 (not current-prefix-arg
)))
2047 (goto-char (process-mark (get-buffer-process (current-buffer))))
2049 (write-region comint-last-input-end
(point) filename
2050 append nil nil mustbenew
)))
2052 ;; This function exists for the benefit of the menu; from the keyboard,
2053 ;; users can just use `comint-write-output' with a prefix arg.
2054 (defun comint-append-output-to-file (filename)
2055 "Append output from interpreter since last input to FILENAME.
2056 Any prompt at the end of the output is not written."
2057 (interactive "fAppend output to file: ")
2058 (comint-write-output filename t
))
2060 (defun comint-show-output ()
2061 "Display start of this batch of interpreter output at top of window.
2062 Sets mark to the value of point when this command is run."
2065 (let ((pos (or (marker-position comint-last-input-end
) (point-max))))
2066 (cond (comint-use-prompt-regexp-instead-of-fields
2068 (beginning-of-line 0)
2069 (set-window-start (selected-window) (point))
2070 (comint-skip-prompt))
2072 (goto-char (field-beginning pos
))
2073 (set-window-start (selected-window) (point))))))
2076 (defun comint-interrupt-subjob ()
2077 "Interrupt the current subjob.
2078 This command also kills the pending input
2079 between the process-mark and point."
2082 (interrupt-process nil comint-ptyp
))
2084 (defun comint-kill-subjob ()
2085 "Send kill signal to the current subjob.
2086 This command also kills the pending input
2087 between the process-mark and point."
2090 (kill-process nil comint-ptyp
))
2092 (defun comint-quit-subjob ()
2093 "Send quit signal to the current subjob.
2094 This command also kills the pending input
2095 between the process-mark and point."
2098 (quit-process nil comint-ptyp
))
2100 (defun comint-stop-subjob ()
2101 "Stop the current subjob.
2102 This command also kills the pending input
2103 between the process-mark and point.
2105 WARNING: if there is no current subjob, you can end up suspending
2106 the top-level process running in the buffer. If you accidentally do
2107 this, use \\[comint-continue-subjob] to resume the process. (This
2108 is not a problem with most shells, since they ignore this signal.)"
2111 (stop-process nil comint-ptyp
))
2113 (defun comint-continue-subjob ()
2114 "Send CONT signal to process buffer's process group.
2115 Useful if you accidentally suspend the top-level process."
2117 (continue-process nil comint-ptyp
))
2119 (defun comint-kill-input ()
2120 "Kill all text from last stuff output by interpreter to point."
2122 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2123 (if (> (point) (marker-position pmark
))
2124 (kill-region pmark
(point)))))
2126 (defun comint-delchar-or-maybe-eof (arg)
2127 "Delete ARG characters forward or send an EOF to subprocess.
2128 Sends an EOF only if point is at the end of the buffer and there is no input."
2130 (let ((proc (get-buffer-process (current-buffer))))
2131 (if (and (eobp) proc
(= (point) (marker-position (process-mark proc
))))
2133 (delete-char arg
))))
2135 (defun comint-send-eof ()
2136 "Send an EOF to the current buffer's process."
2138 (comint-send-input t
)
2142 (defun comint-backward-matching-input (regexp arg
)
2143 "Search backward through buffer for input fields that match REGEXP.
2144 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2145 fields are identified by lines that match `comint-prompt-regexp'.
2147 With prefix argument N, search for Nth previous match.
2148 If N is negative, find the next or Nth next match."
2149 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2150 (if comint-use-prompt-regexp-instead-of-fields
2151 ;; Use comint-prompt-regexp
2152 (let* ((re (concat comint-prompt-regexp
".*" regexp
))
2153 (pos (save-excursion (end-of-line (if (> arg
0) 0 1))
2154 (if (re-search-backward re nil t arg
)
2157 (progn (message "Not found")
2162 (let* ((dir (if (< arg
0) -
1 1))
2166 (unless (re-search-backward regexp nil t dir
)
2167 (error "Not found"))
2168 (when (eq (get-char-property (point) 'field
) 'input
)
2169 (setq arg
(- arg dir
))))
2170 (field-beginning))))
2174 (defun comint-forward-matching-input (regexp arg
)
2175 "Search forward through buffer for input fields that match REGEXP.
2176 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2177 fields are identified by lines that match `comint-prompt-regexp'.
2179 With prefix argument N, search for Nth following match.
2180 If N is negative, find the previous or Nth previous match."
2181 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2182 (comint-backward-matching-input regexp
(- arg
)))
2185 (defun comint-next-prompt (n)
2186 "Move to end of Nth next prompt in the buffer.
2187 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2188 the beginning of the Nth next `input' field, otherwise, it means the Nth
2189 occurance of text matching `comint-prompt-regexp'."
2191 (if comint-use-prompt-regexp-instead-of-fields
2192 ;; Use comint-prompt-regexp
2193 (let ((paragraph-start comint-prompt-regexp
))
2194 (end-of-line (if (> n
0) 1 0))
2195 (forward-paragraph n
)
2196 (comint-skip-prompt))
2205 (next-single-char-property-change pos
'field
)
2206 (previous-single-char-property-change pos
'field
)))
2207 (cond ((or (null pos
) (= pos prev-pos
))
2208 ;; Ran off the end of the buffer.
2210 ;; There's always an input field at the end of the
2211 ;; buffer, but it has a `field' property of nil.
2212 (setq input-pos
(point-max)))
2215 ((eq (get-char-property pos
'field
) 'input
)
2216 (setq n
(if (< n
0) (1+ n
) (1- n
)))
2217 (setq input-pos pos
))))
2219 (goto-char input-pos
)))))
2222 (defun comint-previous-prompt (n)
2223 "Move to end of Nth previous prompt in the buffer.
2224 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2225 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2226 occurance of text matching `comint-prompt-regexp'."
2228 (comint-next-prompt (- n
)))
2230 ;; State used by `comint-insert-previous-argument' when cycling.
2231 (defvar comint-insert-previous-argument-last-start-pos nil
)
2232 (make-variable-buffer-local 'comint-insert-previous-argument-last-start-pos
)
2233 (defvar comint-insert-previous-argument-last-index nil
)
2234 (make-variable-buffer-local 'comint-insert-previous-argument-last-index
)
2237 ;; make comint-arguments understand negative indices as bash does
2238 (defun comint-insert-previous-argument (index)
2239 "Insert the INDEXth argument from the previous comint command-line at point.
2240 Spaces are added at beginning and/or end of the inserted string if
2241 necessary to ensure that it's separated from adjacent arguments.
2242 Interactively, if no prefix argument is given, the last argument is inserted.
2243 Repeated interactive invocations will cycle through the same argument
2244 from progressively earlier commands (using the value of INDEX specified
2245 with the first command).
2246 This command is like `M-.' in bash."
2248 (unless (null index
)
2249 (setq index
(prefix-numeric-value index
)))
2250 (cond ((eq last-command this-command
)
2251 ;; Delete last input inserted by this command.
2252 (delete-region comint-insert-previous-argument-last-start-pos
(point))
2253 (setq index comint-insert-previous-argument-last-index
))
2255 ;; This is a non-repeat invocation, so initialize state.
2256 (setq comint-input-ring-index nil
)
2257 (setq comint-insert-previous-argument-last-index index
)
2258 (when (null comint-insert-previous-argument-last-start-pos
)
2259 ;; First usage; initialize to a marker
2260 (setq comint-insert-previous-argument-last-start-pos
2262 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2263 (if (<= (point) (comint-line-beginning-position))
2266 ;; Remember the beginning of what we insert, so we can delete it if
2267 ;; the command is repeated.
2268 (set-marker comint-insert-previous-argument-last-start-pos
(point))
2269 ;; Insert the argument.
2270 (let ((input-string (comint-previous-input-string 0)))
2271 (when (string-match "[ \t\n]*&" input-string
)
2272 ;; strip terminating '&'
2273 (setq input-string
(substring input-string
0 (match-beginning 0))))
2274 (insert (comint-arguments input-string index index
)))
2275 ;; Make next invocation return arg from previous input
2276 (setq comint-input-ring-index
(1+ (or comint-input-ring-index
0)))
2277 ;; Add a terminating space if necessary.
2282 ;; Support for source-file processing commands.
2283 ;;============================================================================
2284 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2285 ;; commands that process files of source text (e.g. loading or compiling
2286 ;; files). So the corresponding process-in-a-buffer modes have commands
2287 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2288 ;; for defining these commands.
2290 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2291 ;; and Soar, in that they don't know anything about file extensions.
2292 ;; So the compile/load interface gets the wrong default occasionally.
2293 ;; The load-file/compile-file default mechanism could be smarter -- it
2294 ;; doesn't know about the relationship between filename extensions and
2295 ;; whether the file is source or executable. If you compile foo.lisp
2296 ;; with compile-file, then the next load-file should use foo.bin for
2297 ;; the default, not foo.lisp. This is tricky to do right, particularly
2298 ;; because the extension for executable files varies so much (.o, .bin,
2299 ;; .lbin, .mo, .vo, .ao, ...).
2302 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2305 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2306 ;; want to save the buffer before issuing any process requests to the command
2309 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2310 ;; for the file to process.
2312 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2313 ;;============================================================================
2314 ;; This function computes the defaults for the load-file and compile-file
2315 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2317 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2318 ;; source-file processing command. nil if there hasn't been one yet.
2319 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2320 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2321 ;; Typically, (lisp-mode) or (scheme-mode).
2323 ;; If the command is given while the cursor is inside a string, *and*
2324 ;; the string is an existing filename, *and* the filename is not a directory,
2325 ;; then the string is taken as default. This allows you to just position
2326 ;; your cursor over a string that's a filename and have it taken as default.
2328 ;; If the command is given in a file buffer whose major mode is in
2329 ;; SOURCE-MODES, then the filename is the default file, and the
2330 ;; file's directory is the default directory.
2332 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2333 ;; then the default directory & file are what was used in the last source-file
2334 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2335 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2336 ;; is the cwd, with no default file. (\"no default file\" = nil)
2338 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2339 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2340 ;; for Soar programs, etc.
2342 ;; The function returns a pair: (default-directory . default-file).
2344 (defun comint-source-default (previous-dir/file source-modes
)
2345 (cond ((and buffer-file-name
(memq major-mode source-modes
))
2346 (cons (file-name-directory buffer-file-name
)
2347 (file-name-nondirectory buffer-file-name
)))
2350 (cons default-directory nil
))))
2353 ;; (COMINT-CHECK-SOURCE fname)
2354 ;;============================================================================
2355 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2356 ;; process-in-a-buffer modes), this function can be called on the filename.
2357 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2358 ;; is queried to see if he wants to save the buffer before proceeding with
2359 ;; the load or compile.
2361 (defun comint-check-source (fname)
2362 (let ((buff (get-file-buffer fname
)))
2364 (buffer-modified-p buff
)
2365 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff
))))
2367 (let ((old-buffer (current-buffer)))
2370 (set-buffer old-buffer
)))))
2373 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2374 ;;============================================================================
2375 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2376 ;; commands that process source files (like loading or compiling a file).
2377 ;; It prompts for the filename, provides a default, if there is one,
2378 ;; and returns the result filename.
2380 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
2382 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2383 ;; from the last source processing command. SOURCE-MODES is a list of major
2384 ;; modes used to determine what file buffers contain source files. (These
2385 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2386 ;; then the filename reader will only accept a file that exists.
2389 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2392 ;; This is pretty stupid about strings. It decides we're in a string
2393 ;; if there's a quote on both sides of point on the current line.
2394 (defun comint-extract-string ()
2395 "Return string around POINT that starts the current line, or nil."
2397 (let* ((point (point))
2398 (bol (progn (beginning-of-line) (point)))
2399 (eol (progn (end-of-line) (point)))
2400 (start (progn (goto-char point
)
2401 (and (search-backward "\"" bol t
)
2403 (end (progn (goto-char point
)
2404 (and (search-forward "\"" eol t
)
2407 (buffer-substring start end
)))))
2409 (defun comint-get-source (prompt prev-dir
/file source-modes mustmatch-p
)
2410 (let* ((def (comint-source-default prev-dir
/file source-modes
))
2411 (stringfile (comint-extract-string))
2412 (sfile-p (and stringfile
2414 (file-exists-p stringfile
)
2416 (not (file-directory-p stringfile
))))
2417 (defdir (if sfile-p
(file-name-directory stringfile
)
2419 (deffile (if sfile-p
(file-name-nondirectory stringfile
)
2421 (ans (read-file-name (if deffile
(format "%s(default %s) "
2425 (concat defdir deffile
)
2427 (list (expand-file-name (substitute-in-file-name ans
)))))
2429 ;; I am somewhat divided on this string-default feature. It seems
2430 ;; to violate the principle-of-least-astonishment, in that it makes
2431 ;; the default harder to predict, so you actually have to look and see
2432 ;; what the default really is before choosing it. This can trip you up.
2433 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2438 ;; Simple process query facility.
2439 ;; ===========================================================================
2440 ;; This function is for commands that want to send a query to the process
2441 ;; and show the response to the user. For example, a command to get the
2442 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2443 ;; to an inferior Common Lisp process.
2445 ;; This simple facility just sends strings to the inferior process and pops
2446 ;; up a window for the process buffer so you can see what the process
2447 ;; responds with. We don't do anything fancy like try to intercept what the
2448 ;; process responds with and put it in a pop-up window or on the message
2449 ;; line. We just display the buffer. Low tech. Simple. Works good.
2451 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2452 ;; a window for the inferior process so that its response can be seen.
2453 (defun comint-proc-query (proc str
)
2454 (let* ((proc-buf (process-buffer proc
))
2455 (proc-mark (process-mark proc
)))
2456 (display-buffer proc-buf
)
2457 (set-buffer proc-buf
) ; but it's not the selected *window*
2458 (let ((proc-win (get-buffer-window proc-buf
))
2459 (proc-pt (marker-position proc-mark
)))
2460 (comint-send-string proc str
) ; send the query
2461 (accept-process-output proc
) ; wait for some output
2462 ;; Try to position the proc window so you can see the answer.
2463 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2464 ;; I don't know why. Wizards invited to improve it.
2465 (unless (pos-visible-in-window-p proc-pt proc-win
)
2466 (let ((opoint (window-point proc-win
)))
2467 (set-window-point proc-win proc-mark
)
2469 (if (not (pos-visible-in-window-p opoint proc-win
))
2471 (set-window-point proc-win opoint
)))))))
2474 ;; Filename/command/history completion in a buffer
2475 ;; ===========================================================================
2476 ;; Useful completion functions, courtesy of the Ergo group.
2479 ;; comint-dynamic-complete Complete or expand command, filename,
2480 ;; history at point.
2481 ;; comint-dynamic-complete-filename Complete filename at point.
2482 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2483 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2484 ;; replace with expanded/completed name.
2485 ;; comint-dynamic-simple-complete Complete stub given candidates.
2487 ;; These are not installed in the comint-mode keymap. But they are
2488 ;; available for people who want them. Shell-mode installs them:
2489 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2490 ;; (define-key shell-mode-map "\M-?"
2491 ;; 'comint-dynamic-list-filename-completions)))
2493 ;; Commands like this are fine things to put in load hooks if you
2494 ;; want them present in specific modes.
2496 (defcustom comint-completion-autolist nil
2497 "*If non-nil, automatically list possibilities on partial completion.
2498 This mirrors the optional behavior of tcsh."
2500 :group
'comint-completion
)
2502 (defcustom comint-completion-addsuffix t
2503 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2504 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2505 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2506 This mirrors the optional behavior of tcsh."
2507 :type
'(choice (const :tag
"None" nil
)
2508 (const :tag
"Add /" t
)
2509 (cons :tag
"Suffix pair"
2510 (string :tag
"Directory suffix")
2511 (string :tag
"File suffix")))
2512 :group
'comint-completion
)
2514 (defcustom comint-completion-recexact nil
2515 "*If non-nil, use shortest completion if characters cannot be added.
2516 This mirrors the optional behavior of tcsh.
2518 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2520 :group
'comint-completion
)
2522 (defcustom comint-completion-fignore nil
2523 "*List of suffixes to be disregarded during file completion.
2524 This mirrors the optional behavior of bash and tcsh.
2526 Note that this applies to `comint-dynamic-complete-filename' only."
2527 :type
'(repeat (string :tag
"Suffix"))
2528 :group
'comint-completion
)
2530 (defvar comint-file-name-prefix
""
2531 "Prefix prepended to absolute file names taken from process input.
2532 This is used by comint's and shell's completion functions, and by shell's
2533 directory tracking functions.")
2535 (defvar comint-file-name-chars
2536 (if (memq system-type
'(ms-dos windows-nt
))
2537 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2538 "~/A-Za-z0-9+@:_.$#%,={}-")
2539 "String of characters valid in a file name.
2540 Note that all non-ASCII characters are considered valid in a file name
2541 regardless of what this variable says.
2543 This is a good thing to set in mode hooks.")
2545 (defvar comint-file-name-quote-list nil
2546 "List of characters to quote with `\\' when in a file name.
2548 This is a good thing to set in mode hooks.")
2551 (defun comint-directory (directory)
2552 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2553 (expand-file-name (if (file-name-absolute-p directory
)
2554 (concat comint-file-name-prefix directory
)
2558 (defun comint-word (word-chars)
2559 "Return the word of WORD-CHARS at point, or nil if non is found.
2560 Word constituents are considered to be those in WORD-CHARS, which is like the
2561 inside of a \"[...]\" (see `skip-chars-forward'),
2562 plus all non-ASCII characters."
2564 (let ((non-word-chars (concat "[^\\\\" word-chars
"]")) (here (point)))
2565 (while (and (re-search-backward non-word-chars nil
'move
)
2566 ;;(memq (char-after (point)) shell-file-name-quote-list)
2567 (or (>= (following-char) 128)
2568 (eq (preceding-char) ?
\\)))
2570 ;; Don't go forward over a word-char (this can happen if we're at bob).
2571 (when (or (not (bobp)) (looking-at non-word-chars
))
2573 ;; Set match-data to match the entire string.
2574 (when (< (point) here
)
2575 (set-match-data (list (point) here
))
2576 (match-string 0)))))
2578 (defun comint-substitute-in-file-name (filename)
2579 "Return FILENAME with environment variables substituted.
2580 Supports additional environment variable syntax of the command
2581 interpreter (e.g., the percent notation of cmd.exe on NT)."
2582 (let ((name (substitute-in-file-name filename
)))
2583 (if (memq system-type
'(ms-dos windows-nt
))
2587 (while (string-match "%\\([^\\\\/]*\\)%" name
)
2589 (substring name
(match-beginning 1) (match-end 1)))
2590 (setq env-var-val
(if (getenv env-var-name
)
2591 (getenv env-var-name
)
2593 (setq name
(replace-match env-var-val t t name
))))))
2596 (defun comint-match-partial-filename ()
2597 "Return the filename at point, or nil if non is found.
2598 Environment variables are substituted. See `comint-word'."
2599 (let ((filename (comint-word comint-file-name-chars
)))
2600 (and filename
(comint-substitute-in-file-name
2601 (comint-unquote-filename filename
)))))
2604 (defun comint-quote-filename (filename)
2605 "Return FILENAME with magic characters quoted.
2606 Magic characters are those in `comint-file-name-quote-list'."
2607 (if (null comint-file-name-quote-list
)
2610 (format "\\(^\\|[^\\]\\)\\([%s]\\)"
2611 (mapconcat 'char-to-string comint-file-name-quote-list
""))))
2613 (while (string-match regexp filename
)
2614 (setq filename
(replace-match "\\1\\\\\\2" nil nil filename
)))
2617 (defun comint-unquote-filename (filename)
2618 "Return FILENAME with quoted characters unquoted."
2619 (if (null comint-file-name-quote-list
)
2623 (while (string-match "\\\\\\(.\\)" filename i
)
2624 (setq filename
(replace-match "\\1" nil nil filename
))
2625 (setq i
(+ 1 (match-beginning 0)))))
2629 (defun comint-dynamic-complete ()
2630 "Dynamically perform completion at point.
2631 Calls the functions in `comint-dynamic-complete-functions' to perform
2632 completion until a function returns non-nil, at which point completion is
2633 assumed to have occurred."
2635 (run-hook-with-args-until-success 'comint-dynamic-complete-functions
))
2638 (defun comint-dynamic-complete-filename ()
2639 "Dynamically complete the filename at point.
2640 Completes if after a filename. See `comint-match-partial-filename' and
2641 `comint-dynamic-complete-as-filename'.
2642 This function is similar to `comint-replace-by-expanded-filename', except that
2643 it won't change parts of the filename already entered in the buffer; it just
2644 adds completion characters to the end of the filename. A completions listing
2645 may be shown in a help buffer if completion is ambiguous.
2647 Completion is dependent on the value of `comint-completion-addsuffix',
2648 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2649 completions listing is dependent on the value of `comint-completion-autolist'.
2651 Returns t if successful."
2653 (when (comint-match-partial-filename)
2654 (unless (window-minibuffer-p (selected-window))
2655 (message "Completing file name..."))
2656 (comint-dynamic-complete-as-filename)))
2658 (defun comint-dynamic-complete-as-filename ()
2659 "Dynamically complete at point as a filename.
2660 See `comint-dynamic-complete-filename'. Returns t if successful."
2661 (let* ((completion-ignore-case (memq system-type
'(ms-dos windows-nt
)))
2662 (completion-ignored-extensions comint-completion-fignore
)
2663 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2664 ;; I think it was originally bound to solve file completion problems,
2665 ;; but subsequent changes may have made this unnecessary. sm.
2666 ;;(file-name-handler-alist nil)
2667 (minibuffer-p (window-minibuffer-p (selected-window)))
2669 (dirsuffix (cond ((not comint-completion-addsuffix
)
2671 ((not (consp comint-completion-addsuffix
))
2672 (char-to-string directory-sep-char
))
2674 (car comint-completion-addsuffix
))))
2675 (filesuffix (cond ((not comint-completion-addsuffix
)
2677 ((not (consp comint-completion-addsuffix
))
2680 (cdr comint-completion-addsuffix
))))
2681 (filename (or (comint-match-partial-filename) ""))
2682 (pathdir (file-name-directory filename
))
2683 (pathnondir (file-name-nondirectory filename
))
2684 (directory (if pathdir
(comint-directory pathdir
) default-directory
))
2685 (completion (file-name-completion pathnondir directory
)))
2686 (cond ((null completion
)
2687 (message "No completions of %s" filename
)
2689 ((eq completion t
) ; Means already completed "file".
2691 (unless minibuffer-p
2692 (message "Sole completion")))
2693 ((string-equal completion
"") ; Means completion on "directory/".
2694 (comint-dynamic-list-filename-completions))
2695 (t ; Completion string returned.
2696 (let ((file (concat (file-name-as-directory directory
) completion
)))
2697 (insert (comint-quote-filename
2698 (substring (directory-file-name completion
)
2699 (length pathnondir
))))
2700 (cond ((symbolp (file-name-completion completion directory
))
2701 ;; We inserted a unique completion.
2702 (insert (if (file-directory-p file
) dirsuffix filesuffix
))
2703 (unless minibuffer-p
2704 (message "Completed")))
2705 ((and comint-completion-recexact comint-completion-addsuffix
2706 (string-equal pathnondir completion
)
2707 (file-exists-p file
))
2708 ;; It's not unique, but user wants shortest match.
2709 (insert (if (file-directory-p file
) dirsuffix filesuffix
))
2710 (unless minibuffer-p
2711 (message "Completed shortest")))
2712 ((or comint-completion-autolist
2713 (string-equal pathnondir completion
))
2714 ;; It's not unique, list possible completions.
2715 (comint-dynamic-list-filename-completions))
2717 (unless minibuffer-p
2718 (message "Partially completed")))))))
2722 (defun comint-replace-by-expanded-filename ()
2723 "Dynamically expand and complete the filename at point.
2724 Replace the filename with an expanded, canonicalised and completed replacement.
2725 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
2726 with the corresponding directories. \"Canonicalised\" means `..' and `.' are
2727 removed, and the filename is made absolute instead of relative. For expansion
2728 see `expand-file-name' and `substitute-in-file-name'. For completion see
2729 `comint-dynamic-complete-filename'."
2731 (replace-match (expand-file-name (comint-match-partial-filename)) t t
)
2732 (comint-dynamic-complete-filename))
2735 (defun comint-dynamic-simple-complete (stub candidates
)
2736 "Dynamically complete STUB from CANDIDATES list.
2737 This function inserts completion characters at point by completing STUB from
2738 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2739 if completion is ambiguous.
2741 Returns nil if no completion was inserted.
2742 Returns `sole' if completed with the only completion match.
2743 Returns `shortest' if completed with the shortest of the completion matches.
2744 Returns `partial' if completed as far as possible with the completion matches.
2745 Returns `listed' if a completion listing was shown.
2747 See also `comint-dynamic-complete-filename'."
2748 (let* ((completion-ignore-case (memq system-type
'(ms-dos windows-nt
)))
2749 (suffix (cond ((not comint-completion-addsuffix
) "")
2750 ((not (consp comint-completion-addsuffix
)) " ")
2751 (t (cdr comint-completion-addsuffix
))))
2752 (candidates (mapcar (function (lambda (x) (list x
))) candidates
))
2753 (completions (all-completions stub candidates
)))
2754 (cond ((null completions
)
2755 (message "No completions of %s" stub
)
2757 ((= 1 (length completions
)) ; Gotcha!
2758 (let ((completion (car completions
)))
2759 (if (string-equal completion stub
)
2760 (message "Sole completion")
2761 (insert (substring completion
(length stub
)))
2762 (message "Completed"))
2765 (t ; There's no unique completion.
2766 (let ((completion (try-completion stub candidates
)))
2767 ;; Insert the longest substring.
2768 (insert (substring completion
(length stub
)))
2769 (cond ((and comint-completion-recexact comint-completion-addsuffix
2770 (string-equal stub completion
)
2771 (member completion completions
))
2772 ;; It's not unique, but user wants shortest match.
2774 (message "Completed shortest")
2776 ((or comint-completion-autolist
2777 (string-equal stub completion
))
2778 ;; It's not unique, list possible completions.
2779 (comint-dynamic-list-completions completions
)
2782 (message "Partially completed")
2786 (defun comint-dynamic-list-filename-completions ()
2787 "List in help buffer possible completions of the filename at point."
2789 (let* ((completion-ignore-case (memq system-type
'(ms-dos windows-nt
)))
2790 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2791 ;; I think it was originally bound to solve file completion problems,
2792 ;; but subsequent changes may have made this unnecessary. sm.
2793 ;;(file-name-handler-alist nil)
2794 (filename (or (comint-match-partial-filename) ""))
2795 (pathdir (file-name-directory filename
))
2796 (pathnondir (file-name-nondirectory filename
))
2797 (directory (if pathdir
(comint-directory pathdir
) default-directory
))
2798 (completions (file-name-all-completions pathnondir directory
)))
2799 (if (not completions
)
2800 (message "No completions of %s" filename
)
2801 (comint-dynamic-list-completions
2802 (mapcar 'comint-quote-filename completions
)))))
2805 (defun comint-dynamic-list-completions (completions)
2806 "List in help buffer sorted COMPLETIONS.
2807 Typing SPC flushes the help buffer."
2808 (let ((window (get-buffer-window "*Completions*")))
2809 (if (and (eq last-command this-command
)
2810 window
(window-live-p window
) (window-buffer window
)
2811 (buffer-name (window-buffer window
)))
2812 ;; If this command was repeated, and
2813 ;; there's a fresh completion window with a live buffer,
2814 ;; and this command is repeated, scroll that window.
2815 (with-current-buffer (window-buffer window
)
2816 (if (pos-visible-in-window-p (point-max) window
)
2817 (set-window-start window
(point-min))
2818 (save-selected-window
2819 (select-window window
)
2822 (let ((conf (current-window-configuration)))
2823 (with-output-to-temp-buffer "*Completions*"
2824 (display-completion-list (sort completions
'string-lessp
)))
2825 (message "Type space to flush; repeat completion command to scroll")
2828 (set-buffer (get-buffer "*Completions*"))
2829 (setq key
(read-key-sequence nil
)
2831 (and (consp first
) (consp (event-start first
))
2832 (eq (window-buffer (posn-window (event-start first
)))
2833 (get-buffer "*Completions*"))
2834 (eq (key-binding key
) 'mouse-choose-completion
)))
2835 ;; If the user does mouse-choose-completion with the mouse,
2836 ;; execute the command, then delete the completion window.
2838 (mouse-choose-completion first
)
2839 (set-window-configuration conf
))
2841 (set-window-configuration conf
)
2842 (setq unread-command-events
(listify-key-sequence key
)))))))))
2845 (defun comint-get-next-from-history ()
2846 "After fetching a line from input history, this fetches the following line.
2847 In other words, this recalls the input line after the line you recalled last.
2848 You can use this to repeat a sequence of input lines."
2850 (if comint-save-input-ring-index
2852 (setq comint-input-ring-index
(1+ comint-save-input-ring-index
))
2853 (comint-next-input 1))
2854 (message "No previous history command")))
2856 (defun comint-accumulate ()
2857 "Accumulate a line to send as input along with more lines.
2858 This inserts a newline so that you can enter more text
2859 to be sent along with this line. Use \\[comint-send-input]
2860 to send all the accumulated input, at once.
2861 The entire accumulated text becomes one item in the input history
2865 (set-marker comint-accum-marker
(point))
2866 (if comint-input-ring-index
2867 (setq comint-save-input-ring-index
2868 (- comint-input-ring-index
1))))
2870 (defun comint-goto-process-mark ()
2871 "Move point to the process mark.
2872 The process mark separates output, and input already sent,
2873 from input that has not yet been sent."
2875 (let ((proc (or (get-buffer-process (current-buffer))
2876 (error "Current buffer has no process"))))
2877 (goto-char (process-mark proc
))
2878 (when (interactive-p)
2879 (message "Point is now at the process mark"))))
2881 (defun comint-bol-or-process-mark ()
2882 "Move point to beginning of line (after prompt) or to the process mark.
2883 The first time you use this command, it moves to the beginning of the line
2884 \(but after the prompt, if any). If you repeat it again immediately,
2885 it moves point to the process mark.
2887 The process mark separates the process output, along with input already sent,
2888 from input that has not yet been sent. Ordinarily, the process mark
2889 is at the beginning of the current input line; but if you have
2890 used \\[comint-accumulate] to send multiple lines at once,
2891 the process mark is at the beginning of the accumulated input."
2893 (if (not (eq last-command
'comint-bol-or-process-mark
))
2895 (comint-goto-process-mark)))
2897 (defun comint-set-process-mark ()
2898 "Set the process mark at point."
2900 (let ((proc (or (get-buffer-process (current-buffer))
2901 (error "Current buffer has no process"))))
2902 (set-marker (process-mark proc
) (point))
2903 (message "Process mark set")))
2906 ;; Author: Peter Breton <pbreton@ne.mediaone.net>
2908 ;; This little add-on for comint is intended to make it easy to get
2909 ;; output from currently active comint buffers into another buffer,
2910 ;; or buffers, and then go back to using the comint shell.
2912 ;; My particular use is SQL interpreters; I want to be able to execute a
2913 ;; query using the process associated with a comint-buffer, and save that
2914 ;; somewhere else. Because the process might have state (for example, it
2915 ;; could be in an uncommitted transaction), just running starting a new
2916 ;; process and having it execute the query and then finish, would not
2917 ;; work. I'm sure there are other uses as well, although in many cases
2918 ;; starting a new process is the simpler, and thus preferable, approach.
2920 ;; The basic implementation is as follows: comint-redirect changes the
2921 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2922 ;; its own filter. The filter puts the output into the designated buffer,
2923 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2924 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2925 ;; sees the stop regexp, it restores the old filter functions, and runs
2926 ;; comint-redirect-hook.
2928 ;; Each comint buffer may only use one redirection at a time, but any number
2929 ;; of different comint buffers may be simultaneously redirected.
2931 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2932 ;; correct prompt for your interpreter, or that you supply a regexp that says
2933 ;; when the redirection is finished. Otherwise, redirection will continue
2934 ;; indefinitely. The code now does a sanity check to ensure that it can find
2935 ;; a prompt in the comint buffer; however, it is still important to ensure that
2936 ;; this prompt is set correctly.
2938 ;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2939 ;; perhaps it should prompt for a terminating string (with an
2940 ;; appropriate magic default by examining what we think is the prompt)?
2943 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2945 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2947 (defcustom comint-redirect-verbose nil
2948 "*If non-nil, print messages each time the redirection filter is invoked.
2949 Also print a message when redirection is completed."
2953 ;; Directly analagous to comint-preoutput-filter-functions
2954 (defvar comint-redirect-filter-functions nil
2955 "List of functions to call before inserting redirected process output.
2956 Each function gets one argument, a string containing the text received
2957 from the subprocess. It should return the string to insert, perhaps
2958 the same string that was received, or perhaps a modified or transformed
2961 The functions on the list are called sequentially, and each one is given
2962 the string returned by the previous one. The string returned by the
2963 last function is the text that is actually inserted in the redirection buffer.")
2965 (make-variable-buffer-local 'comint-redirect-filter-functions
)
2967 ;; Internal variables
2969 (defvar comint-redirect-output-buffer nil
2970 "The buffer or list of buffers to put output into.")
2972 (defvar comint-redirect-finished-regexp nil
2973 "Regular expression that determines when to stop redirection in Comint.
2974 When the redirection filter function is given output that matches this regexp,
2975 the output is inserted as usual, and redirection is completed.")
2977 (defvar comint-redirect-insert-matching-regexp nil
2978 "If non-nil, the text that ends a redirection is included in it.
2979 More precisely, the text that matches `comint-redirect-finished-regexp'
2980 and therefore terminates an output redirection is inserted in the
2981 redirection target buffer, along with the preceding output.")
2983 (defvar comint-redirect-echo-input nil
2984 "Non-nil means echo input in the process buffer even during redirection.")
2986 (defvar comint-redirect-completed nil
2987 "Non-nil if redirection has completed in the current buffer.")
2989 (defvar comint-redirect-original-mode-line-process nil
2990 "Original mode line for redirected process.")
2992 (defvar comint-redirect-perform-sanity-check t
2993 "If non-nil, check that redirection is likely to complete successfully.
2994 More precisely, before starting a redirection, verify that the
2995 regular expression `comint-redirect-finished-regexp' that controls
2996 when to terminate it actually matches some text already in the process
2997 buffer. The idea is that this regular expression should match a prompt
2998 string, and that there ought to be at least one copy of your prompt string
2999 in the process buffer already.")
3001 (defvar comint-redirect-original-filter-function nil
3002 "The process filter that was in place when redirection is started.
3003 When redirection is completed, the process filter is restored to
3006 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3008 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3010 (defun comint-redirect-setup (output-buffer
3013 &optional echo-input
)
3014 "Set up for output redirection.
3015 This function sets local variables that are used by `comint-redirect-filter'
3016 to perform redirection.
3018 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3019 in the output matches FINISHED-REGEXP.
3021 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3022 original comint buffer.
3024 This function is called by `comint-redirect-send-command-to-process',
3025 and does not normally need to be invoked by the end user or programmer."
3026 (with-current-buffer comint-buffer
3028 (make-local-variable 'comint-redirect-original-mode-line-process
)
3029 (setq comint-redirect-original-mode-line-process mode-line-process
)
3031 (make-local-variable 'comint-redirect-output-buffer
)
3032 (setq comint-redirect-output-buffer output-buffer
)
3034 (make-local-variable 'comint-redirect-finished-regexp
)
3035 (setq comint-redirect-finished-regexp finished-regexp
)
3037 (make-local-variable 'comint-redirect-echo-input
)
3038 (setq comint-redirect-echo-input echo-input
)
3040 (make-local-variable 'comint-redirect-completed
)
3041 (setq comint-redirect-completed nil
)
3043 (setq mode-line-process
3044 (if mode-line-process
3045 (list (concat (elt mode-line-process
0) " Redirection"))
3046 (list ":%s Redirection")))))
3048 (defun comint-redirect-cleanup ()
3049 "End a Comint redirection. See `comint-redirect-send-command'."
3051 ;; Restore the process filter
3052 (set-process-filter (get-buffer-process (current-buffer))
3053 comint-redirect-original-filter-function
)
3054 ;; Restore the mode line
3055 (setq mode-line-process comint-redirect-original-mode-line-process
)
3056 ;; Set the completed flag
3057 (setq comint-redirect-completed t
))
3059 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3060 ;; that it really occurs.
3061 (defalias 'comint-redirect-remove-redirection
'comint-redirect-cleanup
)
3063 (defun comint-redirect-filter (process input-string
)
3064 "Filter function which redirects output from PROCESS to a buffer or buffers.
3065 The variable `comint-redirect-output-buffer' says which buffer(s) to
3068 INPUT-STRING is the input from the comint process.
3070 This function runs as a process filter, and does not need to be invoked by the
3073 (with-current-buffer (process-buffer process
)
3074 (comint-redirect-preoutput-filter input-string
)
3075 ;; If we have to echo output, give it to the original filter function
3076 (and comint-redirect-echo-input
3077 comint-redirect-original-filter-function
3078 (funcall comint-redirect-original-filter-function
3079 process input-string
)))))
3082 (defun comint-redirect-preoutput-filter (input-string)
3083 "Comint filter function which redirects comint output to a buffer or buffers.
3084 The variable `comint-redirect-output-buffer' says which buffer(s) to
3087 INPUT-STRING is the input from the comint process.
3089 This function does not need to be invoked by the end user."
3090 (let ((output-buffer-list
3091 (if (listp comint-redirect-output-buffer
)
3092 comint-redirect-output-buffer
3093 (list comint-redirect-output-buffer
)))
3094 (filtered-input-string input-string
))
3096 ;; If there are any filter functions, give them a chance to modify the string
3097 (let ((functions comint-redirect-filter-functions
))
3098 (while (and functions filtered-input-string
)
3099 (setq filtered-input-string
3100 (funcall (car functions
) filtered-input-string
))
3101 (setq functions
(cdr functions
))))
3103 ;; Clobber `comint-redirect-finished-regexp'
3104 (or comint-redirect-insert-matching-regexp
3105 (and (string-match comint-redirect-finished-regexp filtered-input-string
)
3106 (setq filtered-input-string
3107 (replace-match "" nil nil filtered-input-string
))))
3109 ;; Send output to all registered buffers
3112 (function (lambda(buf)
3113 ;; Set this buffer to the output buffer
3114 (set-buffer (get-buffer-create buf
))
3115 ;; Go to the end of the buffer
3116 (goto-char (point-max))
3117 ;; Insert the output
3118 (insert filtered-input-string
)))
3119 output-buffer-list
))
3122 (and comint-redirect-verbose
3123 (message "Redirected output to buffer(s) %s"
3124 (mapconcat 'identity output-buffer-list
" ")))
3126 ;; If we see the prompt, tidy up
3127 ;; We'll look for the prompt in the original string, so nobody can
3129 (and (string-match comint-redirect-finished-regexp input-string
)
3131 (and comint-redirect-verbose
3132 (message "Redirection completed"))
3133 (comint-redirect-cleanup)
3134 (run-hooks 'comint-redirect-hook
)))
3136 (if comint-redirect-echo-input
3137 filtered-input-string
3141 (defun comint-redirect-send-command (command output-buffer echo
&optional no-display
)
3142 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3143 With prefix arg, echo output in process buffer.
3145 If NO-DISPLAY is non-nil, do not show the output buffer."
3146 (interactive "sCommand: \nBOutput Buffer: \nP")
3147 (let ((process (get-buffer-process (current-buffer))))
3149 (comint-redirect-send-command-to-process
3150 command output-buffer
(current-buffer) echo no-display
)
3151 (error "No process for current buffer"))))
3154 (defun comint-redirect-send-command-to-process
3155 (command output-buffer process echo
&optional no-display
)
3156 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3157 With prefix arg, echo output in process buffer.
3159 If NO-DISPLAY is non-nil, do not show the output buffer."
3160 (interactive "sCommand: \nBOutput Buffer: \nbProcess Buffer: \nP")
3161 (let* (;; The process buffer
3162 (process-buffer (if (processp process
)
3163 (process-buffer process
)
3165 (proc (get-buffer-process process-buffer
)))
3166 ;; Change to the process buffer
3167 (set-buffer process-buffer
)
3169 ;; Make sure there's a prompt in the current process buffer
3170 (and comint-redirect-perform-sanity-check
3172 (goto-char (point-max))
3173 (or (re-search-backward comint-prompt-regexp nil t
)
3174 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3176 ;;;;;;;;;;;;;;;;;;;;;
3177 ;; Set up for redirection
3178 ;;;;;;;;;;;;;;;;;;;;;
3179 (comint-redirect-setup
3185 comint-prompt-regexp
3189 ;;;;;;;;;;;;;;;;;;;;;
3191 ;;;;;;;;;;;;;;;;;;;;;
3192 ;; Save the old filter
3193 (setq comint-redirect-original-filter-function
3194 (process-filter proc
))
3195 (set-process-filter proc
'comint-redirect-filter
)
3197 ;;;;;;;;;;;;;;;;;;;;;
3199 ;;;;;;;;;;;;;;;;;;;;;
3200 (process-send-string
3202 (concat command
"\n"))
3204 ;;;;;;;;;;;;;;;;;;;;;
3206 ;;;;;;;;;;;;;;;;;;;;;
3210 (if (listp output-buffer
)
3215 (defun comint-redirect-results-list (command regexp regexp-group
)
3216 "Send COMMAND to current process.
3217 Return a list of expressions in the output which match REGEXP.
3218 REGEXP-GROUP is the regular expression group in REGEXP to use."
3219 (comint-redirect-results-list-from-process
3220 (get-buffer-process (current-buffer))
3221 command regexp regexp-group
))
3224 (defun comint-redirect-results-list-from-process (process command regexp regexp-group
)
3225 "Send COMMAND to PROCESS.
3226 Return a list of expressions in the output which match REGEXP.
3227 REGEXP-GROUP is the regular expression group in REGEXP to use."
3228 (let ((output-buffer " *Comint Redirect Work Buffer*")
3231 (set-buffer (get-buffer-create output-buffer
))
3233 (comint-redirect-send-command-to-process command
3234 output-buffer process nil t
)
3235 ;; Wait for the process to complete
3236 (set-buffer (process-buffer process
))
3237 (while (null comint-redirect-completed
)
3238 (accept-process-output nil
1))
3239 ;; Collect the output
3240 (set-buffer output-buffer
)
3241 (goto-char (point-min))
3242 ;; Skip past the command, if it was echoed
3243 (and (looking-at command
)
3245 (while (re-search-forward regexp nil t
)
3247 (cons (buffer-substring-no-properties
3248 (match-beginning regexp-group
)
3249 (match-end regexp-group
))
3254 (add-to-list 'debug-ignored-errors x
))
3255 '("^Not at command line$"
3256 "^Empty input ring$"
3258 "^Not found$" ; Too common?
3259 "^Current buffer has no process$"))
3262 ;; Converting process modes to use comint mode
3263 ;; ===========================================================================
3264 ;; The code in the Emacs 19 distribution has all been modified to use comint
3265 ;; where needed. However, there are `third-party' packages out there that
3266 ;; still use the old shell mode. Here's a guide to conversion.
3268 ;; Renaming variables
3269 ;; Most of the work is renaming variables and functions. These are the common
3272 ;; last-input-start comint-last-input-start
3273 ;; last-input-end comint-last-input-end
3274 ;; shell-prompt-pattern comint-prompt-regexp
3275 ;; shell-set-directory-error-hook <no equivalent>
3277 ;; shell-set-directory <unnecessary>
3278 ;; shell-mode-map comint-mode-map
3280 ;; shell-send-input comint-send-input
3281 ;; shell-send-eof comint-delchar-or-maybe-eof
3282 ;; kill-shell-input comint-kill-input
3283 ;; interrupt-shell-subjob comint-interrupt-subjob
3284 ;; stop-shell-subjob comint-stop-subjob
3285 ;; quit-shell-subjob comint-quit-subjob
3286 ;; kill-shell-subjob comint-kill-subjob
3287 ;; kill-output-from-shell comint-delete-output
3288 ;; show-output-from-shell comint-show-output
3289 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3291 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3292 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3293 ;; Comint mode does not provide functionality equivalent to
3294 ;; shell-set-directory-error-hook; it is gone.
3296 ;; comint-last-input-start is provided for modes which want to munge
3297 ;; the buffer after input is sent, perhaps because the inferior
3298 ;; insists on echoing the input. The LAST-INPUT-START variable in
3299 ;; the old shell package was used to implement a history mechanism,
3300 ;; but you should think twice before using comint-last-input-start
3301 ;; for this; the input history ring often does the job better.
3303 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3304 ;; *not* create the comint-mode local variables in your foo-mode function.
3305 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3306 ;; necessary comint-specific local variables. Then create the
3307 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3308 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3309 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3310 ;; get-old-input) that need to be different from the defaults. Call
3311 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3312 ;; comint-mode will take care of it. The following example, from shell.el,
3315 ;; (defvar shell-mode-map '())
3316 ;; (cond ((not shell-mode-map)
3317 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3318 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3319 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3320 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3321 ;; (define-key shell-mode-map "\M-?"
3322 ;; 'comint-dynamic-list-filename-completions)))
3324 ;; (defun shell-mode ()
3327 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3328 ;; (setq major-mode 'shell-mode)
3329 ;; (setq mode-name "Shell")
3330 ;; (use-local-map shell-mode-map)
3331 ;; (make-local-variable 'shell-directory-stack)
3332 ;; (setq shell-directory-stack nil)
3333 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3334 ;; (run-hooks 'shell-mode-hook))
3337 ;; Completion for comint-mode users
3339 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3340 ;; hook to add completion functions to. Functions on this list should return
3341 ;; non-nil if completion occurs (i.e., further completion should not occur).
3342 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3348 ;;; comint.el ends here
HCoop / bpt / emacs.git / blob