| blob | 0fb22b3341cfd49ec1db791c21aec11223e19534 |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988, 90, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001
4 ;; 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 ;; Please send me bug reports, bug fixes, and extensions, so that I can
31 ;; merge them into the master source.
32 ;; - Olin Shivers (shivers@cs.cmu.edu)
33 ;; - Simon Marshall (simon@gnu.org)
35 ;; This file defines a general command-interpreter-in-a-buffer package
36 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
37 ;; modes on top of comint mode -- e.g., lisp, shell, scheme, T, soar, ....
38 ;; This way, all these specific packages share a common base functionality,
39 ;; and a common set of bindings, which makes them easier to use (and
40 ;; saves code, implementation time, etc., etc.).
42 ;; Several packages are already defined using comint mode:
43 ;; - shell.el defines a shell-in-a-buffer mode.
44 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
45 ;;
46 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
47 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
48 ;; - The file soar.el tunes lisp and inferior-lisp modes for Soar.
49 ;; - cmutex.el defines tex and latex modes that invoke tex, latex, bibtex,
50 ;; previewers, and printers from within emacs.
51 ;; - background.el allows csh-like job control inside emacs.
52 ;; It is pretty easy to make new derived modes for other processes.
54 ;; For documentation on the functionality provided by comint mode, and
55 ;; the hooks available for customising it, see the comments below.
56 ;; For further information on the standard derived modes (shell,
57 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
60 ;; To give your mode support for the programmable, dynamic completion
61 ;; facility in "pcomplete.el", you should define two functions in the
62 ;; following form, replacing <MODE> with the prefix of your mode:
64 ;; (defvar <MODE>-pcomplete-setup-p nil)
65 ;; (defun <MODE>-pcomplete ()
66 ;; "Cycle forwards through completions at point, using `pcomplete'.
67 ;; This function merely invokes `pcomplete', after ensuring this buffer
68 ;; is set up for it."
69 ;; (interactive)
70 ;; (unless (prog1 <MODE>-pcomplete-setup-p
71 ;; (setq <MODE>-pcomplete-setup-p t))
72 ;; (pcomplete-comint-setup '<MODE>-dynamic-complete-functions))
73 ;; (setq this-command 'pcomplete)
74 ;; (call-interactively #'pcomplete))
76 ;; (defun <MODE>-pcomplete-reverse ()
77 ;; "Cycle backwards through completions at point, using `pcomplete'.
78 ;; This function merely invokes `pcomplete-reverse', after ensuring this
79 ;; buffer is set up for it."
80 ;; (interactive)
81 ;; (unless (prog1 <MODE>-pcomplete-setup-p
82 ;; (setq <MODE>-pcomplete-setup-p t))
83 ;; (pcomplete-comint-setup '<MODE>-dynamic-complete-functions))
84 ;; (setq this-command 'pcomplete-reverse)
85 ;; (call-interactively #'pcomplete-reverse))
87 ;; For hints on converting existing process modes (e.g., tex-mode,
88 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
89 ;; instead of shell-mode, see the notes at the end of this file.
91 \f
92 ;; Brief Command Documentation:
93 ;;============================================================================
94 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
95 ;; mode)
96 ;;
97 ;; m-p comint-previous-input Cycle backwards in input history
98 ;; m-n comint-next-input Cycle forwards
99 ;; m-r comint-previous-matching-input Previous input matching a regexp
100 ;; m-s comint-next-matching-input Next input that matches
101 ;; m-c-l comint-show-output Show last batch of process output
102 ;; return comint-send-input
103 ;; c-d comint-delchar-or-maybe-eof Delete char unless at end of buff
104 ;; c-c c-a comint-bol-or-process-mark First time, move point to bol;
105 ;; second time, move to process-mark.
106 ;; c-c c-u comint-kill-input ^u
107 ;; c-c c-w backward-kill-word ^w
108 ;; c-c c-c comint-interrupt-subjob ^c
109 ;; c-c c-z comint-stop-subjob ^z
110 ;; c-c c-\ comint-quit-subjob ^\
111 ;; c-c c-o comint-delete-output Delete last batch of process output
112 ;; c-c c-r comint-show-output Show last batch of process output
113 ;; c-c c-l comint-dynamic-list-input-ring List input history
114 ;;
115 ;; Not bound by default in comint-mode (some are in shell mode)
116 ;; comint-run Run a program under comint-mode
117 ;; send-invisible Read a line w/o echo, and send to proc
118 ;; comint-dynamic-complete-filename Complete filename at point.
119 ;; comint-dynamic-list-filename-completions List completions in help buffer.
120 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
121 ;; replace with expanded/completed name.
122 ;; comint-replace-by-expanded-history Expand history at point;
123 ;; replace with expanded name.
124 ;; comint-magic-space Expand history and add (a) space(s).
125 ;; comint-kill-subjob No mercy.
126 ;; comint-show-maximum-output Show as much output as possible.
127 ;; comint-continue-subjob Send CONT signal to buffer's process
128 ;; group. Useful if you accidentally
129 ;; suspend your process (with C-c C-z).
130 ;; comint-get-next-from-history Fetch successive input history lines
131 ;; comint-accumulate Combine lines to send them together
132 ;; as input.
133 ;; comint-goto-process-mark Move point to where process-mark is.
134 ;; comint-set-process-mark Set process-mark to point.
136 ;; comint-mode-hook is the comint mode hook. Basically for your keybindings.
138 ;;; Code:
141 \f
142 ;; Buffer Local Variables:
143 ;;============================================================================
144 ;; Comint mode buffer local variables:
145 ;; comint-prompt-regexp string comint-bol uses to match prompt
146 ;; comint-delimiter-argument-list list For delimiters and arguments
147 ;; comint-last-input-start marker Handy if inferior always echoes
148 ;; comint-last-input-end marker For comint-delete-output command
149 ;; comint-input-ring-size integer For the input history
150 ;; comint-input-ring ring mechanism
151 ;; comint-input-ring-index number ...
152 ;; comint-save-input-ring-index number ...
153 ;; comint-input-autoexpand symbol ...
154 ;; comint-input-ignoredups boolean ...
155 ;; comint-dynamic-complete-functions hook For the completion mechanism
156 ;; comint-completion-fignore list ...
157 ;; comint-file-name-chars string ...
158 ;; comint-file-name-quote-list list ...
159 ;; comint-get-old-input function Hooks for specific
160 ;; comint-input-filter-functions hook process-in-a-buffer
161 ;; comint-output-filter-functions hook function modes.
162 ;; comint-preoutput-filter-functions hook
163 ;; comint-input-filter function ...
164 ;; comint-input-sender function ...
165 ;; comint-eol-on-send boolean ...
166 ;; comint-process-echoes boolean ...
167 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
168 ;; comint-scroll-to-bottom-on-output symbol ...
169 ;; comint-scroll-show-maximum-output boolean ...
170 ;; comint-accum-marker maker For comint-accumulate
171 ;; comint-last-output-overlay overlay
172 ;;
173 ;; Comint mode non-buffer local variables:
174 ;; comint-completion-addsuffix boolean/cons For file name
175 ;; comint-completion-autolist boolean completion behavior
176 ;; comint-completion-recexact boolean ...
179 "General command interpreter in a window stuff."
183 "Completion facilities in comint"
187 "Source finding facilities in comint"
192 "Regexp to recognise prompts in the inferior process.
195 This variable is only used if the variable
196 `comint-use-prompt-regexp-instead-of-fields' is non-nil.
198 Good choices:
209 "List of characters to recognise as separate arguments in input.
210 Strings comprising a character in this list will separate the arguments
211 surrounding them, and also be regarded as arguments in their own right (unlike
212 whitespace). See `comint-arguments'.
213 Defaults to the empty list.
220 "*If non-nil, expand input command history references on completion.
221 This mirrors the optional behavior of tcsh (its autoexpand and histlit).
223 If the value is `input', then the expansion is seen on input.
224 If the value is `history', then the expansion is only when inserting
225 into the buffer's input ring. See also `comint-magic-space' and
226 `comint-dynamic-complete'.
228 This variable is buffer-local."
236 "*If non-nil, highlight input; also allow choosing previous input with a mouse.
237 The face used is `comint-highlight-input'."
242 "Face to use to highlight input when `comint-highlight-input' is non-nil."
246 "*If non-nil, highlight program prompts.
247 The face used is `comint-highlight-prompt'."
254 "Face to use to highlight prompt when `comint-highlight-prompt' is non-nil."
258 "*If non-nil, don't add input matching the last on the input ring.
259 This mirrors the optional behavior of bash.
261 This variable is buffer-local."
266 "*If non-nil, name of the file to read/write input history.
267 See also `comint-read-input-ring' and `comint-write-input-ring'.
269 This variable is buffer-local, and is a good thing to set in mode hooks."
271 file)
275 "*Controls whether input to interpreter causes window to scroll.
276 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
277 If `this', scroll only the selected window.
279 The default is nil.
281 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
289 "*Controls whether interpreter output causes window to scroll.
290 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
291 If `this', scroll only the selected window.
292 If `others', scroll only those that are not the selected window.
294 The default is nil.
296 See variable `comint-scroll-show-maximum-output' and function
297 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
306 "*Controls how interpreter output causes window to scroll.
307 If non-nil, then show the maximum output when the window is scrolled.
309 See variable `comint-scroll-to-bottom-on-output' and function
310 `comint-postoutput-scroll-to-bottom'. This variable is buffer-local."
315 "*The maximum size in lines for comint buffers.
316 Comint buffers are truncated from the top to be no greater than this number, if
317 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
331 "*If non-nil, assume that the subprocess echoes any input.
332 If so, delete one copy of the input so that only one copy eventually
333 appears in the buffer.
335 This variable is buffer-local."
339 ;; AIX puts the name of the person being su'd to in front of the prompt.
340 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
341 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
342 ;; ssh-add prints a prompt like `Enter passphrase: '.
343 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
348 "*Regexp matching prompts for passwords in the inferior process.
349 This is used by `comint-watch-for-password-prompt'."
353 ;; Here are the per-interpreter hooks.
355 "Function that returns old text in comint mode.
356 This function is called when return is typed while the point is in old
357 text. It returns the text to be submitted as process input. The
358 default is `comint-get-old-input-default', which either grabs the
359 current input field or grabs the current line and strips off leading
360 text matching `comint-prompt-regexp', depending on the value of
365 "List of functions called to perform completion.
366 Functions should return non-nil if completion was performed.
367 See also `comint-dynamic-complete'.
373 "Predicate for filtering additions to input history.
374 Takes one argument, the input. If non-nil, the input may be saved on the input
378 "Functions to call before input is sent to the process.
379 These functions get one argument, a string containing the text to send.
384 "Functions to call after output is inserted into the buffer.
385 One possible function is `comint-postoutput-scroll-to-bottom'.
386 These functions get one argument, a string containing the text as originally
387 inserted. Note that this might not be the same as the buffer contents between
388 `comint-last-output-start' and the buffer's `process-mark', if other filter
389 functions have already modified the buffer.
391 See also `comint-preoutput-filter-functions'.
399 "Function to actually send to PROCESS the STRING submitted by user.
400 Usually this is just `comint-simple-send', but if your mode needs to
401 massage the input string, put a different function here.
402 `comint-simple-send' just sends the string plus a newline.
403 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
407 "*Non-nil means go to the end of the line before sending input.
408 See `comint-send-input'."
412 ;; Note: If it is decided to purge comint-prompt-regexp from the source
413 ;; entirely, searching for uses of this variable will help to identify
414 ;; places that need attention.
416 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
417 If nil, then program output and user-input are given different `field'
418 properties, which emacs commands can use to distinguish them (in
419 particular, common movement commands such as begining-of-line respect
420 field boundaries in a natural way)."
425 "Called upon entry into `comint-mode'
426 This is run before the process is cranked up."
431 "Called each time a process is exec'd by `comint-exec'.
432 This is called after the process is cranked up. It is useful for things that
433 must be done each time a process is executed in a comint mode buffer (e.g.,
434 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
435 executed once when the buffer is created."
442 "Non-nil if communications via pty; false if by pipe. Buffer local.
454 "Last input ring index which you copied.
458 "Non-nil if you are accumulating input lines to send as input together.
477 "Major mode for interacting with an inferior interpreter.
478 Interpreter name is same as buffer name, sans the asterisks.
479 Return at end of buffer sends line as input.
480 Return not at end copies rest of line to end and sends it.
481 Setting variable `comint-eol-on-send' means jump to the end of the line
482 before submitting new input.
484 This mode is customised to create major modes such as Inferior Lisp
485 mode, Shell mode, etc. This can be done by setting the hooks
486 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
487 and `comint-get-old-input' to appropriate functions, and the variable
488 `comint-prompt-regexp' to the appropriate regular expression.
490 An input history is maintained of size `comint-input-ring-size', and
491 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
492 Input ring history expansion can be achieved with the commands
494 Input ring expansion is controlled by the variable `comint-input-autoexpand',
495 and addition is controlled by the variable `comint-input-ignoredups'.
497 Commands with no default key bindings include `send-invisible',
498 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
499 `comint-magic-space'.
501 Input to, and output from, the subprocess can cause the window to scroll to
502 the end of the buffer. See variables `comint-output-filter-functions',
503 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
504 and `comint-scroll-to-bottom-on-output'.
507 to continue it.
511 Entry to this mode runs the hooks on `comint-mode-hook'."
548 ;; This behavior is not useful in comint buffers, and is annoying
552 nil
553 ;; Keys:
584 ;; Mouse Buttons:
586 ;; Menu bars:
587 ;; completion:
598 ;; Input history:
639 ;; Signals
654 ;; Put them in the menu bar:
656 menu-bar-final-items))
657 )
660 "Return t if there is a living process associated w/buffer BUFFER.
661 Living means the status is `open', `run', or `stop'.
662 BUFFER can be either a buffer or the name of one."
666 ;;;###autoload
668 "Make a comint process NAME in BUFFER, running PROGRAM.
669 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
670 PROGRAM should be either a string denoting an executable program to create
671 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
672 connection to be opened via `open-network-stream'. If there is already a
673 running process in that buffer, it is not restarted. Optional third arg
674 STARTFILE is the name of a file to send the contents of to the process.
676 If PROGRAM is a string, any more args are arguments to PROGRAM."
680 ;; If no process, or nuked process, crank up a new one and put buffer in
681 ;; comint mode. Otherwise, leave buffer and existing process alone.
687 buffer)
689 ;;;###autoload
691 "Make a comint process NAME in a buffer, running PROGRAM.
692 The name of the buffer is made by surrounding NAME with `*'s.
693 PROGRAM should be either a string denoting an executable program to create
694 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
695 connection to be opened via `open-network-stream'. If there is already a
696 running process in that buffer, it is not restarted. Optional third arg
697 STARTFILE is the name of a file to send the contents of to the process.
699 If PROGRAM is a string, any more args are arguments to PROGRAM."
702 ;;;###autoload
704 "Run PROGRAM in a comint buffer and switch to it.
705 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
706 The file name is used to make a symbol name, such as `comint-sh-hook', and any
707 hooks on this symbol are run in the buffer.
708 See `make-comint' and `comint-exec'."
715 "Start up a process in buffer BUFFER for comint modes.
716 Blasts any old process running in the buffer. Doesn't set the buffer mode.
717 You can use this to cheaply run a series of processes in the same comint
718 buffer. The hook `comint-exec-hook' is run after each exec."
723 ;; Crank up a new process
731 ;; Jump to the end, and set the process mark.
734 ;; Feed it the startfile.
736 ;;This is guaranteed to wait long enough
737 ;;but has bad results if the comint does not prompt at all
738 ;; (while (= size (buffer-size))
739 ;; (sleep-for 1))
740 ;;I hope 1 second is enough!
748 buffer)))
750 ;; This auxiliary function cranks up the process for comint-exec in
751 ;; the appropriate environment.
756 ;; If using termcap, we specify `emacs' as the terminal type
757 ;; because that lets us specify a width.
758 ;; If using terminfo, we specify `dumb' because that is
759 ;; a defined terminal type. `emacs' is not a defined terminal type
760 ;; and there is no way for us to define it here.
761 ;; Some programs that use terminfo get very confused
762 ;; if TERM is not a valid terminal type.
763 ;; ;; There is similar code in compile.el.
770 process-environment))
773 default-directory
775 proc decoding encoding changed)
777 ;; If the command has slashes, make sure we
778 ;; first look relative to the current directory.
784 ;; If start-process decided to use some coding system for decoding
785 ;; data sent from the process and the coding system doesn't
786 ;; specify EOL conversion, we had better convert CRLF to LF.
789 changed t))
790 ;; Even if start-process left the coding system for encoding data
791 ;; sent from the process undecided, we had better use the same one
792 ;; as what we use for decoding. But, we should suppress EOL
793 ;; conversion.
796 changed t))
799 proc))
803 "In a comint buffer, set the current input to the clicked-on previous input."
806 ;; Ignore non-input overlays
810 ;; Do we have input in this area?
816 ;; Can't use kill-region as it sets this-command
821 ;; Fall back to the global definition.
827 \f
828 ;; Input history processing in a buffer
829 ;; ===========================================================================
830 ;; Useful input history functions, courtesy of the Ergo group.
832 ;; Eleven commands:
833 ;; comint-dynamic-list-input-ring List history in help buffer.
834 ;; comint-previous-input Previous input...
835 ;; comint-previous-matching-input ...matching a string.
836 ;; comint-previous-matching-input-from-input ... matching the current input.
837 ;; comint-next-input Next input...
838 ;; comint-next-matching-input ...matching a string.
839 ;; comint-next-matching-input-from-input ... matching the current input.
840 ;; comint-backward-matching-input Backwards input...
841 ;; comint-forward-matching-input ...matching a string.
842 ;; comint-replace-by-expanded-history Expand history at point;
843 ;; replace with expanded history.
844 ;; comint-magic-space Expand history and insert space.
845 ;;
846 ;; Three functions:
847 ;; comint-read-input-ring Read into comint-input-ring...
848 ;; comint-write-input-ring Write to comint-input-ring-file-name.
849 ;; comint-replace-by-expanded-history-before-point Workhorse function.
852 "Sets the buffer's `comint-input-ring' from a history file.
853 The name of the file is given by the variable `comint-input-ring-file-name'.
854 The history ring is of size `comint-input-ring-size', regardless of file size.
855 If `comint-input-ring-file-name' is nil this function does nothing.
857 If the optional argument SILENT is non-nil, we say nothing about a
858 failure to read the history file.
860 This function is useful for major mode commands and mode hooks.
862 The commands stored in the history file are separated by the
863 `comint-input-ring-separator', and entries that match
864 `comint-input-history-ignore' are ignored. The most recent command
865 comes last.
867 See also `comint-input-ignoredups' and `comint-write-input-ring'."
870 nil)
874 comint-input-ring-file-name)))
887 ;; Save restriction in case file is already visited...
888 ;; Watch for those date stamps in history files!
908 comint-input-ring-index nil)))))
911 "Writes the buffer's `comint-input-ring' to a history file.
912 The name of the file is given by the variable `comint-input-ring-file-name'.
913 The original contents of the file are lost if `comint-input-ring' is not empty.
914 If `comint-input-ring-file-name' is nil this function does nothing.
916 Useful within process sentinels.
918 See also `comint-read-input-ring'."
922 nil)
930 ;; Write it all out into a buffer first. Much faster, but messier,
931 ;; than writing it one line at a time.
945 "Choose the input history entry that point is in or next to."
962 "List in help buffer the buffer's input history."
971 ;; We have to build up a list ourselves from the ring vector.
975 ;; Change "completion" to "history reference"
976 ;; to make the display accurate.
997 ;; Return list of regexp and prefix arg using PROMPT.
1005 regexp)
1009 ;; First make sure there is a ring and that we are after the process mark
1016 ;; arg of zero resets search from beginning, and uses arg of 1
1020 arg)))
1023 ;; Index to start a directional search, starting at comint-input-ring-index
1025 ;; If a search is running, offset by 1 in direction of arg
1028 ;; For a new search, start from beginning or end, as appropriate
1034 "Return the string ARG places along the input ring.
1035 Moves relative to `comint-input-ring-index'."
1039 arg)))
1042 "Cycle backwards through input history."
1047 "Cycle forwards through input history."
1052 "Return the string matching REGEXP ARG places along the input ring.
1053 Moves relative to `comint-input-ring-index'."
1058 "Return the index matching REGEXP ARG places along the input ring.
1059 Moves relative to START, or `comint-input-ring-index'."
1068 ;; Do the whole search as many times as the argument says.
1070 ;; Step once.
1073 ;; If we haven't reached a match, step some more.
1077 ;; If we have gone all the way around in this search.
1080 ;; Now that we know which ring element to use, if we found it, return that.
1082 n)))
1085 "Search backwards through input history for match for REGEXP.
1086 \(Previous history elements are earlier commands.)
1087 With prefix argument N, search for Nth previous match.
1088 If N is negative, find the next or Nth next match."
1092 ;; Has a match been found?
1098 ;; Can't use kill-region as it sets this-command
1105 "Search forwards through input history for match for REGEXP.
1106 \(Later history elements are more recent commands.)
1107 With prefix argument N, search for Nth following match.
1108 If N is negative, find the previous or Nth previous match."
1113 "Search backwards through input history for match for current input.
1114 \(Previous history elements are earlier commands.)
1115 With prefix argument N, search for Nth previous match.
1116 If N is negative, search forwards for the -Nth following match."
1119 comint-next-matching-input-from-input)))
1120 ;; Starting a new search
1126 comint-input-ring-index nil))
1129 arg))
1132 "Search forwards through input history for match for current input.
1133 \(Following history elements are more recent commands.)
1134 With prefix argument N, search for Nth following match.
1135 If N is negative, search backwards for the -Nth previous match."
1141 "Expand input command history references before point.
1142 Expansion is dependent on the value of `comint-input-autoexpand'.
1144 This function depends on the buffer's idea of the input history, which may not
1145 match the command interpreter's idea, assuming it has one.
1147 Assumes history syntax is like typical Un*x shells'. However, since emacs
1148 cannot know the interpreter's idea of input line numbers, assuming it has one,
1149 it cannot expand absolute input line number references.
1151 If the optional argument SILENT is non-nil, never complain
1152 even if history reference seems erroneous.
1154 If the optional argument START is non-nil, that specifies the
1155 start of the text to scan for history references, rather
1156 than the logical beginning of line.
1158 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1160 Returns t if successful."
1164 ;; Use comint-prompt-regexp
1168 ;; Use input fields. User input that hasn't been entered
1169 ;; yet, at the end of the buffer, has a nil `field' property.
1172 ;; Looks like there might be history references in the command.
1179 "Expand directory stack reference before point.
1180 See `comint-replace-by-expanded-history'. Returns t if successful.
1182 If the optional argument START is non-nil, that specifies the
1183 start of the text to scan for history references, rather
1184 than the logical beginning of line."
1192 ;; This seems a bit complex. We look for references such as !!, !-num,
1193 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1194 ;; If that wasn't enough, the plings can be suffixed with argument
1195 ;; range specifiers.
1196 ;; Argument ranges are complex too, so we hive off the input line,
1197 ;; referenced with plings, with the range string to `comint-args'.
1201 ;; The history is quoted, or we're in quotes.
1204 ;; We cannot know the interpreter's idea of input line numbers.
1208 ;; Just a number of args from `number' lines backward.
1217 t t)
1223 ;; Just a number of args from the previous input line.
1227 t t)
1231 ;; Most recent input starting with or containing (possibly
1232 ;; protected) string, maybe just a number of args. Phew.
1250 t t)
1253 ;; Quick substitution on the previous input line.
1270 "Expand input history references before point and insert ARG spaces.
1271 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1275 \f
1277 "Return t if the number of quotes between BEG and END is odd.
1278 Quotes are single and double."
1284 "Return number of matches for REGEXP from BEG to END."
1291 count))
1294 ;; From STRING, return the args depending on the range specified in the text
1295 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1296 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1312 ;; Return a list of arguments from ARG. Break it up at the
1313 ;; delimiters in comint-delimiter-argument-list. Returned list is backwards.
1328 comint-delimiter-argument-list)))
1331 args)))
1334 "Return from STRING the NTH to MTH arguments.
1335 NTH and/or MTH can be nil, which means the last argument.
1336 Returned arguments are separated by single spaces.
1337 We assume whitespace separates arguments, except within quotes
1338 and except for a space or tab that immediately follows a backslash.
1339 Also, a run of one or more of a single character
1340 in `comint-delimiter-argument-list' is a separate argument.
1341 Argument 0 is the command name."
1342 ;; The first line handles ordinary characters and backslash-sequences
1343 ;; (except with w32 msdos-like shells, where backslashes are valid).
1344 ;; The second matches "-quoted strings.
1345 ;; The third matches '-quoted strings.
1346 ;; The fourth matches `-quoted strings.
1347 ;; This seems to fit the syntax of BASH 2.0.
1358 beg str value quotes)
1359 ;; Build a list of all the args until we have as many as we want.
1363 ;; It's contiguous, part of the same arg.
1366 ;; It's a new separate arg.
1368 ;; Put the previous arg, if there was one, onto ARGS.
1385 \f
1386 ;;
1387 ;; Input processing stuff
1388 ;;
1390 "Add CMD to the input history.
1391 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1397 cmd))))
1401 "Send input to process.
1402 After the process output mark, sends all text from the process mark to
1403 point as input to the process. Before the process output mark, calls
1404 value of variable `comint-get-old-input' to retrieve old input, copies
1405 it to the process mark, and sends it. A terminal newline is also
1406 inserted into the buffer and sent to the process.
1408 Any history reference may be expanded depending on the value of the variable
1409 `comint-input-autoexpand'. The list of function names contained in the value
1410 of `comint-input-filter-functions' is called on the input before sending it.
1411 The input is entered into the input history ring, if the value of variable
1412 `comint-input-filter' returns non-nil when called on the input.
1414 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1415 end of line before sending the input.
1417 After the input has been sent, if `comint-process-echoes' is non-nil,
1418 then comint-send-input waits to see if the process outputs a string
1419 matching the input, and if so, deletes that part of the output.
1421 The values of `comint-get-old-input', `comint-input-filter-functions', and
1422 `comint-input-filter' are chosen according to the command interpreter running
1423 in the buffer. E.g.,
1425 If the interpreter is the csh,
1426 comint-get-old-input is the default:
1427 If `comint-use-prompt-regexp-instead-of-fields' is nil, then
1428 either return the current input field, if point is on an input
1429 field, or the current line, if point is on an output field.
1430 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then
1431 return the current line with any initial string matching the
1432 regexp `comint-prompt-regexp' removed.
1435 comint-input-filter is the default: returns t if the input isn't all white
1436 space.
1438 If the comint is Lucid Common Lisp,
1439 comint-get-old-input snarfs the sexp ending at point.
1440 comint-input-filter-functions does nothing.
1441 comint-input-filter returns nil if the input matches input-filter-regexp,
1442 which matches (1) all whitespace (2) :a, :c, etc.
1444 Similarly for Soar, Scheme, etc."
1446 ;; Note that the input string does not include its terminal newline.
1456 copy)))
1458 ;; Just whatever's already there
1459 intxt
1460 ;; Expand and leave it visible in buffer
1464 input
1465 ;; This is messy 'cos ultimately the original
1466 ;; functions used do insertion, rather than return
1467 ;; strings. We have to expand, then insert back.
1473 copy))))
1487 ;; Make an overlay for the input field
1490 ;; Give old user input a field property of `input', to
1491 ;; distinguish it from both process output and unsent
1492 ;; input. The terminating newline is put into a special
1493 ;; `boundary' field to make cursor movement between input
1494 ;; and output fields smoother.
1500 'help-echo
1504 ;; Make an overlay for the terminating newline
1514 ;; Update the markers before we send the input
1515 ;; in case we get output amidst sending the input.
1519 ;; clear the "accumulation" marker
1524 ;; Optionally delete echoed input (after checking it).
1527 comint-last-input-start)))
1528 ;; Wait for all input to be echoed:
1534 nil comint-last-input-start
1536 ;; Above difference is equivalent to
1537 ;; (+ comint-last-input-start
1538 ;; (- (point-max) comint-last-input-end))
1545 nil comint-last-input-start comint-last-input-end
1546 nil comint-last-input-end
1551 ;; This used to call comint-output-filter-functions,
1552 ;; but that scrolled the buffer in undesirable ways.
1556 "List of functions to call before inserting Comint output into the buffer.
1557 Each function gets one argument, a string containing the text received
1558 from the subprocess. It should return the string to insert, perhaps
1559 the same string that was received, or perhaps a modified or transformed
1560 string.
1562 The functions on the list are called sequentially, and each one is
1563 given the string returned by the previous one. The string returned by
1564 the last function is the text that is actually inserted in the
1565 redirection buffer.
1569 ;; When non-nil, this is the last overlay used for output.
1570 ;; It is kept around so that we can extend it instead of creating
1571 ;; multiple contiguous overlays for multiple contiguous output chunks.
1574 ;; When non-nil, this is an overlay over the last recognized prompt in
1575 ;; the buffer; it is used when highlighting the prompt.
1578 ;; `snapshot' any current comint-last-prompt-overlay, freezing it in place.
1579 ;; Any further output will then create a new comint-last-prompt-overlay.
1586 "Handle carriage control characters in comint output.
1587 Translate carriage return/linefeed sequences to linefeeds.
1588 Make single carriage returns delete to the beginning of the line.
1589 Make backspaces delete the previous character.
1591 This function should be in the list `comint-output-filter-functions'."
1593 ;; We first check to see if STRING contains any magic characters, to
1594 ;; avoid overhead in the common case where it does not
1602 ;; CR LF -> LF
1603 ;; Note that this won't work properly when the CR and LF
1604 ;; are in different output chunks, but this is probably an
1605 ;; exceedingly rare case (because they are generally
1606 ;; written as a unit), and to delay interpretation of a
1607 ;; trailing CR in a chunk would result in odd interactive
1608 ;; behavior (and this case is probably far more common).
1612 ;; bare CR -> delete preceding line
1616 ;; BS -> delete preceding character
1623 ;; The purpose of using this filter for comint processes
1624 ;; is to keep comint-last-input-end from moving forward
1625 ;; when output is inserted.
1628 ;; First check for killed buffer or no input.
1631 ;; Run preoutput filters
1637 ;; Insert STRING
1639 ;; Avoid the overhead of save-excursion, since we just
1640 ;; fiddle with the point
1643 ;; The point should float after any insertion we do
1646 ;; We temporarly remove any buffer narrowing, in case the
1647 ;; process mark is outside of the restriction
1654 ;; insert-before-markers is a bad thing. XXX
1655 ;;
1656 ;; It is used here to force window-point markers (used to
1657 ;; store the value of point in non-selected windows) to
1658 ;; advance, but it also screws up any other markers that we
1659 ;; don't _want_ to advance, such as the start-marker of some
1660 ;; of the overlays we create.
1661 ;;
1662 ;; We work around the problem with the overlays by
1663 ;; explicitly adjusting them after we do the insertion, but
1664 ;; in the future this problem should be solved correctly, by
1665 ;; using `insert', and making the insertion-type of
1666 ;; window-point markers settable (via a buffer-local
1667 ;; variable). In comint buffers, this variable would be set
1668 ;; to `t', to cause point in non-select windows to advance.
1670 ;; Fixup markers and overlays that got screwed up because we
1671 ;; used `insert-before-markers'.
1673 ;; comint-last-output-start
1675 ;; comint-last-input-end
1680 ;; No overlays we create are set to advance upon insertion
1681 ;; (at the start/end), so we assume that any overlay which
1682 ;; is at the current point was incorrectly advanced by
1683 ;; insert-before-markers. First fixup overlays that might
1684 ;; start at point:
1689 old-point
1691 ;; Then do overlays that might end at point:
1696 old-point))))
1698 ;; Advance process-mark
1702 ;; We check to see if the last overlay used for output is
1703 ;; adjacent to the new input, and if so, just extend it.
1707 ;; Extend comint-last-output-overlay to include the
1708 ;; most recent output
1712 ;; Create a new overlay
1720 ;; Highlight the prompt, where we define `prompt' to mean
1721 ;; the most recent output that doesn't end with a newline.
1723 ;; Need to create or move the prompt overlay (in the case
1724 ;; where there is no prompt ((bolp) == t), we still do
1725 ;; this if there's already an existing overlay).
1728 ;; Just move an existing overlay
1731 ;; Need to create the overlay
1742 "Go to the end of buffer in all windows showing it.
1743 Movement occurs if point in the selected window is not after the process mark,
1744 and `this-command' is an insertion command. Insertion commands recognised
1745 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1746 Depends on the value of `comint-scroll-to-bottom-on-input'.
1748 This function should be a pre-command hook."
1751 hilit-yank)))
1767 nil t))))))
1770 "Go to the end of buffer in all windows showing it.
1771 Does not scroll if the current line is the last line in the buffer.
1772 Depends on the value of `comint-scroll-to-bottom-on-output' and
1773 `comint-scroll-show-maximum-output'.
1775 This function should be in the list `comint-output-filter-functions'."
1789 ;; Maybe user wants point to jump to end.
1792 ;; If point was at the end, keep it at end.
1796 ;; Optionally scroll so that the text
1797 ;; ends at the bottom of the window.
1804 nil t))
1808 "Truncate the buffer to `comint-buffer-maximum-size'.
1809 This function could be on `comint-output-filter-functions' or bound to a key."
1818 "Strip trailing `^M' characters from the current output group.
1819 This function could be on `comint-output-filter-functions' or bound to a key."
1832 "Put the end of the buffer at the bottom of the window."
1838 "Default for `comint-get-old-input'.
1839 If `comint-use-prompt-regexp-instead-of-fields' is nil, then either
1840 return the current input field, if point is on an input field, or the
1841 current line, if point is on an output field.
1842 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then return
1843 the current line with any initial string matching the regexp
1844 `comint-prompt-regexp' removed."
1852 "Insert after prompt old input at point as new input to be edited.
1853 Calls `comint-get-old-input' to get old input."
1863 "Skip past the text matching regexp `comint-prompt-regexp'.
1864 If this takes us past the end of the current line, don't skip at all."
1871 "Return t if point is after the process output marker."
1876 "Default function for sending to PROC input STRING.
1877 This just sends STRING plus a newline. To override this,
1878 set the hook `comint-input-sender'."
1886 "Returns the buffer position of the beginning of the line, after any prompt.
1887 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1888 prompt skip is done by skipping text matching the regular expression
1889 `comint-prompt-regexp', a buffer local variable."
1891 ;; Use comint-prompt-regexp
1896 ;; Use input fields. Note that, unlike the behavior of
1897 ;; `line-beginning-position' inside a field, this function will
1898 ;; return the position of the end of a prompt, even if the point is
1899 ;; already inside the prompt. In order to do this, it assumes that
1900 ;; if there are two fields on a line, then the first one is the
1901 ;; prompt, and the second one is an input field, and is front-sticky
1902 ;; (as input fields should be).
1906 "Goes to the beginning of line, then skips past the prompt, if any.
1908 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1909 prompt skip is done by skipping text matching the regular expression
1910 `comint-prompt-regexp', a buffer local variable."
1913 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1917 ;; These three functions are for entering text you don't want echoed or
1918 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1919 ;; Just enter m-x send-invisible and type in your line, or add
1920 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1923 "Read a single line of text from user without echoing, and return it.
1924 Prompt with argument PROMPT, a string. Optional argument STARS causes
1925 input to be echoed with '*' characters on the prompt line. Input ends with
1926 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1927 `inhibit-quit' is set because e.g. this function was called from a process
1928 filter and C-g is pressed, this function returns nil rather than a string).
1930 Note that the keystrokes comprising the text can still be recovered
1932 Once the caller uses the password, it can erase the password
1933 by doing (fillarray STRING 0)."
1945 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1948 ;; This function may get called from a process filter, where
1949 ;; inhibit-quit is set. In later versions of emacs read-char
1950 ;; may clear quit-flag itself and return C-g. That would make
1951 ;; it impossible to quit this loop in a simple way, so
1952 ;; re-enable it here (for backward-compatibility the check for
1953 ;; quit-flag below would still be necessary, so this seems
1954 ;; like the simplest way to do things).
1956 done t))
1970 ;; Emulate a true quit, except that we have to return a value.
1976 ans)))
1979 "Read a string without echoing.
1980 Then send it to the process running in the current buffer.
1981 The string is sent using `comint-input-sender'.
1982 Security bug: your string can still be temporarily recovered with
1998 "Prompt in the minibuffer for password and send without echoing.
1999 This function uses `send-invisible' to read and send a password to the buffer's
2000 process if STRING contains a password prompt defined by
2001 `comint-password-prompt-regexp'.
2003 This function could be in the list `comint-output-filter-functions'."
2007 \f
2008 ;; Low-level process communication
2011 "Like `process-send-string', but also does extra bookkeeping for comint mode."
2021 "Like `process-send-region', but also does extra bookkeeping for comint mode."
2030 \f
2031 ;; Random input hackage
2034 "Delete all output from interpreter since last input.
2035 Does not delete the prompt."
2048 ;; Output message and put back prompt
2054 "Write output from interpreter since last input to FILENAME.
2055 Any prompt at the end of the output is not written.
2057 If the optional argument APPEND (the prefix argument when interactive)
2058 is non-nil, the output is appended to the file instead.
2060 If the optional argument MUSTBENEW is non-nil, check for an existing
2061 file with the same name. If MUSTBENEW is `excl', that means to get an
2062 error if the file already exists; never overwrite. If MUSTBENEW is
2063 neither nil nor `excl', that means ask for confirmation before
2064 overwriting, but do go ahead and overwrite the file if the user
2065 confirms. When interactive, MUSTBENEW is nil when appending, and t
2066 otherwise."
2070 "Append output to file: "
2072 current-prefix-arg
2078 append nil nil mustbenew)))
2080 ;; This function exists for the benefit of the menu; from the keyboard,
2081 ;; users can just use `comint-write-output' with a prefix arg.
2083 "Append output from interpreter since last input to FILENAME.
2084 Any prompt at the end of the output is not written."
2089 "Display start of this batch of interpreter output at top of window.
2090 Sets mark to the value of point when this command is run."
2105 "Interrupt the current subjob.
2106 This command also kills the pending input
2107 between the process-mark and point."
2113 "Send kill signal to the current subjob.
2114 This command also kills the pending input
2115 between the process-mark and point."
2121 "Send quit signal to the current subjob.
2122 This command also kills the pending input
2123 between the process-mark and point."
2129 "Stop the current subjob.
2130 This command also kills the pending input
2131 between the process-mark and point.
2133 WARNING: if there is no current subjob, you can end up suspending
2134 the top-level process running in the buffer. If you accidentally do
2136 is not a problem with most shells, since they ignore this signal.)"
2142 "Send CONT signal to process buffer's process group.
2143 Useful if you accidentally suspend the top-level process."
2148 "Kill all text from last stuff output by interpreter to point."
2155 "Delete ARG characters forward or send an EOF to subprocess.
2156 Sends an EOF only if point is at the end of the buffer and there is no input."
2164 "Send an EOF to the current buffer's process."
2171 "Search backward through buffer for input fields that match REGEXP.
2172 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2173 fields are identified by lines that match `comint-prompt-regexp'.
2175 With prefix argument N, search for Nth previous match.
2176 If N is negative, find the next or Nth next match."
2179 ;; Use comint-prompt-regexp
2189 ;; Use input fields
2203 "Search forward through buffer for input fields that match REGEXP.
2204 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2205 fields are identified by lines that match `comint-prompt-regexp'.
2207 With prefix argument N, search for Nth following match.
2208 If N is negative, find the previous or Nth previous match."
2214 "Move to end of Nth next prompt in the buffer.
2215 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2216 the beginning of the Nth next `input' field, otherwise, it means the Nth
2217 occurance of text matching `comint-prompt-regexp'."
2220 ;; Use comint-prompt-regexp
2225 ;; Use input fields
2228 prev-pos)
2236 ;; Ran off the end of the buffer.
2238 ;; There's always an input field at the end of the
2239 ;; buffer, but it has a `field' property of nil.
2241 ;; stop iterating
2251 "Move to end of Nth previous prompt in the buffer.
2252 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2253 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2254 occurance of text matching `comint-prompt-regexp'."
2258 ;; State used by `comint-insert-previous-argument' when cycling.
2264 ;; Needs fixing:
2265 ;; make comint-arguments understand negative indices as bash does
2267 "Insert the INDEXth argument from the previous comint command-line at point.
2268 Spaces are added at beginning and/or end of the inserted string if
2269 necessary to ensure that it's separated from adjacent arguments.
2270 Interactively, if no prefix argument is given, the last argument is inserted.
2271 Repeated interactive invocations will cycle through the same argument
2272 from progressively earlier commands (using the value of INDEX specified
2273 with the first command).
2274 This command is like `M-.' in bash."
2279 ;; Delete last input inserted by this command.
2283 ;; This is a non-repeat invocation, so initialize state.
2287 ;; First usage; initialize to a marker
2290 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2294 ;; Remember the beginning of what we insert, so we can delete it if
2295 ;; the command is repeated.
2297 ;; Insert the argument.
2300 ;; strip terminating '&'
2303 ;; Make next invocation return arg from previous input
2305 ;; Add a terminating space if necessary.
2309 \f
2310 ;; Support for source-file processing commands.
2311 ;;============================================================================
2312 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2313 ;; commands that process files of source text (e.g. loading or compiling
2314 ;; files). So the corresponding process-in-a-buffer modes have commands
2315 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2316 ;; for defining these commands.
2317 ;;
2318 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2319 ;; and Soar, in that they don't know anything about file extensions.
2320 ;; So the compile/load interface gets the wrong default occasionally.
2321 ;; The load-file/compile-file default mechanism could be smarter -- it
2322 ;; doesn't know about the relationship between filename extensions and
2323 ;; whether the file is source or executable. If you compile foo.lisp
2324 ;; with compile-file, then the next load-file should use foo.bin for
2325 ;; the default, not foo.lisp. This is tricky to do right, particularly
2326 ;; because the extension for executable files varies so much (.o, .bin,
2327 ;; .lbin, .mo, .vo, .ao, ...).
2330 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2331 ;; commands.
2332 ;;
2333 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2334 ;; want to save the buffer before issuing any process requests to the command
2335 ;; interpreter.
2336 ;;
2337 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2338 ;; for the file to process.
2340 ;; (COMINT-SOURCE-DEFAULT previous-dir/file source-modes)
2341 ;;============================================================================
2342 ;; This function computes the defaults for the load-file and compile-file
2343 ;; commands for tea, soar, cmulisp, and cmuscheme modes.
2344 ;;
2345 ;; - PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2346 ;; source-file processing command. nil if there hasn't been one yet.
2347 ;; - SOURCE-MODES is a list used to determine what buffers contain source
2348 ;; files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2349 ;; Typically, (lisp-mode) or (scheme-mode).
2350 ;;
2351 ;; If the command is given while the cursor is inside a string, *and*
2352 ;; the string is an existing filename, *and* the filename is not a directory,
2353 ;; then the string is taken as default. This allows you to just position
2354 ;; your cursor over a string that's a filename and have it taken as default.
2355 ;;
2356 ;; If the command is given in a file buffer whose major mode is in
2357 ;; SOURCE-MODES, then the filename is the default file, and the
2358 ;; file's directory is the default directory.
2359 ;;
2360 ;; If the buffer isn't a source file buffer (e.g., it's the process buffer),
2361 ;; then the default directory & file are what was used in the last source-file
2362 ;; processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2363 ;; the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2364 ;; is the cwd, with no default file. (\"no default file\" = nil)
2365 ;;
2366 ;; SOURCE-REGEXP is typically going to be something like (tea-mode)
2367 ;; for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2368 ;; for Soar programs, etc.
2369 ;;
2370 ;; The function returns a pair: (default-directory . default-file).
2381 ;; (COMINT-CHECK-SOURCE fname)
2382 ;;============================================================================
2383 ;; Prior to loading or compiling (or otherwise processing) a file (in the CMU
2384 ;; process-in-a-buffer modes), this function can be called on the filename.
2385 ;; If the file is loaded into a buffer, and the buffer is modified, the user
2386 ;; is queried to see if he wants to save the buffer before proceeding with
2387 ;; the load or compile.
2394 ;; save BUFF.
2401 ;; (COMINT-GET-SOURCE prompt prev-dir/file source-modes mustmatch-p)
2402 ;;============================================================================
2403 ;; COMINT-GET-SOURCE is used to prompt for filenames in command-interpreter
2404 ;; commands that process source files (like loading or compiling a file).
2405 ;; It prompts for the filename, provides a default, if there is one,
2406 ;; and returns the result filename.
2407 ;;
2408 ;; See COMINT-SOURCE-DEFAULT for more on determining defaults.
2409 ;;
2410 ;; PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2411 ;; from the last source processing command. SOURCE-MODES is a list of major
2412 ;; modes used to determine what file buffers contain source files. (These
2413 ;; two arguments are used for determining defaults). If MUSTMATCH-P is true,
2414 ;; then the filename reader will only accept a file that exists.
2415 ;;
2416 ;; A typical use:
2417 ;; (interactive (comint-get-source "Compile file: " prev-lisp-dir/file
2418 ;; '(lisp-mode) t))
2420 ;; This is pretty stupid about strings. It decides we're in a string
2421 ;; if there's a quote on both sides of point on the current line.
2423 "Return string around POINT that starts the current line, or nil."
2450 prompt deffile)
2451 prompt)
2452 defdir
2454 mustmatch-p)))
2457 ;; I am somewhat divided on this string-default feature. It seems
2458 ;; to violate the principle-of-least-astonishment, in that it makes
2459 ;; the default harder to predict, so you actually have to look and see
2460 ;; what the default really is before choosing it. This can trip you up.
2461 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2462 ;; on this.
2463 ;; -Olin
2465 \f
2466 ;; Simple process query facility.
2467 ;; ===========================================================================
2468 ;; This function is for commands that want to send a query to the process
2469 ;; and show the response to the user. For example, a command to get the
2470 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2471 ;; to an inferior Common Lisp process.
2472 ;;
2473 ;; This simple facility just sends strings to the inferior process and pops
2474 ;; up a window for the process buffer so you can see what the process
2475 ;; responds with. We don't do anything fancy like try to intercept what the
2476 ;; process responds with and put it in a pop-up window or on the message
2477 ;; line. We just display the buffer. Low tech. Simple. Works good.
2479 ;; Send to the inferior process PROC the string STR. Pop-up but do not select
2480 ;; a window for the inferior process so that its response can be seen.
2490 ;; Try to position the proc window so you can see the answer.
2491 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2492 ;; I don't know why. Wizards invited to improve it.
2501 \f
2502 ;; Filename/command/history completion in a buffer
2503 ;; ===========================================================================
2504 ;; Useful completion functions, courtesy of the Ergo group.
2506 ;; Six commands:
2507 ;; comint-dynamic-complete Complete or expand command, filename,
2508 ;; history at point.
2509 ;; comint-dynamic-complete-filename Complete filename at point.
2510 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2511 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2512 ;; replace with expanded/completed name.
2513 ;; comint-dynamic-simple-complete Complete stub given candidates.
2515 ;; These are not installed in the comint-mode keymap. But they are
2516 ;; available for people who want them. Shell-mode installs them:
2517 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2518 ;; (define-key shell-mode-map "\M-?"
2519 ;; 'comint-dynamic-list-filename-completions)))
2520 ;;
2521 ;; Commands like this are fine things to put in load hooks if you
2522 ;; want them present in specific modes.
2525 "*If non-nil, automatically list possibilities on partial completion.
2526 This mirrors the optional behavior of tcsh."
2531 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2532 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2533 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2534 This mirrors the optional behavior of tcsh."
2543 "*If non-nil, use shortest completion if characters cannot be added.
2544 This mirrors the optional behavior of tcsh.
2546 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2551 "*List of suffixes to be disregarded during file completion.
2552 This mirrors the optional behavior of bash and tcsh.
2554 Note that this applies to `comint-dynamic-complete-filename' only."
2559 "Prefix prepended to absolute file names taken from process input.
2560 This is used by comint's and shell's completion functions, and by shell's
2565 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2567 "String of characters valid in a file name.
2568 Note that all non-ASCII characters are considered valid in a file name
2569 regardless of what this variable says.
2580 ;; Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute.
2583 directory)))
2587 "Return the word of WORD-CHARS at point, or nil if non is found.
2588 Word constituents are considered to be those in WORD-CHARS, which is like the
2590 plus all non-ASCII characters."
2594 ;;(memq (char-after (point)) shell-file-name-quote-list)
2598 ;; Don't go forward over a word-char (this can happen if we're at bob).
2601 ;; Set match-data to match the entire string.
2607 "Return FILENAME with environment variables substituted.
2608 Supports additional environment variable syntax of the command
2609 interpreter (e.g., the percent notation of cmd.exe on NT)."
2613 env-var-val)
2622 name))
2625 "Return the filename at point, or nil if non is found.
2626 Environment variables are substituted. See `comint-word'."
2633 "Return FILENAME with magic characters quoted.
2634 Magic characters are those in `comint-file-name-quote-list'."
2636 filename
2643 filename))))
2646 "Return FILENAME with quoted characters unquoted."
2648 filename
2654 filename)))
2658 "Dynamically perform completion at point.
2659 Calls the functions in `comint-dynamic-complete-functions' to perform
2660 completion until a function returns non-nil, at which point completion is
2661 assumed to have occurred."
2667 "Dynamically complete the filename at point.
2668 Completes if after a filename. See `comint-match-partial-filename' and
2669 `comint-dynamic-complete-as-filename'.
2670 This function is similar to `comint-replace-by-expanded-filename', except that
2671 it won't change parts of the filename already entered in the buffer; it just
2672 adds completion characters to the end of the filename. A completions listing
2673 may be shown in a help buffer if completion is ambiguous.
2675 Completion is dependent on the value of `comint-completion-addsuffix',
2676 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2677 completions listing is dependent on the value of `comint-completion-autolist'.
2679 Returns t if successful."
2687 "Dynamically complete at point as a filename.
2688 See `comint-dynamic-complete-filename'. Returns t if successful."
2691 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2692 ;; I think it was originally bound to solve file completion problems,
2693 ;; but subsequent changes may have made this unnecessary. sm.
2694 ;;(file-name-handler-alist nil)
2729 ;; We inserted a unique completion.
2736 ;; It's not unique, but user wants shortest match.
2742 ;; It's not unique, list possible completions.
2747 success))
2751 "Dynamically expand and complete the filename at point.
2752 Replace the filename with an expanded, canonicalised and completed replacement.
2755 removed, and the filename is made absolute instead of relative. For expansion
2756 see `expand-file-name' and `substitute-in-file-name'. For completion see
2757 `comint-dynamic-complete-filename'."
2766 "Dynamically complete STUB from CANDIDATES list.
2767 This function inserts completion characters at point by completing STUB from
2768 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2769 if completion is ambiguous.
2771 Returns nil if no completion was inserted.
2772 Returns `sole' if completed with the only completion match.
2773 Returns `shortest' if completed with the shortest of the completion matches.
2774 Returns `partial' if completed as far as possible with the completion matches.
2775 Returns `listed' if a completion listing was shown.
2777 See also `comint-dynamic-complete-filename'."
2786 nil)
2797 ;; Insert the longest substring.
2802 ;; It's not unique, but user wants shortest match.
2808 ;; It's not unique, list possible completions.
2817 "List in help buffer possible completions of the filename at point."
2820 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2821 ;; I think it was originally bound to solve file completion problems,
2822 ;; but subsequent changes may have made this unnecessary. sm.
2823 ;;(file-name-handler-alist nil)
2836 "List in help buffer sorted COMPLETIONS.
2837 Typing SPC flushes the help buffer."
2842 ;; If this command was repeated, and
2843 ;; there's a fresh completion window with a live buffer,
2844 ;; and this command is repeated, scroll that window.
2865 ;; If the user does mouse-choose-completion with the mouse,
2866 ;; execute the command, then delete the completion window.
2874 \f
2876 "After fetching a line from input history, this fetches the following line.
2877 In other words, this recalls the input line after the line you recalled last.
2878 You can use this to repeat a sequence of input lines."
2887 "Accumulate a line to send as input along with more lines.
2888 This inserts a newline so that you can enter more text
2890 to send all the accumulated input, at once.
2891 The entire accumulated text becomes one item in the input history
2892 when you send it."
2901 "Move point to the process mark.
2902 The process mark separates output, and input already sent,
2903 from input that has not yet been sent."
2912 "Move point to beginning of line (after prompt) or to the process mark.
2913 The first time you use this command, it moves to the beginning of the line
2914 \(but after the prompt, if any). If you repeat it again immediately,
2915 it moves point to the process mark.
2917 The process mark separates the process output, along with input already sent,
2918 from input that has not yet been sent. Ordinarily, the process mark
2919 is at the beginning of the current input line; but if you have
2921 the process mark is at the beginning of the accumulated input."
2928 "Set the process mark at point."
2935 \f
2936 ;; Author: Peter Breton <pbreton@cs.umb.edu>
2938 ;; This little add-on for comint is intended to make it easy to get
2939 ;; output from currently active comint buffers into another buffer,
2940 ;; or buffers, and then go back to using the comint shell.
2941 ;;
2942 ;; My particular use is SQL interpreters; I want to be able to execute a
2943 ;; query using the process associated with a comint-buffer, and save that
2944 ;; somewhere else. Because the process might have state (for example, it
2945 ;; could be in an uncommitted transaction), just running starting a new
2946 ;; process and having it execute the query and then finish, would not
2947 ;; work. I'm sure there are other uses as well, although in many cases
2948 ;; starting a new process is the simpler, and thus preferable, approach.
2949 ;;
2950 ;; The basic implementation is as follows: comint-redirect changes the
2951 ;; preoutput filter functions (comint-preoutput-filter-functions) to use
2952 ;; its own filter. The filter puts the output into the designated buffer,
2953 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2954 ;; this is the prompt for the interpreter, comint-prompt-regexp). When it
2955 ;; sees the stop regexp, it restores the old filter functions, and runs
2956 ;; comint-redirect-hook.
2957 ;;
2958 ;; Each comint buffer may only use one redirection at a time, but any number
2959 ;; of different comint buffers may be simultaneously redirected.
2960 ;;
2961 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2962 ;; correct prompt for your interpreter, or that you supply a regexp that says
2963 ;; when the redirection is finished. Otherwise, redirection will continue
2964 ;; indefinitely. The code now does a sanity check to ensure that it can find
2965 ;; a prompt in the comint buffer; however, it is still important to ensure that
2966 ;; this prompt is set correctly.
2967 ;;
2968 ;; XXX: This doesn't work so well unless comint-prompt-regexp is set;
2969 ;; perhaps it should prompt for a terminating string (with an
2970 ;; appropriate magic default by examining what we think is the prompt)?
2971 ;;
2973 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2974 ;; Variables
2975 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2978 "*If non-nil, print messages each time the redirection filter is invoked.
2979 Also print a message when redirection is completed."
2983 ;; Directly analagous to comint-preoutput-filter-functions
2985 "List of functions to call before inserting redirected process output.
2986 Each function gets one argument, a string containing the text received
2987 from the subprocess. It should return the string to insert, perhaps
2988 the same string that was received, or perhaps a modified or transformed
2989 string.
2991 The functions on the list are called sequentially, and each one is given
2992 the string returned by the previous one. The string returned by the
2997 ;; Internal variables
3003 "Regular expression that determines when to stop redirection in Comint.
3004 When the redirection filter function is given output that matches this regexp,
3008 "If non-nil, the text that ends a redirection is included in it.
3009 More precisely, the text that matches `comint-redirect-finished-regexp'
3010 and therefore terminates an output redirection is inserted in the
3023 "If non-nil, check that redirection is likely to complete successfully.
3024 More precisely, before starting a redirection, verify that the
3025 regular expression `comint-redirect-finished-regexp' that controls
3026 when to terminate it actually matches some text already in the process
3027 buffer. The idea is that this regular expression should match a prompt
3028 string, and that there ought to be at least one copy of your prompt string
3032 "The process filter that was in place when redirection is started.
3033 When redirection is completed, the process filter is restored to
3036 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3037 ;; Functions
3038 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3041 comint-buffer
3042 finished-regexp
3044 "Set up for output redirection.
3045 This function sets local variables that are used by `comint-redirect-filter'
3046 to perform redirection.
3048 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3049 in the output matches FINISHED-REGEXP.
3051 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3052 original comint buffer.
3054 This function is called by `comint-redirect-send-command-to-process',
3055 and does not normally need to be invoked by the end user or programmer."
3079 "End a Comint redirection. See `comint-redirect-send-command'."
3081 ;; Restore the process filter
3083 comint-redirect-original-filter-function)
3084 ;; Restore the mode line
3086 ;; Set the completed flag
3089 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3090 ;; that it really occurs.
3094 "Filter function which redirects output from PROCESS to a buffer or buffers.
3095 The variable `comint-redirect-output-buffer' says which buffer(s) to
3096 place output in.
3098 INPUT-STRING is the input from the comint process.
3100 This function runs as a process filter, and does not need to be invoked by the
3101 end user."
3105 ;; If we have to echo output, give it to the original filter function
3107 comint-redirect-original-filter-function
3109 process input-string)))))
3113 "Comint filter function which redirects comint output to a buffer or buffers.
3114 The variable `comint-redirect-output-buffer' says which buffer(s) to
3115 place output in.
3117 INPUT-STRING is the input from the comint process.
3119 This function does not need to be invoked by the end user."
3122 comint-redirect-output-buffer
3126 ;; If there are any filter functions, give them a chance to modify the string
3133 ;; Clobber `comint-redirect-finished-regexp'
3139 ;; Send output to all registered buffers
3143 ;; Set this buffer to the output buffer
3145 ;; Go to the end of the buffer
3147 ;; Insert the output
3149 output-buffer-list))
3151 ;; Message
3156 ;; If we see the prompt, tidy up
3157 ;; We'll look for the prompt in the original string, so nobody can
3158 ;; clobber it
3165 ;; Echo input?
3167 filtered-input-string
3170 ;;;###autoload
3172 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3173 With prefix arg, echo output in process buffer.
3175 If NO-DISPLAY is non-nil, do not show the output buffer."
3183 ;;;###autoload
3186 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3187 With prefix arg, echo output in process buffer.
3189 If NO-DISPLAY is non-nil, do not show the output buffer."
3194 process))
3196 ;; Change to the process buffer
3199 ;; Make sure there's a prompt in the current process buffer
3206 ;;;;;;;;;;;;;;;;;;;;;
3207 ;; Set up for redirection
3208 ;;;;;;;;;;;;;;;;;;;;;
3210 ;; Output Buffer
3211 output-buffer
3212 ;; Comint Buffer
3214 ;; Finished Regexp
3215 comint-prompt-regexp
3216 ;; Echo input
3217 echo)
3219 ;;;;;;;;;;;;;;;;;;;;;
3220 ;; Set the filter
3221 ;;;;;;;;;;;;;;;;;;;;;
3222 ;; Save the old filter
3227 ;;;;;;;;;;;;;;;;;;;;;
3228 ;; Send the command
3229 ;;;;;;;;;;;;;;;;;;;;;
3234 ;;;;;;;;;;;;;;;;;;;;;
3235 ;; Show the output
3236 ;;;;;;;;;;;;;;;;;;;;;
3242 output-buffer)))))))
3244 ;;;###autoload
3246 "Send COMMAND to current process.
3247 Return a list of expressions in the output which match REGEXP.
3248 REGEXP-GROUP is the regular expression group in REGEXP to use."
3251 command regexp regexp-group))
3253 ;;;###autoload
3255 "Send COMMAND to PROCESS.
3256 Return a list of expressions in the output which match REGEXP.
3257 REGEXP-GROUP is the regular expression group in REGEXP to use."
3259 results)
3264 output-buffer process nil t)
3265 ;; Wait for the process to complete
3269 ;; Collect the output
3272 ;; Skip past the command, if it was echoed
3280 results)))
3281 results)))
3286 "^Empty input ring$"
3287 "^No history$"
3291 \f
3292 ;; Converting process modes to use comint mode
3293 ;; ===========================================================================
3294 ;; The code in the Emacs 19 distribution has all been modified to use comint
3295 ;; where needed. However, there are `third-party' packages out there that
3296 ;; still use the old shell mode. Here's a guide to conversion.
3297 ;;
3298 ;; Renaming variables
3299 ;; Most of the work is renaming variables and functions. These are the common
3300 ;; ones:
3301 ;; Local variables:
3302 ;; last-input-start comint-last-input-start
3303 ;; last-input-end comint-last-input-end
3304 ;; shell-prompt-pattern comint-prompt-regexp
3305 ;; shell-set-directory-error-hook <no equivalent>
3306 ;; Miscellaneous:
3307 ;; shell-set-directory <unnecessary>
3308 ;; shell-mode-map comint-mode-map
3309 ;; Commands:
3310 ;; shell-send-input comint-send-input
3311 ;; shell-send-eof comint-delchar-or-maybe-eof
3312 ;; kill-shell-input comint-kill-input
3313 ;; interrupt-shell-subjob comint-interrupt-subjob
3314 ;; stop-shell-subjob comint-stop-subjob
3315 ;; quit-shell-subjob comint-quit-subjob
3316 ;; kill-shell-subjob comint-kill-subjob
3317 ;; kill-output-from-shell comint-delete-output
3318 ;; show-output-from-shell comint-show-output
3319 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3320 ;;
3321 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3322 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3323 ;; Comint mode does not provide functionality equivalent to
3324 ;; shell-set-directory-error-hook; it is gone.
3325 ;;
3326 ;; comint-last-input-start is provided for modes which want to munge
3327 ;; the buffer after input is sent, perhaps because the inferior
3328 ;; insists on echoing the input. The LAST-INPUT-START variable in
3329 ;; the old shell package was used to implement a history mechanism,
3330 ;; but you should think twice before using comint-last-input-start
3331 ;; for this; the input history ring often does the job better.
3332 ;;
3333 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3334 ;; *not* create the comint-mode local variables in your foo-mode function.
3335 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3336 ;; necessary comint-specific local variables. Then create the
3337 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3338 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3339 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3340 ;; get-old-input) that need to be different from the defaults. Call
3341 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3342 ;; comint-mode will take care of it. The following example, from shell.el,
3343 ;; is typical:
3344 ;;
3345 ;; (defvar shell-mode-map '())
3346 ;; (cond ((not shell-mode-map)
3347 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3348 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3349 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3350 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3351 ;; (define-key shell-mode-map "\M-?"
3352 ;; 'comint-dynamic-list-filename-completions)))
3353 ;;
3354 ;; (defun shell-mode ()
3355 ;; (interactive)
3356 ;; (comint-mode)
3357 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3358 ;; (setq major-mode 'shell-mode)
3359 ;; (setq mode-name "Shell")
3360 ;; (use-local-map shell-mode-map)
3361 ;; (make-local-variable 'shell-directory-stack)
3362 ;; (setq shell-directory-stack nil)
3363 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3364 ;; (run-hooks 'shell-mode-hook))
3365 ;;
3366 ;;
3367 ;; Completion for comint-mode users
3368 ;;
3369 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3370 ;; hook to add completion functions to. Functions on this list should return
3371 ;; non-nil if completion occurs (i.e., further completion should not occur).
3372 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3373 ;; completion job.
3374 \f
3378 ;;; comint.el ends here