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