| blob | 7d81f357e22700080269ce95128edc4730e9a7d9 |
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, 2006, 2007 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., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, 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-move-point-for-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 recognize prompts in the inferior process.
161 This variable is only used if the variable
162 `comint-use-prompt-regexp' 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 recognize 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."
234 "Face to use to highlight prompts."
238 "*If non-nil, don't add input matching the last on the input ring.
239 This mirrors the optional behavior of bash.
241 This variable is buffer-local."
246 "*If non-nil, name of the file to read/write input history.
247 See also `comint-read-input-ring' and `comint-write-input-ring'.
249 This variable is buffer-local, and is a good thing to set in mode hooks."
251 file)
255 "*Controls whether input to interpreter causes window to scroll.
256 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
257 If `this', scroll only the selected window.
259 The default is nil.
261 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
269 "*Controls whether interpreter output moves point to the end of the output.
270 If nil, then output never moves point to the output.
271 (If the output occurs at point, it is inserted before point.)
272 If t or `all', move point in all windows showing the buffer.
273 If `this', move point only the selected window.
274 If `others', move point only in other windows, not in the selected window.
276 The default is nil.
278 See the variable `comint-scroll-show-maximum-output' and the function
279 `comint-postoutput-scroll-to-bottom'.
280 This variable is buffer-local in all Comint buffers."
291 "*Controls how to scroll due to interpreter output.
292 This variable applies when point is at the end of the buffer
293 \(either because it was originally there, or because
294 `comint-move-point-for-output' said to move it there)
295 and output from the subprocess is inserted.
297 Non-nil means scroll so that the window is full of text
298 and point is on the last line. A value of nil
299 means don't do anything special--scroll normally.
301 See also the variable `comint-move-point-for-output' and the function
302 `comint-postoutput-scroll-to-bottom'.
303 This variable is buffer-local in all Comint buffers."
308 "*The maximum size in lines for Comint buffers.
309 Comint buffers are truncated from the top to be no greater than this number, if
310 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
324 "*If non-nil, assume that the subprocess echoes any input.
325 If so, delete one copy of the input so that only one copy eventually
326 appears in the buffer.
328 This variable is buffer-local."
332 ;; AIX puts the name of the person being su'd to in front of the prompt.
333 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
334 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
335 ;; ssh-add prints a prompt like `Enter passphrase: '.
336 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
343 "*Regexp matching prompts for passwords in the inferior process.
344 This is used by `comint-watch-for-password-prompt'."
348 ;; Here are the per-interpreter hooks.
350 "Function that returns old text in Comint mode.
351 This function is called when return is typed while the point is in old
352 text. It returns the text to be submitted as process input. The
353 default is `comint-get-old-input-default', which either grabs the
354 current input field or grabs the current line and strips off leading
355 text matching `comint-prompt-regexp', depending on the value of
360 "List of functions called to perform completion.
361 Functions should return non-nil if completion was performed.
362 See also `comint-dynamic-complete'.
368 "Predicate for filtering additions to input history.
369 Takes one argument, the input. If non-nil, the input may be saved on the input
373 "Abnormal hook run before input is sent to the process.
376 ;;;###autoload
377 (defvar comint-output-filter-functions '(comint-postoutput-scroll-to-bottom comint-watch-for-password-prompt)
378 "Functions to call after output is inserted into the buffer.
379 One possible function is `comint-postoutput-scroll-to-bottom'.
380 These functions get one argument, a string containing the text as originally
381 inserted. Note that this might not be the same as the buffer contents between
382 `comint-last-output-start' and the buffer's `process-mark', if other filter
383 functions have already modified the buffer.
385 See also `comint-preoutput-filter-functions'.
387 You can use `add-hook' to add functions to this list
394 "Function to actually send to PROCESS the STRING submitted by user.
395 Usually this is just `comint-simple-send', but if your mode needs to
396 massage the input string, put a different function here.
397 `comint-simple-send' just sends the string plus a newline.
398 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
402 "*Non-nil means go to the end of the line before sending input.
403 See `comint-send-input'."
407 ;; Note: If it is decided to purge comint-prompt-regexp from the source
408 ;; entirely, searching for uses of this variable will help to identify
409 ;; places that need attention.
411 "*If non-nil, use `comint-prompt-regexp' to recognize prompts.
412 If nil, then program output and user-input are given different `field'
413 properties, which Emacs commands can use to distinguish them (in
414 particular, common movement commands such as `beginning-of-line'
415 respect field boundaries in a natural way)."
419 ;; Autoload is necessary for Custom to recognize old alias.
420 ;;;###autoload
425 "Hook run upon entry to `comint-mode'.
426 This is run before the process is cranked up."
431 "Hook run each time a process is exec'd by `comint-exec'.
432 This is called after the process is cranked up. It is useful for things that
433 must be done each time a process is executed in a Comint mode buffer (e.g.,
434 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
435 executed once when the buffer is created."
441 ;; Keys:
471 ;; Mouse Buttons:
473 ;; Menu bars:
474 ;; completion:
485 ;; Input history:
526 ;; Signals
530 (define-key signals-map [kill] '("KILL" . comint-kill-subjob))
531 (define-key signals-map [quit] '("QUIT" . comint-quit-subjob))
532 (define-key signals-map [cont] '("CONT" . comint-continue-subjob))
533 (define-key signals-map [stop] '("STOP" . comint-stop-subjob))
534 (define-key signals-map [break] '("BREAK" . comint-interrupt-subjob)))
535 ;; Put them in the menu bar:
536 (setq menu-bar-final-items (append '(completion inout signals)
537 menu-bar-final-items))
538 map))
540 ;; Fixme: Is this still relevant?
541 (defvar comint-ptyp t
542 "Non-nil if communications via pty; false if by pipe. Buffer local.
543 This is to work around a bug in Emacs process signaling.")
545 (defvar comint-input-ring nil)
546 (defvar comint-last-input-start nil)
547 (defvar comint-last-input-end nil)
548 (defvar comint-last-output-start nil)
549 (defvar comint-input-ring-index nil
550 "Index of last matched history element.")
551 (defvar comint-matching-input-from-input-string ""
552 "Input previously used to match input history.")
553 (defvar comint-save-input-ring-index
554 "Last input ring index which you copied.
557 (defvar comint-accum-marker nil
558 "Non-nil if you are accumulating input lines to send as input together.
561 (defvar comint-stored-incomplete-input nil
562 "Stored input for history cycling.")
564 (put 'comint-replace-by-expanded-history 'menu-enable 'comint-input-autoexpand)
565 (put 'comint-input-ring 'permanent-local t)
566 (put 'comint-input-ring-index 'permanent-local t)
567 (put 'comint-save-input-ring-index 'permanent-local t)
568 (put 'comint-input-autoexpand 'permanent-local t)
569 (put 'comint-input-filter-functions 'permanent-local t)
570 (put 'comint-output-filter-functions 'permanent-local t)
571 (put 'comint-preoutput-filter-functions 'permanent-local t)
572 (put 'comint-scroll-to-bottom-on-input 'permanent-local t)
573 (put 'comint-move-point-for-output 'permanent-local t)
574 (put 'comint-scroll-show-maximum-output 'permanent-local t)
575 (put 'comint-ptyp 'permanent-local t)
577 (put 'comint-mode 'mode-class 'special)
579 (define-derived-mode comint-mode fundamental-mode "Comint"
580 "Major mode for interacting with an inferior interpreter.
581 Interpreter name is same as buffer name, sans the asterisks.
582 Return at end of buffer sends line as input.
583 Return not at end copies rest of line to end and sends it.
584 Setting variable `comint-eol-on-send' means jump to the end of the line
585 before submitting new input.
587 This mode is customized to create major modes such as Inferior Lisp
588 mode, Shell mode, etc. This can be done by setting the hooks
589 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
590 and `comint-get-old-input' to appropriate functions, and the variable
591 `comint-prompt-regexp' to the appropriate regular expression.
593 An input history is maintained of size `comint-input-ring-size', and
594 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
595 Input ring history expansion can be achieved with the commands
597 Input ring expansion is controlled by the variable `comint-input-autoexpand',
598 and addition is controlled by the variable `comint-input-ignoredups'.
600 Commands with no default key bindings include `send-invisible',
601 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
602 `comint-magic-space'.
604 Input to, and output from, the subprocess can cause the window to scroll to
605 the end of the buffer. See variables `comint-output-filter-functions',
606 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
607 and `comint-move-point-for-output'.
610 to continue it.
614 Entry to this mode runs the hooks on `comint-mode-hook'."
615 (setq mode-line-process '(":%s"))
616 (set (make-local-variable 'comint-last-input-start) (point-min-marker))
617 (set (make-local-variable 'comint-last-input-end) (point-min-marker))
618 (set (make-local-variable 'comint-last-output-start) (make-marker))
619 (make-local-variable 'comint-last-prompt-overlay)
620 (make-local-variable 'comint-prompt-regexp) ; Don't set; default
621 (make-local-variable 'comint-input-ring-size) ; ...to global val.
622 (make-local-variable 'comint-input-ring)
623 (make-local-variable 'comint-input-ring-file-name)
624 (or (and (boundp 'comint-input-ring) comint-input-ring)
625 (setq comint-input-ring (make-ring comint-input-ring-size)))
626 (make-local-variable 'comint-input-ring-index)
627 (make-local-variable 'comint-save-input-ring-index)
628 (or (and (boundp 'comint-input-ring-index) comint-input-ring-index)
629 (setq comint-input-ring-index nil))
630 (or (and (boundp 'comint-save-input-ring-index) comint-save-input-ring-index)
631 (setq comint-save-input-ring-index nil))
632 (make-local-variable 'comint-matching-input-from-input-string)
633 (make-local-variable 'comint-input-autoexpand)
634 (make-local-variable 'comint-input-ignoredups)
635 (make-local-variable 'comint-delimiter-argument-list)
636 (make-local-variable 'comint-completion-fignore)
637 (make-local-variable 'comint-get-old-input)
638 (make-local-variable 'comint-input-filter)
639 (make-local-variable 'comint-input-sender)
640 (make-local-variable 'comint-eol-on-send)
641 (make-local-variable 'comint-scroll-to-bottom-on-input)
642 (make-local-variable 'comint-move-point-for-output)
643 (make-local-variable 'comint-scroll-show-maximum-output)
644 (make-local-variable 'comint-stored-incomplete-input)
645 ;; This makes it really work to keep point at the bottom.
646 (make-local-variable 'scroll-conservatively)
647 (setq scroll-conservatively 10000)
648 (add-hook 'pre-command-hook 'comint-preinput-scroll-to-bottom t t)
649 (make-local-variable 'comint-ptyp)
650 (make-local-variable 'comint-process-echoes)
651 (make-local-variable 'comint-file-name-chars)
652 (make-local-variable 'comint-file-name-quote-list)
653 (make-local-variable 'comint-accum-marker)
654 (setq comint-accum-marker (make-marker))
655 (make-local-variable 'font-lock-defaults)
656 (setq font-lock-defaults '(nil t))
657 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
658 ;; This behavior is not useful in comint buffers, and is annoying
659 (set (make-local-variable 'next-line-add-newlines) nil))
661 (defun comint-check-proc (buffer)
662 "Return non-nil if there is a living process associated w/buffer BUFFER.
663 Living means the status is `open', `run', or `stop'.
664 BUFFER can be either a buffer or the name of one."
665 (let ((proc (get-buffer-process buffer)))
666 (and proc (memq (process-status proc) '(open run stop)))))
668 ;;;###autoload
669 (defun make-comint-in-buffer (name buffer program &optional startfile &rest switches)
670 "Make a Comint process NAME in BUFFER, running PROGRAM.
671 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
672 PROGRAM should be either a string denoting an executable program to create
673 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
674 connection to be opened via `open-network-stream'. If there is already a
675 running process in that buffer, it is not restarted. Optional fourth arg
676 STARTFILE is the name of a file to send the contents of to the process.
678 If PROGRAM is a string, any more args are arguments to PROGRAM."
679 (or (fboundp 'start-process)
680 (error "Multi-processing is not supported for this system"))
681 (setq buffer (get-buffer-create (or buffer (concat "*" name "*"))))
682 ;; If no process, or nuked process, crank up a new one and put buffer in
683 ;; comint mode. Otherwise, leave buffer and existing process alone.
684 (unless (comint-check-proc buffer)
685 (with-current-buffer buffer
686 (unless (derived-mode-p 'comint-mode)
687 (comint-mode))) ; Install local vars, mode, keymap, ...
688 (comint-exec buffer name program startfile switches))
689 buffer)
691 ;;;###autoload
692 (defun make-comint (name program &optional startfile &rest switches)
693 "Make a Comint process NAME in a buffer, running PROGRAM.
694 The name of the buffer is made by surrounding NAME with `*'s.
695 PROGRAM should be either a string denoting an executable program to create
696 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
697 connection to be opened via `open-network-stream'. If there is already a
698 running process in that buffer, it is not restarted. Optional third arg
699 STARTFILE is the name of a file to send the contents of the process to.
701 If PROGRAM is a string, any more args are arguments to PROGRAM."
702 (apply #'make-comint-in-buffer name nil program startfile switches))
704 ;;;###autoload
705 (defun comint-run (program)
706 "Run PROGRAM in a Comint buffer and switch to it.
707 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
708 The file name is used to make a symbol name, such as `comint-sh-hook', and any
709 hooks on this symbol are run in the buffer.
710 See `make-comint' and `comint-exec'."
711 (interactive "sRun program: ")
712 (let ((name (file-name-nondirectory program)))
713 (switch-to-buffer (make-comint name program))
714 (run-hooks (intern-soft (concat "comint-" name "-hook")))))
716 (defun comint-exec (buffer name command startfile switches)
717 "Start up a process named NAME in buffer BUFFER for Comint modes.
718 Runs the given COMMAND with SWITCHES with output to STARTFILE.
719 Blasts any old process running in the buffer. Doesn't set the buffer mode.
720 You can use this to cheaply run a series of processes in the same Comint
721 buffer. The hook `comint-exec-hook' is run after each exec."
722 (with-current-buffer buffer
723 (let ((proc (get-buffer-process buffer))) ; Blast any old process.
724 (if proc (delete-process proc)))
725 ;; Crank up a new process
726 (let ((proc
727 (if (consp command)
728 (open-network-stream name buffer (car command) (cdr command))
729 (comint-exec-1 name buffer command switches))))
730 (set-process-filter proc 'comint-output-filter)
731 (make-local-variable 'comint-ptyp)
732 (setq comint-ptyp process-connection-type) ; t if pty, nil if pipe.
733 ;; Jump to the end, and set the process mark.
734 (goto-char (point-max))
735 (set-marker (process-mark proc) (point))
736 ;; Feed it the startfile.
737 (cond (startfile
738 ;;This is guaranteed to wait long enough
739 ;;but has bad results if the comint does not prompt at all
740 ;; (while (= size (buffer-size))
741 ;; (sleep-for 1))
742 ;;I hope 1 second is enough!
743 (sleep-for 1)
744 (goto-char (point-max))
745 (insert-file-contents startfile)
746 (setq startfile (buffer-substring (point) (point-max)))
747 (delete-region (point) (point-max))
748 (comint-send-string proc startfile)))
749 (run-hooks 'comint-exec-hook)
750 buffer)))
752 ;; This auxiliary function cranks up the process for comint-exec in
753 ;; the appropriate environment.
755 (defun comint-exec-1 (name buffer command switches)
756 (let ((process-environment
757 (nconc
758 ;; If using termcap, we specify `emacs' as the terminal type
759 ;; because that lets us specify a width.
760 ;; If using terminfo, we specify `dumb' because that is
761 ;; a defined terminal type. `emacs' is not a defined terminal type
762 ;; and there is no way for us to define it here.
763 ;; Some programs that use terminfo get very confused
764 ;; if TERM is not a valid terminal type.
765 ;; ;; There is similar code in compile.el.
766 (if (and (boundp 'system-uses-terminfo) system-uses-terminfo)
767 (list "TERM=dumb" "TERMCAP="
768 (format "COLUMNS=%d" (window-width)))
769 (list "TERM=emacs"
770 (format "TERMCAP=emacs:co#%d:tc=unknown:" (window-width))))
771 (unless (getenv "EMACS")
772 (list "EMACS=t"))
773 (list (format "INSIDE_EMACS=%s,comint" emacs-version))
774 process-environment))
775 (default-directory
776 (if (file-accessible-directory-p default-directory)
777 default-directory
778 "/"))
779 proc decoding encoding changed)
780 (let ((exec-path (if (file-name-directory command)
781 ;; If the command has slashes, make sure we
782 ;; first look relative to the current directory.
783 (cons default-directory exec-path) exec-path)))
784 (setq proc (apply 'start-process name buffer command switches)))
785 (let ((coding-systems (process-coding-system proc)))
786 (setq decoding (car coding-systems)
787 encoding (cdr coding-systems)))
788 ;; If start-process decided to use some coding system for decoding
789 ;; data sent from the process and the coding system doesn't
790 ;; specify EOL conversion, we had better convert CRLF to LF.
791 (if (vectorp (coding-system-eol-type decoding))
792 (setq decoding (coding-system-change-eol-conversion decoding 'dos)
793 changed t))
794 ;; Even if start-process left the coding system for encoding data
795 ;; sent from the process undecided, we had better use the same one
796 ;; as what we use for decoding. But, we should suppress EOL
797 ;; conversion.
798 (if (and decoding (not encoding))
799 (setq encoding (coding-system-change-eol-conversion decoding 'unix)
800 changed t))
801 (if changed
802 (set-process-coding-system proc decoding encoding))
803 proc))
805 (defun comint-insert-input (event)
806 "In a Comint buffer, set the current input to the previous input at point.
807 If there is no previous input at point, run the command specified
808 by the global keymap (usually `mouse-yank-at-point')."
809 (interactive "e")
810 (let ((pos (posn-point (event-end event)))
811 field input)
812 (with-selected-window (posn-window (event-end event))
813 (and (setq field (field-at-pos pos))
814 (setq input (field-string-no-properties pos))))
815 (if (or (null comint-accum-marker)
816 (not (eq field 'input)))
817 ;; Fall back to the global definition if (i) the selected
818 ;; buffer is not a comint buffer (which can happen if a
819 ;; non-comint window was selected and we clicked in a comint
820 ;; window), or (ii) there is no input at POS.
821 (let* ((keys (this-command-keys))
822 (last-key (and (vectorp keys) (aref keys (1- (length keys)))))
823 (fun (and last-key (lookup-key global-map (vector last-key)))))
824 (and fun (not (eq fun 'comint-insert-input))
825 (call-interactively fun)))
826 ;; Otherwise, insert the previous input.
827 (goto-char (point-max))
828 ;; First delete any old unsent input at the end
829 (delete-region
830 (or (marker-position comint-accum-marker)
831 (process-mark (get-buffer-process (current-buffer))))
832 (point))
833 ;; Insert the input at point
834 (insert input))))
835 \f
836 ;; Input history processing in a buffer
837 ;; ===========================================================================
838 ;; Useful input history functions, courtesy of the Ergo group.
840 ;; Eleven commands:
841 ;; comint-dynamic-list-input-ring List history in help buffer.
842 ;; comint-previous-input Previous input...
843 ;; comint-previous-matching-input ...matching a string.
844 ;; comint-previous-matching-input-from-input ... matching the current input.
845 ;; comint-next-input Next input...
846 ;; comint-next-matching-input ...matching a string.
847 ;; comint-next-matching-input-from-input ... matching the current input.
848 ;; comint-backward-matching-input Backwards input...
849 ;; comint-forward-matching-input ...matching a string.
850 ;; comint-replace-by-expanded-history Expand history at point;
851 ;; replace with expanded history.
852 ;; comint-magic-space Expand history and insert space.
853 ;;
854 ;; Three functions:
855 ;; comint-read-input-ring Read into comint-input-ring...
856 ;; comint-write-input-ring Write to comint-input-ring-file-name.
857 ;; comint-replace-by-expanded-history-before-point Workhorse function.
859 (defun comint-read-input-ring (&optional silent)
860 "Set the buffer's `comint-input-ring' from a history file.
861 The name of the file is given by the variable `comint-input-ring-file-name'.
862 The history ring is of size `comint-input-ring-size', regardless of file size.
863 If `comint-input-ring-file-name' is nil this function does nothing.
865 If the optional argument SILENT is non-nil, we say nothing about a
866 failure to read the history file.
868 This function is useful for major mode commands and mode hooks.
870 The commands stored in the history file are separated by the
871 `comint-input-ring-separator', and entries that match
872 `comint-input-history-ignore' are ignored. The most recent command
873 comes last.
875 See also `comint-input-ignoredups' and `comint-write-input-ring'."
876 (cond ((or (null comint-input-ring-file-name)
877 (equal comint-input-ring-file-name ""))
878 nil)
879 ((not (file-readable-p comint-input-ring-file-name))
880 (or silent
881 (message "Cannot read history file %s"
882 comint-input-ring-file-name)))
883 (t
884 (let* ((history-buf (get-buffer-create " *temp*"))
885 (file comint-input-ring-file-name)
886 (count 0)
887 (size comint-input-ring-size)
888 (ring (make-ring size)))
889 (unwind-protect
890 (save-excursion
891 (set-buffer history-buf)
892 (widen)
893 (erase-buffer)
894 (insert-file-contents file)
895 ;; Save restriction in case file is already visited...
896 ;; Watch for those date stamps in history files!
897 (goto-char (point-max))
898 (let (start end history)
899 (while (and (< count size)
900 (re-search-backward comint-input-ring-separator nil t)
901 (setq end (match-beginning 0)))
902 (if (re-search-backward comint-input-ring-separator nil t)
903 (setq start (match-end 0))
904 (setq start (point-min)))
905 (setq history (buffer-substring start end))
906 (goto-char start)
907 (if (and (not (string-match comint-input-history-ignore history))
908 (or (null comint-input-ignoredups)
909 (ring-empty-p ring)
910 (not (string-equal (ring-ref ring 0) history))))
911 (progn
912 (ring-insert-at-beginning ring history)
913 (setq count (1+ count)))))))
914 (kill-buffer history-buf))
915 (setq comint-input-ring ring
916 comint-input-ring-index nil)))))
918 (defun comint-write-input-ring ()
919 "Writes the buffer's `comint-input-ring' to a history file.
920 The name of the file is given by the variable `comint-input-ring-file-name'.
921 The original contents of the file are lost if `comint-input-ring' is not empty.
922 If `comint-input-ring-file-name' is nil this function does nothing.
924 Useful within process sentinels.
926 See also `comint-read-input-ring'."
927 (cond ((or (null comint-input-ring-file-name)
928 (equal comint-input-ring-file-name "")
929 (null comint-input-ring) (ring-empty-p comint-input-ring))
930 nil)
931 ((not (file-writable-p comint-input-ring-file-name))
932 (message "Cannot write history file %s" comint-input-ring-file-name))
933 (t
934 (let* ((history-buf (get-buffer-create " *Temp Input History*"))
935 (ring comint-input-ring)
936 (file comint-input-ring-file-name)
937 (index (ring-length ring)))
938 ;; Write it all out into a buffer first. Much faster, but messier,
939 ;; than writing it one line at a time.
940 (save-excursion
941 (set-buffer history-buf)
942 (erase-buffer)
943 (while (> index 0)
944 (setq index (1- index))
945 (insert (ring-ref ring index) comint-input-ring-separator))
946 (write-region (buffer-string) nil file nil 'no-message)
947 (kill-buffer nil))))))
950 (defvar comint-dynamic-list-input-ring-window-conf)
952 (defun comint-dynamic-list-input-ring-select ()
953 "Choose the input history entry that point is in or next to."
954 (interactive)
955 (let (beg end completion (buffer completion-reference-buffer)
956 (base-size completion-base-size))
957 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
958 (setq end (point) beg (1+ (point))))
959 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
960 (setq end (1- (point)) beg (point)))
961 (if (null beg)
962 (error "No history entry here"))
963 (setq beg (previous-single-property-change beg 'mouse-face))
964 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
965 (setq completion (buffer-substring beg end))
966 (set-window-configuration comint-dynamic-list-input-ring-window-conf)
967 (choose-completion-string completion buffer base-size)))
969 (defun comint-dynamic-list-input-ring ()
970 "List in help buffer the buffer's input history."
971 (interactive)
972 (if (or (not (ring-p comint-input-ring))
973 (ring-empty-p comint-input-ring))
974 (message "No history")
975 (let ((history nil)
976 (history-buffer " *Input History*")
977 (index (1- (ring-length comint-input-ring)))
978 (conf (current-window-configuration)))
979 ;; We have to build up a list ourselves from the ring vector.
980 (while (>= index 0)
981 (setq history (cons (ring-ref comint-input-ring index) history)
982 index (1- index)))
983 ;; Change "completion" to "history reference"
984 ;; to make the display accurate.
985 (with-output-to-temp-buffer history-buffer
986 (display-completion-list history)
987 (set-buffer history-buffer)
988 (let ((keymap (make-sparse-keymap)))
989 (set-keymap-parent keymap (current-local-map))
990 (define-key keymap "\C-m" 'comint-dynamic-list-input-ring-select)
991 (use-local-map keymap))
992 (forward-line 3)
993 (while (search-backward "completion" nil 'move)
994 (replace-match "history reference")))
995 (sit-for 0)
996 (message "Hit space to flush")
997 (setq comint-dynamic-list-input-ring-window-conf conf)
998 (let ((ch (read-event)))
999 (if (eq ch ?\s)
1000 (set-window-configuration conf)
1001 (setq unread-command-events (list ch)))))))
1004 (defun comint-regexp-arg (prompt)
1005 "Return list of regexp and prefix arg using PROMPT."
1006 (let* (;; Don't clobber this.
1007 (last-command last-command)
1008 (regexp (read-from-minibuffer prompt nil nil nil
1009 'minibuffer-history-search-history)))
1010 (list (if (string-equal regexp "")
1011 (setcar minibuffer-history-search-history
1012 (nth 1 minibuffer-history-search-history))
1013 regexp)
1014 (prefix-numeric-value current-prefix-arg))))
1016 (defun comint-search-arg (arg)
1017 ;; First make sure there is a ring and that we are after the process mark
1018 (cond ((not (comint-after-pmark-p))
1019 (error "Not at command line"))
1020 ((or (null comint-input-ring)
1021 (ring-empty-p comint-input-ring))
1022 (error "Empty input ring"))
1023 ((zerop arg)
1024 ;; arg of zero resets search from beginning, and uses arg of 1
1025 (setq comint-input-ring-index nil)
1026 1)
1027 (t
1028 arg)))
1030 (defun comint-restore-input ()
1031 "Restore unfinished input."
1032 (interactive)
1033 (when comint-input-ring-index
1034 (comint-delete-input)
1035 (when (> (length comint-stored-incomplete-input) 0)
1036 (insert comint-stored-incomplete-input)
1037 (message "Input restored"))
1038 (setq comint-input-ring-index nil)))
1040 (defun comint-search-start (arg)
1041 "Index to start a directional search, starting at `comint-input-ring-index'."
1042 (if comint-input-ring-index
1043 ;; If a search is running, offset by 1 in direction of arg
1044 (mod (+ comint-input-ring-index (if (> arg 0) 1 -1))
1045 (ring-length comint-input-ring))
1046 ;; For a new search, start from beginning or end, as appropriate
1047 (if (>= arg 0)
1048 0 ; First elt for forward search
1049 (1- (ring-length comint-input-ring))))) ; Last elt for backward search
1051 (defun comint-previous-input-string (arg)
1052 "Return the string ARG places along the input ring.
1053 Moves relative to `comint-input-ring-index'."
1054 (ring-ref comint-input-ring (if comint-input-ring-index
1055 (mod (+ arg comint-input-ring-index)
1056 (ring-length comint-input-ring))
1057 arg)))
1059 (defun comint-previous-input (arg)
1060 "Cycle backwards through input history, saving input."
1061 (interactive "*p")
1062 (if (and comint-input-ring-index
1063 (or ;; leaving the "end" of the ring
1064 (and (< arg 0) ; going down
1065 (eq comint-input-ring-index 0))
1066 (and (> arg 0) ; going up
1067 (eq comint-input-ring-index
1068 (1- (ring-length comint-input-ring)))))
1069 comint-stored-incomplete-input)
1070 (comint-restore-input)
1071 (comint-previous-matching-input "." arg)))
1073 (defun comint-next-input (arg)
1074 "Cycle forwards through input history."
1075 (interactive "*p")
1076 (comint-previous-input (- arg)))
1078 (defun comint-previous-matching-input-string (regexp arg)
1079 "Return the string matching REGEXP ARG places along the input ring.
1080 Moves relative to `comint-input-ring-index'."
1081 (let* ((pos (comint-previous-matching-input-string-position regexp arg)))
1082 (if pos (ring-ref comint-input-ring pos))))
1084 (defun comint-previous-matching-input-string-position (regexp arg &optional start)
1085 "Return the index matching REGEXP ARG places along the input ring.
1086 Moves relative to START, or `comint-input-ring-index'."
1087 (if (or (not (ring-p comint-input-ring))
1088 (ring-empty-p comint-input-ring))
1089 (error "No history"))
1090 (let* ((len (ring-length comint-input-ring))
1091 (motion (if (> arg 0) 1 -1))
1092 (n (mod (- (or start (comint-search-start arg)) motion) len))
1093 (tried-each-ring-item nil)
1094 (prev nil))
1095 ;; Do the whole search as many times as the argument says.
1096 (while (and (/= arg 0) (not tried-each-ring-item))
1097 ;; Step once.
1098 (setq prev n
1099 n (mod (+ n motion) len))
1100 ;; If we haven't reached a match, step some more.
1101 (while (and (< n len) (not tried-each-ring-item)
1102 (not (string-match regexp (ring-ref comint-input-ring n))))
1103 (setq n (mod (+ n motion) len)
1104 ;; If we have gone all the way around in this search.
1105 tried-each-ring-item (= n prev)))
1106 (setq arg (if (> arg 0) (1- arg) (1+ arg))))
1107 ;; Now that we know which ring element to use, if we found it, return that.
1108 (if (string-match regexp (ring-ref comint-input-ring n))
1109 n)))
1111 (defun comint-delete-input ()
1112 "Delete all input between accumulation or process mark and point."
1113 (delete-region
1114 ;; Can't use kill-region as it sets this-command
1115 (or (marker-position comint-accum-marker)
1116 (process-mark (get-buffer-process (current-buffer))))
1117 (point-max)))
1119 (defun comint-previous-matching-input (regexp n)
1120 "Search backwards through input history for match for REGEXP.
1121 \(Previous history elements are earlier commands.)
1122 With prefix argument N, search for Nth previous match.
1123 If N is negative, find the next or Nth next match."
1124 (interactive (comint-regexp-arg "Previous input matching (regexp): "))
1125 (setq n (comint-search-arg n))
1126 (let ((pos (comint-previous-matching-input-string-position regexp n)))
1127 ;; Has a match been found?
1128 (if (null pos)
1129 (error "Not found")
1130 ;; If leaving the edit line, save partial input
1131 (if (null comint-input-ring-index) ;not yet on ring
1132 (setq comint-stored-incomplete-input
1133 (funcall comint-get-old-input)))
1134 (setq comint-input-ring-index pos)
1135 (message "History item: %d" (1+ pos))
1136 (comint-delete-input)
1137 (insert (ring-ref comint-input-ring pos)))))
1139 (defun comint-next-matching-input (regexp n)
1140 "Search forwards through input history for match for REGEXP.
1141 \(Later history elements are more recent commands.)
1142 With prefix argument N, search for Nth following match.
1143 If N is negative, find the previous or Nth previous match."
1144 (interactive (comint-regexp-arg "Next input matching (regexp): "))
1145 (comint-previous-matching-input regexp (- n)))
1147 (defun comint-previous-matching-input-from-input (n)
1148 "Search backwards through input history for match for current input.
1149 \(Previous history elements are earlier commands.)
1150 With prefix argument N, search for Nth previous match.
1151 If N is negative, search forwards for the -Nth following match."
1152 (interactive "p")
1153 (if (not (memq last-command '(comint-previous-matching-input-from-input
1154 comint-next-matching-input-from-input)))
1155 ;; Starting a new search
1156 (setq comint-matching-input-from-input-string
1157 (buffer-substring
1158 (or (marker-position comint-accum-marker)
1159 (process-mark (get-buffer-process (current-buffer))))
1160 (point))
1161 comint-input-ring-index nil))
1162 (comint-previous-matching-input
1163 (concat "^" (regexp-quote comint-matching-input-from-input-string))
1164 n))
1166 (defun comint-next-matching-input-from-input (n)
1167 "Search forwards through input history for match for current input.
1168 \(Following history elements are more recent commands.)
1169 With prefix argument N, search for Nth following match.
1170 If N is negative, search backwards for the -Nth previous match."
1171 (interactive "p")
1172 (comint-previous-matching-input-from-input (- n)))
1175 (defun comint-replace-by-expanded-history (&optional silent start)
1176 "Expand input command history references before point.
1177 Expansion is dependent on the value of `comint-input-autoexpand'.
1179 This function depends on the buffer's idea of the input history, which may not
1180 match the command interpreter's idea, assuming it has one.
1182 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1183 cannot know the interpreter's idea of input line numbers, assuming it has one,
1184 it cannot expand absolute input line number references.
1186 If the optional argument SILENT is non-nil, never complain
1187 even if history reference seems erroneous.
1189 If the optional argument START is non-nil, that specifies the
1190 start of the text to scan for history references, rather
1191 than the logical beginning of line.
1193 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1195 Returns t if successful."
1196 (interactive)
1197 (if (and comint-input-autoexpand
1198 (if comint-use-prompt-regexp
1199 ;; Use comint-prompt-regexp
1200 (save-excursion
1201 (beginning-of-line)
1203 ;; Use input fields. User input that hasn't been entered
1204 ;; yet, at the end of the buffer, has a nil `field' property.
1205 (and (null (get-char-property (point) 'field))
1207 ;; Looks like there might be history references in the command.
1208 (let ((previous-modified-tick (buffer-modified-tick)))
1209 (comint-replace-by-expanded-history-before-point silent start)
1210 (/= previous-modified-tick (buffer-modified-tick)))))
1213 (defun comint-replace-by-expanded-history-before-point (silent &optional start)
1214 "Expand directory stack reference before point.
1215 See `comint-replace-by-expanded-history'. Returns t if successful.
1217 If the optional argument START is non-nil, that specifies the
1218 start of the text to scan for history references, rather
1219 than the logical beginning of line."
1220 (save-excursion
1221 (let ((toend (- (line-end-position) (point)))
1222 (start (or start (comint-line-beginning-position))))
1223 (goto-char start)
1224 (while (progn
1225 (skip-chars-forward "^!^" (- (line-end-position) toend))
1226 (< (point) (- (line-end-position) toend)))
1227 ;; This seems a bit complex. We look for references such as !!, !-num,
1228 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1229 ;; If that wasn't enough, the plings can be suffixed with argument
1230 ;; range specifiers.
1231 ;; Argument ranges are complex too, so we hive off the input line,
1232 ;; referenced with plings, with the range string to `comint-args'.
1233 (setq comint-input-ring-index nil)
1235 (comint-within-quotes start (point)))
1236 ;; The history is quoted, or we're in quotes.
1237 (goto-char (1+ (point))))
1239 ;; We cannot know the interpreter's idea of input line numbers.
1240 (goto-char (match-end 0))
1241 (message "Absolute reference cannot be expanded"))
1243 ;; Just a number of args from `number' lines backward.
1244 (let ((number (1- (string-to-number
1245 (buffer-substring (match-beginning 1)
1246 (match-end 1))))))
1247 (if (<= number (ring-length comint-input-ring))
1248 (progn
1249 (replace-match
1250 (comint-args (comint-previous-input-string number)
1251 (match-beginning 2) (match-end 2))
1252 t t)
1253 (setq comint-input-ring-index number)
1254 (message "History item: %d" (1+ number)))
1255 (goto-char (match-end 0))
1256 (message "Relative reference exceeds input history size"))))
1258 ;; Just a number of args from the previous input line.
1259 (replace-match
1260 (comint-args (comint-previous-input-string 0)
1261 (match-beginning 1) (match-end 1))
1262 t t)
1263 (message "History item: previous"))
1264 ((looking-at
1266 ;; Most recent input starting with or containing (possibly
1267 ;; protected) string, maybe just a number of args. Phew.
1268 (let* ((mb1 (match-beginning 1)) (me1 (match-end 1))
1269 (mb2 (match-beginning 2)) (me2 (match-end 2))
1270 (exp (buffer-substring (or mb2 mb1) (or me2 me1)))
1272 (pos (save-match-data
1273 (comint-previous-matching-input-string-position
1274 (concat pref (regexp-quote exp)) 1))))
1275 (if (null pos)
1276 (progn
1277 (goto-char (match-end 0))
1278 (or silent
1279 (progn (message "Not found")
1280 (ding))))
1281 (setq comint-input-ring-index pos)
1282 (replace-match
1283 (comint-args (ring-ref comint-input-ring pos)
1284 (match-beginning 4) (match-end 4))
1285 t t)
1286 (message "History item: %d" (1+ pos)))))
1288 ;; Quick substitution on the previous input line.
1289 (let ((old (buffer-substring (match-beginning 1) (match-end 1)))
1290 (new (buffer-substring (match-beginning 2) (match-end 2)))
1291 (pos nil))
1292 (replace-match (comint-previous-input-string 0) t t)
1293 (setq pos (point))
1294 (goto-char (match-beginning 0))
1295 (if (not (search-forward old pos t))
1296 (or silent
1297 (error "Not found"))
1298 (replace-match new t t)
1299 (message "History item: substituted"))))
1300 (t
1301 (forward-char 1)))))))
1304 (defun comint-magic-space (arg)
1305 "Expand input history references before point and insert ARG spaces.
1306 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1307 (interactive "p")
1308 (comint-replace-by-expanded-history)
1309 (self-insert-command arg))
1310 \f
1311 (defun comint-within-quotes (beg end)
1312 "Return t if the number of quotes between BEG and END is odd.
1313 Quotes are single and double."
1316 (or (= (mod countsq 2) 1) (= (mod countdq 2) 1))))
1318 (defun comint-how-many-region (regexp beg end)
1319 "Return number of matches for REGEXP from BEG to END."
1320 (let ((count 0))
1321 (save-excursion
1322 (save-match-data
1323 (goto-char beg)
1324 (while (re-search-forward regexp end t)
1325 (setq count (1+ count)))))
1326 count))
1328 (defun comint-args (string begin end)
1329 ;; From STRING, return the args depending on the range specified in the text
1330 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1331 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1332 (save-match-data
1333 (if (null begin)
1334 (comint-arguments string 0 nil)
1335 (let* ((range (buffer-substring
1336 (if (eq (char-after begin) ?:) (1+ begin) begin) end))
1337 (nth (cond ((string-match "^[*^]" range) 1)
1338 ((string-match "^-" range) 0)
1339 ((string-equal range "$") nil)
1340 (t (string-to-number range))))
1341 (mth (cond ((string-match "[-*$]$" range) nil)
1342 ((string-match "-" range)
1343 (string-to-number (substring range (match-end 0))))
1344 (t nth))))
1345 (comint-arguments string nth mth)))))
1347 (defun comint-delim-arg (arg)
1348 "Return a list of arguments from ARG.
1349 Break it up at the delimiters in `comint-delimiter-argument-list'.
1350 Returned list is backwards.
1352 Characters with non-nil values of the text property `literal' are
1353 assumed to have literal values (e.g., backslash-escaped
1354 characters), and are not considered to be delimiters."
1355 (if (null comint-delimiter-argument-list)
1356 (list arg)
1357 (let ((args nil)
1358 (pos 0)
1359 (len (length arg)))
1360 (while (< pos len)
1361 (let ((char (aref arg pos))
1362 (start pos))
1363 (if (and (memq char comint-delimiter-argument-list)
1364 ;; Ignore backslash-escaped characters.
1365 (not (get-text-property pos 'literal arg)))
1366 (while (and (< pos len) (eq (aref arg pos) char))
1367 (setq pos (1+ pos)))
1368 (while (and (< pos len)
1369 (not (and (memq (aref arg pos)
1370 comint-delimiter-argument-list)
1371 (not (get-text-property
1372 pos 'literal arg)))))
1373 (setq pos (1+ pos))))
1374 (setq args (cons (substring arg start pos) args))))
1375 args)))
1377 (defun comint-arguments (string nth mth)
1378 "Return from STRING the NTH to MTH arguments.
1379 NTH and/or MTH can be nil, which means the last argument.
1380 Returned arguments are separated by single spaces.
1381 We assume whitespace separates arguments, except within quotes
1382 and except for a space or tab that immediately follows a backslash.
1383 Also, a run of one or more of a single character
1384 in `comint-delimiter-argument-list' is a separate argument.
1385 Argument 0 is the command name."
1386 ;; The first line handles ordinary characters and backslash-sequences
1387 ;; (except with w32 msdos-like shells, where backslashes are valid).
1388 ;; The second matches "-quoted strings.
1389 ;; The third matches '-quoted strings.
1390 ;; The fourth matches `-quoted strings.
1391 ;; This seems to fit the syntax of BASH 2.0.
1392 (let* ((backslash-escape (not (and (fboundp 'w32-shell-dos-semantics)
1393 (w32-shell-dos-semantics))))
1394 (first (if backslash-escape
1397 (argpart (concat first
1401 (quote-subexpr (if backslash-escape 2 1))
1402 (args ()) (pos 0)
1403 (count 0)
1404 beg str quotes)
1405 ;; Build a list of all the args until we have as many as we want.
1406 (while (and (or (null mth) (<= count mth))
1407 (string-match argpart string pos))
1408 ;; Apply the `literal' text property to backslash-escaped
1409 ;; characters, so that `comint-delim-arg' won't break them up.
1410 (and backslash-escape
1411 (match-beginning 1)
1412 (put-text-property (match-beginning 1) (match-end 1)
1413 'literal t string))
1414 (if (and beg (= pos (match-beginning 0)))
1415 ;; It's contiguous, part of the same arg.
1416 (setq pos (match-end 0)
1417 quotes (or quotes (match-beginning quote-subexpr)))
1418 ;; It's a new separate arg.
1419 (if beg
1420 ;; Put the previous arg, if there was one, onto ARGS.
1421 (setq str (substring string beg pos)
1422 args (if quotes (cons str args)
1423 (nconc (comint-delim-arg str) args))))
1424 (setq count (length args))
1425 (setq quotes (match-beginning quote-subexpr))
1426 (setq beg (match-beginning 0))
1427 (setq pos (match-end 0))))
1428 (if beg
1429 (setq str (substring string beg pos)
1430 args (if quotes (cons str args)
1431 (nconc (comint-delim-arg str) args))))
1432 (setq count (length args))
1433 (let ((n (or nth (1- count)))
1434 (m (if mth (1- (- count mth)) 0)))
1435 (mapconcat
1436 (function (lambda (a) a)) (nthcdr n (nreverse (nthcdr m args))) " "))))
1437 \f
1438 ;;
1439 ;; Input processing stuff
1440 ;;
1441 (defun comint-add-to-input-history (cmd)
1442 "Add CMD to the input history.
1443 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1444 (if (and (funcall comint-input-filter cmd)
1445 (or (null comint-input-ignoredups)
1446 (not (ring-p comint-input-ring))
1447 (ring-empty-p comint-input-ring)
1448 (not (string-equal (ring-ref comint-input-ring 0)
1449 cmd))))
1450 (ring-insert comint-input-ring cmd)))
1452 (defun comint-send-input (&optional no-newline artificial)
1453 "Send input to process.
1454 After the process output mark, sends all text from the process mark to
1455 point as input to the process. Before the process output mark, calls
1456 value of variable `comint-get-old-input' to retrieve old input, copies
1457 it to the process mark, and sends it.
1459 This command also sends and inserts a final newline, unless
1460 NO-NEWLINE is non-nil.
1462 Any history reference may be expanded depending on the value of the variable
1463 `comint-input-autoexpand'. The list of function names contained in the value
1464 of `comint-input-filter-functions' is called on the input before sending it.
1465 The input is entered into the input history ring, if the value of variable
1466 `comint-input-filter' returns non-nil when called on the input.
1468 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1469 end of line before sending the input.
1471 After the input has been sent, if `comint-process-echoes' is non-nil,
1472 then `comint-send-input' waits to see if the process outputs a string
1473 matching the input, and if so, deletes that part of the output.
1474 If ARTIFICIAL is non-nil, it inhibits such deletion.
1475 Callers sending input not from the user should use ARTIFICIAL = t.
1477 The values of `comint-get-old-input', `comint-input-filter-functions', and
1478 `comint-input-filter' are chosen according to the command interpreter running
1479 in the buffer. E.g.,
1481 If the interpreter is the csh,
1482 `comint-get-old-input' is the default:
1483 If `comint-use-prompt-regexp' is nil, then
1484 either return the current input field, if point is on an input
1485 field, or the current line, if point is on an output field.
1486 If `comint-use-prompt-regexp' is non-nil, then
1487 return the current line with any initial string matching the
1488 regexp `comint-prompt-regexp' removed.
1491 `comint-input-filter' is the default: returns t if the input isn't all white
1492 space.
1494 If the Comint is Lucid Common Lisp,
1495 `comint-get-old-input' snarfs the sexp ending at point.
1496 `comint-input-filter-functions' does nothing.
1497 `comint-input-filter' returns nil if the input matches input-filter-regexp,
1498 which matches (1) all whitespace (2) :a, :c, etc.
1500 Similarly for Soar, Scheme, etc."
1501 (interactive)
1502 ;; Note that the input string does not include its terminal newline.
1503 (let ((proc (get-buffer-process (current-buffer))))
1504 (if (not proc) (error "Current buffer has no process")
1505 (widen)
1506 (let* ((pmark (process-mark proc))
1507 (intxt (if (>= (point) (marker-position pmark))
1508 (progn (if comint-eol-on-send (end-of-line))
1509 (buffer-substring pmark (point)))
1510 (let ((copy (funcall comint-get-old-input)))
1511 (goto-char pmark)
1512 (insert copy)
1513 copy)))
1514 (input (if (not (eq comint-input-autoexpand 'input))
1515 ;; Just whatever's already there
1516 intxt
1517 ;; Expand and leave it visible in buffer
1518 (comint-replace-by-expanded-history t pmark)
1519 (buffer-substring pmark (point))))
1520 (history (if (not (eq comint-input-autoexpand 'history))
1521 input
1522 ;; This is messy 'cos ultimately the original
1523 ;; functions used do insertion, rather than return
1524 ;; strings. We have to expand, then insert back.
1525 (comint-replace-by-expanded-history t pmark)
1526 (let ((copy (buffer-substring pmark (point)))
1527 (start (point)))
1528 (insert input)
1529 (delete-region pmark start)
1530 copy))))
1532 (unless no-newline
1535 (comint-add-to-input-history history)
1537 (run-hook-with-args 'comint-input-filter-functions
1538 (if no-newline input
1541 (let ((beg (marker-position pmark))
1542 (end (if no-newline (point) (1- (point))))
1543 (inhibit-modification-hooks t))
1544 (when (> end beg)
1545 (add-text-properties beg end
1546 '(front-sticky t
1547 font-lock-face comint-highlight-input))
1548 (unless comint-use-prompt-regexp
1549 ;; Give old user input a field property of `input', to
1550 ;; distinguish it from both process output and unsent
1551 ;; input. The terminating newline is put into a special
1552 ;; `boundary' field to make cursor movement between input
1553 ;; and output fields smoother.
1554 (add-text-properties
1555 beg end
1556 '(mouse-face highlight
1557 help-echo "mouse-2: insert after prompt as new input"
1558 field input))))
1559 (unless (or no-newline comint-use-prompt-regexp)
1560 ;; Cover the terminating newline
1561 (add-text-properties end (1+ end)
1562 '(rear-nonsticky t
1563 field boundary
1564 inhibit-line-move-field-capture t))))
1566 (comint-snapshot-last-prompt)
1568 (setq comint-save-input-ring-index comint-input-ring-index)
1569 (setq comint-input-ring-index nil)
1570 ;; Update the markers before we send the input
1571 ;; in case we get output amidst sending the input.
1572 (set-marker comint-last-input-start pmark)
1573 (set-marker comint-last-input-end (point))
1574 (set-marker (process-mark proc) (point))
1575 ;; clear the "accumulation" marker
1576 (set-marker comint-accum-marker nil)
1577 (let ((comint-input-sender-no-newline no-newline))
1578 (funcall comint-input-sender proc input))
1580 ;; Optionally delete echoed input (after checking it).
1581 (when (and comint-process-echoes (not artificial))
1582 (let ((echo-len (- comint-last-input-end
1583 comint-last-input-start)))
1584 ;; Wait for all input to be echoed:
1585 (while (and (accept-process-output proc)
1586 (> (+ comint-last-input-end echo-len)
1587 (point-max))
1588 (zerop
1589 (compare-buffer-substrings
1590 nil comint-last-input-start
1591 (- (point-max) echo-len)
1592 ;; Above difference is equivalent to
1593 ;; (+ comint-last-input-start
1594 ;; (- (point-max) comint-last-input-end))
1595 nil comint-last-input-end (point-max)))))
1596 (if (and
1597 (<= (+ comint-last-input-end echo-len)
1598 (point-max))
1599 (zerop
1600 (compare-buffer-substrings
1601 nil comint-last-input-start comint-last-input-end
1602 nil comint-last-input-end
1603 (+ comint-last-input-end echo-len))))
1604 ;; Certain parts of the text to be deleted may have
1605 ;; been mistaken for prompts. We have to prevent
1606 ;; problems when `comint-prompt-read-only' is non-nil.
1607 (let ((inhibit-read-only t))
1608 (delete-region comint-last-input-end
1609 (+ comint-last-input-end echo-len))
1610 (when comint-prompt-read-only
1611 (save-excursion
1612 (goto-char comint-last-input-end)
1613 (comint-update-fence)))))))
1615 ;; This used to call comint-output-filter-functions,
1616 ;; but that scrolled the buffer in undesirable ways.
1617 (run-hook-with-args 'comint-output-filter-functions "")))))
1619 (defvar comint-preoutput-filter-functions nil
1620 "List of functions to call before inserting Comint output into the buffer.
1621 Each function gets one argument, a string containing the text received
1622 from the subprocess. It should return the string to insert, perhaps
1623 the same string that was received, or perhaps a modified or transformed
1624 string.
1626 The functions on the list are called sequentially, and each one is
1627 given the string returned by the previous one. The string returned by
1628 the last function is the text that is actually inserted in the
1629 redirection buffer.
1631 You can use `add-hook' to add functions to this list
1632 either globally or locally.")
1634 (defvar comint-inhibit-carriage-motion nil
1635 "If nil, Comint will interpret `carriage control' characters in output.
1636 See `comint-carriage-motion' for details.")
1638 ;; When non-nil, this is an overlay over the last recognized prompt in
1639 ;; the buffer; it is used when highlighting the prompt.
1640 (defvar comint-last-prompt-overlay nil)
1642 (defun comint-snapshot-last-prompt ()
1643 "`snapshot' any current `comint-last-prompt-overlay'.
1644 Freeze its attributes in place, even when more input comes along
1645 and moves the prompt overlay."
1646 (when comint-last-prompt-overlay
1647 (let ((inhibit-read-only t)
1648 (inhibit-modification-hooks t))
1649 (add-text-properties (overlay-start comint-last-prompt-overlay)
1650 (overlay-end comint-last-prompt-overlay)
1651 (overlay-properties comint-last-prompt-overlay)))))
1653 (defun comint-carriage-motion (start end)
1654 "Interpret carriage control characters in the region from START to END.
1655 Translate carriage return/linefeed sequences to linefeeds.
1656 Make single carriage returns delete to the beginning of the line.
1657 Make backspaces delete the previous character."
1658 (save-excursion
1659 ;; First do a quick check to see if there are any applicable
1660 ;; characters, so we can avoid calling save-match-data and
1661 ;; save-restriction if not.
1662 (goto-char start)
1664 (save-match-data
1665 (save-restriction
1666 (widen)
1667 (let ((inhibit-field-text-motion t)
1668 (inhibit-read-only t))
1669 ;; CR LF -> LF
1670 ;; Note that this won't work properly when the CR and LF
1671 ;; are in different output chunks, but this is probably an
1672 ;; exceedingly rare case (because they are generally
1673 ;; written as a unit), and to delay interpretation of a
1674 ;; trailing CR in a chunk would result in odd interactive
1675 ;; behavior (and this case is probably far more common).
1677 (delete-char -1))
1678 ;; bare CR -> delete preceding line
1679 (goto-char start)
1681 (delete-region (point) (line-beginning-position)))
1682 ;; BS -> delete preceding character
1683 (goto-char start)
1685 (delete-char -2))))))))
1687 ;; The purpose of using this filter for comint processes
1688 ;; is to keep comint-last-input-end from moving forward
1689 ;; when output is inserted.
1690 (defun comint-output-filter (process string)
1691 (let ((oprocbuf (process-buffer process)))
1692 ;; First check for killed buffer or no input.
1693 (when (and string oprocbuf (buffer-name oprocbuf))
1694 (with-current-buffer oprocbuf
1695 ;; Run preoutput filters
1696 (let ((functions comint-preoutput-filter-functions))
1697 (while (and functions string)
1698 (if (eq (car functions) t)
1699 (let ((functions (default-value 'comint-preoutput-filter-functions)))
1700 (while (and functions string)
1701 (setq string (funcall (car functions) string))
1702 (setq functions (cdr functions))))
1703 (setq string (funcall (car functions) string)))
1704 (setq functions (cdr functions))))
1706 ;; Insert STRING
1707 (let ((inhibit-read-only t)
1708 ;; Avoid the overhead of save-excursion, since we just
1709 ;; fiddle with the point
1710 (saved-point (point-marker)))
1712 ;; The point should float after any insertion we do
1713 (set-marker-insertion-type saved-point t)
1715 ;; We temporarly remove any buffer narrowing, in case the
1716 ;; process mark is outside of the restriction
1717 (save-restriction
1718 (widen)
1720 (goto-char (process-mark process))
1721 (set-marker comint-last-output-start (point))
1723 ;; insert-before-markers is a bad thing. XXX
1724 ;;
1725 ;; It is used here to force window-point markers (used to
1726 ;; store the value of point in non-selected windows) to
1727 ;; advance, but it also screws up any other markers that we
1728 ;; don't _want_ to advance, such as the start-marker of some
1729 ;; of the overlays we create.
1730 ;;
1731 ;; We work around the problem with the overlays by
1732 ;; explicitly adjusting them after we do the insertion, but
1733 ;; in the future this problem should be solved correctly, by
1734 ;; using `insert', and making the insertion-type of
1735 ;; window-point markers settable (via a buffer-local
1736 ;; variable). In comint buffers, this variable would be set
1737 ;; to `t', to cause point in non-select windows to advance.
1738 (insert-before-markers string)
1739 ;; Fixup markers and overlays that got screwed up because we
1740 ;; used `insert-before-markers'.
1741 (let ((old-point (- (point) (length string))))
1742 ;; comint-last-output-start
1743 (set-marker comint-last-output-start old-point)
1744 ;; comint-last-input-end
1745 (when (and comint-last-input-end
1746 (equal (marker-position comint-last-input-end)
1747 (point)))
1748 (set-marker comint-last-input-end old-point))
1749 ;; No overlays we create are set to advance upon insertion
1750 ;; (at the start/end), so we assume that any overlay which
1751 ;; is at the current point was incorrectly advanced by
1752 ;; insert-before-markers. First fixup overlays that might
1753 ;; start at point:
1754 (dolist (over (overlays-at (point)))
1755 (when (= (overlay-start over) (point))
1756 (let ((end (overlay-end over)))
1757 (move-overlay over
1758 old-point
1759 (if (= end (point)) old-point end)))))
1760 ;; Then do overlays that might end at point:
1761 (dolist (over (overlays-at (1- (point))))
1762 (when (= (overlay-end over) (point))
1763 (move-overlay over
1764 (min (overlay-start over) old-point)
1765 old-point))))
1767 ;; Advance process-mark
1768 (set-marker (process-mark process) (point))
1770 (unless comint-inhibit-carriage-motion
1771 ;; Interpret any carriage motion characters (newline, backspace)
1772 (comint-carriage-motion comint-last-output-start (point)))
1774 ;; Run these hooks with point where the user had it.
1775 (goto-char saved-point)
1776 (run-hook-with-args 'comint-output-filter-functions string)
1777 (set-marker saved-point (point))
1779 (goto-char (process-mark process)) ; in case a filter moved it
1781 (unless comint-use-prompt-regexp
1782 (let ((inhibit-read-only t)
1783 (inhibit-modification-hooks t))
1784 (add-text-properties comint-last-output-start (point)
1785 '(rear-nonsticky t
1786 field output
1787 inhibit-line-move-field-capture t))))
1789 ;; Highlight the prompt, where we define `prompt' to mean
1790 ;; the most recent output that doesn't end with a newline.
1791 (let ((prompt-start (save-excursion (forward-line 0) (point)))
1792 (inhibit-read-only t)
1793 (inhibit-modification-hooks t))
1794 (when comint-prompt-read-only
1795 (or (= (point-min) prompt-start)
1796 (get-text-property (1- prompt-start) 'read-only)
1797 (put-text-property
1798 (1- prompt-start) prompt-start 'read-only 'fence))
1799 (add-text-properties
1800 prompt-start (point)
1801 '(read-only t rear-nonsticky t front-sticky (read-only))))
1802 (unless (and (bolp) (null comint-last-prompt-overlay))
1803 ;; Need to create or move the prompt overlay (in the case
1804 ;; where there is no prompt ((bolp) == t), we still do
1805 ;; this if there's already an existing overlay).
1806 (if comint-last-prompt-overlay
1807 ;; Just move an existing overlay
1808 (move-overlay comint-last-prompt-overlay
1809 prompt-start (point))
1810 ;; Need to create the overlay
1811 (setq comint-last-prompt-overlay
1812 (make-overlay prompt-start (point)))
1813 (overlay-put comint-last-prompt-overlay
1814 'font-lock-face 'comint-highlight-prompt))))
1816 (goto-char saved-point)))))))
1818 (defun comint-preinput-scroll-to-bottom ()
1819 "Go to the end of buffer in all windows showing it.
1820 Movement occurs if point in the selected window is not after the process mark,
1821 and `this-command' is an insertion command. Insertion commands recognized
1822 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1823 Depends on the value of `comint-scroll-to-bottom-on-input'.
1825 This function should be a pre-command hook."
1826 (if (and comint-scroll-to-bottom-on-input
1827 (memq this-command '(self-insert-command comint-magic-space yank
1828 hilit-yank)))
1829 (let* ((selected (selected-window))
1830 (current (current-buffer))
1831 (process (get-buffer-process current))
1832 (scroll comint-scroll-to-bottom-on-input))
1833 (if (and process (< (point) (process-mark process)))
1834 (if (eq scroll 'this)
1835 (goto-char (point-max))
1836 (walk-windows
1837 (function (lambda (window)
1838 (if (and (eq (window-buffer window) current)
1839 (or (eq scroll t) (eq scroll 'all)))
1840 (progn
1841 (select-window window)
1842 (goto-char (point-max))
1843 (select-window selected)))))
1844 nil t))))))
1846 (defun comint-postoutput-scroll-to-bottom (string)
1847 "Go to the end of buffer in some or all windows showing it.
1848 Does not scroll if the current line is the last line in the buffer.
1849 Depends on the value of `comint-move-point-for-output' and
1850 `comint-scroll-show-maximum-output'.
1852 This function should be in the list `comint-output-filter-functions'."
1853 (let* ((selected (selected-window))
1854 (current (current-buffer))
1855 (process (get-buffer-process current))
1856 (scroll comint-move-point-for-output))
1857 (unwind-protect
1858 (if process
1859 (walk-windows
1860 (function (lambda (window)
1861 (if (eq (window-buffer window) current)
1862 (progn
1863 (select-window window)
1864 (if (and (< (point) (process-mark process))
1865 (or (eq scroll t) (eq scroll 'all)
1866 ;; Maybe user wants point to jump to end.
1867 (and (eq scroll 'this) (eq selected window))
1868 (and (eq scroll 'others) (not (eq selected window)))
1869 ;; If point was at the end, keep it at end.
1870 (and (marker-position comint-last-output-start)
1871 (>= (point) comint-last-output-start))))
1872 (goto-char (process-mark process)))
1873 ;; Optionally scroll so that the text
1874 ;; ends at the bottom of the window.
1875 (if (and comint-scroll-show-maximum-output
1876 (= (point) (point-max)))
1877 (save-excursion
1878 (goto-char (point-max))
1879 (recenter (- -1 scroll-margin))))
1880 (select-window selected)))))
1881 nil t))
1882 (set-buffer current))))
1884 (defun comint-truncate-buffer (&optional string)
1885 "Truncate the buffer to `comint-buffer-maximum-size'.
1886 This function could be on `comint-output-filter-functions' or bound to a key."
1887 (interactive)
1888 (save-excursion
1889 (goto-char (process-mark (get-buffer-process (current-buffer))))
1890 (forward-line (- comint-buffer-maximum-size))
1891 (beginning-of-line)
1892 (let ((inhibit-read-only t))
1893 (delete-region (point-min) (point)))))
1895 (defun comint-strip-ctrl-m (&optional string)
1896 "Strip trailing `^M' characters from the current output group.
1897 This function could be on `comint-output-filter-functions' or bound to a key."
1898 (interactive)
1899 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1900 (save-excursion
1901 (condition-case nil
1902 (goto-char
1903 (if (interactive-p) comint-last-input-end comint-last-output-start))
1904 (error nil))
1906 (replace-match "" t t)))))
1907 (defalias 'shell-strip-ctrl-m 'comint-strip-ctrl-m)
1909 (defun comint-show-maximum-output ()
1910 "Put the end of the buffer at the bottom of the window."
1911 (interactive)
1912 (goto-char (point-max))
1913 (recenter (- -1 scroll-margin)))
1915 (defun comint-get-old-input-default ()
1916 "Default for `comint-get-old-input'.
1917 If `comint-use-prompt-regexp' is nil, then either
1918 return the current input field, if point is on an input field, or the
1919 current line, if point is on an output field.
1920 If `comint-use-prompt-regexp' is non-nil, then return
1921 the current line with any initial string matching the regexp
1922 `comint-prompt-regexp' removed."
1923 (let ((bof (field-beginning)))
1924 (if (eq (get-char-property bof 'field) 'input)
1925 (field-string-no-properties bof)
1926 (comint-bol)
1927 (buffer-substring-no-properties (point) (line-end-position)))))
1929 (defun comint-copy-old-input ()
1930 "Insert after prompt old input at point as new input to be edited.
1931 Calls `comint-get-old-input' to get old input."
1932 (interactive)
1933 (let ((input (funcall comint-get-old-input))
1934 (process (get-buffer-process (current-buffer))))
1935 (if (not process)
1936 (error "Current buffer has no process")
1937 (goto-char (process-mark process))
1938 (insert input))))
1940 (defun comint-skip-prompt ()
1941 "Skip past the text matching regexp `comint-prompt-regexp'.
1942 If this takes us past the end of the current line, don't skip at all."
1943 (if (and (looking-at comint-prompt-regexp)
1944 (<= (match-end 0) (line-end-position)))
1945 (goto-char (match-end 0))))
1947 (defun comint-after-pmark-p ()
1948 "Return t if point is after the process output marker."
1949 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
1950 (<= (marker-position pmark) (point))))
1952 (defun comint-simple-send (proc string)
1953 "Default function for sending to PROC input STRING.
1954 This just sends STRING plus a newline. To override this,
1955 set the hook `comint-input-sender'."
1956 (comint-send-string proc string)
1957 (if comint-input-sender-no-newline
1958 (if (not (string-equal string ""))
1959 (process-send-eof))
1962 (defun comint-line-beginning-position ()
1963 "Return the buffer position of the beginning of the line, after any prompt.
1964 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done by
1965 skipping text matching the regular expression `comint-prompt-regexp',
1966 a buffer local variable."
1967 (if comint-use-prompt-regexp
1968 ;; Use comint-prompt-regexp
1969 (save-excursion
1970 (beginning-of-line)
1971 (comint-skip-prompt)
1972 (point))
1973 ;; Use input fields. Note that, unlike the behavior of
1974 ;; `line-beginning-position' inside a field, this function will
1975 ;; return the position of the end of a prompt, even if the point is
1976 ;; already inside the prompt. In order to do this, it assumes that
1977 ;; if there are two fields on a line, then the first one is the
1978 ;; prompt, and the second one is an input field, and is front-sticky
1979 ;; (as input fields should be).
1980 (constrain-to-field (line-beginning-position) (line-end-position))))
1982 (defun comint-bol (&optional arg)
1983 "Go to the beginning of line, then skip past the prompt, if any.
1985 If `comint-use-prompt-regexp' is non-nil, then the prompt skip is done
1986 by skipping text matching the regular expression `comint-prompt-regexp',
1987 a buffer local variable."
1988 (interactive "P")
1989 (if arg
1990 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1991 (forward-line 0)
1992 (goto-char (comint-line-beginning-position))))
1994 ;; For compatibility.
1995 (defun comint-read-noecho (prompt &optional ignore)
1996 (read-passwd prompt))
1998 ;; These three functions are for entering text you don't want echoed or
1999 ;; saved -- typically passwords to ftp, telnet, or somesuch.
2000 ;; Just enter m-x send-invisible and type in your line.
2002 (defun send-invisible (&optional prompt)
2003 "Read a string without echoing.
2004 Then send it to the process running in the current buffer.
2005 The string is sent using `comint-input-sender'.
2006 Security bug: your string can still be temporarily recovered with
2008 (interactive "P") ; Defeat snooping via C-x ESC ESC
2009 (let ((proc (get-buffer-process (current-buffer)))
2010 (prefix
2011 (if (eq (window-buffer (selected-window)) (current-buffer))
2012 ""
2013 (format "(In buffer %s) "
2014 (current-buffer)))))
2015 (if proc
2016 (let ((str (read-passwd (concat prefix
2017 (or prompt "Non-echoed text: ")))))
2018 (if (stringp str)
2019 (progn
2020 (comint-snapshot-last-prompt)
2021 (funcall comint-input-sender proc str))
2022 (message "Warning: text will be echoed")))
2023 (error "Buffer %s has no process" (current-buffer)))))
2025 (defun comint-watch-for-password-prompt (string)
2026 "Prompt in the minibuffer for password and send without echoing.
2027 This function uses `send-invisible' to read and send a password to the buffer's
2028 process if STRING contains a password prompt defined by
2029 `comint-password-prompt-regexp'.
2031 This function could be in the list `comint-output-filter-functions'."
2032 (when (string-match comint-password-prompt-regexp string)
2034 (setq string (replace-match "" t t string)))
2035 (send-invisible string)))
2036 \f
2037 ;; Low-level process communication
2039 (defun comint-send-string (process string)
2040 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
2041 (if process
2042 (with-current-buffer (if (processp process)
2043 (process-buffer process)
2044 (get-buffer process))
2045 (comint-snapshot-last-prompt))
2046 (comint-snapshot-last-prompt))
2047 (process-send-string process string))
2049 (defun comint-send-region (process start end)
2050 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
2051 (if process
2052 (with-current-buffer (if (processp process)
2053 (process-buffer process)
2054 (get-buffer process))
2055 (comint-snapshot-last-prompt))
2056 (comint-snapshot-last-prompt))
2057 (process-send-region process start end))
2059 \f
2060 ;; Random input hackage
2062 (defun comint-delete-output ()
2063 "Delete all output from interpreter since last input.
2064 Does not delete the prompt."
2065 (interactive)
2066 (let ((proc (get-buffer-process (current-buffer)))
2067 (replacement nil)
2068 (inhibit-read-only t))
2069 (save-excursion
2070 (let ((pmark (progn (goto-char (process-mark proc))
2071 (forward-line 0)
2072 (point-marker))))
2073 (delete-region comint-last-input-end pmark)
2074 (goto-char (process-mark proc))
2076 (buffer-substring pmark (point))))
2077 (delete-region pmark (point))))
2078 ;; Output message and put back prompt
2079 (comint-output-filter proc replacement)))
2080 (define-obsolete-function-alias 'comint-kill-output
2081 'comint-delete-output "21.1")
2083 (defun comint-write-output (filename &optional append mustbenew)
2084 "Write output from interpreter since last input to FILENAME.
2085 Any prompt at the end of the output is not written.
2087 If the optional argument APPEND (the prefix argument when interactive)
2088 is non-nil, the output is appended to the file instead.
2090 If the optional argument MUSTBENEW is non-nil, check for an existing
2091 file with the same name. If MUSTBENEW is `excl', that means to get an
2092 error if the file already exists; never overwrite. If MUSTBENEW is
2093 neither nil nor `excl', that means ask for confirmation before
2094 overwriting, but do go ahead and overwrite the file if the user
2095 confirms. When interactive, MUSTBENEW is nil when appending, and t
2096 otherwise."
2097 (interactive
2098 (list (read-file-name
2099 (if current-prefix-arg
2100 "Append output to file: "
2101 "Write output to file: "))
2102 current-prefix-arg
2103 (not current-prefix-arg)))
2104 (save-excursion
2105 (goto-char (process-mark (get-buffer-process (current-buffer))))
2106 (forward-line 0)
2107 (write-region comint-last-input-end (point) filename
2108 append nil nil mustbenew)))
2110 ;; This function exists for the benefit of the menu; from the keyboard,
2111 ;; users can just use `comint-write-output' with a prefix arg.
2112 (defun comint-append-output-to-file (filename)
2113 "Append output from interpreter since last input to FILENAME.
2114 Any prompt at the end of the output is not written."
2115 (interactive "fAppend output to file: ")
2116 (comint-write-output filename t))
2118 (defun comint-show-output ()
2119 "Display start of this batch of interpreter output at top of window.
2120 Sets mark to the value of point when this command is run."
2121 (interactive)
2122 (push-mark)
2123 (let ((pos (or (marker-position comint-last-input-end) (point-max))))
2124 (cond (comint-use-prompt-regexp
2125 (goto-char pos)
2126 (beginning-of-line 0)
2127 (set-window-start (selected-window) (point))
2128 (comint-skip-prompt))
2129 (t
2130 (let* ((beg (field-beginning pos))
2131 (pt (if (= (point-min) beg)
2132 (point-min)
2133 (1+ beg))))
2134 (goto-char pt))
2135 (set-window-start (selected-window) (point))))))
2138 (defun comint-interrupt-subjob ()
2139 "Interrupt the current subjob.
2140 This command also kills the pending input
2141 between the process mark and point."
2142 (interactive)
2143 (comint-skip-input)
2144 (interrupt-process nil comint-ptyp)
2146 )
2148 (defun comint-kill-subjob ()
2149 "Send kill signal to the current subjob.
2150 This command also kills the pending input
2151 between the process mark and point."
2152 (interactive)
2153 (comint-skip-input)
2154 (kill-process nil comint-ptyp))
2156 (defun comint-quit-subjob ()
2157 "Send quit signal to the current subjob.
2158 This command also kills the pending input
2159 between the process mark and point."
2160 (interactive)
2161 (comint-skip-input)
2162 (quit-process nil comint-ptyp))
2164 (defun comint-stop-subjob ()
2165 "Stop the current subjob.
2166 This command also kills the pending input
2167 between the process mark and point.
2169 WARNING: if there is no current subjob, you can end up suspending
2170 the top-level process running in the buffer. If you accidentally do
2172 is not a problem with most shells, since they ignore this signal.)"
2173 (interactive)
2174 (comint-skip-input)
2175 (stop-process nil comint-ptyp))
2177 (defun comint-continue-subjob ()
2178 "Send CONT signal to process buffer's process group.
2179 Useful if you accidentally suspend the top-level process."
2180 (interactive)
2181 (continue-process nil comint-ptyp))
2183 (defun comint-skip-input ()
2184 "Skip all pending input, from last stuff output by interpreter to point.
2185 This means mark it as if it had been sent as input, without sending it."
2186 (let ((comint-input-sender 'ignore)
2187 (comint-input-filter-functions nil))
2188 (comint-send-input t t))
2189 (end-of-line)
2190 (let ((pos (point))
2191 (marker (process-mark (get-buffer-process (current-buffer)))))
2192 (insert " " (key-description (this-command-keys)))
2193 (if (= marker pos)
2194 (set-marker marker (point)))))
2196 (defun comint-kill-input ()
2197 "Kill all text from last stuff output by interpreter to point."
2198 (interactive)
2199 (let ((pmark (process-mark (get-buffer-process (current-buffer)))))
2200 (if (> (point) (marker-position pmark))
2201 (kill-region pmark (point)))))
2203 (defun comint-delchar-or-maybe-eof (arg)
2204 "Delete ARG characters forward or send an EOF to subprocess.
2205 Sends an EOF only if point is at the end of the buffer and there is no input."
2206 (interactive "p")
2207 (let ((proc (get-buffer-process (current-buffer))))
2208 (if (and (eobp) proc (= (point) (marker-position (process-mark proc))))
2209 (comint-send-eof)
2210 (delete-char arg))))
2212 (defun comint-send-eof ()
2213 "Send an EOF to the current buffer's process."
2214 (interactive)
2215 (comint-send-input t t)
2216 (process-send-eof))
2219 (defun comint-backward-matching-input (regexp n)
2220 "Search backward through buffer for input fields that match REGEXP.
2221 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2222 by lines that match `comint-prompt-regexp'.
2224 With prefix argument N, search for Nth previous match.
2225 If N is negative, find the next or Nth next match."
2226 (interactive (comint-regexp-arg "Backward input matching (regexp): "))
2227 (if comint-use-prompt-regexp
2228 ;; Use comint-prompt-regexp
2229 (let* ((re (concat comint-prompt-regexp ".*" regexp))
2230 (pos (save-excursion (end-of-line (if (> n 0) 0 1))
2231 (if (re-search-backward re nil t n)
2232 (point)))))
2233 (if (null pos)
2234 (progn (message "Not found")
2235 (ding))
2236 (goto-char pos)
2237 (comint-bol nil)))
2238 ;; Use input fields
2239 (let* ((dir (if (< n 0) -1 1))
2240 (pos
2241 (save-excursion
2242 (while (/= n 0)
2243 (unless (re-search-backward regexp nil t dir)
2244 (error "Not found"))
2245 (when (eq (get-char-property (point) 'field) 'input)
2246 (setq n (- n dir))))
2247 (field-beginning))))
2248 (goto-char pos))))
2251 (defun comint-forward-matching-input (regexp n)
2252 "Search forward through buffer for input fields that match REGEXP.
2253 If `comint-use-prompt-regexp' is non-nil, then input fields are identified
2254 by lines that match `comint-prompt-regexp'.
2256 With prefix argument N, search for Nth following match.
2257 If N is negative, find the previous or Nth previous match."
2258 (interactive (comint-regexp-arg "Forward input matching (regexp): "))
2259 (comint-backward-matching-input regexp (- n)))
2262 (defun comint-next-prompt (n)
2263 "Move to end of Nth next prompt in the buffer.
2264 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2265 the Nth next `input' field, otherwise, it means the Nth occurrence of
2266 text matching `comint-prompt-regexp'."
2267 (interactive "p")
2268 (if comint-use-prompt-regexp
2269 ;; Use comint-prompt-regexp
2270 (let ((paragraph-start comint-prompt-regexp))
2271 (end-of-line (if (> n 0) 1 0))
2272 (forward-paragraph n)
2273 (comint-skip-prompt))
2274 ;; Use input fields
2275 (let ((pos (point))
2276 (input-pos nil)
2277 prev-pos)
2278 (while (/= n 0)
2279 (setq prev-pos pos)
2280 (setq pos
2281 (if (> n 0)
2282 (next-single-char-property-change pos 'field)
2283 (previous-single-char-property-change pos 'field)))
2284 (cond ((or (null pos) (= pos prev-pos))
2285 ;; Ran off the end of the buffer.
2286 (when (> n 0)
2287 ;; There's always an input field at the end of the
2288 ;; buffer, but it has a `field' property of nil.
2289 (setq input-pos (point-max)))
2290 ;; stop iterating
2291 (setq n 0))
2292 ((eq (get-char-property pos 'field) 'input)
2293 (setq n (if (< n 0) (1+ n) (1- n)))
2294 (setq input-pos pos))))
2295 (when input-pos
2296 (goto-char input-pos)))))
2299 (defun comint-previous-prompt (n)
2300 "Move to end of Nth previous prompt in the buffer.
2301 If `comint-use-prompt-regexp' is nil, then this means the beginning of
2302 the Nth previous `input' field, otherwise, it means the Nth occurrence of
2303 text matching `comint-prompt-regexp'."
2304 (interactive "p")
2305 (comint-next-prompt (- n)))
2307 ;; State used by `comint-insert-previous-argument' when cycling.
2308 (defvar comint-insert-previous-argument-last-start-pos nil)
2309 (make-variable-buffer-local 'comint-insert-previous-argument-last-start-pos)
2310 (defvar comint-insert-previous-argument-last-index nil)
2311 (make-variable-buffer-local 'comint-insert-previous-argument-last-index)
2313 ;; Needs fixing:
2314 ;; make comint-arguments understand negative indices as bash does
2315 (defun comint-insert-previous-argument (index)
2316 "Insert the INDEXth argument from the previous Comint command-line at point.
2317 Spaces are added at beginning and/or end of the inserted string if
2318 necessary to ensure that it's separated from adjacent arguments.
2319 Interactively, if no prefix argument is given, the last argument is inserted.
2320 Repeated interactive invocations will cycle through the same argument
2321 from progressively earlier commands (using the value of INDEX specified
2322 with the first command).
2323 This command is like `M-.' in bash."
2324 (interactive "P")
2325 (unless (null index)
2326 (setq index (prefix-numeric-value index)))
2327 (cond ((eq last-command this-command)
2328 ;; Delete last input inserted by this command.
2329 (delete-region comint-insert-previous-argument-last-start-pos (point))
2330 (setq index comint-insert-previous-argument-last-index))
2331 (t
2332 ;; This is a non-repeat invocation, so initialize state.
2333 (setq comint-input-ring-index nil)
2334 (setq comint-insert-previous-argument-last-index index)
2335 (when (null comint-insert-previous-argument-last-start-pos)
2336 ;; First usage; initialize to a marker
2337 (setq comint-insert-previous-argument-last-start-pos
2338 (make-marker)))))
2339 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2340 (if (<= (point) (comint-line-beginning-position))
2341 (comint-bol)
2342 (just-one-space))
2343 ;; Remember the beginning of what we insert, so we can delete it if
2344 ;; the command is repeated.
2345 (set-marker comint-insert-previous-argument-last-start-pos (point))
2346 ;; Insert the argument.
2347 (let ((input-string (comint-previous-input-string 0)))
2349 ;; strip terminating '&'
2350 (setq input-string (substring input-string 0 (match-beginning 0))))
2351 (insert (comint-arguments input-string index index)))
2352 ;; Make next invocation return arg from previous input
2353 (setq comint-input-ring-index (1+ (or comint-input-ring-index 0)))
2354 ;; Add a terminating space if necessary.
2355 (unless (eolp)
2356 (just-one-space)))
2358 \f
2359 ;; Support editing with `comint-prompt-read-only' set to t.
2361 (defun comint-update-fence ()
2362 "Update read-only status of newline before point.
2363 The `fence' read-only property is used to indicate that a newline
2365 following front-sticky read-only region. This is used to
2366 implement comint read-only prompts. If the text after a newline
2367 changes, the read-only status of that newline may need updating.
2368 That is what this function does.
2370 This function does nothing if point is not at the beginning of a
2371 line, or is at the beginning of the accessible portion of the buffer.
2372 Otherwise, if the character after point has a front-sticky
2373 read-only property, then the preceding newline is given a
2374 read-only property of `fence', unless it already is read-only.
2375 If the character after point does not have a front-sticky
2376 read-only property, any read-only property of `fence' on the
2377 preceding newline is removed."
2378 (let* ((pt (point)) (lst (get-text-property pt 'front-sticky))
2379 (inhibit-modification-hooks t))
2380 (and (bolp)
2381 (not (bobp))
2382 (if (and (get-text-property pt 'read-only)
2383 (if (listp lst) (memq 'read-only lst) t))
2384 (unless (get-text-property (1- pt) 'read-only)
2385 (put-text-property (1- pt) pt 'read-only 'fence))
2386 (when (eq (get-text-property (1- pt) 'read-only) 'fence)
2387 (remove-list-of-text-properties (1- pt) pt '(read-only)))))))
2389 (defun comint-kill-whole-line (&optional count)
2390 "Kill current line, ignoring read-only and field properties.
2391 With prefix arg COUNT, kill that many lines starting from the current line.
2392 If COUNT is negative, kill backward. Also kill the preceding newline,
2394 with negative arguments.)
2395 If COUNT is zero, kill current line but exclude the trailing newline.
2396 The read-only status of newlines is updated with `comint-update-fence',
2397 if necessary."
2398 (interactive "p")
2399 (let ((inhibit-read-only t) (inhibit-field-text-motion t))
2400 (kill-whole-line count)
2401 (when (>= count 0) (comint-update-fence))))
2403 (defun comint-kill-region (beg end &optional yank-handler)
2404 "Like `kill-region', but ignores read-only properties, if safe.
2405 This command assumes that the buffer contains read-only
2407 properties at the beginning of a line, with the preceding newline
2408 being read-only to protect the prompt. This is true of the
2409 comint prompts if `comint-prompt-read-only' is non-nil. This
2410 command will not delete the region if this would create mutilated
2411 or out of place prompts. That is, if any part of a prompt is
2412 deleted, the entire prompt must be deleted and all remaining
2413 prompts should stay at the beginning of a line. If this is not
2414 the case, this command just calls `kill-region' with all
2415 read-only properties intact. The read-only status of newlines is
2416 updated using `comint-update-fence', if necessary."
2417 (interactive "r")
2418 (save-excursion
2419 (let* ((true-beg (min beg end))
2420 (true-end (max beg end))
2421 (beg-bolp (progn (goto-char true-beg) (bolp)))
2422 (beg-lst (get-text-property true-beg 'front-sticky))
2423 (beg-bad (and (get-text-property true-beg 'read-only)
2424 (if (listp beg-lst) (memq 'read-only beg-lst) t)))
2425 (end-bolp (progn (goto-char true-end) (bolp)))
2426 (end-lst (get-text-property true-end 'front-sticky))
2427 (end-bad (and (get-text-property true-end 'read-only)
2428 (if (listp end-lst) (memq 'read-only end-lst) t))))
2429 (if (or (and (not beg-bolp) (or beg-bad end-bad))
2430 (and (not end-bolp) end-bad))
2431 (kill-region beg end yank-handler)
2432 (let ((inhibit-read-only t))
2433 (kill-region beg end yank-handler)
2434 (comint-update-fence))))))
2436 \f
2437 ;; Support for source-file processing commands.
2438 ;;============================================================================
2439 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2440 ;; commands that process files of source text (e.g. loading or compiling
2441 ;; files). So the corresponding process-in-a-buffer modes have commands
2442 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2443 ;; for defining these commands.
2444 ;;
2445 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2446 ;; and Soar, in that they don't know anything about file extensions.
2447 ;; So the compile/load interface gets the wrong default occasionally.
2448 ;; The load-file/compile-file default mechanism could be smarter -- it
2449 ;; doesn't know about the relationship between filename extensions and
2450 ;; whether the file is source or executable. If you compile foo.lisp
2451 ;; with compile-file, then the next load-file should use foo.bin for
2452 ;; the default, not foo.lisp. This is tricky to do right, particularly
2453 ;; because the extension for executable files varies so much (.o, .bin,
2454 ;; .lbin, .mo, .vo, .ao, ...).
2457 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2458 ;; commands.
2459 ;;
2460 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2461 ;; want to save the buffer before issuing any process requests to the command
2462 ;; interpreter.
2463 ;;
2464 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2465 ;; for the file to process.
2467 (defun comint-source-default (previous-dir/file source-modes)
2468 "Compute the defaults for `load-file' and `compile-file' commands.
2470 PREVIOUS-DIR/FILE is a pair (DIRECTORY . FILENAME) from the last
2471 source-file processing command, or nil if there hasn't been one yet.
2472 SOURCE-MODES is a list used to determine what buffers contain source
2473 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2474 Typically, (lisp-mode) or (scheme-mode).
2476 If the command is given while the cursor is inside a string, *and*
2477 the string is an existing filename, *and* the filename is not a directory,
2478 then the string is taken as default. This allows you to just position
2479 your cursor over a string that's a filename and have it taken as default.
2481 If the command is given in a file buffer whose major mode is in
2482 SOURCE-MODES, then the filename is the default file, and the
2483 file's directory is the default directory.
2485 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2486 then the default directory & file are what was used in the last source-file
2487 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2488 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2491 SOURCE-MODES is typically going to be something like (tea-mode)
2492 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2493 for Soar programs, etc.
2495 The function returns a pair: (default-directory . default-file)."
2496 (cond ((and buffer-file-name (memq major-mode source-modes))
2497 (cons (file-name-directory buffer-file-name)
2498 (file-name-nondirectory buffer-file-name)))
2499 (previous-dir/file)
2500 (t
2501 (cons default-directory nil))))
2504 (defun comint-check-source (fname)
2505 "Check whether to save buffers visiting file FNAME.
2506 Prior to loading or compiling (or otherwise processing) a file (in the CMU
2507 process-in-a-buffer modes), this function can be called on the filename.
2508 If the file is loaded into a buffer, and the buffer is modified, the user
2509 is queried to see if he wants to save the buffer before proceeding with
2510 the load or compile."
2511 (let ((buff (get-file-buffer fname)))
2512 (if (and buff
2513 (buffer-modified-p buff)
2514 (y-or-n-p (format "Save buffer %s first? " (buffer-name buff))))
2515 ;; save BUFF.
2516 (let ((old-buffer (current-buffer)))
2517 (set-buffer buff)
2518 (save-buffer)
2519 (set-buffer old-buffer)))))
2521 (defun comint-extract-string ()
2522 "Return string around point, or nil."
2523 (let ((syntax (syntax-ppss)))
2524 (when (nth 3 syntax)
2525 (condition-case ()
2526 (buffer-substring-no-properties (1+ (nth 8 syntax))
2527 (progn (goto-char (nth 8 syntax))
2528 (forward-sexp)
2529 (1- (point))))
2530 (error nil)))))
2532 (defun comint-get-source (prompt prev-dir/file source-modes mustmatch-p)
2533 "Prompt for filenames in commands that process source files,
2534 e.g. loading or compiling a file.
2535 Provides a default, if there is one, and returns the result filename.
2537 See `comint-source-default' for more on determining defaults.
2539 PROMPT is the prompt string. PREV-DIR/FILE is the (DIRECTORY . FILE) pair
2540 from the last source processing command. SOURCE-MODES is a list of major
2541 modes used to determine what file buffers contain source files. (These
2542 two arguments are used for determining defaults.) If MUSTMATCH-P is true,
2543 then the filename reader will only accept a file that exists.
2545 A typical use:
2547 '(lisp-mode) t))"
2548 (let* ((def (comint-source-default prev-dir/file source-modes))
2549 (stringfile (comint-extract-string))
2550 (sfile-p (and stringfile
2551 (condition-case ()
2552 (file-exists-p stringfile)
2553 (error nil))
2554 (not (file-directory-p stringfile))))
2555 (defdir (if sfile-p (file-name-directory stringfile)
2556 (car def)))
2557 (deffile (if sfile-p (file-name-nondirectory stringfile)
2558 (cdr def)))
2559 (ans (read-file-name (if deffile (format "%s(default %s) "
2560 prompt deffile)
2561 prompt)
2562 defdir
2563 (concat defdir deffile)
2564 mustmatch-p)))
2565 (list (expand-file-name (substitute-in-file-name ans)))))
2567 ;; I am somewhat divided on this string-default feature. It seems
2568 ;; to violate the principle-of-least-astonishment, in that it makes
2569 ;; the default harder to predict, so you actually have to look and see
2570 ;; what the default really is before choosing it. This can trip you up.
2571 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2572 ;; on this.
2573 ;; -Olin
2575 \f
2576 ;; Simple process query facility.
2577 ;; ===========================================================================
2578 ;; This function is for commands that want to send a query to the process
2579 ;; and show the response to the user. For example, a command to get the
2580 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2581 ;; to an inferior Common Lisp process.
2582 ;;
2583 ;; This simple facility just sends strings to the inferior process and pops
2584 ;; up a window for the process buffer so you can see what the process
2585 ;; responds with. We don't do anything fancy like try to intercept what the
2586 ;; process responds with and put it in a pop-up window or on the message
2587 ;; line. We just display the buffer. Low tech. Simple. Works good.
2589 (defun comint-proc-query (proc str)
2590 "Send to the inferior process PROC the string STR.
2591 Pop-up but do not select a window for the inferior process so that
2592 its response can be seen."
2593 (let* ((proc-buf (process-buffer proc))
2594 (proc-mark (process-mark proc)))
2595 (display-buffer proc-buf)
2596 (set-buffer proc-buf) ; but it's not the selected *window*
2597 (let ((proc-win (get-buffer-window proc-buf 0))
2598 (proc-pt (marker-position proc-mark)))
2599 (comint-send-string proc str) ; send the query
2600 (accept-process-output proc) ; wait for some output
2601 ;; Try to position the proc window so you can see the answer.
2602 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2603 ;; I don't know why. Wizards invited to improve it.
2604 (unless (pos-visible-in-window-p proc-pt proc-win)
2605 (let ((opoint (window-point proc-win)))
2606 (set-window-point proc-win proc-mark)
2607 (sit-for 0)
2608 (if (not (pos-visible-in-window-p opoint proc-win))
2609 (push-mark opoint)
2610 (set-window-point proc-win opoint)))))))
2612 \f
2613 ;; Filename/command/history completion in a buffer
2614 ;; ===========================================================================
2615 ;; Useful completion functions, courtesy of the Ergo group.
2617 ;; Six commands:
2618 ;; comint-dynamic-complete Complete or expand command, filename,
2619 ;; history at point.
2620 ;; comint-dynamic-complete-filename Complete filename at point.
2621 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2622 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2623 ;; replace with expanded/completed name.
2624 ;; comint-dynamic-simple-complete Complete stub given candidates.
2626 ;; These are not installed in the comint-mode keymap. But they are
2627 ;; available for people who want them. Shell-mode installs them:
2629 ;; (define-key shell-mode-map "\M-?"
2630 ;; 'comint-dynamic-list-filename-completions)))
2631 ;;
2632 ;; Commands like this are fine things to put in load hooks if you
2633 ;; want them present in specific modes.
2635 (defcustom comint-completion-autolist nil
2636 "*If non-nil, automatically list possibilities on partial completion.
2637 This mirrors the optional behavior of tcsh."
2638 :type 'boolean
2639 :group 'comint-completion)
2641 (defcustom comint-completion-addsuffix t
2642 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2643 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2644 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2645 This mirrors the optional behavior of tcsh."
2646 :type '(choice (const :tag "None" nil)
2647 (const :tag "Add /" t)
2648 (cons :tag "Suffix pair"
2649 (string :tag "Directory suffix")
2650 (string :tag "File suffix")))
2651 :group 'comint-completion)
2653 (defcustom comint-completion-recexact nil
2654 "*If non-nil, use shortest completion if characters cannot be added.
2655 This mirrors the optional behavior of tcsh.
2657 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2658 :type 'boolean
2659 :group 'comint-completion)
2661 (defcustom comint-completion-fignore nil
2662 "*List of suffixes to be disregarded during file completion.
2663 This mirrors the optional behavior of bash and tcsh.
2665 Note that this applies to `comint-dynamic-complete-filename' only."
2666 :type '(repeat (string :tag "Suffix"))
2667 :group 'comint-completion)
2669 ;;;###autoload
2670 (defvar comint-file-name-prefix ""
2671 "Prefix prepended to absolute file names taken from process input.
2672 This is used by Comint's and shell's completion functions, and by shell's
2673 directory tracking functions.")
2675 (defvar comint-file-name-chars
2676 (if (memq system-type '(ms-dos windows-nt cygwin))
2677 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2678 "[]~/A-Za-z0-9+@:_.$#%,={}-")
2679 "String of characters valid in a file name.
2680 Note that all non-ASCII characters are considered valid in a file name
2681 regardless of what this variable says.
2683 This is a good thing to set in mode hooks.")
2685 (defvar comint-file-name-quote-list nil
2688 This is a good thing to set in mode hooks.")
2691 (defun comint-directory (directory)
2692 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
2693 (expand-file-name (if (file-name-absolute-p directory)
2694 (concat comint-file-name-prefix directory)
2695 directory)))
2698 (defun comint-word (word-chars)
2699 "Return the word of WORD-CHARS at point, or nil if none is found.
2700 Word constituents are considered to be those in WORD-CHARS, which is like the
2702 (save-excursion
2703 (let ((here (point))
2704 giveup)
2705 (while (not giveup)
2706 (let ((startpoint (point)))
2708 ;; Fixme: This isn't consistent with Bash, at least -- not
2709 ;; all non-ASCII chars should be word constituents.
2710 (if (and (> (- (point) 2) (point-min))
2712 (forward-char -2))
2713 (if (and (> (- (point) 1) (point-min))
2714 (>= (char-after (- (point) 1)) 128))
2715 (forward-char -1))
2716 (if (= (point) startpoint)
2717 (setq giveup t))))
2718 ;; Set match-data to match the entire string.
2719 (when (< (point) here)
2720 (set-match-data (list (point) here))
2721 (match-string 0)))))
2723 (defun comint-substitute-in-file-name (filename)
2724 "Return FILENAME with environment variables substituted.
2725 Supports additional environment variable syntax of the command
2726 interpreter (e.g., the percent notation of cmd.exe on NT)."
2727 (let ((name (substitute-in-file-name filename)))
2728 (if (memq system-type '(ms-dos windows-nt))
2729 (let (env-var-name
2730 env-var-val)
2731 (save-match-data
2733 (setq env-var-name
2734 (substring name (match-beginning 1) (match-end 1)))
2735 (setq env-var-val (if (getenv env-var-name)
2736 (getenv env-var-name)
2737 ""))
2738 (setq name (replace-match env-var-val t t name))))))
2739 name))
2741 (defun comint-match-partial-filename ()
2742 "Return the filename at point, or nil if none is found.
2743 Environment variables are substituted. See `comint-word'."
2744 (let ((filename (comint-word comint-file-name-chars)))
2745 (and filename (comint-substitute-in-file-name
2746 (comint-unquote-filename filename)))))
2749 (defun comint-quote-filename (filename)
2750 "Return FILENAME with magic characters quoted.
2751 Magic characters are those in `comint-file-name-quote-list'."
2752 (if (null comint-file-name-quote-list)
2753 filename
2754 (let ((regexp
2755 (format "[%s]"
2756 (mapconcat 'char-to-string comint-file-name-quote-list ""))))
2757 (save-match-data
2758 (let ((i 0))
2759 (while (string-match regexp filename i)
2761 (setq i (1+ (match-end 0)))))
2762 filename))))
2764 (defun comint-unquote-filename (filename)
2765 "Return FILENAME with quoted characters unquoted."
2766 (if (null comint-file-name-quote-list)
2767 filename
2768 (save-match-data
2769 (let ((i 0))
2772 (setq i (+ 1 (match-beginning 0)))))
2773 filename)))
2776 (defun comint-dynamic-complete ()
2777 "Dynamically perform completion at point.
2778 Calls the functions in `comint-dynamic-complete-functions' to perform
2779 completion until a function returns non-nil, at which point completion is
2780 assumed to have occurred."
2781 (interactive)
2782 (run-hook-with-args-until-success 'comint-dynamic-complete-functions))
2785 (defun comint-dynamic-complete-filename ()
2786 "Dynamically complete the filename at point.
2787 Completes if after a filename. See `comint-match-partial-filename' and
2788 `comint-dynamic-complete-as-filename'.
2789 This function is similar to `comint-replace-by-expanded-filename', except that
2790 it won't change parts of the filename already entered in the buffer; it just
2791 adds completion characters to the end of the filename. A completions listing
2792 may be shown in a help buffer if completion is ambiguous.
2794 Completion is dependent on the value of `comint-completion-addsuffix',
2795 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2796 completions listing is dependent on the value of `comint-completion-autolist'.
2798 Returns t if successful."
2799 (interactive)
2800 (when (comint-match-partial-filename)
2801 (unless (window-minibuffer-p (selected-window))
2802 (message "Completing file name..."))
2803 (comint-dynamic-complete-as-filename)))
2805 (defun comint-dynamic-complete-as-filename ()
2806 "Dynamically complete at point as a filename.
2807 See `comint-dynamic-complete-filename'. Returns t if successful."
2808 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2809 (completion-ignored-extensions comint-completion-fignore)
2810 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2811 ;; I think it was originally bound to solve file completion problems,
2812 ;; but subsequent changes may have made this unnecessary. sm.
2813 ;;(file-name-handler-alist nil)
2814 (minibuffer-p (window-minibuffer-p (selected-window)))
2815 (success t)
2816 (dirsuffix (cond ((not comint-completion-addsuffix)
2817 "")
2818 ((not (consp comint-completion-addsuffix))
2819 "/")
2820 (t
2821 (car comint-completion-addsuffix))))
2822 (filesuffix (cond ((not comint-completion-addsuffix)
2823 "")
2824 ((not (consp comint-completion-addsuffix))
2825 " ")
2826 (t
2827 (cdr comint-completion-addsuffix))))
2828 (filename (or (comint-match-partial-filename) ""))
2829 (filedir (file-name-directory filename))
2830 (filenondir (file-name-nondirectory filename))
2831 (directory (if filedir (comint-directory filedir) default-directory))
2832 (completion (file-name-completion filenondir directory)))
2833 (cond ((null completion)
2834 (message "No completions of %s" filename)
2835 (setq success nil))
2836 ((eq completion t) ; Means already completed "file".
2837 (insert filesuffix)
2838 (unless minibuffer-p
2839 (message "Sole completion")))
2840 ((string-equal completion "") ; Means completion on "directory/".
2841 (comint-dynamic-list-filename-completions))
2842 (t ; Completion string returned.
2843 (let ((file (concat (file-name-as-directory directory) completion)))
2844 (insert (comint-quote-filename
2845 (substring (directory-file-name completion)
2846 (length filenondir))))
2847 (cond ((symbolp (file-name-completion completion directory))
2848 ;; We inserted a unique completion.
2849 (insert (if (file-directory-p file) dirsuffix filesuffix))
2850 (unless minibuffer-p
2851 (message "Completed")))
2852 ((and comint-completion-recexact comint-completion-addsuffix
2853 (string-equal filenondir completion)
2854 (file-exists-p file))
2855 ;; It's not unique, but user wants shortest match.
2856 (insert (if (file-directory-p file) dirsuffix filesuffix))
2857 (unless minibuffer-p
2858 (message "Completed shortest")))
2859 ((or comint-completion-autolist
2860 (string-equal filenondir completion))
2861 ;; It's not unique, list possible completions.
2862 (comint-dynamic-list-filename-completions))
2863 (t
2864 (unless minibuffer-p
2865 (message "Partially completed")))))))
2866 success))
2869 (defun comint-replace-by-expanded-filename ()
2870 "Dynamically expand and complete the filename at point.
2871 Replace the filename with an expanded, canonicalized and completed replacement.
2874 removed, and the filename is made absolute instead of relative. For expansion
2875 see `expand-file-name' and `substitute-in-file-name'. For completion see
2876 `comint-dynamic-complete-filename'."
2877 (interactive)
2878 (let ((filename (comint-match-partial-filename)))
2879 (when filename
2880 (replace-match (expand-file-name filename) t t)
2881 (comint-dynamic-complete-filename))))
2884 (defun comint-dynamic-simple-complete (stub candidates)
2885 "Dynamically complete STUB from CANDIDATES list.
2886 This function inserts completion characters at point by completing STUB from
2887 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2888 if completion is ambiguous.
2890 Returns nil if no completion was inserted.
2891 Returns `sole' if completed with the only completion match.
2892 Returns `shortest' if completed with the shortest of the completion matches.
2893 Returns `partial' if completed as far as possible with the completion matches.
2894 Returns `listed' if a completion listing was shown.
2896 See also `comint-dynamic-complete-filename'."
2897 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2898 (suffix (cond ((not comint-completion-addsuffix) "")
2899 ((not (consp comint-completion-addsuffix)) " ")
2900 (t (cdr comint-completion-addsuffix))))
2901 (completions (all-completions stub candidates)))
2902 (cond ((null completions)
2903 (message "No completions of %s" stub)
2904 nil)
2905 ((= 1 (length completions)) ; Gotcha!
2906 (let ((completion (car completions)))
2907 (if (string-equal completion stub)
2908 (message "Sole completion")
2909 (insert (substring completion (length stub)))
2910 (message "Completed"))
2911 (insert suffix)
2912 'sole))
2913 (t ; There's no unique completion.
2914 (let ((completion (try-completion stub candidates)))
2915 ;; Insert the longest substring.
2916 (insert (substring completion (length stub)))
2917 (cond ((and comint-completion-recexact comint-completion-addsuffix
2918 (string-equal stub completion)
2919 (member completion completions))
2920 ;; It's not unique, but user wants shortest match.
2921 (insert suffix)
2922 (message "Completed shortest")
2923 'shortest)
2924 ((or comint-completion-autolist
2925 (string-equal stub completion))
2926 ;; It's not unique, list possible completions.
2927 (comint-dynamic-list-completions completions)
2928 'listed)
2929 (t
2930 (message "Partially completed")
2931 'partial)))))))
2934 (defun comint-dynamic-list-filename-completions ()
2935 "List in help buffer possible completions of the filename at point."
2936 (interactive)
2937 (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt cygwin)))
2938 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2939 ;; I think it was originally bound to solve file completion problems,
2940 ;; but subsequent changes may have made this unnecessary. sm.
2941 ;;(file-name-handler-alist nil)
2942 (filename (or (comint-match-partial-filename) ""))
2943 (filedir (file-name-directory filename))
2944 (filenondir (file-name-nondirectory filename))
2945 (directory (if filedir (comint-directory filedir) default-directory))
2946 (completions (file-name-all-completions filenondir directory)))
2947 (if (not completions)
2948 (message "No completions of %s" filename)
2949 (comint-dynamic-list-completions
2950 (mapcar 'comint-quote-filename completions)))))
2953 ;; This is bound locally in a *Completions* buffer to the list of
2954 ;; completions displayed, and is used to detect the case where the same
2955 ;; command is repeatedly used without the set of completions changing.
2956 (defvar comint-displayed-dynamic-completions nil)
2958 (defvar comint-dynamic-list-completions-config nil)
2960 (defun comint-dynamic-list-completions (completions)
2961 "List in help buffer sorted COMPLETIONS.
2962 Typing SPC flushes the help buffer."
2963 (let ((window (get-buffer-window "*Completions*" 0)))
2964 (setq completions (sort completions 'string-lessp))
2965 (if (and (eq last-command this-command)
2966 window (window-live-p window) (window-buffer window)
2967 (buffer-name (window-buffer window))
2968 ;; The above tests are not sufficient to detect the case where we
2969 ;; should scroll, because the top-level interactive command may
2970 ;; not have displayed a completions window the last time it was
2971 ;; invoked, and there may be such a window left over from a
2972 ;; previous completion command with a different set of
2973 ;; completions. To detect that case, we also test that the set
2974 ;; of displayed completions is in fact the same as the previously
2975 ;; displayed set.
2976 (equal completions
2977 (buffer-local-value 'comint-displayed-dynamic-completions
2978 (window-buffer window))))
2979 ;; If this command was repeated, and
2980 ;; there's a fresh completion window with a live buffer,
2981 ;; and this command is repeated, scroll that window.
2982 (with-current-buffer (window-buffer window)
2983 (if (pos-visible-in-window-p (point-max) window)
2984 (set-window-start window (point-min))
2985 (save-selected-window
2986 (select-window window)
2987 (scroll-up))))
2989 ;; Display a completion list for the first time.
2990 (setq comint-dynamic-list-completions-config
2991 (current-window-configuration))
2992 (with-output-to-temp-buffer "*Completions*"
2993 (display-completion-list completions))
2994 (message "Type space to flush; repeat completion command to scroll"))
2996 ;; Read the next key, to process SPC.
2997 (let (key first)
2998 (if (with-current-buffer (get-buffer "*Completions*")
2999 (set (make-local-variable 'comint-displayed-dynamic-completions)
3000 completions)
3001 (setq key (read-key-sequence nil)
3002 first (aref key 0))
3003 (and (consp first) (consp (event-start first))
3004 (eq (window-buffer (posn-window (event-start first)))
3005 (get-buffer "*Completions*"))
3006 (eq (key-binding key) 'mouse-choose-completion)))
3007 ;; If the user does mouse-choose-completion with the mouse,
3008 ;; execute the command, then delete the completion window.
3009 (progn
3010 (mouse-choose-completion first)
3011 (set-window-configuration comint-dynamic-list-completions-config))
3012 (if (eq first ?\s)
3013 (set-window-configuration comint-dynamic-list-completions-config)
3014 (setq unread-command-events (listify-key-sequence key)))))))
3016 \f
3017 (defun comint-get-next-from-history ()
3018 "After fetching a line from input history, this fetches the following line.
3019 In other words, this recalls the input line after the line you recalled last.
3020 You can use this to repeat a sequence of input lines."
3021 (interactive)
3022 (if comint-save-input-ring-index
3023 (progn
3024 (setq comint-input-ring-index (1+ comint-save-input-ring-index))
3025 (comint-next-input 1))
3026 (message "No previous history command")))
3028 (defun comint-accumulate ()
3029 "Accumulate a line to send as input along with more lines.
3030 This inserts a newline so that you can enter more text
3032 to send all the accumulated input, at once.
3033 The entire accumulated text becomes one item in the input history
3034 when you send it."
3035 (interactive)
3037 (set-marker comint-accum-marker (point))
3038 (if comint-input-ring-index
3039 (setq comint-save-input-ring-index
3040 (- comint-input-ring-index 1))))
3042 (defun comint-goto-process-mark ()
3043 "Move point to the process mark.
3044 The process mark separates output, and input already sent,
3045 from input that has not yet been sent."
3046 (interactive)
3047 (let ((proc (or (get-buffer-process (current-buffer))
3048 (error "Current buffer has no process"))))
3049 (goto-char (process-mark proc))
3050 (when (interactive-p)
3051 (message "Point is now at the process mark"))))
3053 (defun comint-bol-or-process-mark ()
3054 "Move point to beginning of line (after prompt) or to the process mark.
3055 The first time you use this command, it moves to the beginning of the line
3056 \(but after the prompt, if any). If you repeat it again immediately,
3057 it moves point to the process mark.
3059 The process mark separates the process output, along with input already sent,
3060 from input that has not yet been sent. Ordinarily, the process mark
3061 is at the beginning of the current input line; but if you have
3063 the process mark is at the beginning of the accumulated input."
3064 (interactive)
3065 (if (not (eq last-command 'comint-bol-or-process-mark))
3066 (comint-bol nil)
3067 (comint-goto-process-mark)))
3069 (defun comint-set-process-mark ()
3070 "Set the process mark at point."
3071 (interactive)
3072 (let ((proc (or (get-buffer-process (current-buffer))
3073 (error "Current buffer has no process"))))
3074 (set-marker (process-mark proc) (point))
3075 (message "Process mark set")))
3077 \f
3078 ;; Author: Peter Breton <pbreton@cs.umb.edu>
3080 ;; This little add-on for comint is intended to make it easy to get
3081 ;; output from currently active comint buffers into another buffer,
3082 ;; or buffers, and then go back to using the comint shell.
3083 ;;
3084 ;; My particular use is SQL interpreters; I want to be able to execute a
3085 ;; query using the process associated with a comint-buffer, and save that
3086 ;; somewhere else. Because the process might have state (for example, it
3087 ;; could be in an uncommitted transaction), just running starting a new
3088 ;; process and having it execute the query and then finish, would not
3089 ;; work. I'm sure there are other uses as well, although in many cases
3090 ;; starting a new process is the simpler, and thus preferable, approach.
3091 ;;
3092 ;; The basic implementation is as follows: comint-redirect changes the
3093 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
3094 ;; its own filter. The filter puts the output into the designated buffer,
3095 ;; or buffers, until it sees a regexp that tells it to stop (by default,
3096 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
3097 ;; sees the stop regexp, it restores the old filter functions, and runs
3098 ;; `comint-redirect-hook'.
3099 ;;
3100 ;; Each comint buffer may only use one redirection at a time, but any number
3101 ;; of different comint buffers may be simultaneously redirected.
3102 ;;
3103 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
3104 ;; correct prompt for your interpreter, or that you supply a regexp that says
3105 ;; when the redirection is finished. Otherwise, redirection will continue
3106 ;; indefinitely. The code now does a sanity check to ensure that it can find
3107 ;; a prompt in the comint buffer; however, it is still important to ensure that
3108 ;; this prompt is set correctly.
3109 ;;
3110 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
3111 ;; perhaps it should prompt for a terminating string (with an
3112 ;; appropriate magic default by examining what we think is the prompt)?
3113 ;;
3114 ;; Fixme: look for appropriate fields, rather than regexp, if
3115 ;; `comint-use-prompt-regexp' is true.
3117 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3118 ;; Variables
3119 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3121 (defcustom comint-redirect-verbose nil
3122 "*If non-nil, print messages each time the redirection filter is invoked.
3123 Also print a message when redirection is completed."
3124 :group 'comint
3125 :type 'boolean)
3127 ;; Directly analagous to comint-preoutput-filter-functions
3128 (defvar comint-redirect-filter-functions nil
3129 "List of functions to call before inserting redirected process output.
3130 Each function gets one argument, a string containing the text received
3131 from the subprocess. It should return the string to insert, perhaps
3132 the same string that was received, or perhaps a modified or transformed
3133 string.
3135 The functions on the list are called sequentially, and each one is given
3136 the string returned by the previous one. The string returned by the
3137 last function is the text that is actually inserted in the redirection buffer.
3139 You can use `add-hook' to add functions to this list
3140 either globally or locally.")
3142 ;; Internal variables
3144 (defvar comint-redirect-output-buffer nil
3145 "The buffer or list of buffers to put output into.")
3147 (defvar comint-redirect-finished-regexp nil
3148 "Regular expression that determines when to stop redirection in Comint.
3149 When the redirection filter function is given output that matches this regexp,
3150 the output is inserted as usual, and redirection is completed.")
3152 (defvar comint-redirect-insert-matching-regexp nil
3153 "If non-nil, the text that ends a redirection is included in it.
3154 More precisely, the text that matches `comint-redirect-finished-regexp'
3155 and therefore terminates an output redirection is inserted in the
3156 redirection target buffer, along with the preceding output.")
3158 (defvar comint-redirect-echo-input nil
3159 "Non-nil means echo input in the process buffer even during redirection.")
3161 (defvar comint-redirect-completed nil
3162 "Non-nil if redirection has completed in the current buffer.")
3164 (defvar comint-redirect-original-mode-line-process nil
3165 "Original mode line for redirected process.")
3167 (defvar comint-redirect-perform-sanity-check t
3168 "If non-nil, check that redirection is likely to complete successfully.
3169 More precisely, before starting a redirection, verify that the
3170 regular expression `comint-redirect-finished-regexp' that controls
3171 when to terminate it actually matches some text already in the process
3172 buffer. The idea is that this regular expression should match a prompt
3173 string, and that there ought to be at least one copy of your prompt string
3174 in the process buffer already.")
3176 (defvar comint-redirect-original-filter-function nil
3177 "The process filter that was in place when redirection is started.
3178 When redirection is completed, the process filter is restored to
3179 this value.")
3181 (defvar comint-redirect-subvert-readonly nil
3182 "Non-nil means `comint-redirect' can insert into read-only buffers.
3183 This works by binding `inhibit-read-only' around the insertion.
3184 This is useful, for instance, for insertion into Help mode buffers.
3185 You probably want to set it locally to the output buffer.")
3187 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3188 ;; Functions
3189 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3191 (defun comint-redirect-setup (output-buffer
3192 comint-buffer
3193 finished-regexp
3194 &optional echo-input)
3195 "Set up for output redirection.
3196 This function sets local variables that are used by `comint-redirect-filter'
3197 to perform redirection.
3199 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3200 in the output matches FINISHED-REGEXP.
3202 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3203 original Comint buffer.
3205 This function is called by `comint-redirect-send-command-to-process',
3206 and does not normally need to be invoked by the end user or programmer."
3207 (with-current-buffer comint-buffer
3209 (make-local-variable 'comint-redirect-original-mode-line-process)
3210 (setq comint-redirect-original-mode-line-process mode-line-process)
3212 (make-local-variable 'comint-redirect-output-buffer)
3213 (setq comint-redirect-output-buffer output-buffer)
3215 (make-local-variable 'comint-redirect-finished-regexp)
3216 (setq comint-redirect-finished-regexp finished-regexp)
3218 (make-local-variable 'comint-redirect-echo-input)
3219 (setq comint-redirect-echo-input echo-input)
3221 (make-local-variable 'comint-redirect-completed)
3222 (setq comint-redirect-completed nil)
3224 (setq mode-line-process
3225 (if mode-line-process
3226 (list (concat (elt mode-line-process 0) " Redirection"))
3227 (list ":%s Redirection")))))
3229 (defun comint-redirect-cleanup ()
3230 "End a Comint redirection. See `comint-redirect-send-command'."
3231 (interactive)
3232 ;; Restore the process filter
3233 (set-process-filter (get-buffer-process (current-buffer))
3234 comint-redirect-original-filter-function)
3235 ;; Restore the mode line
3236 (setq mode-line-process comint-redirect-original-mode-line-process)
3237 ;; Set the completed flag
3238 (setq comint-redirect-completed t))
3240 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3241 ;; that it really occurs.
3242 (defalias 'comint-redirect-remove-redirection 'comint-redirect-cleanup)
3244 (defun comint-redirect-filter (process input-string)
3245 "Filter function which redirects output from PROCESS to a buffer or buffers.
3246 The variable `comint-redirect-output-buffer' says which buffer(s) to
3247 place output in.
3249 INPUT-STRING is the input from the Comint process.
3251 This function runs as a process filter, and does not need to be invoked by the
3252 end user."
3253 (and process
3254 (with-current-buffer (process-buffer process)
3255 (comint-redirect-preoutput-filter input-string)
3256 ;; If we have to echo output, give it to the original filter function
3257 (and comint-redirect-echo-input
3258 comint-redirect-original-filter-function
3259 (funcall comint-redirect-original-filter-function
3260 process input-string)))))
3263 (defun comint-redirect-preoutput-filter (input-string)
3264 "Comint filter function which redirects Comint output to a buffer or buffers.
3265 The variable `comint-redirect-output-buffer' says which buffer(s) to
3266 place output in.
3268 INPUT-STRING is the input from the Comint process.
3270 This function does not need to be invoked by the end user."
3271 (let ((output-buffer-list
3272 (if (listp comint-redirect-output-buffer)
3273 comint-redirect-output-buffer
3274 (list comint-redirect-output-buffer)))
3275 (filtered-input-string input-string))
3277 ;; If there are any filter functions, give them a chance to modify the string
3278 (let ((functions comint-redirect-filter-functions))
3279 (while (and functions filtered-input-string)
3280 (if (eq (car functions) t)
3281 ;; If a local value says "use the default value too",
3282 ;; do that.
3283 (let ((functions (default-value 'comint-redirect-filter-functions)))
3284 (while (and functions filtered-input-string)
3285 (setq filtered-input-string
3286 (funcall (car functions) filtered-input-string))
3287 (setq functions (cdr functions))))
3288 (setq filtered-input-string
3289 (funcall (car functions) filtered-input-string)))
3290 (setq functions (cdr functions))))
3292 ;; Clobber `comint-redirect-finished-regexp'
3293 (or comint-redirect-insert-matching-regexp
3294 (and (string-match comint-redirect-finished-regexp filtered-input-string)
3295 (setq filtered-input-string
3296 (replace-match "" nil nil filtered-input-string))))
3298 ;; Send output to all registered buffers
3299 (save-excursion
3300 (dolist (buf output-buffer-list)
3301 ;; Set this buffer to the output buffer
3302 (set-buffer (get-buffer-create buf))
3303 ;; Go to the end of the buffer
3304 (goto-char (point-max))
3305 ;; Insert the output
3306 (let ((inhibit-read-only comint-redirect-subvert-readonly))
3307 (insert filtered-input-string))))
3309 ;; Message
3310 (and comint-redirect-verbose
3311 (message "Redirected output to buffer(s) %s"
3312 (mapconcat 'identity output-buffer-list " ")))
3314 ;; If we see the prompt, tidy up
3315 ;; We'll look for the prompt in the original string, so nobody can
3316 ;; clobber it
3317 (and (string-match comint-redirect-finished-regexp input-string)
3318 (progn
3319 (and comint-redirect-verbose
3320 (message "Redirection completed"))
3321 (comint-redirect-cleanup)
3322 (run-hooks 'comint-redirect-hook)))
3323 ;; Echo input?
3324 (if comint-redirect-echo-input
3325 filtered-input-string
3326 "")))
3328 ;;;###autoload
3329 (defun comint-redirect-send-command (command output-buffer echo &optional no-display)
3330 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3331 With prefix arg ECHO, echo output in process buffer.
3333 If NO-DISPLAY is non-nil, do not show the output buffer."
3335 (let ((process (get-buffer-process (current-buffer))))
3336 (if process
3337 (comint-redirect-send-command-to-process
3338 command output-buffer (current-buffer) echo no-display)
3339 (error "No process for current buffer"))))
3341 ;;;###autoload
3342 (defun comint-redirect-send-command-to-process
3343 (command output-buffer process echo &optional no-display)
3344 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3345 With prefix arg, echo output in process buffer.
3347 If NO-DISPLAY is non-nil, do not show the output buffer."
3349 (let* (;; The process buffer
3350 (process-buffer (if (processp process)
3351 (process-buffer process)
3352 process))
3353 (proc (get-buffer-process process-buffer)))
3354 ;; Change to the process buffer
3355 (with-current-buffer process-buffer
3357 ;; Make sure there's a prompt in the current process buffer
3358 (and comint-redirect-perform-sanity-check
3359 (save-excursion
3360 (goto-char (point-max))
3361 (or (re-search-backward comint-prompt-regexp nil t)
3362 (error "No prompt found or `comint-prompt-regexp' not set properly"))))
3364 ;;;;;;;;;;;;;;;;;;;;;
3365 ;; Set up for redirection
3366 ;;;;;;;;;;;;;;;;;;;;;
3367 (comint-redirect-setup
3368 ;; Output Buffer
3369 output-buffer
3370 ;; Comint Buffer
3371 (current-buffer)
3372 ;; Finished Regexp
3373 comint-prompt-regexp
3374 ;; Echo input
3375 echo)
3377 ;;;;;;;;;;;;;;;;;;;;;
3378 ;; Set the filter
3379 ;;;;;;;;;;;;;;;;;;;;;
3380 ;; Save the old filter
3381 (setq comint-redirect-original-filter-function
3382 (process-filter proc))
3383 (set-process-filter proc 'comint-redirect-filter)
3385 ;;;;;;;;;;;;;;;;;;;;;
3386 ;; Send the command
3387 ;;;;;;;;;;;;;;;;;;;;;
3388 (process-send-string
3389 (current-buffer)
3392 ;;;;;;;;;;;;;;;;;;;;;
3393 ;; Show the output
3394 ;;;;;;;;;;;;;;;;;;;;;
3395 (or no-display
3396 (display-buffer
3397 (get-buffer-create
3398 (if (listp output-buffer)
3399 (car output-buffer)
3400 output-buffer)))))))
3402 ;;;###autoload
3403 (defun comint-redirect-results-list (command regexp regexp-group)
3404 "Send COMMAND to current process.
3405 Return a list of expressions in the output which match REGEXP.
3406 REGEXP-GROUP is the regular expression group in REGEXP to use."
3407 (comint-redirect-results-list-from-process
3408 (get-buffer-process (current-buffer))
3409 command regexp regexp-group))
3411 ;;;###autoload
3412 (defun comint-redirect-results-list-from-process (process command regexp regexp-group)
3413 "Send COMMAND to PROCESS.
3414 Return a list of expressions in the output which match REGEXP.
3415 REGEXP-GROUP is the regular expression group in REGEXP to use."
3416 (let ((output-buffer " *Comint Redirect Work Buffer*")
3417 results)
3418 (save-excursion
3419 (set-buffer (get-buffer-create output-buffer))
3420 (erase-buffer)
3421 (comint-redirect-send-command-to-process command
3422 output-buffer process nil t)
3423 ;; Wait for the process to complete
3424 (set-buffer (process-buffer process))
3425 (while (null comint-redirect-completed)
3426 (accept-process-output nil 1))
3427 ;; Collect the output
3428 (set-buffer output-buffer)
3429 (goto-char (point-min))
3430 ;; Skip past the command, if it was echoed
3431 (and (looking-at command)
3432 (forward-line))
3433 (while (re-search-forward regexp nil t)
3434 (setq results
3435 (cons (buffer-substring-no-properties
3436 (match-beginning regexp-group)
3437 (match-end regexp-group))
3438 results)))
3439 results)))
3441 (mapc (lambda (x)
3442 (add-to-list 'debug-ignored-errors x))
3443 '("^Not at command line$"
3444 "^Empty input ring$"
3445 "^No history$"
3446 "^Not found$" ; Too common?
3447 "^Current buffer has no process$"))
3449 \f
3450 ;; Converting process modes to use comint mode
3451 ;; ===========================================================================
3452 ;; The code in the Emacs 19 distribution has all been modified to use comint
3453 ;; where needed. However, there are `third-party' packages out there that
3454 ;; still use the old shell mode. Here's a guide to conversion.
3455 ;;
3456 ;; Renaming variables
3457 ;; Most of the work is renaming variables and functions. These are the common
3458 ;; ones:
3459 ;; Local variables:
3460 ;; last-input-start comint-last-input-start
3461 ;; last-input-end comint-last-input-end
3462 ;; shell-prompt-pattern comint-prompt-regexp
3463 ;; shell-set-directory-error-hook <no equivalent>
3464 ;; Miscellaneous:
3465 ;; shell-set-directory <unnecessary>
3466 ;; shell-mode-map comint-mode-map
3467 ;; Commands:
3468 ;; shell-send-input comint-send-input
3469 ;; shell-send-eof comint-delchar-or-maybe-eof
3470 ;; kill-shell-input comint-kill-input
3471 ;; interrupt-shell-subjob comint-interrupt-subjob
3472 ;; stop-shell-subjob comint-stop-subjob
3473 ;; quit-shell-subjob comint-quit-subjob
3474 ;; kill-shell-subjob comint-kill-subjob
3475 ;; kill-output-from-shell comint-delete-output
3476 ;; show-output-from-shell comint-show-output
3477 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3478 ;;
3479 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3480 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3481 ;; Comint mode does not provide functionality equivalent to
3482 ;; shell-set-directory-error-hook; it is gone.
3483 ;;
3484 ;; comint-last-input-start is provided for modes which want to munge
3485 ;; the buffer after input is sent, perhaps because the inferior
3486 ;; insists on echoing the input. The LAST-INPUT-START variable in
3487 ;; the old shell package was used to implement a history mechanism,
3488 ;; but you should think twice before using comint-last-input-start
3489 ;; for this; the input history ring often does the job better.
3490 ;;
3491 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3492 ;; *not* create the comint-mode local variables in your foo-mode function.
3493 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3494 ;; necessary comint-specific local variables. Then create the
3495 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3496 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3497 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3498 ;; get-old-input) that need to be different from the defaults. Call
3499 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3500 ;; comint-mode will take care of it. The following example, from shell.el,
3501 ;; is typical:
3502 ;;
3503 ;; (defvar shell-mode-map '())
3504 ;; (cond ((not shell-mode-map)
3505 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3506 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3507 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3509 ;; (define-key shell-mode-map "\M-?"
3510 ;; 'comint-dynamic-list-filename-completions)))
3511 ;;
3512 ;; (defun shell-mode ()
3513 ;; (interactive)
3514 ;; (comint-mode)
3515 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3516 ;; (setq major-mode 'shell-mode)
3517 ;; (setq mode-name "Shell")
3518 ;; (use-local-map shell-mode-map)
3519 ;; (make-local-variable 'shell-directory-stack)
3520 ;; (setq shell-directory-stack nil)
3521 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3522 ;; (run-mode-hooks 'shell-mode-hook))
3523 ;;
3524 ;;
3525 ;; Completion for comint-mode users
3526 ;;
3527 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3528 ;; hook to add completion functions to. Functions on this list should return
3529 ;; non-nil if completion occurs (i.e., further completion should not occur).
3530 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3531 ;; completion job.
3532 \f
3534 (provide 'comint)
3536 ;; arch-tag: 1793314c-09db-40be-9549-9aeae3e75164
3537 ;;; comint.el ends here