| blob | feb0bb83de30f769b14a73626fa2b1beb81dd006 |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 1990, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
6 ;; Author: Olin Shivers <shivers@cs.cmu.edu>
7 ;; Simon Marshall <simon@gnu.org>
8 ;; Maintainer: FSF
9 ;; Keywords: processes
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
28 ;;; Commentary:
30 ;; This file defines a general command-interpreter-in-a-buffer package
31 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
32 ;; modes on top of comint mode -- e.g., Lisp, shell, scheme, T, soar, ....
33 ;; This way, all these specific packages share a common base functionality,
34 ;; and a common set of bindings, which makes them easier to use (and
35 ;; saves code, implementation time, etc., etc.).
37 ;; Several packages are already defined using comint mode:
38 ;; - shell.el defines a shell-in-a-buffer mode.
39 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
40 ;;
41 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
42 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
43 ;; - The file soar.el tunes Lisp and inferior-lisp modes for Soar.
44 ;; - cmutex.el defines TeX and LaTeX modes that invoke TeX, LaTeX, BibTeX,
45 ;; previewers, and printers from within Emacs.
46 ;; - background.el allows csh-like job control inside Emacs.
47 ;; It is pretty easy to make new derived modes for other processes.
49 ;; For documentation on the functionality provided by Comint mode, and
50 ;; the hooks available for customising it, see the comments below.
51 ;; For further information on the standard derived modes (shell,
52 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
54 ;; For hints on converting existing process modes (e.g., tex-mode,
55 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
56 ;; instead of shell-mode, see the notes at the end of this file.
58 \f
59 ;; Brief Command Documentation:
60 ;;============================================================================
61 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
62 ;; mode)
63 ;;
64 ;; M-p comint-previous-input Cycle backwards in input history
65 ;; M-n comint-next-input Cycle forwards
66 ;; M-r comint-previous-matching-input Previous input matching a regexp
67 ;; M-s comint-next-matching-input Next input that matches
68 ;; M-C-l comint-show-output Show last batch of process output
69 ;; RET comint-send-input
70 ;; C-d comint-delchar-or-maybe-eof Delete char unless at end of buff
71 ;; C-c C-a comint-bol-or-process-mark First time, move point to bol;
72 ;; second time, move to process-mark.
73 ;; C-c C-u comint-kill-input ^u
74 ;; C-c C-w backward-kill-word ^w
75 ;; C-c C-c comint-interrupt-subjob ^c
76 ;; C-c C-z comint-stop-subjob ^z
77 ;; C-c C-\ comint-quit-subjob ^\
78 ;; C-c C-o comint-delete-output Delete last batch of process output
79 ;; C-c C-r comint-show-output Show last batch of process output
80 ;; C-c C-l comint-dynamic-list-input-ring List input history
81 ;;
82 ;; Not bound by default in comint-mode (some are in shell mode)
83 ;; comint-run Run a program under comint-mode
84 ;; send-invisible Read a line w/o echo, and send to proc
85 ;; comint-dynamic-complete-filename Complete filename at point.
86 ;; comint-dynamic-list-filename-completions List completions in help buffer.
87 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
88 ;; replace with expanded/completed name.
89 ;; comint-replace-by-expanded-history Expand history at point;
90 ;; replace with expanded name.
91 ;; comint-magic-space Expand history and add (a) space(s).
92 ;; comint-kill-subjob No mercy.
93 ;; comint-show-maximum-output Show as much output as possible.
94 ;; comint-continue-subjob Send CONT signal to buffer's process
95 ;; group. Useful if you accidentally
96 ;; suspend your process (with C-c C-z).
97 ;; comint-get-next-from-history Fetch successive input history lines
98 ;; comint-accumulate Combine lines to send them together
99 ;; as input.
100 ;; comint-goto-process-mark Move point to where process-mark is.
101 ;; comint-set-process-mark Set process-mark to point.
103 ;; comint-mode-hook is the Comint mode hook. Basically for your keybindings.
105 ;;; Code:
108 \f
109 ;; Buffer Local Variables:
110 ;;============================================================================
111 ;; Comint mode buffer local variables:
112 ;; comint-prompt-regexp string comint-bol uses to match prompt
113 ;; comint-delimiter-argument-list list For delimiters and arguments
114 ;; comint-last-input-start marker Handy if inferior always echoes
115 ;; comint-last-input-end marker For comint-delete-output command
116 ;; comint-input-ring-size integer For the input history
117 ;; comint-input-ring ring mechanism
118 ;; comint-input-ring-index number ...
119 ;; comint-save-input-ring-index number ...
120 ;; comint-input-autoexpand symbol ...
121 ;; comint-input-ignoredups boolean ...
122 ;; comint-dynamic-complete-functions hook For the completion mechanism
123 ;; comint-completion-fignore list ...
124 ;; comint-file-name-chars string ...
125 ;; comint-file-name-quote-list list ...
126 ;; comint-get-old-input function Hooks for specific
127 ;; comint-input-filter-functions hook process-in-a-buffer
128 ;; comint-output-filter-functions hook function modes.
129 ;; comint-preoutput-filter-functions hook
130 ;; comint-input-filter function ...
131 ;; comint-input-sender function ...
132 ;; comint-eol-on-send boolean ...
133 ;; comint-process-echoes boolean ...
134 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
135 ;; comint-scroll-to-bottom-on-output symbol ...
136 ;; comint-scroll-show-maximum-output boolean ...
137 ;; comint-accum-marker maker For comint-accumulate
138 ;;
139 ;; Comint mode non-buffer local variables:
140 ;; comint-completion-addsuffix boolean/cons For file name
141 ;; comint-completion-autolist boolean completion behavior
142 ;; comint-completion-recexact boolean ...
145 "General command interpreter in a window stuff."
149 "Completion facilities in comint"
153 "Source finding facilities in comint"
158 "Regexp to recognise prompts in the inferior process.
161 This variable is only used if the variable
162 `comint-use-prompt-regexp-instead-of-fields' is non-nil.
164 Good choices:
175 "If non-nil, the comint prompt is read only.
176 The read only region includes the newline before the prompt.
177 This does not affect existing prompts.
178 Certain derived modes may override this option.
180 If you set this option to t, then the safe way to temporarily
181 override the read-only-ness of comint prompts is to call
182 `comint-kill-whole-line' or `comint-kill-region' with no
183 narrowing in effect. This way you will be certain that none of
184 the remaining prompts will be accidentally messed up. You may
185 wish to put something like the following in your `.emacs' file:
187 \(add-hook 'comint-mode-hook
188 (lambda ()
190 (define-key comint-mode-map [C-S-backspace]
191 'comint-kill-whole-line)))
193 If you sometimes use comint-mode on text-only terminals or with `emacs-nw',
194 you might wish to use another binding for `comint-kill-whole-line'."
200 "List of characters to recognise as separate arguments in input.
201 Strings comprising a character in this list will separate the arguments
202 surrounding them, and also be regarded as arguments in their own right (unlike
203 whitespace). See `comint-arguments'.
204 Defaults to the empty list.
211 "*If non-nil, expand input command history references on completion.
212 This mirrors the optional behavior of tcsh (its autoexpand and histlist).
214 If the value is `input', then the expansion is seen on input.
215 If the value is `history', then the expansion is only when inserting
216 into the buffer's input ring. See also `comint-magic-space' and
217 `comint-dynamic-complete'.
219 This variable is buffer-local."
227 "Face to use to highlight user input."
233 "Face to use to highlight prompts."
237 "*If non-nil, don't add input matching the last on the input ring.
238 This mirrors the optional behavior of bash.
240 This variable is buffer-local."
245 "*If non-nil, name of the file to read/write input history.
246 See also `comint-read-input-ring' and `comint-write-input-ring'.
248 This variable is buffer-local, and is a good thing to set in mode hooks."
250 file)
254 "*Controls whether input to interpreter causes window to scroll.
255 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
256 If `this', scroll only the selected window.
258 The default is nil.
260 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
268 "*Controls whether interpreter output moves point to the end of the output.
269 If nil, then output never moves point to the output.
270 (If the output occurs at point, it is inserted before point.)
271 If t or `all', move point in all windows showing the buffer.
272 If `this', move point only the selected window.
273 If `others', move point only in other windows, not in the selected window.
275 The default is nil.
277 See the variable `comint-scroll-show-maximum-output' and the function
278 `comint-postoutput-scroll-to-bottom'.
279 This variable is buffer-local in all Comint buffers."
290 "*Controls how to scroll due to interpreter output.
291 This variable applies when point is at the end of the buffer
292 \(either because it was originally there, or because
293 `comint-move-point-for-output' said to move it there)
294 and output from the subprocess is inserted.
296 Non-nil means scroll so that the window is full of text
297 and point is on the last line. A value of nil
298 means don't do anything special--scroll normally.
300 See also the variable `comint-move-point-for-output' and the function
301 `comint-postoutput-scroll-to-bottom'.
302 This variable is buffer-local in all Comint buffers."
307 "*The maximum size in lines for Comint buffers.
308 Comint buffers are truncated from the top to be no greater than this number, if
309 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
323 "*If non-nil, assume that the subprocess echoes any input.
324 If so, delete one copy of the input so that only one copy eventually
325 appears in the buffer.
327 This variable is buffer-local."
331 ;; AIX puts the name of the person being su'd to in front of the prompt.
332 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
333 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
334 ;; ssh-add prints a prompt like `Enter passphrase: '.
335 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
342 "*Regexp matching prompts for passwords in the inferior process.
343 This is used by `comint-watch-for-password-prompt'."
347 ;; Here are the per-interpreter hooks.
349 "Function that returns old text in Comint mode.
350 This function is called when return is typed while the point is in old
351 text. It returns the text to be submitted as process input. The
352 default is `comint-get-old-input-default', which either grabs the
353 current input field or grabs the current line and strips off leading
354 text matching `comint-prompt-regexp', depending on the value of
359 "List of functions called to perform completion.
360 Functions should return non-nil if completion was performed.
361 See also `comint-dynamic-complete'.
367 "Predicate for filtering additions to input history.
368 Takes one argument, the input. If non-nil, the input may be saved on the input
372 "Abnormal hook run before input is sent to the process.
375 (defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom comint-watch-for-password-prompt)
376 "Functions to call after output is inserted into the buffer.
377 One possible function is `comint-postoutput-scroll-to-bottom'.
378 These functions get one argument, a string containing the text as originally
379 inserted. Note that this might not be the same as the buffer contents between
380 `comint-last-output-start' and the buffer's `process-mark', if other filter
381 functions have already modified the buffer.
383 See also `comint-preoutput-filter-functions'.
385 You can use `add-hook' to add functions to this list
392 "Function to actually send to PROCESS the STRING submitted by user.
393 Usually this is just `comint-simple-send', but if your mode needs to
394 massage the input string, put a different function here.
395 `comint-simple-send' just sends the string plus a newline.
396 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
400 "*Non-nil means go to the end of the line before sending input.
401 See `comint-send-input'."
405 ;; Note: If it is decided to purge comint-prompt-regexp from the source
406 ;; entirely, searching for uses of this variable will help to identify
407 ;; places that need attention.
409 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
410 If nil, then program output and user-input are given different `field'
411 properties, which Emacs commands can use to distinguish them (in
412 particular, common movement commands such as begining-of-line respect
413 field boundaries in a natural way)."
418 "Hook run upon entry to `comint-mode'.
419 This is run before the process is cranked up."
424 "Hook run each time a process is exec'd by `comint-exec'.
425 This is called after the process is cranked up. It is useful for things that
426 must be done each time a process is executed in a Comint mode buffer (e.g.,
427 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
428 executed once when the buffer is created."
434 ;; Keys:
464 ;; Mouse Buttons:
466 ;; Menu bars:
467 ;; completion:
478 ;; Input history:
519 ;; Signals
523 (define-key signals-map [kill] '("KILL" . comint-kill-subjob))
524 (define-key signals-map [quit] '("QUIT" . comint-quit-subjob))
525 (define-key signals-map [cont] '("CONT" . comint-continue-subjob))
526 (define-key signals-map [stop] '("STOP" . comint-stop-subjob))
527 (define-key signals-map [break] '("BREAK" . comint-interrupt-subjob)))
528 ;; Put them in the menu bar:
529 (setq menu-bar-final-items (append '(completion inout signals)
530 menu-bar-final-items))
531 map))
533 ;; Fixme: Is this still relevant?
534 (defvar comint-ptyp t
535 "Non-nil if communications via pty; false if by pipe. Buffer local.
536 This is to work around a bug in Emacs process signaling.")
538 (defvar comint-input-ring nil)
539 (defvar comint-last-input-start nil)
540 (defvar comint-last-input-end nil)
541 (defvar comint-last-output-start nil)
542 (defvar comint-input-ring-index nil
543 "Index of last matched history element.")
544 (defvar comint-matching-input-from-input-string ""
545 "Input previously used to match input history.")
546 (defvar comint-save-input-ring-index
547 "Last input ring index which you copied.
550 (defvar comint-accum-marker nil
551 "Non-nil if you are accumulating input lines to send as input together.
554 (put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
555 (put 'comint-input-ring 'permanent-local t)
556 (put 'comint-input-ring-index 'permanent-local t)
557 (put 'comint-save-input-ring-index 'permanent-local t)
558 (put 'comint-input-autoexpand 'permanent-local t)
559 (put 'comint-input-filter-functions 'permanent-local t)
560 (put 'comint-output-filter-functions 'permanent-local t)
561 (put 'comint-preoutput-filter-functions 'permanent-local t)
562 (put 'comint-scroll-to-bottom-on-input 'permanent-local t)
563 (put 'comint-move-point-for-output 'permanent-local t)
564 (put 'comint-scroll-show-maximum-output 'permanent-local t)
565 (put 'comint-ptyp 'permanent-local t)
567 (put 'comint-mode 'mode-class 'special)
569 (define-derived-mode comint-mode fundamental-mode "Comint"
570 "Major mode for interacting with an inferior interpreter.
571 Interpreter name is same as buffer name, sans the asterisks.
572 Return at end of buffer sends line as input.
573 Return not at end copies rest of line to end and sends it.
574 Setting variable `comint-eol-on-send' means jump to the end of the line
575 before submitting new input.
577 This mode is customised to create major modes such as Inferior Lisp
578 mode, Shell mode, etc. This can be done by setting the hooks
579 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
580 and `comint-get-old-input' to appropriate functions, and the variable
581 `comint-prompt-regexp' to the appropriate regular expression.
583 An input history is maintained of size `comint-input-ring-size', and
584 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
585 Input ring history expansion can be achieved with the commands
587 Input ring expansion is controlled by the variable `comint-input-autoexpand',
588 and addition is controlled by the variable `comint-input-ignoredups'.
590 Commands with no default key bindings include `send-invisible',
591 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
592 `comint-magic-space'.
594 Input to, and output from, the subprocess can cause the window to scroll to
595 the end of the buffer. See variables `comint-output-filter-functions',
596 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
597 and `comint-move-point-for-output'.
600 to continue it.
604 Entry to this mode runs the hooks on `comint-mode-hook'."
605 (setq mode-line-process '(":%s"))
606 (set (make-local-variable 'comint-last-input-start) (point-min-marker))
607 (set (make-local-variable 'comint-last-input-end) (point-min-marker))
608 (set (make-local-variable 'comint-last-output-start) (make-marker))
609 (make-local-variable 'comint-last-prompt-overlay)
610 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
611 (make-local-variable 'comint-input-ring-size) ; ...to global val.
612 (make-local-variable 'comint-input-ring)
613 (make-local-variable 'comint-input-ring-file-name)
614 (or (and (boundp 'comint-input-ring) comint-input-ring)
615 (setq comint-input-ring (make-ring comint-input-ring-size)))
616 (make-local-variable 'comint-input-ring-index)
617 (make-local-variable 'comint-save-input-ring-index)
618 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
619 (setq comint-input-ring-index nil))
620 (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
621 (setq comint-save-input-ring-index nil))
622 (make-local-variable 'comint-matching-input-from-input-string)
623 (make-local-variable 'comint-input-autoexpand)
624 (make-local-variable 'comint-input-ignoredups)
625 (make-local-variable 'comint-delimiter-argument-list)
626 (make-local-variable 'comint-completion-fignore)
627 (make-local-variable 'comint-get-old-input)
628 (make-local-variable 'comint-input-filter)
629 (make-local-variable 'comint-input-sender)
630 (make-local-variable 'comint-eol-on-send)
631 (make-local-variable 'comint-scroll-to-bottom-on-input)
632 (make-local-variable 'comint-move-point-for-output)
633 (make-local-variable 'comint-scroll-show-maximum-output)
634 ;; This makes it really work to keep point at the bottom.
635 (make-local-variable 'scroll-conservatively)
636 (setq scroll-conservatively 10000)
637 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
638 (make-local-variable 'comint-ptyp)
639 (make-local-variable 'comint-process-echoes)
640 (make-local-variable 'comint-file-name-chars)
641 (make-local-variable 'comint-file-name-quote-list)
642 (set (make-local-variable 'comint-accum-marker) (make-marker))
643 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
644 ;; This behavior is not useful in comint buffers, and is annoying
645 (set (make-local-variable 'next-line-add-newlines) nil))
647 (defun comint-check-proc (buffer)
648 "Return t if there is a living process associated w/buffer BUFFER.
649 Living means the status is `open', `run', or `stop'.
650 BUFFER can be either a buffer or the name of one."
651 (let ((proc (get-buffer-process buffer)))
652 (and proc (memq (process-status proc) '(open run stop)))))
654 ;;;###autoload
655 (defun make-comint-in-buffer (name buffer program &optional startfile &rest switches)
656 "Make a Comint process NAME in BUFFER, running PROGRAM.
657 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
658 PROGRAM should be either a string denoting an executable program to create
659 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
660 connection to be opened via `open-network-stream'. If there is already a
661 running process in that buffer, it is not restarted. Optional third arg
662 STARTFILE is the name of a file to send the contents of to the process.
664 If PROGRAM is a string, any more args are arguments to PROGRAM."
665 (or (fboundp 'start-process)
666 (error "Multi-processing is not supported for this system"))
667 (setq buffer (get-buffer-create (or buffer (concat "*" name "*"))))
668 ;; If no process, or nuked process, crank up a new one and put buffer in
669 ;; comint mode. Otherwise, leave buffer and existing process alone.
670 (unless (comint-check-proc buffer)
671 (with-current-buffer buffer
672 (unless (derived-mode-p 'comint-mode)
673 (comint-mode))) ; Install local vars, mode, keymap, ...
674 (comint-exec buffer name program startfile switches))
675 buffer)
677 ;;;###autoload
678 (defun make-comint (name program &optional startfile &rest switches)
679 "Make a Comint process NAME in a buffer, running PROGRAM.
680 The name of the buffer is made by surrounding NAME with `*'s.
681 PROGRAM should be either a string denoting an executable program to create
682 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
683 connection to be opened via `open-network-stream'. If there is already a
684 running process in that buffer, it is not restarted. Optional third arg
685 STARTFILE is the name of a file to send the contents of the process to.
687 If PROGRAM is a string, any more args are arguments to PROGRAM."
688 (apply #'make-comint-in-buffer name nil program startfile switches))
690 ;;;###autoload
691 (defun comint-run (program)
692 "Run PROGRAM in a Comint buffer and switch to it.
693 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
694 The file name is used to make a symbol name, such as `comint-sh-hook', and any
695 hooks on this symbol are run in the buffer.
696 See `make-comint' and `comint-exec'."
697 (interactive "sRun program: ")
698 (let ((name (file-name-nondirectory program)))
699 (switch-to-buffer (make-comint name program))
700 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
702 (defun comint-exec (buffer name command startfile switches)
703 "Start up a process named NAME in buffer BUFFER for Comint modes.
704 Runs the given COMMAND with SWITCHES with output to STARTFILE.
705 Blasts any old process running in the buffer. Doesn't set the buffer mode.
706 You can use this to cheaply run a series of processes in the same Comint
707 buffer. The hook `comint-exec-hook' is run after each exec."
708 (with-current-buffer buffer
709 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
710 (if proc (delete-process proc)))
711 ;; Crank up a new process
712 (let ((proc
713 (if (consp command)
714 (open-network-stream name buffer (car command) (cdr command))
715 (comint-exec-1 name buffer command switches))))
716 (set-process-filter proc 'comint-output-filter)
717 (make-local-variable 'comint-ptyp)
718 (setq comint-ptyp process-connection-type) ; t if pty, nil if pipe.
719 ;; Jump to the end, and set the process mark.
720 (goto-char (point-max))
721 (set-marker (process-mark proc) (point))
722 ;; Feed it the startfile.
723 (cond (startfile
724 ;;This is guaranteed to wait long enough
725 ;;but has bad results if the comint does not prompt at all
726 ;; (while (= size (buffer-size))
727 ;; (sleep-for 1))
728 ;;I hope 1 second is enough!
729 (sleep-for 1)
730 (goto-char (point-max))
731 (insert-file-contents startfile)
732 (setq startfile (buffer-substring (point) (point-max)))
733 (delete-region (point) (point-max))
734 (comint-send-string proc startfile)))
735 (run-hooks 'comint-exec-hook)
736 buffer)))
738 ;; This auxiliary function cranks up the process for comint-exec in
739 ;; the appropriate environment.
741 (defun comint-exec-1 (name buffer command switches)
742 (let ((process-environment
743 (nconc
744 ;; If using termcap, we specify `emacs' as the terminal type
745 ;; because that lets us specify a width.
746 ;; If using terminfo, we specify `dumb' because that is
747 ;; a defined terminal type. `emacs' is not a defined terminal type
748 ;; and there is no way for us to define it here.
749 ;; Some programs that use terminfo get very confused
750 ;; if TERM is not a valid terminal type.
751 ;; ;; There is similar code in compile.el.
752 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
753 (list "TERM=dumb" "TERMCAP="
754 (format "COLUMNS=%d" (window-width)))
755 (list "TERM=emacs"
756 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
757 (if (getenv "EMACS") nil (list "EMACS=t"))
758 process-environment))
759 (default-directory
760 (if (file-accessible-directory-p default-directory)
761 default-directory
762 "/"))
763 proc decoding encoding changed)
764 (let ((exec-path (if (file-name-directory command)
765 ;; If the command has slashes, make sure we
766 ;; first look relative to the current directory.
767 (cons default-directory exec-path) exec-path)))
768 (setq proc (apply 'start-process name buffer command switches)))
769 (let ((coding-systems (process-coding-system proc)))
770 (setq decoding (car coding-systems)
771 encoding (cdr coding-systems)))
772 ;; If start-process decided to use some coding system for decoding
773 ;; data sent from the process and the coding system doesn't
774 ;; specify EOL conversion, we had better convert CRLF to LF.
775 (if (vectorp (coding-system-eol-type decoding))
776 (setq decoding (coding-system-change-eol-conversion decoding 'dos)
777 changed t))
778 ;; Even if start-process left the coding system for encoding data
779 ;; sent from the process undecided, we had better use the same one
780 ;; as what we use for decoding. But, we should suppress EOL
781 ;; conversion.
782 (if (and decoding (not encoding))
783 (setq encoding (coding-system-change-eol-conversion decoding 'unix)
784 changed t))
785 (if changed
786 (set-process-coding-system proc decoding encoding))
787 proc))
789 (defun comint-insert-input (&optional event)
790 "In a Comint buffer, set the current input to the previous input at point."
791 ;; This doesn't use "e" because it is supposed to work
792 ;; for events without parameters.
793 (interactive (list last-input-event))
794 (let ((pos (point)))
795 (if event (mouse-set-point event))
796 (if (not (eq (get-char-property (point) 'field) 'input))
797 ;; No input at POS, fall back to the global definition.
798 (let* ((keys (this-command-keys))
799 (last-key (and (vectorp keys) (aref keys (1- (length keys)))))
800 (fun (and last-key (lookup-key global-map (vector last-key)))))
801 (goto-char pos)
802 (and fun (call-interactively fun)))
803 (setq pos (point))
804 ;; There's previous input at POS, insert it at the end of the buffer.
805 (goto-char (point-max))
806 ;; First delete any old unsent input at the end
807 (delete-region
808 (or (marker-position comint-accum-marker)
809 (process-mark (get-buffer-process (current-buffer))))
810 (point))
811 ;; Insert the input at point
812 (insert (buffer-substring-no-properties
813 (previous-single-char-property-change (1+ pos) 'field)
814 (next-single-char-property-change pos 'field))))))
816 \f
817 ;; Input history processing in a buffer
818 ;; ===========================================================================
819 ;; Useful input history functions, courtesy of the Ergo group.
821 ;; Eleven commands:
822 ;; comint-dynamic-list-input-ring List history in help buffer.
823 ;; comint-previous-input Previous input...
824 ;; comint-previous-matching-input ...matching a string.
825 ;; comint-previous-matching-input-from-input ... matching the current input.
826 ;; comint-next-input Next input...
827 ;; comint-next-matching-input ...matching a string.
828 ;; comint-next-matching-input-from-input ... matching the current input.
829 ;; comint-backward-matching-input Backwards input...
830 ;; comint-forward-matching-input ...matching a string.
831 ;; comint-replace-by-expanded-history Expand history at point;
832 ;; replace with expanded history.
833 ;; comint-magic-space Expand history and insert space.
834 ;;
835 ;; Three functions:
836 ;; comint-read-input-ring Read into comint-input-ring...
837 ;; comint-write-input-ring Write to comint-input-ring-file-name.
838 ;; comint-replace-by-expanded-history-before-point Workhorse function.
840 (defun comint-read-input-ring (&optional silent)
841 "Set the buffer's `comint-input-ring' from a history file.
842 The name of the file is given by the variable `comint-input-ring-file-name'.
843 The history ring is of size `comint-input-ring-size', regardless of file size.
844 If `comint-input-ring-file-name' is nil this function does nothing.
846 If the optional argument SILENT is non-nil, we say nothing about a
847 failure to read the history file.
849 This function is useful for major mode commands and mode hooks.
851 The commands stored in the history file are separated by the
852 `comint-input-ring-separator', and entries that match
853 `comint-input-history-ignore' are ignored. The most recent command
854 comes last.
856 See also `comint-input-ignoredups' and `comint-write-input-ring'."
857 (cond ((or (null comint-input-ring-file-name)
858 (equal comint-input-ring-file-name ""))
859 nil)
860 ((not (file-readable-p comint-input-ring-file-name))
861 (or silent
862 (message "Cannot read history file %s"
863 comint-input-ring-file-name)))
864 (t
865 (let* ((history-buf (get-buffer-create " *temp*"))
866 (file comint-input-ring-file-name)
867 (count 0)
868 (size comint-input-ring-size)
869 (ring (make-ring size)))
870 (unwind-protect
871 (save-excursion
872 (set-buffer history-buf)
873 (widen)
874 (erase-buffer)
875 (insert-file-contents file)
876 ;; Save restriction in case file is already visited...
877 ;; Watch for those date stamps in history files!
878 (goto-char (point-max))
879 (let (start end history)
880 (while (and (< count comint-input-ring-size)
881 (re-search-backward comint-input-ring-separator nil t)
882 (setq end (match-beginning 0)))
883 (if (re-search-backward comint-input-ring-separator nil t)
884 (setq start (match-end 0))
885 (setq start (point-min)))
886 (setq history (buffer-substring start end))
887 (goto-char start)
888 (if (and (not (string-match comint-input-history-ignore history))
889 (or (null comint-input-ignoredups)
890 (ring-empty-p ring)
891 (not (string-equal (ring-ref ring 0) history))))
892 (progn
893 (ring-insert-at-beginning ring history)
894 (setq count (1+ count)))))))
895 (kill-buffer history-buf))
896 (setq comint-input-ring ring
897 comint-input-ring-index nil)))))
899 (defun comint-write-input-ring ()
900 "Writes the buffer's `comint-input-ring' to a history file.
901 The name of the file is given by the variable `comint-input-ring-file-name'.
902 The original contents of the file are lost if `comint-input-ring' is not empty.
903 If `comint-input-ring-file-name' is nil this function does nothing.
905 Useful within process sentinels.
907 See also `comint-read-input-ring'."
908 (cond ((or (null comint-input-ring-file-name)
909 (equal comint-input-ring-file-name "")
910 (null comint-input-ring) (ring-empty-p comint-input-ring))
911 nil)
912 ((not (file-writable-p comint-input-ring-file-name))
913 (message "Cannot write history file %s" comint-input-ring-file-name))
914 (t
915 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
916 (ring comint-input-ring)
917 (file comint-input-ring-file-name)
918 (index (ring-length ring)))
919 ;; Write it all out into a buffer first. Much faster, but messier,
920 ;; than writing it one line at a time.
921 (save-excursion
922 (set-buffer history-buf)
923 (erase-buffer)
924 (while (> index 0)
925 (setq index (1- index))
926 (insert (ring-ref ring index) comint-input-ring-separator))
927 (write-region (buffer-string) nil file nil 'no-message)
928 (kill-buffer nil))))))
931 (defvar comint-dynamic-list-input-ring-window-conf)
933 (defun comint-dynamic-list-input-ring-select ()
934 "Choose the input history entry that point is in or next to."
935 (interactive)
936 (let (beg end completion (buffer completion-reference-buffer)
937 (base-size completion-base-size))
938 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
939 (setq end (point) beg (1+ (point))))
940 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
941 (setq end (1- (point)) beg (point)))
942 (if (null beg)
943 (error "No history entry here"))
944 (setq beg (previous-single-property-change beg 'mouse-face))
945 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
946 (setq completion (buffer-substring beg end))
947 (set-window-configuration comint-dynamic-list-input-ring-window-conf)
948 (choose-completion-string completion buffer base-size)))
950 (defun comint-dynamic-list-input-ring ()
951 "List in help buffer the buffer's input history."
952 (interactive)
953 (if (or (not (ring-p comint-input-ring))
954 (ring-empty-p comint-input-ring))
955 (message "No history")
956 (let ((history nil)
957 (history-buffer " *Input History*")
958 (index (1- (ring-length comint-input-ring)))
959 (conf (current-window-configuration)))
960 ;; We have to build up a list ourselves from the ring vector.
961 (while (>= index 0)
962 (setq history (cons (ring-ref comint-input-ring index) history)
963 index (1- index)))
964 ;; Change "completion" to "history reference"
965 ;; to make the display accurate.
966 (with-output-to-temp-buffer history-buffer
967 (display-completion-list history)
968 (set-buffer history-buffer)
969 (let ((keymap (make-sparse-keymap)))
970 (set-keymap-parent keymap (current-local-map))
971 (define-key keymap "\C-m" 'comint-dynamic-list-input-ring-select)
972 (use-local-map keymap))
973 (forward-line 3)
974 (while (search-backward "completion" nil 'move)
975 (replace-match "history reference")))
976 (sit-for 0)
977 (message "Hit space to flush")
978 (setq comint-dynamic-list-input-ring-window-conf conf)
979 (let ((ch (read-event)))
980 (if (eq ch ?\ )
981 (set-window-configuration conf)
982 (setq unread-command-events (list ch)))))))
985 (defun comint-regexp-arg (prompt)
986 "Return list of regexp and prefix arg using PROMPT."
987 (let* (;; Don't clobber this.
988 (last-command last-command)
989 (regexp (read-from-minibuffer prompt nil nil nil
990 'minibuffer-history-search-history)))
991 (list (if (string-equal regexp "")
992 (setcar minibuffer-history-search-history
993 (nth 1 minibuffer-history-search-history))
994 regexp)
995 (prefix-numeric-value current-prefix-arg))))
997 (defun comint-search-arg (arg)
998 ;; First make sure there is a ring and that we are after the process mark
999 (cond ((not (comint-after-pmark-p))
1000 (error "Not at command line"))
1001 ((or (null comint-input-ring)
1002 (ring-empty-p comint-input-ring))
1003 (error "Empty input ring"))
1004 ((zerop arg)
1005 ;; arg of zero resets search from beginning, and uses arg of 1
1006 (setq comint-input-ring-index nil)
1007 1)
1008 (t
1009 arg)))
1011 (defun comint-search-start (arg)
1012 "Index to start a directional search, starting at `comint-input-ring-index'."
1013 (if comint-input-ring-index
1014 ;; If a search is running, offset by 1 in direction of arg
1015 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
1016 (ring-length comint-input-ring))
1017 ;; For a new search, start from beginning or end, as appropriate
1018 (if (>= arg 0)
1019 0 ; First elt for forward search
1020 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
1022 (defun comint-previous-input-string (arg)
1023 "Return the string ARG places along the input ring.
1024 Moves relative to `comint-input-ring-index'."
1025 (ring-ref comint-input-ring (if comint-input-ring-index
1026 (mod (+ arg comint-input-ring-index)
1027 (ring-length comint-input-ring))
1028 arg)))
1030 (defun comint-previous-input (arg)
1031 "Cycle backwards through input history."
1032 (interactive "*p")
1033 (comint-previous-matching-input "." arg))
1035 (defun comint-next-input (arg)
1036 "Cycle forwards through input history."
1037 (interactive "*p")
1038 (comint-previous-input (- arg)))
1040 (defun comint-previous-matching-input-string (regexp arg)
1041 "Return the string matching REGEXP ARG places along the input ring.
1042 Moves relative to `comint-input-ring-index'."
1043 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
1044 (if pos (ring-ref comint-input-ring pos))))
1046 (defun comint-previous-matching-input-string-position (regexp arg &optional start)
1047 "Return the index matching REGEXP ARG places along the input ring.
1048 Moves relative to START, or `comint-input-ring-index'."
1049 (if (or (not (ring-p comint-input-ring))
1050 (ring-empty-p comint-input-ring))
1051 (error "No history"))
1052 (let* ((len (ring-length comint-input-ring))
1053 (motion (if (> arg 0) 1 -1))
1054 (n (mod (- (or start (comint-search-start arg)) motion) len))
1055 (tried-each-ring-item nil)
1056 (prev nil))
1057 ;; Do the whole search as many times as the argument says.
1058 (while (and (/= arg 0) (not tried-each-ring-item))
1059 ;; Step once.
1060 (setq prev n
1061 n (mod (+ n motion) len))
1062 ;; If we haven't reached a match, step some more.
1063 (while (and (< n len) (not tried-each-ring-item)
1064 (not (string-match regexp (ring-ref comint-input-ring n))))
1065 (setq n (mod (+ n motion) len)
1066 ;; If we have gone all the way around in this search.
1067 tried-each-ring-item (= n prev)))
1068 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1069 ;; Now that we know which ring element to use, if we found it, return that.
1070 (if (string-match regexp (ring-ref comint-input-ring n))
1071 n)))
1073 (defun comint-previous-matching-input (regexp arg)
1074 "Search backwards through input history for match for REGEXP.
1075 \(Previous history elements are earlier commands.)
1076 With prefix argument N, search for Nth previous match.
1077 If N is negative, find the next or Nth next match."
1078 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1079 (setq arg (comint-search-arg arg))
1080 (let ((pos (comint-previous-matching-input-string-position regexp arg)))
1081 ;; Has a match been found?
1082 (if (null pos)
1083 (error "Not found")
1084 (setq comint-input-ring-index pos)
1085 (message "History item: %d" (1+ pos))
1086 (delete-region
1087 ;; Can't use kill-region as it sets this-command
1088 (or (marker-position comint-accum-marker)
1089 (process-mark (get-buffer-process (current-buffer))))
1090 (point))
1091 (insert (ring-ref comint-input-ring pos)))))
1093 (defun comint-next-matching-input (regexp arg)
1094 "Search forwards through input history for match for REGEXP.
1095 \(Later history elements are more recent commands.)
1096 With prefix argument N, search for Nth following match.
1097 If N is negative, find the previous or Nth previous match."
1098 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1099 (comint-previous-matching-input regexp (- arg)))
1101 (defun comint-previous-matching-input-from-input (arg)
1102 "Search backwards through input history for match for current input.
1103 \(Previous history elements are earlier commands.)
1104 With prefix argument N, search for Nth previous match.
1105 If N is negative, search forwards for the -Nth following match."
1106 (interactive "p")
1107 (if (not (memq last-command '(comint-previous-matching-input-from-input
1108 comint-next-matching-input-from-input)))
1109 ;; Starting a new search
1110 (setq comint-matching-input-from-input-string
1111 (buffer-substring
1112 (or (marker-position comint-accum-marker)
1113 (process-mark (get-buffer-process (current-buffer))))
1114 (point))
1115 comint-input-ring-index nil))
1116 (comint-previous-matching-input
1117 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1118 arg))
1120 (defun comint-next-matching-input-from-input (arg)
1121 "Search forwards through input history for match for current input.
1122 \(Following history elements are more recent commands.)
1123 With prefix argument N, search for Nth following match.
1124 If N is negative, search backwards for the -Nth previous match."
1125 (interactive "p")
1126 (comint-previous-matching-input-from-input (- arg)))
1129 (defun comint-replace-by-expanded-history (&optional silent start)
1130 "Expand input command history references before point.
1131 Expansion is dependent on the value of `comint-input-autoexpand'.
1133 This function depends on the buffer's idea of the input history, which may not
1134 match the command interpreter's idea, assuming it has one.
1136 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1137 cannot know the interpreter's idea of input line numbers, assuming it has one,
1138 it cannot expand absolute input line number references.
1140 If the optional argument SILENT is non-nil, never complain
1141 even if history reference seems erroneous.
1143 If the optional argument START is non-nil, that specifies the
1144 start of the text to scan for history references, rather
1145 than the logical beginning of line.
1147 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1149 Returns t if successful."
1150 (interactive)
1151 (if (and comint-input-autoexpand
1152 (if comint-use-prompt-regexp-instead-of-fields
1153 ;; Use comint-prompt-regexp
1154 (save-excursion
1155 (beginning-of-line)
1157 ;; Use input fields. User input that hasn't been entered
1158 ;; yet, at the end of the buffer, has a nil `field' property.
1159 (and (null (get-char-property (point) 'field))
1161 ;; Looks like there might be history references in the command.
1162 (let ((previous-modified-tick (buffer-modified-tick)))
1163 (comint-replace-by-expanded-history-before-point silent start)
1164 (/= previous-modified-tick (buffer-modified-tick)))))
1167 (defun comint-replace-by-expanded-history-before-point (silent &optional start)
1168 "Expand directory stack reference before point.
1169 See `comint-replace-by-expanded-history'. Returns t if successful.
1171 If the optional argument START is non-nil, that specifies the
1172 start of the text to scan for history references, rather
1173 than the logical beginning of line."
1174 (save-excursion
1175 (let ((toend (- (line-end-position) (point)))
1176 (start (or start (comint-line-beginning-position))))
1177 (goto-char start)
1178 (while (progn
1179 (skip-chars-forward "^!^" (- (line-end-position) toend))
1180 (< (point) (- (line-end-position) toend)))
1181 ;; This seems a bit complex. We look for references such as !!, !-num,
1182 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1183 ;; If that wasn't enough, the plings can be suffixed with argument
1184 ;; range specifiers.
1185 ;; Argument ranges are complex too, so we hive off the input line,
1186 ;; referenced with plings, with the range string to `comint-args'.
1187 (setq comint-input-ring-index nil)
1189 (comint-within-quotes start (point)))
1190 ;; The history is quoted, or we're in quotes.
1191 (goto-char (1+ (point))))
1193 ;; We cannot know the interpreter's idea of input line numbers.
1194 (goto-char (match-end 0))
1195 (message "Absolute reference cannot be expanded"))
1197 ;; Just a number of args from `number' lines backward.
1198 (let ((number (1- (string-to-number
1199 (buffer-substring (match-beginning 1)
1200 (match-end 1))))))
1201 (if (<= number (ring-length comint-input-ring))
1202 (progn
1203 (replace-match
1204 (comint-args (comint-previous-input-string number)
1205 (match-beginning 2) (match-end 2))
1206 t t)
1207 (setq comint-input-ring-index number)
1208 (message "History item: %d" (1+ number)))
1209 (goto-char (match-end 0))
1210 (message "Relative reference exceeds input history size"))))
1212 ;; Just a number of args from the previous input line.
1213 (replace-match
1214 (comint-args (comint-previous-input-string 0)
1215 (match-beginning 1) (match-end 1))
1216 t t)
1217 (message "History item: previous"))
1218 ((looking-at
1220 ;; Most recent input starting with or containing (possibly
1221 ;; protected) string, maybe just a number of args. Phew.
1222 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1223 (mb2 (match-beginning 2)) (me2 (match-end 2))
1224 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1226 (pos (save-match-data
1227 (comint-previous-matching-input-string-position
1228 (concat pref (regexp-quote exp)) 1))))
1229 (if (null pos)
1230 (progn
1231 (goto-char (match-end 0))
1232 (or silent
1233 (progn (message "Not found")
1234 (ding))))
1235 (setq comint-input-ring-index pos)
1236 (replace-match
1237 (comint-args (ring-ref comint-input-ring pos)
1238 (match-beginning 4) (match-end 4))
1239 t t)
1240 (message "History item: %d" (1+ pos)))))
1242 ;; Quick substitution on the previous input line.
1243 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1244 (new (buffer-substring (match-beginning 2) (match-end 2)))
1245 (pos nil))
1246 (replace-match (comint-previous-input-string 0) t t)
1247 (setq pos (point))
1248 (goto-char (match-beginning 0))
1249 (if (not (search-forward old pos t))
1250 (or silent
1251 (error "Not found"))
1252 (replace-match new t t)
1253 (message "History item: substituted"))))
1254 (t
1255 (forward-char 1)))))))
1258 (defun comint-magic-space (arg)
1259 "Expand input history references before point and insert ARG spaces.
1260 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1261 (interactive "p")
1262 (comint-replace-by-expanded-history)
1263 (self-insert-command arg))
1264 \f
1265 (defun comint-within-quotes (beg end)
1266 "Return t if the number of quotes between BEG and END is odd.
1267 Quotes are single and double."
1270 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1272 (defun comint-how-many-region (regexp beg end)
1273 "Return number of matches for REGEXP from BEG to END."
1274 (let ((count 0))
1275 (save-excursion
1276 (save-match-data
1277 (goto-char beg)
1278 (while (re-search-forward regexp end t)
1279 (setq count (1+ count)))))
1280 count))
1282 (defun comint-args (string begin end)
1283 ;; From STRING, return the args depending on the range specified in the text
1284 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1285 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1286 (save-match-data
1287 (if (null begin)
1288 (comint-arguments string 0 nil)
1289 (let* ((range (buffer-substring
1290 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1291 (nth (cond ((string-match "^[*^]" range) 1)
1292 ((string-match "^-" range) 0)
1293 ((string-equal range "$") nil)
1294 (t (string-to-number range))))
1295 (mth (cond ((string-match "[-*$]$" range) nil)
1296 ((string-match "-" range)
1297 (string-to-number (substring range (match-end 0))))
1298 (t nth))))
1299 (comint-arguments string nth mth)))))
1301 (defun comint-delim-arg (arg)
1302 "Return a list of arguments from ARG.
1303 Break it up at the delimiters in `comint-delimiter-argument-list'.
1304 Returned list is backwards."
1305 (if (null comint-delimiter-argument-list)
1306 (list arg)
1307 (let ((args nil)
1308 (pos 0)
1309 (len (length arg)))
1310 (while (< pos len)
1311 (let ((char (aref arg pos))
1312 (start pos))
1313 (if (memq char comint-delimiter-argument-list)
1314 (while (and (< pos len) (eq (aref arg pos) char))
1315 (setq pos (1+ pos)))
1316 (while (and (< pos len)
1317 (not (memq (aref arg pos)
1318 comint-delimiter-argument-list)))
1319 (setq pos (1+ pos))))
1320 (setq args (cons (substring arg start pos) args))))
1321 args)))
1323 (defun comint-arguments (string nth mth)
1324 "Return from STRING the NTH to MTH arguments.
1325 NTH and/or MTH can be nil, which means the last argument.
1326 Returned arguments are separated by single spaces.
1327 We assume whitespace separates arguments, except within quotes
1328 and except for a space or tab that immediately follows a backslash.
1329 Also, a run of one or more of a single character
1330 in `comint-delimiter-argument-list' is a separate argument.
1331 Argument 0 is the command name."
1332 ;; The first line handles ordinary characters and backslash-sequences
1333 ;; (except with w32 msdos-like shells, where backslashes are valid).
1334 ;; The second matches "-quoted strings.
1335 ;; The third matches '-quoted strings.
1336 ;; The fourth matches `-quoted strings.
1337 ;; This seems to fit the syntax of BASH 2.0.
1338 (let* ((first (if (if (fboundp 'w32-shell-dos-semantics)
1339 (w32-shell-dos-semantics))
1342 (argpart (concat first
1346 (args ()) (pos 0)
1347 (count 0)
1348 beg str quotes)
1349 ;; Build a list of all the args until we have as many as we want.
1350 (while (and (or (null mth) (<= count mth))
1351 (string-match argpart string pos))
1352 (if (and beg (= pos (match-beginning 0)))
1353 ;; It's contiguous, part of the same arg.
1354 (setq pos (match-end 0)
1355 quotes (or quotes (match-beginning 1)))
1356 ;; It's a new separate arg.
1357 (if beg
1358 ;; Put the previous arg, if there was one, onto ARGS.
1359 (setq str (substring string beg pos)
1360 args (if quotes (cons str args)
1361 (nconc (comint-delim-arg str) args))))
1362 (setq count (length args))
1363 (setq quotes (match-beginning 1))
1364 (setq beg (match-beginning 0))
1365 (setq pos (match-end 0))))
1366 (if beg
1367 (setq str (substring string beg pos)
1368 args (if quotes (cons str args)
1369 (nconc (comint-delim-arg str) args))))
1370 (setq count (length args))
1371 (let ((n (or nth (1- count)))
1372 (m (if mth (1- (- count mth)) 0)))
1373 (mapconcat
1374 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1375 \f
1376 ;;
1377 ;; Input processing stuff
1378 ;;
1379 (defun comint-add-to-input-history (cmd)
1380 "Add CMD to the input history.
1381 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1382 (if (and (funcall comint-input-filter cmd)
1383 (or (null comint-input-ignoredups)
1384 (not (ring-p comint-input-ring))
1385 (ring-empty-p comint-input-ring)
1386 (not (string-equal (ring-ref comint-input-ring 0)
1387 cmd))))
1388 (ring-insert comint-input-ring cmd)))
1390 (defun comint-send-input (&optional no-newline)
1391 "Send input to process.
1392 After the process output mark, sends all text from the process mark to
1393 point as input to the process. Before the process output mark, calls
1394 value of variable `comint-get-old-input' to retrieve old input, copies
1395 it to the process mark, and sends it. A terminal newline is also
1396 inserted into the buffer and sent to the process unless NO-NEWLINE is
1397 non-nil.
1399 Any history reference may be expanded depending on the value of the variable
1400 `comint-input-autoexpand'. The list of function names contained in the value
1401 of `comint-input-filter-functions' is called on the input before sending it.
1402 The input is entered into the input history ring, if the value of variable
1403 `comint-input-filter' returns non-nil when called on the input.
1405 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1406 end of line before sending the input.
1408 After the input has been sent, if `comint-process-echoes' is non-nil,
1409 then `comint-send-input' waits to see if the process outputs a string
1410 matching the input, and if so, deletes that part of the output.
1412 The values of `comint-get-old-input', `comint-input-filter-functions', and
1413 `comint-input-filter' are chosen according to the command interpreter running
1414 in the buffer. E.g.,
1416 If the interpreter is the csh,
1417 `comint-get-old-input' is the default:
1418 If `comint-use-prompt-regexp-instead-of-fields' is nil, then
1419 either return the current input field, if point is on an input
1420 field, or the current line, if point is on an output field.
1421 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then
1422 return the current line with any initial string matching the
1423 regexp `comint-prompt-regexp' removed.
1426 comint-input-filter is the default: returns t if the input isn't all white
1427 space.
1429 If the Comint is Lucid Common Lisp,
1430 comint-get-old-input snarfs the sexp ending at point.
1431 comint-input-filter-functions does nothing.
1432 comint-input-filter returns nil if the input matches input-filter-regexp,
1433 which matches (1) all whitespace (2) :a, :c, etc.
1435 Similarly for Soar, Scheme, etc."
1436 (interactive)
1437 ;; Note that the input string does not include its terminal newline.
1438 (let ((proc (get-buffer-process (current-buffer))))
1439 (if (not proc) (error "Current buffer has no process")
1440 (let* ((pmark (process-mark proc))
1441 (intxt (if (>= (point) (marker-position pmark))
1442 (progn (if comint-eol-on-send (end-of-line))
1443 (buffer-substring pmark (point)))
1444 (let ((copy (funcall comint-get-old-input)))
1445 (goto-char pmark)
1446 (insert copy)
1447 copy)))
1448 (input (if (not (eq comint-input-autoexpand 'input))
1449 ;; Just whatever's already there
1450 intxt
1451 ;; Expand and leave it visible in buffer
1452 (comint-replace-by-expanded-history t pmark)
1453 (buffer-substring pmark (point))))
1454 (history (if (not (eq comint-input-autoexpand 'history))
1455 input
1456 ;; This is messy 'cos ultimately the original
1457 ;; functions used do insertion, rather than return
1458 ;; strings. We have to expand, then insert back.
1459 (comint-replace-by-expanded-history t pmark)
1460 (let ((copy (buffer-substring pmark (point)))
1461 (start (point)))
1462 (insert input)
1463 (delete-region pmark start)
1464 copy))))
1466 (unless no-newline
1469 (comint-add-to-input-history history)
1471 (run-hook-with-args 'comint-input-filter-functions
1472 (if no-newline input
1475 (let ((beg (marker-position pmark))
1476 (end (if no-newline (point) (1- (point))))
1477 (inhibit-modification-hooks t))
1478 (when (> end beg)
1479 ;; Set text-properties for the input field
1480 (add-text-properties
1481 beg end
1482 '(front-sticky t
1483 font-lock-face comint-highlight-input
1484 mouse-face highlight
1485 help-echo "mouse-2: insert after prompt as new input"))
1486 (unless comint-use-prompt-regexp-instead-of-fields
1487 ;; Give old user input a field property of `input', to
1488 ;; distinguish it from both process output and unsent
1489 ;; input. The terminating newline is put into a special
1490 ;; `boundary' field to make cursor movement between input
1491 ;; and output fields smoother.
1492 (put-text-property beg end 'field 'input)))
1493 (unless (or no-newline comint-use-prompt-regexp-instead-of-fields)
1494 ;; Cover the terminating newline
1495 (add-text-properties end (1+ end)
1496 '(rear-nonsticky t
1497 field boundary
1498 inhibit-line-move-field-capture t))))
1500 (comint-snapshot-last-prompt)
1502 (setq comint-save-input-ring-index comint-input-ring-index)
1503 (setq comint-input-ring-index nil)
1504 ;; Update the markers before we send the input
1505 ;; in case we get output amidst sending the input.
1506 (set-marker comint-last-input-start pmark)
1507 (set-marker comint-last-input-end (point))
1508 (set-marker (process-mark proc) (point))
1509 ;; clear the "accumulation" marker
1510 (set-marker comint-accum-marker nil)
1511 (let ((comint-input-sender-no-newline no-newline))
1512 (funcall comint-input-sender proc input))
1514 ;; Optionally delete echoed input (after checking it).
1515 (when comint-process-echoes
1516 (let ((echo-len (- comint-last-input-end
1517 comint-last-input-start)))
1518 ;; Wait for all input to be echoed:
1519 (while (and (accept-process-output proc)
1520 (> (+ comint-last-input-end echo-len)
1521 (point-max))
1522 (zerop
1523 (compare-buffer-substrings
1524 nil comint-last-input-start
1525 (- (point-max) echo-len)
1526 ;; Above difference is equivalent to
1527 ;; (+ comint-last-input-start
1528 ;; (- (point-max) comint-last-input-end))
1529 nil comint-last-input-end (point-max)))))
1530 (if (and
1531 (<= (+ comint-last-input-end echo-len)
1532 (point-max))
1533 (zerop
1534 (compare-buffer-substrings
1535 nil comint-last-input-start comint-last-input-end
1536 nil comint-last-input-end
1537 (+ comint-last-input-end echo-len))))
1538 (delete-region comint-last-input-end
1539 (+ comint-last-input-end echo-len)))))
1541 ;; This used to call comint-output-filter-functions,
1542 ;; but that scrolled the buffer in undesirable ways.
1543 (run-hook-with-args 'comint-output-filter-functions "")))))
1545 (defvar comint-preoutput-filter-functions nil
1546 "List of functions to call before inserting Comint output into the buffer.
1547 Each function gets one argument, a string containing the text received
1548 from the subprocess. It should return the string to insert, perhaps
1549 the same string that was received, or perhaps a modified or transformed
1550 string.
1552 The functions on the list are called sequentially, and each one is
1553 given the string returned by the previous one. The string returned by
1554 the last function is the text that is actually inserted in the
1555 redirection buffer.
1557 You can use `add-hook' to add functions to this list
1558 either globally or locally.")
1560 (defvar comint-inhibit-carriage-motion nil
1561 "If nil, Comint will interpret `carriage control' characters in output.
1562 See `comint-carriage-motion' for details.")
1564 ;; When non-nil, this is an overlay over the last recognized prompt in
1565 ;; the buffer; it is used when highlighting the prompt.
1566 (defvar comint-last-prompt-overlay nil)
1568 (defun comint-snapshot-last-prompt ()
1569 "`snapshot' any current `comint-last-prompt-overlay'.
1570 freeze its attributes in place, even when more input comes a long
1571 and moves the prompt overlay."
1572 (when comint-last-prompt-overlay
1573 (let ((inhibit-read-only t)
1574 (inhibit-modification-hooks t))
1575 (add-text-properties (overlay-start comint-last-prompt-overlay)
1576 (overlay-end comint-last-prompt-overlay)
1577 (overlay-properties comint-last-prompt-overlay)))))
1579 (defun comint-carriage-motion (start end)
1580 "Interpret carriage control characters in the region from START to END.
1581 Translate carriage return/linefeed sequences to linefeeds.
1582 Make single carriage returns delete to the beginning of the line.
1583 Make backspaces delete the previous character."
1584 (save-excursion
1585 ;; First do a quick check to see if there are any applicable
1586 ;; characters, so we can avoid calling save-match-data and
1587 ;; save-restriction if not.
1588 (goto-char start)
1590 (save-match-data
1591 (save-restriction
1592 (widen)
1593 (let ((inhibit-field-text-motion t)
1594 (inhibit-read-only t))
1595 ;; CR LF -> LF
1596 ;; Note that this won't work properly when the CR and LF
1597 ;; are in different output chunks, but this is probably an
1598 ;; exceedingly rare case (because they are generally
1599 ;; written as a unit), and to delay interpretation of a
1600 ;; trailing CR in a chunk would result in odd interactive
1601 ;; behavior (and this case is probably far more common).
1603 (delete-char -1))
1604 ;; bare CR -> delete preceding line
1605 (goto-char start)
1607 (delete-region (point) (line-beginning-position)))
1608 ;; BS -> delete preceding character
1609 (goto-char start)
1611 (delete-char -2))))))))
1613 ;; The purpose of using this filter for comint processes
1614 ;; is to keep comint-last-input-end from moving forward
1615 ;; when output is inserted.
1616 (defun comint-output-filter (process string)
1617 (let ((oprocbuf (process-buffer process)))
1618 ;; First check for killed buffer or no input.
1619 (when (and string oprocbuf (buffer-name oprocbuf))
1620 (with-current-buffer oprocbuf
1621 ;; Run preoutput filters
1622 (let ((functions comint-preoutput-filter-functions))
1623 (while (and functions string)
1624 (if (eq (car functions) t)
1625 (let ((functions (default-value 'comint-preoutput-filter-functions)))
1626 (while (and functions string)
1627 (setq string (funcall (car functions) string))
1628 (setq functions (cdr functions))))
1629 (setq string (funcall (car functions) string)))
1630 (setq functions (cdr functions))))
1632 ;; Insert STRING
1633 (let ((inhibit-read-only t)
1634 ;; Avoid the overhead of save-excursion, since we just
1635 ;; fiddle with the point
1636 (saved-point (point-marker)))
1638 ;; The point should float after any insertion we do
1639 (set-marker-insertion-type saved-point t)
1641 ;; We temporarly remove any buffer narrowing, in case the
1642 ;; process mark is outside of the restriction
1643 (save-restriction
1644 (widen)
1646 (goto-char (process-mark process))
1647 (set-marker comint-last-output-start (point))
1649 ;; insert-before-markers is a bad thing. XXX
1650 ;;
1651 ;; It is used here to force window-point markers (used to
1652 ;; store the value of point in non-selected windows) to
1653 ;; advance, but it also screws up any other markers that we
1654 ;; don't _want_ to advance, such as the start-marker of some
1655 ;; of the overlays we create.
1656 ;;
1657 ;; We work around the problem with the overlays by
1658 ;; explicitly adjusting them after we do the insertion, but
1659 ;; in the future this problem should be solved correctly, by
1660 ;; using `insert', and making the insertion-type of
1661 ;; window-point markers settable (via a buffer-local
1662 ;; variable). In comint buffers, this variable would be set
1663 ;; to `t', to cause point in non-select windows to advance.
1664 (insert-before-markers string)
1665 ;; Fixup markers and overlays that got screwed up because we
1666 ;; used `insert-before-markers'.
1667 (let ((old-point (- (point) (length string))))
1668 ;; comint-last-output-start
1669 (set-marker comint-last-output-start old-point)
1670 ;; comint-last-input-end
1671 (when (and comint-last-input-end
1672 (equal (marker-position comint-last-input-end)
1673 (point)))
1674 (set-marker comint-last-input-end old-point))
1675 ;; No overlays we create are set to advance upon insertion
1676 ;; (at the start/end), so we assume that any overlay which
1677 ;; is at the current point was incorrectly advanced by
1678 ;; insert-before-markers. First fixup overlays that might
1679 ;; start at point:
1680 (dolist (over (overlays-at (point)))
1681 (when (= (overlay-start over) (point))
1682 (let ((end (overlay-end over)))
1683 (move-overlay over
1684 old-point
1685 (if (= end (point)) old-point end)))))
1686 ;; Then do overlays that might end at point:
1687 (dolist (over (overlays-at (1- (point))))
1688 (when (= (overlay-end over) (point))
1689 (move-overlay over
1690 (min (overlay-start over) old-point)
1691 old-point))))
1693 ;; Advance process-mark
1694 (set-marker (process-mark process) (point))
1696 (unless comint-inhibit-carriage-motion
1697 ;; Interpret any carriage motion characters (newline, backspace)
1698 (comint-carriage-motion comint-last-output-start (point)))
1700 (run-hook-with-args 'comint-output-filter-functions string)
1702 (goto-char (process-mark process)) ; in case a filter moved it
1704 (unless comint-use-prompt-regexp-instead-of-fields
1705 (let ((inhibit-read-only t)
1706 (inhibit-modification-hooks t))
1707 (add-text-properties comint-last-output-start (point)
1708 '(rear-nonsticky t
1709 field output
1710 inhibit-line-move-field-capture t))))
1712 ;; Highlight the prompt, where we define `prompt' to mean
1713 ;; the most recent output that doesn't end with a newline.
1714 (let ((prompt-start (save-excursion (forward-line 0) (point)))
1715 (inhibit-read-only t)
1716 (inhibit-modification-hooks t))
1717 (when comint-prompt-read-only
1718 (or (= (point-min) prompt-start)
1719 (get-text-property (1- prompt-start) 'read-only)
1720 (put-text-property
1721 (1- prompt-start) prompt-start 'read-only 'fence))
1722 (add-text-properties
1723 prompt-start (point)
1724 '(read-only t rear-nonsticky t front-sticky (read-only))))
1725 (unless (and (bolp) (null comint-last-prompt-overlay))
1726 ;; Need to create or move the prompt overlay (in the case
1727 ;; where there is no prompt ((bolp) == t), we still do
1728 ;; this if there's already an existing overlay).
1729 (if comint-last-prompt-overlay
1730 ;; Just move an existing overlay
1731 (move-overlay comint-last-prompt-overlay
1732 prompt-start (point))
1733 ;; Need to create the overlay
1734 (setq comint-last-prompt-overlay
1735 (make-overlay prompt-start (point)))
1736 (overlay-put comint-last-prompt-overlay
1737 'font-lock-face 'comint-highlight-prompt))))
1739 (goto-char saved-point)))))))
1741 (defun comint-preinput-scroll-to-bottom ()
1742 "Go to the end of buffer in all windows showing it.
1743 Movement occurs if point in the selected window is not after the process mark,
1744 and `this-command' is an insertion command. Insertion commands recognised
1745 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1746 Depends on the value of `comint-scroll-to-bottom-on-input'.
1748 This function should be a pre-command hook."
1749 (if (and comint-scroll-to-bottom-on-input
1750 (memq this-command '(self-insert-command comint-magic-space yank
1751 hilit-yank)))
1752 (let* ((selected (selected-window))
1753 (current (current-buffer))
1754 (process (get-buffer-process current))
1755 (scroll comint-scroll-to-bottom-on-input))
1756 (if (and process (< (point) (process-mark process)))
1757 (if (eq scroll 'this)
1758 (goto-char (point-max))
1759 (walk-windows
1760 (function (lambda (window)
1761 (if (and (eq (window-buffer window) current)
1762 (or (eq scroll t) (eq scroll 'all)))
1763 (progn
1764 (select-window window)
1765 (goto-char (point-max))
1766 (select-window selected)))))
1767 nil t))))))
1769 (defun comint-postoutput-scroll-to-bottom (string)
1770 "Go to the end of buffer in some or all windows showing it.
1771 Does not scroll if the current line is the last line in the buffer.
1772 Depends on the value of `comint-move-point-for-output' and
1773 `comint-scroll-show-maximum-output'.
1775 This function should be in the list `comint-output-filter-functions'."
1776 (let* ((selected (selected-window))
1777 (current (current-buffer))
1778 (process (get-buffer-process current))
1779 (scroll comint-move-point-for-output))
1780 (unwind-protect
1781 (if process
1782 (walk-windows
1783 (function (lambda (window)
1784 (if (eq (window-buffer window) current)
1785 (progn
1786 (select-window window)
1787 (if (and (< (point) (process-mark process))
1788 (or (eq scroll t) (eq scroll 'all)
1789 ;; Maybe user wants point to jump to end.
1790 (and (eq scroll 'this) (eq selected window))
1791 (and (eq scroll 'others) (not (eq selected window)))
1792 ;; If point was at the end, keep it at end.
1793 (and (marker-position comint-last-output-start)
1794 (>= (point) comint-last-output-start))))
1795 (goto-char (process-mark process)))
1796 ;; Optionally scroll so that the text
1797 ;; ends at the bottom of the window.
1798 (if (and comint-scroll-show-maximum-output
1799 (= (point) (point-max)))
1800 (save-excursion
1801 (goto-char (point-max))
1802 (recenter -1)))
1803 (select-window selected)))))
1804 nil t))
1805 (set-buffer current))))
1807 (defun comint-truncate-buffer (&optional string)
1808 "Truncate the buffer to `comint-buffer-maximum-size'.
1809 This function could be on `comint-output-filter-functions' or bound to a key."
1810 (interactive)
1811 (save-excursion
1812 (goto-char (process-mark (get-buffer-process (current-buffer))))
1813 (forward-line (- comint-buffer-maximum-size))
1814 (beginning-of-line)
1815 (let ((inhibit-read-only t))
1816 (delete-region (point-min) (point)))))
1818 (defun comint-strip-ctrl-m (&optional string)
1819 "Strip trailing `^M' characters from the current output group.
1820 This function could be on `comint-output-filter-functions' or bound to a key."
1821 (interactive)
1822 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1823 (save-excursion
1824 (condition-case nil
1825 (goto-char
1826 (if (interactive-p) comint-last-input-end comint-last-output-start))
1827 (error nil))
1829 (replace-match "" t t)))))
1830 (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
1832 (defun comint-show-maximum-output ()
1833 "Put the end of the buffer at the bottom of the window."
1834 (interactive)
1835 (goto-char (point-max))
1836 (recenter -1))
1838 (defun comint-get-old-input-default ()
1839 "Default for `comint-get-old-input'.
1840 If `comint-use-prompt-regexp-instead-of-fields' is nil, then either
1841 return the current input field, if point is on an input field, or the
1842 current line, if point is on an output field.
1843 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then return
1844 the current line with any initial string matching the regexp
1845 `comint-prompt-regexp' removed."
1846 (let ((bof (field-beginning)))
1847 (if (eq (get-char-property bof 'field) 'input)
1848 (field-string-no-properties bof)
1849 (comint-bol)
1850 (buffer-substring-no-properties (point) (line-end-position)))))
1852 (defun comint-skip-prompt ()
1853 "Skip past the text matching regexp `comint-prompt-regexp'.
1854 If this takes us past the end of the current line, don't skip at all."
1855 (if (and (looking-at comint-prompt-regexp)
1856 (<= (match-end 0) (line-end-position)))
1857 (goto-char (match-end 0))))
1859 (defun comint-after-pmark-p ()
1860 "Return t if point is after the process output marker."
1861 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1862 (<= (marker-position pmark) (point))))
1864 (defun comint-simple-send (proc string)
1865 "Default function for sending to PROC input STRING.
1866 This just sends STRING plus a newline. To override this,
1867 set the hook `comint-input-sender'."
1868 (comint-send-string proc string)
1869 (if comint-input-sender-no-newline
1870 (if (not (string-equal string ""))
1871 (process-send-eof))
1874 (defun comint-line-beginning-position ()
1875 "Return the buffer position of the beginning of the line, after any prompt.
1876 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1877 prompt skip is done by skipping text matching the regular expression
1878 `comint-prompt-regexp', a buffer local variable."
1879 (if comint-use-prompt-regexp-instead-of-fields
1880 ;; Use comint-prompt-regexp
1881 (save-excursion
1882 (beginning-of-line)
1883 (comint-skip-prompt)
1884 (point))
1885 ;; Use input fields. Note that, unlike the behavior of
1886 ;; `line-beginning-position' inside a field, this function will
1887 ;; return the position of the end of a prompt, even if the point is
1888 ;; already inside the prompt. In order to do this, it assumes that
1889 ;; if there are two fields on a line, then the first one is the
1890 ;; prompt, and the second one is an input field, and is front-sticky
1891 ;; (as input fields should be).
1892 (constrain-to-field (line-beginning-position) (line-end-position))))
1894 (defun comint-bol (&optional arg)
1895 "Go to the beginning of line, then skip past the prompt, if any.
1897 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1898 prompt skip is done by skipping text matching the regular expression
1899 `comint-prompt-regexp', a buffer local variable."
1900 (interactive "P")
1901 (if arg
1902 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1903 (forward-line 0)
1904 (goto-char (comint-line-beginning-position))))
1906 ;; For compatibility.
1907 (defun comint-read-noecho (prompt &optional ignore)
1908 (read-passwd prompt))
1910 ;; These three functions are for entering text you don't want echoed or
1911 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1912 ;; Just enter m-x send-invisible and type in your line.
1914 (defun send-invisible (&optional prompt)
1915 "Read a string without echoing.
1916 Then send it to the process running in the current buffer.
1917 The string is sent using `comint-input-sender'.
1918 Security bug: your string can still be temporarily recovered with
1920 (interactive "P") ; Defeat snooping via C-x ESC ESC
1921 (let ((proc (get-buffer-process (current-buffer))))
1922 (if proc
1923 (let ((str (read-passwd (or prompt "Non-echoed text: "))))
1924 (if (stringp str)
1925 (progn
1926 (comint-snapshot-last-prompt)
1927 (funcall comint-input-sender proc str))
1928 (message "Warning: text will be echoed")))
1929 (error "Current buffer has no process"))))
1931 (defun comint-watch-for-password-prompt (string)
1932 "Prompt in the minibuffer for password and send without echoing.
1933 This function uses `send-invisible' to read and send a password to the buffer's
1934 process if STRING contains a password prompt defined by
1935 `comint-password-prompt-regexp'.
1937 This function could be in the list `comint-output-filter-functions'."
1938 (when (string-match comint-password-prompt-regexp string)
1940 (setq string (replace-match "" t t string)))
1941 (send-invisible string)))
1942 \f
1943 ;; Low-level process communication
1945 (defun comint-send-string (process string)
1946 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
1947 (if process
1948 (with-current-buffer (if (processp process)
1949 (process-buffer process)
1950 (get-buffer process))
1951 (comint-snapshot-last-prompt))
1952 (comint-snapshot-last-prompt))
1953 (process-send-string process string))
1955 (defun comint-send-region (process start end)
1956 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
1957 (if process
1958 (with-current-buffer (if (processp process)
1959 (process-buffer process)
1960 (get-buffer process))
1961 (comint-snapshot-last-prompt))
1962 (comint-snapshot-last-prompt))
1963 (process-send-region process start end))
1965 \f
1966 ;; Random input hackage
1968 (defun comint-delete-output ()
1969 "Delete all output from interpreter since last input.
1970 Does not delete the prompt."
1971 (interactive)
1972 (let ((proc (get-buffer-process (current-buffer)))
1973 (replacement nil)
1974 (inhibit-read-only t))
1975 (save-excursion
1976 (let ((pmark (progn (goto-char (process-mark proc))
1977 (forward-line 0)
1978 (point-marker))))
1979 (delete-region comint-last-input-end pmark)
1980 (goto-char (process-mark proc))
1982 (buffer-substring pmark (point))))
1983 (delete-region pmark (point))))
1984 ;; Output message and put back prompt
1985 (comint-output-filter proc replacement)))
1986 (defalias 'comint-kill-output 'comint-delete-output)
1987 (make-obsolete 'comint-kill-output 'comint-delete-output "21.1")
1989 (defun comint-write-output (filename &optional append mustbenew)
1990 "Write output from interpreter since last input to FILENAME.
1991 Any prompt at the end of the output is not written.
1993 If the optional argument APPEND (the prefix argument when interactive)
1994 is non-nil, the output is appended to the file instead.
1996 If the optional argument MUSTBENEW is non-nil, check for an existing
1997 file with the same name. If MUSTBENEW is `excl', that means to get an
1998 error if the file already exists; never overwrite. If MUSTBENEW is
1999 neither nil nor `excl', that means ask for confirmation before
2000 overwriting, but do go ahead and overwrite the file if the user
2001 confirms. When interactive, MUSTBENEW is nil when appending, and t
2002 otherwise."
2003 (interactive
2004 (list (read-file-name
2005 (if current-prefix-arg
2006 "Append output to file: "
2007 "Write output to file: "))
2008 current-prefix-arg
2009 (not current-prefix-arg)))
2010 (save-excursion
2011 (goto-char (process-mark (get-buffer-process (current-buffer))))
2012 (forward-line 0)
2013 (write-region comint-last-input-end (point) filename
2014 append nil nil mustbenew)))
2016 ;; This function exists for the benefit of the menu; from the keyboard,
2017 ;; users can just use `comint-write-output' with a prefix arg.
2018 (defun comint-append-output-to-file (filename)
2019 "Append output from interpreter since last input to FILENAME.
2020 Any prompt at the end of the output is not written."
2021 (interactive "fAppend output to file: ")
2022 (comint-write-output filename t))
2024 (defun comint-show-output ()
2025 "Display start of this batch of interpreter output at top of window.
2026 Sets mark to the value of point when this command is run."
2027 (interactive)
2028 (push-mark)
2029 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
2030 (cond (comint-use-prompt-regexp-instead-of-fields
2031 (goto-char pos)
2032 (beginning-of-line 0)
2033 (set-window-start (selected-window) (point))
2034 (comint-skip-prompt))
2035 (t
2036 (goto-char (field-beginning pos))
2037 (set-window-start (selected-window) (point))))))
2040 (defun comint-interrupt-subjob ()
2041 "Interrupt the current subjob.
2042 This command also kills the pending input
2043 between the process mark and point."
2044 (interactive)
2045 (comint-skip-input)
2046 (interrupt-process nil comint-ptyp)
2048 )
2050 (defun comint-kill-subjob ()
2051 "Send kill signal to the current subjob.
2052 This command also kills the pending input
2053 between the process mark and point."
2054 (interactive)
2055 (comint-skip-input)
2056 (kill-process nil comint-ptyp))
2058 (defun comint-quit-subjob ()
2059 "Send quit signal to the current subjob.
2060 This command also kills the pending input
2061 between the process mark and point."
2062 (interactive)
2063 (comint-skip-input)
2064 (quit-process nil comint-ptyp))
2066 (defun comint-stop-subjob ()
2067 "Stop the current subjob.
2068 This command also kills the pending input
2069 between the process mark and point.
2071 WARNING: if there is no current subjob, you can end up suspending
2072 the top-level process running in the buffer. If you accidentally do
2074 is not a problem with most shells, since they ignore this signal.)"
2075 (interactive)
2076 (comint-skip-input)
2077 (stop-process nil comint-ptyp))
2079 (defun comint-continue-subjob ()
2080 "Send CONT signal to process buffer's process group.
2081 Useful if you accidentally suspend the top-level process."
2082 (interactive)
2083 (continue-process nil comint-ptyp))
2085 (defun comint-skip-input ()
2086 "Skip all pending input, from last stuff output by interpreter to point.
2087 This means mark it as if it had been sent as input, without sending it."
2088 (let ((comint-input-sender 'ignore)
2089 (comint-input-filter-functions nil))
2090 (comint-send-input t))
2091 (end-of-line)
2092 (let ((pos (point))
2093 (marker (process-mark (get-buffer-process (current-buffer)))))
2094 (insert " " (key-description (this-command-keys)))
2095 (if (= marker pos)
2096 (set-marker marker (point)))))
2098 (defun comint-kill-input ()
2099 "Kill all text from last stuff output by interpreter to point."
2100 (interactive)
2101 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2102 (if (> (point) (marker-position pmark))
2103 (kill-region pmark (point)))))
2105 (defun comint-delchar-or-maybe-eof (arg)
2106 "Delete ARG characters forward or send an EOF to subprocess.
2107 Sends an EOF only if point is at the end of the buffer and there is no input."
2108 (interactive "p")
2109 (let ((proc (get-buffer-process (current-buffer))))
2110 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
2111 (comint-send-eof)
2112 (delete-char arg))))
2114 (defun comint-send-eof ()
2115 "Send an EOF to the current buffer's process."
2116 (interactive)
2117 (comint-send-input t)
2118 (process-send-eof))
2121 (defun comint-backward-matching-input (regexp n)
2122 "Search backward through buffer for input fields that match REGEXP.
2123 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2124 fields are identified by lines that match `comint-prompt-regexp'.
2126 With prefix argument N, search for Nth previous match.
2127 If N is negative, find the next or Nth next match."
2128 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2129 (if comint-use-prompt-regexp-instead-of-fields
2130 ;; Use comint-prompt-regexp
2131 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2132 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2133 (if (re-search-backward re nil t n)
2134 (point)))))
2135 (if (null pos)
2136 (progn (message "Not found")
2137 (ding))
2138 (goto-char pos)
2139 (comint-bol nil)))
2140 ;; Use input fields
2141 (let* ((dir (if (< n 0) -1 1))
2142 (pos
2143 (save-excursion
2144 (while (/= n 0)
2145 (unless (re-search-backward regexp nil t dir)
2146 (error "Not found"))
2147 (when (eq (get-char-property (point) 'field) 'input)
2148 (setq n (- n dir))))
2149 (field-beginning))))
2150 (goto-char pos))))
2153 (defun comint-forward-matching-input (regexp arg)
2154 "Search forward through buffer for input fields that match REGEXP.
2155 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2156 fields are identified by lines that match `comint-prompt-regexp'.
2158 With prefix argument N, search for Nth following match.
2159 If N is negative, find the previous or Nth previous match."
2160 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2161 (comint-backward-matching-input regexp (- arg)))
2164 (defun comint-next-prompt (n)
2165 "Move to end of Nth next prompt in the buffer.
2166 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2167 the beginning of the Nth next `input' field, otherwise, it means the Nth
2168 occurrence of text matching `comint-prompt-regexp'."
2169 (interactive "p")
2170 (if comint-use-prompt-regexp-instead-of-fields
2171 ;; Use comint-prompt-regexp
2172 (let ((paragraph-start comint-prompt-regexp))
2173 (end-of-line (if (> n 0) 1 0))
2174 (forward-paragraph n)
2175 (comint-skip-prompt))
2176 ;; Use input fields
2177 (let ((pos (point))
2178 (input-pos nil)
2179 prev-pos)
2180 (while (/= n 0)
2181 (setq prev-pos pos)
2182 (setq pos
2183 (if (> n 0)
2184 (next-single-char-property-change pos 'field)
2185 (previous-single-char-property-change pos 'field)))
2186 (cond ((or (null pos) (= pos prev-pos))
2187 ;; Ran off the end of the buffer.
2188 (when (> n 0)
2189 ;; There's always an input field at the end of the
2190 ;; buffer, but it has a `field' property of nil.
2191 (setq input-pos (point-max)))
2192 ;; stop iterating
2193 (setq n 0))
2194 ((eq (get-char-property pos 'field) 'input)
2195 (setq n (if (< n 0) (1+ n) (1- n)))
2196 (setq input-pos pos))))
2197 (when input-pos
2198 (goto-char input-pos)))))
2201 (defun comint-previous-prompt (n)
2202 "Move to end of Nth previous prompt in the buffer.
2203 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2204 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2205 occurrence of text matching `comint-prompt-regexp'."
2206 (interactive "p")
2207 (comint-next-prompt (- n)))
2209 ;; State used by `comint-insert-previous-argument' when cycling.
2210 (defvar comint-insert-previous-argument-last-start-pos nil)
2211 (make-variable-buffer-local 'comint-insert-previous-argument-last-start-pos)
2212 (defvar comint-insert-previous-argument-last-index nil)
2213 (make-variable-buffer-local 'comint-insert-previous-argument-last-index)
2215 ;; Needs fixing:
2216 ;; make comint-arguments understand negative indices as bash does
2217 (defun comint-insert-previous-argument (index)
2218 "Insert the INDEXth argument from the previous Comint command-line at point.
2219 Spaces are added at beginning and/or end of the inserted string if
2220 necessary to ensure that it's separated from adjacent arguments.
2221 Interactively, if no prefix argument is given, the last argument is inserted.
2222 Repeated interactive invocations will cycle through the same argument
2223 from progressively earlier commands (using the value of INDEX specified
2224 with the first command).
2225 This command is like `M-.' in bash."
2226 (interactive "P")
2227 (unless (null index)
2228 (setq index (prefix-numeric-value index)))
2229 (cond ((eq last-command this-command)
2230 ;; Delete last input inserted by this command.
2231 (delete-region comint-insert-previous-argument-last-start-pos (point))
2232 (setq index comint-insert-previous-argument-last-index))
2233 (t
2234 ;; This is a non-repeat invocation, so initialize state.
2235 (setq comint-input-ring-index nil)
2236 (setq comint-insert-previous-argument-last-index index)
2237 (when (null comint-insert-previous-argument-last-start-pos)
2238 ;; First usage; initialize to a marker
2239 (setq comint-insert-previous-argument-last-start-pos
2240 (make-marker)))))
2241 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2242 (if (<= (point) (comint-line-beginning-position))
2243 (comint-bol)
2244 (just-one-space))
2245 ;; Remember the beginning of what we insert, so we can delete it if
2246 ;; the command is repeated.
2247 (set-marker comint-insert-previous-argument-last-start-pos (point))
2248 ;; Insert the argument.
2249 (let ((input-string (comint-previous-input-string 0)))
2251 ;; strip terminating '&'
2252 (setq input-string (substring input-string 0 (match-beginning 0))))
2253 (insert (comint-arguments input-string index index)))
2254 ;; Make next invocation return arg from previous input
2255 (setq comint-input-ring-index (1+ (or comint-input-ring-index 0)))
2256 ;; Add a terminating space if necessary.
2257 (unless (eolp)
2258 (just-one-space)))
2260 \f
2261 ;; Support editing with `comint-prompt-read-only' set to t.
2263 (defun comint-update-fence ()
2264 "Update read-only status of newline before point.
2265 The `fence' read-only property is used to indicate that a newline
2267 following front-sticky read-only region. This is used to
2268 implement comint read-only prompts. If the text after a newline
2269 changes, the read-only status of that newline may need updating.
2270 That is what this function does.
2272 This function does nothing if point is not at the beginning of a
2273 line, or is at the beginning of the accessible portion of the buffer.
2274 Otherwise, if the character after point has a front-sticky
2275 read-only property, then the preceding newline is given a
2276 read-only property of `fence', unless it already is read-only.
2277 If the character after point does not have a front-sticky
2278 read-only property, any read-only property of `fence' on the
2279 preceding newline is removed."
2280 (let* ((pt (point)) (lst (get-text-property pt 'front-sticky))
2281 (inhibit-modification-hooks t))
2282 (and (bolp)
2283 (not (bobp))
2284 (if (and (get-text-property pt 'read-only)
2285 (if (listp lst) (memq 'read-only lst) t))
2286 (unless (get-text-property (1- pt) 'read-only)
2287 (put-text-property (1- pt) pt 'read-only 'fence))
2288 (when (eq (get-text-property (1- pt) 'read-only) 'fence)
2289 (remove-list-of-text-properties (1- pt) pt '(read-only)))))))
2291 (defun comint-kill-whole-line (&optional arg)
2292 "Kill current line, ignoring read-only and field properties.
2293 With prefix arg, kill that many lines starting from the current line.
2294 If arg is negative, kill backward. Also kill the preceding newline,
2296 with negative arguments.)
2297 If arg is zero, kill current line but exclude the trailing newline.
2298 The read-only status of newlines is updated with `comint-update-fence',
2299 if necessary."
2300 (interactive "p")
2301 (let ((inhibit-read-only t) (inhibit-field-text-motion t))
2302 (kill-whole-line arg)
2303 (when (>= arg 0) (comint-update-fence))))
2305 (defun comint-kill-region (beg end &optional yank-handler)
2306 "Like `kill-region', but ignores read-only properties, if safe.
2307 This command assumes that the buffer contains read-only
2309 properties at the beginning of a line, with the preceding newline
2310 being read-only to protect the prompt. This is true of the
2311 comint prompts if `comint-prompt-read-only' is non-nil. This
2312 command will not delete the region if this would create mutilated
2313 or out of place prompts. That is, if any part of a prompt is
2314 deleted, the entire prompt must be deleted and all remaining
2315 prompts should stay at the beginning of a line. If this is not
2316 the case, this command just calls `kill-region' with all
2317 read-only properties intact. The read-only status of newlines is
2318 updated using `comint-update-fence', if necessary."
2319 (interactive "r")
2320 (save-excursion
2321 (let* ((true-beg (min beg end))
2322 (true-end (max beg end))
2323 (beg-bolp (progn (goto-char true-beg) (bolp)))
2324 (beg-lst (get-text-property true-beg 'front-sticky))
2325 (beg-bad (and (get-text-property true-beg 'read-only)
2326 (if (listp beg-lst) (memq 'read-only beg-lst) t)))
2327 (end-bolp (progn (goto-char true-end) (bolp)))
2328 (end-lst (get-text-property true-end 'front-sticky))
2329 (end-bad (and (get-text-property true-end 'read-only)
2330 (if (listp end-lst) (memq 'read-only end-lst) t))))
2331 (if (or (and (not beg-bolp) (or beg-bad end-bad))
2332 (and (not end-bolp) end-bad))
2333 (kill-region beg end yank-handler)
2334 (let ((inhibit-read-only t))
2335 (kill-region beg end yank-handler)
2336 (comint-update-fence))))))
2338 \f
2339 ;; Support for source-file processing commands.
2340 ;;============================================================================
2341 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2342 ;; commands that process files of source text (e.g. loading or compiling
2343 ;; files). So the corresponding process-in-a-buffer modes have commands
2344 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2345 ;; for defining these commands.
2346 ;;
2347 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2348 ;; and Soar, in that they don't know anything about file extensions.
2349 ;; So the compile/load interface gets the wrong default occasionally.
2350 ;; The load-file/compile-file default mechanism could be smarter -- it
2351 ;; doesn't know about the relationship between filename extensions and
2352 ;; whether the file is source or executable. If you compile foo.lisp
2353 ;; with compile-file, then the next load-file should use foo.bin for
2354 ;; the default, not foo.lisp. This is tricky to do right, particularly
2355 ;; because the extension for executable files varies so much (.o, .bin,
2356 ;; .lbin, .mo, .vo, .ao, ...).
2359 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2360 ;; commands.
2361 ;;
2362 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2363 ;; want to save the buffer before issuing any process requests to the command
2364 ;; interpreter.
2365 ;;
2366 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2367 ;; for the file to process.
2369 (defun comint-source-default (previous-dir/file source-modes)
2370 "Compute the defaults for `load-file' and `compile-file' commands.
2372 PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2373 source-file processing command. nil if there hasn't been one yet.
2374 SOURCE-MODES is a list used to determine what buffers contain source
2375 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2376 Typically, (lisp-mode) or (scheme-mode).
2378 If the command is given while the cursor is inside a string, *and*
2379 the string is an existing filename, *and* the filename is not a directory,
2380 then the string is taken as default. This allows you to just position
2381 your cursor over a string that's a filename and have it taken as default.
2383 If the command is given in a file buffer whose major mode is in
2384 SOURCE-MODES, then the filename is the default file, and the
2385 file's directory is the default directory.
2387 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2388 then the default directory & file are what was used in the last source-file
2389 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2390 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2393 SOURCE-REGEXP is typically going to be something like (tea-mode)
2394 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2395 for Soar programs, etc.
2397 The function returns a pair: (default-directory . default-file)."
2398 (cond ((and buffer-file-name (memq major-mode source-modes))
2399 (cons (file-name-directory buffer-file-name)
2400 (file-name-nondirectory buffer-file-name)))
2401 (previous-dir/file)
2402 (t
2403 (cons default-directory nil))))
2406 (defun comint-check-source (fname)
2407 "Check whether to save buffers visiting file FNAME.
2408 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2409 process-in-a-buffer modes), this function can be called on the filename.
2410 If the file is loaded into a buffer, and the buffer is modified, the user
2411 is queried to see if he wants to save the buffer before proceeding with
2412 the load or compile."
2413 (let ((buff (get-file-buffer fname)))
2414 (if (and buff
2415 (buffer-modified-p buff)
2416 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
2417 ;; save BUFF.
2418 (let ((old-buffer (current-buffer)))
2419 (set-buffer buff)
2420 (save-buffer)
2421 (set-buffer old-buffer)))))
2423 (defun comint-extract-string ()
2424 "Return string around POINT, or nil."
2425 (let ((syntax (syntax-ppss)))
2426 (when (nth 3 syntax)
2427 (condition-case ()
2428 (buffer-substring-no-properties (1+ (nth 8 syntax))
2429 (progn (goto-char (nth 8 syntax))
2430 (forward-sexp)
2431 (1- (point))))
2432 (error nil)))))
2434 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2435 "Prompt for filenames in commands that process source files,
2436 e.g. loading or compiling a file.
2437 Provides a default, if there is one, and returns the result filename.
2439 See `comint-source-default' for more on determining defaults.
2441 PROMPT is the prompt string. PREV-DIR/FILE is the (DIRECTORY . FILE) pair
2442 from the last source processing command. SOURCE-MODES is a list of major
2443 modes used to determine what file buffers contain source files. (These
2444 two arguments are used for determining defaults). If MUSTMATCH-P is true,
2445 then the filename reader will only accept a file that exists.
2447 A typical use:
2449 '(lisp-mode) t))"
2450 (let* ((def (comint-source-default prev-dir/file source-modes))
2451 (stringfile (comint-extract-string))
2452 (sfile-p (and stringfile
2453 (condition-case ()
2454 (file-exists-p stringfile)
2455 (error nil))
2456 (not (file-directory-p stringfile))))
2457 (defdir (if sfile-p (file-name-directory stringfile)
2458 (car def)))
2459 (deffile (if sfile-p (file-name-nondirectory stringfile)
2460 (cdr def)))
2461 (ans (read-file-name (if deffile (format "%s(default %s) "
2462 prompt deffile)
2463 prompt)
2464 defdir
2465 (concat defdir deffile)
2466 mustmatch-p)))
2467 (list (expand-file-name (substitute-in-file-name ans)))))
2469 ;; I am somewhat divided on this string-default feature. It seems
2470 ;; to violate the principle-of-least-astonishment, in that it makes
2471 ;; the default harder to predict, so you actually have to look and see
2472 ;; what the default really is before choosing it. This can trip you up.
2473 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2474 ;; on this.
2475 ;; -Olin
2477 \f
2478 ;; Simple process query facility.
2479 ;; ===========================================================================
2480 ;; This function is for commands that want to send a query to the process
2481 ;; and show the response to the user. For example, a command to get the
2482 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2483 ;; to an inferior Common Lisp process.
2484 ;;
2485 ;; This simple facility just sends strings to the inferior process and pops
2486 ;; up a window for the process buffer so you can see what the process
2487 ;; responds with. We don't do anything fancy like try to intercept what the
2488 ;; process responds with and put it in a pop-up window or on the message
2489 ;; line. We just display the buffer. Low tech. Simple. Works good.
2491 (defun comint-proc-query (proc str)
2492 "Send to the inferior process PROC the string STR.
2493 Pop-up but do not select a window for the inferior process so that
2494 its response can be seen."
2495 (let* ((proc-buf (process-buffer proc))
2496 (proc-mark (process-mark proc)))
2497 (display-buffer proc-buf)
2498 (set-buffer proc-buf) ; but it's not the selected *window*
2499 (let ((proc-win (get-buffer-window proc-buf))
2500 (proc-pt (marker-position proc-mark)))
2501 (comint-send-string proc str) ; send the query
2502 (accept-process-output proc) ; wait for some output
2503 ;; Try to position the proc window so you can see the answer.
2504 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2505 ;; I don't know why. Wizards invited to improve it.
2506 (unless (pos-visible-in-window-p proc-pt proc-win)
2507 (let ((opoint (window-point proc-win)))
2508 (set-window-point proc-win proc-mark)
2509 (sit-for 0)
2510 (if (not (pos-visible-in-window-p opoint proc-win))
2511 (push-mark opoint)
2512 (set-window-point proc-win opoint)))))))
2514 \f
2515 ;; Filename/command/history completion in a buffer
2516 ;; ===========================================================================
2517 ;; Useful completion functions, courtesy of the Ergo group.
2519 ;; Six commands:
2520 ;; comint-dynamic-complete Complete or expand command, filename,
2521 ;; history at point.
2522 ;; comint-dynamic-complete-filename Complete filename at point.
2523 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2524 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2525 ;; replace with expanded/completed name.
2526 ;; comint-dynamic-simple-complete Complete stub given candidates.
2528 ;; These are not installed in the comint-mode keymap. But they are
2529 ;; available for people who want them. Shell-mode installs them:
2531 ;; (define-key shell-mode-map "\M-?"
2532 ;; 'comint-dynamic-list-filename-completions)))
2533 ;;
2534 ;; Commands like this are fine things to put in load hooks if you
2535 ;; want them present in specific modes.
2537 (defcustom comint-completion-autolist nil
2538 "*If non-nil, automatically list possibilities on partial completion.
2539 This mirrors the optional behavior of tcsh."
2540 :type 'boolean
2541 :group 'comint-completion)
2543 (defcustom comint-completion-addsuffix t
2544 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2545 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2546 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2547 This mirrors the optional behavior of tcsh."
2548 :type '(choice (const :tag "None" nil)
2549 (const :tag "Add /" t)
2550 (cons :tag "Suffix pair"
2551 (string :tag "Directory suffix")
2552 (string :tag "File suffix")))
2553 :group 'comint-completion)
2555 (defcustom comint-completion-recexact nil
2556 "*If non-nil, use shortest completion if characters cannot be added.
2557 This mirrors the optional behavior of tcsh.
2559 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2560 :type 'boolean
2561 :group 'comint-completion)
2563 (defcustom comint-completion-fignore nil
2564 "*List of suffixes to be disregarded during file completion.
2565 This mirrors the optional behavior of bash and tcsh.
2567 Note that this applies to `comint-dynamic-complete-filename' only."
2568 :type '(repeat (string :tag "Suffix"))
2569 :group 'comint-completion)
2571 (defvar comint-file-name-prefix ""
2572 "Prefix prepended to absolute file names taken from process input.
2573 This is used by Comint's and shell's completion functions, and by shell's
2574 directory tracking functions.")
2576 (defvar comint-file-name-chars
2577 (if (memq system-type '(ms-dos windows-nt cygwin))
2578 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2579 "[]~/A-Za-z0-9+@:_.$#%,={}-")
2580 "String of characters valid in a file name.
2581 Note that all non-ASCII characters are considered valid in a file name
2582 regardless of what this variable says.
2584 This is a good thing to set in mode hooks.")
2586 (defvar comint-file-name-quote-list nil
2589 This is a good thing to set in mode hooks.")
2592 (defun comint-directory (directory)
2593 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
2594 (expand-file-name (if (file-name-absolute-p directory)
2595 (concat comint-file-name-prefix directory)
2596 directory)))
2599 (defun comint-word (word-chars)
2600 "Return the word of WORD-CHARS at point, or nil if none is found.
2601 Word constituents are considered to be those in WORD-CHARS, which is like the
2603 plus all non-ASCII characters."
2604 (save-excursion
2605 (let ((here (point))
2606 giveup)
2607 (while (not giveup)
2608 (let ((startpoint (point)))
2610 ;; Fixme: This isn't consistent with Bash, at least -- not
2611 ;; all non-ASCII chars should be word constituents.
2612 (if (and (> (- (point) 2) (point-min))
2614 (forward-char -2))
2615 (if (and (> (- (point) 1) (point-min))
2616 (>= (char-after (- (point) 1)) 128))
2617 (forward-char -1))
2618 (if (= (point) startpoint)
2619 (setq giveup t))))
2620 ;; Set match-data to match the entire string.
2621 (when (< (point) here)
2622 (set-match-data (list (point) here))
2623 (match-string 0)))))
2625 (defun comint-substitute-in-file-name (filename)
2626 "Return FILENAME with environment variables substituted.
2627 Supports additional environment variable syntax of the command
2628 interpreter (e.g., the percent notation of cmd.exe on NT)."
2629 (let ((name (substitute-in-file-name filename)))
2630 (if (memq system-type '(ms-dos windows-nt))
2631 (let (env-var-name
2632 env-var-val)
2633 (save-match-data
2635 (setq env-var-name
2636 (substring name (match-beginning 1) (match-end 1)))
2637 (setq env-var-val (if (getenv env-var-name)
2638 (getenv env-var-name)
2639 ""))
2640 (setq name (replace-match env-var-val t t name))))))
2641 name))
2643 (defun comint-match-partial-filename ()
2644 "Return the filename at point, or nil if non is found.
2645 Environment variables are substituted. See `comint-word'."
2646 (let ((filename (comint-word comint-file-name-chars)))
2647 (and filename (comint-substitute-in-file-name
2648 (comint-unquote-filename filename)))))
2651 (defun comint-quote-filename (filename)
2652 "Return FILENAME with magic characters quoted.
2653 Magic characters are those in `comint-file-name-quote-list'."
2654 (if (null comint-file-name-quote-list)
2655 filename
2656 (let ((regexp
2657 (format "[%s]"
2658 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
2659 (save-match-data
2660 (let ((i 0))
2661 (while (string-match regexp filename i)
2663 (setq i (1+ (match-end 0)))))
2664 filename))))
2666 (defun comint-unquote-filename (filename)
2667 "Return FILENAME with quoted characters unquoted."
2668 (if (null comint-file-name-quote-list)
2669 filename
2670 (save-match-data
2671 (let ((i 0))
2674 (setq i (+ 1 (match-beginning 0)))))
2675 filename)))
2678 (defun comint-dynamic-complete ()
2679 "Dynamically perform completion at point.
2680 Calls the functions in `comint-dynamic-complete-functions' to perform
2681 completion until a function returns non-nil, at which point completion is
2682 assumed to have occurred."
2683 (interactive)
2684 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
2687 (defun comint-dynamic-complete-filename ()
2688 "Dynamically complete the filename at point.
2689 Completes if after a filename. See `comint-match-partial-filename' and
2690 `comint-dynamic-complete-as-filename'.
2691 This function is similar to `comint-replace-by-expanded-filename', except that
2692 it won't change parts of the filename already entered in the buffer; it just
2693 adds completion characters to the end of the filename. A completions listing
2694 may be shown in a help buffer if completion is ambiguous.
2696 Completion is dependent on the value of `comint-completion-addsuffix',
2697 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2698 completions listing is dependent on the value of `comint-completion-autolist'.
2700 Returns t if successful."
2701 (interactive)
2702 (when (comint-match-partial-filename)
2703 (unless (window-minibuffer-p (selected-window))
2704 (message "Completing file name..."))
2705 (comint-dynamic-complete-as-filename)))
2707 (defun comint-dynamic-complete-as-filename ()
2708 "Dynamically complete at point as a filename.
2709 See `comint-dynamic-complete-filename'. Returns t if successful."
2710 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2711 (completion-ignored-extensions comint-completion-fignore)
2712 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2713 ;; I think it was originally bound to solve file completion problems,
2714 ;; but subsequent changes may have made this unnecessary. sm.
2715 ;;(file-name-handler-alist nil)
2716 (minibuffer-p (window-minibuffer-p (selected-window)))
2717 (success t)
2718 (dirsuffix (cond ((not comint-completion-addsuffix)
2719 "")
2720 ((not (consp comint-completion-addsuffix))
2721 "/")
2722 (t
2723 (car comint-completion-addsuffix))))
2724 (filesuffix (cond ((not comint-completion-addsuffix)
2725 "")
2726 ((not (consp comint-completion-addsuffix))
2727 " ")
2728 (t
2729 (cdr comint-completion-addsuffix))))
2730 (filename (or (comint-match-partial-filename) ""))
2731 (filedir (file-name-directory filename))
2732 (filenondir (file-name-nondirectory filename))
2733 (directory (if filedir (comint-directory filedir) default-directory))
2734 (completion (file-name-completion filenondir directory)))
2735 (cond ((null completion)
2736 (message "No completions of %s" filename)
2737 (setq success nil))
2738 ((eq completion t) ; Means already completed "file".
2739 (insert filesuffix)
2740 (unless minibuffer-p
2741 (message "Sole completion")))
2742 ((string-equal completion "") ; Means completion on "directory/".
2743 (comint-dynamic-list-filename-completions))
2744 (t ; Completion string returned.
2745 (let ((file (concat (file-name-as-directory directory) completion)))
2746 (insert (comint-quote-filename
2747 (substring (directory-file-name completion)
2748 (length filenondir))))
2749 (cond ((symbolp (file-name-completion completion directory))
2750 ;; We inserted a unique completion.
2751 (insert (if (file-directory-p file) dirsuffix filesuffix))
2752 (unless minibuffer-p
2753 (message "Completed")))
2754 ((and comint-completion-recexact comint-completion-addsuffix
2755 (string-equal filenondir completion)
2756 (file-exists-p file))
2757 ;; It's not unique, but user wants shortest match.
2758 (insert (if (file-directory-p file) dirsuffix filesuffix))
2759 (unless minibuffer-p
2760 (message "Completed shortest")))
2761 ((or comint-completion-autolist
2762 (string-equal filenondir completion))
2763 ;; It's not unique, list possible completions.
2764 (comint-dynamic-list-filename-completions))
2765 (t
2766 (unless minibuffer-p
2767 (message "Partially completed")))))))
2768 success))
2771 (defun comint-replace-by-expanded-filename ()
2772 "Dynamically expand and complete the filename at point.
2773 Replace the filename with an expanded, canonicalised and completed replacement.
2776 removed, and the filename is made absolute instead of relative. For expansion
2777 see `expand-file-name' and `substitute-in-file-name'. For completion see
2778 `comint-dynamic-complete-filename'."
2779 (interactive)
2780 (let ((filename (comint-match-partial-filename)))
2781 (when filename
2782 (replace-match (expand-file-name filename) t t)
2783 (comint-dynamic-complete-filename))))
2786 (defun comint-dynamic-simple-complete (stub candidates)
2787 "Dynamically complete STUB from CANDIDATES list.
2788 This function inserts completion characters at point by completing STUB from
2789 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2790 if completion is ambiguous.
2792 Returns nil if no completion was inserted.
2793 Returns `sole' if completed with the only completion match.
2794 Returns `shortest' if completed with the shortest of the completion matches.
2795 Returns `partial' if completed as far as possible with the completion matches.
2796 Returns `listed' if a completion listing was shown.
2798 See also `comint-dynamic-complete-filename'."
2799 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2800 (suffix (cond ((not comint-completion-addsuffix) "")
2801 ((not (consp comint-completion-addsuffix)) " ")
2802 (t (cdr comint-completion-addsuffix))))
2803 (completions (all-completions stub candidates)))
2804 (cond ((null completions)
2805 (message "No completions of %s" stub)
2806 nil)
2807 ((= 1 (length completions)) ; Gotcha!
2808 (let ((completion (car completions)))
2809 (if (string-equal completion stub)
2810 (message "Sole completion")
2811 (insert (substring completion (length stub)))
2812 (message "Completed"))
2813 (insert suffix)
2814 'sole))
2815 (t ; There's no unique completion.
2816 (let ((completion (try-completion stub candidates)))
2817 ;; Insert the longest substring.
2818 (insert (substring completion (length stub)))
2819 (cond ((and comint-completion-recexact comint-completion-addsuffix
2820 (string-equal stub completion)
2821 (member completion completions))
2822 ;; It's not unique, but user wants shortest match.
2823 (insert suffix)
2824 (message "Completed shortest")
2825 'shortest)
2826 ((or comint-completion-autolist
2827 (string-equal stub completion))
2828 ;; It's not unique, list possible completions.
2829 (comint-dynamic-list-completions completions)
2830 'listed)
2831 (t
2832 (message "Partially completed")
2833 'partial)))))))
2836 (defun comint-dynamic-list-filename-completions ()
2837 "List in help buffer possible completions of the filename at point."
2838 (interactive)
2839 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2840 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2841 ;; I think it was originally bound to solve file completion problems,
2842 ;; but subsequent changes may have made this unnecessary. sm.
2843 ;;(file-name-handler-alist nil)
2844 (filename (or (comint-match-partial-filename) ""))
2845 (filedir (file-name-directory filename))
2846 (filenondir (file-name-nondirectory filename))
2847 (directory (if filedir (comint-directory filedir) default-directory))
2848 (completions (file-name-all-completions filenondir directory)))
2849 (if (not completions)
2850 (message "No completions of %s" filename)
2851 (comint-dynamic-list-completions
2852 (mapcar 'comint-quote-filename completions)))))
2855 ;; This is bound locally in a *Completions* buffer to the list of
2856 ;; completions displayed, and is used to detect the case where the same
2857 ;; command is repeatedly used without the set of completions changing.
2858 (defvar comint-displayed-dynamic-completions nil)
2860 (defvar comint-dynamic-list-completions-config nil)
2862 (defun comint-dynamic-list-completions (completions)
2863 "List in help buffer sorted COMPLETIONS.
2864 Typing SPC flushes the help buffer."
2865 (let ((window (get-buffer-window "*Completions*")))
2866 (setq completions (sort completions 'string-lessp))
2867 (if (and (eq last-command this-command)
2868 window (window-live-p window) (window-buffer window)
2869 (buffer-name (window-buffer window))
2870 ;; The above tests are not sufficient to detect the case where we
2871 ;; should scroll, because the top-level interactive command may
2872 ;; not have displayed a completions window the last time it was
2873 ;; invoked, and there may be such a window left over from a
2874 ;; previous completion command with a different set of
2875 ;; completions. To detect that case, we also test that the set
2876 ;; of displayed completions is in fact the same as the previously
2877 ;; displayed set.
2878 (equal completions
2879 (buffer-local-value 'comint-displayed-dynamic-completions
2880 (window-buffer window))))
2881 ;; If this command was repeated, and
2882 ;; there's a fresh completion window with a live buffer,
2883 ;; and this command is repeated, scroll that window.
2884 (with-current-buffer (window-buffer window)
2885 (if (pos-visible-in-window-p (point-max) window)
2886 (set-window-start window (point-min))
2887 (save-selected-window
2888 (select-window window)
2889 (scroll-up))))
2891 ;; Display a completion list for the first time.
2892 (setq comint-dynamic-list-completions-config
2893 (current-window-configuration))
2894 (with-output-to-temp-buffer "*Completions*"
2895 (display-completion-list completions))
2896 (message "Type space to flush; repeat completion command to scroll"))
2898 ;; Read the next key, to process SPC.
2899 (let (key first)
2900 (if (with-current-buffer (get-buffer "*Completions*")
2901 (set (make-local-variable 'comint-displayed-dynamic-completions)
2902 completions)
2903 (setq key (read-key-sequence nil)
2904 first (aref key 0))
2905 (and (consp first) (consp (event-start first))
2906 (eq (window-buffer (posn-window (event-start first)))
2907 (get-buffer "*Completions*"))
2908 (eq (key-binding key) 'mouse-choose-completion)))
2909 ;; If the user does mouse-choose-completion with the mouse,
2910 ;; execute the command, then delete the completion window.
2911 (progn
2912 (mouse-choose-completion first)
2913 (set-window-configuration comint-dynamic-list-completions-config))
2914 (unless (eq first ?\ )
2915 (setq unread-command-events (listify-key-sequence key)))
2917 (set-window-configuration comint-dynamic-list-completions-config))))))
2919 \f
2920 (defun comint-get-next-from-history ()
2921 "After fetching a line from input history, this fetches the following line.
2922 In other words, this recalls the input line after the line you recalled last.
2923 You can use this to repeat a sequence of input lines."
2924 (interactive)
2925 (if comint-save-input-ring-index
2926 (progn
2927 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
2928 (comint-next-input 1))
2929 (message "No previous history command")))
2931 (defun comint-accumulate ()
2932 "Accumulate a line to send as input along with more lines.
2933 This inserts a newline so that you can enter more text
2935 to send all the accumulated input, at once.
2936 The entire accumulated text becomes one item in the input history
2937 when you send it."
2938 (interactive)
2940 (set-marker comint-accum-marker (point))
2941 (if comint-input-ring-index
2942 (setq comint-save-input-ring-index
2943 (- comint-input-ring-index 1))))
2945 (defun comint-goto-process-mark ()
2946 "Move point to the process mark.
2947 The process mark separates output, and input already sent,
2948 from input that has not yet been sent."
2949 (interactive)
2950 (let ((proc (or (get-buffer-process (current-buffer))
2951 (error "Current buffer has no process"))))
2952 (goto-char (process-mark proc))
2953 (when (interactive-p)
2954 (message "Point is now at the process mark"))))
2956 (defun comint-bol-or-process-mark ()
2957 "Move point to beginning of line (after prompt) or to the process mark.
2958 The first time you use this command, it moves to the beginning of the line
2959 \(but after the prompt, if any). If you repeat it again immediately,
2960 it moves point to the process mark.
2962 The process mark separates the process output, along with input already sent,
2963 from input that has not yet been sent. Ordinarily, the process mark
2964 is at the beginning of the current input line; but if you have
2966 the process mark is at the beginning of the accumulated input."
2967 (interactive)
2968 (if (not (eq last-command 'comint-bol-or-process-mark))
2969 (comint-bol nil)
2970 (comint-goto-process-mark)))
2972 (defun comint-set-process-mark ()
2973 "Set the process mark at point."
2974 (interactive)
2975 (let ((proc (or (get-buffer-process (current-buffer))
2976 (error "Current buffer has no process"))))
2977 (set-marker (process-mark proc) (point))
2978 (message "Process mark set")))
2980 \f
2981 ;; Author: Peter Breton <pbreton@cs.umb.edu>
2983 ;; This little add-on for comint is intended to make it easy to get
2984 ;; output from currently active comint buffers into another buffer,
2985 ;; or buffers, and then go back to using the comint shell.
2986 ;;
2987 ;; My particular use is SQL interpreters; I want to be able to execute a
2988 ;; query using the process associated with a comint-buffer, and save that
2989 ;; somewhere else. Because the process might have state (for example, it
2990 ;; could be in an uncommitted transaction), just running starting a new
2991 ;; process and having it execute the query and then finish, would not
2992 ;; work. I'm sure there are other uses as well, although in many cases
2993 ;; starting a new process is the simpler, and thus preferable, approach.
2994 ;;
2995 ;; The basic implementation is as follows: comint-redirect changes the
2996 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
2997 ;; its own filter. The filter puts the output into the designated buffer,
2998 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2999 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
3000 ;; sees the stop regexp, it restores the old filter functions, and runs
3001 ;; `comint-redirect-hook'.
3002 ;;
3003 ;; Each comint buffer may only use one redirection at a time, but any number
3004 ;; of different comint buffers may be simultaneously redirected.
3005 ;;
3006 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
3007 ;; correct prompt for your interpreter, or that you supply a regexp that says
3008 ;; when the redirection is finished. Otherwise, redirection will continue
3009 ;; indefinitely. The code now does a sanity check to ensure that it can find
3010 ;; a prompt in the comint buffer; however, it is still important to ensure that
3011 ;; this prompt is set correctly.
3012 ;;
3013 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
3014 ;; perhaps it should prompt for a terminating string (with an
3015 ;; appropriate magic default by examining what we think is the prompt)?
3016 ;;
3017 ;; Fixme: look for appropriate fields, rather than regexp, if
3018 ;; `comint-use-prompt-regexp-instead-of-fields' is true.
3020 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3021 ;; Variables
3022 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3024 (defcustom comint-redirect-verbose nil
3025 "*If non-nil, print messages each time the redirection filter is invoked.
3026 Also print a message when redirection is completed."
3027 :group 'comint
3028 :type 'boolean)
3030 ;; Directly analagous to comint-preoutput-filter-functions
3031 (defvar comint-redirect-filter-functions nil
3032 "List of functions to call before inserting redirected process output.
3033 Each function gets one argument, a string containing the text received
3034 from the subprocess. It should return the string to insert, perhaps
3035 the same string that was received, or perhaps a modified or transformed
3036 string.
3038 The functions on the list are called sequentially, and each one is given
3039 the string returned by the previous one. The string returned by the
3040 last function is the text that is actually inserted in the redirection buffer.
3042 You can use `add-hook' to add functions to this list
3043 either globally or locally.")
3045 ;; Internal variables
3047 (defvar comint-redirect-output-buffer nil
3048 "The buffer or list of buffers to put output into.")
3050 (defvar comint-redirect-finished-regexp nil
3051 "Regular expression that determines when to stop redirection in Comint.
3052 When the redirection filter function is given output that matches this regexp,
3053 the output is inserted as usual, and redirection is completed.")
3055 (defvar comint-redirect-insert-matching-regexp nil
3056 "If non-nil, the text that ends a redirection is included in it.
3057 More precisely, the text that matches `comint-redirect-finished-regexp'
3058 and therefore terminates an output redirection is inserted in the
3059 redirection target buffer, along with the preceding output.")
3061 (defvar comint-redirect-echo-input nil
3062 "Non-nil means echo input in the process buffer even during redirection.")
3064 (defvar comint-redirect-completed nil
3065 "Non-nil if redirection has completed in the current buffer.")
3067 (defvar comint-redirect-original-mode-line-process nil
3068 "Original mode line for redirected process.")
3070 (defvar comint-redirect-perform-sanity-check t
3071 "If non-nil, check that redirection is likely to complete successfully.
3072 More precisely, before starting a redirection, verify that the
3073 regular expression `comint-redirect-finished-regexp' that controls
3074 when to terminate it actually matches some text already in the process
3075 buffer. The idea is that this regular expression should match a prompt
3076 string, and that there ought to be at least one copy of your prompt string
3077 in the process buffer already.")
3079 (defvar comint-redirect-original-filter-function nil
3080 "The process filter that was in place when redirection is started.
3081 When redirection is completed, the process filter is restored to
3082 this value.")
3084 (defvar comint-redirect-subvert-readonly nil
3085 "Non-nil means comint-redirect can insert into otherwise-readonly buffers.
3086 The readonly status is toggled around insertion.
3087 This is useful, for instance, for insertion into Help mode buffers.
3088 You probably want to set it locally to the output buffer.")
3090 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3091 ;; Functions
3092 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3094 (defun comint-redirect-setup (output-buffer
3095 comint-buffer
3096 finished-regexp
3097 &optional echo-input)
3098 "Set up for output redirection.
3099 This function sets local variables that are used by `comint-redirect-filter'
3100 to perform redirection.
3102 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3103 in the output matches FINISHED-REGEXP.
3105 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3106 original Comint buffer.
3108 This function is called by `comint-redirect-send-command-to-process',
3109 and does not normally need to be invoked by the end user or programmer."
3110 (with-current-buffer comint-buffer
3112 (make-local-variable 'comint-redirect-original-mode-line-process)
3113 (setq comint-redirect-original-mode-line-process mode-line-process)
3115 (make-local-variable 'comint-redirect-output-buffer)
3116 (setq comint-redirect-output-buffer output-buffer)
3118 (make-local-variable 'comint-redirect-finished-regexp)
3119 (setq comint-redirect-finished-regexp finished-regexp)
3121 (make-local-variable 'comint-redirect-echo-input)
3122 (setq comint-redirect-echo-input echo-input)
3124 (make-local-variable 'comint-redirect-completed)
3125 (setq comint-redirect-completed nil)
3127 (setq mode-line-process
3128 (if mode-line-process
3129 (list (concat (elt mode-line-process 0) " Redirection"))
3130 (list ":%s Redirection")))))
3132 (defun comint-redirect-cleanup ()
3133 "End a Comint redirection. See `comint-redirect-send-command'."
3134 (interactive)
3135 ;; Restore the process filter
3136 (set-process-filter (get-buffer-process (current-buffer))
3137 comint-redirect-original-filter-function)
3138 ;; Restore the mode line
3139 (setq mode-line-process comint-redirect-original-mode-line-process)
3140 ;; Set the completed flag
3141 (setq comint-redirect-completed t))
3143 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3144 ;; that it really occurs.
3145 (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
3147 (defun comint-redirect-filter (process input-string)
3148 "Filter function which redirects output from PROCESS to a buffer or buffers.
3149 The variable `comint-redirect-output-buffer' says which buffer(s) to
3150 place output in.
3152 INPUT-STRING is the input from the Comint process.
3154 This function runs as a process filter, and does not need to be invoked by the
3155 end user."
3156 (and process
3157 (with-current-buffer (process-buffer process)
3158 (comint-redirect-preoutput-filter input-string)
3159 ;; If we have to echo output, give it to the original filter function
3160 (and comint-redirect-echo-input
3161 comint-redirect-original-filter-function
3162 (funcall comint-redirect-original-filter-function
3163 process input-string)))))
3166 (defun comint-redirect-preoutput-filter (input-string)
3167 "Comint filter function which redirects Comint output to a buffer or buffers.
3168 The variable `comint-redirect-output-buffer' says which buffer(s) to
3169 place output in.
3171 INPUT-STRING is the input from the Comint process.
3173 This function does not need to be invoked by the end user."
3174 (let ((output-buffer-list
3175 (if (listp comint-redirect-output-buffer)
3176 comint-redirect-output-buffer
3177 (list comint-redirect-output-buffer)))
3178 (filtered-input-string input-string))
3180 ;; If there are any filter functions, give them a chance to modify the string
3181 (let ((functions comint-redirect-filter-functions))
3182 (while (and functions filtered-input-string)
3183 (if (eq (car functions) t)
3184 ;; If a local value says "use the default value too",
3185 ;; do that.
3186 (let ((functions (default-value 'comint-redirect-filter-functions)))
3187 (while (and functions filtered-input-string)
3188 (setq filtered-input-string
3189 (funcall (car functions) filtered-input-string))
3190 (setq functions (cdr functions))))
3191 (setq filtered-input-string
3192 (funcall (car functions) filtered-input-string)))
3193 (setq functions (cdr functions))))
3195 ;; Clobber `comint-redirect-finished-regexp'
3196 (or comint-redirect-insert-matching-regexp
3197 (and (string-match comint-redirect-finished-regexp filtered-input-string)
3198 (setq filtered-input-string
3199 (replace-match "" nil nil filtered-input-string))))
3201 ;; Send output to all registered buffers
3202 (save-excursion
3203 (dolist (buf output-buffer-list)
3204 ;; Set this buffer to the output buffer
3205 (set-buffer (get-buffer-create buf))
3206 ;; Go to the end of the buffer
3207 (goto-char (point-max))
3208 ;; Insert the output
3209 (let ((inhibit-read-only comint-redirect-subvert-readonly))
3210 (insert filtered-input-string))))
3212 ;; Message
3213 (and comint-redirect-verbose
3214 (message "Redirected output to buffer(s) %s"
3215 (mapconcat 'identity output-buffer-list " ")))
3217 ;; If we see the prompt, tidy up
3218 ;; We'll look for the prompt in the original string, so nobody can
3219 ;; clobber it
3220 (and (string-match comint-redirect-finished-regexp input-string)
3221 (progn
3222 (and comint-redirect-verbose
3223 (message "Redirection completed"))
3224 (comint-redirect-cleanup)
3225 (run-hooks 'comint-redirect-hook)))
3226 ;; Echo input?
3227 (if comint-redirect-echo-input
3228 filtered-input-string
3229 "")))
3231 ;;;###autoload
3232 (defun comint-redirect-send-command (command output-buffer echo &optional no-display)
3233 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3234 With prefix arg ECHO, echo output in process buffer.
3236 If NO-DISPLAY is non-nil, do not show the output buffer."
3238 (let ((process (get-buffer-process (current-buffer))))
3239 (if process
3240 (comint-redirect-send-command-to-process
3241 command output-buffer (current-buffer) echo no-display)
3242 (error "No process for current buffer"))))
3244 ;;;###autoload
3245 (defun comint-redirect-send-command-to-process
3246 (command output-buffer process echo &optional no-display)
3247 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3248 With prefix arg, echo output in process buffer.
3250 If NO-DISPLAY is non-nil, do not show the output buffer."
3252 (let* (;; The process buffer
3253 (process-buffer (if (processp process)
3254 (process-buffer process)
3255 process))
3256 (proc (get-buffer-process process-buffer)))
3257 ;; Change to the process buffer
3258 (with-current-buffer process-buffer
3260 ;; Make sure there's a prompt in the current process buffer
3261 (and comint-redirect-perform-sanity-check
3262 (save-excursion
3263 (goto-char (point-max))
3264 (or (re-search-backward comint-prompt-regexp nil t)
3265 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3267 ;;;;;;;;;;;;;;;;;;;;;
3268 ;; Set up for redirection
3269 ;;;;;;;;;;;;;;;;;;;;;
3270 (comint-redirect-setup
3271 ;; Output Buffer
3272 output-buffer
3273 ;; Comint Buffer
3274 (current-buffer)
3275 ;; Finished Regexp
3276 comint-prompt-regexp
3277 ;; Echo input
3278 echo)
3280 ;;;;;;;;;;;;;;;;;;;;;
3281 ;; Set the filter
3282 ;;;;;;;;;;;;;;;;;;;;;
3283 ;; Save the old filter
3284 (setq comint-redirect-original-filter-function
3285 (process-filter proc))
3286 (set-process-filter proc 'comint-redirect-filter)
3288 ;;;;;;;;;;;;;;;;;;;;;
3289 ;; Send the command
3290 ;;;;;;;;;;;;;;;;;;;;;
3291 (process-send-string
3292 (current-buffer)
3295 ;;;;;;;;;;;;;;;;;;;;;
3296 ;; Show the output
3297 ;;;;;;;;;;;;;;;;;;;;;
3298 (or no-display
3299 (display-buffer
3300 (get-buffer-create
3301 (if (listp output-buffer)
3302 (car output-buffer)
3303 output-buffer)))))))
3305 ;;;###autoload
3306 (defun comint-redirect-results-list (command regexp regexp-group)
3307 "Send COMMAND to current process.
3308 Return a list of expressions in the output which match REGEXP.
3309 REGEXP-GROUP is the regular expression group in REGEXP to use."
3310 (comint-redirect-results-list-from-process
3311 (get-buffer-process (current-buffer))
3312 command regexp regexp-group))
3314 ;;;###autoload
3315 (defun comint-redirect-results-list-from-process (process command regexp regexp-group)
3316 "Send COMMAND to PROCESS.
3317 Return a list of expressions in the output which match REGEXP.
3318 REGEXP-GROUP is the regular expression group in REGEXP to use."
3319 (let ((output-buffer " *Comint Redirect Work Buffer*")
3320 results)
3321 (save-excursion
3322 (set-buffer (get-buffer-create output-buffer))
3323 (erase-buffer)
3324 (comint-redirect-send-command-to-process command
3325 output-buffer process nil t)
3326 ;; Wait for the process to complete
3327 (set-buffer (process-buffer process))
3328 (while (null comint-redirect-completed)
3329 (accept-process-output nil 1))
3330 ;; Collect the output
3331 (set-buffer output-buffer)
3332 (goto-char (point-min))
3333 ;; Skip past the command, if it was echoed
3334 (and (looking-at command)
3335 (forward-line))
3336 (while (re-search-forward regexp nil t)
3337 (setq results
3338 (cons (buffer-substring-no-properties
3339 (match-beginning regexp-group)
3340 (match-end regexp-group))
3341 results)))
3342 results)))
3344 (mapc (lambda (x)
3345 (add-to-list 'debug-ignored-errors x))
3346 '("^Not at command line$"
3347 "^Empty input ring$"
3348 "^No history$"
3349 "^Not found$" ; Too common?
3350 "^Current buffer has no process$"))
3352 \f
3353 ;; Converting process modes to use comint mode
3354 ;; ===========================================================================
3355 ;; The code in the Emacs 19 distribution has all been modified to use comint
3356 ;; where needed. However, there are `third-party' packages out there that
3357 ;; still use the old shell mode. Here's a guide to conversion.
3358 ;;
3359 ;; Renaming variables
3360 ;; Most of the work is renaming variables and functions. These are the common
3361 ;; ones:
3362 ;; Local variables:
3363 ;; last-input-start comint-last-input-start
3364 ;; last-input-end comint-last-input-end
3365 ;; shell-prompt-pattern comint-prompt-regexp
3366 ;; shell-set-directory-error-hook <no equivalent>
3367 ;; Miscellaneous:
3368 ;; shell-set-directory <unnecessary>
3369 ;; shell-mode-map comint-mode-map
3370 ;; Commands:
3371 ;; shell-send-input comint-send-input
3372 ;; shell-send-eof comint-delchar-or-maybe-eof
3373 ;; kill-shell-input comint-kill-input
3374 ;; interrupt-shell-subjob comint-interrupt-subjob
3375 ;; stop-shell-subjob comint-stop-subjob
3376 ;; quit-shell-subjob comint-quit-subjob
3377 ;; kill-shell-subjob comint-kill-subjob
3378 ;; kill-output-from-shell comint-delete-output
3379 ;; show-output-from-shell comint-show-output
3380 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3381 ;;
3382 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3383 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3384 ;; Comint mode does not provide functionality equivalent to
3385 ;; shell-set-directory-error-hook; it is gone.
3386 ;;
3387 ;; comint-last-input-start is provided for modes which want to munge
3388 ;; the buffer after input is sent, perhaps because the inferior
3389 ;; insists on echoing the input. The LAST-INPUT-START variable in
3390 ;; the old shell package was used to implement a history mechanism,
3391 ;; but you should think twice before using comint-last-input-start
3392 ;; for this; the input history ring often does the job better.
3393 ;;
3394 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3395 ;; *not* create the comint-mode local variables in your foo-mode function.
3396 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3397 ;; necessary comint-specific local variables. Then create the
3398 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3399 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3400 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3401 ;; get-old-input) that need to be different from the defaults. Call
3402 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3403 ;; comint-mode will take care of it. The following example, from shell.el,
3404 ;; is typical:
3405 ;;
3406 ;; (defvar shell-mode-map '())
3407 ;; (cond ((not shell-mode-map)
3408 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3409 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3410 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3412 ;; (define-key shell-mode-map "\M-?"
3413 ;; 'comint-dynamic-list-filename-completions)))
3414 ;;
3415 ;; (defun shell-mode ()
3416 ;; (interactive)
3417 ;; (comint-mode)
3418 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3419 ;; (setq major-mode 'shell-mode)
3420 ;; (setq mode-name "Shell")
3421 ;; (use-local-map shell-mode-map)
3422 ;; (make-local-variable 'shell-directory-stack)
3423 ;; (setq shell-directory-stack nil)
3424 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3425 ;; (run-hooks 'shell-mode-hook))
3426 ;;
3427 ;;
3428 ;; Completion for comint-mode users
3429 ;;
3430 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3431 ;; hook to add completion functions to. Functions on this list should return
3432 ;; non-nil if completion occurs (i.e., further completion should not occur).
3433 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3434 ;; completion job.
3435 \f
3437 (provide 'comint)
3439 ;; arch-tag: 1793314c-09db-40be-9549-9aeae3e75164
3440 ;;; comint.el ends here