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