| blob | 52217fa8ad6ec480321670d6dca75fdb91aaba80 |
1 ;;; comint.el --- general command interpreter in a window stuff
3 ;; Copyright (C) 1988,90,92,93,94,95,96,97,98,99,2000,01,02,03,2004
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 ;; This file defines a general command-interpreter-in-a-buffer package
31 ;; (comint mode). The idea is that you can build specific process-in-a-buffer
32 ;; modes on top of comint mode -- e.g., Lisp, shell, scheme, T, soar, ....
33 ;; This way, all these specific packages share a common base functionality,
34 ;; and a common set of bindings, which makes them easier to use (and
35 ;; saves code, implementation time, etc., etc.).
37 ;; Several packages are already defined using comint mode:
38 ;; - shell.el defines a shell-in-a-buffer mode.
39 ;; - cmulisp.el defines a simple lisp-in-a-buffer mode.
40 ;;
41 ;; - The file cmuscheme.el defines a scheme-in-a-buffer mode.
42 ;; - The file tea.el tunes scheme and inferior-scheme modes for T.
43 ;; - The file soar.el tunes Lisp and inferior-lisp modes for Soar.
44 ;; - cmutex.el defines TeX and LaTeX modes that invoke TeX, LaTeX, BibTeX,
45 ;; previewers, and printers from within Emacs.
46 ;; - background.el allows csh-like job control inside Emacs.
47 ;; It is pretty easy to make new derived modes for other processes.
49 ;; For documentation on the functionality provided by Comint mode, and
50 ;; the hooks available for customising it, see the comments below.
51 ;; For further information on the standard derived modes (shell,
52 ;; inferior-lisp, inferior-scheme, ...), see the relevant source files.
54 ;; For hints on converting existing process modes (e.g., tex-mode,
55 ;; background, dbx, gdb, kermit, prolog, telnet) to use comint-mode
56 ;; instead of shell-mode, see the notes at the end of this file.
58 \f
59 ;; Brief Command Documentation:
60 ;;============================================================================
61 ;; Comint Mode Commands: (common to all derived modes, like shell & cmulisp
62 ;; mode)
63 ;;
64 ;; M-p comint-previous-input Cycle backwards in input history
65 ;; M-n comint-next-input Cycle forwards
66 ;; M-r comint-previous-matching-input Previous input matching a regexp
67 ;; M-s comint-next-matching-input Next input that matches
68 ;; M-C-l comint-show-output Show last batch of process output
69 ;; RET comint-send-input
70 ;; C-d comint-delchar-or-maybe-eof Delete char unless at end of buff
71 ;; C-c C-a comint-bol-or-process-mark First time, move point to bol;
72 ;; second time, move to process-mark.
73 ;; C-c C-u comint-kill-input ^u
74 ;; C-c C-w backward-kill-word ^w
75 ;; C-c C-c comint-interrupt-subjob ^c
76 ;; C-c C-z comint-stop-subjob ^z
77 ;; C-c C-\ comint-quit-subjob ^\
78 ;; C-c C-o comint-delete-output Delete last batch of process output
79 ;; C-c C-r comint-show-output Show last batch of process output
80 ;; C-c C-l comint-dynamic-list-input-ring List input history
81 ;;
82 ;; Not bound by default in comint-mode (some are in shell mode)
83 ;; comint-run Run a program under comint-mode
84 ;; send-invisible Read a line w/o echo, and send to proc
85 ;; comint-dynamic-complete-filename Complete filename at point.
86 ;; comint-dynamic-list-filename-completions List completions in help buffer.
87 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
88 ;; replace with expanded/completed name.
89 ;; comint-replace-by-expanded-history Expand history at point;
90 ;; replace with expanded name.
91 ;; comint-magic-space Expand history and add (a) space(s).
92 ;; comint-kill-subjob No mercy.
93 ;; comint-show-maximum-output Show as much output as possible.
94 ;; comint-continue-subjob Send CONT signal to buffer's process
95 ;; group. Useful if you accidentally
96 ;; suspend your process (with C-c C-z).
97 ;; comint-get-next-from-history Fetch successive input history lines
98 ;; comint-accumulate Combine lines to send them together
99 ;; as input.
100 ;; comint-goto-process-mark Move point to where process-mark is.
101 ;; comint-set-process-mark Set process-mark to point.
103 ;; comint-mode-hook is the Comint mode hook. Basically for your keybindings.
105 ;;; Code:
108 \f
109 ;; Buffer Local Variables:
110 ;;============================================================================
111 ;; Comint mode buffer local variables:
112 ;; comint-prompt-regexp string comint-bol uses to match prompt
113 ;; comint-delimiter-argument-list list For delimiters and arguments
114 ;; comint-last-input-start marker Handy if inferior always echoes
115 ;; comint-last-input-end marker For comint-delete-output command
116 ;; comint-input-ring-size integer For the input history
117 ;; comint-input-ring ring mechanism
118 ;; comint-input-ring-index number ...
119 ;; comint-save-input-ring-index number ...
120 ;; comint-input-autoexpand symbol ...
121 ;; comint-input-ignoredups boolean ...
122 ;; comint-dynamic-complete-functions hook For the completion mechanism
123 ;; comint-completion-fignore list ...
124 ;; comint-file-name-chars string ...
125 ;; comint-file-name-quote-list list ...
126 ;; comint-get-old-input function Hooks for specific
127 ;; comint-input-filter-functions hook process-in-a-buffer
128 ;; comint-output-filter-functions hook function modes.
129 ;; comint-preoutput-filter-functions hook
130 ;; comint-input-filter function ...
131 ;; comint-input-sender function ...
132 ;; comint-eol-on-send boolean ...
133 ;; comint-process-echoes boolean ...
134 ;; comint-scroll-to-bottom-on-input symbol For scroll behavior
135 ;; comint-scroll-to-bottom-on-output symbol ...
136 ;; comint-scroll-show-maximum-output boolean ...
137 ;; comint-accum-marker maker For comint-accumulate
138 ;;
139 ;; Comint mode non-buffer local variables:
140 ;; comint-completion-addsuffix boolean/cons For file name
141 ;; comint-completion-autolist boolean completion behavior
142 ;; comint-completion-recexact boolean ...
145 "General command interpreter in a window stuff."
149 "Completion facilities in comint"
153 "Source finding facilities in comint"
158 "Regexp to recognise prompts in the inferior process.
161 This variable is only used if the variable
162 `comint-use-prompt-regexp-instead-of-fields' is non-nil.
164 Good choices:
175 "If non-nil, the comint prompt is read only.
176 This does not affect existing prompts.
177 Certain derived modes may override this option."
183 "List of characters to recognise as separate arguments in input.
184 Strings comprising a character in this list will separate the arguments
185 surrounding them, and also be regarded as arguments in their own right (unlike
186 whitespace). See `comint-arguments'.
187 Defaults to the empty list.
194 "*If non-nil, expand input command history references on completion.
195 This mirrors the optional behavior of tcsh (its autoexpand and histlist).
197 If the value is `input', then the expansion is seen on input.
198 If the value is `history', then the expansion is only when inserting
199 into the buffer's input ring. See also `comint-magic-space' and
200 `comint-dynamic-complete'.
202 This variable is buffer-local."
210 "Face to use to highlight user input."
216 "Face to use to highlight prompts."
220 "*If non-nil, don't add input matching the last on the input ring.
221 This mirrors the optional behavior of bash.
223 This variable is buffer-local."
228 "*If non-nil, name of the file to read/write input history.
229 See also `comint-read-input-ring' and `comint-write-input-ring'.
231 This variable is buffer-local, and is a good thing to set in mode hooks."
233 file)
237 "*Controls whether input to interpreter causes window to scroll.
238 If nil, then do not scroll. If t or `all', scroll all windows showing buffer.
239 If `this', scroll only the selected window.
241 The default is nil.
243 See `comint-preinput-scroll-to-bottom'. This variable is buffer-local."
251 "*Controls whether interpreter output moves point to the end of the output.
252 If nil, then output never moves point to the output.
253 (If the output occurs at point, it is inserted before point.)
254 If t or `all', move point in all windows showing the buffer.
255 If `this', move point only the selected window.
256 If `others', move point only in other windows, not in the selected window.
258 The default is nil.
260 See the variable `comint-scroll-show-maximum-output' and the function
261 `comint-postoutput-scroll-to-bottom'.
262 This variable is buffer-local in all Comint buffers."
273 "*Controls how to scroll due to interpreter output.
274 This variable applies when point is at the end of the buffer
275 \(either because it was originally there, or because
276 `comint-move-point-for-output' said to move it there)
277 and output from the subprocess is inserted.
279 Non-nil means scroll so that the window is full of text
280 and point is on the last line. A value of nil
281 means don't do anything special--scroll normally.
283 See also the variable `comint-move-point-for-output' and the function
284 `comint-postoutput-scroll-to-bottom'.
285 This variable is buffer-local in all Comint buffers."
290 "*The maximum size in lines for Comint buffers.
291 Comint buffers are truncated from the top to be no greater than this number, if
292 the function `comint-truncate-buffer' is on `comint-output-filter-functions'."
306 "*If non-nil, assume that the subprocess echoes any input.
307 If so, delete one copy of the input so that only one copy eventually
308 appears in the buffer.
310 This variable is buffer-local."
314 ;; AIX puts the name of the person being su'd to in front of the prompt.
315 ;; kinit prints a prompt like `Password for devnull@GNU.ORG: '.
316 ;; ksu prints a prompt like `Kerberos password for devnull/root@GNU.ORG: '.
317 ;; ssh-add prints a prompt like `Enter passphrase: '.
318 ;; Some implementations of passwd use "Password (again)" as the 2nd prompt.
325 "*Regexp matching prompts for passwords in the inferior process.
326 This is used by `comint-watch-for-password-prompt'."
330 ;; Here are the per-interpreter hooks.
332 "Function that returns old text in Comint mode.
333 This function is called when return is typed while the point is in old
334 text. It returns the text to be submitted as process input. The
335 default is `comint-get-old-input-default', which either grabs the
336 current input field or grabs the current line and strips off leading
337 text matching `comint-prompt-regexp', depending on the value of
342 "List of functions called to perform completion.
343 Functions should return non-nil if completion was performed.
344 See also `comint-dynamic-complete'.
350 "Predicate for filtering additions to input history.
351 Takes one argument, the input. If non-nil, the input may be saved on the input
355 "Functions to call before input is sent to the process.
356 These functions get one argument, a string containing the text to send.
358 You can use `add-hook' to add functions to this list
362 "Functions to call after output is inserted into the buffer.
363 One possible function is `comint-postoutput-scroll-to-bottom'.
364 These functions get one argument, a string containing the text as originally
365 inserted. Note that this might not be the same as the buffer contents between
366 `comint-last-output-start' and the buffer's `process-mark', if other filter
367 functions have already modified the buffer.
369 See also `comint-preoutput-filter-functions'.
371 You can use `add-hook' to add functions to this list
378 "Function to actually send to PROCESS the STRING submitted by user.
379 Usually this is just `comint-simple-send', but if your mode needs to
380 massage the input string, put a different function here.
381 `comint-simple-send' just sends the string plus a newline.
382 \(If `comint-input-sender-no-newline' is non-nil, it omits the newline.)
386 "*Non-nil means go to the end of the line before sending input.
387 See `comint-send-input'."
391 ;; Note: If it is decided to purge comint-prompt-regexp from the source
392 ;; entirely, searching for uses of this variable will help to identify
393 ;; places that need attention.
395 "*If non-nil, use `comint-prompt-regexp' to distinguish prompts from user-input.
396 If nil, then program output and user-input are given different `field'
397 properties, which emacs commands can use to distinguish them (in
398 particular, common movement commands such as begining-of-line respect
399 field boundaries in a natural way)."
404 "Hook run upon entry to `comint-mode'.
405 This is run before the process is cranked up."
410 "Hook run each time a process is exec'd by `comint-exec'.
411 This is called after the process is cranked up. It is useful for things that
412 must be done each time a process is executed in a Comint mode buffer (e.g.,
413 `(process-kill-without-query)'). In contrast, the `comint-mode-hook' is only
414 executed once when the buffer is created."
420 ;; Fixme: Is this still relevant?
422 "Non-nil if communications via pty; false if by pipe. Buffer local.
434 "Last input ring index which you copied.
438 "Non-nil if you are accumulating input lines to send as input together.
457 "Major mode for interacting with an inferior interpreter.
458 Interpreter name is same as buffer name, sans the asterisks.
459 Return at end of buffer sends line as input.
460 Return not at end copies rest of line to end and sends it.
461 Setting variable `comint-eol-on-send' means jump to the end of the line
462 before submitting new input.
464 This mode is customised to create major modes such as Inferior Lisp
465 mode, Shell mode, etc. This can be done by setting the hooks
466 `comint-input-filter-functions', `comint-input-filter', `comint-input-sender'
467 and `comint-get-old-input' to appropriate functions, and the variable
468 `comint-prompt-regexp' to the appropriate regular expression.
470 An input history is maintained of size `comint-input-ring-size', and
471 can be accessed with the commands \\[comint-next-input], \\[comint-previous-input], and \\[comint-dynamic-list-input-ring].
472 Input ring history expansion can be achieved with the commands
474 Input ring expansion is controlled by the variable `comint-input-autoexpand',
475 and addition is controlled by the variable `comint-input-ignoredups'.
477 Commands with no default key bindings include `send-invisible',
478 `comint-dynamic-complete', `comint-dynamic-list-filename-completions', and
479 `comint-magic-space'.
481 Input to, and output from, the subprocess can cause the window to scroll to
482 the end of the buffer. See variables `comint-output-filter-functions',
483 `comint-preoutput-filter-functions', `comint-scroll-to-bottom-on-input',
484 and `comint-move-point-for-output'.
487 to continue it.
491 Entry to this mode runs the hooks on `comint-mode-hook'."
521 ;; This makes it really work to keep point at the bottom.
531 ;; This behavior is not useful in comint buffers, and is annoying
535 nil
536 ;; Keys:
567 ;; Mouse Buttons:
569 ;; Menu bars:
570 ;; completion:
581 ;; Input history:
622 ;; Signals
637 ;; Put them in the menu bar:
639 menu-bar-final-items))
640 )
643 "Return t if there is a living process associated w/buffer BUFFER.
644 Living means the status is `open', `run', or `stop'.
645 BUFFER can be either a buffer or the name of one."
649 ;;;###autoload
651 "Make a Comint process NAME in BUFFER, running PROGRAM.
652 If BUFFER is nil, it defaults to NAME surrounded by `*'s.
653 PROGRAM should be either a string denoting an executable program to create
654 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
655 connection to be opened via `open-network-stream'. If there is already a
656 running process in that buffer, it is not restarted. Optional third arg
657 STARTFILE is the name of a file to send the contents of to the process.
659 If PROGRAM is a string, any more args are arguments to PROGRAM."
663 ;; If no process, or nuked process, crank up a new one and put buffer in
664 ;; comint mode. Otherwise, leave buffer and existing process alone.
670 buffer)
672 ;;;###autoload
674 "Make a Comint process NAME in a buffer, running PROGRAM.
675 The name of the buffer is made by surrounding NAME with `*'s.
676 PROGRAM should be either a string denoting an executable program to create
677 via `start-process', or a cons pair of the form (HOST . SERVICE) denoting a TCP
678 connection to be opened via `open-network-stream'. If there is already a
679 running process in that buffer, it is not restarted. Optional third arg
680 STARTFILE is the name of a file to send the contents of the process to.
682 If PROGRAM is a string, any more args are arguments to PROGRAM."
685 ;;;###autoload
687 "Run PROGRAM in a Comint buffer and switch to it.
688 The buffer name is made by surrounding the file name of PROGRAM with `*'s.
689 The file name is used to make a symbol name, such as `comint-sh-hook', and any
690 hooks on this symbol are run in the buffer.
691 See `make-comint' and `comint-exec'."
698 "Start up a process named NAME in buffer BUFFER for Comint modes.
699 Runs the given COMMAND with SWITCHES with output to STARTFILE.
700 Blasts any old process running in the buffer. Doesn't set the buffer mode.
701 You can use this to cheaply run a series of processes in the same Comint
702 buffer. The hook `comint-exec-hook' is run after each exec."
706 ;; Crank up a new process
714 ;; Jump to the end, and set the process mark.
717 ;; Feed it the startfile.
719 ;;This is guaranteed to wait long enough
720 ;;but has bad results if the comint does not prompt at all
721 ;; (while (= size (buffer-size))
722 ;; (sleep-for 1))
723 ;;I hope 1 second is enough!
731 buffer)))
733 ;; This auxiliary function cranks up the process for comint-exec in
734 ;; the appropriate environment.
739 ;; If using termcap, we specify `emacs' as the terminal type
740 ;; because that lets us specify a width.
741 ;; If using terminfo, we specify `dumb' because that is
742 ;; a defined terminal type. `emacs' is not a defined terminal type
743 ;; and there is no way for us to define it here.
744 ;; Some programs that use terminfo get very confused
745 ;; if TERM is not a valid terminal type.
746 ;; ;; There is similar code in compile.el.
753 process-environment))
756 default-directory
758 proc decoding encoding changed)
760 ;; If the command has slashes, make sure we
761 ;; first look relative to the current directory.
767 ;; If start-process decided to use some coding system for decoding
768 ;; data sent from the process and the coding system doesn't
769 ;; specify EOL conversion, we had better convert CRLF to LF.
772 changed t))
773 ;; Even if start-process left the coding system for encoding data
774 ;; sent from the process undecided, we had better use the same one
775 ;; as what we use for decoding. But, we should suppress EOL
776 ;; conversion.
779 changed t))
782 proc))
786 "In a Comint buffer, set the current input to the clicked-on previous input."
790 ;; No input at POS, fall back to the global definition.
795 ;; There's previous input at POS, insert it at the end of the buffer.
797 ;; First delete any old unsent input at the end
802 ;; Insert the clicked-upon input
808 \f
809 ;; Input history processing in a buffer
810 ;; ===========================================================================
811 ;; Useful input history functions, courtesy of the Ergo group.
813 ;; Eleven commands:
814 ;; comint-dynamic-list-input-ring List history in help buffer.
815 ;; comint-previous-input Previous input...
816 ;; comint-previous-matching-input ...matching a string.
817 ;; comint-previous-matching-input-from-input ... matching the current input.
818 ;; comint-next-input Next input...
819 ;; comint-next-matching-input ...matching a string.
820 ;; comint-next-matching-input-from-input ... matching the current input.
821 ;; comint-backward-matching-input Backwards input...
822 ;; comint-forward-matching-input ...matching a string.
823 ;; comint-replace-by-expanded-history Expand history at point;
824 ;; replace with expanded history.
825 ;; comint-magic-space Expand history and insert space.
826 ;;
827 ;; Three functions:
828 ;; comint-read-input-ring Read into comint-input-ring...
829 ;; comint-write-input-ring Write to comint-input-ring-file-name.
830 ;; comint-replace-by-expanded-history-before-point Workhorse function.
833 "Set the buffer's `comint-input-ring' from a history file.
834 The name of the file is given by the variable `comint-input-ring-file-name'.
835 The history ring is of size `comint-input-ring-size', regardless of file size.
836 If `comint-input-ring-file-name' is nil this function does nothing.
838 If the optional argument SILENT is non-nil, we say nothing about a
839 failure to read the history file.
841 This function is useful for major mode commands and mode hooks.
843 The commands stored in the history file are separated by the
844 `comint-input-ring-separator', and entries that match
845 `comint-input-history-ignore' are ignored. The most recent command
846 comes last.
848 See also `comint-input-ignoredups' and `comint-write-input-ring'."
851 nil)
855 comint-input-ring-file-name)))
868 ;; Save restriction in case file is already visited...
869 ;; Watch for those date stamps in history files!
889 comint-input-ring-index nil)))))
892 "Writes the buffer's `comint-input-ring' to a history file.
893 The name of the file is given by the variable `comint-input-ring-file-name'.
894 The original contents of the file are lost if `comint-input-ring' is not empty.
895 If `comint-input-ring-file-name' is nil this function does nothing.
897 Useful within process sentinels.
899 See also `comint-read-input-ring'."
903 nil)
911 ;; Write it all out into a buffer first. Much faster, but messier,
912 ;; than writing it one line at a time.
926 "Choose the input history entry that point is in or next to."
943 "List in help buffer the buffer's input history."
952 ;; We have to build up a list ourselves from the ring vector.
956 ;; Change "completion" to "history reference"
957 ;; to make the display accurate.
978 "Return list of regexp and prefix arg using PROMPT."
986 regexp)
990 ;; First make sure there is a ring and that we are after the process mark
997 ;; arg of zero resets search from beginning, and uses arg of 1
1001 arg)))
1004 "Index to start a directional search, starting at `comint-input-ring-index'."
1006 ;; If a search is running, offset by 1 in direction of arg
1009 ;; For a new search, start from beginning or end, as appropriate
1015 "Return the string ARG places along the input ring.
1016 Moves relative to `comint-input-ring-index'."
1020 arg)))
1023 "Cycle backwards through input history."
1028 "Cycle forwards through input history."
1033 "Return the string matching REGEXP ARG places along the input ring.
1034 Moves relative to `comint-input-ring-index'."
1039 "Return the index matching REGEXP ARG places along the input ring.
1040 Moves relative to START, or `comint-input-ring-index'."
1049 ;; Do the whole search as many times as the argument says.
1051 ;; Step once.
1054 ;; If we haven't reached a match, step some more.
1058 ;; If we have gone all the way around in this search.
1061 ;; Now that we know which ring element to use, if we found it, return that.
1063 n)))
1066 "Search backwards through input history for match for REGEXP.
1067 \(Previous history elements are earlier commands.)
1068 With prefix argument N, search for Nth previous match.
1069 If N is negative, find the next or Nth next match."
1073 ;; Has a match been found?
1079 ;; Can't use kill-region as it sets this-command
1086 "Search forwards through input history for match for REGEXP.
1087 \(Later history elements are more recent commands.)
1088 With prefix argument N, search for Nth following match.
1089 If N is negative, find the previous or Nth previous match."
1094 "Search backwards through input history for match for current input.
1095 \(Previous history elements are earlier commands.)
1096 With prefix argument N, search for Nth previous match.
1097 If N is negative, search forwards for the -Nth following match."
1100 comint-next-matching-input-from-input)))
1101 ;; Starting a new search
1107 comint-input-ring-index nil))
1110 arg))
1113 "Search forwards through input history for match for current input.
1114 \(Following history elements are more recent commands.)
1115 With prefix argument N, search for Nth following match.
1116 If N is negative, search backwards for the -Nth previous match."
1122 "Expand input command history references before point.
1123 Expansion is dependent on the value of `comint-input-autoexpand'.
1125 This function depends on the buffer's idea of the input history, which may not
1126 match the command interpreter's idea, assuming it has one.
1128 Assumes history syntax is like typical Un*x shells'. However, since Emacs
1129 cannot know the interpreter's idea of input line numbers, assuming it has one,
1130 it cannot expand absolute input line number references.
1132 If the optional argument SILENT is non-nil, never complain
1133 even if history reference seems erroneous.
1135 If the optional argument START is non-nil, that specifies the
1136 start of the text to scan for history references, rather
1137 than the logical beginning of line.
1139 See `comint-magic-space' and `comint-replace-by-expanded-history-before-point'.
1141 Returns t if successful."
1145 ;; Use comint-prompt-regexp
1149 ;; Use input fields. User input that hasn't been entered
1150 ;; yet, at the end of the buffer, has a nil `field' property.
1153 ;; Looks like there might be history references in the command.
1160 "Expand directory stack reference before point.
1161 See `comint-replace-by-expanded-history'. Returns t if successful.
1163 If the optional argument START is non-nil, that specifies the
1164 start of the text to scan for history references, rather
1165 than the logical beginning of line."
1173 ;; This seems a bit complex. We look for references such as !!, !-num,
1174 ;; !foo, !?foo, !{bar}, !?{bar}, ^oh, ^my^, ^god^it, ^never^ends^.
1175 ;; If that wasn't enough, the plings can be suffixed with argument
1176 ;; range specifiers.
1177 ;; Argument ranges are complex too, so we hive off the input line,
1178 ;; referenced with plings, with the range string to `comint-args'.
1182 ;; The history is quoted, or we're in quotes.
1185 ;; We cannot know the interpreter's idea of input line numbers.
1189 ;; Just a number of args from `number' lines backward.
1198 t t)
1204 ;; Just a number of args from the previous input line.
1208 t t)
1212 ;; Most recent input starting with or containing (possibly
1213 ;; protected) string, maybe just a number of args. Phew.
1231 t t)
1234 ;; Quick substitution on the previous input line.
1251 "Expand input history references before point and insert ARG spaces.
1252 A useful command to bind to SPC. See `comint-replace-by-expanded-history'."
1256 \f
1258 "Return t if the number of quotes between BEG and END is odd.
1259 Quotes are single and double."
1265 "Return number of matches for REGEXP from BEG to END."
1272 count))
1275 ;; From STRING, return the args depending on the range specified in the text
1276 ;; from BEGIN to END. If BEGIN is nil, assume all args. Ignore leading `:'.
1277 ;; Range can be x-y, x-, -y, where x/y can be [0-9], *, ^, $.
1294 "Return a list of arguments from ARG.
1295 Break it up at the delimiters in `comint-delimiter-argument-list'.
1296 Returned list is backwards."
1310 comint-delimiter-argument-list)))
1313 args)))
1316 "Return from STRING the NTH to MTH arguments.
1317 NTH and/or MTH can be nil, which means the last argument.
1318 Returned arguments are separated by single spaces.
1319 We assume whitespace separates arguments, except within quotes
1320 and except for a space or tab that immediately follows a backslash.
1321 Also, a run of one or more of a single character
1322 in `comint-delimiter-argument-list' is a separate argument.
1323 Argument 0 is the command name."
1324 ;; The first line handles ordinary characters and backslash-sequences
1325 ;; (except with w32 msdos-like shells, where backslashes are valid).
1326 ;; The second matches "-quoted strings.
1327 ;; The third matches '-quoted strings.
1328 ;; The fourth matches `-quoted strings.
1329 ;; This seems to fit the syntax of BASH 2.0.
1340 beg str quotes)
1341 ;; Build a list of all the args until we have as many as we want.
1345 ;; It's contiguous, part of the same arg.
1348 ;; It's a new separate arg.
1350 ;; Put the previous arg, if there was one, onto ARGS.
1367 \f
1368 ;;
1369 ;; Input processing stuff
1370 ;;
1372 "Add CMD to the input history.
1373 Ignore duplicates if `comint-input-ignoredups' is non-nil."
1379 cmd))))
1383 "Send input to process.
1384 After the process output mark, sends all text from the process mark to
1385 point as input to the process. Before the process output mark, calls
1386 value of variable `comint-get-old-input' to retrieve old input, copies
1387 it to the process mark, and sends it. A terminal newline is also
1388 inserted into the buffer and sent to the process unless NO-NEWLINE is
1389 non-nil.
1391 Any history reference may be expanded depending on the value of the variable
1392 `comint-input-autoexpand'. The list of function names contained in the value
1393 of `comint-input-filter-functions' is called on the input before sending it.
1394 The input is entered into the input history ring, if the value of variable
1395 `comint-input-filter' returns non-nil when called on the input.
1397 If variable `comint-eol-on-send' is non-nil, then point is moved to the
1398 end of line before sending the input.
1400 After the input has been sent, if `comint-process-echoes' is non-nil,
1401 then `comint-send-input' waits to see if the process outputs a string
1402 matching the input, and if so, deletes that part of the output.
1404 The values of `comint-get-old-input', `comint-input-filter-functions', and
1405 `comint-input-filter' are chosen according to the command interpreter running
1406 in the buffer. E.g.,
1408 If the interpreter is the csh,
1409 `comint-get-old-input' is the default:
1410 If `comint-use-prompt-regexp-instead-of-fields' is nil, then
1411 either return the current input field, if point is on an input
1412 field, or the current line, if point is on an output field.
1413 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then
1414 return the current line with any initial string matching the
1415 regexp `comint-prompt-regexp' removed.
1418 comint-input-filter is the default: returns t if the input isn't all white
1419 space.
1421 If the Comint is Lucid Common Lisp,
1422 comint-get-old-input snarfs the sexp ending at point.
1423 comint-input-filter-functions does nothing.
1424 comint-input-filter returns nil if the input matches input-filter-regexp,
1425 which matches (1) all whitespace (2) :a, :c, etc.
1427 Similarly for Soar, Scheme, etc."
1429 ;; Note that the input string does not include its terminal newline.
1439 copy)))
1441 ;; Just whatever's already there
1442 intxt
1443 ;; Expand and leave it visible in buffer
1447 input
1448 ;; This is messy 'cos ultimately the original
1449 ;; functions used do insertion, rather than return
1450 ;; strings. We have to expand, then insert back.
1456 copy))))
1470 ;; Set text-properties for the input field
1472 beg end
1474 font-lock-face comint-highlight-input
1475 mouse-face highlight
1478 ;; Give old user input a field property of `input', to
1479 ;; distinguish it from both process output and unsent
1480 ;; input. The terminating newline is put into a special
1481 ;; `boundary' field to make cursor movement between input
1482 ;; and output fields smoother.
1485 ;; Cover the terminating newline
1488 field boundary
1489 inhibit-line-move-field-capture t))))
1495 ;; Update the markers before we send the input
1496 ;; in case we get output amidst sending the input.
1500 ;; clear the "accumulation" marker
1505 ;; Optionally delete echoed input (after checking it).
1508 comint-last-input-start)))
1509 ;; Wait for all input to be echoed:
1515 nil comint-last-input-start
1517 ;; Above difference is equivalent to
1518 ;; (+ comint-last-input-start
1519 ;; (- (point-max) comint-last-input-end))
1526 nil comint-last-input-start comint-last-input-end
1527 nil comint-last-input-end
1532 ;; This used to call comint-output-filter-functions,
1533 ;; but that scrolled the buffer in undesirable ways.
1537 "List of functions to call before inserting Comint output into the buffer.
1538 Each function gets one argument, a string containing the text received
1539 from the subprocess. It should return the string to insert, perhaps
1540 the same string that was received, or perhaps a modified or transformed
1541 string.
1543 The functions on the list are called sequentially, and each one is
1544 given the string returned by the previous one. The string returned by
1545 the last function is the text that is actually inserted in the
1546 redirection buffer.
1548 You can use `add-hook' to add functions to this list
1552 "If nil, Comint will interpret `carriage control' characters in output.
1555 ;; When non-nil, this is an overlay over the last recognized prompt in
1556 ;; the buffer; it is used when highlighting the prompt.
1560 "`snapshot' any current `comint-last-prompt-overlay'.
1561 freeze its attributes in place, even when more input comes a long
1562 and moves the prompt overlay."
1570 "Interpret carriage control characters in the region from START to END.
1571 Translate carriage return/linefeed sequences to linefeeds.
1572 Make single carriage returns delete to the beginning of the line.
1573 Make backspaces delete the previous character."
1575 ;; First do a quick check to see if there are any applicable
1576 ;; characters, so we can avoid calling save-match-data and
1577 ;; save-restriction if not.
1585 ;; CR LF -> LF
1586 ;; Note that this won't work properly when the CR and LF
1587 ;; are in different output chunks, but this is probably an
1588 ;; exceedingly rare case (because they are generally
1589 ;; written as a unit), and to delay interpretation of a
1590 ;; trailing CR in a chunk would result in odd interactive
1591 ;; behavior (and this case is probably far more common).
1594 ;; bare CR -> delete preceding line
1598 ;; BS -> delete preceding character
1603 ;; The purpose of using this filter for comint processes
1604 ;; is to keep comint-last-input-end from moving forward
1605 ;; when output is inserted.
1608 ;; First check for killed buffer or no input.
1611 ;; Run preoutput filters
1622 ;; Insert STRING
1624 ;; Avoid the overhead of save-excursion, since we just
1625 ;; fiddle with the point
1628 ;; The point should float after any insertion we do
1631 ;; We temporarly remove any buffer narrowing, in case the
1632 ;; process mark is outside of the restriction
1639 ;; insert-before-markers is a bad thing. XXX
1640 ;;
1641 ;; It is used here to force window-point markers (used to
1642 ;; store the value of point in non-selected windows) to
1643 ;; advance, but it also screws up any other markers that we
1644 ;; don't _want_ to advance, such as the start-marker of some
1645 ;; of the overlays we create.
1646 ;;
1647 ;; We work around the problem with the overlays by
1648 ;; explicitly adjusting them after we do the insertion, but
1649 ;; in the future this problem should be solved correctly, by
1650 ;; using `insert', and making the insertion-type of
1651 ;; window-point markers settable (via a buffer-local
1652 ;; variable). In comint buffers, this variable would be set
1653 ;; to `t', to cause point in non-select windows to advance.
1655 ;; Fixup markers and overlays that got screwed up because we
1656 ;; used `insert-before-markers'.
1658 ;; comint-last-output-start
1660 ;; comint-last-input-end
1665 ;; No overlays we create are set to advance upon insertion
1666 ;; (at the start/end), so we assume that any overlay which
1667 ;; is at the current point was incorrectly advanced by
1668 ;; insert-before-markers. First fixup overlays that might
1669 ;; start at point:
1674 old-point
1676 ;; Then do overlays that might end at point:
1681 old-point))))
1683 ;; Advance process-mark
1687 ;; Interpret any carriage motion characters (newline, backspace)
1698 field output
1699 inhibit-line-move-field-capture t))))
1701 ;; Highlight the prompt, where we define `prompt' to mean
1702 ;; the most recent output that doesn't end with a newline.
1714 ;; Need to create or move the prompt overlay (in the case
1715 ;; where there is no prompt ((bolp) == t), we still do
1716 ;; this if there's already an existing overlay).
1718 ;; Just move an existing overlay
1721 ;; Need to create the overlay
1730 "Go to the end of buffer in all windows showing it.
1731 Movement occurs if point in the selected window is not after the process mark,
1732 and `this-command' is an insertion command. Insertion commands recognised
1733 are `self-insert-command', `comint-magic-space', `yank', and `hilit-yank'.
1734 Depends on the value of `comint-scroll-to-bottom-on-input'.
1736 This function should be a pre-command hook."
1739 hilit-yank)))
1755 nil t))))))
1758 "Go to the end of buffer in some or all windows showing it.
1759 Does not scroll if the current line is the last line in the buffer.
1760 Depends on the value of `comint-move-point-for-output' and
1761 `comint-scroll-show-maximum-output'.
1763 This function should be in the list `comint-output-filter-functions'."
1777 ;; Maybe user wants point to jump to end.
1780 ;; If point was at the end, keep it at end.
1784 ;; Optionally scroll so that the text
1785 ;; ends at the bottom of the window.
1792 nil t))
1796 "Truncate the buffer to `comint-buffer-maximum-size'.
1797 This function could be on `comint-output-filter-functions' or bound to a key."
1807 "Strip trailing `^M' characters from the current output group.
1808 This function could be on `comint-output-filter-functions' or bound to a key."
1821 "Put the end of the buffer at the bottom of the window."
1827 "Default for `comint-get-old-input'.
1828 If `comint-use-prompt-regexp-instead-of-fields' is nil, then either
1829 return the current input field, if point is on an input field, or the
1830 current line, if point is on an output field.
1831 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then return
1832 the current line with any initial string matching the regexp
1833 `comint-prompt-regexp' removed."
1841 "Insert after prompt old input at point as new input to be edited.
1842 Calls `comint-get-old-input' to get old input."
1852 "Skip past the text matching regexp `comint-prompt-regexp'.
1853 If this takes us past the end of the current line, don't skip at all."
1859 "Return t if point is after the process output marker."
1864 "Default function for sending to PROC input STRING.
1865 This just sends STRING plus a newline. To override this,
1866 set the hook `comint-input-sender'."
1874 "Return the buffer position of the beginning of the line, after any prompt.
1875 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1876 prompt skip is done by skipping text matching the regular expression
1877 `comint-prompt-regexp', a buffer local variable."
1879 ;; Use comint-prompt-regexp
1884 ;; Use input fields. Note that, unlike the behavior of
1885 ;; `line-beginning-position' inside a field, this function will
1886 ;; return the position of the end of a prompt, even if the point is
1887 ;; already inside the prompt. In order to do this, it assumes that
1888 ;; if there are two fields on a line, then the first one is the
1889 ;; prompt, and the second one is an input field, and is front-sticky
1890 ;; (as input fields should be).
1894 "Go to the beginning of line, then skip past the prompt, if any.
1896 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then the
1897 prompt skip is done by skipping text matching the regular expression
1898 `comint-prompt-regexp', a buffer local variable."
1901 ;; Unlike `beginning-of-line', forward-line ignores field boundaries
1905 ;; These three functions are for entering text you don't want echoed or
1906 ;; saved -- typically passwords to ftp, telnet, or somesuch.
1907 ;; Just enter m-x send-invisible and type in your line, or add
1908 ;; `comint-watch-for-password-prompt' to `comint-output-filter-functions'.
1911 "Read a single line of text from user without echoing, and return it.
1912 Prompt with argument PROMPT, a string. Optional argument STARS causes
1913 input to be echoed with '*' characters on the prompt line. Input ends with
1914 RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if
1915 `inhibit-quit' is set because e.g. this function was called from a process
1916 filter and C-g is pressed, this function returns nil rather than a string).
1918 Note that the keystrokes comprising the text can still be recovered
1920 however, `clear-this-command-keys').
1921 Once the caller uses the password, it can erase the password
1922 by doing (clear-string STRING)."
1934 ;; Use this instead of `read-char' to avoid "Non-character input-event".
1937 ;; This function may get called from a process filter, where
1938 ;; inhibit-quit is set. In later versions of emacs read-char
1939 ;; may clear quit-flag itself and return C-g. That would make
1940 ;; it impossible to quit this loop in a simple way, so
1941 ;; re-enable it here (for backward-compatibility the check for
1942 ;; quit-flag below would still be necessary, so this seems
1943 ;; like the simplest way to do things).
1945 done t))
1959 ;; Emulate a true quit, except that we have to return a value.
1965 ans)))
1968 "Read a string without echoing.
1969 Then send it to the process running in the current buffer.
1970 The string is sent using `comint-input-sender'.
1971 Security bug: your string can still be temporarily recovered with
1985 "Prompt in the minibuffer for password and send without echoing.
1986 This function uses `send-invisible' to read and send a password to the buffer's
1987 process if STRING contains a password prompt defined by
1988 `comint-password-prompt-regexp'.
1990 This function could be in the list `comint-output-filter-functions'."
1995 \f
1996 ;; Low-level process communication
1999 "Like `process-send-string', but also does extra bookkeeping for Comint mode."
2009 "Like `process-send-region', but also does extra bookkeeping for Comint mode."
2018 \f
2019 ;; Random input hackage
2022 "Delete all output from interpreter since last input.
2023 Does not delete the prompt."
2037 ;; Output message and put back prompt
2043 "Write output from interpreter since last input to FILENAME.
2044 Any prompt at the end of the output is not written.
2046 If the optional argument APPEND (the prefix argument when interactive)
2047 is non-nil, the output is appended to the file instead.
2049 If the optional argument MUSTBENEW is non-nil, check for an existing
2050 file with the same name. If MUSTBENEW is `excl', that means to get an
2051 error if the file already exists; never overwrite. If MUSTBENEW is
2052 neither nil nor `excl', that means ask for confirmation before
2053 overwriting, but do go ahead and overwrite the file if the user
2054 confirms. When interactive, MUSTBENEW is nil when appending, and t
2055 otherwise."
2059 "Append output to file: "
2061 current-prefix-arg
2067 append nil nil mustbenew)))
2069 ;; This function exists for the benefit of the menu; from the keyboard,
2070 ;; users can just use `comint-write-output' with a prefix arg.
2072 "Append output from interpreter since last input to FILENAME.
2073 Any prompt at the end of the output is not written."
2078 "Display start of this batch of interpreter output at top of window.
2079 Sets mark to the value of point when this command is run."
2094 "Interrupt the current subjob.
2095 This command also kills the pending input
2096 between the process mark and point."
2100 ;; (process-send-string nil "\n")
2101 )
2104 "Send kill signal to the current subjob.
2105 This command also kills the pending input
2106 between the process mark and point."
2112 "Send quit signal to the current subjob.
2113 This command also kills the pending input
2114 between the process mark and point."
2120 "Stop the current subjob.
2121 This command also kills the pending input
2122 between the process mark and point.
2124 WARNING: if there is no current subjob, you can end up suspending
2125 the top-level process running in the buffer. If you accidentally do
2127 is not a problem with most shells, since they ignore this signal.)"
2133 "Send CONT signal to process buffer's process group.
2134 Useful if you accidentally suspend the top-level process."
2139 "Skip all pending input, from last stuff output by interpreter to point.
2140 This means mark it as if it had been sent as input, without sending it."
2152 "Kill all text from last stuff output by interpreter to point."
2159 "Delete ARG characters forward or send an EOF to subprocess.
2160 Sends an EOF only if point is at the end of the buffer and there is no input."
2168 "Send an EOF to the current buffer's process."
2175 "Search backward through buffer for input fields that match REGEXP.
2176 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2177 fields are identified by lines that match `comint-prompt-regexp'.
2179 With prefix argument N, search for Nth previous match.
2180 If N is negative, find the next or Nth next match."
2183 ;; Use comint-prompt-regexp
2193 ;; Use input fields
2207 "Search forward through buffer for input fields that match REGEXP.
2208 If `comint-use-prompt-regexp-instead-of-fields' is non-nil, then input
2209 fields are identified by lines that match `comint-prompt-regexp'.
2211 With prefix argument N, search for Nth following match.
2212 If N is negative, find the previous or Nth previous match."
2218 "Move to end of Nth next prompt in the buffer.
2219 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2220 the beginning of the Nth next `input' field, otherwise, it means the Nth
2221 occurrence of text matching `comint-prompt-regexp'."
2224 ;; Use comint-prompt-regexp
2229 ;; Use input fields
2232 prev-pos)
2240 ;; Ran off the end of the buffer.
2242 ;; There's always an input field at the end of the
2243 ;; buffer, but it has a `field' property of nil.
2245 ;; stop iterating
2255 "Move to end of Nth previous prompt in the buffer.
2256 If `comint-use-prompt-regexp-instead-of-fields' is nil, then this means
2257 the beginning of the Nth previous `input' field, otherwise, it means the Nth
2258 occurrence of text matching `comint-prompt-regexp'."
2262 ;; State used by `comint-insert-previous-argument' when cycling.
2268 ;; Needs fixing:
2269 ;; make comint-arguments understand negative indices as bash does
2271 "Insert the INDEXth argument from the previous Comint command-line at point.
2272 Spaces are added at beginning and/or end of the inserted string if
2273 necessary to ensure that it's separated from adjacent arguments.
2274 Interactively, if no prefix argument is given, the last argument is inserted.
2275 Repeated interactive invocations will cycle through the same argument
2276 from progressively earlier commands (using the value of INDEX specified
2277 with the first command).
2278 This command is like `M-.' in bash."
2283 ;; Delete last input inserted by this command.
2287 ;; This is a non-repeat invocation, so initialize state.
2291 ;; First usage; initialize to a marker
2294 ;; Make sure we're not in the prompt, and add a beginning space if necess.
2298 ;; Remember the beginning of what we insert, so we can delete it if
2299 ;; the command is repeated.
2301 ;; Insert the argument.
2304 ;; strip terminating '&'
2307 ;; Make next invocation return arg from previous input
2309 ;; Add a terminating space if necessary.
2313 \f
2314 ;; Support for source-file processing commands.
2315 ;;============================================================================
2316 ;; Many command-interpreters (e.g., Lisp, Scheme, Soar) have
2317 ;; commands that process files of source text (e.g. loading or compiling
2318 ;; files). So the corresponding process-in-a-buffer modes have commands
2319 ;; for doing this (e.g., lisp-load-file). The functions below are useful
2320 ;; for defining these commands.
2321 ;;
2322 ;; Alas, these guys don't do exactly the right thing for Lisp, Scheme
2323 ;; and Soar, in that they don't know anything about file extensions.
2324 ;; So the compile/load interface gets the wrong default occasionally.
2325 ;; The load-file/compile-file default mechanism could be smarter -- it
2326 ;; doesn't know about the relationship between filename extensions and
2327 ;; whether the file is source or executable. If you compile foo.lisp
2328 ;; with compile-file, then the next load-file should use foo.bin for
2329 ;; the default, not foo.lisp. This is tricky to do right, particularly
2330 ;; because the extension for executable files varies so much (.o, .bin,
2331 ;; .lbin, .mo, .vo, .ao, ...).
2334 ;; COMINT-SOURCE-DEFAULT -- determines defaults for source-file processing
2335 ;; commands.
2336 ;;
2337 ;; COMINT-CHECK-SOURCE -- if FNAME is in a modified buffer, asks you if you
2338 ;; want to save the buffer before issuing any process requests to the command
2339 ;; interpreter.
2340 ;;
2341 ;; COMINT-GET-SOURCE -- used by the source-file processing commands to prompt
2342 ;; for the file to process.
2345 "Compute the defaults for `load-file' and `compile-file' commands.
2347 PREVIOUS-DIR/FILE is a pair (directory . filename) from the last
2348 source-file processing command. nil if there hasn't been one yet.
2349 SOURCE-MODES is a list used to determine what buffers contain source
2350 files: if the major mode of the buffer is in SOURCE-MODES, it's source.
2351 Typically, (lisp-mode) or (scheme-mode).
2353 If the command is given while the cursor is inside a string, *and*
2354 the string is an existing filename, *and* the filename is not a directory,
2355 then the string is taken as default. This allows you to just position
2356 your cursor over a string that's a filename and have it taken as default.
2358 If the command is given in a file buffer whose major mode is in
2359 SOURCE-MODES, then the filename is the default file, and the
2360 file's directory is the default directory.
2362 If the buffer isn't a source file buffer (e.g., it's the process buffer),
2363 then the default directory & file are what was used in the last source-file
2364 processing command (i.e., PREVIOUS-DIR/FILE). If this is the first time
2365 the command has been run (PREVIOUS-DIR/FILE is nil), the default directory
2368 SOURCE-REGEXP is typically going to be something like (tea-mode)
2369 for T programs, (lisp-mode) for Lisp programs, (soar-mode lisp-mode)
2370 for Soar programs, etc.
2372 The function returns a pair: (default-directory . default-file)."
2382 "Check whether to save buffers visiting file FNAME.
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."
2392 ;; save BUFF.
2399 "Return string around POINT, or nil."
2410 "Prompt for filenames in commands that process source files,
2411 e.g. loading or compiling a file.
2412 Provides a default, if there is one, and returns the result filename.
2414 See `comint-source-default' for more on determining defaults.
2416 PROMPT is the prompt string. PREV-DIR/FILE is the (directory . file) pair
2417 from the last source processing command. SOURCE-MODES is a list of major
2418 modes used to determine what file buffers contain source files. (These
2419 two arguments are used for determining defaults). If MUSTMATCH-P is true,
2420 then the filename reader will only accept a file that exists.
2422 A typical use:
2424 '(lisp-mode) t))"
2437 prompt deffile)
2438 prompt)
2439 defdir
2441 mustmatch-p)))
2444 ;; I am somewhat divided on this string-default feature. It seems
2445 ;; to violate the principle-of-least-astonishment, in that it makes
2446 ;; the default harder to predict, so you actually have to look and see
2447 ;; what the default really is before choosing it. This can trip you up.
2448 ;; On the other hand, it can be useful, I guess. I would appreciate feedback
2449 ;; on this.
2450 ;; -Olin
2452 \f
2453 ;; Simple process query facility.
2454 ;; ===========================================================================
2455 ;; This function is for commands that want to send a query to the process
2456 ;; and show the response to the user. For example, a command to get the
2457 ;; arglist for a Common Lisp function might send a "(arglist 'foo)" query
2458 ;; to an inferior Common Lisp process.
2459 ;;
2460 ;; This simple facility just sends strings to the inferior process and pops
2461 ;; up a window for the process buffer so you can see what the process
2462 ;; responds with. We don't do anything fancy like try to intercept what the
2463 ;; process responds with and put it in a pop-up window or on the message
2464 ;; line. We just display the buffer. Low tech. Simple. Works good.
2467 "Send to the inferior process PROC the string STR.
2468 Pop-up but do not select a window for the inferior process so that
2469 its response can be seen."
2478 ;; Try to position the proc window so you can see the answer.
2479 ;; This is bogus code. If you delete the (sit-for 0), it breaks.
2480 ;; I don't know why. Wizards invited to improve it.
2489 \f
2490 ;; Filename/command/history completion in a buffer
2491 ;; ===========================================================================
2492 ;; Useful completion functions, courtesy of the Ergo group.
2494 ;; Six commands:
2495 ;; comint-dynamic-complete Complete or expand command, filename,
2496 ;; history at point.
2497 ;; comint-dynamic-complete-filename Complete filename at point.
2498 ;; comint-dynamic-list-filename-completions List completions in help buffer.
2499 ;; comint-replace-by-expanded-filename Expand and complete filename at point;
2500 ;; replace with expanded/completed name.
2501 ;; comint-dynamic-simple-complete Complete stub given candidates.
2503 ;; These are not installed in the comint-mode keymap. But they are
2504 ;; available for people who want them. Shell-mode installs them:
2505 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
2506 ;; (define-key shell-mode-map "\M-?"
2507 ;; 'comint-dynamic-list-filename-completions)))
2508 ;;
2509 ;; Commands like this are fine things to put in load hooks if you
2510 ;; want them present in specific modes.
2513 "*If non-nil, automatically list possibilities on partial completion.
2514 This mirrors the optional behavior of tcsh."
2519 "*If non-nil, add a `/' to completed directories, ` ' to file names.
2520 If a cons pair, it should be of the form (DIRSUFFIX . FILESUFFIX) where
2521 DIRSUFFIX and FILESUFFIX are strings added on unambiguous or exact completion.
2522 This mirrors the optional behavior of tcsh."
2531 "*If non-nil, use shortest completion if characters cannot be added.
2532 This mirrors the optional behavior of tcsh.
2534 A non-nil value is useful if `comint-completion-autolist' is non-nil too."
2539 "*List of suffixes to be disregarded during file completion.
2540 This mirrors the optional behavior of bash and tcsh.
2542 Note that this applies to `comint-dynamic-complete-filename' only."
2547 "Prefix prepended to absolute file names taken from process input.
2548 This is used by Comint's and shell's completion functions, and by shell's
2553 "~/A-Za-z0-9_^$!#%&{}@`'.,:()-"
2555 "String of characters valid in a file name.
2556 Note that all non-ASCII characters are considered valid in a file name
2557 regardless of what this variable says.
2568 "Return expanded DIRECTORY, with `comint-file-name-prefix' if absolute."
2571 directory)))
2575 "Return the word of WORD-CHARS at point, or nil if none is found.
2576 Word constituents are considered to be those in WORD-CHARS, which is like the
2578 plus all non-ASCII characters."
2581 giveup)
2585 ;; Fixme: This isn't consistent with Bash, at least -- not
2586 ;; all non-ASCII chars should be word constituents.
2595 ;; Set match-data to match the entire string.
2601 "Return FILENAME with environment variables substituted.
2602 Supports additional environment variable syntax of the command
2603 interpreter (e.g., the percent notation of cmd.exe on NT)."
2607 env-var-val)
2616 name))
2619 "Return the filename at point, or nil if non is found.
2620 Environment variables are substituted. See `comint-word'."
2627 "Return FILENAME with magic characters quoted.
2628 Magic characters are those in `comint-file-name-quote-list'."
2630 filename
2639 filename))))
2642 "Return FILENAME with quoted characters unquoted."
2644 filename
2650 filename)))
2654 "Dynamically perform completion at point.
2655 Calls the functions in `comint-dynamic-complete-functions' to perform
2656 completion until a function returns non-nil, at which point completion is
2657 assumed to have occurred."
2663 "Dynamically complete the filename at point.
2664 Completes if after a filename. See `comint-match-partial-filename' and
2665 `comint-dynamic-complete-as-filename'.
2666 This function is similar to `comint-replace-by-expanded-filename', except that
2667 it won't change parts of the filename already entered in the buffer; it just
2668 adds completion characters to the end of the filename. A completions listing
2669 may be shown in a help buffer if completion is ambiguous.
2671 Completion is dependent on the value of `comint-completion-addsuffix',
2672 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
2673 completions listing is dependent on the value of `comint-completion-autolist'.
2675 Returns t if successful."
2683 "Dynamically complete at point as a filename.
2684 See `comint-dynamic-complete-filename'. Returns t if successful."
2687 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2688 ;; I think it was originally bound to solve file completion problems,
2689 ;; but subsequent changes may have made this unnecessary. sm.
2690 ;;(file-name-handler-alist nil)
2725 ;; We inserted a unique completion.
2732 ;; It's not unique, but user wants shortest match.
2738 ;; It's not unique, list possible completions.
2743 success))
2747 "Dynamically expand and complete the filename at point.
2748 Replace the filename with an expanded, canonicalised and completed replacement.
2751 removed, and the filename is made absolute instead of relative. For expansion
2752 see `expand-file-name' and `substitute-in-file-name'. For completion see
2753 `comint-dynamic-complete-filename'."
2762 "Dynamically complete STUB from CANDIDATES list.
2763 This function inserts completion characters at point by completing STUB from
2764 the strings in CANDIDATES. A completions listing may be shown in a help buffer
2765 if completion is ambiguous.
2767 Returns nil if no completion was inserted.
2768 Returns `sole' if completed with the only completion match.
2769 Returns `shortest' if completed with the shortest of the completion matches.
2770 Returns `partial' if completed as far as possible with the completion matches.
2771 Returns `listed' if a completion listing was shown.
2773 See also `comint-dynamic-complete-filename'."
2781 nil)
2792 ;; Insert the longest substring.
2797 ;; It's not unique, but user wants shortest match.
2803 ;; It's not unique, list possible completions.
2812 "List in help buffer possible completions of the filename at point."
2815 ;; If we bind this, it breaks remote directory tracking in rlogin.el.
2816 ;; I think it was originally bound to solve file completion problems,
2817 ;; but subsequent changes may have made this unnecessary. sm.
2818 ;;(file-name-handler-alist nil)
2830 ;; This is bound locally in a *Completions* buffer to the list of
2831 ;; completions displayed, and is used to detect the case where the same
2832 ;; command is repeatedly used without the set of completions changing.
2838 "List in help buffer sorted COMPLETIONS.
2839 Typing SPC flushes the help buffer."
2845 ;; The above tests are not sufficient to detect the case where we
2846 ;; should scroll, because the top-level interactive command may
2847 ;; not have displayed a completions window the last time it was
2848 ;; invoked, and there may be such a window left over from a
2849 ;; previous completion command with a different set of
2850 ;; completions. To detect that case, we also test that the set
2851 ;; of displayed completions is in fact the same as the previously
2852 ;; displayed set.
2856 ;; If this command was repeated, and
2857 ;; there's a fresh completion window with a live buffer,
2858 ;; and this command is repeated, scroll that window.
2866 ;; Display a completion list for the first time.
2873 ;; Read the next key, to process SPC.
2879 completions)
2886 ;; If the user does mouse-choose-completion with the mouse,
2887 ;; execute the command, then delete the completion window.
2896 \f
2898 "After fetching a line from input history, this fetches the following line.
2899 In other words, this recalls the input line after the line you recalled last.
2900 You can use this to repeat a sequence of input lines."
2909 "Accumulate a line to send as input along with more lines.
2910 This inserts a newline so that you can enter more text
2912 to send all the accumulated input, at once.
2913 The entire accumulated text becomes one item in the input history
2914 when you send it."
2923 "Move point to the process mark.
2924 The process mark separates output, and input already sent,
2925 from input that has not yet been sent."
2934 "Move point to beginning of line (after prompt) or to the process mark.
2935 The first time you use this command, it moves to the beginning of the line
2936 \(but after the prompt, if any). If you repeat it again immediately,
2937 it moves point to the process mark.
2939 The process mark separates the process output, along with input already sent,
2940 from input that has not yet been sent. Ordinarily, the process mark
2941 is at the beginning of the current input line; but if you have
2943 the process mark is at the beginning of the accumulated input."
2950 "Set the process mark at point."
2957 \f
2958 ;; Author: Peter Breton <pbreton@cs.umb.edu>
2960 ;; This little add-on for comint is intended to make it easy to get
2961 ;; output from currently active comint buffers into another buffer,
2962 ;; or buffers, and then go back to using the comint shell.
2963 ;;
2964 ;; My particular use is SQL interpreters; I want to be able to execute a
2965 ;; query using the process associated with a comint-buffer, and save that
2966 ;; somewhere else. Because the process might have state (for example, it
2967 ;; could be in an uncommitted transaction), just running starting a new
2968 ;; process and having it execute the query and then finish, would not
2969 ;; work. I'm sure there are other uses as well, although in many cases
2970 ;; starting a new process is the simpler, and thus preferable, approach.
2971 ;;
2972 ;; The basic implementation is as follows: comint-redirect changes the
2973 ;; preoutput filter functions (`comint-preoutput-filter-functions') to use
2974 ;; its own filter. The filter puts the output into the designated buffer,
2975 ;; or buffers, until it sees a regexp that tells it to stop (by default,
2976 ;; this is the prompt for the interpreter, `comint-prompt-regexp'). When it
2977 ;; sees the stop regexp, it restores the old filter functions, and runs
2978 ;; `comint-redirect-hook'.
2979 ;;
2980 ;; Each comint buffer may only use one redirection at a time, but any number
2981 ;; of different comint buffers may be simultaneously redirected.
2982 ;;
2983 ;; NOTE: It is EXTREMELY important that `comint-prompt-regexp' be set to the
2984 ;; correct prompt for your interpreter, or that you supply a regexp that says
2985 ;; when the redirection is finished. Otherwise, redirection will continue
2986 ;; indefinitely. The code now does a sanity check to ensure that it can find
2987 ;; a prompt in the comint buffer; however, it is still important to ensure that
2988 ;; this prompt is set correctly.
2989 ;;
2990 ;; XXX: This doesn't work so well unless `comint-prompt-regexp' is set;
2991 ;; perhaps it should prompt for a terminating string (with an
2992 ;; appropriate magic default by examining what we think is the prompt)?
2993 ;;
2994 ;; Fixme: look for appropriate fields, rather than regexp, if
2995 ;; `comint-use-prompt-regexp-instead-of-fields' is true.
2997 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2998 ;; Variables
2999 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3002 "*If non-nil, print messages each time the redirection filter is invoked.
3003 Also print a message when redirection is completed."
3007 ;; Directly analagous to comint-preoutput-filter-functions
3009 "List of functions to call before inserting redirected process output.
3010 Each function gets one argument, a string containing the text received
3011 from the subprocess. It should return the string to insert, perhaps
3012 the same string that was received, or perhaps a modified or transformed
3013 string.
3015 The functions on the list are called sequentially, and each one is given
3016 the string returned by the previous one. The string returned by the
3017 last function is the text that is actually inserted in the redirection buffer.
3019 You can use `add-hook' to add functions to this list
3022 ;; Internal variables
3028 "Regular expression that determines when to stop redirection in Comint.
3029 When the redirection filter function is given output that matches this regexp,
3033 "If non-nil, the text that ends a redirection is included in it.
3034 More precisely, the text that matches `comint-redirect-finished-regexp'
3035 and therefore terminates an output redirection is inserted in the
3048 "If non-nil, check that redirection is likely to complete successfully.
3049 More precisely, before starting a redirection, verify that the
3050 regular expression `comint-redirect-finished-regexp' that controls
3051 when to terminate it actually matches some text already in the process
3052 buffer. The idea is that this regular expression should match a prompt
3053 string, and that there ought to be at least one copy of your prompt string
3057 "The process filter that was in place when redirection is started.
3058 When redirection is completed, the process filter is restored to
3062 "Non-nil means comint-redirect can insert into otherwise-readonly buffers.
3063 The readonly status is toggled around insertion.
3064 This is useful, for instance, for insertion into Help mode buffers.
3067 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3068 ;; Functions
3069 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3072 comint-buffer
3073 finished-regexp
3075 "Set up for output redirection.
3076 This function sets local variables that are used by `comint-redirect-filter'
3077 to perform redirection.
3079 Output from COMINT-BUFFER is redirected to OUTPUT-BUFFER, until something
3080 in the output matches FINISHED-REGEXP.
3082 If optional argument ECHO-INPUT is non-nil, output is echoed to the
3083 original Comint buffer.
3085 This function is called by `comint-redirect-send-command-to-process',
3086 and does not normally need to be invoked by the end user or programmer."
3110 "End a Comint redirection. See `comint-redirect-send-command'."
3112 ;; Restore the process filter
3114 comint-redirect-original-filter-function)
3115 ;; Restore the mode line
3117 ;; Set the completed flag
3120 ;; Because the cleanup happens as a callback, it's not easy to guarantee
3121 ;; that it really occurs.
3125 "Filter function which redirects output from PROCESS to a buffer or buffers.
3126 The variable `comint-redirect-output-buffer' says which buffer(s) to
3127 place output in.
3129 INPUT-STRING is the input from the Comint process.
3131 This function runs as a process filter, and does not need to be invoked by the
3132 end user."
3136 ;; If we have to echo output, give it to the original filter function
3138 comint-redirect-original-filter-function
3140 process input-string)))))
3144 "Comint filter function which redirects Comint output to a buffer or buffers.
3145 The variable `comint-redirect-output-buffer' says which buffer(s) to
3146 place output in.
3148 INPUT-STRING is the input from the Comint process.
3150 This function does not need to be invoked by the end user."
3153 comint-redirect-output-buffer
3157 ;; If there are any filter functions, give them a chance to modify the string
3161 ;; If a local value says "use the default value too",
3162 ;; do that.
3172 ;; Clobber `comint-redirect-finished-regexp'
3178 ;; Send output to all registered buffers
3181 ;; Set this buffer to the output buffer
3183 ;; Go to the end of the buffer
3185 ;; Insert the output
3189 ;; Message
3194 ;; If we see the prompt, tidy up
3195 ;; We'll look for the prompt in the original string, so nobody can
3196 ;; clobber it
3203 ;; Echo input?
3205 filtered-input-string
3208 ;;;###autoload
3210 "Send COMMAND to process in current buffer, with output to OUTPUT-BUFFER.
3211 With prefix arg ECHO, echo output in process buffer.
3213 If NO-DISPLAY is non-nil, do not show the output buffer."
3221 ;;;###autoload
3224 "Send COMMAND to PROCESS, with output to OUTPUT-BUFFER.
3225 With prefix arg, echo output in process buffer.
3227 If NO-DISPLAY is non-nil, do not show the output buffer."
3232 process))
3234 ;; Change to the process buffer
3237 ;; Make sure there's a prompt in the current process buffer
3244 ;;;;;;;;;;;;;;;;;;;;;
3245 ;; Set up for redirection
3246 ;;;;;;;;;;;;;;;;;;;;;
3248 ;; Output Buffer
3249 output-buffer
3250 ;; Comint Buffer
3252 ;; Finished Regexp
3253 comint-prompt-regexp
3254 ;; Echo input
3255 echo)
3257 ;;;;;;;;;;;;;;;;;;;;;
3258 ;; Set the filter
3259 ;;;;;;;;;;;;;;;;;;;;;
3260 ;; Save the old filter
3265 ;;;;;;;;;;;;;;;;;;;;;
3266 ;; Send the command
3267 ;;;;;;;;;;;;;;;;;;;;;
3272 ;;;;;;;;;;;;;;;;;;;;;
3273 ;; Show the output
3274 ;;;;;;;;;;;;;;;;;;;;;
3280 output-buffer)))))))
3282 ;;;###autoload
3284 "Send COMMAND to current process.
3285 Return a list of expressions in the output which match REGEXP.
3286 REGEXP-GROUP is the regular expression group in REGEXP to use."
3289 command regexp regexp-group))
3291 ;;;###autoload
3293 "Send COMMAND to PROCESS.
3294 Return a list of expressions in the output which match REGEXP.
3295 REGEXP-GROUP is the regular expression group in REGEXP to use."
3297 results)
3302 output-buffer process nil t)
3303 ;; Wait for the process to complete
3307 ;; Collect the output
3310 ;; Skip past the command, if it was echoed
3318 results)))
3319 results)))
3324 "^Empty input ring$"
3325 "^No history$"
3329 \f
3330 ;; Converting process modes to use comint mode
3331 ;; ===========================================================================
3332 ;; The code in the Emacs 19 distribution has all been modified to use comint
3333 ;; where needed. However, there are `third-party' packages out there that
3334 ;; still use the old shell mode. Here's a guide to conversion.
3335 ;;
3336 ;; Renaming variables
3337 ;; Most of the work is renaming variables and functions. These are the common
3338 ;; ones:
3339 ;; Local variables:
3340 ;; last-input-start comint-last-input-start
3341 ;; last-input-end comint-last-input-end
3342 ;; shell-prompt-pattern comint-prompt-regexp
3343 ;; shell-set-directory-error-hook <no equivalent>
3344 ;; Miscellaneous:
3345 ;; shell-set-directory <unnecessary>
3346 ;; shell-mode-map comint-mode-map
3347 ;; Commands:
3348 ;; shell-send-input comint-send-input
3349 ;; shell-send-eof comint-delchar-or-maybe-eof
3350 ;; kill-shell-input comint-kill-input
3351 ;; interrupt-shell-subjob comint-interrupt-subjob
3352 ;; stop-shell-subjob comint-stop-subjob
3353 ;; quit-shell-subjob comint-quit-subjob
3354 ;; kill-shell-subjob comint-kill-subjob
3355 ;; kill-output-from-shell comint-delete-output
3356 ;; show-output-from-shell comint-show-output
3357 ;; copy-last-shell-input Use comint-previous-input/comint-next-input
3358 ;;
3359 ;; SHELL-SET-DIRECTORY is gone, its functionality taken over by
3360 ;; SHELL-DIRECTORY-TRACKER, the shell mode's comint-input-filter-functions.
3361 ;; Comint mode does not provide functionality equivalent to
3362 ;; shell-set-directory-error-hook; it is gone.
3363 ;;
3364 ;; comint-last-input-start is provided for modes which want to munge
3365 ;; the buffer after input is sent, perhaps because the inferior
3366 ;; insists on echoing the input. The LAST-INPUT-START variable in
3367 ;; the old shell package was used to implement a history mechanism,
3368 ;; but you should think twice before using comint-last-input-start
3369 ;; for this; the input history ring often does the job better.
3370 ;;
3371 ;; If you are implementing some process-in-a-buffer mode, called foo-mode, do
3372 ;; *not* create the comint-mode local variables in your foo-mode function.
3373 ;; This is not modular. Instead, call comint-mode, and let *it* create the
3374 ;; necessary comint-specific local variables. Then create the
3375 ;; foo-mode-specific local variables in foo-mode. Set the buffer's keymap to
3376 ;; be foo-mode-map, and its mode to be foo-mode. Set the comint-mode hooks
3377 ;; (comint-{prompt-regexp, input-filter, input-filter-functions,
3378 ;; get-old-input) that need to be different from the defaults. Call
3379 ;; foo-mode-hook, and you're done. Don't run the comint-mode hook yourself;
3380 ;; comint-mode will take care of it. The following example, from shell.el,
3381 ;; is typical:
3382 ;;
3383 ;; (defvar shell-mode-map '())
3384 ;; (cond ((not shell-mode-map)
3385 ;; (setq shell-mode-map (copy-keymap comint-mode-map))
3386 ;; (define-key shell-mode-map "\C-c\C-f" 'shell-forward-command)
3387 ;; (define-key shell-mode-map "\C-c\C-b" 'shell-backward-command)
3388 ;; (define-key shell-mode-map "\t" 'comint-dynamic-complete)
3389 ;; (define-key shell-mode-map "\M-?"
3390 ;; 'comint-dynamic-list-filename-completions)))
3391 ;;
3392 ;; (defun shell-mode ()
3393 ;; (interactive)
3394 ;; (comint-mode)
3395 ;; (setq comint-prompt-regexp shell-prompt-pattern)
3396 ;; (setq major-mode 'shell-mode)
3397 ;; (setq mode-name "Shell")
3398 ;; (use-local-map shell-mode-map)
3399 ;; (make-local-variable 'shell-directory-stack)
3400 ;; (setq shell-directory-stack nil)
3401 ;; (add-hook 'comint-input-filter-functions 'shell-directory-tracker)
3402 ;; (run-hooks 'shell-mode-hook))
3403 ;;
3404 ;;
3405 ;; Completion for comint-mode users
3406 ;;
3407 ;; For modes that use comint-mode, comint-dynamic-complete-functions is the
3408 ;; hook to add completion functions to. Functions on this list should return
3409 ;; non-nil if completion occurs (i.e., further completion should not occur).
3410 ;; You could use comint-dynamic-simple-complete to do the bulk of the
3411 ;; completion job.
3412 \f
3416 ;;; arch-tag: 1793314c-09db-40be-9549-9aeae3e75164
3417 ;;; comint.el ends here