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