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