1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988,90,92,93,94,95,96,97,98,99,2000,01,02,2003
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
144 ;; Comint mode non-buffer local variables:
145 ;; comint-completion-addsuffix boolean/cons For file name
146 ;; comint-completion-autolist boolean completion behavior
147 ;; comint-completion-recexact boolean ...
150 "General command interpreter in a window stuff."
153 (defgroup comint-completion nil
154 "Completion facilities in comint"
157 (defgroup comint-source nil
158 "Source finding facilities in comint"
162 (defvar comint-prompt-regexp
"^"
163 "Regexp to recognise prompts in the inferior process.
164 Defaults to \"^\", the null string at BOL.
166 This variable is only used if the variable
167 `comint-use-prompt-regexp-instead-of-fields' is non-nil.
170 Canonical Lisp: \"^[^> \\n]*>+:? *\" (Lucid, franz, kcl, T, cscheme, oaklisp)
171 Lucid Common Lisp: \"^\\\\(>\\\\|\\\\(->\\\\)+\\\\) *\"
172 franz: \"^\\\\(->\\\\|<[0-9]*>:\\\\) *\"
174 shell: \"^[^#$%>\\n]*[#$%>] *\"
177 This is a good thing to set in mode hooks.")
179 (defvar comint-delimiter-argument-list
()
180 "List of characters to recognise as separate arguments in input.
181 Strings comprising a character in this list will separate the arguments
182 surrounding them, and also be regarded as arguments in their own right (unlike
183 whitespace). See `comint-arguments'.
184 Defaults to the empty list.
186 For shells, a good value is (?\\| ?& ?< ?> ?\\( ?\\) ?;).
188 This is a good thing to set in mode hooks.")
190 (defcustom comint-input-autoexpand nil
191 "*If non-nil, expand input command history references on completion.
192 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
194 If the value is `input', then the expansion is seen on input.
195 If the value is `history', then the expansion is only when inserting
196 into the buffer's input ring. See also `comint-magic-space' and
197 `comint-dynamic-complete'.
199 This variable is buffer-local."
200 :type
'(choice (const :tag
"off" nil
)
206 (defface comint-highlight-input
'((t (:weight bold
)))
207 "Face to use to highlight user input."
210 (defface comint-highlight-prompt
211 '((((background dark
)) (:foreground
"cyan"))
212 (t (:foreground
"dark blue")))
213 "Face to use to highlight prompts."
216 (defcustom comint-input-ignoredups nil
217 "*If non-nil, don't add input matching the last on the input ring.
218 This mirrors the optional behavior of bash.
220 This variable is buffer-local."
224 (defcustom comint-input-ring-file-name nil
225 "*If non-nil, name of the file to read/write input history.
226 See also `comint-read-input-ring' and `comint-write-input-ring'.
228 This variable is buffer-local, and is a good thing to set in mode hooks."
229 :type
'(choice (const :tag
"nil" nil
)
233 (defcustom comint-scroll-to-bottom-on-input nil
234 "*Controls whether input to interpreter causes window to scroll.
235 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
236 If `this', scroll only the selected window.
240 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
241 :type
'(choice (const :tag
"off" nil
)
247 (defcustom comint-scroll-to-bottom-on-output nil
248 "*Controls whether interpreter output causes window to scroll.
249 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
250 If `this', scroll only the selected window.
251 If `others', scroll only those that are not the selected window.
255 See variable `comint-scroll-show-maximum-output' and function
256 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
257 :type
'(choice (const :tag
"off" nil
)
264 (defcustom comint-scroll-show-maximum-output t
265 "*Controls how interpreter output causes window to scroll.
266 If non-nil, then show the maximum output when the window is scrolled.
268 See variable `comint-scroll-to-bottom-on-output' and function
269 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
273 (defcustom comint-buffer-maximum-size
1024
274 "*The maximum size in lines for comint buffers.
275 Comint buffers are truncated from the top to be no greater than this number, if
276 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
280 (defvar comint-input-ring-size
32
281 "Size of input history ring.")
283 (defvar comint-input-ring-separator
"\n"
284 "Separator between commands in the history file.")
286 (defvar comint-input-history-ignore
"^#"
287 "Regexp for history entries that should be ignored when comint initializes.")
289 (defcustom comint-process-echoes nil
290 "*If non-nil, assume that the subprocess echoes any input.
291 If so, delete one copy of the input so that only one copy eventually
292 appears in the buffer.
294 This variable is buffer-local."
298 ;; AIX puts the name of the person being su'd to in front of the prompt.
299 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
300 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
301 ;; ssh-add prints a prompt like `Enter passphrase: '.
302 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
303 (defcustom comint-password-prompt-regexp
304 "\\(\\([Oo]ld \\|[Nn]ew \\|'s \\|login \\|\
305 Kerberos \\|CVS \\|UNIX \\| SMB \\|^\\)\
306 [Pp]assword\\( (again)\\)?\\|\
307 pass phrase\\|\\(Enter\\|Repeat\\) passphrase\\)\
308 \\( for [^:]+\\)?:\\s *\\'"
309 "*Regexp matching prompts for passwords in the inferior process.
310 This is used by `comint-watch-for-password-prompt'."
314 ;; Here are the per-interpreter hooks.
315 (defvar comint-get-old-input
(function comint-get-old-input-default
)
316 "Function that returns old text in comint mode.
317 This function is called when return is typed while the point is in old
318 text. It returns the text to be submitted as process input. The
319 default is `comint-get-old-input-default', which either grabs the
320 current input field or grabs the current line and strips off leading
321 text matching `comint-prompt-regexp', depending on the value of
322 `comint-use-prompt-regexp-instead-of-fields'.")
324 (defvar comint-dynamic-complete-functions
325 '(comint-replace-by-expanded-history comint-dynamic-complete-filename
)
326 "List of functions called to perform completion.
327 Functions should return non-nil if completion was performed.
328 See also `comint-dynamic-complete'.
330 This is a good thing to set in mode hooks.")
332 (defvar comint-input-filter
333 (function (lambda (str) (not (string-match "\\`\\s *\\'" str
))))
334 "Predicate for filtering additions to input history.
335 Takes one argument, the input. If non-nil, the input may be saved on the input
336 history list. Default is to save anything that isn't all whitespace.")
338 (defvar comint-input-filter-functions
'()
339 "Functions to call before input is sent to the process.
340 These functions get one argument, a string containing the text to send.
342 You can use `add-hook' to add functions to this list
343 either globally or locally.")
345 (defvar comint-output-filter-functions
'(comint-postoutput-scroll-to-bottom)
346 "Functions to call after output is inserted into the buffer.
347 One possible function is `comint-postoutput-scroll-to-bottom'.
348 These functions get one argument, a string containing the text as originally
349 inserted. Note that this might not be the same as the buffer contents between
350 `comint-last-output-start' and the buffer's `process-mark', if other filter
351 functions have already modified the buffer.
353 See also `comint-preoutput-filter-functions'.
355 You can use `add-hook' to add functions to this list
356 either globally or locally.")
358 (defvar comint-input-sender-no-newline nil
359 "Non-nil directs the `comint-input-sender' function not to send a newline.")
361 (defvar comint-input-sender
(function comint-simple-send
)
362 "Function to actually send to PROCESS the STRING submitted by user.
363 Usually this is just `comint-simple-send', but if your mode needs to
364 massage the input string, put a different function here.
365 `comint-simple-send' just sends the string plus a newline.
366 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
367 This is called from the user command `comint-send-input'.")
369 (defcustom comint-eol-on-send t
370 "*Non-nil means go to the end of the line before sending input.
371 See `comint-send-input'."
375 ;; Note: If it is decided to purge comint-prompt-regexp from the source
376 ;; entirely, searching for uses of this variable will help to identify
377 ;; places that need attention.
378 (defcustom comint-use-prompt-regexp-instead-of-fields nil
379 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
380 If nil, then program output and user-input are given different `field'
381 properties, which emacs commands can use to distinguish them (in
382 particular, common movement commands such as begining-of-line respect
383 field boundaries in a natural way)."
387 (defcustom comint-mode-hook
'(turn-on-font-lock)
388 "Called upon entry into `comint-mode'
389 This is run before the process is cranked up."
393 (defcustom comint-exec-hook
'()
394 "Called each time a process is exec'd by `comint-exec'.
395 This is called after the process is cranked up. It is useful for things that
396 must be done each time a process is executed in a comint mode buffer (e.g.,
397 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
398 executed once when the buffer is created."
402 (defvar comint-mode-map nil
)
404 (defvar comint-ptyp t
405 "Non-nil if communications via pty; false if by pipe. Buffer local.
406 This is to work around a bug in Emacs process signaling.")
408 (defvar comint-input-ring nil
)
409 (defvar comint-last-input-start
)
410 (defvar comint-last-input-end
)
411 (defvar comint-last-output-start
)
412 (defvar comint-input-ring-index nil
413 "Index of last matched history element.")
414 (defvar comint-matching-input-from-input-string
""
415 "Input previously used to match input history.")
416 (defvar comint-save-input-ring-index
417 "Last input ring index which you copied.
418 This is to support the command \\[comint-get-next-from-history].")
420 (defvar comint-accum-marker nil
421 "Non-nil if you are accumulating input lines to send as input together.
422 The command \\[comint-accumulate] sets this.")
424 (put 'comint-replace-by-expanded-history
'menu-enable
'comint-input-autoexpand
)
425 (put 'comint-input-ring
'permanent-local t
)
426 (put 'comint-input-ring-index
'permanent-local t
)
427 (put 'comint-save-input-ring-index
'permanent-local t
)
428 (put 'comint-input-autoexpand
'permanent-local t
)
429 (put 'comint-input-filter-functions
'permanent-local t
)
430 (put 'comint-output-filter-functions
'permanent-local t
)
431 (put 'comint-preoutput-filter-functions
'permanent-local t
)
432 (put 'comint-scroll-to-bottom-on-input
'permanent-local t
)
433 (put 'comint-scroll-to-bottom-on-output
'permanent-local t
)
434 (put 'comint-scroll-show-maximum-output
'permanent-local t
)
435 (put 'comint-ptyp
'permanent-local t
)
437 (put 'comint-mode
'mode-class
'special
)
439 (define-derived-mode comint-mode fundamental-mode
"Comint"
440 "Major mode for interacting with an inferior interpreter.
441 Interpreter name is same as buffer name, sans the asterisks.
442 Return at end of buffer sends line as input.
443 Return not at end copies rest of line to end and sends it.
444 Setting variable `comint-eol-on-send' means jump to the end of the line
445 before submitting new input.
447 This mode is customised to create major modes such as Inferior Lisp
448 mode, Shell mode, etc. This can be done by setting the hooks
449 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
450 and `comint-get-old-input' to appropriate functions, and the variable
451 `comint-prompt-regexp' to the appropriate regular expression.
453 An input history is maintained of size `comint-input-ring-size', and
454 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
455 Input ring history expansion can be achieved with the commands
456 \\[comint-replace-by-expanded-history] or \\[comint-magic-space].
457 Input ring expansion is controlled by the variable `comint-input-autoexpand',
458 and addition is controlled by the variable `comint-input-ignoredups'.
460 Commands with no default key bindings include `send-invisible',
461 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
462 `comint-magic-space'.
464 Input to, and output from, the subprocess can cause the window to scroll to
465 the end of the buffer. See variables `comint-output-filter-functions',
466 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
467 and `comint-scroll-to-bottom-on-output'.
469 If you accidentally suspend your process, use \\[comint-continue-subjob]
474 Entry to this mode runs the hooks on `comint-mode-hook'."
475 (setq mode-line-process
'(":%s"))
476 (set (make-local-variable 'comint-last-input-start
) (point-min-marker))
477 (set (make-local-variable 'comint-last-input-end
) (point-min-marker))
478 (set (make-local-variable 'comint-last-output-start
) (make-marker))
479 (make-local-variable 'comint-last-prompt-overlay
)
480 (make-local-variable 'comint-prompt-regexp
) ; Don't set; default
481 (make-local-variable 'comint-input-ring-size
) ; ...to global val.
482 (make-local-variable 'comint-input-ring
)
483 (make-local-variable 'comint-input-ring-file-name
)
484 (or (and (boundp 'comint-input-ring
) comint-input-ring
)
485 (setq comint-input-ring
(make-ring comint-input-ring-size
)))
486 (make-local-variable 'comint-input-ring-index
)
487 (make-local-variable 'comint-save-input-ring-index
)
488 (or (and (boundp 'comint-input-ring-index
) comint-input-ring-index
)
489 (setq comint-input-ring-index nil
))
490 (or (and (boundp 'comint-save-input-ring-index
) comint-save-input-ring-index
)
491 (setq comint-save-input-ring-index nil
))
492 (make-local-variable 'comint-matching-input-from-input-string
)
493 (make-local-variable 'comint-input-autoexpand
)
494 (make-local-variable 'comint-input-ignoredups
)
495 (make-local-variable 'comint-delimiter-argument-list
)
496 (make-local-variable 'comint-completion-fignore
)
497 (make-local-variable 'comint-get-old-input
)
498 (make-local-variable 'comint-input-filter
)
499 (make-local-variable 'comint-input-sender
)
500 (make-local-variable 'comint-eol-on-send
)
501 (make-local-variable 'comint-scroll-to-bottom-on-input
)
502 (make-local-variable 'comint-scroll-to-bottom-on-output
)
503 (make-local-variable 'comint-scroll-show-maximum-output
)
504 ;; This makes it really work to keep point at the bottom.
505 (make-local-variable 'scroll-conservatively
)
506 (setq scroll-conservatively
10000)
507 (add-hook 'pre-command-hook
'comint-preinput-scroll-to-bottom t t
)
508 (make-local-variable 'comint-ptyp
)
509 (make-local-variable 'comint-process-echoes
)
510 (make-local-variable 'comint-file-name-chars
)
511 (make-local-variable 'comint-file-name-quote-list
)
512 (set (make-local-variable 'comint-accum-marker
) (make-marker))
513 (add-hook 'change-major-mode-hook
'font-lock-defontify nil t
)
514 ;; This behavior is not useful in comint buffers, and is annoying
515 (set (make-local-variable 'next-line-add-newlines
) nil
))
520 (setq comint-mode-map
(make-sparse-keymap))
521 (define-key comint-mode-map
"\ep" 'comint-previous-input
)
522 (define-key comint-mode-map
"\en" 'comint-next-input
)
523 (define-key comint-mode-map
[C-up
] 'comint-previous-input
)
524 (define-key comint-mode-map
[C-down
] 'comint-next-input
)
525 (define-key comint-mode-map
"\er" 'comint-previous-matching-input
)
526 (define-key comint-mode-map
"\es" 'comint-next-matching-input
)
527 (define-key comint-mode-map
[?\C-c ?\M-r
] 'comint-previous-matching-input-from-input
)
528 (define-key comint-mode-map
[?\C-c ?\M-s
] 'comint-next-matching-input-from-input
)
529 (define-key comint-mode-map
"\e\C-l" 'comint-show-output
)
530 (define-key comint-mode-map
"\C-m" 'comint-send-input
)
531 (define-key comint-mode-map
"\C-d" 'comint-delchar-or-maybe-eof
)
532 (define-key comint-mode-map
"\C-c " 'comint-accumulate
)
533 (define-key comint-mode-map
"\C-c\C-x" 'comint-get-next-from-history
)
534 (define-key comint-mode-map
"\C-c\C-a" 'comint-bol-or-process-mark
)
535 (define-key comint-mode-map
"\C-c\C-u" 'comint-kill-input
)
536 (define-key comint-mode-map
"\C-c\C-w" 'backward-kill-word
)
537 (define-key comint-mode-map
"\C-c\C-c" 'comint-interrupt-subjob
)
538 (define-key comint-mode-map
"\C-c\C-z" 'comint-stop-subjob
)
539 (define-key comint-mode-map
"\C-c\C-\\" 'comint-quit-subjob
)
540 (define-key comint-mode-map
"\C-c\C-m" 'comint-copy-old-input
)
541 (define-key comint-mode-map
"\C-c\C-o" 'comint-delete-output
)
542 (define-key comint-mode-map
"\C-c\C-r" 'comint-show-output
)
543 (define-key comint-mode-map
"\C-c\C-e" 'comint-show-maximum-output
)
544 (define-key comint-mode-map
"\C-c\C-l" 'comint-dynamic-list-input-ring
)
545 (define-key comint-mode-map
"\C-c\C-n" 'comint-next-prompt
)
546 (define-key comint-mode-map
"\C-c\C-p" 'comint-previous-prompt
)
547 (define-key comint-mode-map
"\C-c\C-d" 'comint-send-eof
)
548 (define-key comint-mode-map
"\C-c\C-s" 'comint-write-output
)
549 (define-key comint-mode-map
"\C-c." 'comint-insert-previous-argument
)
551 (define-key comint-mode-map
[mouse-2
] 'comint-insert-clicked-input
)
554 (define-key comint-mode-map
[menu-bar completion
]
555 (cons "Complete" (make-sparse-keymap "Complete")))
556 (define-key comint-mode-map
[menu-bar completion complete-expand
]
557 '("Expand File Name" . comint-replace-by-expanded-filename
))
558 (define-key comint-mode-map
[menu-bar completion complete-listing
]
559 '("File Completion Listing" . comint-dynamic-list-filename-completions
))
560 (define-key comint-mode-map
[menu-bar completion complete-file
]
561 '("Complete File Name" . comint-dynamic-complete-filename
))
562 (define-key comint-mode-map
[menu-bar completion complete
]
563 '("Complete Before Point" . comint-dynamic-complete
))
565 (define-key comint-mode-map
[menu-bar inout
]
566 (cons "In/Out" (make-sparse-keymap "In/Out")))
567 (define-key comint-mode-map
[menu-bar inout delete-output
]
568 '("Delete Current Output Group" . comint-delete-output
))
569 (define-key comint-mode-map
[menu-bar inout append-output-to-file
]
570 '("Append Current Output Group to File" . comint-append-output-to-file
))
571 (define-key comint-mode-map
[menu-bar inout write-output
]
572 '("Write Current Output Group to File" . comint-write-output
))
573 (define-key comint-mode-map
[menu-bar inout next-prompt
]
574 '("Forward Output Group" . comint-next-prompt
))
575 (define-key comint-mode-map
[menu-bar inout previous-prompt
]
576 '("Backward Output Group" . comint-previous-prompt
))
577 (define-key comint-mode-map
[menu-bar inout show-maximum-output
]
578 '("Show Maximum Output" . comint-show-maximum-output
))
579 (define-key comint-mode-map
[menu-bar inout show-output
]
580 '("Show Current Output Group" . comint-show-output
))
581 (define-key comint-mode-map
[menu-bar inout kill-input
]
582 '("Kill Current Input" . comint-kill-input
))
583 (define-key comint-mode-map
[menu-bar inout copy-input
]
584 '("Copy Old Input" . comint-copy-old-input
))
585 (define-key comint-mode-map
[menu-bar inout forward-matching-history
]
586 '("Forward Matching Input..." . comint-forward-matching-input
))
587 (define-key comint-mode-map
[menu-bar inout backward-matching-history
]
588 '("Backward Matching Input..." . comint-backward-matching-input
))
589 (define-key comint-mode-map
[menu-bar inout next-matching-history
]
590 '("Next Matching Input..." . comint-next-matching-input
))
591 (define-key comint-mode-map
[menu-bar inout previous-matching-history
]
592 '("Previous Matching Input..." . comint-previous-matching-input
))
593 (define-key comint-mode-map
[menu-bar inout next-matching-history-from-input
]
594 '("Next Matching Current Input" . comint-next-matching-input-from-input
))
595 (define-key comint-mode-map
[menu-bar inout previous-matching-history-from-input
]
596 '("Previous Matching Current Input" . comint-previous-matching-input-from-input
))
597 (define-key comint-mode-map
[menu-bar inout next-history
]
598 '("Next Input" . comint-next-input
))
599 (define-key comint-mode-map
[menu-bar inout previous-history
]
600 '("Previous Input" . comint-previous-input
))
601 (define-key comint-mode-map
[menu-bar inout list-history
]
602 '("List Input History" . comint-dynamic-list-input-ring
))
603 (define-key comint-mode-map
[menu-bar inout expand-history
]
604 '("Expand History Before Point" . comint-replace-by-expanded-history
))
606 (define-key comint-mode-map
[menu-bar signals
]
607 (cons "Signals" (make-sparse-keymap "Signals")))
608 (define-key comint-mode-map
[menu-bar signals eof
]
609 '("EOF" . comint-send-eof
))
610 (define-key comint-mode-map
[menu-bar signals kill
]
611 '("KILL" . comint-kill-subjob
))
612 (define-key comint-mode-map
[menu-bar signals quit
]
613 '("QUIT" . comint-quit-subjob
))
614 (define-key comint-mode-map
[menu-bar signals cont
]
615 '("CONT" . comint-continue-subjob
))
616 (define-key comint-mode-map
[menu-bar signals stop
]
617 '("STOP" . comint-stop-subjob
))
618 (define-key comint-mode-map
[menu-bar signals break
]
619 '("BREAK" . comint-interrupt-subjob
))
620 ;; Put them in the menu bar:
621 (setq menu-bar-final-items
(append '(completion inout signals
)
622 menu-bar-final-items
))
625 (defun comint-check-proc (buffer)
626 "Return t if there is a living process associated w/buffer BUFFER.
627 Living means the status is `open', `run', or `stop'.
628 BUFFER can be either a buffer or the name of one."
629 (let ((proc (get-buffer-process buffer
)))
630 (and proc
(memq (process-status proc
) '(open run stop
)))))
633 (defun make-comint-in-buffer (name buffer program
&optional startfile
&rest switches
)
634 "Make a comint process NAME in BUFFER, running PROGRAM.
635 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
636 PROGRAM should be either a string denoting an executable program to create
637 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
638 connection to be opened via `open-network-stream'. If there is already a
639 running process in that buffer, it is not restarted. Optional third arg
640 STARTFILE is the name of a file to send the contents of to the process.
642 If PROGRAM is a string, any more args are arguments to PROGRAM."
643 (or (fboundp 'start-process
)
644 (error "Multi-processing is not supported for this system"))
645 (setq buffer
(get-buffer-create (or buffer
(concat "*" name
"*"))))
646 ;; If no process, or nuked process, crank up a new one and put buffer in
647 ;; comint mode. Otherwise, leave buffer and existing process alone.
648 (unless (comint-check-proc buffer
)
649 (with-current-buffer buffer
650 (unless (derived-mode-p 'comint-mode
)
651 (comint-mode))) ; Install local vars, mode, keymap, ...
652 (comint-exec buffer name program startfile switches
))
656 (defun make-comint (name program
&optional startfile
&rest switches
)
657 "Make a comint process NAME in a buffer, running PROGRAM.
658 The name of the buffer is made by surrounding NAME with `*'s.
659 PROGRAM should be either a string denoting an executable program to create
660 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
661 connection to be opened via `open-network-stream'. If there is already a
662 running process in that buffer, it is not restarted. Optional third arg
663 STARTFILE is the name of a file to send the contents of to the process.
665 If PROGRAM is a string, any more args are arguments to PROGRAM."
666 (apply #'make-comint-in-buffer name nil program startfile switches
))
669 (defun comint-run (program)
670 "Run PROGRAM in a comint buffer and switch to it.
671 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
672 The file name is used to make a symbol name, such as `comint-sh-hook', and any
673 hooks on this symbol are run in the buffer.
674 See `make-comint' and `comint-exec'."
675 (interactive "sRun program: ")
676 (let ((name (file-name-nondirectory program
)))
677 (switch-to-buffer (make-comint name program
))
678 (run-hooks (intern-soft (concat "comint-" name
"-hook")))))
680 (defun comint-exec (buffer name command startfile switches
)
681 "Start up a process in buffer BUFFER for comint modes.
682 Blasts any old process running in the buffer. Doesn't set the buffer mode.
683 You can use this to cheaply run a series of processes in the same comint
684 buffer. The hook `comint-exec-hook' is run after each exec."
685 (with-current-buffer buffer
686 (let ((proc (get-buffer-process buffer
))) ; Blast any old process.
687 (if proc
(delete-process proc
)))
688 ;; Crank up a new process
691 (open-network-stream name buffer
(car command
) (cdr command
))
692 (comint-exec-1 name buffer command switches
))))
693 (set-process-filter proc
'comint-output-filter
)
694 (make-local-variable 'comint-ptyp
)
695 (setq comint-ptyp process-connection-type
) ; t if pty, nil if pipe.
696 ;; Jump to the end, and set the process mark.
697 (goto-char (point-max))
698 (set-marker (process-mark proc
) (point))
699 ;; Feed it the startfile.
701 ;;This is guaranteed to wait long enough
702 ;;but has bad results if the comint does not prompt at all
703 ;; (while (= size (buffer-size))
705 ;;I hope 1 second is enough!
707 (goto-char (point-max))
708 (insert-file-contents startfile
)
709 (setq startfile
(buffer-substring (point) (point-max)))
710 (delete-region (point) (point-max))
711 (comint-send-string proc startfile
)))
712 (run-hooks 'comint-exec-hook
)
715 ;; This auxiliary function cranks up the process for comint-exec in
716 ;; the appropriate environment.
718 (defun comint-exec-1 (name buffer command switches
)
719 (let ((process-environment
721 ;; If using termcap, we specify `emacs' as the terminal type
722 ;; because that lets us specify a width.
723 ;; If using terminfo, we specify `dumb' because that is
724 ;; a defined terminal type. `emacs' is not a defined terminal type
725 ;; and there is no way for us to define it here.
726 ;; Some programs that use terminfo get very confused
727 ;; if TERM is not a valid terminal type.
728 ;; ;; There is similar code in compile.el.
729 (if (and (boundp 'system-uses-terminfo
) system-uses-terminfo
)
730 (list "TERM=dumb" "TERMCAP="
731 (format "COLUMNS=%d" (window-width)))
733 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
734 (if (getenv "EMACS") nil
(list "EMACS=t"))
735 process-environment
))
737 (if (file-accessible-directory-p default-directory
)
739 (char-to-string directory-sep-char
)))
740 proc decoding encoding changed
)
741 (let ((exec-path (if (file-name-directory command
)
742 ;; If the command has slashes, make sure we
743 ;; first look relative to the current directory.
744 (cons default-directory exec-path
) exec-path
)))
745 (setq proc
(apply 'start-process name buffer command switches
)))
746 (let ((coding-systems (process-coding-system proc
)))
747 (setq decoding
(car coding-systems
)
748 encoding
(cdr coding-systems
)))
749 ;; If start-process decided to use some coding system for decoding
750 ;; data sent from the process and the coding system doesn't
751 ;; specify EOL conversion, we had better convert CRLF to LF.
752 (if (vectorp (coding-system-eol-type decoding
))
753 (setq decoding
(coding-system-change-eol-conversion decoding
'dos
)
755 ;; Even if start-process left the coding system for encoding data
756 ;; sent from the process undecided, we had better use the same one
757 ;; as what we use for decoding. But, we should suppress EOL
759 (if (and decoding
(not encoding
))
760 (setq encoding
(coding-system-change-eol-conversion decoding
'unix
)
763 (set-process-coding-system proc decoding encoding
))
767 (defun comint-insert-clicked-input (event)
768 "In a comint buffer, set the current input to the clicked-on previous input."
770 (let ((pos (posn-point (event-end event
))))
771 (if (not (eq (get-char-property pos
'field
) 'input
))
772 ;; No input at POS, fall back to the global definition.
773 (let* ((keys (this-command-keys))
774 (last-key (and (vectorp keys
) (aref keys
(1- (length keys
)))))
775 (fun (and last-key
(lookup-key global-map
(vector last-key
)))))
776 (and fun
(call-interactively fun
)))
777 ;; There's previous input at POS, insert it at the end of the buffer.
778 (goto-char (point-max))
779 ;; First delete any old unsent input at the end
781 (or (marker-position comint-accum-marker
)
782 (process-mark (get-buffer-process (current-buffer))))
784 ;; Insert the clicked-upon input
785 (insert (buffer-substring-no-properties
786 (previous-single-char-property-change (1+ pos
) 'field
)
787 (next-single-char-property-change pos
'field
))))))
791 ;; Input history processing in a buffer
792 ;; ===========================================================================
793 ;; Useful input history functions, courtesy of the Ergo group.
796 ;; comint-dynamic-list-input-ring List history in help buffer.
797 ;; comint-previous-input Previous input...
798 ;; comint-previous-matching-input ...matching a string.
799 ;; comint-previous-matching-input-from-input ... matching the current input.
800 ;; comint-next-input Next input...
801 ;; comint-next-matching-input ...matching a string.
802 ;; comint-next-matching-input-from-input ... matching the current input.
803 ;; comint-backward-matching-input Backwards input...
804 ;; comint-forward-matching-input ...matching a string.
805 ;; comint-replace-by-expanded-history Expand history at point;
806 ;; replace with expanded history.
807 ;; comint-magic-space Expand history and insert space.
810 ;; comint-read-input-ring Read into comint-input-ring...
811 ;; comint-write-input-ring Write to comint-input-ring-file-name.
812 ;; comint-replace-by-expanded-history-before-point Workhorse function.
814 (defun comint-read-input-ring (&optional silent
)
815 "Sets the buffer's `comint-input-ring' from a history file.
816 The name of the file is given by the variable `comint-input-ring-file-name'.
817 The history ring is of size `comint-input-ring-size', regardless of file size.
818 If `comint-input-ring-file-name' is nil this function does nothing.
820 If the optional argument SILENT is non-nil, we say nothing about a
821 failure to read the history file.
823 This function is useful for major mode commands and mode hooks.
825 The commands stored in the history file are separated by the
826 `comint-input-ring-separator', and entries that match
827 `comint-input-history-ignore' are ignored. The most recent command
830 See also `comint-input-ignoredups' and `comint-write-input-ring'."
831 (cond ((or (null comint-input-ring-file-name
)
832 (equal comint-input-ring-file-name
""))
834 ((not (file-readable-p comint-input-ring-file-name
))
836 (message "Cannot read history file %s"
837 comint-input-ring-file-name
)))
839 (let* ((history-buf (get-buffer-create " *temp*"))
840 (file comint-input-ring-file-name
)
842 (size comint-input-ring-size
)
843 (ring (make-ring size
)))
846 (set-buffer history-buf
)
849 (insert-file-contents file
)
850 ;; Save restriction in case file is already visited...
851 ;; Watch for those date stamps in history files!
852 (goto-char (point-max))
853 (let (start end history
)
854 (while (and (< count comint-input-ring-size
)
855 (re-search-backward comint-input-ring-separator nil t
)
856 (setq end
(match-beginning 0)))
857 (if (re-search-backward comint-input-ring-separator nil t
)
858 (setq start
(match-end 0))
859 (setq start
(point-min)))
860 (setq history
(buffer-substring start end
))
862 (if (and (not (string-match comint-input-history-ignore history
))
863 (or (null comint-input-ignoredups
)
865 (not (string-equal (ring-ref ring
0) history
))))
867 (ring-insert-at-beginning ring history
)
868 (setq count
(1+ count
)))))))
869 (kill-buffer history-buf
))
870 (setq comint-input-ring ring
871 comint-input-ring-index nil
)))))
873 (defun comint-write-input-ring ()
874 "Writes the buffer's `comint-input-ring' to a history file.
875 The name of the file is given by the variable `comint-input-ring-file-name'.
876 The original contents of the file are lost if `comint-input-ring' is not empty.
877 If `comint-input-ring-file-name' is nil this function does nothing.
879 Useful within process sentinels.
881 See also `comint-read-input-ring'."
882 (cond ((or (null comint-input-ring-file-name
)
883 (equal comint-input-ring-file-name
"")
884 (null comint-input-ring
) (ring-empty-p comint-input-ring
))
886 ((not (file-writable-p comint-input-ring-file-name
))
887 (message "Cannot write history file %s" comint-input-ring-file-name
))
889 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
890 (ring comint-input-ring
)
891 (file comint-input-ring-file-name
)
892 (index (ring-length ring
)))
893 ;; Write it all out into a buffer first. Much faster, but messier,
894 ;; than writing it one line at a time.
896 (set-buffer history-buf
)
899 (setq index
(1- index
))
900 (insert (ring-ref ring index
) comint-input-ring-separator
))
901 (write-region (buffer-string) nil file nil
'no-message
)
902 (kill-buffer nil
))))))
905 (defvar comint-dynamic-list-input-ring-window-conf
)
907 (defun comint-dynamic-list-input-ring-select ()
908 "Choose the input history entry that point is in or next to."
910 (let (beg end completion
(buffer completion-reference-buffer
)
911 (base-size completion-base-size
))
912 (if (and (not (eobp)) (get-text-property (point) 'mouse-face
))
913 (setq end
(point) beg
(1+ (point))))
914 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face
))
915 (setq end
(1- (point)) beg
(point)))
917 (error "No history entry here"))
918 (setq beg
(previous-single-property-change beg
'mouse-face
))
919 (setq end
(or (next-single-property-change end
'mouse-face
) (point-max)))
920 (setq completion
(buffer-substring beg end
))
921 (set-window-configuration comint-dynamic-list-input-ring-window-conf
)
922 (choose-completion-string completion buffer base-size
)))
924 (defun comint-dynamic-list-input-ring ()
925 "List in help buffer the buffer's input history."
927 (if (or (not (ring-p comint-input-ring
))
928 (ring-empty-p comint-input-ring
))
929 (message "No history")
931 (history-buffer " *Input History*")
932 (index (1- (ring-length comint-input-ring
)))
933 (conf (current-window-configuration)))
934 ;; We have to build up a list ourselves from the ring vector.
936 (setq history
(cons (ring-ref comint-input-ring index
) history
)
938 ;; Change "completion" to "history reference"
939 ;; to make the display accurate.
940 (with-output-to-temp-buffer history-buffer
941 (display-completion-list history
)
942 (set-buffer history-buffer
)
943 (let ((keymap (make-sparse-keymap)))
944 (set-keymap-parent keymap
(current-local-map))
945 (define-key keymap
"\C-m" 'comint-dynamic-list-input-ring-select
)
946 (use-local-map keymap
))
948 (while (search-backward "completion" nil
'move
)
949 (replace-match "history reference")))
951 (message "Hit space to flush")
952 (setq comint-dynamic-list-input-ring-window-conf conf
)
953 (let ((ch (read-event)))
955 (set-window-configuration conf
)
956 (setq unread-command-events
(list ch
)))))))
959 (defun comint-regexp-arg (prompt)
960 ;; Return list of regexp and prefix arg using PROMPT.
961 (let* (;; Don't clobber this.
962 (last-command last-command
)
963 (regexp (read-from-minibuffer prompt nil nil nil
964 'minibuffer-history-search-history
)))
965 (list (if (string-equal regexp
"")
966 (setcar minibuffer-history-search-history
967 (nth 1 minibuffer-history-search-history
))
969 (prefix-numeric-value current-prefix-arg
))))
971 (defun comint-search-arg (arg)
972 ;; First make sure there is a ring and that we are after the process mark
973 (cond ((not (comint-after-pmark-p))
974 (error "Not at command line"))
975 ((or (null comint-input-ring
)
976 (ring-empty-p comint-input-ring
))
977 (error "Empty input ring"))
979 ;; arg of zero resets search from beginning, and uses arg of 1
980 (setq comint-input-ring-index nil
)
985 (defun comint-search-start (arg)
986 ;; Index to start a directional search, starting at comint-input-ring-index
987 (if comint-input-ring-index
988 ;; If a search is running, offset by 1 in direction of arg
989 (mod (+ comint-input-ring-index
(if (> arg
0) 1 -
1))
990 (ring-length comint-input-ring
))
991 ;; For a new search, start from beginning or end, as appropriate
993 0 ; First elt for forward search
994 (1- (ring-length comint-input-ring
))))) ; Last elt for backward search
996 (defun comint-previous-input-string (arg)
997 "Return the string ARG places along the input ring.
998 Moves relative to `comint-input-ring-index'."
999 (ring-ref comint-input-ring
(if comint-input-ring-index
1000 (mod (+ arg comint-input-ring-index
)
1001 (ring-length comint-input-ring
))
1004 (defun comint-previous-input (arg)
1005 "Cycle backwards through input history."
1007 (comint-previous-matching-input "." arg
))
1009 (defun comint-next-input (arg)
1010 "Cycle forwards through input history."
1012 (comint-previous-input (- arg
)))
1014 (defun comint-previous-matching-input-string (regexp arg
)
1015 "Return the string matching REGEXP ARG places along the input ring.
1016 Moves relative to `comint-input-ring-index'."
1017 (let* ((pos (comint-previous-matching-input-string-position regexp arg
)))
1018 (if pos
(ring-ref comint-input-ring pos
))))
1020 (defun comint-previous-matching-input-string-position (regexp arg
&optional start
)
1021 "Return the index matching REGEXP ARG places along the input ring.
1022 Moves relative to START, or `comint-input-ring-index'."
1023 (if (or (not (ring-p comint-input-ring
))
1024 (ring-empty-p comint-input-ring
))
1025 (error "No history"))
1026 (let* ((len (ring-length comint-input-ring
))
1027 (motion (if (> arg
0) 1 -
1))
1028 (n (mod (- (or start
(comint-search-start arg
)) motion
) len
))
1029 (tried-each-ring-item nil
)
1031 ;; Do the whole search as many times as the argument says.
1032 (while (and (/= arg
0) (not tried-each-ring-item
))
1035 n
(mod (+ n motion
) len
))
1036 ;; If we haven't reached a match, step some more.
1037 (while (and (< n len
) (not tried-each-ring-item
)
1038 (not (string-match regexp
(ring-ref comint-input-ring n
))))
1039 (setq n
(mod (+ n motion
) len
)
1040 ;; If we have gone all the way around in this search.
1041 tried-each-ring-item
(= n prev
)))
1042 (setq arg
(if (> arg
0) (1- arg
) (1+ arg
))))
1043 ;; Now that we know which ring element to use, if we found it, return that.
1044 (if (string-match regexp
(ring-ref comint-input-ring n
))
1047 (defun comint-previous-matching-input (regexp arg
)
1048 "Search backwards through input history for match for REGEXP.
1049 \(Previous history elements are earlier commands.)
1050 With prefix argument N, search for Nth previous match.
1051 If N is negative, find the next or Nth next match."
1052 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1053 (setq arg
(comint-search-arg arg
))
1054 (let ((pos (comint-previous-matching-input-string-position regexp arg
)))
1055 ;; Has a match been found?
1058 (setq comint-input-ring-index pos
)
1059 (message "History item: %d" (1+ pos
))
1061 ;; Can't use kill-region as it sets this-command
1062 (or (marker-position comint-accum-marker
)
1063 (process-mark (get-buffer-process (current-buffer))))
1065 (insert (ring-ref comint-input-ring pos
)))))
1067 (defun comint-next-matching-input (regexp arg
)
1068 "Search forwards through input history for match for REGEXP.
1069 \(Later history elements are more recent commands.)
1070 With prefix argument N, search for Nth following match.
1071 If N is negative, find the previous or Nth previous match."
1072 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1073 (comint-previous-matching-input regexp
(- arg
)))
1075 (defun comint-previous-matching-input-from-input (arg)
1076 "Search backwards through input history for match for current input.
1077 \(Previous history elements are earlier commands.)
1078 With prefix argument N, search for Nth previous match.
1079 If N is negative, search forwards for the -Nth following match."
1081 (if (not (memq last-command
'(comint-previous-matching-input-from-input
1082 comint-next-matching-input-from-input
)))
1083 ;; Starting a new search
1084 (setq comint-matching-input-from-input-string
1086 (or (marker-position comint-accum-marker
)
1087 (process-mark (get-buffer-process (current-buffer))))
1089 comint-input-ring-index nil
))
1090 (comint-previous-matching-input
1091 (concat "^" (regexp-quote comint-matching-input-from-input-string
))
1094 (defun comint-next-matching-input-from-input (arg)
1095 "Search forwards through input history for match for current input.
1096 \(Following history elements are more recent commands.)
1097 With prefix argument N, search for Nth following match.
1098 If N is negative, search backwards for the -Nth previous match."
1100 (comint-previous-matching-input-from-input (- arg
)))
1103 (defun comint-replace-by-expanded-history (&optional silent start
)
1104 "Expand input command history references before point.
1105 Expansion is dependent on the value of `comint-input-autoexpand'.
1107 This function depends on the buffer's idea of the input history, which may not
1108 match the command interpreter's idea, assuming it has one.
1110 Assumes history syntax is like typical Un*x shells'. However, since emacs
1111 cannot know the interpreter's idea of input line numbers, assuming it has one,
1112 it cannot expand absolute input line number references.
1114 If the optional argument SILENT is non-nil, never complain
1115 even if history reference seems erroneous.
1117 If the optional argument START is non-nil, that specifies the
1118 start of the text to scan for history references, rather
1119 than the logical beginning of line.
1121 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1123 Returns t if successful."
1125 (if (and comint-input-autoexpand
1126 (if comint-use-prompt-regexp-instead-of-fields
1127 ;; Use comint-prompt-regexp
1130 (looking-at (concat comint-prompt-regexp
"!\\|\\^")))
1131 ;; Use input fields. User input that hasn't been entered
1132 ;; yet, at the end of the buffer, has a nil `field' property.
1133 (and (null (get-char-property (point) 'field
))
1134 (string-match "!\\|^\\^" (field-string)))))
1135 ;; Looks like there might be history references in the command.
1136 (let ((previous-modified-tick (buffer-modified-tick)))
1137 (comint-replace-by-expanded-history-before-point silent start
)
1138 (/= previous-modified-tick
(buffer-modified-tick)))))
1141 (defun comint-replace-by-expanded-history-before-point (silent &optional start
)
1142 "Expand directory stack reference before point.
1143 See `comint-replace-by-expanded-history'. Returns t if successful.
1145 If the optional argument START is non-nil, that specifies the
1146 start of the text to scan for history references, rather
1147 than the logical beginning of line."
1149 (let ((toend (- (line-end-position) (point)))
1150 (start (comint-line-beginning-position)))
1153 (skip-chars-forward "^!^" (- (line-end-position) toend
))
1154 (< (point) (- (line-end-position) toend
)))
1155 ;; This seems a bit complex. We look for references such as !!, !-num,
1156 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1157 ;; If that wasn't enough, the plings can be suffixed with argument
1158 ;; range specifiers.
1159 ;; Argument ranges are complex too, so we hive off the input line,
1160 ;; referenced with plings, with the range string to `comint-args'.
1161 (setq comint-input-ring-index nil
)
1162 (cond ((or (= (preceding-char) ?
\\)
1163 (comint-within-quotes start
(point)))
1164 ;; The history is quoted, or we're in quotes.
1165 (goto-char (1+ (point))))
1166 ((looking-at "![0-9]+\\($\\|[^-]\\)")
1167 ;; We cannot know the interpreter's idea of input line numbers.
1168 (goto-char (match-end 0))
1169 (message "Absolute reference cannot be expanded"))
1170 ((looking-at "!-\\([0-9]+\\)\\(:?[0-9^$*-]+\\)?")
1171 ;; Just a number of args from `number' lines backward.
1172 (let ((number (1- (string-to-number
1173 (buffer-substring (match-beginning 1)
1175 (if (<= number
(ring-length comint-input-ring
))
1178 (comint-args (comint-previous-input-string number
)
1179 (match-beginning 2) (match-end 2))
1181 (setq comint-input-ring-index number
)
1182 (message "History item: %d" (1+ number
)))
1183 (goto-char (match-end 0))
1184 (message "Relative reference exceeds input history size"))))
1185 ((or (looking-at "!!?:?\\([0-9^$*-]+\\)") (looking-at "!!"))
1186 ;; Just a number of args from the previous input line.
1188 (comint-args (comint-previous-input-string 0)
1189 (match-beginning 1) (match-end 1))
1191 (message "History item: previous"))
1193 "!\\??\\({\\(.+\\)}\\|\\(\\sw+\\)\\)\\(:?[0-9^$*-]+\\)?")
1194 ;; Most recent input starting with or containing (possibly
1195 ;; protected) string, maybe just a number of args. Phew.
1196 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1197 (mb2 (match-beginning 2)) (me2 (match-end 2))
1198 (exp (buffer-substring (or mb2 mb1
) (or me2 me1
)))
1199 (pref (if (save-match-data (looking-at "!\\?")) "" "^"))
1200 (pos (save-match-data
1201 (comint-previous-matching-input-string-position
1202 (concat pref
(regexp-quote exp
)) 1))))
1205 (goto-char (match-end 0))
1207 (progn (message "Not found")
1209 (setq comint-input-ring-index pos
)
1211 (comint-args (ring-ref comint-input-ring pos
)
1212 (match-beginning 4) (match-end 4))
1214 (message "History item: %d" (1+ pos
)))))
1215 ((looking-at "\\^\\([^^]+\\)\\^?\\([^^]*\\)\\^?")
1216 ;; Quick substitution on the previous input line.
1217 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1218 (new (buffer-substring (match-beginning 2) (match-end 2)))
1220 (replace-match (comint-previous-input-string 0) t t
)
1222 (goto-char (match-beginning 0))
1223 (if (not (search-forward old pos t
))
1225 (error "Not found"))
1226 (replace-match new t t
)
1227 (message "History item: substituted"))))
1229 (forward-char 1)))))))
1232 (defun comint-magic-space (arg)
1233 "Expand input history references before point and insert ARG spaces.
1234 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1236 (comint-replace-by-expanded-history)
1237 (self-insert-command arg
))
1239 (defun comint-within-quotes (beg end
)
1240 "Return t if the number of quotes between BEG and END is odd.
1241 Quotes are single and double."
1242 (let ((countsq (comint-how-many-region "\\(^\\|[^\\\\]\\)\'" beg end
))
1243 (countdq (comint-how-many-region "\\(^\\|[^\\\\]\\)\"" beg end
)))
1244 (or (= (mod countsq
2) 1) (= (mod countdq
2) 1))))
1246 (defun comint-how-many-region (regexp beg end
)
1247 "Return number of matches for REGEXP from BEG to END."
1252 (while (re-search-forward regexp end t
)
1253 (setq count
(1+ count
)))))
1256 (defun comint-args (string begin end
)
1257 ;; From STRING, return the args depending on the range specified in the text
1258 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1259 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1262 (comint-arguments string
0 nil
)
1263 (let* ((range (buffer-substring
1264 (if (eq (char-after begin
) ?
:) (1+ begin
) begin
) end
))
1265 (nth (cond ((string-match "^[*^]" range
) 1)
1266 ((string-match "^-" range
) 0)
1267 ((string-equal range
"$") nil
)
1268 (t (string-to-number range
))))
1269 (mth (cond ((string-match "[-*$]$" range
) nil
)
1270 ((string-match "-" range
)
1271 (string-to-number (substring range
(match-end 0))))
1273 (comint-arguments string nth mth
)))))
1275 ;; Return a list of arguments from ARG. Break it up at the
1276 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1277 (defun comint-delim-arg (arg)
1278 (if (null comint-delimiter-argument-list
)
1284 (let ((char (aref arg pos
))
1286 (if (memq char comint-delimiter-argument-list
)
1287 (while (and (< pos len
) (eq (aref arg pos
) char
))
1288 (setq pos
(1+ pos
)))
1289 (while (and (< pos len
)
1290 (not (memq (aref arg pos
)
1291 comint-delimiter-argument-list
)))
1292 (setq pos
(1+ pos
))))
1293 (setq args
(cons (substring arg start pos
) args
))))
1296 (defun comint-arguments (string nth mth
)
1297 "Return from STRING the NTH to MTH arguments.
1298 NTH and/or MTH can be nil, which means the last argument.
1299 Returned arguments are separated by single spaces.
1300 We assume whitespace separates arguments, except within quotes
1301 and except for a space or tab that immediately follows a backslash.
1302 Also, a run of one or more of a single character
1303 in `comint-delimiter-argument-list' is a separate argument.
1304 Argument 0 is the command name."
1305 ;; The first line handles ordinary characters and backslash-sequences
1306 ;; (except with w32 msdos-like shells, where backslashes are valid).
1307 ;; The second matches "-quoted strings.
1308 ;; The third matches '-quoted strings.
1309 ;; The fourth matches `-quoted strings.
1310 ;; This seems to fit the syntax of BASH 2.0.
1311 (let* ((first (if (and (eq system-type
'windows-nt
)
1312 (w32-shell-dos-semantics))
1314 "[^ \n\t\"'`\\]+\\|\\\\[\"'`\\ \t]+\\|"))
1315 (argpart (concat first
1316 "\\(\"\\([^\"\\]\\|\\\\.\\)*\"\\|\
1321 beg str value quotes
)
1322 ;; Build a list of all the args until we have as many as we want.
1323 (while (and (or (null mth
) (<= count mth
))
1324 (string-match argpart string pos
))
1325 (if (and beg
(= pos
(match-beginning 0)))
1326 ;; It's contiguous, part of the same arg.
1327 (setq pos
(match-end 0)
1328 quotes
(or quotes
(match-beginning 1)))
1329 ;; It's a new separate arg.
1331 ;; Put the previous arg, if there was one, onto ARGS.
1332 (setq str
(substring string beg pos
)
1333 args
(if quotes
(cons str args
)
1334 (nconc (comint-delim-arg str
) args
))
1336 (setq quotes
(match-beginning 1))
1337 (setq beg
(match-beginning 0))
1338 (setq pos
(match-end 0))))
1340 (setq str
(substring string beg pos
)
1341 args
(if quotes
(cons str args
)
1342 (nconc (comint-delim-arg str
) args
))
1344 (let ((n (or nth
(1- count
)))
1345 (m (if mth
(1- (- count mth
)) 0)))
1347 (function (lambda (a) a
)) (nthcdr n
(nreverse (nthcdr m args
))) " "))))
1350 ;; Input processing stuff
1352 (defun comint-add-to-input-history (cmd)
1353 "Add CMD to the input history.
1354 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1355 (if (and (funcall comint-input-filter cmd
)
1356 (or (null comint-input-ignoredups
)
1357 (not (ring-p comint-input-ring
))
1358 (ring-empty-p comint-input-ring
)
1359 (not (string-equal (ring-ref comint-input-ring
0)
1361 (ring-insert comint-input-ring cmd
)))
1363 (defun comint-send-input (&optional no-newline
)
1364 "Send input to process.
1365 After the process output mark, sends all text from the process mark to
1366 point as input to the process. Before the process output mark, calls
1367 value of variable `comint-get-old-input' to retrieve old input, copies
1368 it to the process mark, and sends it. A terminal newline is also
1369 inserted into the buffer and sent to the process.
1371 Any history reference may be expanded depending on the value of the variable
1372 `comint-input-autoexpand'. The list of function names contained in the value
1373 of `comint-input-filter-functions' is called on the input before sending it.
1374 The input is entered into the input history ring, if the value of variable
1375 `comint-input-filter' returns non-nil when called on the input.
1377 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1378 end of line before sending the input.
1380 After the input has been sent, if `comint-process-echoes' is non-nil,
1381 then comint-send-input waits to see if the process outputs a string
1382 matching the input, and if so, deletes that part of the output.
1384 The values of `comint-get-old-input', `comint-input-filter-functions', and
1385 `comint-input-filter' are chosen according to the command interpreter running
1386 in the buffer. E.g.,
1388 If the interpreter is the csh,
1389 comint-get-old-input is the default:
1390 If `comint-use-prompt-regexp-instead-of-fields' is nil, then
1391 either return the current input field, if point is on an input
1392 field, or the current line, if point is on an output field.
1393 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then
1394 return the current line with any initial string matching the
1395 regexp `comint-prompt-regexp' removed.
1396 comint-input-filter-functions monitors input for \"cd\", \"pushd\", and
1397 \"popd\" commands. When it sees one, it cd's the buffer.
1398 comint-input-filter is the default: returns t if the input isn't all white
1401 If the comint is Lucid Common Lisp,
1402 comint-get-old-input snarfs the sexp ending at point.
1403 comint-input-filter-functions does nothing.
1404 comint-input-filter returns nil if the input matches input-filter-regexp,
1405 which matches (1) all whitespace (2) :a, :c, etc.
1407 Similarly for Soar, Scheme, etc."
1409 ;; Note that the input string does not include its terminal newline.
1410 (let ((proc (get-buffer-process (current-buffer))))
1411 (if (not proc
) (error "Current buffer has no process")
1412 (let* ((pmark (process-mark proc
))
1413 (intxt (if (>= (point) (marker-position pmark
))
1414 (progn (if comint-eol-on-send
(end-of-line))
1415 (buffer-substring pmark
(point)))
1416 (let ((copy (funcall comint-get-old-input
)))
1420 (input (if (not (eq comint-input-autoexpand
'input
))
1421 ;; Just whatever's already there
1423 ;; Expand and leave it visible in buffer
1424 (comint-replace-by-expanded-history t pmark
)
1425 (buffer-substring pmark
(point))))
1426 (history (if (not (eq comint-input-autoexpand
'history
))
1428 ;; This is messy 'cos ultimately the original
1429 ;; functions used do insertion, rather than return
1430 ;; strings. We have to expand, then insert back.
1431 (comint-replace-by-expanded-history t pmark
)
1432 (let ((copy (buffer-substring pmark
(point)))
1435 (delete-region pmark start
)
1441 (comint-add-to-input-history history
)
1443 (run-hook-with-args 'comint-input-filter-functions
1444 (if no-newline input
1445 (concat input
"\n")))
1447 (let ((beg (marker-position pmark
))
1448 (end (if no-newline
(point) (1- (point)))))
1450 ;; Set text-properties for the input field
1451 (add-text-properties
1454 font-lock-face comint-highlight-input
1455 mouse-face highlight
1456 help-echo
"mouse-2: insert after prompt as new input"))
1457 (unless comint-use-prompt-regexp-instead-of-fields
1458 ;; Give old user input a field property of `input', to
1459 ;; distinguish it from both process output and unsent
1460 ;; input. The terminating newline is put into a special
1461 ;; `boundary' field to make cursor movement between input
1462 ;; and output fields smoother.
1463 (put-text-property beg end
'field
'input
)))
1464 (unless (or no-newline comint-use-prompt-regexp-instead-of-fields
)
1465 ;; Cover the terminating newline
1466 (add-text-properties end
(1+ end
)
1469 inhibit-line-move-field-capture t
))))
1471 (comint-snapshot-last-prompt)
1473 (setq comint-save-input-ring-index comint-input-ring-index
)
1474 (setq comint-input-ring-index nil
)
1475 ;; Update the markers before we send the input
1476 ;; in case we get output amidst sending the input.
1477 (set-marker comint-last-input-start pmark
)
1478 (set-marker comint-last-input-end
(point))
1479 (set-marker (process-mark proc
) (point))
1480 ;; clear the "accumulation" marker
1481 (set-marker comint-accum-marker nil
)
1482 (let ((comint-input-sender-no-newline no-newline
))
1483 (funcall comint-input-sender proc input
))
1485 ;; Optionally delete echoed input (after checking it).
1486 (when comint-process-echoes
1487 (let ((echo-len (- comint-last-input-end
1488 comint-last-input-start
)))
1489 ;; Wait for all input to be echoed:
1490 (while (and (accept-process-output proc
)
1491 (> (+ comint-last-input-end echo-len
)
1494 (compare-buffer-substrings
1495 nil comint-last-input-start
1496 (- (point-max) echo-len
)
1497 ;; Above difference is equivalent to
1498 ;; (+ comint-last-input-start
1499 ;; (- (point-max) comint-last-input-end))
1500 nil comint-last-input-end
(point-max)))))
1502 (<= (+ comint-last-input-end echo-len
)
1505 (compare-buffer-substrings
1506 nil comint-last-input-start comint-last-input-end
1507 nil comint-last-input-end
1508 (+ comint-last-input-end echo-len
))))
1509 (delete-region comint-last-input-end
1510 (+ comint-last-input-end echo-len
)))))
1512 ;; This used to call comint-output-filter-functions,
1513 ;; but that scrolled the buffer in undesirable ways.
1514 (run-hook-with-args 'comint-output-filter-functions
"")))))
1516 (defvar comint-preoutput-filter-functions nil
1517 "List of functions to call before inserting Comint output into the buffer.
1518 Each function gets one argument, a string containing the text received
1519 from the subprocess. It should return the string to insert, perhaps
1520 the same string that was received, or perhaps a modified or transformed
1523 The functions on the list are called sequentially, and each one is
1524 given the string returned by the previous one. The string returned by
1525 the last function is the text that is actually inserted in the
1528 You can use `add-hook' to add functions to this list
1529 either globally or locally.")
1531 (defvar comint-inhibit-carriage-motion nil
1532 "If nil, comint will interpret `carriage control' characters in output.
1533 See `comint-carriage-motion' for details.")
1535 ;; When non-nil, this is an overlay over the last recognized prompt in
1536 ;; the buffer; it is used when highlighting the prompt.
1537 (defvar comint-last-prompt-overlay nil
)
1539 ;; `snapshot' any current comint-last-prompt-overlay, freezing its
1540 ;; attributes in place, even when more input comes a long and moves the
1542 (defun comint-snapshot-last-prompt ()
1543 (when comint-last-prompt-overlay
1544 (let ((inhibit-read-only t
))
1545 (add-text-properties (overlay-start comint-last-prompt-overlay
)
1546 (overlay-end comint-last-prompt-overlay
)
1547 (overlay-properties comint-last-prompt-overlay
)))))
1549 (defun comint-carriage-motion (start end
)
1550 "Interpret carriage control characters in the region from START to END.
1551 Translate carriage return/linefeed sequences to linefeeds.
1552 Make single carriage returns delete to the beginning of the line.
1553 Make backspaces delete the previous character."
1555 ;; First do a quick check to see if there are any applicable
1556 ;; characters, so we can avoid calling save-match-data and
1557 ;; save-restriction if not.
1559 (when (< (skip-chars-forward "^\b\r" end
) (- end start
))
1563 (let ((inhibit-field-text-motion t
)
1564 (inhibit-read-only t
))
1566 ;; Note that this won't work properly when the CR and LF
1567 ;; are in different output chunks, but this is probably an
1568 ;; exceedingly rare case (because they are generally
1569 ;; written as a unit), and to delay interpretation of a
1570 ;; trailing CR in a chunk would result in odd interactive
1571 ;; behavior (and this case is probably far more common).
1572 (while (re-search-forward "\r$" end t
)
1574 ;; bare CR -> delete preceding line
1576 (while (search-forward "\r" end t
)
1577 (delete-region (point) (line-beginning-position)))
1578 ;; BS -> delete preceding character
1580 (while (search-forward "\b" end t
)
1581 (delete-char -
2))))))))
1583 ;; The purpose of using this filter for comint processes
1584 ;; is to keep comint-last-input-end from moving forward
1585 ;; when output is inserted.
1586 (defun comint-output-filter (process string
)
1587 (let ((oprocbuf (process-buffer process
)))
1588 ;; First check for killed buffer or no input.
1589 (when (and string oprocbuf
(buffer-name oprocbuf
))
1590 (with-current-buffer oprocbuf
1591 ;; Run preoutput filters
1592 (let ((functions comint-preoutput-filter-functions
))
1593 (while (and functions string
)
1594 (if (eq (car functions
) t
)
1595 (let ((functions (default-value 'comint-preoutput-filter-functions
)))
1596 (while (and functions string
)
1597 (setq string
(funcall (car functions
) string
))
1598 (setq functions
(cdr functions
))))
1599 (setq string
(funcall (car functions
) string
)))
1600 (setq functions
(cdr functions
))))
1603 (let ((inhibit-read-only t
)
1604 ;; Avoid the overhead of save-excursion, since we just
1605 ;; fiddle with the point
1606 (saved-point (point-marker)))
1608 ;; The point should float after any insertion we do
1609 (set-marker-insertion-type saved-point t
)
1611 ;; We temporarly remove any buffer narrowing, in case the
1612 ;; process mark is outside of the restriction
1616 (goto-char (process-mark process
))
1617 (set-marker comint-last-output-start
(point))
1619 ;; insert-before-markers is a bad thing. XXX
1621 ;; It is used here to force window-point markers (used to
1622 ;; store the value of point in non-selected windows) to
1623 ;; advance, but it also screws up any other markers that we
1624 ;; don't _want_ to advance, such as the start-marker of some
1625 ;; of the overlays we create.
1627 ;; We work around the problem with the overlays by
1628 ;; explicitly adjusting them after we do the insertion, but
1629 ;; in the future this problem should be solved correctly, by
1630 ;; using `insert', and making the insertion-type of
1631 ;; window-point markers settable (via a buffer-local
1632 ;; variable). In comint buffers, this variable would be set
1633 ;; to `t', to cause point in non-select windows to advance.
1634 (insert-before-markers string
)
1635 ;; Fixup markers and overlays that got screwed up because we
1636 ;; used `insert-before-markers'.
1637 (let ((old-point (- (point) (length string
))))
1638 ;; comint-last-output-start
1639 (set-marker comint-last-output-start old-point
)
1640 ;; comint-last-input-end
1641 (when (and comint-last-input-end
1642 (equal (marker-position comint-last-input-end
)
1644 (set-marker comint-last-input-end old-point
))
1645 ;; No overlays we create are set to advance upon insertion
1646 ;; (at the start/end), so we assume that any overlay which
1647 ;; is at the current point was incorrectly advanced by
1648 ;; insert-before-markers. First fixup overlays that might
1650 (dolist (over (overlays-at (point)))
1651 (when (= (overlay-start over
) (point))
1652 (let ((end (overlay-end over
)))
1655 (if (= end
(point)) old-point end
)))))
1656 ;; Then do overlays that might end at point:
1657 (dolist (over (overlays-at (1- (point))))
1658 (when (= (overlay-end over
) (point))
1660 (min (overlay-start over
) old-point
)
1663 ;; Advance process-mark
1664 (set-marker (process-mark process
) (point))
1666 (unless comint-inhibit-carriage-motion
1667 ;; Interpret any carriage motion characters (newline, backspace)
1668 (comint-carriage-motion comint-last-output-start
(point)))
1670 (run-hook-with-args 'comint-output-filter-functions string
)
1672 (goto-char (process-mark process
)) ; in case a filter moved it
1674 (unless comint-use-prompt-regexp-instead-of-fields
1675 (let ((inhibit-read-only t
))
1676 (add-text-properties comint-last-output-start
(point)
1679 inhibit-line-move-field-capture t
))))
1681 ;; Highlight the prompt, where we define `prompt' to mean
1682 ;; the most recent output that doesn't end with a newline.
1683 (unless (and (bolp) (null comint-last-prompt-overlay
))
1684 ;; Need to create or move the prompt overlay (in the case
1685 ;; where there is no prompt ((bolp) == t), we still do
1686 ;; this if there's already an existing overlay).
1687 (let ((prompt-start (save-excursion (forward-line 0) (point))))
1688 (if comint-last-prompt-overlay
1689 ;; Just move an existing overlay
1690 (move-overlay comint-last-prompt-overlay
1691 prompt-start
(point))
1692 ;; Need to create the overlay
1693 (setq comint-last-prompt-overlay
1694 (make-overlay prompt-start
(point)))
1695 (overlay-put comint-last-prompt-overlay
1696 'font-lock-face
'comint-highlight-prompt
))))
1698 (goto-char saved-point
)))))))
1700 (defun comint-preinput-scroll-to-bottom ()
1701 "Go to the end of buffer in all windows showing it.
1702 Movement occurs if point in the selected window is not after the process mark,
1703 and `this-command' is an insertion command. Insertion commands recognised
1704 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1705 Depends on the value of `comint-scroll-to-bottom-on-input'.
1707 This function should be a pre-command hook."
1708 (if (and comint-scroll-to-bottom-on-input
1709 (memq this-command
'(self-insert-command comint-magic-space yank
1711 (let* ((selected (selected-window))
1712 (current (current-buffer))
1713 (process (get-buffer-process current
))
1714 (scroll comint-scroll-to-bottom-on-input
))
1715 (if (and process
(< (point) (process-mark process
)))
1716 (if (eq scroll
'this
)
1717 (goto-char (point-max))
1719 (function (lambda (window)
1720 (if (and (eq (window-buffer window
) current
)
1721 (or (eq scroll t
) (eq scroll
'all
)))
1723 (select-window window
)
1724 (goto-char (point-max))
1725 (select-window selected
)))))
1728 (defun comint-postoutput-scroll-to-bottom (string)
1729 "Go to the end of buffer in all windows showing it.
1730 Does not scroll if the current line is the last line in the buffer.
1731 Depends on the value of `comint-scroll-to-bottom-on-output' and
1732 `comint-scroll-show-maximum-output'.
1734 This function should be in the list `comint-output-filter-functions'."
1735 (let* ((selected (selected-window))
1736 (current (current-buffer))
1737 (process (get-buffer-process current
))
1738 (scroll comint-scroll-to-bottom-on-output
))
1742 (function (lambda (window)
1743 (if (eq (window-buffer window
) current
)
1745 (select-window window
)
1746 (if (and (< (point) (process-mark process
))
1747 (or (eq scroll t
) (eq scroll
'all
)
1748 ;; Maybe user wants point to jump to end.
1749 (and (eq scroll
'this
) (eq selected window
))
1750 (and (eq scroll
'others
) (not (eq selected window
)))
1751 ;; If point was at the end, keep it at end.
1752 (and (marker-position comint-last-output-start
)
1753 (>= (point) comint-last-output-start
))))
1754 (goto-char (process-mark process
)))
1755 ;; Optionally scroll so that the text
1756 ;; ends at the bottom of the window.
1757 (if (and comint-scroll-show-maximum-output
1758 (= (point) (point-max)))
1760 (goto-char (point-max))
1762 (select-window selected
)))))
1764 (set-buffer current
))))
1766 (defun comint-truncate-buffer (&optional string
)
1767 "Truncate the buffer to `comint-buffer-maximum-size'.
1768 This function could be on `comint-output-filter-functions' or bound to a key."
1771 (goto-char (process-mark (get-buffer-process (current-buffer))))
1772 (forward-line (- comint-buffer-maximum-size
))
1774 (let ((inhibit-read-only t
))
1775 (delete-region (point-min) (point)))))
1777 (defun comint-strip-ctrl-m (&optional string
)
1778 "Strip trailing `^M' characters from the current output group.
1779 This function could be on `comint-output-filter-functions' or bound to a key."
1781 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1785 (if (interactive-p) comint-last-input-end comint-last-output-start
))
1787 (while (re-search-forward "\r+$" pmark t
)
1788 (replace-match "" t t
)))))
1789 (defalias 'shell-strip-ctrl-m
'comint-strip-ctrl-m
)
1791 (defun comint-show-maximum-output ()
1792 "Put the end of the buffer at the bottom of the window."
1794 (goto-char (point-max))
1797 (defun comint-get-old-input-default ()
1798 "Default for `comint-get-old-input'.
1799 If `comint-use-prompt-regexp-instead-of-fields' is nil, then either
1800 return the current input field, if point is on an input field, or the
1801 current line, if point is on an output field.
1802 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then return
1803 the current line with any initial string matching the regexp
1804 `comint-prompt-regexp' removed."
1805 (let ((bof (field-beginning)))
1806 (if (eq (get-char-property bof
'field
) 'input
)
1807 (field-string-no-properties bof
)
1809 (buffer-substring-no-properties (point) (line-end-position)))))
1811 (defun comint-copy-old-input ()
1812 "Insert after prompt old input at point as new input to be edited.
1813 Calls `comint-get-old-input' to get old input."
1815 (let ((input (funcall comint-get-old-input
))
1816 (process (get-buffer-process (current-buffer))))
1818 (error "Current buffer has no process")
1819 (goto-char (process-mark process
))
1822 (defun comint-skip-prompt ()
1823 "Skip past the text matching regexp `comint-prompt-regexp'.
1824 If this takes us past the end of the current line, don't skip at all."
1825 (let ((eol (save-excursion (end-of-line) (point))))
1826 (if (and (looking-at comint-prompt-regexp
)
1827 (<= (match-end 0) eol
))
1828 (goto-char (match-end 0)))))
1830 (defun comint-after-pmark-p ()
1831 "Return t if point is after the process output marker."
1832 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1833 (<= (marker-position pmark
) (point))))
1835 (defun comint-simple-send (proc string
)
1836 "Default function for sending to PROC input STRING.
1837 This just sends STRING plus a newline. To override this,
1838 set the hook `comint-input-sender'."
1839 (comint-send-string proc string
)
1840 (if comint-input-sender-no-newline
1841 (if (not (string-equal string
""))
1843 (comint-send-string proc
"\n")))
1845 (defun comint-line-beginning-position ()
1846 "Returns the buffer position of the beginning of the line, after any prompt.
1847 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1848 prompt skip is done by skipping text matching the regular expression
1849 `comint-prompt-regexp', a buffer local variable."
1850 (if comint-use-prompt-regexp-instead-of-fields
1851 ;; Use comint-prompt-regexp
1854 (comint-skip-prompt)
1856 ;; Use input fields. Note that, unlike the behavior of
1857 ;; `line-beginning-position' inside a field, this function will
1858 ;; return the position of the end of a prompt, even if the point is
1859 ;; already inside the prompt. In order to do this, it assumes that
1860 ;; if there are two fields on a line, then the first one is the
1861 ;; prompt, and the second one is an input field, and is front-sticky
1862 ;; (as input fields should be).
1863 (constrain-to-field (line-beginning-position) (line-end-position))))
1865 (defun comint-bol (&optional arg
)
1866 "Goes to the beginning of line, then skips past the prompt, if any.
1867 If prefix argument is given (\\[universal-argument]) the prompt is not skipped.
1868 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1869 prompt skip is done by skipping text matching the regular expression
1870 `comint-prompt-regexp', a buffer local variable."
1873 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1875 (goto-char (comint-line-beginning-position))))
1877 ;; These three functions are for entering text you don't want echoed or
1878 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1879 ;; Just enter m-x send-invisible and type in your line, or add
1880 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1882 (defun comint-read-noecho (prompt &optional stars
)
1883 "Read a single line of text from user without echoing, and return it.
1884 Prompt with argument PROMPT, a string. Optional argument STARS causes
1885 input to be echoed with '*' characters on the prompt line. Input ends with
1886 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1887 `inhibit-quit' is set because e.g. this function was called from a process
1888 filter and C-g is pressed, this function returns nil rather than a string).
1890 Note that the keystrokes comprising the text can still be recovered
1891 \(temporarily) with \\[view-lossage]. Some people find this worrysome.
1892 Once the caller uses the password, it can erase the password
1893 by doing (fillarray STRING 0)."
1898 (cursor-in-echo-area t
)
1899 (message-log-max nil
)
1903 (message "%s%s" prompt
(make-string (length ans
) ?
*))
1904 (message "%s" prompt
))
1905 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1906 (setq c
(read-char-exclusive))
1908 ;; This function may get called from a process filter, where
1909 ;; inhibit-quit is set. In later versions of emacs read-char
1910 ;; may clear quit-flag itself and return C-g. That would make
1911 ;; it impossible to quit this loop in a simple way, so
1912 ;; re-enable it here (for backward-compatibility the check for
1913 ;; quit-flag below would still be necessary, so this seems
1914 ;; like the simplest way to do things).
1917 ((or (= c ?
\r) (= c ?
\n) (= c ?\e
))
1922 ((and (/= c ?
\b) (/= c ?
\177))
1923 (setq newans
(concat ans
(char-to-string c
)))
1927 (aset ans
(1- (length ans
)) 0)
1928 (setq ans
(substring ans
0 -
1)))))
1930 ;; Emulate a true quit, except that we have to return a value.
1932 (setq quit-flag nil
)
1938 (defun send-invisible (str)
1939 "Read a string without echoing.
1940 Then send it to the process running in the current buffer.
1941 The string is sent using `comint-input-sender'.
1942 Security bug: your string can still be temporarily recovered with
1944 (interactive "P") ; Defeat snooping via C-x ESC ESC
1945 (let ((proc (get-buffer-process (current-buffer))))
1947 (error "Current buffer has no process"))
1949 (comint-snapshot-last-prompt)
1950 (funcall comint-input-sender proc str
))
1952 (let ((str (comint-read-noecho "Non-echoed text: " t
)))
1954 (send-invisible str
)
1955 (message "Warning: text will be echoed")))))))
1957 (defun comint-watch-for-password-prompt (string)
1958 "Prompt in the minibuffer for password and send without echoing.
1959 This function uses `send-invisible' to read and send a password to the buffer's
1960 process if STRING contains a password prompt defined by
1961 `comint-password-prompt-regexp'.
1963 This function could be in the list `comint-output-filter-functions'."
1964 (when (string-match comint-password-prompt-regexp string
)
1965 (when (string-match "^[ \n\r\t\v\f\b\a]+" string
)
1966 (setq string
(replace-match "" t t string
)))
1967 (let ((pw (comint-read-noecho string t
)))
1968 (send-invisible pw
))))
1970 ;; Low-level process communication
1972 (defun comint-send-string (process string
)
1973 "Like `process-send-string', but also does extra bookkeeping for comint mode."
1975 (with-current-buffer (if (processp process
)
1976 (process-buffer process
)
1977 (get-buffer process
))
1978 (comint-snapshot-last-prompt))
1979 (comint-snapshot-last-prompt))
1980 (process-send-string process string
))
1982 (defun comint-send-region (process start end
)
1983 "Like `process-send-region', 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-region process start end
))
1993 ;; Random input hackage
1995 (defun comint-delete-output ()
1996 "Delete all output from interpreter since last input.
1997 Does not delete the prompt."
1999 (let ((proc (get-buffer-process (current-buffer)))
2002 (let ((pmark (progn (goto-char (process-mark proc
))
2005 (delete-region comint-last-input-end pmark
)
2006 (goto-char (process-mark proc
))
2007 (setq replacement
(concat "*** output flushed ***\n"
2008 (buffer-substring pmark
(point))))
2009 (delete-region pmark
(point))))
2010 ;; Output message and put back prompt
2011 (comint-output-filter proc replacement
)))
2012 (defalias 'comint-kill-output
'comint-delete-output
)
2013 (make-obsolete 'comint-kill-output
'comint-delete-output
"21.1")
2015 (defun comint-write-output (filename &optional append mustbenew
)
2016 "Write output from interpreter since last input to FILENAME.
2017 Any prompt at the end of the output is not written.
2019 If the optional argument APPEND (the prefix argument when interactive)
2020 is non-nil, the output is appended to the file instead.
2022 If the optional argument MUSTBENEW is non-nil, check for an existing
2023 file with the same name. If MUSTBENEW is `excl', that means to get an
2024 error if the file already exists; never overwrite. If MUSTBENEW is
2025 neither nil nor `excl', that means ask for confirmation before
2026 overwriting, but do go ahead and overwrite the file if the user
2027 confirms. When interactive, MUSTBENEW is nil when appending, and t
2030 (list (read-file-name
2031 (if current-prefix-arg
2032 "Append output to file: "
2033 "Write output to file: "))
2035 (not current-prefix-arg
)))
2037 (goto-char (process-mark (get-buffer-process (current-buffer))))
2039 (write-region comint-last-input-end
(point) filename
2040 append nil nil mustbenew
)))
2042 ;; This function exists for the benefit of the menu; from the keyboard,
2043 ;; users can just use `comint-write-output' with a prefix arg.
2044 (defun comint-append-output-to-file (filename)
2045 "Append output from interpreter since last input to FILENAME.
2046 Any prompt at the end of the output is not written."
2047 (interactive "fAppend output to file: ")
2048 (comint-write-output filename t
))
2050 (defun comint-show-output ()
2051 "Display start of this batch of interpreter output at top of window.
2052 Sets mark to the value of point when this command is run."
2055 (let ((pos (or (marker-position comint-last-input-end
) (point-max))))
2056 (cond (comint-use-prompt-regexp-instead-of-fields
2058 (beginning-of-line 0)
2059 (set-window-start (selected-window) (point))
2060 (comint-skip-prompt))
2062 (goto-char (field-beginning pos
))
2063 (set-window-start (selected-window) (point))))))
2066 (defun comint-interrupt-subjob ()
2067 "Interrupt the current subjob.
2068 This command also kills the pending input
2069 between the process-mark and point."
2072 (interrupt-process nil comint-ptyp
))
2074 (defun comint-kill-subjob ()
2075 "Send kill signal to the current subjob.
2076 This command also kills the pending input
2077 between the process-mark and point."
2080 (kill-process nil comint-ptyp
))
2082 (defun comint-quit-subjob ()
2083 "Send quit signal to the current subjob.
2084 This command also kills the pending input
2085 between the process-mark and point."
2088 (quit-process nil comint-ptyp
))
2090 (defun comint-stop-subjob ()
2091 "Stop the current subjob.
2092 This command also kills the pending input
2093 between the process-mark and point.
2095 WARNING: if there is no current subjob, you can end up suspending
2096 the top-level process running in the buffer. If you accidentally do
2097 this, use \\[comint-continue-subjob] to resume the process. (This
2098 is not a problem with most shells, since they ignore this signal.)"
2101 (stop-process nil comint-ptyp
))
2103 (defun comint-continue-subjob ()
2104 "Send CONT signal to process buffer's process group.
2105 Useful if you accidentally suspend the top-level process."
2107 (continue-process nil comint-ptyp
))
2109 (defun comint-skip-input ()
2110 "Skip all pending input, from last stuff output by interpreter to point.
2111 This means mark it as if it had been sent as input, without sending it."
2112 (let ((comint-input-sender 'ignore
)
2113 (comint-input-filter-functions nil
))
2114 (comint-send-input t
))
2117 (marker (process-mark (get-buffer-process (current-buffer)))))
2118 (insert " " (key-description (this-command-keys)))
2120 (set-marker marker
(point)))))
2122 (defun comint-kill-input ()
2123 "Kill all text from last stuff output by interpreter to point."
2125 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2126 (if (> (point) (marker-position pmark
))
2127 (kill-region pmark
(point)))))
2129 (defun comint-delchar-or-maybe-eof (arg)
2130 "Delete ARG characters forward or send an EOF to subprocess.
2131 Sends an EOF only if point is at the end of the buffer and there is no input."
2133 (let ((proc (get-buffer-process (current-buffer))))
2134 (if (and (eobp) proc
(= (point) (marker-position (process-mark proc
))))
2136 (delete-char arg
))))
2138 (defun comint-send-eof ()
2139 "Send an EOF to the current buffer's process."
2141 (comint-send-input t
)
2145 (defun comint-backward-matching-input (regexp arg
)
2146 "Search backward through buffer for input fields that match REGEXP.
2147 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2148 fields are identified by lines that match `comint-prompt-regexp'.
2150 With prefix argument N, search for Nth previous match.
2151 If N is negative, find the next or Nth next match."
2152 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2153 (if comint-use-prompt-regexp-instead-of-fields
2154 ;; Use comint-prompt-regexp
2155 (let* ((re (concat comint-prompt-regexp
".*" regexp
))
2156 (pos (save-excursion (end-of-line (if (> arg
0) 0 1))
2157 (if (re-search-backward re nil t arg
)
2160 (progn (message "Not found")
2165 (let* ((dir (if (< arg
0) -
1 1))
2169 (unless (re-search-backward regexp nil t dir
)
2170 (error "Not found"))
2171 (when (eq (get-char-property (point) 'field
) 'input
)
2172 (setq arg
(- arg dir
))))
2173 (field-beginning))))
2177 (defun comint-forward-matching-input (regexp arg
)
2178 "Search forward through buffer for input fields that match REGEXP.
2179 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2180 fields are identified by lines that match `comint-prompt-regexp'.
2182 With prefix argument N, search for Nth following match.
2183 If N is negative, find the previous or Nth previous match."
2184 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2185 (comint-backward-matching-input regexp
(- arg
)))
2188 (defun comint-next-prompt (n)
2189 "Move to end of Nth next prompt in the buffer.
2190 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2191 the beginning of the Nth next `input' field, otherwise, it means the Nth
2192 occurrence of text matching `comint-prompt-regexp'."
2194 (if comint-use-prompt-regexp-instead-of-fields
2195 ;; Use comint-prompt-regexp
2196 (let ((paragraph-start comint-prompt-regexp
))
2197 (end-of-line (if (> n
0) 1 0))
2198 (forward-paragraph n
)
2199 (comint-skip-prompt))
2208 (next-single-char-property-change pos
'field
)
2209 (previous-single-char-property-change pos
'field
)))
2210 (cond ((or (null pos
) (= pos prev-pos
))
2211 ;; Ran off the end of the buffer.
2213 ;; There's always an input field at the end of the
2214 ;; buffer, but it has a `field' property of nil.
2215 (setq input-pos
(point-max)))
2218 ((eq (get-char-property pos
'field
) 'input
)
2219 (setq n
(if (< n
0) (1+ n
) (1- n
)))
2220 (setq input-pos pos
))))
2222 (goto-char input-pos
)))))
2225 (defun comint-previous-prompt (n)
2226 "Move to end of Nth previous prompt in the buffer.
2227 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2228 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2229 occurrence of text matching `comint-prompt-regexp'."
2231 (comint-next-prompt (- n
)))
2233 ;; State used by `comint-insert-previous-argument' when cycling.
2234 (defvar comint-insert-previous-argument-last-start-pos nil
)
2235 (make-variable-buffer-local 'comint-insert-previous-argument-last-start-pos
)
2236 (defvar comint-insert-previous-argument-last-index nil
)
2237 (make-variable-buffer-local 'comint-insert-previous-argument-last-index
)
2240 ;; make comint-arguments understand negative indices as bash does
2241 (defun comint-insert-previous-argument (index)
2242 "Insert the INDEXth argument from the previous comint command-line at point.
2243 Spaces are added at beginning and/or end of the inserted string if
2244 necessary to ensure that it's separated from adjacent arguments.
2245 Interactively, if no prefix argument is given, the last argument is inserted.
2246 Repeated interactive invocations will cycle through the same argument
2247 from progressively earlier commands (using the value of INDEX specified
2248 with the first command).
2249 This command is like `M-.' in bash."
2251 (unless (null index
)
2252 (setq index
(prefix-numeric-value index
)))
2253 (cond ((eq last-command this-command
)
2254 ;; Delete last input inserted by this command.
2255 (delete-region comint-insert-previous-argument-last-start-pos
(point))
2256 (setq index comint-insert-previous-argument-last-index
))
2258 ;; This is a non-repeat invocation, so initialize state.
2259 (setq comint-input-ring-index nil
)
2260 (setq comint-insert-previous-argument-last-index index
)
2261 (when (null comint-insert-previous-argument-last-start-pos
)
2262 ;; First usage; initialize to a marker
2263 (setq comint-insert-previous-argument-last-start-pos
2265 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2266 (if (<= (point) (comint-line-beginning-position))
2269 ;; Remember the beginning of what we insert, so we can delete it if
2270 ;; the command is repeated.
2271 (set-marker comint-insert-previous-argument-last-start-pos
(point))
2272 ;; Insert the argument.
2273 (let ((input-string (comint-previous-input-string 0)))
2274 (when (string-match "[ \t\n]*&" input-string
)
2275 ;; strip terminating '&'
2276 (setq input-string
(substring input-string
0 (match-beginning 0))))
2277 (insert (comint-arguments input-string index index
)))
2278 ;; Make next invocation return arg from previous input
2279 (setq comint-input-ring-index
(1+ (or comint-input-ring-index
0)))
2280 ;; Add a terminating space if necessary.
2285 ;; Support for source-file processing commands.
2286 ;;============================================================================
2287 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2288 ;; commands that process files of source text (e.g. loading or compiling
2289 ;; files). So the corresponding process-in-a-buffer modes have commands
2290 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2291 ;; for defining these commands.
2293 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2294 ;; and Soar, in that they don't know anything about file extensions.
2295 ;; So the compile/load interface gets the wrong default occasionally.
2296 ;; The load-file/compile-file default mechanism could be smarter -- it
2297 ;; doesn't know about the relationship between filename extensions and
2298 ;; whether the file is source or executable. If you compile foo.lisp
2299 ;; with compile-file, then the next load-file should use foo.bin for
2300 ;; the default, not foo.lisp. This is tricky to do right, particularly
2301 ;; because the extension for executable files varies so much (.o, .bin,
2302 ;; .lbin, .mo, .vo, .ao, ...).
2305 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2308 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2309 ;; want to save the buffer before issuing any process requests to the command
2312 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2313 ;; for the file to process.
2315 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2316 ;;============================================================================
2317 ;; This function computes the defaults for the load-file and compile-file
2318 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2320 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2321 ;; source-file processing command. nil if there hasn't been one yet.
2322 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2323 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2324 ;; Typically, (lisp-mode) or (scheme-mode).
2326 ;; If the command is given while the cursor is inside a string, *and*
2327 ;; the string is an existing filename, *and* the filename is not a directory,
2328 ;; then the string is taken as default. This allows you to just position
2329 ;; your cursor over a string that's a filename and have it taken as default.
2331 ;; If the command is given in a file buffer whose major mode is in
2332 ;; SOURCE-MODES, then the filename is the default file, and the
2333 ;; file's directory is the default directory.
2335 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2336 ;; then the default directory & file are what was used in the last source-file
2337 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2338 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2339 ;; is the cwd, with no default file. (\"no default file\" = nil)
2341 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2342 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2343 ;; for Soar programs, etc.
2345 ;; The function returns a pair: (default-directory . default-file).
2347 (defun comint-source-default (previous-dir/file source-modes
)
2348 (cond ((and buffer-file-name
(memq major-mode source-modes
))
2349 (cons (file-name-directory buffer-file-name
)
2350 (file-name-nondirectory buffer-file-name
)))
2353 (cons default-directory nil
))))
2356 ;; (COMINT-CHECK-SOURCE fname)
2357 ;;============================================================================
2358 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2359 ;; process-in-a-buffer modes), this function can be called on the filename.
2360 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2361 ;; is queried to see if he wants to save the buffer before proceeding with
2362 ;; the load or compile.
2364 (defun comint-check-source (fname)
2365 (let ((buff (get-file-buffer fname
)))
2367 (buffer-modified-p buff
)
2368 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff
))))
2370 (let ((old-buffer (current-buffer)))
2373 (set-buffer old-buffer
)))))
2376 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2377 ;;============================================================================
2378 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2379 ;; commands that process source files (like loading or compiling a file).
2380 ;; It prompts for the filename, provides a default, if there is one,
2381 ;; and returns the result filename.
2383 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
2385 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2386 ;; from the last source processing command. SOURCE-MODES is a list of major
2387 ;; modes used to determine what file buffers contain source files. (These
2388 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2389 ;; then the filename reader will only accept a file that exists.
2392 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2395 ;; This is pretty stupid about strings. It decides we're in a string
2396 ;; if there's a quote on both sides of point on the current line.
2397 (defun comint-extract-string ()
2398 "Return string around POINT that starts the current line, or nil."
2400 (let* ((point (point))
2401 (bol (progn (beginning-of-line) (point)))
2402 (eol (progn (end-of-line) (point)))
2403 (start (progn (goto-char point
)
2404 (and (search-backward "\"" bol t
)
2406 (end (progn (goto-char point
)
2407 (and (search-forward "\"" eol t
)
2410 (buffer-substring-no-properties start end
)))))
2412 (defun comint-get-source (prompt prev-dir
/file source-modes mustmatch-p
)
2413 (let* ((def (comint-source-default prev-dir
/file source-modes
))
2414 (stringfile (comint-extract-string))
2415 (sfile-p (and stringfile
2417 (file-exists-p stringfile
)
2419 (not (file-directory-p stringfile
))))
2420 (defdir (if sfile-p
(file-name-directory stringfile
)
2422 (deffile (if sfile-p
(file-name-nondirectory stringfile
)
2424 (ans (read-file-name (if deffile
(format "%s(default %s) "
2428 (concat defdir deffile
)
2430 (list (expand-file-name (substitute-in-file-name ans
)))))
2432 ;; I am somewhat divided on this string-default feature. It seems
2433 ;; to violate the principle-of-least-astonishment, in that it makes
2434 ;; the default harder to predict, so you actually have to look and see
2435 ;; what the default really is before choosing it. This can trip you up.
2436 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2441 ;; Simple process query facility.
2442 ;; ===========================================================================
2443 ;; This function is for commands that want to send a query to the process
2444 ;; and show the response to the user. For example, a command to get the
2445 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2446 ;; to an inferior Common Lisp process.
2448 ;; This simple facility just sends strings to the inferior process and pops
2449 ;; up a window for the process buffer so you can see what the process
2450 ;; responds with. We don't do anything fancy like try to intercept what the
2451 ;; process responds with and put it in a pop-up window or on the message
2452 ;; line. We just display the buffer. Low tech. Simple. Works good.
2454 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2455 ;; a window for the inferior process so that its response can be seen.
2456 (defun comint-proc-query (proc str
)
2457 (let* ((proc-buf (process-buffer proc
))
2458 (proc-mark (process-mark proc
)))
2459 (display-buffer proc-buf
)
2460 (set-buffer proc-buf
) ; but it's not the selected *window*
2461 (let ((proc-win (get-buffer-window proc-buf
))
2462 (proc-pt (marker-position proc-mark
)))
2463 (comint-send-string proc str
) ; send the query
2464 (accept-process-output proc
) ; wait for some output
2465 ;; Try to position the proc window so you can see the answer.
2466 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2467 ;; I don't know why. Wizards invited to improve it.
2468 (unless (pos-visible-in-window-p proc-pt proc-win
)
2469 (let ((opoint (window-point proc-win
)))
2470 (set-window-point proc-win proc-mark
)
2472 (if (not (pos-visible-in-window-p opoint proc-win
))
2474 (set-window-point proc-win opoint
)))))))
2477 ;; Filename/command/history completion in a buffer
2478 ;; ===========================================================================
2479 ;; Useful completion functions, courtesy of the Ergo group.
2482 ;; comint-dynamic-complete Complete or expand command, filename,
2483 ;; history at point.
2484 ;; comint-dynamic-complete-filename Complete filename at point.
2485 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2486 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2487 ;; replace with expanded/completed name.
2488 ;; comint-dynamic-simple-complete Complete stub given candidates.
2490 ;; These are not installed in the comint-mode keymap. But they are
2491 ;; available for people who want them. Shell-mode installs them:
2492 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2493 ;; (define-key shell-mode-map "\M-?"
2494 ;; 'comint-dynamic-list-filename-completions)))
2496 ;; Commands like this are fine things to put in load hooks if you
2497 ;; want them present in specific modes.
2499 (defcustom comint-completion-autolist nil
2500 "*If non-nil, automatically list possibilities on partial completion.
2501 This mirrors the optional behavior of tcsh."
2503 :group
'comint-completion
)
2505 (defcustom comint-completion-addsuffix t
2506 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2507 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2508 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2509 This mirrors the optional behavior of tcsh."
2510 :type
'(choice (const :tag
"None" nil
)
2511 (const :tag
"Add /" t
)
2512 (cons :tag
"Suffix pair"
2513 (string :tag
"Directory suffix")
2514 (string :tag
"File suffix")))
2515 :group
'comint-completion
)
2517 (defcustom comint-completion-recexact nil
2518 "*If non-nil, use shortest completion if characters cannot be added.
2519 This mirrors the optional behavior of tcsh.
2521 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2523 :group
'comint-completion
)
2525 (defcustom comint-completion-fignore nil
2526 "*List of suffixes to be disregarded during file completion.
2527 This mirrors the optional behavior of bash and tcsh.
2529 Note that this applies to `comint-dynamic-complete-filename' only."
2530 :type
'(repeat (string :tag
"Suffix"))
2531 :group
'comint-completion
)
2533 (defvar comint-file-name-prefix
""
2534 "Prefix prepended to absolute file names taken from process input.
2535 This is used by comint's and shell's completion functions, and by shell's
2536 directory tracking functions.")
2538 (defvar comint-file-name-chars
2539 (if (memq system-type
'(ms-dos windows-nt cygwin
))
2540 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2541 "~/A-Za-z0-9+@:_.$#%,={}-")
2542 "String of characters valid in a file name.
2543 Note that all non-ASCII characters are considered valid in a file name
2544 regardless of what this variable says.
2546 This is a good thing to set in mode hooks.")
2548 (defvar comint-file-name-quote-list nil
2549 "List of characters to quote with `\\' when in a file name.
2551 This is a good thing to set in mode hooks.")
2554 (defun comint-directory (directory)
2555 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2556 (expand-file-name (if (file-name-absolute-p directory
)
2557 (concat comint-file-name-prefix directory
)
2561 (defun comint-word (word-chars)
2562 "Return the word of WORD-CHARS at point, or nil if non is found.
2563 Word constituents are considered to be those in WORD-CHARS, which is like the
2564 inside of a \"[...]\" (see `skip-chars-forward'),
2565 plus all non-ASCII characters."
2567 (let ((non-word-chars (concat "[^\\\\" word-chars
"]")) (here (point)))
2568 (while (and (re-search-backward non-word-chars nil
'move
)
2569 ;;(memq (char-after (point)) shell-file-name-quote-list)
2570 (or (>= (following-char) 128)
2571 (eq (preceding-char) ?
\\)))
2573 ;; Don't go forward over a word-char (this can happen if we're at bob).
2574 (when (or (not (bobp)) (looking-at non-word-chars
))
2576 ;; Set match-data to match the entire string.
2577 (when (< (point) here
)
2578 (set-match-data (list (point) here
))
2579 (match-string 0)))))
2581 (defun comint-substitute-in-file-name (filename)
2582 "Return FILENAME with environment variables substituted.
2583 Supports additional environment variable syntax of the command
2584 interpreter (e.g., the percent notation of cmd.exe on NT)."
2585 (let ((name (substitute-in-file-name filename
)))
2586 (if (memq system-type
'(ms-dos windows-nt
))
2590 (while (string-match "%\\([^\\\\/]*\\)%" name
)
2592 (substring name
(match-beginning 1) (match-end 1)))
2593 (setq env-var-val
(if (getenv env-var-name
)
2594 (getenv env-var-name
)
2596 (setq name
(replace-match env-var-val t t name
))))))
2599 (defun comint-match-partial-filename ()
2600 "Return the filename at point, or nil if non is found.
2601 Environment variables are substituted. See `comint-word'."
2602 (let ((filename (comint-word comint-file-name-chars
)))
2603 (and filename
(comint-substitute-in-file-name
2604 (comint-unquote-filename filename
)))))
2607 (defun comint-quote-filename (filename)
2608 "Return FILENAME with magic characters quoted.
2609 Magic characters are those in `comint-file-name-quote-list'."
2610 (if (null comint-file-name-quote-list
)
2613 (format "\\(^\\|[^\\]\\)\\([%s]\\)"
2614 (mapconcat 'char-to-string comint-file-name-quote-list
""))))
2616 (while (string-match regexp filename
)
2617 (setq filename
(replace-match "\\1\\\\\\2" nil nil filename
)))
2620 (defun comint-unquote-filename (filename)
2621 "Return FILENAME with quoted characters unquoted."
2622 (if (null comint-file-name-quote-list
)
2626 (while (string-match "\\\\\\(.\\)" filename i
)
2627 (setq filename
(replace-match "\\1" nil nil filename
))
2628 (setq i
(+ 1 (match-beginning 0)))))
2632 (defun comint-dynamic-complete ()
2633 "Dynamically perform completion at point.
2634 Calls the functions in `comint-dynamic-complete-functions' to perform
2635 completion until a function returns non-nil, at which point completion is
2636 assumed to have occurred."
2638 (run-hook-with-args-until-success 'comint-dynamic-complete-functions
))
2641 (defun comint-dynamic-complete-filename ()
2642 "Dynamically complete the filename at point.
2643 Completes if after a filename. See `comint-match-partial-filename' and
2644 `comint-dynamic-complete-as-filename'.
2645 This function is similar to `comint-replace-by-expanded-filename', except that
2646 it won't change parts of the filename already entered in the buffer; it just
2647 adds completion characters to the end of the filename. A completions listing
2648 may be shown in a help buffer if completion is ambiguous.
2650 Completion is dependent on the value of `comint-completion-addsuffix',
2651 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2652 completions listing is dependent on the value of `comint-completion-autolist'.
2654 Returns t if successful."
2656 (when (comint-match-partial-filename)
2657 (unless (window-minibuffer-p (selected-window))
2658 (message "Completing file name..."))
2659 (comint-dynamic-complete-as-filename)))
2661 (defun comint-dynamic-complete-as-filename ()
2662 "Dynamically complete at point as a filename.
2663 See `comint-dynamic-complete-filename'. Returns t if successful."
2664 (let* ((completion-ignore-case (memq system-type
'(ms-dos windows-nt cygwin
)))
2665 (completion-ignored-extensions comint-completion-fignore
)
2666 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2667 ;; I think it was originally bound to solve file completion problems,
2668 ;; but subsequent changes may have made this unnecessary. sm.
2669 ;;(file-name-handler-alist nil)
2670 (minibuffer-p (window-minibuffer-p (selected-window)))
2672 (dirsuffix (cond ((not comint-completion-addsuffix
)
2674 ((not (consp comint-completion-addsuffix
))
2675 (char-to-string directory-sep-char
))
2677 (car comint-completion-addsuffix
))))
2678 (filesuffix (cond ((not comint-completion-addsuffix
)
2680 ((not (consp comint-completion-addsuffix
))
2683 (cdr comint-completion-addsuffix
))))
2684 (filename (or (comint-match-partial-filename) ""))
2685 (pathdir (file-name-directory filename
))
2686 (pathnondir (file-name-nondirectory filename
))
2687 (directory (if pathdir
(comint-directory pathdir
) default-directory
))
2688 (completion (file-name-completion pathnondir directory
)))
2689 (cond ((null completion
)
2690 (message "No completions of %s" filename
)
2692 ((eq completion t
) ; Means already completed "file".
2694 (unless minibuffer-p
2695 (message "Sole completion")))
2696 ((string-equal completion
"") ; Means completion on "directory/".
2697 (comint-dynamic-list-filename-completions))
2698 (t ; Completion string returned.
2699 (let ((file (concat (file-name-as-directory directory
) completion
)))
2700 (insert (comint-quote-filename
2701 (substring (directory-file-name completion
)
2702 (length pathnondir
))))
2703 (cond ((symbolp (file-name-completion completion directory
))
2704 ;; We inserted a unique completion.
2705 (insert (if (file-directory-p file
) dirsuffix filesuffix
))
2706 (unless minibuffer-p
2707 (message "Completed")))
2708 ((and comint-completion-recexact comint-completion-addsuffix
2709 (string-equal pathnondir completion
)
2710 (file-exists-p file
))
2711 ;; It's not unique, but user wants shortest match.
2712 (insert (if (file-directory-p file
) dirsuffix filesuffix
))
2713 (unless minibuffer-p
2714 (message "Completed shortest")))
2715 ((or comint-completion-autolist
2716 (string-equal pathnondir completion
))
2717 ;; It's not unique, list possible completions.
2718 (comint-dynamic-list-filename-completions))
2720 (unless minibuffer-p
2721 (message "Partially completed")))))))
2725 (defun comint-replace-by-expanded-filename ()
2726 "Dynamically expand and complete the filename at point.
2727 Replace the filename with an expanded, canonicalised and completed replacement.
2728 \"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
2729 with the corresponding directories. \"Canonicalised\" means `..' and `.' are
2730 removed, and the filename is made absolute instead of relative. For expansion
2731 see `expand-file-name' and `substitute-in-file-name'. For completion see
2732 `comint-dynamic-complete-filename'."
2734 (let ((filename (comint-match-partial-filename)))
2736 (replace-match (expand-file-name filename
) t t
)
2737 (comint-dynamic-complete-filename))))
2740 (defun comint-dynamic-simple-complete (stub candidates
)
2741 "Dynamically complete STUB from CANDIDATES list.
2742 This function inserts completion characters at point by completing STUB from
2743 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2744 if completion is ambiguous.
2746 Returns nil if no completion was inserted.
2747 Returns `sole' if completed with the only completion match.
2748 Returns `shortest' if completed with the shortest of the completion matches.
2749 Returns `partial' if completed as far as possible with the completion matches.
2750 Returns `listed' if a completion listing was shown.
2752 See also `comint-dynamic-complete-filename'."
2753 (let* ((completion-ignore-case (memq system-type
'(ms-dos windows-nt cygwin
)))
2754 (suffix (cond ((not comint-completion-addsuffix
) "")
2755 ((not (consp comint-completion-addsuffix
)) " ")
2756 (t (cdr comint-completion-addsuffix
))))
2757 (candidates (mapcar (function (lambda (x) (list x
))) candidates
))
2758 (completions (all-completions stub candidates
)))
2759 (cond ((null completions
)
2760 (message "No completions of %s" stub
)
2762 ((= 1 (length completions
)) ; Gotcha!
2763 (let ((completion (car completions
)))
2764 (if (string-equal completion stub
)
2765 (message "Sole completion")
2766 (insert (substring completion
(length stub
)))
2767 (message "Completed"))
2770 (t ; There's no unique completion.
2771 (let ((completion (try-completion stub candidates
)))
2772 ;; Insert the longest substring.
2773 (insert (substring completion
(length stub
)))
2774 (cond ((and comint-completion-recexact comint-completion-addsuffix
2775 (string-equal stub completion
)
2776 (member completion completions
))
2777 ;; It's not unique, but user wants shortest match.
2779 (message "Completed shortest")
2781 ((or comint-completion-autolist
2782 (string-equal stub completion
))
2783 ;; It's not unique, list possible completions.
2784 (comint-dynamic-list-completions completions
)
2787 (message "Partially completed")
2791 (defun comint-dynamic-list-filename-completions ()
2792 "List in help buffer possible completions of the filename at point."
2794 (let* ((completion-ignore-case (memq system-type
'(ms-dos windows-nt cygwin
)))
2795 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2796 ;; I think it was originally bound to solve file completion problems,
2797 ;; but subsequent changes may have made this unnecessary. sm.
2798 ;;(file-name-handler-alist nil)
2799 (filename (or (comint-match-partial-filename) ""))
2800 (pathdir (file-name-directory filename
))
2801 (pathnondir (file-name-nondirectory filename
))
2802 (directory (if pathdir
(comint-directory pathdir
) default-directory
))
2803 (completions (file-name-all-completions pathnondir directory
)))
2804 (if (not completions
)
2805 (message "No completions of %s" filename
)
2806 (comint-dynamic-list-completions
2807 (mapcar 'comint-quote-filename completions
)))))
2810 ;; This is bound locally in a *Completions* buffer to the list of
2811 ;; completions displayed, and is used to detect the case where the same
2812 ;; command is repeatedly used without the set of completions changing.
2813 (defvar comint-displayed-dynamic-completions nil
)
2815 (defun comint-dynamic-list-completions (completions)
2816 "List in help buffer sorted COMPLETIONS.
2817 Typing SPC flushes the help buffer."
2818 (let ((window (get-buffer-window "*Completions*")))
2819 (setq completions
(sort completions
'string-lessp
))
2820 (if (and (eq last-command this-command
)
2821 window
(window-live-p window
) (window-buffer window
)
2822 (buffer-name (window-buffer window
))
2823 ;; The above tests are not sufficient to detect the case where we
2824 ;; should scroll, because the top-level interactive command may
2825 ;; not have displayed a completions window the last time it was
2826 ;; invoked, and there may be such a window left over from a
2827 ;; previous completion command with a different set of
2828 ;; completions. To detect that case, we also test that the set
2829 ;; of displayed completions is in fact the same as the previously
2832 (buffer-local-value 'comint-displayed-dynamic-completions
2833 (window-buffer window
))))
2834 ;; If this command was repeated, and
2835 ;; there's a fresh completion window with a live buffer,
2836 ;; and this command is repeated, scroll that window.
2837 (with-current-buffer (window-buffer window
)
2838 (if (pos-visible-in-window-p (point-max) window
)
2839 (set-window-start window
(point-min))
2840 (save-selected-window
2841 (select-window window
)
2844 (let ((conf (current-window-configuration)))
2845 (with-output-to-temp-buffer "*Completions*"
2846 (display-completion-list completions
))
2847 (message "Type space to flush; repeat completion command to scroll")
2850 (set-buffer (get-buffer "*Completions*"))
2851 (set (make-local-variable
2852 'comint-displayed-dynamic-completions
)
2854 (setq key
(read-key-sequence nil
)
2856 (and (consp first
) (consp (event-start first
))
2857 (eq (window-buffer (posn-window (event-start first
)))
2858 (get-buffer "*Completions*"))
2859 (eq (key-binding key
) 'mouse-choose-completion
)))
2860 ;; If the user does mouse-choose-completion with the mouse,
2861 ;; execute the command, then delete the completion window.
2863 (mouse-choose-completion first
)
2864 (set-window-configuration conf
))
2866 (set-window-configuration conf
)
2867 (setq unread-command-events
(listify-key-sequence key
)))))))))
2870 (defun comint-get-next-from-history ()
2871 "After fetching a line from input history, this fetches the following line.
2872 In other words, this recalls the input line after the line you recalled last.
2873 You can use this to repeat a sequence of input lines."
2875 (if comint-save-input-ring-index
2877 (setq comint-input-ring-index
(1+ comint-save-input-ring-index
))
2878 (comint-next-input 1))
2879 (message "No previous history command")))
2881 (defun comint-accumulate ()
2882 "Accumulate a line to send as input along with more lines.
2883 This inserts a newline so that you can enter more text
2884 to be sent along with this line. Use \\[comint-send-input]
2885 to send all the accumulated input, at once.
2886 The entire accumulated text becomes one item in the input history
2890 (set-marker comint-accum-marker
(point))
2891 (if comint-input-ring-index
2892 (setq comint-save-input-ring-index
2893 (- comint-input-ring-index
1))))
2895 (defun comint-goto-process-mark ()
2896 "Move point to the process mark.
2897 The process mark separates output, and input already sent,
2898 from input that has not yet been sent."
2900 (let ((proc (or (get-buffer-process (current-buffer))
2901 (error "Current buffer has no process"))))
2902 (goto-char (process-mark proc
))
2903 (when (interactive-p)
2904 (message "Point is now at the process mark"))))
2906 (defun comint-bol-or-process-mark ()
2907 "Move point to beginning of line (after prompt) or to the process mark.
2908 The first time you use this command, it moves to the beginning of the line
2909 \(but after the prompt, if any). If you repeat it again immediately,
2910 it moves point to the process mark.
2912 The process mark separates the process output, along with input already sent,
2913 from input that has not yet been sent. Ordinarily, the process mark
2914 is at the beginning of the current input line; but if you have
2915 used \\[comint-accumulate] to send multiple lines at once,
2916 the process mark is at the beginning of the accumulated input."
2918 (if (not (eq last-command
'comint-bol-or-process-mark
))
2920 (comint-goto-process-mark)))
2922 (defun comint-set-process-mark ()
2923 "Set the process mark at point."
2925 (let ((proc (or (get-buffer-process (current-buffer))
2926 (error "Current buffer has no process"))))
2927 (set-marker (process-mark proc
) (point))
2928 (message "Process mark set")))
2931 ;; Author: Peter Breton <pbreton@cs.umb.edu>
2933 ;; This little add-on for comint is intended to make it easy to get
2934 ;; output from currently active comint buffers into another buffer,
2935 ;; or buffers, and then go back to using the comint shell.
2937 ;; My particular use is SQL interpreters; I want to be able to execute a
2938 ;; query using the process associated with a comint-buffer, and save that
2939 ;; somewhere else. Because the process might have state (for example, it
2940 ;; could be in an uncommitted transaction), just running starting a new
2941 ;; process and having it execute the query and then finish, would not
2942 ;; work. I'm sure there are other uses as well, although in many cases
2943 ;; starting a new process is the simpler, and thus preferable, approach.
2945 ;; The basic implementation is as follows: comint-redirect changes the
2946 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2947 ;; its own filter. The filter puts the output into the designated buffer,
2948 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2949 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2950 ;; sees the stop regexp, it restores the old filter functions, and runs
2951 ;; comint-redirect-hook.
2953 ;; Each comint buffer may only use one redirection at a time, but any number
2954 ;; of different comint buffers may be simultaneously redirected.
2956 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2957 ;; correct prompt for your interpreter, or that you supply a regexp that says
2958 ;; when the redirection is finished. Otherwise, redirection will continue
2959 ;; indefinitely. The code now does a sanity check to ensure that it can find
2960 ;; a prompt in the comint buffer; however, it is still important to ensure that
2961 ;; this prompt is set correctly.
2963 ;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2964 ;; perhaps it should prompt for a terminating string (with an
2965 ;; appropriate magic default by examining what we think is the prompt)?
2968 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2970 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2972 (defcustom comint-redirect-verbose nil
2973 "*If non-nil, print messages each time the redirection filter is invoked.
2974 Also print a message when redirection is completed."
2978 ;; Directly analagous to comint-preoutput-filter-functions
2979 (defvar comint-redirect-filter-functions nil
2980 "List of functions to call before inserting redirected process output.
2981 Each function gets one argument, a string containing the text received
2982 from the subprocess. It should return the string to insert, perhaps
2983 the same string that was received, or perhaps a modified or transformed
2986 The functions on the list are called sequentially, and each one is given
2987 the string returned by the previous one. The string returned by the
2988 last function is the text that is actually inserted in the redirection buffer.
2990 You can use `add-hook' to add functions to this list
2991 either globally or locally.")
2993 ;; Internal variables
2995 (defvar comint-redirect-output-buffer nil
2996 "The buffer or list of buffers to put output into.")
2998 (defvar comint-redirect-finished-regexp nil
2999 "Regular expression that determines when to stop redirection in Comint.
3000 When the redirection filter function is given output that matches this regexp,
3001 the output is inserted as usual, and redirection is completed.")
3003 (defvar comint-redirect-insert-matching-regexp nil
3004 "If non-nil, the text that ends a redirection is included in it.
3005 More precisely, the text that matches `comint-redirect-finished-regexp'
3006 and therefore terminates an output redirection is inserted in the
3007 redirection target buffer, along with the preceding output.")
3009 (defvar comint-redirect-echo-input nil
3010 "Non-nil means echo input in the process buffer even during redirection.")
3012 (defvar comint-redirect-completed nil
3013 "Non-nil if redirection has completed in the current buffer.")
3015 (defvar comint-redirect-original-mode-line-process nil
3016 "Original mode line for redirected process.")
3018 (defvar comint-redirect-perform-sanity-check t
3019 "If non-nil, check that redirection is likely to complete successfully.
3020 More precisely, before starting a redirection, verify that the
3021 regular expression `comint-redirect-finished-regexp' that controls
3022 when to terminate it actually matches some text already in the process
3023 buffer. The idea is that this regular expression should match a prompt
3024 string, and that there ought to be at least one copy of your prompt string
3025 in the process buffer already.")
3027 (defvar comint-redirect-original-filter-function nil
3028 "The process filter that was in place when redirection is started.
3029 When redirection is completed, the process filter is restored to
3032 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3034 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3036 (defun comint-redirect-setup (output-buffer
3039 &optional echo-input
)
3040 "Set up for output redirection.
3041 This function sets local variables that are used by `comint-redirect-filter'
3042 to perform redirection.
3044 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3045 in the output matches FINISHED-REGEXP.
3047 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3048 original comint buffer.
3050 This function is called by `comint-redirect-send-command-to-process',
3051 and does not normally need to be invoked by the end user or programmer."
3052 (with-current-buffer comint-buffer
3054 (make-local-variable 'comint-redirect-original-mode-line-process
)
3055 (setq comint-redirect-original-mode-line-process mode-line-process
)
3057 (make-local-variable 'comint-redirect-output-buffer
)
3058 (setq comint-redirect-output-buffer output-buffer
)
3060 (make-local-variable 'comint-redirect-finished-regexp
)
3061 (setq comint-redirect-finished-regexp finished-regexp
)
3063 (make-local-variable 'comint-redirect-echo-input
)
3064 (setq comint-redirect-echo-input echo-input
)
3066 (make-local-variable 'comint-redirect-completed
)
3067 (setq comint-redirect-completed nil
)
3069 (setq mode-line-process
3070 (if mode-line-process
3071 (list (concat (elt mode-line-process
0) " Redirection"))
3072 (list ":%s Redirection")))))
3074 (defun comint-redirect-cleanup ()
3075 "End a Comint redirection. See `comint-redirect-send-command'."
3077 ;; Restore the process filter
3078 (set-process-filter (get-buffer-process (current-buffer))
3079 comint-redirect-original-filter-function
)
3080 ;; Restore the mode line
3081 (setq mode-line-process comint-redirect-original-mode-line-process
)
3082 ;; Set the completed flag
3083 (setq comint-redirect-completed t
))
3085 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3086 ;; that it really occurs.
3087 (defalias 'comint-redirect-remove-redirection
'comint-redirect-cleanup
)
3089 (defun comint-redirect-filter (process input-string
)
3090 "Filter function which redirects output from PROCESS to a buffer or buffers.
3091 The variable `comint-redirect-output-buffer' says which buffer(s) to
3094 INPUT-STRING is the input from the comint process.
3096 This function runs as a process filter, and does not need to be invoked by the
3099 (with-current-buffer (process-buffer process
)
3100 (comint-redirect-preoutput-filter input-string
)
3101 ;; If we have to echo output, give it to the original filter function
3102 (and comint-redirect-echo-input
3103 comint-redirect-original-filter-function
3104 (funcall comint-redirect-original-filter-function
3105 process input-string
)))))
3108 (defun comint-redirect-preoutput-filter (input-string)
3109 "Comint filter function which redirects comint output to a buffer or buffers.
3110 The variable `comint-redirect-output-buffer' says which buffer(s) to
3113 INPUT-STRING is the input from the comint process.
3115 This function does not need to be invoked by the end user."
3116 (let ((output-buffer-list
3117 (if (listp comint-redirect-output-buffer
)
3118 comint-redirect-output-buffer
3119 (list comint-redirect-output-buffer
)))
3120 (filtered-input-string input-string
))
3122 ;; If there are any filter functions, give them a chance to modify the string
3123 (let ((functions comint-redirect-filter-functions
))
3124 (while (and functions filtered-input-string
)
3125 (if (eq (car functions
) t
)
3126 ;; If a local value says "use the default value too",
3128 (let ((functions (default-value 'comint-redirect-filter-functions
)))
3129 (while (and functions filtered-input-string
)
3130 (setq filtered-input-string
3131 (funcall (car functions
) filtered-input-string
))
3132 (setq functions
(cdr functions
))))
3133 (setq filtered-input-string
3134 (funcall (car functions
) filtered-input-string
)))
3135 (setq functions
(cdr functions
))))
3137 ;; Clobber `comint-redirect-finished-regexp'
3138 (or comint-redirect-insert-matching-regexp
3139 (and (string-match comint-redirect-finished-regexp filtered-input-string
)
3140 (setq filtered-input-string
3141 (replace-match "" nil nil filtered-input-string
))))
3143 ;; Send output to all registered buffers
3146 (function (lambda(buf)
3147 ;; Set this buffer to the output buffer
3148 (set-buffer (get-buffer-create buf
))
3149 ;; Go to the end of the buffer
3150 (goto-char (point-max))
3151 ;; Insert the output
3152 (insert filtered-input-string
)))
3153 output-buffer-list
))
3156 (and comint-redirect-verbose
3157 (message "Redirected output to buffer(s) %s"
3158 (mapconcat 'identity output-buffer-list
" ")))
3160 ;; If we see the prompt, tidy up
3161 ;; We'll look for the prompt in the original string, so nobody can
3163 (and (string-match comint-redirect-finished-regexp input-string
)
3165 (and comint-redirect-verbose
3166 (message "Redirection completed"))
3167 (comint-redirect-cleanup)
3168 (run-hooks 'comint-redirect-hook
)))
3170 (if comint-redirect-echo-input
3171 filtered-input-string
3175 (defun comint-redirect-send-command (command output-buffer echo
&optional no-display
)
3176 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3177 With prefix arg, echo output in process buffer.
3179 If NO-DISPLAY is non-nil, do not show the output buffer."
3180 (interactive "sCommand: \nBOutput Buffer: \nP")
3181 (let ((process (get-buffer-process (current-buffer))))
3183 (comint-redirect-send-command-to-process
3184 command output-buffer
(current-buffer) echo no-display
)
3185 (error "No process for current buffer"))))
3188 (defun comint-redirect-send-command-to-process
3189 (command output-buffer process echo
&optional no-display
)
3190 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3191 With prefix arg, echo output in process buffer.
3193 If NO-DISPLAY is non-nil, do not show the output buffer."
3194 (interactive "sCommand: \nBOutput Buffer: \nbProcess Buffer: \nP")
3195 (let* (;; The process buffer
3196 (process-buffer (if (processp process
)
3197 (process-buffer process
)
3199 (proc (get-buffer-process process-buffer
)))
3200 ;; Change to the process buffer
3201 (with-current-buffer process-buffer
3203 ;; Make sure there's a prompt in the current process buffer
3204 (and comint-redirect-perform-sanity-check
3206 (goto-char (point-max))
3207 (or (re-search-backward comint-prompt-regexp nil t
)
3208 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3210 ;;;;;;;;;;;;;;;;;;;;;
3211 ;; Set up for redirection
3212 ;;;;;;;;;;;;;;;;;;;;;
3213 (comint-redirect-setup
3219 comint-prompt-regexp
3223 ;;;;;;;;;;;;;;;;;;;;;
3225 ;;;;;;;;;;;;;;;;;;;;;
3226 ;; Save the old filter
3227 (setq comint-redirect-original-filter-function
3228 (process-filter proc
))
3229 (set-process-filter proc
'comint-redirect-filter
)
3231 ;;;;;;;;;;;;;;;;;;;;;
3233 ;;;;;;;;;;;;;;;;;;;;;
3234 (process-send-string
3236 (concat command
"\n"))
3238 ;;;;;;;;;;;;;;;;;;;;;
3240 ;;;;;;;;;;;;;;;;;;;;;
3244 (if (listp output-buffer
)
3246 output-buffer
)))))))
3249 (defun comint-redirect-results-list (command regexp regexp-group
)
3250 "Send COMMAND to current process.
3251 Return a list of expressions in the output which match REGEXP.
3252 REGEXP-GROUP is the regular expression group in REGEXP to use."
3253 (comint-redirect-results-list-from-process
3254 (get-buffer-process (current-buffer))
3255 command regexp regexp-group
))
3258 (defun comint-redirect-results-list-from-process (process command regexp regexp-group
)
3259 "Send COMMAND to PROCESS.
3260 Return a list of expressions in the output which match REGEXP.
3261 REGEXP-GROUP is the regular expression group in REGEXP to use."
3262 (let ((output-buffer " *Comint Redirect Work Buffer*")
3265 (set-buffer (get-buffer-create output-buffer
))
3267 (comint-redirect-send-command-to-process command
3268 output-buffer process nil t
)
3269 ;; Wait for the process to complete
3270 (set-buffer (process-buffer process
))
3271 (while (null comint-redirect-completed
)
3272 (accept-process-output nil
1))
3273 ;; Collect the output
3274 (set-buffer output-buffer
)
3275 (goto-char (point-min))
3276 ;; Skip past the command, if it was echoed
3277 (and (looking-at command
)
3279 (while (re-search-forward regexp nil t
)
3281 (cons (buffer-substring-no-properties
3282 (match-beginning regexp-group
)
3283 (match-end regexp-group
))
3288 (add-to-list 'debug-ignored-errors x
))
3289 '("^Not at command line$"
3290 "^Empty input ring$"
3292 "^Not found$" ; Too common?
3293 "^Current buffer has no process$"))
3296 ;; Converting process modes to use comint mode
3297 ;; ===========================================================================
3298 ;; The code in the Emacs 19 distribution has all been modified to use comint
3299 ;; where needed. However, there are `third-party' packages out there that
3300 ;; still use the old shell mode. Here's a guide to conversion.
3302 ;; Renaming variables
3303 ;; Most of the work is renaming variables and functions. These are the common
3306 ;; last-input-start comint-last-input-start
3307 ;; last-input-end comint-last-input-end
3308 ;; shell-prompt-pattern comint-prompt-regexp
3309 ;; shell-set-directory-error-hook <no equivalent>
3311 ;; shell-set-directory <unnecessary>
3312 ;; shell-mode-map comint-mode-map
3314 ;; shell-send-input comint-send-input
3315 ;; shell-send-eof comint-delchar-or-maybe-eof
3316 ;; kill-shell-input comint-kill-input
3317 ;; interrupt-shell-subjob comint-interrupt-subjob
3318 ;; stop-shell-subjob comint-stop-subjob
3319 ;; quit-shell-subjob comint-quit-subjob
3320 ;; kill-shell-subjob comint-kill-subjob
3321 ;; kill-output-from-shell comint-delete-output
3322 ;; show-output-from-shell comint-show-output
3323 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3325 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3326 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3327 ;; Comint mode does not provide functionality equivalent to
3328 ;; shell-set-directory-error-hook; it is gone.
3330 ;; comint-last-input-start is provided for modes which want to munge
3331 ;; the buffer after input is sent, perhaps because the inferior
3332 ;; insists on echoing the input. The LAST-INPUT-START variable in
3333 ;; the old shell package was used to implement a history mechanism,
3334 ;; but you should think twice before using comint-last-input-start
3335 ;; for this; the input history ring often does the job better.
3337 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3338 ;; *not* create the comint-mode local variables in your foo-mode function.
3339 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3340 ;; necessary comint-specific local variables. Then create the
3341 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3342 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3343 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3344 ;; get-old-input) that need to be different from the defaults. Call
3345 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3346 ;; comint-mode will take care of it. The following example, from shell.el,
3349 ;; (defvar shell-mode-map '())
3350 ;; (cond ((not shell-mode-map)
3351 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3352 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3353 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3354 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3355 ;; (define-key shell-mode-map "\M-?"
3356 ;; 'comint-dynamic-list-filename-completions)))
3358 ;; (defun shell-mode ()
3361 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3362 ;; (setq major-mode 'shell-mode)
3363 ;; (setq mode-name "Shell")
3364 ;; (use-local-map shell-mode-map)
3365 ;; (make-local-variable 'shell-directory-stack)
3366 ;; (setq shell-directory-stack nil)
3367 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3368 ;; (run-hooks 'shell-mode-hook))
3371 ;; Completion for comint-mode users
3373 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3374 ;; hook to add completion functions to. Functions on this list should return
3375 ;; non-nil if completion occurs (i.e., further completion should not occur).
3376 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3382 ;;; comint.el ends here
HCoop / bpt / emacs.git / blob