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